* [PATCH v2 0/5] Fix kernel-doc comments for 'struct spi_nor'
@ 2020-04-03 20:39 Sergei Shtylyov
2020-04-03 20:41 ` [PATCH v2 1/5] mtd: spi-nor: fix kernel-doc " Sergei Shtylyov
` (5 more replies)
0 siblings, 6 replies; 13+ messages in thread
From: Sergei Shtylyov @ 2020-04-03 20:39 UTC (permalink / raw)
To: Tudor Ambarus, linux-mtd
Cc: Richard Weinberger, Vignesh Raghavendra, Miquel Raynal
Hello!
Here's a set of 5 patches against the 'spi-nor/next' branch of the MTD 'linux.git'
repo. I'm fixing a number of issues in the kernel-doc comment to 'struct spi_nor'
accumulated since its creation. Instead of a single patch, I'm fixing the kernel-doc
comment with several patches, each fixing its own broken commit -- this simplifies
porting to the stable kernels (if that ever happens). :-)
[1/5] mtd: spi-nor: fix kernel-doc for 'struct spi_nor'
[2/5] mtd: spi-nor: fix kernel-doc for spi_nor::mtd
[3/5] mtd: spi-nor: fix kernel-doc for spi_nor::reg_proto
[4/5] mtd: spi-nor: fix kernel-doc for spi_nor::info
[5/5] mtd: spi-nor: fix kernel-doc for spi_nor::spimem
MBR, Sergei
______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/
^ permalink raw reply [flat|nested] 13+ messages in thread
* [PATCH v2 1/5] mtd: spi-nor: fix kernel-doc for 'struct spi_nor'
2020-04-03 20:39 [PATCH v2 0/5] Fix kernel-doc comments for 'struct spi_nor' Sergei Shtylyov
@ 2020-04-03 20:41 ` Sergei Shtylyov
2020-04-03 20:44 ` [PATCH v2 2/5] mtd: spi-nor: fix kernel-doc for spi_nor::mtd Sergei Shtylyov
` (4 subsequent siblings)
5 siblings, 0 replies; 13+ messages in thread
From: Sergei Shtylyov @ 2020-04-03 20:41 UTC (permalink / raw)
To: Tudor Ambarus, linux-mtd
Cc: Richard Weinberger, Vignesh Raghavendra, Miquel Raynal
When introducing 'struct spi_nor', a number of issues was added in its
kernel-doc comment:
- double article in the heading kernel-doc comment;
- "point" instead of "pointer" for the 'mtd' and 'dev' fields;
- "a" articles instead of "an" for the 'dev' field;
- acronyms in the lower case for the 'dev' field;
- missing "pointer to" for the 'priv' field.
Fix all of those at once...
Fixes: 6e602ef73334 ("mtd: spi-nor: add the basic data structures")
Signed-off-by: Sergei Shtylyov <sergei.shtylyov@cogentembedded.com>
---
include/linux/mtd/spi-nor.h | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
Index: linux/include/linux/mtd/spi-nor.h
===================================================================
--- linux.orig/include/linux/mtd/spi-nor.h
+++ linux/include/linux/mtd/spi-nor.h
@@ -327,10 +327,10 @@ struct spi_nor_manufacturer;
struct spi_nor_flash_parameter;
/**
- * struct spi_nor - Structure for defining a the SPI NOR layer
- * @mtd: point to a mtd_info structure
+ * struct spi_nor - Structure for defining the SPI NOR layer
+ * @mtd: pointer to an mtd_info structure
* @lock: the lock for the read/write/erase/lock/unlock operations
- * @dev: point to a spi device, or a spi nor controller device.
+ * @dev: pointer to an SPI device or an SPI NOR controller device
* @spimem: point to the spi mem device
* @bouncebuf: bounce buffer used when the buffer passed by the MTD
* layer is not DMA-able
@@ -354,7 +354,7 @@ struct spi_nor_flash_parameter;
* settings that can be overwritten by the spi_nor_fixups
* hooks, or dynamically when parsing the SFDP tables.
* @dirmap: pointers to struct spi_mem_dirmap_desc for reads/writes.
- * @priv: the private data
+ * @priv: pointer to the private data
*/
struct spi_nor {
struct mtd_info mtd;
______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/
^ permalink raw reply [flat|nested] 13+ messages in thread
* [PATCH v2 2/5] mtd: spi-nor: fix kernel-doc for spi_nor::mtd
2020-04-03 20:39 [PATCH v2 0/5] Fix kernel-doc comments for 'struct spi_nor' Sergei Shtylyov
2020-04-03 20:41 ` [PATCH v2 1/5] mtd: spi-nor: fix kernel-doc " Sergei Shtylyov
@ 2020-04-03 20:44 ` Sergei Shtylyov
2020-04-03 20:45 ` [PATCH v2 3/5] mtd: spi-nor: fix kernel-doc for spi_nor::reg_proto Sergei Shtylyov
` (3 subsequent siblings)
5 siblings, 0 replies; 13+ messages in thread
From: Sergei Shtylyov @ 2020-04-03 20:44 UTC (permalink / raw)
To: Tudor Ambarus, linux-mtd
Cc: Richard Weinberger, Vignesh Raghavendra, Miquel Raynal
When embedding 'struct mtd_info' within 'struct spi_nor', the kernel-doc
comment was forgotten. Fix it by dropping the "pointer to" part from the
comment.
Fixes: 1976367173a4 ("mtd: spi-nor: embed struct mtd_info within struct spi_nor")
Signed-off-by: Sergei Shtylyov <sergei.shtylyov@cogentembedded.com>
---
Changes in version 2:
- rebased to the 'spi-nor/next' branch of the MTD repo.
include/linux/mtd/spi-nor.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
Index: linux/include/linux/mtd/spi-nor.h
===================================================================
--- linux.orig/include/linux/mtd/spi-nor.h
+++ linux/include/linux/mtd/spi-nor.h
@@ -328,7 +328,7 @@ struct spi_nor_flash_parameter;
/**
* struct spi_nor - Structure for defining the SPI NOR layer
- * @mtd: pointer to an mtd_info structure
+ * @mtd: an mtd_info structure
* @lock: the lock for the read/write/erase/lock/unlock operations
* @dev: pointer to an SPI device or an SPI NOR controller device
* @spimem: point to the spi mem device
______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/
^ permalink raw reply [flat|nested] 13+ messages in thread
* [PATCH v2 3/5] mtd: spi-nor: fix kernel-doc for spi_nor::reg_proto
2020-04-03 20:39 [PATCH v2 0/5] Fix kernel-doc comments for 'struct spi_nor' Sergei Shtylyov
2020-04-03 20:41 ` [PATCH v2 1/5] mtd: spi-nor: fix kernel-doc " Sergei Shtylyov
2020-04-03 20:44 ` [PATCH v2 2/5] mtd: spi-nor: fix kernel-doc for spi_nor::mtd Sergei Shtylyov
@ 2020-04-03 20:45 ` Sergei Shtylyov
2020-04-03 20:49 ` [PATCH v2 4/5] mtd: spi-nor: fix kernel-doc for spi_nor::info Sergei Shtylyov
` (2 subsequent siblings)
5 siblings, 0 replies; 13+ messages in thread
From: Sergei Shtylyov @ 2020-04-03 20:45 UTC (permalink / raw)
To: Tudor Ambarus, linux-mtd
Cc: Richard Weinberger, Vignesh Raghavendra, Miquel Raynal
When adding the '{read|write|reg}_proto' fields to 'struct spi_nor', a
colon was missed in the comment for the spi_nor::reg_proto' -- add it.
Fixes: cfc5604c488c ("mtd: spi-nor: introduce SPI 1-2-2 and SPI 1-4-4 protocols")
Signed-off-by: Sergei Shtylyov <sergei.shtylyov@cogentembedded.com>
---
Changes in version 2:
- rebased to the 'spi-nor/next' branch of the MTD repo.
include/linux/mtd/spi-nor.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
Index: linux/include/linux/mtd/spi-nor.h
===================================================================
--- linux.orig/include/linux/mtd/spi-nor.h
+++ linux/include/linux/mtd/spi-nor.h
@@ -347,7 +347,7 @@ struct spi_nor_flash_parameter;
* @flags: flag options for the current SPI-NOR (SNOR_F_*)
* @read_proto: the SPI protocol for read operations
* @write_proto: the SPI protocol for write operations
- * @reg_proto the SPI protocol for read_reg/write_reg/erase operations
+ * @reg_proto: the SPI protocol for read_reg/write_reg/erase operations
* @controller_ops: SPI NOR controller driver specific operations.
* @params: [FLASH-SPECIFIC] SPI-NOR flash parameters and settings.
* The structure includes legacy flash parameters and
______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/
^ permalink raw reply [flat|nested] 13+ messages in thread
* [PATCH v2 4/5] mtd: spi-nor: fix kernel-doc for spi_nor::info
2020-04-03 20:39 [PATCH v2 0/5] Fix kernel-doc comments for 'struct spi_nor' Sergei Shtylyov
` (2 preceding siblings ...)
2020-04-03 20:45 ` [PATCH v2 3/5] mtd: spi-nor: fix kernel-doc for spi_nor::reg_proto Sergei Shtylyov
@ 2020-04-03 20:49 ` Sergei Shtylyov
2020-04-20 9:20 ` Tudor.Ambarus
2020-04-28 8:47 ` [PATCH trivial] mtd: spi-nor: Fix SPI NOR acronym Tudor.Ambarus
2020-04-03 20:50 ` [PATCH v2 5/5] mtd: spi-nor: fix kernel-doc for spi_nor::spimem Sergei Shtylyov
2020-04-28 8:35 ` [PATCH v2 0/5] Fix kernel-doc comments for 'struct spi_nor' Tudor.Ambarus
5 siblings, 2 replies; 13+ messages in thread
From: Sergei Shtylyov @ 2020-04-03 20:49 UTC (permalink / raw)
To: Tudor Ambarus, linux-mtd
Cc: Richard Weinberger, Vignesh Raghavendra, Miquel Raynal
When adding the 'info' field to 'struct spi_nor', some acronyms were in
lower case and some in upper case and the JEDEC acronym mistyped -- fix
these issues.
Fixes: 46dde01f6bab ("mtd: spi-nor: add spi_nor_init() function")
Signed-off-by: Sergei Shtylyov <sergei.shtylyov@cogentembedded.com>
---
Changes in version 2:
- rebased to the 'spi-nor/next' branch of the MTD repo.
include/linux/mtd/spi-nor.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
Index: linux/include/linux/mtd/spi-nor.h
===================================================================
--- linux.orig/include/linux/mtd/spi-nor.h
+++ linux/include/linux/mtd/spi-nor.h
@@ -335,7 +335,7 @@ struct spi_nor_flash_parameter;
* @bouncebuf: bounce buffer used when the buffer passed by the MTD
* layer is not DMA-able
* @bouncebuf_size: size of the bounce buffer
- * @info: spi-nor part JDEC MFR id and other info
+ * @info: SPI-NOR part JEDEC MFR ID and other info
* @manufacturer: spi-nor manufacturer
* @page_size: the page size of the SPI NOR
* @addr_width: number of address bytes
______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/
^ permalink raw reply [flat|nested] 13+ messages in thread
* [PATCH v2 5/5] mtd: spi-nor: fix kernel-doc for spi_nor::spimem
2020-04-03 20:39 [PATCH v2 0/5] Fix kernel-doc comments for 'struct spi_nor' Sergei Shtylyov
` (3 preceding siblings ...)
2020-04-03 20:49 ` [PATCH v2 4/5] mtd: spi-nor: fix kernel-doc for spi_nor::info Sergei Shtylyov
@ 2020-04-03 20:50 ` Sergei Shtylyov
2020-04-28 8:35 ` [PATCH v2 0/5] Fix kernel-doc comments for 'struct spi_nor' Tudor.Ambarus
5 siblings, 0 replies; 13+ messages in thread
From: Sergei Shtylyov @ 2020-04-03 20:50 UTC (permalink / raw)
To: Tudor Ambarus, linux-mtd
Cc: Richard Weinberger, Vignesh Raghavendra, Miquel Raynal
When adding the 'spimem' field to 'struct spi_nor', a grammar mistake
("point" instead of "pointer") was made -- fix it and convert the SPI
acronym to uppercase and fully spell out "memory", while at it...
Fixes: b35b9a10362 ("mtd: spi-nor: Move m25p80 code in spi-nor.c")
Signed-off-by: Sergei Shtylyov <sergei.shtylyov@cogentembedded.com>
---
Changes in version 2:
- rebased to the 'spi-nor/next' branch of the MTD repo.
include/linux/mtd/spi-nor.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
Index: linux/include/linux/mtd/spi-nor.h
===================================================================
--- linux.orig/include/linux/mtd/spi-nor.h
+++ linux/include/linux/mtd/spi-nor.h
@@ -331,7 +331,7 @@ struct spi_nor_flash_parameter;
* @mtd: an mtd_info structure
* @lock: the lock for the read/write/erase/lock/unlock operations
* @dev: pointer to an SPI device or an SPI NOR controller device
- * @spimem: point to the spi mem device
+ * @spimem: pointer to the SPI memory device
* @bouncebuf: bounce buffer used when the buffer passed by the MTD
* layer is not DMA-able
* @bouncebuf_size: size of the bounce buffer
______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/
^ permalink raw reply [flat|nested] 13+ messages in thread
* Re: [PATCH v2 4/5] mtd: spi-nor: fix kernel-doc for spi_nor::info
2020-04-03 20:49 ` [PATCH v2 4/5] mtd: spi-nor: fix kernel-doc for spi_nor::info Sergei Shtylyov
@ 2020-04-20 9:20 ` Tudor.Ambarus
2020-04-21 3:50 ` Tudor.Ambarus
2020-04-28 8:47 ` [PATCH trivial] mtd: spi-nor: Fix SPI NOR acronym Tudor.Ambarus
1 sibling, 1 reply; 13+ messages in thread
From: Tudor.Ambarus @ 2020-04-20 9:20 UTC (permalink / raw)
To: sergei.shtylyov; +Cc: richard, linux-mtd, vigneshr, miquel.raynal
Hi, Sergei,
On Friday, April 3, 2020 11:49:48 PM EEST Sergei Shtylyov wrote:
> EXTERNAL EMAIL: Do not click links or open attachments unless you know the
> content is safe
>
> When adding the 'info' field to 'struct spi_nor', some acronyms were in
> lower case and some in upper case and the JEDEC acronym mistyped -- fix
> these issues.
>
> Fixes: 46dde01f6bab ("mtd: spi-nor: add spi_nor_init() function")
> Signed-off-by: Sergei Shtylyov <sergei.shtylyov@cogentembedded.com>
>
> ---
> Changes in version 2:
> - rebased to the 'spi-nor/next' branch of the MTD repo.
>
> include/linux/mtd/spi-nor.h | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> Index: linux/include/linux/mtd/spi-nor.h
> ===================================================================
> --- linux.orig/include/linux/mtd/spi-nor.h
> +++ linux/include/linux/mtd/spi-nor.h
> @@ -335,7 +335,7 @@ struct spi_nor_flash_parameter;
> * @bouncebuf: bounce buffer used when the buffer passed by the MTD
> * layer is not DMA-able
> * @bouncebuf_size: size of the bounce buffer
> - * @info: spi-nor part JDEC MFR id and other info
> + * @info: SPI-NOR part JEDEC MFR ID and other info
There is an inconsistency in this file when referring to SPI NOR. It's either
called SPI-NOR or "SPI NOR". While I don't have a preference whether to keep
the "-" or not, I think we should be consistent across the file and use just a
format. So would you care to fix all the comments in spi-nor.h?
> * @manufacturer: spi-nor manufacturer
^ here's another problem.
Also, I think I would fix all these typos in a single patch, the fixes are
trivial enough, without affecting functionality and I'm not sure it is worth
backporting them. But again I don't have a strong opinion, so if you want to
keep these in separate commits that's ok for me.
Cheers,
ta
______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/
^ permalink raw reply [flat|nested] 13+ messages in thread
* Re: [PATCH v2 4/5] mtd: spi-nor: fix kernel-doc for spi_nor::info
2020-04-20 9:20 ` Tudor.Ambarus
@ 2020-04-21 3:50 ` Tudor.Ambarus
0 siblings, 0 replies; 13+ messages in thread
From: Tudor.Ambarus @ 2020-04-21 3:50 UTC (permalink / raw)
To: sergei.shtylyov; +Cc: richard, linux-mtd, vigneshr, miquel.raynal
On Monday, April 20, 2020 12:20:48 PM EEST Tudor Ambarus wrote:
> Hi, Sergei,
>
> On Friday, April 3, 2020 11:49:48 PM EEST Sergei Shtylyov wrote:
> > EXTERNAL EMAIL: Do not click links or open attachments unless you know the
> > content is safe
> >
> > When adding the 'info' field to 'struct spi_nor', some acronyms were in
> > lower case and some in upper case and the JEDEC acronym mistyped -- fix
> > these issues.
> >
> > Fixes: 46dde01f6bab ("mtd: spi-nor: add spi_nor_init() function")
> > Signed-off-by: Sergei Shtylyov <sergei.shtylyov@cogentembedded.com>
> >
> > ---
> > Changes in version 2:
> > - rebased to the 'spi-nor/next' branch of the MTD repo.
> >
> > include/linux/mtd/spi-nor.h | 2 +-
> > 1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > Index: linux/include/linux/mtd/spi-nor.h
> > ===================================================================
> > --- linux.orig/include/linux/mtd/spi-nor.h
> > +++ linux/include/linux/mtd/spi-nor.h
> > @@ -335,7 +335,7 @@ struct spi_nor_flash_parameter;
> >
> > * @bouncebuf: bounce buffer used when the buffer passed by the
> > MTD
> >
> > * layer is not DMA-able
> >
> > * @bouncebuf_size: size of the bounce buffer
> >
> > - * @info: spi-nor part JDEC MFR id and other info
> > + * @info: SPI-NOR part JEDEC MFR ID and other info
>
> There is an inconsistency in this file when referring to SPI NOR. It's
> either called SPI-NOR or "SPI NOR". While I don't have a preference whether
> to keep the "-" or not, I think we should be consistent across the file and
Probably it's better to have "SPI NOR" instead of "SPI-NOR".
> use just a format. So would you care to fix all the comments in spi-nor.h?
>
> > * @manufacturer: spi-nor manufacturer
>
> ^ here's another problem.
>
> Also, I think I would fix all these typos in a single patch, the fixes are
> trivial enough, without affecting functionality and I'm not sure it is worth
> backporting them. But again I don't have a strong opinion, so if you want
> to keep these in separate commits that's ok for me.
>
BTW, the rest of the patches in this series look good. Let me know if you're
going to resubmit and address the rest of the doc/comments issues in this
file.
Cheers,
ta
______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/
^ permalink raw reply [flat|nested] 13+ messages in thread
* Re: [PATCH v2 0/5] Fix kernel-doc comments for 'struct spi_nor'
2020-04-03 20:39 [PATCH v2 0/5] Fix kernel-doc comments for 'struct spi_nor' Sergei Shtylyov
` (4 preceding siblings ...)
2020-04-03 20:50 ` [PATCH v2 5/5] mtd: spi-nor: fix kernel-doc for spi_nor::spimem Sergei Shtylyov
@ 2020-04-28 8:35 ` Tudor.Ambarus
5 siblings, 0 replies; 13+ messages in thread
From: Tudor.Ambarus @ 2020-04-28 8:35 UTC (permalink / raw)
To: sergei.shtylyov; +Cc: richard, linux-mtd, vigneshr, miquel.raynal
On Friday, April 3, 2020 11:39:25 PM EEST Sergei Shtylyov wrote:
> EXTERNAL EMAIL: Do not click links or open attachments unless you know the
> content is safe
>
> Hello!
>
> Here's a set of 5 patches against the 'spi-nor/next' branch of the MTD
> 'linux.git' repo. I'm fixing a number of issues in the kernel-doc comment
> to 'struct spi_nor' accumulated since its creation. Instead of a single
> patch, I'm fixing the kernel-doc comment with several patches, each fixing
> its own broken commit -- this simplifies porting to the stable kernels (if
> that ever happens). :-)
>
> [1/5] mtd: spi-nor: fix kernel-doc for 'struct spi_nor'
> [2/5] mtd: spi-nor: fix kernel-doc for spi_nor::mtd
> [3/5] mtd: spi-nor: fix kernel-doc for spi_nor::reg_proto
> [4/5] mtd: spi-nor: fix kernel-doc for spi_nor::info
> [5/5] mtd: spi-nor: fix kernel-doc for spi_nor::spimem
>
> MBR, Sergei
s/SPI-NOR/SPI NOR in 4/5. All applied, thanks.
______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/
^ permalink raw reply [flat|nested] 13+ messages in thread
* [PATCH trivial] mtd: spi-nor: Fix SPI NOR acronym
2020-04-03 20:49 ` [PATCH v2 4/5] mtd: spi-nor: fix kernel-doc for spi_nor::info Sergei Shtylyov
2020-04-20 9:20 ` Tudor.Ambarus
@ 2020-04-28 8:47 ` Tudor.Ambarus
2020-04-28 8:56 ` Tudor.Ambarus
` (2 more replies)
1 sibling, 3 replies; 13+ messages in thread
From: Tudor.Ambarus @ 2020-04-28 8:47 UTC (permalink / raw)
To: sergei.shtylyov, vigneshr; +Cc: linux-mtd, Tudor.Ambarus
From: Tudor Ambarus <tudor.ambarus@microchip.com>
The correct terminology is serial NOR flash or SPI NOR.
s/SPI-NOR/SPI NOR and s/spi-nor/SPI NOR across the subsystem.
Signed-off-by: Tudor Ambarus <tudor.ambarus@microchip.com>
---
drivers/mtd/spi-nor/Kconfig | 4 ++--
drivers/mtd/spi-nor/controllers/Kconfig | 4 ++--
drivers/mtd/spi-nor/controllers/aspeed-smc.c | 2 +-
drivers/mtd/spi-nor/controllers/hisi-sfc.c | 2 +-
drivers/mtd/spi-nor/controllers/nxp-spifi.c | 2 +-
drivers/mtd/spi-nor/core.c | 4 ++--
include/linux/mtd/spi-nor.h | 8 ++++----
7 files changed, 13 insertions(+), 13 deletions(-)
diff --git a/drivers/mtd/spi-nor/Kconfig b/drivers/mtd/spi-nor/Kconfig
index 6e816eafb312..ffc4b380f2b1 100644
--- a/drivers/mtd/spi-nor/Kconfig
+++ b/drivers/mtd/spi-nor/Kconfig
@@ -1,12 +1,12 @@
# SPDX-License-Identifier: GPL-2.0-only
menuconfig MTD_SPI_NOR
- tristate "SPI-NOR device support"
+ tristate "SPI NOR device support"
depends on MTD
depends on MTD && SPI_MASTER
select SPI_MEM
help
This is the framework for the SPI NOR which can be used by the SPI
- device drivers and the SPI-NOR device driver.
+ device drivers and the SPI NOR device driver.
if MTD_SPI_NOR
diff --git a/drivers/mtd/spi-nor/controllers/Kconfig b/drivers/mtd/spi-nor/controllers/Kconfig
index 10b86660b821..d89a5ea9446a 100644
--- a/drivers/mtd/spi-nor/controllers/Kconfig
+++ b/drivers/mtd/spi-nor/controllers/Kconfig
@@ -21,11 +21,11 @@ config SPI_CADENCE_QUADSPI
Flash as an MTD device.
config SPI_HISI_SFC
- tristate "Hisilicon FMC SPI-NOR Flash Controller(SFC)"
+ tristate "Hisilicon FMC SPI NOR Flash Controller(SFC)"
depends on ARCH_HISI || COMPILE_TEST
depends on HAS_IOMEM
help
- This enables support for HiSilicon FMC SPI-NOR flash controller.
+ This enables support for HiSilicon FMC SPI NOR flash controller.
config SPI_NXP_SPIFI
tristate "NXP SPI Flash Interface (SPIFI)"
diff --git a/drivers/mtd/spi-nor/controllers/aspeed-smc.c b/drivers/mtd/spi-nor/controllers/aspeed-smc.c
index ae85e4c0e114..7225870e8b18 100644
--- a/drivers/mtd/spi-nor/controllers/aspeed-smc.c
+++ b/drivers/mtd/spi-nor/controllers/aspeed-smc.c
@@ -727,7 +727,7 @@ static int aspeed_smc_chip_setup_finish(struct aspeed_smc_chip *chip)
/*
* TODO: Adjust clocks if fast read is supported and interpret
- * SPI-NOR flags to adjust controller settings.
+ * SPI NOR flags to adjust controller settings.
*/
if (chip->nor.read_proto == SNOR_PROTO_1_1_1) {
if (chip->nor.read_dummy == 0)
diff --git a/drivers/mtd/spi-nor/controllers/hisi-sfc.c b/drivers/mtd/spi-nor/controllers/hisi-sfc.c
index 6c7a4118752e..95c502173cbd 100644
--- a/drivers/mtd/spi-nor/controllers/hisi-sfc.c
+++ b/drivers/mtd/spi-nor/controllers/hisi-sfc.c
@@ -1,6 +1,6 @@
// SPDX-License-Identifier: GPL-2.0-or-later
/*
- * HiSilicon FMC SPI-NOR flash controller driver
+ * HiSilicon FMC SPI NOR flash controller driver
*
* Copyright (c) 2015-2016 HiSilicon Technologies Co., Ltd.
*/
diff --git a/drivers/mtd/spi-nor/controllers/nxp-spifi.c b/drivers/mtd/spi-nor/controllers/nxp-spifi.c
index 9a5b1a7c636a..5703e8313980 100644
--- a/drivers/mtd/spi-nor/controllers/nxp-spifi.c
+++ b/drivers/mtd/spi-nor/controllers/nxp-spifi.c
@@ -1,6 +1,6 @@
// SPDX-License-Identifier: GPL-2.0-only
/*
- * SPI-NOR driver for NXP SPI Flash Interface (SPIFI)
+ * SPI NOR driver for NXP SPI Flash Interface (SPIFI)
*
* Copyright (C) 2015 Joachim Eastwood <manabian@gmail.com>
*
diff --git a/drivers/mtd/spi-nor/core.c b/drivers/mtd/spi-nor/core.c
index 757ac0e21554..ed69a44e8964 100644
--- a/drivers/mtd/spi-nor/core.c
+++ b/drivers/mtd/spi-nor/core.c
@@ -2469,7 +2469,7 @@ static int spi_nor_select_read(struct spi_nor *nor,
nor->read_proto = read->proto;
/*
- * In the spi-nor framework, we don't need to make the difference
+ * In the SPI NOR framework, we don't need to make the difference
* between mode clock cycles and wait state clock cycles.
* Indeed, the value of the mode clock cycles is used by a QSPI
* flash memory to know whether it should enter or leave its 0-4-4
@@ -3126,7 +3126,7 @@ int spi_nor_scan(struct spi_nor *nor, const char *name,
/*
* Make sure the XSR_RDY flag is set before calling
* spi_nor_wait_till_ready(). Xilinx S3AN share MFR
- * with Atmel spi-nor
+ * with Atmel SPI NOR.
*/
if (info->flags & SPI_NOR_XSR_RDY)
nor->flags |= SNOR_F_READY_XSR_RDY;
diff --git a/include/linux/mtd/spi-nor.h b/include/linux/mtd/spi-nor.h
index bebff2729c18..60bac2c0ec45 100644
--- a/include/linux/mtd/spi-nor.h
+++ b/include/linux/mtd/spi-nor.h
@@ -302,7 +302,7 @@ struct spi_nor;
* @read: read data from the SPI NOR.
* @write: write data to the SPI NOR.
* @erase: erase a sector of the SPI NOR at the offset @offs; if
- * not provided by the driver, spi-nor will send the erase
+ * not provided by the driver, SPI NOR will send the erase
* opcode via write_reg().
*/
struct spi_nor_controller_ops {
@@ -336,7 +336,7 @@ struct spi_nor_flash_parameter;
* layer is not DMA-able
* @bouncebuf_size: size of the bounce buffer
* @info: SPI NOR part JEDEC MFR ID and other info
- * @manufacturer: spi-nor manufacturer
+ * @manufacturer: SPI NOR manufacturer
* @page_size: the page size of the SPI NOR
* @addr_width: number of address bytes
* @erase_opcode: the opcode for erasing a sector
@@ -344,12 +344,12 @@ struct spi_nor_flash_parameter;
* @read_dummy: the dummy needed by the read operation
* @program_opcode: the program opcode
* @sst_write_second: used by the SST write operation
- * @flags: flag options for the current SPI-NOR (SNOR_F_*)
+ * @flags: flag options for the current SPI NOR (SNOR_F_*)
* @read_proto: the SPI protocol for read operations
* @write_proto: the SPI protocol for write operations
* @reg_proto: the SPI protocol for read_reg/write_reg/erase operations
* @controller_ops: SPI NOR controller driver specific operations.
- * @params: [FLASH-SPECIFIC] SPI-NOR flash parameters and settings.
+ * @params: [FLASH-SPECIFIC] SPI NOR flash parameters and settings.
* The structure includes legacy flash parameters and
* settings that can be overwritten by the spi_nor_fixups
* hooks, or dynamically when parsing the SFDP tables.
--
2.23.0
______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/
^ permalink raw reply related [flat|nested] 13+ messages in thread
* Re: [PATCH trivial] mtd: spi-nor: Fix SPI NOR acronym
2020-04-28 8:47 ` [PATCH trivial] mtd: spi-nor: Fix SPI NOR acronym Tudor.Ambarus
@ 2020-04-28 8:56 ` Tudor.Ambarus
2020-05-01 19:53 ` Sergei Shtylyov
2020-05-28 8:11 ` Tudor.Ambarus
2 siblings, 0 replies; 13+ messages in thread
From: Tudor.Ambarus @ 2020-04-28 8:56 UTC (permalink / raw)
To: sergei.shtylyov; +Cc: linux-mtd, vigneshr
Hi, Sergei,
On Tuesday, April 28, 2020 11:47:43 AM EEST Tudor Ambarus - M18064 wrote:
> From: Tudor Ambarus <tudor.ambarus@microchip.com>
>
> The correct terminology is serial NOR flash or SPI NOR.
> s/SPI-NOR/SPI NOR and s/spi-nor/SPI NOR across the subsystem.
>
> Signed-off-by: Tudor Ambarus <tudor.ambarus@microchip.com>
> ---
> drivers/mtd/spi-nor/Kconfig | 4 ++--
> drivers/mtd/spi-nor/controllers/Kconfig | 4 ++--
> drivers/mtd/spi-nor/controllers/aspeed-smc.c | 2 +-
> drivers/mtd/spi-nor/controllers/hisi-sfc.c | 2 +-
> drivers/mtd/spi-nor/controllers/nxp-spifi.c | 2 +-
> drivers/mtd/spi-nor/core.c | 4 ++--
> include/linux/mtd/spi-nor.h | 8 ++++----
> 7 files changed, 13 insertions(+), 13 deletions(-)
Would you please review this patch? Can you take a look also on the following
trivial patches?
https://patchwork.ozlabs.org/project/linux-mtd/patch/20200421063129.244466-1-tudor.ambarus@microchip.com/
https://patchwork.ozlabs.org/project/linux-mtd/patch/20200421063129.244466-2-tudor.ambarus@microchip.com/
Cheers,
ta
______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/
^ permalink raw reply [flat|nested] 13+ messages in thread
* Re: [PATCH trivial] mtd: spi-nor: Fix SPI NOR acronym
2020-04-28 8:47 ` [PATCH trivial] mtd: spi-nor: Fix SPI NOR acronym Tudor.Ambarus
2020-04-28 8:56 ` Tudor.Ambarus
@ 2020-05-01 19:53 ` Sergei Shtylyov
2020-05-28 8:11 ` Tudor.Ambarus
2 siblings, 0 replies; 13+ messages in thread
From: Sergei Shtylyov @ 2020-05-01 19:53 UTC (permalink / raw)
To: Tudor.Ambarus, vigneshr; +Cc: linux-mtd
Hello!
On 04/28/2020 11:47 AM, Tudor.Ambarus@microchip.com wrote:
> From: Tudor Ambarus <tudor.ambarus@microchip.com>
>
> The correct terminology is serial NOR flash or SPI NOR.
> s/SPI-NOR/SPI NOR and s/spi-nor/SPI NOR across the subsystem.
>
> Signed-off-by: Tudor Ambarus <tudor.ambarus@microchip.com>
[...]
Reviewed-by: Sergei Shtylyov <sergei.shtylyov@cogentembedded.com>
MBR, Sergei
______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/
^ permalink raw reply [flat|nested] 13+ messages in thread
* Re: [PATCH trivial] mtd: spi-nor: Fix SPI NOR acronym
2020-04-28 8:47 ` [PATCH trivial] mtd: spi-nor: Fix SPI NOR acronym Tudor.Ambarus
2020-04-28 8:56 ` Tudor.Ambarus
2020-05-01 19:53 ` Sergei Shtylyov
@ 2020-05-28 8:11 ` Tudor.Ambarus
2 siblings, 0 replies; 13+ messages in thread
From: Tudor.Ambarus @ 2020-05-28 8:11 UTC (permalink / raw)
To: sergei.shtylyov; +Cc: linux-mtd, vigneshr
On Tuesday, April 28, 2020 11:47:43 AM EEST Tudor Ambarus - M18064 wrote:
> The correct terminology is serial NOR flash or SPI NOR.
> s/SPI-NOR/SPI NOR and s/spi-nor/SPI NOR across the subsystem.
>
> Signed-off-by: Tudor Ambarus <tudor.ambarus@microchip.com>
Applied, thanks.
______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/
^ permalink raw reply [flat|nested] 13+ messages in thread
end of thread, other threads:[~2020-05-28 8:11 UTC | newest]
Thread overview: 13+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-04-03 20:39 [PATCH v2 0/5] Fix kernel-doc comments for 'struct spi_nor' Sergei Shtylyov
2020-04-03 20:41 ` [PATCH v2 1/5] mtd: spi-nor: fix kernel-doc " Sergei Shtylyov
2020-04-03 20:44 ` [PATCH v2 2/5] mtd: spi-nor: fix kernel-doc for spi_nor::mtd Sergei Shtylyov
2020-04-03 20:45 ` [PATCH v2 3/5] mtd: spi-nor: fix kernel-doc for spi_nor::reg_proto Sergei Shtylyov
2020-04-03 20:49 ` [PATCH v2 4/5] mtd: spi-nor: fix kernel-doc for spi_nor::info Sergei Shtylyov
2020-04-20 9:20 ` Tudor.Ambarus
2020-04-21 3:50 ` Tudor.Ambarus
2020-04-28 8:47 ` [PATCH trivial] mtd: spi-nor: Fix SPI NOR acronym Tudor.Ambarus
2020-04-28 8:56 ` Tudor.Ambarus
2020-05-01 19:53 ` Sergei Shtylyov
2020-05-28 8:11 ` Tudor.Ambarus
2020-04-03 20:50 ` [PATCH v2 5/5] mtd: spi-nor: fix kernel-doc for spi_nor::spimem Sergei Shtylyov
2020-04-28 8:35 ` [PATCH v2 0/5] Fix kernel-doc comments for 'struct spi_nor' Tudor.Ambarus
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.