drivers/mtd/spi/sf_probe.c

   1 /*
   2  * SPI flash probing
   3  *
   4  * Copyright (C) 2008 Atmel Corporation
   5  * Copyright (C) 2010 Reinhard Meyer, EMK Elektronik
   6  * Copyright (C) 2013 Jagannadha Sutradharudu Teki, Xilinx Inc.
   7  *
   8  * SPDX-License-Identifier:     GPL-2.0+
   9  */
  10
  11 #include <common.h>
  12 #include <fdtdec.h>
  13 #include <malloc.h>
  14 #include <spi.h>
  15 #include <spi_flash.h>
  16
  17 #include "sf_internal.h"
  18
  19 DECLARE_GLOBAL_DATA_PTR;
  20
  21 /**
  22  * struct spi_flash_params - SPI/QSPI flash device params structure
  23  *
  24  * @name:               Device name ([MANUFLETTER][DEVTYPE][DENSITY][EXTRAINFO])
  25  * @jedec:              Device jedec ID (0x[1byte_manuf_id][2byte_dev_id])
  26  * @ext_jedec:          Device ext_jedec ID
  27  * @sector_size:        Sector size of this device
  28  * @nr_sectors:         No.of sectors on this device
  29  * @flags:              Importent param, for flash specific behaviour
  30  */
  31 struct spi_flash_params {
  32         const char *name;
  33         u32 jedec;
  34         u16 ext_jedec;
  35         u32 sector_size;
  36         u32 nr_sectors;
  37         u16 flags;
  38 };
  39
  40 static const struct spi_flash_params spi_flash_params_table[] = {
  41 #ifdef CONFIG_SPI_FLASH_ATMEL           /* ATMEL */
  42         {"AT45DB011D",     0x1f2200, 0x0,       64 * 1024,     4,              SECT_4K},
  43         {"AT45DB021D",     0x1f2300, 0x0,       64 * 1024,     8,              SECT_4K},
  44         {"AT45DB041D",     0x1f2400, 0x0,       64 * 1024,     8,              SECT_4K},
  45         {"AT45DB081D",     0x1f2500, 0x0,       64 * 1024,    16,              SECT_4K},
  46         {"AT45DB161D",     0x1f2600, 0x0,       64 * 1024,    32,              SECT_4K},
  47         {"AT45DB321D",     0x1f2700, 0x0,       64 * 1024,    64,              SECT_4K},
  48         {"AT45DB641D",     0x1f2800, 0x0,       64 * 1024,   128,              SECT_4K},
  49         {"AT25DF321",      0x1f4701, 0x0,       64 * 1024,    64,              SECT_4K},
  50 #endif
  51 #ifdef CONFIG_SPI_FLASH_EON             /* EON */
  52         {"EN25Q32B",       0x1c3016, 0x0,       64 * 1024,    64,                    0},
  53         {"EN25Q64",        0x1c3017, 0x0,       64 * 1024,   128,              SECT_4K},
  54         {"EN25Q128B",      0x1c3018, 0x0,       64 * 1024,   256,                    0},
  55         {"EN25S64",        0x1c3817, 0x0,       64 * 1024,   128,                    0},
  56 #endif
  57 #ifdef CONFIG_SPI_FLASH_GIGADEVICE      /* GIGADEVICE */
  58         {"GD25Q64B",       0xc84017, 0x0,       64 * 1024,   128,              SECT_4K},
  59         {"GD25LQ32",       0xc86016, 0x0,       64 * 1024,    64,              SECT_4K},
  60 #endif
  61 #ifdef CONFIG_SPI_FLASH_MACRONIX        /* MACRONIX */
  62         {"MX25L4005",      0xc22013, 0x0,       64 * 1024,     8,                    0},
  63         {"MX25L8005",      0xc22014, 0x0,       64 * 1024,    16,                    0},
  64         {"MX25L1605D",     0xc22015, 0x0,       64 * 1024,    32,                    0},
  65         {"MX25L3205D",     0xc22016, 0x0,       64 * 1024,    64,                    0},
  66         {"MX25L6405D",     0xc22017, 0x0,       64 * 1024,   128,                    0},
  67         {"MX25L12805",     0xc22018, 0x0,       64 * 1024,   256,                    0},
  68         {"MX25L25635F",    0xc22019, 0x0,       64 * 1024,   512,                    0},
  69         {"MX25L51235F",    0xc2201A, 0x0,       64 * 1024,  1024,                    0},
  70         {"MX25L12855E",    0xc22618, 0x0,       64 * 1024,   256,                    0},
  71 #endif
  72 #ifdef CONFIG_SPI_FLASH_SPANSION        /* SPANSION */
  73         {"S25FL008A",      0x010213, 0x0,       64 * 1024,    16,                    0},
  74         {"S25FL016A",      0x010214, 0x0,       64 * 1024,    32,                    0},
  75         {"S25FL032A",      0x010215, 0x0,       64 * 1024,    64,                    0},
  76         {"S25FL064A",      0x010216, 0x0,       64 * 1024,   128,                    0},
  77         {"S25FL128P_256K", 0x012018, 0x0300,   256 * 1024,    64,                    0},
  78         {"S25FL128P_64K",  0x012018, 0x0301,    64 * 1024,   256,                    0},
  79         {"S25FL032P",      0x010215, 0x4d00,    64 * 1024,    64,                    0},
  80         {"S25FL064P",      0x010216, 0x4d00,    64 * 1024,   128,                    0},
  81         {"S25FL128S_64K",  0x012018, 0x4d01,    64 * 1024,   256,                    0},
  82         {"S25FL256S_256K", 0x010219, 0x4d00,    64 * 1024,   512,                    0},
  83         {"S25FL256S_64K",  0x010219, 0x4d01,    64 * 1024,   512,                    0},
  84         {"S25FL512S_256K", 0x010220, 0x4d00,    64 * 1024,  1024,                    0},
  85         {"S25FL512S_64K",  0x010220, 0x4d01,    64 * 1024,  1024,                    0},
  86 #endif
  87 #ifdef CONFIG_SPI_FLASH_STMICRO         /* STMICRO */
  88         {"M25P10",         0x202011, 0x0,       32 * 1024,     4,                    0},
  89         {"M25P20",         0x202012, 0x0,       64 * 1024,     4,                    0},
  90         {"M25P40",         0x202013, 0x0,       64 * 1024,     8,                    0},
  91         {"M25P80",         0x202014, 0x0,       64 * 1024,    16,                    0},
  92         {"M25P16",         0x202015, 0x0,       64 * 1024,    32,                    0},
  93         {"M25P32",         0x202016, 0x0,       64 * 1024,    64,                    0},
  94         {"M25P64",         0x202017, 0x0,       64 * 1024,   128,                    0},
  95         {"M25P128",        0x202018, 0x0,      256 * 1024,    64,                    0},
  96         {"N25Q32",         0x20ba16, 0x0,       64 * 1024,    64,              SECT_4K},
  97         {"N25Q32A",        0x20bb16, 0x0,       64 * 1024,    64,              SECT_4K},
  98         {"N25Q64",         0x20ba17, 0x0,       64 * 1024,   128,              SECT_4K},
  99         {"N25Q64A",        0x20bb17, 0x0,       64 * 1024,   128,              SECT_4K},
 100         {"N25Q128",        0x20ba18, 0x0,       64 * 1024,   256,              SECT_4K},
 101         {"N25Q128A",       0x20bb18, 0x0,       64 * 1024,   256,              SECT_4K},
 102         {"N25Q256",        0x20ba19, 0x0,       64 * 1024,   512,              SECT_4K},
 103         {"N25Q256A",       0x20bb19, 0x0,       64 * 1024,   512,              SECT_4K},
 104         {"N25Q512",        0x20ba20, 0x0,       64 * 1024,  1024,      E_FSR | SECT_4K},
 105         {"N25Q512A",       0x20bb20, 0x0,       64 * 1024,  1024,      E_FSR | SECT_4K},
 106         {"N25Q1024",       0x20ba21, 0x0,       64 * 1024,  2048,      E_FSR | SECT_4K},
 107         {"N25Q1024A",      0x20bb21, 0x0,       64 * 1024,  2048,      E_FSR | SECT_4K},
 108 #endif
 109 #ifdef CONFIG_SPI_FLASH_SST             /* SST */
 110         {"SST25VF040B",    0xbf258d, 0x0,       64 * 1024,     8,     SECT_4K | SST_WP},
 111         {"SST25VF080B",    0xbf258e, 0x0,       64 * 1024,    16,     SECT_4K | SST_WP},
 112         {"SST25VF016B",    0xbf2541, 0x0,       64 * 1024,    32,     SECT_4K | SST_WP},
 113         {"SST25VF032B",    0xbf254a, 0x0,       64 * 1024,    64,     SECT_4K | SST_WP},
 114         {"SST25VF064C",    0xbf254b, 0x0,       64 * 1024,   128,              SECT_4K},
 115         {"SST25WF512",     0xbf2501, 0x0,       64 * 1024,     1,     SECT_4K | SST_WP},
 116         {"SST25WF010",     0xbf2502, 0x0,       64 * 1024,     2,     SECT_4K | SST_WP},
 117         {"SST25WF020",     0xbf2503, 0x0,       64 * 1024,     4,     SECT_4K | SST_WP},
 118         {"SST25WF040",     0xbf2504, 0x0,       64 * 1024,     8,     SECT_4K | SST_WP},
 119         {"SST25WF080",     0xbf2505, 0x0,       64 * 1024,    16,     SECT_4K | SST_WP},
 120 #endif
 121 #ifdef CONFIG_SPI_FLASH_WINBOND         /* WINBOND */
 122         {"W25P80",         0xef2014, 0x0,       64 * 1024,    16,                   0},
 123         {"W25P16",         0xef2015, 0x0,       64 * 1024,    32,                   0},
 124         {"W25P32",         0xef2016, 0x0,       64 * 1024,    64,                   0},
 125         {"W25X40",         0xef3013, 0x0,       64 * 1024,     8,             SECT_4K},
 126         {"W25X16",         0xef3015, 0x0,       64 * 1024,    32,             SECT_4K},
 127         {"W25X32",         0xef3016, 0x0,       64 * 1024,    64,             SECT_4K},
 128         {"W25X64",         0xef3017, 0x0,       64 * 1024,   128,             SECT_4K},
 129         {"W25Q80BL",       0xef4014, 0x0,       64 * 1024,    16,             SECT_4K},
 130         {"W25Q16CL",       0xef4015, 0x0,       64 * 1024,    32,             SECT_4K},
 131         {"W25Q32BV",       0xef4016, 0x0,       64 * 1024,    64,             SECT_4K},
 132         {"W25Q64CV",       0xef4017, 0x0,       64 * 1024,   128,             SECT_4K},
 133         {"W25Q128BV",      0xef4018, 0x0,       64 * 1024,   256,             SECT_4K},
 134         {"W25Q256",        0xef4019, 0x0,       64 * 1024,   512,             SECT_4K},
 135         {"W25Q80BW",       0xef5014, 0x0,       64 * 1024,    16,             SECT_4K},
 136         {"W25Q16DW",       0xef6015, 0x0,       64 * 1024,    32,             SECT_4K},
 137         {"W25Q32DW",       0xef6016, 0x0,       64 * 1024,    64,             SECT_4K},
 138         {"W25Q64DW",       0xef6017, 0x0,       64 * 1024,   128,             SECT_4K},
 139         {"W25Q128FW",      0xef6018, 0x0,       64 * 1024,   256,             SECT_4K},
 140 #endif
 141         /*
 142          * Note:
 143          * Below paired flash devices has similar spi_flash params.
 144          * (S25FL129P_64K, S25FL128S_64K)
 145          * (W25Q80BL, W25Q80BV)
 146          * (W25Q16CL, W25Q16DV)
 147          * (W25Q32BV, W25Q32FV_SPI)
 148          * (W25Q64CV, W25Q64FV_SPI)
 149          * (W25Q128BV, W25Q128FV_SPI)
 150          * (W25Q32DW, W25Q32FV_QPI)
 151          * (W25Q64DW, W25Q64FV_QPI)
 152          * (W25Q128FW, W25Q128FV_QPI)
 153          */
 154 };
 155
 156 static struct spi_flash *spi_flash_validate_params(struct spi_slave *spi,
 157                 u8 *idcode)
 158 {
 159         const struct spi_flash_params *params;
 160         struct spi_flash *flash;
 161         int i;
 162         u16 jedec = idcode[1] << 8 | idcode[2];
 163         u16 ext_jedec = idcode[3] << 8 | idcode[4];
 164
 165         /* Get the flash id (jedec = manuf_id + dev_id, ext_jedec) */
 166         for (i = 0; i < ARRAY_SIZE(spi_flash_params_table); i++) {
 167                 params = &spi_flash_params_table[i];
 168                 if ((params->jedec >> 16) == idcode[0]) {
 169                         if ((params->jedec & 0xFFFF) == jedec) {
 170                                 if (params->ext_jedec == 0)
 171                                         break;
 172                                 else if (params->ext_jedec == ext_jedec)
 173                                         break;
 174                         }
 175                 }
 176         }
 177
 178         if (i == ARRAY_SIZE(spi_flash_params_table)) {
 179                 printf("SF: Unsupported flash IDs: ");
 180                 printf("manuf %02x, jedec %04x, ext_jedec %04x\n",
 181                        idcode[0], jedec, ext_jedec);
 182                 return NULL;
 183         }
 184
 185         flash = malloc(sizeof(*flash));
 186         if (!flash) {
 187                 debug("SF: Failed to allocate spi_flash\n");
 188                 return NULL;
 189         }
 190         memset(flash, '\0', sizeof(*flash));
 191
 192         /* Assign spi data */
 193         flash->spi = spi;
 194         flash->name = params->name;
 195         flash->memory_map = spi->memory_map;
 196
 197         /* Assign spi_flash ops */
 198         flash->write = spi_flash_cmd_write_ops;
 199 #ifdef CONFIG_SPI_FLASH_SST
 200         if (params->flags & SST_WP)
 201                 flash->write = sst_write_wp;
 202 #endif
 203         flash->erase = spi_flash_cmd_erase_ops;
 204         flash->read = spi_flash_cmd_read_ops;
 205
 206         /* Compute the flash size */
 207         flash->page_size = (ext_jedec == 0x4d00) ? 512 : 256;
 208         flash->sector_size = params->sector_size;
 209         flash->size = flash->sector_size * params->nr_sectors;
 210
 211         /* Compute erase sector and command */
 212         if (params->flags & SECT_4K) {
 213                 flash->erase_cmd = CMD_ERASE_4K;
 214                 flash->erase_size = 4096;
 215         } else if (params->flags & SECT_32K) {
 216                 flash->erase_cmd = CMD_ERASE_32K;
 217                 flash->erase_size = 32768;
 218         } else {
 219                 flash->erase_cmd = CMD_ERASE_64K;
 220                 flash->erase_size = flash->sector_size;
 221         }
 222
 223         /* Poll cmd seclection */
 224         flash->poll_cmd = CMD_READ_STATUS;
 225 #ifdef CONFIG_SPI_FLASH_STMICRO
 226         if (params->flags & E_FSR)
 227                 flash->poll_cmd = CMD_FLAG_STATUS;
 228 #endif
 229
 230         /* Configure the BAR - discover bank cmds and read current bank */
 231 #ifdef CONFIG_SPI_FLASH_BAR
 232         u8 curr_bank = 0;
 233         if (flash->size > SPI_FLASH_16MB_BOUN) {
 234                 flash->bank_read_cmd = (idcode[0] == 0x01) ?
 235                                         CMD_BANKADDR_BRRD : CMD_EXTNADDR_RDEAR;
 236                 flash->bank_write_cmd = (idcode[0] == 0x01) ?
 237                                         CMD_BANKADDR_BRWR : CMD_EXTNADDR_WREAR;
 238
 239                 if (spi_flash_read_common(flash, &flash->bank_read_cmd, 1,
 240                                           &curr_bank, 1)) {
 241                         debug("SF: fail to read bank addr register\n");
 242                         return NULL;
 243                 }
 244                 flash->bank_curr = curr_bank;
 245         } else {
 246                 flash->bank_curr = curr_bank;
 247         }
 248 #endif
 249
 250         /* Flash powers up read-only, so clear BP# bits */
 251 #if defined(CONFIG_SPI_FLASH_ATMEL) || \
 252         defined(CONFIG_SPI_FLASH_MACRONIX) || \
 253         defined(CONFIG_SPI_FLASH_SST)
 254                 spi_flash_cmd_write_status(flash, 0);
 255 #endif
 256
 257         return flash;
 258 }
 259
 260 #ifdef CONFIG_OF_CONTROL
 261 int spi_flash_decode_fdt(const void *blob, struct spi_flash *flash)
 262 {
 263         fdt_addr_t addr;
 264         fdt_size_t size;
 265         int node;
 266
 267         /* If there is no node, do nothing */
 268         node = fdtdec_next_compatible(blob, 0, COMPAT_GENERIC_SPI_FLASH);
 269         if (node < 0)
 270                 return 0;
 271
 272         addr = fdtdec_get_addr_size(blob, node, "memory-map", &size);
 273         if (addr == FDT_ADDR_T_NONE) {
 274                 debug("%s: Cannot decode address\n", __func__);
 275                 return 0;
 276         }
 277
 278         if (flash->size != size) {
 279                 debug("%s: Memory map must cover entire device\n", __func__);
 280                 return -1;
 281         }
 282         flash->memory_map = (void *)addr;
 283
 284         return 0;
 285 }
 286 #endif /* CONFIG_OF_CONTROL */
 287
 288 static struct spi_flash *spi_flash_probe_slave(struct spi_slave *spi)
 289 {
 290         struct spi_flash *flash = NULL;
 291         u8 idcode[5];
 292         int ret;
 293
 294         /* Setup spi_slave */
 295         if (!spi) {
 296                 printf("SF: Failed to set up slave\n");
 297                 return NULL;
 298         }
 299
 300         /* Claim spi bus */
 301         ret = spi_claim_bus(spi);
 302         if (ret) {
 303                 debug("SF: Failed to claim SPI bus: %d\n", ret);
 304                 goto err_claim_bus;
 305         }
 306
 307         /* Read the ID codes */
 308         ret = spi_flash_cmd(spi, CMD_READ_ID, idcode, sizeof(idcode));
 309         if (ret) {
 310                 printf("SF: Failed to get idcodes\n");
 311                 goto err_read_id;
 312         }
 313
 314 #ifdef DEBUG
 315         printf("SF: Got idcodes\n");
 316         print_buffer(0, idcode, 1, sizeof(idcode), 0);
 317 #endif
 318
 319         /* Validate params from spi_flash_params table */
 320         flash = spi_flash_validate_params(spi, idcode);
 321         if (!flash)
 322                 goto err_read_id;
 323
 324 #ifdef CONFIG_OF_CONTROL
 325         if (spi_flash_decode_fdt(gd->fdt_blob, flash)) {
 326                 debug("SF: FDT decode error\n");
 327                 goto err_read_id;
 328         }
 329 #endif
 330 #ifndef CONFIG_SPL_BUILD
 331         printf("SF: Detected %s with page size ", flash->name);
 332         print_size(flash->page_size, ", erase size ");
 333         print_size(flash->erase_size, ", total ");
 334         print_size(flash->size, "");
 335         if (flash->memory_map)
 336                 printf(", mapped at %p", flash->memory_map);
 337         puts("\n");
 338 #endif
 339 #ifndef CONFIG_SPI_FLASH_BAR
 340         if (flash->size > SPI_FLASH_16MB_BOUN) {
 341                 puts("SF: Warning - Only lower 16MiB accessible,");
 342                 puts(" Full access #define CONFIG_SPI_FLASH_BAR\n");
 343         }
 344 #endif
 345
 346         /* Release spi bus */
 347         spi_release_bus(spi);
 348
 349         return flash;
 350
 351 err_read_id:
 352         spi_release_bus(spi);
 353 err_claim_bus:
 354         spi_free_slave(spi);
 355         return NULL;
 356 }
 357
 358 struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs,
 359                 unsigned int max_hz, unsigned int spi_mode)
 360 {
 361         struct spi_slave *spi;
 362
 363         spi = spi_setup_slave(bus, cs, max_hz, spi_mode);
 364         return spi_flash_probe_slave(spi);
 365 }
 366
 367 #ifdef CONFIG_OF_SPI_FLASH
 368 struct spi_flash *spi_flash_probe_fdt(const void *blob, int slave_node,
 369                                       int spi_node)
 370 {
 371         struct spi_slave *spi;
 372
 373         spi = spi_setup_slave_fdt(blob, slave_node, spi_node);
 374         return spi_flash_probe_slave(spi);
 375 }
 376 #endif
 377
 378 void spi_flash_free(struct spi_flash *flash)
 379 {
 380         spi_free_slave(flash->spi);
 381         free(flash);
 382 }