hollalinux
/
linux-sg2042
mirror of https://github.com/sophgo/linux-riscv.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

media: vb2: add cross references at memops and v4l2 kernel-doc markups 

Add cross-references where needed and add periods at the end of
each kernel-doc paragraph, in order to make it coherent with other
VB2 descriptions.

Acked-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
This commit is contained in:
Mauro Carvalho Chehab 2017-10-09 05:36:52 -04:00
parent 8dcde47ff8
commit 9fbe71b4d8
2 changed files with 63 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
include/media/videobuf2-memops.h
View File

@ -19,11 +19,11 @@
#include <linux/refcount.h> #include <linux/refcount.h>
/** /**
* struct vb2_vmarea_handler - common vma refcount tracking handler * struct vb2_vmarea_handler - common vma refcount tracking handler.
* *
* @refcount: pointer to refcount entry in the buffer * @refcount: pointer to &refcount_t entry in the buffer.
* @put: callback to function that decreases buffer refcount * @put: callback to function that decreases buffer refcount.
* @arg: argument for @put callback * @arg: argument for @put callback.
*/ */
struct vb2_vmarea_handler { struct vb2_vmarea_handler {
refcount_t *refcount; refcount_t *refcount;

112
include/media/videobuf2-v4l2.h
View File

@ -24,16 +24,17 @@
#endif #endif
/** /**
* struct vb2_v4l2_buffer - video buffer information for v4l2 * struct vb2_v4l2_buffer - video buffer information for v4l2.
* *
* @vb2_buf: video buffer 2 * @vb2_buf: embedded struct &vb2_buffer.
* @flags: buffer informational flags * @flags: buffer informational flags.
* @field: enum v4l2_field; field order of the image in the buffer * @field: field order of the image in the buffer, as defined by
* @timecode: frame timecode * &enum v4l2_field.
* @sequence: sequence count of this frame * @timecode: frame timecode.
* @sequence: sequence count of this frame.
* *
* Should contain enough information to be able to cover all the fields * Should contain enough information to be able to cover all the fields
* of struct v4l2_buffer at videodev2.h * of &struct v4l2_buffer at ``videodev2.h``.
*/ */
struct vb2_v4l2_buffer { struct vb2_v4l2_buffer {
struct vb2_buffer vb2_buf; struct vb2_buffer vb2_buf;
@ -56,9 +57,9 @@ int vb2_querybuf(struct vb2_queue *q, struct v4l2_buffer *b);
* vb2_reqbufs() - Wrapper for vb2_core_reqbufs() that also verifies * vb2_reqbufs() - Wrapper for vb2_core_reqbufs() that also verifies
* the memory and type values. * the memory and type values.
* *
* @q: videobuf2 queue * @q: pointer to &struct vb2_queue with videobuf2 queue.
* @req: struct passed from userspace to vidioc_reqbufs handler * @req: &struct v4l2_requestbuffers passed from userspace to
* in driver * &v4l2_ioctl_ops->vidioc_reqbufs handler in driver.
*/ */
int vb2_reqbufs(struct vb2_queue *q, struct v4l2_requestbuffers *req); int vb2_reqbufs(struct vb2_queue *q, struct v4l2_requestbuffers *req);
@ -66,94 +67,99 @@ int vb2_reqbufs(struct vb2_queue *q, struct v4l2_requestbuffers *req);
* vb2_create_bufs() - Wrapper for vb2_core_create_bufs() that also verifies * vb2_create_bufs() - Wrapper for vb2_core_create_bufs() that also verifies
* the memory and type values. * the memory and type values.
* *
* @q: videobuf2 queue * @q: pointer to &struct vb2_queue with videobuf2 queue.
* @create: creation parameters, passed from userspace to vidioc_create_bufs * @create: creation parameters, passed from userspace to
* handler in driver * &v4l2_ioctl_ops->vidioc_create_bufs handler in driver
*/ */
int vb2_create_bufs(struct vb2_queue *q, struct v4l2_create_buffers *create); int vb2_create_bufs(struct vb2_queue *q, struct v4l2_create_buffers *create);
/** /**
* vb2_prepare_buf() - Pass ownership of a buffer from userspace to the kernel * vb2_prepare_buf() - Pass ownership of a buffer from userspace to the kernel
* *
* @q: videobuf2 queue * @q: pointer to &struct vb2_queue with videobuf2 queue.
* @b: buffer structure passed from userspace to vidioc_prepare_buf * @b: buffer structure passed from userspace to
* handler in driver * &v4l2_ioctl_ops->vidioc_prepare_buf handler in driver
*
* Should be called from &v4l2_ioctl_ops->vidioc_prepare_buf ioctl handler
* of a driver.
* *
* Should be called from vidioc_prepare_buf ioctl handler of a driver.
* This function: * This function:
* *
* #) verifies the passed buffer, * #) verifies the passed buffer,
* #) calls buf_prepare callback in the driver (if provided), in which * #) calls &vb2_ops->buf_prepare callback in the driver (if provided),
* driver-specific buffer initialization can be performed. * in which driver-specific buffer initialization can be performed.
* *
* The return values from this function are intended to be directly returned * The return values from this function are intended to be directly returned
* from vidioc_prepare_buf handler in driver. * from &v4l2_ioctl_ops->vidioc_prepare_buf handler in driver.
*/ */
int vb2_prepare_buf(struct vb2_queue *q, struct v4l2_buffer *b); int vb2_prepare_buf(struct vb2_queue *q, struct v4l2_buffer *b);
/** /**
* vb2_qbuf() - Queue a buffer from userspace * vb2_qbuf() - Queue a buffer from userspace
* @q: videobuf2 queue * @q: pointer to &struct vb2_queue with videobuf2 queue.
* @b: buffer structure passed from userspace to VIDIOC_QBUF() handler * @b: buffer structure passed from userspace to
* in driver * &v4l2_ioctl_ops->vidioc_qbuf handler in driver
* *
* Should be called from VIDIOC_QBUF() ioctl handler of a driver. * Should be called from &v4l2_ioctl_ops->vidioc_qbuf handler of a driver.
* *
* This function: * This function:
* *
* #) verifies the passed buffer, * #) verifies the passed buffer;
* #) if necessary, calls buf_prepare callback in the driver (if provided), in * #) if necessary, calls &vb2_ops->buf_prepare callback in the driver
* which driver-specific buffer initialization can be performed, * (if provided), in which driver-specific buffer initialization can
* #) if streaming is on, queues the buffer in driver by the means of buf_queue * be performed;
* callback for processing. * #) if streaming is on, queues the buffer in driver by the means of
* &vb2_ops->buf_queue callback for processing.
* *
* The return values from this function are intended to be directly returned * The return values from this function are intended to be directly returned
* from VIDIOC_QBUF() handler in driver. * from &v4l2_ioctl_ops->vidioc_qbuf handler in driver.
*/ */
int vb2_qbuf(struct vb2_queue *q, struct v4l2_buffer *b); int vb2_qbuf(struct vb2_queue *q, struct v4l2_buffer *b);
/** /**
* vb2_expbuf() - Export a buffer as a file descriptor * vb2_expbuf() - Export a buffer as a file descriptor
* @q: videobuf2 queue * @q: pointer to &struct vb2_queue with videobuf2 queue.
* @eb: export buffer structure passed from userspace to VIDIOC_EXPBUF() * @eb: export buffer structure passed from userspace to
* handler in driver * &v4l2_ioctl_ops->vidioc_expbuf handler in driver
* *
* The return values from this function are intended to be directly returned * The return values from this function are intended to be directly returned
* from VIDIOC_EXPBUF() handler in driver. * from &v4l2_ioctl_ops->vidioc_expbuf handler in driver.
*/ */
int vb2_expbuf(struct vb2_queue *q, struct v4l2_exportbuffer *eb); int vb2_expbuf(struct vb2_queue *q, struct v4l2_exportbuffer *eb);
/** /**
* vb2_dqbuf() - Dequeue a buffer to the userspace * vb2_dqbuf() - Dequeue a buffer to the userspace
* @q: videobuf2 queue * @q: pointer to &struct vb2_queue with videobuf2 queue.
* @b: buffer structure passed from userspace to VIDIOC_DQBUF() handler * @b: buffer structure passed from userspace to
* in driver * &v4l2_ioctl_ops->vidioc_dqbuf handler in driver
* @nonblocking: if true, this call will not sleep waiting for a buffer if no * @nonblocking: if true, this call will not sleep waiting for a buffer if no
* buffers ready for dequeuing are present. Normally the driver * buffers ready for dequeuing are present. Normally the driver
* would be passing (file->f_flags & O_NONBLOCK) here * would be passing (&file->f_flags & %O_NONBLOCK) here
* *
* Should be called from VIDIOC_DQBUF() ioctl handler of a driver. * Should be called from &v4l2_ioctl_ops->vidioc_dqbuf ioctl handler
* of a driver.
* *
* This function: * This function:
* *
* #) verifies the passed buffer, * #) verifies the passed buffer;
* #) calls buf_finish callback in the driver (if provided), in which * #) calls &vb2_ops->buf_finish callback in the driver (if provided), in which
* driver can perform any additional operations that may be required before * driver can perform any additional operations that may be required before
* returning the buffer to userspace, such as cache sync, * returning the buffer to userspace, such as cache sync;
* #) the buffer struct members are filled with relevant information for * #) the buffer struct members are filled with relevant information for
* the userspace. * the userspace.
* *
* The return values from this function are intended to be directly returned * The return values from this function are intended to be directly returned
* from VIDIOC_DQBUF() handler in driver. * from &v4l2_ioctl_ops->vidioc_dqbuf handler in driver.
*/ */
int vb2_dqbuf(struct vb2_queue *q, struct v4l2_buffer *b, bool nonblocking); int vb2_dqbuf(struct vb2_queue *q, struct v4l2_buffer *b, bool nonblocking);
/** /**
* vb2_streamon - start streaming * vb2_streamon - start streaming
* @q: videobuf2 queue * @q: pointer to &struct vb2_queue with videobuf2 queue.
* @type: type argument passed from userspace to vidioc_streamon handler * @type: type argument passed from userspace to vidioc_streamon handler,
* as defined by &enum v4l2_buf_type.
* *
* Should be called from vidioc_streamon handler of a driver. * Should be called from &v4l2_ioctl_ops->vidioc_streamon handler of a driver.
* *
* This function: * This function:
* *
@ -161,13 +167,13 @@ int vb2_dqbuf(struct vb2_queue *q, struct v4l2_buffer *b, bool nonblocking);
* 2) passes any previously queued buffers to the driver and starts streaming * 2) passes any previously queued buffers to the driver and starts streaming
* *
* The return values from this function are intended to be directly returned * The return values from this function are intended to be directly returned
* from vidioc_streamon handler in the driver. * from &v4l2_ioctl_ops->vidioc_streamon handler in the driver.
*/ */
int vb2_streamon(struct vb2_queue *q, enum v4l2_buf_type type); int vb2_streamon(struct vb2_queue *q, enum v4l2_buf_type type);
/** /**
* vb2_streamoff - stop streaming * vb2_streamoff - stop streaming
* @q: videobuf2 queue * @q: pointer to &struct vb2_queue with videobuf2 queue.
* @type: type argument passed from userspace to vidioc_streamoff handler * @type: type argument passed from userspace to vidioc_streamoff handler
* *
* Should be called from vidioc_streamoff handler of a driver. * Should be called from vidioc_streamoff handler of a driver.
@ -186,7 +192,7 @@ int vb2_streamoff(struct vb2_queue *q, enum v4l2_buf_type type);
/** /**
* vb2_queue_init() - initialize a videobuf2 queue * vb2_queue_init() - initialize a videobuf2 queue
* @q: videobuf2 queue; this structure should be allocated in driver * @q: pointer to &struct vb2_queue with videobuf2 queue.
* *
* The vb2_queue structure should be allocated by the driver. The driver is * The vb2_queue structure should be allocated by the driver. The driver is
* responsible of clearing it's content and setting initial values for some * responsible of clearing it's content and setting initial values for some
@ -199,7 +205,7 @@ int __must_check vb2_queue_init(struct vb2_queue *q);
/** /**
* vb2_queue_release() - stop streaming, release the queue and free memory * vb2_queue_release() - stop streaming, release the queue and free memory
* @q: videobuf2 queue * @q: pointer to &struct vb2_queue with videobuf2 queue.
* *
* This function stops streaming and performs necessary clean ups, including * This function stops streaming and performs necessary clean ups, including
* freeing video buffer memory. The driver is responsible for freeing * freeing video buffer memory. The driver is responsible for freeing
@ -209,7 +215,7 @@ void vb2_queue_release(struct vb2_queue *q);
/** /**
* vb2_poll() - implements poll userspace operation * vb2_poll() - implements poll userspace operation
* @q: videobuf2 queue * @q: pointer to &struct vb2_queue with videobuf2 queue.
* @file: file argument passed to the poll file operation handler * @file: file argument passed to the poll file operation handler
* @wait: wait argument passed to the poll file operation handler * @wait: wait argument passed to the poll file operation handler
* *
@ -271,7 +277,7 @@ unsigned long vb2_fop_get_unmapped_area(struct file *file, unsigned long addr,
/** /**
* vb2_ops_wait_prepare - helper function to lock a struct &vb2_queue * vb2_ops_wait_prepare - helper function to lock a struct &vb2_queue
* *
* @vq: pointer to struct vb2_queue * @vq: pointer to &struct vb2_queue
* *
* ..note:: only use if vq->lock is non-NULL. * ..note:: only use if vq->lock is non-NULL.
*/ */
@ -280,7 +286,7 @@ void vb2_ops_wait_prepare(struct vb2_queue *vq);
/** /**
* vb2_ops_wait_finish - helper function to unlock a struct &vb2_queue * vb2_ops_wait_finish - helper function to unlock a struct &vb2_queue
* *
* @vq: pointer to struct vb2_queue * @vq: pointer to &struct vb2_queue
* *
* ..note:: only use if vq->lock is non-NULL. * ..note:: only use if vq->lock is non-NULL.
*/ */