]> bbs.cooldavid.org Git - net-next-2.6.git/blame - include/linux/mtd/mtd.h
[MTD] update internal API to support 64-bit device size
[net-next-2.6.git] / include / linux / mtd / mtd.h
CommitLineData
61ecfa87 1/*
1da177e4
LT
2 * Copyright (C) 1999-2003 David Woodhouse <dwmw2@infradead.org> et al.
3 *
4 * Released under GPL
5 */
6
7#ifndef __MTD_MTD_H__
8#define __MTD_MTD_H__
9
1da177e4
LT
10#include <linux/types.h>
11#include <linux/module.h>
12#include <linux/uio.h>
963a6fb0 13#include <linux/notifier.h>
1da177e4
LT
14
15#include <linux/mtd/compatmac.h>
16#include <mtd/mtd-abi.h>
17
69423d99
AH
18#include <asm/div64.h>
19
1da177e4
LT
20#define MTD_CHAR_MAJOR 90
21#define MTD_BLOCK_MAJOR 31
c0fe10ae 22#define MAX_MTD_DEVICES 32
1da177e4
LT
23
24#define MTD_ERASE_PENDING 0x01
25#define MTD_ERASING 0x02
26#define MTD_ERASE_SUSPEND 0x04
27#define MTD_ERASE_DONE 0x08
28#define MTD_ERASE_FAILED 0x10
29
69423d99 30#define MTD_FAIL_ADDR_UNKNOWN -1LL
bb0eb217 31
1da177e4 32/* If the erase fails, fail_addr might indicate exactly which block failed. If
bb0eb217 33 fail_addr = MTD_FAIL_ADDR_UNKNOWN, the failure was not at the device level or was not
1da177e4
LT
34 specific to any particular block. */
35struct erase_info {
36 struct mtd_info *mtd;
69423d99
AH
37 uint64_t addr;
38 uint64_t len;
39 uint64_t fail_addr;
1da177e4
LT
40 u_long time;
41 u_long retries;
42 u_int dev;
43 u_int cell;
44 void (*callback) (struct erase_info *self);
45 u_long priv;
46 u_char state;
47 struct erase_info *next;
48};
49
50struct mtd_erase_region_info {
69423d99 51 uint64_t offset; /* At which this region starts, from the beginning of the MTD */
1da177e4
LT
52 u_int32_t erasesize; /* For this region */
53 u_int32_t numblocks; /* Number of blocks of erasesize in this region */
0ecbc81a 54 unsigned long *lockmap; /* If keeping bitmap of locks */
1da177e4
LT
55};
56
8593fbc6
TG
57/*
58 * oob operation modes
59 *
60 * MTD_OOB_PLACE: oob data are placed at the given offset
61 * MTD_OOB_AUTO: oob data are automatically placed at the free areas
62 * which are defined by the ecclayout
63 * MTD_OOB_RAW: mode to read raw data+oob in one chunk. The oob data
64 * is inserted into the data. Thats a raw image of the
65 * flash contents.
66 */
67typedef enum {
68 MTD_OOB_PLACE,
69 MTD_OOB_AUTO,
70 MTD_OOB_RAW,
71} mtd_oob_mode_t;
72
73/**
74 * struct mtd_oob_ops - oob operation operands
75 * @mode: operation mode
76 *
7014568b 77 * @len: number of data bytes to write/read
8593fbc6 78 *
7014568b 79 * @retlen: number of data bytes written/read
8593fbc6 80 *
7014568b
VW
81 * @ooblen: number of oob bytes to write/read
82 * @oobretlen: number of oob bytes written/read
8593fbc6
TG
83 * @ooboffs: offset of oob data in the oob area (only relevant when
84 * mode = MTD_OOB_PLACE)
85 * @datbuf: data buffer - if NULL only oob data are read/written
86 * @oobbuf: oob data buffer
73a4421c
AB
87 *
88 * Note, it is allowed to read more then one OOB area at one go, but not write.
89 * The interface assumes that the OOB write requests program only one page's
90 * OOB area.
8593fbc6
TG
91 */
92struct mtd_oob_ops {
93 mtd_oob_mode_t mode;
94 size_t len;
95 size_t retlen;
96 size_t ooblen;
7014568b 97 size_t oobretlen;
8593fbc6
TG
98 uint32_t ooboffs;
99 uint8_t *datbuf;
100 uint8_t *oobbuf;
101};
102
1da177e4
LT
103struct mtd_info {
104 u_char type;
105 u_int32_t flags;
69423d99 106 uint64_t size; // Total size of the MTD
1da177e4 107
151e7659 108 /* "Major" erase size for the device. Naïve users may take this
1da177e4
LT
109 * to be the only erase size available, or may use the more detailed
110 * information below if they desire
111 */
112 u_int32_t erasesize;
783ed81f
AB
113 /* Minimal writable flash unit size. In case of NOR flash it is 1 (even
114 * though individual bits can be cleared), in case of NAND flash it is
115 * one NAND page (or half, or one-fourths of it), in case of ECC-ed NOR
116 * it is of ECC block size, etc. It is illegal to have writesize = 0.
117 * Any driver registering a struct mtd_info must ensure a writesize of
118 * 1 or larger.
28318776
JE
119 */
120 u_int32_t writesize;
1da177e4 121
1da177e4 122 u_int32_t oobsize; // Amount of OOB data per block (e.g. 16)
1f92267c 123 u_int32_t oobavail; // Available OOB bytes per block
638d9838 124
69423d99
AH
125 /*
126 * If erasesize is a power of 2 then the shift is stored in
127 * erasesize_shift otherwise erasesize_shift is zero. Ditto writesize.
128 */
129 unsigned int erasesize_shift;
130 unsigned int writesize_shift;
131 /* Masks based on erasesize_shift and writesize_shift */
132 unsigned int erasesize_mask;
133 unsigned int writesize_mask;
134
1da177e4 135 // Kernel-only stuff starts here.
eadcf0d7 136 const char *name;
1da177e4
LT
137 int index;
138
5bd34c09
TG
139 /* ecc layout structure pointer - read only ! */
140 struct nand_ecclayout *ecclayout;
1da177e4
LT
141
142 /* Data for variable erase regions. If numeraseregions is zero,
61ecfa87 143 * it means that the whole device has erasesize as given above.
1da177e4
LT
144 */
145 int numeraseregions;
61ecfa87 146 struct mtd_erase_region_info *eraseregions;
1da177e4 147
b38178ee
JE
148 /*
149 * Erase is an asynchronous operation. Device drivers are supposed
150 * to call instr->callback() whenever the operation completes, even
151 * if it completes with a failure.
152 * Callers are supposed to pass a callback function and wait for it
153 * to be called before writing to the block.
154 */
1da177e4
LT
155 int (*erase) (struct mtd_info *mtd, struct erase_info *instr);
156
157 /* This stuff for eXecute-In-Place */
a98889f3
JH
158 /* phys is optional and may be set to NULL */
159 int (*point) (struct mtd_info *mtd, loff_t from, size_t len,
160 size_t *retlen, void **virt, resource_size_t *phys);
1da177e4
LT
161
162 /* We probably shouldn't allow XIP if the unpoint isn't a NULL */
a98889f3 163 void (*unpoint) (struct mtd_info *mtd, loff_t from, size_t len);
1da177e4
LT
164
165
166 int (*read) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
167 int (*write) (struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf);
168
388bbb09
RP
169 /* In blackbox flight recorder like scenarios we want to make successful
170 writes in interrupt context. panic_write() is only intended to be
171 called when its known the kernel is about to panic and we need the
172 write to succeed. Since the kernel is not going to be running for much
173 longer, this function can break locks and delay to ensure the write
174 succeeds (but not sleep). */
175
176 int (*panic_write) (struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf);
177
8593fbc6
TG
178 int (*read_oob) (struct mtd_info *mtd, loff_t from,
179 struct mtd_oob_ops *ops);
180 int (*write_oob) (struct mtd_info *mtd, loff_t to,
181 struct mtd_oob_ops *ops);
1da177e4 182
61ecfa87
TG
183 /*
184 * Methods to access the protection register area, present in some
1da177e4 185 * flash devices. The user data is one time programmable but the
61ecfa87 186 * factory data is read only.
1da177e4 187 */
f77814dd 188 int (*get_fact_prot_info) (struct mtd_info *mtd, struct otp_info *buf, size_t len);
1da177e4 189 int (*read_fact_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
f77814dd
NP
190 int (*get_user_prot_info) (struct mtd_info *mtd, struct otp_info *buf, size_t len);
191 int (*read_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
1da177e4 192 int (*write_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
f77814dd 193 int (*lock_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len);
1da177e4 194
2528e8cd 195 /* kvec-based read/write methods.
61ecfa87 196 NB: The 'count' parameter is the number of _vectors_, each of
1da177e4
LT
197 which contains an (ofs, len) tuple.
198 */
1da177e4 199 int (*writev) (struct mtd_info *mtd, const struct kvec *vecs, unsigned long count, loff_t to, size_t *retlen);
1da177e4
LT
200
201 /* Sync */
202 void (*sync) (struct mtd_info *mtd);
203
204 /* Chip-supported device locking */
69423d99
AH
205 int (*lock) (struct mtd_info *mtd, loff_t ofs, uint64_t len);
206 int (*unlock) (struct mtd_info *mtd, loff_t ofs, uint64_t len);
1da177e4
LT
207
208 /* Power Management functions */
209 int (*suspend) (struct mtd_info *mtd);
210 void (*resume) (struct mtd_info *mtd);
211
212 /* Bad block management functions */
213 int (*block_isbad) (struct mtd_info *mtd, loff_t ofs);
214 int (*block_markbad) (struct mtd_info *mtd, loff_t ofs);
215
963a6fb0
NP
216 struct notifier_block reboot_notifier; /* default mode before reboot */
217
7fac4648
TG
218 /* ECC status information */
219 struct mtd_ecc_stats ecc_stats;
29072b96
TG
220 /* Subpage shift (NAND) */
221 int subpage_sft;
7fac4648 222
1da177e4
LT
223 void *priv;
224
225 struct module *owner;
226 int usecount;
9fe912ce
AB
227
228 /* If the driver is something smart, like UBI, it may need to maintain
229 * its own reference counting. The below functions are only for driver.
230 * The driver may register its callbacks. These callbacks are not
231 * supposed to be called by MTD users */
232 int (*get_device) (struct mtd_info *mtd);
233 void (*put_device) (struct mtd_info *mtd);
1da177e4
LT
234};
235
69423d99
AH
236static inline u_int32_t mtd_div_by_eb(uint64_t sz, struct mtd_info *mtd)
237{
238 if (mtd->erasesize_shift)
239 return sz >> mtd->erasesize_shift;
240 do_div(sz, mtd->erasesize);
241 return sz;
242}
243
244static inline u_int32_t mtd_mod_by_eb(uint64_t sz, struct mtd_info *mtd)
245{
246 if (mtd->erasesize_shift)
247 return sz & mtd->erasesize_mask;
248 return do_div(sz, mtd->erasesize);
249}
250
251static inline u_int32_t mtd_div_by_ws(uint64_t sz, struct mtd_info *mtd)
252{
253 if (mtd->writesize_shift)
254 return sz >> mtd->writesize_shift;
255 do_div(sz, mtd->writesize);
256 return sz;
257}
258
259static inline u_int32_t mtd_mod_by_ws(uint64_t sz, struct mtd_info *mtd)
260{
261 if (mtd->writesize_shift)
262 return sz & mtd->writesize_mask;
263 return do_div(sz, mtd->writesize);
264}
1da177e4
LT
265
266 /* Kernel-side ioctl definitions */
267
268extern int add_mtd_device(struct mtd_info *mtd);
269extern int del_mtd_device (struct mtd_info *mtd);
270
271extern struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num);
7799308f 272extern struct mtd_info *get_mtd_device_nm(const char *name);
1da177e4
LT
273
274extern void put_mtd_device(struct mtd_info *mtd);
275
276
277struct mtd_notifier {
278 void (*add)(struct mtd_info *mtd);
279 void (*remove)(struct mtd_info *mtd);
280 struct list_head list;
281};
282
283
284extern void register_mtd_user (struct mtd_notifier *new);
285extern int unregister_mtd_user (struct mtd_notifier *old);
286
287int default_mtd_writev(struct mtd_info *mtd, const struct kvec *vecs,
288 unsigned long count, loff_t to, size_t *retlen);
289
290int default_mtd_readv(struct mtd_info *mtd, struct kvec *vecs,
291 unsigned long count, loff_t from, size_t *retlen);
292
1da177e4
LT
293#ifdef CONFIG_MTD_PARTITIONS
294void mtd_erase_callback(struct erase_info *instr);
295#else
296static inline void mtd_erase_callback(struct erase_info *instr)
297{
298 if (instr->callback)
299 instr->callback(instr);
300}
301#endif
302
303/*
304 * Debugging macro and defines
305 */
306#define MTD_DEBUG_LEVEL0 (0) /* Quiet */
307#define MTD_DEBUG_LEVEL1 (1) /* Audible */
308#define MTD_DEBUG_LEVEL2 (2) /* Loud */
309#define MTD_DEBUG_LEVEL3 (3) /* Noisy */
310
311#ifdef CONFIG_MTD_DEBUG
312#define DEBUG(n, args...) \
f4a43cfc 313 do { \
1da177e4
LT
314 if (n <= CONFIG_MTD_DEBUG_VERBOSE) \
315 printk(KERN_INFO args); \
316 } while(0)
317#else /* CONFIG_MTD_DEBUG */
95b1bc20
DB
318#define DEBUG(n, args...) \
319 do { \
320 if (0) \
321 printk(KERN_INFO args); \
322 } while(0)
1da177e4
LT
323
324#endif /* CONFIG_MTD_DEBUG */
325
326#endif /* __MTD_MTD_H__ */