2 * Copyright (C) 1999-2003 David Woodhouse <dwmw2@infradead.org> et al.
10 #include <linux/types.h>
11 #include <linux/module.h>
12 #include <linux/uio.h>
13 #include <linux/notifier.h>
15 #include <linux/mtd/compatmac.h>
16 #include <mtd/mtd-abi.h>
18 #include <asm/div64.h>
20 #define MTD_CHAR_MAJOR 90
21 #define MTD_BLOCK_MAJOR 31
22 #define MAX_MTD_DEVICES 32
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
30 #define MTD_FAIL_ADDR_UNKNOWN -1LL
32 /* If the erase fails, fail_addr might indicate exactly which block failed. If
33 fail_addr = MTD_FAIL_ADDR_UNKNOWN, the failure was not at the device level or was not
34 specific to any particular block. */
44 void (*callback) (struct erase_info *self);
47 struct erase_info *next;
50 struct mtd_erase_region_info {
51 uint64_t offset; /* At which this region starts, from the beginning of the MTD */
52 uint32_t erasesize; /* For this region */
53 uint32_t numblocks; /* Number of blocks of erasesize in this region */
54 unsigned long *lockmap; /* If keeping bitmap of locks */
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
74 * struct mtd_oob_ops - oob operation operands
75 * @mode: operation mode
77 * @len: number of data bytes to write/read
79 * @retlen: number of data bytes written/read
81 * @ooblen: number of oob bytes to write/read
82 * @oobretlen: number of oob bytes written/read
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
88 * Note, it is allowed to read more than one OOB area at one go, but not write.
89 * The interface assumes that the OOB write requests program only one page's
106 uint64_t size; // Total size of the MTD
108 /* "Major" erase size for the device. Naïve users may take this
109 * to be the only erase size available, or may use the more detailed
110 * information below if they desire
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
122 uint32_t oobsize; // Amount of OOB data per block (e.g. 16)
123 uint32_t oobavail; // Available OOB bytes per block
126 * If erasesize is a power of 2 then the shift is stored in
127 * erasesize_shift otherwise erasesize_shift is zero. Ditto writesize.
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;
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, resource_size_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);
165 /* Allow NOMMU mmap() to directly map the device (if not NULL)
166 * - return the address to which the offset maps
167 * - return -ENOSYS to indicate refusal to do the mapping
169 unsigned long (*get_unmapped_area) (struct mtd_info *mtd,
171 unsigned long offset,
172 unsigned long flags);
174 /* Backing device capabilities for this device
175 * - provides mmap capabilities
177 struct backing_dev_info *backing_dev_info;
180 int (*read) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
181 int (*write) (struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf);
183 /* In blackbox flight recorder like scenarios we want to make successful
184 writes in interrupt context. panic_write() is only intended to be
185 called when its known the kernel is about to panic and we need the
186 write to succeed. Since the kernel is not going to be running for much
187 longer, this function can break locks and delay to ensure the write
188 succeeds (but not sleep). */
190 int (*panic_write) (struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf);
192 int (*read_oob) (struct mtd_info *mtd, loff_t from,
193 struct mtd_oob_ops *ops);
194 int (*write_oob) (struct mtd_info *mtd, loff_t to,
195 struct mtd_oob_ops *ops);
198 * Methods to access the protection register area, present in some
199 * flash devices. The user data is one time programmable but the
200 * factory data is read only.
202 int (*get_fact_prot_info) (struct mtd_info *mtd, struct otp_info *buf, size_t len);
203 int (*read_fact_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
204 int (*get_user_prot_info) (struct mtd_info *mtd, struct otp_info *buf, size_t len);
205 int (*read_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
206 int (*write_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
207 int (*lock_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len);
209 /* kvec-based read/write methods.
210 NB: The 'count' parameter is the number of _vectors_, each of
211 which contains an (ofs, len) tuple.
213 int (*writev) (struct mtd_info *mtd, const struct kvec *vecs, unsigned long count, loff_t to, size_t *retlen);
216 void (*sync) (struct mtd_info *mtd);
218 /* Chip-supported device locking */
219 int (*lock) (struct mtd_info *mtd, loff_t ofs, uint64_t len);
220 int (*unlock) (struct mtd_info *mtd, loff_t ofs, uint64_t len);
222 /* Power Management functions */
223 int (*suspend) (struct mtd_info *mtd);
224 void (*resume) (struct mtd_info *mtd);
226 /* Bad block management functions */
227 int (*block_isbad) (struct mtd_info *mtd, loff_t ofs);
228 int (*block_markbad) (struct mtd_info *mtd, loff_t ofs);
230 struct notifier_block reboot_notifier; /* default mode before reboot */
232 /* ECC status information */
233 struct mtd_ecc_stats ecc_stats;
234 /* Subpage shift (NAND) */
239 struct module *owner;
242 /* If the driver is something smart, like UBI, it may need to maintain
243 * its own reference counting. The below functions are only for driver.
244 * The driver may register its callbacks. These callbacks are not
245 * supposed to be called by MTD users */
246 int (*get_device) (struct mtd_info *mtd);
247 void (*put_device) (struct mtd_info *mtd);
250 static inline uint32_t mtd_div_by_eb(uint64_t sz, struct mtd_info *mtd)
252 if (mtd->erasesize_shift)
253 return sz >> mtd->erasesize_shift;
254 do_div(sz, mtd->erasesize);
258 static inline uint32_t mtd_mod_by_eb(uint64_t sz, struct mtd_info *mtd)
260 if (mtd->erasesize_shift)
261 return sz & mtd->erasesize_mask;
262 return do_div(sz, mtd->erasesize);
265 static inline uint32_t mtd_div_by_ws(uint64_t sz, struct mtd_info *mtd)
267 if (mtd->writesize_shift)
268 return sz >> mtd->writesize_shift;
269 do_div(sz, mtd->writesize);
273 static inline uint32_t mtd_mod_by_ws(uint64_t sz, struct mtd_info *mtd)
275 if (mtd->writesize_shift)
276 return sz & mtd->writesize_mask;
277 return do_div(sz, mtd->writesize);
280 /* Kernel-side ioctl definitions */
282 extern int add_mtd_device(struct mtd_info *mtd);
283 extern int del_mtd_device (struct mtd_info *mtd);
285 extern struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num);
286 extern struct mtd_info *get_mtd_device_nm(const char *name);
288 extern void put_mtd_device(struct mtd_info *mtd);
291 struct mtd_notifier {
292 void (*add)(struct mtd_info *mtd);
293 void (*remove)(struct mtd_info *mtd);
294 struct list_head list;
298 extern void register_mtd_user (struct mtd_notifier *new);
299 extern int unregister_mtd_user (struct mtd_notifier *old);
301 int default_mtd_writev(struct mtd_info *mtd, const struct kvec *vecs,
302 unsigned long count, loff_t to, size_t *retlen);
304 int default_mtd_readv(struct mtd_info *mtd, struct kvec *vecs,
305 unsigned long count, loff_t from, size_t *retlen);
307 #ifdef CONFIG_MTD_PARTITIONS
308 void mtd_erase_callback(struct erase_info *instr);
310 static inline void mtd_erase_callback(struct erase_info *instr)
313 instr->callback(instr);
318 * Debugging macro and defines
320 #define MTD_DEBUG_LEVEL0 (0) /* Quiet */
321 #define MTD_DEBUG_LEVEL1 (1) /* Audible */
322 #define MTD_DEBUG_LEVEL2 (2) /* Loud */
323 #define MTD_DEBUG_LEVEL3 (3) /* Noisy */
325 #ifdef CONFIG_MTD_DEBUG
326 #define DEBUG(n, args...) \
328 if (n <= CONFIG_MTD_DEBUG_VERBOSE) \
329 printk(KERN_INFO args); \
331 #else /* CONFIG_MTD_DEBUG */
332 #define DEBUG(n, args...) \
335 printk(KERN_INFO args); \
338 #endif /* CONFIG_MTD_DEBUG */
340 #endif /* __MTD_MTD_H__ */