media: mtk-vcodec: fix kernel-doc warnings

mtk_vcodec_drv.h:
	It's '@var:', not '@var - '.
	In two places 'struct' was used instead of 'enum'.

vdec_drv_if.h:
	It's '@var:', not '@var :'.
	In one place 'struct' was used instead of 'enum'.

venc_ipi_msg.h:
	It's '@data:', not '@data[8]:', i.e. arrays do not include the
	size in kernel-doc.
	It's '@var:', not 'var:'.

Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
Cc: Alexandre Courbot <acourbot@chromium.org>
Cc: Tiffany Lin <tiffany.lin@mediatek.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

diff --git a/drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h b/drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h
index 3dd010cba23e541f12f2e6117e3ce13d6597887a..43be6b5a405ac205703680350a9a1897ac31dc4f 100644 (file)
--- a/drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h
+++ b/drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h
@@ -59,12 +59,12 @@ enum mtk_instance_type {
 
 /**
  * enum mtk_instance_state - The state of an MTK Vcodec instance.
- * @MTK_STATE_FREE - default state when instance is created
- * @MTK_STATE_INIT - vcodec instance is initialized
- * @MTK_STATE_HEADER - vdec had sps/pps header parsed or venc
+ * @MTK_STATE_FREE: default state when instance is created
+ * @MTK_STATE_INIT: vcodec instance is initialized
+ * @MTK_STATE_HEADER: vdec had sps/pps header parsed or venc
  *                     had sps/pps header encoded
- * @MTK_STATE_FLUSH - vdec is flushing. Only used by decoder
- * @MTK_STATE_ABORT - vcodec should be aborted
+ * @MTK_STATE_FLUSH: vdec is flushing. Only used by decoder
+ * @MTK_STATE_ABORT: vcodec should be aborted
  */
 enum mtk_instance_state {
        MTK_STATE_FREE = 0,
@@ -75,7 +75,7 @@ enum mtk_instance_state {
 };
 
 /**
- * struct mtk_encode_param - General encoding parameters type
+ * enum mtk_encode_param - General encoding parameters type
  */
 enum mtk_encode_param {
        MTK_ENCODE_PARAM_NONE = 0,
@@ -112,7 +112,7 @@ struct mtk_codec_framesizes {
 };
 
 /**
- * struct mtk_q_type - Type of queue
+ * enum mtk_q_type - Type of queue
  */
 enum mtk_q_type {
        MTK_Q_DATA_SRC = 0,

diff --git a/drivers/media/platform/mtk-vcodec/vdec_drv_if.h b/drivers/media/platform/mtk-vcodec/vdec_drv_if.h
index 270d8dc9984b0028c54526448cfa44ecaae668e1..ec8f4e8d3d232f7e6dc810ea5350c8b3e4fdd40c 100644 (file)
--- a/drivers/media/platform/mtk-vcodec/vdec_drv_if.h
+++ b/drivers/media/platform/mtk-vcodec/vdec_drv_if.h
@@ -14,10 +14,10 @@
 
 
 /**
- * struct vdec_fb_status  - decoder frame buffer status
- * @FB_ST_NORMAL       : initial state
- * @FB_ST_DISPLAY      : frmae buffer is ready to be displayed
- * @FB_ST_FREE         : frame buffer is not used by decoder any more
+ * enum vdec_fb_status  - decoder frame buffer status
+ * @FB_ST_NORMAL: initial state
+ * @FB_ST_DISPLAY: frame buffer is ready to be displayed
+ * @FB_ST_FREE: frame buffer is not used by decoder any more
  */
 enum vdec_fb_status {
        FB_ST_NORMAL            = 0,

diff --git a/drivers/media/platform/mtk-vcodec/venc_ipi_msg.h b/drivers/media/platform/mtk-vcodec/venc_ipi_msg.h
index 2feb0365179fd1f822105ebcaa9478126dd81217..5f53d4255c3686af32e67b4e37478e0339e132f9 100644 (file)
--- a/drivers/media/platform/mtk-vcodec/venc_ipi_msg.h
+++ b/drivers/media/platform/mtk-vcodec/venc_ipi_msg.h
@@ -52,7 +52,7 @@ struct venc_ap_ipi_msg_init {
  *                     (struct venc_vp8_vsi/venc_h264_vsi *)
  * @param_id:  parameter id (venc_set_param_type)
  * @data_item: number of items in the data array
- * @data[8]:   data array to store the set parameters
+ * @data:      data array to store the set parameters
  */
 struct venc_ap_ipi_msg_set_param {
        uint32_t msg_id;
@@ -92,7 +92,7 @@ struct venc_ap_ipi_msg_enc {
  *
  * @base:      base msg structure
  * @data_item: number of items in the data array
- * @data[8]:   data array to store the set parameters
+ * @data:      data array to store the set parameters
  */
 struct venc_ap_ipi_msg_enc_ext {
        struct venc_ap_ipi_msg_enc base;
@@ -158,7 +158,7 @@ struct venc_vpu_ipi_msg_init {
  * @venc_inst: AP encoder instance (struct venc_vp8_inst/venc_h264_inst *)
  * @param_id:  parameter id (venc_set_param_type)
  * @data_item: number of items in the data array
- * @data[6]:   data array to store the return result
+ * @data:      data array to store the return result
  */
 struct venc_vpu_ipi_msg_set_param {
        uint32_t msg_id;
@@ -171,10 +171,10 @@ struct venc_vpu_ipi_msg_set_param {
 
 /**
  * enum venc_ipi_msg_enc_state - Type of encode state
- * VEN_IPI_MSG_ENC_STATE_FRAME:        one frame being encoded
- * VEN_IPI_MSG_ENC_STATE_PART: bit stream buffer full
- * VEN_IPI_MSG_ENC_STATE_SKIP: encoded skip frame
- * VEN_IPI_MSG_ENC_STATE_ERROR:        encounter error
+ * @VEN_IPI_MSG_ENC_STATE_FRAME:       one frame being encoded
+ * @VEN_IPI_MSG_ENC_STATE_PART:                bit stream buffer full
+ * @VEN_IPI_MSG_ENC_STATE_SKIP:                encoded skip frame
+ * @VEN_IPI_MSG_ENC_STATE_ERROR:       encounter error
  */
 enum venc_ipi_msg_enc_state {
        VEN_IPI_MSG_ENC_STATE_FRAME,