git.sur5r.net Git - u-boot/blob - drivers/mtd/spi/spi_flash_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  * Licensed under the GPL-2 or later.
   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 "spi_flash_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  */
  30 struct spi_flash_params {
  31         const char *name;
  32         u32 jedec;
  33         u16 ext_jedec;
  34         u32 sector_size;
  35         u32 nr_sectors;
  36 };
  37
  38 static const struct spi_flash_params spi_flash_params_table[] = {
  39 #ifdef CONFIG_SPI_FLASH_STMICRO         /* STMICRO */
  40         {"M25P10",              0x202011, 0x0,     32 * 1024,      4},
  41         {"M25P20",              0x202012, 0x0,     64 * 1024,      4},
  42         {"M25P40",              0x202013, 0x0,     64 * 1024,      8},
  43         {"M25P80",              0x202014, 0x0,     64 * 1024,     16},
  44         {"M25P16",              0x202015, 0x0,     64 * 1024,     32},
  45         {"M25P32",              0x202016, 0x0,     64 * 1024,     64},
  46         {"M25P64",              0x202017, 0x0,     64 * 1024,    128},
  47         {"M25P128",             0x202018, 0x0,    256 * 1024,     64},
  48         {"N25Q32",              0x20ba16, 0x0,     64 * 1024,     64},
  49         {"N25Q32A",             0x20bb16, 0x0,     64 * 1024,     64},
  50         {"N25Q64",              0x20ba17, 0x0,     64 * 1024,    128},
  51         {"N25Q64A",             0x20bb17, 0x0,     64 * 1024,    128},
  52         {"N25Q128",             0x20ba18, 0x0,     64 * 1024,    256},
  53         {"N25Q128A",            0x20bb18, 0x0,     64 * 1024,    256},
  54         {"N25Q256",             0x20ba19, 0x0,     64 * 1024,    512},
  55         {"N25Q256A",            0x20bb19, 0x0,     64 * 1024,    512},
  56         {"N25Q512",             0x20ba20, 0x0,     64 * 1024,   1024},
  57         {"N25Q512A",            0x20bb20, 0x0,     64 * 1024,   1024},
  58         {"N25Q1024",            0x20ba21, 0x0,     64 * 1024,   2048},
  59         {"N25Q1024A",           0x20bb21, 0x0,     64 * 1024,   2048},
  60 #endif
  61         /*
  62          * TODO:
  63          * ATMEL
  64          * EON
  65          * GIGADEVICE
  66          * MACRONIX
  67          * RAMTRON
  68          * SPANSION
  69          * SST
  70          * WINBOND
  71          */
  72 };
  73
  74 struct spi_flash *spi_flash_validate_ids(struct spi_slave *spi, u8 *idcode)
  75 {
  76         const struct spi_flash_params *params;
  77         struct spi_flash *flash;
  78         int i;
  79         u16 jedec = idcode[1] << 8 | idcode[2];
  80
  81         /* Get the flash id (jedec = manuf_id + dev_id) */
  82         for (i = 0; i < ARRAY_SIZE(spi_flash_params_table); i++) {
  83                 params = &spi_flash_params_table[i];
  84                 if ((params->jedec >> 16) == idcode[0]) {
  85                         if ((params->jedec & 0xFFFF) == jedec)
  86                                 break;
  87                 }
  88         }
  89
  90         if (i == ARRAY_SIZE(spi_flash_params_table)) {
  91                 printf("SF: Unsupported flash ID: manuf %02x, jedec %04x\n",
  92                        idcode[0], jedec);
  93                 return NULL;
  94         }
  95
  96         flash = malloc(sizeof(*flash));
  97         if (!flash) {
  98                 debug("SF: Failed to allocate spi_flash\n");
  99                 return NULL;
 100         }
 101         memset(flash, '\0', sizeof(*flash));
 102
 103         flash->spi = spi;
 104         flash->name = params->name;
 105         flash->poll_cmd = CMD_READ_STATUS;
 106
 107         /* Assign spi_flash ops */
 108         flash->write = spi_flash_cmd_write_multi;
 109         flash->erase = spi_flash_cmd_erase;
 110         flash->read = spi_flash_cmd_read_fast;
 111
 112         /* Compute the flash size */
 113         flash->page_size = 256;
 114         flash->sector_size = params->sector_size;
 115         flash->size = flash->sector_size * params->nr_sectors;
 116
 117         return flash;
 118 }
 119
 120 #ifdef CONFIG_SPI_FLASH_BAR
 121 int spi_flash_bank_config(struct spi_flash *flash, u8 idcode0)
 122 {
 123         u8 cmd;
 124         u8 curr_bank = 0;
 125
 126         /* discover bank cmds */
 127         switch (idcode0) {
 128         case SPI_FLASH_SPANSION_IDCODE0:
 129                 flash->bank_read_cmd = CMD_BANKADDR_BRRD;
 130                 flash->bank_write_cmd = CMD_BANKADDR_BRWR;
 131                 break;
 132         case SPI_FLASH_STMICRO_IDCODE0:
 133         case SPI_FLASH_WINBOND_IDCODE0:
 134                 flash->bank_read_cmd = CMD_EXTNADDR_RDEAR;
 135                 flash->bank_write_cmd = CMD_EXTNADDR_WREAR;
 136                 break;
 137         default:
 138                 printf("SF: Unsupported bank commands %02x\n", idcode0);
 139                 return -1;
 140         }
 141
 142         /* read the bank reg - on which bank the flash is in currently */
 143         cmd = flash->bank_read_cmd;
 144         if (flash->size > SPI_FLASH_16MB_BOUN) {
 145                 if (spi_flash_read_common(flash, &cmd, 1, &curr_bank, 1)) {
 146                         debug("SF: fail to read bank addr register\n");
 147                         return -1;
 148                 }
 149                 flash->bank_curr = curr_bank;
 150         } else {
 151                 flash->bank_curr = curr_bank;
 152         }
 153
 154         return 0;
 155 }
 156 #endif
 157
 158 #ifdef CONFIG_OF_CONTROL
 159 int spi_flash_decode_fdt(const void *blob, struct spi_flash *flash)
 160 {
 161         fdt_addr_t addr;
 162         fdt_size_t size;
 163         int node;
 164
 165         /* If there is no node, do nothing */
 166         node = fdtdec_next_compatible(blob, 0, COMPAT_GENERIC_SPI_FLASH);
 167         if (node < 0)
 168                 return 0;
 169
 170         addr = fdtdec_get_addr_size(blob, node, "memory-map", &size);
 171         if (addr == FDT_ADDR_T_NONE) {
 172                 debug("%s: Cannot decode address\n", __func__);
 173                 return 0;
 174         }
 175
 176         if (flash->size != size) {
 177                 debug("%s: Memory map must cover entire device\n", __func__);
 178                 return -1;
 179         }
 180         flash->memory_map = (void *)addr;
 181
 182         return 0;
 183 }
 184 #endif /* CONFIG_OF_CONTROL */
 185
 186 struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs,
 187                 unsigned int max_hz, unsigned int spi_mode)
 188 {
 189         struct spi_slave *spi;
 190         struct spi_flash *flash = NULL;
 191         u8 idcode[5], *idp;
 192         int ret;
 193
 194         /* Setup spi_slave */
 195         spi = spi_setup_slave(bus, cs, max_hz, spi_mode);
 196         if (!spi) {
 197                 printf("SF: Failed to set up slave\n");
 198                 return NULL;
 199         }
 200
 201         /* Claim spi bus */
 202         ret = spi_claim_bus(spi);
 203         if (ret) {
 204                 debug("SF: Failed to claim SPI bus: %d\n", ret);
 205                 goto err_claim_bus;
 206         }
 207
 208         /* Read the ID codes */
 209         ret = spi_flash_cmd(spi, CMD_READ_ID, idcode, sizeof(idcode));
 210         if (ret) {
 211                 printf("SF: Failed to get idcodes\n");
 212                 goto err_read_id;
 213         }
 214
 215 #ifdef DEBUG
 216         printf("SF: Got idcodes\n");
 217         print_buffer(0, idcode, 1, sizeof(idcode), 0);
 218 #endif
 219
 220         /* Validate ID's from flash dev table */
 221         idp = idcode;
 222         flash = spi_flash_validate_ids(spi, idp);
 223         if (!flash)
 224                 goto err_read_id;
 225
 226 #ifdef CONFIG_SPI_FLASH_BAR
 227         /* Configure the BAR - discover bank cmds and read current bank  */
 228         ret = spi_flash_bank_config(flash, *idp);
 229         if (ret < 0)
 230                 goto err_read_id;
 231 #endif
 232
 233 #ifdef CONFIG_OF_CONTROL
 234         if (spi_flash_decode_fdt(gd->fdt_blob, flash)) {
 235                 debug("SF: FDT decode error\n");
 236                 goto err_read_id;
 237         }
 238 #endif
 239 #ifndef CONFIG_SPL_BUILD
 240         printf("SF: Detected %s with page size ", flash->name);
 241         print_size(flash->sector_size, ", total ");
 242         print_size(flash->size, "");
 243         if (flash->memory_map)
 244                 printf(", mapped at %p", flash->memory_map);
 245         puts("\n");
 246 #endif
 247 #ifndef CONFIG_SPI_FLASH_BAR
 248         if (flash->size > SPI_FLASH_16MB_BOUN) {
 249                 puts("SF: Warning - Only lower 16MiB accessible,");
 250                 puts(" Full access #define CONFIG_SPI_FLASH_BAR\n");
 251         }
 252 #endif
 253
 254         /* Release spi bus */
 255         spi_release_bus(spi);
 256
 257         return flash;
 258
 259 err_read_id:
 260         spi_release_bus(spi);
 261 err_claim_bus:
 262         spi_free_slave(spi);
 263         return NULL;
 264 }
 265
 266 void spi_flash_free(struct spi_flash *flash)
 267 {
 268         spi_free_slave(flash->spi);
 269         free(flash);
 270 }