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 /* Read commands array */ 23 static u8 spi_read_cmds_array[] = { 24 CMD_READ_ARRAY_SLOW, 25 CMD_READ_DUAL_OUTPUT_FAST, 26 CMD_READ_DUAL_IO_FAST, 27 CMD_READ_QUAD_OUTPUT_FAST, 28 CMD_READ_QUAD_IO_FAST, 29 }; 30 31 #ifdef CONFIG_SPI_FLASH_MACRONIX 32 static int spi_flash_set_qeb_mxic(struct spi_flash *flash) 33 { 34 u8 qeb_status; 35 int ret; 36 37 ret = spi_flash_cmd_read_status(flash, &qeb_status); 38 if (ret < 0) 39 return ret; 40 41 if (qeb_status & STATUS_QEB_MXIC) { 42 debug("SF: mxic: QEB is already set\n"); 43 } else { 44 ret = spi_flash_cmd_write_status(flash, STATUS_QEB_MXIC); 45 if (ret < 0) 46 return ret; 47 } 48 49 return ret; 50 } 51 #endif 52 53 #if defined(CONFIG_SPI_FLASH_SPANSION) || defined(CONFIG_SPI_FLASH_WINBOND) 54 static int spi_flash_set_qeb_winspan(struct spi_flash *flash) 55 { 56 u8 qeb_status; 57 int ret; 58 59 ret = spi_flash_cmd_read_config(flash, &qeb_status); 60 if (ret < 0) 61 return ret; 62 63 if (qeb_status & STATUS_QEB_WINSPAN) { 64 debug("SF: winspan: QEB is already set\n"); 65 } else { 66 ret = spi_flash_cmd_write_config(flash, STATUS_QEB_WINSPAN); 67 if (ret < 0) 68 return ret; 69 } 70 71 return ret; 72 } 73 #endif 74 75 static int spi_flash_set_qeb(struct spi_flash *flash, u8 idcode0) 76 { 77 switch (idcode0) { 78 #ifdef CONFIG_SPI_FLASH_MACRONIX 79 case SPI_FLASH_CFI_MFR_MACRONIX: 80 return spi_flash_set_qeb_mxic(flash); 81 #endif 82 #if defined(CONFIG_SPI_FLASH_SPANSION) || defined(CONFIG_SPI_FLASH_WINBOND) 83 case SPI_FLASH_CFI_MFR_SPANSION: 84 case SPI_FLASH_CFI_MFR_WINBOND: 85 return spi_flash_set_qeb_winspan(flash); 86 #endif 87 #ifdef CONFIG_SPI_FLASH_STMICRO 88 case SPI_FLASH_CFI_MFR_STMICRO: 89 debug("SF: QEB is volatile for %02x flash\n", idcode0); 90 return 0; 91 #endif 92 default: 93 printf("SF: Need set QEB func for %02x flash\n", idcode0); 94 return -1; 95 } 96 } 97 98 static struct spi_flash *spi_flash_validate_params(struct spi_slave *spi, 99 u8 *idcode) 100 { 101 const struct spi_flash_params *params; 102 struct spi_flash *flash; 103 u8 cmd; 104 u16 jedec = idcode[1] << 8 | idcode[2]; 105 u16 ext_jedec = idcode[3] << 8 | idcode[4]; 106 107 params = spi_flash_params_table; 108 for (; params->name != NULL; params++) { 109 if ((params->jedec >> 16) == idcode[0]) { 110 if ((params->jedec & 0xFFFF) == jedec) { 111 if (params->ext_jedec == 0) 112 break; 113 else if (params->ext_jedec == ext_jedec) 114 break; 115 } 116 } 117 } 118 119 if (!params->name) { 120 printf("SF: Unsupported flash IDs: "); 121 printf("manuf %02x, jedec %04x, ext_jedec %04x\n", 122 idcode[0], jedec, ext_jedec); 123 return NULL; 124 } 125 126 flash = calloc(1, sizeof(*flash)); 127 if (!flash) { 128 debug("SF: Failed to allocate spi_flash\n"); 129 return NULL; 130 } 131 132 /* Assign spi data */ 133 flash->spi = spi; 134 flash->name = params->name; 135 flash->memory_map = spi->memory_map; 136 flash->dual_flash = flash->spi->option; 137 138 /* Assign spi_flash ops */ 139 flash->write = spi_flash_cmd_write_ops; 140 #ifdef CONFIG_SPI_FLASH_SST 141 if (params->flags & SST_WP) 142 flash->write = sst_write_wp; 143 #endif 144 flash->erase = spi_flash_cmd_erase_ops; 145 flash->read = spi_flash_cmd_read_ops; 146 147 /* Compute the flash size */ 148 flash->shift = (flash->dual_flash & SF_DUAL_PARALLEL_FLASH) ? 1 : 0; 149 /* 150 * The Spansion S25FL032P and S25FL064P have 256b pages, yet use the 151 * 0x4d00 Extended JEDEC code. The rest of the Spansion flashes with 152 * the 0x4d00 Extended JEDEC code have 512b pages. All of the others 153 * have 256b pages. 154 */ 155 if (ext_jedec == 0x4d00) { 156 if ((jedec == 0x0215) || (jedec == 0x216)) 157 flash->page_size = 256; 158 else 159 flash->page_size = 512; 160 } else { 161 flash->page_size = 256; 162 } 163 flash->page_size <<= flash->shift; 164 flash->sector_size = params->sector_size << flash->shift; 165 flash->size = flash->sector_size * params->nr_sectors << flash->shift; 166 #ifdef CONFIG_SF_DUAL_FLASH 167 if (flash->dual_flash & SF_DUAL_STACKED_FLASH) 168 flash->size <<= 1; 169 #endif 170 171 /* Compute erase sector and command */ 172 if (params->flags & SECT_4K) { 173 flash->erase_cmd = CMD_ERASE_4K; 174 flash->erase_size = 4096 << flash->shift; 175 } else if (params->flags & SECT_32K) { 176 flash->erase_cmd = CMD_ERASE_32K; 177 flash->erase_size = 32768 << flash->shift; 178 } else { 179 flash->erase_cmd = CMD_ERASE_64K; 180 flash->erase_size = flash->sector_size; 181 } 182 183 /* Look for the fastest read cmd */ 184 cmd = fls(params->e_rd_cmd & flash->spi->op_mode_rx); 185 if (cmd) { 186 cmd = spi_read_cmds_array[cmd - 1]; 187 flash->read_cmd = cmd; 188 } else { 189 /* Go for default supported read cmd */ 190 flash->read_cmd = CMD_READ_ARRAY_FAST; 191 } 192 193 /* Not require to look for fastest only two write cmds yet */ 194 if (params->flags & WR_QPP && flash->spi->op_mode_tx & SPI_OPM_TX_QPP) 195 flash->write_cmd = CMD_QUAD_PAGE_PROGRAM; 196 else 197 /* Go for default supported write cmd */ 198 flash->write_cmd = CMD_PAGE_PROGRAM; 199 200 /* Read dummy_byte: dummy byte is determined based on the 201 * dummy cycles of a particular command. 202 * Fast commands - dummy_byte = dummy_cycles/8 203 * I/O commands- dummy_byte = (dummy_cycles * no.of lines)/8 204 * For I/O commands except cmd[0] everything goes on no.of lines 205 * based on particular command but incase of fast commands except 206 * data all go on single line irrespective of command. 207 */ 208 switch (flash->read_cmd) { 209 case CMD_READ_QUAD_IO_FAST: 210 flash->dummy_byte = 2; 211 break; 212 case CMD_READ_ARRAY_SLOW: 213 flash->dummy_byte = 0; 214 break; 215 default: 216 flash->dummy_byte = 1; 217 } 218 219 /* Poll cmd selection */ 220 flash->poll_cmd = CMD_READ_STATUS; 221 #ifdef CONFIG_SPI_FLASH_STMICRO 222 if (params->flags & E_FSR) 223 flash->poll_cmd = CMD_FLAG_STATUS; 224 #endif 225 226 /* Configure the BAR - discover bank cmds and read current bank */ 227 #ifdef CONFIG_SPI_FLASH_BAR 228 u8 curr_bank = 0; 229 if (flash->size > SPI_FLASH_16MB_BOUN) { 230 flash->bank_read_cmd = (idcode[0] == 0x01) ? 231 CMD_BANKADDR_BRRD : CMD_EXTNADDR_RDEAR; 232 flash->bank_write_cmd = (idcode[0] == 0x01) ? 233 CMD_BANKADDR_BRWR : CMD_EXTNADDR_WREAR; 234 235 if (spi_flash_read_common(flash, &flash->bank_read_cmd, 1, 236 &curr_bank, 1)) { 237 debug("SF: fail to read bank addr register\n"); 238 return NULL; 239 } 240 flash->bank_curr = curr_bank; 241 } else { 242 flash->bank_curr = curr_bank; 243 } 244 #endif 245 246 /* Flash powers up read-only, so clear BP# bits */ 247 #if defined(CONFIG_SPI_FLASH_ATMEL) || \ 248 defined(CONFIG_SPI_FLASH_MACRONIX) || \ 249 defined(CONFIG_SPI_FLASH_SST) 250 spi_flash_cmd_write_status(flash, 0); 251 #endif 252 253 return flash; 254 } 255 256 #ifdef CONFIG_OF_CONTROL 257 int spi_flash_decode_fdt(const void *blob, struct spi_flash *flash) 258 { 259 fdt_addr_t addr; 260 fdt_size_t size; 261 int node; 262 263 /* If there is no node, do nothing */ 264 node = fdtdec_next_compatible(blob, 0, COMPAT_GENERIC_SPI_FLASH); 265 if (node < 0) 266 return 0; 267 268 addr = fdtdec_get_addr_size(blob, node, "memory-map", &size); 269 if (addr == FDT_ADDR_T_NONE) { 270 debug("%s: Cannot decode address\n", __func__); 271 return 0; 272 } 273 274 if (flash->size != size) { 275 debug("%s: Memory map must cover entire device\n", __func__); 276 return -1; 277 } 278 flash->memory_map = map_sysmem(addr, size); 279 280 return 0; 281 } 282 #endif /* CONFIG_OF_CONTROL */ 283 284 static struct spi_flash *spi_flash_probe_slave(struct spi_slave *spi) 285 { 286 struct spi_flash *flash = NULL; 287 u8 idcode[5]; 288 int ret; 289 290 /* Setup spi_slave */ 291 if (!spi) { 292 printf("SF: Failed to set up slave\n"); 293 return NULL; 294 } 295 296 /* Claim spi bus */ 297 ret = spi_claim_bus(spi); 298 if (ret) { 299 debug("SF: Failed to claim SPI bus: %d\n", ret); 300 goto err_claim_bus; 301 } 302 303 /* Read the ID codes */ 304 ret = spi_flash_cmd(spi, CMD_READ_ID, idcode, sizeof(idcode)); 305 if (ret) { 306 printf("SF: Failed to get idcodes\n"); 307 goto err_read_id; 308 } 309 310 #ifdef DEBUG 311 printf("SF: Got idcodes\n"); 312 print_buffer(0, idcode, 1, sizeof(idcode), 0); 313 #endif 314 315 /* Validate params from spi_flash_params table */ 316 flash = spi_flash_validate_params(spi, idcode); 317 if (!flash) 318 goto err_read_id; 319 320 /* Set the quad enable bit - only for quad commands */ 321 if ((flash->read_cmd == CMD_READ_QUAD_OUTPUT_FAST) || 322 (flash->read_cmd == CMD_READ_QUAD_IO_FAST) || 323 (flash->write_cmd == CMD_QUAD_PAGE_PROGRAM)) { 324 if (spi_flash_set_qeb(flash, idcode[0])) { 325 debug("SF: Fail to set QEB for %02x\n", idcode[0]); 326 return NULL; 327 } 328 } 329 330 #ifdef CONFIG_OF_CONTROL 331 if (spi_flash_decode_fdt(gd->fdt_blob, flash)) { 332 debug("SF: FDT decode error\n"); 333 goto err_read_id; 334 } 335 #endif 336 #ifndef CONFIG_SPL_BUILD 337 printf("SF: Detected %s with page size ", flash->name); 338 print_size(flash->page_size, ", erase size "); 339 print_size(flash->erase_size, ", total "); 340 print_size(flash->size, ""); 341 if (flash->memory_map) 342 printf(", mapped at %p", flash->memory_map); 343 puts("\n"); 344 #endif 345 #ifndef CONFIG_SPI_FLASH_BAR 346 if (((flash->dual_flash == SF_SINGLE_FLASH) && 347 (flash->size > SPI_FLASH_16MB_BOUN)) || 348 ((flash->dual_flash > SF_SINGLE_FLASH) && 349 (flash->size > SPI_FLASH_16MB_BOUN << 1))) { 350 puts("SF: Warning - Only lower 16MiB accessible,"); 351 puts(" Full access #define CONFIG_SPI_FLASH_BAR\n"); 352 } 353 #endif 354 355 /* Release spi bus */ 356 spi_release_bus(spi); 357 358 return flash; 359 360 err_read_id: 361 spi_release_bus(spi); 362 err_claim_bus: 363 spi_free_slave(spi); 364 return NULL; 365 } 366 367 struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs, 368 unsigned int max_hz, unsigned int spi_mode) 369 { 370 struct spi_slave *spi; 371 372 spi = spi_setup_slave(bus, cs, max_hz, spi_mode); 373 return spi_flash_probe_slave(spi); 374 } 375 376 #ifdef CONFIG_OF_SPI_FLASH 377 struct spi_flash *spi_flash_probe_fdt(const void *blob, int slave_node, 378 int spi_node) 379 { 380 struct spi_slave *spi; 381 382 spi = spi_setup_slave_fdt(blob, slave_node, spi_node); 383 return spi_flash_probe_slave(spi); 384 } 385 #endif 386 387 void spi_flash_free(struct spi_flash *flash) 388 { 389 spi_free_slave(flash->spi); 390 free(flash); 391 } 392