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

Commit 62c0d016 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

[media] Docbook: Fix comments at v4l2-mem2mem.h 



Warning(.//include/media/v4l2-mem2mem.h:50): No description found for parameter 'lock'
Warning(.//include/media/v4l2-mem2mem.h:50): No description found for parameter 'unlock'
Warning(.//include/media/v4l2-mem2mem.h:167): No description found for parameter 'm2m_ctx'
Warning(.//include/media/v4l2-mem2mem.h:177): No description found for parameter 'm2m_ctx'
Warning(.//include/media/v4l2-mem2mem.h:188): No description found for parameter 'm2m_ctx'
Warning(.//include/media/v4l2-mem2mem.h:197): No description found for parameter 'm2m_ctx'
Warning(.//include/media/v4l2-mem2mem.h:206): No description found for parameter 'm2m_ctx'
Warning(.//include/media/v4l2-mem2mem.h:215): No description found for parameter 'm2m_ctx'
Warning(.//include/media/v4l2-mem2mem.h:226): No description found for parameter 'm2m_ctx'
Warning(.//include/media/v4l2-mem2mem.h:235): No description found for parameter 'm2m_ctx'

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@osg.samsung.com>
Acked-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 62ba6b22

include/media/v4l2-mem2mem.h

+20 −0
Original line number Diff line number Diff line
@@ -40,6 +40,10 @@ 
 *		v4l2_m2m_job_finish() (as if the transaction ended normally).

 *		This function does not have to (and will usually not) wait

 *		until the device enters a state when it can be stopped.

 * @lock:	optional. Define a driver's own lock callback, instead of using

 *		m2m_ctx->q_lock.

 * @unlock:	optional. Define a driver's own unlock callback, instead of

 *		using m2m_ctx->q_lock.

 */

struct v4l2_m2m_ops {

	void (*device_run)(void *priv);
@@ -161,6 +165,8 @@ void v4l2_m2m_buf_queue(struct v4l2_m2m_ctx *m2m_ctx, struct vb2_buffer *vb); 
/**

 * v4l2_m2m_num_src_bufs_ready() - return the number of source buffers ready for

 * use

 *

 * @m2m_ctx: pointer to struct v4l2_m2m_ctx

 */

static inline

unsigned int v4l2_m2m_num_src_bufs_ready(struct v4l2_m2m_ctx *m2m_ctx)
@@ -171,6 +177,8 @@ unsigned int v4l2_m2m_num_src_bufs_ready(struct v4l2_m2m_ctx *m2m_ctx) 
/**

 * v4l2_m2m_num_src_bufs_ready() - return the number of destination buffers

 * ready for use

 *

 * @m2m_ctx: pointer to struct v4l2_m2m_ctx

 */

static inline

unsigned int v4l2_m2m_num_dst_bufs_ready(struct v4l2_m2m_ctx *m2m_ctx)
@@ -183,6 +191,8 @@ void *v4l2_m2m_next_buf(struct v4l2_m2m_queue_ctx *q_ctx); 
/**

 * v4l2_m2m_next_src_buf() - return next source buffer from the list of ready

 * buffers

 *

 * @m2m_ctx: pointer to struct v4l2_m2m_ctx

 */

static inline void *v4l2_m2m_next_src_buf(struct v4l2_m2m_ctx *m2m_ctx)

{
@@ -192,6 +202,8 @@ static inline void *v4l2_m2m_next_src_buf(struct v4l2_m2m_ctx *m2m_ctx) 
/**

 * v4l2_m2m_next_dst_buf() - return next destination buffer from the list of

 * ready buffers

 *

 * @m2m_ctx: pointer to struct v4l2_m2m_ctx

 */

static inline void *v4l2_m2m_next_dst_buf(struct v4l2_m2m_ctx *m2m_ctx)

{
@@ -200,6 +212,8 @@ static inline void *v4l2_m2m_next_dst_buf(struct v4l2_m2m_ctx *m2m_ctx) 


/**

 * v4l2_m2m_get_src_vq() - return vb2_queue for source buffers

 *

 * @m2m_ctx: pointer to struct v4l2_m2m_ctx

 */

static inline

struct vb2_queue *v4l2_m2m_get_src_vq(struct v4l2_m2m_ctx *m2m_ctx)
@@ -209,6 +223,8 @@ struct vb2_queue *v4l2_m2m_get_src_vq(struct v4l2_m2m_ctx *m2m_ctx) 


/**

 * v4l2_m2m_get_dst_vq() - return vb2_queue for destination buffers

 *

 * @m2m_ctx: pointer to struct v4l2_m2m_ctx

 */

static inline

struct vb2_queue *v4l2_m2m_get_dst_vq(struct v4l2_m2m_ctx *m2m_ctx)
@@ -221,6 +237,8 @@ void *v4l2_m2m_buf_remove(struct v4l2_m2m_queue_ctx *q_ctx); 
/**

 * v4l2_m2m_src_buf_remove() - take off a source buffer from the list of ready

 * buffers and return it

 *

 * @m2m_ctx: pointer to struct v4l2_m2m_ctx

 */

static inline void *v4l2_m2m_src_buf_remove(struct v4l2_m2m_ctx *m2m_ctx)

{
@@ -230,6 +248,8 @@ static inline void *v4l2_m2m_src_buf_remove(struct v4l2_m2m_ctx *m2m_ctx) 
/**

 * v4l2_m2m_dst_buf_remove() - take off a destination buffer from the list of

 * ready buffers and return it

 *

 * @m2m_ctx: pointer to struct v4l2_m2m_ctx

 */

static inline void *v4l2_m2m_dst_buf_remove(struct v4l2_m2m_ctx *m2m_ctx)

{