[MTD] Add initial support for OneNAND flash chips

OneNAND is a new flash technology from Samsung with integrated SRAM
buffers and logic interface.

Signed-off-by: Kyungmin Park <kyungmin.park@samsung.com>
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>

2 files changed, 301 insertions, 0 deletions

diff --git a/include/linux/mtd/onenand.h b/include/linux/mtd/onenand.h
new file mode 100644
index 000000000000..b9a64117d646
--- /dev/null
+++ b/include/linux/mtd/onenand.h
@@ -0,0 +1,134 @@
+/*
+ *  linux/include/linux/mtd/onenand.h
+ *
+ *  Copyright (C) 2005 Samsung Electronics
+ *  Kyungmin Park <kyungmin.park@samsung.com>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 as
+ * published by the Free Software Foundation.
+ */
+
+#ifndef __LINUX_MTD_ONENAND_H
+#define __LINUX_MTD_ONENAND_H
+
+#include <linux/spinlock.h>
+#include <linux/mtd/onenand_regs.h>
+
+#define MAX_BUFFERRAM           2
+
+/* Scan and identify a OneNAND device */
+extern int onenand_scan(struct mtd_info *mtd, int max_chips);
+/* Free resources held by the OneNAND device */
+extern void onenand_release(struct mtd_info *mtd);
+
+/**
+ * onenand_state_t - chip states
+ * Enumeration for OneNAND flash chip state
+ */
+typedef enum {
+        FL_READY,
+        FL_READING,
+        FL_WRITING,
+        FL_ERASING,
+        FL_SYNCING,
+        FL_UNLOCKING,
+        FL_LOCKING,
+} onenand_state_t;
+
+/**
+ * struct onenand_bufferram - OneNAND BufferRAM Data
+ * @param block         block address in BufferRAM
+ * @param page          page address in BufferRAM
+ * @param valid         valid flag
+ */
+struct onenand_bufferram {
+        int block;
+        int page;
+        int valid;
+};
+
+/**
+ * struct onenand_chip - OneNAND Private Flash Chip Data
+ * @param base          [BOARDSPECIFIC] address to access OneNAND
+ * @param chipsize      [INTERN] the size of one chip for multichip arrays
+ * @param device_id     [INTERN] device ID
+ * @param verstion_id   [INTERN] version ID
+ * @param options       [BOARDSPECIFIC] various chip options. They can partly be set to inform onenand_scan about
+ * @param erase_shift   [INTERN] number of address bits in a block
+ * @param page_shift    [INTERN] number of address bits in a page
+ * @param ppb_shift     [INTERN] number of address bits in a pages per block
+ * @param page_mask     [INTERN] a page per block mask
+ * @param bufferam_index        [INTERN] BufferRAM index
+ * @param bufferam      [INTERN] BufferRAM info
+ * @param readw         [REPLACEABLE] hardware specific function for read short
+ * @param writew        [REPLACEABLE] hardware specific function for write short
+ * @param command       [REPLACEABLE] hardware specific function for writing commands to the chip
+ * @param wait          [REPLACEABLE] hardware specific function for wait on ready
+ * @param read_bufferram        [REPLACEABLE] hardware specific function for BufferRAM Area
+ * @param write_bufferram       [REPLACEABLE] hardware specific function for BufferRAM Area
+ * @param chip_lock     [INTERN] spinlock used to protect access to this structure and the chip
+ * @param wq            [INTERN] wait queue to sleep on if a OneNAND operation is in progress
+ * @param state         [INTERN] the current state of the OneNAND device
+ * @param autooob       [REPLACEABLE] the default (auto)placement scheme
+ * @param priv          [OPTIONAL] pointer to private chip date
+ */
+struct onenand_chip {
+        void __iomem            *base;
+        unsigned int            chipsize;
+        unsigned int            device_id;
+        unsigned int            options;
+
+        unsigned int            erase_shift;
+        unsigned int            page_shift;
+        unsigned int            ppb_shift;      /* Pages per block shift */
+        unsigned int            page_mask;
+
+        unsigned int            bufferram_index;
+        struct onenand_bufferram        bufferram[MAX_BUFFERRAM];
+
+        int (*command)(struct mtd_info *mtd, int cmd, loff_t address, size_t len);
+        int (*wait)(struct mtd_info *mtd, int state);
+        int (*read_bufferram)(struct mtd_info *mtd, int area,
+                        unsigned char *buffer, int offset, size_t count);
+        int (*write_bufferram)(struct mtd_info *mtd, int area,
+                        const unsigned char *buffer, int offset, size_t count);
+        unsigned short (*read_word)(void __iomem *addr);
+        void (*write_word)(unsigned short value, void __iomem *addr);
+
+        spinlock_t              chip_lock;
+        wait_queue_head_t       wq;
+        onenand_state_t         state;
+
+        struct nand_oobinfo     *autooob;
+
+        void                    *priv;
+};
+
+#define ONENAND_CURRENT_BUFFERRAM(this)         (this->bufferram_index)
+#define ONENAND_NEXT_BUFFERRAM(this)            (this->bufferram_index ^ 1)
+#define ONENAND_SET_NEXT_BUFFERRAM(this)        (this->bufferram_index ^= 1)
+
+/*
+ * Options bits
+ */
+#define ONENAND_CONT_LOCK               (0x0001)
+
+
+/*
+ * OneNAND Flash Manufacturer ID Codes
+ */
+#define ONENAND_MFR_SAMSUNG     0xec
+#define ONENAND_MFR_UNKNOWN     0x00
+
+/**
+ * struct nand_manufacturers - NAND Flash Manufacturer ID Structure
+ * @param name:         Manufacturer name
+ * @param id:           manufacturer ID code of device.
+*/
+struct onenand_manufacturers {
+        int id;
+        char *name;
+};
+
+#endif  /* __LINUX_MTD_ONENAND_H */
diff --git a/include/linux/mtd/onenand_regs.h b/include/linux/mtd/onenand_regs.h
new file mode 100644
index 000000000000..4a2daad7d738
--- /dev/null
+++ b/include/linux/mtd/onenand_regs.h
@@ -0,0 +1,167 @@
+/*
+ *  linux/include/linux/mtd/onenand_regs.h
+ *
+ *  OneNAND Register header file
+ *
+ *  Copyright (C) 2005 Samsung Electronics
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 as
+ * published by the Free Software Foundation.
+ */
+
+#ifndef __ONENAND_REG_H
+#define __ONENAND_REG_H
+
+/* Memory Address Map Translation (Word order) */
+#define ONENAND_MEMORY_MAP(x)           ((x) << 1)
+
+/*
+ * External BufferRAM area
+ */
+#define ONENAND_BOOTRAM                 ONENAND_MEMORY_MAP(0x0000)
+#define ONENAND_DATARAM                 ONENAND_MEMORY_MAP(0x0200)
+#define ONENAND_SPARERAM                ONENAND_MEMORY_MAP(0x8010)
+
+/*
+ * OneNAND Registers
+ */
+#define ONENAND_REG_MANUFACTURER_ID     ONENAND_MEMORY_MAP(0xF000)
+#define ONENAND_REG_DEVICE_ID           ONENAND_MEMORY_MAP(0xF001)
+#define ONENAND_REG_VERSION_ID          ONENAND_MEMORY_MAP(0xF002)
+#define ONENAND_REG_DATA_BUFFER_SIZE    ONENAND_MEMORY_MAP(0xF003)
+#define ONENAND_REG_BOOT_BUFFER_SIZE    ONENAND_MEMORY_MAP(0xF004)
+#define ONENAND_REG_NUM_BUFFERS         ONENAND_MEMORY_MAP(0xF005)
+#define ONENAND_REG_TECHNOLOGY          ONENAND_MEMORY_MAP(0xF006)
+
+#define ONENAND_REG_START_ADDRESS1      ONENAND_MEMORY_MAP(0xF100)
+#define ONENAND_REG_START_ADDRESS2      ONENAND_MEMORY_MAP(0xF101)
+#define ONENAND_REG_START_ADDRESS3      ONENAND_MEMORY_MAP(0xF102)
+#define ONENAND_REG_START_ADDRESS4      ONENAND_MEMORY_MAP(0xF103)
+#define ONENAND_REG_START_ADDRESS5      ONENAND_MEMORY_MAP(0xF104)
+#define ONENAND_REG_START_ADDRESS6      ONENAND_MEMORY_MAP(0xF105)
+#define ONENAND_REG_START_ADDRESS7      ONENAND_MEMORY_MAP(0xF106)
+#define ONENAND_REG_START_ADDRESS8      ONENAND_MEMORY_MAP(0xF107)
+
+#define ONENAND_REG_START_BUFFER        ONENAND_MEMORY_MAP(0xF200)
+#define ONENAND_REG_COMMAND             ONENAND_MEMORY_MAP(0xF220)
+#define ONENAND_REG_SYS_CFG1            ONENAND_MEMORY_MAP(0xF221)
+#define ONENAND_REG_SYS_CFG2            ONENAND_MEMORY_MAP(0xF222)
+#define ONENAND_REG_CTRL_STATUS         ONENAND_MEMORY_MAP(0xF240)
+#define ONENAND_REG_INTERRUPT           ONENAND_MEMORY_MAP(0xF241)
+#define ONENAND_REG_START_BLOCK_ADDRESS ONENAND_MEMORY_MAP(0xF24C)
+#define ONENAND_REG_END_BLOCK_ADDRESS   ONENAND_MEMORY_MAP(0xF24D)
+#define ONENAND_REG_WP_STATUS           ONENAND_MEMORY_MAP(0xF24E)
+
+#define ONENAND_REG_ECC_STATUS          ONENAND_MEMORY_MAP(0xFF00)
+#define ONENAND_REG_ECC_M0              ONENAND_MEMORY_MAP(0xFF01)
+#define ONENAND_REG_ECC_S0              ONENAND_MEMORY_MAP(0xFF02)
+#define ONENAND_REG_ECC_M1              ONENAND_MEMORY_MAP(0xFF03)
+#define ONENAND_REG_ECC_S1              ONENAND_MEMORY_MAP(0xFF04)
+#define ONENAND_REG_ECC_M2              ONENAND_MEMORY_MAP(0xFF05)
+#define ONENAND_REG_ECC_S2              ONENAND_MEMORY_MAP(0xFF06)
+#define ONENAND_REG_ECC_M3              ONENAND_MEMORY_MAP(0xFF07)
+#define ONENAND_REG_ECC_S3              ONENAND_MEMORY_MAP(0xFF08)
+
+/*
+ * Device ID Register F001h (R)
+ */
+#define ONENAND_DEVICE_DENSITY_SHIFT    (4)
+#define ONENAND_DEVICE_IS_DDP           (1 << 3)
+#define ONENAND_DEVICE_IS_DEMUX         (1 << 2)
+#define ONENAND_DEVICE_VCC_MASK         (0x3)
+
+#define ONENAND_DEVICE_DENSITY_512Mb    (0x002)
+
+/*
+ * Version ID Register F002h (R)
+ */
+#define ONENAND_VERSION_PROCESS_SHIFT   (8)
+
+/*
+ * Start Address 1 F100h (R/W)
+ */
+#define ONENAND_DDP_SHIFT               (15)
+
+/*
+ * Start Address 8 F107h (R/W)
+ */
+#define ONENAND_FPA_MASK                (0x3f)
+#define ONENAND_FPA_SHIFT               (2)
+#define ONENAND_FSA_MASK                (0x03)
+
+/*
+ * Start Buffer Register F200h (R/W)
+ */
+#define ONENAND_BSA_MASK                (0x03)
+#define ONENAND_BSA_SHIFT               (8)
+#define ONENAND_BSA_BOOTRAM             (0 << 2)
+#define ONENAND_BSA_DATARAM0            (2 << 2)
+#define ONENAND_BSA_DATARAM1            (3 << 2)
+#define ONENAND_BSC_MASK                (0x03)
+
+/*
+ * Command Register F220h (R/W)
+ */
+#define ONENAND_CMD_READ                (0x00)
+#define ONENAND_CMD_READOOB             (0x13)
+#define ONENAND_CMD_PROG                (0x80)
+#define ONENAND_CMD_PROGOOB             (0x1A)
+#define ONENAND_CMD_UNLOCK              (0x23)
+#define ONENAND_CMD_LOCK                (0x2A)
+#define ONENAND_CMD_LOCK_TIGHT          (0x2C)
+#define ONENAND_CMD_ERASE               (0x94)
+#define ONENAND_CMD_RESET               (0xF0)
+#define ONENAND_CMD_READID              (0x90)
+
+/* NOTE: Those are not *REAL* commands */
+#define ONENAND_CMD_BUFFERRAM           (0x1978)
+
+/*
+ * System Configuration 1 Register F221h (R, R/W)
+ */
+#define ONENAND_SYS_CFG1_SYNC_READ      (1 << 15)
+#define ONENAND_SYS_CFG1_BRL            (1 << 12)
+#define ONENAND_SYS_CFG1_BL             (1 << 9)
+#define ONENAND_SYS_CFG1_NO_ECC         (1 << 8)
+#define ONENAND_SYS_CFG1_RDY            (1 << 7)
+#define ONENAND_SYS_CFG1_INT            (1 << 6)
+#define ONENAND_SYS_CFG1_IOBE           (1 << 5)
+#define ONENAND_SYS_CFG1_RDY_CONF       (1 << 4)
+
+/*
+ * Controller Status Register F240h (R)
+ */
+#define ONENAND_CTRL_ONGO               (1 << 15)
+#define ONENAND_CTRL_LOCK               (1 << 14)
+#define ONENAND_CTRL_LOAD               (1 << 13)
+#define ONENAND_CTRL_PROGRAM            (1 << 12)
+#define ONENAND_CTRL_ERASE              (1 << 11)
+#define ONENAND_CTRL_ERROR              (1 << 10)
+#define ONENAND_CTRL_RSTB               (1 << 7)
+
+/*
+ * Interrupt Status Register F241h (R)
+ */
+#define ONENAND_INT_MASTER              (1 << 15)
+#define ONENAND_INT_READ                (1 << 7)
+#define ONENAND_INT_WRITE               (1 << 6)
+#define ONENAND_INT_ERASE               (1 << 5)
+#define ONENAND_INT_RESET               (1 << 4)
+#define ONENAND_INT_CLEAR               (0 << 0)
+
+/*
+ * NAND Flash Write Protection Status Register F24Eh (R)
+ */
+#define ONENAND_WP_US                   (1 << 2)
+#define ONENAND_WP_LS                   (1 << 1)
+#define ONENAND_WP_LTS                  (1 << 0)
+
+/*
+ * ECC Status Reigser FF00h (R)
+ */
+#define ONENAND_ECC_1BIT                (1 << 0)
+#define ONENAND_ECC_2BIT                (1 << 1)
+#define ONENAND_ECC_2BIT_ALL            (0xAAAA)
+
+#endif  /* __ONENAND_REG_H */