[PATCH] firmware: qcom: tzmem: area: fix qcom_tzmem_policy kernel-doc

[PATCH] firmware: qcom: tzmem: area: fix qcom_tzmem_policy kernel-doc

[Randy Dunlap]

Fix kernel-doc warnings by using correct kernel-doc syntax and
formatting to prevent warnings:

Warning: include/linux/firmware/qcom/qcom_tzmem.h:25 Enum value
 'QCOM_TZMEM_POLICY_STATIC' not described in enum 'qcom_tzmem_policy'
Warning: ../include/linux/firmware/qcom/qcom_tzmem.h:25 Enum value
 'QCOM_TZMEM_POLICY_MULTIPLIER' not described in enum 'qcom_tzmem_policy'
Warning: ../include/linux/firmware/qcom/qcom_tzmem.h:25 Enum value
 'QCOM_TZMEM_POLICY_ON_DEMAND' not described in enum 'qcom_tzmem_policy'

Fixes: 84f5a7b67b61 ("firmware: qcom: add a dedicated TrustZone buffer allocator")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
Cc: Bjorn Andersson <andersson@kernel.org>
Cc: Konrad Dybcio <konradybcio@kernel.org>
Cc: linux-arm-msm@vger.kernel.org
---
 include/linux/firmware/qcom/qcom_tzmem.h |   12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

--- linux-next-20251016.orig/include/linux/firmware/qcom/qcom_tzmem.h
+++ linux-next-20251016/include/linux/firmware/qcom/qcom_tzmem.h
@@ -17,11 +17,17 @@ struct qcom_tzmem_pool;
  * enum qcom_tzmem_policy - Policy for pool growth.
  */
 enum qcom_tzmem_policy {
-	/**< Static pool, never grow above initial size. */
+	/**
+	 * @QCOM_TZMEM_POLICY_STATIC: Static pool,
+	 * never grow above initial size. */
 	QCOM_TZMEM_POLICY_STATIC = 1,
-	/**< When out of memory, add increment * current size of memory. */
+	/**
+	 * @QCOM_TZMEM_POLICY_MULTIPLIER: When out of memory,
+	 * add increment * current size of memory. */
 	QCOM_TZMEM_POLICY_MULTIPLIER,
-	/**< When out of memory add as much as is needed until max_size. */
+	/**
+	 * @QCOM_TZMEM_POLICY_ON_DEMAND: When out of memory
+	 * add as much as is needed until max_size. */
 	QCOM_TZMEM_POLICY_ON_DEMAND,
 };
 

Re: [PATCH] firmware: qcom: tzmem: area: fix qcom_tzmem_policy kernel-doc

[Konrad Dybcio]

On 10/17/25 9:07 AM, Randy Dunlap wrote:
> Fix kernel-doc warnings by using correct kernel-doc syntax and
> formatting to prevent warnings:
> 
> Warning: include/linux/firmware/qcom/qcom_tzmem.h:25 Enum value
>  'QCOM_TZMEM_POLICY_STATIC' not described in enum 'qcom_tzmem_policy'
> Warning: ../include/linux/firmware/qcom/qcom_tzmem.h:25 Enum value
>  'QCOM_TZMEM_POLICY_MULTIPLIER' not described in enum 'qcom_tzmem_policy'
> Warning: ../include/linux/firmware/qcom/qcom_tzmem.h:25 Enum value
>  'QCOM_TZMEM_POLICY_ON_DEMAND' not described in enum 'qcom_tzmem_policy'
> 
> Fixes: 84f5a7b67b61 ("firmware: qcom: add a dedicated TrustZone buffer allocator")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> ---
> Cc: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
> Cc: Bjorn Andersson <andersson@kernel.org>
> Cc: Konrad Dybcio <konradybcio@kernel.org>
> Cc: linux-arm-msm@vger.kernel.org
> ---
>  include/linux/firmware/qcom/qcom_tzmem.h |   12 +++++++++---
>  1 file changed, 9 insertions(+), 3 deletions(-)
> 
> --- linux-next-20251016.orig/include/linux/firmware/qcom/qcom_tzmem.h
> +++ linux-next-20251016/include/linux/firmware/qcom/qcom_tzmem.h
> @@ -17,11 +17,17 @@ struct qcom_tzmem_pool;
>   * enum qcom_tzmem_policy - Policy for pool growth.
>   */
>  enum qcom_tzmem_policy {
> -	/**< Static pool, never grow above initial size. */
> +	/**
> +	 * @QCOM_TZMEM_POLICY_STATIC: Static pool,
> +	 * never grow above initial size. */

Didn't know inline '*/' was cool, but if the checkers I'm happy, I'm not
going to complain either

Reviewed-by: Konrad Dybcio <konrad.dybcio@oss.qualcomm.com>

Konrad

Re: [PATCH] firmware: qcom: tzmem: area: fix qcom_tzmem_policy kernel-doc

[Bartosz Golaszewski]

On Fri, 17 Oct 2025 at 10:17, Konrad Dybcio
<konrad.dybcio@oss.qualcomm.com> wrote:
>
> On 10/17/25 9:07 AM, Randy Dunlap wrote:
> > Fix kernel-doc warnings by using correct kernel-doc syntax and
> > formatting to prevent warnings:
> >
> > Warning: include/linux/firmware/qcom/qcom_tzmem.h:25 Enum value
> >  'QCOM_TZMEM_POLICY_STATIC' not described in enum 'qcom_tzmem_policy'
> > Warning: ../include/linux/firmware/qcom/qcom_tzmem.h:25 Enum value
> >  'QCOM_TZMEM_POLICY_MULTIPLIER' not described in enum 'qcom_tzmem_policy'
> > Warning: ../include/linux/firmware/qcom/qcom_tzmem.h:25 Enum value
> >  'QCOM_TZMEM_POLICY_ON_DEMAND' not described in enum 'qcom_tzmem_policy'
> >
> > Fixes: 84f5a7b67b61 ("firmware: qcom: add a dedicated TrustZone buffer allocator")
> > Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> > ---
> > Cc: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
> > Cc: Bjorn Andersson <andersson@kernel.org>
> > Cc: Konrad Dybcio <konradybcio@kernel.org>
> > Cc: linux-arm-msm@vger.kernel.org
> > ---
> >  include/linux/firmware/qcom/qcom_tzmem.h |   12 +++++++++---
> >  1 file changed, 9 insertions(+), 3 deletions(-)
> >
> > --- linux-next-20251016.orig/include/linux/firmware/qcom/qcom_tzmem.h
> > +++ linux-next-20251016/include/linux/firmware/qcom/qcom_tzmem.h
> > @@ -17,11 +17,17 @@ struct qcom_tzmem_pool;
> >   * enum qcom_tzmem_policy - Policy for pool growth.
> >   */
> >  enum qcom_tzmem_policy {
> > -     /**< Static pool, never grow above initial size. */
> > +     /**
> > +      * @QCOM_TZMEM_POLICY_STATIC: Static pool,
> > +      * never grow above initial size. */
>
> Didn't know inline '*/' was cool, but if the checkers I'm happy, I'm not
> going to complain either
>
> Reviewed-by: Konrad Dybcio <konrad.dybcio@oss.qualcomm.com>
>
> Konrad

Yes, very surprising. Almost doesn't look "right".

Anyway:
Reviewed-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>

Re: [PATCH] firmware: qcom: tzmem: area: fix qcom_tzmem_policy kernel-doc

[Randy Dunlap]

On 10/17/25 1:25 AM, Bartosz Golaszewski wrote:
> On Fri, 17 Oct 2025 at 10:17, Konrad Dybcio
> <konrad.dybcio@oss.qualcomm.com> wrote:
>>
>> On 10/17/25 9:07 AM, Randy Dunlap wrote:
>>> Fix kernel-doc warnings by using correct kernel-doc syntax and
>>> formatting to prevent warnings:
>>>
>>> Warning: include/linux/firmware/qcom/qcom_tzmem.h:25 Enum value
>>>  'QCOM_TZMEM_POLICY_STATIC' not described in enum 'qcom_tzmem_policy'
>>> Warning: ../include/linux/firmware/qcom/qcom_tzmem.h:25 Enum value
>>>  'QCOM_TZMEM_POLICY_MULTIPLIER' not described in enum 'qcom_tzmem_policy'
>>> Warning: ../include/linux/firmware/qcom/qcom_tzmem.h:25 Enum value
>>>  'QCOM_TZMEM_POLICY_ON_DEMAND' not described in enum 'qcom_tzmem_policy'
>>>
>>> Fixes: 84f5a7b67b61 ("firmware: qcom: add a dedicated TrustZone buffer allocator")
>>> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
>>> ---
>>> Cc: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
>>> Cc: Bjorn Andersson <andersson@kernel.org>
>>> Cc: Konrad Dybcio <konradybcio@kernel.org>
>>> Cc: linux-arm-msm@vger.kernel.org
>>> ---
>>>  include/linux/firmware/qcom/qcom_tzmem.h |   12 +++++++++---
>>>  1 file changed, 9 insertions(+), 3 deletions(-)
>>>
>>> --- linux-next-20251016.orig/include/linux/firmware/qcom/qcom_tzmem.h
>>> +++ linux-next-20251016/include/linux/firmware/qcom/qcom_tzmem.h
>>> @@ -17,11 +17,17 @@ struct qcom_tzmem_pool;
>>>   * enum qcom_tzmem_policy - Policy for pool growth.
>>>   */
>>>  enum qcom_tzmem_policy {
>>> -     /**< Static pool, never grow above initial size. */
>>> +     /**
>>> +      * @QCOM_TZMEM_POLICY_STATIC: Static pool,
>>> +      * never grow above initial size. */
>>
>> Didn't know inline '*/' was cool, but if the checkers I'm happy, I'm not
>> going to complain either
>>
>> Reviewed-by: Konrad Dybcio <konrad.dybcio@oss.qualcomm.com>
>>
>> Konrad
> 
> Yes, very surprising. Almost doesn't look "right".
> 
> Anyway:
> Reviewed-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>

Darn. It looks OK but it totally confuses scripts/kernel-doc.
It has to end with a separate */ for each comment.
I'll have to resend this patch.

-- 
~Randy