1 /* SPDX-License-Identifier: GPL-2.0-or-later */ 2 /* 3 * Copyright © 1999-2010 David Woodhouse <dwmw2@infradead.org> et al. 4 */ 5 6 #ifndef __MTD_MTD_H__ 7 #define __MTD_MTD_H__ 8 9 #include <linux/types.h> 10 #include <linux/uio.h> 11 #include <linux/list.h> 12 #include <linux/notifier.h> 13 #include <linux/device.h> 14 #include <linux/of.h> 15 #include <linux/nvmem-provider.h> 16 17 #include <mtd/mtd-abi.h> 18 19 #include <asm/div64.h> 20 21 #define MTD_FAIL_ADDR_UNKNOWN -1LL 22 23 struct mtd_info; 24 25 /* 26 * If the erase fails, fail_addr might indicate exactly which block failed. If 27 * fail_addr = MTD_FAIL_ADDR_UNKNOWN, the failure was not at the device level 28 * or was not specific to any particular block. 29 */ 30 struct erase_info { 31 uint64_t addr; 32 uint64_t len; 33 uint64_t fail_addr; 34 }; 35 36 struct mtd_erase_region_info { 37 uint64_t offset; /* At which this region starts, from the beginning of the MTD */ 38 uint32_t erasesize; /* For this region */ 39 uint32_t numblocks; /* Number of blocks of erasesize in this region */ 40 unsigned long *lockmap; /* If keeping bitmap of locks */ 41 }; 42 43 /** 44 * struct mtd_oob_ops - oob operation operands 45 * @mode: operation mode 46 * 47 * @len: number of data bytes to write/read 48 * 49 * @retlen: number of data bytes written/read 50 * 51 * @ooblen: number of oob bytes to write/read 52 * @oobretlen: number of oob bytes written/read 53 * @ooboffs: offset of oob data in the oob area (only relevant when 54 * mode = MTD_OPS_PLACE_OOB or MTD_OPS_RAW) 55 * @datbuf: data buffer - if NULL only oob data are read/written 56 * @oobbuf: oob data buffer 57 * 58 * Note, some MTD drivers do not allow you to write more than one OOB area at 59 * one go. If you try to do that on such an MTD device, -EINVAL will be 60 * returned. If you want to make your implementation portable on all kind of MTD 61 * devices you should split the write request into several sub-requests when the 62 * request crosses a page boundary. 63 */ 64 struct mtd_oob_ops { 65 unsigned int mode; 66 size_t len; 67 size_t retlen; 68 size_t ooblen; 69 size_t oobretlen; 70 uint32_t ooboffs; 71 uint8_t *datbuf; 72 uint8_t *oobbuf; 73 }; 74 75 /** 76 * struct mtd_oob_region - oob region definition 77 * @offset: region offset 78 * @length: region length 79 * 80 * This structure describes a region of the OOB area, and is used 81 * to retrieve ECC or free bytes sections. 82 * Each section is defined by an offset within the OOB area and a 83 * length. 84 */ 85 struct mtd_oob_region { 86 u32 offset; 87 u32 length; 88 }; 89 90 /* 91 * struct mtd_ooblayout_ops - NAND OOB layout operations 92 * @ecc: function returning an ECC region in the OOB area. 93 * Should return -ERANGE if %section exceeds the total number of 94 * ECC sections. 95 * @free: function returning a free region in the OOB area. 96 * Should return -ERANGE if %section exceeds the total number of 97 * free sections. 98 */ 99 struct mtd_ooblayout_ops { 100 int (*ecc)(struct mtd_info *mtd, int section, 101 struct mtd_oob_region *oobecc); 102 int (*free)(struct mtd_info *mtd, int section, 103 struct mtd_oob_region *oobfree); 104 }; 105 106 /** 107 * struct mtd_pairing_info - page pairing information 108 * 109 * @pair: pair id 110 * @group: group id 111 * 112 * The term "pair" is used here, even though TLC NANDs might group pages by 3 113 * (3 bits in a single cell). A pair should regroup all pages that are sharing 114 * the same cell. Pairs are then indexed in ascending order. 115 * 116 * @group is defining the position of a page in a given pair. It can also be 117 * seen as the bit position in the cell: page attached to bit 0 belongs to 118 * group 0, page attached to bit 1 belongs to group 1, etc. 119 * 120 * Example: 121 * The H27UCG8T2BTR-BC datasheet describes the following pairing scheme: 122 * 123 * group-0 group-1 124 * 125 * pair-0 page-0 page-4 126 * pair-1 page-1 page-5 127 * pair-2 page-2 page-8 128 * ... 129 * pair-127 page-251 page-255 130 * 131 * 132 * Note that the "group" and "pair" terms were extracted from Samsung and 133 * Hynix datasheets, and might be referenced under other names in other 134 * datasheets (Micron is describing this concept as "shared pages"). 135 */ 136 struct mtd_pairing_info { 137 int pair; 138 int group; 139 }; 140 141 /** 142 * struct mtd_pairing_scheme - page pairing scheme description 143 * 144 * @ngroups: number of groups. Should be related to the number of bits 145 * per cell. 146 * @get_info: converts a write-unit (page number within an erase block) into 147 * mtd_pairing information (pair + group). This function should 148 * fill the info parameter based on the wunit index or return 149 * -EINVAL if the wunit parameter is invalid. 150 * @get_wunit: converts pairing information into a write-unit (page) number. 151 * This function should return the wunit index pointed by the 152 * pairing information described in the info argument. It should 153 * return -EINVAL, if there's no wunit corresponding to the 154 * passed pairing information. 155 * 156 * See mtd_pairing_info documentation for a detailed explanation of the 157 * pair and group concepts. 158 * 159 * The mtd_pairing_scheme structure provides a generic solution to represent 160 * NAND page pairing scheme. Instead of exposing two big tables to do the 161 * write-unit <-> (pair + group) conversions, we ask the MTD drivers to 162 * implement the ->get_info() and ->get_wunit() functions. 163 * 164 * MTD users will then be able to query these information by using the 165 * mtd_pairing_info_to_wunit() and mtd_wunit_to_pairing_info() helpers. 166 * 167 * @ngroups is here to help MTD users iterating over all the pages in a 168 * given pair. This value can be retrieved by MTD users using the 169 * mtd_pairing_groups() helper. 170 * 171 * Examples are given in the mtd_pairing_info_to_wunit() and 172 * mtd_wunit_to_pairing_info() documentation. 173 */ 174 struct mtd_pairing_scheme { 175 int ngroups; 176 int (*get_info)(struct mtd_info *mtd, int wunit, 177 struct mtd_pairing_info *info); 178 int (*get_wunit)(struct mtd_info *mtd, 179 const struct mtd_pairing_info *info); 180 }; 181 182 struct module; /* only needed for owner field in mtd_info */ 183 184 /** 185 * struct mtd_debug_info - debugging information for an MTD device. 186 * 187 * @dfs_dir: direntry object of the MTD device debugfs directory 188 */ 189 struct mtd_debug_info { 190 struct dentry *dfs_dir; 191 192 const char *partname; 193 const char *partid; 194 }; 195 196 /** 197 * struct mtd_part - MTD partition specific fields 198 * 199 * @node: list node used to add an MTD partition to the parent partition list 200 * @offset: offset of the partition relatively to the parent offset 201 * @size: partition size. Should be equal to mtd->size unless 202 * MTD_SLC_ON_MLC_EMULATION is set 203 * @flags: original flags (before the mtdpart logic decided to tweak them based 204 * on flash constraints, like eraseblock/pagesize alignment) 205 * 206 * This struct is embedded in mtd_info and contains partition-specific 207 * properties/fields. 208 */ 209 struct mtd_part { 210 struct list_head node; 211 u64 offset; 212 u64 size; 213 u32 flags; 214 }; 215 216 /** 217 * struct mtd_master - MTD master specific fields 218 * 219 * @partitions_lock: lock protecting accesses to the partition list. Protects 220 * not only the master partition list, but also all 221 * sub-partitions. 222 * @suspended: et to 1 when the device is suspended, 0 otherwise 223 * 224 * This struct is embedded in mtd_info and contains master-specific 225 * properties/fields. The master is the root MTD device from the MTD partition 226 * point of view. 227 */ 228 struct mtd_master { 229 struct mutex partitions_lock; 230 struct mutex chrdev_lock; 231 unsigned int suspended : 1; 232 }; 233 234 struct mtd_info { 235 u_char type; 236 uint32_t flags; 237 uint64_t size; // Total size of the MTD 238 239 /* "Major" erase size for the device. Naïve users may take this 240 * to be the only erase size available, or may use the more detailed 241 * information below if they desire 242 */ 243 uint32_t erasesize; 244 /* Minimal writable flash unit size. In case of NOR flash it is 1 (even 245 * though individual bits can be cleared), in case of NAND flash it is 246 * one NAND page (or half, or one-fourths of it), in case of ECC-ed NOR 247 * it is of ECC block size, etc. It is illegal to have writesize = 0. 248 * Any driver registering a struct mtd_info must ensure a writesize of 249 * 1 or larger. 250 */ 251 uint32_t writesize; 252 253 /* 254 * Size of the write buffer used by the MTD. MTD devices having a write 255 * buffer can write multiple writesize chunks at a time. E.g. while 256 * writing 4 * writesize bytes to a device with 2 * writesize bytes 257 * buffer the MTD driver can (but doesn't have to) do 2 writesize 258 * operations, but not 4. Currently, all NANDs have writebufsize 259 * equivalent to writesize (NAND page size). Some NOR flashes do have 260 * writebufsize greater than writesize. 261 */ 262 uint32_t writebufsize; 263 264 uint32_t oobsize; // Amount of OOB data per block (e.g. 16) 265 uint32_t oobavail; // Available OOB bytes per block 266 267 /* 268 * If erasesize is a power of 2 then the shift is stored in 269 * erasesize_shift otherwise erasesize_shift is zero. Ditto writesize. 270 */ 271 unsigned int erasesize_shift; 272 unsigned int writesize_shift; 273 /* Masks based on erasesize_shift and writesize_shift */ 274 unsigned int erasesize_mask; 275 unsigned int writesize_mask; 276 277 /* 278 * read ops return -EUCLEAN if max number of bitflips corrected on any 279 * one region comprising an ecc step equals or exceeds this value. 280 * Settable by driver, else defaults to ecc_strength. User can override 281 * in sysfs. N.B. The meaning of the -EUCLEAN return code has changed; 282 * see Documentation/ABI/testing/sysfs-class-mtd for more detail. 283 */ 284 unsigned int bitflip_threshold; 285 286 /* Kernel-only stuff starts here. */ 287 const char *name; 288 int index; 289 290 /* OOB layout description */ 291 const struct mtd_ooblayout_ops *ooblayout; 292 293 /* NAND pairing scheme, only provided for MLC/TLC NANDs */ 294 const struct mtd_pairing_scheme *pairing; 295 296 /* the ecc step size. */ 297 unsigned int ecc_step_size; 298 299 /* max number of correctible bit errors per ecc step */ 300 unsigned int ecc_strength; 301 302 /* Data for variable erase regions. If numeraseregions is zero, 303 * it means that the whole device has erasesize as given above. 304 */ 305 int numeraseregions; 306 struct mtd_erase_region_info *eraseregions; 307 308 /* 309 * Do not call via these pointers, use corresponding mtd_*() 310 * wrappers instead. 311 */ 312 int (*_erase) (struct mtd_info *mtd, struct erase_info *instr); 313 int (*_point) (struct mtd_info *mtd, loff_t from, size_t len, 314 size_t *retlen, void **virt, resource_size_t *phys); 315 int (*_unpoint) (struct mtd_info *mtd, loff_t from, size_t len); 316 int (*_read) (struct mtd_info *mtd, loff_t from, size_t len, 317 size_t *retlen, u_char *buf); 318 int (*_write) (struct mtd_info *mtd, loff_t to, size_t len, 319 size_t *retlen, const u_char *buf); 320 int (*_panic_write) (struct mtd_info *mtd, loff_t to, size_t len, 321 size_t *retlen, const u_char *buf); 322 int (*_read_oob) (struct mtd_info *mtd, loff_t from, 323 struct mtd_oob_ops *ops); 324 int (*_write_oob) (struct mtd_info *mtd, loff_t to, 325 struct mtd_oob_ops *ops); 326 int (*_get_fact_prot_info) (struct mtd_info *mtd, size_t len, 327 size_t *retlen, struct otp_info *buf); 328 int (*_read_fact_prot_reg) (struct mtd_info *mtd, loff_t from, 329 size_t len, size_t *retlen, u_char *buf); 330 int (*_get_user_prot_info) (struct mtd_info *mtd, size_t len, 331 size_t *retlen, struct otp_info *buf); 332 int (*_read_user_prot_reg) (struct mtd_info *mtd, loff_t from, 333 size_t len, size_t *retlen, u_char *buf); 334 int (*_write_user_prot_reg) (struct mtd_info *mtd, loff_t to, 335 size_t len, size_t *retlen, 336 const u_char *buf); 337 int (*_lock_user_prot_reg) (struct mtd_info *mtd, loff_t from, 338 size_t len); 339 int (*_erase_user_prot_reg) (struct mtd_info *mtd, loff_t from, 340 size_t len); 341 int (*_writev) (struct mtd_info *mtd, const struct kvec *vecs, 342 unsigned long count, loff_t to, size_t *retlen); 343 void (*_sync) (struct mtd_info *mtd); 344 int (*_lock) (struct mtd_info *mtd, loff_t ofs, uint64_t len); 345 int (*_unlock) (struct mtd_info *mtd, loff_t ofs, uint64_t len); 346 int (*_is_locked) (struct mtd_info *mtd, loff_t ofs, uint64_t len); 347 int (*_block_isreserved) (struct mtd_info *mtd, loff_t ofs); 348 int (*_block_isbad) (struct mtd_info *mtd, loff_t ofs); 349 int (*_block_markbad) (struct mtd_info *mtd, loff_t ofs); 350 int (*_max_bad_blocks) (struct mtd_info *mtd, loff_t ofs, size_t len); 351 int (*_suspend) (struct mtd_info *mtd); 352 void (*_resume) (struct mtd_info *mtd); 353 void (*_reboot) (struct mtd_info *mtd); 354 /* 355 * If the driver is something smart, like UBI, it may need to maintain 356 * its own reference counting. The below functions are only for driver. 357 */ 358 int (*_get_device) (struct mtd_info *mtd); 359 void (*_put_device) (struct mtd_info *mtd); 360 361 /* 362 * flag indicates a panic write, low level drivers can take appropriate 363 * action if required to ensure writes go through 364 */ 365 bool oops_panic_write; 366 367 struct notifier_block reboot_notifier; /* default mode before reboot */ 368 369 /* ECC status information */ 370 struct mtd_ecc_stats ecc_stats; 371 /* Subpage shift (NAND) */ 372 int subpage_sft; 373 374 void *priv; 375 376 struct module *owner; 377 struct device dev; 378 int usecount; 379 struct mtd_debug_info dbg; 380 struct nvmem_device *nvmem; 381 struct nvmem_device *otp_user_nvmem; 382 struct nvmem_device *otp_factory_nvmem; 383 384 /* 385 * Parent device from the MTD partition point of view. 386 * 387 * MTD masters do not have any parent, MTD partitions do. The parent 388 * MTD device can itself be a partition. 389 */ 390 struct mtd_info *parent; 391 392 /* List of partitions attached to this MTD device */ 393 struct list_head partitions; 394 395 union { 396 struct mtd_part part; 397 struct mtd_master master; 398 }; 399 }; 400 401 static inline struct mtd_info *mtd_get_master(struct mtd_info *mtd) 402 { 403 while (mtd->parent) 404 mtd = mtd->parent; 405 406 return mtd; 407 } 408 409 static inline u64 mtd_get_master_ofs(struct mtd_info *mtd, u64 ofs) 410 { 411 while (mtd->parent) { 412 ofs += mtd->part.offset; 413 mtd = mtd->parent; 414 } 415 416 return ofs; 417 } 418 419 static inline bool mtd_is_partition(const struct mtd_info *mtd) 420 { 421 return mtd->parent; 422 } 423 424 static inline bool mtd_has_partitions(const struct mtd_info *mtd) 425 { 426 return !list_empty(&mtd->partitions); 427 } 428 429 int mtd_ooblayout_ecc(struct mtd_info *mtd, int section, 430 struct mtd_oob_region *oobecc); 431 int mtd_ooblayout_find_eccregion(struct mtd_info *mtd, int eccbyte, 432 int *section, 433 struct mtd_oob_region *oobregion); 434 int mtd_ooblayout_get_eccbytes(struct mtd_info *mtd, u8 *eccbuf, 435 const u8 *oobbuf, int start, int nbytes); 436 int mtd_ooblayout_set_eccbytes(struct mtd_info *mtd, const u8 *eccbuf, 437 u8 *oobbuf, int start, int nbytes); 438 int mtd_ooblayout_free(struct mtd_info *mtd, int section, 439 struct mtd_oob_region *oobfree); 440 int mtd_ooblayout_get_databytes(struct mtd_info *mtd, u8 *databuf, 441 const u8 *oobbuf, int start, int nbytes); 442 int mtd_ooblayout_set_databytes(struct mtd_info *mtd, const u8 *databuf, 443 u8 *oobbuf, int start, int nbytes); 444 int mtd_ooblayout_count_freebytes(struct mtd_info *mtd); 445 int mtd_ooblayout_count_eccbytes(struct mtd_info *mtd); 446 447 static inline void mtd_set_ooblayout(struct mtd_info *mtd, 448 const struct mtd_ooblayout_ops *ooblayout) 449 { 450 mtd->ooblayout = ooblayout; 451 } 452 453 static inline void mtd_set_pairing_scheme(struct mtd_info *mtd, 454 const struct mtd_pairing_scheme *pairing) 455 { 456 mtd->pairing = pairing; 457 } 458 459 static inline void mtd_set_of_node(struct mtd_info *mtd, 460 struct device_node *np) 461 { 462 mtd->dev.of_node = np; 463 if (!mtd->name) 464 of_property_read_string(np, "label", &mtd->name); 465 } 466 467 static inline struct device_node *mtd_get_of_node(struct mtd_info *mtd) 468 { 469 return dev_of_node(&mtd->dev); 470 } 471 472 static inline u32 mtd_oobavail(struct mtd_info *mtd, struct mtd_oob_ops *ops) 473 { 474 return ops->mode == MTD_OPS_AUTO_OOB ? mtd->oobavail : mtd->oobsize; 475 } 476 477 static inline int mtd_max_bad_blocks(struct mtd_info *mtd, 478 loff_t ofs, size_t len) 479 { 480 struct mtd_info *master = mtd_get_master(mtd); 481 482 if (!master->_max_bad_blocks) 483 return -ENOTSUPP; 484 485 if (mtd->size < (len + ofs) || ofs < 0) 486 return -EINVAL; 487 488 return master->_max_bad_blocks(master, mtd_get_master_ofs(mtd, ofs), 489 len); 490 } 491 492 int mtd_wunit_to_pairing_info(struct mtd_info *mtd, int wunit, 493 struct mtd_pairing_info *info); 494 int mtd_pairing_info_to_wunit(struct mtd_info *mtd, 495 const struct mtd_pairing_info *info); 496 int mtd_pairing_groups(struct mtd_info *mtd); 497 int mtd_erase(struct mtd_info *mtd, struct erase_info *instr); 498 int mtd_point(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, 499 void **virt, resource_size_t *phys); 500 int mtd_unpoint(struct mtd_info *mtd, loff_t from, size_t len); 501 unsigned long mtd_get_unmapped_area(struct mtd_info *mtd, unsigned long len, 502 unsigned long offset, unsigned long flags); 503 int mtd_read(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, 504 u_char *buf); 505 int mtd_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, 506 const u_char *buf); 507 int mtd_panic_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, 508 const u_char *buf); 509 510 int mtd_read_oob(struct mtd_info *mtd, loff_t from, struct mtd_oob_ops *ops); 511 int mtd_write_oob(struct mtd_info *mtd, loff_t to, struct mtd_oob_ops *ops); 512 513 int mtd_get_fact_prot_info(struct mtd_info *mtd, size_t len, size_t *retlen, 514 struct otp_info *buf); 515 int mtd_read_fact_prot_reg(struct mtd_info *mtd, loff_t from, size_t len, 516 size_t *retlen, u_char *buf); 517 int mtd_get_user_prot_info(struct mtd_info *mtd, size_t len, size_t *retlen, 518 struct otp_info *buf); 519 int mtd_read_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len, 520 size_t *retlen, u_char *buf); 521 int mtd_write_user_prot_reg(struct mtd_info *mtd, loff_t to, size_t len, 522 size_t *retlen, const u_char *buf); 523 int mtd_lock_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len); 524 int mtd_erase_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len); 525 526 int mtd_writev(struct mtd_info *mtd, const struct kvec *vecs, 527 unsigned long count, loff_t to, size_t *retlen); 528 529 static inline void mtd_sync(struct mtd_info *mtd) 530 { 531 struct mtd_info *master = mtd_get_master(mtd); 532 533 if (master->_sync) 534 master->_sync(master); 535 } 536 537 int mtd_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len); 538 int mtd_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len); 539 int mtd_is_locked(struct mtd_info *mtd, loff_t ofs, uint64_t len); 540 int mtd_block_isreserved(struct mtd_info *mtd, loff_t ofs); 541 int mtd_block_isbad(struct mtd_info *mtd, loff_t ofs); 542 int mtd_block_markbad(struct mtd_info *mtd, loff_t ofs); 543 544 static inline int mtd_suspend(struct mtd_info *mtd) 545 { 546 struct mtd_info *master = mtd_get_master(mtd); 547 int ret; 548 549 if (master->master.suspended) 550 return 0; 551 552 ret = master->_suspend ? master->_suspend(master) : 0; 553 if (ret) 554 return ret; 555 556 master->master.suspended = 1; 557 return 0; 558 } 559 560 static inline void mtd_resume(struct mtd_info *mtd) 561 { 562 struct mtd_info *master = mtd_get_master(mtd); 563 564 if (!master->master.suspended) 565 return; 566 567 if (master->_resume) 568 master->_resume(master); 569 570 master->master.suspended = 0; 571 } 572 573 static inline uint32_t mtd_div_by_eb(uint64_t sz, struct mtd_info *mtd) 574 { 575 if (mtd->erasesize_shift) 576 return sz >> mtd->erasesize_shift; 577 do_div(sz, mtd->erasesize); 578 return sz; 579 } 580 581 static inline uint32_t mtd_mod_by_eb(uint64_t sz, struct mtd_info *mtd) 582 { 583 if (mtd->erasesize_shift) 584 return sz & mtd->erasesize_mask; 585 return do_div(sz, mtd->erasesize); 586 } 587 588 /** 589 * mtd_align_erase_req - Adjust an erase request to align things on eraseblock 590 * boundaries. 591 * @mtd: the MTD device this erase request applies on 592 * @req: the erase request to adjust 593 * 594 * This function will adjust @req->addr and @req->len to align them on 595 * @mtd->erasesize. Of course we expect @mtd->erasesize to be != 0. 596 */ 597 static inline void mtd_align_erase_req(struct mtd_info *mtd, 598 struct erase_info *req) 599 { 600 u32 mod; 601 602 if (WARN_ON(!mtd->erasesize)) 603 return; 604 605 mod = mtd_mod_by_eb(req->addr, mtd); 606 if (mod) { 607 req->addr -= mod; 608 req->len += mod; 609 } 610 611 mod = mtd_mod_by_eb(req->addr + req->len, mtd); 612 if (mod) 613 req->len += mtd->erasesize - mod; 614 } 615 616 static inline uint32_t mtd_div_by_ws(uint64_t sz, struct mtd_info *mtd) 617 { 618 if (mtd->writesize_shift) 619 return sz >> mtd->writesize_shift; 620 do_div(sz, mtd->writesize); 621 return sz; 622 } 623 624 static inline uint32_t mtd_mod_by_ws(uint64_t sz, struct mtd_info *mtd) 625 { 626 if (mtd->writesize_shift) 627 return sz & mtd->writesize_mask; 628 return do_div(sz, mtd->writesize); 629 } 630 631 static inline int mtd_wunit_per_eb(struct mtd_info *mtd) 632 { 633 struct mtd_info *master = mtd_get_master(mtd); 634 635 return master->erasesize / mtd->writesize; 636 } 637 638 static inline int mtd_offset_to_wunit(struct mtd_info *mtd, loff_t offs) 639 { 640 return mtd_div_by_ws(mtd_mod_by_eb(offs, mtd), mtd); 641 } 642 643 static inline loff_t mtd_wunit_to_offset(struct mtd_info *mtd, loff_t base, 644 int wunit) 645 { 646 return base + (wunit * mtd->writesize); 647 } 648 649 650 static inline int mtd_has_oob(const struct mtd_info *mtd) 651 { 652 struct mtd_info *master = mtd_get_master((struct mtd_info *)mtd); 653 654 return master->_read_oob && master->_write_oob; 655 } 656 657 static inline int mtd_type_is_nand(const struct mtd_info *mtd) 658 { 659 return mtd->type == MTD_NANDFLASH || mtd->type == MTD_MLCNANDFLASH; 660 } 661 662 static inline int mtd_can_have_bb(const struct mtd_info *mtd) 663 { 664 struct mtd_info *master = mtd_get_master((struct mtd_info *)mtd); 665 666 return !!master->_block_isbad; 667 } 668 669 /* Kernel-side ioctl definitions */ 670 671 struct mtd_partition; 672 struct mtd_part_parser_data; 673 674 extern int mtd_device_parse_register(struct mtd_info *mtd, 675 const char * const *part_probe_types, 676 struct mtd_part_parser_data *parser_data, 677 const struct mtd_partition *defparts, 678 int defnr_parts); 679 #define mtd_device_register(master, parts, nr_parts) \ 680 mtd_device_parse_register(master, NULL, NULL, parts, nr_parts) 681 extern int mtd_device_unregister(struct mtd_info *master); 682 extern struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num); 683 extern int __get_mtd_device(struct mtd_info *mtd); 684 extern void __put_mtd_device(struct mtd_info *mtd); 685 extern struct mtd_info *get_mtd_device_nm(const char *name); 686 extern void put_mtd_device(struct mtd_info *mtd); 687 688 689 struct mtd_notifier { 690 void (*add)(struct mtd_info *mtd); 691 void (*remove)(struct mtd_info *mtd); 692 struct list_head list; 693 }; 694 695 696 extern void register_mtd_user (struct mtd_notifier *new); 697 extern int unregister_mtd_user (struct mtd_notifier *old); 698 void *mtd_kmalloc_up_to(const struct mtd_info *mtd, size_t *size); 699 700 static inline int mtd_is_bitflip(int err) { 701 return err == -EUCLEAN; 702 } 703 704 static inline int mtd_is_eccerr(int err) { 705 return err == -EBADMSG; 706 } 707 708 static inline int mtd_is_bitflip_or_eccerr(int err) { 709 return mtd_is_bitflip(err) || mtd_is_eccerr(err); 710 } 711 712 unsigned mtd_mmap_capabilities(struct mtd_info *mtd); 713 714 extern char *mtd_expert_analysis_warning; 715 extern bool mtd_expert_analysis_mode; 716 717 #endif /* __MTD_MTD_H__ */ 718