include/linux/mtd/mtd.h

   1 /*
   2  * Copyright © 1999-2010 David Woodhouse <dwmw2@infradead.org> et al.
   3  *
   4  * Released under GPL
   5  *
   6  */
   7
   8 #ifndef __MTD_MTD_H__
   9 #define __MTD_MTD_H__
  10
  11 #ifndef __UBOOT__
  12 #include <linux/types.h>
  13 #include <linux/uio.h>
  14 #include <linux/notifier.h>
  15 #include <linux/device.h>
  16
  17 #include <mtd/mtd-abi.h>
  18
  19 #include <asm/div64.h>
  20 #else
  21 #include <linux/compat.h>
  22 #include <mtd/mtd-abi.h>
  23 #include <asm/errno.h>
  24 #include <div64.h>
  25
  26 #define MAX_MTD_DEVICES 32
  27 #endif
  28
  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
  34
  35 #define MTD_FAIL_ADDR_UNKNOWN -1LL
  36
  37 /*
  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.
  41  */
  42 struct erase_info {
  43         struct mtd_info *mtd;
  44         uint64_t addr;
  45         uint64_t len;
  46         uint64_t fail_addr;
  47         u_long time;
  48         u_long retries;
  49         unsigned dev;
  50         unsigned cell;
  51         void (*callback) (struct erase_info *self);
  52         u_long priv;
  53         u_char state;
  54         struct erase_info *next;
  55         int scrub;
  56 };
  57
  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 */
  63 };
  64
  65 /**
  66  * struct mtd_oob_ops - oob operation operands
  67  * @mode:       operation mode
  68  *
  69  * @len:        number of data bytes to write/read
  70  *
  71  * @retlen:     number of data bytes written/read
  72  *
  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
  79  *
  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
  82  * OOB area.
  83  */
  84 struct mtd_oob_ops {
  85         unsigned int    mode;
  86         size_t          len;
  87         size_t          retlen;
  88         size_t          ooblen;
  89         size_t          oobretlen;
  90         uint32_t        ooboffs;
  91         uint8_t         *datbuf;
  92         uint8_t         *oobbuf;
  93 };
  94
  95 #ifdef CONFIG_SYS_NAND_MAX_OOBFREE
  96 #define MTD_MAX_OOBFREE_ENTRIES_LARGE   CONFIG_SYS_NAND_MAX_OOBFREE
  97 #else
  98 #define MTD_MAX_OOBFREE_ENTRIES_LARGE   32
  99 #endif
 100
 101 #ifdef CONFIG_SYS_NAND_MAX_ECCPOS
 102 #define MTD_MAX_ECCPOS_ENTRIES_LARGE    CONFIG_SYS_NAND_MAX_ECCPOS
 103 #else
 104 #define MTD_MAX_ECCPOS_ENTRIES_LARGE    640
 105 #endif
 106
 107 /*
 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.
 112  */
 113 struct nand_ecclayout {
 114         __u32 eccbytes;
 115         __u32 eccpos[MTD_MAX_ECCPOS_ENTRIES_LARGE];
 116         __u32 oobavail;
 117         struct nand_oobfree oobfree[MTD_MAX_OOBFREE_ENTRIES_LARGE];
 118 };
 119
 120 struct module;  /* only needed for owner field in mtd_info */
 121
 122 struct mtd_info {
 123         u_char type;
 124         uint32_t flags;
 125         uint64_t size;   // Total size of the MTD
 126
 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
 130          */
 131         uint32_t erasesize;
 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
 137          * 1 or larger.
 138          */
 139         uint32_t writesize;
 140
 141         /*
 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.
 149          */
 150         uint32_t writebufsize;
 151
 152         uint32_t oobsize;   // Amount of OOB data per block (e.g. 16)
 153         uint32_t oobavail;  // Available OOB bytes per block
 154
 155         /*
 156          * If erasesize is a power of 2 then the shift is stored in
 157          * erasesize_shift otherwise erasesize_shift is zero. Ditto writesize.
 158          */
 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;
 164
 165         /*
 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.
 171          */
 172         unsigned int bitflip_threshold;
 173
 174         // Kernel-only stuff starts here.
 175 #ifndef __UBOOT__
 176         const char *name;
 177 #else
 178         char *name;
 179 #endif
 180         int index;
 181
 182         /* ECC layout structure pointer - read only! */
 183         struct nand_ecclayout *ecclayout;
 184
 185         /* the ecc step size. */
 186         unsigned int ecc_step_size;
 187
 188         /* max number of correctible bit errors per ecc step */
 189         unsigned int ecc_strength;
 190
 191         /* Data for variable erase regions. If numeraseregions is zero,
 192          * it means that the whole device has erasesize as given above.
 193          */
 194         int numeraseregions;
 195         struct mtd_erase_region_info *eraseregions;
 196
 197         /*
 198          * Do not call via these pointers, use corresponding mtd_*()
 199          * wrappers instead.
 200          */
 201         int (*_erase) (struct mtd_info *mtd, struct erase_info *instr);
 202 #ifndef __UBOOT__
 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);
 206 #endif
 207         unsigned long (*_get_unmapped_area) (struct mtd_info *mtd,
 208                                              unsigned long len,
 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,
 232                                     size_t len);
 233 #ifndef __UBOOT__
 234         int (*_writev) (struct mtd_info *mtd, const struct kvec *vecs,
 235                         unsigned long count, loff_t to, size_t *retlen);
 236 #endif
 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_isbad) (struct mtd_info *mtd, loff_t ofs);
 242         int (*_block_markbad) (struct mtd_info *mtd, loff_t ofs);
 243 #ifndef __UBOOT__
 244         int (*_suspend) (struct mtd_info *mtd);
 245         void (*_resume) (struct mtd_info *mtd);
 246 #endif
 247         /*
 248          * If the driver is something smart, like UBI, it may need to maintain
 249          * its own reference counting. The below functions are only for driver.
 250          */
 251         int (*_get_device) (struct mtd_info *mtd);
 252         void (*_put_device) (struct mtd_info *mtd);
 253
 254 #ifndef __UBOOT__
 255         /* Backing device capabilities for this device
 256          * - provides mmap capabilities
 257          */
 258         struct backing_dev_info *backing_dev_info;
 259
 260         struct notifier_block reboot_notifier;  /* default mode before reboot */
 261 #endif
 262
 263         /* ECC status information */
 264         struct mtd_ecc_stats ecc_stats;
 265         /* Subpage shift (NAND) */
 266         int subpage_sft;
 267
 268         void *priv;
 269
 270         struct module *owner;
 271 #ifndef __UBOOT__
 272         struct device dev;
 273 #endif
 274         int usecount;
 275 };
 276
 277 int mtd_erase(struct mtd_info *mtd, struct erase_info *instr);
 278 #ifndef __UBOOT__
 279 int mtd_point(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen,
 280               void **virt, resource_size_t *phys);
 281 int mtd_unpoint(struct mtd_info *mtd, loff_t from, size_t len);
 282 #endif
 283 unsigned long mtd_get_unmapped_area(struct mtd_info *mtd, unsigned long len,
 284                                     unsigned long offset, unsigned long flags);
 285 int mtd_read(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen,
 286              u_char *buf);
 287 int mtd_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen,
 288               const u_char *buf);
 289 int mtd_panic_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen,
 290                     const u_char *buf);
 291
 292 int mtd_read_oob(struct mtd_info *mtd, loff_t from, struct mtd_oob_ops *ops);
 293
 294 static inline int mtd_write_oob(struct mtd_info *mtd, loff_t to,
 295                                 struct mtd_oob_ops *ops)
 296 {
 297         ops->retlen = ops->oobretlen = 0;
 298         if (!mtd->_write_oob)
 299                 return -EOPNOTSUPP;
 300         if (!(mtd->flags & MTD_WRITEABLE))
 301                 return -EROFS;
 302         return mtd->_write_oob(mtd, to, ops);
 303 }
 304
 305 int mtd_get_fact_prot_info(struct mtd_info *mtd, size_t len, size_t *retlen,
 306                            struct otp_info *buf);
 307 int mtd_read_fact_prot_reg(struct mtd_info *mtd, loff_t from, size_t len,
 308                            size_t *retlen, u_char *buf);
 309 int mtd_get_user_prot_info(struct mtd_info *mtd, size_t len, size_t *retlen,
 310                            struct otp_info *buf);
 311 int mtd_read_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len,
 312                            size_t *retlen, u_char *buf);
 313 int mtd_write_user_prot_reg(struct mtd_info *mtd, loff_t to, size_t len,
 314                             size_t *retlen, u_char *buf);
 315 int mtd_lock_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len);
 316
 317 #ifndef __UBOOT__
 318 int mtd_writev(struct mtd_info *mtd, const struct kvec *vecs,
 319                unsigned long count, loff_t to, size_t *retlen);
 320 #endif
 321
 322 static inline void mtd_sync(struct mtd_info *mtd)
 323 {
 324         if (mtd->_sync)
 325                 mtd->_sync(mtd);
 326 }
 327
 328 int mtd_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len);
 329 int mtd_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len);
 330 int mtd_is_locked(struct mtd_info *mtd, loff_t ofs, uint64_t len);
 331 int mtd_block_isbad(struct mtd_info *mtd, loff_t ofs);
 332 int mtd_block_markbad(struct mtd_info *mtd, loff_t ofs);
 333
 334 #ifndef __UBOOT__
 335 static inline int mtd_suspend(struct mtd_info *mtd)
 336 {
 337         return mtd->_suspend ? mtd->_suspend(mtd) : 0;
 338 }
 339
 340 static inline void mtd_resume(struct mtd_info *mtd)
 341 {
 342         if (mtd->_resume)
 343                 mtd->_resume(mtd);
 344 }
 345 #endif
 346
 347 static inline uint32_t mtd_div_by_eb(uint64_t sz, struct mtd_info *mtd)
 348 {
 349         if (mtd->erasesize_shift)
 350                 return sz >> mtd->erasesize_shift;
 351         do_div(sz, mtd->erasesize);
 352         return sz;
 353 }
 354
 355 static inline uint32_t mtd_mod_by_eb(uint64_t sz, struct mtd_info *mtd)
 356 {
 357         if (mtd->erasesize_shift)
 358                 return sz & mtd->erasesize_mask;
 359         return do_div(sz, mtd->erasesize);
 360 }
 361
 362 static inline uint32_t mtd_div_by_ws(uint64_t sz, struct mtd_info *mtd)
 363 {
 364         if (mtd->writesize_shift)
 365                 return sz >> mtd->writesize_shift;
 366         do_div(sz, mtd->writesize);
 367         return sz;
 368 }
 369
 370 static inline uint32_t mtd_mod_by_ws(uint64_t sz, struct mtd_info *mtd)
 371 {
 372         if (mtd->writesize_shift)
 373                 return sz & mtd->writesize_mask;
 374         return do_div(sz, mtd->writesize);
 375 }
 376
 377 static inline int mtd_has_oob(const struct mtd_info *mtd)
 378 {
 379         return mtd->_read_oob && mtd->_write_oob;
 380 }
 381
 382 static inline int mtd_type_is_nand(const struct mtd_info *mtd)
 383 {
 384         return mtd->type == MTD_NANDFLASH || mtd->type == MTD_MLCNANDFLASH;
 385 }
 386
 387 static inline int mtd_can_have_bb(const struct mtd_info *mtd)
 388 {
 389         return !!mtd->_block_isbad;
 390 }
 391
 392         /* Kernel-side ioctl definitions */
 393
 394 struct mtd_partition;
 395 struct mtd_part_parser_data;
 396
 397 extern int mtd_device_parse_register(struct mtd_info *mtd,
 398                                      const char * const *part_probe_types,
 399                                      struct mtd_part_parser_data *parser_data,
 400                                      const struct mtd_partition *defparts,
 401                                      int defnr_parts);
 402 #define mtd_device_register(master, parts, nr_parts)    \
 403         mtd_device_parse_register(master, NULL, NULL, parts, nr_parts)
 404 extern int mtd_device_unregister(struct mtd_info *master);
 405 extern struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num);
 406 extern int __get_mtd_device(struct mtd_info *mtd);
 407 extern void __put_mtd_device(struct mtd_info *mtd);
 408 extern struct mtd_info *get_mtd_device_nm(const char *name);
 409 extern void put_mtd_device(struct mtd_info *mtd);
 410
 411
 412 #ifndef __UBOOT__
 413 struct mtd_notifier {
 414         void (*add)(struct mtd_info *mtd);
 415         void (*remove)(struct mtd_info *mtd);
 416         struct list_head list;
 417 };
 418
 419
 420 extern void register_mtd_user (struct mtd_notifier *new);
 421 extern int unregister_mtd_user (struct mtd_notifier *old);
 422 #endif
 423 void *mtd_kmalloc_up_to(const struct mtd_info *mtd, size_t *size);
 424
 425 #ifdef CONFIG_MTD_PARTITIONS
 426 void mtd_erase_callback(struct erase_info *instr);
 427 #else
 428 static inline void mtd_erase_callback(struct erase_info *instr)
 429 {
 430         if (instr->callback)
 431                 instr->callback(instr);
 432 }
 433 #endif
 434
 435 #ifdef __UBOOT__
 436 /*
 437  * Debugging macro and defines
 438  */
 439 #define MTD_DEBUG_LEVEL0        (0)     /* Quiet   */
 440 #define MTD_DEBUG_LEVEL1        (1)     /* Audible */
 441 #define MTD_DEBUG_LEVEL2        (2)     /* Loud    */
 442 #define MTD_DEBUG_LEVEL3        (3)     /* Noisy   */
 443
 444 #ifdef CONFIG_MTD_DEBUG
 445 #define pr_debug(args...)       MTDDEBUG(MTD_DEBUG_LEVEL0, args)
 446 #define MTDDEBUG(n, args...)                            \
 447         do {                                            \
 448                 if (n <= CONFIG_MTD_DEBUG_VERBOSE)      \
 449                         printk(KERN_INFO args);         \
 450         } while(0)
 451 #else /* CONFIG_MTD_DEBUG */
 452 #define pr_debug(args...)
 453 #define MTDDEBUG(n, args...)                            \
 454         do {                                            \
 455                 if (0)                                  \
 456                         printk(KERN_INFO args);         \
 457         } while(0)
 458 #endif /* CONFIG_MTD_DEBUG */
 459 #define pr_info(args...)        MTDDEBUG(MTD_DEBUG_LEVEL0, args)
 460 #define pr_warn(args...)        MTDDEBUG(MTD_DEBUG_LEVEL0, args)
 461 #define pr_err(args...)         MTDDEBUG(MTD_DEBUG_LEVEL0, args)
 462 #define pr_crit(args...)        MTDDEBUG(MTD_DEBUG_LEVEL0, args)
 463 #define pr_cont(args...)        MTDDEBUG(MTD_DEBUG_LEVEL0, args)
 464 #define pr_notice(args...)      MTDDEBUG(MTD_DEBUG_LEVEL0, args)
 465 #endif
 466
 467 static inline int mtd_is_bitflip(int err) {
 468         return err == -EUCLEAN;
 469 }
 470
 471 static inline int mtd_is_eccerr(int err) {
 472         return err == -EBADMSG;
 473 }
 474
 475 static inline int mtd_is_bitflip_or_eccerr(int err) {
 476         return mtd_is_bitflip(err) || mtd_is_eccerr(err);
 477 }
 478
 479 #ifdef __UBOOT__
 480 /* drivers/mtd/mtdcore.h */
 481 int add_mtd_device(struct mtd_info *mtd);
 482 int del_mtd_device(struct mtd_info *mtd);
 483 int add_mtd_partitions(struct mtd_info *, const struct mtd_partition *, int);
 484 int del_mtd_partitions(struct mtd_info *);
 485 #endif
 486 #endif /* __MTD_MTD_H__ */