Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

media: staging/media/meson: vdec.h: fix kerneldoc warnings

Fix a bunch of kernel-doc warnings:

drivers/staging/media/meson/vdec/esparser.h:22: warning: Function parameter or member 'core' not described in 'esparser_queue_eos'
drivers/staging/media/meson/vdec/esparser.h:22: warning: Function parameter or member 'data' not described in 'esparser_queue_eos'
drivers/staging/media/meson/vdec/esparser.h:22: warning: Function parameter or member 'len' not described in 'esparser_queue_eos'
drivers/staging/media/meson/vdec/esparser.h:28: warning: Function parameter or member 'work' not described in 'esparser_queue_all_src'
drivers/staging/media/meson/vdec/vdec.h:92: warning: Function parameter or member 'vdec_hevcf_clk' not described in 'amvdec_core'
drivers/staging/media/meson/vdec/vdec.h:92: warning: Function parameter or member 'vdev_dec' not described in 'amvdec_core'
drivers/staging/media/meson/vdec/vdec.h:92: warning: Function parameter or member 'lock' not described in 'amvdec_core'
drivers/staging/media/meson/vdec/vdec.h:141: warning: Function parameter or member 'resume' not described in 'amvdec_codec_ops'
drivers/staging/media/meson/vdec/vdec.h:274: warning: Function parameter or member 'lock' not described in 'amvdec_session'
drivers/staging/media/meson/vdec/vdec.h:274: warning: Function parameter or member 'sequence_out' not described in 'amvdec_session'
drivers/staging/media/meson/vdec/vdec.h:274: warning: Function parameter or member 'num_dst_bufs' not described in 'amvdec_session'
drivers/staging/media/meson/vdec/vdec.h:274: warning: Function parameter or member 'changed_format' not described in 'amvdec_session'
drivers/staging/media/meson/vdec/vdec.h:274: warning: Function parameter or member 'last_offset' not described in 'amvdec_session'
drivers/staging/media/meson/vdec/vdec.h:274: warning: Function parameter or member 'wrap_count' not described in 'amvdec_session'
drivers/staging/media/meson/vdec/vdec.h:274: warning: Function parameter or member 'fw_idx_to_vb2_idx' not described in 'amvdec_session'
drivers/staging/media/meson/vdec/vdec_helpers.h:59: warning: Function parameter or member 'tc' not described in 'amvdec_add_ts'
drivers/staging/media/meson/vdec/vdec_helpers.h:59: warning: Function parameter or member 'flags' not described in 'amvdec_add_ts'

Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

authored by

Hans Verkuil and committed by
Mauro Carvalho Chehab
9d45ccf7 7266dda2

+20 -5
+5 -1
drivers/staging/media/meson/vdec/esparser.h
··· 17 17 /** 18 18 * esparser_queue_eos() - write End Of Stream sequence to the ESPARSER 19 19 * 20 - * @core vdec core struct 20 + * @core: vdec core struct 21 + * @data: EOS sequence 22 + * @len: length of EOS sequence 21 23 */ 22 24 int esparser_queue_eos(struct amvdec_core *core, const u8 *data, u32 len); 23 25 24 26 /** 25 27 * esparser_queue_all_src() - work handler that writes as many src buffers 26 28 * as possible to the ESPARSER 29 + * 30 + * @work: work struct 27 31 */ 28 32 void esparser_queue_all_src(struct work_struct *work); 29 33
+13 -3
drivers/staging/media/meson/vdec/vdec.h
··· 60 60 * @dos_clk: DOS clock 61 61 * @vdec_1_clk: VDEC_1 clock 62 62 * @vdec_hevc_clk: VDEC_HEVC clock 63 + * @vdec_hevcf_clk: VDEC_HEVCF clock 63 64 * @esparser_reset: RESET for the PARSER 64 - * @vdec_dec: video device for the decoder 65 + * @vdev_dec: video device for the decoder 65 66 * @v4l2_dev: v4l2 device 66 67 * @cur_sess: current decoding session 68 + * @lock: video device lock 67 69 */ 68 70 struct amvdec_core { 69 71 void __iomem *dos_base; ··· 90 88 struct v4l2_device v4l2_dev; 91 89 92 90 struct amvdec_session *cur_sess; 93 - struct mutex lock; /* video device lock */ 91 + struct mutex lock; 94 92 }; 95 93 96 94 /** ··· 122 120 * @recycle: optional call to tell the codec to recycle a dst buffer. Must go 123 121 * in pair with @can_recycle 124 122 * @drain: optional call if the codec has a custom way of draining 123 + * @resume: optional call to resume after a resolution change 125 124 * @eos_sequence: optional call to get an end sequence to send to esparser 126 125 * for flush. Mutually exclusive with @drain. 127 126 * @isr: mandatory call when the ISR triggers ··· 188 185 * @m2m_ctx: v4l2 m2m context 189 186 * @ctrl_handler: V4L2 control handler 190 187 * @ctrl_min_buf_capture: V4L2 control V4L2_CID_MIN_BUFFERS_FOR_CAPTURE 188 + * @lock: cap & out queues lock 191 189 * @fmt_out: vdec pixel format for the OUTPUT queue 192 190 * @pixfmt_cap: V4L2 pixel format for the CAPTURE queue 193 191 * @src_buffer_size: size in bytes of the OUTPUT buffers' only plane ··· 204 200 * @streamon_cap: stream on flag for capture queue 205 201 * @streamon_out: stream on flag for output queue 206 202 * @sequence_cap: capture sequence counter 203 + * @sequence_out: output sequence counter 207 204 * @should_stop: flag set if userspace signaled EOS via command 208 205 * or empty buffer 209 206 * @keyframe_found: flag set once a keyframe has been parsed 207 + * @num_dst_bufs: number of destination buffers 208 + * @changed_format: the format changed 210 209 * @canvas_alloc: array of all the canvas IDs allocated 211 210 * @canvas_num: number of canvas IDs allocated 212 211 * @vififo_vaddr: virtual address for the VIFIFO ··· 221 214 * @timestamps: chronological list of src timestamps 222 215 * @ts_spinlock: spinlock for the timestamps list 223 216 * @last_irq_jiffies: tracks last time the vdec triggered an IRQ 217 + * @last_offset: tracks last offset of vififo 218 + * @wrap_count: number of times the vififo wrapped around 219 + * @fw_idx_to_vb2_idx: firmware buffer index to vb2 buffer index 224 220 * @status: current decoding status 225 221 * @priv: codec private data 226 222 */ ··· 235 225 struct v4l2_m2m_ctx *m2m_ctx; 236 226 struct v4l2_ctrl_handler ctrl_handler; 237 227 struct v4l2_ctrl *ctrl_min_buf_capture; 238 - struct mutex lock; /* cap & out queues lock */ 228 + struct mutex lock; 239 229 240 230 const struct amvdec_format *fmt_out; 241 231 u32 pixfmt_cap;
+2 -1
drivers/staging/media/meson/vdec/vdec_helpers.h
··· 52 52 * 53 53 * @sess: current session 54 54 * @ts: timestamp to add 55 + * @tc: timecode to add 55 56 * @offset: offset in the VIFIFO where the associated packet was written 56 - * @flags the vb2_v4l2_buffer flags 57 + * @flags: the vb2_v4l2_buffer flags 57 58 */ 58 59 void amvdec_add_ts(struct amvdec_session *sess, u64 ts, 59 60 struct v4l2_timecode tc, u32 offset, u32 flags);