iommu.lists.linux-foundation.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] dma-mapping: Name SG DMA flag helpers consistently
@ 2023-05-25 17:46 Robin Murphy
  2023-05-26  6:42 ` Christoph Hellwig
                   ` (2 more replies)
  0 siblings, 3 replies; 4+ messages in thread
From: Robin Murphy @ 2023-05-25 17:46 UTC (permalink / raw)
  To: hch; +Cc: m.szyprowski, iommu, catalin.marinas, linux-kernel, logang

sg_is_dma_bus_address() is inconsistent with the naming pattern of its
corresponding setters and its own kerneldoc, so take the majority vote
and rename it sg_dma_is_bus_address() (and fix up the missing
underscores in the kerneldoc too). This gives us a nice clear pattern
where SG DMA flags are SG_DMA_<NAME>, and the helpers for acting on them
are sg_dma_<action>_<name>().

Signed-off-by: Robin Murphy <robin.murphy@arm.com>
---
 drivers/iommu/dma-iommu.c   | 8 ++++----
 drivers/iommu/iommu.c       | 2 +-
 include/linux/scatterlist.h | 8 ++++----
 kernel/dma/direct.c         | 2 +-
 4 files changed, 10 insertions(+), 10 deletions(-)

diff --git a/drivers/iommu/dma-iommu.c b/drivers/iommu/dma-iommu.c
index 7a9f0b0bddbd..b8bba4aa196f 100644
--- a/drivers/iommu/dma-iommu.c
+++ b/drivers/iommu/dma-iommu.c
@@ -1080,7 +1080,7 @@ static int __finalise_sg(struct device *dev, struct scatterlist *sg, int nents,
 		sg_dma_address(s) = DMA_MAPPING_ERROR;
 		sg_dma_len(s) = 0;
 
-		if (sg_is_dma_bus_address(s)) {
+		if (sg_dma_is_bus_address(s)) {
 			if (i > 0)
 				cur = sg_next(cur);
 
@@ -1136,7 +1136,7 @@ static void __invalidate_sg(struct scatterlist *sg, int nents)
 	int i;
 
 	for_each_sg(sg, s, nents, i) {
-		if (sg_is_dma_bus_address(s)) {
+		if (sg_dma_is_bus_address(s)) {
 			sg_dma_unmark_bus_address(s);
 		} else {
 			if (sg_dma_address(s) != DMA_MAPPING_ERROR)
@@ -1329,7 +1329,7 @@ static void iommu_dma_unmap_sg(struct device *dev, struct scatterlist *sg,
 	 * just have to be determined.
 	 */
 	for_each_sg(sg, tmp, nents, i) {
-		if (sg_is_dma_bus_address(tmp)) {
+		if (sg_dma_is_bus_address(tmp)) {
 			sg_dma_unmark_bus_address(tmp);
 			continue;
 		}
@@ -1343,7 +1343,7 @@ static void iommu_dma_unmap_sg(struct device *dev, struct scatterlist *sg,
 
 	nents -= i;
 	for_each_sg(tmp, tmp, nents, i) {
-		if (sg_is_dma_bus_address(tmp)) {
+		if (sg_dma_is_bus_address(tmp)) {
 			sg_dma_unmark_bus_address(tmp);
 			continue;
 		}
diff --git a/drivers/iommu/iommu.c b/drivers/iommu/iommu.c
index f1dcfa3f1a1b..eb620552967b 100644
--- a/drivers/iommu/iommu.c
+++ b/drivers/iommu/iommu.c
@@ -2567,7 +2567,7 @@ ssize_t iommu_map_sg(struct iommu_domain *domain, unsigned long iova,
 			len = 0;
 		}
 
-		if (sg_is_dma_bus_address(sg))
+		if (sg_dma_is_bus_address(sg))
 			goto next;
 
 		if (len) {
diff --git a/include/linux/scatterlist.h b/include/linux/scatterlist.h
index 375a5e90d86a..d1ed52d083da 100644
--- a/include/linux/scatterlist.h
+++ b/include/linux/scatterlist.h
@@ -259,7 +259,7 @@ static inline void sg_unmark_end(struct scatterlist *sg)
 #define SG_DMA_BUS_ADDRESS (1 << 0)
 
 /**
- * sg_dma_is_bus address - Return whether a given segment was marked
+ * sg_dma_is_bus_address - Return whether a given segment was marked
  *			   as a bus address
  * @sg:		 SG entry
  *
@@ -267,13 +267,13 @@ static inline void sg_unmark_end(struct scatterlist *sg)
  *   Returns true if sg_dma_mark_bus_address() has been called on
  *   this segment.
  **/
-static inline bool sg_is_dma_bus_address(struct scatterlist *sg)
+static inline bool sg_dma_is_bus_address(struct scatterlist *sg)
 {
 	return sg->dma_flags & SG_DMA_BUS_ADDRESS;
 }
 
 /**
- * sg_dma_mark_bus address - Mark the scatterlist entry as a bus address
+ * sg_dma_mark_bus_address - Mark the scatterlist entry as a bus address
  * @sg:		 SG entry
  *
  * Description:
@@ -301,7 +301,7 @@ static inline void sg_dma_unmark_bus_address(struct scatterlist *sg)
 
 #else
 
-static inline bool sg_is_dma_bus_address(struct scatterlist *sg)
+static inline bool sg_dma_is_bus_address(struct scatterlist *sg)
 {
 	return false;
 }
diff --git a/kernel/dma/direct.c b/kernel/dma/direct.c
index 5595d1d5cdcc..d29cade048db 100644
--- a/kernel/dma/direct.c
+++ b/kernel/dma/direct.c
@@ -463,7 +463,7 @@ void dma_direct_unmap_sg(struct device *dev, struct scatterlist *sgl,
 	int i;
 
 	for_each_sg(sgl,  sg, nents, i) {
-		if (sg_is_dma_bus_address(sg))
+		if (sg_dma_is_bus_address(sg))
 			sg_dma_unmark_bus_address(sg);
 		else
 			dma_direct_unmap_page(dev, sg->dma_address,
-- 
2.39.2.101.g768bb238c484.dirty


^ permalink raw reply related	[flat|nested] 4+ messages in thread

* Re: [PATCH] dma-mapping: Name SG DMA flag helpers consistently
  2023-05-25 17:46 [PATCH] dma-mapping: Name SG DMA flag helpers consistently Robin Murphy
@ 2023-05-26  6:42 ` Christoph Hellwig
  2023-05-30 17:12 ` Jerry Snitselaar
  2023-05-30 17:23 ` Logan Gunthorpe
  2 siblings, 0 replies; 4+ messages in thread
From: Christoph Hellwig @ 2023-05-26  6:42 UTC (permalink / raw)
  To: Robin Murphy
  Cc: hch, m.szyprowski, iommu, catalin.marinas, linux-kernel, logang

Looks fine to me:

Reviewed-by: Christoph Hellwig <hch@lst.de>

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH] dma-mapping: Name SG DMA flag helpers consistently
  2023-05-25 17:46 [PATCH] dma-mapping: Name SG DMA flag helpers consistently Robin Murphy
  2023-05-26  6:42 ` Christoph Hellwig
@ 2023-05-30 17:12 ` Jerry Snitselaar
  2023-05-30 17:23 ` Logan Gunthorpe
  2 siblings, 0 replies; 4+ messages in thread
From: Jerry Snitselaar @ 2023-05-30 17:12 UTC (permalink / raw)
  To: Robin Murphy
  Cc: hch, m.szyprowski, iommu, catalin.marinas, linux-kernel, logang

On Thu, May 25, 2023 at 06:46:31PM +0100, Robin Murphy wrote:
> sg_is_dma_bus_address() is inconsistent with the naming pattern of its
> corresponding setters and its own kerneldoc, so take the majority vote
> and rename it sg_dma_is_bus_address() (and fix up the missing
> underscores in the kerneldoc too). This gives us a nice clear pattern
> where SG DMA flags are SG_DMA_<NAME>, and the helpers for acting on them
> are sg_dma_<action>_<name>().
> 
> Signed-off-by: Robin Murphy <robin.murphy@arm.com>

Reviewed-by: Jerry Snitselaar <jsnitsel@redhat.com>

> ---
>  drivers/iommu/dma-iommu.c   | 8 ++++----
>  drivers/iommu/iommu.c       | 2 +-
>  include/linux/scatterlist.h | 8 ++++----
>  kernel/dma/direct.c         | 2 +-
>  4 files changed, 10 insertions(+), 10 deletions(-)
> 
> diff --git a/drivers/iommu/dma-iommu.c b/drivers/iommu/dma-iommu.c
> index 7a9f0b0bddbd..b8bba4aa196f 100644
> --- a/drivers/iommu/dma-iommu.c
> +++ b/drivers/iommu/dma-iommu.c
> @@ -1080,7 +1080,7 @@ static int __finalise_sg(struct device *dev, struct scatterlist *sg, int nents,
>  		sg_dma_address(s) = DMA_MAPPING_ERROR;
>  		sg_dma_len(s) = 0;
>  
> -		if (sg_is_dma_bus_address(s)) {
> +		if (sg_dma_is_bus_address(s)) {
>  			if (i > 0)
>  				cur = sg_next(cur);
>  
> @@ -1136,7 +1136,7 @@ static void __invalidate_sg(struct scatterlist *sg, int nents)
>  	int i;
>  
>  	for_each_sg(sg, s, nents, i) {
> -		if (sg_is_dma_bus_address(s)) {
> +		if (sg_dma_is_bus_address(s)) {
>  			sg_dma_unmark_bus_address(s);
>  		} else {
>  			if (sg_dma_address(s) != DMA_MAPPING_ERROR)
> @@ -1329,7 +1329,7 @@ static void iommu_dma_unmap_sg(struct device *dev, struct scatterlist *sg,
>  	 * just have to be determined.
>  	 */
>  	for_each_sg(sg, tmp, nents, i) {
> -		if (sg_is_dma_bus_address(tmp)) {
> +		if (sg_dma_is_bus_address(tmp)) {
>  			sg_dma_unmark_bus_address(tmp);
>  			continue;
>  		}
> @@ -1343,7 +1343,7 @@ static void iommu_dma_unmap_sg(struct device *dev, struct scatterlist *sg,
>  
>  	nents -= i;
>  	for_each_sg(tmp, tmp, nents, i) {
> -		if (sg_is_dma_bus_address(tmp)) {
> +		if (sg_dma_is_bus_address(tmp)) {
>  			sg_dma_unmark_bus_address(tmp);
>  			continue;
>  		}
> diff --git a/drivers/iommu/iommu.c b/drivers/iommu/iommu.c
> index f1dcfa3f1a1b..eb620552967b 100644
> --- a/drivers/iommu/iommu.c
> +++ b/drivers/iommu/iommu.c
> @@ -2567,7 +2567,7 @@ ssize_t iommu_map_sg(struct iommu_domain *domain, unsigned long iova,
>  			len = 0;
>  		}
>  
> -		if (sg_is_dma_bus_address(sg))
> +		if (sg_dma_is_bus_address(sg))
>  			goto next;
>  
>  		if (len) {
> diff --git a/include/linux/scatterlist.h b/include/linux/scatterlist.h
> index 375a5e90d86a..d1ed52d083da 100644
> --- a/include/linux/scatterlist.h
> +++ b/include/linux/scatterlist.h
> @@ -259,7 +259,7 @@ static inline void sg_unmark_end(struct scatterlist *sg)
>  #define SG_DMA_BUS_ADDRESS (1 << 0)
>  
>  /**
> - * sg_dma_is_bus address - Return whether a given segment was marked
> + * sg_dma_is_bus_address - Return whether a given segment was marked
>   *			   as a bus address
>   * @sg:		 SG entry
>   *
> @@ -267,13 +267,13 @@ static inline void sg_unmark_end(struct scatterlist *sg)
>   *   Returns true if sg_dma_mark_bus_address() has been called on
>   *   this segment.
>   **/
> -static inline bool sg_is_dma_bus_address(struct scatterlist *sg)
> +static inline bool sg_dma_is_bus_address(struct scatterlist *sg)
>  {
>  	return sg->dma_flags & SG_DMA_BUS_ADDRESS;
>  }
>  
>  /**
> - * sg_dma_mark_bus address - Mark the scatterlist entry as a bus address
> + * sg_dma_mark_bus_address - Mark the scatterlist entry as a bus address
>   * @sg:		 SG entry
>   *
>   * Description:
> @@ -301,7 +301,7 @@ static inline void sg_dma_unmark_bus_address(struct scatterlist *sg)
>  
>  #else
>  
> -static inline bool sg_is_dma_bus_address(struct scatterlist *sg)
> +static inline bool sg_dma_is_bus_address(struct scatterlist *sg)
>  {
>  	return false;
>  }
> diff --git a/kernel/dma/direct.c b/kernel/dma/direct.c
> index 5595d1d5cdcc..d29cade048db 100644
> --- a/kernel/dma/direct.c
> +++ b/kernel/dma/direct.c
> @@ -463,7 +463,7 @@ void dma_direct_unmap_sg(struct device *dev, struct scatterlist *sgl,
>  	int i;
>  
>  	for_each_sg(sgl,  sg, nents, i) {
> -		if (sg_is_dma_bus_address(sg))
> +		if (sg_dma_is_bus_address(sg))
>  			sg_dma_unmark_bus_address(sg);
>  		else
>  			dma_direct_unmap_page(dev, sg->dma_address,
> -- 
> 2.39.2.101.g768bb238c484.dirty
> 


^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH] dma-mapping: Name SG DMA flag helpers consistently
  2023-05-25 17:46 [PATCH] dma-mapping: Name SG DMA flag helpers consistently Robin Murphy
  2023-05-26  6:42 ` Christoph Hellwig
  2023-05-30 17:12 ` Jerry Snitselaar
@ 2023-05-30 17:23 ` Logan Gunthorpe
  2 siblings, 0 replies; 4+ messages in thread
From: Logan Gunthorpe @ 2023-05-30 17:23 UTC (permalink / raw)
  To: Robin Murphy, hch; +Cc: m.szyprowski, iommu, catalin.marinas, linux-kernel



On 2023-05-25 11:46, Robin Murphy wrote:
> sg_is_dma_bus_address() is inconsistent with the naming pattern of its
> corresponding setters and its own kerneldoc, so take the majority vote
> and rename it sg_dma_is_bus_address() (and fix up the missing
> underscores in the kerneldoc too). This gives us a nice clear pattern
> where SG DMA flags are SG_DMA_<NAME>, and the helpers for acting on them
> are sg_dma_<action>_<name>().
> 
> Signed-off-by: Robin Murphy <robin.murphy@arm.com>

Looks good to me. Thanks.

Reviewed-by: Logan Gunthorpe <logang@deltatee.com>

^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2023-05-30 18:03 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-05-25 17:46 [PATCH] dma-mapping: Name SG DMA flag helpers consistently Robin Murphy
2023-05-26  6:42 ` Christoph Hellwig
2023-05-30 17:12 ` Jerry Snitselaar
2023-05-30 17:23 ` Logan Gunthorpe

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).