2 * Copyright (C) 2009 Freescale Semiconductor, Inc.
4 * Author: Mingkai Hu (Mingkai.hu@freescale.com)
5 * Based on stmicro.c by Wolfgang Denk (wd@denx.de),
6 * TsiChung Liew (Tsi-Chung.Liew@freescale.com),
7 * and Jason McMullan (mcmullan@netapp.com)
9 * See file CREDITS for list of people who contributed to this
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License as
14 * published by the Free Software Foundation; either version 2 of
15 * the License, or (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
30 #include <spi_flash.h>
32 #include "spi_flash_internal.h"
34 /* S25FLxx-specific commands */
35 #define CMD_S25FLXX_READ 0x03 /* Read Data Bytes */
36 #define CMD_S25FLXX_FAST_READ 0x0b /* Read Data Bytes at Higher Speed */
37 #define CMD_S25FLXX_READID 0x90 /* Read Manufacture ID and Device ID */
38 #define CMD_S25FLXX_WREN 0x06 /* Write Enable */
39 #define CMD_S25FLXX_WRDI 0x04 /* Write Disable */
40 #define CMD_S25FLXX_RDSR 0x05 /* Read Status Register */
41 #define CMD_S25FLXX_WRSR 0x01 /* Write Status Register */
42 #define CMD_S25FLXX_PP 0x02 /* Page Program */
43 #define CMD_S25FLXX_SE 0xd8 /* Sector Erase */
44 #define CMD_S25FLXX_BE 0xc7 /* Bulk Erase */
45 #define CMD_S25FLXX_DP 0xb9 /* Deep Power-down */
46 #define CMD_S25FLXX_RES 0xab /* Release from DP, and Read Signature */
48 #define SPSN_ID_S25FL008A 0x0213
49 #define SPSN_ID_S25FL016A 0x0214
50 #define SPSN_ID_S25FL032A 0x0215
51 #define SPSN_ID_S25FL064A 0x0216
52 #define SPSN_ID_S25FL128P 0x2018
53 #define SPSN_EXT_ID_S25FL128P_256KB 0x0300
54 #define SPSN_EXT_ID_S25FL128P_64KB 0x0301
55 #define SPSN_EXT_ID_S25FL032P 0x4d00
57 #define SPANSION_SR_WIP (1 << 0) /* Write-in-Progress */
59 struct spansion_spi_flash_params {
68 struct spansion_spi_flash {
69 struct spi_flash flash;
70 const struct spansion_spi_flash_params *params;
73 static inline struct spansion_spi_flash *to_spansion_spi_flash(struct spi_flash
76 return container_of(flash, struct spansion_spi_flash, flash);
79 static const struct spansion_spi_flash_params spansion_spi_flash_table[] = {
81 .idcode1 = SPSN_ID_S25FL008A,
84 .pages_per_sector = 256,
89 .idcode1 = SPSN_ID_S25FL016A,
92 .pages_per_sector = 256,
97 .idcode1 = SPSN_ID_S25FL032A,
100 .pages_per_sector = 256,
105 .idcode1 = SPSN_ID_S25FL064A,
108 .pages_per_sector = 256,
113 .idcode1 = SPSN_ID_S25FL128P,
114 .idcode2 = SPSN_EXT_ID_S25FL128P_64KB,
116 .pages_per_sector = 256,
118 .name = "S25FL128P_64K",
121 .idcode1 = SPSN_ID_S25FL128P,
122 .idcode2 = SPSN_EXT_ID_S25FL128P_256KB,
124 .pages_per_sector = 1024,
126 .name = "S25FL128P_256K",
129 .idcode1 = SPSN_ID_S25FL032A,
130 .idcode2 = SPSN_EXT_ID_S25FL032P,
132 .pages_per_sector = 256,
138 static int spansion_wait_ready(struct spi_flash *flash, unsigned long timeout)
140 struct spi_slave *spi = flash->spi;
141 unsigned long timebase;
145 timebase = get_timer(0);
147 ret = spi_flash_cmd(spi, CMD_S25FLXX_RDSR, &status, sizeof(status));
151 if ((status & SPANSION_SR_WIP) == 0)
154 } while (get_timer(timebase) < timeout);
157 if ((status & SPANSION_SR_WIP) == 0)
164 static int spansion_read_fast(struct spi_flash *flash,
165 u32 offset, size_t len, void *buf)
167 struct spansion_spi_flash *spsn = to_spansion_spi_flash(flash);
168 unsigned long page_addr;
169 unsigned long page_size;
172 page_size = spsn->params->page_size;
173 page_addr = offset / page_size;
175 cmd[0] = CMD_READ_ARRAY_FAST;
176 cmd[1] = page_addr >> 8;
178 cmd[3] = offset % page_size;
182 ("READ: 0x%x => cmd = { 0x%02x 0x%02x%02x%02x%02x } len = 0x%x\n",
183 offset, cmd[0], cmd[1], cmd[2], cmd[3], cmd[4], len);
185 return spi_flash_read_common(flash, cmd, sizeof(cmd), buf, len);
188 static int spansion_write(struct spi_flash *flash,
189 u32 offset, size_t len, const void *buf)
191 struct spansion_spi_flash *spsn = to_spansion_spi_flash(flash);
192 unsigned long page_addr;
193 unsigned long byte_addr;
194 unsigned long page_size;
200 page_size = spsn->params->page_size;
201 page_addr = offset / page_size;
202 byte_addr = offset % page_size;
204 ret = spi_claim_bus(flash->spi);
206 debug("SF: Unable to claim SPI bus\n");
211 for (actual = 0; actual < len; actual += chunk_len) {
212 chunk_len = min(len - actual, page_size - byte_addr);
214 cmd[0] = CMD_S25FLXX_PP;
215 cmd[1] = page_addr >> 8;
220 ("PP: 0x%p => cmd = { 0x%02x 0x%02x%02x%02x } chunk_len = %d\n",
221 buf + actual, cmd[0], cmd[1], cmd[2], cmd[3], chunk_len);
223 ret = spi_flash_cmd(flash->spi, CMD_S25FLXX_WREN, NULL, 0);
225 debug("SF: Enabling Write failed\n");
229 ret = spi_flash_cmd_write(flash->spi, cmd, 4,
230 buf + actual, chunk_len);
232 debug("SF: SPANSION Page Program failed\n");
236 ret = spansion_wait_ready(flash, SPI_FLASH_PROG_TIMEOUT);
238 debug("SF: SPANSION page programming timed out\n");
246 debug("SF: SPANSION: Successfully programmed %u bytes @ 0x%x\n",
249 spi_release_bus(flash->spi);
253 int spansion_erase(struct spi_flash *flash, u32 offset, size_t len)
255 struct spansion_spi_flash *spsn = to_spansion_spi_flash(flash);
256 unsigned long sector_size;
262 * This function currently uses sector erase only.
263 * probably speed things up by using bulk erase
267 sector_size = spsn->params->page_size * spsn->params->pages_per_sector;
269 if (offset % sector_size || len % sector_size) {
270 debug("SF: Erase offset/length not multiple of sector size\n");
274 cmd[0] = CMD_S25FLXX_SE;
278 ret = spi_claim_bus(flash->spi);
280 debug("SF: Unable to claim SPI bus\n");
285 for (actual = 0; actual < len; actual += sector_size) {
286 cmd[1] = (offset + actual) >> 16;
288 ret = spi_flash_cmd(flash->spi, CMD_S25FLXX_WREN, NULL, 0);
290 debug("SF: Enabling Write failed\n");
294 ret = spi_flash_cmd_write(flash->spi, cmd, 4, NULL, 0);
296 debug("SF: SPANSION page erase failed\n");
300 /* Up to 2 seconds */
301 ret = spansion_wait_ready(flash, SPI_FLASH_PAGE_ERASE_TIMEOUT);
303 debug("SF: SPANSION page erase timed out\n");
308 debug("SF: SPANSION: Successfully erased %u bytes @ 0x%x\n",
311 spi_release_bus(flash->spi);
315 struct spi_flash *spi_flash_probe_spansion(struct spi_slave *spi, u8 *idcode)
317 const struct spansion_spi_flash_params *params;
318 struct spansion_spi_flash *spsn;
320 unsigned short jedec, ext_jedec;
322 jedec = idcode[1] << 8 | idcode[2];
323 ext_jedec = idcode[3] << 8 | idcode[4];
325 for (i = 0; i < ARRAY_SIZE(spansion_spi_flash_table); i++) {
326 params = &spansion_spi_flash_table[i];
327 if (params->idcode1 == jedec) {
328 if (params->idcode2 == ext_jedec)
333 if (i == ARRAY_SIZE(spansion_spi_flash_table)) {
334 debug("SF: Unsupported SPANSION ID %04x %04x\n", jedec, ext_jedec);
338 spsn = malloc(sizeof(struct spansion_spi_flash));
340 debug("SF: Failed to allocate memory\n");
344 spsn->params = params;
345 spsn->flash.spi = spi;
346 spsn->flash.name = params->name;
348 spsn->flash.write = spansion_write;
349 spsn->flash.erase = spansion_erase;
350 spsn->flash.read = spansion_read_fast;
351 spsn->flash.size = params->page_size * params->pages_per_sector
352 * params->nr_sectors;
354 printf("SF: Detected %s with page size %u, total ",
355 params->name, params->page_size);
356 print_size(spsn->flash.size, "\n");