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 struct sst_spi_flash_params
{
45 struct sst_spi_flash
{
46 struct spi_flash flash
;
47 const struct sst_spi_flash_params
*params
;
50 static inline struct sst_spi_flash
*to_sst_spi_flash(struct spi_flash
*flash
)
52 return container_of(flash
, struct sst_spi_flash
, flash
);
55 #define SST_SECTOR_SIZE (4 * 1024)
56 static const struct sst_spi_flash_params sst_spi_flash_table
[] = {
60 .name
= "SST25VF040B",
64 .name
= "SST25VF080B",
68 .name
= "SST25VF016B",
72 .name
= "SST25VF032B",
76 .name
= "SST25VF064C",
97 sst_enable_writing(struct spi_flash
*flash
)
99 int ret
= spi_flash_cmd_write_enable(flash
);
101 debug("SF: Enabling Write failed\n");
106 sst_disable_writing(struct spi_flash
*flash
)
108 int ret
= spi_flash_cmd(flash
->spi
, CMD_SST_WRDI
, NULL
, 0);
110 debug("SF: Disabling Write failed\n");
115 sst_byte_write(struct spi_flash
*flash
, u32 offset
, const void *buf
)
125 debug("BP[%02x]: 0x%p => cmd = { 0x%02x 0x%06x }\n",
126 spi_w8r8(flash
->spi
, CMD_SST_RDSR
), buf
, cmd
[0], offset
);
128 ret
= sst_enable_writing(flash
);
132 ret
= spi_flash_cmd_write(flash
->spi
, cmd
, sizeof(cmd
), buf
, 1);
136 return spi_flash_cmd_wait_ready(flash
, SPI_FLASH_PROG_TIMEOUT
);
140 sst_write(struct spi_flash
*flash
, u32 offset
, size_t len
, const void *buf
)
142 size_t actual
, cmd_len
;
146 ret
= spi_claim_bus(flash
->spi
);
148 debug("SF: Unable to claim SPI bus\n");
152 /* If the data is not word aligned, write out leading single byte */
155 ret
= sst_byte_write(flash
, offset
, buf
);
161 ret
= sst_enable_writing(flash
);
166 cmd
[0] = CMD_SST_AAI_WP
;
167 cmd
[1] = offset
>> 16;
168 cmd
[2] = offset
>> 8;
171 for (; actual
< len
- 1; actual
+= 2) {
172 debug("WP[%02x]: 0x%p => cmd = { 0x%02x 0x%06x }\n",
173 spi_w8r8(flash
->spi
, CMD_SST_RDSR
), buf
+ actual
, cmd
[0],
176 ret
= spi_flash_cmd_write(flash
->spi
, cmd
, cmd_len
,
179 debug("SF: sst word program failed\n");
183 ret
= spi_flash_cmd_wait_ready(flash
, SPI_FLASH_PROG_TIMEOUT
);
192 ret
= sst_disable_writing(flash
);
194 /* If there is a single trailing byte, write it out */
195 if (!ret
&& actual
!= len
)
196 ret
= sst_byte_write(flash
, offset
, buf
+ actual
);
199 debug("SF: sst: program %s %zu bytes @ 0x%zx\n",
200 ret
? "failure" : "success", len
, offset
- actual
);
202 spi_release_bus(flash
->spi
);
206 static int sst_erase(struct spi_flash
*flash
, u32 offset
, size_t len
)
208 return spi_flash_cmd_erase(flash
, CMD_SST_SE
, offset
, len
);
212 sst_unlock(struct spi_flash
*flash
)
217 ret
= sst_enable_writing(flash
);
223 ret
= spi_flash_cmd_write(flash
->spi
, &cmd
, 1, &status
, 1);
225 debug("SF: Unable to set status byte\n");
227 debug("SF: sst: status = %x\n", spi_w8r8(flash
->spi
, CMD_SST_RDSR
));
233 spi_flash_probe_sst(struct spi_slave
*spi
, u8
*idcode
)
235 const struct sst_spi_flash_params
*params
;
236 struct sst_spi_flash
*stm
;
239 for (i
= 0; i
< ARRAY_SIZE(sst_spi_flash_table
); ++i
) {
240 params
= &sst_spi_flash_table
[i
];
241 if (params
->idcode1
== idcode
[2])
245 if (i
== ARRAY_SIZE(sst_spi_flash_table
)) {
246 debug("SF: Unsupported SST ID %02x\n", idcode
[1]);
250 stm
= malloc(sizeof(*stm
));
252 debug("SF: Failed to allocate memory\n");
256 stm
->params
= params
;
257 stm
->flash
.spi
= spi
;
258 stm
->flash
.name
= params
->name
;
260 stm
->flash
.write
= sst_write
;
261 stm
->flash
.erase
= sst_erase
;
262 stm
->flash
.read
= spi_flash_cmd_read_fast
;
263 stm
->flash
.sector_size
= SST_SECTOR_SIZE
;
264 stm
->flash
.size
= stm
->flash
.sector_size
* params
->nr_sectors
;
266 /* Flash powers up read-only, so clear BP# bits */
267 sst_unlock(&stm
->flash
);