Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit b6d1a17f authored by Robert Jarzmik's avatar Robert Jarzmik
Browse files

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: default avatarRobert Jarzmik <robert.jarzmik@free.fr>
Acked-by: default avatarVinod Koul <vkoul@kernel.org>
parent 273340e8
Loading
Loading
Loading
Loading
+9 −0
Original line number Diff line number Diff line
@@ -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;