sf: new Macronix MX25xx SPI flash driver
authorPrafulla Wadaskar <prafulla@marvell.com>
Mon, 6 Apr 2009 15:54:43 +0000 (21:24 +0530)
committerWolfgang Denk <wd@denx.de>
Fri, 12 Jun 2009 18:47:18 +0000 (20:47 +0200)
Added macronix SF driver for MTD framework
MX25L12805D is supported and tested
TBD: sector erase implementation, other deivces support

Signed-off-by: Prafulla Wadaskar <prafulla@marvell.com>
Signed-off-by: Mike Frysinger <vapier@gentoo.org>
drivers/mtd/spi/Makefile
drivers/mtd/spi/macronix.c [new file with mode: 0644]
drivers/mtd/spi/spi_flash.c
drivers/mtd/spi/spi_flash_internal.h

index a71b16e..27dcbff 100644 (file)
@@ -27,6 +27,7 @@ LIB   := $(obj)libspi_flash.a
 
 COBJS-$(CONFIG_SPI_FLASH)      += spi_flash.o
 COBJS-$(CONFIG_SPI_FLASH_ATMEL)        += atmel.o
+COBJS-$(CONFIG_SPI_FLASH_MACRONIX)     += macronix.o
 COBJS-$(CONFIG_SPI_FLASH_SPANSION)     += spansion.o
 COBJS-$(CONFIG_SPI_FLASH_SST)  += sst.o
 COBJS-$(CONFIG_SPI_FLASH_STMICRO)      += stmicro.o
diff --git a/drivers/mtd/spi/macronix.c b/drivers/mtd/spi/macronix.c
new file mode 100644 (file)
index 0000000..9464c84
--- /dev/null
@@ -0,0 +1,312 @@
+/*
+ * Copyright 2009(C) Marvell International Ltd. and its affiliates
+ * Prafulla Wadaskar <prafulla@marvell.com>
+ *
+ * Based on drivers/mtd/spi/stmicro.c
+ *
+ * Copyright 2008, Network Appliance Inc.
+ * Jason McMullan <mcmullan@netapp.com>
+ *
+ * Copyright (C) 2004-2007 Freescale Semiconductor, Inc.
+ * TsiChung Liew (Tsi-Chung.Liew@freescale.com)
+ *
+ * See file CREDITS for list of people who contributed to this
+ * project.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of
+ * the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.         See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * MA 02110-1301 USA
+ */
+
+#include <common.h>
+#include <malloc.h>
+#include <spi_flash.h>
+
+#include "spi_flash_internal.h"
+
+/* MX25xx-specific commands */
+#define CMD_MX25XX_WREN                0x06    /* Write Enable */
+#define CMD_MX25XX_WRDI                0x04    /* Write Disable */
+#define CMD_MX25XX_RDSR                0x05    /* Read Status Register */
+#define CMD_MX25XX_WRSR                0x01    /* Write Status Register */
+#define CMD_MX25XX_READ                0x03    /* Read Data Bytes */
+#define CMD_MX25XX_FAST_READ   0x0b    /* Read Data Bytes at Higher Speed */
+#define CMD_MX25XX_PP          0x02    /* Page Program */
+#define CMD_MX25XX_SE          0x20    /* Sector Erase */
+#define CMD_MX25XX_BE          0xD8    /* Block Erase */
+#define CMD_MX25XX_CE          0xc7    /* Chip Erase */
+#define CMD_MX25XX_DP          0xb9    /* Deep Power-down */
+#define CMD_MX25XX_RES         0xab    /* Release from DP, and Read Signature */
+
+#define MXIC_ID_MX2516         0x15
+#define MXIC_ID_MX2520         0x12
+#define MXIC_ID_MX2532         0x16
+#define MXIC_ID_MX2540         0x13
+#define MXIC_ID_MX2564         0x17
+#define MXIC_ID_MX2580         0x14
+#define MXIC_ID_MX25128                0x18
+
+#define MACRONIX_SR_WIP                (1 << 0)        /* Write-in-Progress */
+
+struct macronix_spi_flash_params {
+       u8 idcode1;
+       u16 page_size;
+       u16 pages_per_sector;
+       u16 sectors_per_block;
+       u16 nr_blocks;
+       const char *name;
+};
+
+struct macronix_spi_flash {
+       struct spi_flash flash;
+       const struct macronix_spi_flash_params *params;
+};
+
+static inline struct macronix_spi_flash *to_macronix_spi_flash(struct spi_flash
+                                                              *flash)
+{
+       return container_of(flash, struct macronix_spi_flash, flash);
+}
+
+static const struct macronix_spi_flash_params macronix_spi_flash_table[] = {
+       {
+               .idcode1 = MXIC_ID_MX25128,
+               .page_size = 256,
+               .pages_per_sector = 16,
+               .sectors_per_block = 16,
+               .nr_blocks = 256,
+               .name = "MX25L12805D",
+       },
+};
+
+static int macronix_wait_ready(struct spi_flash *flash, unsigned long timeout)
+{
+       struct spi_slave *spi = flash->spi;
+       unsigned long timebase;
+       int ret;
+       u8 status;
+       u8 cmd = CMD_MX25XX_RDSR;
+
+       ret = spi_xfer(spi, 8, &cmd, NULL, SPI_XFER_BEGIN);
+       if (ret) {
+               debug("SF: Failed to send command %02x: %d\n", cmd, ret);
+               return ret;
+       }
+
+       timebase = get_timer(0);
+       do {
+               ret = spi_xfer(spi, 8, NULL, &status, 0);
+               if (ret)
+                       return -1;
+
+               if ((status & MACRONIX_SR_WIP) == 0)
+                       break;
+
+       } while (get_timer(timebase) < timeout);
+
+       spi_xfer(spi, 0, NULL, NULL, SPI_XFER_END);
+
+       if ((status & MACRONIX_SR_WIP) == 0)
+               return 0;
+
+       /* Timed out */
+       return -1;
+}
+
+static int macronix_read_fast(struct spi_flash *flash,
+                             u32 offset, size_t len, void *buf)
+{
+       struct macronix_spi_flash *mcx = to_macronix_spi_flash(flash);
+       unsigned long page_addr;
+       unsigned long page_size;
+       u8 cmd[5];
+
+       page_size = mcx->params->page_size;
+       page_addr = offset / page_size;
+
+       cmd[0] = CMD_READ_ARRAY_FAST;
+       cmd[1] = page_addr >> 8;
+       cmd[2] = page_addr;
+       cmd[3] = offset % page_size;
+       cmd[4] = 0x00;
+
+       return spi_flash_read_common(flash, cmd, sizeof(cmd), buf, len);
+}
+
+static int macronix_write(struct spi_flash *flash,
+                         u32 offset, size_t len, const void *buf)
+{
+       struct macronix_spi_flash *mcx = to_macronix_spi_flash(flash);
+       unsigned long page_addr;
+       unsigned long byte_addr;
+       unsigned long page_size;
+       size_t chunk_len;
+       size_t actual;
+       int ret;
+       u8 cmd[4];
+
+       page_size = mcx->params->page_size;
+       page_addr = offset / page_size;
+       byte_addr = offset % page_size;
+
+       ret = spi_claim_bus(flash->spi);
+       if (ret) {
+               debug("SF: Unable to claim SPI bus\n");
+               return ret;
+       }
+
+       ret = 0;
+       for (actual = 0; actual < len; actual += chunk_len) {
+               chunk_len = min(len - actual, page_size - byte_addr);
+
+               cmd[0] = CMD_MX25XX_PP;
+               cmd[1] = page_addr >> 8;
+               cmd[2] = page_addr;
+               cmd[3] = byte_addr;
+
+               debug
+                   ("PP: 0x%p => cmd = { 0x%02x 0x%02x%02x%02x } chunk_len = %d\n",
+                    buf + actual, cmd[0], cmd[1], cmd[2], cmd[3], chunk_len);
+
+               ret = spi_flash_cmd(flash->spi, CMD_MX25XX_WREN, NULL, 0);
+               if (ret < 0) {
+                       debug("SF: Enabling Write failed\n");
+                       break;
+               }
+
+               ret = spi_flash_cmd_write(flash->spi, cmd, 4,
+                                         buf + actual, chunk_len);
+               if (ret < 0) {
+                       debug("SF: Macronix Page Program failed\n");
+                       break;
+               }
+
+               ret = macronix_wait_ready(flash, SPI_FLASH_PROG_TIMEOUT);
+               if (ret < 0) {
+                       debug("SF: Macronix page programming timed out\n");
+                       break;
+               }
+
+               page_addr++;
+               byte_addr = 0;
+       }
+
+       debug("SF: Macronix: Successfully programmed %u bytes @ 0x%x\n",
+             len, offset);
+
+       spi_release_bus(flash->spi);
+       return ret;
+}
+
+int macronix_erase(struct spi_flash *flash, u32 offset, size_t len)
+{
+       struct macronix_spi_flash *mcx = to_macronix_spi_flash(flash);
+       unsigned long sector_size;
+       size_t actual;
+       int ret;
+       u8 cmd[4];
+
+       /*
+        * This function currently uses sector erase only.
+        * probably speed things up by using bulk erase
+        * when possible.
+        */
+
+       sector_size = mcx->params->page_size * mcx->params->pages_per_sector
+                       * mcx->params->sectors_per_block;
+
+       if (offset % sector_size || len % sector_size) {
+               debug("SF: Erase offset/length not multiple of sector size\n");
+               return -1;
+       }
+
+       len /= sector_size;
+       cmd[0] = CMD_MX25XX_BE;
+       cmd[2] = 0x00;
+       cmd[3] = 0x00;
+
+       ret = spi_claim_bus(flash->spi);
+       if (ret) {
+               debug("SF: Unable to claim SPI bus\n");
+               return ret;
+       }
+
+       ret = 0;
+       for (actual = 0; actual < len; actual++) {
+               cmd[1] = (offset / sector_size) + actual;
+
+               ret = spi_flash_cmd(flash->spi, CMD_MX25XX_WREN, NULL, 0);
+               if (ret < 0) {
+                       debug("SF: Enabling Write failed\n");
+                       break;
+               }
+
+               ret = spi_flash_cmd_write(flash->spi, cmd, 4, NULL, 0);
+               if (ret < 0) {
+                       debug("SF: Macronix page erase failed\n");
+                       break;
+               }
+
+               ret = macronix_wait_ready(flash, SPI_FLASH_PAGE_ERASE_TIMEOUT);
+               if (ret < 0) {
+                       debug("SF: Macronix page erase timed out\n");
+                       break;
+               }
+       }
+
+       debug("SF: Macronix: Successfully erased %u bytes @ 0x%x\n",
+             len * sector_size, offset);
+
+       spi_release_bus(flash->spi);
+       return ret;
+}
+
+struct spi_flash *spi_flash_probe_macronix(struct spi_slave *spi, u8 *idcode)
+{
+       const struct macronix_spi_flash_params *params;
+       struct macronix_spi_flash *mcx;
+       unsigned int i;
+
+       for (i = 0; i < ARRAY_SIZE(macronix_spi_flash_table); i++) {
+               params = &macronix_spi_flash_table[i];
+               if (params->idcode1 == idcode[2])
+                       break;
+       }
+
+       if (i == ARRAY_SIZE(macronix_spi_flash_table)) {
+               debug("SF: Unsupported Macronix ID %02x\n", idcode[1]);
+               return NULL;
+       }
+
+       mcx = malloc(sizeof(*mcx));
+       if (!mcx) {
+               debug("SF: Failed to allocate memory\n");
+               return NULL;
+       }
+
+       mcx->params = params;
+       mcx->flash.spi = spi;
+       mcx->flash.name = params->name;
+
+       mcx->flash.write = macronix_write;
+       mcx->flash.erase = macronix_erase;
+       mcx->flash.read = macronix_read_fast;
+       mcx->flash.size = params->page_size * params->pages_per_sector
+           * params->sectors_per_block * params->nr_blocks;
+
+       printf("SF: Detected %s with page size %u, total %u bytes\n",
+             params->name, params->page_size, mcx->flash.size);
+
+       return &mcx->flash;
+}
index 274895a..0c83231 100644 (file)
@@ -134,6 +134,11 @@ struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs,
                flash = spi_flash_probe_atmel(spi, idcode);
                break;
 #endif
+#ifdef CONFIG_SPI_FLASH_MACRONIX
+       case 0xc2:
+               flash = spi_flash_probe_macronix(spi, idcode);
+               break;
+#endif
 #ifdef CONFIG_SPI_FLASH_STMICRO
        case 0x20:
                flash = spi_flash_probe_stmicro(spi, idcode);
index 5d1e395..0612383 100644 (file)
@@ -46,5 +46,6 @@ int spi_flash_read_common(struct spi_flash *flash, const u8 *cmd,
 /* Manufacturer-specific probe functions */
 struct spi_flash *spi_flash_probe_spansion(struct spi_slave *spi, u8 *idcode);
 struct spi_flash *spi_flash_probe_atmel(struct spi_slave *spi, u8 *idcode);
+struct spi_flash *spi_flash_probe_macronix(struct spi_slave *spi, u8 *idcode);
 struct spi_flash *spi_flash_probe_sst(struct spi_slave *spi, u8 *idcode);
 struct spi_flash *spi_flash_probe_stmicro(struct spi_slave *spi, u8 *idcode);