2 * Copyright (C) 1999-2003 David Woodhouse <dwmw2@infradead.org> et al.
10 #include <linux/types.h>
12 #include <linux/mtd/mtd-abi.h>
14 #define MTD_CHAR_MAJOR 90
15 #define MTD_BLOCK_MAJOR 31
16 #define MAX_MTD_DEVICES 32
18 #define MTD_ERASE_PENDING 0x01
19 #define MTD_ERASING 0x02
20 #define MTD_ERASE_SUSPEND 0x04
21 #define MTD_ERASE_DONE 0x08
22 #define MTD_ERASE_FAILED 0x10
24 #define MTD_FAIL_ADDR_UNKNOWN -1LL
27 * Enumeration for NAND/OneNAND flash chip state
42 /* If the erase fails, fail_addr might indicate exactly which block failed. If
43 fail_addr = MTD_FAIL_ADDR_UNKNOWN, the failure was not at the device level or was not
44 specific to any particular block. */
54 void (*callback) (struct erase_info *self);
57 struct erase_info *next;
60 struct mtd_erase_region_info {
61 uint64_t offset; /* At which this region starts, from the beginning of the MTD */
62 u_int32_t erasesize; /* For this region */
63 u_int32_t numblocks; /* Number of blocks of erasesize in this region */
64 unsigned long *lockmap; /* If keeping bitmap of locks */
70 * MTD_OOB_PLACE: oob data are placed at the given offset
71 * MTD_OOB_AUTO: oob data are automatically placed at the free areas
72 * which are defined by the ecclayout
73 * MTD_OOB_RAW: mode to read raw data+oob in one chunk. The oob data
74 * is inserted into the data. Thats a raw image of the
84 * struct mtd_oob_ops - oob operation operands
85 * @mode: operation mode
87 * @len: number of data bytes to write/read
89 * @retlen: number of data bytes written/read
91 * @ooblen: number of oob bytes to write/read
92 * @oobretlen: number of oob bytes written/read
93 * @ooboffs: offset of oob data in the oob area (only relevant when
94 * mode = MTD_OOB_PLACE)
95 * @datbuf: data buffer - if NULL only oob data are read/written
96 * @oobbuf: oob data buffer
98 * Note, it is allowed to read more then one OOB area at one go, but not write.
99 * The interface assumes that the OOB write requests program only one page's
116 uint64_t size; // Total size of the MTD
118 /* "Major" erase size for the device. Naïve users may take this
119 * to be the only erase size available, or may use the more detailed
120 * information below if they desire
123 /* Minimal writable flash unit size. In case of NOR flash it is 1 (even
124 * though individual bits can be cleared), in case of NAND flash it is
125 * one NAND page (or half, or one-fourths of it), in case of ECC-ed NOR
126 * it is of ECC block size, etc. It is illegal to have writesize = 0.
127 * Any driver registering a struct mtd_info must ensure a writesize of
132 u_int32_t oobsize; /* Amount of OOB data per block (e.g. 16) */
133 u_int32_t oobavail; /* Available OOB bytes per block */
135 /* Kernel-only stuff starts here. */
139 /* ecc layout structure pointer - read only ! */
140 struct nand_ecclayout *ecclayout;
142 /* Data for variable erase regions. If numeraseregions is zero,
143 * it means that the whole device has erasesize as given above.
146 struct mtd_erase_region_info *eraseregions;
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.
155 int (*erase) (struct mtd_info *mtd, struct erase_info *instr);
157 /* This stuff for eXecute-In-Place */
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, phys_addr_t *phys);
162 /* We probably shouldn't allow XIP if the unpoint isn't a NULL */
163 void (*unpoint) (struct mtd_info *mtd, loff_t from, size_t len);
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);
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). */
176 int (*panic_write) (struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf);
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);
184 * Methods to access the protection register area, present in some
185 * flash devices. The user data is one time programmable but the
186 * factory data is read only.
188 int (*get_fact_prot_info) (struct mtd_info *mtd, struct otp_info *buf, size_t len);
189 int (*read_fact_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
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);
192 int (*write_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
193 int (*lock_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len);
197 /* kvec-based read/write methods.
198 NB: The 'count' parameter is the number of _vectors_, each of
199 which contains an (ofs, len) tuple.
201 int (*writev) (struct mtd_info *mtd, const struct kvec *vecs, unsigned long count, loff_t to, size_t *retlen);
205 void (*sync) (struct mtd_info *mtd);
207 /* Chip-supported device locking */
208 int (*lock) (struct mtd_info *mtd, loff_t ofs, uint64_t len);
209 int (*unlock) (struct mtd_info *mtd, loff_t ofs, uint64_t len);
211 /* Power Management functions */
212 int (*suspend) (struct mtd_info *mtd);
213 void (*resume) (struct mtd_info *mtd);
215 /* Bad block management functions */
216 int (*block_isbad) (struct mtd_info *mtd, loff_t ofs);
217 int (*block_markbad) (struct mtd_info *mtd, loff_t ofs);
221 struct notifier_block reboot_notifier; /* default mode before reboot */
224 /* ECC status information */
225 struct mtd_ecc_stats ecc_stats;
226 /* Subpage shift (NAND) */
231 struct module *owner;
234 /* If the driver is something smart, like UBI, it may need to maintain
235 * its own reference counting. The below functions are only for driver.
236 * The driver may register its callbacks. These callbacks are not
237 * supposed to be called by MTD users */
238 int (*get_device) (struct mtd_info *mtd);
239 void (*put_device) (struct mtd_info *mtd);
242 static inline uint32_t mtd_div_by_eb(uint64_t sz, struct mtd_info *mtd)
244 do_div(sz, mtd->erasesize);
248 static inline uint32_t mtd_mod_by_eb(uint64_t sz, struct mtd_info *mtd)
250 return do_div(sz, mtd->erasesize);
253 /* Kernel-side ioctl definitions */
255 extern int add_mtd_device(struct mtd_info *mtd);
256 extern int del_mtd_device (struct mtd_info *mtd);
258 extern struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num);
259 extern struct mtd_info *get_mtd_device_nm(const char *name);
261 extern void put_mtd_device(struct mtd_info *mtd);
265 struct mtd_notifier {
266 void (*add)(struct mtd_info *mtd);
267 void (*remove)(struct mtd_info *mtd);
268 struct list_head list;
271 extern void register_mtd_user (struct mtd_notifier *new);
272 extern int unregister_mtd_user (struct mtd_notifier *old);
274 int default_mtd_writev(struct mtd_info *mtd, const struct kvec *vecs,
275 unsigned long count, loff_t to, size_t *retlen);
277 int default_mtd_readv(struct mtd_info *mtd, struct kvec *vecs,
278 unsigned long count, loff_t from, size_t *retlen);
281 #ifdef CONFIG_MTD_PARTITIONS
282 void mtd_erase_callback(struct erase_info *instr);
284 static inline void mtd_erase_callback(struct erase_info *instr)
287 instr->callback(instr);
292 * Debugging macro and defines
294 #define MTD_DEBUG_LEVEL0 (0) /* Quiet */
295 #define MTD_DEBUG_LEVEL1 (1) /* Audible */
296 #define MTD_DEBUG_LEVEL2 (2) /* Loud */
297 #define MTD_DEBUG_LEVEL3 (3) /* Noisy */
299 #ifdef CONFIG_MTD_DEBUG
300 #define MTDDEBUG(n, args...) \
302 if (n <= CONFIG_MTD_DEBUG_VERBOSE) \
303 printk(KERN_INFO args); \
305 #else /* CONFIG_MTD_DEBUG */
306 #define MTDDEBUG(n, args...) \
309 printk(KERN_INFO args); \
311 #endif /* CONFIG_MTD_DEBUG */
313 #endif /* __MTD_MTD_H__ */