Gh0st
/
linux
mirror of https://github.com/torvalds/linux.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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: bcc64b57b4 ("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>
This commit is contained in:
Bagas Sanjaya 2025-11-07 15:13:01 +07:00 committed by Joerg Roedel
parent 6573d552e2
commit e4dfaf25df
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
drivers/iommu/generic_pt/pt_common.h
View File

@ -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 * pt_test_sw_bit_acquire() - Read a software bit in an item
* @pts: Entry to set * @pts: Entry to set
* @bitnr: Bit to read
* *
* Software bits are ignored by HW and can be used for any purpose by the * Software bits are ignored by HW and can be used for any purpose by the
* software. This does a test bit and acquire operation. * 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 * pt_set_sw_bit_release() - Set a software bit in an item
* @pts: Entry to set * @pts: Entry to set
* @bitnr: Bit to read
* *
* Software bits are ignored by HW and can be used for any purpose by the * Software bits are ignored by HW and can be used for any purpose by the
* software. This does a set bit and release operation. * software. This does a set bit and release operation.