michaelh/zephyr
1
0
Fork 0
Code Releases Activity

include: drivers: dma format the documentation from header file

Browse source 
This patch is re-formating the doc generated from the dma.h
header file. Result to be accessible on the
https://docs.zephyrproject.org/latest/reference/peripherals/dma.html

Signed-off-by: Francois Ramu <francois.ramu@st.com>
This commit is contained in:
Francois Ramu 2021-08-18 11:29:02 +02:00 • committed by Christopher Friedt
commit be2f0bfaa9
1 changed files with 38 additions and 38 deletions
Download patch file Download diff file Expand all files Collapse all files

76
include/drivers/dma.h
View file

@ -49,37 +49,40 @@ enum dma_channel_filter {
};
/**
* @struct dma_block_config
* @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
* @param source_address is block starting address at source
* @param source_gather_interval is the address adjustment at gather boundary
* @param dest_address is block starting address at destination
* @param dest_scatter_interval is the address adjustment at scatter boundary
* @param dest_scatter_count is the continuous transfer count between scatter
* boundaries
* source_gather_count is the continuous transfer count between gather
* @param 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
* @param block_size is the number of bytes to be transferred for this block.
*
* @param 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
* 10-no change.
* dest_addr_adj [ 4 : 5 ] - 00-increment, 01-decrement,
* 10-no change
* 10-no change.
* source_reload_en [ 6 ] - reload source address at the end of
* block transfer
* 0-disable, 1-enable
* 0-disable, 1-enable.
* dest_reload_en [ 7 ] - reload destination address at the end
* of block transfer
* 0-disable, 1-enable
* 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
* availability.
* 1-source request postponed until
* destination request happens
* destination request happens.
* reserved [ 13 : 15 ]
*/
struct dma_block_config {
@ -123,44 +126,41 @@ typedef void (*dma_callback_t)(const struct device *dev, void *user_data,
uint32_t channel, int status);
/**
* @struct dma_config
* @brief DMA configuration structure.
*
* dma_slot [ 0 : 6 ] - which peripheral and direction
* @param dma_slot [ 0 : 6 ] - which peripheral and direction
* (HW specific)
* channel_direction [ 7 : 9 ] - 000-memory to memory,
* @param channel_direction [ 7 : 9 ] - 000-memory to memory,
* 001-memory to peripheral,
* 010-peripheral to memory,
* 011-peripheral to peripheral,
* ...
* complete_callback_en [ 10 ] - 0-callback invoked at completion only
* @param complete_callback_en [ 10 ] - 0-callback invoked at completion only
* 1-callback invoked at completion of
* each block
* error_callback_en [ 11 ] - 0-error callback enabled
* @param error_callback_en [ 11 ] - 0-error callback enabled
* 1-error callback disabled
* source_handshake [ 12 ] - 0-HW, 1-SW
* dest_handshake [ 13 ] - 0-HW, 1-SW
* channel_priority [ 14 : 17 ] - DMA channel priority
* source_chaining_en [ 18 ] - enable/disable source block chaining
* @param source_handshake [ 12 ] - 0-HW, 1-SW
* @param dest_handshake [ 13 ] - 0-HW, 1-SW
* @param channel_priority [ 14 : 17 ] - DMA channel priority
* @param source_chaining_en [ 18 ] - enable/disable source block chaining
* 0-disable, 1-enable
* dest_chaining_en [ 19 ] - enable/disable destination block
* @param dest_chaining_en [ 19 ] - enable/disable destination block
* chaining.
* 0-disable, 1-enable
* linked_channel [ 20 : 26 ] - after channel count exhaust will
* @param linked_channel [ 20 : 26 ] - after channel count exhaust will
* initiate a channel service request
* at this channel
* reserved [ 27 : 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
* @param reserved [ 27 : 31 ]
* @param source_data_size [ 0 : 15 ] - width of source data (in bytes)
* @param dest_data_size [ 16 : 31 ] - width of dest data (in bytes)
* @param source_burst_length [ 0 : 15 ] - number of source data units
* @param dest_burst_length [ 16 : 31 ] - number of destination data units
* @param block_count is the number of blocks used for block chaining, this
* depends on availability of the DMA controller.
*
* user_data private data from DMA client.
*
* dma_callback see dma_callback_t for details
* @param user_data private data from DMA client.
* @param dma_callback see dma_callback_t for details
*/
struct dma_config {
uint32_t dma_slot : 7;