drivers/mtd/spi/macronix.c

   1 /*
   2  * Copyright 2009(C) Marvell International Ltd. and its affiliates
   3  * Prafulla Wadaskar <prafulla@marvell.com>
   4  *
   5  * Based on drivers/mtd/spi/stmicro.c
   6  *
   7  * Copyright 2008, Network Appliance Inc.
   8  * Jason McMullan <mcmullan@netapp.com>
   9  *
  10  * Copyright (C) 2004-2007 Freescale Semiconductor, Inc.
  11  * TsiChung Liew (Tsi-Chung.Liew@freescale.com)
  12  *
  13  * See file CREDITS for list of people who contributed to this
  14  * project.
  15  *
  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.
  20  *
  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.
  25  *
  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,
  29  * MA 02110-1301 USA
  30  */
  31
  32 #include <common.h>
  33 #include <malloc.h>
  34 #include <spi_flash.h>
  35
  36 #include "spi_flash_internal.h"
  37
  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 */
  51
  52 struct macronix_spi_flash_params {
  53         u16 idcode;
  54         u16 page_size;
  55         u16 pages_per_sector;
  56         u16 sectors_per_block;
  57         u16 nr_blocks;
  58         const char *name;
  59 };
  60
  61 struct macronix_spi_flash {
  62         struct spi_flash flash;
  63         const struct macronix_spi_flash_params *params;
  64 };
  65
  66 static inline struct macronix_spi_flash *to_macronix_spi_flash(struct spi_flash
  67                                                                *flash)
  68 {
  69         return container_of(flash, struct macronix_spi_flash, flash);
  70 }
  71
  72 static const struct macronix_spi_flash_params macronix_spi_flash_table[] = {
  73         {
  74                 .idcode = 0x2015,
  75                 .page_size = 256,
  76                 .pages_per_sector = 16,
  77                 .sectors_per_block = 16,
  78                 .nr_blocks = 32,
  79                 .name = "MX25L1605D",
  80         },
  81         {
  82                 .idcode = 0x2016,
  83                 .page_size = 256,
  84                 .pages_per_sector = 16,
  85                 .sectors_per_block = 16,
  86                 .nr_blocks = 64,
  87                 .name = "MX25L3205D",
  88         },
  89         {
  90                 .idcode = 0x2017,
  91                 .page_size = 256,
  92                 .pages_per_sector = 16,
  93                 .sectors_per_block = 16,
  94                 .nr_blocks = 128,
  95                 .name = "MX25L6405D",
  96         },
  97         {
  98                 .idcode = 0x2018,
  99                 .page_size = 256,
 100                 .pages_per_sector = 16,
 101                 .sectors_per_block = 16,
 102                 .nr_blocks = 256,
 103                 .name = "MX25L12805D",
 104         },
 105         {
 106                 .idcode = 0x2618,
 107                 .page_size = 256,
 108                 .pages_per_sector = 16,
 109                 .sectors_per_block = 16,
 110                 .nr_blocks = 256,
 111                 .name = "MX25L12855E",
 112         },
 113 };
 114
 115 static int macronix_read_fast(struct spi_flash *flash,
 116                               u32 offset, size_t len, void *buf)
 117 {
 118         struct macronix_spi_flash *mcx = to_macronix_spi_flash(flash);
 119         unsigned long page_addr;
 120         unsigned long page_size;
 121         u8 cmd[5];
 122
 123         page_size = mcx->params->page_size;
 124         page_addr = offset / page_size;
 125
 126         cmd[0] = CMD_READ_ARRAY_FAST;
 127         cmd[1] = page_addr >> 8;
 128         cmd[2] = page_addr;
 129         cmd[3] = offset % page_size;
 130         cmd[4] = 0x00;
 131
 132         return spi_flash_read_common(flash, cmd, sizeof(cmd), buf, len);
 133 }
 134
 135 static int macronix_write(struct spi_flash *flash,
 136                           u32 offset, size_t len, const void *buf)
 137 {
 138         struct macronix_spi_flash *mcx = to_macronix_spi_flash(flash);
 139         unsigned long page_addr;
 140         unsigned long byte_addr;
 141         unsigned long page_size;
 142         size_t chunk_len;
 143         size_t actual;
 144         int ret;
 145         u8 cmd[4];
 146
 147         page_size = mcx->params->page_size;
 148         page_addr = offset / page_size;
 149         byte_addr = offset % page_size;
 150
 151         ret = spi_claim_bus(flash->spi);
 152         if (ret) {
 153                 debug("SF: Unable to claim SPI bus\n");
 154                 return ret;
 155         }
 156
 157         ret = 0;
 158         for (actual = 0; actual < len; actual += chunk_len) {
 159                 chunk_len = min(len - actual, page_size - byte_addr);
 160
 161                 cmd[0] = CMD_MX25XX_PP;
 162                 cmd[1] = page_addr >> 8;
 163                 cmd[2] = page_addr;
 164                 cmd[3] = byte_addr;
 165
 166                 debug
 167                     ("PP: 0x%p => cmd = { 0x%02x 0x%02x%02x%02x } chunk_len = %d\n",
 168                      buf + actual, cmd[0], cmd[1], cmd[2], cmd[3], chunk_len);
 169
 170                 ret = spi_flash_cmd(flash->spi, CMD_MX25XX_WREN, NULL, 0);
 171                 if (ret < 0) {
 172                         debug("SF: Enabling Write failed\n");
 173                         break;
 174                 }
 175
 176                 ret = spi_flash_cmd_write(flash->spi, cmd, 4,
 177                                           buf + actual, chunk_len);
 178                 if (ret < 0) {
 179                         debug("SF: Macronix Page Program failed\n");
 180                         break;
 181                 }
 182
 183                 ret = spi_flash_cmd_wait_ready(flash, SPI_FLASH_PROG_TIMEOUT);
 184                 if (ret)
 185                         break;
 186
 187                 page_addr++;
 188                 byte_addr = 0;
 189         }
 190
 191         debug("SF: Macronix: Successfully programmed %u bytes @ 0x%x\n",
 192               len, offset);
 193
 194         spi_release_bus(flash->spi);
 195         return ret;
 196 }
 197
 198 int macronix_erase(struct spi_flash *flash, u32 offset, size_t len)
 199 {
 200         struct macronix_spi_flash *mcx = to_macronix_spi_flash(flash);
 201         return spi_flash_cmd_erase(flash, CMD_MX25XX_BE,
 202                 mcx->params->page_size * mcx->params->pages_per_sector *
 203                         mcx->params->sectors_per_block,
 204                 offset, len);
 205 }
 206
 207 struct spi_flash *spi_flash_probe_macronix(struct spi_slave *spi, u8 *idcode)
 208 {
 209         const struct macronix_spi_flash_params *params;
 210         struct macronix_spi_flash *mcx;
 211         unsigned int i;
 212         u16 id = idcode[2] | idcode[1] << 8;
 213
 214         for (i = 0; i < ARRAY_SIZE(macronix_spi_flash_table); i++) {
 215                 params = &macronix_spi_flash_table[i];
 216                 if (params->idcode == id)
 217                         break;
 218         }
 219
 220         if (i == ARRAY_SIZE(macronix_spi_flash_table)) {
 221                 debug("SF: Unsupported Macronix ID %04x\n", id);
 222                 return NULL;
 223         }
 224
 225         mcx = malloc(sizeof(*mcx));
 226         if (!mcx) {
 227                 debug("SF: Failed to allocate memory\n");
 228                 return NULL;
 229         }
 230
 231         mcx->params = params;
 232         mcx->flash.spi = spi;
 233         mcx->flash.name = params->name;
 234
 235         mcx->flash.write = macronix_write;
 236         mcx->flash.erase = macronix_erase;
 237         mcx->flash.read = macronix_read_fast;
 238         mcx->flash.size = params->page_size * params->pages_per_sector
 239             * params->sectors_per_block * params->nr_blocks;
 240
 241         printf("SF: Detected %s with page size %u, total ",
 242                params->name, params->page_size);
 243         print_size(mcx->flash.size, "\n");
 244
 245         return &mcx->flash;
 246 }