[PATCH v2 2/2] iommupt: Describe @bitnr parameter

Bagas Sanjaya
2025-11-07T08:13:22Z

Sphinx reports kernel-doc warnings when making htmldocs:

WARNING: ./drivers/iommu/generic_pt/pt_common.h:361 function parameter 'bitnr' not described in 'pt_test_sw_bit_acquire'
WARNING: ./drivers/iommu/generic_pt/pt_common.h:371 function parameter 'bitnr' not described in 'pt_set_sw_bit_release'

Describe @bitnr to squash them.

Fixes: bcc64b57b48e ("iommupt: Add basic support for SW bits in the page table")
Reviewed-by: Jason Gunthorpe <jgg@nvidia.com>
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
drivers/iommu/generic_pt/pt_common.h | 2 ++
1 file changed, 2 insertions(+)

diff --git a/drivers/iommu/generic_pt/pt_common.h b/drivers/iommu/generic_pt/pt_common.h
index b5628f47e0db40..3b4e371089140a 100644
--- a/drivers/iommu/generic_pt/pt_common.h
+++ b/drivers/iommu/generic_pt/pt_common.h
@@ -354,6 +354,7 @@ static inline unsigned int pt_max_sw_bit(struct pt_common *common);
/**
* pt_test_sw_bit_acquire() - Read a software bit in an item
* @pts: Entry to set
+ * @bitnr: Bit to read
*
* Software bits are ignored by HW and can be used for any purpose by the
* software. This does a test bit and acquire operation.
@@ -364,6 +365,7 @@ static inline bool pt_test_sw_bit_acquire(struct pt_state *pts,
/**
* pt_set_sw_bit_release() - Set a software bit in an item
* @pts: Entry to set
+ * @bitnr: Bit to read
*
* Software bits are ignored by HW and can be used for any purpose by the
* software. This does a set bit and release operation.