Sync Serial Flash Discoverable Parameters (SFDP) parsing support from
Linux. This allows auto detection and configuration of Flash parameters.

Signed-off-by: Vignesh R <vigne...@ti.com>
Tested-by: Simon Goldschmidt <simon.k.r.goldschm...@gmail.com>
Tested-by: Stefan Roese <s...@denx.de>
Tested-by: Horatiu Vultur <horatiu.vul...@microchip.com>
---
 common/spl/Kconfig             |  13 +-
 drivers/mtd/spi/Kconfig        |  14 +-
 drivers/mtd/spi/spi-nor-core.c | 629 ++++++++++++++++++++++++++++++++-
 3 files changed, 649 insertions(+), 7 deletions(-)

diff --git a/common/spl/Kconfig b/common/spl/Kconfig
index 54b0dc34f595..2e1dd2705a62 100644
--- a/common/spl/Kconfig
+++ b/common/spl/Kconfig
@@ -730,13 +730,24 @@ config SPL_SPI_FLASH_SUPPORT
          lines). This enables the drivers in drivers/mtd/spi as part of an
          SPL build. This normally requires SPL_SPI_SUPPORT.
 
+if SPL_SPI_FLASH_SUPPORT
+
+config SPL_SPI_FLASH_SFDP_SUPPORT
+       bool "SFDP table parsing support for SPI NOR flashes"
+       depends on !SPI_FLASH_BAR
+       help
+        Enable support for parsing and auto discovery of parameters for
+        SPI NOR flashes using Serial Flash Discoverable Parameters (SFDP)
+        tables as per JESD216 standard in SPL.
+
 config SPL_SPI_LOAD
        bool "Support loading from SPI flash"
-       depends on SPL_SPI_FLASH_SUPPORT
        help
          Enable support for loading next stage, U-Boot or otherwise, from
          SPI NOR in U-Boot SPL.
 
+endif # SPL_SPI_FLASH_SUPPORT
+
 config SPL_SPI_SUPPORT
        bool "Support SPI drivers"
        help
diff --git a/drivers/mtd/spi/Kconfig b/drivers/mtd/spi/Kconfig
index 76d5a1d11527..4ba95d58b371 100644
--- a/drivers/mtd/spi/Kconfig
+++ b/drivers/mtd/spi/Kconfig
@@ -34,9 +34,18 @@ config SPI_FLASH
 
          If unsure, say N
 
+if SPI_FLASH
+
+config SPI_FLASH_SFDP_SUPPORT
+       bool "SFDP table parsing support for SPI NOR flashes"
+       depends on !SPI_FLASH_BAR
+       help
+        Enable support for parsing and auto discovery of parameters for
+        SPI NOR flashes using Serial Flash Discoverable Parameters (SFDP)
+        tables as per JESD216 standard.
+
 config SPI_FLASH_BAR
        bool "SPI flash Bank/Extended address register support"
-       depends on SPI_FLASH
        help
          Enable the SPI flash Bank/Extended address register support.
          Bank/Extended address registers are used to access the flash
@@ -44,13 +53,10 @@ config SPI_FLASH_BAR
 
 config SF_DUAL_FLASH
        bool "SPI DUAL flash memory support"
-       depends on SPI_FLASH
        help
          Enable this option to support two flash memories connected to a single
          controller. Currently Xilinx Zynq qspi supports this.
 
-if SPI_FLASH
-
 config SPI_FLASH_ATMEL
        bool "Atmel SPI flash support"
        help
diff --git a/drivers/mtd/spi/spi-nor-core.c b/drivers/mtd/spi/spi-nor-core.c
index 570383464193..97ec8e8e7a19 100644
--- a/drivers/mtd/spi/spi-nor-core.c
+++ b/drivers/mtd/spi/spi-nor-core.c
@@ -81,6 +81,7 @@ struct flash_info {
                                         * to support memory size above 128Mib.
                                         */
 #define NO_CHIP_ERASE          BIT(12) /* Chip does not support chip erase */
+#define SPI_NOR_SKIP_SFDP      BIT(13) /* Skip parsing of SFDP tables */
 #define USE_CLSR               BIT(14) /* use CLSR command */
 
        int     (*quad_enable)(struct spi_nor *nor);
@@ -1411,6 +1412,39 @@ static int spansion_read_cr_quad_enable(struct spi_nor 
*nor)
 
        return 0;
 }
+
+#if CONFIG_IS_ENABLED(SPI_FLASH_SFDP_SUPPORT)
+/**
+ * spansion_no_read_cr_quad_enable() - set QE bit in Configuration Register.
+ * @nor:       pointer to a 'struct spi_nor'
+ *
+ * Set the Quad Enable (QE) bit in the Configuration Register.
+ * This function should be used with QSPI memories not supporting the Read
+ * Configuration Register (35h) instruction.
+ *
+ * bit 1 of the Configuration Register is the QE bit for Spansion like QSPI
+ * memories.
+ *
+ * Return: 0 on success, -errno otherwise.
+ */
+static int spansion_no_read_cr_quad_enable(struct spi_nor *nor)
+{
+       u8 sr_cr[2];
+       int ret;
+
+       /* Keep the current value of the Status Register. */
+       ret = read_sr(nor);
+       if (ret < 0) {
+               dev_dbg(nor->dev, "error while reading status register\n");
+               return -EINVAL;
+       }
+       sr_cr[0] = ret;
+       sr_cr[1] = CR_QUAD_EN_SPAN;
+
+       return write_sr_cr(nor, sr_cr);
+}
+
+#endif /* CONFIG_SPI_FLASH_SFDP_SUPPORT */
 #endif /* CONFIG_SPI_FLASH_SPANSION */
 
 struct spi_nor_read_command {
@@ -1500,6 +1534,573 @@ spi_nor_set_pp_settings(struct spi_nor_pp_command *pp,
        pp->proto = proto;
 }
 
+#if CONFIG_IS_ENABLED(SPI_FLASH_SFDP_SUPPORT)
+/*
+ * Serial Flash Discoverable Parameters (SFDP) parsing.
+ */
+
+/**
+ * spi_nor_read_sfdp() - read Serial Flash Discoverable Parameters.
+ * @nor:       pointer to a 'struct spi_nor'
+ * @addr:      offset in the SFDP area to start reading data from
+ * @len:       number of bytes to read
+ * @buf:       buffer where the SFDP data are copied into (dma-safe memory)
+ *
+ * Whatever the actual numbers of bytes for address and dummy cycles are
+ * for (Fast) Read commands, the Read SFDP (5Ah) instruction is always
+ * followed by a 3-byte address and 8 dummy clock cycles.
+ *
+ * Return: 0 on success, -errno otherwise.
+ */
+static int spi_nor_read_sfdp(struct spi_nor *nor, u32 addr,
+                            size_t len, void *buf)
+{
+       u8 addr_width, read_opcode, read_dummy;
+       int ret;
+
+       read_opcode = nor->read_opcode;
+       addr_width = nor->addr_width;
+       read_dummy = nor->read_dummy;
+
+       nor->read_opcode = SPINOR_OP_RDSFDP;
+       nor->addr_width = 3;
+       nor->read_dummy = 8;
+
+       while (len) {
+               ret = nor->read(nor, addr, len, (u8 *)buf);
+               if (!ret || ret > len) {
+                       ret = -EIO;
+                       goto read_err;
+               }
+               if (ret < 0)
+                       goto read_err;
+
+               buf += ret;
+               addr += ret;
+               len -= ret;
+       }
+       ret = 0;
+
+read_err:
+       nor->read_opcode = read_opcode;
+       nor->addr_width = addr_width;
+       nor->read_dummy = read_dummy;
+
+       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_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
+spi_nor_set_read_settings_from_bfpt(struct spi_nor_read_command *read,
+                                   u16 half,
+                                   enum spi_nor_protocol proto)
+{
+       read->num_mode_clocks = (half >> 5) & 0x07;
+       read->num_wait_states = (half >> 0) & 0x1f;
+       read->opcode = (half >> 8) & 0xff;
+       read->proto = proto;
+}
+
+struct sfdp_bfpt_read {
+       /* The Fast Read x-y-z hardware capability in params->hwcaps.mask. */
+       u32                     hwcaps;
+
+       /*
+        * The <supported_bit> bit in <supported_dword> BFPT DWORD tells us
+        * whether the Fast Read x-y-z command is supported.
+        */
+       u32                     supported_dword;
+       u32                     supported_bit;
+
+       /*
+        * The half-word at offset <setting_shift> in <setting_dword> BFPT DWORD
+        * encodes the op code, the number of mode clocks and the number of wait
+        * states to be used by Fast Read x-y-z command.
+        */
+       u32                     settings_dword;
+       u32                     settings_shift;
+
+       /* The SPI protocol for this Fast Read x-y-z command. */
+       enum spi_nor_protocol   proto;
+};
+
+static const struct sfdp_bfpt_read sfdp_bfpt_reads[] = {
+       /* Fast Read 1-1-2 */
+       {
+               SNOR_HWCAPS_READ_1_1_2,
+               BFPT_DWORD(1), BIT(16), /* Supported bit */
+               BFPT_DWORD(4), 0,       /* Settings */
+               SNOR_PROTO_1_1_2,
+       },
+
+       /* Fast Read 1-2-2 */
+       {
+               SNOR_HWCAPS_READ_1_2_2,
+               BFPT_DWORD(1), BIT(20), /* Supported bit */
+               BFPT_DWORD(4), 16,      /* Settings */
+               SNOR_PROTO_1_2_2,
+       },
+
+       /* Fast Read 2-2-2 */
+       {
+               SNOR_HWCAPS_READ_2_2_2,
+               BFPT_DWORD(5),  BIT(0), /* Supported bit */
+               BFPT_DWORD(6), 16,      /* Settings */
+               SNOR_PROTO_2_2_2,
+       },
+
+       /* Fast Read 1-1-4 */
+       {
+               SNOR_HWCAPS_READ_1_1_4,
+               BFPT_DWORD(1), BIT(22), /* Supported bit */
+               BFPT_DWORD(3), 16,      /* Settings */
+               SNOR_PROTO_1_1_4,
+       },
+
+       /* Fast Read 1-4-4 */
+       {
+               SNOR_HWCAPS_READ_1_4_4,
+               BFPT_DWORD(1), BIT(21), /* Supported bit */
+               BFPT_DWORD(3), 0,       /* Settings */
+               SNOR_PROTO_1_4_4,
+       },
+
+       /* Fast Read 4-4-4 */
+       {
+               SNOR_HWCAPS_READ_4_4_4,
+               BFPT_DWORD(5), BIT(4),  /* Supported bit */
+               BFPT_DWORD(7), 16,      /* Settings */
+               SNOR_PROTO_4_4_4,
+       },
+};
+
+struct sfdp_bfpt_erase {
+       /*
+        * The half-word at offset <shift> in DWORD <dwoard> encodes the
+        * op code and erase sector size to be used by Sector Erase commands.
+        */
+       u32                     dword;
+       u32                     shift;
+};
+
+static const struct sfdp_bfpt_erase sfdp_bfpt_erases[] = {
+       /* Erase Type 1 in DWORD8 bits[15:0] */
+       {BFPT_DWORD(8), 0},
+
+       /* Erase Type 2 in DWORD8 bits[31:16] */
+       {BFPT_DWORD(8), 16},
+
+       /* Erase Type 3 in DWORD9 bits[15:0] */
+       {BFPT_DWORD(9), 0},
+
+       /* Erase Type 4 in DWORD9 bits[31:16] */
+       {BFPT_DWORD(9), 16},
+};
+
+static int spi_nor_hwcaps_read2cmd(u32 hwcaps);
+
+/**
+ * spi_nor_parse_bfpt() - read and parse the Basic Flash Parameter Table.
+ * @nor:               pointer to a 'struct spi_nor'
+ * @bfpt_header:       pointer to the 'struct sfdp_parameter_header' describing
+ *                     the Basic Flash Parameter Table length and version
+ * @params:            pointer to the 'struct spi_nor_flash_parameter' to be
+ *                     filled
+ *
+ * The Basic Flash Parameter Table is the main and only mandatory table as
+ * defined by the SFDP (JESD216) specification.
+ * It provides us with the total size (memory density) of the data array and
+ * the number of address bytes for Fast Read, Page Program and Sector Erase
+ * commands.
+ * For Fast READ commands, it also gives the number of mode clock cycles and
+ * wait states (regrouped in the number of dummy clock cycles) for each
+ * supported instruction op code.
+ * For Page Program, the page size is now available since JESD216 rev A, 
however
+ * the supported instruction op codes are still not provided.
+ * For Sector Erase commands, this table stores the supported instruction op
+ * codes and the associated sector sizes.
+ * Finally, the Quad Enable Requirements (QER) are also available since JESD216
+ * rev A. The QER bits encode the manufacturer dependent procedure to be
+ * executed to set the Quad Enable (QE) bit in some internal register of the
+ * Quad SPI memory. Indeed the QE bit, when it exists, must be set before
+ * sending any Quad SPI command to the memory. Actually, setting the QE bit
+ * tells the memory to reassign its WP# and HOLD#/RESET# pins to functions IO2
+ * and IO3 hence enabling 4 (Quad) I/O lines.
+ *
+ * Return: 0 on success, -errno otherwise.
+ */
+static int spi_nor_parse_bfpt(struct spi_nor *nor,
+                             const struct sfdp_parameter_header *bfpt_header,
+                             struct spi_nor_flash_parameter *params)
+{
+       struct mtd_info *mtd = &nor->mtd;
+       struct sfdp_bfpt bfpt;
+       size_t len;
+       int i, cmd, err;
+       u32 addr;
+       u16 half;
+
+       /* JESD216 Basic Flash Parameter Table length is at least 9 DWORDs. */
+       if (bfpt_header->length < BFPT_DWORD_MAX_JESD216)
+               return -EINVAL;
+
+       /* Read the Basic Flash Parameter Table. */
+       len = min_t(size_t, sizeof(bfpt),
+                   bfpt_header->length * sizeof(u32));
+       addr = SFDP_PARAM_HEADER_PTP(bfpt_header);
+       memset(&bfpt, 0, sizeof(bfpt));
+       err = spi_nor_read_sfdp(nor,  addr, len, &bfpt);
+       if (err < 0)
+               return err;
+
+       /* Fix endianness of the BFPT DWORDs. */
+       for (i = 0; i < BFPT_DWORD_MAX; i++)
+               bfpt.dwords[i] = le32_to_cpu(bfpt.dwords[i]);
+
+       /* Number of address bytes. */
+       switch (bfpt.dwords[BFPT_DWORD(1)] & BFPT_DWORD1_ADDRESS_BYTES_MASK) {
+       case BFPT_DWORD1_ADDRESS_BYTES_3_ONLY:
+               nor->addr_width = 3;
+               break;
+
+       case BFPT_DWORD1_ADDRESS_BYTES_4_ONLY:
+               nor->addr_width = 4;
+               break;
+
+       default:
+               break;
+       }
+
+       /* Flash Memory Density (in bits). */
+       params->size = bfpt.dwords[BFPT_DWORD(2)];
+       if (params->size & BIT(31)) {
+               params->size &= ~BIT(31);
+
+               /*
+                * Prevent overflows on params->size. Anyway, a NOR of 2^64
+                * bits is unlikely to exist so this error probably means
+                * the BFPT we are reading is corrupted/wrong.
+                */
+               if (params->size > 63)
+                       return -EINVAL;
+
+               params->size = 1ULL << params->size;
+       } else {
+               params->size++;
+       }
+       params->size >>= 3; /* Convert to bytes. */
+
+       /* Fast Read settings. */
+       for (i = 0; i < ARRAY_SIZE(sfdp_bfpt_reads); i++) {
+               const struct sfdp_bfpt_read *rd = &sfdp_bfpt_reads[i];
+               struct spi_nor_read_command *read;
+
+               if (!(bfpt.dwords[rd->supported_dword] & rd->supported_bit)) {
+                       params->hwcaps.mask &= ~rd->hwcaps;
+                       continue;
+               }
+
+               params->hwcaps.mask |= rd->hwcaps;
+               cmd = spi_nor_hwcaps_read2cmd(rd->hwcaps);
+               read = &params->reads[cmd];
+               half = bfpt.dwords[rd->settings_dword] >> rd->settings_shift;
+               spi_nor_set_read_settings_from_bfpt(read, half, rd->proto);
+       }
+
+       /* Sector Erase settings. */
+       for (i = 0; i < ARRAY_SIZE(sfdp_bfpt_erases); i++) {
+               const struct sfdp_bfpt_erase *er = &sfdp_bfpt_erases[i];
+               u32 erasesize;
+               u8 opcode;
+
+               half = bfpt.dwords[er->dword] >> er->shift;
+               erasesize = half & 0xff;
+
+               /* erasesize == 0 means this Erase Type is not supported. */
+               if (!erasesize)
+                       continue;
+
+               erasesize = 1U << erasesize;
+               opcode = (half >> 8) & 0xff;
+#ifdef CONFIG_MTD_SPI_NOR_USE_4K_SECTORS
+               if (erasesize == SZ_4K) {
+                       nor->erase_opcode = opcode;
+                       mtd->erasesize = erasesize;
+                       break;
+               }
+#endif
+               if (!mtd->erasesize || mtd->erasesize < erasesize) {
+                       nor->erase_opcode = opcode;
+                       mtd->erasesize = erasesize;
+               }
+       }
+
+       /* Stop here if not JESD216 rev A or later. */
+       if (bfpt_header->length < BFPT_DWORD_MAX)
+               return 0;
+
+       /* Page size: this field specifies 'N' so the page size = 2^N bytes. */
+       params->page_size = bfpt.dwords[BFPT_DWORD(11)];
+       params->page_size &= BFPT_DWORD11_PAGE_SIZE_MASK;
+       params->page_size >>= BFPT_DWORD11_PAGE_SIZE_SHIFT;
+       params->page_size = 1U << params->page_size;
+
+       /* 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:
+               params->quad_enable = spansion_no_read_cr_quad_enable;
+               break;
+#endif
+#ifdef CONFIG_SPI_FLASH_MACRONIX
+       case BFPT_DWORD15_QER_SR1_BIT6:
+               params->quad_enable = macronix_quad_enable;
+               break;
+#endif
+#if defined(CONFIG_SPI_FLASH_SPANSION) || defined(CONFIG_SPI_FLASH_WINBOND)
+       case BFPT_DWORD15_QER_SR2_BIT1:
+               params->quad_enable = spansion_read_cr_quad_enable;
+               break;
+#endif
+       default:
+               return -EINVAL;
+       }
+
+       return 0;
+}
+
+/**
+ * spi_nor_parse_sfdp() - parse the Serial Flash Discoverable Parameters.
+ * @nor:               pointer to a 'struct spi_nor'
+ * @params:            pointer to the 'struct spi_nor_flash_parameter' to be
+ *                     filled
+ *
+ * The Serial Flash Discoverable Parameters are described by the JEDEC JESD216
+ * specification. This is a standard which tends to supported by almost all
+ * (Q)SPI memory manufacturers. Those hard-coded tables allow us to learn at
+ * runtime the main parameters needed to perform basic SPI flash operations 
such
+ * as Fast Read, Page Program or Sector Erase commands.
+ *
+ * Return: 0 on success, -errno otherwise.
+ */
+static int spi_nor_parse_sfdp(struct spi_nor *nor,
+                             struct spi_nor_flash_parameter *params)
+{
+       const struct sfdp_parameter_header *param_header, *bfpt_header;
+       struct sfdp_parameter_header *param_headers = NULL;
+       struct sfdp_header header;
+       size_t psize;
+       int i, err;
+
+       /* Get the SFDP header. */
+       err = spi_nor_read_sfdp(nor, 0, sizeof(header), &header);
+       if (err < 0)
+               return err;
+
+       /* Check the SFDP header version. */
+       if (le32_to_cpu(header.signature) != SFDP_SIGNATURE ||
+           header.major != SFDP_JESD216_MAJOR)
+               return -EINVAL;
+
+       /*
+        * Verify that the first and only mandatory parameter header is a
+        * Basic Flash Parameter Table header as specified in JESD216.
+        */
+       bfpt_header = &header.bfpt_header;
+       if (SFDP_PARAM_HEADER_ID(bfpt_header) != SFDP_BFPT_ID ||
+           bfpt_header->major != SFDP_JESD216_MAJOR)
+               return -EINVAL;
+
+       /*
+        * Allocate memory then read all parameter headers with a single
+        * Read SFDP command. These parameter headers will actually be parsed
+        * twice: a first time to get the latest revision of the basic flash
+        * parameter table, then a second time to handle the supported optional
+        * tables.
+        * Hence we read the parameter headers once for all to reduce the
+        * processing time. Also we use kmalloc() instead of devm_kmalloc()
+        * because we don't need to keep these parameter headers: the allocated
+        * memory is always released with kfree() before exiting this function.
+        */
+       if (header.nph) {
+               psize = header.nph * sizeof(*param_headers);
+
+               param_headers = kmalloc(psize, GFP_KERNEL);
+               if (!param_headers)
+                       return -ENOMEM;
+
+               err = spi_nor_read_sfdp(nor, sizeof(header),
+                                       psize, param_headers);
+               if (err < 0) {
+                       dev_err(dev, "failed to read SFDP parameter headers\n");
+                       goto exit;
+               }
+       }
+
+       /*
+        * Check other parameter headers to get the latest revision of
+        * the basic flash parameter table.
+        */
+       for (i = 0; i < header.nph; i++) {
+               param_header = &param_headers[i];
+
+               if (SFDP_PARAM_HEADER_ID(param_header) == SFDP_BFPT_ID &&
+                   param_header->major == SFDP_JESD216_MAJOR &&
+                   (param_header->minor > bfpt_header->minor ||
+                    (param_header->minor == bfpt_header->minor &&
+                     param_header->length > bfpt_header->length)))
+                       bfpt_header = param_header;
+       }
+
+       err = spi_nor_parse_bfpt(nor, bfpt_header, params);
+       if (err)
+               goto exit;
+
+       /* Parse other parameter headers. */
+       for (i = 0; i < header.nph; i++) {
+               param_header = &param_headers[i];
+
+               switch (SFDP_PARAM_HEADER_ID(param_header)) {
+               case SFDP_SECTOR_MAP_ID:
+                       dev_info(dev, "non-uniform erase sector maps are not 
supported yet.\n");
+                       break;
+
+               default:
+                       break;
+               }
+
+               if (err)
+                       goto exit;
+       }
+
+exit:
+       kfree(param_headers);
+       return err;
+}
+#else
+static int spi_nor_parse_sfdp(struct spi_nor *nor,
+                             struct spi_nor_flash_parameter *params)
+{
+       return -EINVAL;
+}
+#endif /* SPI_FLASH_SFDP_SUPPORT */
+
 static int spi_nor_init_params(struct spi_nor *nor,
                               const struct flash_info *info,
                               struct spi_nor_flash_parameter *params)
@@ -1570,6 +2171,24 @@ static int spi_nor_init_params(struct spi_nor *nor,
                        break;
                }
        }
+
+       /* Override the parameters with data read from SFDP tables. */
+       nor->addr_width = 0;
+       nor->mtd.erasesize = 0;
+       if ((info->flags & (SPI_NOR_DUAL_READ | SPI_NOR_QUAD_READ)) &&
+           !(info->flags & SPI_NOR_SKIP_SFDP)) {
+               struct spi_nor_flash_parameter sfdp_params;
+
+               memcpy(&sfdp_params, params, sizeof(sfdp_params));
+               if (spi_nor_parse_sfdp(nor, &sfdp_params)) {
+                       nor->addr_width = 0;
+                       nor->mtd.erasesize = 0;
+               } else {
+                       memcpy(params, &sfdp_params, sizeof(*params));
+               }
+       }
+
+       return 0;
 }
 
 static int spi_nor_hwcaps2cmd(u32 hwcaps, const int table[][2], size_t size)
@@ -1680,6 +2299,10 @@ static int spi_nor_select_erase(struct spi_nor *nor,
 {
        struct mtd_info *mtd = &nor->mtd;
 
+       /* Do nothing if already configured from SFDP. */
+       if (mtd->erasesize)
+               return 0;
+
 #ifdef CONFIG_SPI_FLASH_USE_4K_SECTORS
        /* prefer "small sector" erase if possible */
        if (info->flags & SECT_4K) {
@@ -1840,7 +2463,7 @@ int spi_nor_scan(struct spi_nor *nor)
        info = spi_nor_read_id(nor);
        if (IS_ERR_OR_NULL(info))
                return -ENOENT;
-
+       /* Parse the Serial Flash Discoverable Parameters table. */
        ret = spi_nor_init_params(nor, info, &params);
        if (ret)
                return ret;
@@ -1905,7 +2528,9 @@ int spi_nor_scan(struct spi_nor *nor)
        if (ret)
                return ret;
 
-       if (info->addr_width) {
+       if (nor->addr_width) {
+               /* already configured from SFDP */
+       } else if (info->addr_width) {
                nor->addr_width = info->addr_width;
        } else if (mtd->size > 0x1000000) {
                /* enable 4-byte addressing if the device exceeds 16MiB */
-- 
2.20.1

_______________________________________________
U-Boot mailing list
U-Boot@lists.denx.de
https://lists.denx.de/listinfo/u-boot

Reply via email to