include/linux/mtd/mtd.h

   1 /*
   2  * Copyright © 1999-2010 David Woodhouse <dwmw2@infradead.org> et al.
   3  *
   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.
   8  *
   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.
  13  *
  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
  17  *
  18  */
  19
  20 #ifndef __MTD_MTD_H__
  21 #define __MTD_MTD_H__
  22
  23 #include <linux/types.h>
  24 #include <linux/uio.h>
  25 #include <linux/notifier.h>
  26 #include <linux/device.h>
  27
  28 #include <mtd/mtd-abi.h>
  29
  30 #include <asm/div64.h>
  31
  32 #define MTD_CHAR_MAJOR 90
  33 #define MTD_BLOCK_MAJOR 31
  34
  35 #define MTD_ERASE_PENDING       0x01
  36 #define MTD_ERASING             0x02
  37 #define MTD_ERASE_SUSPEND       0x04
  38 #define MTD_ERASE_DONE          0x08
  39 #define MTD_ERASE_FAILED        0x10
  40
  41 #define MTD_FAIL_ADDR_UNKNOWN -1LL
  42
  43 #ifdef CONFIG_MTK_MTD_NAND
  44 #ifndef CONFIG_MTD_DEBUG
  45 #define CONFIG_MTD_DEBUG 1
  46 #endif
  47 #ifndef CONFIG_MTD_DEBUG_VERBOSE
  48 #define CONFIG_MTD_DEBUG_VERBOSE 0
  49 #endif
  50
  51 /*
  52  * NSS (Nand Speedup Strategy) Configurations
  53  */
  54
  55 #define CONFIG_MTK_NSS_CACHEV_MAX_CNT (4)
  56
  57 #endif
  58 /*
  59  * If the erase fails, fail_addr might indicate exactly which block failed. If
  60  * fail_addr = MTD_FAIL_ADDR_UNKNOWN, the failure was not at the device level
  61  * or was not specific to any particular block.
  62  */
  63 struct erase_info {
  64         struct mtd_info *mtd;
  65         uint64_t addr;
  66         uint64_t len;
  67         uint64_t fail_addr;
  68         u_long time;
  69         u_long retries;
  70         unsigned dev;
  71         unsigned cell;
  72         void (*callback) (struct erase_info *self);
  73         u_long priv;
  74         u_char state;
  75         struct erase_info *next;
  76 };
  77
  78 struct mtd_erase_region_info {
  79         uint64_t offset;                /* At which this region starts, from the beginning of the MTD */
  80         uint32_t erasesize;             /* For this region */
  81         uint32_t numblocks;             /* Number of blocks of erasesize in this region */
  82         unsigned long *lockmap;         /* If keeping bitmap of locks */
  83 };
  84
  85 /**
  86  * struct mtd_oob_ops - oob operation operands
  87  * @mode:       operation mode
  88  *
  89  * @len:        number of data bytes to write/read
  90  *
  91  * @retlen:     number of data bytes written/read
  92  *
  93  * @ooblen:     number of oob bytes to write/read
  94  * @oobretlen:  number of oob bytes written/read
  95  * @ooboffs:    offset of oob data in the oob area (only relevant when
  96  *              mode = MTD_OPS_PLACE_OOB or MTD_OPS_RAW)
  97  * @datbuf:     data buffer - if NULL only oob data are read/written
  98  * @oobbuf:     oob data buffer
  99  *
 100  * Note, it is allowed to read more than one OOB area at one go, but not write.
 101  * The interface assumes that the OOB write requests program only one page's
 102  * OOB area.
 103  */
 104 struct mtd_oob_ops {
 105         unsigned int    mode;
 106         size_t          len;
 107         size_t          retlen;
 108         size_t          ooblen;
 109         size_t          oobretlen;
 110         uint32_t        ooboffs;
 111         uint8_t         *datbuf;
 112         uint8_t         *oobbuf;
 113 };
 114
 115 #define MTD_MAX_OOBFREE_ENTRIES_LARGE   32
 116 #define MTD_MAX_ECCPOS_ENTRIES_LARGE    640
 117 /*
 118  * Internal ECC layout control structure. For historical reasons, there is a
 119  * similar, smaller struct nand_ecclayout_user (in mtd-abi.h) that is retained
 120  * for export to user-space via the ECCGETLAYOUT ioctl.
 121  * nand_ecclayout should be expandable in the future simply by the above macros.
 122  */
 123 struct nand_ecclayout {
 124         __u32 eccbytes;
 125         __u32 eccpos[MTD_MAX_ECCPOS_ENTRIES_LARGE];
 126         __u32 oobavail;
 127         struct nand_oobfree oobfree[MTD_MAX_OOBFREE_ENTRIES_LARGE];
 128 };
 129
 130 struct module;  /* only needed for owner field in mtd_info */
 131
 132 struct mtd_info {
 133         u_char type;
 134         uint32_t flags;
 135         uint64_t size;   // Total size of the MTD
 136
 137         /* "Major" erase size for the device. Naïve users may take this
 138          * to be the only erase size available, or may use the more detailed
 139          * information below if they desire
 140          */
 141         uint32_t erasesize;
 142         /* Minimal writable flash unit size. In case of NOR flash it is 1 (even
 143          * though individual bits can be cleared), in case of NAND flash it is
 144          * one NAND page (or half, or one-fourths of it), in case of ECC-ed NOR
 145          * it is of ECC block size, etc. It is illegal to have writesize = 0.
 146          * Any driver registering a struct mtd_info must ensure a writesize of
 147          * 1 or larger.
 148          */
 149         uint32_t writesize;
 150
 151         /*
 152          * Size of the write buffer used by the MTD. MTD devices having a write
 153          * buffer can write multiple writesize chunks at a time. E.g. while
 154          * writing 4 * writesize bytes to a device with 2 * writesize bytes
 155          * buffer the MTD driver can (but doesn't have to) do 2 writesize
 156          * operations, but not 4. Currently, all NANDs have writebufsize
 157          * equivalent to writesize (NAND page size). Some NOR flashes do have
 158          * writebufsize greater than writesize.
 159          */
 160         uint32_t writebufsize;
 161
 162         uint32_t oobsize;   // Amount of OOB data per block (e.g. 16)
 163         uint32_t oobavail;  // Available OOB bytes per block
 164
 165         /*
 166          * If erasesize is a power of 2 then the shift is stored in
 167          * erasesize_shift otherwise erasesize_shift is zero. Ditto writesize.
 168          */
 169         unsigned int erasesize_shift;
 170         unsigned int writesize_shift;
 171         /* Masks based on erasesize_shift and writesize_shift */
 172         unsigned int erasesize_mask;
 173         unsigned int writesize_mask;
 174
 175         /*
 176          * read ops return -EUCLEAN if max number of bitflips corrected on any
 177          * one region comprising an ecc step equals or exceeds this value.
 178          * Settable by driver, else defaults to ecc_strength.  User can override
 179          * in sysfs.  N.B. The meaning of the -EUCLEAN return code has changed;
 180          * see Documentation/ABI/testing/sysfs-class-mtd for more detail.
 181          */
 182         unsigned int bitflip_threshold;
 183
 184         // Kernel-only stuff starts here.
 185         const char *name;
 186         int index;
 187
 188         /* ECC layout structure pointer - read only! */
 189         struct nand_ecclayout *ecclayout;
 190
 191         /* max number of correctible bit errors per ecc step */
 192         unsigned int ecc_strength;
 193
 194         /* Data for variable erase regions. If numeraseregions is zero,
 195          * it means that the whole device has erasesize as given above.
 196          */
 197         int numeraseregions;
 198         struct mtd_erase_region_info *eraseregions;
 199
 200         /*
 201          * Do not call via these pointers, use corresponding mtd_*()
 202          * wrappers instead.
 203          */
 204         int (*_erase) (struct mtd_info *mtd, struct erase_info *instr);
 205         int (*_point) (struct mtd_info *mtd, loff_t from, size_t len,
 206                        size_t *retlen, void **virt, resource_size_t *phys);
 207         int (*_unpoint) (struct mtd_info *mtd, loff_t from, size_t len);
 208         unsigned long (*_get_unmapped_area) (struct mtd_info *mtd,
 209                                              unsigned long len,
 210                                              unsigned long offset,
 211                                              unsigned long flags);
 212         int (*_read) (struct mtd_info *mtd, loff_t from, size_t len,
 213                       size_t *retlen, u_char *buf);
 214         int (*_write) (struct mtd_info *mtd, loff_t to, size_t len,
 215                        size_t *retlen, const u_char *buf);
 216         int (*_panic_write) (struct mtd_info *mtd, loff_t to, size_t len,
 217                              size_t *retlen, const u_char *buf);
 218         int (*_read_oob) (struct mtd_info *mtd, loff_t from,
 219                           struct mtd_oob_ops *ops);
 220         int (*_write_oob) (struct mtd_info *mtd, loff_t to,
 221                            struct mtd_oob_ops *ops);
 222         int (*_get_fact_prot_info) (struct mtd_info *mtd, struct otp_info *buf,
 223                                     size_t len);
 224         int (*_read_fact_prot_reg) (struct mtd_info *mtd, loff_t from,
 225                                     size_t len, size_t *retlen, u_char *buf);
 226         int (*_get_user_prot_info) (struct mtd_info *mtd, struct otp_info *buf,
 227                                     size_t len);
 228         int (*_read_user_prot_reg) (struct mtd_info *mtd, loff_t from,
 229                                     size_t len, size_t *retlen, u_char *buf);
 230         int (*_write_user_prot_reg) (struct mtd_info *mtd, loff_t to,
 231                                      size_t len, size_t *retlen, u_char *buf);
 232         int (*_lock_user_prot_reg) (struct mtd_info *mtd, loff_t from,
 233                                     size_t len);
 234         int (*_writev) (struct mtd_info *mtd, const struct kvec *vecs,
 235                         unsigned long count, loff_t to, size_t *retlen);
 236         void (*_sync) (struct mtd_info *mtd);
 237         int (*_lock) (struct mtd_info *mtd, loff_t ofs, uint64_t len);
 238         int (*_unlock) (struct mtd_info *mtd, loff_t ofs, uint64_t len);
 239         int (*_is_locked) (struct mtd_info *mtd, loff_t ofs, uint64_t len);
 240         int (*_block_isbad) (struct mtd_info *mtd, loff_t ofs);
 241         int (*_block_markbad) (struct mtd_info *mtd, loff_t ofs);
 242         int (*_suspend) (struct mtd_info *mtd);
 243         void (*_resume) (struct mtd_info *mtd);
 244         /*
 245          * If the driver is something smart, like UBI, it may need to maintain
 246          * its own reference counting. The below functions are only for driver.
 247          */
 248         int (*_get_device) (struct mtd_info *mtd);
 249         void (*_put_device) (struct mtd_info *mtd);
 250
 251         /* Backing device capabilities for this device
 252          * - provides mmap capabilities
 253          */
 254         struct backing_dev_info *backing_dev_info;
 255
 256         struct notifier_block reboot_notifier;  /* default mode before reboot */
 257
 258         /* ECC status information */
 259         struct mtd_ecc_stats ecc_stats;
 260         /* Subpage shift (NAND) */
 261         int subpage_sft;
 262
 263         void *priv;
 264
 265         struct module *owner;
 266         struct device dev;
 267         int usecount;
 268 };
 269
 270 int mtd_erase(struct mtd_info *mtd, struct erase_info *instr);
 271 int mtd_point(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen,
 272               void **virt, resource_size_t *phys);
 273 int mtd_unpoint(struct mtd_info *mtd, loff_t from, size_t len);
 274 unsigned long mtd_get_unmapped_area(struct mtd_info *mtd, unsigned long len,
 275                                     unsigned long offset, unsigned long flags);
 276 int mtd_read(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen,
 277              u_char *buf);
 278 int mtd_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen,
 279               const u_char *buf);
 280 int mtd_panic_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen,
 281                     const u_char *buf);
 282
 283 int mtd_read_oob(struct mtd_info *mtd, loff_t from, struct mtd_oob_ops *ops);
 284
 285 static inline int mtd_write_oob(struct mtd_info *mtd, loff_t to,
 286                                 struct mtd_oob_ops *ops)
 287 {
 288         ops->retlen = ops->oobretlen = 0;
 289         if (!mtd->_write_oob)
 290                 return -EOPNOTSUPP;
 291         if (!(mtd->flags & MTD_WRITEABLE))
 292                 return -EROFS;
 293         return mtd->_write_oob(mtd, to, ops);
 294 }
 295
 296 int mtd_get_fact_prot_info(struct mtd_info *mtd, struct otp_info *buf,
 297                            size_t len);
 298 int mtd_read_fact_prot_reg(struct mtd_info *mtd, loff_t from, size_t len,
 299                            size_t *retlen, u_char *buf);
 300 int mtd_get_user_prot_info(struct mtd_info *mtd, struct otp_info *buf,
 301                            size_t len);
 302 int mtd_read_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len,
 303                            size_t *retlen, u_char *buf);
 304 int mtd_write_user_prot_reg(struct mtd_info *mtd, loff_t to, size_t len,
 305                             size_t *retlen, u_char *buf);
 306 int mtd_lock_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len);
 307
 308 int mtd_writev(struct mtd_info *mtd, const struct kvec *vecs,
 309                unsigned long count, loff_t to, size_t *retlen);
 310
 311 static inline void mtd_sync(struct mtd_info *mtd)
 312 {
 313         if (mtd->_sync)
 314                 mtd->_sync(mtd);
 315 }
 316
 317 int mtd_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len);
 318 int mtd_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len);
 319 int mtd_is_locked(struct mtd_info *mtd, loff_t ofs, uint64_t len);
 320 int mtd_block_isbad(struct mtd_info *mtd, loff_t ofs);
 321 int mtd_block_markbad(struct mtd_info *mtd, loff_t ofs);
 322
 323 static inline int mtd_suspend(struct mtd_info *mtd)
 324 {
 325         return mtd->_suspend ? mtd->_suspend(mtd) : 0;
 326 }
 327
 328 static inline void mtd_resume(struct mtd_info *mtd)
 329 {
 330         if (mtd->_resume)
 331                 mtd->_resume(mtd);
 332 }
 333
 334 static inline uint32_t mtd_div_by_eb(uint64_t sz, struct mtd_info *mtd)
 335 {
 336         if (mtd->erasesize_shift)
 337                 return sz >> mtd->erasesize_shift;
 338         do_div(sz, mtd->erasesize);
 339         return sz;
 340 }
 341
 342 static inline uint32_t mtd_mod_by_eb(uint64_t sz, struct mtd_info *mtd)
 343 {
 344         if (mtd->erasesize_shift)
 345                 return sz & mtd->erasesize_mask;
 346         return do_div(sz, mtd->erasesize);
 347 }
 348
 349 static inline uint32_t mtd_div_by_ws(uint64_t sz, struct mtd_info *mtd)
 350 {
 351         if (mtd->writesize_shift)
 352                 return sz >> mtd->writesize_shift;
 353         do_div(sz, mtd->writesize);
 354         return sz;
 355 }
 356
 357 static inline uint32_t mtd_mod_by_ws(uint64_t sz, struct mtd_info *mtd)
 358 {
 359         if (mtd->writesize_shift)
 360                 return sz & mtd->writesize_mask;
 361         return do_div(sz, mtd->writesize);
 362 }
 363
 364 static inline int mtd_has_oob(const struct mtd_info *mtd)
 365 {
 366         return mtd->_read_oob && mtd->_write_oob;
 367 }
 368
 369 static inline int mtd_can_have_bb(const struct mtd_info *mtd)
 370 {
 371         return !!mtd->_block_isbad;
 372 }
 373
 374         /* Kernel-side ioctl definitions */
 375
 376 struct mtd_partition;
 377 struct mtd_part_parser_data;
 378
 379 extern int mtd_device_parse_register(struct mtd_info *mtd,
 380                                      const char * const *part_probe_types,
 381                                      struct mtd_part_parser_data *parser_data,
 382                                      const struct mtd_partition *defparts,
 383                                      int defnr_parts);
 384 #define mtd_device_register(master, parts, nr_parts)    \
 385         mtd_device_parse_register(master, NULL, NULL, parts, nr_parts)
 386 extern int mtd_device_unregister(struct mtd_info *master);
 387 extern struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num);
 388 extern int __get_mtd_device(struct mtd_info *mtd);
 389 extern void __put_mtd_device(struct mtd_info *mtd);
 390 extern struct mtd_info *get_mtd_device_nm(const char *name);
 391 extern void put_mtd_device(struct mtd_info *mtd);
 392
 393
 394 struct mtd_notifier {
 395         void (*add)(struct mtd_info *mtd);
 396         void (*remove)(struct mtd_info *mtd);
 397         struct list_head list;
 398 };
 399
 400
 401 extern void register_mtd_user (struct mtd_notifier *new);
 402 extern int unregister_mtd_user (struct mtd_notifier *old);
 403 void *mtd_kmalloc_up_to(const struct mtd_info *mtd, size_t *size);
 404
 405 void mtd_erase_callback(struct erase_info *instr);
 406
 407 static inline int mtd_is_bitflip(int err) {
 408         return err == -EUCLEAN;
 409 }
 410
 411 static inline int mtd_is_eccerr(int err) {
 412         return err == -EBADMSG;
 413 }
 414
 415 static inline int mtd_is_bitflip_or_eccerr(int err) {
 416         return mtd_is_bitflip(err) || mtd_is_eccerr(err);
 417 }
 418
 419 #endif /* __MTD_MTD_H__ */