mbox series

[00/17] media: kerneldoc warnings

Message ID 20240126-gix-mtk-warnings-v1-0-eed7865fce18@chromium.org
Headers show
Series media: kerneldoc warnings | expand

Message

Ricardo Ribalda Jan. 26, 2024, 11:15 p.m. UTC
While automating the CI, I found the following kernel-doc errors.

Signed-off-by: Ricardo Ribalda <ribalda@chromium.org>
---
Ricardo Ribalda (17):
      media: mediatek: vcodec: Fix kerneldoc warnings
      media: videodev2.h: Fix kerneldoc
      media: media-entity.h: Fix kerneldoc
      media: cec.h: Fix kerneldoc
      media: pci: dt315.h: Fix kerneldoc
      media: i2c: css-quirk.h: Fix kerneldoc
      media: i2c: adv748: Fix kerneldoc
      media: mediatek: jpeg: Fix kerneldoc
      media: mediatek: vcodec: Fix kerneldoc
      media: verisilicon: Fix kerneldoc
      media: qcom: venus: Fix kerneldoc
      media: samsung: exynos4-is: Fix kerneldoc
      media: samsung: s5p-mfc: Fix kerneldoc
      media: dvb-usb: Fix kerneldoc
      media: ipu3: Fix kerneldoc
      media: staging: meson: Fix kerneldoc
      linux: v4l2-vp9.h: Fix kerneldoc

 drivers/media/i2c/adv748x/adv748x.h                |  1 -
 drivers/media/i2c/ccs/ccs-quirk.h                  |  8 +++---
 drivers/media/pci/dt3155/dt3155.h                  |  1 -
 .../media/platform/mediatek/jpeg/mtk_jpeg_core.h   |  1 -
 .../mediatek/vcodec/decoder/mtk_vcodec_dec.h       |  1 -
 .../mediatek/vcodec/decoder/vdec/vdec_vp8_req_if.c |  1 -
 .../vcodec/decoder/vdec/vdec_vp9_req_lat_if.c      |  1 -
 .../platform/mediatek/vcodec/decoder/vdec_vpu_if.h |  1 -
 .../mediatek/vcodec/encoder/mtk_vcodec_enc.h       |  1 -
 drivers/media/platform/qcom/venus/core.h           |  1 -
 .../media/platform/samsung/exynos4-is/fimc-lite.h  |  3 --
 .../platform/samsung/s5p-mfc/s5p_mfc_common.h      |  1 -
 drivers/media/platform/verisilicon/hantro.h        |  1 -
 drivers/media/usb/dvb-usb/dvb-usb.h                |  2 --
 .../staging/media/ipu3/include/uapi/intel-ipu3.h   |  3 --
 drivers/staging/media/meson/vdec/vdec.h            |  1 -
 include/media/cec.h                                |  2 --
 include/media/media-entity.h                       |  4 ---
 include/media/v4l2-vp9.h                           |  6 +++-
 include/uapi/linux/videodev2.h                     | 32 +++++++++++-----------
 20 files changed, 25 insertions(+), 47 deletions(-)
---
base-commit: 615d300648869c774bd1fe54b4627bb0c20faed4
change-id: 20240126-gix-mtk-warnings-7c70f653717b

Best regards,

Comments

Randy Dunlap Jan. 27, 2024, 1:38 a.m. UTC | #1
On 1/26/24 15:16, Ricardo Ribalda wrote:
> These fields seems to be gone:
> drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_vp8_req_if.c:57: warning: Excess struct member 'wait_key_frame' description in 'vdec_vp8_slice_info'
> drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_vp9_req_lat_if.c:166: warning: Excess struct member 'mv_joint' description in 'vdec_vp9_slice_counts_map'
> 
> Signed-off-by: Ricardo Ribalda <ribalda@chromium.org>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
>  drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_vp8_req_if.c    | 1 -
>  .../media/platform/mediatek/vcodec/decoder/vdec/vdec_vp9_req_lat_if.c    | 1 -
>  2 files changed, 2 deletions(-)
> 
> diff --git a/drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_vp8_req_if.c b/drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_vp8_req_if.c
> index f64b21c07169..f677e499fefa 100644
> --- a/drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_vp8_req_if.c
> +++ b/drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_vp8_req_if.c
> @@ -37,7 +37,6 @@
>   * @bs_sz:		bitstream size
>   * @resolution_changed:resolution change flag 1 - changed,  0 - not change
>   * @frame_header_type:	current frame header type
> - * @wait_key_frame:	wait key frame coming
>   * @crc:		used to check whether hardware's status is right
>   * @reserved:		reserved, currently unused
>   */
> diff --git a/drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_vp9_req_lat_if.c b/drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_vp9_req_lat_if.c
> index 69d37b93bd35..cf48d09b78d7 100644
> --- a/drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_vp9_req_lat_if.c
> +++ b/drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_vp9_req_lat_if.c
> @@ -141,7 +141,6 @@ struct vdec_vp9_slice_frame_counts {
>   * @skip:	skip counts.
>   * @y_mode:	Y prediction mode counts.
>   * @filter:	interpolation filter counts.
> - * @mv_joint:	motion vector joint counts.
>   * @sign:	motion vector sign counts.
>   * @classes:	motion vector class counts.
>   * @class0:	motion vector class0 bit counts.
>
Randy Dunlap Jan. 27, 2024, 1:51 a.m. UTC | #2
On 1/26/24 15:16, Ricardo Ribalda wrote:
> The fields seems to be documented twice.
> 
> Signed-off-by: Ricardo Ribalda <ribalda@chromium.org>
> ---
>  include/media/media-entity.h | 4 ----
>  1 file changed, 4 deletions(-)
> 
> diff --git a/include/media/media-entity.h b/include/media/media-entity.h
> index 2b6cd343ee9e..c79176ed6299 100644
> --- a/include/media/media-entity.h
> +++ b/include/media/media-entity.h
> @@ -337,10 +337,6 @@ enum media_entity_type {
>   * @info.dev:	Contains device major and minor info.
>   * @info.dev.major: device node major, if the device is a devnode.
>   * @info.dev.minor: device node minor, if the device is a devnode.
> - * @major:	Devnode major number (zero if not applicable). Kept just
> - *		for backward compatibility.
> - * @minor:	Devnode minor number (zero if not applicable). Kept just
> - *		for backward compatibility.
>   *
>   * .. note::
>   *
> 

I'd say that this is correct based on
https://patchwork.kernel.org/project/linux-media/patch/20231223050707.14091-1-rdunlap@infradead.org/


Hans, can you please explain this message from you, on 2024-Jan-22, that I cannot find in the media patchwork:


Subject: [git:media_stage/master] media: media-entity.h: fix Excess kernel-doc description warnings



This is an automatic generated email to let you know that the following patch were queued:

Subject: media: media-entity.h: fix Excess kernel-doc description warnings
Author:  Randy Dunlap <rdunlap@infradead.org>
Date:    Fri Dec 22 21:07:07 2023 -0800

Remove the @major: and @minor: lines to prevent the kernel-doc warnings:

include/media/media-entity.h:376: warning: Excess struct member 'major' description in 'media_entity'
include/media/media-entity.h:376: warning: Excess struct member 'minor' description in 'media_entity'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>

 include/media/media-entity.h | 4 ----
 1 file changed, 4 deletions(-)

---

diff --git a/include/media/media-entity.h b/include/media/media-entity.h
index 2b6cd343ee9e..c79176ed6299 100644
--- a/include/media/media-entity.h
+++ b/include/media/media-entity.h
@@ -337,10 +337,6 @@ enum media_entity_type {
  * @info.dev:	Contains device major and minor info.
  * @info.dev.major: device node major, if the device is a devnode.
  * @info.dev.minor: device node minor, if the device is a devnode.
- * @major:	Devnode major number (zero if not applicable). Kept just
- *		for backward compatibility.
- * @minor:	Devnode minor number (zero if not applicable). Kept just
- *		for backward compatibility.
  *
  * .. note::
  *



Thanks.
Sakari Ailus Jan. 27, 2024, 9:48 a.m. UTC | #3
Hi Ricardo,

Thanks for the patchset.

On Fri, Jan 26, 2024 at 11:16:02PM +0000, Ricardo Ribalda wrote:
> The fields seems to be documented twice.
> 
> Signed-off-by: Ricardo Ribalda <ribalda@chromium.org>
> ---
>  include/media/media-entity.h | 4 ----
>  1 file changed, 4 deletions(-)
> 
> diff --git a/include/media/media-entity.h b/include/media/media-entity.h
> index 2b6cd343ee9e..c79176ed6299 100644
> --- a/include/media/media-entity.h
> +++ b/include/media/media-entity.h
> @@ -337,10 +337,6 @@ enum media_entity_type {
>   * @info.dev:	Contains device major and minor info.
>   * @info.dev.major: device node major, if the device is a devnode.
>   * @info.dev.minor: device node minor, if the device is a devnode.
> - * @major:	Devnode major number (zero if not applicable). Kept just
> - *		for backward compatibility.
> - * @minor:	Devnode minor number (zero if not applicable). Kept just
> - *		for backward compatibility.

A similar patch by Randy Dunlap was recently merged. You can drop this one.

>   *
>   * .. note::
>   *
>
Sakari Ailus Jan. 27, 2024, 9:57 a.m. UTC | #4
Hi Ricardo,

On Fri, Jan 26, 2024 at 11:16:16PM +0000, Ricardo Ribalda wrote:
> Kerneldoc cannot understand arrays defined like
> v4l2_frame_symbol_counts.
> 
> Adding an asterisk to the name does do the trick.
> 
> Disable the kerneldoc notation for now, it is already ignored:
> https://docs.kernel.org/search.html?q=v4l2_vp9_frame_symbol_counts

Wouldn't it be nicer to fix kerneldoc instead? It might not be difficult at
all.

Feel free to, but I can also give it a try.
Sakari Ailus Jan. 27, 2024, 6:40 p.m. UTC | #5
Hi Randy,

On Fri, Jan 26, 2024 at 05:51:06PM -0800, Randy Dunlap wrote:
> 
> 
> On 1/26/24 15:16, Ricardo Ribalda wrote:
> > The fields seems to be documented twice.
> > 
> > Signed-off-by: Ricardo Ribalda <ribalda@chromium.org>
> > ---
> >  include/media/media-entity.h | 4 ----
> >  1 file changed, 4 deletions(-)
> > 
> > diff --git a/include/media/media-entity.h b/include/media/media-entity.h
> > index 2b6cd343ee9e..c79176ed6299 100644
> > --- a/include/media/media-entity.h
> > +++ b/include/media/media-entity.h
> > @@ -337,10 +337,6 @@ enum media_entity_type {
> >   * @info.dev:	Contains device major and minor info.
> >   * @info.dev.major: device node major, if the device is a devnode.
> >   * @info.dev.minor: device node minor, if the device is a devnode.
> > - * @major:	Devnode major number (zero if not applicable). Kept just
> > - *		for backward compatibility.
> > - * @minor:	Devnode minor number (zero if not applicable). Kept just
> > - *		for backward compatibility.
> >   *
> >   * .. note::
> >   *
> > 
> 
> I'd say that this is correct based on
> https://patchwork.kernel.org/project/linux-media/patch/20231223050707.14091-1-rdunlap@infradead.org/
> 
> 
> Hans, can you please explain this message from you, on 2024-Jan-22, that
> I cannot find in the media patchwork:

It's in linuxtv.org Patchwork here
<URL:https://patchwork.linuxtv.org/project/linux-media/patch/20231223050707.14091-1-rdunlap@infradead.org/>
and also in the media stage tree (as indicated by the state) but not yet in
master AFAIU.

> 
> 
> Subject: [git:media_stage/master] media: media-entity.h: fix Excess kernel-doc description warnings
> 
> 
> 
> This is an automatic generated email to let you know that the following patch were queued:
> 
> Subject: media: media-entity.h: fix Excess kernel-doc description warnings
> Author:  Randy Dunlap <rdunlap@infradead.org>
> Date:    Fri Dec 22 21:07:07 2023 -0800
> 
> Remove the @major: and @minor: lines to prevent the kernel-doc warnings:
> 
> include/media/media-entity.h:376: warning: Excess struct member 'major' description in 'media_entity'
> include/media/media-entity.h:376: warning: Excess struct member 'minor' description in 'media_entity'
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
> Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
> 
>  include/media/media-entity.h | 4 ----
>  1 file changed, 4 deletions(-)
> 
> ---
> 
> diff --git a/include/media/media-entity.h b/include/media/media-entity.h
> index 2b6cd343ee9e..c79176ed6299 100644
> --- a/include/media/media-entity.h
> +++ b/include/media/media-entity.h
> @@ -337,10 +337,6 @@ enum media_entity_type {
>   * @info.dev:	Contains device major and minor info.
>   * @info.dev.major: device node major, if the device is a devnode.
>   * @info.dev.minor: device node minor, if the device is a devnode.
> - * @major:	Devnode major number (zero if not applicable). Kept just
> - *		for backward compatibility.
> - * @minor:	Devnode minor number (zero if not applicable). Kept just
> - *		for backward compatibility.
>   *
>   * .. note::
>   *
> 
> 
> 
> Thanks.
Randy Dunlap Jan. 27, 2024, 8:50 p.m. UTC | #6
On 1/27/24 10:40, Sakari Ailus wrote:
> Hi Randy,
> 
> On Fri, Jan 26, 2024 at 05:51:06PM -0800, Randy Dunlap wrote:
>>
>>
>> On 1/26/24 15:16, Ricardo Ribalda wrote:
>>> The fields seems to be documented twice.
>>>
>>> Signed-off-by: Ricardo Ribalda <ribalda@chromium.org>
>>> ---
>>>  include/media/media-entity.h | 4 ----
>>>  1 file changed, 4 deletions(-)
>>>
>>> diff --git a/include/media/media-entity.h b/include/media/media-entity.h
>>> index 2b6cd343ee9e..c79176ed6299 100644
>>> --- a/include/media/media-entity.h
>>> +++ b/include/media/media-entity.h
>>> @@ -337,10 +337,6 @@ enum media_entity_type {
>>>   * @info.dev:	Contains device major and minor info.
>>>   * @info.dev.major: device node major, if the device is a devnode.
>>>   * @info.dev.minor: device node minor, if the device is a devnode.
>>> - * @major:	Devnode major number (zero if not applicable). Kept just
>>> - *		for backward compatibility.
>>> - * @minor:	Devnode minor number (zero if not applicable). Kept just
>>> - *		for backward compatibility.
>>>   *
>>>   * .. note::
>>>   *
>>>
>>
>> I'd say that this is correct based on
>> https://patchwork.kernel.org/project/linux-media/patch/20231223050707.14091-1-rdunlap@infradead.org/
>>

Ah, I see. Thank you.

>>
>> Hans, can you please explain this message from you, on 2024-Jan-22, that
>> I cannot find in the media patchwork:
> 
> It's in linuxtv.org Patchwork here
> <URL:https://patchwork.linuxtv.org/project/linux-media/patch/20231223050707.14091-1-rdunlap@infradead.org/>
> and also in the media stage tree (as indicated by the state) but not yet in
> master AFAIU.
> 
>>
>>
>> Subject: [git:media_stage/master] media: media-entity.h: fix Excess kernel-doc description warnings
>>
>>
>>
>> This is an automatic generated email to let you know that the following patch were queued:
>>
>> Subject: media: media-entity.h: fix Excess kernel-doc description warnings
>> Author:  Randy Dunlap <rdunlap@infradead.org>
>> Date:    Fri Dec 22 21:07:07 2023 -0800
>>
>> Remove the @major: and @minor: lines to prevent the kernel-doc warnings:
>>
>> include/media/media-entity.h:376: warning: Excess struct member 'major' description in 'media_entity'
>> include/media/media-entity.h:376: warning: Excess struct member 'minor' description in 'media_entity'
>>
>> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
>> Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
>> Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
>> Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
>>
>>  include/media/media-entity.h | 4 ----
>>  1 file changed, 4 deletions(-)
>>
>> ---
>>
>> diff --git a/include/media/media-entity.h b/include/media/media-entity.h
>> index 2b6cd343ee9e..c79176ed6299 100644
>> --- a/include/media/media-entity.h
>> +++ b/include/media/media-entity.h
>> @@ -337,10 +337,6 @@ enum media_entity_type {
>>   * @info.dev:	Contains device major and minor info.
>>   * @info.dev.major: device node major, if the device is a devnode.
>>   * @info.dev.minor: device node minor, if the device is a devnode.
>> - * @major:	Devnode major number (zero if not applicable). Kept just
>> - *		for backward compatibility.
>> - * @minor:	Devnode minor number (zero if not applicable). Kept just
>> - *		for backward compatibility.
>>   *
>>   * .. note::
>>   *
>>
>>
>>
>> Thanks.
>
Randy Dunlap Jan. 27, 2024, 9:03 p.m. UTC | #7
On 1/26/24 15:16, Ricardo Ribalda wrote:
> The field is gone, remove it.
> 
> Signed-off-by: Ricardo Ribalda <ribalda@chromium.org>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
>  drivers/media/pci/dt3155/dt3155.h | 1 -
>  1 file changed, 1 deletion(-)
> 
> diff --git a/drivers/media/pci/dt3155/dt3155.h b/drivers/media/pci/dt3155/dt3155.h
> index c9ce79cb5566..ce1835d9691e 100644
> --- a/drivers/media/pci/dt3155/dt3155.h
> +++ b/drivers/media/pci/dt3155/dt3155.h
> @@ -162,7 +162,6 @@
>   * @height:		frame height
>   * @input:		current input
>   * @sequence:		frame counter
> - * @stats:		statistics structure
>   * @regs:		local copy of mmio base register
>   * @csr2:		local copy of csr2 register
>   * @config:		local copy of config register
>
Randy Dunlap Jan. 27, 2024, 10:02 p.m. UTC | #8
On 1/26/24 15:16, Ricardo Ribalda wrote:
> The field is gone, remove the documentation.
> 
> Signed-off-by: Ricardo Ribalda <ribalda@chromium.org>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Thanks.

> ---
>  drivers/media/i2c/adv748x/adv748x.h | 1 -
>  1 file changed, 1 deletion(-)
> 
> diff --git a/drivers/media/i2c/adv748x/adv748x.h b/drivers/media/i2c/adv748x/adv748x.h
> index 6f90f78f58cf..d2b5e722e997 100644
> --- a/drivers/media/i2c/adv748x/adv748x.h
> +++ b/drivers/media/i2c/adv748x/adv748x.h
> @@ -173,7 +173,6 @@ struct adv748x_afe {
>   *
>   * @endpoints:		parsed device node endpoints for each port
>   *
> - * @i2c_addresses:	I2C Page addresses
>   * @i2c_clients:	I2C clients for the page accesses
>   * @regmap:		regmap configuration pages.
>   *
>
Randy Dunlap Jan. 27, 2024, 10:07 p.m. UTC | #9
On 1/26/24 15:16, Ricardo Ribalda wrote:
> Those fields have been removed. They do not need to be documented.
> 
> Signed-off-by: Ricardo Ribalda <ribalda@chromium.org>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Thanks.

> ---
>  drivers/media/platform/mediatek/vcodec/decoder/mtk_vcodec_dec.h | 1 -
>  drivers/media/platform/mediatek/vcodec/decoder/vdec_vpu_if.h    | 1 -
>  drivers/media/platform/mediatek/vcodec/encoder/mtk_vcodec_enc.h | 1 -
>  3 files changed, 3 deletions(-)
> 
> diff --git a/drivers/media/platform/mediatek/vcodec/decoder/mtk_vcodec_dec.h b/drivers/media/platform/mediatek/vcodec/decoder/mtk_vcodec_dec.h
> index ece27c880e50..1af075fc0194 100644
> --- a/drivers/media/platform/mediatek/vcodec/decoder/mtk_vcodec_dec.h
> +++ b/drivers/media/platform/mediatek/vcodec/decoder/mtk_vcodec_dec.h
> @@ -39,7 +39,6 @@ struct vdec_fb {
>  /**
>   * struct mtk_video_dec_buf - Private data related to each VB2 buffer.
>   * @m2m_buf:	M2M buffer
> - * @list:	link list
>   * @used:	Capture buffer contain decoded frame data and keep in
>   *			codec data structure
>   * @queued_in_vb2:	Capture buffer is queue in vb2
> diff --git a/drivers/media/platform/mediatek/vcodec/decoder/vdec_vpu_if.h b/drivers/media/platform/mediatek/vcodec/decoder/vdec_vpu_if.h
> index fbb3f34a73f0..aa7d08afc2f4 100644
> --- a/drivers/media/platform/mediatek/vcodec/decoder/vdec_vpu_if.h
> +++ b/drivers/media/platform/mediatek/vcodec/decoder/vdec_vpu_if.h
> @@ -22,7 +22,6 @@ struct mtk_vcodec_dec_ctx;
>   *                in place of inst_addr in messages.
>   * @signaled    : 1 - Host has received ack message from VPU, 0 - not received
>   * @ctx         : context for v4l2 layer integration
> - * @dev		: platform device of VPU
>   * @wq          : wait queue to wait VPU message ack
>   * @handler     : ipi handler for each decoder
>   * @codec_type     : use codec type to separate different codecs
> diff --git a/drivers/media/platform/mediatek/vcodec/encoder/mtk_vcodec_enc.h b/drivers/media/platform/mediatek/vcodec/encoder/mtk_vcodec_enc.h
> index 82246401ed4a..908d8179b2d2 100644
> --- a/drivers/media/platform/mediatek/vcodec/encoder/mtk_vcodec_enc.h
> +++ b/drivers/media/platform/mediatek/vcodec/encoder/mtk_vcodec_enc.h
> @@ -26,7 +26,6 @@
>  /**
>   * struct mtk_video_enc_buf - Private data related to each VB2 buffer.
>   * @m2m_buf:	M2M buffer
> - * @list:	list that buffer link to
>   * @param_change: Types of encode parameter change before encoding this
>   *				buffer
>   * @enc_params: Encode parameters changed before encode this buffer
>
Randy Dunlap Jan. 27, 2024, 10:13 p.m. UTC | #10
Hi,

On 1/26/24 15:16, Ricardo Ribalda wrote:
> Remove doc for missing field.
> 
> Signed-off-by: Ricardo Ribalda <ribalda@chromium.org>
> ---
>  drivers/media/platform/qcom/venus/core.h | 1 -
>  1 file changed, 1 deletion(-)
> 
> diff --git a/drivers/media/platform/qcom/venus/core.h b/drivers/media/platform/qcom/venus/core.h
> index 4a633261ece4..a39986ce79f1 100644
> --- a/drivers/media/platform/qcom/venus/core.h
> +++ b/drivers/media/platform/qcom/venus/core.h
> @@ -428,7 +428,6 @@ enum venus_inst_modes {
>   * @error:	an error returned during last HFI sync operation
>   * @session_error:	a flag rised by HFI interface in case of session error
>   * @ops:		HFI operations
> - * @priv:	a private for HFI operations callbacks
>   * @session_type:	the type of the session (decoder or encoder)
>   * @hprop:	a union used as a holder by get property
>   * @core_acquired:	the Core has been acquired
> 

I don't understand this one. I do understand the patch above, but the in the struct,
I see:

	unsigned long enc_codecs;
	unsigned long dec_codecs;
	unsigned int max_sessions_supported;
	void *priv;
	const struct hfi_ops *ops;
	struct delayed_work work;

I'm just guessing, but maybe scripts/kernel-doc is confused....
Randy Dunlap Jan. 27, 2024, 10:14 p.m. UTC | #11
On 1/27/24 14:13, Randy Dunlap wrote:
> Hi,
> 
> On 1/26/24 15:16, Ricardo Ribalda wrote:
>> Remove doc for missing field.
>>
>> Signed-off-by: Ricardo Ribalda <ribalda@chromium.org>
>> ---
>>  drivers/media/platform/qcom/venus/core.h | 1 -
>>  1 file changed, 1 deletion(-)
>>
>> diff --git a/drivers/media/platform/qcom/venus/core.h b/drivers/media/platform/qcom/venus/core.h
>> index 4a633261ece4..a39986ce79f1 100644
>> --- a/drivers/media/platform/qcom/venus/core.h
>> +++ b/drivers/media/platform/qcom/venus/core.h
>> @@ -428,7 +428,6 @@ enum venus_inst_modes {
>>   * @error:	an error returned during last HFI sync operation
>>   * @session_error:	a flag rised by HFI interface in case of session error
>>   * @ops:		HFI operations
>> - * @priv:	a private for HFI operations callbacks
>>   * @session_type:	the type of the session (decoder or encoder)
>>   * @hprop:	a union used as a holder by get property
>>   * @core_acquired:	the Core has been acquired
>>
> 
> I don't understand this one. I do understand the patch above, but the in the struct,
> I see:
> 
> 	unsigned long enc_codecs;
> 	unsigned long dec_codecs;
> 	unsigned int max_sessions_supported;
> 	void *priv;
> 	const struct hfi_ops *ops;
> 	struct delayed_work work;
> 
> I'm just guessing, but maybe scripts/kernel-doc is confused....
> 

Nope, I'm confused. The patch is correct.
Thanks.

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Randy Dunlap Jan. 27, 2024, 10:17 p.m. UTC | #12
On 1/26/24 15:16, Ricardo Ribalda wrote:
> Remove doc from missing fields.
> 
> Signed-off-by: Ricardo Ribalda <ribalda@chromium.org>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Thanks.

> ---
>  drivers/media/platform/samsung/s5p-mfc/s5p_mfc_common.h | 1 -
>  1 file changed, 1 deletion(-)
> 
> diff --git a/drivers/media/platform/samsung/s5p-mfc/s5p_mfc_common.h b/drivers/media/platform/samsung/s5p-mfc/s5p_mfc_common.h
> index 59450b324f7d..7e7e7b695b53 100644
> --- a/drivers/media/platform/samsung/s5p-mfc/s5p_mfc_common.h
> +++ b/drivers/media/platform/samsung/s5p-mfc/s5p_mfc_common.h
> @@ -612,7 +612,6 @@ struct s5p_mfc_codec_ops {
>   * @chroma_dpb_size:	dpb buffer size for chroma
>   * @me_buffer_size:	size of the motion estimation buffer
>   * @tmv_buffer_size:	size of temporal predictor motion vector buffer
> - * @frame_type:		used to force the type of the next encoded frame
>   * @ref_queue:		list of the reference buffers for encoding
>   * @force_frame_type:	encoder's frame type forcing control
>   * @ref_queue_cnt:	number of the buffers in the reference list
>
Randy Dunlap Jan. 27, 2024, 10:22 p.m. UTC | #13
On 1/26/24 15:16, Ricardo Ribalda wrote:
> Remove documentation from missing fields.
> 
> Signed-off-by: Ricardo Ribalda <ribalda@chromium.org>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Thanks.

> ---
>  drivers/staging/media/ipu3/include/uapi/intel-ipu3.h | 3 ---
>  1 file changed, 3 deletions(-)
> 
> diff --git a/drivers/staging/media/ipu3/include/uapi/intel-ipu3.h b/drivers/staging/media/ipu3/include/uapi/intel-ipu3.h
> index caa358e0bae4..4aa2797f5e3c 100644
> --- a/drivers/staging/media/ipu3/include/uapi/intel-ipu3.h
> +++ b/drivers/staging/media/ipu3/include/uapi/intel-ipu3.h
> @@ -2485,11 +2485,9 @@ struct ipu3_uapi_anr_config {
>   *		&ipu3_uapi_yuvp1_y_ee_nr_config
>   * @yds:	y down scaler config. See &ipu3_uapi_yuvp1_yds_config
>   * @chnr:	chroma noise reduction config. See &ipu3_uapi_yuvp1_chnr_config
> - * @reserved1: reserved
>   * @yds2:	y channel down scaler config. See &ipu3_uapi_yuvp1_yds_config
>   * @tcc:	total color correction config as defined in struct
>   *		&ipu3_uapi_yuvp2_tcc_static_config
> - * @reserved2: reserved
>   * @anr:	advanced noise reduction config.See &ipu3_uapi_anr_config
>   * @awb_fr:	AWB filter response config. See ipu3_uapi_awb_fr_config
>   * @ae:	auto exposure config  As specified by &ipu3_uapi_ae_config
> @@ -2724,7 +2722,6 @@ struct ipu3_uapi_obgrid_param {
>   * @acc_ae: 0 = no update, 1 = update.
>   * @acc_af: 0 = no update, 1 = update.
>   * @acc_awb: 0 = no update, 1 = update.
> - * @__acc_osys: 0 = no update, 1 = update.
>   * @reserved3: Not used.
>   * @lin_vmem_params: 0 = no update, 1 = update.
>   * @tnr3_vmem_params: 0 = no update, 1 = update.
>
Kieran Bingham Jan. 28, 2024, 11:01 a.m. UTC | #14
Quoting Ricardo Ribalda (2024-01-26 23:16:06)
> The field is gone, remove the documentation.

Looking at 3e89586a64df ("media: i2c: adv748x: add adv748x driver")
confims it was never added. Must have been an old leftover when I
upstreamed.

Thanks for the fix.

Reviewed-by: Kieran Bingham <kieran.bingham+renesas@ideasonboard.com>

> Signed-off-by: Ricardo Ribalda <ribalda@chromium.org>
> ---
>  drivers/media/i2c/adv748x/adv748x.h | 1 -
>  1 file changed, 1 deletion(-)
> 
> diff --git a/drivers/media/i2c/adv748x/adv748x.h b/drivers/media/i2c/adv748x/adv748x.h
> index 6f90f78f58cf..d2b5e722e997 100644
> --- a/drivers/media/i2c/adv748x/adv748x.h
> +++ b/drivers/media/i2c/adv748x/adv748x.h
> @@ -173,7 +173,6 @@ struct adv748x_afe {
>   *
>   * @endpoints:         parsed device node endpoints for each port
>   *
> - * @i2c_addresses:     I2C Page addresses
>   * @i2c_clients:       I2C clients for the page accesses
>   * @regmap:            regmap configuration pages.
>   *
> 
> -- 
> 2.43.0.429.g432eaa2c6b-goog
>
AngeloGioacchino Del Regno Jan. 29, 2024, 10:08 a.m. UTC | #15
Il 27/01/24 00:16, Ricardo Ribalda ha scritto:
> These fields seems to be gone:
> drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_vp8_req_if.c:57: warning: Excess struct member 'wait_key_frame' description in 'vdec_vp8_slice_info'
> drivers/media/platform/mediatek/vcodec/decoder/vdec/vdec_vp9_req_lat_if.c:166: warning: Excess struct member 'mv_joint' description in 'vdec_vp9_slice_counts_map'
> 
> Signed-off-by: Ricardo Ribalda <ribalda@chromium.org>

Reviewed-by: AngeloGioacchino Del Regno <angelogioacchino.delregno@collabora.com>