1 /* 2 * SPI flash interface 3 * 4 * Copyright (C) 2008 Atmel Corporation 5 * Copyright (C) 2010 Reinhard Meyer, EMK Elektronik 6 * 7 * Licensed under the GPL-2 or later. 8 */ 9 10 #include <common.h> 11 #include <fdtdec.h> 12 #include <malloc.h> 13 #include <spi.h> 14 #include <spi_flash.h> 15 #include <watchdog.h> 16 17 #include "spi_flash_internal.h" 18 19 DECLARE_GLOBAL_DATA_PTR; 20 21 static void spi_flash_addr(u32 addr, u8 *cmd) 22 { 23 /* cmd[0] is actual command */ 24 cmd[1] = addr >> 16; 25 cmd[2] = addr >> 8; 26 cmd[3] = addr >> 0; 27 } 28 29 static int spi_flash_read_write(struct spi_slave *spi, 30 const u8 *cmd, size_t cmd_len, 31 const u8 *data_out, u8 *data_in, 32 size_t data_len) 33 { 34 unsigned long flags = SPI_XFER_BEGIN; 35 int ret; 36 37 if (data_len == 0) 38 flags |= SPI_XFER_END; 39 40 ret = spi_xfer(spi, cmd_len * 8, cmd, NULL, flags); 41 if (ret) { 42 debug("SF: Failed to send command (%zu bytes): %d\n", 43 cmd_len, ret); 44 } else if (data_len != 0) { 45 ret = spi_xfer(spi, data_len * 8, data_out, data_in, SPI_XFER_END); 46 if (ret) 47 debug("SF: Failed to transfer %zu bytes of data: %d\n", 48 data_len, ret); 49 } 50 51 return ret; 52 } 53 54 int spi_flash_cmd(struct spi_slave *spi, u8 cmd, void *response, size_t len) 55 { 56 return spi_flash_cmd_read(spi, &cmd, 1, response, len); 57 } 58 59 int spi_flash_cmd_read(struct spi_slave *spi, const u8 *cmd, 60 size_t cmd_len, void *data, size_t data_len) 61 { 62 return spi_flash_read_write(spi, cmd, cmd_len, NULL, data, data_len); 63 } 64 65 int spi_flash_cmd_write(struct spi_slave *spi, const u8 *cmd, size_t cmd_len, 66 const void *data, size_t data_len) 67 { 68 return spi_flash_read_write(spi, cmd, cmd_len, data, NULL, data_len); 69 } 70 71 int spi_flash_cmd_write_multi(struct spi_flash *flash, u32 offset, 72 size_t len, const void *buf) 73 { 74 unsigned long page_addr, byte_addr, page_size; 75 size_t chunk_len, actual; 76 int ret; 77 u8 cmd[4]; 78 79 page_size = flash->page_size; 80 page_addr = offset / page_size; 81 byte_addr = offset % page_size; 82 83 ret = spi_claim_bus(flash->spi); 84 if (ret) { 85 debug("SF: unable to claim SPI bus\n"); 86 return ret; 87 } 88 89 cmd[0] = CMD_PAGE_PROGRAM; 90 for (actual = 0; actual < len; actual += chunk_len) { 91 chunk_len = min(len - actual, page_size - byte_addr); 92 93 if (flash->spi->max_write_size) 94 chunk_len = min(chunk_len, flash->spi->max_write_size); 95 96 cmd[1] = page_addr >> 8; 97 cmd[2] = page_addr; 98 cmd[3] = byte_addr; 99 100 debug("PP: 0x%p => cmd = { 0x%02x 0x%02x%02x%02x } chunk_len = %zu\n", 101 buf + actual, cmd[0], cmd[1], cmd[2], cmd[3], chunk_len); 102 103 ret = spi_flash_cmd_write_enable(flash); 104 if (ret < 0) { 105 debug("SF: enabling write failed\n"); 106 break; 107 } 108 109 ret = spi_flash_cmd_write(flash->spi, cmd, 4, 110 buf + actual, chunk_len); 111 if (ret < 0) { 112 debug("SF: write failed\n"); 113 break; 114 } 115 116 ret = spi_flash_cmd_wait_ready(flash, SPI_FLASH_PROG_TIMEOUT); 117 if (ret) 118 break; 119 120 byte_addr += chunk_len; 121 if (byte_addr == page_size) { 122 page_addr++; 123 byte_addr = 0; 124 } 125 } 126 127 debug("SF: program %s %zu bytes @ %#x\n", 128 ret ? "failure" : "success", len, offset); 129 130 spi_release_bus(flash->spi); 131 return ret; 132 } 133 134 int spi_flash_read_common(struct spi_flash *flash, const u8 *cmd, 135 size_t cmd_len, void *data, size_t data_len) 136 { 137 struct spi_slave *spi = flash->spi; 138 int ret; 139 140 spi_claim_bus(spi); 141 ret = spi_flash_cmd_read(spi, cmd, cmd_len, data, data_len); 142 spi_release_bus(spi); 143 144 return ret; 145 } 146 147 int spi_flash_cmd_read_fast(struct spi_flash *flash, u32 offset, 148 size_t len, void *data) 149 { 150 u8 cmd[5]; 151 152 /* Handle memory-mapped SPI */ 153 if (flash->memory_map) { 154 memcpy(data, flash->memory_map + offset, len); 155 return 0; 156 } 157 158 cmd[0] = CMD_READ_ARRAY_FAST; 159 spi_flash_addr(offset, cmd); 160 cmd[4] = 0x00; 161 162 return spi_flash_read_common(flash, cmd, sizeof(cmd), data, len); 163 } 164 165 int spi_flash_cmd_poll_bit(struct spi_flash *flash, unsigned long timeout, 166 u8 cmd, u8 poll_bit) 167 { 168 struct spi_slave *spi = flash->spi; 169 unsigned long timebase; 170 int ret; 171 u8 status; 172 173 ret = spi_xfer(spi, 8, &cmd, NULL, SPI_XFER_BEGIN); 174 if (ret) { 175 debug("SF: Failed to send command %02x: %d\n", cmd, ret); 176 return ret; 177 } 178 179 timebase = get_timer(0); 180 do { 181 WATCHDOG_RESET(); 182 183 ret = spi_xfer(spi, 8, NULL, &status, 0); 184 if (ret) 185 return -1; 186 187 if ((status & poll_bit) == 0) 188 break; 189 190 } while (get_timer(timebase) < timeout); 191 192 spi_xfer(spi, 0, NULL, NULL, SPI_XFER_END); 193 194 if ((status & poll_bit) == 0) 195 return 0; 196 197 /* Timed out */ 198 debug("SF: time out!\n"); 199 return -1; 200 } 201 202 int spi_flash_cmd_wait_ready(struct spi_flash *flash, unsigned long timeout) 203 { 204 return spi_flash_cmd_poll_bit(flash, timeout, 205 CMD_READ_STATUS, STATUS_WIP); 206 } 207 208 int spi_flash_cmd_erase(struct spi_flash *flash, u32 offset, size_t len) 209 { 210 u32 end, erase_size; 211 int ret; 212 u8 cmd[4]; 213 214 erase_size = flash->sector_size; 215 if (offset % erase_size || len % erase_size) { 216 debug("SF: Erase offset/length not multiple of erase size\n"); 217 return -1; 218 } 219 220 ret = spi_claim_bus(flash->spi); 221 if (ret) { 222 debug("SF: Unable to claim SPI bus\n"); 223 return ret; 224 } 225 226 if (erase_size == 4096) 227 cmd[0] = CMD_ERASE_4K; 228 else 229 cmd[0] = CMD_ERASE_64K; 230 end = offset + len; 231 232 while (offset < end) { 233 spi_flash_addr(offset, cmd); 234 offset += erase_size; 235 236 debug("SF: erase %2x %2x %2x %2x (%x)\n", cmd[0], cmd[1], 237 cmd[2], cmd[3], offset); 238 239 ret = spi_flash_cmd_write_enable(flash); 240 if (ret) 241 goto out; 242 243 ret = spi_flash_cmd_write(flash->spi, cmd, sizeof(cmd), NULL, 0); 244 if (ret) 245 goto out; 246 247 ret = spi_flash_cmd_wait_ready(flash, SPI_FLASH_PAGE_ERASE_TIMEOUT); 248 if (ret) 249 goto out; 250 } 251 252 out: 253 spi_release_bus(flash->spi); 254 return ret; 255 } 256 257 int spi_flash_cmd_write_status(struct spi_flash *flash, u8 sr) 258 { 259 u8 cmd; 260 int ret; 261 262 ret = spi_flash_cmd_write_enable(flash); 263 if (ret < 0) { 264 debug("SF: enabling write failed\n"); 265 return ret; 266 } 267 268 cmd = CMD_WRITE_STATUS; 269 ret = spi_flash_cmd_write(flash->spi, &cmd, 1, &sr, 1); 270 if (ret) { 271 debug("SF: fail to write status register\n"); 272 return ret; 273 } 274 275 ret = spi_flash_cmd_wait_ready(flash, SPI_FLASH_PROG_TIMEOUT); 276 if (ret < 0) { 277 debug("SF: write status register timed out\n"); 278 return ret; 279 } 280 281 return 0; 282 } 283 284 #ifdef CONFIG_OF_CONTROL 285 int spi_flash_decode_fdt(const void *blob, struct spi_flash *flash) 286 { 287 fdt_addr_t addr; 288 fdt_size_t size; 289 int node; 290 291 /* If there is no node, do nothing */ 292 node = fdtdec_next_compatible(blob, 0, COMPAT_GENERIC_SPI_FLASH); 293 if (node < 0) 294 return 0; 295 296 addr = fdtdec_get_addr_size(blob, node, "memory-map", &size); 297 if (addr == FDT_ADDR_T_NONE) { 298 debug("%s: Cannot decode address\n", __func__); 299 return 0; 300 } 301 302 if (flash->size != size) { 303 debug("%s: Memory map must cover entire device\n", __func__); 304 return -1; 305 } 306 flash->memory_map = (void *)addr; 307 308 return 0; 309 } 310 #endif /* CONFIG_OF_CONTROL */ 311 312 /* 313 * The following table holds all device probe functions 314 * 315 * shift: number of continuation bytes before the ID 316 * idcode: the expected IDCODE or 0xff for non JEDEC devices 317 * probe: the function to call 318 * 319 * Non JEDEC devices should be ordered in the table such that 320 * the probe functions with best detection algorithms come first. 321 * 322 * Several matching entries are permitted, they will be tried 323 * in sequence until a probe function returns non NULL. 324 * 325 * IDCODE_CONT_LEN may be redefined if a device needs to declare a 326 * larger "shift" value. IDCODE_PART_LEN generally shouldn't be 327 * changed. This is the max number of bytes probe functions may 328 * examine when looking up part-specific identification info. 329 * 330 * Probe functions will be given the idcode buffer starting at their 331 * manu id byte (the "idcode" in the table below). In other words, 332 * all of the continuation bytes will be skipped (the "shift" below). 333 */ 334 #define IDCODE_CONT_LEN 0 335 #define IDCODE_PART_LEN 5 336 static const struct { 337 const u8 shift; 338 const u8 idcode; 339 struct spi_flash *(*probe) (struct spi_slave *spi, u8 *idcode); 340 } flashes[] = { 341 /* Keep it sorted by define name */ 342 #ifdef CONFIG_SPI_FLASH_ATMEL 343 { 0, 0x1f, spi_flash_probe_atmel, }, 344 #endif 345 #ifdef CONFIG_SPI_FLASH_EON 346 { 0, 0x1c, spi_flash_probe_eon, }, 347 #endif 348 #ifdef CONFIG_SPI_FLASH_MACRONIX 349 { 0, 0xc2, spi_flash_probe_macronix, }, 350 #endif 351 #ifdef CONFIG_SPI_FLASH_SPANSION 352 { 0, 0x01, spi_flash_probe_spansion, }, 353 #endif 354 #ifdef CONFIG_SPI_FLASH_SST 355 { 0, 0xbf, spi_flash_probe_sst, }, 356 #endif 357 #ifdef CONFIG_SPI_FLASH_STMICRO 358 { 0, 0x20, spi_flash_probe_stmicro, }, 359 #endif 360 #ifdef CONFIG_SPI_FLASH_WINBOND 361 { 0, 0xef, spi_flash_probe_winbond, }, 362 #endif 363 #ifdef CONFIG_SPI_FRAM_RAMTRON 364 { 6, 0xc2, spi_fram_probe_ramtron, }, 365 # undef IDCODE_CONT_LEN 366 # define IDCODE_CONT_LEN 6 367 #endif 368 /* Keep it sorted by best detection */ 369 #ifdef CONFIG_SPI_FLASH_STMICRO 370 { 0, 0xff, spi_flash_probe_stmicro, }, 371 #endif 372 #ifdef CONFIG_SPI_FRAM_RAMTRON_NON_JEDEC 373 { 0, 0xff, spi_fram_probe_ramtron, }, 374 #endif 375 }; 376 #define IDCODE_LEN (IDCODE_CONT_LEN + IDCODE_PART_LEN) 377 378 struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs, 379 unsigned int max_hz, unsigned int spi_mode) 380 { 381 struct spi_slave *spi; 382 struct spi_flash *flash = NULL; 383 int ret, i, shift; 384 u8 idcode[IDCODE_LEN], *idp; 385 386 spi = spi_setup_slave(bus, cs, max_hz, spi_mode); 387 if (!spi) { 388 printf("SF: Failed to set up slave\n"); 389 return NULL; 390 } 391 392 ret = spi_claim_bus(spi); 393 if (ret) { 394 debug("SF: Failed to claim SPI bus: %d\n", ret); 395 goto err_claim_bus; 396 } 397 398 /* Read the ID codes */ 399 ret = spi_flash_cmd(spi, CMD_READ_ID, idcode, sizeof(idcode)); 400 if (ret) 401 goto err_read_id; 402 403 #ifdef DEBUG 404 printf("SF: Got idcodes\n"); 405 print_buffer(0, idcode, 1, sizeof(idcode), 0); 406 #endif 407 408 /* count the number of continuation bytes */ 409 for (shift = 0, idp = idcode; 410 shift < IDCODE_CONT_LEN && *idp == 0x7f; 411 ++shift, ++idp) 412 continue; 413 414 /* search the table for matches in shift and id */ 415 for (i = 0; i < ARRAY_SIZE(flashes); ++i) 416 if (flashes[i].shift == shift && flashes[i].idcode == *idp) { 417 /* we have a match, call probe */ 418 flash = flashes[i].probe(spi, idp); 419 if (flash) 420 break; 421 } 422 423 if (!flash) { 424 printf("SF: Unsupported manufacturer %02x\n", *idp); 425 goto err_manufacturer_probe; 426 } 427 428 #ifdef CONFIG_OF_CONTROL 429 if (spi_flash_decode_fdt(gd->fdt_blob, flash)) { 430 debug("SF: FDT decode error\n"); 431 goto err_manufacturer_probe; 432 } 433 #endif 434 printf("SF: Detected %s with page size ", flash->name); 435 print_size(flash->sector_size, ", total "); 436 print_size(flash->size, ""); 437 if (flash->memory_map) 438 printf(", mapped at %p", flash->memory_map); 439 puts("\n"); 440 441 spi_release_bus(spi); 442 443 return flash; 444 445 err_manufacturer_probe: 446 err_read_id: 447 spi_release_bus(spi); 448 err_claim_bus: 449 spi_free_slave(spi); 450 return NULL; 451 } 452 453 void *spi_flash_do_alloc(int offset, int size, struct spi_slave *spi, 454 const char *name) 455 { 456 struct spi_flash *flash; 457 void *ptr; 458 459 ptr = malloc(size); 460 if (!ptr) { 461 debug("SF: Failed to allocate memory\n"); 462 return NULL; 463 } 464 memset(ptr, '\0', size); 465 flash = (struct spi_flash *)(ptr + offset); 466 467 /* Set up some basic fields - caller will sort out sizes */ 468 flash->spi = spi; 469 flash->name = name; 470 471 flash->read = spi_flash_cmd_read_fast; 472 flash->write = spi_flash_cmd_write_multi; 473 flash->erase = spi_flash_cmd_erase; 474 475 return flash; 476 } 477 478 void spi_flash_free(struct spi_flash *flash) 479 { 480 spi_free_slave(flash->spi); 481 free(flash); 482 } 483