media: hantro: fix kernel-doc warnings and style

Add a description for enum values in hantro_enc_fmt,
in order to fix these warnings:

drivers/staging/media/hantro/hantro_hw.h:149: warning: Enum value 'RK3288_VPU_ENC_FMT_YUV420P' not described in enum 'hantro_enc_fmt'
drivers/staging/media/hantro/hantro_hw.h:149: warning: Enum value 'RK3288_VPU_ENC_FMT_YUV420SP' not described in enum 'hantro_enc_fmt'
drivers/staging/media/hantro/hantro_hw.h:149: warning: Enum value 'RK3288_VPU_ENC_FMT_YUYV422' not described in enum 'hantro_enc_fmt'
drivers/staging/media/hantro/hantro_hw.h:149: warning: Enum value 'RK3288_VPU_ENC_FMT_UYVY422' not described in enum 'hantro_enc_fmt'

While here, improve the kernel-doc style, adding an empty
line before the fields of the structs.

Signed-off-by: Ezequiel Garcia <ezequiel@collabora.com>
Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
This commit is contained in:
Ezequiel Garcia 2021-03-23 13:07:46 +01:00 committed by Mauro Carvalho Chehab
parent d75b32853d
commit 5cd255e726
1 changed files with 12 additions and 0 deletions

View File

@ -27,6 +27,7 @@ struct hantro_variant;
/** /**
* struct hantro_aux_buf - auxiliary DMA buffer for hardware data * struct hantro_aux_buf - auxiliary DMA buffer for hardware data
*
* @cpu: CPU pointer to the buffer. * @cpu: CPU pointer to the buffer.
* @dma: DMA address of the buffer. * @dma: DMA address of the buffer.
* @size: Size of the buffer. * @size: Size of the buffer.
@ -41,6 +42,7 @@ struct hantro_aux_buf {
/** /**
* struct hantro_jpeg_enc_hw_ctx * struct hantro_jpeg_enc_hw_ctx
*
* @bounce_buffer: Bounce buffer * @bounce_buffer: Bounce buffer
*/ */
struct hantro_jpeg_enc_hw_ctx { struct hantro_jpeg_enc_hw_ctx {
@ -52,6 +54,7 @@ struct hantro_jpeg_enc_hw_ctx {
/** /**
* struct hantro_h264_dec_ctrls * struct hantro_h264_dec_ctrls
*
* @decode: Decode params * @decode: Decode params
* @scaling: Scaling info * @scaling: Scaling info
* @sps: SPS info * @sps: SPS info
@ -66,6 +69,7 @@ struct hantro_h264_dec_ctrls {
/** /**
* struct hantro_h264_dec_reflists * struct hantro_h264_dec_reflists
*
* @p: P reflist * @p: P reflist
* @b0: B0 reflist * @b0: B0 reflist
* @b1: B1 reflist * @b1: B1 reflist
@ -78,6 +82,7 @@ struct hantro_h264_dec_reflists {
/** /**
* struct hantro_h264_dec_hw_ctx * struct hantro_h264_dec_hw_ctx
*
* @priv: Private auxiliary buffer for hardware. * @priv: Private auxiliary buffer for hardware.
* @dpb: DPB * @dpb: DPB
* @reflists: P/B0/B1 reflists * @reflists: P/B0/B1 reflists
@ -92,6 +97,7 @@ struct hantro_h264_dec_hw_ctx {
/** /**
* struct hantro_mpeg2_dec_hw_ctx * struct hantro_mpeg2_dec_hw_ctx
*
* @qtable: Quantization table * @qtable: Quantization table
*/ */
struct hantro_mpeg2_dec_hw_ctx { struct hantro_mpeg2_dec_hw_ctx {
@ -100,6 +106,7 @@ struct hantro_mpeg2_dec_hw_ctx {
/** /**
* struct hantro_vp8_dec_hw_ctx * struct hantro_vp8_dec_hw_ctx
*
* @segment_map: Segment map buffer. * @segment_map: Segment map buffer.
* @prob_tbl: Probability table buffer. * @prob_tbl: Probability table buffer.
*/ */
@ -140,6 +147,11 @@ struct hantro_codec_ops {
/** /**
* enum hantro_enc_fmt - source format ID for hardware registers. * enum hantro_enc_fmt - source format ID for hardware registers.
*
* @RK3288_VPU_ENC_FMT_YUV420P: Y/CbCr 4:2:0 planar format
* @RK3288_VPU_ENC_FMT_YUV420SP: Y/CbCr 4:2:0 semi-planar format
* @RK3288_VPU_ENC_FMT_YUYV422: YUV 4:2:2 packed format (YUYV)
* @RK3288_VPU_ENC_FMT_UYVY422: YUV 4:2:2 packed format (UYVY)
*/ */
enum hantro_enc_fmt { enum hantro_enc_fmt {
RK3288_VPU_ENC_FMT_YUV420P = 0, RK3288_VPU_ENC_FMT_YUV420P = 0,