1 /* 2 * $Id: mtd.h,v 1.56 2004/08/09 18:46:04 dmarlin 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 #include <linux/types.h> 12 #include <linux/mtd/mtd-abi.h> 13 14 #define MAX_MTD_DEVICES 16 15 16 #define MTD_ERASE_PENDING 0x01 17 #define MTD_ERASING 0x02 18 #define MTD_ERASE_SUSPEND 0x04 19 #define MTD_ERASE_DONE 0x08 20 #define MTD_ERASE_FAILED 0x10 21 22 /* If the erase fails, fail_addr might indicate exactly which block failed. If 23 fail_addr = 0xffffffff, the failure was not at the device level or was not 24 specific to any particular block. */ 25 struct erase_info { 26 struct mtd_info *mtd; 27 u_int32_t addr; 28 u_int32_t len; 29 u_int32_t fail_addr; 30 u_long time; 31 u_long retries; 32 u_int dev; 33 u_int cell; 34 void (*callback) (struct erase_info *self); 35 u_long priv; 36 u_char state; 37 struct erase_info *next; 38 }; 39 40 struct mtd_erase_region_info { 41 u_int32_t offset; /* At which this region starts, from the beginning of the MTD */ 42 u_int32_t erasesize; /* For this region */ 43 u_int32_t numblocks; /* Number of blocks of erasesize in this region */ 44 }; 45 46 struct mtd_info { 47 u_char type; 48 u_int32_t flags; 49 u_int32_t size; /* Total size of the MTD */ 50 51 /* "Major" erase size for the device. Na�ve users may take this 52 * to be the only erase size available, or may use the more detailed 53 * information below if they desire 54 */ 55 u_int32_t erasesize; 56 57 u_int32_t oobblock; /* Size of OOB blocks (e.g. 512) */ 58 u_int32_t oobsize; /* Amount of OOB data per block (e.g. 16) */ 59 u_int32_t oobavail; /* Number of bytes in OOB area available for fs */ 60 u_int32_t ecctype; 61 u_int32_t eccsize; 62 63 64 /* Kernel-only stuff starts here. */ 65 char *name; 66 int index; 67 68 /* oobinfo is a nand_oobinfo structure, which can be set by iotcl (MEMSETOOBINFO) */ 69 struct nand_oobinfo oobinfo; 70 71 /* Data for variable erase regions. If numeraseregions is zero, 72 * it means that the whole device has erasesize as given above. 73 */ 74 int numeraseregions; 75 struct mtd_erase_region_info *eraseregions; 76 77 /* This really shouldn't be here. It can go away in 2.5 */ 78 u_int32_t bank_size; 79 80 int (*erase) (struct mtd_info *mtd, struct erase_info *instr); 81 82 /* This stuff for eXecute-In-Place */ 83 int (*point) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char **mtdbuf); 84 85 /* We probably shouldn't allow XIP if the unpoint isn't a NULL */ 86 void (*unpoint) (struct mtd_info *mtd, u_char * addr, loff_t from, size_t len); 87 88 89 int (*read) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf); 90 int (*write) (struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf); 91 92 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); 93 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); 94 95 int (*read_oob) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf); 96 int (*write_oob) (struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf); 97 98 /* 99 * Methods to access the protection register area, present in some 100 * flash devices. The user data is one time programmable but the 101 * factory data is read only. 102 */ 103 int (*read_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf); 104 105 int (*read_fact_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf); 106 107 /* This function is not yet implemented */ 108 int (*write_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf); 109 #if 0 110 /* kvec-based read/write methods. We need these especially for NAND flash, 111 with its limited number of write cycles per erase. 112 NB: The 'count' parameter is the number of _vectors_, each of 113 which contains an (ofs, len) tuple. 114 */ 115 int (*readv) (struct mtd_info *mtd, struct kvec *vecs, unsigned long count, loff_t from, size_t *retlen); 116 int (*readv_ecc) (struct mtd_info *mtd, struct kvec *vecs, unsigned long count, loff_t from, 117 size_t *retlen, u_char *eccbuf, struct nand_oobinfo *oobsel); 118 int (*writev) (struct mtd_info *mtd, const struct kvec *vecs, unsigned long count, loff_t to, size_t *retlen); 119 int (*writev_ecc) (struct mtd_info *mtd, const struct kvec *vecs, unsigned long count, loff_t to, 120 size_t *retlen, u_char *eccbuf, struct nand_oobinfo *oobsel); 121 #endif 122 /* Sync */ 123 void (*sync) (struct mtd_info *mtd); 124 #if 0 125 /* Chip-supported device locking */ 126 int (*lock) (struct mtd_info *mtd, loff_t ofs, size_t len); 127 int (*unlock) (struct mtd_info *mtd, loff_t ofs, size_t len); 128 129 /* Power Management functions */ 130 int (*suspend) (struct mtd_info *mtd); 131 void (*resume) (struct mtd_info *mtd); 132 #endif 133 /* Bad block management functions */ 134 int (*block_isbad) (struct mtd_info *mtd, loff_t ofs); 135 int (*block_markbad) (struct mtd_info *mtd, loff_t ofs); 136 137 void *priv; 138 139 struct module *owner; 140 int usecount; 141 }; 142 143 144 /* Kernel-side ioctl definitions */ 145 146 extern int add_mtd_device(struct mtd_info *mtd); 147 extern int del_mtd_device (struct mtd_info *mtd); 148 149 extern struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num); 150 151 extern void put_mtd_device(struct mtd_info *mtd); 152 153 #if 0 154 struct mtd_notifier { 155 void (*add)(struct mtd_info *mtd); 156 void (*remove)(struct mtd_info *mtd); 157 struct list_head list; 158 }; 159 160 161 extern void register_mtd_user (struct mtd_notifier *new); 162 extern int unregister_mtd_user (struct mtd_notifier *old); 163 164 int default_mtd_writev(struct mtd_info *mtd, const struct kvec *vecs, 165 unsigned long count, loff_t to, size_t *retlen); 166 167 int default_mtd_readv(struct mtd_info *mtd, struct kvec *vecs, 168 unsigned long count, loff_t from, size_t *retlen); 169 #endif 170 171 #define MTD_ERASE(mtd, args...) (*(mtd->erase))(mtd, args) 172 #define MTD_POINT(mtd, a,b,c,d) (*(mtd->point))(mtd, a,b,c, (u_char **)(d)) 173 #define MTD_UNPOINT(mtd, arg) (*(mtd->unpoint))(mtd, (u_char *)arg) 174 #define MTD_READ(mtd, args...) (*(mtd->read))(mtd, args) 175 #define MTD_WRITE(mtd, args...) (*(mtd->write))(mtd, args) 176 #define MTD_READV(mtd, args...) (*(mtd->readv))(mtd, args) 177 #define MTD_WRITEV(mtd, args...) (*(mtd->writev))(mtd, args) 178 #define MTD_READECC(mtd, args...) (*(mtd->read_ecc))(mtd, args) 179 #define MTD_WRITEECC(mtd, args...) (*(mtd->write_ecc))(mtd, args) 180 #define MTD_READOOB(mtd, args...) (*(mtd->read_oob))(mtd, args) 181 #define MTD_WRITEOOB(mtd, args...) (*(mtd->write_oob))(mtd, args) 182 #define MTD_SYNC(mtd) do { if (mtd->sync) (*(mtd->sync))(mtd); } while (0) 183 184 185 #ifdef CONFIG_MTD_PARTITIONS 186 void mtd_erase_callback(struct erase_info *instr); 187 #else 188 static inline void mtd_erase_callback(struct erase_info *instr) 189 { 190 if (instr->callback) 191 instr->callback(instr); 192 } 193 #endif 194 195 /* 196 * Debugging macro and defines 197 */ 198 #define MTD_DEBUG_LEVEL0 (0) /* Quiet */ 199 #define MTD_DEBUG_LEVEL1 (1) /* Audible */ 200 #define MTD_DEBUG_LEVEL2 (2) /* Loud */ 201 #define MTD_DEBUG_LEVEL3 (3) /* Noisy */ 202 203 #ifdef CONFIG_MTD_DEBUG 204 #define DEBUG(n, args...) \ 205 do { \ 206 if (n <= CONFIG_MTD_DEBUG_VERBOSE) \ 207 printk(KERN_INFO args); \ 208 } while(0) 209 #else /* CONFIG_MTD_DEBUG */ 210 #define DEBUG(n, args...) do { } while(0) 211 212 #endif /* CONFIG_MTD_DEBUG */ 213 214 #endif /* __MTD_MTD_H__ */ 215