[PATCH 0/2] spi: spi-cadence: Align function names and fix

[PATCH 0/2] spi: spi-cadence: Align function names and fix

[Amit Kumar Mahapatra]

This patch series
 - Aligns resume/suspend function names.
 - Fixes kernel-doc format.
---
BRANCH: mtd/next
---

Michal Simek (2):
  spi: spi-cadence: Align function name s/cnds/cdns/g
  spi: spi-cadence: Fix kernel-doc format for resume/suspend

 drivers/spi/spi-cadence.c | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

-- 
2.17.1

[PATCH 1/2] spi: spi-cadence: Align function name s/cnds/cdns/g

[Amit Kumar Mahapatra]

From: Michal Simek <michal.simek@xilinx.com>

Resume/suspend functions are using cnds instead of cdns that's why fix it
to be aligned with the rest of functions.

Signed-off-by: Michal Simek <michal.simek@xilinx.com>
Signed-off-by: Amit Kumar Mahapatra <amit.kumar-mahapatra@xilinx.com>
---
 drivers/spi/spi-cadence.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/drivers/spi/spi-cadence.c b/drivers/spi/spi-cadence.c
index ceb16e70d235..aff3f4241840 100644
--- a/drivers/spi/spi-cadence.c
+++ b/drivers/spi/spi-cadence.c
@@ -657,7 +657,7 @@ static int __maybe_unused cdns_spi_resume(struct device *dev)
  *
  * Return:	0 on success and error value on error
  */
-static int __maybe_unused cnds_runtime_resume(struct device *dev)
+static int __maybe_unused cdns_runtime_resume(struct device *dev)
 {
 	struct spi_master *master = dev_get_drvdata(dev);
 	struct cdns_spi *xspi = spi_master_get_devdata(master);
@@ -686,7 +686,7 @@ static int __maybe_unused cnds_runtime_resume(struct device *dev)
  *
  * Return:	Always 0
  */
-static int __maybe_unused cnds_runtime_suspend(struct device *dev)
+static int __maybe_unused cdns_runtime_suspend(struct device *dev)
 {
 	struct spi_master *master = dev_get_drvdata(dev);
 	struct cdns_spi *xspi = spi_master_get_devdata(master);
@@ -698,8 +698,8 @@ static int __maybe_unused cnds_runtime_suspend(struct device *dev)
 }
 
 static const struct dev_pm_ops cdns_spi_dev_pm_ops = {
-	SET_RUNTIME_PM_OPS(cnds_runtime_suspend,
-			   cnds_runtime_resume, NULL)
+	SET_RUNTIME_PM_OPS(cdns_runtime_suspend,
+			   cdns_runtime_resume, NULL)
 	SET_SYSTEM_SLEEP_PM_OPS(cdns_spi_suspend, cdns_spi_resume)
 };
 
-- 
2.17.1

[PATCH 2/2] spi: spi-cadence: Fix kernel-doc format for resume/suspend

[Amit Kumar Mahapatra]

From: Michal Simek <michal.simek@xilinx.com>

Kernel function name don't match with function name.

Error log:
drivers/spi/spi-cadence.c:662: warning: expecting prototype for
cdns_spi_runtime_resume(). Prototype was for cnds_runtime_resume() instead
drivers/spi/spi-cadence.c:691: warning: expecting prototype for
cdns_spi_runtime_suspend(). Prototype was for cnds_runtime_suspend()
instead

Signed-off-by: Michal Simek <michal.simek@xilinx.com>
Signed-off-by: Amit Kumar Mahapatra <amit.kumar-mahapatra@xilinx.com>
---
 drivers/spi/spi-cadence.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/spi/spi-cadence.c b/drivers/spi/spi-cadence.c
index aff3f4241840..87bb29ac4d7c 100644
--- a/drivers/spi/spi-cadence.c
+++ b/drivers/spi/spi-cadence.c
@@ -650,7 +650,7 @@ static int __maybe_unused cdns_spi_resume(struct device *dev)
 }
 
 /**
- * cdns_spi_runtime_resume - Runtime resume method for the SPI driver
+ * cdns_runtime_resume - Runtime resume method for the SPI driver
  * @dev:	Address of the platform_device structure
  *
  * This function enables the clocks
@@ -679,7 +679,7 @@ static int __maybe_unused cdns_runtime_resume(struct device *dev)
 }
 
 /**
- * cdns_spi_runtime_suspend - Runtime suspend method for the SPI driver
+ * cdns_runtime_suspend - Runtime suspend method for the SPI driver
  * @dev:	Address of the platform_device structure
  *
  * This function disables the clocks
-- 
2.17.1

Re: [PATCH 2/2] spi: spi-cadence: Fix kernel-doc format for resume/suspend

[Mark Brown]

[-- Attachment #1: Type: text/plain, Size: 640 bytes --]

On Thu, Mar 10, 2022 at 10:12:35PM +0530, Amit Kumar Mahapatra wrote:
> From: Michal Simek <michal.simek@xilinx.com>
> 
> Kernel function name don't match with function name.
> 
> Error log:
> drivers/spi/spi-cadence.c:662: warning: expecting prototype for
> cdns_spi_runtime_resume(). Prototype was for cnds_runtime_resume() instead
> drivers/spi/spi-cadence.c:691: warning: expecting prototype for
> cdns_spi_runtime_suspend(). Prototype was for cnds_runtime_suspend()
> instead

These errors are introduced by the prior patch in the series, that patch
should be fixed to just not introduce these errors in the first place.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 484 bytes --]

RE: [PATCH 2/2] spi: spi-cadence: Fix kernel-doc format for resume/suspend

[Amit Kumar Kumar Mahapatra]

Hello Mark,

> -----Original Message-----
> From: Mark Brown <broonie@kernel.org>
> Sent: Friday, March 11, 2022 12:17 AM
> To: Amit Kumar Kumar Mahapatra <akumarma@xilinx.com>
> Cc: linux-spi@vger.kernel.org; linux-kernel@vger.kernel.org; git
> <git@xilinx.com>; Amit Kumar Kumar Mahapatra <akumarma@xilinx.com>;
> Michal Simek <michals@xilinx.com>
> Subject: Re: [PATCH 2/2] spi: spi-cadence: Fix kernel-doc format for
> resume/suspend
> 
> On Thu, Mar 10, 2022 at 10:12:35PM +0530, Amit Kumar Mahapatra wrote:
> > From: Michal Simek <michal.simek@xilinx.com>
> >
> > Kernel function name don't match with function name.
> >
> > Error log:
> > drivers/spi/spi-cadence.c:662: warning: expecting prototype for
> > cdns_spi_runtime_resume(). Prototype was for cnds_runtime_resume()
> > instead
> > drivers/spi/spi-cadence.c:691: warning: expecting prototype for
> > cdns_spi_runtime_suspend(). Prototype was for cnds_runtime_suspend()
> > instead
> 
> These errors are introduced by the prior patch in the series, that patch
> should be fixed to just not introduce these errors in the first place.

https://github.com/torvalds/linux/commit/d36ccd9f7ea41f343391a15677b8a858376e1107
The above patch introduced two issues. as mentioned below
1) Runtime suspend/resume API had "cnds" prefix, unlike all other driver APIs 
that has "cdns" prefix
2) kernel-doc warnings in runtime suspend/resume APIs. 

So, the runtime suspend/resume kernel-doc warnings  were present prior to this 
patch series and were not introduced in the 1/2 patch of this series.

1/2 patch of this series aligns the runtime suspend/resume API prefix with the 
rest of the functions by changing it from "cnds" to "cdns".
2/2 patch of this series fixes the kernel-doc warning in runtime suspend/resume 
APIs. 

Regards,
Amit

Re: [PATCH 2/2] spi: spi-cadence: Fix kernel-doc format for resume/suspend

[Mark Brown]

[-- Attachment #1: Type: text/plain, Size: 461 bytes --]

On Fri, Mar 11, 2022 at 11:32:57AM +0000, Amit Kumar Kumar Mahapatra wrote:

> 1/2 patch of this series aligns the runtime suspend/resume API prefix with the 
> rest of the functions by changing it from "cnds" to "cdns".
> 2/2 patch of this series fixes the kernel-doc warning in runtime suspend/resume 
> APIs. 

The warning being fixed is that the name of the runtime suspend/resume
functions which were just renamed doesn't match the documentation.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]