2 * Copyright 2009(C) Marvell International Ltd. and its affiliates
3 * Prafulla Wadaskar <prafulla@marvell.com>
5 * Based on drivers/mtd/spi/stmicro.c
7 * Copyright 2008, Network Appliance Inc.
8 * Jason McMullan <mcmullan@netapp.com>
10 * Copyright (C) 2004-2007 Freescale Semiconductor, Inc.
11 * TsiChung Liew (Tsi-Chung.Liew@freescale.com)
13 * See file CREDITS for list of people who contributed to this
16 * This program is free software; you can redistribute it and/or
17 * modify it under the terms of the GNU General Public License as
18 * published by the Free Software Foundation; either version 2 of
19 * the License, or (at your option) any later version.
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU General Public License for more details.
26 * You should have received a copy of the GNU General Public License
27 * along with this program; if not, write to the Free Software
28 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
34 #include <spi_flash.h>
36 #include "spi_flash_internal.h"
38 /* MX25xx-specific commands */
39 #define CMD_MX25XX_WREN 0x06 /* Write Enable */
40 #define CMD_MX25XX_WRDI 0x04 /* Write Disable */
41 #define CMD_MX25XX_RDSR 0x05 /* Read Status Register */
42 #define CMD_MX25XX_WRSR 0x01 /* Write Status Register */
43 #define CMD_MX25XX_READ 0x03 /* Read Data Bytes */
44 #define CMD_MX25XX_FAST_READ 0x0b /* Read Data Bytes at Higher Speed */
45 #define CMD_MX25XX_PP 0x02 /* Page Program */
46 #define CMD_MX25XX_SE 0x20 /* Sector Erase */
47 #define CMD_MX25XX_BE 0xD8 /* Block Erase */
48 #define CMD_MX25XX_CE 0xc7 /* Chip Erase */
49 #define CMD_MX25XX_DP 0xb9 /* Deep Power-down */
50 #define CMD_MX25XX_RES 0xab /* Release from DP, and Read Signature */
52 #define MACRONIX_SR_WIP (1 << 0) /* Write-in-Progress */
54 struct macronix_spi_flash_params {
58 u16 sectors_per_block;
63 struct macronix_spi_flash {
64 struct spi_flash flash;
65 const struct macronix_spi_flash_params *params;
68 static inline struct macronix_spi_flash *to_macronix_spi_flash(struct spi_flash
71 return container_of(flash, struct macronix_spi_flash, flash);
74 static const struct macronix_spi_flash_params macronix_spi_flash_table[] = {
78 .pages_per_sector = 16,
79 .sectors_per_block = 16,
86 .pages_per_sector = 16,
87 .sectors_per_block = 16,
94 .pages_per_sector = 16,
95 .sectors_per_block = 16,
102 .pages_per_sector = 16,
103 .sectors_per_block = 16,
105 .name = "MX25L12805D",
110 .pages_per_sector = 16,
111 .sectors_per_block = 16,
113 .name = "MX25L12855E",
117 static int macronix_wait_ready(struct spi_flash *flash, unsigned long timeout)
119 struct spi_slave *spi = flash->spi;
120 unsigned long timebase;
123 u8 cmd = CMD_MX25XX_RDSR;
125 ret = spi_xfer(spi, 8, &cmd, NULL, SPI_XFER_BEGIN);
127 debug("SF: Failed to send command %02x: %d\n", cmd, ret);
131 timebase = get_timer(0);
133 ret = spi_xfer(spi, 8, NULL, &status, 0);
137 if ((status & MACRONIX_SR_WIP) == 0)
140 } while (get_timer(timebase) < timeout);
142 spi_xfer(spi, 0, NULL, NULL, SPI_XFER_END);
144 if ((status & MACRONIX_SR_WIP) == 0)
151 static int macronix_read_fast(struct spi_flash *flash,
152 u32 offset, size_t len, void *buf)
154 struct macronix_spi_flash *mcx = to_macronix_spi_flash(flash);
155 unsigned long page_addr;
156 unsigned long page_size;
159 page_size = mcx->params->page_size;
160 page_addr = offset / page_size;
162 cmd[0] = CMD_READ_ARRAY_FAST;
163 cmd[1] = page_addr >> 8;
165 cmd[3] = offset % page_size;
168 return spi_flash_read_common(flash, cmd, sizeof(cmd), buf, len);
171 static int macronix_write(struct spi_flash *flash,
172 u32 offset, size_t len, const void *buf)
174 struct macronix_spi_flash *mcx = to_macronix_spi_flash(flash);
175 unsigned long page_addr;
176 unsigned long byte_addr;
177 unsigned long page_size;
183 page_size = mcx->params->page_size;
184 page_addr = offset / page_size;
185 byte_addr = offset % page_size;
187 ret = spi_claim_bus(flash->spi);
189 debug("SF: Unable to claim SPI bus\n");
194 for (actual = 0; actual < len; actual += chunk_len) {
195 chunk_len = min(len - actual, page_size - byte_addr);
197 cmd[0] = CMD_MX25XX_PP;
198 cmd[1] = page_addr >> 8;
203 ("PP: 0x%p => cmd = { 0x%02x 0x%02x%02x%02x } chunk_len = %d\n",
204 buf + actual, cmd[0], cmd[1], cmd[2], cmd[3], chunk_len);
206 ret = spi_flash_cmd(flash->spi, CMD_MX25XX_WREN, NULL, 0);
208 debug("SF: Enabling Write failed\n");
212 ret = spi_flash_cmd_write(flash->spi, cmd, 4,
213 buf + actual, chunk_len);
215 debug("SF: Macronix Page Program failed\n");
219 ret = macronix_wait_ready(flash, SPI_FLASH_PROG_TIMEOUT);
221 debug("SF: Macronix page programming timed out\n");
229 debug("SF: Macronix: Successfully programmed %u bytes @ 0x%x\n",
232 spi_release_bus(flash->spi);
236 int macronix_erase(struct spi_flash *flash, u32 offset, size_t len)
238 struct macronix_spi_flash *mcx = to_macronix_spi_flash(flash);
239 unsigned long sector_size;
245 * This function currently uses sector erase only.
246 * probably speed things up by using bulk erase
250 sector_size = mcx->params->page_size * mcx->params->pages_per_sector
251 * mcx->params->sectors_per_block;
253 if (offset % sector_size || len % sector_size) {
254 debug("SF: Erase offset/length not multiple of sector size\n");
259 cmd[0] = CMD_MX25XX_BE;
263 ret = spi_claim_bus(flash->spi);
265 debug("SF: Unable to claim SPI bus\n");
270 for (actual = 0; actual < len; actual++) {
271 cmd[1] = (offset / sector_size) + actual;
273 ret = spi_flash_cmd(flash->spi, CMD_MX25XX_WREN, NULL, 0);
275 debug("SF: Enabling Write failed\n");
279 ret = spi_flash_cmd_write(flash->spi, cmd, 4, NULL, 0);
281 debug("SF: Macronix page erase failed\n");
285 ret = macronix_wait_ready(flash, SPI_FLASH_PAGE_ERASE_TIMEOUT);
287 debug("SF: Macronix page erase timed out\n");
292 debug("SF: Macronix: Successfully erased %u bytes @ 0x%x\n",
293 len * sector_size, offset);
295 spi_release_bus(flash->spi);
299 struct spi_flash *spi_flash_probe_macronix(struct spi_slave *spi, u8 *idcode)
301 const struct macronix_spi_flash_params *params;
302 struct macronix_spi_flash *mcx;
304 u16 id = idcode[2] | idcode[1] << 8;
306 for (i = 0; i < ARRAY_SIZE(macronix_spi_flash_table); i++) {
307 params = ¯onix_spi_flash_table[i];
308 if (params->idcode == id)
312 if (i == ARRAY_SIZE(macronix_spi_flash_table)) {
313 debug("SF: Unsupported Macronix ID %04x\n", id);
317 mcx = malloc(sizeof(*mcx));
319 debug("SF: Failed to allocate memory\n");
323 mcx->params = params;
324 mcx->flash.spi = spi;
325 mcx->flash.name = params->name;
327 mcx->flash.write = macronix_write;
328 mcx->flash.erase = macronix_erase;
329 mcx->flash.read = macronix_read_fast;
330 mcx->flash.size = params->page_size * params->pages_per_sector
331 * params->sectors_per_block * params->nr_blocks;
333 printf("SF: Detected %s with page size %u, total ",
334 params->name, params->page_size);
335 print_size(mcx->flash.size, "\n");