2 * Copyright © 1999-2010 David Woodhouse <dwmw2@infradead.org> et al.
4 * SPDX-License-Identifier: GPL-2.0+
12 #include <linux/types.h>
13 #include <linux/uio.h>
14 #include <linux/notifier.h>
15 #include <linux/device.h>
17 #include <mtd/mtd-abi.h>
19 #include <asm/div64.h>
21 #include <linux/compat.h>
22 #include <mtd/mtd-abi.h>
23 #include <linux/errno.h>
26 #define MAX_MTD_DEVICES 32
29 #define MTD_ERASE_PENDING 0x01
30 #define MTD_ERASING 0x02
31 #define MTD_ERASE_SUSPEND 0x04
32 #define MTD_ERASE_DONE 0x08
33 #define MTD_ERASE_FAILED 0x10
35 #define MTD_FAIL_ADDR_UNKNOWN -1LL
38 * If the erase fails, fail_addr might indicate exactly which block failed. If
39 * fail_addr = MTD_FAIL_ADDR_UNKNOWN, the failure was not at the device level
40 * or was not specific to any particular block.
51 void (*callback) (struct erase_info *self);
54 struct erase_info *next;
58 struct mtd_erase_region_info {
59 uint64_t offset; /* At which this region starts, from the beginning of the MTD */
60 uint32_t erasesize; /* For this region */
61 uint32_t numblocks; /* Number of blocks of erasesize in this region */
62 unsigned long *lockmap; /* If keeping bitmap of locks */
66 * struct mtd_oob_ops - oob operation operands
67 * @mode: operation mode
69 * @len: number of data bytes to write/read
71 * @retlen: number of data bytes written/read
73 * @ooblen: number of oob bytes to write/read
74 * @oobretlen: number of oob bytes written/read
75 * @ooboffs: offset of oob data in the oob area (only relevant when
76 * mode = MTD_OPS_PLACE_OOB or MTD_OPS_RAW)
77 * @datbuf: data buffer - if NULL only oob data are read/written
78 * @oobbuf: oob data buffer
80 * Note, it is allowed to read more than one OOB area at one go, but not write.
81 * The interface assumes that the OOB write requests program only one page's
95 #ifdef CONFIG_SYS_NAND_MAX_OOBFREE
96 #define MTD_MAX_OOBFREE_ENTRIES_LARGE CONFIG_SYS_NAND_MAX_OOBFREE
98 #define MTD_MAX_OOBFREE_ENTRIES_LARGE 32
101 #ifdef CONFIG_SYS_NAND_MAX_ECCPOS
102 #define MTD_MAX_ECCPOS_ENTRIES_LARGE CONFIG_SYS_NAND_MAX_ECCPOS
104 #define MTD_MAX_ECCPOS_ENTRIES_LARGE 680
108 * Internal ECC layout control structure. For historical reasons, there is a
109 * similar, smaller struct nand_ecclayout_user (in mtd-abi.h) that is retained
110 * for export to user-space via the ECCGETLAYOUT ioctl.
111 * nand_ecclayout should be expandable in the future simply by the above macros.
113 struct nand_ecclayout {
115 __u32 eccpos[MTD_MAX_ECCPOS_ENTRIES_LARGE];
117 struct nand_oobfree oobfree[MTD_MAX_OOBFREE_ENTRIES_LARGE];
120 struct module; /* only needed for owner field in mtd_info */
125 uint64_t size; // Total size of the MTD
127 /* "Major" erase size for the device. Naïve users may take this
128 * to be the only erase size available, or may use the more detailed
129 * information below if they desire
132 /* Minimal writable flash unit size. In case of NOR flash it is 1 (even
133 * though individual bits can be cleared), in case of NAND flash it is
134 * one NAND page (or half, or one-fourths of it), in case of ECC-ed NOR
135 * it is of ECC block size, etc. It is illegal to have writesize = 0.
136 * Any driver registering a struct mtd_info must ensure a writesize of
142 * Size of the write buffer used by the MTD. MTD devices having a write
143 * buffer can write multiple writesize chunks at a time. E.g. while
144 * writing 4 * writesize bytes to a device with 2 * writesize bytes
145 * buffer the MTD driver can (but doesn't have to) do 2 writesize
146 * operations, but not 4. Currently, all NANDs have writebufsize
147 * equivalent to writesize (NAND page size). Some NOR flashes do have
148 * writebufsize greater than writesize.
150 uint32_t writebufsize;
152 uint32_t oobsize; // Amount of OOB data per block (e.g. 16)
153 uint32_t oobavail; // Available OOB bytes per block
156 * If erasesize is a power of 2 then the shift is stored in
157 * erasesize_shift otherwise erasesize_shift is zero. Ditto writesize.
159 unsigned int erasesize_shift;
160 unsigned int writesize_shift;
161 /* Masks based on erasesize_shift and writesize_shift */
162 unsigned int erasesize_mask;
163 unsigned int writesize_mask;
166 * read ops return -EUCLEAN if max number of bitflips corrected on any
167 * one region comprising an ecc step equals or exceeds this value.
168 * Settable by driver, else defaults to ecc_strength. User can override
169 * in sysfs. N.B. The meaning of the -EUCLEAN return code has changed;
170 * see Documentation/ABI/testing/sysfs-class-mtd for more detail.
172 unsigned int bitflip_threshold;
174 // Kernel-only stuff starts here.
182 /* ECC layout structure pointer - read only! */
183 struct nand_ecclayout *ecclayout;
185 /* the ecc step size. */
186 unsigned int ecc_step_size;
188 /* max number of correctible bit errors per ecc step */
189 unsigned int ecc_strength;
191 /* Data for variable erase regions. If numeraseregions is zero,
192 * it means that the whole device has erasesize as given above.
195 struct mtd_erase_region_info *eraseregions;
198 * Do not call via these pointers, use corresponding mtd_*()
201 int (*_erase) (struct mtd_info *mtd, struct erase_info *instr);
203 int (*_point) (struct mtd_info *mtd, loff_t from, size_t len,
204 size_t *retlen, void **virt, resource_size_t *phys);
205 int (*_unpoint) (struct mtd_info *mtd, loff_t from, size_t len);
207 unsigned long (*_get_unmapped_area) (struct mtd_info *mtd,
209 unsigned long offset,
210 unsigned long flags);
211 int (*_read) (struct mtd_info *mtd, loff_t from, size_t len,
212 size_t *retlen, u_char *buf);
213 int (*_write) (struct mtd_info *mtd, loff_t to, size_t len,
214 size_t *retlen, const u_char *buf);
215 int (*_panic_write) (struct mtd_info *mtd, loff_t to, size_t len,
216 size_t *retlen, const u_char *buf);
217 int (*_read_oob) (struct mtd_info *mtd, loff_t from,
218 struct mtd_oob_ops *ops);
219 int (*_write_oob) (struct mtd_info *mtd, loff_t to,
220 struct mtd_oob_ops *ops);
221 int (*_get_fact_prot_info) (struct mtd_info *mtd, size_t len,
222 size_t *retlen, struct otp_info *buf);
223 int (*_read_fact_prot_reg) (struct mtd_info *mtd, loff_t from,
224 size_t len, size_t *retlen, u_char *buf);
225 int (*_get_user_prot_info) (struct mtd_info *mtd, size_t len,
226 size_t *retlen, struct otp_info *buf);
227 int (*_read_user_prot_reg) (struct mtd_info *mtd, loff_t from,
228 size_t len, size_t *retlen, u_char *buf);
229 int (*_write_user_prot_reg) (struct mtd_info *mtd, loff_t to,
230 size_t len, size_t *retlen, u_char *buf);
231 int (*_lock_user_prot_reg) (struct mtd_info *mtd, loff_t from,
234 int (*_writev) (struct mtd_info *mtd, const struct kvec *vecs,
235 unsigned long count, loff_t to, size_t *retlen);
237 void (*_sync) (struct mtd_info *mtd);
238 int (*_lock) (struct mtd_info *mtd, loff_t ofs, uint64_t len);
239 int (*_unlock) (struct mtd_info *mtd, loff_t ofs, uint64_t len);
240 int (*_is_locked) (struct mtd_info *mtd, loff_t ofs, uint64_t len);
241 int (*_block_isreserved) (struct mtd_info *mtd, loff_t ofs);
242 int (*_block_isbad) (struct mtd_info *mtd, loff_t ofs);
243 int (*_block_markbad) (struct mtd_info *mtd, loff_t ofs);
245 int (*_suspend) (struct mtd_info *mtd);
246 void (*_resume) (struct mtd_info *mtd);
247 void (*_reboot) (struct mtd_info *mtd);
250 * If the driver is something smart, like UBI, it may need to maintain
251 * its own reference counting. The below functions are only for driver.
253 int (*_get_device) (struct mtd_info *mtd);
254 void (*_put_device) (struct mtd_info *mtd);
257 /* Backing device capabilities for this device
258 * - provides mmap capabilities
260 struct backing_dev_info *backing_dev_info;
262 struct notifier_block reboot_notifier; /* default mode before reboot */
265 /* ECC status information */
266 struct mtd_ecc_stats ecc_stats;
267 /* Subpage shift (NAND) */
272 struct module *owner;
281 static inline int mtd_oobavail(struct mtd_info *mtd, struct mtd_oob_ops *ops)
283 return ops->mode == MTD_OPS_AUTO_OOB ? mtd->oobavail : mtd->oobsize;
286 int mtd_erase(struct mtd_info *mtd, struct erase_info *instr);
288 int mtd_point(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen,
289 void **virt, resource_size_t *phys);
290 int mtd_unpoint(struct mtd_info *mtd, loff_t from, size_t len);
292 unsigned long mtd_get_unmapped_area(struct mtd_info *mtd, unsigned long len,
293 unsigned long offset, unsigned long flags);
294 int mtd_read(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen,
296 int mtd_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen,
298 int mtd_panic_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen,
301 int mtd_read_oob(struct mtd_info *mtd, loff_t from, struct mtd_oob_ops *ops);
303 static inline int mtd_write_oob(struct mtd_info *mtd, loff_t to,
304 struct mtd_oob_ops *ops)
306 ops->retlen = ops->oobretlen = 0;
307 if (!mtd->_write_oob)
309 if (!(mtd->flags & MTD_WRITEABLE))
311 return mtd->_write_oob(mtd, to, ops);
314 int mtd_get_fact_prot_info(struct mtd_info *mtd, size_t len, size_t *retlen,
315 struct otp_info *buf);
316 int mtd_read_fact_prot_reg(struct mtd_info *mtd, loff_t from, size_t len,
317 size_t *retlen, u_char *buf);
318 int mtd_get_user_prot_info(struct mtd_info *mtd, size_t len, size_t *retlen,
319 struct otp_info *buf);
320 int mtd_read_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len,
321 size_t *retlen, u_char *buf);
322 int mtd_write_user_prot_reg(struct mtd_info *mtd, loff_t to, size_t len,
323 size_t *retlen, u_char *buf);
324 int mtd_lock_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len);
327 int mtd_writev(struct mtd_info *mtd, const struct kvec *vecs,
328 unsigned long count, loff_t to, size_t *retlen);
331 static inline void mtd_sync(struct mtd_info *mtd)
337 int mtd_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len);
338 int mtd_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len);
339 int mtd_is_locked(struct mtd_info *mtd, loff_t ofs, uint64_t len);
340 int mtd_block_isreserved(struct mtd_info *mtd, loff_t ofs);
341 int mtd_block_isbad(struct mtd_info *mtd, loff_t ofs);
342 int mtd_block_markbad(struct mtd_info *mtd, loff_t ofs);
345 static inline int mtd_suspend(struct mtd_info *mtd)
347 return mtd->_suspend ? mtd->_suspend(mtd) : 0;
350 static inline void mtd_resume(struct mtd_info *mtd)
357 static inline uint32_t mtd_div_by_eb(uint64_t sz, struct mtd_info *mtd)
359 if (mtd->erasesize_shift)
360 return sz >> mtd->erasesize_shift;
361 do_div(sz, mtd->erasesize);
365 static inline uint32_t mtd_mod_by_eb(uint64_t sz, struct mtd_info *mtd)
367 if (mtd->erasesize_shift)
368 return sz & mtd->erasesize_mask;
369 return do_div(sz, mtd->erasesize);
372 static inline uint32_t mtd_div_by_ws(uint64_t sz, struct mtd_info *mtd)
374 if (mtd->writesize_shift)
375 return sz >> mtd->writesize_shift;
376 do_div(sz, mtd->writesize);
380 static inline uint32_t mtd_mod_by_ws(uint64_t sz, struct mtd_info *mtd)
382 if (mtd->writesize_shift)
383 return sz & mtd->writesize_mask;
384 return do_div(sz, mtd->writesize);
387 static inline int mtd_has_oob(const struct mtd_info *mtd)
389 return mtd->_read_oob && mtd->_write_oob;
392 static inline int mtd_type_is_nand(const struct mtd_info *mtd)
394 return mtd->type == MTD_NANDFLASH || mtd->type == MTD_MLCNANDFLASH;
397 static inline int mtd_can_have_bb(const struct mtd_info *mtd)
399 return !!mtd->_block_isbad;
402 /* Kernel-side ioctl definitions */
404 struct mtd_partition;
405 struct mtd_part_parser_data;
407 extern int mtd_device_parse_register(struct mtd_info *mtd,
408 const char * const *part_probe_types,
409 struct mtd_part_parser_data *parser_data,
410 const struct mtd_partition *defparts,
412 #define mtd_device_register(master, parts, nr_parts) \
413 mtd_device_parse_register(master, NULL, NULL, parts, nr_parts)
414 extern int mtd_device_unregister(struct mtd_info *master);
415 extern struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num);
416 extern int __get_mtd_device(struct mtd_info *mtd);
417 extern void __put_mtd_device(struct mtd_info *mtd);
418 extern struct mtd_info *get_mtd_device_nm(const char *name);
419 extern void put_mtd_device(struct mtd_info *mtd);
423 struct mtd_notifier {
424 void (*add)(struct mtd_info *mtd);
425 void (*remove)(struct mtd_info *mtd);
426 struct list_head list;
430 extern void register_mtd_user (struct mtd_notifier *new);
431 extern int unregister_mtd_user (struct mtd_notifier *old);
433 void *mtd_kmalloc_up_to(const struct mtd_info *mtd, size_t *size);
435 #ifdef CONFIG_MTD_PARTITIONS
436 void mtd_erase_callback(struct erase_info *instr);
438 static inline void mtd_erase_callback(struct erase_info *instr)
441 instr->callback(instr);
447 * Debugging macro and defines
449 #define MTD_DEBUG_LEVEL0 (0) /* Quiet */
450 #define MTD_DEBUG_LEVEL1 (1) /* Audible */
451 #define MTD_DEBUG_LEVEL2 (2) /* Loud */
452 #define MTD_DEBUG_LEVEL3 (3) /* Noisy */
454 #ifdef CONFIG_MTD_DEBUG
455 #define pr_debug(args...) MTDDEBUG(MTD_DEBUG_LEVEL0, args)
456 #define MTDDEBUG(n, args...) \
458 if (n <= CONFIG_MTD_DEBUG_VERBOSE) \
459 printk(KERN_INFO args); \
461 #else /* CONFIG_MTD_DEBUG */
462 #define pr_debug(args...)
463 #define MTDDEBUG(n, args...) \
466 printk(KERN_INFO args); \
468 #endif /* CONFIG_MTD_DEBUG */
469 #define pr_info(args...) MTDDEBUG(MTD_DEBUG_LEVEL0, args)
470 #define pr_warn(args...) MTDDEBUG(MTD_DEBUG_LEVEL0, args)
471 #define pr_err(args...) MTDDEBUG(MTD_DEBUG_LEVEL0, args)
472 #define pr_crit(args...) MTDDEBUG(MTD_DEBUG_LEVEL0, args)
473 #define pr_cont(args...) MTDDEBUG(MTD_DEBUG_LEVEL0, args)
474 #define pr_notice(args...) MTDDEBUG(MTD_DEBUG_LEVEL0, args)
477 static inline int mtd_is_bitflip(int err) {
478 return err == -EUCLEAN;
481 static inline int mtd_is_eccerr(int err) {
482 return err == -EBADMSG;
485 static inline int mtd_is_bitflip_or_eccerr(int err) {
486 return mtd_is_bitflip(err) || mtd_is_eccerr(err);
489 unsigned mtd_mmap_capabilities(struct mtd_info *mtd);
492 /* drivers/mtd/mtdcore.h */
493 int add_mtd_device(struct mtd_info *mtd);
494 int del_mtd_device(struct mtd_info *mtd);
495 int add_mtd_partitions(struct mtd_info *, const struct mtd_partition *, int);
496 int del_mtd_partitions(struct mtd_info *);
498 int mtd_arg_off(const char *arg, int *idx, loff_t *off, loff_t *size,
499 loff_t *maxsize, int devtype, uint64_t chipsize);
500 int mtd_arg_off_size(int argc, char *const argv[], int *idx, loff_t *off,
501 loff_t *size, loff_t *maxsize, int devtype,
504 /* drivers/mtd/mtdcore.c */
505 void mtd_get_len_incl_bad(struct mtd_info *mtd, uint64_t offset,
506 const uint64_t length, uint64_t *len_incl_bad,
509 #endif /* __MTD_MTD_H__ */