[PATCH] media: venus: core.h: update kerneldoc

[PATCH] media: venus: core.h: update kerneldoc

[Hans Verkuil]

Document missing fields. This resolves two warnings:

drivers/media/platform/qcom/venus/core.h:226: warning: Function parameter or member 'venus_ver' not described in 'venus_core'
drivers/media/platform/qcom/venus/core.h:501: warning: Function parameter or member 'enc_state' not described in 'venus_inst'

Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
---
 drivers/media/platform/qcom/venus/core.h | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/drivers/media/platform/qcom/venus/core.h b/drivers/media/platform/qcom/venus/core.h
index 320bde0f83cb..df78bc297c11 100644
--- a/drivers/media/platform/qcom/venus/core.h
+++ b/drivers/media/platform/qcom/venus/core.h
@@ -160,6 +160,7 @@ struct venus_format {
  * @core0_usage_count: usage counter for core0
  * @core1_usage_count: usage counter for core1
  * @root:	debugfs root directory
+ * @venus_ver:	the venus firmware version
  */
 struct venus_core {
 	void __iomem *base;
@@ -386,7 +387,8 @@ enum venus_inst_modes {
  * @ycbcr_enc:	current YCbCr encoding
  * @quantization:	current quantization
  * @xfer_func:	current xfer function
- * @codec_state:	current codec API state (see DEC/ENC_STATE_)
+ * @codec_state:	current decoder API state (see DEC_STATE_)
+ * @enc_state:		current encoder API state (see ENC_STATE_)
  * @reconf_wait:	wait queue for resolution change event
  * @subscriptions:	used to hold current events subscriptions
  * @buf_count:		used to count number of buffers (reqbuf(0))
-- 
2.40.1

Re: [PATCH] media: venus: core.h: update kerneldoc

[Dikshita Agarwal]

On 7/20/2023 12:49 PM, Hans Verkuil wrote:
> Document missing fields. This resolves two warnings:
> 
> drivers/media/platform/qcom/venus/core.h:226: warning: Function parameter or member 'venus_ver' not described in 'venus_core'
> drivers/media/platform/qcom/venus/core.h:501: warning: Function parameter or member 'enc_state' not described in 'venus_inst'
> 
> Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
> ---

Thanks for this fix.
Reviewed-by: Dikshita Agarwal <quic_dikshita@quicinc.com>

>  drivers/media/platform/qcom/venus/core.h | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
> 
> diff --git a/drivers/media/platform/qcom/venus/core.h b/drivers/media/platform/qcom/venus/core.h
> index 320bde0f83cb..df78bc297c11 100644
> --- a/drivers/media/platform/qcom/venus/core.h
> +++ b/drivers/media/platform/qcom/venus/core.h
> @@ -160,6 +160,7 @@ struct venus_format {
>   * @core0_usage_count: usage counter for core0
>   * @core1_usage_count: usage counter for core1
>   * @root:	debugfs root directory
> + * @venus_ver:	the venus firmware version
>   */
>  struct venus_core {
>  	void __iomem *base;
> @@ -386,7 +387,8 @@ enum venus_inst_modes {
>   * @ycbcr_enc:	current YCbCr encoding
>   * @quantization:	current quantization
>   * @xfer_func:	current xfer function
> - * @codec_state:	current codec API state (see DEC/ENC_STATE_)
> + * @codec_state:	current decoder API state (see DEC_STATE_)
> + * @enc_state:		current encoder API state (see ENC_STATE_)
>   * @reconf_wait:	wait queue for resolution change event
>   * @subscriptions:	used to hold current events subscriptions
>   * @buf_count:		used to count number of buffers (reqbuf(0))