2 * (C) Copyright 2000-2002
3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5 * Copyright 2008, Network Appliance Inc.
6 * Jason McMullan <mcmullan@netapp.com>
8 * Copyright (C) 2004-2007 Freescale Semiconductor, Inc.
9 * TsiChung Liew (Tsi-Chung.Liew@freescale.com)
11 * See file CREDITS for list of people who contributed to this
14 * This program is free software; you can redistribute it and/or
15 * modify it under the terms of the GNU General Public License as
16 * published by the Free Software Foundation; either version 2 of
17 * the License, or (at your option) any later version.
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with this program; if not, write to the Free Software
26 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
32 #include <spi_flash.h>
34 #include "spi_flash_internal.h"
36 /* M25Pxx-specific commands */
37 #define CMD_M25PXX_WREN 0x06 /* Write Enable */
38 #define CMD_M25PXX_WRDI 0x04 /* Write Disable */
39 #define CMD_M25PXX_RDSR 0x05 /* Read Status Register */
40 #define CMD_M25PXX_WRSR 0x01 /* Write Status Register */
41 #define CMD_M25PXX_READ 0x03 /* Read Data Bytes */
42 #define CMD_M25PXX_FAST_READ 0x0b /* Read Data Bytes at Higher Speed */
43 #define CMD_M25PXX_PP 0x02 /* Page Program */
44 #define CMD_M25PXX_SE 0xd8 /* Sector Erase */
45 #define CMD_M25PXX_BE 0xc7 /* Bulk Erase */
46 #define CMD_M25PXX_DP 0xb9 /* Deep Power-down */
47 #define CMD_M25PXX_RES 0xab /* Release from DP, and Read Signature */
49 #define STM_ID_M25P10 0x11
50 #define STM_ID_M25P16 0x15
51 #define STM_ID_M25P20 0x12
52 #define STM_ID_M25P32 0x16
53 #define STM_ID_M25P40 0x13
54 #define STM_ID_M25P64 0x17
55 #define STM_ID_M25P80 0x14
56 #define STM_ID_M25P128 0x18
58 #define STMICRO_SR_WIP (1 << 0) /* Write-in-Progress */
60 struct stmicro_spi_flash_params {
68 /* spi_flash needs to be first so upper layers can free() it */
69 struct stmicro_spi_flash {
70 struct spi_flash flash;
71 const struct stmicro_spi_flash_params *params;
74 static inline struct stmicro_spi_flash *to_stmicro_spi_flash(struct spi_flash
77 return container_of(flash, struct stmicro_spi_flash, flash);
80 static const struct stmicro_spi_flash_params stmicro_spi_flash_table[] = {
82 .idcode1 = STM_ID_M25P10,
84 .pages_per_sector = 128,
89 .idcode1 = STM_ID_M25P16,
91 .pages_per_sector = 256,
96 .idcode1 = STM_ID_M25P20,
98 .pages_per_sector = 256,
103 .idcode1 = STM_ID_M25P32,
105 .pages_per_sector = 256,
110 .idcode1 = STM_ID_M25P40,
112 .pages_per_sector = 256,
117 .idcode1 = STM_ID_M25P64,
119 .pages_per_sector = 256,
124 .idcode1 = STM_ID_M25P80,
126 .pages_per_sector = 256,
131 .idcode1 = STM_ID_M25P128,
133 .pages_per_sector = 1024,
139 static int stmicro_wait_ready(struct spi_flash *flash, unsigned long timeout)
141 struct spi_slave *spi = flash->spi;
142 unsigned long timebase;
144 u8 cmd = CMD_M25PXX_RDSR;
147 ret = spi_xfer(spi, 8, &cmd, NULL, SPI_XFER_BEGIN);
149 debug("SF: Failed to send command %02x: %d\n", cmd, ret);
153 timebase = get_timer(0);
155 ret = spi_xfer(spi, 8, NULL, &status, 0);
159 if ((status & STMICRO_SR_WIP) == 0)
162 } while (get_timer(timebase) < timeout);
164 spi_xfer(spi, 0, NULL, NULL, SPI_XFER_END);
166 if ((status & STMICRO_SR_WIP) == 0)
173 static int stmicro_read_fast(struct spi_flash *flash,
174 u32 offset, size_t len, void *buf)
176 struct stmicro_spi_flash *stm = to_stmicro_spi_flash(flash);
177 unsigned long page_addr;
178 unsigned long page_size;
181 page_size = stm->params->page_size;
182 page_addr = offset / page_size;
184 cmd[0] = CMD_READ_ARRAY_FAST;
185 cmd[1] = page_addr >> 8;
187 cmd[3] = offset % page_size;
190 return spi_flash_read_common(flash, cmd, sizeof(cmd), buf, len);
193 static int stmicro_write(struct spi_flash *flash,
194 u32 offset, size_t len, const void *buf)
196 struct stmicro_spi_flash *stm = to_stmicro_spi_flash(flash);
197 unsigned long page_addr;
198 unsigned long byte_addr;
199 unsigned long page_size;
205 page_size = stm->params->page_size;
206 page_addr = offset / page_size;
207 byte_addr = offset % page_size;
209 ret = spi_claim_bus(flash->spi);
211 debug("SF: Unable to claim SPI bus\n");
216 for (actual = 0; actual < len; actual += chunk_len) {
217 chunk_len = min(len - actual, page_size - byte_addr);
219 cmd[0] = CMD_M25PXX_PP;
220 cmd[1] = page_addr >> 8;
225 ("PP: 0x%p => cmd = { 0x%02x 0x%02x%02x%02x } chunk_len = %d\n",
226 buf + actual, cmd[0], cmd[1], cmd[2], cmd[3], chunk_len);
228 ret = spi_flash_cmd(flash->spi, CMD_M25PXX_WREN, NULL, 0);
230 debug("SF: Enabling Write failed\n");
234 ret = spi_flash_cmd_write(flash->spi, cmd, 4,
235 buf + actual, chunk_len);
237 debug("SF: STMicro Page Program failed\n");
241 ret = stmicro_wait_ready(flash, SPI_FLASH_PROG_TIMEOUT);
243 debug("SF: STMicro page programming timed out\n");
251 debug("SF: STMicro: Successfully programmed %u bytes @ 0x%x\n",
254 spi_release_bus(flash->spi);
258 int stmicro_erase(struct spi_flash *flash, u32 offset, size_t len)
260 struct stmicro_spi_flash *stm = to_stmicro_spi_flash(flash);
261 unsigned long sector_size;
267 * This function currently uses sector erase only.
268 * probably speed things up by using bulk erase
272 sector_size = stm->params->page_size * stm->params->pages_per_sector;
274 if (offset % sector_size || len % sector_size) {
275 debug("SF: Erase offset/length not multiple of sector size\n");
280 cmd[0] = CMD_M25PXX_SE;
284 ret = spi_claim_bus(flash->spi);
286 debug("SF: Unable to claim SPI bus\n");
291 for (actual = 0; actual < len; actual++) {
292 cmd[1] = offset >> 16;
293 offset += sector_size;
295 ret = spi_flash_cmd(flash->spi, CMD_M25PXX_WREN, NULL, 0);
297 debug("SF: Enabling Write failed\n");
301 ret = spi_flash_cmd_write(flash->spi, cmd, 4, NULL, 0);
303 debug("SF: STMicro page erase failed\n");
307 ret = stmicro_wait_ready(flash, SPI_FLASH_PAGE_ERASE_TIMEOUT);
309 debug("SF: STMicro page erase timed out\n");
314 debug("SF: STMicro: Successfully erased %u bytes @ 0x%x\n",
315 len * sector_size, offset);
317 spi_release_bus(flash->spi);
321 struct spi_flash *spi_flash_probe_stmicro(struct spi_slave *spi, u8 * idcode)
323 const struct stmicro_spi_flash_params *params;
324 struct stmicro_spi_flash *stm;
327 if (idcode[0] == 0xff) {
328 i = spi_flash_cmd(spi, CMD_M25PXX_RES,
332 if ((idcode[3] & 0xf0) == 0x10) {
335 idcode[2] = idcode[3] + 1;
340 for (i = 0; i < ARRAY_SIZE(stmicro_spi_flash_table); i++) {
341 params = &stmicro_spi_flash_table[i];
342 if (params->idcode1 == idcode[2]) {
347 if (i == ARRAY_SIZE(stmicro_spi_flash_table)) {
348 debug("SF: Unsupported STMicro ID %02x\n", idcode[1]);
352 stm = malloc(sizeof(struct stmicro_spi_flash));
354 debug("SF: Failed to allocate memory\n");
358 stm->params = params;
359 stm->flash.spi = spi;
360 stm->flash.name = params->name;
362 stm->flash.write = stmicro_write;
363 stm->flash.erase = stmicro_erase;
364 stm->flash.read = stmicro_read_fast;
365 stm->flash.size = params->page_size * params->pages_per_sector
366 * params->nr_sectors;
368 printf("SF: Detected %s with page size %u, total ",
369 params->name, params->page_size);
370 print_size(stm->flash.size, "\n");