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