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  * oob operation modes
  61  *
  62  * MTD_OOB_PLACE:       oob data are placed at the given offset
  63  * MTD_OOB_AUTO:        oob data are automatically placed at the free areas
  64  *                      which are defined by the ecclayout
  65  * MTD_OOB_RAW:         mode to read raw data+oob in one chunk. The oob data
  66  *                      is inserted into the data. Thats a raw image of the
  67  *                      flash contents.
  68  */
  69 typedef enum {
  70         MTD_OOB_PLACE,
  71         MTD_OOB_AUTO,
  72         MTD_OOB_RAW,
  73 } mtd_oob_mode_t;
  74
  75 /**
  76  * struct mtd_oob_ops - oob operation operands
  77  * @mode:       operation mode
  78  *
  79  * @len:        number of bytes to write/read. When a data buffer is given
  80  *              (datbuf != NULL) this is the number of data bytes. When
  81  +              no data buffer is available this is the number of oob bytes.
  82  *
  83  * @retlen:     number of bytes written/read. When a data buffer is given
  84  *              (datbuf != NULL) this is the number of data bytes. When
  85  +              no data buffer is available this is the number of oob bytes.
  86  *
  87  * @ooblen:     number of oob bytes per page
  88  * @ooboffs:    offset of oob data in the oob area (only relevant when
  89  *              mode = MTD_OOB_PLACE)
  90  * @datbuf:     data buffer - if NULL only oob data are read/written
  91  * @oobbuf:     oob data buffer
  92  */
  93 struct mtd_oob_ops {
  94         mtd_oob_mode_t  mode;
  95         size_t          len;
  96         size_t          retlen;
  97         size_t          ooblen;
  98         uint32_t        ooboffs;
  99         uint8_t         *datbuf;
 100         uint8_t         *oobbuf;
 101 };
 102
 103 struct mtd_info {
 104         u_char type;
 105         u_int32_t flags;
 106         u_int32_t size;  // Total size of the MTD
 107
 108         /* "Major" erase size for the device. Naïve users may take this
 109          * to be the only erase size available, or may use the more detailed
 110          * information below if they desire
 111          */
 112         u_int32_t erasesize;
 113         /* Minimal writable flash unit size. In case of NOR flash it is 1 (even
 114          * though individual bits can be cleared), in case of NAND flash it is
 115          * one NAND page (or half, or one-fourths of it), in case of ECC-ed NOR
 116          * it is of ECC block size, etc. It is illegal to have writesize = 0.
 117          * Any driver registering a struct mtd_info must ensure a writesize of
 118          * 1 or larger.
 119          */
 120         u_int32_t writesize;
 121
 122         u_int32_t oobsize;   // Amount of OOB data per block (e.g. 16)
 123         u_int32_t ecctype;
 124         u_int32_t eccsize;
 125
 126         /*
 127          * Reuse some of the above unused fields in the case of NOR flash
 128          * with configurable programming regions to avoid modifying the
 129          * user visible structure layout/size.  Only valid when the
 130          * MTD_PROGRAM_REGIONS flag is set.
 131          * (Maybe we should have an union for those?)
 132          */
 133 #define MTD_PROGREGION_CTRLMODE_VALID(mtd)  (mtd)->oobsize
 134 #define MTD_PROGREGION_CTRLMODE_INVALID(mtd)  (mtd)->ecctype
 135
 136         // Kernel-only stuff starts here.
 137         char *name;
 138         int index;
 139
 140         /* ecc layout structure pointer - read only ! */
 141         struct nand_ecclayout *ecclayout;
 142
 143         /* Data for variable erase regions. If numeraseregions is zero,
 144          * it means that the whole device has erasesize as given above.
 145          */
 146         int numeraseregions;
 147         struct mtd_erase_region_info *eraseregions;
 148
 149         /* This really shouldn't be here. It can go away in 2.5 */
 150         u_int32_t bank_size;
 151
 152         int (*erase) (struct mtd_info *mtd, struct erase_info *instr);
 153
 154         /* This stuff for eXecute-In-Place */
 155         int (*point) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char **mtdbuf);
 156
 157         /* We probably shouldn't allow XIP if the unpoint isn't a NULL */
 158         void (*unpoint) (struct mtd_info *mtd, u_char * addr, loff_t from, size_t len);
 159
 160
 161         int (*read) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
 162         int (*write) (struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf);
 163
 164         int (*read_oob) (struct mtd_info *mtd, loff_t from,
 165                          struct mtd_oob_ops *ops);
 166         int (*write_oob) (struct mtd_info *mtd, loff_t to,
 167                          struct mtd_oob_ops *ops);
 168
 169         /*
 170          * Methods to access the protection register area, present in some
 171          * flash devices. The user data is one time programmable but the
 172          * factory data is read only.
 173          */
 174         int (*get_fact_prot_info) (struct mtd_info *mtd, struct otp_info *buf, size_t len);
 175         int (*read_fact_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
 176         int (*get_user_prot_info) (struct mtd_info *mtd, struct otp_info *buf, size_t len);
 177         int (*read_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
 178         int (*write_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
 179         int (*lock_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len);
 180
 181         /* kvec-based read/write methods.
 182            NB: The 'count' parameter is the number of _vectors_, each of
 183            which contains an (ofs, len) tuple.
 184         */
 185         int (*writev) (struct mtd_info *mtd, const struct kvec *vecs, unsigned long count, loff_t to, size_t *retlen);
 186
 187         /* Sync */
 188         void (*sync) (struct mtd_info *mtd);
 189
 190         /* Chip-supported device locking */
 191         int (*lock) (struct mtd_info *mtd, loff_t ofs, size_t len);
 192         int (*unlock) (struct mtd_info *mtd, loff_t ofs, size_t len);
 193
 194         /* Power Management functions */
 195         int (*suspend) (struct mtd_info *mtd);
 196         void (*resume) (struct mtd_info *mtd);
 197
 198         /* Bad block management functions */
 199         int (*block_isbad) (struct mtd_info *mtd, loff_t ofs);
 200         int (*block_markbad) (struct mtd_info *mtd, loff_t ofs);
 201
 202         struct notifier_block reboot_notifier;  /* default mode before reboot */
 203
 204         /* ECC status information */
 205         struct mtd_ecc_stats ecc_stats;
 206
 207         void *priv;
 208
 209         struct module *owner;
 210         int usecount;
 211 };
 212
 213
 214         /* Kernel-side ioctl definitions */
 215
 216 extern int add_mtd_device(struct mtd_info *mtd);
 217 extern int del_mtd_device (struct mtd_info *mtd);
 218
 219 extern struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num);
 220
 221 extern void put_mtd_device(struct mtd_info *mtd);
 222
 223
 224 struct mtd_notifier {
 225         void (*add)(struct mtd_info *mtd);
 226         void (*remove)(struct mtd_info *mtd);
 227         struct list_head list;
 228 };
 229
 230
 231 extern void register_mtd_user (struct mtd_notifier *new);
 232 extern int unregister_mtd_user (struct mtd_notifier *old);
 233
 234 int default_mtd_writev(struct mtd_info *mtd, const struct kvec *vecs,
 235                        unsigned long count, loff_t to, size_t *retlen);
 236
 237 int default_mtd_readv(struct mtd_info *mtd, struct kvec *vecs,
 238                       unsigned long count, loff_t from, size_t *retlen);
 239
 240 #ifdef CONFIG_MTD_PARTITIONS
 241 void mtd_erase_callback(struct erase_info *instr);
 242 #else
 243 static inline void mtd_erase_callback(struct erase_info *instr)
 244 {
 245         if (instr->callback)
 246                 instr->callback(instr);
 247 }
 248 #endif
 249
 250 /*
 251  * Debugging macro and defines
 252  */
 253 #define MTD_DEBUG_LEVEL0        (0)     /* Quiet   */
 254 #define MTD_DEBUG_LEVEL1        (1)     /* Audible */
 255 #define MTD_DEBUG_LEVEL2        (2)     /* Loud    */
 256 #define MTD_DEBUG_LEVEL3        (3)     /* Noisy   */
 257
 258 #ifdef CONFIG_MTD_DEBUG
 259 #define DEBUG(n, args...)                               \
 260         do {                                            \
 261                 if (n <= CONFIG_MTD_DEBUG_VERBOSE)      \
 262                         printk(KERN_INFO args);         \
 263         } while(0)
 264 #else /* CONFIG_MTD_DEBUG */
 265 #define DEBUG(n, args...) do { } while(0)
 266
 267 #endif /* CONFIG_MTD_DEBUG */
 268
 269 #endif /* __MTD_MTD_H__ */