Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

firmware: qcom: tzmem: fix qcom_tzmem_policy kernel-doc

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>
Link: https://lore.kernel.org/r/20251017191323.1820167-1-rdunlap@infradead.org
Signed-off-by: Bjorn Andersson <andersson@kernel.org>

authored by

Randy Dunlap and committed by
Bjorn Andersson
edd548dc 5e88dfc5

+12 -3
+12 -3
include/linux/firmware/qcom/qcom_tzmem.h
··· 17 17 * enum qcom_tzmem_policy - Policy for pool growth. 18 18 */ 19 19 enum qcom_tzmem_policy { 20 - /**< Static pool, never grow above initial size. */ 20 + /** 21 + * @QCOM_TZMEM_POLICY_STATIC: Static pool, 22 + * never grow above initial size. 23 + */ 21 24 QCOM_TZMEM_POLICY_STATIC = 1, 22 - /**< When out of memory, add increment * current size of memory. */ 25 + /** 26 + * @QCOM_TZMEM_POLICY_MULTIPLIER: When out of memory, 27 + * add increment * current size of memory. 28 + */ 23 29 QCOM_TZMEM_POLICY_MULTIPLIER, 24 - /**< When out of memory add as much as is needed until max_size. */ 30 + /** 31 + * @QCOM_TZMEM_POLICY_ON_DEMAND: When out of memory 32 + * add as much as is needed until max_size. 33 + */ 25 34 QCOM_TZMEM_POLICY_ON_DEMAND, 26 35 }; 27 36