iommupt: Actually correct pt_test_sw_bit_{acquire_release}() parameter description

[PATCH] iommupt: Actually correct pt_test_sw_bit_{acquire_release}() parameter description

Posted by Bagas Sanjaya 3 months ago

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>
---
 drivers/iommu/generic_pt/pt_common.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/iommu/generic_pt/pt_common.h b/drivers/iommu/generic_pt/pt_common.h
index 3b4e371089140a..e1123d35c90765 100644
--- a/drivers/iommu/generic_pt/pt_common.h
+++ b/drivers/iommu/generic_pt/pt_common.h
@@ -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.

base-commit: 91920a9d87f5192c56ba5bf3e133aeb3576b705d
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH] iommupt: Actually correct pt_test_sw_bit_{acquire_release}() parameter description

Posted by Joerg Roedel 2 months, 3 weeks ago

On Sat, Nov 08, 2025 at 06:33:17AM +0700, Bagas Sanjaya wrote:
> 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>
> ---
>  drivers/iommu/generic_pt/pt_common.h | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)

Applied, thanks.

Re: [PATCH] iommupt: Actually correct pt_test_sw_bit_{acquire_release}() parameter description

Posted by Randy Dunlap 3 months ago


On 11/7/25 3:33 PM, Bagas Sanjaya wrote:
> 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>

Looks good. Thanks.

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>

> ---
>  drivers/iommu/generic_pt/pt_common.h | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/iommu/generic_pt/pt_common.h b/drivers/iommu/generic_pt/pt_common.h
> index 3b4e371089140a..e1123d35c90765 100644
> --- a/drivers/iommu/generic_pt/pt_common.h
> +++ b/drivers/iommu/generic_pt/pt_common.h
> @@ -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.
> 
> base-commit: 91920a9d87f5192c56ba5bf3e133aeb3576b705d

-- 
~Randy