Commit 493ae3f2 authored by Hans Verkuil's avatar Hans Verkuil Committed by Mauro Carvalho Chehab

media: mtk-vcodec: fix kerneldoc warnings

Fix the following kerneldoc warnings:

drivers/media/platform/mtk-vcodec/venc_ipi_msg.h:31: warning: Enum value 'AP_IPIMSG_ENC_INIT' not described in enum 'venc_ipi_msg_id'
drivers/media/platform/mtk-vcodec/venc_ipi_msg.h:31: warning: Enum value 'AP_IPIMSG_ENC_SET_PARAM' not described in enum 'venc_ipi_msg_id'
drivers/media/platform/mtk-vcodec/venc_ipi_msg.h:31: warning: Enum value 'AP_IPIMSG_ENC_ENCODE' not described in enum 'venc_ipi_msg_id'
drivers/media/platform/mtk-vcodec/venc_ipi_msg.h:31: warning: Enum value 'AP_IPIMSG_ENC_DEINIT' not described in enum 'venc_ipi_msg_id'
drivers/media/platform/mtk-vcodec/venc_ipi_msg.h:31: warning: Enum value 'VPU_IPIMSG_ENC_INIT_DONE' not described in enum 'venc_ipi_msg_id'
drivers/media/platform/mtk-vcodec/venc_ipi_msg.h:31: warning: Enum value 'VPU_IPIMSG_ENC_SET_PARAM_DONE' not described in enum 'venc_ipi_msg_id'
drivers/media/platform/mtk-vcodec/venc_ipi_msg.h:31: warning: Enum value 'VPU_IPIMSG_ENC_ENCODE_DONE' not described in enum 'venc_ipi_msg_id'
drivers/media/platform/mtk-vcodec/venc_ipi_msg.h:31: warning: Enum value 'VPU_IPIMSG_ENC_DEINIT_DONE' not described in enum 'venc_ipi_msg_id'
drivers/media/platform/mtk-vcodec/venc_ipi_msg.h:31: warning: Excess enum value 'VPU_IPIMSG_ENC_XXX_DONE' description in 'venc_ipi_msg_id'
drivers/media/platform/mtk-vcodec/venc_ipi_msg.h:31: warning: Excess enum value 'AP_IPIMSG_ENC_XXX' description in 'venc_ipi_msg_id'
drivers/media/platform/mtk-vcodec/venc_ipi_msg.h:120: warning: Enum value 'VENC_IPI_MSG_STATUS_OK' not described in enum 'venc_ipi_msg_status'
drivers/media/platform/mtk-vcodec/venc_ipi_msg.h:120: warning: Enum value 'VENC_IPI_MSG_STATUS_FAIL' not described in enum 'venc_ipi_msg_status'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:50: warning: Enum value 'VDEC_SYS' not described in enum 'mtk_hw_reg_idx'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:50: warning: Enum value 'VDEC_MISC' not described in enum 'mtk_hw_reg_idx'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:50: warning: Enum value 'VDEC_LD' not described in enum 'mtk_hw_reg_idx'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:50: warning: Enum value 'VDEC_TOP' not described in enum 'mtk_hw_reg_idx'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:50: warning: Enum value 'VDEC_CM' not described in enum 'mtk_hw_reg_idx'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:50: warning: Enum value 'VDEC_AD' not described in enum 'mtk_hw_reg_idx'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:50: warning: Enum value 'VDEC_AV' not described in enum 'mtk_hw_reg_idx'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:50: warning: Enum value 'VDEC_PP' not described in enum 'mtk_hw_reg_idx'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:50: warning: Enum value 'VDEC_HWD' not described in enum 'mtk_hw_reg_idx'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:50: warning: Enum value 'VDEC_HWQ' not described in enum 'mtk_hw_reg_idx'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:50: warning: Enum value 'VDEC_HWB' not described in enum 'mtk_hw_reg_idx'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:50: warning: Enum value 'VDEC_HWG' not described in enum 'mtk_hw_reg_idx'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:50: warning: Enum value 'NUM_MAX_VDEC_REG_BASE' not described in enum 'mtk_hw_reg_idx'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:50: warning: Enum value 'VENC_SYS' not described in enum 'mtk_hw_reg_idx'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:50: warning: Enum value 'VENC_LT_SYS' not described in enum 'mtk_hw_reg_idx'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:50: warning: Enum value 'NUM_MAX_VCODEC_REG_BASE' not described in enum 'mtk_hw_reg_idx'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:58: warning: Enum value 'MTK_INST_DECODER' not described in enum 'mtk_instance_type'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:58: warning: Enum value 'MTK_INST_ENCODER' not described in enum 'mtk_instance_type'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:87: warning: Enum value 'MTK_ENCODE_PARAM_NONE' not described in enum 'mtk_encode_param'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:87: warning: Enum value 'MTK_ENCODE_PARAM_BITRATE' not described in enum 'mtk_encode_param'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:87: warning: Enum value 'MTK_ENCODE_PARAM_FRAMERATE' not described in enum 'mtk_encode_param'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:87: warning: Enum value 'MTK_ENCODE_PARAM_INTRA_PERIOD' not described in enum
'mtk_encode_param'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:87: warning: Enum value 'MTK_ENCODE_PARAM_FORCE_INTRA' not described in enum
'mtk_encode_param'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:87: warning: Enum value 'MTK_ENCODE_PARAM_GOP_SIZE' not described in enum 'mtk_encode_param'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:103: warning: Function parameter or member 'fourcc' not described in 'mtk_video_fmt'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:103: warning: Function parameter or member 'type' not described in 'mtk_video_fmt'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:103: warning: Function parameter or member 'num_planes' not described in 'mtk_video_fmt'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:103: warning: Function parameter or member 'flags' not described in 'mtk_video_fmt'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:112: warning: Function parameter or member 'fourcc' not described in 'mtk_codec_framesizes'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:112: warning: Function parameter or member 'stepwise' not described in 'mtk_codec_framesizes'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:120: warning: Enum value 'MTK_Q_DATA_SRC' not described in enum 'mtk_q_type'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:120: warning: Enum value 'MTK_Q_DATA_DST' not described in enum 'mtk_q_type'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:134: warning: Function parameter or member 'visible_width' not described in 'mtk_q_data'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:134: warning: Function parameter or member 'visible_height' not described in 'mtk_q_data'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:134: warning: Function parameter or member 'coded_width' not described in 'mtk_q_data'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:134: warning: Function parameter or member 'coded_height' not described in 'mtk_q_data'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:134: warning: Function parameter or member 'field' not described in 'mtk_q_data'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:134: warning: Function parameter or member 'bytesperline' not described in 'mtk_q_data'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:134: warning: Function parameter or member 'sizeimage' not described in 'mtk_q_data'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:134: warning: Function parameter or member 'fmt' not described in 'mtk_q_data'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:177: warning: Function parameter or member 'clk_name' not described in 'mtk_vcodec_clk_info'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:177: warning: Function parameter or member 'vcodec_clk' not described in
'mtk_vcodec_clk_info'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:185: warning: Function parameter or member 'clk_info' not described in 'mtk_vcodec_clk'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:185: warning: Function parameter or member 'clk_num' not described in 'mtk_vcodec_clk'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:198: warning: Function parameter or member 'vdec_clk' not described in 'mtk_vcodec_pm'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:198: warning: Function parameter or member 'larbvdec' not described in 'mtk_vcodec_pm'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:198: warning: Function parameter or member 'venc_clk' not described in 'mtk_vcodec_pm'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:198: warning: Function parameter or member 'larbvenc' not described in 'mtk_vcodec_pm'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:198: warning: Function parameter or member 'dev' not described in 'mtk_vcodec_pm'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:198: warning: Function parameter or member 'mtkdev' not described in 'mtk_vcodec_pm'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:300: warning: Function parameter or member 'decoded_frame_cnt' not described in
'mtk_vcodec_ctx'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:332: warning: Function parameter or member 'min_bitrate' not described in
'mtk_vcodec_enc_pdata'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:405: warning: Function parameter or member 'venc_pdata' not described in 'mtk_vcodec_dev'
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h:405: warning: Function parameter or member 'decode_workqueue' not described in
'mtk_vcodec_dev'
drivers/media/platform/mtk-vcodec/vdec_ipi_msg.h:27: warning: Enum value 'AP_IPIMSG_DEC_INIT' not described in enum 'vdec_ipi_msgid'
drivers/media/platform/mtk-vcodec/vdec_ipi_msg.h:27: warning: Enum value 'AP_IPIMSG_DEC_START' not described in enum 'vdec_ipi_msgid'
drivers/media/platform/mtk-vcodec/vdec_ipi_msg.h:27: warning: Enum value 'AP_IPIMSG_DEC_END' not described in enum 'vdec_ipi_msgid'
drivers/media/platform/mtk-vcodec/vdec_ipi_msg.h:27: warning: Enum value 'AP_IPIMSG_DEC_DEINIT' not described in enum 'vdec_ipi_msgid'
drivers/media/platform/mtk-vcodec/vdec_ipi_msg.h:27: warning: Enum value 'AP_IPIMSG_DEC_RESET' not described in enum 'vdec_ipi_msgid'
drivers/media/platform/mtk-vcodec/vdec_ipi_msg.h:27: warning: Enum value 'VPU_IPIMSG_DEC_INIT_ACK' not described in enum 'vdec_ipi_msgid'
drivers/media/platform/mtk-vcodec/vdec_ipi_msg.h:27: warning: Enum value 'VPU_IPIMSG_DEC_START_ACK' not described in enum 'vdec_ipi_msgid'
drivers/media/platform/mtk-vcodec/vdec_ipi_msg.h:27: warning: Enum value 'VPU_IPIMSG_DEC_END_ACK' not described in enum 'vdec_ipi_msgid'
drivers/media/platform/mtk-vcodec/vdec_ipi_msg.h:27: warning: Enum value 'VPU_IPIMSG_DEC_DEINIT_ACK' not described in enum 'vdec_ipi_msgid'
drivers/media/platform/mtk-vcodec/vdec_ipi_msg.h:27: warning: Enum value 'VPU_IPIMSG_DEC_RESET_ACK' not described in enum 'vdec_ipi_msgid'
drivers/media/platform/mtk-vcodec/vdec_ipi_msg.h:27: warning: Excess enum value 'AP_IPIMSG_XXX' description in 'vdec_ipi_msgid'
drivers/media/platform/mtk-vcodec/vdec_ipi_msg.h:27: warning: Excess enum value 'VPU_IPIMSG_XXX_ACK' description in 'vdec_ipi_msgid'

In some cases I just changed /** to /*, in other cases the missing
field descriptions were added.
Signed-off-by: default avatarHans Verkuil <hverkuil-cisco@xs4all.nl>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
parent 7629cbd6
...@@ -25,7 +25,7 @@ ...@@ -25,7 +25,7 @@
#define MTK_V4L2_BENCHMARK 0 #define MTK_V4L2_BENCHMARK 0
#define WAIT_INTR_TIMEOUT_MS 1000 #define WAIT_INTR_TIMEOUT_MS 1000
/** /*
* enum mtk_hw_reg_idx - MTK hw register base index * enum mtk_hw_reg_idx - MTK hw register base index
*/ */
enum mtk_hw_reg_idx { enum mtk_hw_reg_idx {
...@@ -49,7 +49,7 @@ enum mtk_hw_reg_idx { ...@@ -49,7 +49,7 @@ enum mtk_hw_reg_idx {
NUM_MAX_VCODEC_REG_BASE NUM_MAX_VCODEC_REG_BASE
}; };
/** /*
* enum mtk_instance_type - The type of an MTK Vcodec instance. * enum mtk_instance_type - The type of an MTK Vcodec instance.
*/ */
enum mtk_instance_type { enum mtk_instance_type {
...@@ -74,7 +74,7 @@ enum mtk_instance_state { ...@@ -74,7 +74,7 @@ enum mtk_instance_state {
MTK_STATE_ABORT = 4, MTK_STATE_ABORT = 4,
}; };
/** /*
* enum mtk_encode_param - General encoding parameters type * enum mtk_encode_param - General encoding parameters type
*/ */
enum mtk_encode_param { enum mtk_encode_param {
...@@ -92,7 +92,7 @@ enum mtk_fmt_type { ...@@ -92,7 +92,7 @@ enum mtk_fmt_type {
MTK_FMT_FRAME = 2, MTK_FMT_FRAME = 2,
}; };
/** /*
* struct mtk_video_fmt - Structure used to store information about pixelformats * struct mtk_video_fmt - Structure used to store information about pixelformats
*/ */
struct mtk_video_fmt { struct mtk_video_fmt {
...@@ -102,7 +102,7 @@ struct mtk_video_fmt { ...@@ -102,7 +102,7 @@ struct mtk_video_fmt {
u32 flags; u32 flags;
}; };
/** /*
* struct mtk_codec_framesizes - Structure used to store information about * struct mtk_codec_framesizes - Structure used to store information about
* framesizes * framesizes
*/ */
...@@ -111,7 +111,7 @@ struct mtk_codec_framesizes { ...@@ -111,7 +111,7 @@ struct mtk_codec_framesizes {
struct v4l2_frmsize_stepwise stepwise; struct v4l2_frmsize_stepwise stepwise;
}; };
/** /*
* enum mtk_q_type - Type of queue * enum mtk_q_type - Type of queue
*/ */
enum mtk_q_type { enum mtk_q_type {
...@@ -119,7 +119,7 @@ enum mtk_q_type { ...@@ -119,7 +119,7 @@ enum mtk_q_type {
MTK_Q_DATA_DST = 1, MTK_Q_DATA_DST = 1,
}; };
/** /*
* struct mtk_q_data - Structure used to store information about queue * struct mtk_q_data - Structure used to store information about queue
*/ */
struct mtk_q_data { struct mtk_q_data {
...@@ -168,7 +168,7 @@ struct mtk_enc_params { ...@@ -168,7 +168,7 @@ struct mtk_enc_params {
unsigned int force_intra; unsigned int force_intra;
}; };
/** /*
* struct mtk_vcodec_clk_info - Structure used to store clock name * struct mtk_vcodec_clk_info - Structure used to store clock name
*/ */
struct mtk_vcodec_clk_info { struct mtk_vcodec_clk_info {
...@@ -176,7 +176,7 @@ struct mtk_vcodec_clk_info { ...@@ -176,7 +176,7 @@ struct mtk_vcodec_clk_info {
struct clk *vcodec_clk; struct clk *vcodec_clk;
}; };
/** /*
* struct mtk_vcodec_clk - Structure used to store vcodec clock information * struct mtk_vcodec_clk - Structure used to store vcodec clock information
*/ */
struct mtk_vcodec_clk { struct mtk_vcodec_clk {
...@@ -184,7 +184,7 @@ struct mtk_vcodec_clk { ...@@ -184,7 +184,7 @@ struct mtk_vcodec_clk {
int clk_num; int clk_num;
}; };
/** /*
* struct mtk_vcodec_pm - Power management data structure * struct mtk_vcodec_pm - Power management data structure
*/ */
struct mtk_vcodec_pm { struct mtk_vcodec_pm {
...@@ -255,6 +255,7 @@ struct vdec_pic_info { ...@@ -255,6 +255,7 @@ struct vdec_pic_info {
* @ycbcr_enc: enum v4l2_ycbcr_encoding, Y'CbCr encoding * @ycbcr_enc: enum v4l2_ycbcr_encoding, Y'CbCr encoding
* @quantization: enum v4l2_quantization, colorspace quantization * @quantization: enum v4l2_quantization, colorspace quantization
* @xfer_func: enum v4l2_xfer_func, colorspace transfer function * @xfer_func: enum v4l2_xfer_func, colorspace transfer function
* @decoded_frame_cnt: number of decoded frames
* @lock: protect variables accessed by V4L2 threads and worker thread such as * @lock: protect variables accessed by V4L2 threads and worker thread such as
* mtk_video_dec_buf. * mtk_video_dec_buf.
*/ */
...@@ -311,7 +312,7 @@ enum mtk_chip { ...@@ -311,7 +312,7 @@ enum mtk_chip {
* @chip: chip this encoder is compatible with * @chip: chip this encoder is compatible with
* *
* @uses_ext: whether the encoder uses the extended firmware messaging format * @uses_ext: whether the encoder uses the extended firmware messaging format
* @min_birate: minimum supported encoding bitrate * @min_bitrate: minimum supported encoding bitrate
* @max_bitrate: maximum supported encoding bitrate * @max_bitrate: maximum supported encoding bitrate
* @capture_formats: array of supported capture formats * @capture_formats: array of supported capture formats
* @num_capture_formats: number of entries in capture_formats * @num_capture_formats: number of entries in capture_formats
...@@ -348,10 +349,12 @@ struct mtk_vcodec_enc_pdata { ...@@ -348,10 +349,12 @@ struct mtk_vcodec_enc_pdata {
* @curr_ctx: The context that is waiting for codec hardware * @curr_ctx: The context that is waiting for codec hardware
* *
* @reg_base: Mapped address of MTK Vcodec registers. * @reg_base: Mapped address of MTK Vcodec registers.
* @venc_pdata: encoder IC-specific data
* *
* @fw_handler: used to communicate with the firmware. * @fw_handler: used to communicate with the firmware.
* @id_counter: used to identify current opened instance * @id_counter: used to identify current opened instance
* *
* @decode_workqueue: decode work queue
* @encode_workqueue: encode work queue * @encode_workqueue: encode work queue
* *
* @int_cond: used to identify interrupt condition happen * @int_cond: used to identify interrupt condition happen
......
...@@ -7,7 +7,7 @@ ...@@ -7,7 +7,7 @@
#ifndef _VDEC_IPI_MSG_H_ #ifndef _VDEC_IPI_MSG_H_
#define _VDEC_IPI_MSG_H_ #define _VDEC_IPI_MSG_H_
/** /*
* enum vdec_ipi_msgid - message id between AP and VPU * enum vdec_ipi_msgid - message id between AP and VPU
* @AP_IPIMSG_XXX : AP to VPU cmd message id * @AP_IPIMSG_XXX : AP to VPU cmd message id
* @VPU_IPIMSG_XXX_ACK : VPU ack AP cmd message id * @VPU_IPIMSG_XXX_ACK : VPU ack AP cmd message id
......
...@@ -12,7 +12,7 @@ ...@@ -12,7 +12,7 @@
#define AP_IPIMSG_VENC_BASE 0xC000 #define AP_IPIMSG_VENC_BASE 0xC000
#define VPU_IPIMSG_VENC_BASE 0xD000 #define VPU_IPIMSG_VENC_BASE 0xD000
/** /*
* enum venc_ipi_msg_id - message id between AP and VPU * enum venc_ipi_msg_id - message id between AP and VPU
* (ipi stands for inter-processor interrupt) * (ipi stands for inter-processor interrupt)
* @AP_IPIMSG_ENC_XXX: AP to VPU cmd message id * @AP_IPIMSG_ENC_XXX: AP to VPU cmd message id
...@@ -111,7 +111,7 @@ struct venc_ap_ipi_msg_deinit { ...@@ -111,7 +111,7 @@ struct venc_ap_ipi_msg_deinit {
uint32_t vpu_inst_addr; uint32_t vpu_inst_addr;
}; };
/** /*
* enum venc_ipi_msg_status - VPU ack AP cmd status * enum venc_ipi_msg_status - VPU ack AP cmd status
*/ */
enum venc_ipi_msg_status { enum venc_ipi_msg_status {
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment