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>
29 #include <mtd/mtd-abi.h>
31 #include <asm/div64.h>
33 #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.
48 struct mtd_erase_region_info {
49 uint64_t offset; /* At which this region starts, from the beginning of the MTD */
50 uint32_t erasesize; /* For this region */
51 uint32_t numblocks; /* Number of blocks of erasesize in this region */
52 unsigned long *lockmap; /* If keeping bitmap of locks */
56 * struct mtd_oob_ops - oob operation operands
57 * @mode: operation mode
59 * @len: number of data bytes to write/read
61 * @retlen: number of data bytes written/read
63 * @ooblen: number of oob bytes to write/read
64 * @oobretlen: number of oob bytes written/read
65 * @ooboffs: offset of oob data in the oob area (only relevant when
66 * mode = MTD_OPS_PLACE_OOB or MTD_OPS_RAW)
67 * @datbuf: data buffer - if NULL only oob data are read/written
68 * @oobbuf: oob data buffer
70 * Note, some MTD drivers do not allow you to write more than one OOB area at
71 * one go. If you try to do that on such an MTD device, -EINVAL will be
72 * returned. If you want to make your implementation portable on all kind of MTD
73 * devices you should split the write request into several sub-requests when the
74 * request crosses a page boundary.
87 #define MTD_MAX_OOBFREE_ENTRIES_LARGE 32
88 #define MTD_MAX_ECCPOS_ENTRIES_LARGE 640
90 * struct mtd_oob_region - oob region definition
91 * @offset: region offset
92 * @length: region length
94 * This structure describes a region of the OOB area, and is used
95 * to retrieve ECC or free bytes sections.
96 * Each section is defined by an offset within the OOB area and a
99 struct mtd_oob_region {
105 * struct mtd_ooblayout_ops - NAND OOB layout operations
106 * @ecc: function returning an ECC region in the OOB area.
107 * Should return -ERANGE if %section exceeds the total number of
109 * @free: function returning a free region in the OOB area.
110 * Should return -ERANGE if %section exceeds the total number of
113 struct mtd_ooblayout_ops {
114 int (*ecc)(struct mtd_info *mtd, int section,
115 struct mtd_oob_region *oobecc);
116 int (*free)(struct mtd_info *mtd, int section,
117 struct mtd_oob_region *oobfree);
121 * struct mtd_pairing_info - page pairing information
126 * The term "pair" is used here, even though TLC NANDs might group pages by 3
127 * (3 bits in a single cell). A pair should regroup all pages that are sharing
128 * the same cell. Pairs are then indexed in ascending order.
130 * @group is defining the position of a page in a given pair. It can also be
131 * seen as the bit position in the cell: page attached to bit 0 belongs to
132 * group 0, page attached to bit 1 belongs to group 1, etc.
135 * The H27UCG8T2BTR-BC datasheet describes the following pairing scheme:
139 * pair-0 page-0 page-4
140 * pair-1 page-1 page-5
141 * pair-2 page-2 page-8
143 * pair-127 page-251 page-255
146 * Note that the "group" and "pair" terms were extracted from Samsung and
147 * Hynix datasheets, and might be referenced under other names in other
148 * datasheets (Micron is describing this concept as "shared pages").
150 struct mtd_pairing_info {
156 * struct mtd_pairing_scheme - page pairing scheme description
158 * @ngroups: number of groups. Should be related to the number of bits
160 * @get_info: converts a write-unit (page number within an erase block) into
161 * mtd_pairing information (pair + group). This function should
162 * fill the info parameter based on the wunit index or return
163 * -EINVAL if the wunit parameter is invalid.
164 * @get_wunit: converts pairing information into a write-unit (page) number.
165 * This function should return the wunit index pointed by the
166 * pairing information described in the info argument. It should
167 * return -EINVAL, if there's no wunit corresponding to the
168 * passed pairing information.
170 * See mtd_pairing_info documentation for a detailed explanation of the
171 * pair and group concepts.
173 * The mtd_pairing_scheme structure provides a generic solution to represent
174 * NAND page pairing scheme. Instead of exposing two big tables to do the
175 * write-unit <-> (pair + group) conversions, we ask the MTD drivers to
176 * implement the ->get_info() and ->get_wunit() functions.
178 * MTD users will then be able to query these information by using the
179 * mtd_pairing_info_to_wunit() and mtd_wunit_to_pairing_info() helpers.
181 * @ngroups is here to help MTD users iterating over all the pages in a
182 * given pair. This value can be retrieved by MTD users using the
183 * mtd_pairing_groups() helper.
185 * Examples are given in the mtd_pairing_info_to_wunit() and
186 * mtd_wunit_to_pairing_info() documentation.
188 struct mtd_pairing_scheme {
190 int (*get_info)(struct mtd_info *mtd, int wunit,
191 struct mtd_pairing_info *info);
192 int (*get_wunit)(struct mtd_info *mtd,
193 const struct mtd_pairing_info *info);
196 struct module; /* only needed for owner field in mtd_info */
199 * struct mtd_debug_info - debugging information for an MTD device.
201 * @dfs_dir: direntry object of the MTD device debugfs directory
203 struct mtd_debug_info {
204 struct dentry *dfs_dir;
210 uint64_t size; // Total size of the MTD
212 /* "Major" erase size for the device. Naïve users may take this
213 * to be the only erase size available, or may use the more detailed
214 * information below if they desire
217 /* Minimal writable flash unit size. In case of NOR flash it is 1 (even
218 * though individual bits can be cleared), in case of NAND flash it is
219 * one NAND page (or half, or one-fourths of it), in case of ECC-ed NOR
220 * it is of ECC block size, etc. It is illegal to have writesize = 0.
221 * Any driver registering a struct mtd_info must ensure a writesize of
227 * Size of the write buffer used by the MTD. MTD devices having a write
228 * buffer can write multiple writesize chunks at a time. E.g. while
229 * writing 4 * writesize bytes to a device with 2 * writesize bytes
230 * buffer the MTD driver can (but doesn't have to) do 2 writesize
231 * operations, but not 4. Currently, all NANDs have writebufsize
232 * equivalent to writesize (NAND page size). Some NOR flashes do have
233 * writebufsize greater than writesize.
235 uint32_t writebufsize;
237 uint32_t oobsize; // Amount of OOB data per block (e.g. 16)
238 uint32_t oobavail; // Available OOB bytes per block
241 * If erasesize is a power of 2 then the shift is stored in
242 * erasesize_shift otherwise erasesize_shift is zero. Ditto writesize.
244 unsigned int erasesize_shift;
245 unsigned int writesize_shift;
246 /* Masks based on erasesize_shift and writesize_shift */
247 unsigned int erasesize_mask;
248 unsigned int writesize_mask;
251 * read ops return -EUCLEAN if max number of bitflips corrected on any
252 * one region comprising an ecc step equals or exceeds this value.
253 * Settable by driver, else defaults to ecc_strength. User can override
254 * in sysfs. N.B. The meaning of the -EUCLEAN return code has changed;
255 * see Documentation/ABI/testing/sysfs-class-mtd for more detail.
257 unsigned int bitflip_threshold;
259 /* Kernel-only stuff starts here. */
263 /* OOB layout description */
264 const struct mtd_ooblayout_ops *ooblayout;
266 /* NAND pairing scheme, only provided for MLC/TLC NANDs */
267 const struct mtd_pairing_scheme *pairing;
269 /* the ecc step size. */
270 unsigned int ecc_step_size;
272 /* max number of correctible bit errors per ecc step */
273 unsigned int ecc_strength;
275 /* Data for variable erase regions. If numeraseregions is zero,
276 * it means that the whole device has erasesize as given above.
279 struct mtd_erase_region_info *eraseregions;
282 * Do not call via these pointers, use corresponding mtd_*()
285 int (*_erase) (struct mtd_info *mtd, struct erase_info *instr);
286 int (*_point) (struct mtd_info *mtd, loff_t from, size_t len,
287 size_t *retlen, void **virt, resource_size_t *phys);
288 int (*_unpoint) (struct mtd_info *mtd, loff_t from, size_t len);
289 int (*_read) (struct mtd_info *mtd, loff_t from, size_t len,
290 size_t *retlen, u_char *buf);
291 int (*_write) (struct mtd_info *mtd, loff_t to, size_t len,
292 size_t *retlen, const u_char *buf);
293 int (*_panic_write) (struct mtd_info *mtd, loff_t to, size_t len,
294 size_t *retlen, const u_char *buf);
295 int (*_read_oob) (struct mtd_info *mtd, loff_t from,
296 struct mtd_oob_ops *ops);
297 int (*_write_oob) (struct mtd_info *mtd, loff_t to,
298 struct mtd_oob_ops *ops);
299 int (*_get_fact_prot_info) (struct mtd_info *mtd, size_t len,
300 size_t *retlen, struct otp_info *buf);
301 int (*_read_fact_prot_reg) (struct mtd_info *mtd, loff_t from,
302 size_t len, size_t *retlen, u_char *buf);
303 int (*_get_user_prot_info) (struct mtd_info *mtd, size_t len,
304 size_t *retlen, struct otp_info *buf);
305 int (*_read_user_prot_reg) (struct mtd_info *mtd, loff_t from,
306 size_t len, size_t *retlen, u_char *buf);
307 int (*_write_user_prot_reg) (struct mtd_info *mtd, loff_t to,
308 size_t len, size_t *retlen, u_char *buf);
309 int (*_lock_user_prot_reg) (struct mtd_info *mtd, loff_t from,
311 int (*_writev) (struct mtd_info *mtd, const struct kvec *vecs,
312 unsigned long count, loff_t to, size_t *retlen);
313 void (*_sync) (struct mtd_info *mtd);
314 int (*_lock) (struct mtd_info *mtd, loff_t ofs, uint64_t len);
315 int (*_unlock) (struct mtd_info *mtd, loff_t ofs, uint64_t len);
316 int (*_is_locked) (struct mtd_info *mtd, loff_t ofs, uint64_t len);
317 int (*_block_isreserved) (struct mtd_info *mtd, loff_t ofs);
318 int (*_block_isbad) (struct mtd_info *mtd, loff_t ofs);
319 int (*_block_markbad) (struct mtd_info *mtd, loff_t ofs);
320 int (*_max_bad_blocks) (struct mtd_info *mtd, loff_t ofs, size_t len);
321 int (*_suspend) (struct mtd_info *mtd);
322 void (*_resume) (struct mtd_info *mtd);
323 void (*_reboot) (struct mtd_info *mtd);
325 * If the driver is something smart, like UBI, it may need to maintain
326 * its own reference counting. The below functions are only for driver.
328 int (*_get_device) (struct mtd_info *mtd);
329 void (*_put_device) (struct mtd_info *mtd);
331 struct notifier_block reboot_notifier; /* default mode before reboot */
333 /* ECC status information */
334 struct mtd_ecc_stats ecc_stats;
335 /* Subpage shift (NAND) */
340 struct module *owner;
343 struct mtd_debug_info dbg;
346 int mtd_ooblayout_ecc(struct mtd_info *mtd, int section,
347 struct mtd_oob_region *oobecc);
348 int mtd_ooblayout_find_eccregion(struct mtd_info *mtd, int eccbyte,
350 struct mtd_oob_region *oobregion);
351 int mtd_ooblayout_get_eccbytes(struct mtd_info *mtd, u8 *eccbuf,
352 const u8 *oobbuf, int start, int nbytes);
353 int mtd_ooblayout_set_eccbytes(struct mtd_info *mtd, const u8 *eccbuf,
354 u8 *oobbuf, int start, int nbytes);
355 int mtd_ooblayout_free(struct mtd_info *mtd, int section,
356 struct mtd_oob_region *oobfree);
357 int mtd_ooblayout_get_databytes(struct mtd_info *mtd, u8 *databuf,
358 const u8 *oobbuf, int start, int nbytes);
359 int mtd_ooblayout_set_databytes(struct mtd_info *mtd, const u8 *databuf,
360 u8 *oobbuf, int start, int nbytes);
361 int mtd_ooblayout_count_freebytes(struct mtd_info *mtd);
362 int mtd_ooblayout_count_eccbytes(struct mtd_info *mtd);
364 static inline void mtd_set_ooblayout(struct mtd_info *mtd,
365 const struct mtd_ooblayout_ops *ooblayout)
367 mtd->ooblayout = ooblayout;
370 static inline void mtd_set_pairing_scheme(struct mtd_info *mtd,
371 const struct mtd_pairing_scheme *pairing)
373 mtd->pairing = pairing;
376 static inline void mtd_set_of_node(struct mtd_info *mtd,
377 struct device_node *np)
379 mtd->dev.of_node = np;
381 of_property_read_string(np, "label", &mtd->name);
384 static inline struct device_node *mtd_get_of_node(struct mtd_info *mtd)
386 return dev_of_node(&mtd->dev);
389 static inline u32 mtd_oobavail(struct mtd_info *mtd, struct mtd_oob_ops *ops)
391 return ops->mode == MTD_OPS_AUTO_OOB ? mtd->oobavail : mtd->oobsize;
394 static inline int mtd_max_bad_blocks(struct mtd_info *mtd,
395 loff_t ofs, size_t len)
397 if (!mtd->_max_bad_blocks)
400 if (mtd->size < (len + ofs) || ofs < 0)
403 return mtd->_max_bad_blocks(mtd, ofs, len);
406 int mtd_wunit_to_pairing_info(struct mtd_info *mtd, int wunit,
407 struct mtd_pairing_info *info);
408 int mtd_pairing_info_to_wunit(struct mtd_info *mtd,
409 const struct mtd_pairing_info *info);
410 int mtd_pairing_groups(struct mtd_info *mtd);
411 int mtd_erase(struct mtd_info *mtd, struct erase_info *instr);
412 int mtd_point(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen,
413 void **virt, resource_size_t *phys);
414 int mtd_unpoint(struct mtd_info *mtd, loff_t from, size_t len);
415 unsigned long mtd_get_unmapped_area(struct mtd_info *mtd, unsigned long len,
416 unsigned long offset, unsigned long flags);
417 int mtd_read(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen,
419 int mtd_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen,
421 int mtd_panic_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen,
424 int mtd_read_oob(struct mtd_info *mtd, loff_t from, struct mtd_oob_ops *ops);
425 int mtd_write_oob(struct mtd_info *mtd, loff_t to, struct mtd_oob_ops *ops);
427 int mtd_get_fact_prot_info(struct mtd_info *mtd, size_t len, size_t *retlen,
428 struct otp_info *buf);
429 int mtd_read_fact_prot_reg(struct mtd_info *mtd, loff_t from, size_t len,
430 size_t *retlen, u_char *buf);
431 int mtd_get_user_prot_info(struct mtd_info *mtd, size_t len, size_t *retlen,
432 struct otp_info *buf);
433 int mtd_read_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len,
434 size_t *retlen, u_char *buf);
435 int mtd_write_user_prot_reg(struct mtd_info *mtd, loff_t to, size_t len,
436 size_t *retlen, u_char *buf);
437 int mtd_lock_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len);
439 int mtd_writev(struct mtd_info *mtd, const struct kvec *vecs,
440 unsigned long count, loff_t to, size_t *retlen);
442 static inline void mtd_sync(struct mtd_info *mtd)
448 int mtd_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len);
449 int mtd_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len);
450 int mtd_is_locked(struct mtd_info *mtd, loff_t ofs, uint64_t len);
451 int mtd_block_isreserved(struct mtd_info *mtd, loff_t ofs);
452 int mtd_block_isbad(struct mtd_info *mtd, loff_t ofs);
453 int mtd_block_markbad(struct mtd_info *mtd, loff_t ofs);
455 static inline int mtd_suspend(struct mtd_info *mtd)
457 return mtd->_suspend ? mtd->_suspend(mtd) : 0;
460 static inline void mtd_resume(struct mtd_info *mtd)
466 static inline uint32_t mtd_div_by_eb(uint64_t sz, struct mtd_info *mtd)
468 if (mtd->erasesize_shift)
469 return sz >> mtd->erasesize_shift;
470 do_div(sz, mtd->erasesize);
474 static inline uint32_t mtd_mod_by_eb(uint64_t sz, struct mtd_info *mtd)
476 if (mtd->erasesize_shift)
477 return sz & mtd->erasesize_mask;
478 return do_div(sz, mtd->erasesize);
482 * mtd_align_erase_req - Adjust an erase request to align things on eraseblock
484 * @mtd: the MTD device this erase request applies on
485 * @req: the erase request to adjust
487 * This function will adjust @req->addr and @req->len to align them on
488 * @mtd->erasesize. Of course we expect @mtd->erasesize to be != 0.
490 static inline void mtd_align_erase_req(struct mtd_info *mtd,
491 struct erase_info *req)
495 if (WARN_ON(!mtd->erasesize))
498 mod = mtd_mod_by_eb(req->addr, mtd);
504 mod = mtd_mod_by_eb(req->addr + req->len, mtd);
506 req->len += mtd->erasesize - mod;
509 static inline uint32_t mtd_div_by_ws(uint64_t sz, struct mtd_info *mtd)
511 if (mtd->writesize_shift)
512 return sz >> mtd->writesize_shift;
513 do_div(sz, mtd->writesize);
517 static inline uint32_t mtd_mod_by_ws(uint64_t sz, struct mtd_info *mtd)
519 if (mtd->writesize_shift)
520 return sz & mtd->writesize_mask;
521 return do_div(sz, mtd->writesize);
524 static inline int mtd_wunit_per_eb(struct mtd_info *mtd)
526 return mtd->erasesize / mtd->writesize;
529 static inline int mtd_offset_to_wunit(struct mtd_info *mtd, loff_t offs)
531 return mtd_div_by_ws(mtd_mod_by_eb(offs, mtd), mtd);
534 static inline loff_t mtd_wunit_to_offset(struct mtd_info *mtd, loff_t base,
537 return base + (wunit * mtd->writesize);
541 static inline int mtd_has_oob(const struct mtd_info *mtd)
543 return mtd->_read_oob && mtd->_write_oob;
546 static inline int mtd_type_is_nand(const struct mtd_info *mtd)
548 return mtd->type == MTD_NANDFLASH || mtd->type == MTD_MLCNANDFLASH;
551 static inline int mtd_can_have_bb(const struct mtd_info *mtd)
553 return !!mtd->_block_isbad;
556 /* Kernel-side ioctl definitions */
558 struct mtd_partition;
559 struct mtd_part_parser_data;
561 extern int mtd_device_parse_register(struct mtd_info *mtd,
562 const char * const *part_probe_types,
563 struct mtd_part_parser_data *parser_data,
564 const struct mtd_partition *defparts,
566 #define mtd_device_register(master, parts, nr_parts) \
567 mtd_device_parse_register(master, NULL, NULL, parts, nr_parts)
568 extern int mtd_device_unregister(struct mtd_info *master);
569 extern struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num);
570 extern int __get_mtd_device(struct mtd_info *mtd);
571 extern void __put_mtd_device(struct mtd_info *mtd);
572 extern struct mtd_info *get_mtd_device_nm(const char *name);
573 extern void put_mtd_device(struct mtd_info *mtd);
576 struct mtd_notifier {
577 void (*add)(struct mtd_info *mtd);
578 void (*remove)(struct mtd_info *mtd);
579 struct list_head list;
583 extern void register_mtd_user (struct mtd_notifier *new);
584 extern int unregister_mtd_user (struct mtd_notifier *old);
585 void *mtd_kmalloc_up_to(const struct mtd_info *mtd, size_t *size);
587 static inline int mtd_is_bitflip(int err) {
588 return err == -EUCLEAN;
591 static inline int mtd_is_eccerr(int err) {
592 return err == -EBADMSG;
595 static inline int mtd_is_bitflip_or_eccerr(int err) {
596 return mtd_is_bitflip(err) || mtd_is_eccerr(err);
599 unsigned mtd_mmap_capabilities(struct mtd_info *mtd);
601 #endif /* __MTD_MTD_H__ */