Chromium: arm: tegra: Add NAND support

board/tegra2/common/nand/HY27UF084G2B/tegra2_nand.c

+/*
+ * (C) Copyright 2006 Detlev Zundel, dzu@denx.de
+ * (C) Copyright 2006 DENX Software Engineering
+ * (C) Copyright 2011 NVIDIA Corporation <www.nvidia.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., 59 Temple Place, Suite 330, Boston,
+ * MA 02111-1307 USA
+ */
+
+#include <common.h>
+#include <asm/io.h>
+#include <nand.h>
+#include <asm/arch/gpio.h>
+#include "tegra2_nand.h"
+#include <asm/arch/nvcommon.h>
+#include "../../board.h"
+
+#define NAND_PIO_CMD_TIMEOUT_MS 100
+static int byte_count;
+
+static struct nand_ecclayout nand_soft_eccoob = {
+        .oobfree = {
+                {.offset = 40, .length = 24 }}
+};
+
+/**
+ * tegra2_nand_read_byte - [DEFAULT] read one byte from the chip
+ * @mtd:        MTD device structure
+ *
+ * Default read function for 8bit buswith
+ */
+static uint8_t tegra2_nand_read_byte(struct mtd_info *mtd)
+{
+        struct nand_chip *chip = mtd->priv;
+        int dword_read;
+
+        dword_read = readl(chip->IO_ADDR_R + NAND_RESP_0);
+        dword_read = dword_read >> (8 * byte_count);
+        byte_count ++;
+        return (uint8_t) dword_read;
+}
+
+/**
+ * tegra2_nand_write_buf - [DEFAULT] write buffer to chip
+ * @mtd:        MTD device structure
+ * @buf:        data buffer
+ * @len:        number of bytes to write
+ *
+ * Default write function for 8bit buswith
+ */
+static void tegra2_nand_write_buf(struct mtd_info *mtd, const uint8_t *buf, 
+        int len)
+{
+        int i, j, l, l2;
+        struct nand_chip *chip = mtd->priv;
+
+        for (i = 0; i < len/4; i++)
+        {
+                l = ((int *)buf)[i];
+                writel(l, chip->IO_ADDR_W+ NAND_RESP_0);
+                /* Go, PIO, Tx, TRANS_SIZE=3 for 4 bytes, A_valid, CE0 */
+                writel(Bit31+Bit28+Bit27+(3<<20)+Bit19+Bit8, chip->IO_ADDR_W +

[Tom Warren, 2011/03/10 17:06:23]

I had this comment in Patchset 1, but I must not have pushed it.

I don't like the use of BitXX, etc. here - it has no context. Please #define
NAND_CMD_GO, _PIO, _TX, _A_VALID, etc. in the header file and use the
more-informative names throughout. That way a future maintainer/porter (me, when
I go to push this upstream) can look at the TRM and see what it is you are
doing. Thanks.

+                        NAND_COMMAND_0);
+                if (!tegra2_nand_waitfor_GO_cleared(mtd))
+                        printf("Command timeout during write_buf\n");
+        }
+        if ((len % 4) != 0)
+        {
+                l = 0;
+                for (j=0; j<(len %4); j++)
+                {
+                        l2 = (int) buf[i*4+j];
+                        l |= (l2<< (8*j));
+                }
+                writel(l, chip->IO_ADDR_W+ NAND_RESP_0);
+                /* Go, PIO, Tx, TRANS_SIZE, A_valid, CE0 */
+                writel(Bit31+Bit28+Bit27+(((len % 4)-1)<<20)+Bit19+Bit8, 
+                        chip->IO_ADDR_W + NAND_COMMAND_0);
+                if (!tegra2_nand_waitfor_GO_cleared(mtd))
+                        printf("Command timeout during write_buf\n");
+        }
+}
+
+/**
+ * tegra2_nand_read_buf - [DEFAULT] read chip data into buffer
+ * @mtd:        MTD device structure
+ * @buf:        buffer to store date
+ * @len:        number of bytes to read
+ *
+ * Default read function for 8bit buswith
+ */
+static void tegra2_nand_read_buf(struct mtd_info *mtd, uint8_t *buf, int len)
+{
+        int i, j, l;
+        struct nand_chip *chip = mtd->priv;
+        int *buf_dword;
+
+        buf_dword = (int *) buf;
+        for (i = 0; i < len/4; i++)
+        {
+                /* Go, PIO, Rx, TRANS_SIZE=3 for 4 bytes, A_valid, CE0 */
+                writel(Bit31+Bit28+Bit26+(3<<20)+Bit19+Bit8, chip->IO_ADDR_W +
+                        NAND_COMMAND_0);
+                if (!tegra2_nand_waitfor_GO_cleared(mtd))
+                        printf("Command timeout during read_buf\n");
+                l = readl(chip->IO_ADDR_R+ NAND_RESP_0);
+                buf_dword[i] = l;
+        }
+        if ((len % 4) != 0)
+        {
+                /* Go, PIO, Rx, TRANS_SIZE, A_valid, CE0 */
+                writel(Bit31+Bit28+Bit26+(((len % 4)-1)<<20)+Bit19+Bit8, 
+                        chip->IO_ADDR_W + NAND_COMMAND_0);
+                if (!tegra2_nand_waitfor_GO_cleared(mtd))
+                        printf("Command timeout during read_buf\n");
+                l = readl(chip->IO_ADDR_R+ NAND_RESP_0);
+                for (j=0; j<(len %4); j++)
+                {
+                        buf[i*4+j] = (char) (l>>(8*j));
+                }
+        }
+}
+
+/*
+ * = 1 - ready
+ *   0 - not ready
+ */
+static int tegra2_nand_waitfor_GO_cleared(struct mtd_info *mtd)
+{
+        struct nand_chip *this = mtd->priv;
+        int     i;
+
+        for (i=0; i< NAND_PIO_CMD_TIMEOUT_MS * 1000; i++)
+        {
+                if (!(readl(this->IO_ADDR_R + NAND_CMD_REG1_0) & Bit31))
+                                break;
+                else
+                                udelay(1);
+        }
+        if (i== NAND_PIO_CMD_TIMEOUT_MS * 1000)
+                return 0;
+        return 1;
+}
+
+/*
+ * = 1 - ready
+ *   0 - not ready
+ */
+static int tegra2_nand_dev_ready(struct mtd_info *mtd)
+{
+        register struct nand_chip *chip = mtd->priv;
+        int     status;
+
+        writel(NAND_CMD_STATUS, chip->IO_ADDR_W + NAND_CMD_REG1_0);
+        /* Go, CLE, PIO, Rx, CE0, 0+1 transfer byte */
+        writel(Bit31+Bit30+Bit28+Bit26+(0<<20)+Bit8, chip->IO_ADDR_W + 
+                NAND_COMMAND_0);
+        if (!(tegra2_nand_waitfor_GO_cleared(mtd)))
+                printf("NAND_CMD_STATUS command timeout\n");
+        udelay(1);
+        status = readl(chip->IO_ADDR_R + NAND_RESP_0);
+        if (status & NAND_STATUS_READY)
+                return 1;
+        return 0;
+}
+
+/*
+ *      hardware specific access to control-lines
+ */
+static void tegra2_nand_hwcontrol(struct mtd_info *mtd, int cmd, 
+        unsigned int ctrl)
+{
+}
+
+/**
+ * tegra2_nand_command - [DEFAULT] Send command to NAND device
+ * @mtd:        MTD device structure
+ * @command:    the command to be sent
+ * @column:     the column address for this command, -1 if none
+ * @page_addr:  the page address for this command, -1 if none
+ */
+static void tegra2_nand_command(struct mtd_info *mtd, unsigned int command,
+                         int column, int page_addr)
+{
+        register struct nand_chip *chip = mtd->priv;
+
+        /*
+         * Write out the command to the device.
+         */
+        if (mtd->writesize < 2048) {
+                /* Only command NAND_CMD_RESET or NAND_CMD_READID will come
+                 * here before mtd->writesize is initialized, we don't have
+                 * any action here because page size of NAND HY27UF084G2B 
+                 * is 2048 bytes and mtd->writesize will be 2048 after 
+                 * initialized. */
+        }
+        else
+        {
+                /* Emulate NAND_CMD_READOOB */
+                if (command == NAND_CMD_READOOB)
+                {
+                        column += mtd->writesize;
+                        command = NAND_CMD_READ0;
+                }
+
+                if (column != -1 || page_addr != -1)
+                {
+                        /* Serially input address */
+                        if (column != -1)
+                        {
+                                /* Adjust columns for 16 bit buswidth */
+                                if (chip->options & NAND_BUSWIDTH_16)
+                                        column >>= 1;
+                        }
+                }
+        }
+
+        /*
+         * program and erase have their own busy handlers
+         * status and sequential in needs no delay
+         */
+        switch (command) {
+        case NAND_CMD_READID:
+                writel(NAND_CMD_READID, chip->IO_ADDR_W + NAND_CMD_REG1_0);
+                writel(Bit31+Bit30+Bit29+Bit28+Bit26+(3<<20)+Bit8, 
+                        chip->IO_ADDR_W + NAND_COMMAND_0);
+                byte_count = 0;
+                break;
+        case NAND_CMD_READ0:
+                writel(NAND_CMD_READ0, chip->IO_ADDR_W + NAND_CMD_REG1_0);
+                writel(NAND_CMD_READSTART, chip->IO_ADDR_W + NAND_CMD_REG2_0);
+                writel((page_addr <<16)+ (column & 0xFFFF), chip->IO_ADDR_W + 
+                        NAND_ADDR_REG1_0);
+                writel(page_addr >>16, chip->IO_ADDR_W + NAND_ADDR_REG2_0);
+                /* Go, CLE, ALE, PIO, SEC_CMD, CE0, 4+1 address cycles */
+                writel(Bit31+Bit30+Bit29+Bit28+Bit25+Bit8+4, chip->IO_ADDR_W + 
+                        NAND_COMMAND_0);
+                byte_count = 0;
+                break;
+        case NAND_CMD_SEQIN:
+                writel(NAND_CMD_SEQIN, chip->IO_ADDR_W + NAND_CMD_REG1_0);
+                writel(NAND_CMD_PAGEPROG, chip->IO_ADDR_W + NAND_CMD_REG2_0);
+                writel((page_addr <<16)+ (column & 0xFFFF), chip->IO_ADDR_W + 
+                        NAND_ADDR_REG1_0);
+                writel(page_addr >>16, chip->IO_ADDR_W + NAND_ADDR_REG2_0);
+                /* Go, CLE, ALE, PIO, SEC_CMD, AFT_DAT, CE0, 4+1 address cycles */
+                writel(Bit31+Bit30+Bit29+Bit28+Bit25+Bit24+Bit8+4, chip->IO_ADDR_W + 
+                        NAND_COMMAND_0);
+                break;
+        case NAND_CMD_PAGEPROG:
+                writel(NAND_CMD_PAGEPROG, chip->IO_ADDR_W + NAND_CMD_REG1_0);
+                /* Go, CLE, CE0 */
+                writel(Bit31+Bit30+Bit8, chip->IO_ADDR_W + NAND_COMMAND_0);
+                break;
+        case NAND_CMD_ERASE1:
+                writel(NAND_CMD_ERASE1, chip->IO_ADDR_W + NAND_CMD_REG1_0);
+                writel(NAND_CMD_ERASE2, chip->IO_ADDR_W + NAND_CMD_REG2_0);
+                writel(page_addr, chip->IO_ADDR_W + NAND_ADDR_REG1_0);
+                /* Go, CLE, ALE, SEC_CMD, CE0, 2+1 address cycles */
+                writel(Bit31+Bit30+Bit29+Bit25+Bit8+2, chip->IO_ADDR_W + 
+                        NAND_COMMAND_0);
+                break;
+        case NAND_CMD_RNDOUT:
+                writel(NAND_CMD_RNDOUT, chip->IO_ADDR_W + NAND_CMD_REG1_0);
+                writel(NAND_CMD_RNDOUTSTART, chip->IO_ADDR_W + NAND_CMD_REG2_0);
+                writel((column & 0xFFFF), chip->IO_ADDR_W + NAND_ADDR_REG1_0);
+                /* Go, CLE, ALE, PIO, SEC_CMD, CE0, 1+1 address cycles */
+                writel(Bit31+Bit30+Bit29+Bit28+Bit25+Bit8+1, chip->IO_ADDR_W + 
+                        NAND_COMMAND_0);
+                break;
+        case NAND_CMD_ERASE2:
+                return;
+        case NAND_CMD_STATUS:
+                writel(NAND_CMD_STATUS, chip->IO_ADDR_W + NAND_CMD_REG1_0);
+                /* Go, CLE, PIO, Rx, CE0, 0+1 transfer byte */
+                writel(Bit31+Bit30+Bit28+Bit26+(0<<20)+Bit8, chip->IO_ADDR_W + 
+                        NAND_COMMAND_0);
+                byte_count = 0;
+                break;
+
+        case NAND_CMD_RESET:
+                writel(NAND_CMD_RESET, chip->IO_ADDR_W + NAND_CMD_REG1_0);
+                /* Go, CLE, CE0 */
+                writel(Bit31+Bit30+Bit8, chip->IO_ADDR_W + NAND_COMMAND_0);
+                break;
+        default:
+                /*
+                 * If we don't have access to the busy pin, we apply the given
+                 * command delay
+                 */
+                if (!chip->dev_ready)
+                {
+                        udelay(chip->chip_delay);
+                        return;
+                }
+        }
+        if (!tegra2_nand_waitfor_GO_cleared(mtd))
+                printf("Command 0x%02X timeout\n", command);
+
+        if (command == NAND_CMD_READ0)
+                udelay(25);
+        else
+                udelay(1);
+}
+
+/*
+ * Board-specific NAND initialization. The following members of the
+ * argument are board-specific (per include/linux/mtd/nand.h):
+ * - IO_ADDR_R?: address to read the 8 I/O lines of the flash device
+ * - IO_ADDR_W?: address to write the 8 I/O lines of the flash device
+ * - cmd_ctrl: hardwarespecific function for accesing control-lines
+ * - dev_ready: hardwarespecific function for  accesing device ready/busy line
+ * - enable_hwecc?: function to enable (reset)  hardware ecc generator. Must
+ *   only be provided if a hardware ECC is available
+ * - eccm.ode: mode of ecc, see defines
+ * - chip_delay: chip dependent delay for transfering data from array to
+ *   read regs (tR)
+ * - options: various chip options. They can partly be set to inform
+ *   nand_scan about special functionality. See the defines for further
+ *   explanation
+ * Members with a "?" were not set in the merged testing-NAND branch,
+ * so they are not set here either.
+ */
+int board_nand_init(struct nand_chip *nand)
+{
+#if (LINUX_MACH_TYPE == MACH_TYPE_SEABOARD)
+        /* GPIO port H bit 3, H.03, GMI_AD11->MFG_MODE_R, */
+        tg2_gpio_direction_output(7, 3, 1);
+#endif
+#if (LINUX_MACH_TYPE == MACH_TYPE_HARMONY)
+        /* GPIO port C bit 7, C.07, GMI_WP->NAND_WP */
+        tg2_gpio_direction_output(2, 7, 1);
+#endif
+        nand->cmd_ctrl = tegra2_nand_hwcontrol;
+        nand->dev_ready  = tegra2_nand_dev_ready;
+        nand->ecc.mode = NAND_ECC_NONE;
+        nand->ecc.layout = &nand_soft_eccoob;
+        nand->options = LP_OPTIONS;
+        nand->cmdfunc = tegra2_nand_command;
+        nand->read_byte = tegra2_nand_read_byte;
+        nand->read_buf = tegra2_nand_read_buf;
+        nand->write_buf = tegra2_nand_write_buf;
+        return 0;
+}