* [PATCH 01/13] exynos-gsc/exynos4-is: add missing 'struct' to kerneldoc
2021-03-11 10:20 [PATCH 00/13] media platform: fix kernel-doc formatting Hans Verkuil
@ 2021-03-11 10:20 ` Hans Verkuil
2021-03-11 10:20 ` [PATCH 02/13] s5p-jpeg: fix kernel-doc warnings Hans Verkuil
` (11 subsequent siblings)
12 siblings, 0 replies; 19+ messages in thread
From: Hans Verkuil @ 2021-03-11 10:20 UTC (permalink / raw)
To: linux-media; +Cc: Hans Verkuil, Marek Szyprowski
Fix kernel-doc warnings due to missing 'struct' keyword.
Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
Cc: Marek Szyprowski <m.szyprowski@samsung.com>
---
drivers/media/platform/exynos-gsc/gsc-core.h | 2 +-
drivers/media/platform/exynos4-is/fimc-core.h | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/drivers/media/platform/exynos-gsc/gsc-core.h b/drivers/media/platform/exynos-gsc/gsc-core.h
index 8e5a9acb78aa..a2eeb8affe0d 100644
--- a/drivers/media/platform/exynos-gsc/gsc-core.h
+++ b/drivers/media/platform/exynos-gsc/gsc-core.h
@@ -340,7 +340,7 @@ struct gsc_dev {
};
/**
- * gsc_ctx - the device context data
+ * struct gsc_ctx - the device context data
* @s_frame: source frame properties
* @d_frame: destination frame properties
* @in_path: input mode (DMA or camera)
diff --git a/drivers/media/platform/exynos4-is/fimc-core.h b/drivers/media/platform/exynos4-is/fimc-core.h
index 58b72a052cef..24212a6bce25 100644
--- a/drivers/media/platform/exynos4-is/fimc-core.h
+++ b/drivers/media/platform/exynos4-is/fimc-core.h
@@ -453,7 +453,7 @@ struct fimc_ctrls {
};
/**
- * fimc_ctx - the device context data
+ * struct fimc_ctx - the device context data
* @s_frame: source frame properties
* @d_frame: destination frame properties
* @out_order_1p: output 1-plane YCBCR order
--
2.30.1
^ permalink raw reply related [flat|nested] 19+ messages in thread* [PATCH 02/13] s5p-jpeg: fix kernel-doc warnings
2021-03-11 10:20 [PATCH 00/13] media platform: fix kernel-doc formatting Hans Verkuil
2021-03-11 10:20 ` [PATCH 01/13] exynos-gsc/exynos4-is: add missing 'struct' to kerneldoc Hans Verkuil
@ 2021-03-11 10:20 ` Hans Verkuil
2021-03-11 10:20 ` [PATCH 03/13] ti-vpe/cal.h: fix kernel-doc formatting Hans Verkuil
` (10 subsequent siblings)
12 siblings, 0 replies; 19+ messages in thread
From: Hans Verkuil @ 2021-03-11 10:20 UTC (permalink / raw)
To: linux-media; +Cc: Hans Verkuil, Marek Szyprowski
- added missing 'struct' kernel-doc keywords
- add missing '*' in kernel-doc comment blocks
Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
Cc: Marek Szyprowski <m.szyprowski@samsung.com>
---
drivers/media/platform/s5p-jpeg/jpeg-core.h | 13 ++++++-------
1 file changed, 6 insertions(+), 7 deletions(-)
diff --git a/drivers/media/platform/s5p-jpeg/jpeg-core.h b/drivers/media/platform/s5p-jpeg/jpeg-core.h
index 4407fe775afa..fcd21ae8bcbe 100644
--- a/drivers/media/platform/s5p-jpeg/jpeg-core.h
+++ b/drivers/media/platform/s5p-jpeg/jpeg-core.h
@@ -115,8 +115,7 @@ enum s5p_jpeg_ctx_state {
* @dev: JPEG IP struct device
* @variant: driver variant to be used
* @irq_status interrupt flags set during single encode/decode
- operation
-
+ * operation
*/
struct s5p_jpeg {
struct mutex lock;
@@ -149,7 +148,7 @@ struct s5p_jpeg_variant {
};
/**
- * struct jpeg_fmt - driver's internal color format data
+ * struct s5p_jpeg_fmt - driver's internal color format data
* @fourcc: the fourcc code, 0 if not applicable
* @depth: number of bits per pixel
* @colplanes: number of color planes (1 for packed formats)
@@ -169,7 +168,7 @@ struct s5p_jpeg_fmt {
};
/**
- * s5p_jpeg_marker - collection of markers from jpeg header
+ * struct s5p_jpeg_marker - collection of markers from jpeg header
* @marker: markers' positions relative to the buffer beginning
* @len: markers' payload lengths (without length field)
* @n: number of markers in collection
@@ -181,7 +180,7 @@ struct s5p_jpeg_marker {
};
/**
- * s5p_jpeg_q_data - parameters of one queue
+ * struct s5p_jpeg_q_data - parameters of one queue
* @fmt: driver-specific format of this queue
* @w: image width
* @h: image height
@@ -205,7 +204,7 @@ struct s5p_jpeg_q_data {
};
/**
- * s5p_jpeg_ctx - the device context data
+ * struct s5p_jpeg_ctx - the device context data
* @jpeg: JPEG IP device for this context
* @mode: compression (encode) operation or decompression (decode)
* @compr_quality: destination image quality in compression (encode) mode
@@ -239,7 +238,7 @@ struct s5p_jpeg_ctx {
};
/**
- * s5p_jpeg_buffer - description of memory containing input JPEG data
+ * struct s5p_jpeg_buffer - description of memory containing input JPEG data
* @size: buffer size
* @curr: current position in the buffer
* @data: pointer to the data
--
2.30.1
^ permalink raw reply related [flat|nested] 19+ messages in thread* [PATCH 03/13] ti-vpe/cal.h: fix kernel-doc formatting
2021-03-11 10:20 [PATCH 00/13] media platform: fix kernel-doc formatting Hans Verkuil
2021-03-11 10:20 ` [PATCH 01/13] exynos-gsc/exynos4-is: add missing 'struct' to kerneldoc Hans Verkuil
2021-03-11 10:20 ` [PATCH 02/13] s5p-jpeg: fix kernel-doc warnings Hans Verkuil
@ 2021-03-11 10:20 ` Hans Verkuil
2021-03-16 15:03 ` Tomi Valkeinen
2021-03-11 10:20 ` [PATCH 04/13] rcar-vin/rcar-vin.h: " Hans Verkuil
` (9 subsequent siblings)
12 siblings, 1 reply; 19+ messages in thread
From: Hans Verkuil @ 2021-03-11 10:20 UTC (permalink / raw)
To: linux-media; +Cc: Hans Verkuil, Tomi Valkeinen
Fix inline struct member documentation, was missing the
'@memb:' prefix.
Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
Cc: Tomi Valkeinen <tomi.valkeinen@ideasonboard.com>
---
drivers/media/platform/ti-vpe/cal.h | 19 +++++++++----------
1 file changed, 9 insertions(+), 10 deletions(-)
diff --git a/drivers/media/platform/ti-vpe/cal.h b/drivers/media/platform/ti-vpe/cal.h
index d471b7f82519..7aaea82c6b42 100644
--- a/drivers/media/platform/ti-vpe/cal.h
+++ b/drivers/media/platform/ti-vpe/cal.h
@@ -84,35 +84,34 @@ struct cal_buffer {
/**
* struct cal_dmaqueue - Queue of DMA buffers
- * @active: Buffer being DMA'ed to for the current frame
*/
struct cal_dmaqueue {
/**
- * Protects all fields in the cal_dmaqueue.
+ * @lock: Protects all fields in the cal_dmaqueue.
*/
spinlock_t lock;
/**
- * Buffers queued to the driver and waiting for DMA processing.
+ * @queue: Buffers queued to the driver and waiting for DMA processing.
* Buffers are added to the list by the vb2 .buffer_queue() operation,
* and move to @pending when they are scheduled for the next frame.
*/
struct list_head queue;
/**
- * Buffer provided to the hardware to DMA the next frame. Will move to
- * @active at the end of the current frame.
+ * @pending: Buffer provided to the hardware to DMA the next frame.
+ * Will move to @active at the end of the current frame.
*/
struct cal_buffer *pending;
/**
- * Buffer being DMA'ed to for the current frame. Will be retired and
- * given back to vb2 at the end of the current frame if a @pending
- * buffer has been scheduled to replace it.
+ * @active: Buffer being DMA'ed to for the current frame. Will be
+ * retired and given back to vb2 at the end of the current frame if
+ * a @pending buffer has been scheduled to replace it.
*/
struct cal_buffer *active;
- /** State of the DMA engine. */
+ /** @state: State of the DMA engine. */
enum cal_dma_state state;
- /** Wait queue to signal a @state transition to CAL_DMA_STOPPED. */
+ /** @wait: Wait queue to signal a @state transition to CAL_DMA_STOPPED. */
struct wait_queue_head wait;
};
--
2.30.1
^ permalink raw reply related [flat|nested] 19+ messages in thread* Re: [PATCH 03/13] ti-vpe/cal.h: fix kernel-doc formatting
2021-03-11 10:20 ` [PATCH 03/13] ti-vpe/cal.h: fix kernel-doc formatting Hans Verkuil
@ 2021-03-16 15:03 ` Tomi Valkeinen
0 siblings, 0 replies; 19+ messages in thread
From: Tomi Valkeinen @ 2021-03-16 15:03 UTC (permalink / raw)
To: Hans Verkuil, linux-media
On 11/03/2021 12:20, Hans Verkuil wrote:
> Fix inline struct member documentation, was missing the
> '@memb:' prefix.
>
> Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
> Cc: Tomi Valkeinen <tomi.valkeinen@ideasonboard.com>
> ---
> drivers/media/platform/ti-vpe/cal.h | 19 +++++++++----------
> 1 file changed, 9 insertions(+), 10 deletions(-)
>
> diff --git a/drivers/media/platform/ti-vpe/cal.h b/drivers/media/platform/ti-vpe/cal.h
> index d471b7f82519..7aaea82c6b42 100644
> --- a/drivers/media/platform/ti-vpe/cal.h
> +++ b/drivers/media/platform/ti-vpe/cal.h
> @@ -84,35 +84,34 @@ struct cal_buffer {
>
> /**
> * struct cal_dmaqueue - Queue of DMA buffers
> - * @active: Buffer being DMA'ed to for the current frame
> */
> struct cal_dmaqueue {
> /**
> - * Protects all fields in the cal_dmaqueue.
> + * @lock: Protects all fields in the cal_dmaqueue.
> */
> spinlock_t lock;
>
> /**
> - * Buffers queued to the driver and waiting for DMA processing.
> + * @queue: Buffers queued to the driver and waiting for DMA processing.
> * Buffers are added to the list by the vb2 .buffer_queue() operation,
> * and move to @pending when they are scheduled for the next frame.
> */
> struct list_head queue;
> /**
> - * Buffer provided to the hardware to DMA the next frame. Will move to
> - * @active at the end of the current frame.
> + * @pending: Buffer provided to the hardware to DMA the next frame.
> + * Will move to @active at the end of the current frame.
> */
> struct cal_buffer *pending;
> /**
> - * Buffer being DMA'ed to for the current frame. Will be retired and
> - * given back to vb2 at the end of the current frame if a @pending
> - * buffer has been scheduled to replace it.
> + * @active: Buffer being DMA'ed to for the current frame. Will be
> + * retired and given back to vb2 at the end of the current frame if
> + * a @pending buffer has been scheduled to replace it.
> */
> struct cal_buffer *active;
>
> - /** State of the DMA engine. */
> + /** @state: State of the DMA engine. */
> enum cal_dma_state state;
> - /** Wait queue to signal a @state transition to CAL_DMA_STOPPED. */
> + /** @wait: Wait queue to signal a @state transition to CAL_DMA_STOPPED. */
> struct wait_queue_head wait;
> };
>
>
Reviewed-by: Tomi Valkeinen <tomi.valkeinen@ideasonboard.com>
Tomi
^ permalink raw reply [flat|nested] 19+ messages in thread
* [PATCH 04/13] rcar-vin/rcar-vin.h: fix kernel-doc formatting
2021-03-11 10:20 [PATCH 00/13] media platform: fix kernel-doc formatting Hans Verkuil
` (2 preceding siblings ...)
2021-03-11 10:20 ` [PATCH 03/13] ti-vpe/cal.h: fix kernel-doc formatting Hans Verkuil
@ 2021-03-11 10:20 ` Hans Verkuil
2021-03-11 12:12 ` Niklas Söderlund
2021-03-11 10:20 ` [PATCH 05/13] media/platform/sti: " Hans Verkuil
` (8 subsequent siblings)
12 siblings, 1 reply; 19+ messages in thread
From: Hans Verkuil @ 2021-03-11 10:20 UTC (permalink / raw)
To: linux-media; +Cc: Hans Verkuil, Niklas Söderlund
Fix formatting of two enums and one struct.
Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
Cc: Niklas Söderlund <niklas.soderlund+renesas@ragnatech.se>
---
drivers/media/platform/rcar-vin/rcar-vin.h | 19 ++++++++++---------
1 file changed, 10 insertions(+), 9 deletions(-)
diff --git a/drivers/media/platform/rcar-vin/rcar-vin.h b/drivers/media/platform/rcar-vin/rcar-vin.h
index 0ee9d402f5ac..b263ead4db2b 100644
--- a/drivers/media/platform/rcar-vin/rcar-vin.h
+++ b/drivers/media/platform/rcar-vin/rcar-vin.h
@@ -49,11 +49,12 @@ enum rvin_csi_id {
};
/**
- * STOPPED - No operation in progress
- * STARTING - Capture starting up
- * RUNNING - Operation in progress have buffers
- * STOPPING - Stopping operation
- * SUSPENDED - Capture is suspended
+ * enum rvin_dma_state - DMA states
+ * @STOPPED: No operation in progress
+ * @STARTING: Capture starting up
+ * @RUNNING: Operation in progress have buffers
+ * @STOPPING: Stopping operation
+ * @SUSPENDED: Capture is suspended
*/
enum rvin_dma_state {
STOPPED = 0,
@@ -70,9 +71,9 @@ enum rvin_dma_state {
* to capture SEQ_TB/BT it's needed to capture to the same vb2
* buffer twice so the type of buffer needs to be kept.
*
- * FULL - One capture fills the whole vb2 buffer
- * HALF_TOP - One capture fills the top half of the vb2 buffer
- * HALF_BOTTOM - One capture fills the bottom half of the vb2 buffer
+ * @FULL: One capture fills the whole vb2 buffer
+ * @HALF_TOP: One capture fills the top half of the vb2 buffer
+ * @HALF_BOTTOM: One capture fills the bottom half of the vb2 buffer
*/
enum rvin_buffer_type {
FULL,
@@ -191,7 +192,7 @@ struct rvin_info {
* @state: keeps track of operation state
*
* @is_csi: flag to mark the VIN as using a CSI-2 subdevice
- * @chsel Cached value of the current CSI-2 channel selection
+ * @chsel: Cached value of the current CSI-2 channel selection
*
* @mbus_code: media bus format code
* @format: active V4L2 pixel format
--
2.30.1
^ permalink raw reply related [flat|nested] 19+ messages in thread* Re: [PATCH 04/13] rcar-vin/rcar-vin.h: fix kernel-doc formatting
2021-03-11 10:20 ` [PATCH 04/13] rcar-vin/rcar-vin.h: " Hans Verkuil
@ 2021-03-11 12:12 ` Niklas Söderlund
0 siblings, 0 replies; 19+ messages in thread
From: Niklas Söderlund @ 2021-03-11 12:12 UTC (permalink / raw)
To: Hans Verkuil; +Cc: linux-media
Hi Hans,
Thanks for your patch.
On 2021-03-11 11:20:13 +0100, Hans Verkuil wrote:
> Fix formatting of two enums and one struct.
>
> Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
> Cc: Niklas Söderlund <niklas.soderlund+renesas@ragnatech.se>
Reviewed-by: Niklas Söderlund <niklas.soderlund+renesas@ragnatech.se>
> ---
> drivers/media/platform/rcar-vin/rcar-vin.h | 19 ++++++++++---------
> 1 file changed, 10 insertions(+), 9 deletions(-)
>
> diff --git a/drivers/media/platform/rcar-vin/rcar-vin.h b/drivers/media/platform/rcar-vin/rcar-vin.h
> index 0ee9d402f5ac..b263ead4db2b 100644
> --- a/drivers/media/platform/rcar-vin/rcar-vin.h
> +++ b/drivers/media/platform/rcar-vin/rcar-vin.h
> @@ -49,11 +49,12 @@ enum rvin_csi_id {
> };
>
> /**
> - * STOPPED - No operation in progress
> - * STARTING - Capture starting up
> - * RUNNING - Operation in progress have buffers
> - * STOPPING - Stopping operation
> - * SUSPENDED - Capture is suspended
> + * enum rvin_dma_state - DMA states
> + * @STOPPED: No operation in progress
> + * @STARTING: Capture starting up
> + * @RUNNING: Operation in progress have buffers
> + * @STOPPING: Stopping operation
> + * @SUSPENDED: Capture is suspended
> */
> enum rvin_dma_state {
> STOPPED = 0,
> @@ -70,9 +71,9 @@ enum rvin_dma_state {
> * to capture SEQ_TB/BT it's needed to capture to the same vb2
> * buffer twice so the type of buffer needs to be kept.
> *
> - * FULL - One capture fills the whole vb2 buffer
> - * HALF_TOP - One capture fills the top half of the vb2 buffer
> - * HALF_BOTTOM - One capture fills the bottom half of the vb2 buffer
> + * @FULL: One capture fills the whole vb2 buffer
> + * @HALF_TOP: One capture fills the top half of the vb2 buffer
> + * @HALF_BOTTOM: One capture fills the bottom half of the vb2 buffer
> */
> enum rvin_buffer_type {
> FULL,
> @@ -191,7 +192,7 @@ struct rvin_info {
> * @state: keeps track of operation state
> *
> * @is_csi: flag to mark the VIN as using a CSI-2 subdevice
> - * @chsel Cached value of the current CSI-2 channel selection
> + * @chsel: Cached value of the current CSI-2 channel selection
> *
> * @mbus_code: media bus format code
> * @format: active V4L2 pixel format
> --
> 2.30.1
>
--
Regards,
Niklas Söderlund
^ permalink raw reply [flat|nested] 19+ messages in thread
* [PATCH 05/13] media/platform/sti: fix kernel-doc formatting
2021-03-11 10:20 [PATCH 00/13] media platform: fix kernel-doc formatting Hans Verkuil
` (3 preceding siblings ...)
2021-03-11 10:20 ` [PATCH 04/13] rcar-vin/rcar-vin.h: " Hans Verkuil
@ 2021-03-11 10:20 ` Hans Verkuil
2021-03-11 10:20 ` [PATCH 06/13] vsp1/vsp1_drm.h: add missing 'struct' kernel-doc keyword Hans Verkuil
` (7 subsequent siblings)
12 siblings, 0 replies; 19+ messages in thread
From: Hans Verkuil @ 2021-03-11 10:20 UTC (permalink / raw)
To: linux-media; +Cc: Hans Verkuil, Jean-Christophe Trotin
bdisp/bdisp-filter.h: coef: -> @coef: (missing @)
c8sectpfe/c8sectpfe-debugfs.h: /** -> /* (wasn't a kernel-doc comment)
sti/hva/hva.h: @v4l2: -> @vbuf: (wrong name)
Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
Cc: Jean-Christophe Trotin <jean-christophe.trotin@st.com>
---
drivers/media/platform/sti/bdisp/bdisp-filter.h | 4 ++--
drivers/media/platform/sti/c8sectpfe/c8sectpfe-debugfs.h | 3 +--
drivers/media/platform/sti/hva/hva.h | 2 +-
3 files changed, 4 insertions(+), 5 deletions(-)
diff --git a/drivers/media/platform/sti/bdisp/bdisp-filter.h b/drivers/media/platform/sti/bdisp/bdisp-filter.h
index d25adb57e3d0..9e1a95fd27ed 100644
--- a/drivers/media/platform/sti/bdisp/bdisp-filter.h
+++ b/drivers/media/platform/sti/bdisp/bdisp-filter.h
@@ -12,7 +12,7 @@
*
* @min: min scale factor for this filter (6.10 fixed point)
* @max: max scale factor for this filter (6.10 fixed point)
- * coef: filter coefficients
+ * @coef: filter coefficients
*/
struct bdisp_filter_h_spec {
const u16 min;
@@ -24,7 +24,7 @@ struct bdisp_filter_h_spec {
*
* @min: min scale factor for this filter (6.10 fixed point)
* @max: max scale factor for this filter (6.10 fixed point)
- * coef: filter coefficients
+ * @coef: filter coefficients
*/
struct bdisp_filter_v_spec {
const u16 min;
diff --git a/drivers/media/platform/sti/c8sectpfe/c8sectpfe-debugfs.h b/drivers/media/platform/sti/c8sectpfe/c8sectpfe-debugfs.h
index b8c30bcc8df9..d2c35fb32d7e 100644
--- a/drivers/media/platform/sti/c8sectpfe/c8sectpfe-debugfs.h
+++ b/drivers/media/platform/sti/c8sectpfe/c8sectpfe-debugfs.h
@@ -1,11 +1,10 @@
/* SPDX-License-Identifier: GPL-2.0 */
-/**
+/*
* c8sectpfe-debugfs.h - C8SECTPFE STi DVB driver debugfs header
*
* Copyright (c) STMicroelectronics 2015
*
* Authors: Peter Griffin <peter.griffin@linaro.org>
- *
*/
#ifndef __C8SECTPFE_DEBUG_H
diff --git a/drivers/media/platform/sti/hva/hva.h b/drivers/media/platform/sti/hva/hva.h
index 1226d60cc367..ba6b893416ec 100644
--- a/drivers/media/platform/sti/hva/hva.h
+++ b/drivers/media/platform/sti/hva/hva.h
@@ -130,7 +130,7 @@ struct hva_frame {
/**
* struct hva_stream - hva stream buffer (capture)
*
- * @v4l2: video buffer information for V4L2
+ * @vbuf: video buffer information for V4L2
* @list: V4L2 m2m list that the frame belongs to
* @paddr: physical address (for hardware)
* @vaddr: virtual address (kernel can read/write)
--
2.30.1
^ permalink raw reply related [flat|nested] 19+ messages in thread* [PATCH 06/13] vsp1/vsp1_drm.h: add missing 'struct' kernel-doc keyword
2021-03-11 10:20 [PATCH 00/13] media platform: fix kernel-doc formatting Hans Verkuil
` (4 preceding siblings ...)
2021-03-11 10:20 ` [PATCH 05/13] media/platform/sti: " Hans Verkuil
@ 2021-03-11 10:20 ` Hans Verkuil
2021-03-11 12:12 ` Laurent Pinchart
2021-03-11 10:20 ` [PATCH 07/13] staging: media: hantro: fix kernel-doc formatting Hans Verkuil
` (6 subsequent siblings)
12 siblings, 1 reply; 19+ messages in thread
From: Hans Verkuil @ 2021-03-11 10:20 UTC (permalink / raw)
To: linux-media; +Cc: Hans Verkuil, Laurent Pinchart
The kernel-doc documentation for two structs was missing the
'struct' keyword.
Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
Cc: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
drivers/media/platform/vsp1/vsp1_drm.h | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/drivers/media/platform/vsp1/vsp1_drm.h b/drivers/media/platform/vsp1/vsp1_drm.h
index e85ad4366fbb..ab8b7e3161a2 100644
--- a/drivers/media/platform/vsp1/vsp1_drm.h
+++ b/drivers/media/platform/vsp1/vsp1_drm.h
@@ -18,7 +18,7 @@
#include "vsp1_pipe.h"
/**
- * vsp1_drm_pipeline - State for the API exposed to the DRM driver
+ * struct vsp1_drm_pipeline - State for the API exposed to the DRM driver
* @pipe: the VSP1 pipeline used for display
* @width: output display width
* @height: output display height
@@ -47,7 +47,7 @@ struct vsp1_drm_pipeline {
};
/**
- * vsp1_drm - State for the API exposed to the DRM driver
+ * struct vsp1_drm - State for the API exposed to the DRM driver
* @pipe: the VSP1 DRM pipeline used for display
* @lock: protects the BRU and BRS allocation
* @inputs: source crop rectangle, destination compose rectangle and z-order
--
2.30.1
^ permalink raw reply related [flat|nested] 19+ messages in thread* Re: [PATCH 06/13] vsp1/vsp1_drm.h: add missing 'struct' kernel-doc keyword
2021-03-11 10:20 ` [PATCH 06/13] vsp1/vsp1_drm.h: add missing 'struct' kernel-doc keyword Hans Verkuil
@ 2021-03-11 12:12 ` Laurent Pinchart
2021-03-11 12:35 ` Hans Verkuil
0 siblings, 1 reply; 19+ messages in thread
From: Laurent Pinchart @ 2021-03-11 12:12 UTC (permalink / raw)
To: Hans Verkuil; +Cc: linux-media
Hi Hans,
Thank you for the patch.
On Thu, Mar 11, 2021 at 11:20:15AM +0100, Hans Verkuil wrote:
> The kernel-doc documentation for two structs was missing the
> 'struct' keyword.
>
> Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
> Cc: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Should I take this in my tree, or will you merge them with your series ?
> ---
> drivers/media/platform/vsp1/vsp1_drm.h | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/drivers/media/platform/vsp1/vsp1_drm.h b/drivers/media/platform/vsp1/vsp1_drm.h
> index e85ad4366fbb..ab8b7e3161a2 100644
> --- a/drivers/media/platform/vsp1/vsp1_drm.h
> +++ b/drivers/media/platform/vsp1/vsp1_drm.h
> @@ -18,7 +18,7 @@
> #include "vsp1_pipe.h"
>
> /**
> - * vsp1_drm_pipeline - State for the API exposed to the DRM driver
> + * struct vsp1_drm_pipeline - State for the API exposed to the DRM driver
> * @pipe: the VSP1 pipeline used for display
> * @width: output display width
> * @height: output display height
> @@ -47,7 +47,7 @@ struct vsp1_drm_pipeline {
> };
>
> /**
> - * vsp1_drm - State for the API exposed to the DRM driver
> + * struct vsp1_drm - State for the API exposed to the DRM driver
> * @pipe: the VSP1 DRM pipeline used for display
> * @lock: protects the BRU and BRS allocation
> * @inputs: source crop rectangle, destination compose rectangle and z-order
--
Regards,
Laurent Pinchart
^ permalink raw reply [flat|nested] 19+ messages in thread* Re: [PATCH 06/13] vsp1/vsp1_drm.h: add missing 'struct' kernel-doc keyword
2021-03-11 12:12 ` Laurent Pinchart
@ 2021-03-11 12:35 ` Hans Verkuil
0 siblings, 0 replies; 19+ messages in thread
From: Hans Verkuil @ 2021-03-11 12:35 UTC (permalink / raw)
To: Laurent Pinchart; +Cc: linux-media
On 11/03/2021 13:12, Laurent Pinchart wrote:
> Hi Hans,
>
> Thank you for the patch.
>
> On Thu, Mar 11, 2021 at 11:20:15AM +0100, Hans Verkuil wrote:
>> The kernel-doc documentation for two structs was missing the
>> 'struct' keyword.
>>
>> Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
>> Cc: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
>
> Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
>
> Should I take this in my tree, or will you merge them with your series ?
I'll take it.
Regards,
Hans
>
>> ---
>> drivers/media/platform/vsp1/vsp1_drm.h | 4 ++--
>> 1 file changed, 2 insertions(+), 2 deletions(-)
>>
>> diff --git a/drivers/media/platform/vsp1/vsp1_drm.h b/drivers/media/platform/vsp1/vsp1_drm.h
>> index e85ad4366fbb..ab8b7e3161a2 100644
>> --- a/drivers/media/platform/vsp1/vsp1_drm.h
>> +++ b/drivers/media/platform/vsp1/vsp1_drm.h
>> @@ -18,7 +18,7 @@
>> #include "vsp1_pipe.h"
>>
>> /**
>> - * vsp1_drm_pipeline - State for the API exposed to the DRM driver
>> + * struct vsp1_drm_pipeline - State for the API exposed to the DRM driver
>> * @pipe: the VSP1 pipeline used for display
>> * @width: output display width
>> * @height: output display height
>> @@ -47,7 +47,7 @@ struct vsp1_drm_pipeline {
>> };
>>
>> /**
>> - * vsp1_drm - State for the API exposed to the DRM driver
>> + * struct vsp1_drm - State for the API exposed to the DRM driver
>> * @pipe: the VSP1 DRM pipeline used for display
>> * @lock: protects the BRU and BRS allocation
>> * @inputs: source crop rectangle, destination compose rectangle and z-order
>
^ permalink raw reply [flat|nested] 19+ messages in thread
* [PATCH 07/13] staging: media: hantro: fix kernel-doc formatting
2021-03-11 10:20 [PATCH 00/13] media platform: fix kernel-doc formatting Hans Verkuil
` (5 preceding siblings ...)
2021-03-11 10:20 ` [PATCH 06/13] vsp1/vsp1_drm.h: add missing 'struct' kernel-doc keyword Hans Verkuil
@ 2021-03-11 10:20 ` Hans Verkuil
2021-03-11 14:19 ` Ezequiel Garcia
2021-03-11 10:20 ` [PATCH 08/13] staging: media: ipu3: add missing kernel-doc 'struct' keywords Hans Verkuil
` (5 subsequent siblings)
12 siblings, 1 reply; 19+ messages in thread
From: Hans Verkuil @ 2021-03-11 10:20 UTC (permalink / raw)
To: linux-media; +Cc: Hans Verkuil, Ezequiel Garcia
- @h264_dec was not documented, add that trivial change
- it is not possible to document a global variable in kernel-doc,
change to use 'DOC:' instead
- fix mismatched struct name (hantro_vp8d_hw_ctx -> hantro_vp8_dec_hw_ctx)
Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
Cc: Ezequiel Garcia <ezequiel@collabora.com>
---
drivers/staging/media/hantro/hantro.h | 3 ++-
drivers/staging/media/hantro/hantro_hw.h | 2 +-
2 files changed, 3 insertions(+), 2 deletions(-)
diff --git a/drivers/staging/media/hantro/hantro.h b/drivers/staging/media/hantro/hantro.h
index 65f9f7ea7dcf..6c1b888abe75 100644
--- a/drivers/staging/media/hantro/hantro.h
+++ b/drivers/staging/media/hantro/hantro.h
@@ -214,6 +214,7 @@ struct hantro_dev {
*
* @codec_ops: Set of operations related to codec mode.
* @postproc: Post-processing context.
+ * @h264_dec: H.264-decoding context.
* @jpeg_enc: JPEG-encoding context.
* @mpeg2_dec: MPEG-2-decoding context.
* @vp8_dec: VP8-decoding context.
@@ -293,7 +294,7 @@ struct hantro_postproc_regs {
/* Logging helpers */
/**
- * debug - Module parameter to control level of debugging messages.
+ * DOC: hantro_debug: Module parameter to control level of debugging messages.
*
* Level of debugging messages can be controlled by bits of
* module parameter called "debug". Meaning of particular
diff --git a/drivers/staging/media/hantro/hantro_hw.h b/drivers/staging/media/hantro/hantro_hw.h
index 34c9e4649a25..65a9eaf5bb18 100644
--- a/drivers/staging/media/hantro/hantro_hw.h
+++ b/drivers/staging/media/hantro/hantro_hw.h
@@ -99,7 +99,7 @@ struct hantro_mpeg2_dec_hw_ctx {
};
/**
- * struct hantro_vp8d_hw_ctx
+ * struct hantro_vp8_dec_hw_ctx
* @segment_map: Segment map buffer.
* @prob_tbl: Probability table buffer.
*/
--
2.30.1
^ permalink raw reply related [flat|nested] 19+ messages in thread* Re: [PATCH 07/13] staging: media: hantro: fix kernel-doc formatting
2021-03-11 10:20 ` [PATCH 07/13] staging: media: hantro: fix kernel-doc formatting Hans Verkuil
@ 2021-03-11 14:19 ` Ezequiel Garcia
0 siblings, 0 replies; 19+ messages in thread
From: Ezequiel Garcia @ 2021-03-11 14:19 UTC (permalink / raw)
To: Hans Verkuil, linux-media
Hi Hans,
Thanks for the fix.
On Thu, 2021-03-11 at 11:20 +0100, Hans Verkuil wrote:
> - @h264_dec was not documented, add that trivial change
> - it is not possible to document a global variable in kernel-doc,
> change to use 'DOC:' instead
> - fix mismatched struct name (hantro_vp8d_hw_ctx -> hantro_vp8_dec_hw_ctx)
>
> Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
> Cc: Ezequiel Garcia <ezequiel@collabora.com>
Reviewed-by: Ezequiel Garcia <ezequiel@collabora.com>
Thanks,
Ezequiel
> ---
> drivers/staging/media/hantro/hantro.h | 3 ++-
> drivers/staging/media/hantro/hantro_hw.h | 2 +-
> 2 files changed, 3 insertions(+), 2 deletions(-)
>
> diff --git a/drivers/staging/media/hantro/hantro.h b/drivers/staging/media/hantro/hantro.h
> index 65f9f7ea7dcf..6c1b888abe75 100644
> --- a/drivers/staging/media/hantro/hantro.h
> +++ b/drivers/staging/media/hantro/hantro.h
> @@ -214,6 +214,7 @@ struct hantro_dev {
> *
> * @codec_ops: Set of operations related to codec mode.
> * @postproc: Post-processing context.
> + * @h264_dec: H.264-decoding context.
> * @jpeg_enc: JPEG-encoding context.
> * @mpeg2_dec: MPEG-2-decoding context.
> * @vp8_dec: VP8-decoding context.
> @@ -293,7 +294,7 @@ struct hantro_postproc_regs {
> /* Logging helpers */
>
> /**
> - * debug - Module parameter to control level of debugging messages.
> + * DOC: hantro_debug: Module parameter to control level of debugging messages.
> *
> * Level of debugging messages can be controlled by bits of
> * module parameter called "debug". Meaning of particular
> diff --git a/drivers/staging/media/hantro/hantro_hw.h b/drivers/staging/media/hantro/hantro_hw.h
> index 34c9e4649a25..65a9eaf5bb18 100644
> --- a/drivers/staging/media/hantro/hantro_hw.h
> +++ b/drivers/staging/media/hantro/hantro_hw.h
> @@ -99,7 +99,7 @@ struct hantro_mpeg2_dec_hw_ctx {
> };
>
> /**
> - * struct hantro_vp8d_hw_ctx
> + * struct hantro_vp8_dec_hw_ctx
> * @segment_map: Segment map buffer.
> * @prob_tbl: Probability table buffer.
> */
^ permalink raw reply [flat|nested] 19+ messages in thread
* [PATCH 08/13] staging: media: ipu3: add missing kernel-doc 'struct' keywords
2021-03-11 10:20 [PATCH 00/13] media platform: fix kernel-doc formatting Hans Verkuil
` (6 preceding siblings ...)
2021-03-11 10:20 ` [PATCH 07/13] staging: media: hantro: fix kernel-doc formatting Hans Verkuil
@ 2021-03-11 10:20 ` Hans Verkuil
2021-03-11 10:20 ` [PATCH 09/13] staging: media: meson: vdec: fix kernel-doc warning Hans Verkuil
` (4 subsequent siblings)
12 siblings, 0 replies; 19+ messages in thread
From: Hans Verkuil @ 2021-03-11 10:20 UTC (permalink / raw)
To: linux-media; +Cc: Hans Verkuil, Sakari Ailus
Two structs where missing the kernel-doc 'struct' keyword
in their kernel-doc documentation.
Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
Cc: Sakari Ailus <sakari.ailus@linux.intel.com>
---
drivers/staging/media/ipu3/ipu3-css-pool.h | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/drivers/staging/media/ipu3/ipu3-css-pool.h b/drivers/staging/media/ipu3/ipu3-css-pool.h
index a8ccd4f70320..35519a08c08c 100644
--- a/drivers/staging/media/ipu3/ipu3-css-pool.h
+++ b/drivers/staging/media/ipu3/ipu3-css-pool.h
@@ -10,7 +10,7 @@ struct imgu_device;
#define IPU3_CSS_POOL_SIZE 4
/**
- * imgu_css_map - store DMA mapping info for buffer
+ * struct imgu_css_map - store DMA mapping info for buffer
*
* @size: size of the buffer in bytes.
* @vaddr: kernel virtual address.
@@ -24,7 +24,7 @@ struct imgu_css_map {
};
/**
- * imgu_css_pool - circular buffer pool definition
+ * struct imgu_css_pool - circular buffer pool definition
*
* @entry: array with IPU3_CSS_POOL_SIZE elements.
* @entry.param: a &struct imgu_css_map for storing the mem mapping.
--
2.30.1
^ permalink raw reply related [flat|nested] 19+ messages in thread* [PATCH 09/13] staging: media: meson: vdec: fix kernel-doc warning
2021-03-11 10:20 [PATCH 00/13] media platform: fix kernel-doc formatting Hans Verkuil
` (7 preceding siblings ...)
2021-03-11 10:20 ` [PATCH 08/13] staging: media: ipu3: add missing kernel-doc 'struct' keywords Hans Verkuil
@ 2021-03-11 10:20 ` Hans Verkuil
2021-03-11 10:20 ` [PATCH 10/13] mtk-jpeg/mtk_jpeg_core.h: fix kernel-doc warnings Hans Verkuil
` (3 subsequent siblings)
12 siblings, 0 replies; 19+ messages in thread
From: Hans Verkuil @ 2021-03-11 10:20 UTC (permalink / raw)
To: linux-media; +Cc: Hans Verkuil, Neil Armstrong
One comment used /** instead of /*, so it caused kernel-doc
warnings. Just turn it into a regular comment.
Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
Cc: Neil Armstrong <narmstrong@baylibre.com>
---
drivers/staging/media/meson/vdec/codec_hevc_common.h | 4 +---
1 file changed, 1 insertion(+), 3 deletions(-)
diff --git a/drivers/staging/media/meson/vdec/codec_hevc_common.h b/drivers/staging/media/meson/vdec/codec_hevc_common.h
index 88e4379ba1ee..cf072b8a9da2 100644
--- a/drivers/staging/media/meson/vdec/codec_hevc_common.h
+++ b/drivers/staging/media/meson/vdec/codec_hevc_common.h
@@ -49,9 +49,7 @@ static inline int codec_hevc_use_mmu(u32 revision, u32 pixfmt, int is_10bit)
codec_hevc_use_fbc(pixfmt, is_10bit);
}
-/**
- * Configure decode head read mode
- */
+/* Configure decode head read mode */
void codec_hevc_setup_decode_head(struct amvdec_session *sess, int is_10bit);
void codec_hevc_free_fbc_buffers(struct amvdec_session *sess,
--
2.30.1
^ permalink raw reply related [flat|nested] 19+ messages in thread* [PATCH 10/13] mtk-jpeg/mtk_jpeg_core.h: fix kernel-doc warnings
2021-03-11 10:20 [PATCH 00/13] media platform: fix kernel-doc formatting Hans Verkuil
` (8 preceding siblings ...)
2021-03-11 10:20 ` [PATCH 09/13] staging: media: meson: vdec: fix kernel-doc warning Hans Verkuil
@ 2021-03-11 10:20 ` Hans Verkuil
2021-03-11 10:20 ` [PATCH 11/13] mtk-mdp: " Hans Verkuil
` (2 subsequent siblings)
12 siblings, 0 replies; 19+ messages in thread
From: Hans Verkuil @ 2021-03-11 10:20 UTC (permalink / raw)
To: linux-media; +Cc: Hans Verkuil, Xia Jiang
Add missing 'struct' keywords and fix typos in two struct member
names.
Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
Cc: Xia Jiang <xia.jiang@mediatek.com>
---
drivers/media/platform/mtk-jpeg/mtk_jpeg_core.h | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/drivers/media/platform/mtk-jpeg/mtk_jpeg_core.h b/drivers/media/platform/mtk-jpeg/mtk_jpeg_core.h
index 68e634f02e00..595f7f10c9fd 100644
--- a/drivers/media/platform/mtk-jpeg/mtk_jpeg_core.h
+++ b/drivers/media/platform/mtk-jpeg/mtk_jpeg_core.h
@@ -45,11 +45,11 @@ enum mtk_jpeg_ctx_state {
};
/**
- * mtk_jpeg_variant - mtk jpeg driver variant
+ * struct mtk_jpeg_variant - mtk jpeg driver variant
* @clks: clock names
* @num_clks: numbers of clock
- * @format: jpeg driver's internal color format
- * @num_format: number of format
+ * @formats: jpeg driver's internal color format
+ * @num_formats: number of formats
* @qops: the callback of jpeg vb2_ops
* @irq_handler: jpeg irq handler callback
* @hw_reset: jpeg hardware reset callback
@@ -75,7 +75,7 @@ struct mtk_jpeg_variant {
};
/**
- * struct mt_jpeg - JPEG IP abstraction
+ * struct mtk_jpeg_dev - JPEG IP abstraction
* @lock: the mutex protecting this structure
* @hw_lock: spinlock protecting the hw device resource
* @workqueue: decode work queue
@@ -105,7 +105,7 @@ struct mtk_jpeg_dev {
};
/**
- * struct jpeg_fmt - driver's internal color format data
+ * struct mtk_jpeg_fmt - driver's internal color format data
* @fourcc: the fourcc code, 0 if not applicable
* @hw_format: hardware format value
* @h_sample: horizontal sample count of plane in 4 * 4 pixel image
@@ -127,7 +127,7 @@ struct mtk_jpeg_fmt {
};
/**
- * mtk_jpeg_q_data - parameters of one queue
+ * struct mtk_jpeg_q_data - parameters of one queue
* @fmt: driver-specific format of this queue
* @pix_mp: multiplanar format
* @enc_crop_rect: jpeg encoder crop information
@@ -139,7 +139,7 @@ struct mtk_jpeg_q_data {
};
/**
- * mtk_jpeg_ctx - the device context data
+ * struct mtk_jpeg_ctx - the device context data
* @jpeg: JPEG IP device for this context
* @out_q: source (output) queue information
* @cap_q: destination (capture) queue queue information
--
2.30.1
^ permalink raw reply related [flat|nested] 19+ messages in thread* [PATCH 11/13] mtk-mdp: fix kernel-doc warnings
2021-03-11 10:20 [PATCH 00/13] media platform: fix kernel-doc formatting Hans Verkuil
` (9 preceding siblings ...)
2021-03-11 10:20 ` [PATCH 10/13] mtk-jpeg/mtk_jpeg_core.h: fix kernel-doc warnings Hans Verkuil
@ 2021-03-11 10:20 ` Hans Verkuil
2021-03-11 10:20 ` [PATCH 12/13] mtk-vcodec: " Hans Verkuil
2021-03-11 10:20 ` [PATCH 13/13] mtk-vpu/mtk_vpu.h: " Hans Verkuil
12 siblings, 0 replies; 19+ messages in thread
From: Hans Verkuil @ 2021-03-11 10:20 UTC (permalink / raw)
To: linux-media; +Cc: Hans Verkuil, Eizan Miyamoto
mtk_mdp_comp.h: MTK_MDP_COMP_TYPE_MAX was undocumented, but it
is also unused, so just remove it.
mtk_mdp_core.h: add missing '*' inside comment blocks, add a
missing : after '@ctrls' and add a missing struct keyword.
Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
Cc: Eizan Miyamoto <eizan@chromium.org>
---
drivers/media/platform/mtk-mdp/mtk_mdp_comp.h | 1 -
drivers/media/platform/mtk-mdp/mtk_mdp_core.h | 10 +++++-----
2 files changed, 5 insertions(+), 6 deletions(-)
diff --git a/drivers/media/platform/mtk-mdp/mtk_mdp_comp.h b/drivers/media/platform/mtk-mdp/mtk_mdp_comp.h
index 1bf0242cce46..7897766c96bb 100644
--- a/drivers/media/platform/mtk-mdp/mtk_mdp_comp.h
+++ b/drivers/media/platform/mtk-mdp/mtk_mdp_comp.h
@@ -19,7 +19,6 @@ enum mtk_mdp_comp_type {
MTK_MDP_RSZ,
MTK_MDP_WDMA,
MTK_MDP_WROT,
- MTK_MDP_COMP_TYPE_MAX,
};
/**
diff --git a/drivers/media/platform/mtk-mdp/mtk_mdp_core.h b/drivers/media/platform/mtk-mdp/mtk_mdp_core.h
index a7da14b97077..a6e6dc36307b 100644
--- a/drivers/media/platform/mtk-mdp/mtk_mdp_core.h
+++ b/drivers/media/platform/mtk-mdp/mtk_mdp_core.h
@@ -52,8 +52,8 @@ struct mtk_mdp_pix_align {
* @depth: per plane driver's private 'number of bits per pixel'
* @row_depth: per plane driver's private 'number of bits per pixel per row'
* @flags: flags indicating which operation mode format applies to
- MTK_MDP_FMT_FLAG_OUTPUT is used in OUTPUT stream
- MTK_MDP_FMT_FLAG_CAPTURE is used in CAPTURE stream
+ * MTK_MDP_FMT_FLAG_OUTPUT is used in OUTPUT stream
+ * MTK_MDP_FMT_FLAG_CAPTURE is used in CAPTURE stream
* @align: pointer to a pixel alignment struct, NULL if using default value
*/
struct mtk_mdp_fmt {
@@ -168,14 +168,14 @@ struct mtk_mdp_dev {
};
/**
- * mtk_mdp_ctx - the device context data
+ * struct mtk_mdp_ctx - the device context data
* @list: link to ctx_list of mtk_mdp_dev
* @s_frame: source frame properties
* @d_frame: destination frame properties
* @id: index of the context that this structure describes
* @flags: additional flags for image conversion
* @state: flags to keep track of user configuration
- Protected by slock
+ * Protected by slock
* @rotation: rotates the image by specified angle
* @hflip: mirror the picture horizontally
* @vflip: mirror the picture vertically
@@ -183,7 +183,7 @@ struct mtk_mdp_dev {
* @m2m_ctx: memory-to-memory device context
* @fh: v4l2 file handle
* @ctrl_handler: v4l2 controls handler
- * @ctrls image processor control set
+ * @ctrls: image processor control set
* @ctrls_rdy: true if the control handler is initialized
* @colorspace: enum v4l2_colorspace; supplemental to pixelformat
* @ycbcr_enc: enum v4l2_ycbcr_encoding, Y'CbCr encoding
--
2.30.1
^ permalink raw reply related [flat|nested] 19+ messages in thread* [PATCH 12/13] mtk-vcodec: fix kernel-doc warnings
2021-03-11 10:20 [PATCH 00/13] media platform: fix kernel-doc formatting Hans Verkuil
` (10 preceding siblings ...)
2021-03-11 10:20 ` [PATCH 11/13] mtk-mdp: " Hans Verkuil
@ 2021-03-11 10:20 ` Hans Verkuil
2021-03-11 10:20 ` [PATCH 13/13] mtk-vpu/mtk_vpu.h: " Hans Verkuil
12 siblings, 0 replies; 19+ messages in thread
From: Hans Verkuil @ 2021-03-11 10:20 UTC (permalink / raw)
To: linux-media; +Cc: Hans Verkuil, Alexandre Courbot, Tiffany Lin
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>
---
drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h | 14 +++++++-------
drivers/media/platform/mtk-vcodec/vdec_drv_if.h | 8 ++++----
drivers/media/platform/mtk-vcodec/venc_ipi_msg.h | 14 +++++++-------
3 files changed, 18 insertions(+), 18 deletions(-)
diff --git a/drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h b/drivers/media/platform/mtk-vcodec/mtk_vcodec_drv.h
index 3dd010cba23e..43be6b5a405a 100644
--- 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 270d8dc9984b..ec8f4e8d3d23 100644
--- 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 2feb0365179f..5f53d4255c36 100644
--- 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,
--
2.30.1
^ permalink raw reply related [flat|nested] 19+ messages in thread* [PATCH 13/13] mtk-vpu/mtk_vpu.h: fix kernel-doc warnings
2021-03-11 10:20 [PATCH 00/13] media platform: fix kernel-doc formatting Hans Verkuil
` (11 preceding siblings ...)
2021-03-11 10:20 ` [PATCH 12/13] mtk-vcodec: " Hans Verkuil
@ 2021-03-11 10:20 ` Hans Verkuil
12 siblings, 0 replies; 19+ messages in thread
From: Hans Verkuil @ 2021-03-11 10:20 UTC (permalink / raw)
To: linux-media; +Cc: Hans Verkuil, Irui Wang, Andrew-CT Chen
A top-level documentation block was missing 'DOC:'.
Fix typos in vpu_wdt_reg_handler() and vpu_mapping_dm_addr().
Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
Cc: Irui Wang <irui.wang@mediatek.com>
Cc: Andrew-CT Chen <andrew-ct.chen@mediatek.com>
---
drivers/media/platform/mtk-vpu/mtk_vpu.h | 18 ++++++++++--------
1 file changed, 10 insertions(+), 8 deletions(-)
diff --git a/drivers/media/platform/mtk-vpu/mtk_vpu.h b/drivers/media/platform/mtk-vpu/mtk_vpu.h
index ee7c552ce928..a56053ff135a 100644
--- a/drivers/media/platform/mtk-vpu/mtk_vpu.h
+++ b/drivers/media/platform/mtk-vpu/mtk_vpu.h
@@ -10,10 +10,12 @@
#include <linux/platform_device.h>
/**
+ * DOC: VPU
+ *
* VPU (video processor unit) is a tiny processor controlling video hardware
* related to video codec, scaling and color format converting.
* VPU interfaces with other blocks by share memory and interrupt.
- **/
+ */
typedef void (*ipi_handler_t) (const void *data,
unsigned int len,
@@ -126,18 +128,18 @@ struct platform_device *vpu_get_plat_device(struct platform_device *pdev);
* vpu_wdt_reg_handler - register a VPU watchdog handler
*
* @pdev: VPU platform device
- * @vpu_wdt_reset_func: the callback reset function
- * @private_data: the private data for reset function
- * @rst_id: reset id
+ * @vpu_wdt_reset_func(): the callback reset function
+ * @priv: the private data for reset function
+ * @priv: the private data for reset function
+ * @id: reset id
*
* Register a handler performing own tasks when vpu reset by watchdog
*
* Return: Return 0 if the handler is added successfully,
* otherwise it is failed.
- *
**/
int vpu_wdt_reg_handler(struct platform_device *pdev,
- void vpu_wdt_reset_func(void *),
+ void vpu_wdt_reset_func(void *priv),
void *priv, enum rst_id id);
/**
@@ -171,8 +173,8 @@ int vpu_load_firmware(struct platform_device *pdev);
/**
* vpu_mapping_dm_addr - Mapping DTCM/DMEM to kernel virtual address
*
- * @pdev: VPU platform device
- * @dmem_addr: VPU's data memory address
+ * @pdev: VPU platform device
+ * @dtcm_dmem_addr: VPU's data memory address
*
* Mapping the VPU's DTCM (Data Tightly-Coupled Memory) /
* DMEM (Data Extended Memory) memory address to
--
2.30.1
^ permalink raw reply related [flat|nested] 19+ messages in thread