[media] videobuf2-v4l2: document two helper functions
Document vb2_ops_wait_prepare() and vb2_ops_wait_finish(), in order to fix those two warnings: Documentation/media/kapi/v4l2-dev.rst:166: WARNING: c:func reference target not found: vb2_ops_wait_prepare Documentation/media/kapi/v4l2-dev.rst:166: WARNING: c:func reference target not found: vb2_ops_wait_finish Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>steinar/wifi_calib_4_9_kernel
parent
bf4404b482
commit
dba2d12ae4
|
@ -268,9 +268,22 @@ unsigned long vb2_fop_get_unmapped_area(struct file *file, unsigned long addr,
|
||||||
unsigned long len, unsigned long pgoff, unsigned long flags);
|
unsigned long len, unsigned long pgoff, unsigned long flags);
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
/* struct vb2_ops helpers, only use if vq->lock is non-NULL. */
|
/**
|
||||||
|
* vb2_ops_wait_prepare - helper function to lock a struct &vb2_queue
|
||||||
|
*
|
||||||
|
* @vq: pointer to struct vb2_queue
|
||||||
|
*
|
||||||
|
* ..note:: only use if vq->lock is non-NULL.
|
||||||
|
*/
|
||||||
void vb2_ops_wait_prepare(struct vb2_queue *vq);
|
void vb2_ops_wait_prepare(struct vb2_queue *vq);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* vb2_ops_wait_finish - helper function to unlock a struct &vb2_queue
|
||||||
|
*
|
||||||
|
* @vq: pointer to struct vb2_queue
|
||||||
|
*
|
||||||
|
* ..note:: only use if vq->lock is non-NULL.
|
||||||
|
*/
|
||||||
void vb2_ops_wait_finish(struct vb2_queue *vq);
|
void vb2_ops_wait_finish(struct vb2_queue *vq);
|
||||||
|
|
||||||
#endif /* _MEDIA_VIDEOBUF2_V4L2_H */
|
#endif /* _MEDIA_VIDEOBUF2_V4L2_H */
|
||||||
|
|
Loading…
Reference in New Issue