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