include/linux/mtd/mtd.h

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