2 * Copyright © 1999-2010 David Woodhouse <dwmw2@infradead.org> et al.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
23 #include <linux/types.h>
24 #include <linux/uio.h>
25 #include <linux/notifier.h>
26 #include <linux/device.h>
28 #include <mtd/mtd-abi.h>
30 #include <asm/div64.h>
32 #define MTD_CHAR_MAJOR 90
33 #define MTD_BLOCK_MAJOR 31
35 #define MTD_ERASE_PENDING 0x01
36 #define MTD_ERASING 0x02
37 #define MTD_ERASE_SUSPEND 0x04
38 #define MTD_ERASE_DONE 0x08
39 #define MTD_ERASE_FAILED 0x10
41 #define MTD_FAIL_ADDR_UNKNOWN -1LL
44 * If the erase fails, fail_addr might indicate exactly which block failed. If
45 * fail_addr = MTD_FAIL_ADDR_UNKNOWN, the failure was not at the device level
46 * or was not specific to any particular block.
57 void (*callback) (struct erase_info *self);
60 struct erase_info *next;
63 struct mtd_erase_region_info {
64 uint64_t offset; /* At which this region starts, from the beginning of the MTD */
65 uint32_t erasesize; /* For this region */
66 uint32_t numblocks; /* Number of blocks of erasesize in this region */
67 unsigned long *lockmap; /* If keeping bitmap of locks */
71 * struct mtd_oob_ops - oob operation operands
72 * @mode: operation mode
74 * @len: number of data bytes to write/read
76 * @retlen: number of data bytes written/read
78 * @ooblen: number of oob bytes to write/read
79 * @oobretlen: number of oob bytes written/read
80 * @ooboffs: offset of oob data in the oob area (only relevant when
81 * mode = MTD_OPS_PLACE_OOB or MTD_OPS_RAW)
82 * @datbuf: data buffer - if NULL only oob data are read/written
83 * @oobbuf: oob data buffer
85 * Note, it is allowed to read more than one OOB area at one go, but not write.
86 * The interface assumes that the OOB write requests program only one page's
100 #define MTD_MAX_OOBFREE_ENTRIES_LARGE 32
101 #define MTD_MAX_ECCPOS_ENTRIES_LARGE 448
103 * Internal ECC layout control structure. For historical reasons, there is a
104 * similar, smaller struct nand_ecclayout_user (in mtd-abi.h) that is retained
105 * for export to user-space via the ECCGETLAYOUT ioctl.
106 * nand_ecclayout should be expandable in the future simply by the above macros.
108 struct nand_ecclayout {
110 __u32 eccpos[MTD_MAX_ECCPOS_ENTRIES_LARGE];
112 struct nand_oobfree oobfree[MTD_MAX_OOBFREE_ENTRIES_LARGE];
115 struct module; /* only needed for owner field in mtd_info */
120 uint64_t size; // Total size of the MTD
122 /* "Major" erase size for the device. Naïve users may take this
123 * to be the only erase size available, or may use the more detailed
124 * information below if they desire
127 /* Minimal writable flash unit size. In case of NOR flash it is 1 (even
128 * though individual bits can be cleared), in case of NAND flash it is
129 * one NAND page (or half, or one-fourths of it), in case of ECC-ed NOR
130 * it is of ECC block size, etc. It is illegal to have writesize = 0.
131 * Any driver registering a struct mtd_info must ensure a writesize of
137 * Size of the write buffer used by the MTD. MTD devices having a write
138 * buffer can write multiple writesize chunks at a time. E.g. while
139 * writing 4 * writesize bytes to a device with 2 * writesize bytes
140 * buffer the MTD driver can (but doesn't have to) do 2 writesize
141 * operations, but not 4. Currently, all NANDs have writebufsize
142 * equivalent to writesize (NAND page size). Some NOR flashes do have
143 * writebufsize greater than writesize.
145 uint32_t writebufsize;
147 uint32_t oobsize; // Amount of OOB data per block (e.g. 16)
148 uint32_t oobavail; // Available OOB bytes per block
151 * If erasesize is a power of 2 then the shift is stored in
152 * erasesize_shift otherwise erasesize_shift is zero. Ditto writesize.
154 unsigned int erasesize_shift;
155 unsigned int writesize_shift;
156 /* Masks based on erasesize_shift and writesize_shift */
157 unsigned int erasesize_mask;
158 unsigned int writesize_mask;
160 // Kernel-only stuff starts here.
164 /* ECC layout structure pointer - read only! */
165 struct nand_ecclayout *ecclayout;
167 /* Data for variable erase regions. If numeraseregions is zero,
168 * it means that the whole device has erasesize as given above.
171 struct mtd_erase_region_info *eraseregions;
174 * Do not call via these pointers, use corresponding mtd_*()
177 int (*erase) (struct mtd_info *mtd, struct erase_info *instr);
178 int (*point) (struct mtd_info *mtd, loff_t from, size_t len,
179 size_t *retlen, void **virt, resource_size_t *phys);
180 void (*unpoint) (struct mtd_info *mtd, loff_t from, size_t len);
181 unsigned long (*get_unmapped_area) (struct mtd_info *mtd,
183 unsigned long offset,
184 unsigned long flags);
185 int (*read) (struct mtd_info *mtd, loff_t from, size_t len,
186 size_t *retlen, u_char *buf);
187 int (*write) (struct mtd_info *mtd, loff_t to, size_t len,
188 size_t *retlen, const u_char *buf);
189 int (*panic_write) (struct mtd_info *mtd, loff_t to, size_t len,
190 size_t *retlen, const u_char *buf);
191 int (*read_oob) (struct mtd_info *mtd, loff_t from,
192 struct mtd_oob_ops *ops);
193 int (*write_oob) (struct mtd_info *mtd, loff_t to,
194 struct mtd_oob_ops *ops);
195 int (*get_fact_prot_info) (struct mtd_info *mtd, struct otp_info *buf,
197 int (*read_fact_prot_reg) (struct mtd_info *mtd, loff_t from,
198 size_t len, size_t *retlen, u_char *buf);
199 int (*get_user_prot_info) (struct mtd_info *mtd, struct otp_info *buf,
201 int (*read_user_prot_reg) (struct mtd_info *mtd, loff_t from,
202 size_t len, size_t *retlen, u_char *buf);
203 int (*write_user_prot_reg) (struct mtd_info *mtd, loff_t to, size_t len,
204 size_t *retlen, u_char *buf);
205 int (*lock_user_prot_reg) (struct mtd_info *mtd, loff_t from,
207 int (*writev) (struct mtd_info *mtd, const struct kvec *vecs,
208 unsigned long count, loff_t to, size_t *retlen);
209 void (*sync) (struct mtd_info *mtd);
210 int (*lock) (struct mtd_info *mtd, loff_t ofs, uint64_t len);
212 /* Backing device capabilities for this device
213 * - provides mmap capabilities
215 struct backing_dev_info *backing_dev_info;
217 int (*unlock) (struct mtd_info *mtd, loff_t ofs, uint64_t len);
218 int (*is_locked) (struct mtd_info *mtd, loff_t ofs, uint64_t len);
220 /* Power Management functions */
221 int (*suspend) (struct mtd_info *mtd);
222 void (*resume) (struct mtd_info *mtd);
224 /* Bad block management functions */
225 int (*block_isbad) (struct mtd_info *mtd, loff_t ofs);
226 int (*block_markbad) (struct mtd_info *mtd, loff_t ofs);
228 struct notifier_block reboot_notifier; /* default mode before reboot */
230 /* ECC status information */
231 struct mtd_ecc_stats ecc_stats;
232 /* Subpage shift (NAND) */
237 struct module *owner;
241 /* If the driver is something smart, like UBI, it may need to maintain
242 * its own reference counting. The below functions are only for driver.
243 * The driver may register its callbacks. These callbacks are not
244 * supposed to be called by MTD users */
245 int (*get_device) (struct mtd_info *mtd);
246 void (*put_device) (struct mtd_info *mtd);
250 * Erase is an asynchronous operation. Device drivers are supposed
251 * to call instr->callback() whenever the operation completes, even
252 * if it completes with a failure.
253 * Callers are supposed to pass a callback function and wait for it
254 * to be called before writing to the block.
256 static inline int mtd_erase(struct mtd_info *mtd, struct erase_info *instr)
258 return mtd->erase(mtd, instr);
262 * This stuff for eXecute-In-Place. phys is optional and may be set to NULL.
264 static inline int mtd_point(struct mtd_info *mtd, loff_t from, size_t len,
265 size_t *retlen, void **virt, resource_size_t *phys)
267 return mtd->point(mtd, from, len, retlen, virt, phys);
270 /* We probably shouldn't allow XIP if the unpoint isn't a NULL */
271 static inline void mtd_unpoint(struct mtd_info *mtd, loff_t from, size_t len)
273 return mtd->unpoint(mtd, from, len);
277 * Allow NOMMU mmap() to directly map the device (if not NULL)
278 * - return the address to which the offset maps
279 * - return -ENOSYS to indicate refusal to do the mapping
281 static inline unsigned long mtd_get_unmapped_area(struct mtd_info *mtd,
283 unsigned long offset,
286 return mtd->get_unmapped_area(mtd, len, offset, flags);
289 static inline int mtd_read(struct mtd_info *mtd, loff_t from, size_t len,
290 size_t *retlen, u_char *buf)
292 return mtd->read(mtd, from, len, retlen, buf);
295 static inline int mtd_write(struct mtd_info *mtd, loff_t to, size_t len,
296 size_t *retlen, const u_char *buf)
298 return mtd->write(mtd, to, len, retlen, buf);
302 * In blackbox flight recorder like scenarios we want to make successful writes
303 * in interrupt context. panic_write() is only intended to be called when its
304 * known the kernel is about to panic and we need the write to succeed. Since
305 * the kernel is not going to be running for much longer, this function can
306 * break locks and delay to ensure the write succeeds (but not sleep).
308 static inline int mtd_panic_write(struct mtd_info *mtd, loff_t to, size_t len,
309 size_t *retlen, const u_char *buf)
311 return mtd->panic_write(mtd, to, len, retlen, buf);
314 static inline int mtd_read_oob(struct mtd_info *mtd, loff_t from,
315 struct mtd_oob_ops *ops)
317 return mtd->read_oob(mtd, from, ops);
320 static inline int mtd_write_oob(struct mtd_info *mtd, loff_t to,
321 struct mtd_oob_ops *ops)
323 return mtd->write_oob(mtd, to, ops);
327 * Method to access the protection register area, present in some flash
328 * devices. The user data is one time programmable but the factory data is read
331 static inline int mtd_get_fact_prot_info(struct mtd_info *mtd,
332 struct otp_info *buf, size_t len)
334 return mtd->get_fact_prot_info(mtd, buf, len);
337 static inline int mtd_read_fact_prot_reg(struct mtd_info *mtd, loff_t from,
338 size_t len, size_t *retlen,
341 return mtd->read_fact_prot_reg(mtd, from, len, retlen, buf);
344 static inline int mtd_get_user_prot_info(struct mtd_info *mtd,
345 struct otp_info *buf,
348 return mtd->get_user_prot_info(mtd, buf, len);
351 static inline int mtd_read_user_prot_reg(struct mtd_info *mtd, loff_t from,
352 size_t len, size_t *retlen,
355 return mtd->read_user_prot_reg(mtd, from, len, retlen, buf);
358 static inline int mtd_write_user_prot_reg(struct mtd_info *mtd, loff_t to,
359 size_t len, size_t *retlen,
362 return mtd->write_user_prot_reg(mtd, to, len, retlen, buf);
365 static inline int mtd_lock_user_prot_reg(struct mtd_info *mtd, loff_t from,
368 return mtd->lock_user_prot_reg(mtd, from, len);
372 * kvec-based read/write method. NB: The 'count' parameter is the number of
373 * _vectors_, each of which contains an (ofs, len) tuple.
375 static inline int mtd_writev(struct mtd_info *mtd, const struct kvec *vecs,
376 unsigned long count, loff_t to, size_t *retlen)
378 return mtd->writev(mtd, vecs, count, to, retlen);
381 static inline void mtd_sync(struct mtd_info *mtd)
386 /* Chip-supported device locking */
387 static inline int mtd_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
389 return mtd->lock(mtd, ofs, len);
392 static inline struct mtd_info *dev_to_mtd(struct device *dev)
394 return dev ? dev_get_drvdata(dev) : NULL;
397 static inline uint32_t mtd_div_by_eb(uint64_t sz, struct mtd_info *mtd)
399 if (mtd->erasesize_shift)
400 return sz >> mtd->erasesize_shift;
401 do_div(sz, mtd->erasesize);
405 static inline uint32_t mtd_mod_by_eb(uint64_t sz, struct mtd_info *mtd)
407 if (mtd->erasesize_shift)
408 return sz & mtd->erasesize_mask;
409 return do_div(sz, mtd->erasesize);
412 static inline uint32_t mtd_div_by_ws(uint64_t sz, struct mtd_info *mtd)
414 if (mtd->writesize_shift)
415 return sz >> mtd->writesize_shift;
416 do_div(sz, mtd->writesize);
420 static inline uint32_t mtd_mod_by_ws(uint64_t sz, struct mtd_info *mtd)
422 if (mtd->writesize_shift)
423 return sz & mtd->writesize_mask;
424 return do_div(sz, mtd->writesize);
427 /* Kernel-side ioctl definitions */
429 struct mtd_partition;
430 struct mtd_part_parser_data;
432 extern int mtd_device_parse_register(struct mtd_info *mtd,
433 const char **part_probe_types,
434 struct mtd_part_parser_data *parser_data,
435 const struct mtd_partition *defparts,
437 #define mtd_device_register(master, parts, nr_parts) \
438 mtd_device_parse_register(master, NULL, NULL, parts, nr_parts)
439 extern int mtd_device_unregister(struct mtd_info *master);
440 extern struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num);
441 extern int __get_mtd_device(struct mtd_info *mtd);
442 extern void __put_mtd_device(struct mtd_info *mtd);
443 extern struct mtd_info *get_mtd_device_nm(const char *name);
444 extern void put_mtd_device(struct mtd_info *mtd);
447 struct mtd_notifier {
448 void (*add)(struct mtd_info *mtd);
449 void (*remove)(struct mtd_info *mtd);
450 struct list_head list;
454 extern void register_mtd_user (struct mtd_notifier *new);
455 extern int unregister_mtd_user (struct mtd_notifier *old);
457 int default_mtd_writev(struct mtd_info *mtd, const struct kvec *vecs,
458 unsigned long count, loff_t to, size_t *retlen);
460 int default_mtd_readv(struct mtd_info *mtd, struct kvec *vecs,
461 unsigned long count, loff_t from, size_t *retlen);
463 void *mtd_kmalloc_up_to(const struct mtd_info *mtd, size_t *size);
465 void mtd_erase_callback(struct erase_info *instr);
467 static inline int mtd_is_bitflip(int err) {
468 return err == -EUCLEAN;
471 static inline int mtd_is_eccerr(int err) {
472 return err == -EBADMSG;
475 static inline int mtd_is_bitflip_or_eccerr(int err) {
476 return mtd_is_bitflip(err) || mtd_is_eccerr(err);
479 #endif /* __MTD_MTD_H__ */