kpriv/linux-hardened
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

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

Browse source 
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: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Acked-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Mauro Carvalho Chehab 2015-08-22 05:34:40 -03:00
parent 62ba6b22f4
commit 62c0d016da
1 changed files with 20 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
include/media/v4l2-mem2mem.h
View file

@ -40,6 +40,10 @@
* v4l2_m2m_job_finish() (as if the transaction ended normally). * v4l2_m2m_job_finish() (as if the transaction ended normally).
* This function does not have to (and will usually not) wait * This function does not have to (and will usually not) wait
* until the device enters a state when it can be stopped. * 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 { struct v4l2_m2m_ops {
void (*device_run)(void *priv); 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 * v4l2_m2m_num_src_bufs_ready() - return the number of source buffers ready for
* use * use
*
* @m2m_ctx: pointer to struct v4l2_m2m_ctx
*/ */
static inline static inline
unsigned int v4l2_m2m_num_src_bufs_ready(struct v4l2_m2m_ctx *m2m_ctx) 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 * v4l2_m2m_num_src_bufs_ready() - return the number of destination buffers
* ready for use * ready for use
*
* @m2m_ctx: pointer to struct v4l2_m2m_ctx
*/ */
static inline static inline
unsigned int v4l2_m2m_num_dst_bufs_ready(struct v4l2_m2m_ctx *m2m_ctx) 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 * v4l2_m2m_next_src_buf() - return next source buffer from the list of ready
* buffers * buffers
*
* @m2m_ctx: pointer to struct v4l2_m2m_ctx
*/ */
static inline void *v4l2_m2m_next_src_buf(struct v4l2_m2m_ctx *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 * v4l2_m2m_next_dst_buf() - return next destination buffer from the list of
* ready buffers * ready buffers
*
* @m2m_ctx: pointer to struct v4l2_m2m_ctx
*/ */
static inline void *v4l2_m2m_next_dst_buf(struct v4l2_m2m_ctx *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 * v4l2_m2m_get_src_vq() - return vb2_queue for source buffers
*
* @m2m_ctx: pointer to struct v4l2_m2m_ctx
*/ */
static inline static inline
struct vb2_queue *v4l2_m2m_get_src_vq(struct v4l2_m2m_ctx *m2m_ctx) 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 * v4l2_m2m_get_dst_vq() - return vb2_queue for destination buffers
*
* @m2m_ctx: pointer to struct v4l2_m2m_ctx
*/ */
static inline static inline
struct vb2_queue *v4l2_m2m_get_dst_vq(struct v4l2_m2m_ctx *m2m_ctx) 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 * v4l2_m2m_src_buf_remove() - take off a source buffer from the list of ready
* buffers and return it * 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) 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 * v4l2_m2m_dst_buf_remove() - take off a destination buffer from the list of
* ready buffers and return it * 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) static inline void *v4l2_m2m_dst_buf_remove(struct v4l2_m2m_ctx *m2m_ctx)
{ {