Commit e4dfaf25 authored by Bagas Sanjaya's avatar Bagas Sanjaya Committed by Joerg Roedel
Browse files

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: bcc64b57 ("iommupt: Add basic support for SW bits in the page table")
Reviewed-by: default avatarJason Gunthorpe <jgg@nvidia.com>
Signed-off-by: default avatarBagas Sanjaya <bagasdotme@gmail.com>
Signed-off-by: default avatarJoerg Roedel <joerg.roedel@amd.com>
parent 6573d552

drivers/iommu/generic_pt/pt_common.h

+2 −0
Original line number Diff line number Diff line
@@ -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.