diff options
| author | Bagas Sanjaya <bagasdotme@gmail.com> | 2025-11-07 15:13:01 +0700 |
|---|---|---|
| committer | Joerg Roedel <joerg.roedel@amd.com> | 2025-11-07 11:07:04 +0100 |
| commit | e4dfaf25df1210af6776b6672191cf5e32ba5529 (patch) | |
| tree | ca66d67ff2b0a8e5b46c8cd1ecd96ec38bd915f0 | |
| parent | 6573d552e28c22f5f7b7eedce3ac7c2677032b13 (diff) | |
| download | linux-e4dfaf25df1210af6776b6672191cf5e32ba5529.tar.gz linux-e4dfaf25df1210af6776b6672191cf5e32ba5529.zip | |
iommupt: Describe @bitnr parameter
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>
Signed-off-by: Joerg Roedel <joerg.roedel@amd.com>
| -rw-r--r-- | drivers/iommu/generic_pt/pt_common.h | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/drivers/iommu/generic_pt/pt_common.h b/drivers/iommu/generic_pt/pt_common.h index b5628f47e0db..3b4e37108914 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. |