]> Gentwo Git Trees - linux/.git/commitdiff
iommupt: Actually correct pt_test_sw_bit_{acquire_release}() parameter description
authorBagas Sanjaya <bagasdotme@gmail.com>
Fri, 7 Nov 2025 23:33:17 +0000 (06:33 +0700)
committerJoerg Roedel <joerg.roedel@amd.com>
Mon, 17 Nov 2025 08:46:22 +0000 (09:46 +0100)
In review comment for v1 of genpt documentation fixes [1], Randy
suggested that pt_test_sw_bit_acquire() parameters description
should be written using "to read". Commit e4dfaf25df1210 ("iommupt:
Describe @bitnr parameter"), however, misunderstood the review by
instead using "to read" on @bitnr parameter on both
pt_test_sw_bit_acquire() and pt_test_sw_bit_release().

Actually correct the description.

[1]: https://lore.kernel.org/linux-doc/9dba0eb7-6f32-41b7-b70b-12379364585f@infradead.org/

Fixes: e4dfaf25df1210 ("iommupt: Describe @bitnr parameter")
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Joerg Roedel <joerg.roedel@amd.com>
drivers/iommu/generic_pt/pt_common.h

index 3b4e371089140a931e8dfb9cd0ecf50e380a21f6..e1123d35c90765bbd2a09c5dabfb28f05dcdeb43 100644 (file)
@@ -353,7 +353,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
+ * @pts: Entry to read
  * @bitnr: Bit to read
  *
  * Software bits are ignored by HW and can be used for any purpose by the
@@ -365,7 +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
+ * @bitnr: Bit to set
  *
  * Software bits are ignored by HW and can be used for any purpose by the
  * software. This does a set bit and release operation.