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>
This commit is contained in:
parent
273340e8bf
commit
b6d1a17f47
|
@ -9,6 +9,15 @@ enum pxad_chan_prio {
|
||||||
PXAD_PRIO_LOWEST,
|
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 {
|
struct pxad_param {
|
||||||
unsigned int drcmr;
|
unsigned int drcmr;
|
||||||
enum pxad_chan_prio prio;
|
enum pxad_chan_prio prio;
|
||||||
|
|
Loading…
Reference in New Issue