drivers/mtd/spi/sst.c

   1 /*
   2  * Driver for SST serial flashes
   3  *
   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.
  11  *
  12  * Licensed under the GPL-2 or later.
  13  */
  14
  15 #include <common.h>
  16 #include <malloc.h>
  17 #include <spi_flash.h>
  18
  19 #include "spi_flash_internal.h"
  20
  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 */
  30
  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 */
  38
  39 struct sst_spi_flash_params {
  40         u8 idcode1;
  41         u16 nr_sectors;
  42         const char *name;
  43 };
  44
  45 struct sst_spi_flash {
  46         struct spi_flash flash;
  47         const struct sst_spi_flash_params *params;
  48 };
  49
  50 static inline struct sst_spi_flash *to_sst_spi_flash(struct spi_flash *flash)
  51 {
  52         return container_of(flash, struct sst_spi_flash, flash);
  53 }
  54
  55 #define SST_SECTOR_SIZE (4 * 1024)
  56 static const struct sst_spi_flash_params sst_spi_flash_table[] = {
  57         {
  58                 .idcode1 = 0x8d,
  59                 .nr_sectors = 128,
  60                 .name = "SST25VF040B",
  61         },{
  62                 .idcode1 = 0x8e,
  63                 .nr_sectors = 256,
  64                 .name = "SST25VF080B",
  65         },{
  66                 .idcode1 = 0x41,
  67                 .nr_sectors = 512,
  68                 .name = "SST25VF016B",
  69         },{
  70                 .idcode1 = 0x4a,
  71                 .nr_sectors = 1024,
  72                 .name = "SST25VF032B",
  73         },{
  74                 .idcode1 = 0x01,
  75                 .nr_sectors = 16,
  76                 .name = "SST25WF512",
  77         },{
  78                 .idcode1 = 0x02,
  79                 .nr_sectors = 32,
  80                 .name = "SST25WF010",
  81         },{
  82                 .idcode1 = 0x03,
  83                 .nr_sectors = 64,
  84                 .name = "SST25WF020",
  85         },{
  86                 .idcode1 = 0x04,
  87                 .nr_sectors = 128,
  88                 .name = "SST25WF040",
  89         },
  90 };
  91
  92 static int
  93 sst_enable_writing(struct spi_flash *flash)
  94 {
  95         int ret = spi_flash_cmd(flash->spi, CMD_SST_WREN, NULL, 0);
  96         if (ret)
  97                 debug("SF: Enabling Write failed\n");
  98         return ret;
  99 }
 100
 101 static int
 102 sst_disable_writing(struct spi_flash *flash)
 103 {
 104         int ret = spi_flash_cmd(flash->spi, CMD_SST_WRDI, NULL, 0);
 105         if (ret)
 106                 debug("SF: Disabling Write failed\n");
 107         return ret;
 108 }
 109
 110 static int
 111 sst_read_fast(struct spi_flash *flash, u32 offset, size_t len, void *buf)
 112 {
 113         u8 cmd[5] = {
 114                 CMD_READ_ARRAY_FAST,
 115                 offset >> 16,
 116                 offset >> 8,
 117                 offset,
 118                 0x00,
 119         };
 120         return spi_flash_read_common(flash, cmd, sizeof(cmd), buf, len);
 121 }
 122
 123 static int
 124 sst_byte_write(struct spi_flash *flash, u32 offset, const void *buf)
 125 {
 126         int ret;
 127         u8 cmd[4] = {
 128                 CMD_SST_BP,
 129                 offset >> 16,
 130                 offset >> 8,
 131                 offset,
 132         };
 133
 134         debug("BP[%02x]: 0x%p => cmd = { 0x%02x 0x%06x }\n",
 135                 spi_w8r8(flash->spi, CMD_SST_RDSR), buf, cmd[0], offset);
 136
 137         ret = sst_enable_writing(flash);
 138         if (ret)
 139                 return ret;
 140
 141         ret = spi_flash_cmd_write(flash->spi, cmd, sizeof(cmd), buf, 1);
 142         if (ret)
 143                 return ret;
 144
 145         return spi_flash_cmd_wait_ready(flash, SPI_FLASH_PROG_TIMEOUT);
 146 }
 147
 148 static int
 149 sst_write(struct spi_flash *flash, u32 offset, size_t len, const void *buf)
 150 {
 151         size_t actual, cmd_len;
 152         int ret;
 153         u8 cmd[4];
 154
 155         ret = spi_claim_bus(flash->spi);
 156         if (ret) {
 157                 debug("SF: Unable to claim SPI bus\n");
 158                 return ret;
 159         }
 160
 161         /* If the data is not word aligned, write out leading single byte */
 162         actual = offset % 2;
 163         if (actual) {
 164                 ret = sst_byte_write(flash, offset, buf);
 165                 if (ret)
 166                         goto done;
 167         }
 168         offset += actual;
 169
 170         ret = sst_enable_writing(flash);
 171         if (ret)
 172                 goto done;
 173
 174         cmd_len = 4;
 175         cmd[0] = CMD_SST_AAI_WP;
 176         cmd[1] = offset >> 16;
 177         cmd[2] = offset >> 8;
 178         cmd[3] = offset;
 179
 180         for (; actual < len - 1; actual += 2) {
 181                 debug("WP[%02x]: 0x%p => cmd = { 0x%02x 0x%06x }\n",
 182                      spi_w8r8(flash->spi, CMD_SST_RDSR), buf + actual, cmd[0],
 183                      offset);
 184
 185                 ret = spi_flash_cmd_write(flash->spi, cmd, cmd_len,
 186                                           buf + actual, 2);
 187                 if (ret) {
 188                         debug("SF: sst word program failed\n");
 189                         break;
 190                 }
 191
 192                 ret = spi_flash_cmd_wait_ready(flash, SPI_FLASH_PROG_TIMEOUT);
 193                 if (ret)
 194                         break;
 195
 196                 cmd_len = 1;
 197                 offset += 2;
 198         }
 199
 200         if (!ret)
 201                 ret = sst_disable_writing(flash);
 202
 203         /* If there is a single trailing byte, write it out */
 204         if (!ret && actual != len)
 205                 ret = sst_byte_write(flash, offset, buf + actual);
 206
 207  done:
 208         debug("SF: sst: program %s %zu bytes @ 0x%zx\n",
 209               ret ? "failure" : "success", len, offset - actual);
 210
 211         spi_release_bus(flash->spi);
 212         return ret;
 213 }
 214
 215 int
 216 sst_erase(struct spi_flash *flash, u32 offset, size_t len)
 217 {
 218         unsigned long sector_size;
 219         u32 start, end;
 220         int ret;
 221         u8 cmd[4];
 222
 223         /*
 224          * This function currently uses sector erase only.
 225          * Probably speed things up by using bulk erase
 226          * when possible.
 227          */
 228
 229         sector_size = SST_SECTOR_SIZE;
 230
 231         if (offset % sector_size) {
 232                 debug("SF: Erase offset not multiple of sector size\n");
 233                 return -1;
 234         }
 235
 236         ret = spi_claim_bus(flash->spi);
 237         if (ret) {
 238                 debug("SF: Unable to claim SPI bus\n");
 239                 return ret;
 240         }
 241
 242         cmd[0] = CMD_SST_SE;
 243         cmd[3] = 0;
 244         start = offset;
 245         end = start + len;
 246
 247         ret = 0;
 248         while (offset < end) {
 249                 cmd[1] = offset >> 16;
 250                 cmd[2] = offset >> 8;
 251                 offset += sector_size;
 252
 253                 debug("SF: erase %2x %2x %2x %2x (%x)\n", cmd[0], cmd[1],
 254                       cmd[2], cmd[3], offset);
 255
 256                 ret = sst_enable_writing(flash);
 257                 if (ret)
 258                         break;
 259
 260                 ret = spi_flash_cmd_write(flash->spi, cmd, sizeof(cmd), NULL, 0);
 261                 if (ret) {
 262                         debug("SF: sst page erase failed\n");
 263                         break;
 264                 }
 265
 266                 ret = spi_flash_cmd_wait_ready(flash, SPI_FLASH_PAGE_ERASE_TIMEOUT);
 267                 if (ret)
 268                         break;
 269         }
 270
 271         debug("SF: sst: Successfully erased %lu bytes @ 0x%x\n",
 272               len * sector_size, start);
 273
 274         spi_release_bus(flash->spi);
 275         return ret;
 276 }
 277
 278 static int
 279 sst_unlock(struct spi_flash *flash)
 280 {
 281         int ret;
 282         u8 cmd, status;
 283
 284         ret = sst_enable_writing(flash);
 285         if (ret)
 286                 return ret;
 287
 288         cmd = CMD_SST_WRSR;
 289         status = 0;
 290         ret = spi_flash_cmd_write(flash->spi, &cmd, 1, &status, 1);
 291         if (ret)
 292                 debug("SF: Unable to set status byte\n");
 293
 294         debug("SF: sst: status = %x\n", spi_w8r8(flash->spi, CMD_SST_RDSR));
 295
 296         return ret;
 297 }
 298
 299 struct spi_flash *
 300 spi_flash_probe_sst(struct spi_slave *spi, u8 *idcode)
 301 {
 302         const struct sst_spi_flash_params *params;
 303         struct sst_spi_flash *stm;
 304         size_t i;
 305
 306         for (i = 0; i < ARRAY_SIZE(sst_spi_flash_table); ++i) {
 307                 params = &sst_spi_flash_table[i];
 308                 if (params->idcode1 == idcode[2])
 309                         break;
 310         }
 311
 312         if (i == ARRAY_SIZE(sst_spi_flash_table)) {
 313                 debug("SF: Unsupported SST ID %02x\n", idcode[1]);
 314                 return NULL;
 315         }
 316
 317         stm = malloc(sizeof(*stm));
 318         if (!stm) {
 319                 debug("SF: Failed to allocate memory\n");
 320                 return NULL;
 321         }
 322
 323         stm->params = params;
 324         stm->flash.spi = spi;
 325         stm->flash.name = params->name;
 326
 327         stm->flash.write = sst_write;
 328         stm->flash.erase = sst_erase;
 329         stm->flash.read = sst_read_fast;
 330         stm->flash.size = SST_SECTOR_SIZE * params->nr_sectors;
 331
 332         printf("SF: Detected %s with page size %u, total ",
 333                params->name, SST_SECTOR_SIZE);
 334         print_size(stm->flash.size, "\n");
 335
 336         /* Flash powers up read-only, so clear BP# bits */
 337         sst_unlock(&stm->flash);
 338
 339         return &stm->flash;
 340 }