include/linux/mtd/mtd.h

   1 /*
   2  * Copyright (C) 1999-2003 David Woodhouse <dwmw2@infradead.org> et al.
   3  *
   4  * Released under GPL
   5  */
   6
   7 #ifndef __MTD_MTD_H__
   8 #define __MTD_MTD_H__
   9
  10 #include <linux/types.h>
  11 #include <linux/mtd/mtd-abi.h>
  12
  13 #define MTD_CHAR_MAJOR 90
  14 #define MTD_BLOCK_MAJOR 31
  15 #define MAX_MTD_DEVICES 32
  16
  17 #define MTD_ERASE_PENDING       0x01
  18 #define MTD_ERASING             0x02
  19 #define MTD_ERASE_SUSPEND       0x04
  20 #define MTD_ERASE_DONE          0x08
  21 #define MTD_ERASE_FAILED        0x10
  22
  23 /*
  24  * Enumeration for NAND/OneNAND flash chip state
  25  */
  26 enum {
  27         FL_READY,
  28         FL_READING,
  29         FL_WRITING,
  30         FL_ERASING,
  31         FL_SYNCING,
  32         FL_CACHEDPRG,
  33         FL_RESETING,
  34         FL_UNLOCKING,
  35         FL_LOCKING,
  36         FL_PM_SUSPENDED,
  37 };
  38
  39 /* If the erase fails, fail_addr might indicate exactly which block failed.  If
  40    fail_addr = 0xffffffff, the failure was not at the device level or was not
  41    specific to any particular block. */
  42 struct erase_info {
  43         struct mtd_info *mtd;
  44         u_int32_t addr;
  45         u_int32_t len;
  46         u_int32_t fail_addr;
  47         u_long time;
  48         u_long retries;
  49         u_int dev;
  50         u_int cell;
  51         void (*callback) (struct erase_info *self);
  52         u_long priv;
  53         u_char state;
  54         struct erase_info *next;
  55 };
  56
  57 struct mtd_erase_region_info {
  58         u_int32_t offset;                       /* At which this region starts, from the beginning of the MTD */
  59         u_int32_t erasesize;            /* For this region */
  60         u_int32_t numblocks;            /* Number of blocks of erasesize in this region */
  61         unsigned long *lockmap;         /* If keeping bitmap of locks */
  62 };
  63
  64 /*
  65  * oob operation modes
  66  *
  67  * MTD_OOB_PLACE:       oob data are placed at the given offset
  68  * MTD_OOB_AUTO:        oob data are automatically placed at the free areas
  69  *                      which are defined by the ecclayout
  70  * MTD_OOB_RAW:         mode to read raw data+oob in one chunk. The oob data
  71  *                      is inserted into the data. Thats a raw image of the
  72  *                      flash contents.
  73  */
  74 typedef enum {
  75         MTD_OOB_PLACE,
  76         MTD_OOB_AUTO,
  77         MTD_OOB_RAW,
  78 } mtd_oob_mode_t;
  79
  80 /**
  81  * struct mtd_oob_ops - oob operation operands
  82  * @mode:       operation mode
  83  *
  84  * @len:        number of data bytes to write/read
  85  *
  86  * @retlen:     number of data bytes written/read
  87  *
  88  * @ooblen:     number of oob bytes to write/read
  89  * @oobretlen:  number of oob bytes written/read
  90  * @ooboffs:    offset of oob data in the oob area (only relevant when
  91  *              mode = MTD_OOB_PLACE)
  92  * @datbuf:     data buffer - if NULL only oob data are read/written
  93  * @oobbuf:     oob data buffer
  94  *
  95  * Note, it is allowed to read more then one OOB area at one go, but not write.
  96  * The interface assumes that the OOB write requests program only one page's
  97  * OOB area.
  98  */
  99 struct mtd_oob_ops {
 100         mtd_oob_mode_t  mode;
 101         size_t          len;
 102         size_t          retlen;
 103         size_t          ooblen;
 104         size_t          oobretlen;
 105         uint32_t        ooboffs;
 106         uint8_t         *datbuf;
 107         uint8_t         *oobbuf;
 108 };
 109
 110 struct mtd_info {
 111         u_char type;
 112         u_int32_t flags;
 113         u_int32_t size;  /* Total size of the MTD */
 114
 115         /* "Major" erase size for the device. Naïve users may take this
 116          * to be the only erase size available, or may use the more detailed
 117          * information below if they desire
 118          */
 119         u_int32_t erasesize;
 120         /* Minimal writable flash unit size. In case of NOR flash it is 1 (even
 121          * though individual bits can be cleared), in case of NAND flash it is
 122          * one NAND page (or half, or one-fourths of it), in case of ECC-ed NOR
 123          * it is of ECC block size, etc. It is illegal to have writesize = 0.
 124          * Any driver registering a struct mtd_info must ensure a writesize of
 125          * 1 or larger.
 126          */
 127         u_int32_t writesize;
 128
 129         u_int32_t oobsize;   /* Amount of OOB data per block (e.g. 16) */
 130         u_int32_t oobavail;  /* Available OOB bytes per block */
 131
 132         /* Kernel-only stuff starts here. */
 133         const char *name;
 134         int index;
 135
 136         /* ecc layout structure pointer - read only ! */
 137         struct nand_ecclayout *ecclayout;
 138
 139         /* Data for variable erase regions. If numeraseregions is zero,
 140          * it means that the whole device has erasesize as given above.
 141          */
 142         int numeraseregions;
 143         struct mtd_erase_region_info *eraseregions;
 144
 145         /*
 146          * Erase is an asynchronous operation.  Device drivers are supposed
 147          * to call instr->callback() whenever the operation completes, even
 148          * if it completes with a failure.
 149          * Callers are supposed to pass a callback function and wait for it
 150          * to be called before writing to the block.
 151          */
 152         int (*erase) (struct mtd_info *mtd, struct erase_info *instr);
 153
 154         /* This stuff for eXecute-In-Place */
 155         /* phys is optional and may be set to NULL */
 156         int (*point) (struct mtd_info *mtd, loff_t from, size_t len,
 157                         size_t *retlen, void **virt, phys_addr_t *phys);
 158
 159         /* We probably shouldn't allow XIP if the unpoint isn't a NULL */
 160         void (*unpoint) (struct mtd_info *mtd, loff_t from, size_t len);
 161
 162
 163         int (*read) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
 164         int (*write) (struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf);
 165
 166         /* In blackbox flight recorder like scenarios we want to make successful
 167            writes in interrupt context. panic_write() is only intended to be
 168            called when its known the kernel is about to panic and we need the
 169            write to succeed. Since the kernel is not going to be running for much
 170            longer, this function can break locks and delay to ensure the write
 171            succeeds (but not sleep). */
 172
 173         int (*panic_write) (struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf);
 174
 175         int (*read_oob) (struct mtd_info *mtd, loff_t from,
 176                          struct mtd_oob_ops *ops);
 177         int (*write_oob) (struct mtd_info *mtd, loff_t to,
 178                          struct mtd_oob_ops *ops);
 179
 180         /*
 181          * Methods to access the protection register area, present in some
 182          * flash devices. The user data is one time programmable but the
 183          * factory data is read only.
 184          */
 185         int (*get_fact_prot_info) (struct mtd_info *mtd, struct otp_info *buf, size_t len);
 186         int (*read_fact_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
 187         int (*get_user_prot_info) (struct mtd_info *mtd, struct otp_info *buf, size_t len);
 188         int (*read_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
 189         int (*write_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
 190         int (*lock_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len);
 191
 192 /* XXX U-BOOT XXX */
 193 #if 0
 194         /* kvec-based read/write methods.
 195            NB: The 'count' parameter is the number of _vectors_, each of
 196            which contains an (ofs, len) tuple.
 197         */
 198         int (*writev) (struct mtd_info *mtd, const struct kvec *vecs, unsigned long count, loff_t to, size_t *retlen);
 199 #endif
 200
 201         /* Sync */
 202         void (*sync) (struct mtd_info *mtd);
 203
 204         /* Chip-supported device locking */
 205         int (*lock) (struct mtd_info *mtd, loff_t ofs, size_t len);
 206         int (*unlock) (struct mtd_info *mtd, loff_t ofs, size_t len);
 207
 208         /* Power Management functions */
 209         int (*suspend) (struct mtd_info *mtd);
 210         void (*resume) (struct mtd_info *mtd);
 211
 212         /* Bad block management functions */
 213         int (*block_isbad) (struct mtd_info *mtd, loff_t ofs);
 214         int (*block_markbad) (struct mtd_info *mtd, loff_t ofs);
 215
 216 /* XXX U-BOOT XXX */
 217 #if 0
 218         struct notifier_block reboot_notifier;  /* default mode before reboot */
 219 #endif
 220
 221         /* ECC status information */
 222         struct mtd_ecc_stats ecc_stats;
 223         /* Subpage shift (NAND) */
 224         int subpage_sft;
 225
 226         void *priv;
 227
 228         struct module *owner;
 229         int usecount;
 230
 231         /* If the driver is something smart, like UBI, it may need to maintain
 232          * its own reference counting. The below functions are only for driver.
 233          * The driver may register its callbacks. These callbacks are not
 234          * supposed to be called by MTD users */
 235         int (*get_device) (struct mtd_info *mtd);
 236         void (*put_device) (struct mtd_info *mtd);
 237 };
 238
 239
 240         /* Kernel-side ioctl definitions */
 241
 242 extern int add_mtd_device(struct mtd_info *mtd);
 243 extern int del_mtd_device (struct mtd_info *mtd);
 244
 245 extern struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num);
 246 extern struct mtd_info *get_mtd_device_nm(const char *name);
 247
 248 extern void put_mtd_device(struct mtd_info *mtd);
 249
 250 /* XXX U-BOOT XXX */
 251 #if 0
 252 struct mtd_notifier {
 253         void (*add)(struct mtd_info *mtd);
 254         void (*remove)(struct mtd_info *mtd);
 255         struct list_head list;
 256 };
 257
 258 extern void register_mtd_user (struct mtd_notifier *new);
 259 extern int unregister_mtd_user (struct mtd_notifier *old);
 260
 261 int default_mtd_writev(struct mtd_info *mtd, const struct kvec *vecs,
 262                        unsigned long count, loff_t to, size_t *retlen);
 263
 264 int default_mtd_readv(struct mtd_info *mtd, struct kvec *vecs,
 265                       unsigned long count, loff_t from, size_t *retlen);
 266 #endif
 267
 268 #ifdef CONFIG_MTD_PARTITIONS
 269 void mtd_erase_callback(struct erase_info *instr);
 270 #else
 271 static inline void mtd_erase_callback(struct erase_info *instr)
 272 {
 273         if (instr->callback)
 274                 instr->callback(instr);
 275 }
 276 #endif
 277
 278 /*
 279  * Debugging macro and defines
 280  */
 281 #define MTD_DEBUG_LEVEL0        (0)     /* Quiet   */
 282 #define MTD_DEBUG_LEVEL1        (1)     /* Audible */
 283 #define MTD_DEBUG_LEVEL2        (2)     /* Loud    */
 284 #define MTD_DEBUG_LEVEL3        (3)     /* Noisy   */
 285
 286 #ifdef CONFIG_MTD_DEBUG
 287 #define MTDDEBUG(n, args...)                            \
 288         do {                                            \
 289                 if (n <= CONFIG_MTD_DEBUG_VERBOSE)      \
 290                         printk(KERN_INFO args);         \
 291         } while(0)
 292 #else /* CONFIG_MTD_DEBUG */
 293 #define MTDDEBUG(n, args...)                            \
 294         do {                                            \
 295                 if (0)                                  \
 296                         printk(KERN_INFO args);         \
 297         } while(0)
 298 #endif /* CONFIG_MTD_DEBUG */
 299
 300 #endif /* __MTD_MTD_H__ */