diff options
| author | Jon Medhurst <tixy@linaro.org> | 2017-02-21 10:55:57 +0000 |
|---|---|---|
| committer | Anas Nashif <nashif@linux.intel.com> | 2017-03-02 00:05:55 +0000 |
| commit | d626dc989eb5e6d17c4ac638da8ab171e37b0ad3 (patch) | |
| tree | 1aae3ecf9886340694f0c8d81eb9c062f42bd58e | |
| parent | 06a36923c6262ab0620d236c2404ddd999ca021f (diff) | |
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 <tixy@linaro.org>
| -rw-r--r-- | include/dma.h | 11 |
1 files changed, 5 insertions, 6 deletions
diff --git a/include/dma.h b/include/dma.h index 0d60e0305..0310b29a1 100644 --- a/include/dma.h +++ b/include/dma.h @@ -159,7 +159,6 @@ struct dma_block_config { /** * @brief DMA configuration structure. * - * config is a bit field with the following parts: * dma_slot [ 0 : 5 ] - which peripheral and direction * (HW specific) * channel_direction [ 6 : 8 ] - 000-memory to memory, 001-memory to @@ -180,11 +179,11 @@ struct dma_block_config { * 0-disable, 1-enable * reserved [ 19 : 31 ] * - * config_size is a bit field with the following parts: - * source_data_size [ 0 : 15 ] - number of bytes - * dest_data_size [ 16 : 31 ] - number of bytes - * source_burst_length [ 0 : 15 ] - number of source data units - * dest_burst_length [ 16 : 31 ] - number of destination data units + * source_data_size [ 0 : 15 ] - number of bytes + * dest_data_size [ 16 : 31 ] - number of 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. |