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/types.h> 17 #include <linux/module.h> 18 #include <linux/uio.h> 19 #include <linux/notifier.h> 20 21 #include <linux/mtd/compatmac.h> 22 #include <mtd/mtd-abi.h> 23 24 #define MTD_CHAR_MAJOR 90 25 #define MTD_BLOCK_MAJOR 31 26 #define MAX_MTD_DEVICES 32 27 28 #define MTD_ERASE_PENDING 0x01 29 #define MTD_ERASING 0x02 30 #define MTD_ERASE_SUSPEND 0x04 31 #define MTD_ERASE_DONE 0x08 32 #define MTD_ERASE_FAILED 0x10 33 34 /* If the erase fails, fail_addr might indicate exactly which block failed. If 35 fail_addr = 0xffffffff, the failure was not at the device level or was not 36 specific to any particular block. */ 37 struct erase_info { 38 struct mtd_info *mtd; 39 u_int32_t addr; 40 u_int32_t len; 41 u_int32_t fail_addr; 42 u_long time; 43 u_long retries; 44 u_int dev; 45 u_int cell; 46 void (*callback) (struct erase_info *self); 47 u_long priv; 48 u_char state; 49 struct erase_info *next; 50 }; 51 52 struct mtd_erase_region_info { 53 u_int32_t offset; /* At which this region starts, from the beginning of the MTD */ 54 u_int32_t erasesize; /* For this region */ 55 u_int32_t numblocks; /* Number of blocks of erasesize in this region */ 56 }; 57 58 /* 59 * oob operation modes 60 * 61 * MTD_OOB_PLACE: oob data are placed at the given offset 62 * MTD_OOB_AUTO: oob data are automatically placed at the free areas 63 * which are defined by the ecclayout 64 * MTD_OOB_RAW: mode to read raw data+oob in one chunk. The oob data 65 * is inserted into the data. Thats a raw image of the 66 * flash contents. 67 */ 68 typedef enum { 69 MTD_OOB_PLACE, 70 MTD_OOB_AUTO, 71 MTD_OOB_RAW, 72 } mtd_oob_mode_t; 73 74 /** 75 * struct mtd_oob_ops - oob operation operands 76 * @mode: operation mode 77 * 78 * @len: number of data bytes to write/read 79 * 80 * @retlen: number of data bytes written/read 81 * 82 * @ooblen: number of oob bytes to write/read 83 * @oobretlen: number of oob bytes written/read 84 * @ooboffs: offset of oob data in the oob area (only relevant when 85 * mode = MTD_OOB_PLACE) 86 * @datbuf: data buffer - if NULL only oob data are read/written 87 * @oobbuf: oob data buffer 88 * 89 * Note, it is allowed to read more then one OOB area at one go, but not write. 90 * The interface assumes that the OOB write requests program only one page's 91 * OOB area. 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 size_t oobretlen; 99 uint32_t ooboffs; 100 uint8_t *datbuf; 101 uint8_t *oobbuf; 102 }; 103 104 struct mtd_info { 105 u_char type; 106 u_int32_t flags; 107 u_int32_t size; // Total size of the MTD 108 109 /* "Major" erase size for the device. Naïve users may take this 110 * to be the only erase size available, or may use the more detailed 111 * information below if they desire 112 */ 113 u_int32_t erasesize; 114 /* Minimal writable flash unit size. In case of NOR flash it is 1 (even 115 * though individual bits can be cleared), in case of NAND flash it is 116 * one NAND page (or half, or one-fourths of it), in case of ECC-ed NOR 117 * it is of ECC block size, etc. It is illegal to have writesize = 0. 118 * Any driver registering a struct mtd_info must ensure a writesize of 119 * 1 or larger. 120 */ 121 u_int32_t writesize; 122 123 u_int32_t oobsize; // Amount of OOB data per block (e.g. 16) 124 u_int32_t oobavail; // Available OOB bytes per block 125 126 // Kernel-only stuff starts here. 127 char *name; 128 int index; 129 130 /* ecc layout structure pointer - read only ! */ 131 struct nand_ecclayout *ecclayout; 132 133 /* Data for variable erase regions. If numeraseregions is zero, 134 * it means that the whole device has erasesize as given above. 135 */ 136 int numeraseregions; 137 struct mtd_erase_region_info *eraseregions; 138 139 /* This really shouldn't be here. It can go away in 2.5 */ 140 u_int32_t bank_size; 141 142 int (*erase) (struct mtd_info *mtd, struct erase_info *instr); 143 144 /* This stuff for eXecute-In-Place */ 145 int (*point) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char **mtdbuf); 146 147 /* We probably shouldn't allow XIP if the unpoint isn't a NULL */ 148 void (*unpoint) (struct mtd_info *mtd, u_char * addr, loff_t from, size_t len); 149 150 151 int (*read) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf); 152 int (*write) (struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf); 153 154 int (*read_oob) (struct mtd_info *mtd, loff_t from, 155 struct mtd_oob_ops *ops); 156 int (*write_oob) (struct mtd_info *mtd, loff_t to, 157 struct mtd_oob_ops *ops); 158 159 /* 160 * Methods to access the protection register area, present in some 161 * flash devices. The user data is one time programmable but the 162 * factory data is read only. 163 */ 164 int (*get_fact_prot_info) (struct mtd_info *mtd, struct otp_info *buf, size_t len); 165 int (*read_fact_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf); 166 int (*get_user_prot_info) (struct mtd_info *mtd, struct otp_info *buf, size_t len); 167 int (*read_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf); 168 int (*write_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf); 169 int (*lock_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len); 170 171 /* kvec-based read/write methods. 172 NB: The 'count' parameter is the number of _vectors_, each of 173 which contains an (ofs, len) tuple. 174 */ 175 int (*writev) (struct mtd_info *mtd, const struct kvec *vecs, unsigned long count, loff_t to, size_t *retlen); 176 177 /* Sync */ 178 void (*sync) (struct mtd_info *mtd); 179 180 /* Chip-supported device locking */ 181 int (*lock) (struct mtd_info *mtd, loff_t ofs, size_t len); 182 int (*unlock) (struct mtd_info *mtd, loff_t ofs, size_t len); 183 184 /* Power Management functions */ 185 int (*suspend) (struct mtd_info *mtd); 186 void (*resume) (struct mtd_info *mtd); 187 188 /* Bad block management functions */ 189 int (*block_isbad) (struct mtd_info *mtd, loff_t ofs); 190 int (*block_markbad) (struct mtd_info *mtd, loff_t ofs); 191 192 struct notifier_block reboot_notifier; /* default mode before reboot */ 193 194 /* ECC status information */ 195 struct mtd_ecc_stats ecc_stats; 196 /* Subpage shift (NAND) */ 197 int subpage_sft; 198 199 void *priv; 200 201 struct module *owner; 202 int usecount; 203 204 /* If the driver is something smart, like UBI, it may need to maintain 205 * its own reference counting. The below functions are only for driver. 206 * The driver may register its callbacks. These callbacks are not 207 * supposed to be called by MTD users */ 208 int (*get_device) (struct mtd_info *mtd); 209 void (*put_device) (struct mtd_info *mtd); 210 }; 211 212 213 /* Kernel-side ioctl definitions */ 214 215 extern int add_mtd_device(struct mtd_info *mtd); 216 extern int del_mtd_device (struct mtd_info *mtd); 217 218 extern struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num); 219 extern struct mtd_info *get_mtd_device_nm(const char *name); 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__ */ 270