2 * Copyright © 1999-2010 David Woodhouse <dwmw2@infradead.org> et al.
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 <asm/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
);
249 * If the driver is something smart, like UBI, it may need to maintain
250 * its own reference counting. The below functions are only for driver.
252 int (*_get_device
) (struct mtd_info
*mtd
);
253 void (*_put_device
) (struct mtd_info
*mtd
);
256 /* Backing device capabilities for this device
257 * - provides mmap capabilities
259 struct backing_dev_info
*backing_dev_info
;
261 struct notifier_block reboot_notifier
; /* default mode before reboot */
264 /* ECC status information */
265 struct mtd_ecc_stats ecc_stats
;
266 /* Subpage shift (NAND) */
271 struct module
*owner
;
278 int mtd_erase(struct mtd_info
*mtd
, struct erase_info
*instr
);
280 int mtd_point(struct mtd_info
*mtd
, loff_t from
, size_t len
, size_t *retlen
,
281 void **virt
, resource_size_t
*phys
);
282 int mtd_unpoint(struct mtd_info
*mtd
, loff_t from
, size_t len
);
284 unsigned long mtd_get_unmapped_area(struct mtd_info
*mtd
, unsigned long len
,
285 unsigned long offset
, unsigned long flags
);
286 int mtd_read(struct mtd_info
*mtd
, loff_t from
, size_t len
, size_t *retlen
,
288 int mtd_write(struct mtd_info
*mtd
, loff_t to
, size_t len
, size_t *retlen
,
290 int mtd_panic_write(struct mtd_info
*mtd
, loff_t to
, size_t len
, size_t *retlen
,
293 int mtd_read_oob(struct mtd_info
*mtd
, loff_t from
, struct mtd_oob_ops
*ops
);
295 static inline int mtd_write_oob(struct mtd_info
*mtd
, loff_t to
,
296 struct mtd_oob_ops
*ops
)
298 ops
->retlen
= ops
->oobretlen
= 0;
299 if (!mtd
->_write_oob
)
301 if (!(mtd
->flags
& MTD_WRITEABLE
))
303 return mtd
->_write_oob(mtd
, to
, ops
);
306 int mtd_get_fact_prot_info(struct mtd_info
*mtd
, size_t len
, size_t *retlen
,
307 struct otp_info
*buf
);
308 int mtd_read_fact_prot_reg(struct mtd_info
*mtd
, loff_t from
, size_t len
,
309 size_t *retlen
, u_char
*buf
);
310 int mtd_get_user_prot_info(struct mtd_info
*mtd
, size_t len
, size_t *retlen
,
311 struct otp_info
*buf
);
312 int mtd_read_user_prot_reg(struct mtd_info
*mtd
, loff_t from
, size_t len
,
313 size_t *retlen
, u_char
*buf
);
314 int mtd_write_user_prot_reg(struct mtd_info
*mtd
, loff_t to
, size_t len
,
315 size_t *retlen
, u_char
*buf
);
316 int mtd_lock_user_prot_reg(struct mtd_info
*mtd
, loff_t from
, size_t len
);
319 int mtd_writev(struct mtd_info
*mtd
, const struct kvec
*vecs
,
320 unsigned long count
, loff_t to
, size_t *retlen
);
323 static inline void mtd_sync(struct mtd_info
*mtd
)
329 int mtd_lock(struct mtd_info
*mtd
, loff_t ofs
, uint64_t len
);
330 int mtd_unlock(struct mtd_info
*mtd
, loff_t ofs
, uint64_t len
);
331 int mtd_is_locked(struct mtd_info
*mtd
, loff_t ofs
, uint64_t len
);
332 int mtd_block_isreserved(struct mtd_info
*mtd
, loff_t ofs
);
333 int mtd_block_isbad(struct mtd_info
*mtd
, loff_t ofs
);
334 int mtd_block_markbad(struct mtd_info
*mtd
, loff_t ofs
);
337 static inline int mtd_suspend(struct mtd_info
*mtd
)
339 return mtd
->_suspend
? mtd
->_suspend(mtd
) : 0;
342 static inline void mtd_resume(struct mtd_info
*mtd
)
349 static inline uint32_t mtd_div_by_eb(uint64_t sz
, struct mtd_info
*mtd
)
351 if (mtd
->erasesize_shift
)
352 return sz
>> mtd
->erasesize_shift
;
353 do_div(sz
, mtd
->erasesize
);
357 static inline uint32_t mtd_mod_by_eb(uint64_t sz
, struct mtd_info
*mtd
)
359 if (mtd
->erasesize_shift
)
360 return sz
& mtd
->erasesize_mask
;
361 return do_div(sz
, mtd
->erasesize
);
364 static inline uint32_t mtd_div_by_ws(uint64_t sz
, struct mtd_info
*mtd
)
366 if (mtd
->writesize_shift
)
367 return sz
>> mtd
->writesize_shift
;
368 do_div(sz
, mtd
->writesize
);
372 static inline uint32_t mtd_mod_by_ws(uint64_t sz
, struct mtd_info
*mtd
)
374 if (mtd
->writesize_shift
)
375 return sz
& mtd
->writesize_mask
;
376 return do_div(sz
, mtd
->writesize
);
379 static inline int mtd_has_oob(const struct mtd_info
*mtd
)
381 return mtd
->_read_oob
&& mtd
->_write_oob
;
384 static inline int mtd_type_is_nand(const struct mtd_info
*mtd
)
386 return mtd
->type
== MTD_NANDFLASH
|| mtd
->type
== MTD_MLCNANDFLASH
;
389 static inline int mtd_can_have_bb(const struct mtd_info
*mtd
)
391 return !!mtd
->_block_isbad
;
394 /* Kernel-side ioctl definitions */
396 struct mtd_partition
;
397 struct mtd_part_parser_data
;
399 extern int mtd_device_parse_register(struct mtd_info
*mtd
,
400 const char * const *part_probe_types
,
401 struct mtd_part_parser_data
*parser_data
,
402 const struct mtd_partition
*defparts
,
404 #define mtd_device_register(master, parts, nr_parts) \
405 mtd_device_parse_register(master, NULL, NULL, parts, nr_parts)
406 extern int mtd_device_unregister(struct mtd_info
*master
);
407 extern struct mtd_info
*get_mtd_device(struct mtd_info
*mtd
, int num
);
408 extern int __get_mtd_device(struct mtd_info
*mtd
);
409 extern void __put_mtd_device(struct mtd_info
*mtd
);
410 extern struct mtd_info
*get_mtd_device_nm(const char *name
);
411 extern void put_mtd_device(struct mtd_info
*mtd
);
415 struct mtd_notifier
{
416 void (*add
)(struct mtd_info
*mtd
);
417 void (*remove
)(struct mtd_info
*mtd
);
418 struct list_head list
;
422 extern void register_mtd_user (struct mtd_notifier
*new);
423 extern int unregister_mtd_user (struct mtd_notifier
*old
);
425 void *mtd_kmalloc_up_to(const struct mtd_info
*mtd
, size_t *size
);
427 #ifdef CONFIG_MTD_PARTITIONS
428 void mtd_erase_callback(struct erase_info
*instr
);
430 static inline void mtd_erase_callback(struct erase_info
*instr
)
433 instr
->callback(instr
);
439 * Debugging macro and defines
441 #define MTD_DEBUG_LEVEL0 (0) /* Quiet */
442 #define MTD_DEBUG_LEVEL1 (1) /* Audible */
443 #define MTD_DEBUG_LEVEL2 (2) /* Loud */
444 #define MTD_DEBUG_LEVEL3 (3) /* Noisy */
446 #ifdef CONFIG_MTD_DEBUG
447 #define pr_debug(args...) MTDDEBUG(MTD_DEBUG_LEVEL0, args)
448 #define MTDDEBUG(n, args...) \
450 if (n <= CONFIG_MTD_DEBUG_VERBOSE) \
451 printk(KERN_INFO args); \
453 #else /* CONFIG_MTD_DEBUG */
454 #define pr_debug(args...)
455 #define MTDDEBUG(n, args...) \
458 printk(KERN_INFO args); \
460 #endif /* CONFIG_MTD_DEBUG */
461 #define pr_info(args...) MTDDEBUG(MTD_DEBUG_LEVEL0, args)
462 #define pr_warn(args...) MTDDEBUG(MTD_DEBUG_LEVEL0, args)
463 #define pr_err(args...) MTDDEBUG(MTD_DEBUG_LEVEL0, args)
464 #define pr_crit(args...) MTDDEBUG(MTD_DEBUG_LEVEL0, args)
465 #define pr_cont(args...) MTDDEBUG(MTD_DEBUG_LEVEL0, args)
466 #define pr_notice(args...) MTDDEBUG(MTD_DEBUG_LEVEL0, args)
469 static inline int mtd_is_bitflip(int err
) {
470 return err
== -EUCLEAN
;
473 static inline int mtd_is_eccerr(int err
) {
474 return err
== -EBADMSG
;
477 static inline int mtd_is_bitflip_or_eccerr(int err
) {
478 return mtd_is_bitflip(err
) || mtd_is_eccerr(err
);
482 /* drivers/mtd/mtdcore.h */
483 int add_mtd_device(struct mtd_info
*mtd
);
484 int del_mtd_device(struct mtd_info
*mtd
);
485 int add_mtd_partitions(struct mtd_info
*, const struct mtd_partition
*, int);
486 int del_mtd_partitions(struct mtd_info
*);
488 int mtd_arg_off(const char *arg
, int *idx
, loff_t
*off
, loff_t
*size
,
489 loff_t
*maxsize
, int devtype
, uint64_t chipsize
);
490 int mtd_arg_off_size(int argc
, char *const argv
[], int *idx
, loff_t
*off
,
491 loff_t
*size
, loff_t
*maxsize
, int devtype
,
494 #endif /* __MTD_MTD_H__ */