~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/include/linux/mtd/onenand.h

Version: ~ [ linux-5.3-rc5 ] ~ [ linux-5.2.9 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.67 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.139 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.189 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.189 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.19.8 ] ~ [ linux-3.18.140 ] ~ [ linux-3.17.8 ] ~ [ linux-3.16.72 ] ~ [ linux-3.15.10 ] ~ [ linux-3.14.79 ] ~ [ linux-3.13.11 ] ~ [ linux-3.12.74 ] ~ [ linux-3.11.10 ] ~ [ linux-3.10.108 ] ~ [ linux-3.9.11 ] ~ [ linux-3.8.13 ] ~ [ linux-3.7.10 ] ~ [ linux-3.6.11 ] ~ [ linux-3.5.7 ] ~ [ linux-3.4.113 ] ~ [ linux-3.3.8 ] ~ [ linux-3.2.102 ] ~ [ linux-3.1.10 ] ~ [ linux-3.0.101 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

  1 /*
  2  *  linux/include/linux/mtd/onenand.h
  3  *
  4  *  Copyright © 2005-2009 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/flashchip.h>
 18 #include <linux/mtd/onenand_regs.h>
 19 #include <linux/mtd/bbm.h>
 20 
 21 #define MAX_DIES                2
 22 #define MAX_BUFFERRAM           2
 23 
 24 /* Scan and identify a OneNAND device */
 25 extern int onenand_scan(struct mtd_info *mtd, int max_chips);
 26 /* Free resources held by the OneNAND device */
 27 extern void onenand_release(struct mtd_info *mtd);
 28 
 29 /**
 30  * struct onenand_bufferram - OneNAND BufferRAM Data
 31  * @blockpage:          block & page address in BufferRAM
 32  */
 33 struct onenand_bufferram {
 34         int     blockpage;
 35 };
 36 
 37 /**
 38  * struct onenand_chip - OneNAND Private Flash Chip Data
 39  * @base:               [BOARDSPECIFIC] address to access OneNAND
 40  * @dies:               [INTERN][FLEX-ONENAND] number of dies on chip
 41  * @boundary:           [INTERN][FLEX-ONENAND] Boundary of the dies
 42  * @diesize:            [INTERN][FLEX-ONENAND] Size of the dies
 43  * @chipsize:           [INTERN] the size of one chip for multichip arrays
 44  *                      FIXME For Flex-OneNAND, chipsize holds maximum possible
 45  *                      device size ie when all blocks are considered MLC
 46  * @device_id:          [INTERN] device ID
 47  * @density_mask:       chip density, used for DDP devices
 48  * @verstion_id:        [INTERN] version ID
 49  * @options:            [BOARDSPECIFIC] various chip options. They can
 50  *                      partly be set to inform onenand_scan about
 51  * @erase_shift:        [INTERN] number of address bits in a block
 52  * @page_shift:         [INTERN] number of address bits in a page
 53  * @page_mask:          [INTERN] a page per block mask
 54  * @writesize:          [INTERN] a real page size
 55  * @bufferram_index:    [INTERN] BufferRAM index
 56  * @bufferram:          [INTERN] BufferRAM info
 57  * @readw:              [REPLACEABLE] hardware specific function for read short
 58  * @writew:             [REPLACEABLE] hardware specific function for write short
 59  * @command:            [REPLACEABLE] hardware specific function for writing
 60  *                      commands to the chip
 61  * @wait:               [REPLACEABLE] hardware specific function for wait on ready
 62  * @bbt_wait:           [REPLACEABLE] hardware specific function for bbt wait on ready
 63  * @unlock_all:         [REPLACEABLE] hardware specific function for unlock all
 64  * @read_bufferram:     [REPLACEABLE] hardware specific function for BufferRAM Area
 65  * @write_bufferram:    [REPLACEABLE] hardware specific function for BufferRAM Area
 66  * @read_word:          [REPLACEABLE] hardware specific function for read
 67  *                      register of OneNAND
 68  * @write_word:         [REPLACEABLE] hardware specific function for write
 69  *                      register of OneNAND
 70  * @mmcontrol:          sync burst read function
 71  * @chip_probe:         [REPLACEABLE] hardware specific function for chip probe
 72  * @block_markbad:      function to mark a block as bad
 73  * @scan_bbt:           [REPLACEALBE] hardware specific function for scanning
 74  *                      Bad block Table
 75  * @chip_lock:          [INTERN] spinlock used to protect access to this
 76  *                      structure and the chip
 77  * @wq:                 [INTERN] wait queue to sleep on if a OneNAND
 78  *                      operation is in progress
 79  * @state:              [INTERN] the current state of the OneNAND device
 80  * @page_buf:           [INTERN] page main data buffer
 81  * @oob_buf:            [INTERN] page oob data buffer
 82  * @subpagesize:        [INTERN] holds the subpagesize
 83  * @bbm:                [REPLACEABLE] pointer to Bad Block Management
 84  * @priv:               [OPTIONAL] pointer to private chip date
 85  */
 86 struct onenand_chip {
 87         void __iomem            *base;
 88         unsigned                dies;
 89         unsigned                boundary[MAX_DIES];
 90         loff_t                  diesize[MAX_DIES];
 91         unsigned int            chipsize;
 92         unsigned int            device_id;
 93         unsigned int            version_id;
 94         unsigned int            technology;
 95         unsigned int            density_mask;
 96         unsigned int            options;
 97 
 98         unsigned int            erase_shift;
 99         unsigned int            page_shift;
100         unsigned int            page_mask;
101         unsigned int            writesize;
102 
103         unsigned int            bufferram_index;
104         struct onenand_bufferram        bufferram[MAX_BUFFERRAM];
105 
106         int (*command)(struct mtd_info *mtd, int cmd, loff_t address, size_t len);
107         int (*wait)(struct mtd_info *mtd, int state);
108         int (*bbt_wait)(struct mtd_info *mtd, int state);
109         void (*unlock_all)(struct mtd_info *mtd);
110         int (*read_bufferram)(struct mtd_info *mtd, int area,
111                         unsigned char *buffer, int offset, size_t count);
112         int (*write_bufferram)(struct mtd_info *mtd, int area,
113                         const unsigned char *buffer, int offset, size_t count);
114         unsigned short (*read_word)(void __iomem *addr);
115         void (*write_word)(unsigned short value, void __iomem *addr);
116         void (*mmcontrol)(struct mtd_info *mtd, int sync_read);
117         int (*chip_probe)(struct mtd_info *mtd);
118         int (*block_markbad)(struct mtd_info *mtd, loff_t ofs);
119         int (*scan_bbt)(struct mtd_info *mtd);
120         int (*enable)(struct mtd_info *mtd);
121         int (*disable)(struct mtd_info *mtd);
122 
123         struct completion       complete;
124         int                     irq;
125 
126         spinlock_t              chip_lock;
127         wait_queue_head_t       wq;
128         flstate_t               state;
129         unsigned char           *page_buf;
130         unsigned char           *oob_buf;
131 #ifdef CONFIG_MTD_ONENAND_VERIFY_WRITE
132         unsigned char           *verify_buf;
133 #endif
134 
135         int                     subpagesize;
136 
137         void                    *bbm;
138 
139         void                    *priv;
140 
141         /*
142          * Shows that the current operation is composed
143          * of sequence of commands. For example, cache program.
144          * Such command status OnGo bit is checked at the end of
145          * sequence.
146          */
147         unsigned int            ongoing;
148 };
149 
150 /*
151  * Helper macros
152  */
153 #define ONENAND_PAGES_PER_BLOCK        (1<<6)
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 #define ONENAND_IS_CACHE_PROGRAM(this)                                  \
183         (this->options & ONENAND_HAS_CACHE_PROGRAM)
184 
185 #define ONENAND_IS_NOP_1(this)                                          \
186         (this->options & ONENAND_HAS_NOP_1)
187 
188 /* Check byte access in OneNAND */
189 #define ONENAND_CHECK_BYTE_ACCESS(addr)         (addr & 0x1)
190 
191 /*
192  * Options bits
193  */
194 #define ONENAND_HAS_CONT_LOCK           (0x0001)
195 #define ONENAND_HAS_UNLOCK_ALL          (0x0002)
196 #define ONENAND_HAS_2PLANE              (0x0004)
197 #define ONENAND_HAS_4KB_PAGE            (0x0008)
198 #define ONENAND_HAS_CACHE_PROGRAM       (0x0010)
199 #define ONENAND_HAS_NOP_1               (0x0020)
200 #define ONENAND_SKIP_UNLOCK_CHECK       (0x0100)
201 #define ONENAND_PAGEBUF_ALLOC           (0x1000)
202 #define ONENAND_OOBBUF_ALLOC            (0x2000)
203 #define ONENAND_SKIP_INITIAL_UNLOCKING  (0x4000)
204 
205 #define ONENAND_IS_4KB_PAGE(this)                                       \
206         (this->options & ONENAND_HAS_4KB_PAGE)
207 
208 /*
209  * OneNAND Flash Manufacturer ID Codes
210  */
211 #define ONENAND_MFR_SAMSUNG     0xec
212 #define ONENAND_MFR_NUMONYX     0x20
213 
214 /**
215  * struct onenand_manufacturers - NAND Flash Manufacturer ID Structure
216  * @name:       Manufacturer name
217  * @id:         manufacturer ID code of device.
218 */
219 struct onenand_manufacturers {
220         int id;
221         char *name;
222 };
223 
224 int onenand_bbt_read_oob(struct mtd_info *mtd, loff_t from,
225                          struct mtd_oob_ops *ops);
226 unsigned onenand_block(struct onenand_chip *this, loff_t addr);
227 loff_t onenand_addr(struct onenand_chip *this, int block);
228 int flexonenand_region(struct mtd_info *mtd, loff_t addr);
229 
230 struct mtd_partition;
231 
232 struct onenand_platform_data {
233         void            (*mmcontrol)(struct mtd_info *mtd, int sync_read);
234         int             (*read_bufferram)(struct mtd_info *mtd, int area,
235                         unsigned char *buffer, int offset, size_t count);
236         struct mtd_partition *parts;
237         unsigned int    nr_parts;
238 };
239 
240 #endif  /* __LINUX_MTD_ONENAND_H */
241 

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp