]>
Commit | Line | Data |
---|---|---|
cd5f6346 KP |
1 | /* |
2 | * linux/include/linux/mtd/onenand.h | |
3 | * | |
3cf60253 | 4 | * Copyright © 2005-2009 Samsung Electronics |
cd5f6346 KP |
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> | |
2c22120f | 16 | #include <linux/completion.h> |
30631cb8 | 17 | #include <linux/mtd/flashchip.h> |
cd5f6346 | 18 | #include <linux/mtd/onenand_regs.h> |
cdc00130 | 19 | #include <linux/mtd/bbm.h> |
cd5f6346 | 20 | |
5988af23 | 21 | #define MAX_DIES 2 |
cd5f6346 KP |
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 | ||
cd5f6346 KP |
29 | /** |
30 | * struct onenand_bufferram - OneNAND BufferRAM Data | |
abf3c0f2 | 31 | * @blockpage: block & page address in BufferRAM |
cd5f6346 KP |
32 | */ |
33 | struct onenand_bufferram { | |
abf3c0f2 | 34 | int blockpage; |
cd5f6346 KP |
35 | }; |
36 | ||
37 | /** | |
38 | * struct onenand_chip - OneNAND Private Flash Chip Data | |
ea9b6dcc | 39 | * @base: [BOARDSPECIFIC] address to access OneNAND |
5988af23 RH |
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 | |
ea9b6dcc | 43 | * @chipsize: [INTERN] the size of one chip for multichip arrays |
5988af23 RH |
44 | * FIXME For Flex-OneNAND, chipsize holds maximum possible |
45 | * device size ie when all blocks are considered MLC | |
ea9b6dcc RD |
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 | |
ea9b6dcc | 53 | * @page_mask: [INTERN] a page per block mask |
ee9745fc | 54 | * @writesize: [INTERN] a real page size |
ea9b6dcc RD |
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 | |
31bb999e KP |
62 | * @bbt_wait: [REPLACEABLE] hardware specific function for bbt wait on ready |
63 | * @unlock_all: [REPLACEABLE] hardware specific function for unlock all | |
ea9b6dcc RD |
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 | |
ad0d363b | 71 | * @chip_probe: [REPLACEABLE] hardware specific function for chip probe |
ea9b6dcc RD |
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 | |
470bc844 KP |
80 | * @page_buf: [INTERN] page main data buffer |
81 | * @oob_buf: [INTERN] page oob data buffer | |
60d84f97 | 82 | * @subpagesize: [INTERN] holds the subpagesize |
ea9b6dcc RD |
83 | * @ecclayout: [REPLACEABLE] the default ecc placement scheme |
84 | * @bbm: [REPLACEABLE] pointer to Bad Block Management | |
85 | * @priv: [OPTIONAL] pointer to private chip date | |
cd5f6346 KP |
86 | */ |
87 | struct onenand_chip { | |
88 | void __iomem *base; | |
5988af23 RH |
89 | unsigned dies; |
90 | unsigned boundary[MAX_DIES]; | |
91 | loff_t diesize[MAX_DIES]; | |
cd5f6346 KP |
92 | unsigned int chipsize; |
93 | unsigned int device_id; | |
28b79ff9 | 94 | unsigned int version_id; |
5988af23 | 95 | unsigned int technology; |
83a36838 | 96 | unsigned int density_mask; |
cd5f6346 KP |
97 | unsigned int options; |
98 | ||
99 | unsigned int erase_shift; | |
100 | unsigned int page_shift; | |
cd5f6346 | 101 | unsigned int page_mask; |
ee9745fc | 102 | unsigned int writesize; |
cd5f6346 KP |
103 | |
104 | unsigned int bufferram_index; | |
105 | struct onenand_bufferram bufferram[MAX_BUFFERRAM]; | |
106 | ||
107 | int (*command)(struct mtd_info *mtd, int cmd, loff_t address, size_t len); | |
108 | int (*wait)(struct mtd_info *mtd, int state); | |
31bb999e KP |
109 | int (*bbt_wait)(struct mtd_info *mtd, int state); |
110 | void (*unlock_all)(struct mtd_info *mtd); | |
cd5f6346 KP |
111 | int (*read_bufferram)(struct mtd_info *mtd, int area, |
112 | unsigned char *buffer, int offset, size_t count); | |
113 | int (*write_bufferram)(struct mtd_info *mtd, int area, | |
114 | const unsigned char *buffer, int offset, size_t count); | |
115 | unsigned short (*read_word)(void __iomem *addr); | |
116 | void (*write_word)(unsigned short value, void __iomem *addr); | |
52b0eea7 | 117 | void (*mmcontrol)(struct mtd_info *mtd, int sync_read); |
ad0d363b | 118 | int (*chip_probe)(struct mtd_info *mtd); |
cdc00130 KP |
119 | int (*block_markbad)(struct mtd_info *mtd, loff_t ofs); |
120 | int (*scan_bbt)(struct mtd_info *mtd); | |
cf24dc85 AH |
121 | int (*enable)(struct mtd_info *mtd); |
122 | int (*disable)(struct mtd_info *mtd); | |
cd5f6346 | 123 | |
2c22120f KP |
124 | struct completion complete; |
125 | int irq; | |
126 | ||
cd5f6346 KP |
127 | spinlock_t chip_lock; |
128 | wait_queue_head_t wq; | |
30631cb8 | 129 | flstate_t state; |
532a37cf | 130 | unsigned char *page_buf; |
470bc844 | 131 | unsigned char *oob_buf; |
4a8ce0b0 KP |
132 | #ifdef CONFIG_MTD_ONENAND_VERIFY_WRITE |
133 | unsigned char *verify_buf; | |
134 | #endif | |
cd5f6346 | 135 | |
60d84f97 | 136 | int subpagesize; |
5bd34c09 | 137 | struct nand_ecclayout *ecclayout; |
cd5f6346 | 138 | |
5bd34c09 | 139 | void *bbm; |
cdc00130 | 140 | |
cd5f6346 | 141 | void *priv; |
3e3198f1 RT |
142 | |
143 | /* | |
144 | * Shows that the current operation is composed | |
145 | * of sequence of commands. For example, cache program. | |
146 | * Such command status OnGo bit is checked at the end of | |
147 | * sequence. | |
148 | */ | |
149 | unsigned int ongoing; | |
cd5f6346 KP |
150 | }; |
151 | ||
fcc31470 KP |
152 | /* |
153 | * Helper macros | |
154 | */ | |
3cf60253 AKS |
155 | #define ONENAND_PAGES_PER_BLOCK (1<<6) |
156 | ||
cd5f6346 KP |
157 | #define ONENAND_CURRENT_BUFFERRAM(this) (this->bufferram_index) |
158 | #define ONENAND_NEXT_BUFFERRAM(this) (this->bufferram_index ^ 1) | |
159 | #define ONENAND_SET_NEXT_BUFFERRAM(this) (this->bufferram_index ^= 1) | |
a8de85d5 | 160 | #define ONENAND_SET_PREV_BUFFERRAM(this) (this->bufferram_index ^= 1) |
ee9745fc KP |
161 | #define ONENAND_SET_BUFFERRAM0(this) (this->bufferram_index = 0) |
162 | #define ONENAND_SET_BUFFERRAM1(this) (this->bufferram_index = 1) | |
cd5f6346 | 163 | |
5988af23 RH |
164 | #define FLEXONENAND(this) \ |
165 | (this->device_id & DEVICE_IS_FLEXONENAND) | |
fcc31470 KP |
166 | #define ONENAND_GET_SYS_CFG1(this) \ |
167 | (this->read_word(this->base + ONENAND_REG_SYS_CFG1)) | |
168 | #define ONENAND_SET_SYS_CFG1(v, this) \ | |
169 | (this->write_word(v, this->base + ONENAND_REG_SYS_CFG1)) | |
170 | ||
738d61f5 KP |
171 | #define ONENAND_IS_DDP(this) \ |
172 | (this->device_id & ONENAND_DEVICE_IS_DDP) | |
173 | ||
5988af23 RH |
174 | #define ONENAND_IS_MLC(this) \ |
175 | (this->technology & ONENAND_TECHNOLOGY_IS_MLC) | |
176 | ||
ee9745fc KP |
177 | #ifdef CONFIG_MTD_ONENAND_2X_PROGRAM |
178 | #define ONENAND_IS_2PLANE(this) \ | |
179 | (this->options & ONENAND_HAS_2PLANE) | |
180 | #else | |
181 | #define ONENAND_IS_2PLANE(this) (0) | |
182 | #endif | |
183 | ||
3e3198f1 RT |
184 | #define ONENAND_IS_CACHE_PROGRAM(this) \ |
185 | (this->options & ONENAND_HAS_CACHE_PROGRAM) | |
186 | ||
e1c10243 KP |
187 | #define ONENAND_IS_NOP_1(this) \ |
188 | (this->options & ONENAND_HAS_NOP_1) | |
189 | ||
9c01f87d KP |
190 | /* Check byte access in OneNAND */ |
191 | #define ONENAND_CHECK_BYTE_ACCESS(addr) (addr & 0x1) | |
192 | ||
cd5f6346 KP |
193 | /* |
194 | * Options bits | |
195 | */ | |
28b79ff9 KP |
196 | #define ONENAND_HAS_CONT_LOCK (0x0001) |
197 | #define ONENAND_HAS_UNLOCK_ALL (0x0002) | |
ee9745fc | 198 | #define ONENAND_HAS_2PLANE (0x0004) |
6a88c47b | 199 | #define ONENAND_HAS_4KB_PAGE (0x0008) |
3e3198f1 | 200 | #define ONENAND_HAS_CACHE_PROGRAM (0x0010) |
e1c10243 | 201 | #define ONENAND_HAS_NOP_1 (0x0020) |
31bb999e | 202 | #define ONENAND_SKIP_UNLOCK_CHECK (0x0100) |
532a37cf | 203 | #define ONENAND_PAGEBUF_ALLOC (0x1000) |
470bc844 | 204 | #define ONENAND_OOBBUF_ALLOC (0x2000) |
b3dcfd35 | 205 | #define ONENAND_SKIP_INITIAL_UNLOCKING (0x4000) |
cd5f6346 | 206 | |
6a88c47b KP |
207 | #define ONENAND_IS_4KB_PAGE(this) \ |
208 | (this->options & ONENAND_HAS_4KB_PAGE) | |
209 | ||
cd5f6346 KP |
210 | /* |
211 | * OneNAND Flash Manufacturer ID Codes | |
212 | */ | |
213 | #define ONENAND_MFR_SAMSUNG 0xec | |
ee8f3768 | 214 | #define ONENAND_MFR_NUMONYX 0x20 |
cd5f6346 KP |
215 | |
216 | /** | |
ea9b6dcc RD |
217 | * struct onenand_manufacturers - NAND Flash Manufacturer ID Structure |
218 | * @name: Manufacturer name | |
219 | * @id: manufacturer ID code of device. | |
cd5f6346 KP |
220 | */ |
221 | struct onenand_manufacturers { | |
222 | int id; | |
223 | char *name; | |
224 | }; | |
225 | ||
607d1cb1 AB |
226 | int onenand_bbt_read_oob(struct mtd_info *mtd, loff_t from, |
227 | struct mtd_oob_ops *ops); | |
5988af23 RH |
228 | unsigned onenand_block(struct onenand_chip *this, loff_t addr); |
229 | loff_t onenand_addr(struct onenand_chip *this, int block); | |
230 | int flexonenand_region(struct mtd_info *mtd, loff_t addr); | |
607d1cb1 | 231 | |
778dbcc1 MD |
232 | struct mtd_partition; |
233 | ||
234 | struct onenand_platform_data { | |
235 | void (*mmcontrol)(struct mtd_info *mtd, int sync_read); | |
3328dc31 KP |
236 | int (*read_bufferram)(struct mtd_info *mtd, int area, |
237 | unsigned char *buffer, int offset, size_t count); | |
778dbcc1 MD |
238 | struct mtd_partition *parts; |
239 | unsigned int nr_parts; | |
240 | }; | |
241 | ||
cd5f6346 | 242 | #endif /* __LINUX_MTD_ONENAND_H */ |