Skip to content

Commit d626dc9

Browse files
tixyAnas Nashif
authored andcommitted
api: dma: Fix comments for struct dma_config
The comments refered to 'config' and 'config_size' as though they were named members of the struct, which they are not, and so is a little confusing. Delete these comments and also correctly align the text for size and burst members. Change-Id: Iae14c76940268b8e7d72b117c8aea5a204b3da34 Signed-off-by: Jon Medhurst <[email protected]>
1 parent 06a3692 commit d626dc9

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

include/dma.h

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,6 @@ struct dma_block_config {
159159
/**
160160
* @brief DMA configuration structure.
161161
*
162-
* config is a bit field with the following parts:
163162
* dma_slot [ 0 : 5 ] - which peripheral and direction
164163
* (HW specific)
165164
* channel_direction [ 6 : 8 ] - 000-memory to memory, 001-memory to
@@ -180,11 +179,11 @@ struct dma_block_config {
180179
* 0-disable, 1-enable
181180
* reserved [ 19 : 31 ]
182181
*
183-
* config_size is a bit field with the following parts:
184-
* source_data_size [ 0 : 15 ] - number of bytes
185-
* dest_data_size [ 16 : 31 ] - number of bytes
186-
* source_burst_length [ 0 : 15 ] - number of source data units
187-
* dest_burst_length [ 16 : 31 ] - number of destination data units
182+
* source_data_size [ 0 : 15 ] - number of bytes
183+
* dest_data_size [ 16 : 31 ] - number of bytes
184+
*
185+
* source_burst_length [ 0 : 15 ] - number of source data units
186+
* dest_burst_length [ 16 : 31 ] - number of destination data units
188187
*
189188
* block_count is the number of blocks used for block chaining, this
190189
* depends on availability of the DMA controller.

0 commit comments

Comments
 (0)