sf: Remove non-meaningful comments
[oweals/u-boot.git] / drivers / mtd / spi / spi_flash.c
index e72abb97ac9b66a279ceb8be96063f3a6cc2b941..813f08dca451e4f29d24a3f438a5a94dfec33f7b 100644 (file)
@@ -16,6 +16,7 @@
 #include <spi.h>
 #include <spi_flash.h>
 #include <linux/log2.h>
+#include <dma.h>
 
 #include "sf_internal.h"
 
@@ -164,7 +165,8 @@ bar_end:
        return flash->bank_curr;
 }
 
-static int spi_flash_read_bar(struct spi_flash *flash, u8 idcode0)
+static int spi_flash_read_bar(struct spi_flash *flash,
+                             const struct spi_flash_info *info)
 {
        u8 curr_bank = 0;
        int ret;
@@ -172,7 +174,7 @@ static int spi_flash_read_bar(struct spi_flash *flash, u8 idcode0)
        if (flash->size <= SPI_FLASH_16MB_BOUN)
                goto bar_end;
 
-       switch (idcode0) {
+       switch (JEDEC_MFR(info)) {
        case SPI_FLASH_CFI_MFR_SPANSION:
                flash->bank_read_cmd = CMD_BANKADDR_BRRD;
                flash->bank_write_cmd = CMD_BANKADDR_BRWR;
@@ -264,7 +266,8 @@ static int spi_flash_ready(struct spi_flash *flash)
 static int spi_flash_cmd_wait_ready(struct spi_flash *flash,
                                        unsigned long timeout)
 {
-       int timebase, ret;
+       unsigned long timebase;
+       int ret;
 
        timebase = get_timer(0);
 
@@ -454,8 +457,16 @@ int spi_flash_read_common(struct spi_flash *flash, const u8 *cmd,
        return ret;
 }
 
+/*
+ * TODO: remove the weak after all the other spi_flash_copy_mmap
+ * implementations removed from drivers
+ */
 void __weak spi_flash_copy_mmap(void *data, void *offset, size_t len)
 {
+#ifdef CONFIG_DMA
+       if (!dma_memcpy(data, offset, len))
+               return;
+#endif
        memcpy(data, offset, len);
 }
 
@@ -656,7 +667,7 @@ int sst_write_bp(struct spi_flash *flash, u32 offset, size_t len,
 
 #if defined(CONFIG_SPI_FLASH_STMICRO) || defined(CONFIG_SPI_FLASH_SST)
 static void stm_get_locked_range(struct spi_flash *flash, u8 sr, loff_t *ofs,
-                                u32 *len)
+                                u64 *len)
 {
        u8 mask = SR_BP2 | SR_BP1 | SR_BP0;
        int shift = ffs(mask) - 1;
@@ -676,11 +687,11 @@ static void stm_get_locked_range(struct spi_flash *flash, u8 sr, loff_t *ofs,
 /*
  * Return 1 if the entire region is locked, 0 otherwise
  */
-static int stm_is_locked_sr(struct spi_flash *flash, u32 ofs, u32 len,
+static int stm_is_locked_sr(struct spi_flash *flash, loff_t ofs, u64 len,
                            u8 sr)
 {
        loff_t lock_offs;
-       u32 lock_len;
+       u64 lock_len;
 
        stm_get_locked_range(flash, sr, &lock_offs, &lock_len);
 
@@ -914,9 +925,35 @@ static int micron_quad_enable(struct spi_flash *flash)
 }
 #endif
 
-static int set_quad_mode(struct spi_flash *flash, u8 idcode0)
+static const struct spi_flash_info *spi_flash_read_id(struct spi_flash *flash)
 {
-       switch (idcode0) {
+       int                             tmp;
+       u8                              id[SPI_FLASH_MAX_ID_LEN];
+       const struct spi_flash_info     *info;
+
+       tmp = spi_flash_cmd(flash->spi, CMD_READ_ID, id, SPI_FLASH_MAX_ID_LEN);
+       if (tmp < 0) {
+               printf("SF: error %d reading JEDEC ID\n", tmp);
+               return ERR_PTR(tmp);
+       }
+
+       info = spi_flash_ids;
+       for (; info->name != NULL; info++) {
+               if (info->id_len) {
+                       if (!memcmp(info->id, id, info->id_len))
+                               return info;
+               }
+       }
+
+       printf("SF: unrecognized JEDEC id bytes: %02x, %02x, %02x\n",
+              id[0], id[1], id[2]);
+       return ERR_PTR(-ENODEV);
+}
+
+static int set_quad_mode(struct spi_flash *flash,
+                        const struct spi_flash_info *info)
+{
+       switch (JEDEC_MFR(info)) {
 #ifdef CONFIG_SPI_FLASH_MACRONIX
        case SPI_FLASH_CFI_MFR_MACRONIX:
                return macronix_quad_enable(flash);
@@ -931,7 +968,8 @@ static int set_quad_mode(struct spi_flash *flash, u8 idcode0)
                return micron_quad_enable(flash);
 #endif
        default:
-               printf("SF: Need set QEB func for %02x flash\n", idcode0);
+               printf("SF: Need set QEB func for %02x flash\n",
+                      JEDEC_MFR(info));
                return -1;
        }
 }
@@ -939,14 +977,10 @@ static int set_quad_mode(struct spi_flash *flash, u8 idcode0)
 #if CONFIG_IS_ENABLED(OF_CONTROL)
 int spi_flash_decode_fdt(const void *blob, struct spi_flash *flash)
 {
+#ifdef CONFIG_DM_SPI_FLASH
        fdt_addr_t addr;
        fdt_size_t size;
-       int node;
-
-       /* If there is no node, do nothing */
-       node = fdtdec_next_compatible(blob, 0, COMPAT_GENERIC_SPI_FLASH);
-       if (node < 0)
-               return 0;
+       int node = flash->dev->of_offset;
 
        addr = fdtdec_get_addr_size(blob, node, "memory-map", &size);
        if (addr == FDT_ADDR_T_NONE) {
@@ -959,6 +993,7 @@ int spi_flash_decode_fdt(const void *blob, struct spi_flash *flash)
                return -1;
        }
        flash->memory_map = map_sysmem(addr, size);
+#endif
 
        return 0;
 }
@@ -967,69 +1002,26 @@ int spi_flash_decode_fdt(const void *blob, struct spi_flash *flash)
 int spi_flash_scan(struct spi_flash *flash)
 {
        struct spi_slave *spi = flash->spi;
-       const struct spi_flash_params *params;
-       u16 jedec, ext_jedec;
-       u8 cmd, idcode[5];
-       int ret;
-       static u8 spi_read_cmds_array[] = {
-               CMD_READ_ARRAY_SLOW,
-               CMD_READ_ARRAY_FAST,
-               CMD_READ_DUAL_OUTPUT_FAST,
-               CMD_READ_DUAL_IO_FAST,
-               CMD_READ_QUAD_OUTPUT_FAST,
-               CMD_READ_QUAD_IO_FAST };
-
-       /* Read the ID codes */
-       ret = spi_flash_cmd(spi, CMD_READ_ID, idcode, sizeof(idcode));
-       if (ret) {
-               printf("SF: Failed to get idcodes\n");
-               return -EINVAL;
-       }
-
-#ifdef DEBUG
-       printf("SF: Got idcodes\n");
-       print_buffer(0, idcode, 1, sizeof(idcode), 0);
-#endif
-
-       jedec = idcode[1] << 8 | idcode[2];
-       ext_jedec = idcode[3] << 8 | idcode[4];
-
-       /* Validate params from spi_flash_params table */
-       params = spi_flash_params_table;
-       for (; params->name != NULL; params++) {
-               if ((params->jedec >> 16) == idcode[0]) {
-                       if ((params->jedec & 0xFFFF) == jedec) {
-                               if (params->ext_jedec == 0)
-                                       break;
-                               else if (params->ext_jedec == ext_jedec)
-                                       break;
-                       }
-               }
-       }
+       const struct spi_flash_info *info = NULL;
+       int ret = -1;
 
-       if (!params->name) {
-               printf("SF: Unsupported flash IDs: ");
-               printf("manuf %02x, jedec %04x, ext_jedec %04x\n",
-                      idcode[0], jedec, ext_jedec);
-               return -EPROTONOSUPPORT;
-       }
+       info = spi_flash_read_id(flash);
+       if (IS_ERR_OR_NULL(info))
+               return -ENOENT;
 
        /* Flash powers up read-only, so clear BP# bits */
-       if (idcode[0] == SPI_FLASH_CFI_MFR_ATMEL ||
-           idcode[0] == SPI_FLASH_CFI_MFR_MACRONIX ||
-           idcode[0] == SPI_FLASH_CFI_MFR_SST)
+       if (JEDEC_MFR(info) == SPI_FLASH_CFI_MFR_ATMEL ||
+           JEDEC_MFR(info) == SPI_FLASH_CFI_MFR_MACRONIX ||
+           JEDEC_MFR(info) == SPI_FLASH_CFI_MFR_SST)
                write_sr(flash, 0);
 
-       /* Assign spi data */
-       flash->name = params->name;
+       flash->name = info->name;
        flash->memory_map = spi->memory_map;
        flash->dual_flash = spi->option;
 
-       /* Assign spi flash flags */
-       if (params->flags & SST_WR)
+       if (info->flags & SST_WR)
                flash->flags |= SNOR_F_SST_WR;
 
-       /* Assign spi_flash ops */
 #ifndef CONFIG_DM_SPI_FLASH
        flash->write = spi_flash_cmd_write_ops;
 #if defined(CONFIG_SPI_FLASH_SST)
@@ -1044,52 +1036,46 @@ int spi_flash_scan(struct spi_flash *flash)
        flash->read = spi_flash_cmd_read_ops;
 #endif
 
-       /* lock hooks are flash specific - assign them based on idcode0 */
-       switch (idcode[0]) {
 #if defined(CONFIG_SPI_FLASH_STMICRO) || defined(CONFIG_SPI_FLASH_SST)
-       case SPI_FLASH_CFI_MFR_STMICRO:
-       case SPI_FLASH_CFI_MFR_SST:
+       /* NOR protection support for STmicro/Micron chips and similar */
+       if (JEDEC_MFR(info) == SPI_FLASH_CFI_MFR_STMICRO ||
+           JEDEC_MFR(info) == SPI_FLASH_CFI_MFR_SST) {
                flash->flash_lock = stm_lock;
                flash->flash_unlock = stm_unlock;
                flash->flash_is_locked = stm_is_locked;
-#endif
-               break;
-       default:
-               debug("SF: Lock ops not supported for %02x flash\n", idcode[0]);
        }
+#endif
 
        /* Compute the flash size */
        flash->shift = (flash->dual_flash & SF_DUAL_PARALLEL_FLASH) ? 1 : 0;
+       flash->page_size = info->page_size;
        /*
         * The Spansion S25FL032P and S25FL064P have 256b pages, yet use the
         * 0x4d00 Extended JEDEC code. The rest of the Spansion flashes with
         * the 0x4d00 Extended JEDEC code have 512b pages. All of the others
         * have 256b pages.
         */
-       if (ext_jedec == 0x4d00) {
-               if ((jedec == 0x0215) || (jedec == 0x216))
-                       flash->page_size = 256;
-               else
+       if (JEDEC_EXT(info) == 0x4d00) {
+               if ((JEDEC_ID(info) != 0x0215) &&
+                   (JEDEC_ID(info) != 0x0216))
                        flash->page_size = 512;
-       } else {
-               flash->page_size = 256;
        }
        flash->page_size <<= flash->shift;
-       flash->sector_size = params->sector_size << flash->shift;
-       flash->size = flash->sector_size * params->nr_sectors << flash->shift;
+       flash->sector_size = info->sector_size << flash->shift;
+       flash->size = flash->sector_size * info->n_sectors << flash->shift;
 #ifdef CONFIG_SF_DUAL_FLASH
        if (flash->dual_flash & SF_DUAL_STACKED_FLASH)
                flash->size <<= 1;
 #endif
 
+#ifdef CONFIG_SPI_FLASH_USE_4K_SECTORS
        /* Compute erase sector and command */
-       if (params->flags & SECT_4K) {
+       if (info->flags & SECT_4K) {
                flash->erase_cmd = CMD_ERASE_4K;
                flash->erase_size = 4096 << flash->shift;
-       } else if (params->flags & SECT_32K) {
-               flash->erase_cmd = CMD_ERASE_32K;
-               flash->erase_size = 32768 << flash->shift;
-       } else {
+       } else
+#endif
+       {
                flash->erase_cmd = CMD_ERASE_64K;
                flash->erase_size = flash->sector_size;
        }
@@ -1097,18 +1083,17 @@ int spi_flash_scan(struct spi_flash *flash)
        /* Now erase size becomes valid sector size */
        flash->sector_size = flash->erase_size;
 
-       /* Look for the fastest read cmd */
-       cmd = fls(params->e_rd_cmd & spi->op_mode_rx);
-       if (cmd) {
-               cmd = spi_read_cmds_array[cmd - 1];
-               flash->read_cmd = cmd;
-       } else {
-               /* Go for default supported read cmd */
-               flash->read_cmd = CMD_READ_ARRAY_FAST;
-       }
-
-       /* Not require to look for fastest only two write cmds yet */
-       if (params->flags & WR_QPP && spi->mode & SPI_TX_QUAD)
+       /* Look for read commands */
+       flash->read_cmd = CMD_READ_ARRAY_FAST;
+       if (spi->mode & SPI_RX_SLOW)
+               flash->read_cmd = CMD_READ_ARRAY_SLOW;
+       else if (spi->mode & SPI_RX_QUAD && info->flags & RD_QUAD)
+               flash->read_cmd = CMD_READ_QUAD_OUTPUT_FAST;
+       else if (spi->mode & SPI_RX_DUAL && info->flags & RD_DUAL)
+               flash->read_cmd = CMD_READ_DUAL_OUTPUT_FAST;
+
+       /* Look for write commands */
+       if (info->flags & WR_QPP && spi->mode & SPI_TX_QUAD)
                flash->write_cmd = CMD_QUAD_PAGE_PROGRAM;
        else
                /* Go for default supported write cmd */
@@ -1118,9 +1103,10 @@ int spi_flash_scan(struct spi_flash *flash)
        if ((flash->read_cmd == CMD_READ_QUAD_OUTPUT_FAST) ||
            (flash->read_cmd == CMD_READ_QUAD_IO_FAST) ||
            (flash->write_cmd == CMD_QUAD_PAGE_PROGRAM)) {
-               ret = set_quad_mode(flash, idcode[0]);
+               ret = set_quad_mode(flash, info);
                if (ret) {
-                       debug("SF: Fail to set QEB for %02x\n", idcode[0]);
+                       debug("SF: Fail to set QEB for %02x\n",
+                             JEDEC_MFR(info));
                        return -EINVAL;
                }
        }
@@ -1145,13 +1131,13 @@ int spi_flash_scan(struct spi_flash *flash)
        }
 
 #ifdef CONFIG_SPI_FLASH_STMICRO
-       if (params->flags & E_FSR)
+       if (info->flags & E_FSR)
                flash->flags |= SNOR_F_USE_FSR;
 #endif
 
        /* Configure the BAR - discover bank cmds and read current bank */
 #ifdef CONFIG_SPI_FLASH_BAR
-       ret = spi_flash_read_bar(flash, idcode[0]);
+       ret = spi_flash_read_bar(flash, info);
        if (ret < 0)
                return ret;
 #endif