Skip to content

Commit

Permalink
dmaengine: virt-dma: Fix kernel-doc annotations
Browse files Browse the repository at this point in the history
In kernel-doc annotations parameters need to start with a @ for them to be
properly recognized. Add those where missing for virt-dma.

Signed-off-by: Lars-Peter Clausen <lars@metafoo.de>
Signed-off-by: Vinod Koul <vinod.koul@intel.com>
  • Loading branch information
Lars-Peter Clausen authored and Vinod Koul committed Oct 27, 2015
1 parent 52984aa commit 28ca3e8
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions drivers/dma/virt-dma.h
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,9 @@ struct virt_dma_desc *vchan_find_desc(struct virt_dma_chan *, dma_cookie_t);

/**
* vchan_tx_prep - prepare a descriptor
* vc: virtual channel allocating this descriptor
* vd: virtual descriptor to prepare
* tx_flags: flags argument passed in to prepare function
* @vc: virtual channel allocating this descriptor
* @vd: virtual descriptor to prepare
* @tx_flags: flags argument passed in to prepare function
*/
static inline struct dma_async_tx_descriptor *vchan_tx_prep(struct virt_dma_chan *vc,
struct virt_dma_desc *vd, unsigned long tx_flags)
Expand All @@ -65,7 +65,7 @@ static inline struct dma_async_tx_descriptor *vchan_tx_prep(struct virt_dma_chan

/**
* vchan_issue_pending - move submitted descriptors to issued list
* vc: virtual channel to update
* @vc: virtual channel to update
*
* vc.lock must be held by caller
*/
Expand All @@ -77,7 +77,7 @@ static inline bool vchan_issue_pending(struct virt_dma_chan *vc)

/**
* vchan_cookie_complete - report completion of a descriptor
* vd: virtual descriptor to update
* @vd: virtual descriptor to update
*
* vc.lock must be held by caller
*/
Expand All @@ -97,7 +97,7 @@ static inline void vchan_cookie_complete(struct virt_dma_desc *vd)

/**
* vchan_cyclic_callback - report the completion of a period
* vd: virtual descriptor
* @vd: virtual descriptor
*/
static inline void vchan_cyclic_callback(struct virt_dma_desc *vd)
{
Expand All @@ -109,7 +109,7 @@ static inline void vchan_cyclic_callback(struct virt_dma_desc *vd)

/**
* vchan_next_desc - peek at the next descriptor to be processed
* vc: virtual channel to obtain descriptor from
* @vc: virtual channel to obtain descriptor from
*
* vc.lock must be held by caller
*/
Expand All @@ -123,8 +123,8 @@ static inline struct virt_dma_desc *vchan_next_desc(struct virt_dma_chan *vc)

/**
* vchan_get_all_descriptors - obtain all submitted and issued descriptors
* vc: virtual channel to get descriptors from
* head: list of descriptors found
* @vc: virtual channel to get descriptors from
* @head: list of descriptors found
*
* vc.lock must be held by caller
*
Expand Down

0 comments on commit 28ca3e8

Please sign in to comment.