diff options
author | Robert Jarzmik <robert.jarzmik@free.fr> | 2018-06-17 20:02:14 +0300 |
---|---|---|
committer | Robert Jarzmik <robert.jarzmik@free.fr> | 2018-06-18 22:32:15 +0300 |
commit | b6d1a17f4729e4fda5740a855da91d202db2c118 (patch) | |
tree | c5a37a9b301831646d2237ee95bff77ad8ac9d57 | |
parent | 273340e8bf86de53eef7073993352ea11c563696 (diff) | |
download | linux-b6d1a17f4729e4fda5740a855da91d202db2c118.tar.xz |
dmaengine: pxa: document pxad_param
Add some documentation for the pxad_param structure, and describe the
contract behind the minimal required priority of a DMA channel.
Signed-off-by: Robert Jarzmik <robert.jarzmik@free.fr>
Acked-by: Vinod Koul <vkoul@kernel.org>
-rw-r--r-- | include/linux/dma/pxa-dma.h | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/include/linux/dma/pxa-dma.h b/include/linux/dma/pxa-dma.h index e56ec7af4fd7..9fc594f69eff 100644 --- a/include/linux/dma/pxa-dma.h +++ b/include/linux/dma/pxa-dma.h @@ -9,6 +9,15 @@ enum pxad_chan_prio { PXAD_PRIO_LOWEST, }; +/** + * struct pxad_param - dma channel request parameters + * @drcmr: requestor line number + * @prio: minimal mandatory priority of the channel + * + * If a requested channel is granted, its priority will be at least @prio, + * ie. if PXAD_PRIO_LOW is required, the requested channel will be either + * PXAD_PRIO_LOW, PXAD_PRIO_NORMAL or PXAD_PRIO_HIGHEST. + */ struct pxad_param { unsigned int drcmr; enum pxad_chan_prio prio; |