Merge m25p80 into spi-nor
Subsystems (2)
Vignesh Raghavendra
maintainerv3 cover Merge m25p80 into spi-nor
This is repost of patch 6 and 7 split from from Boris Brezillon's X-X-X mode support series[1]
Background from cover letter for RFC[1]:
m25p80 is just a simple SPI NOR controller driver (a wrapper around the SPI mem API). Not only it shouldn't be named after a specific SPI NOR chip, but it also doesn't deserve a specific driver IMO, especially if the end goal is to get rid of SPI NOR controller drivers found in drivers/mtd/spi-nor/ and replace them by SPI mem drivers (which would be placed in drivers/spi/). With this solution, we declare the SPI NOR driver as a spi_mem_driver, just like the SPI NAND layer is declared as a spi_mem driver (patch 1/2).
This solution also allows us to check at a fined-grain level (thanks to the spi_mem_supports_op() function) which operations are supported and which ones are not, while the original m25p80 logic was basing this decision on the SPI_{RX,TX}_{DUAL,QUAD,OCTO} flags only (patch 2/2).
[1] https://patchwork.ozlabs.org/cover/982926/
Tested on TI' DRA7xx EVM with TI QSPI controller (a spi-mem driver) with DMA (s25fl256) flash. I don't see any performance regression due to bounce buffer copy introduced by this series
Also tested with cadence-quadspi (a spi-nor driver) driver
Boris Brezillon (2):
mtd: spi-nor: Move m25p80 code in spi-nor.c
mtd: spi-nor: Rework hwcaps selection for the spi-mem case
Vignesh Raghavendra (1):
mtd: spi-nor: always use bounce buffer for register read/writes
drivers/mtd/devices/Kconfig | 18 - drivers/mtd/devices/Makefile | 1 - drivers/mtd/devices/m25p80.c | 347 --------------- drivers/mtd/spi-nor/Kconfig | 2 + drivers/mtd/spi-nor/spi-nor.c | 802 +++++++++++++++++++++++++++++++--- include/linux/mtd/spi-nor.h | 24 +- 6 files changed, 769 insertions(+), 425 deletions(-) delete mode 100644 drivers/mtd/devices/m25p80.c
Signature · 1 line
2.22.0
Vignesh Raghavendra
maintainerPATCH v3 1/3 mtd: spi-nor: always use bounce buffer for register read/writes
spi-mem layer expects all buffers passed to it to be DMA'able. But spi-nor layer mostly allocates buffers on stack for reading/writing to registers and therefore are not DMA'able. Introduce bounce buffer to be used to read/write to registers. This ensures that buffer passed to spi-mem layer during register read/writes is DMA'able. With this change nor->cmd-buf is no longer used, so drop it.
---
v3: new patch
drivers/mtd/spi-nor/spi-nor.c | 71 ++++++++++++++++++++--------------- include/linux/mtd/spi-nor.h | 7 +++- 2 files changed, 46 insertions(+), 32 deletions(-)
drivers/mtd/spi-nor/spi-nor.c +41 -30
@@ -296,15 +296,14 @@ struct flash_info {static int read_sr (struct spi_nor *nor) {int ret; -u8 val; - ret = nor->read_reg (nor,SPINOR_OP_RDSR , &val,1 ); + ret = nor->read_reg (nor,SPINOR_OP_RDSR , nor->bouncebuf,1 );if (ret <0 ) {pr_err ("error %d reading SR\n" , (int ) ret);return ret; } -return val; +return nor->bouncebuf[0 ]; }/*
@@ -315,15 +314,14 @@ static int read_sr(struct spi_nor *nor)static int read_fsr (struct spi_nor *nor) {int ret; -u8 val; - ret = nor->read_reg (nor,SPINOR_OP_RDFSR , &val,1 ); + ret = nor->read_reg (nor,SPINOR_OP_RDFSR , nor->bouncebuf,1 );if (ret <0 ) {pr_err ("error %d reading FSR\n" , ret);return ret; } -return val; +return nor->bouncebuf[0 ]; }/*
@@ -334,15 +332,14 @@ static int read_fsr(struct spi_nor *nor)static int read_cr (struct spi_nor *nor) {int ret; -u8 val; - ret = nor->read_reg (nor,SPINOR_OP_RDCR , &val,1 ); + ret = nor->read_reg (nor,SPINOR_OP_RDCR , nor->bouncebuf,1 );if (ret <0 ) {dev_err (nor->dev,"error %d reading CR\n" , ret);return ret; } -return val; +return nor->bouncebuf[0 ]; }/*
@@ -351,8 +348,8 @@ static int read_cr(struct spi_nor *nor)*/ static int write_sr (struct spi_nor *nor,u8 val) { - nor->cmd_buf[0 ] = val; -return nor->write_reg (nor,SPINOR_OP_WRSR , nor->cmd_buf,1 ); + nor->bouncebuf[0 ] = val; +return nor->write_reg (nor,SPINOR_OP_WRSR , nor->bouncebuf,1 ); }/*
@@ -500,31 +497,31 @@ static int set_4byte(struct spi_nor *nor, bool enable)* We must clear the register to enable normal behavior. */ write_enable (nor); - nor->cmd_buf[0 ] =0 ; - nor->write_reg (nor,SPINOR_OP_WREAR , nor->cmd_buf,1 ); + nor->bouncebuf[0 ] =0 ; + nor->write_reg (nor,SPINOR_OP_WREAR , + nor->bouncebuf,1 );write_disable (nor); }return status;default :/* Spansion style */ - nor->cmd_buf[0 ] = enable <<7 ; -return nor->write_reg (nor,SPINOR_OP_BRWR , nor->cmd_buf,1 ); + nor->bouncebuf[0 ] = enable <<7 ; +return nor->write_reg (nor,SPINOR_OP_BRWR , nor->bouncebuf,1 ); } }static int s3an_sr_ready (struct spi_nor *nor) {int ret; -u8 val; - ret = nor->read_reg (nor,SPINOR_OP_XRDSR , &val,1 ); + ret = nor->read_reg (nor,SPINOR_OP_XRDSR , nor->bouncebuf,1 );if (ret <0 ) {dev_err (nor->dev,"error %d reading XRDSR\n" , (int ) ret);return ret; } -return !!(val &XSR_RDY ); +return !!(nor->bouncebuf[0 ] &XSR_RDY ); }static int spi_nor_sr_ready (struct spi_nor *nor)
@@ -683,7 +680,6 @@ static loff_t spi_nor_s3an_addr_convert(struct spi_nor *nor, unsigned int addr)*/ static int spi_nor_erase_sector (struct spi_nor *nor,u32 addr) { -u8 buf[SPI_NOR_MAX_ADDR_WIDTH ];int i;if (nor->flags &SNOR_F_S3AN_ADDR_DEFAULT )
@@ -697,11 +693,12 @@ static int spi_nor_erase_sector(struct spi_nor *nor, u32 addr)* control */ for (i = nor->addr_width -1 ; i >=0 ; i--) { - buf[i] = addr &0xff ; + nor->bouncebuf[i] = addr &0xff ; addr >>=8 ; } -return nor->write_reg (nor, nor->erase_opcode, buf, nor->addr_width); +return nor->write_reg (nor, nor->erase_opcode, nor->bouncebuf, + nor->addr_width); }/**
@@ -1404,9 +1401,11 @@ static int write_sr_cr(struct spi_nor *nor, u8 *sr_cr) {int ret; +memcpy (nor->bouncebuf, sr_cr,2 ); +write_enable (nor); - ret = nor->write_reg (nor,SPINOR_OP_WRSR , sr_cr,2 ); + ret = nor->write_reg (nor,SPINOR_OP_WRSR , nor->bouncebuf,2 );if (ret <0 ) {dev_err (nor->dev,"error while writing configuration register\n" );
@@ -1599,22 +1598,22 @@ static int spansion_read_cr_quad_enable(struct spi_nor *nor)*/ static int sr2_bit7_quad_enable (struct spi_nor *nor) { -u8 sr2; +u8 *sr2 = nor->bouncebuf;int ret;/* Check current Quad Enable bit value. */ - ret = nor->read_reg (nor,SPINOR_OP_RDSR2 , &sr2,1 ); + ret = nor->read_reg (nor,SPINOR_OP_RDSR2 , sr2,1 );if (ret)return ret; -if (sr2 &SR2_QUAD_EN_BIT7 ) +if (*sr2 &SR2_QUAD_EN_BIT7 )return 0 ;/* Update the Quad Enable bit. */ - sr2 |=SR2_QUAD_EN_BIT7 ; + *sr2 |=SR2_QUAD_EN_BIT7 ;write_enable (nor); - ret = nor->write_reg (nor,SPINOR_OP_WRSR2 , &sr2,1 ); + ret = nor->write_reg (nor,SPINOR_OP_WRSR2 , sr2,1 );if (ret <0 ) {dev_err (nor->dev,"error while writing status register 2\n" );return -EINVAL ;
@@ -1627,8 +1626,8 @@ static int sr2_bit7_quad_enable(struct spi_nor *nor) }/* Read back and check it. */ - ret = nor->read_reg (nor,SPINOR_OP_RDSR2 , &sr2,1 ); -if (!(ret >0 && (sr2 &SR2_QUAD_EN_BIT7 ))) { + ret = nor->read_reg (nor,SPINOR_OP_RDSR2 , sr2,1 ); +if (!(ret >0 && (*sr2 &SR2_QUAD_EN_BIT7 ))) {dev_err (nor->dev,"SR2 Quad bit not set\n" );return -EINVAL ; }
@@ -2180,11 +2179,13 @@ static const struct flash_info *spi_nor_read_id(struct spi_nor *nor)u8 id[SPI_NOR_MAX_ID_LEN ];const struct flash_info *info; - tmp = nor->read_reg (nor,SPINOR_OP_RDID , id,SPI_NOR_MAX_ID_LEN ); + tmp = nor->read_reg (nor,SPINOR_OP_RDID , nor->bouncebuf, +SPI_NOR_MAX_ID_LEN );if (tmp <0 ) {dev_err (nor->dev,"error %d reading JEDEC ID\n" , tmp);return ERR_PTR (tmp); } +memcpy (id, nor->bouncebuf,SPI_NOR_MAX_ID_LEN );for (tmp =0 ; tmp <ARRAY_SIZE (spi_nor_ids) -1 ; tmp++) { info = &spi_nor_ids[tmp];
@@ -4121,6 +4122,16 @@ int spi_nor_scan(struct spi_nor *nor, const char *name, nor->read_proto =SNOR_PROTO_1_1_1 ; nor->write_proto =SNOR_PROTO_1_1_1 ; +/* +* We need the bounce buffer early to read/write registers when going +* through the spi-mem layer (buffers have to be DMA-able). +*/ + nor->bouncebuf_size =PAGE_SIZE ; + nor->bouncebuf =devm_kmalloc (dev, nor->bouncebuf_size, +GFP_KERNEL ); +if (!nor->bouncebuf) +return -ENOMEM ; +if (name) info =spi_nor_match_id (name);/* Try to auto-detect if chip name wasn't specified or not found */
include/linux/mtd/spi-nor.h +5 -2
@@ -344,6 +344,9 @@ struct flash_info;* @mtd: point to a 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. +* @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 * @page_size: the page size of the SPI NOR * @addr_width: number of address bytes
@@ -356,7 +359,6 @@ struct flash_info;* @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 -* @cmd_buf: used by the write_reg * @erase_map: the erase map of the SPI NOR * @prepare: [OPTIONAL] do some preparations for the * read/write/erase/lock/unlock operations
@@ -382,6 +384,8 @@ struct spi_nor {struct mtd_info mtd;struct mutex lock;struct device *dev; +u8 *bouncebuf; +size_t bouncebuf_size;const struct flash_info *info;u32 page_size;u8 addr_width;
@@ -394,7 +398,6 @@ struct spi_nor {enum spi_nor_protocol reg_proto;bool sst_write_second;u32 flags; -u8 cmd_buf[SPI_NOR_MAX_CMD_SIZE ];struct spi_nor_erase_map erase_map;int (*prepare)(struct spi_nor *nor,enum spi_nor_ops ops);
Signature · 1 line
2.22.0
Re: [PATCH v3 1/3] mtd: spi-nor: always use bounce buffer for register read/writes
Quoted 200 lines · On Thu, 1 Aug 2019 10:00:50 +0530 Vignesh Raghavendra <[email protected]> wrote:
spi-mem layer expects all buffers passed to it to be DMA'able. But spi-nor layer mostly allocates buffers on stack for reading/writing to registers and therefore are not DMA'able. Introduce bounce buffer to be used to read/write to registers. This ensures that buffer passed to spi-mem layer during register read/writes is DMA'able. With this change nor->cmd-buf is no longer used, so drop it.
Signed-off-by Vignesh Raghavendra <[email protected]>---
v3: new patchdrivers/mtd/spi-nor/spi-nor.c | 71 ++++++++++++++++++++--------------- include/linux/mtd/spi-nor.h | 7 +++- 2 files changed, 46 insertions(+), 32 deletions(-)drivers/mtd/spi-nor/spi-nor.c +28
-29@@ -296,15 +296,14 @@ struct flash_info {static int read_sr (struct spi_nor *nor) {int ret; -u8 val; - ret = nor->read_reg (nor,SPINOR_OP_RDSR , &val,1 ); + ret = nor->read_reg (nor,SPINOR_OP_RDSR , nor->bouncebuf,1 );if (ret <0 ) {pr_err ("error %d reading SR\n" , (int ) ret);return ret; } -return val; +return nor->bouncebuf[0 ]; }/* @@ -315,15 +314,14 @@ static int read_sr(struct spi_nor *nor)static int read_fsr (struct spi_nor *nor) {int ret; -u8 val; - ret = nor->read_reg (nor,SPINOR_OP_RDFSR , &val,1 ); + ret = nor->read_reg (nor,SPINOR_OP_RDFSR , nor->bouncebuf,1 );if (ret <0 ) {pr_err ("error %d reading FSR\n" , ret);return ret; } -return val; +return nor->bouncebuf[0 ]; }/* @@ -334,15 +332,14 @@ static int read_fsr(struct spi_nor *nor)static int read_cr (struct spi_nor *nor) {int ret; -u8 val; - ret = nor->read_reg (nor,SPINOR_OP_RDCR , &val,1 ); + ret = nor->read_reg (nor,SPINOR_OP_RDCR , nor->bouncebuf,1 );if (ret <0 ) {dev_err (nor->dev,"error %d reading CR\n" , ret);return ret; } -return val; +return nor->bouncebuf[0 ]; }/* @@ -351,8 +348,8 @@ static int read_cr(struct spi_nor *nor)*/ static int write_sr (struct spi_nor *nor,u8 val) { - nor->cmd_buf[0 ] = val; -return nor->write_reg (nor,SPINOR_OP_WRSR , nor->cmd_buf,1 ); + nor->bouncebuf[0 ] = val; +return nor->write_reg (nor,SPINOR_OP_WRSR , nor->bouncebuf,1 ); }/* @@ -500,31 +497,31 @@ static int set_4byte(struct spi_nor *nor, bool enable)* We must clear the register to enable normal behavior. */ write_enable (nor); - nor->cmd_buf[0 ] =0 ; - nor->write_reg (nor,SPINOR_OP_WREAR , nor->cmd_buf,1 ); + nor->bouncebuf[0 ] =0 ; + nor->write_reg (nor,SPINOR_OP_WREAR , + nor->bouncebuf,1 );write_disable (nor); }return status;default :/* Spansion style */ - nor->cmd_buf[0 ] = enable <<7 ; -return nor->write_reg (nor,SPINOR_OP_BRWR , nor->cmd_buf,1 ); + nor->bouncebuf[0 ] = enable <<7 ; +return nor->write_reg (nor,SPINOR_OP_BRWR , nor->bouncebuf,1 ); } }static int s3an_sr_ready (struct spi_nor *nor) {int ret; -u8 val; - ret = nor->read_reg (nor,SPINOR_OP_XRDSR , &val,1 ); + ret = nor->read_reg (nor,SPINOR_OP_XRDSR , nor->bouncebuf,1 );if (ret <0 ) {dev_err (nor->dev,"error %d reading XRDSR\n" , (int ) ret);return ret; } -return !!(val &XSR_RDY ); +return !!(nor->bouncebuf[0 ] &XSR_RDY ); }static int spi_nor_sr_ready (struct spi_nor *nor)@@ -683,7 +680,6 @@ static loff_t spi_nor_s3an_addr_convert(struct spi_nor *nor, unsigned int addr)*/ static int spi_nor_erase_sector (struct spi_nor *nor,u32 addr) { -u8 buf[SPI_NOR_MAX_ADDR_WIDTH ];int i;if (nor->flags &SNOR_F_S3AN_ADDR_DEFAULT )@@ -697,11 +693,12 @@ static int spi_nor_erase_sector(struct spi_nor *nor, u32 addr)* control */ for (i = nor->addr_width -1 ; i >=0 ; i--) { - buf[i] = addr &0xff ; + nor->bouncebuf[i] = addr &0xff ; addr >>=8 ; } -return nor->write_reg (nor, nor->erase_opcode, buf, nor->addr_width); +return nor->write_reg (nor, nor->erase_opcode, nor->bouncebuf, + nor->addr_width); }/** @@ -1404,9 +1401,11 @@ static int write_sr_cr(struct spi_nor *nor, u8 *sr_cr) {int ret; +memcpy (nor->bouncebuf, sr_cr,2 ); +write_enable (nor); - ret = nor->write_reg (nor,SPINOR_OP_WRSR , sr_cr,2 ); + ret = nor->write_reg (nor,SPINOR_OP_WRSR , nor->bouncebuf,2 );if (ret <0 ) {dev_err (nor->dev,"error while writing configuration register\n" );@@ -1599,22 +1598,22 @@ static int spansion_read_cr_quad_enable(struct spi_nor *nor)*/ static int sr2_bit7_quad_enable (struct spi_nor *nor) { -u8 sr2; +u8 *sr2 = nor->bouncebuf;int ret;/* Check current Quad Enable bit value. */ - ret = nor->read_reg (nor,SPINOR_OP_RDSR2 , &sr2,1 ); + ret = nor->read_reg (nor,SPINOR_OP_RDSR2 , sr2,1 );if (ret)return ret; -if (sr2 &SR2_QUAD_EN_BIT7 ) +if (*sr2 &SR2_QUAD_EN_BIT7 )return 0 ;/* Update the Quad Enable bit. */ - sr2 |=SR2_QUAD_EN_BIT7 ; + *sr2 |=SR2_QUAD_EN_BIT7 ;write_enable (nor); - ret = nor->write_reg (nor,SPINOR_OP_WRSR2 , &sr2,1 ); + ret = nor->write_reg (nor,SPINOR_OP_WRSR2 , sr2,1 );if (ret <0 ) {dev_err (nor->dev,"error while writing status register 2\n" );return -EINVAL ;@@ -1627,8 +1626,8 @@ static int sr2_bit7_quad_enable(struct spi_nor *nor) }/* Read back and check it. */ - ret = nor->read_reg (nor,SPINOR_OP_RDSR2 , &sr2,1 ); -if (!(ret >0 && (sr2 &SR2_QUAD_EN_BIT7 ))) { + ret = nor->read_reg (nor,SPINOR_OP_RDSR2 , sr2,1 ); +if (!(ret >0 && (*sr2 &SR2_QUAD_EN_BIT7 ))) {dev_err (nor->dev,"SR2 Quad bit not set\n" );return -EINVAL ; }@@ -2180,11 +2179,13 @@ static const struct flash_info *spi_nor_read_id(struct spi_nor *nor)u8 id[SPI_NOR_MAX_ID_LEN ];
drivers/mtd/spi-nor/spi-nor.c static const struct flash_info *spi_nor_read_id(struct spi_nor *nor) · line 2188
Quoted 10 lines
drivers/mtd/spi-nor/spi-nor.c +3
-1const struct flash_info *info; - tmp = nor->read_reg (nor,SPINOR_OP_RDID , id,SPI_NOR_MAX_ID_LEN ); + tmp = nor->read_reg (nor,SPINOR_OP_RDID , nor->bouncebuf, +SPI_NOR_MAX_ID_LEN );if (tmp <0 ) {dev_err (nor->dev,"error %d reading JEDEC ID\n" , tmp);return ERR_PTR (tmp); } +memcpy (id, nor->bouncebuf,SPI_NOR_MAX_ID_LEN );
Why not directly including the change you have in patch 2 (id is a pointer that points directly to ->bouncebuf) so you can get rid of this memcpy() here?
drivers/mtd/spi-nor/spi-nor.c int spi_nor_scan(struct spi_nor *nor, const char *name, · line 4127
Quoted 10 lines
drivers/mtd/spi-nor/spi-nor.c +3
-0for (tmp =0 ; tmp <ARRAY_SIZE (spi_nor_ids) -1 ; tmp++) { info = &spi_nor_ids[tmp];@@ -4121,6 +4122,16 @@ int spi_nor_scan(struct spi_nor *nor, const char *name, nor->read_proto =SNOR_PROTO_1_1_1 ; nor->write_proto =SNOR_PROTO_1_1_1 ; +/* +* We need the bounce buffer early to read/write registers when going +* through the spi-mem layer (buffers have to be DMA-able).
You should probably extend this comment in patch 2 to explain why 4k should be enough for regular read/write operations.
The patch looks good otherwise.
Quoted 49 lines
drivers/mtd/spi-nor/spi-nor.c +7
-0+*/ + nor->bouncebuf_size =PAGE_SIZE ; + nor->bouncebuf =devm_kmalloc (dev, nor->bouncebuf_size, +GFP_KERNEL ); +if (!nor->bouncebuf) +return -ENOMEM ; +if (name) info =spi_nor_match_id (name);/* Try to auto-detect if chip name wasn't specified or not found */ include/linux/mtd/spi-nor.h +5
-2@@ -344,6 +344,9 @@ struct flash_info;* @mtd: point to a 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. +* @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 * @page_size: the page size of the SPI NOR * @addr_width: number of address bytes @@ -356,7 +359,6 @@ struct flash_info;* @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 -* @cmd_buf: used by the write_reg * @erase_map: the erase map of the SPI NOR * @prepare: [OPTIONAL] do some preparations for the * read/write/erase/lock/unlock operations @@ -382,6 +384,8 @@ struct spi_nor {struct mtd_info mtd;struct mutex lock;struct device *dev; +u8 *bouncebuf; +size_t bouncebuf_size;const struct flash_info *info;u32 page_size;u8 addr_width;@@ -394,7 +398,6 @@ struct spi_nor {enum spi_nor_protocol reg_proto;bool sst_write_second;u32 flags; -u8 cmd_buf[SPI_NOR_MAX_CMD_SIZE ];struct spi_nor_erase_map erase_map;int (*prepare)(struct spi_nor *nor,enum spi_nor_ops ops);
Vignesh Raghavendra
maintainerRe: [PATCH v3 1/3] mtd: spi-nor: always use bounce buffer for register read/writes
Hi Boris
Quoted 14 lines · Boris Brezillon
Quoted 11 lines · On Thu, 1 Aug 2019 10:00:50 +0530 Vignesh Raghavendra <[email protected]> wrote:
spi-mem layer expects all buffers passed to it to be DMA'able. But spi-nor layer mostly allocates buffers on stack for reading/writing to registers and therefore are not DMA'able. Introduce bounce buffer to be used to read/write to registers. This ensures that buffer passed to spi-mem layer during register read/writes is DMA'able. With this change nor->cmd-buf is no longer used, so drop it.
Signed-off-by Vignesh Raghavendra <[email protected]>---
v3: new patch
[...]
Quoted 4 lines
Quoted 4 lines
drivers/mtd/spi-nor/spi-nor.c +0
-0@@ -2180,11 +2179,13 @@ static const struct flash_info *spi_nor_read_id(struct spi_nor *nor)u8 id[SPI_NOR_MAX_ID_LEN ];const struct flash_info *info;
Quoted 13 lines
drivers/mtd/spi-nor/spi-nor.c static const struct flash_info *spi_nor_read_id(struct spi_nor *nor) · line 2188
Quoted 8 lines
drivers/mtd/spi-nor/spi-nor.c +3
-1- tmp = nor->read_reg (nor,SPINOR_OP_RDID , id,SPI_NOR_MAX_ID_LEN ); + tmp = nor->read_reg (nor,SPINOR_OP_RDID , nor->bouncebuf, +SPI_NOR_MAX_ID_LEN );if (tmp <0 ) {dev_err (nor->dev,"error %d reading JEDEC ID\n" , tmp);return ERR_PTR (tmp); } +memcpy (id, nor->bouncebuf,SPI_NOR_MAX_ID_LEN );Why not directly including the change you have in patch 2 (id is a pointer that points directly to ->bouncebuf) so you can get rid of this
memcpy()here?
Ok will do that in next version.
Quoted 7 lines
Quoted 7 lines
drivers/mtd/spi-nor/spi-nor.c +0
-0for (tmp =0 ; tmp <ARRAY_SIZE (spi_nor_ids) -1 ; tmp++) { info = &spi_nor_ids[tmp];@@ -4121,6 +4122,16 @@ int spi_nor_scan(struct spi_nor *nor, const char *name, nor->read_proto =SNOR_PROTO_1_1_1 ; nor->write_proto =SNOR_PROTO_1_1_1 ;
Quoted 7 lines
drivers/mtd/spi-nor/spi-nor.c int spi_nor_scan(struct spi_nor *nor, const char *name, · line 4127
Quoted 3 lines
drivers/mtd/spi-nor/spi-nor.c +3
-0+/* +* We need the bounce buffer early to read/write registers when going +* through the spi-mem layer (buffers have to be DMA-able). You should probably extend this comment in patch 2 to explain why 4k should be enough for regular read/write operations.
Will update
Quoted 4 lines
The patch looks good otherwise.
Reviewed-by Boris Brezillon <[email protected]>
Thanks for the review!
Signature · 2 lines
Regards Vignesh
Vignesh Raghavendra
maintainerPATCH v3 2/3 mtd: spi-nor: Move m25p80 code in spi-nor.c
In reply to Vignesh RaghavendraFrom: Boris Brezillon <[email protected]>
The m25p80 driver is actually a generic wrapper around the spi-mem layer. Not only the driver name is misleading, but we'd expect such a common logic to be directly available in the core. Another reason for moving this code is that SPI NOR controller drivers should progressively be replaced by SPI controller drivers implementing the spi_mem_ops interface, and when the conversion is done, we should have a single spi-nor driver directly interfacing with the spi-mem layer.
While moving the code we also fix a longstanding issue when non-DMA-able buffers are passed by the MTD layer.
---
v3:
Simplify register read/write by dropping spi_nor_exec_op() and using spi_mem_exec_op() directly
Modify spi_nor_spimem_xfer_data() to drop "enum spi_nor_protocol proto" Fix misc coding style comments by Tudor
v2:
Add docs for new functions added
Add spi_nor_ prefix to new functions
Incorporate Andrey's patches https://lkml.org/lkml/2019/4/1/32
to avoid looping spi_nor_spimem_* APIs
drivers/mtd/devices/Kconfig | 18 - drivers/mtd/devices/Makefile | 1 - drivers/mtd/devices/m25p80.c | 347 ------------------- drivers/mtd/spi-nor/Kconfig | 2 + drivers/mtd/spi-nor/spi-nor.c | 632 ++++++++++++++++++++++++++++++++-- include/linux/mtd/spi-nor.h | 3 + 6 files changed, 604 insertions(+), 399 deletions(-) delete mode 100644 drivers/mtd/devices/m25p80.c
drivers/mtd/devices/Kconfig +0 -18
@@ -79,24 +79,6 @@ config MTD_DATAFLASH_OTP other key product data. The second half is programmed with a unique-to-each-chip bit pattern at the factory. -config MTD_M25P80 - tristate "Support most SPI Flash chips (AT26DF, M25P, W25X, ...)" - depends on SPI_MASTER && MTD_SPI_NOR - select SPI_MEM - help - This enables access to most modern SPI flash chips, used for - program and data storage. Series supported include Atmel AT26DF, - Spansion S25SL, SST 25VF, ST M25P, and Winbond W25X. Other chips - are supported as well. See the driver source for the current list, - or to add other chips. - - Note that the original DataFlash chips (AT45 series, not AT26DF), - need an entirely different driver. - - Set up your spi devices with the right board-specific platform data, - if you want to specify device partitioning or to use a device which - doesn't support the JEDEC ID instruction. - config MTD_MCHP23K256 tristate "Microchip 23K256 SRAM" depends on SPI_MASTER
drivers/mtd/devices/Makefile +0 -1
@@ -12,7 +12,6 @@ obj-$(CONFIG_MTD_MTDRAM) += mtdram.o obj-$(CONFIG_MTD_LART) += lart.o obj-$(CONFIG_MTD_BLOCK2MTD) += block2mtd.o obj-$(CONFIG_MTD_DATAFLASH) += mtd_dataflash.o -obj-$(CONFIG_MTD_M25P80) += m25p80.o obj-$(CONFIG_MTD_MCHP23K256) += mchp23k256.o obj-$(CONFIG_MTD_SPEAR_SMI) += spear_smi.o obj-$(CONFIG_MTD_SST25L) += sst25l.o
drivers/mtd/devices/m25p80.c deleted +0 -347
347 lines not on this page · raw message
drivers/mtd/spi-nor/Kconfig +2 -0
@@ -2,6 +2,8 @@ menuconfig MTD_SPI_NOR 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.
drivers/mtd/spi-nor/spi-nor.c +599 -33
855 lines not on this page · raw message
include/linux/mtd/spi-nor.h +3 -0
@@ -9,6 +9,7 @@#include <linux/bitops.h> #include <linux/mtd/cfi.h> #include <linux/mtd/mtd.h> +#include <linux/spi/spi-mem.h> /* * Manufacturer IDs
@@ -344,6 +345,7 @@ struct flash_info;* @mtd: point to a 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. +* @spimem: point to the spi mem device * @bouncebuf: bounce buffer used when the buffer passed by the MTD * layer is not DMA-able * @bouncebuf_size: size of the bounce buffer
@@ -384,6 +386,7 @@ struct spi_nor {struct mtd_info mtd;struct mutex lock;struct device *dev; +struct spi_mem *spimem;u8 *bouncebuf;size_t bouncebuf_size;const struct flash_info *info;
Signature · 1 line
2.22.0
Re: [PATCH v3 2/3] mtd: spi-nor: Move m25p80 code in spi-nor.c
Quoted 37 lines · On Thu, 1 Aug 2019 10:00:51 +0530 Vignesh Raghavendra <[email protected]> wrote:
From: Boris Brezillon <[email protected]>
The m25p80 driver is actually a generic wrapper around the spi-mem layer. Not only the driver name is misleading, but we'd expect such a common logic to be directly available in the core. Another reason for moving this code is that SPI NOR controller drivers should progressively be replaced by SPI controller drivers implementing the
spi_mem_opsinterface, and when the conversion is done, we should have a single spi-nor driver directly interfacing with the spi-mem layer.While moving the code we also fix a longstanding issue when non-DMA-able buffers are passed by the MTD layer.
Signed-off-by Boris Brezillon <[email protected]>Signed-off-by Vignesh Raghavendra <[email protected]>---
v3:
Simplify register read/write by droppingspi_nor_exec_op()and usingspi_mem_exec_op()directly
Modifyspi_nor_spimem_xfer_data()to drop "enumspi_nor_protocolproto" Fix misc coding style comments by Tudorv2:
Add docs for new functions added
Addspi_nor_prefix to new functions
Incorporate Andrey's patches https://lkml.org/lkml/2019/4/1/32
to avoid looping spi_nor_spimem_* APIsdrivers/mtd/devices/Kconfig | 18 - drivers/mtd/devices/Makefile | 1 - drivers/mtd/devices/m25p80.c | 347 ------------------- drivers/mtd/spi-nor/Kconfig | 2 + drivers/mtd/spi-nor/spi-nor.c | 632 ++++++++++++++++++++++++++++++++-- include/linux/mtd/spi-nor.h | 3 + 6 files changed, 604 insertions(+), 399 deletions(-) delete mode 100644 drivers/mtd/devices/m25p80.c
[...]
Quoted 5 lines
drivers/mtd/spi-nor/spi-nor.c +1
-0@@ -348,6 +530,16 @@ static int read_cr(struct spi_nor *nor)*/ static int write_sr (struct spi_nor *nor,u8 val) { +if (nor->spimem) {
drivers/mtd/spi-nor/spi-nor.c static int read_cr(struct spi_nor *nor) · line 543
Quoted 10 lines
drivers/mtd/spi-nor/spi-nor.c +9
-0+struct spi_mem_op op = +SPI_MEM_OP (SPI_MEM_OP_CMD (SPINOR_OP_WRSR ,1 ), +SPI_MEM_OP_NO_ADDR , +SPI_MEM_OP_NO_DUMMY , +SPI_MEM_OP_DATA_IN (1 , nor->bouncebuf,1 )); + +return spi_mem_exec_op (nor->spimem, &op); + } + nor->bouncebuf[0 ] = val;
The above line should be moved at the beginning of the function if you want the spimem path to work correctly.
Quoted 2 lines
drivers/mtd/spi-nor/spi-nor.c +0
-0return nor->write_reg (nor,SPINOR_OP_WRSR , nor->bouncebuf,1 ); }
Vignesh Raghavendra
maintainerRe: [PATCH v3 2/3] mtd: spi-nor: Move m25p80 code in spi-nor.c
Quoted 54 lines · Boris Brezillon
Quoted 37 lines · On Thu, 1 Aug 2019 10:00:51 +0530 Vignesh Raghavendra <[email protected]> wrote:
From: Boris Brezillon <[email protected]>
The m25p80 driver is actually a generic wrapper around the spi-mem layer. Not only the driver name is misleading, but we'd expect such a common logic to be directly available in the core. Another reason for moving this code is that SPI NOR controller drivers should progressively be replaced by SPI controller drivers implementing the
spi_mem_opsinterface, and when the conversion is done, we should have a single spi-nor driver directly interfacing with the spi-mem layer.While moving the code we also fix a longstanding issue when non-DMA-able buffers are passed by the MTD layer.
Signed-off-by Boris Brezillon <[email protected]>Signed-off-by Vignesh Raghavendra <[email protected]>---
v3:
Simplify register read/write by droppingspi_nor_exec_op()and usingspi_mem_exec_op()directly
Modifyspi_nor_spimem_xfer_data()to drop "enumspi_nor_protocolproto" Fix misc coding style comments by Tudorv2:
Add docs for new functions added
Addspi_nor_prefix to new functions
Incorporate Andrey's patches https://lkml.org/lkml/2019/4/1/32
to avoid looping spi_nor_spimem_* APIsdrivers/mtd/devices/Kconfig | 18 - drivers/mtd/devices/Makefile | 1 - drivers/mtd/devices/m25p80.c | 347 ------------------- drivers/mtd/spi-nor/Kconfig | 2 + drivers/mtd/spi-nor/spi-nor.c | 632 ++++++++++++++++++++++++++++++++-- include/linux/mtd/spi-nor.h | 3 + 6 files changed, 604 insertions(+), 399 deletions(-) delete mode 100644 drivers/mtd/devices/m25p80.c[...]
Quoted 10 lines
drivers/mtd/spi-nor/spi-nor.c +6
-0@@ -348,6 +530,16 @@ static int read_cr(struct spi_nor *nor)*/ static int write_sr (struct spi_nor *nor,u8 val) { +if (nor->spimem) { +struct spi_mem_op op = +SPI_MEM_OP (SPI_MEM_OP_CMD (SPINOR_OP_WRSR ,1 ), +SPI_MEM_OP_NO_ADDR , +SPI_MEM_OP_NO_DUMMY , +SPI_MEM_OP_DATA_IN (1 , nor->bouncebuf,1 ));
Quoted 8 lines
drivers/mtd/spi-nor/spi-nor.c static int read_cr(struct spi_nor *nor) · line 543
Quoted 5 lines
drivers/mtd/spi-nor/spi-nor.c +4
-0+ +return spi_mem_exec_op (nor->spimem, &op); + } + nor->bouncebuf[0 ] = val;The above line should be moved at the beginning of the function if you want the spimem path to work correctly.
Good catch! will send v4 with this fixed
Signature · 6 lines
Regards Vignesh ______________________________________________________ Linux MTD discussion mailing list http://lists.infradead.org/mailman/listinfo/linux-mtd/
Vignesh Raghavendra
maintainerPATCH v3 3/3 mtd: spi-nor: Rework hwcaps selection for the spi-mem case
In reply to Vignesh RaghavendraFrom: Boris Brezillon <[email protected]>
The spi-mem layer provides a spi_mem_supports_op() function to check whether a specific operation is supported by the controller or not. This is much more accurate than the hwcaps selection logic based on SPI_{RX,TX}_ flags.
Rework the hwcaps selection logic to use spi_mem_supports_op() when nor->spimem != NULL.
--- drivers/mtd/spi-nor/spi-nor.c | 183 +++++++++++++++++++++++++++------- include/linux/mtd/spi-nor.h | 14 +++ 2 files changed, 161 insertions(+), 36 deletions(-)
drivers/mtd/spi-nor/spi-nor.c +147 -36
@@ -2952,6 +2952,129 @@ static int spi_nor_read_sfdp(struct spi_nor *nor, u32 addr,return ret; } +/** +* spi_nor_spimem_check_op - check if the operation is supported +* by controller +*@nor: pointer to a 'struct spi_nor' +*@op: pointer to op template to be checked +* +* Returns 0 if operation is supported, -ENOTSUPP otherwise. +*/ +static int spi_nor_spimem_check_op (struct spi_nor *nor, +struct spi_mem_op *op) +{ +/* +* First test with 4 address bytes. The opcode itself might +* be a 3B addressing opcode but we don't care, because +* SPI controller implementation should not check the opcode, +* but just the sequence. +*/ + op->addr.nbytes =4 ; +if (!spi_mem_supports_op (nor->spimem, op)) { +/* If flash size <16MB, 3 address bytes are sufficient */ +if (nor->mtd.size <=SZ_16M ) { + op->addr.nbytes =3 ; +if (!spi_mem_supports_op (nor->spimem, op)) +return -ENOTSUPP ; + } + } + +return 0 ; +} + +/** +* spi_nor_spimem_check_readop - check if the read op is supported +* by controller +*@nor: pointer to a 'struct spi_nor' +*@read: pointer to op template to be checked +* +* Returns 0 if operation is supported, -ENOTSUPP otherwise. +*/ +static int spi_nor_spimem_check_readop (struct spi_nor *nor, +const struct spi_nor_read_command *read) +{ +struct spi_mem_op op =SPI_MEM_OP (SPI_MEM_OP_CMD (read->opcode,1 ), +SPI_MEM_OP_ADDR (3 ,0 ,1 ), +SPI_MEM_OP_DUMMY (0 ,1 ), +SPI_MEM_OP_DATA_IN (0 ,NULL ,1 )); + + op.cmd.buswidth =spi_nor_get_protocol_inst_nbits (read->proto); + op.addr.buswidth =spi_nor_get_protocol_addr_nbits (read->proto); + op.data.buswidth =spi_nor_get_protocol_data_nbits (read->proto); + op.dummy.buswidth = op.addr.buswidth; + op.dummy.nbytes = (read->num_mode_clocks + read->num_wait_states) * + op.dummy.buswidth /8 ; + +return spi_nor_spimem_check_op (nor, &op); +} + +/** +* spi_nor_spimem_check_pp - check if the page program op is supported +* by controller +*@nor: pointer to a 'struct spi_nor' +*@pp: pointer to op template to be checked +* +* Returns 0 if operation is supported, -ENOTSUPP otherwise. +*/ +static int spi_nor_spimem_check_pp (struct spi_nor *nor, +const struct spi_nor_pp_command *pp) +{ +struct spi_mem_op op =SPI_MEM_OP (SPI_MEM_OP_CMD (pp->opcode,1 ), +SPI_MEM_OP_ADDR (3 ,0 ,1 ), +SPI_MEM_OP_NO_DUMMY , +SPI_MEM_OP_DATA_OUT (0 ,NULL ,1 )); + + op.cmd.buswidth =spi_nor_get_protocol_inst_nbits (pp->proto); + op.addr.buswidth =spi_nor_get_protocol_addr_nbits (pp->proto); + op.data.buswidth =spi_nor_get_protocol_data_nbits (pp->proto); + +return spi_nor_spimem_check_op (nor, &op); +} + +/** +* spi_nor_spimem_adjust_hwcaps - Find optimal Read/Write protocol +* based on SPI controller capabilities +* @nor: pointer to a 'struct spi_nor' +* @params: pointer to the 'struct spi_nor_flash_parameter' +* representing SPI NOR flash capabilities +* @hwcaps: pointer to resulting capabilities after adjusting +* according to controller and flash's capability +*/ +static void +spi_nor_spimem_adjust_hwcaps (struct spi_nor *nor, +const struct spi_nor_flash_parameter *params, +u32 *hwcaps) +{ +unsigned int cap; + +/* DTR modes are not supported yet, mask them all. */ + *hwcaps &= ~SNOR_HWCAPS_DTR ; + +/* X-X-X modes are not supported yet, mask them all. */ + *hwcaps &= ~SNOR_HWCAPS_X_X_X ; + +/* Start with read commands. */ +for (cap =0 ; cap <sizeof (*hwcaps) *BITS_PER_BYTE ; cap++) { +int rdidx, ppidx; + +if (!(*hwcaps &BIT (cap))) +continue ; + + rdidx =spi_nor_hwcaps_read2cmd (BIT (cap)); +if (rdidx >=0 && +spi_nor_spimem_check_readop (nor, ¶ms->reads[rdidx])) + *hwcaps &= ~BIT (cap); + + ppidx =spi_nor_hwcaps_pp2cmd (BIT (cap)); +if (ppidx <0 ) +continue ; + +if (spi_nor_spimem_check_pp (nor, + ¶ms->page_programs[ppidx])) + *hwcaps &= ~BIT (cap); + } +} +/** * spi_nor_read_sfdp_dma_unsafe() - read Serial Flash Discoverable Parameters. * @nor: pointer to a 'struct spi_nor'
@@ -4361,16 +4484,25 @@ static int spi_nor_setup(struct spi_nor *nor,*/ shared_mask = hwcaps->mask & params->hwcaps.mask; -/* SPI n-n-n protocols are not supported yet. */ - ignored_mask = (SNOR_HWCAPS_READ_2_2_2 | -SNOR_HWCAPS_READ_4_4_4 | -SNOR_HWCAPS_READ_8_8_8 | -SNOR_HWCAPS_PP_4_4_4 | -SNOR_HWCAPS_PP_8_8_8 ); -if (shared_mask & ignored_mask) { -dev_dbg (nor->dev, -"SPI n-n-n protocols are not supported yet.\n" ); - shared_mask &= ~ignored_mask; +if (nor->spimem) { +/* +* When called from spi_nor_probe(), all caps are set and we +* need to discard some of them based on what the SPI +* controller actually supports (using spi_mem_supports_op()). +*/ +spi_nor_spimem_adjust_hwcaps (nor, params, &shared_mask); + }else { +/* +* SPI n-n-n protocols are not supported when the SPI +* controller directly implements the spi_nor interface. +* Yet another reason to switch to spi-mem. +*/ + ignored_mask =SNOR_HWCAPS_X_X_X ; +if (shared_mask & ignored_mask) { +dev_dbg (nor->dev, +"SPI n-n-n protocols are not supported.\n" ); + shared_mask &= ~ignored_mask; + } }/* Select the (Fast) Read command. */
@@ -4709,11 +4841,11 @@ static int spi_nor_probe(struct spi_mem *spimem)struct spi_device *spi = spimem->spi;struct flash_platform_data *data =dev_get_platdata (&spi->dev);struct spi_nor *nor; -struct spi_nor_hwcaps hwcaps = { - .mask =SNOR_HWCAPS_READ | -SNOR_HWCAPS_READ_FAST | -SNOR_HWCAPS_PP , - }; +/* +* Enable all caps by default. The core will mask them after +* checking what's really supported using spi_mem_supports_op(). +*/ +const struct spi_nor_hwcaps hwcaps = { .mask =SNOR_HWCAPS_ALL };char *flash_name;int ret;
@@ -4727,27 +4859,6 @@ static int spi_nor_probe(struct spi_mem *spimem)spi_mem_set_drvdata (spimem, nor); -if (spi->mode &SPI_RX_OCTAL ) { - hwcaps.mask |=SNOR_HWCAPS_READ_1_1_8 ; - -if (spi->mode &SPI_TX_OCTAL ) - hwcaps.mask |= (SNOR_HWCAPS_READ_1_8_8 | -SNOR_HWCAPS_PP_1_1_8 | -SNOR_HWCAPS_PP_1_8_8 ); - }else if (spi->mode &SPI_RX_QUAD ) { - hwcaps.mask |=SNOR_HWCAPS_READ_1_1_4 ; - -if (spi->mode &SPI_TX_QUAD ) - hwcaps.mask |= (SNOR_HWCAPS_READ_1_4_4 | -SNOR_HWCAPS_PP_1_1_4 | -SNOR_HWCAPS_PP_1_4_4 ); - }else if (spi->mode &SPI_RX_DUAL ) { - hwcaps.mask |=SNOR_HWCAPS_READ_1_1_2 ; - -if (spi->mode &SPI_TX_DUAL ) - hwcaps.mask |=SNOR_HWCAPS_READ_1_2_2 ; - } -if (data && data->name) nor->mtd.name = data->name;
include/linux/mtd/spi-nor.h +14 -0
@@ -524,6 +524,20 @@ struct spi_nor_hwcaps {#define SNOR_HWCAPS_PP_1_8_8 BIT(21)#define SNOR_HWCAPS_PP_8_8_8 BIT(22) +#define SNOR_HWCAPS_X_X_X (SNOR_HWCAPS_READ_2_2_2 | \ + SNOR_HWCAPS_READ_4_4_4 | \ + SNOR_HWCAPS_READ_8_8_8 | \ + SNOR_HWCAPS_PP_4_4_4 | \ + SNOR_HWCAPS_PP_8_8_8) + +#define SNOR_HWCAPS_DTR (SNOR_HWCAPS_READ_1_1_1_DTR | \ + SNOR_HWCAPS_READ_1_2_2_DTR | \ + SNOR_HWCAPS_READ_1_4_4_DTR | \ + SNOR_HWCAPS_READ_1_8_8_DTR) + +#define SNOR_HWCAPS_ALL (SNOR_HWCAPS_READ_MASK | \ + SNOR_HWCAPS_PP_MASK) +/** * spi_nor_scan() - scan the SPI NOR * @nor: the spi_nor structure
Signature · 1 line
2.22.0