Skip to contentSkip to conversation

drm/panfrost: cleanup comments

PATCH Superseded [email protected] 2 participants 3 messages Mar 1, 2022 – Mar 2, 2022

Subsystems (3)

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 drm/panfrost: cleanup comments

From: Tom Rix <[email protected]>

For spdx
change tab to space delimiter
Use // for *.c

Replacements
commited to committed, use multiline comment style regsiters to registers
initialze to initialize

---
 drivers/gpu/drm/panfrost/panfrost_drv.c          | 2 +-
 drivers/gpu/drm/panfrost/panfrost_gem_shrinker.c | 2 +-
 drivers/gpu/drm/panfrost/panfrost_issues.h       | 6 ++++--
 drivers/gpu/drm/panfrost/panfrost_mmu.c          | 2 +-
 drivers/gpu/drm/panfrost/panfrost_regs.h         | 2 +-
 5 files changed, 8 insertions(+), 6 deletions(-)
drivers/gpu/drm/panfrost/panfrost_drv.c +1 -1
index 96bb5a4656278..94b6f0a19c83a 100644
@@ -562,7 +562,7 @@ static int panfrost_probe(struct platform_device *pdev)
 
 	pfdev->coherent = device_get_dma_attr(&pdev->dev) == DEV_DMA_COHERENT;
 
-	/* Allocate and initialze the DRM device. */
+	/* Allocate and initialize the DRM device. */
 	ddev = drm_dev_alloc(&panfrost_drm_driver, &pdev->dev);
 	if (IS_ERR(ddev))
 		return PTR_ERR(ddev);
drivers/gpu/drm/panfrost/panfrost_gem_shrinker.c +1 -1
index b0142341e2235..77e7cb6d1ae3b 100644
@@ -1,4 +1,4 @@
-/* SPDX-License-Identifier: GPL-2.0 */
+// SPDX-License-Identifier: GPL-2.0
 /* Copyright (C) 2019 Arm Ltd.
  *
  * Based on msm_gem_freedreno.c:
drivers/gpu/drm/panfrost/panfrost_issues.h +4 -2
index 8e59d765bf19f..4e7cf979ee67a 100644
@@ -13,8 +13,10 @@
  * to care about.
  */
 enum panfrost_hw_issue {
-	/* Need way to guarantee that all previously-translated memory accesses
-	 * are commited */
+	/*
+	 * Need way to guarantee that all previously-translated memory accesses
+	 * are committed
+	 */
 	HW_ISSUE_6367,
 
 	/* On job complete with non-done the cache is not flushed */
drivers/gpu/drm/panfrost/panfrost_mmu.c +1 -1
index 39562f2d11a47..d3f82b26a631d 100644
@@ -1,4 +1,4 @@
-// SPDX-License-Identifier:	GPL-2.0
+// SPDX-License-Identifier: GPL-2.0
 /* Copyright 2019 Linaro, Ltd, Rob Herring <[email protected]> */
 
 #include <drm/panfrost_drm.h>
drivers/gpu/drm/panfrost/panfrost_regs.h +1 -1
index 6c5a11ef1ee87..efe4b75149d35 100644
@@ -292,7 +292,7 @@
 #define AS_FAULTADDRESS_LO(as)		(MMU_AS(as) + 0x20) /* (RO) Fault Address for address space n, low word */
 #define AS_FAULTADDRESS_HI(as)		(MMU_AS(as) + 0x24) /* (RO) Fault Address for address space n, high word */
 #define AS_STATUS(as)			(MMU_AS(as) + 0x28) /* (RO) Status flags for address space n */
-/* Additional Bifrost AS regsiters */
+/* Additional Bifrost AS registers */
 #define AS_TRANSCFG_LO(as)		(MMU_AS(as) + 0x30) /* (RW) Translation table configuration for address space n, low word */
 #define AS_TRANSCFG_HI(as)		(MMU_AS(as) + 0x34) /* (RW) Translation table configuration for address space n, high word */
 #define AS_FAULTEXTRA_LO(as)		(MMU_AS(as) + 0x38) /* (RO) Secondary fault address for address space n, low word */
Signature · 1 line
2.26.3
maintainer
#1 lore raw
Quoted 6 lines · On 01/03/2022 12:43, [email protected] wrote:

From: Tom Rix <[email protected]>

For spdx
change tab to space delimiter
Use // for *.c

Quoted 6 lines

Replacements
commited to committed, use multiline comment style regsiters to registers
initialze to initialize

Thanks, most of the changes look reasonable (although I've never understood the reason for using // for SPDX comments), but there's one below that I think needs rethinking.

Quoted 36 lines
---
 drivers/gpu/drm/panfrost/panfrost_drv.c          | 2 +-
 drivers/gpu/drm/panfrost/panfrost_gem_shrinker.c | 2 +-
 drivers/gpu/drm/panfrost/panfrost_issues.h       | 6 ++++--
 drivers/gpu/drm/panfrost/panfrost_mmu.c          | 2 +-
 drivers/gpu/drm/panfrost/panfrost_regs.h         | 2 +-
 5 files changed, 8 insertions(+), 6 deletions(-)
drivers/gpu/drm/panfrost/panfrost_drv.c +1 -1
index 96bb5a4656278..94b6f0a19c83a 100644
@@ -562,7 +562,7 @@ static int panfrost_probe(struct platform_device *pdev)
 
 	pfdev->coherent = device_get_dma_attr(&pdev->dev) == DEV_DMA_COHERENT;
 
-	/* Allocate and initialze the DRM device. */
+	/* Allocate and initialize the DRM device. */
 	ddev = drm_dev_alloc(&panfrost_drm_driver, &pdev->dev);
 	if (IS_ERR(ddev))
 		return PTR_ERR(ddev);
drivers/gpu/drm/panfrost/panfrost_gem_shrinker.c +1 -1
index b0142341e2235..77e7cb6d1ae3b 100644
@@ -1,4 +1,4 @@
-/* SPDX-License-Identifier: GPL-2.0 */
+// SPDX-License-Identifier: GPL-2.0
 /* Copyright (C) 2019 Arm Ltd.
  *
  * Based on msm_gem_freedreno.c:
drivers/gpu/drm/panfrost/panfrost_issues.h +0 -0
index 8e59d765bf19f..4e7cf979ee67a 100644

drivers/gpu/drm/panfrost/panfrost_issues.h line 19

Quoted 9 lines
drivers/gpu/drm/panfrost/panfrost_issues.h +4 -2
@@ -13,8 +13,10 @@
  * to care about.
  */
 enum panfrost_hw_issue {
-	/* Need way to guarantee that all previously-translated memory accesses
-	 * are commited */
+	/*
+	 * Need way to guarantee that all previously-translated memory accesses
+	 * are committed
+	 */

This file has a whole load of multiline comments that don't technically follow the coding style. Fixing just one comment makes the file inconsistent. Note we recently had a discussion about this[1] and decided to leave the comment style as is. And I have to admit in this instance avoiding the extra mostly-blank lines makes the list easier to read. The typo fix is obviously welcomed though!

[1] https://lore.kernel.org/r/c7331489-ad04-0f35-224e-164f144fb819%40arm.com

Quoted 26 lines
drivers/gpu/drm/panfrost/panfrost_issues.h +0 -0
 	HW_ISSUE_6367,
 
 	/* On job complete with non-done the cache is not flushed */
drivers/gpu/drm/panfrost/panfrost_mmu.c +1 -1
index 39562f2d11a47..d3f82b26a631d 100644
@@ -1,4 +1,4 @@
-// SPDX-License-Identifier:	GPL-2.0
+// SPDX-License-Identifier: GPL-2.0
 /* Copyright 2019 Linaro, Ltd, Rob Herring <[email protected]> */
 
 #include <drm/panfrost_drm.h>
drivers/gpu/drm/panfrost/panfrost_regs.h +1 -1
index 6c5a11ef1ee87..efe4b75149d35 100644
@@ -292,7 +292,7 @@
 #define AS_FAULTADDRESS_LO(as)		(MMU_AS(as) + 0x20) /* (RO) Fault Address for address space n, low word */
 #define AS_FAULTADDRESS_HI(as)		(MMU_AS(as) + 0x24) /* (RO) Fault Address for address space n, high word */
 #define AS_STATUS(as)			(MMU_AS(as) + 0x28) /* (RO) Status flags for address space n */
-/* Additional Bifrost AS regsiters */
+/* Additional Bifrost AS registers */
 #define AS_TRANSCFG_LO(as)		(MMU_AS(as) + 0x30) /* (RW) Translation table configuration for address space n, low word */
 #define AS_TRANSCFG_HI(as)		(MMU_AS(as) + 0x34) /* (RW) Translation table configuration for address space n, high word */
 #define AS_FAULTEXTRA_LO(as)		(MMU_AS(as) + 0x38) /* (RO) Secondary fault address for address space n, low word */
author
#2 lore raw
Quoted 60 lines · Steven Price
Quoted 6 lines · On 01/03/2022 12:43, [email protected] wrote:

From: Tom Rix <[email protected]>

For spdx
change tab to space delimiter
Use // for *.c

Quoted 6 lines

Replacements
commited to committed, use multiline comment style regsiters to registers
initialze to initialize

Thanks, most of the changes look reasonable (although I've never understood the reason for using // for SPDX comments), but there's one below that I think needs rethinking.

Quoted 43 lines
---
  drivers/gpu/drm/panfrost/panfrost_drv.c          | 2 +-
  drivers/gpu/drm/panfrost/panfrost_gem_shrinker.c | 2 +-
  drivers/gpu/drm/panfrost/panfrost_issues.h       | 6 ++++--
  drivers/gpu/drm/panfrost/panfrost_mmu.c          | 2 +-
  drivers/gpu/drm/panfrost/panfrost_regs.h         | 2 +-
  5 files changed, 8 insertions(+), 6 deletions(-)
drivers/gpu/drm/panfrost/panfrost_drv.c +1 -1
index 96bb5a4656278..94b6f0a19c83a 100644
@@ -562,7 +562,7 @@ static int panfrost_probe(struct platform_device *pdev)
 
  	pfdev->coherent = device_get_dma_attr(&pdev->dev) == DEV_DMA_COHERENT;
 
-	/* Allocate and initialze the DRM device. */
+	/* Allocate and initialize the DRM device. */
  	ddev = drm_dev_alloc(&panfrost_drm_driver, &pdev->dev);
  	if (IS_ERR(ddev))
  		return PTR_ERR(ddev);
drivers/gpu/drm/panfrost/panfrost_gem_shrinker.c +1 -1
index b0142341e2235..77e7cb6d1ae3b 100644
@@ -1,4 +1,4 @@
-/* SPDX-License-Identifier: GPL-2.0 */
+// SPDX-License-Identifier: GPL-2.0
  /* Copyright (C) 2019 Arm Ltd.
   *
   * Based on msm_gem_freedreno.c:
drivers/gpu/drm/panfrost/panfrost_issues.h +2 -2
index 8e59d765bf19f..4e7cf979ee67a 100644
@@ -13,8 +13,10 @@
   * to care about.
   */
  enum panfrost_hw_issue {
-	/* Need way to guarantee that all previously-translated memory accesses
-	 * are commited */
+	/*
+	 * Need way to guarantee that all previously-translated memory accesses
Quoted 8 lines

drivers/gpu/drm/panfrost/panfrost_issues.h line 19

Quoted 2 lines
drivers/gpu/drm/panfrost/panfrost_issues.h +2 -0
+	 * are committed
+	 */

This file has a whole load of multiline comments that don't technically follow the coding style. Fixing just one comment makes the file inconsistent. Note we recently had a discussion about this[1] and decided to leave the comment style as is. And I have to admit in this instance avoiding the extra mostly-blank lines makes the list easier to read. The typo fix is obviously welcomed though!

I'll switch this back in a respin.

Thanks

Tom

Quoted 29 lines

[1] https://lore.kernel.org/r/c7331489-ad04-0f35-224e-164f144fb819%40arm.com

Quoted 26 lines
drivers/gpu/drm/panfrost/panfrost_issues.h +0 -0
  	HW_ISSUE_6367,
 
  	/* On job complete with non-done the cache is not flushed */
drivers/gpu/drm/panfrost/panfrost_mmu.c +1 -1
index 39562f2d11a47..d3f82b26a631d 100644
@@ -1,4 +1,4 @@
-// SPDX-License-Identifier:	GPL-2.0
+// SPDX-License-Identifier: GPL-2.0
  /* Copyright 2019 Linaro, Ltd, Rob Herring <[email protected]> */
 
  #include <drm/panfrost_drm.h>
drivers/gpu/drm/panfrost/panfrost_regs.h +1 -1
index 6c5a11ef1ee87..efe4b75149d35 100644
@@ -292,7 +292,7 @@
  #define AS_FAULTADDRESS_LO(as)		(MMU_AS(as) + 0x20) /* (RO) Fault Address for address space n, low word */
  #define AS_FAULTADDRESS_HI(as)		(MMU_AS(as) + 0x24) /* (RO) Fault Address for address space n, high word */
  #define AS_STATUS(as)			(MMU_AS(as) + 0x28) /* (RO) Status flags for address space n */
-/* Additional Bifrost AS regsiters */
+/* Additional Bifrost AS registers */
  #define AS_TRANSCFG_LO(as)		(MMU_AS(as) + 0x30) /* (RW) Translation table configuration for address space n, low word */
  #define AS_TRANSCFG_HI(as)		(MMU_AS(as) + 0x34) /* (RW) Translation table configuration for address space n, high word */
  #define AS_FAULTEXTRA_LO(as)		(MMU_AS(as) + 0x38) /* (RO) Secondary fault address for address space n, low word */