1 /* 2 * $Id: mtd.h,v 1.59 2005/04/11 10:19:02 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 // Kernel-only stuff starts here. 78 char *name; 79 int index; 80 81 // oobinfo is a nand_oobinfo structure, which can be set by iotcl (MEMSETOOBINFO) 82 struct nand_oobinfo oobinfo; 83 u_int32_t oobavail; // Number of bytes in OOB area available for fs 84 85 /* Data for variable erase regions. If numeraseregions is zero, 86 * it means that the whole device has erasesize as given above. 87 */ 88 int numeraseregions; 89 struct mtd_erase_region_info *eraseregions; 90 91 /* This really shouldn't be here. It can go away in 2.5 */ 92 u_int32_t bank_size; 93 94 int (*erase) (struct mtd_info *mtd, struct erase_info *instr); 95 96 /* This stuff for eXecute-In-Place */ 97 int (*point) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char **mtdbuf); 98 99 /* We probably shouldn't allow XIP if the unpoint isn't a NULL */ 100 void (*unpoint) (struct mtd_info *mtd, u_char * addr, loff_t from, size_t len); 101 102 103 int (*read) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf); 104 int (*write) (struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf); 105 106 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); 107 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); 108 109 int (*read_oob) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf); 110 int (*write_oob) (struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf); 111 112 /* 113 * Methods to access the protection register area, present in some 114 * flash devices. The user data is one time programmable but the 115 * factory data is read only. 116 */ 117 int (*get_fact_prot_info) (struct mtd_info *mtd, struct otp_info *buf, size_t len); 118 int (*read_fact_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf); 119 int (*get_user_prot_info) (struct mtd_info *mtd, struct otp_info *buf, size_t len); 120 int (*read_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf); 121 int (*write_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf); 122 int (*lock_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len); 123 124 /* kvec-based read/write methods. We need these especially for NAND flash, 125 with its limited number of write cycles per erase. 126 NB: The 'count' parameter is the number of _vectors_, each of 127 which contains an (ofs, len) tuple. 128 */ 129 int (*readv) (struct mtd_info *mtd, struct kvec *vecs, unsigned long count, loff_t from, size_t *retlen); 130 int (*readv_ecc) (struct mtd_info *mtd, struct kvec *vecs, unsigned long count, loff_t from, 131 size_t *retlen, u_char *eccbuf, struct nand_oobinfo *oobsel); 132 int (*writev) (struct mtd_info *mtd, const struct kvec *vecs, unsigned long count, loff_t to, size_t *retlen); 133 int (*writev_ecc) (struct mtd_info *mtd, const struct kvec *vecs, unsigned long count, loff_t to, 134 size_t *retlen, u_char *eccbuf, struct nand_oobinfo *oobsel); 135 136 /* Sync */ 137 void (*sync) (struct mtd_info *mtd); 138 139 /* Chip-supported device locking */ 140 int (*lock) (struct mtd_info *mtd, loff_t ofs, size_t len); 141 int (*unlock) (struct mtd_info *mtd, loff_t ofs, size_t len); 142 143 /* Power Management functions */ 144 int (*suspend) (struct mtd_info *mtd); 145 void (*resume) (struct mtd_info *mtd); 146 147 /* Bad block management functions */ 148 int (*block_isbad) (struct mtd_info *mtd, loff_t ofs); 149 int (*block_markbad) (struct mtd_info *mtd, loff_t ofs); 150 151 struct notifier_block reboot_notifier; /* default mode before reboot */ 152 153 void *priv; 154 155 struct module *owner; 156 int usecount; 157 }; 158 159 160 /* Kernel-side ioctl definitions */ 161 162 extern int add_mtd_device(struct mtd_info *mtd); 163 extern int del_mtd_device (struct mtd_info *mtd); 164 165 extern struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num); 166 167 extern void put_mtd_device(struct mtd_info *mtd); 168 169 170 struct mtd_notifier { 171 void (*add)(struct mtd_info *mtd); 172 void (*remove)(struct mtd_info *mtd); 173 struct list_head list; 174 }; 175 176 177 extern void register_mtd_user (struct mtd_notifier *new); 178 extern int unregister_mtd_user (struct mtd_notifier *old); 179 180 int default_mtd_writev(struct mtd_info *mtd, const struct kvec *vecs, 181 unsigned long count, loff_t to, size_t *retlen); 182 183 int default_mtd_readv(struct mtd_info *mtd, struct kvec *vecs, 184 unsigned long count, loff_t from, size_t *retlen); 185 186 #define MTD_ERASE(mtd, args...) (*(mtd->erase))(mtd, args) 187 #define MTD_POINT(mtd, a,b,c,d) (*(mtd->point))(mtd, a,b,c, (u_char **)(d)) 188 #define MTD_UNPOINT(mtd, arg) (*(mtd->unpoint))(mtd, (u_char *)arg) 189 #define MTD_READ(mtd, args...) (*(mtd->read))(mtd, args) 190 #define MTD_WRITE(mtd, args...) (*(mtd->write))(mtd, args) 191 #define MTD_READV(mtd, args...) (*(mtd->readv))(mtd, args) 192 #define MTD_WRITEV(mtd, args...) (*(mtd->writev))(mtd, args) 193 #define MTD_READECC(mtd, args...) (*(mtd->read_ecc))(mtd, args) 194 #define MTD_WRITEECC(mtd, args...) (*(mtd->write_ecc))(mtd, args) 195 #define MTD_READOOB(mtd, args...) (*(mtd->read_oob))(mtd, args) 196 #define MTD_WRITEOOB(mtd, args...) (*(mtd->write_oob))(mtd, args) 197 #define MTD_SYNC(mtd) do { if (mtd->sync) (*(mtd->sync))(mtd); } while (0) 198 199 200 #ifdef CONFIG_MTD_PARTITIONS 201 void mtd_erase_callback(struct erase_info *instr); 202 #else 203 static inline void mtd_erase_callback(struct erase_info *instr) 204 { 205 if (instr->callback) 206 instr->callback(instr); 207 } 208 #endif 209 210 /* 211 * Debugging macro and defines 212 */ 213 #define MTD_DEBUG_LEVEL0 (0) /* Quiet */ 214 #define MTD_DEBUG_LEVEL1 (1) /* Audible */ 215 #define MTD_DEBUG_LEVEL2 (2) /* Loud */ 216 #define MTD_DEBUG_LEVEL3 (3) /* Noisy */ 217 218 #ifdef CONFIG_MTD_DEBUG 219 #define DEBUG(n, args...) \ 220 do { \ 221 if (n <= CONFIG_MTD_DEBUG_VERBOSE) \ 222 printk(KERN_INFO args); \ 223 } while(0) 224 #else /* CONFIG_MTD_DEBUG */ 225 #define DEBUG(n, args...) do { } while(0) 226 227 #endif /* CONFIG_MTD_DEBUG */ 228 229 #endif /* __MTD_MTD_H__ */ 230