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