diff options
author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-09-08 17:12:18 -0400 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-09-09 09:19:06 -0400 |
commit | dba2d12ae49217254cfc0452c68f1a4e2d2f1e4b (patch) | |
tree | 9c3c1990fff630fc3307f119b722f2137828ca68 | |
parent | bf4404b482f927096ba3001d829a79f788d2265f (diff) |
[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>
-rw-r--r-- | include/media/videobuf2-v4l2.h | 17 |
1 files changed, 15 insertions, 2 deletions
diff --git a/include/media/videobuf2-v4l2.h b/include/media/videobuf2-v4l2.h index 611d4f330a4c..036127c54bbf 100644 --- a/include/media/videobuf2-v4l2.h +++ b/include/media/videobuf2-v4l2.h | |||
@@ -268,9 +268,22 @@ unsigned long vb2_fop_get_unmapped_area(struct file *file, unsigned long addr, | |||
268 | unsigned long len, unsigned long pgoff, unsigned long flags); | 268 | unsigned long len, unsigned long pgoff, unsigned long flags); |
269 | #endif | 269 | #endif |
270 | 270 | ||
271 | /* struct vb2_ops helpers, only use if vq->lock is non-NULL. */ | 271 | /** |
272 | 272 | * vb2_ops_wait_prepare - helper function to lock a struct &vb2_queue | |
273 | * | ||
274 | * @vq: pointer to struct vb2_queue | ||
275 | * | ||
276 | * ..note:: only use if vq->lock is non-NULL. | ||
277 | */ | ||
273 | void vb2_ops_wait_prepare(struct vb2_queue *vq); | 278 | void vb2_ops_wait_prepare(struct vb2_queue *vq); |
279 | |||
280 | /** | ||
281 | * vb2_ops_wait_finish - helper function to unlock a struct &vb2_queue | ||
282 | * | ||
283 | * @vq: pointer to struct vb2_queue | ||
284 | * | ||
285 | * ..note:: only use if vq->lock is non-NULL. | ||
286 | */ | ||
274 | void vb2_ops_wait_finish(struct vb2_queue *vq); | 287 | void vb2_ops_wait_finish(struct vb2_queue *vq); |
275 | 288 | ||
276 | #endif /* _MEDIA_VIDEOBUF2_V4L2_H */ | 289 | #endif /* _MEDIA_VIDEOBUF2_V4L2_H */ |