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 = malloc(sizeof(*flash)); 127 if (!flash) { 128 debug("SF: Failed to allocate spi_flash\n"); 129 return NULL; 130 } 131 memset(flash, '\0', sizeof(*flash)); 132 133 /* Assign spi data */ 134 flash->spi = spi; 135 flash->name = params->name; 136 flash->memory_map = spi->memory_map; 137 flash->dual_flash = flash->spi->option; 138 139 /* Assign spi_flash ops */ 140 flash->write = spi_flash_cmd_write_ops; 141 #ifdef CONFIG_SPI_FLASH_SST 142 if (params->flags & SST_WP) 143 flash->write = sst_write_wp; 144 #endif 145 flash->erase = spi_flash_cmd_erase_ops; 146 flash->read = spi_flash_cmd_read_ops; 147 148 /* Compute the flash size */ 149 flash->shift = (flash->dual_flash & SF_DUAL_PARALLEL_FLASH) ? 1 : 0; 150 flash->page_size = ((ext_jedec == 0x4d00) ? 512 : 256) << flash->shift; 151 flash->sector_size = params->sector_size << flash->shift; 152 flash->size = flash->sector_size * params->nr_sectors << flash->shift; 153 if (flash->dual_flash & SF_DUAL_STACKED_FLASH) 154 flash->size <<= 1; 155 156 /* Compute erase sector and command */ 157 if (params->flags & SECT_4K) { 158 flash->erase_cmd = CMD_ERASE_4K; 159 flash->erase_size = 4096 << flash->shift; 160 } else if (params->flags & SECT_32K) { 161 flash->erase_cmd = CMD_ERASE_32K; 162 flash->erase_size = 32768 << flash->shift; 163 } else { 164 flash->erase_cmd = CMD_ERASE_64K; 165 flash->erase_size = flash->sector_size; 166 } 167 168 /* Look for the fastest read cmd */ 169 cmd = fls(params->e_rd_cmd & flash->spi->op_mode_rx); 170 if (cmd) { 171 cmd = spi_read_cmds_array[cmd - 1]; 172 flash->read_cmd = cmd; 173 } else { 174 /* Go for default supported read cmd */ 175 flash->read_cmd = CMD_READ_ARRAY_FAST; 176 } 177 178 /* Not require to look for fastest only two write cmds yet */ 179 if (params->flags & WR_QPP && flash->spi->op_mode_tx & SPI_OPM_TX_QPP) 180 flash->write_cmd = CMD_QUAD_PAGE_PROGRAM; 181 else 182 /* Go for default supported write cmd */ 183 flash->write_cmd = CMD_PAGE_PROGRAM; 184 185 /* Set the quad enable bit - only for quad commands */ 186 if ((flash->read_cmd == CMD_READ_QUAD_OUTPUT_FAST) || 187 (flash->read_cmd == CMD_READ_QUAD_IO_FAST) || 188 (flash->write_cmd == CMD_QUAD_PAGE_PROGRAM)) { 189 if (spi_flash_set_qeb(flash, idcode[0])) { 190 debug("SF: Fail to set QEB for %02x\n", idcode[0]); 191 return NULL; 192 } 193 } 194 195 /* Read dummy_byte: dummy byte is determined based on the 196 * dummy cycles of a particular command. 197 * Fast commands - dummy_byte = dummy_cycles/8 198 * I/O commands- dummy_byte = (dummy_cycles * no.of lines)/8 199 * For I/O commands except cmd[0] everything goes on no.of lines 200 * based on particular command but incase of fast commands except 201 * data all go on single line irrespective of command. 202 */ 203 switch (flash->read_cmd) { 204 case CMD_READ_QUAD_IO_FAST: 205 flash->dummy_byte = 2; 206 break; 207 case CMD_READ_ARRAY_SLOW: 208 flash->dummy_byte = 0; 209 break; 210 default: 211 flash->dummy_byte = 1; 212 } 213 214 /* Poll cmd selection */ 215 flash->poll_cmd = CMD_READ_STATUS; 216 #ifdef CONFIG_SPI_FLASH_STMICRO 217 if (params->flags & E_FSR) 218 flash->poll_cmd = CMD_FLAG_STATUS; 219 #endif 220 221 /* Configure the BAR - discover bank cmds and read current bank */ 222 #ifdef CONFIG_SPI_FLASH_BAR 223 u8 curr_bank = 0; 224 if (flash->size > SPI_FLASH_16MB_BOUN) { 225 flash->bank_read_cmd = (idcode[0] == 0x01) ? 226 CMD_BANKADDR_BRRD : CMD_EXTNADDR_RDEAR; 227 flash->bank_write_cmd = (idcode[0] == 0x01) ? 228 CMD_BANKADDR_BRWR : CMD_EXTNADDR_WREAR; 229 230 if (spi_flash_read_common(flash, &flash->bank_read_cmd, 1, 231 &curr_bank, 1)) { 232 debug("SF: fail to read bank addr register\n"); 233 return NULL; 234 } 235 flash->bank_curr = curr_bank; 236 } else { 237 flash->bank_curr = curr_bank; 238 } 239 #endif 240 241 /* Flash powers up read-only, so clear BP# bits */ 242 #if defined(CONFIG_SPI_FLASH_ATMEL) || \ 243 defined(CONFIG_SPI_FLASH_MACRONIX) || \ 244 defined(CONFIG_SPI_FLASH_SST) 245 spi_flash_cmd_write_status(flash, 0); 246 #endif 247 248 return flash; 249 } 250 251 #ifdef CONFIG_OF_CONTROL 252 int spi_flash_decode_fdt(const void *blob, struct spi_flash *flash) 253 { 254 fdt_addr_t addr; 255 fdt_size_t size; 256 int node; 257 258 /* If there is no node, do nothing */ 259 node = fdtdec_next_compatible(blob, 0, COMPAT_GENERIC_SPI_FLASH); 260 if (node < 0) 261 return 0; 262 263 addr = fdtdec_get_addr_size(blob, node, "memory-map", &size); 264 if (addr == FDT_ADDR_T_NONE) { 265 debug("%s: Cannot decode address\n", __func__); 266 return 0; 267 } 268 269 if (flash->size != size) { 270 debug("%s: Memory map must cover entire device\n", __func__); 271 return -1; 272 } 273 flash->memory_map = map_sysmem(addr, size); 274 275 return 0; 276 } 277 #endif /* CONFIG_OF_CONTROL */ 278 279 static struct spi_flash *spi_flash_probe_slave(struct spi_slave *spi) 280 { 281 struct spi_flash *flash = NULL; 282 u8 idcode[5]; 283 int ret; 284 285 /* Setup spi_slave */ 286 if (!spi) { 287 printf("SF: Failed to set up slave\n"); 288 return NULL; 289 } 290 291 /* Claim spi bus */ 292 ret = spi_claim_bus(spi); 293 if (ret) { 294 debug("SF: Failed to claim SPI bus: %d\n", ret); 295 goto err_claim_bus; 296 } 297 298 /* Read the ID codes */ 299 ret = spi_flash_cmd(spi, CMD_READ_ID, idcode, sizeof(idcode)); 300 if (ret) { 301 printf("SF: Failed to get idcodes\n"); 302 goto err_read_id; 303 } 304 305 #ifdef DEBUG 306 printf("SF: Got idcodes\n"); 307 print_buffer(0, idcode, 1, sizeof(idcode), 0); 308 #endif 309 310 /* Validate params from spi_flash_params table */ 311 flash = spi_flash_validate_params(spi, idcode); 312 if (!flash) 313 goto err_read_id; 314 315 #ifdef CONFIG_OF_CONTROL 316 if (spi_flash_decode_fdt(gd->fdt_blob, flash)) { 317 debug("SF: FDT decode error\n"); 318 goto err_read_id; 319 } 320 #endif 321 #ifndef CONFIG_SPL_BUILD 322 printf("SF: Detected %s with page size ", flash->name); 323 print_size(flash->page_size, ", erase size "); 324 print_size(flash->erase_size, ", total "); 325 print_size(flash->size, ""); 326 if (flash->memory_map) 327 printf(", mapped at %p", flash->memory_map); 328 puts("\n"); 329 #endif 330 #ifndef CONFIG_SPI_FLASH_BAR 331 if (((flash->dual_flash == SF_SINGLE_FLASH) && 332 (flash->size > SPI_FLASH_16MB_BOUN)) || 333 ((flash->dual_flash > SF_SINGLE_FLASH) && 334 (flash->size > SPI_FLASH_16MB_BOUN << 1))) { 335 puts("SF: Warning - Only lower 16MiB accessible,"); 336 puts(" Full access #define CONFIG_SPI_FLASH_BAR\n"); 337 } 338 #endif 339 340 /* Release spi bus */ 341 spi_release_bus(spi); 342 343 return flash; 344 345 err_read_id: 346 spi_release_bus(spi); 347 err_claim_bus: 348 spi_free_slave(spi); 349 return NULL; 350 } 351 352 struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs, 353 unsigned int max_hz, unsigned int spi_mode) 354 { 355 struct spi_slave *spi; 356 357 spi = spi_setup_slave(bus, cs, max_hz, spi_mode); 358 return spi_flash_probe_slave(spi); 359 } 360 361 #ifdef CONFIG_OF_SPI_FLASH 362 struct spi_flash *spi_flash_probe_fdt(const void *blob, int slave_node, 363 int spi_node) 364 { 365 struct spi_slave *spi; 366 367 spi = spi_setup_slave_fdt(blob, slave_node, spi_node); 368 return spi_flash_probe_slave(spi); 369 } 370 #endif 371 372 void spi_flash_free(struct spi_flash *flash) 373 { 374 spi_free_slave(flash->spi); 375 free(flash); 376 } 377