1 /* SPDX-License-Identifier: GPL-2.0+ */ 2 /* 3 * Copyright © 1999-2010 David Woodhouse <dwmw2@infradead.org> et al. 4 * 5 */ 6 7 #ifndef __MTD_MTD_H__ 8 #define __MTD_MTD_H__ 9 10 #ifndef __UBOOT__ 11 #include <linux/types.h> 12 #include <linux/uio.h> 13 #include <linux/notifier.h> 14 #include <linux/device.h> 15 16 #include <mtd/mtd-abi.h> 17 18 #include <asm/div64.h> 19 #else 20 #include <linux/compat.h> 21 #include <mtd/mtd-abi.h> 22 #include <linux/errno.h> 23 #include <div64.h> 24 #if IS_ENABLED(CONFIG_DM) 25 #include <dm/device.h> 26 #endif 27 28 #define MAX_MTD_DEVICES 32 29 #endif 30 31 #define MTD_ERASE_PENDING 0x01 32 #define MTD_ERASING 0x02 33 #define MTD_ERASE_SUSPEND 0x04 34 #define MTD_ERASE_DONE 0x08 35 #define MTD_ERASE_FAILED 0x10 36 37 #define MTD_FAIL_ADDR_UNKNOWN -1LL 38 39 /* 40 * If the erase fails, fail_addr might indicate exactly which block failed. If 41 * fail_addr = MTD_FAIL_ADDR_UNKNOWN, the failure was not at the device level 42 * or was not specific to any particular block. 43 */ 44 struct erase_info { 45 struct mtd_info *mtd; 46 uint64_t addr; 47 uint64_t len; 48 uint64_t fail_addr; 49 u_long time; 50 u_long retries; 51 unsigned dev; 52 unsigned cell; 53 void (*callback) (struct erase_info *self); 54 u_long priv; 55 u_char state; 56 struct erase_info *next; 57 int scrub; 58 }; 59 60 struct mtd_erase_region_info { 61 uint64_t offset; /* At which this region starts, from the beginning of the MTD */ 62 uint32_t erasesize; /* For this region */ 63 uint32_t numblocks; /* Number of blocks of erasesize in this region */ 64 unsigned long *lockmap; /* If keeping bitmap of locks */ 65 }; 66 67 /** 68 * struct mtd_oob_ops - oob operation operands 69 * @mode: operation mode 70 * 71 * @len: number of data bytes to write/read 72 * 73 * @retlen: number of data bytes written/read 74 * 75 * @ooblen: number of oob bytes to write/read 76 * @oobretlen: number of oob bytes written/read 77 * @ooboffs: offset of oob data in the oob area (only relevant when 78 * mode = MTD_OPS_PLACE_OOB or MTD_OPS_RAW) 79 * @datbuf: data buffer - if NULL only oob data are read/written 80 * @oobbuf: oob data buffer 81 */ 82 struct mtd_oob_ops { 83 unsigned int mode; 84 size_t len; 85 size_t retlen; 86 size_t ooblen; 87 size_t oobretlen; 88 uint32_t ooboffs; 89 uint8_t *datbuf; 90 uint8_t *oobbuf; 91 }; 92 93 #ifdef CONFIG_SYS_NAND_MAX_OOBFREE 94 #define MTD_MAX_OOBFREE_ENTRIES_LARGE CONFIG_SYS_NAND_MAX_OOBFREE 95 #else 96 #define MTD_MAX_OOBFREE_ENTRIES_LARGE 32 97 #endif 98 99 #ifdef CONFIG_SYS_NAND_MAX_ECCPOS 100 #define MTD_MAX_ECCPOS_ENTRIES_LARGE CONFIG_SYS_NAND_MAX_ECCPOS 101 #else 102 #define MTD_MAX_ECCPOS_ENTRIES_LARGE 680 103 #endif 104 /** 105 * struct mtd_oob_region - oob region definition 106 * @offset: region offset 107 * @length: region length 108 * 109 * This structure describes a region of the OOB area, and is used 110 * to retrieve ECC or free bytes sections. 111 * Each section is defined by an offset within the OOB area and a 112 * length. 113 */ 114 struct mtd_oob_region { 115 u32 offset; 116 u32 length; 117 }; 118 119 /* 120 * struct mtd_ooblayout_ops - NAND OOB layout operations 121 * @ecc: function returning an ECC region in the OOB area. 122 * Should return -ERANGE if %section exceeds the total number of 123 * ECC sections. 124 * @free: function returning a free region in the OOB area. 125 * Should return -ERANGE if %section exceeds the total number of 126 * free sections. 127 */ 128 struct mtd_ooblayout_ops { 129 int (*ecc)(struct mtd_info *mtd, int section, 130 struct mtd_oob_region *oobecc); 131 int (*free)(struct mtd_info *mtd, int section, 132 struct mtd_oob_region *oobfree); 133 }; 134 135 /* 136 * Internal ECC layout control structure. For historical reasons, there is a 137 * similar, smaller struct nand_ecclayout_user (in mtd-abi.h) that is retained 138 * for export to user-space via the ECCGETLAYOUT ioctl. 139 * nand_ecclayout should be expandable in the future simply by the above macros. 140 */ 141 struct nand_ecclayout { 142 __u32 eccbytes; 143 __u32 eccpos[MTD_MAX_ECCPOS_ENTRIES_LARGE]; 144 __u32 oobavail; 145 struct nand_oobfree oobfree[MTD_MAX_OOBFREE_ENTRIES_LARGE]; 146 }; 147 148 struct module; /* only needed for owner field in mtd_info */ 149 150 struct mtd_info { 151 u_char type; 152 uint32_t flags; 153 uint64_t size; // Total size of the MTD 154 155 /* "Major" erase size for the device. Naïve users may take this 156 * to be the only erase size available, or may use the more detailed 157 * information below if they desire 158 */ 159 uint32_t erasesize; 160 /* Minimal writable flash unit size. In case of NOR flash it is 1 (even 161 * though individual bits can be cleared), in case of NAND flash it is 162 * one NAND page (or half, or one-fourths of it), in case of ECC-ed NOR 163 * it is of ECC block size, etc. It is illegal to have writesize = 0. 164 * Any driver registering a struct mtd_info must ensure a writesize of 165 * 1 or larger. 166 */ 167 uint32_t writesize; 168 169 /* 170 * Size of the write buffer used by the MTD. MTD devices having a write 171 * buffer can write multiple writesize chunks at a time. E.g. while 172 * writing 4 * writesize bytes to a device with 2 * writesize bytes 173 * buffer the MTD driver can (but doesn't have to) do 2 writesize 174 * operations, but not 4. Currently, all NANDs have writebufsize 175 * equivalent to writesize (NAND page size). Some NOR flashes do have 176 * writebufsize greater than writesize. 177 */ 178 uint32_t writebufsize; 179 180 uint32_t oobsize; // Amount of OOB data per block (e.g. 16) 181 uint32_t oobavail; // Available OOB bytes per block 182 183 /* 184 * If erasesize is a power of 2 then the shift is stored in 185 * erasesize_shift otherwise erasesize_shift is zero. Ditto writesize. 186 */ 187 unsigned int erasesize_shift; 188 unsigned int writesize_shift; 189 /* Masks based on erasesize_shift and writesize_shift */ 190 unsigned int erasesize_mask; 191 unsigned int writesize_mask; 192 193 /* 194 * read ops return -EUCLEAN if max number of bitflips corrected on any 195 * one region comprising an ecc step equals or exceeds this value. 196 * Settable by driver, else defaults to ecc_strength. User can override 197 * in sysfs. N.B. The meaning of the -EUCLEAN return code has changed; 198 * see Documentation/ABI/testing/sysfs-class-mtd for more detail. 199 */ 200 unsigned int bitflip_threshold; 201 202 // Kernel-only stuff starts here. 203 #ifndef __UBOOT__ 204 const char *name; 205 #else 206 char *name; 207 #endif 208 int index; 209 210 /* OOB layout description */ 211 const struct mtd_ooblayout_ops *ooblayout; 212 213 /* ECC layout structure pointer - read only! */ 214 struct nand_ecclayout *ecclayout; 215 216 /* the ecc step size. */ 217 unsigned int ecc_step_size; 218 219 /* max number of correctible bit errors per ecc step */ 220 unsigned int ecc_strength; 221 222 /* Data for variable erase regions. If numeraseregions is zero, 223 * it means that the whole device has erasesize as given above. 224 */ 225 int numeraseregions; 226 struct mtd_erase_region_info *eraseregions; 227 228 /* 229 * Do not call via these pointers, use corresponding mtd_*() 230 * wrappers instead. 231 */ 232 int (*_erase) (struct mtd_info *mtd, struct erase_info *instr); 233 #ifndef __UBOOT__ 234 int (*_point) (struct mtd_info *mtd, loff_t from, size_t len, 235 size_t *retlen, void **virt, resource_size_t *phys); 236 int (*_unpoint) (struct mtd_info *mtd, loff_t from, size_t len); 237 #endif 238 unsigned long (*_get_unmapped_area) (struct mtd_info *mtd, 239 unsigned long len, 240 unsigned long offset, 241 unsigned long flags); 242 int (*_read) (struct mtd_info *mtd, loff_t from, size_t len, 243 size_t *retlen, u_char *buf); 244 int (*_write) (struct mtd_info *mtd, loff_t to, size_t len, 245 size_t *retlen, const u_char *buf); 246 int (*_panic_write) (struct mtd_info *mtd, loff_t to, size_t len, 247 size_t *retlen, const u_char *buf); 248 int (*_read_oob) (struct mtd_info *mtd, loff_t from, 249 struct mtd_oob_ops *ops); 250 int (*_write_oob) (struct mtd_info *mtd, loff_t to, 251 struct mtd_oob_ops *ops); 252 int (*_get_fact_prot_info) (struct mtd_info *mtd, size_t len, 253 size_t *retlen, struct otp_info *buf); 254 int (*_read_fact_prot_reg) (struct mtd_info *mtd, loff_t from, 255 size_t len, size_t *retlen, u_char *buf); 256 int (*_get_user_prot_info) (struct mtd_info *mtd, size_t len, 257 size_t *retlen, struct otp_info *buf); 258 int (*_read_user_prot_reg) (struct mtd_info *mtd, loff_t from, 259 size_t len, size_t *retlen, u_char *buf); 260 int (*_write_user_prot_reg) (struct mtd_info *mtd, loff_t to, 261 size_t len, size_t *retlen, u_char *buf); 262 int (*_lock_user_prot_reg) (struct mtd_info *mtd, loff_t from, 263 size_t len); 264 #ifndef __UBOOT__ 265 int (*_writev) (struct mtd_info *mtd, const struct kvec *vecs, 266 unsigned long count, loff_t to, size_t *retlen); 267 #endif 268 void (*_sync) (struct mtd_info *mtd); 269 int (*_lock) (struct mtd_info *mtd, loff_t ofs, uint64_t len); 270 int (*_unlock) (struct mtd_info *mtd, loff_t ofs, uint64_t len); 271 int (*_is_locked) (struct mtd_info *mtd, loff_t ofs, uint64_t len); 272 int (*_block_isreserved) (struct mtd_info *mtd, loff_t ofs); 273 int (*_block_isbad) (struct mtd_info *mtd, loff_t ofs); 274 int (*_block_markbad) (struct mtd_info *mtd, loff_t ofs); 275 #ifndef __UBOOT__ 276 int (*_suspend) (struct mtd_info *mtd); 277 void (*_resume) (struct mtd_info *mtd); 278 void (*_reboot) (struct mtd_info *mtd); 279 #endif 280 /* 281 * If the driver is something smart, like UBI, it may need to maintain 282 * its own reference counting. The below functions are only for driver. 283 */ 284 int (*_get_device) (struct mtd_info *mtd); 285 void (*_put_device) (struct mtd_info *mtd); 286 287 #ifndef __UBOOT__ 288 /* Backing device capabilities for this device 289 * - provides mmap capabilities 290 */ 291 struct backing_dev_info *backing_dev_info; 292 293 struct notifier_block reboot_notifier; /* default mode before reboot */ 294 #endif 295 296 /* ECC status information */ 297 struct mtd_ecc_stats ecc_stats; 298 /* Subpage shift (NAND) */ 299 int subpage_sft; 300 301 void *priv; 302 303 struct module *owner; 304 #ifndef __UBOOT__ 305 struct device dev; 306 #else 307 struct udevice *dev; 308 #endif 309 int usecount; 310 }; 311 312 #if IS_ENABLED(CONFIG_DM) 313 static inline void mtd_set_of_node(struct mtd_info *mtd, 314 const struct device_node *np) 315 { 316 mtd->dev->node.np = np; 317 } 318 319 static inline const struct device_node *mtd_get_of_node(struct mtd_info *mtd) 320 { 321 return mtd->dev->node.np; 322 } 323 #else 324 struct device_node; 325 326 static inline void mtd_set_of_node(struct mtd_info *mtd, 327 const struct device_node *np) 328 { 329 } 330 331 static inline const struct device_node *mtd_get_of_node(struct mtd_info *mtd) 332 { 333 return NULL; 334 } 335 #endif 336 337 int mtd_ooblayout_ecc(struct mtd_info *mtd, int section, 338 struct mtd_oob_region *oobecc); 339 int mtd_ooblayout_find_eccregion(struct mtd_info *mtd, int eccbyte, 340 int *section, 341 struct mtd_oob_region *oobregion); 342 int mtd_ooblayout_get_eccbytes(struct mtd_info *mtd, u8 *eccbuf, 343 const u8 *oobbuf, int start, int nbytes); 344 int mtd_ooblayout_set_eccbytes(struct mtd_info *mtd, const u8 *eccbuf, 345 u8 *oobbuf, int start, int nbytes); 346 int mtd_ooblayout_free(struct mtd_info *mtd, int section, 347 struct mtd_oob_region *oobfree); 348 int mtd_ooblayout_get_databytes(struct mtd_info *mtd, u8 *databuf, 349 const u8 *oobbuf, int start, int nbytes); 350 int mtd_ooblayout_set_databytes(struct mtd_info *mtd, const u8 *databuf, 351 u8 *oobbuf, int start, int nbytes); 352 int mtd_ooblayout_count_freebytes(struct mtd_info *mtd); 353 int mtd_ooblayout_count_eccbytes(struct mtd_info *mtd); 354 355 static inline void mtd_set_ooblayout(struct mtd_info *mtd, 356 const struct mtd_ooblayout_ops *ooblayout) 357 { 358 mtd->ooblayout = ooblayout; 359 } 360 361 static inline int mtd_oobavail(struct mtd_info *mtd, struct mtd_oob_ops *ops) 362 { 363 return ops->mode == MTD_OPS_AUTO_OOB ? mtd->oobavail : mtd->oobsize; 364 } 365 366 int mtd_erase(struct mtd_info *mtd, struct erase_info *instr); 367 #ifndef __UBOOT__ 368 int mtd_point(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, 369 void **virt, resource_size_t *phys); 370 int mtd_unpoint(struct mtd_info *mtd, loff_t from, size_t len); 371 #endif 372 unsigned long mtd_get_unmapped_area(struct mtd_info *mtd, unsigned long len, 373 unsigned long offset, unsigned long flags); 374 int mtd_read(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, 375 u_char *buf); 376 int mtd_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, 377 const u_char *buf); 378 int mtd_panic_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, 379 const u_char *buf); 380 381 int mtd_read_oob(struct mtd_info *mtd, loff_t from, struct mtd_oob_ops *ops); 382 int mtd_write_oob(struct mtd_info *mtd, loff_t to, struct mtd_oob_ops *ops); 383 384 int mtd_get_fact_prot_info(struct mtd_info *mtd, size_t len, size_t *retlen, 385 struct otp_info *buf); 386 int mtd_read_fact_prot_reg(struct mtd_info *mtd, loff_t from, size_t len, 387 size_t *retlen, u_char *buf); 388 int mtd_get_user_prot_info(struct mtd_info *mtd, size_t len, size_t *retlen, 389 struct otp_info *buf); 390 int mtd_read_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len, 391 size_t *retlen, u_char *buf); 392 int mtd_write_user_prot_reg(struct mtd_info *mtd, loff_t to, size_t len, 393 size_t *retlen, u_char *buf); 394 int mtd_lock_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len); 395 396 #ifndef __UBOOT__ 397 int mtd_writev(struct mtd_info *mtd, const struct kvec *vecs, 398 unsigned long count, loff_t to, size_t *retlen); 399 #endif 400 401 static inline void mtd_sync(struct mtd_info *mtd) 402 { 403 if (mtd->_sync) 404 mtd->_sync(mtd); 405 } 406 407 int mtd_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len); 408 int mtd_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len); 409 int mtd_is_locked(struct mtd_info *mtd, loff_t ofs, uint64_t len); 410 int mtd_block_isreserved(struct mtd_info *mtd, loff_t ofs); 411 int mtd_block_isbad(struct mtd_info *mtd, loff_t ofs); 412 int mtd_block_markbad(struct mtd_info *mtd, loff_t ofs); 413 414 #ifndef __UBOOT__ 415 static inline int mtd_suspend(struct mtd_info *mtd) 416 { 417 return mtd->_suspend ? mtd->_suspend(mtd) : 0; 418 } 419 420 static inline void mtd_resume(struct mtd_info *mtd) 421 { 422 if (mtd->_resume) 423 mtd->_resume(mtd); 424 } 425 #endif 426 427 static inline uint32_t mtd_div_by_eb(uint64_t sz, struct mtd_info *mtd) 428 { 429 if (mtd->erasesize_shift) 430 return sz >> mtd->erasesize_shift; 431 do_div(sz, mtd->erasesize); 432 return sz; 433 } 434 435 static inline uint32_t mtd_mod_by_eb(uint64_t sz, struct mtd_info *mtd) 436 { 437 if (mtd->erasesize_shift) 438 return sz & mtd->erasesize_mask; 439 return do_div(sz, mtd->erasesize); 440 } 441 442 static inline uint32_t mtd_div_by_ws(uint64_t sz, struct mtd_info *mtd) 443 { 444 if (mtd->writesize_shift) 445 return sz >> mtd->writesize_shift; 446 do_div(sz, mtd->writesize); 447 return sz; 448 } 449 450 static inline uint32_t mtd_mod_by_ws(uint64_t sz, struct mtd_info *mtd) 451 { 452 if (mtd->writesize_shift) 453 return sz & mtd->writesize_mask; 454 return do_div(sz, mtd->writesize); 455 } 456 457 static inline int mtd_has_oob(const struct mtd_info *mtd) 458 { 459 return mtd->_read_oob && mtd->_write_oob; 460 } 461 462 static inline int mtd_type_is_nand(const struct mtd_info *mtd) 463 { 464 return mtd->type == MTD_NANDFLASH || mtd->type == MTD_MLCNANDFLASH; 465 } 466 467 static inline int mtd_can_have_bb(const struct mtd_info *mtd) 468 { 469 return !!mtd->_block_isbad; 470 } 471 472 /* Kernel-side ioctl definitions */ 473 474 struct mtd_partition; 475 struct mtd_part_parser_data; 476 477 extern int mtd_device_parse_register(struct mtd_info *mtd, 478 const char * const *part_probe_types, 479 struct mtd_part_parser_data *parser_data, 480 const struct mtd_partition *defparts, 481 int defnr_parts); 482 #define mtd_device_register(master, parts, nr_parts) \ 483 mtd_device_parse_register(master, NULL, NULL, parts, nr_parts) 484 extern int mtd_device_unregister(struct mtd_info *master); 485 extern struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num); 486 extern int __get_mtd_device(struct mtd_info *mtd); 487 extern void __put_mtd_device(struct mtd_info *mtd); 488 extern struct mtd_info *get_mtd_device_nm(const char *name); 489 extern void put_mtd_device(struct mtd_info *mtd); 490 491 492 #ifndef __UBOOT__ 493 struct mtd_notifier { 494 void (*add)(struct mtd_info *mtd); 495 void (*remove)(struct mtd_info *mtd); 496 struct list_head list; 497 }; 498 499 500 extern void register_mtd_user (struct mtd_notifier *new); 501 extern int unregister_mtd_user (struct mtd_notifier *old); 502 #endif 503 void *mtd_kmalloc_up_to(const struct mtd_info *mtd, size_t *size); 504 505 #ifdef CONFIG_MTD_PARTITIONS 506 void mtd_erase_callback(struct erase_info *instr); 507 #else 508 static inline void mtd_erase_callback(struct erase_info *instr) 509 { 510 if (instr->callback) 511 instr->callback(instr); 512 } 513 #endif 514 515 static inline int mtd_is_bitflip(int err) { 516 return err == -EUCLEAN; 517 } 518 519 static inline int mtd_is_eccerr(int err) { 520 return err == -EBADMSG; 521 } 522 523 static inline int mtd_is_bitflip_or_eccerr(int err) { 524 return mtd_is_bitflip(err) || mtd_is_eccerr(err); 525 } 526 527 unsigned mtd_mmap_capabilities(struct mtd_info *mtd); 528 529 #ifdef __UBOOT__ 530 /* drivers/mtd/mtdcore.h */ 531 int add_mtd_device(struct mtd_info *mtd); 532 int del_mtd_device(struct mtd_info *mtd); 533 int add_mtd_partitions(struct mtd_info *, const struct mtd_partition *, int); 534 int del_mtd_partitions(struct mtd_info *); 535 536 struct mtd_info *__mtd_next_device(int i); 537 #define mtd_for_each_device(mtd) \ 538 for ((mtd) = __mtd_next_device(0); \ 539 (mtd) != NULL; \ 540 (mtd) = __mtd_next_device(mtd->index + 1)) 541 542 int mtd_arg_off(const char *arg, int *idx, loff_t *off, loff_t *size, 543 loff_t *maxsize, int devtype, uint64_t chipsize); 544 int mtd_arg_off_size(int argc, char *const argv[], int *idx, loff_t *off, 545 loff_t *size, loff_t *maxsize, int devtype, 546 uint64_t chipsize); 547 548 /* drivers/mtd/mtdcore.c */ 549 void mtd_get_len_incl_bad(struct mtd_info *mtd, uint64_t offset, 550 const uint64_t length, uint64_t *len_incl_bad, 551 int *truncated); 552 #endif 553 #endif /* __MTD_MTD_H__ */ 554