2 * Driver for SST serial flashes
4 * (C) Copyright 2000-2002
5 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
6 * Copyright 2008, Network Appliance Inc.
7 * Jason McMullan <mcmullan@netapp.com>
8 * Copyright (C) 2004-2007 Freescale Semiconductor, Inc.
9 * TsiChung Liew (Tsi-Chung.Liew@freescale.com)
10 * Copyright (c) 2008-2009 Analog Devices Inc.
12 * Licensed under the GPL-2 or later.
17 #include <spi_flash.h>
19 #include "spi_flash_internal.h"
21 #define CMD_SST_WREN 0x06 /* Write Enable */
22 #define CMD_SST_WRDI 0x04 /* Write Disable */
23 #define CMD_SST_RDSR 0x05 /* Read Status Register */
24 #define CMD_SST_WRSR 0x01 /* Write Status Register */
25 #define CMD_SST_READ 0x03 /* Read Data Bytes */
26 #define CMD_SST_FAST_READ 0x0b /* Read Data Bytes at Higher Speed */
27 #define CMD_SST_BP 0x02 /* Byte Program */
28 #define CMD_SST_AAI_WP 0xAD /* Auto Address Increment Word Program */
29 #define CMD_SST_SE 0x20 /* Sector Erase */
31 #define SST_SR_WIP (1 << 0) /* Write-in-Progress */
32 #define SST_SR_WEL (1 << 1) /* Write enable */
33 #define SST_SR_BP0 (1 << 2) /* Block Protection 0 */
34 #define SST_SR_BP1 (1 << 3) /* Block Protection 1 */
35 #define SST_SR_BP2 (1 << 4) /* Block Protection 2 */
36 #define SST_SR_AAI (1 << 6) /* Addressing mode */
37 #define SST_SR_BPL (1 << 7) /* BP bits lock */
39 #define SST_FEAT_WP (1 << 0) /* Supports AAI word program */
40 #define SST_FEAT_MBP (1 << 1) /* Supports multibyte program */
42 struct sst_spi_flash_params {
49 struct sst_spi_flash {
50 struct spi_flash flash;
51 const struct sst_spi_flash_params *params;
54 static inline struct sst_spi_flash *to_sst_spi_flash(struct spi_flash *flash)
56 return container_of(flash, struct sst_spi_flash, flash);
59 #define SST_SECTOR_SIZE (4 * 1024)
60 #define SST_PAGE_SIZE 256
61 static const struct sst_spi_flash_params sst_spi_flash_table[] = {
66 .name = "SST25VF040B",
71 .name = "SST25VF080B",
76 .name = "SST25VF016B",
81 .name = "SST25VF032B",
84 .flags = SST_FEAT_MBP,
86 .name = "SST25VF064C",
101 .name = "SST25WF020",
104 .flags = SST_FEAT_WP,
106 .name = "SST25WF040",
111 sst_enable_writing(struct spi_flash *flash)
113 int ret = spi_flash_cmd_write_enable(flash);
115 debug("SF: Enabling Write failed\n");
120 sst_disable_writing(struct spi_flash *flash)
122 int ret = spi_flash_cmd_write_disable(flash);
124 debug("SF: Disabling Write failed\n");
129 sst_byte_write(struct spi_flash *flash, u32 offset, const void *buf)
139 debug("BP[%02x]: 0x%p => cmd = { 0x%02x 0x%06x }\n",
140 spi_w8r8(flash->spi, CMD_SST_RDSR), buf, cmd[0], offset);
142 ret = sst_enable_writing(flash);
146 ret = spi_flash_cmd_write(flash->spi, cmd, sizeof(cmd), buf, 1);
150 return spi_flash_cmd_wait_ready(flash, SPI_FLASH_PROG_TIMEOUT);
154 sst_write_wp(struct spi_flash *flash, u32 offset, size_t len, const void *buf)
156 size_t actual, cmd_len;
160 ret = spi_claim_bus(flash->spi);
162 debug("SF: Unable to claim SPI bus\n");
166 /* If the data is not word aligned, write out leading single byte */
169 ret = sst_byte_write(flash, offset, buf);
175 ret = sst_enable_writing(flash);
180 cmd[0] = CMD_SST_AAI_WP;
181 cmd[1] = offset >> 16;
182 cmd[2] = offset >> 8;
185 for (; actual < len - 1; actual += 2) {
186 debug("WP[%02x]: 0x%p => cmd = { 0x%02x 0x%06x }\n",
187 spi_w8r8(flash->spi, CMD_SST_RDSR), buf + actual, cmd[0],
190 ret = spi_flash_cmd_write(flash->spi, cmd, cmd_len,
193 debug("SF: sst word program failed\n");
197 ret = spi_flash_cmd_wait_ready(flash, SPI_FLASH_PROG_TIMEOUT);
206 ret = sst_disable_writing(flash);
208 /* If there is a single trailing byte, write it out */
209 if (!ret && actual != len)
210 ret = sst_byte_write(flash, offset, buf + actual);
213 debug("SF: sst: program %s %zu bytes @ 0x%zx\n",
214 ret ? "failure" : "success", len, offset - actual);
216 spi_release_bus(flash->spi);
220 static int sst_erase(struct spi_flash *flash, u32 offset, size_t len)
222 return spi_flash_cmd_erase(flash, CMD_SST_SE, offset, len);
226 sst_unlock(struct spi_flash *flash)
231 ret = sst_enable_writing(flash);
237 ret = spi_flash_cmd_write(flash->spi, &cmd, 1, &status, 1);
239 debug("SF: Unable to set status byte\n");
241 debug("SF: sst: status = %x\n", spi_w8r8(flash->spi, CMD_SST_RDSR));
247 spi_flash_probe_sst(struct spi_slave *spi, u8 *idcode)
249 const struct sst_spi_flash_params *params;
250 struct sst_spi_flash *stm;
253 for (i = 0; i < ARRAY_SIZE(sst_spi_flash_table); ++i) {
254 params = &sst_spi_flash_table[i];
255 if (params->idcode1 == idcode[2])
259 if (i == ARRAY_SIZE(sst_spi_flash_table)) {
260 debug("SF: Unsupported SST ID %02x\n", idcode[1]);
264 stm = malloc(sizeof(*stm));
266 debug("SF: Failed to allocate memory\n");
270 stm->params = params;
271 stm->flash.spi = spi;
272 stm->flash.name = params->name;
274 if (stm->params->flags & SST_FEAT_WP)
275 stm->flash.write = sst_write_wp;
277 stm->flash.write = spi_flash_cmd_write_multi;
278 stm->flash.erase = sst_erase;
279 stm->flash.read = spi_flash_cmd_read_fast;
280 stm->flash.page_size = SST_PAGE_SIZE;
281 stm->flash.sector_size = SST_SECTOR_SIZE;
282 stm->flash.size = stm->flash.sector_size * params->nr_sectors;
284 /* Flash powers up read-only, so clear BP# bits */
285 sst_unlock(&stm->flash);