include/linux/mtd/onenand.h

   1 /*
   2  *  linux/include/linux/mtd/onenand.h
   3  *
   4  *  Copyright (C) 2005-2007 Samsung Electronics
   5  *  Kyungmin Park <kyungmin.park@samsung.com>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License version 2 as
   9  * published by the Free Software Foundation.
  10  */
  11
  12 #ifndef __LINUX_MTD_ONENAND_H
  13 #define __LINUX_MTD_ONENAND_H
  14
  15 #include <linux/spinlock.h>
  16 #include <linux/completion.h>
  17 #include <linux/mtd/onenand_regs.h>
  18 #include <linux/mtd/bbm.h>
  19
  20 #define MAX_DIES                2
  21 #define MAX_BUFFERRAM           2
  22
  23 /* Scan and identify a OneNAND device */
  24 extern int onenand_scan(struct mtd_info *mtd, int max_chips);
  25 /* Free resources held by the OneNAND device */
  26 extern void onenand_release(struct mtd_info *mtd);
  27
  28 /*
  29  * onenand_state_t - chip states
  30  * Enumeration for OneNAND flash chip state
  31  */
  32 typedef enum {
  33         FL_READY,
  34         FL_READING,
  35         FL_WRITING,
  36         FL_ERASING,
  37         FL_SYNCING,
  38         FL_LOCKING,
  39         FL_RESETING,
  40         FL_OTPING,
  41         FL_PM_SUSPENDED,
  42 } onenand_state_t;
  43
  44 /**
  45  * struct onenand_bufferram - OneNAND BufferRAM Data
  46  * @blockpage:          block & page address in BufferRAM
  47  */
  48 struct onenand_bufferram {
  49         int     blockpage;
  50 };
  51
  52 /**
  53  * struct onenand_chip - OneNAND Private Flash Chip Data
  54  * @base:               [BOARDSPECIFIC] address to access OneNAND
  55  * @dies:               [INTERN][FLEX-ONENAND] number of dies on chip
  56  * @boundary:           [INTERN][FLEX-ONENAND] Boundary of the dies
  57  * @diesize:            [INTERN][FLEX-ONENAND] Size of the dies
  58  * @chipsize:           [INTERN] the size of one chip for multichip arrays
  59  *                      FIXME For Flex-OneNAND, chipsize holds maximum possible
  60  *                      device size ie when all blocks are considered MLC
  61  * @device_id:          [INTERN] device ID
  62  * @density_mask:       chip density, used for DDP devices
  63  * @verstion_id:        [INTERN] version ID
  64  * @options:            [BOARDSPECIFIC] various chip options. They can
  65  *                      partly be set to inform onenand_scan about
  66  * @erase_shift:        [INTERN] number of address bits in a block
  67  * @page_shift:         [INTERN] number of address bits in a page
  68  * @page_mask:          [INTERN] a page per block mask
  69  * @writesize:          [INTERN] a real page size
  70  * @bufferram_index:    [INTERN] BufferRAM index
  71  * @bufferram:          [INTERN] BufferRAM info
  72  * @readw:              [REPLACEABLE] hardware specific function for read short
  73  * @writew:             [REPLACEABLE] hardware specific function for write short
  74  * @command:            [REPLACEABLE] hardware specific function for writing
  75  *                      commands to the chip
  76  * @wait:               [REPLACEABLE] hardware specific function for wait on ready
  77  * @bbt_wait:           [REPLACEABLE] hardware specific function for bbt wait on ready
  78  * @unlock_all:         [REPLACEABLE] hardware specific function for unlock all
  79  * @read_bufferram:     [REPLACEABLE] hardware specific function for BufferRAM Area
  80  * @write_bufferram:    [REPLACEABLE] hardware specific function for BufferRAM Area
  81  * @read_word:          [REPLACEABLE] hardware specific function for read
  82  *                      register of OneNAND
  83  * @write_word:         [REPLACEABLE] hardware specific function for write
  84  *                      register of OneNAND
  85  * @mmcontrol:          sync burst read function
  86  * @block_markbad:      function to mark a block as bad
  87  * @scan_bbt:           [REPLACEALBE] hardware specific function for scanning
  88  *                      Bad block Table
  89  * @chip_lock:          [INTERN] spinlock used to protect access to this
  90  *                      structure and the chip
  91  * @wq:                 [INTERN] wait queue to sleep on if a OneNAND
  92  *                      operation is in progress
  93  * @state:              [INTERN] the current state of the OneNAND device
  94  * @page_buf:           [INTERN] page main data buffer
  95  * @oob_buf:            [INTERN] page oob data buffer
  96  * @subpagesize:        [INTERN] holds the subpagesize
  97  * @ecclayout:          [REPLACEABLE] the default ecc placement scheme
  98  * @bbm:                [REPLACEABLE] pointer to Bad Block Management
  99  * @priv:               [OPTIONAL] pointer to private chip date
 100  */
 101 struct onenand_chip {
 102         void __iomem            *base;
 103         unsigned                dies;
 104         unsigned                boundary[MAX_DIES];
 105         loff_t                  diesize[MAX_DIES];
 106         unsigned int            chipsize;
 107         unsigned int            device_id;
 108         unsigned int            version_id;
 109         unsigned int            technology;
 110         unsigned int            density_mask;
 111         unsigned int            options;
 112
 113         unsigned int            erase_shift;
 114         unsigned int            page_shift;
 115         unsigned int            page_mask;
 116         unsigned int            writesize;
 117
 118         unsigned int            bufferram_index;
 119         struct onenand_bufferram        bufferram[MAX_BUFFERRAM];
 120
 121         int (*command)(struct mtd_info *mtd, int cmd, loff_t address, size_t len);
 122         int (*wait)(struct mtd_info *mtd, int state);
 123         int (*bbt_wait)(struct mtd_info *mtd, int state);
 124         void (*unlock_all)(struct mtd_info *mtd);
 125         int (*read_bufferram)(struct mtd_info *mtd, int area,
 126                         unsigned char *buffer, int offset, size_t count);
 127         int (*write_bufferram)(struct mtd_info *mtd, int area,
 128                         const unsigned char *buffer, int offset, size_t count);
 129         unsigned short (*read_word)(void __iomem *addr);
 130         void (*write_word)(unsigned short value, void __iomem *addr);
 131         void (*mmcontrol)(struct mtd_info *mtd, int sync_read);
 132         int (*block_markbad)(struct mtd_info *mtd, loff_t ofs);
 133         int (*scan_bbt)(struct mtd_info *mtd);
 134
 135         struct completion       complete;
 136         int                     irq;
 137
 138         spinlock_t              chip_lock;
 139         wait_queue_head_t       wq;
 140         onenand_state_t         state;
 141         unsigned char           *page_buf;
 142         unsigned char           *oob_buf;
 143
 144         int                     subpagesize;
 145         struct nand_ecclayout   *ecclayout;
 146
 147         void                    *bbm;
 148
 149         void                    *priv;
 150 };
 151
 152 /*
 153  * Helper macros
 154  */
 155 #define ONENAND_CURRENT_BUFFERRAM(this)         (this->bufferram_index)
 156 #define ONENAND_NEXT_BUFFERRAM(this)            (this->bufferram_index ^ 1)
 157 #define ONENAND_SET_NEXT_BUFFERRAM(this)        (this->bufferram_index ^= 1)
 158 #define ONENAND_SET_PREV_BUFFERRAM(this)        (this->bufferram_index ^= 1)
 159 #define ONENAND_SET_BUFFERRAM0(this)            (this->bufferram_index = 0)
 160 #define ONENAND_SET_BUFFERRAM1(this)            (this->bufferram_index = 1)
 161
 162 #define FLEXONENAND(this)                                               \
 163         (this->device_id & DEVICE_IS_FLEXONENAND)
 164 #define ONENAND_GET_SYS_CFG1(this)                                      \
 165         (this->read_word(this->base + ONENAND_REG_SYS_CFG1))
 166 #define ONENAND_SET_SYS_CFG1(v, this)                                   \
 167         (this->write_word(v, this->base + ONENAND_REG_SYS_CFG1))
 168
 169 #define ONENAND_IS_DDP(this)                                            \
 170         (this->device_id & ONENAND_DEVICE_IS_DDP)
 171
 172 #define ONENAND_IS_MLC(this)                                            \
 173         (this->technology & ONENAND_TECHNOLOGY_IS_MLC)
 174
 175 #ifdef CONFIG_MTD_ONENAND_2X_PROGRAM
 176 #define ONENAND_IS_2PLANE(this)                                         \
 177         (this->options & ONENAND_HAS_2PLANE)
 178 #else
 179 #define ONENAND_IS_2PLANE(this)                 (0)
 180 #endif
 181
 182 /* Check byte access in OneNAND */
 183 #define ONENAND_CHECK_BYTE_ACCESS(addr)         (addr & 0x1)
 184
 185 /*
 186  * Options bits
 187  */
 188 #define ONENAND_HAS_CONT_LOCK           (0x0001)
 189 #define ONENAND_HAS_UNLOCK_ALL          (0x0002)
 190 #define ONENAND_HAS_2PLANE              (0x0004)
 191 #define ONENAND_SKIP_UNLOCK_CHECK       (0x0100)
 192 #define ONENAND_PAGEBUF_ALLOC           (0x1000)
 193 #define ONENAND_OOBBUF_ALLOC            (0x2000)
 194
 195 /*
 196  * OneNAND Flash Manufacturer ID Codes
 197  */
 198 #define ONENAND_MFR_SAMSUNG     0xec
 199 #define ONENAND_MFR_NUMONYX     0x20
 200
 201 /**
 202  * struct onenand_manufacturers - NAND Flash Manufacturer ID Structure
 203  * @name:       Manufacturer name
 204  * @id:         manufacturer ID code of device.
 205 */
 206 struct onenand_manufacturers {
 207         int id;
 208         char *name;
 209 };
 210
 211 int onenand_bbt_read_oob(struct mtd_info *mtd, loff_t from,
 212                          struct mtd_oob_ops *ops);
 213 unsigned onenand_block(struct onenand_chip *this, loff_t addr);
 214 loff_t onenand_addr(struct onenand_chip *this, int block);
 215 int flexonenand_region(struct mtd_info *mtd, loff_t addr);
 216
 217 #endif  /* __LINUX_MTD_ONENAND_H */