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/config.h>
  17 #include <linux/version.h>
  18 #include <linux/types.h>
  19 #include <linux/module.h>
  20 #include <linux/uio.h>
  21 #include <linux/notifier.h>
  22
  23 #include <linux/mtd/compatmac.h>
  24 #include <mtd/mtd-abi.h>
  25
  26 #define MTD_CHAR_MAJOR 90
  27 #define MTD_BLOCK_MAJOR 31
  28 #define MAX_MTD_DEVICES 16
  29
  30 #define MTD_ERASE_PENDING       0x01
  31 #define MTD_ERASING             0x02
  32 #define MTD_ERASE_SUSPEND       0x04
  33 #define MTD_ERASE_DONE          0x08
  34 #define MTD_ERASE_FAILED        0x10
  35
  36 /* If the erase fails, fail_addr might indicate exactly which block failed.  If
  37    fail_addr = 0xffffffff, the failure was not at the device level or was not
  38    specific to any particular block. */
  39 struct erase_info {
  40         struct mtd_info *mtd;
  41         u_int32_t addr;
  42         u_int32_t len;
  43         u_int32_t fail_addr;
  44         u_long time;
  45         u_long retries;
  46         u_int dev;
  47         u_int cell;
  48         void (*callback) (struct erase_info *self);
  49         u_long priv;
  50         u_char state;
  51         struct erase_info *next;
  52 };
  53
  54 struct mtd_erase_region_info {
  55         u_int32_t offset;                       /* At which this region starts, from the beginning of the MTD */
  56         u_int32_t erasesize;            /* For this region */
  57         u_int32_t numblocks;            /* Number of blocks of erasesize in this region */
  58 };
  59
  60 struct mtd_info {
  61         u_char type;
  62         u_int32_t flags;
  63         u_int32_t size;  // Total size of the MTD
  64
  65         /* "Major" erase size for the device. Naïve users may take this
  66          * to be the only erase size available, or may use the more detailed
  67          * information below if they desire
  68          */
  69         u_int32_t erasesize;
  70
  71         u_int32_t oobblock;  // Size of OOB blocks (e.g. 512)
  72         u_int32_t oobsize;   // Amount of OOB data per block (e.g. 16)
  73         u_int32_t ecctype;
  74         u_int32_t eccsize;
  75
  76         /*
  77          * Reuse some of the above unused fields in the case of NOR flash
  78          * with configurable programming regions to avoid modifying the
  79          * user visible structure layout/size.  Only valid when the
  80          * MTD_PROGRAM_REGIONS flag is set.
  81          * (Maybe we should have an union for those?)
  82          */
  83 #define MTD_PROGREGION_SIZE(mtd)  (mtd)->oobblock
  84 #define MTD_PROGREGION_CTRLMODE_VALID(mtd)  (mtd)->oobsize
  85 #define MTD_PROGREGION_CTRLMODE_INVALID(mtd)  (mtd)->ecctype
  86
  87         // Kernel-only stuff starts here.
  88         char *name;
  89         int index;
  90
  91         // oobinfo is a nand_oobinfo structure, which can be set by iotcl (MEMSETOOBINFO)
  92         struct nand_oobinfo oobinfo;
  93         u_int32_t oobavail;  // Number of bytes in OOB area available for fs
  94
  95         /* Data for variable erase regions. If numeraseregions is zero,
  96          * it means that the whole device has erasesize as given above.
  97          */
  98         int numeraseregions;
  99         struct mtd_erase_region_info *eraseregions;
 100
 101         /* This really shouldn't be here. It can go away in 2.5 */
 102         u_int32_t bank_size;
 103
 104         int (*erase) (struct mtd_info *mtd, struct erase_info *instr);
 105
 106         /* This stuff for eXecute-In-Place */
 107         int (*point) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char **mtdbuf);
 108
 109         /* We probably shouldn't allow XIP if the unpoint isn't a NULL */
 110         void (*unpoint) (struct mtd_info *mtd, u_char * addr, loff_t from, size_t len);
 111
 112
 113         int (*read) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
 114         int (*write) (struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf);
 115
 116         int (*read_ecc) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf, u_char *eccbuf, struct nand_oobinfo *oobsel);
 117         int (*write_ecc) (struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf, u_char *eccbuf, struct nand_oobinfo *oobsel);
 118
 119         int (*read_oob) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
 120         int (*write_oob) (struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf);
 121
 122         /*
 123          * Methods to access the protection register area, present in some
 124          * flash devices. The user data is one time programmable but the
 125          * factory data is read only.
 126          */
 127         int (*get_fact_prot_info) (struct mtd_info *mtd, struct otp_info *buf, size_t len);
 128         int (*read_fact_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
 129         int (*get_user_prot_info) (struct mtd_info *mtd, struct otp_info *buf, size_t len);
 130         int (*read_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
 131         int (*write_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
 132         int (*lock_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len);
 133
 134         /* kvec-based read/write methods. We need these especially for NAND flash,
 135            with its limited number of write cycles per erase.
 136            NB: The 'count' parameter is the number of _vectors_, each of
 137            which contains an (ofs, len) tuple.
 138         */
 139         int (*readv) (struct mtd_info *mtd, struct kvec *vecs, unsigned long count, loff_t from, size_t *retlen);
 140         int (*readv_ecc) (struct mtd_info *mtd, struct kvec *vecs, unsigned long count, loff_t from,
 141                 size_t *retlen, u_char *eccbuf, struct nand_oobinfo *oobsel);
 142         int (*writev) (struct mtd_info *mtd, const struct kvec *vecs, unsigned long count, loff_t to, size_t *retlen);
 143         int (*writev_ecc) (struct mtd_info *mtd, const struct kvec *vecs, unsigned long count, loff_t to,
 144                 size_t *retlen, u_char *eccbuf, struct nand_oobinfo *oobsel);
 145
 146         /* Sync */
 147         void (*sync) (struct mtd_info *mtd);
 148
 149         /* Chip-supported device locking */
 150         int (*lock) (struct mtd_info *mtd, loff_t ofs, size_t len);
 151         int (*unlock) (struct mtd_info *mtd, loff_t ofs, size_t len);
 152
 153         /* Power Management functions */
 154         int (*suspend) (struct mtd_info *mtd);
 155         void (*resume) (struct mtd_info *mtd);
 156
 157         /* Bad block management functions */
 158         int (*block_isbad) (struct mtd_info *mtd, loff_t ofs);
 159         int (*block_markbad) (struct mtd_info *mtd, loff_t ofs);
 160
 161         struct notifier_block reboot_notifier;  /* default mode before reboot */
 162
 163         void *priv;
 164
 165         struct module *owner;
 166         int usecount;
 167 };
 168
 169
 170         /* Kernel-side ioctl definitions */
 171
 172 extern int add_mtd_device(struct mtd_info *mtd);
 173 extern int del_mtd_device (struct mtd_info *mtd);
 174
 175 extern struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num);
 176
 177 extern void put_mtd_device(struct mtd_info *mtd);
 178
 179
 180 struct mtd_notifier {
 181         void (*add)(struct mtd_info *mtd);
 182         void (*remove)(struct mtd_info *mtd);
 183         struct list_head list;
 184 };
 185
 186
 187 extern void register_mtd_user (struct mtd_notifier *new);
 188 extern int unregister_mtd_user (struct mtd_notifier *old);
 189
 190 int default_mtd_writev(struct mtd_info *mtd, const struct kvec *vecs,
 191                        unsigned long count, loff_t to, size_t *retlen);
 192
 193 int default_mtd_readv(struct mtd_info *mtd, struct kvec *vecs,
 194                       unsigned long count, loff_t from, size_t *retlen);
 195
 196 #define MTD_ERASE(mtd, args...) (*(mtd->erase))(mtd, args)
 197 #define MTD_POINT(mtd, a,b,c,d) (*(mtd->point))(mtd, a,b,c, (u_char **)(d))
 198 #define MTD_UNPOINT(mtd, arg) (*(mtd->unpoint))(mtd, (u_char *)arg)
 199 #define MTD_READ(mtd, args...) (*(mtd->read))(mtd, args)
 200 #define MTD_WRITE(mtd, args...) (*(mtd->write))(mtd, args)
 201 #define MTD_READV(mtd, args...) (*(mtd->readv))(mtd, args)
 202 #define MTD_WRITEV(mtd, args...) (*(mtd->writev))(mtd, args)
 203 #define MTD_READECC(mtd, args...) (*(mtd->read_ecc))(mtd, args)
 204 #define MTD_WRITEECC(mtd, args...) (*(mtd->write_ecc))(mtd, args)
 205 #define MTD_READOOB(mtd, args...) (*(mtd->read_oob))(mtd, args)
 206 #define MTD_WRITEOOB(mtd, args...) (*(mtd->write_oob))(mtd, args)
 207 #define MTD_SYNC(mtd) do { if (mtd->sync) (*(mtd->sync))(mtd);  } while (0)
 208
 209
 210 #ifdef CONFIG_MTD_PARTITIONS
 211 void mtd_erase_callback(struct erase_info *instr);
 212 #else
 213 static inline void mtd_erase_callback(struct erase_info *instr)
 214 {
 215         if (instr->callback)
 216                 instr->callback(instr);
 217 }
 218 #endif
 219
 220 /*
 221  * Debugging macro and defines
 222  */
 223 #define MTD_DEBUG_LEVEL0        (0)     /* Quiet   */
 224 #define MTD_DEBUG_LEVEL1        (1)     /* Audible */
 225 #define MTD_DEBUG_LEVEL2        (2)     /* Loud    */
 226 #define MTD_DEBUG_LEVEL3        (3)     /* Noisy   */
 227
 228 #ifdef CONFIG_MTD_DEBUG
 229 #define DEBUG(n, args...)                               \
 230         do {                                            \
 231                 if (n <= CONFIG_MTD_DEBUG_VERBOSE)      \
 232                         printk(KERN_INFO args);         \
 233         } while(0)
 234 #else /* CONFIG_MTD_DEBUG */
 235 #define DEBUG(n, args...) do { } while(0)
 236
 237 #endif /* CONFIG_MTD_DEBUG */
 238
 239 #endif /* __MTD_MTD_H__ */