michaelh/zephyr
1
0
Fork 0
Code Releases Activity

cleanup: include/: move dma.h to drivers/dma.h

Browse source 
move dma.h to drivers/dma.h and
create a shim for backward-compatibility.

No functional changes to the headers.
A warning in the shim can be controlled with CONFIG_COMPAT_INCLUDES.

Related to #16539

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2019-06-25 15:53:48 -04:00
commit 46a5d1e5cb
20 changed files with 413 additions and 398 deletions
Download patch file Download diff file Expand all files Collapse all files

2
drivers/audio/intel_dmic.c
View file

@ -14,7 +14,7 @@
#include <zephyr.h> #include <zephyr.h>
#include <device.h> #include <device.h>
#include <soc.h> #include <soc.h>
#include <dma.h> #include <drivers/dma.h>
#include <audio/dmic.h> #include <audio/dmic.h>
#include "intel_dmic.h" #include "intel_dmic.h"

2
drivers/dma/dma_cavs.c
View file

@ -11,7 +11,7 @@
#include <kernel.h> #include <kernel.h>
#include <device.h> #include <device.h>
#include <init.h> #include <init.h>
#include <dma.h> #include <drivers/dma.h>
#include <soc.h> #include <soc.h>
#include "dma_cavs.h" #include "dma_cavs.h"

2
drivers/dma/dma_handlers.c
View file

@ -4,7 +4,7 @@
* SPDX-License-Identifier: Apache-2.0 * SPDX-License-Identifier: Apache-2.0
*/ */
#include <dma.h> #include <drivers/dma.h>
#include <syscall_handler.h> #include <syscall_handler.h>
/* Both of these APIs are assuming that the drive implementations are checking /* Both of these APIs are assuming that the drive implementations are checking

2
drivers/dma/dma_nios2_msgdma.c
View file

@ -9,7 +9,7 @@
#include <init.h> #include <init.h>
#include <string.h> #include <string.h>
#include <soc.h> #include <soc.h>
#include <dma.h> #include <drivers/dma.h>
#include <altera_common.h> #include <altera_common.h>
#include "altera_msgdma_csr_regs.h" #include "altera_msgdma_csr_regs.h"
#include "altera_msgdma_descriptor_regs.h" #include "altera_msgdma_descriptor_regs.h"

2
drivers/dma/dma_qmsi.c
View file

@ -11,7 +11,7 @@
#include <soc.h> #include <soc.h>
#include <device.h> #include <device.h>
#include <init.h> #include <init.h>
#include <dma.h> #include <drivers/dma.h>
#include "qm_dma.h" #include "qm_dma.h"
#include "qm_isr.h" #include "qm_isr.h"

2
drivers/dma/dma_sam0.c
View file

@ -6,7 +6,7 @@
#include <device.h> #include <device.h>
#include <soc.h> #include <soc.h>
#include <dma.h> #include <drivers/dma.h>
#include <logging/log.h> #include <logging/log.h>
LOG_MODULE_REGISTER(dma_sam0, CONFIG_DMA_LOG_LEVEL); LOG_MODULE_REGISTER(dma_sam0, CONFIG_DMA_LOG_LEVEL);

2
drivers/dma/dma_sam_xdmac.c
View file

@ -14,7 +14,7 @@
#include <init.h> #include <init.h>
#include <string.h> #include <string.h>
#include <soc.h> #include <soc.h>
#include <dma.h> #include <drivers/dma.h>
#include "dma_sam_xdmac.h" #include "dma_sam_xdmac.h"
#define LOG_LEVEL CONFIG_DMA_LOG_LEVEL #define LOG_LEVEL CONFIG_DMA_LOG_LEVEL

2
drivers/dma/dma_stm32f4x.c
View file

@ -7,7 +7,7 @@
#include <device.h> #include <device.h>
#include <dma.h> #include <drivers/dma.h>
#include <errno.h> #include <errno.h>
#include <init.h> #include <init.h>
#include <stdio.h> #include <stdio.h>

2
drivers/i2c/i2c_sam0.c
View file

@ -10,7 +10,7 @@
#include <init.h> #include <init.h>
#include <soc.h> #include <soc.h>
#include <i2c.h> #include <i2c.h>
#include <dma.h> #include <drivers/dma.h>
#include <logging/log.h> #include <logging/log.h>
LOG_MODULE_REGISTER(i2c_sam0, CONFIG_I2C_LOG_LEVEL); LOG_MODULE_REGISTER(i2c_sam0, CONFIG_I2C_LOG_LEVEL);

2
drivers/i2s/i2s_cavs.c
View file

@ -18,7 +18,7 @@
#include <kernel.h> #include <kernel.h>
#include <device.h> #include <device.h>
#include <init.h> #include <init.h>
#include <dma.h> #include <drivers/dma.h>
#include <i2s.h> #include <i2s.h>
#include <soc.h> #include <soc.h>
#include "i2s_cavs.h" #include "i2s_cavs.h"

2
drivers/i2s/i2s_ll_stm32.c
View file

@ -5,7 +5,7 @@
*/ */
#include <string.h> #include <string.h>
#include <dma.h> #include <drivers/dma.h>
#include <i2s.h> #include <i2s.h>
#include <soc.h> #include <soc.h>
#include <clock_control/stm32_clock_control.h> #include <clock_control/stm32_clock_control.h>

2
drivers/i2s/i2s_sam_ssc.c
View file

@ -23,7 +23,7 @@
#include <kernel.h> #include <kernel.h>
#include <device.h> #include <device.h>
#include <init.h> #include <init.h>
#include <dma.h> #include <drivers/dma.h>
#include <i2s.h> #include <i2s.h>
#include <soc.h> #include <soc.h>

2
drivers/serial/uart_sam0.c
View file

@ -10,7 +10,7 @@
#include <misc/__assert.h> #include <misc/__assert.h>
#include <soc.h> #include <soc.h>
#include <uart.h> #include <uart.h>
#include <dma.h> #include <drivers/dma.h>
/* Device constant configuration parameters */ /* Device constant configuration parameters */
struct uart_sam0_dev_cfg { struct uart_sam0_dev_cfg {

2
drivers/spi/spi_sam0.c
View file

@ -13,7 +13,7 @@ LOG_MODULE_REGISTER(spi_sam0);
#include <device.h> #include <device.h>
#include <spi.h> #include <spi.h>
#include <soc.h> #include <soc.h>
#include <dma.h> #include <drivers/dma.h>
/* Device constant configuration parameters */ /* Device constant configuration parameters */
struct spi_sam0_config { struct spi_sam0_config {

384
include/dma.h
View file

@ -1,391 +1,15 @@
/**
* @file
*
* @brief Public APIs for the DMA drivers.
*/
/* /*
* Copyright (c) 2016 Intel Corporation * Copyright (c) 2019 Intel Corporation
* *
* SPDX-License-Identifier: Apache-2.0 * SPDX-License-Identifier: Apache-2.0
*/ */
#ifndef ZEPHYR_INCLUDE_DMA_H_ #ifndef ZEPHYR_INCLUDE_DMA_H_
#define ZEPHYR_INCLUDE_DMA_H_ #define ZEPHYR_INCLUDE_DMA_H_
#include <kernel.h> #ifndef CONFIG_COMPAT_INCLUDES
#include <device.h> #warning "This header file has moved, include <drivers/dma.h> instead."
#ifdef __cplusplus
extern "C" {
#endif #endif
#include <drivers/dma.h>
/**
* @brief DMA Interface
* @defgroup dma_interface DMA Interface
* @ingroup io_interfaces
* @{
*/
enum dma_channel_direction {
MEMORY_TO_MEMORY = 0x0,
MEMORY_TO_PERIPHERAL,
PERIPHERAL_TO_MEMORY
};
/** Valid values for @a source_addr_adj and @a dest_addr_adj */
enum dma_addr_adj {
DMA_ADDR_ADJ_INCREMENT,
DMA_ADDR_ADJ_DECREMENT,
DMA_ADDR_ADJ_NO_CHANGE,
};
/**
* @brief DMA block configuration structure.
*
* source_address is block starting address at source
* source_gather_interval is the address adjustment at gather boundary
* dest_address is block starting address at destination
* dest_scatter_interval is the address adjustment at scatter boundary
* dest_scatter_count is the continuous transfer count between scatter
* boundaries
* source_gather_count is the continuous transfer count between gather
* boundaries
* block_size is the number of bytes to be transferred for this block.
*
* config is a bit field with the following parts:
* source_gather_en [ 0 ] - 0-disable, 1-enable
* dest_scatter_en [ 1 ] - 0-disable, 1-enable
* source_addr_adj [ 2 : 3 ] - 00-increment, 01-decrement,
* 10-no change
* dest_addr_adj [ 4 : 5 ] - 00-increment, 01-decrement,
* 10-no change
* source_reload_en [ 6 ] - reload source address at the end of
* block transfer
* 0-disable, 1-enable
* dest_reload_en [ 7 ] - reload destination address at the end
* of block transfer
* 0-disable, 1-enable
* fifo_mode_control [ 8 : 11 ] - How full of the fifo before transfer
* start. HW specific.
* flow_control_mode [ 12 ] - 0-source request served upon data
* availability
* 1-source request postponed until
* destination request happens
* reserved [ 13 : 15 ]
*/
struct dma_block_config {
u32_t source_address;
u32_t source_gather_interval;
u32_t dest_address;
u32_t dest_scatter_interval;
u16_t dest_scatter_count;
u16_t source_gather_count;
u32_t block_size;
struct dma_block_config *next_block;
u16_t source_gather_en : 1;
u16_t dest_scatter_en : 1;
u16_t source_addr_adj : 2;
u16_t dest_addr_adj : 2;
u16_t source_reload_en : 1;
u16_t dest_reload_en : 1;
u16_t fifo_mode_control : 4;
u16_t flow_control_mode : 1;
u16_t reserved : 3;
};
/**
* @brief DMA configuration structure.
*
* dma_slot [ 0 : 5 ] - which peripheral and direction
* (HW specific)
* channel_direction [ 6 : 8 ] - 000-memory to memory, 001-memory to
* peripheral, 010-peripheral to memory,
* ...
* complete_callback_en [ 9 ] - 0-callback invoked at completion only
* 1-callback invoked at completion of
* each block
* error_callback_en [ 10 ] - 0-error callback enabled
* 1-error callback disabled
* source_handshake [ 11 ] - 0-HW, 1-SW
* dest_handshake [ 12 ] - 0-HW, 1-SW
* channel_priority [ 13 : 16 ] - DMA channel priority
* source_chaining_en [ 17 ] - enable/disable source block chaining
* 0-disable, 1-enable
* dest_chaining_en [ 18 ] - enable/disable destination block
* chaining.
* 0-disable, 1-enable
* reserved [ 19 : 31 ]
*
* source_data_size [ 0 : 15 ] - width of source data (in bytes)
* dest_data_size [ 16 : 31 ] - width of dest data (in bytes)
* source_burst_length [ 0 : 15 ] - number of source data units
* dest_burst_length [ 16 : 31 ] - number of destination data units
*
* block_count is the number of blocks used for block chaining, this
* depends on availability of the DMA controller.
*
* callback_arg private argument from DMA client.
*
* dma_callback is the callback function pointer. If enabled, callback function
* will be invoked at transfer completion or when error happens
* (error_code: zero-transfer success, non zero-error happens).
*/
struct dma_config {
u32_t dma_slot : 6;
u32_t channel_direction : 3;
u32_t complete_callback_en : 1;
u32_t error_callback_en : 1;
u32_t source_handshake : 1;
u32_t dest_handshake : 1;
u32_t channel_priority : 4;
u32_t source_chaining_en : 1;
u32_t dest_chaining_en : 1;
u32_t reserved : 13;
u32_t source_data_size : 16;
u32_t dest_data_size : 16;
u32_t source_burst_length : 16;
u32_t dest_burst_length : 16;
u32_t block_count;
struct dma_block_config *head_block;
void *callback_arg;
void (*dma_callback)(void *callback_arg, u32_t channel,
int error_code);
};
/**
* DMA runtime status structure
*
* busy - is current DMA transfer busy or idle
* dir - DMA transfer direction
* pending_length - data length pending to be transferred in bytes
* or platform dependent.
*
*/
struct dma_status {
bool busy;
enum dma_channel_direction dir;
u32_t pending_length;
};
/**
* @cond INTERNAL_HIDDEN
*
* These are for internal use only, so skip these in
* public documentation.
*/
typedef int (*dma_api_config)(struct device *dev, u32_t channel,
struct dma_config *config);
typedef int (*dma_api_reload)(struct device *dev, u32_t channel,
u32_t src, u32_t dst, size_t size);
typedef int (*dma_api_start)(struct device *dev, u32_t channel);
typedef int (*dma_api_stop)(struct device *dev, u32_t channel);
typedef int (*dma_api_get_status)(struct device *dev, u32_t channel,
struct dma_status *status);
struct dma_driver_api {
dma_api_config config;
dma_api_reload reload;
dma_api_start start;
dma_api_stop stop;
dma_api_get_status get_status;
};
/**
* @endcond
*/
/**
* @brief Configure individual channel for DMA transfer.
*
* @param dev Pointer to the device structure for the driver instance.
* @param channel Numeric identification of the channel to configure
* @param config Data structure containing the intended configuration for the
* selected channel
*
* @retval 0 if successful.
* @retval Negative errno code if failure.
*/
static inline int dma_config(struct device *dev, u32_t channel,
struct dma_config *config)
{
const struct dma_driver_api *api =
(const struct dma_driver_api *)dev->driver_api;
return api->config(dev, channel, config);
}
/**
* @brief Reload buffer(s) for a DMA channel
*
* @param dev Pointer to the device structure for the driver instance.
* @param channel Numeric identification of the channel to configure
* selected channel
* @param src source address for the DMA transfer
* @param dst destination address for the DMA transfer
* @param size size of DMA transfer
*
* @retval 0 if successful.
* @retval Negative errno code if failure.
*/
static inline int dma_reload(struct device *dev, u32_t channel,
u32_t src, u32_t dst, size_t size)
{
const struct dma_driver_api *api =
(const struct dma_driver_api *)dev->driver_api;
if (api->reload) {
return api->reload(dev, channel, src, dst, size);
}
return -ENOSYS;
}
/**
* @brief Enables DMA channel and starts the transfer, the channel must be
* configured beforehand.
*
* Implementations must check the validity of the channel ID passed in and
* return -EINVAL if it is invalid.
*
* @param dev Pointer to the device structure for the driver instance.
* @param channel Numeric identification of the channel where the transfer will
* be processed
*
* @retval 0 if successful.
* @retval Negative errno code if failure.
*/
__syscall int dma_start(struct device *dev, u32_t channel);
static inline int z_impl_dma_start(struct device *dev, u32_t channel)
{
const struct dma_driver_api *api =
(const struct dma_driver_api *)dev->driver_api;
return api->start(dev, channel);
}
/**
* @brief Stops the DMA transfer and disables the channel.
*
* Implementations must check the validity of the channel ID passed in and
* return -EINVAL if it is invalid.
*
* @param dev Pointer to the device structure for the driver instance.
* @param channel Numeric identification of the channel where the transfer was
* being processed
*
* @retval 0 if successful.
* @retval Negative errno code if failure.
*/
__syscall int dma_stop(struct device *dev, u32_t channel);
static inline int z_impl_dma_stop(struct device *dev, u32_t channel)
{
const struct dma_driver_api *api =
(const struct dma_driver_api *)dev->driver_api;
return api->stop(dev, channel);
}
/**
* @brief get current runtime status of DMA transfer
*
* Implementations must check the validity of the channel ID passed in and
* return -EINVAL if it is invalid or -ENOSYS if not supported.
*
* @param dev Pointer to the device structure for the driver instance.
* @param channel Numeric identification of the channel where the transfer was
* being processed
* @param stat a non-NULL dma_status object for storing DMA status
*
* @retval non-negative if successful.
* @retval Negative errno code if failure.
*/
static inline int dma_get_status(struct device *dev, u32_t channel,
struct dma_status *stat)
{
const struct dma_driver_api *api =
(const struct dma_driver_api *)dev->driver_api;
if (api->get_status) {
return api->get_status(dev, channel, stat);
}
return -ENOSYS;
}
/**
* @brief Look-up generic width index to be used in registers
*
* WARNING: This look-up works for most controllers, but *may* not work for
* yours. Ensure your controller expects the most common register
* bit values before using this convenience function. If your
* controller does not support these values, you will have to write
* your own look-up inside the controller driver.
*
* @param size: width of bus (in bytes)
*
* @retval common DMA index to be placed into registers.
*/
static inline u32_t dma_width_index(u32_t size)
{
/* Check boundaries (max supported width is 32 Bytes) */
if (size < 1 || size > 32) {
return 0; /* Zero is the default (8 Bytes) */
}
/* Ensure size is a power of 2 */
if (!is_power_of_two(size)) {
return 0; /* Zero is the default (8 Bytes) */
}
/* Convert to bit pattern for writing to a register */
return find_msb_set(size);
}
/**
* @brief Look-up generic burst index to be used in registers
*
* WARNING: This look-up works for most controllers, but *may* not work for
* yours. Ensure your controller expects the most common register
* bit values before using this convenience function. If your
* controller does not support these values, you will have to write
* your own look-up inside the controller driver.
*
* @param burst: number of bytes to be sent in a single burst
*
* @retval common DMA index to be placed into registers.
*/
static inline u32_t dma_burst_index(u32_t burst)
{
/* Check boundaries (max supported burst length is 256) */
if (burst < 1 || burst > 256) {
return 0; /* Zero is the default (1 burst length) */
}
/* Ensure burst is a power of 2 */
if (!(burst & (burst - 1))) {
return 0; /* Zero is the default (1 burst length) */
}
/* Convert to bit pattern for writing to a register */
return find_msb_set(burst);
}
/**
* @}
*/
#ifdef __cplusplus
}
#endif
#include <syscalls/dma.h>
#endif /* ZEPHYR_INCLUDE_DMA_H_ */ #endif /* ZEPHYR_INCLUDE_DMA_H_ */

391
include/drivers/dma.h Normal file
View file

@ -0,0 +1,391 @@
/**
* @file
*
* @brief Public APIs for the DMA drivers.
*/
/*
* Copyright (c) 2016 Intel Corporation
*
* SPDX-License-Identifier: Apache-2.0
*/
#ifndef ZEPHYR_INCLUDE_DRIVERS_DMA_H_
#define ZEPHYR_INCLUDE_DRIVERS_DMA_H_
#include <kernel.h>
#include <device.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief DMA Interface
* @defgroup dma_interface DMA Interface
* @ingroup io_interfaces
* @{
*/
enum dma_channel_direction {
MEMORY_TO_MEMORY = 0x0,
MEMORY_TO_PERIPHERAL,
PERIPHERAL_TO_MEMORY
};
/** Valid values for @a source_addr_adj and @a dest_addr_adj */
enum dma_addr_adj {
DMA_ADDR_ADJ_INCREMENT,
DMA_ADDR_ADJ_DECREMENT,
DMA_ADDR_ADJ_NO_CHANGE,
};
/**
* @brief DMA block configuration structure.
*
* source_address is block starting address at source
* source_gather_interval is the address adjustment at gather boundary
* dest_address is block starting address at destination
* dest_scatter_interval is the address adjustment at scatter boundary
* dest_scatter_count is the continuous transfer count between scatter
* boundaries
* source_gather_count is the continuous transfer count between gather
* boundaries
* block_size is the number of bytes to be transferred for this block.
*
* config is a bit field with the following parts:
* source_gather_en [ 0 ] - 0-disable, 1-enable
* dest_scatter_en [ 1 ] - 0-disable, 1-enable
* source_addr_adj [ 2 : 3 ] - 00-increment, 01-decrement,
* 10-no change
* dest_addr_adj [ 4 : 5 ] - 00-increment, 01-decrement,
* 10-no change
* source_reload_en [ 6 ] - reload source address at the end of
* block transfer
* 0-disable, 1-enable
* dest_reload_en [ 7 ] - reload destination address at the end
* of block transfer
* 0-disable, 1-enable
* fifo_mode_control [ 8 : 11 ] - How full of the fifo before transfer
* start. HW specific.
* flow_control_mode [ 12 ] - 0-source request served upon data
* availability
* 1-source request postponed until
* destination request happens
* reserved [ 13 : 15 ]
*/
struct dma_block_config {
u32_t source_address;
u32_t source_gather_interval;
u32_t dest_address;
u32_t dest_scatter_interval;
u16_t dest_scatter_count;
u16_t source_gather_count;
u32_t block_size;
struct dma_block_config *next_block;
u16_t source_gather_en : 1;
u16_t dest_scatter_en : 1;
u16_t source_addr_adj : 2;
u16_t dest_addr_adj : 2;
u16_t source_reload_en : 1;
u16_t dest_reload_en : 1;
u16_t fifo_mode_control : 4;
u16_t flow_control_mode : 1;
u16_t reserved : 3;
};
/**
* @brief DMA configuration structure.
*
* dma_slot [ 0 : 5 ] - which peripheral and direction
* (HW specific)
* channel_direction [ 6 : 8 ] - 000-memory to memory, 001-memory to
* peripheral, 010-peripheral to memory,
* ...
* complete_callback_en [ 9 ] - 0-callback invoked at completion only
* 1-callback invoked at completion of
* each block
* error_callback_en [ 10 ] - 0-error callback enabled
* 1-error callback disabled
* source_handshake [ 11 ] - 0-HW, 1-SW
* dest_handshake [ 12 ] - 0-HW, 1-SW
* channel_priority [ 13 : 16 ] - DMA channel priority
* source_chaining_en [ 17 ] - enable/disable source block chaining
* 0-disable, 1-enable
* dest_chaining_en [ 18 ] - enable/disable destination block
* chaining.
* 0-disable, 1-enable
* reserved [ 19 : 31 ]
*
* source_data_size [ 0 : 15 ] - width of source data (in bytes)
* dest_data_size [ 16 : 31 ] - width of dest data (in bytes)
* source_burst_length [ 0 : 15 ] - number of source data units
* dest_burst_length [ 16 : 31 ] - number of destination data units
*
* block_count is the number of blocks used for block chaining, this
* depends on availability of the DMA controller.
*
* callback_arg private argument from DMA client.
*
* dma_callback is the callback function pointer. If enabled, callback function
* will be invoked at transfer completion or when error happens
* (error_code: zero-transfer success, non zero-error happens).
*/
struct dma_config {
u32_t dma_slot : 6;
u32_t channel_direction : 3;
u32_t complete_callback_en : 1;
u32_t error_callback_en : 1;
u32_t source_handshake : 1;
u32_t dest_handshake : 1;
u32_t channel_priority : 4;
u32_t source_chaining_en : 1;
u32_t dest_chaining_en : 1;
u32_t reserved : 13;
u32_t source_data_size : 16;
u32_t dest_data_size : 16;
u32_t source_burst_length : 16;
u32_t dest_burst_length : 16;
u32_t block_count;
struct dma_block_config *head_block;
void *callback_arg;
void (*dma_callback)(void *callback_arg, u32_t channel,
int error_code);
};
/**
* DMA runtime status structure
*
* busy - is current DMA transfer busy or idle
* dir - DMA transfer direction
* pending_length - data length pending to be transferred in bytes
* or platform dependent.
*
*/
struct dma_status {
bool busy;
enum dma_channel_direction dir;
u32_t pending_length;
};
/**
* @cond INTERNAL_HIDDEN
*
* These are for internal use only, so skip these in
* public documentation.
*/
typedef int (*dma_api_config)(struct device *dev, u32_t channel,
struct dma_config *config);
typedef int (*dma_api_reload)(struct device *dev, u32_t channel,
u32_t src, u32_t dst, size_t size);
typedef int (*dma_api_start)(struct device *dev, u32_t channel);
typedef int (*dma_api_stop)(struct device *dev, u32_t channel);
typedef int (*dma_api_get_status)(struct device *dev, u32_t channel,
struct dma_status *status);
struct dma_driver_api {
dma_api_config config;
dma_api_reload reload;
dma_api_start start;
dma_api_stop stop;
dma_api_get_status get_status;
};
/**
* @endcond
*/
/**
* @brief Configure individual channel for DMA transfer.
*
* @param dev Pointer to the device structure for the driver instance.
* @param channel Numeric identification of the channel to configure
* @param config Data structure containing the intended configuration for the
* selected channel
*
* @retval 0 if successful.
* @retval Negative errno code if failure.
*/
static inline int dma_config(struct device *dev, u32_t channel,
struct dma_config *config)
{
const struct dma_driver_api *api =
(const struct dma_driver_api *)dev->driver_api;
return api->config(dev, channel, config);
}
/**
* @brief Reload buffer(s) for a DMA channel
*
* @param dev Pointer to the device structure for the driver instance.
* @param channel Numeric identification of the channel to configure
* selected channel
* @param src source address for the DMA transfer
* @param dst destination address for the DMA transfer
* @param size size of DMA transfer
*
* @retval 0 if successful.
* @retval Negative errno code if failure.
*/
static inline int dma_reload(struct device *dev, u32_t channel,
u32_t src, u32_t dst, size_t size)
{
const struct dma_driver_api *api =
(const struct dma_driver_api *)dev->driver_api;
if (api->reload) {
return api->reload(dev, channel, src, dst, size);
}
return -ENOSYS;
}
/**
* @brief Enables DMA channel and starts the transfer, the channel must be
* configured beforehand.
*
* Implementations must check the validity of the channel ID passed in and
* return -EINVAL if it is invalid.
*
* @param dev Pointer to the device structure for the driver instance.
* @param channel Numeric identification of the channel where the transfer will
* be processed
*
* @retval 0 if successful.
* @retval Negative errno code if failure.
*/
__syscall int dma_start(struct device *dev, u32_t channel);
static inline int z_impl_dma_start(struct device *dev, u32_t channel)
{
const struct dma_driver_api *api =
(const struct dma_driver_api *)dev->driver_api;
return api->start(dev, channel);
}
/**
* @brief Stops the DMA transfer and disables the channel.
*
* Implementations must check the validity of the channel ID passed in and
* return -EINVAL if it is invalid.
*
* @param dev Pointer to the device structure for the driver instance.
* @param channel Numeric identification of the channel where the transfer was
* being processed
*
* @retval 0 if successful.
* @retval Negative errno code if failure.
*/
__syscall int dma_stop(struct device *dev, u32_t channel);
static inline int z_impl_dma_stop(struct device *dev, u32_t channel)
{
const struct dma_driver_api *api =
(const struct dma_driver_api *)dev->driver_api;
return api->stop(dev, channel);
}
/**
* @brief get current runtime status of DMA transfer
*
* Implementations must check the validity of the channel ID passed in and
* return -EINVAL if it is invalid or -ENOSYS if not supported.
*
* @param dev Pointer to the device structure for the driver instance.
* @param channel Numeric identification of the channel where the transfer was
* being processed
* @param stat a non-NULL dma_status object for storing DMA status
*
* @retval non-negative if successful.
* @retval Negative errno code if failure.
*/
static inline int dma_get_status(struct device *dev, u32_t channel,
struct dma_status *stat)
{
const struct dma_driver_api *api =
(const struct dma_driver_api *)dev->driver_api;
if (api->get_status) {
return api->get_status(dev, channel, stat);
}
return -ENOSYS;
}
/**
* @brief Look-up generic width index to be used in registers
*
* WARNING: This look-up works for most controllers, but *may* not work for
* yours. Ensure your controller expects the most common register
* bit values before using this convenience function. If your
* controller does not support these values, you will have to write
* your own look-up inside the controller driver.
*
* @param size: width of bus (in bytes)
*
* @retval common DMA index to be placed into registers.
*/
static inline u32_t dma_width_index(u32_t size)
{
/* Check boundaries (max supported width is 32 Bytes) */
if (size < 1 || size > 32) {
return 0; /* Zero is the default (8 Bytes) */
}
/* Ensure size is a power of 2 */
if (!is_power_of_two(size)) {
return 0; /* Zero is the default (8 Bytes) */
}
/* Convert to bit pattern for writing to a register */
return find_msb_set(size);
}
/**
* @brief Look-up generic burst index to be used in registers
*
* WARNING: This look-up works for most controllers, but *may* not work for
* yours. Ensure your controller expects the most common register
* bit values before using this convenience function. If your
* controller does not support these values, you will have to write
* your own look-up inside the controller driver.
*
* @param burst: number of bytes to be sent in a single burst
*
* @retval common DMA index to be placed into registers.
*/
static inline u32_t dma_burst_index(u32_t burst)
{
/* Check boundaries (max supported burst length is 256) */
if (burst < 1 || burst > 256) {
return 0; /* Zero is the default (1 burst length) */
}
/* Ensure burst is a power of 2 */
if (!(burst & (burst - 1))) {
return 0; /* Zero is the default (1 burst length) */
}
/* Convert to bit pattern for writing to a register */
return find_msb_set(burst);
}
/**
* @}
*/
#ifdef __cplusplus
}
#endif
#include <syscalls/dma.h>
#endif /* ZEPHYR_INCLUDE_DRIVERS_DMA_H_ */

2
tests/boards/altera_max10/msgdma/src/dma.c
View file

@ -8,7 +8,7 @@
#include <soc.h> #include <soc.h>
#include <kernel_structs.h> #include <kernel_structs.h>
#include <device.h> #include <device.h>
#include <dma.h> #include <drivers/dma.h>
#define DMA_BUFF_SIZE 1024 #define DMA_BUFF_SIZE 1024

2
tests/boards/intel_s1000_crb/src/dma_test.c
View file

@ -30,7 +30,7 @@
#include <misc/printk.h> #include <misc/printk.h>
#include <device.h> #include <device.h>
#include <dma.h> #include <drivers/dma.h>
#include <string.h> #include <string.h>
#include <xtensa/hal.h> #include <xtensa/hal.h>

2
tests/drivers/dma/chan_blen_transfer/src/test_dma.c
View file

@ -20,7 +20,7 @@
*/ */
#include <zephyr.h> #include <zephyr.h>
#include <dma.h> #include <drivers/dma.h>
#include <ztest.h> #include <ztest.h>
#define DMA_DEVICE_NAME CONFIG_DMA_0_NAME #define DMA_DEVICE_NAME CONFIG_DMA_0_NAME

2
tests/drivers/dma/loop_transfer/src/dma.c
View file

@ -9,7 +9,7 @@
#include <zephyr.h> #include <zephyr.h>
#include <device.h> #include <device.h>
#include <dma.h> #include <drivers/dma.h>
#include <misc/printk.h> #include <misc/printk.h>
#include <string.h> #include <string.h>