mtd: spi-nor-core: add xSPI Octal DTR support
Subsystems (3)
v4 cover mtd: spi-nor-core: add xSPI Octal DTR support
Hi,
This series adds support for octal DTR flashes in the spi-nor framework, and then adds hooks for the Cypress Semper flash which is an xSPI compliant Octal DTR flash.
The Cadence QSPI controller driver is also updated to run in Octal DTR mode.
Tested on TI J721e EVM.
Changes in v4:
- Fix BFPT parsing stopping too early for JESD216 rev B flashes.
- Instead of just checking for spi_nor_get_protocol_width() in spi_nor_octal_dtr_enable(), make sure the protocol is SNOR_PROTO_8_8_8_DTR since get_protocol_width() only cares about data width.
- Do not enable stateful X-X-X modes if the reset line is broken.
- Instead of setting SNOR_READ_HWCAPS_8_8_8_DTR from Profile 1.0 table parsing, do it in spi_nor_info_init_params() instead based on the SPI_NOR_OCTAL_DTR_READ flag instead.
- Set SNOR_HWCAPS_PP_8_8_8_DTR in s28hs post_sfdp hook since this capability is no longer set in Profile 1.0 parsing.
- Rename spi_nor_cypress_octal_enable() to
spi_nor_cypress_octal_dtr_enable().
- Instead of hard-coding 8D-8D-8D Fast Read dummy cycles to 20, find them out from the Profile 1.0 table.
- Call post-bfpt fixup when exiting early because of JESD rev A.
- Do not make an invalid Quad Enable BFPT field a fatal error. Silently ignore it by assuming no quad enable bit is present.
- Set cmd.nbytes to 1 when using SPI_MEM_OP_CMD().
- Reject ops with more than 1 command byte in
spi_mem_default_supports_op().
- Drop flag SPI_NOR_SOFT_RESET. Instead, discover soft reset capability via BFPT.
- Add missing headers that were removed from common header.
Changes in v3:
- Read 2 bytes in Octal DTR mode when reading SR and FSR to avoid tripping up controllers.
- Use op->data.nbytes as a measure of whether the data phase exists or not. This fixes data buswidth not being updadted for SR and FSR reads because they keep data buffer as NULL when calling spi_nor_setup_op().
- Add support for Micron mt35xu512aba to run in Octal DTR mode.
Pratyush Yadav (20):
spi: spi-mem: allow specifying whether an op is DTR or not
spi: spi-mem: allow specifying a command's extension
spi: cadence-qspi: Do not calibrate when device tree sets read delay
spi: cadence-qspi: Add support for octal DTR flashes
mtd: spi-nor-core: Add a ->setup() hook
mtd: spi-nor-core: Move SFDP related declarations to top
mtd: spi-nor-core: Introduce flash-specific fixup hooks
mtd: spi-nor-core: Rework hwcaps selection
mtd: spi-nor-core: Add support for DTR protocol
mtd: spi-nor-core: prepare BFPT parsing for JESD216 rev D
mtd: spi-nor-core: Get command opcode extension type from BFPT
mtd: spi-nor-core: Parse xSPI Profile 1.0 table
mtd: spi-nor-core: Prepare Read SR and FSR for Octal DTR mode
mtd: spi-nor-core: Enable octal DTR mode when possible
mtd: spi-nor-core: Do not make invalid quad enable fatal
mtd: spi-nor-core: Detect Soft Reset sequence support from BFPT
mtd: spi-nor-core: Perform a Soft Reset on shutdown
mtd: spi-nor-core: Perform a Soft Reset on boot
mtd: spi-nor-core: Add support for Cypress Semper flash
mtd: spi-nor-core: Allow using Micron mt35xu512aba in Octal DTR mode
drivers/mtd/spi/Kconfig | 11 + drivers/mtd/spi/sf_internal.h | 12 + drivers/mtd/spi/sf_probe.c | 9 + drivers/mtd/spi/spi-nor-core.c | 1253 ++++++++++++++++++++++++++------ drivers/mtd/spi/spi-nor-ids.c | 4 +- drivers/mtd/spi/spi-nor-tiny.c | 22 - drivers/spi/cadence_qspi.c | 87 ++- drivers/spi/cadence_qspi.h | 15 +- drivers/spi/cadence_qspi_apb.c | 286 +++++++- drivers/spi/spi-mem.c | 6 + include/linux/mtd/spi-nor.h | 275 +++++-- include/spi-mem.h | 17 +- 12 files changed, 1639 insertions(+), 358 deletions(-)
--
2.26.2
PATCH v4 1/20 spi: spi-mem: allow specifying whether an op is DTR or not
Each phase is given a separate 'dtr' field so mixed protocols like 4S-4D-4D can be supported.
--- drivers/spi/spi-mem.c | 3 +++ include/spi-mem.h | 8 ++++++++ 2 files changed, 11 insertions(+)
drivers/spi/spi-mem.c +3 -0
@@ -159,6 +159,9 @@ bool spi_mem_default_supports_op(struct spi_slave *slave, op->data.dir == SPI_MEM_DATA_OUT))return false; +if (op->cmd.dtr || op->addr.dtr || op->dummy.dtr || op->data.dtr) +return false; +return true; }EXPORT_SYMBOL_GPL (spi_mem_default_supports_op);
include/spi-mem.h +8 -0
@@ -74,6 +74,7 @@ enum spi_mem_data_dir {* struct spi_mem_op - describes a SPI memory operation * @cmd.buswidth: number of IO lines used to transmit the command * @cmd.opcode: operation opcode +* @cmd.dtr: whether the command opcode should be sent in DTR mode or not * @addr.nbytes: number of address bytes to send. Can be zero if the operation * does not need to send an address * @addr.buswidth: number of IO lines used to transmit the address cycles
@@ -81,10 +82,13 @@ enum spi_mem_data_dir {* Note that only @addr.nbytes are taken into account in this * address value, so users should make sure the value fits in the * assigned number of bytes. +* @addr.dtr: whether the address should be sent in DTR mode or not * @dummy.nbytes: number of dummy bytes to send after an opcode or address. Can * be zero if the operation does not require dummy bytes * @dummy.buswidth: number of IO lanes used to transmit the dummy bytes +* @dummy.dtr: whether the dummy bytes should be sent in DTR mode or not * @data.buswidth: number of IO lanes used to send/receive the data +* @data.dtr: whether the data should be sent in DTR mode or not * @data.dir: direction of the transfer * @data.buf.in: input buffer * @data.buf.out: output buffer
@@ -93,21 +97,25 @@ struct spi_mem_op {struct {u8 buswidth;u8 opcode; +u8 dtr :1 ; } cmd;struct {u8 nbytes;u8 buswidth; +u8 dtr :1 ;u64 val; } addr;struct {u8 nbytes;u8 buswidth; +u8 dtr :1 ; } dummy;struct {u8 buswidth; +u8 dtr :1 ;enum spi_mem_data_dir dir;unsigned int nbytes;/* buf.{in,out} must be DMA-able. */
Signature · 1 line
2.26.2
PATCH v4 2/20 spi: spi-mem: allow specifying a command's extension
In reply to Pratyush YadavIn xSPI mode, flashes expect 2-byte opcodes. The second byte is called the "command extension". There can be 3 types of extensions in xSPI:
repeat, invert, and hex. When the extension type is "repeat", the same opcode is sent twice. When it is "invert", the second byte is the inverse of the opcode. When it is "hex" an additional opcode byte based is sent with the command whose value can be anything.
So, make opcode a 16-bit value and add a 'nbytes', similar to how multiple address widths are handled.
--- drivers/spi/spi-mem.c | 3 +++ include/spi-mem.h | 6 +++++- 2 files changed, 8 insertions(+), 1 deletion(-)
drivers/spi/spi-mem.c +3 -0
@@ -162,6 +162,9 @@ bool spi_mem_default_supports_op(struct spi_slave *slave,if (op->cmd.dtr || op->addr.dtr || op->dummy.dtr || op->data.dtr)return false; +if (op->cmd.nbytes !=1 ) +return false; +return true; }EXPORT_SYMBOL_GPL (spi_mem_default_supports_op);
include/spi-mem.h +5 -1
@@ -20,6 +20,7 @@ { \ .buswidth = __buswidth, \ .opcode = __opcode, \ + .nbytes = 1, \ }#define SPI_MEM_OP_ADDR (__nbytes, __val, __buswidth) \
@@ -72,6 +73,8 @@ enum spi_mem_data_dir {/** * struct spi_mem_op - describes a SPI memory operation +* @cmd.nbytes: number of opcode bytes (only 1 or 2 are valid). The opcode is +* sent MSB-first. * @cmd.buswidth: number of IO lines used to transmit the command * @cmd.opcode: operation opcode * @cmd.dtr: whether the command opcode should be sent in DTR mode or not
@@ -95,9 +98,10 @@ enum spi_mem_data_dir {*/ struct spi_mem_op {struct { +u8 nbytes;u8 buswidth; -u8 opcode;u8 dtr :1 ; +u16 opcode; } cmd;struct {
Signature · 1 line
2.26.2
PATCH v4 3/20 spi: cadence-qspi: Do not calibrate when device tree sets read delay
In reply to Pratyush YadavIf the device tree provides a read delay value, use that directly and do not perform the calibration procedure.
This allows the device tree to over-ride the read delay value in cases where the read delay value obtained via calibration is incorrect. One such example is the Cypress Semper flash. It needs a read delay of 4 in octal DTR mode. But since the calibration procedure is run before the flash is switched in octal DTR mode, it yields a read delay of 2. A value of 4 works for both octal DTR and legacy modes.
--- drivers/spi/cadence_qspi.c | 26 +++++++++++++++++++++----- drivers/spi/cadence_qspi.h | 1 + 2 files changed, 22 insertions(+), 5 deletions(-)
drivers/spi/cadence_qspi.c +21 -5
@@ -141,12 +141,20 @@ static int cadence_spi_set_speed(struct udevice *bus, uint hz)cadence_qspi_apb_controller_disable (priv->regbase);/* -* Calibration required for different current SCLK speed, requested -* SCLK speed or chip select +* If the device tree already provides a read delay value, use that +* instead of calibrating. */ -if (priv->previous_hz != hz || - priv->qspi_calibrated_hz != hz || - priv->qspi_calibrated_cs !=spi_chip_select (bus)) { +if (plat->read_delay >=0 ) { +cadence_spi_write_speed (bus, hz); +cadence_qspi_apb_readdata_capture (priv->regbase,1 , + plat->read_delay); + }else if (priv->previous_hz != hz || + priv->qspi_calibrated_hz != hz || + priv->qspi_calibrated_cs !=spi_chip_select (bus)) { +/* +* Calibration required for different current SCLK speed, +* requested SCLK speed or chip select +*/ err =spi_calibration (bus, hz);if (err)return err;
@@ -320,6 +328,14 @@ static int cadence_spi_ofdata_to_platdata(struct udevice *bus) 255); plat->tchsh_ns =ofnode_read_u32_default (subnode,"cdns,tchsh-ns" ,20 ); plat->tslch_ns =ofnode_read_u32_default (subnode,"cdns,tslch-ns" ,20 ); +/* +* Read delay should be an unsigned value but we use a signed integer +* so that negative values can indicate that the device tree did not +* specify any signed values and we need to perform the calibration +* sequence to find it out. +*/ + plat->read_delay =ofnode_read_s32_default (subnode,"cdns,read-delay" , +-1 ); debug("%s: regbase=%p ahbbase=%p max-frequency=%d page-size=%d\n", __func__, plat->regbase, plat->ahbbase, plat->max_hz,
drivers/spi/cadence_qspi.h +1 -0
@@ -26,6 +26,7 @@ struct cadence_spi_platdata {u32 trigger_address;fdt_addr_t ahbsize;bool use_dac_mode; +int read_delay;/* Flash parameters */ u32 page_size;
Signature · 1 line
2.26.2
PATCH v4 4/20 spi: cadence-qspi: Add support for octal DTR flashes
In reply to Pratyush YadavSet up opcode extension and enable/disable DTR mode based on whether the command is DTR or not.
xSPI flashes can have a 4-byte dummy address associated with some commands like the Read Status Register command in octal DTR mode. Since the flash does not support sending the dummy address, we can not use automatic write completion polling in DTR mode. Further, no write completion polling makes it impossible to use DAC mode for DTR writes. In that mode, the controller does not know beforehand how long a write will be and so it can de-assert Chip Select (CS#) at any time. Once CS# is de-assert, the flash will go into burning phase. But since the controller does not do write completion polling, it does not know when the flash is busy and might send in writes while the flash is not ready.
So, disable write completion polling and make writes go through indirect mode for DTR writes and let spi-mem take care of polling the SR.
--- drivers/spi/cadence_qspi.c | 61 ++++++- drivers/spi/cadence_qspi.h | 14 +- drivers/spi/cadence_qspi_apb.c | 286 ++++++++++++++++++++++++++++++--- include/spi-mem.h | 3 + 4 files changed, 338 insertions(+), 26 deletions(-)
drivers/spi/cadence_qspi.c +55 -6
@@ -41,20 +41,22 @@ static int cadence_spi_write_speed(struct udevice *bus, uint hz)return 0 ; } -static int cadence_spi_read_id (void *reg_base,u8 len,u8 *idcode) +static int cadence_spi_read_id (struct cadence_spi_platdata *plat,u8 len, +u8 *idcode) {struct spi_mem_op op =SPI_MEM_OP (SPI_MEM_OP_CMD (0x9F ,1 ),SPI_MEM_OP_NO_ADDR ,SPI_MEM_OP_NO_DUMMY ,SPI_MEM_OP_DATA_IN (len, idcode,1 )); -return cadence_qspi_apb_command_read (reg_base, &op); +return cadence_qspi_apb_command_read (plat, &op); }/* Calibration sequence to determine the read data capture delay register */ static int spi_calibration (struct udevice *bus,uint hz) {struct cadence_spi_priv *priv =dev_get_priv (bus); +struct cadence_spi_platdata *plat = bus->platdata;void *base = priv->regbase;unsigned int idcode =0 , temp =0 ;int err =0 , i, range_lo =-1 , range_hi =-1 ;
@@ -69,7 +71,7 @@ static int spi_calibration(struct udevice *bus, uint hz)cadence_qspi_apb_controller_enable (base);/* read the ID which will be our golden value */ - err =cadence_spi_read_id (base,3 , (u8 *)&idcode); + err =cadence_spi_read_id (plat,3 , (u8 *)&idcode);if (err) {puts ("SF: Calibration failed (read)\n" );return err;
@@ -88,7 +90,7 @@ static int spi_calibration(struct udevice *bus, uint hz)cadence_qspi_apb_controller_enable (base);/* issue a RDID to get the ID value */ - err =cadence_spi_read_id (base,3 , (u8 *)&temp); + err =cadence_spi_read_id (plat,3 , (u8 *)&temp);if (err) {puts ("SF: Calibration failed (read)\n" );return err;
@@ -267,10 +269,14 @@ static int cadence_spi_mem_exec_op(struct spi_slave *spi,switch (mode) {case CQSPI_STIG_READ : - err =cadence_qspi_apb_command_read (base, op); + err =cadence_qspi_apb_command_read_setup (plat, op); +if (!err) + err =cadence_qspi_apb_command_read (plat, op);break ;case CQSPI_STIG_WRITE : - err =cadence_qspi_apb_command_write (base, op); + err =cadence_qspi_apb_command_write_setup (plat, op); +if (!err) + err =cadence_qspi_apb_command_write (plat, op);break ;case CQSPI_READ : err =cadence_qspi_apb_read_setup (plat, op);
@@ -290,6 +296,48 @@ static int cadence_spi_mem_exec_op(struct spi_slave *spi,return err; } +static bool cadence_spi_mem_supports_op (struct spi_slave *slave, +const struct spi_mem_op *op) +{ +bool all_true, all_false; +u8 buswidths[4 ]; +int i; + + all_true = op->cmd.dtr && op->addr.dtr && op->dummy.dtr && + op->data.dtr; + all_false = !op->cmd.dtr && !op->addr.dtr && !op->dummy.dtr && + !op->data.dtr; + +/* Mixed DTR modes not supported. */ +if (!(all_true || all_false)) +return false; + +/* +* Only buswidths of 1, 2, 4, and 8 are supported. 0 is allowed in case +* that phase does not exist. +*/ + buswidths[0 ] = op->cmd.buswidth; + buswidths[1 ] = op->addr.buswidth; + buswidths[2 ] = op->dummy.buswidth; + buswidths[3 ] = op->data.buswidth; +for (i =0 ; i <ARRAY_SIZE (buswidths); i++) { +if (!(buswidths[i] ==0 || buswidths[i] ==1 || + buswidths[i] ==2 || buswidths[i] ==4 || + buswidths[i] ==8 )) +return false; + } + +/* +* The exception to the above is the command phase. A non-existent +* command phase means that it is an XIP command, which we do not +* support. +*/ +if (op->cmd.buswidth ==0 ) +return false; + +return true; +} +static int cadence_spi_ofdata_to_platdata (struct udevice *bus) {struct cadence_spi_platdata *plat = bus->platdata;
@@ -346,6 +394,7 @@ static int cadence_spi_ofdata_to_platdata(struct udevice *bus)static const struct spi_controller_mem_ops cadence_spi_mem_ops = { .exec_op = cadence_spi_mem_exec_op, + .supports_op = cadence_spi_mem_supports_op, };static const struct dm_spi_ops cadence_spi_ops = {
drivers/spi/cadence_qspi.h +12 -2
@@ -35,6 +35,12 @@ struct cadence_spi_platdata {u32 tsd2d_ns;u32 tchsh_ns;u32 tslch_ns; + +/* Transaction protocol parameters. */ +u8 inst_width; +u8 addr_width; +u8 data_width; +bool dtr; };struct cadence_spi_priv {
@@ -58,9 +64,13 @@ void cadence_qspi_apb_controller_enable(void *reg_base_addr);void cadence_qspi_apb_controller_disable (void *reg_base_addr);void cadence_qspi_apb_dac_mode_enable (void *reg_base); -int cadence_qspi_apb_command_read (void *reg_base_addr, +int cadence_qspi_apb_command_read_setup (struct cadence_spi_platdata *plat, +const struct spi_mem_op *op); +int cadence_qspi_apb_command_read (struct cadence_spi_platdata *plat,const struct spi_mem_op *op); -int cadence_qspi_apb_command_write (void *reg_base_addr, +int cadence_qspi_apb_command_write_setup (struct cadence_spi_platdata *plat, +const struct spi_mem_op *op); +int cadence_qspi_apb_command_write (struct cadence_spi_platdata *plat,const struct spi_mem_op *op); int cadence_qspi_apb_read_setup(struct cadence_spi_platdata *plat,
drivers/spi/cadence_qspi_apb.c +268 -18
401 lines not on this page · raw message
include/spi-mem.h +3 -0
@@ -253,6 +253,9 @@ int spi_mem_adjust_op_size(struct spi_slave *slave, struct spi_mem_op *op);bool spi_mem_supports_op (struct spi_slave *slave,const struct spi_mem_op *op); +bool spi_mem_default_supports_op (struct spi_slave *slave, +const struct spi_mem_op *op); +int spi_mem_exec_op (struct spi_slave *slave,const struct spi_mem_op *op);#ifndef __UBOOT__
Signature · 1 line
2.26.2
PATCH v4 5/20 mtd: spi-nor-core: Add a ->setup() hook
In reply to Pratyush Yadavnor->setup() can be used by flashes to configure settings in case they have any peculiarities that can't be easily expressed by the generic spi-nor framework. This includes things like different opcodes, dummy cycles, page size, uniform/non-uniform sector sizes, etc.
Move related declarations to avoid forward declarations.
Inspired by the Linux kernel's setup() hook.
--- drivers/mtd/spi/spi-nor-core.c | 84 +++------------ drivers/mtd/spi/spi-nor-tiny.c | 22 ---- include/linux/mtd/spi-nor.h | 192 ++++++++++++++++++++++----------- 3 files changed, 147 insertions(+), 151 deletions(-)
drivers/mtd/spi/spi-nor-core.c +16 -68
@@ -1441,71 +1441,6 @@ static int spansion_no_read_cr_quad_enable(struct spi_nor *nor)#endif /* CONFIG_SPI_FLASH_SFDP_SUPPORT */ #endif /* CONFIG_SPI_FLASH_SPANSION */ -struct spi_nor_read_command { -u8 num_mode_clocks; -u8 num_wait_states; -u8 opcode; -enum spi_nor_protocol proto; -}; - -struct spi_nor_pp_command { -u8 opcode; -enum spi_nor_protocol proto; -}; - -enum spi_nor_read_command_index { -SNOR_CMD_READ , -SNOR_CMD_READ_FAST , -SNOR_CMD_READ_1_1_1_DTR , - -/* Dual SPI */ -SNOR_CMD_READ_1_1_2 , -SNOR_CMD_READ_1_2_2 , -SNOR_CMD_READ_2_2_2 , -SNOR_CMD_READ_1_2_2_DTR , - -/* Quad SPI */ -SNOR_CMD_READ_1_1_4 , -SNOR_CMD_READ_1_4_4 , -SNOR_CMD_READ_4_4_4 , -SNOR_CMD_READ_1_4_4_DTR , - -/* Octo SPI */ -SNOR_CMD_READ_1_1_8 , -SNOR_CMD_READ_1_8_8 , -SNOR_CMD_READ_8_8_8 , -SNOR_CMD_READ_1_8_8_DTR , - -SNOR_CMD_READ_MAX -}; - -enum spi_nor_pp_command_index { -SNOR_CMD_PP , - -/* Quad SPI */ -SNOR_CMD_PP_1_1_4 , -SNOR_CMD_PP_1_4_4 , -SNOR_CMD_PP_4_4_4 , - -/* Octo SPI */ -SNOR_CMD_PP_1_1_8 , -SNOR_CMD_PP_1_8_8 , -SNOR_CMD_PP_8_8_8 , - -SNOR_CMD_PP_MAX -}; - -struct spi_nor_flash_parameter { -u64 size; -u32 page_size; - -struct spi_nor_hwcaps hwcaps; -struct spi_nor_read_command reads[SNOR_CMD_READ_MAX ]; -struct spi_nor_pp_command page_programs[SNOR_CMD_PP_MAX ]; - -int (*quad_enable)(struct spi_nor *nor); -}; - static void spi_nor_set_read_settings(struct spi_nor_read_command *read, u8 num_mode_clocks,
@@ -2366,9 +2301,10 @@ static int spi_nor_select_erase(struct spi_nor *nor,return 0 ; } -static int spi_nor_setup (struct spi_nor *nor,const struct flash_info *info, -const struct spi_nor_flash_parameter *params, -const struct spi_nor_hwcaps *hwcaps) +static int spi_nor_default_setup (struct spi_nor *nor, +const struct flash_info *info, +const struct spi_nor_flash_parameter *params, +const struct spi_nor_hwcaps *hwcaps) {u32 ignored_mask, shared_mask;bool enable_quad_io;
@@ -2427,6 +2363,16 @@ static int spi_nor_setup(struct spi_nor *nor, const struct flash_info *info,return 0 ; } +static int spi_nor_setup (struct spi_nor *nor,const struct flash_info *info, +const struct spi_nor_flash_parameter *params, +const struct spi_nor_hwcaps *hwcaps) +{ +if (!nor->setup) +return 0 ; + +return nor->setup (nor, info, params, hwcaps); +} +static int spi_nor_init (struct spi_nor *nor) {int err;
@@ -2492,6 +2438,8 @@ int spi_nor_scan(struct spi_nor *nor) nor->read_reg = spi_nor_read_reg; nor->write_reg = spi_nor_write_reg; + nor->setup = spi_nor_default_setup; +if (spi->mode &SPI_RX_OCTAL ) { hwcaps.mask |=SNOR_HWCAPS_READ_1_1_8 ;
drivers/mtd/spi/spi-nor-tiny.c +0 -22
@@ -544,28 +544,6 @@ static int spansion_read_cr_quad_enable(struct spi_nor *nor) }#endif /* CONFIG_SPI_FLASH_SPANSION */ -struct spi_nor_read_command { -u8 num_mode_clocks; -u8 num_wait_states; -u8 opcode; -enum spi_nor_protocol proto; -}; - -enum spi_nor_read_command_index { -SNOR_CMD_READ , -SNOR_CMD_READ_FAST , - -/* Quad SPI */ -SNOR_CMD_READ_1_1_4 , - -SNOR_CMD_READ_MAX -}; - -struct spi_nor_flash_parameter { -struct spi_nor_hwcaps hwcaps; -struct spi_nor_read_command reads[SNOR_CMD_READ_MAX ]; -}; - static void spi_nor_set_read_settings(struct spi_nor_read_command *read, u8 num_mode_clocks,
include/linux/mtd/spi-nor.h +131 -61
210 lines not on this page · raw message
Signature · 1 line
2.26.2
PATCH v4 6/20 mtd: spi-nor-core: Move SFDP related declarations to top
In reply to Pratyush YadavThese structures will be used in a later commit inside another structure definition. Also take the declarations out of the ifdef since they won't affect the final binary anyway and will be used in a later commit.
--- drivers/mtd/spi/spi-nor-core.c | 224 ++++++++++++++++----------------- 1 file changed, 112 insertions(+), 112 deletions(-)
drivers/mtd/spi/spi-nor-core.c +112 -112
@@ -38,6 +38,118 @@#define DEFAULT_READY_WAIT_JIFFIES (40UL * HZ) +struct sfdp_parameter_header { +u8 id_lsb; +u8 minor; +u8 major; +u8 length;/* in double words */ +u8 parameter_table_pointer[3 ];/* byte address */ +u8 id_msb; +}; + +#define SFDP_PARAM_HEADER_ID (p) (((p)->id_msb << 8) | (p)->id_lsb) +#define SFDP_PARAM_HEADER_PTP (p) \ + (((p)->parameter_table_pointer[2] << 16) | \ + ((p)->parameter_table_pointer[1] << 8) | \ + ((p)->parameter_table_pointer[0] << 0)) + +#define SFDP_BFPT_ID 0xff00/* Basic Flash Parameter Table */ +#define SFDP_SECTOR_MAP_ID 0xff81/* Sector Map Table */ +#define SFDP_SST_ID 0x01bf/* Manufacturer specific Table */ + +#define SFDP_SIGNATURE 0x50444653U +#define SFDP_JESD216_MAJOR 1 +#define SFDP_JESD216_MINOR 0 +#define SFDP_JESD216A_MINOR 5 +#define SFDP_JESD216B_MINOR 6 + +struct sfdp_header { +u32 signature;/* Ox50444653U <=> "SFDP" */ +u8 minor; +u8 major; +u8 nph;/* 0-base number of parameter headers */ +u8 unused; + +/* Basic Flash Parameter Table. */ +struct sfdp_parameter_header bfpt_header; +}; + +/* Basic Flash Parameter Table */ + +/* +* JESD216 rev B defines a Basic Flash Parameter Table of 16 DWORDs. +* They are indexed from 1 but C arrays are indexed from 0. +*/ +#define BFPT_DWORD (i) ((i) - 1) +#define BFPT_DWORD_MAX 16 + +/* The first version of JESB216 defined only 9 DWORDs. */ +#define BFPT_DWORD_MAX_JESD216 9 + +/* 1st DWORD. */ +#define BFPT_DWORD1_FAST_READ_1_1_2 BIT(16) +#define BFPT_DWORD1_ADDRESS_BYTES_MASK GENMASK(18, 17) +#define BFPT_DWORD1_ADDRESS_BYTES_3_ONLY (0x0UL << 17) +#define BFPT_DWORD1_ADDRESS_BYTES_3_OR_4 (0x1UL << 17) +#define BFPT_DWORD1_ADDRESS_BYTES_4_ONLY (0x2UL << 17) +#define BFPT_DWORD1_DTR BIT(19) +#define BFPT_DWORD1_FAST_READ_1_2_2 BIT(20) +#define BFPT_DWORD1_FAST_READ_1_4_4 BIT(21) +#define BFPT_DWORD1_FAST_READ_1_1_4 BIT(22) + +/* 5th DWORD. */ +#define BFPT_DWORD5_FAST_READ_2_2_2 BIT(0) +#define BFPT_DWORD5_FAST_READ_4_4_4 BIT(4) + +/* 11th DWORD. */ +#define BFPT_DWORD11_PAGE_SIZE_SHIFT 4 +#define BFPT_DWORD11_PAGE_SIZE_MASK GENMASK(7, 4) + +/* 15th DWORD. */ + +/* +* (from JESD216 rev B) +* Quad Enable Requirements (QER): +* - 000b: Device does not have a QE bit. Device detects 1-1-4 and 1-4-4 +* reads based on instruction. DQ3/HOLD# functions are hold during +* instruction phase. +* - 001b: QE is bit 1 of status register 2. It is set via Write Status with +* two data bytes where bit 1 of the second byte is one. +* [...] +* Writing only one byte to the status register has the side-effect of +* clearing status register 2, including the QE bit. The 100b code is +* used if writing one byte to the status register does not modify +* status register 2. +* - 010b: QE is bit 6 of status register 1. It is set via Write Status with +* one data byte where bit 6 is one. +* [...] +* - 011b: QE is bit 7 of status register 2. It is set via Write status +* register 2 instruction 3Eh with one data byte where bit 7 is one. +* [...] +* The status register 2 is read using instruction 3Fh. +* - 100b: QE is bit 1 of status register 2. It is set via Write Status with +* two data bytes where bit 1 of the second byte is one. +* [...] +* In contrast to the 001b code, writing one byte to the status +* register does not modify status register 2. +* - 101b: QE is bit 1 of status register 2. Status register 1 is read using +* Read Status instruction 05h. Status register2 is read using +* instruction 35h. QE is set via Writ Status instruction 01h with +* two data bytes where bit 1 of the second byte is one. +* [...] +*/ +#define BFPT_DWORD15_QER_MASK GENMASK(22, 20) +#define BFPT_DWORD15_QER_NONE (0x0UL << 20)/* Micron */ +#define BFPT_DWORD15_QER_SR2_BIT1_BUGGY (0x1UL << 20) +#define BFPT_DWORD15_QER_SR1_BIT6 (0x2UL << 20)/* Macronix */ +#define BFPT_DWORD15_QER_SR2_BIT7 (0x3UL << 20) +#define BFPT_DWORD15_QER_SR2_BIT1_NO_RD (0x4UL << 20) +#define BFPT_DWORD15_QER_SR2_BIT1 (0x5UL << 20)/* Spansion */ + +struct sfdp_bfpt { +u32 dwords[BFPT_DWORD_MAX ]; +}; +static int spi_nor_read_write_reg (struct spi_nor *nor,struct spi_mem_op *op,void *buf) {
@@ -1518,118 +1630,6 @@ read_err:return ret; } -struct sfdp_parameter_header { -u8 id_lsb; -u8 minor; -u8 major; -u8 length;/* in double words */ -u8 parameter_table_pointer[3 ];/* byte address */ -u8 id_msb; -}; - -#define SFDP_PARAM_HEADER_ID (p) (((p)->id_msb << 8) | (p)->id_lsb) -#define SFDP_PARAM_HEADER_PTP (p) \ - (((p)->parameter_table_pointer[2] << 16) | \ - ((p)->parameter_table_pointer[1] << 8) | \ - ((p)->parameter_table_pointer[0] << 0)) - -#define SFDP_BFPT_ID 0xff00/* Basic Flash Parameter Table */ -#define SFDP_SECTOR_MAP_ID 0xff81/* Sector Map Table */ -#define SFDP_SST_ID 0x01bf/* Manufacturer specific Table */ - -#define SFDP_SIGNATURE 0x50444653U -#define SFDP_JESD216_MAJOR 1 -#define SFDP_JESD216_MINOR 0 -#define SFDP_JESD216A_MINOR 5 -#define SFDP_JESD216B_MINOR 6 - -struct sfdp_header { -u32 signature;/* Ox50444653U <=> "SFDP" */ -u8 minor; -u8 major; -u8 nph;/* 0-base number of parameter headers */ -u8 unused; - -/* Basic Flash Parameter Table. */ -struct sfdp_parameter_header bfpt_header; -}; - -/* Basic Flash Parameter Table */ - -/* -* JESD216 rev B defines a Basic Flash Parameter Table of 16 DWORDs. -* They are indexed from 1 but C arrays are indexed from 0. -*/ -#define BFPT_DWORD (i) ((i) - 1) -#define BFPT_DWORD_MAX 16 - -/* The first version of JESB216 defined only 9 DWORDs. */ -#define BFPT_DWORD_MAX_JESD216 9 - -/* 1st DWORD. */ -#define BFPT_DWORD1_FAST_READ_1_1_2 BIT(16) -#define BFPT_DWORD1_ADDRESS_BYTES_MASK GENMASK(18, 17) -#define BFPT_DWORD1_ADDRESS_BYTES_3_ONLY (0x0UL << 17) -#define BFPT_DWORD1_ADDRESS_BYTES_3_OR_4 (0x1UL << 17) -#define BFPT_DWORD1_ADDRESS_BYTES_4_ONLY (0x2UL << 17) -#define BFPT_DWORD1_DTR BIT(19) -#define BFPT_DWORD1_FAST_READ_1_2_2 BIT(20) -#define BFPT_DWORD1_FAST_READ_1_4_4 BIT(21) -#define BFPT_DWORD1_FAST_READ_1_1_4 BIT(22) - -/* 5th DWORD. */ -#define BFPT_DWORD5_FAST_READ_2_2_2 BIT(0) -#define BFPT_DWORD5_FAST_READ_4_4_4 BIT(4) - -/* 11th DWORD. */ -#define BFPT_DWORD11_PAGE_SIZE_SHIFT 4 -#define BFPT_DWORD11_PAGE_SIZE_MASK GENMASK(7, 4) - -/* 15th DWORD. */ - -/* -* (from JESD216 rev B) -* Quad Enable Requirements (QER): -* - 000b: Device does not have a QE bit. Device detects 1-1-4 and 1-4-4 -* reads based on instruction. DQ3/HOLD# functions are hold during -* instruction phase. -* - 001b: QE is bit 1 of status register 2. It is set via Write Status with -* two data bytes where bit 1 of the second byte is one. -* [...] -* Writing only one byte to the status register has the side-effect of -* clearing status register 2, including the QE bit. The 100b code is -* used if writing one byte to the status register does not modify -* status register 2. -* - 010b: QE is bit 6 of status register 1. It is set via Write Status with -* one data byte where bit 6 is one. -* [...] -* - 011b: QE is bit 7 of status register 2. It is set via Write status -* register 2 instruction 3Eh with one data byte where bit 7 is one. -* [...] -* The status register 2 is read using instruction 3Fh. -* - 100b: QE is bit 1 of status register 2. It is set via Write Status with -* two data bytes where bit 1 of the second byte is one. -* [...] -* In contrast to the 001b code, writing one byte to the status -* register does not modify status register 2. -* - 101b: QE is bit 1 of status register 2. Status register 1 is read using -* Read Status instruction 05h. Status register2 is read using -* instruction 35h. QE is set via Writ Status instruction 01h with -* two data bytes where bit 1 of the second byte is one. -* [...] -*/ -#define BFPT_DWORD15_QER_MASK GENMASK(22, 20) -#define BFPT_DWORD15_QER_NONE (0x0UL << 20)/* Micron */ -#define BFPT_DWORD15_QER_SR2_BIT1_BUGGY (0x1UL << 20) -#define BFPT_DWORD15_QER_SR1_BIT6 (0x2UL << 20)/* Macronix */ -#define BFPT_DWORD15_QER_SR2_BIT7 (0x3UL << 20) -#define BFPT_DWORD15_QER_SR2_BIT1_NO_RD (0x4UL << 20) -#define BFPT_DWORD15_QER_SR2_BIT1 (0x5UL << 20)/* Spansion */ - -struct sfdp_bfpt { -u32 dwords[BFPT_DWORD_MAX ]; -}; -/* Fast Read settings. */ static void
Signature · 1 line
2.26.2
PATCH v4 7/20 mtd: spi-nor-core: Introduce flash-specific fixup hooks
In reply to Pratyush YadavSometimes the information in a flash's SFDP tables is wrong. Sometimes some information just can't be expressed in the SFDP table. So, introduce the fixup hooks to allow tailoring settings for a specific flash.
Three hooks are added: default_init, post_sfdp, and post_bfpt. These allow tweaking the flash settings at different point in the probe sequence. Since the hooks reside in nor->info, set that value just before the call to spi_nor_init_params().
The hooks and at what points they are executed mimics Linux's spi-nor framework.
--- drivers/mtd/spi/sf_internal.h | 3 ++ drivers/mtd/spi/spi-nor-core.c | 72 ++++++++++++++++++++++++++++++++-- 2 files changed, 72 insertions(+), 3 deletions(-)
drivers/mtd/spi/sf_internal.h +3 -0
@@ -68,6 +68,9 @@ struct flash_info {#define USE_CLSR BIT(14)/* use CLSR command */ #define SPI_NOR_HAS_SST26LOCK BIT(15)/* Flash supports lock/unlock via BPR */ #define SPI_NOR_OCTAL_READ BIT(16)/* Flash supports Octal Read */ + +/* Part specific fixup hooks. */ +const struct spi_nor_fixups *fixups; };extern const struct flash_info spi_nor_ids[];
drivers/mtd/spi/spi-nor-core.c +69 -3
126 lines not on this page · raw message
Signature · 1 line
2.26.2
PATCH v4 8/20 mtd: spi-nor-core: Rework hwcaps selection
In reply to Pratyush YadavThe 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().
Based on the Linux commit c76f5089796a (mtd: spi-nor: Rework hwcaps selection for the spi-mem case, 2019-08-06)
--- drivers/mtd/spi/spi-nor-core.c | 168 +++++++++++++++++++++++++-------- include/linux/mtd/spi-nor.h | 14 +++ 2 files changed, 144 insertions(+), 38 deletions(-)
drivers/mtd/spi/spi-nor-core.c +130 -38
@@ -2289,6 +2289,124 @@ static int spi_nor_hwcaps_pp2cmd(u32 hwcaps) ARRAY_SIZE(hwcaps_pp2cmd)); } +/** +* spi_nor_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_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->spi, op)) { +if (nor->mtd.size >SZ_16M ) +return -ENOTSUPP ; + +/* If flash size <= 16MB, 3 address bytes are sufficient */ + op->addr.nbytes =3 ; +if (!spi_mem_supports_op (nor->spi, op)) +return -ENOTSUPP ; + } + +return 0 ; +} + +/** +* spi_nor_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_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_check_op (nor, &op); +} + +/** +* spi_nor_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_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_check_op (nor, &op); +} + +/** +* spi_nor_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_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 ; + +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_check_readop (nor, ¶ms->reads[rdidx])) + *hwcaps &= ~BIT (cap); + + ppidx =spi_nor_hwcaps_pp2cmd (BIT (cap)); +if (ppidx <0 ) +continue ; + +if (spi_nor_check_pp (nor, ¶ms->page_programs[ppidx])) + *hwcaps &= ~BIT (cap); + } +} +static int spi_nor_select_read (struct spi_nor *nor,const struct spi_nor_flash_parameter *params,u32 shared_hwcaps)
@@ -2372,7 +2490,7 @@ static int spi_nor_default_setup(struct spi_nor *nor,const struct spi_nor_flash_parameter *params, const struct spi_nor_hwcaps *hwcaps) { - u32 ignored_mask, shared_mask; + u32 shared_mask;bool enable_quad_io;int err;
@@ -2382,17 +2500,12 @@ static int spi_nor_default_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; - } +/* +* 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_adjust_hwcaps (nor, params, &shared_mask);/* Select the (Fast) Read command. */ err =spi_nor_select_read (nor, params, shared_mask);
@@ -2487,12 +2600,12 @@ int spi_nor_scan(struct spi_nor *nor)struct spi_nor_flash_parameter params;const struct flash_info *info =NULL ;struct mtd_info *mtd = &nor->mtd; -struct spi_nor_hwcaps hwcaps = { - .mask =SNOR_HWCAPS_READ | -SNOR_HWCAPS_READ_FAST | -SNOR_HWCAPS_PP , - };struct spi_slave *spi = nor->spi; +/* +* 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 };int ret;/* Reset SPI protocol for all commands. */
@@ -2506,27 +2619,6 @@ int spi_nor_scan(struct spi_nor *nor) nor->setup = spi_nor_default_setup; -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 ; - } - info =spi_nor_read_id (nor);if (IS_ERR_OR_NULL (info))return -ENOENT ;
include/linux/mtd/spi-nor.h +14 -0
@@ -312,6 +312,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) +struct spi_nor_read_command {u8 num_mode_clocks;u8 num_wait_states;
Signature · 1 line
2.26.2
PATCH v4 9/20 mtd: spi-nor-core: Add support for DTR protocol
In reply to Pratyush YadavDouble Transfer Rate (DTR) is SPI protocol in which data is transferred on each clock edge as opposed to on each clock cycle. Make framework-level changes to allow supporting flashes in DTR mode.
Right now, mixed DTR modes are not supported. So, for example a mode like 4S-4D-4D will not work. All phases need to be either DTR or STR.
--- drivers/mtd/spi/sf_internal.h | 1 + drivers/mtd/spi/spi-nor-core.c | 126 +++++++++++++++++++++++++++++---- include/linux/mtd/spi-nor.h | 50 +++++++++---- 3 files changed, 150 insertions(+), 27 deletions(-)
drivers/mtd/spi/sf_internal.h +1 -0
@@ -68,6 +68,7 @@ struct flash_info {#define USE_CLSR BIT(14)/* use CLSR command */ #define SPI_NOR_HAS_SST26LOCK BIT(15)/* Flash supports lock/unlock via BPR */ #define SPI_NOR_OCTAL_READ BIT(16)/* Flash supports Octal Read */ +#define SPI_NOR_OCTAL_DTR_READ BIT(17)/* Flash supports Octal DTR Read */ /* Part specific fixup hooks. */ const struct spi_nor_fixups *fixups;
drivers/mtd/spi/spi-nor-core.c +111 -15
217 lines not on this page · raw message
include/linux/mtd/spi-nor.h +38 -12
116 lines not on this page · raw message
Signature · 1 line
2.26.2
PATCH v4 10/20 mtd: spi-nor-core: prepare BFPT parsing for JESD216 rev D
In reply to Pratyush YadavJESD216 rev D makes BFPT 20 DWORDs. Update the BFPT size define to reflect that.
The check for rev A or later compared the BFPT header length with the maximum BFPT length, BFPT_DWORD_MAX. Since BFPT_DWORD_MAX was 16, and so was the BFPT length for both rev A and B, this check worked fine. But now, since BFPT_DWORD_MAX is 20, it means this check will also stop BFPT parsing for rev A or B, since their length is 16.
So, instead check for BFPT_DWORD_MAX_JESD216 to stop BFPT parsing for the first JESD216 version, and check for BFPT_DWORD_MAX_JESD216B for the next two versions.
--- drivers/mtd/spi/spi-nor-core.c | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-)
drivers/mtd/spi/spi-nor-core.c +9 -3
@@ -77,14 +77,15 @@ struct sfdp_header {/* Basic Flash Parameter Table */ /* -* JESD216 rev B defines a Basic Flash Parameter Table of 16 DWORDs. +* JESD216 rev D defines a Basic Flash Parameter Table of 20 DWORDs. * They are indexed from 1 but C arrays are indexed from 0. */ #define BFPT_DWORD (i) ((i) - 1) -#define BFPT_DWORD_MAX 16 +#define BFPT_DWORD_MAX 20/* The first version of JESB216 defined only 9 DWORDs. */ #define BFPT_DWORD_MAX_JESD216 9 +#define BFPT_DWORD_MAX_JESD216B 16/* 1st DWORD. */ #define BFPT_DWORD1_FAST_READ_1_1_2 BIT(16)
@@ -1987,7 +1988,7 @@ static int spi_nor_parse_bfpt(struct spi_nor *nor, }/* Stop here if not JESD216 rev A or later. */ -if (bfpt_header->length <BFPT_DWORD_MAX ) +if (bfpt_header->length ==BFPT_DWORD_MAX_JESD216 )return spi_nor_post_bfpt_fixups (nor, bfpt_header, &bfpt, params);
@@ -2022,6 +2023,11 @@ static int spi_nor_parse_bfpt(struct spi_nor *nor,return -EINVAL ; } +/* Stop here if JESD216 rev B. */ +if (bfpt_header->length ==BFPT_DWORD_MAX_JESD216B ) +return spi_nor_post_bfpt_fixups (nor, bfpt_header, &bfpt, + params); +return spi_nor_post_bfpt_fixups (nor, bfpt_header, &bfpt, params); }
Signature · 1 line
2.26.2
PATCH v4 11/20 mtd: spi-nor-core: Get command opcode extension type from BFPT
In reply to Pratyush YadavSome devices in DTR mode expect an extra command byte called the extension. The extension can either be same as the opcode, bitwise inverse of the opcode, or another additional byte forming a 16-byte opcode. Get the extension type from the BFPT. For now, only flashes with "repeat" and "inverse" extensions are supported.
--- drivers/mtd/spi/spi-nor-core.c | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+)
drivers/mtd/spi/spi-nor-core.c +24 -0
@@ -147,6 +147,12 @@ struct sfdp_header {#define BFPT_DWORD15_QER_SR2_BIT1_NO_RD (0x4UL << 20)#define BFPT_DWORD15_QER_SR2_BIT1 (0x5UL << 20)/* Spansion */ +#define BFPT_DWORD18_CMD_EXT_MASK GENMASK(30, 29) +#define BFPT_DWORD18_CMD_EXT_REP (0x0UL << 29)/* Repeat */ +#define BFPT_DWORD18_CMD_EXT_INV (0x1UL << 29)/* Invert */ +#define BFPT_DWORD18_CMD_EXT_RES (0x2UL << 29)/* Reserved */ +#define BFPT_DWORD18_CMD_EXT_16B (0x3UL << 29)/* 16-bit opcode */ +struct sfdp_bfpt {u32 dwords[BFPT_DWORD_MAX ]; };
@@ -2028,6 +2034,24 @@ static int spi_nor_parse_bfpt(struct spi_nor *nor,return spi_nor_post_bfpt_fixups (nor, bfpt_header, &bfpt, params); +/* 8D-8D-8D command extension. */ +switch (bfpt.dwords[BFPT_DWORD (18 )] &BFPT_DWORD18_CMD_EXT_MASK ) { +case BFPT_DWORD18_CMD_EXT_REP : + nor->cmd_ext_type =SPI_NOR_EXT_REPEAT ; +break ; + +case BFPT_DWORD18_CMD_EXT_INV : + nor->cmd_ext_type =SPI_NOR_EXT_INVERT ; +break ; + +case BFPT_DWORD18_CMD_EXT_RES : +return -EINVAL ; + +case BFPT_DWORD18_CMD_EXT_16B : +dev_err (nor->dev,"16-bit opcodes not supported\n" ); +return -ENOTSUPP ; + } +return spi_nor_post_bfpt_fixups (nor, bfpt_header, &bfpt, params); }
Signature · 1 line
2.26.2
PATCH v4 12/20 mtd: spi-nor-core: Parse xSPI Profile 1.0 table
In reply to Pratyush YadavThis table is indication that the flash is xSPI compliant and hence supports octal DTR mode. Extract information like the fast read opcode, the number of dummy cycles needed for a Read Status Register command, and the number of address bytes needed for a Read Status Register command.
The default dummy cycles for a fast octal DTR read are set to 20. Since there is no simple way of determining the dummy cycles needed for the fast read command, flashes that use a different value should update it in their flash-specific hooks.
--- drivers/mtd/spi/spi-nor-core.c | 100 +++++++++++++++++++++++++++++++++ include/linux/mtd/spi-nor.h | 7 +++ 2 files changed, 107 insertions(+)
drivers/mtd/spi/spi-nor-core.c +100 -0
@@ -19,6 +19,7 @@#include <linux/log2.h> #include <linux/math64.h> #include <linux/sizes.h> +#include <linux/bitfield.h> #include <linux/mtd/mtd.h> #include <linux/mtd/spi-nor.h>
@@ -38,6 +39,8 @@#define DEFAULT_READY_WAIT_JIFFIES (40UL * HZ) +#define ROUND_UP_TO (x, y) (((x) + (y) - 1) / (y) * (y)) +struct sfdp_parameter_header {u8 id_lsb;u8 minor;
@@ -56,6 +59,7 @@ struct sfdp_parameter_header {#define SFDP_BFPT_ID 0xff00/* Basic Flash Parameter Table */ #define SFDP_SECTOR_MAP_ID 0xff81/* Sector Map Table */ #define SFDP_SST_ID 0x01bf/* Manufacturer specific Table */ +#define SFDP_PROFILE1_ID 0xff05/* xSPI Profile 1.0 Table */ #define SFDP_SIGNATURE 0x50444653U#define SFDP_JESD216_MAJOR 1
@@ -153,6 +157,16 @@ struct sfdp_header {#define BFPT_DWORD18_CMD_EXT_RES (0x2UL << 29)/* Reserved */ #define BFPT_DWORD18_CMD_EXT_16B (0x3UL << 29)/* 16-bit opcode */ +/* xSPI Profile 1.0 table (from JESD216D.01). */ +#define PROFILE1_DWORD1_RD_FAST_CMD GENMASK(15, 8) +#define PROFILE1_DWORD1_RDSR_DUMMY BIT(28) +#define PROFILE1_DWORD1_RDSR_ADDR_BYTES BIT(29) +#define PROFILE1_DWORD4_DUMMY_200MHZ GENMASK(11, 7) +#define PROFILE1_DWORD5_DUMMY_166MHZ GENMASK(31, 27) +#define PROFILE1_DWORD5_DUMMY_133MHZ GENMASK(21, 17) +#define PROFILE1_DWORD5_DUMMY_100MHZ GENMASK(11, 7) +#define PROFILE1_DUMMY_DEFAULT 20 +struct sfdp_bfpt {u32 dwords[BFPT_DWORD_MAX ]; };
@@ -2055,6 +2069,86 @@ static int spi_nor_parse_bfpt(struct spi_nor *nor,return spi_nor_post_bfpt_fixups (nor, bfpt_header, &bfpt, params); } +/** +* spi_nor_parse_profile1() - parse the xSPI Profile 1.0 table +* @nor: pointer to a 'struct spi_nor' +* @param_header: pointer to the 'struct sfdp_parameter_header' describing +* the 4-Byte Address Instruction Table length and version. +* @params: pointer to the 'struct spi_nor_flash_parameter' to be. +* +* Return: 0 on success, -errno otherwise. +*/ +static int spi_nor_parse_profile1 (struct spi_nor *nor, +const struct sfdp_parameter_header *profile1_header, +struct spi_nor_flash_parameter *params) +{ +u32 *table, opcode, addr; +size_t len; +int ret, i; +u8 dummy; + + len = profile1_header->length *sizeof (*table); + table =kmalloc (len,GFP_KERNEL ); +if (!table) +return -ENOMEM ; + + addr =SFDP_PARAM_HEADER_PTP (profile1_header); + ret =spi_nor_read_sfdp (nor, addr, len, table); +if (ret) + goto out; + +/* Fix endianness of the table DWORDs. */ +for (i =0 ; i < profile1_header->length; i++) + table[i] =le32_to_cpu (table[i]); + +/* Get 8D-8D-8D fast read opcode and dummy cycles. */ + opcode =FIELD_GET (PROFILE1_DWORD1_RD_FAST_CMD , table[0 ]); + +/* +* We don't know what speed the controller is running at. Find the +* dummy cycles for the fastest frequency the flash can run at to be +* sure we are never short of dummy cycles. A value of 0 means the +* frequency is not supported. +* +* Default to PROFILE1_DUMMY_DEFAULT if we don't find anything, and let +* flashes set the correct value if needed in their fixup hooks. +*/ + dummy =FIELD_GET (PROFILE1_DWORD4_DUMMY_200MHZ , table[3 ]); +if (!dummy) + dummy =FIELD_GET (PROFILE1_DWORD5_DUMMY_166MHZ , table[4 ]); +if (!dummy) + dummy =FIELD_GET (PROFILE1_DWORD5_DUMMY_133MHZ , table[4 ]); +if (!dummy) + dummy =FIELD_GET (PROFILE1_DWORD5_DUMMY_100MHZ , table[4 ]); +if (!dummy) + dummy =PROFILE1_DUMMY_DEFAULT ; + +/* Round up to an even value to avoid tripping controllers up. */ + dummy =ROUND_UP_TO (dummy,2 ); + +/* Update the fast read settings. */ +spi_nor_set_read_settings (¶ms->reads[SNOR_CMD_READ_8_8_8_DTR ], +0 , dummy, opcode, +SNOR_PROTO_8_8_8_DTR ); + +/* +* Set the Read Status Register dummy cycles and dummy address bytes. +*/ +if (table[0 ] &PROFILE1_DWORD1_RDSR_DUMMY ) + params->rdsr_dummy =8 ; +else + params->rdsr_dummy =4 ; + +if (table[0 ] &PROFILE1_DWORD1_RDSR_ADDR_BYTES ) + params->rdsr_addr_nbytes =4 ; +else + params->rdsr_addr_nbytes =0 ; + +out: +kfree (table); +return ret; +} +/** * spi_nor_parse_microchip_sfdp() - parse the Microchip manufacturer specific * SFDP table.
@@ -2185,6 +2279,10 @@ static int spi_nor_parse_sfdp(struct spi_nor *nor, err =spi_nor_parse_microchip_sfdp (nor, param_header);break ; +case SFDP_PROFILE1_ID : + err =spi_nor_parse_profile1 (nor, param_header, params); +break ; +default :break ; }
@@ -2857,6 +2955,8 @@ int spi_nor_scan(struct spi_nor *nor)if (ret)return ret; + nor->rdsr_dummy = params.rdsr_dummy; + nor->rdsr_addr_nbytes = params.rdsr_addr_nbytes; nor->name = mtd->name; nor->size = mtd->size; nor->erase_size = mtd->erasesize;
include/linux/mtd/spi-nor.h +7 -0
@@ -391,6 +391,8 @@ enum spi_nor_pp_command_index {struct spi_nor_flash_parameter {u64 size;u32 page_size; +u8 rdsr_dummy; +u8 rdsr_addr_nbytes;struct spi_nor_hwcaps hwcaps;struct spi_nor_read_command reads[SNOR_CMD_READ_MAX ];
@@ -443,6 +445,9 @@ struct flash_info;* @read_opcode: the read opcode * @read_dummy: the dummy needed by the read operation * @program_opcode: the program opcode +* @rdsr_dummy dummy cycles needed for Read Status Register command. +* @rdsr_addr_nbytes: dummy address bytes needed for Read Status Register +* command. * @bank_read_cmd: Bank read cmd * @bank_write_cmd: Bank write cmd * @bank_curr: Current flash bank
@@ -483,6 +488,8 @@ struct spi_nor {u8 read_opcode;u8 read_dummy;u8 program_opcode; +u8 rdsr_dummy; +u8 rdsr_addr_nbytes;#ifdef CONFIG_SPI_FLASH_BAR u8 bank_read_cmd;u8 bank_write_cmd;
Signature · 1 line
2.26.2
PATCH v4 13/20 mtd: spi-nor-core: Prepare Read SR and FSR for Octal DTR mode
In reply to Pratyush YadavThe xSPI Profile 1.0 table specifies how many dummy cycles and address bytes are needed for the Read Status Register command in Octal DTR mode. Use that information to send the correct Read SR command.
Some controllers might have trouble reading just 1 byte in DTR mode. So, when we are in DTR mode read 2 bytes and discard the second. This shows no side effects with the two flashes I tested: Micron mt35xu512aba and Cypress s28hs512t.
Update Read FSR to mimic Read SR because they share the same characteristics.
--- drivers/mtd/spi/spi-nor-core.c | 43 +++++++++++++++++++++++++++++----- 1 file changed, 37 insertions(+), 6 deletions(-)
drivers/mtd/spi/spi-nor-core.c +37 -6
@@ -376,15 +376,30 @@ static ssize_t spi_nor_write_data(struct spi_nor *nor, loff_t to, size_t len,static int read_sr (struct spi_nor *nor) {int ret; -u8 val; +u8 val[2 ]; +u8 addr_nbytes = nor->rdsr_addr_nbytes; +u8 dummy = nor->rdsr_dummy; +struct spi_mem_op op =SPI_MEM_OP (SPI_MEM_OP_CMD (SPINOR_OP_RDSR ,1 ), +SPI_MEM_OP_ADDR (addr_nbytes,0 ,1 ), +SPI_MEM_OP_DUMMY (dummy,1 ), +SPI_MEM_OP_DATA_IN (1 ,NULL ,1 )); - ret = nor->read_reg (nor,SPINOR_OP_RDSR , &val,1 ); +spi_nor_setup_op (nor, &op, nor->reg_proto); + +/* +* We don't want to read only one byte in DTR mode. So, read 2 and then +* discard the second byte. +*/ +if (spi_nor_protocol_is_dtr (nor->reg_proto)) + op.data.nbytes =2 ; + + ret =spi_nor_read_write_reg (nor, &op, val);if (ret <0 ) {pr_debug ("error %d reading SR\n" , (int )ret);return ret; } -return val; +return *val; }/*
@@ -395,15 +410,31 @@ static int read_sr(struct spi_nor *nor)static int read_fsr (struct spi_nor *nor) {int ret; -u8 val; +u8 val[2 ]; +u8 addr_nbytes = nor->rdsr_addr_nbytes; +u8 dummy = nor->rdsr_dummy; - ret = nor->read_reg (nor,SPINOR_OP_RDFSR , &val,1 ); +struct spi_mem_op op =SPI_MEM_OP (SPI_MEM_OP_CMD (SPINOR_OP_RDFSR ,1 ), +SPI_MEM_OP_ADDR (addr_nbytes,0 ,1 ), +SPI_MEM_OP_DUMMY (dummy,1 ), +SPI_MEM_OP_DATA_IN (1 ,NULL ,1 )); + +spi_nor_setup_op (nor, &op, nor->reg_proto); + +/* +* We don't want to read only one byte in DTR mode. So, read 2 and then +* discard the second byte. +*/ +if (spi_nor_protocol_is_dtr (nor->reg_proto)) + op.data.nbytes =2 ; + + ret =spi_nor_read_write_reg (nor, &op, val);if (ret <0 ) {pr_debug ("error %d reading FSR\n" , ret);return ret; } -return val; +return *val; }/*
Signature · 1 line
2.26.2
PATCH v4 14/20 mtd: spi-nor-core: Enable octal DTR mode when possible
In reply to Pratyush YadavAllow flashes to specify a hook to enable octal DTR mode. Use this hook whenever possible to get optimal transfer speeds.
--- drivers/mtd/spi/spi-nor-core.c | 31 +++++++++++++++++++++++++++++++ include/linux/mtd/spi-nor.h | 2 ++ 2 files changed, 33 insertions(+)
drivers/mtd/spi/spi-nor-core.c +31 -0
@@ -2803,10 +2803,41 @@ static int spi_nor_setup(struct spi_nor *nor, const struct flash_info *info,return nor->setup (nor, info, params, hwcaps); } +/** spi_nor_octal_dtr_enable() - enable Octal DTR I/O if needed +* @nor: pointer to a 'struct spi_nor' +* +* Return: 0 on success, -errno otherwise. +*/ +static int spi_nor_octal_dtr_enable (struct spi_nor *nor) +{ +int ret; + +if (!nor->octal_dtr_enable) +return 0 ; + +if (!(nor->read_proto ==SNOR_PROTO_8_8_8_DTR && + nor->write_proto ==SNOR_PROTO_8_8_8_DTR )) +return 0 ; + + ret = nor->octal_dtr_enable (nor); +if (ret) +return ret; + + nor->reg_proto =SNOR_PROTO_8_8_8_DTR ; + +return 0 ; +} +static int spi_nor_init (struct spi_nor *nor) {int err; + err =spi_nor_octal_dtr_enable (nor); +if (err) { +dev_dbg (nor->dev,"Octal DTR mode not supported\n" ); +return err; + } +/* * Atmel, SST, Intel/Numonyx, and others serial NOR tend to power up * with the software protection bits set
include/linux/mtd/spi-nor.h +2 -0
@@ -474,6 +474,7 @@ struct flash_info;* @flash_is_locked: [FLASH-SPECIFIC] check if a region of the SPI NOR is * @quad_enable: [FLASH-SPECIFIC] enables SPI NOR quad mode * completely locked +* @octal_dtr_enable: [FLASH-SPECIFIC] enables SPI NOR octal DTR mode. * @priv: the private data */ struct spi_nor {
@@ -521,6 +522,7 @@ struct spi_nor {int (*flash_unlock)(struct spi_nor *nor,loff_t ofs,uint64_t len);int (*flash_is_locked)(struct spi_nor *nor,loff_t ofs,uint64_t len);int (*quad_enable)(struct spi_nor *nor); +int (*octal_dtr_enable)(struct spi_nor *nor);void *priv;/* Compatibility for spi_flash, remove once sf layer is merged with mtd */
Signature · 1 line
2.26.2
PATCH v4 15/20 mtd: spi-nor-core: Do not make invalid quad enable fatal
In reply to Pratyush YadavThe Micron MT35XU512ABA flash does not support the quad enable bit. But instead of programming the Quad Enable Require field to 000b ("Device does not have a QE bit"), it is programmed to 111b ("Reserved").
While this is technically incorrect, it is not reason enough to abort BFPT parsing. Instead, continue BFPT parsing assuming there is no quad enable bit present.
--- drivers/mtd/spi/spi-nor-core.c | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-)
drivers/mtd/spi/spi-nor-core.c +3 -4
@@ -2051,9 +2051,6 @@ static int spi_nor_parse_bfpt(struct spi_nor *nor,/* Quad Enable Requirements. */ switch (bfpt.dwords[BFPT_DWORD (15 )] &BFPT_DWORD15_QER_MASK ) { -case BFPT_DWORD15_QER_NONE : - params->quad_enable =NULL ; -break ;#if defined(CONFIG_SPI_FLASH_SPANSION ) || defined(CONFIG_SPI_FLASH_WINBOND )case BFPT_DWORD15_QER_SR2_BIT1_BUGGY :case BFPT_DWORD15_QER_SR2_BIT1_NO_RD :
@@ -2070,8 +2067,10 @@ static int spi_nor_parse_bfpt(struct spi_nor *nor, params->quad_enable = spansion_read_cr_quad_enable;break ;#endif +case BFPT_DWORD15_QER_NONE :default : -return -EINVAL ; + params->quad_enable =NULL ; +break ; }/* Stop here if JESD216 rev B. */
Signature · 1 line
2.26.2
PATCH v4 16/20 mtd: spi-nor-core: Detect Soft Reset sequence support from BFPT
In reply to Pratyush YadavA Soft Reset sequence will return the flash to Power-on-Reset (POR) state. It consists of two commands: Soft Reset Enable and Soft Reset. Find out if the sequence is supported from BFPT DWORD 16.
--- drivers/mtd/spi/spi-nor-core.c | 6 ++++++ include/linux/mtd/spi-nor.h | 1 + 2 files changed, 7 insertions(+)
drivers/mtd/spi/spi-nor-core.c +6 -0
@@ -151,6 +151,8 @@ struct sfdp_header {#define BFPT_DWORD15_QER_SR2_BIT1_NO_RD (0x4UL << 20)#define BFPT_DWORD15_QER_SR2_BIT1 (0x5UL << 20)/* Spansion */ +#define BFPT_DWORD16_SOFT_RST BIT(12) +#define BFPT_DWORD18_CMD_EXT_MASK GENMASK(30, 29)#define BFPT_DWORD18_CMD_EXT_REP (0x0UL << 29)/* Repeat */ #define BFPT_DWORD18_CMD_EXT_INV (0x1UL << 29)/* Invert */
@@ -2073,6 +2075,10 @@ static int spi_nor_parse_bfpt(struct spi_nor *nor,break ; } +/* Soft Reset support. */ +if (bfpt.dwords[BFPT_DWORD (16 )] &BFPT_DWORD16_SOFT_RST ) + nor->flags |=SNOR_F_SOFT_RESET ; +/* Stop here if JESD216 rev B. */ if (bfpt_header->length ==BFPT_DWORD_MAX_JESD216B ) return spi_nor_post_bfpt_fixups(nor, bfpt_header, &bfpt,
include/linux/mtd/spi-nor.h +1 -0
@@ -248,6 +248,7 @@ enum spi_nor_option_flags {SNOR_F_READY_XSR_RDY =BIT (4 ),SNOR_F_USE_CLSR =BIT (5 ),SNOR_F_BROKEN_RESET =BIT (6 ), + SNOR_F_SOFT_RESET = BIT(7), };struct spi_nor ;
Signature · 1 line
2.26.2
PATCH v4 17/20 mtd: spi-nor-core: Perform a Soft Reset on shutdown
In reply to Pratyush YadavOn probe, the SPI NOR core will put a flash in 8D-8D-8D mode if it supports it. But Linux as of now expects to get the flash in 1S-1S-1S mode. Handing the flash to Linux in Octal DTR mode means the kernel will fail to detect the flash.
So, we need to reset to Power-on-Reset (POR) state before handing off the flash. A Software Reset command can be used to do this.
One limitation of the soft reset is that it will restore state from non-volatile registers in some flashes. This means that if the flash was set to 8D mode in a non-volatile configuration, a soft reset won't help. This commit assumes that we don't set any non-volatile bits anywhere, and the flash doesn't have any non-volatile Octal DTR mode configuration.
--- drivers/mtd/spi/sf_probe.c | 9 +++++ drivers/mtd/spi/spi-nor-core.c | 64 ++++++++++++++++++++++++++++++++++ include/linux/mtd/spi-nor.h | 10 ++++++ 3 files changed, 83 insertions(+)
drivers/mtd/spi/sf_probe.c +9 -0
@@ -153,6 +153,14 @@ int spi_flash_std_probe(struct udevice *dev)static int spi_flash_std_remove (struct udevice *dev) { +struct spi_flash *flash; +int ret; + + flash =dev_get_uclass_priv (dev); + ret =spi_nor_remove (flash); +if (ret) +return ret; +#if CONFIG_IS_ENABLED (SPI_FLASH_MTD )spi_flash_mtd_unregister ();#endif
@@ -179,6 +187,7 @@ U_BOOT_DRIVER(spi_flash_std) = { .remove = spi_flash_std_remove, .priv_auto_alloc_size = sizeof(struct spi_flash), .ops = &spi_flash_std_ops, + .flags = DM_FLAG_OS_PREPARE, };#endif /* CONFIG_DM_SPI_FLASH */
drivers/mtd/spi/spi-nor-core.c +64 -0
82 lines not on this page · raw message
include/linux/mtd/spi-nor.h +10 -0
@@ -67,6 +67,8 @@#define SPINOR_OP_CLFSR 0x50/* Clear flag status register */ #define SPINOR_OP_RDEAR 0xc8/* Read Extended Address Register */ #define SPINOR_OP_WREAR 0xc5/* Write Extended Address Register */ +#define SPINOR_OP_SRSTEN 0x66/* Software Reset Enable */ +#define SPINOR_OP_SRST 0x99/* Software Reset */ /* 4-byte address opcodes - used on Spansion and some Macronix flashes. */ #define SPINOR_OP_READ_4B 0x13/* Read data bytes (low frequency) */
@@ -557,4 +559,12 @@ device_node *spi_nor_get_flash_node(struct spi_nor *nor)*/ int spi_nor_scan (struct spi_nor *nor); +/** +* spi_nor_remove() - perform cleanup before booting to the next stage +* @nor: the spi_nor structure +* +* Return: 0 for success, -errno for failure. +*/ +int spi_nor_remove (struct spi_nor *nor); +#endif
Signature · 1 line
2.26.2
PATCH v4 18/20 mtd: spi-nor-core: Perform a Soft Reset on boot
In reply to Pratyush YadavWhen the flash is handed to us in a stateful mode like 8D-8D-8D, it is difficult to detect the mode the flash is in. One option is to read SFDP in all modes and see which one gives the correct "SFDP" signature, but not all flashes support SFDP in 8D-8D-8D mode.
Further, even if you detect the mode of the flash via SFDP, you still have the problem of actually reading the ID. The Read ID command is not standardized across flash vendors. Flashes can have different dummy cycles needed for reading the ID. Some flashes even expect a 4-byte dummy address with the Read ID command. All this information cannot be obtained from the SFDP table.
So, perform a Software Reset sequence before reading the ID and initializing the flash. A Soft Reset will bring back the flash in its default protocol mode assuming no non-volatile configuration was set. This will let us detect the flash even if ROM hands it to us in Octal DTR mode.
To accommodate cases where there is more than one flash on a board, and only one of them needs a soft reset, failure to reset is not made fatal, and we still try to read ID if possible.
--- drivers/mtd/spi/Kconfig | 11 +++++++++++ drivers/mtd/spi/spi-nor-core.c | 27 +++++++++++++++++++++++++++ 2 files changed, 38 insertions(+)
drivers/mtd/spi/Kconfig +11 -0
@@ -88,6 +88,17 @@ config SPI_FLASH_SFDP_SUPPORT SPI NOR flashes using Serial Flash Discoverable Parameters (SFDP) tables as per JESD216 standard. +config SPI_FLASH_SOFT_RESET + bool "Software Reset support for SPI NOR flashes" + help + Enable support for xSPI Software Reset. It will be used to switch + from Octal DTR mode to legacy mode to allow detecting flashes that + are handed to us in Octal DTR mode. It is expected that if the config + is enabled the flash supports the Soft Reset sequence and is booted in + Octal DTR mode. Do not enable this config on flashes that are not + supposed to be handed to U-Boot in Octal DTR mode, even if they _do_ + support the Soft Reset sequence. + config SPI_FLASH_BAR bool "SPI flash Bank/Extended address register support" help
drivers/mtd/spi/spi-nor-core.c +27 -0
@@ -2971,6 +2971,33 @@ int spi_nor_scan(struct spi_nor *nor) nor->setup = spi_nor_default_setup; +#if defined(CONFIG_SPI_FLASH_SOFT_RESET ) +/* +* When the flash is handed to us in a stateful mode like 8D-8D-8D, it +* is difficult to detect the mode the flash is in. One option is to +* read SFDP in all modes and see which one gives the correct "SFDP" +* signature, but not all flashes support SFDP in 8D-8D-8D mode. +* +* Further, even if you detect the mode of the flash via SFDP, you +* still have the problem of actually reading the ID. The Read ID +* command is not standardized across flash vendors. Flashes can have +* different dummy cycles needed for reading the ID. Some flashes even +* expect a 4-byte dummy address with the Read ID command. All this +* information cannot be obtained from the SFDP table. +* +* So, perform a Software Reset sequence before reading the ID and +* initializing the flash. A Soft Reset will bring back the flash in +* its default protocol mode assuming no non-volatile configuration was +* set. This will let us detect the flash even if ROM hands it to us in +* Octal DTR mode. +* +* To accommodate cases where there is more than one flash on a board, +* and only one of them needs a soft reset, failure to reset is not +* made fatal, and we still try to read ID if possible. +*/ +spi_nor_soft_reset (nor); +#endif /* CONFIG_SPI_FLASH_SOFT_RESET */ + info =spi_nor_read_id (nor);if (IS_ERR_OR_NULL (info))return -ENOENT ;
Signature · 1 line
2.26.2
PATCH v4 19/20 mtd: spi-nor-core: Add support for Cypress Semper flash
In reply to Pratyush YadavThe Cypress Semper flash is an xSPI compliant octal DTR flash. Add support for using it in octal DTR mode.
The flash by default boots in a hybrid sector mode. Switch to uniform sector mode on boot. Use the default 20 dummy cycles for a read fast command.
The SFDP programming on some older versions of the flash was incorrect. Fixes for that are included in the fixup hooks.
--- drivers/mtd/spi/sf_internal.h | 4 + drivers/mtd/spi/spi-nor-core.c | 196 +++++++++++++++++++++++++++++++++ drivers/mtd/spi/spi-nor-ids.c | 1 + include/linux/mtd/spi-nor.h | 13 +++ 4 files changed, 214 insertions(+)
drivers/mtd/spi/sf_internal.h +4 -0
@@ -76,6 +76,10 @@ struct flash_info {extern const struct flash_info spi_nor_ids[]; +#ifdef CONFIG_SPI_FLASH_SPANSION +extern struct spi_nor_fixups s28hs512t_fixups; +#endif +#define JEDEC_MFR (info) ((info)->id[0])#define JEDEC_ID (info) (((info)->id[1]) << 8 | ((info)->id[2]))
drivers/mtd/spi/spi-nor-core.c +196 -0
202 lines not on this page · raw message
drivers/mtd/spi/spi-nor-ids.c +1 -0
@@ -215,6 +215,7 @@ const struct flash_info spi_nor_ids[] = { { INFO("s25fl208k", 0x014014, 0, 64 * 1024, 16, SECT_4K | SPI_NOR_DUAL_READ) }, { INFO("s25fl064l", 0x016017, 0, 64 * 1024, 128, SECT_4K | SPI_NOR_DUAL_READ | SPI_NOR_QUAD_READ | SPI_NOR_4B_OPCODES) }, { INFO("s25fl128l", 0x016018, 0, 64 * 1024, 256, SECT_4K | SPI_NOR_DUAL_READ | SPI_NOR_QUAD_READ | SPI_NOR_4B_OPCODES) }, + { INFO("s28hs512t", 0x345b1a, 0, 256 * 1024, 256, SPI_NOR_OCTAL_DTR_READ) .fixups = &s28hs512t_fixups }, #endif #ifdef CONFIG_SPI_FLASH_SST /* SST */ /* SST -- large erase sizes are "overlays", "sectors" are 4K */
include/linux/mtd/spi-nor.h +13 -0
@@ -157,6 +157,19 @@/* Status Register 2 bits. */ #define SR2_QUAD_EN_BIT7 BIT(7) +/* For Cypress flash. */ +#define SPINOR_OP_RD_ANY_REG 0x65/* Read any register */ +#define SPINOR_OP_WR_ANY_REG 0x71/* Write any register */ +#define SPINOR_REG_CYPRESS_CFR2V 0x00800003 +#define SPINOR_REG_CYPRESS_CFR2V_MEMLAT_11_24 0xb +#define SPINOR_REG_CYPRESS_CFR3N 0x00000004 +#define SPINOR_REG_CYPRESS_CFR3V 0x00800004 +#define SPINOR_REG_CYPRESS_CFR3V_PGSZ BIT(4)/* Page size. */ +#define SPINOR_REG_CYPRESS_CFR3N_UNISECT BIT(3)/* Uniform sector mode */ +#define SPINOR_REG_CYPRESS_CFR5V 0x00800006 +#define SPINOR_REG_CYPRESS_CFR5V_OCT_DTR_EN 0x3 +#define SPINOR_OP_CYPRESS_RD_FAST 0xee +/* Supported SPI protocols */ #define SNOR_PROTO_INST_MASK GENMASK(23, 16)#define SNOR_PROTO_INST_SHIFT 16
Signature · 1 line
2.26.2
PATCH v4 20/20 mtd: spi-nor-core: Allow using Micron mt35xu512aba in Octal DTR mode
In reply to Pratyush YadavSince this flash doesn't have a Profile 1.0 table, the Octal DTR capabilities are enabled in the post SFDP fixup, along with the 8D-8D-8D fast read settings.
Enable Octal DTR mode with 20 dummy cycles to allow running at the maximum supported frequency of 200Mhz.
The flash supports the soft reset sequence. So, add the flag in the flash's info.
--- drivers/mtd/spi/sf_internal.h | 4 ++ drivers/mtd/spi/spi-nor-core.c | 87 ++++++++++++++++++++++++++++++++++ drivers/mtd/spi/spi-nor-ids.c | 3 +- include/linux/mtd/spi-nor.h | 10 +++- 4 files changed, 101 insertions(+), 3 deletions(-)
drivers/mtd/spi/sf_internal.h +4 -0
@@ -80,6 +80,10 @@ extern const struct flash_info spi_nor_ids[];extern struct spi_nor_fixups s28hs512t_fixups;#endif +#ifdef CONFIG_SPI_FLASH_STMICRO +extern struct spi_nor_fixups mt35xu512aba_fixups; +#endif +#define JEDEC_MFR (info) ((info)->id[0])#define JEDEC_ID (info) (((info)->id[1]) << 8 | ((info)->id[2]))
drivers/mtd/spi/spi-nor-core.c +87 -0
93 lines not on this page · raw message
drivers/mtd/spi/spi-nor-ids.c +2 -1
@@ -185,7 +185,8 @@ const struct flash_info spi_nor_ids[] = { { INFO("n25q00", 0x20ba21, 0, 64 * 1024, 2048, SECT_4K | USE_FSR | SPI_NOR_QUAD_READ | NO_CHIP_ERASE) }, { INFO("n25q00a", 0x20bb21, 0, 64 * 1024, 2048, SECT_4K | USE_FSR | SPI_NOR_QUAD_READ | NO_CHIP_ERASE) }, { INFO("mt25qu02g", 0x20bb22, 0, 64 * 1024, 4096, SECT_4K | USE_FSR | SPI_NOR_QUAD_READ | NO_CHIP_ERASE) }, - { INFO("mt35xu512aba", 0x2c5b1a, 0, 128 * 1024, 512, USE_FSR | SPI_NOR_OCTAL_READ | SPI_NOR_4B_OPCODES) }, + { INFO("mt35xu512aba", 0x2c5b1a, 0, 128 * 1024, 512, USE_FSR | SPI_NOR_OCTAL_READ | SPI_NOR_4B_OPCODES | SPI_NOR_OCTAL_DTR_READ) + .fixups = &mt35xu512aba_fixups }, { INFO("mt35xu02g", 0x2c5b1c, 0, 128 * 1024, 2048, USE_FSR | SPI_NOR_OCTAL_READ | SPI_NOR_4B_OPCODES) }, #endif #ifdef CONFIG_SPI_FLASH_SPANSION /* SPANSION */
include/linux/mtd/spi-nor.h +8 -2
@@ -124,8 +124,14 @@#define SPINOR_OP_CLSR 0x30/* Clear status register 1 */ /* Used for Micron flashes only. */ -#define SPINOR_OP_RD_EVCR 0x65/* Read EVCR register */ -#define SPINOR_OP_WD_EVCR 0x61/* Write EVCR register */ +#define SPINOR_OP_RD_EVCR 0x65/* Read EVCR register */ +#define SPINOR_OP_WD_EVCR 0x61/* Write EVCR register */ +#define SPINOR_OP_MT_DTR_RD 0xfd/* Fast Read opcode in DTR mode */ +#define SPINOR_OP_MT_RD_ANY_REG 0x85/* Read volatile register */ +#define SPINOR_OP_MT_WR_ANY_REG 0x81/* Write volatile register */ +#define SPINOR_REG_MT_CFR0V 0x00/* For setting octal DTR mode */ +#define SPINOR_REG_MT_CFR1V 0x01/* For setting dummy cycles */ +#define SPINOR_MT_DTR_NO_DQS 0xc7/* Enable Octal DTR without DQS. */ /* Status Register bits. */ #define SR_WIP BIT(0)/* Write in progress */
Signature · 1 line
2.26.2