Commit | Line | Data |
---|---|---|
61ecfa87 TG |
1 | /* |
2 | * $Id: mtd.h,v 1.61 2005/11/07 11:14:54 gleixner Exp $ | |
1da177e4 LT |
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> | |
1da177e4 LT |
17 | #include <linux/types.h> |
18 | #include <linux/module.h> | |
19 | #include <linux/uio.h> | |
963a6fb0 | 20 | #include <linux/notifier.h> |
1da177e4 LT |
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 | struct mtd_info { | |
60 | u_char type; | |
61 | u_int32_t flags; | |
62 | u_int32_t size; // Total size of the MTD | |
63 | ||
151e7659 | 64 | /* "Major" erase size for the device. Naïve users may take this |
1da177e4 LT |
65 | * to be the only erase size available, or may use the more detailed |
66 | * information below if they desire | |
67 | */ | |
68 | u_int32_t erasesize; | |
69 | ||
70 | u_int32_t oobblock; // Size of OOB blocks (e.g. 512) | |
71 | u_int32_t oobsize; // Amount of OOB data per block (e.g. 16) | |
1da177e4 LT |
72 | u_int32_t ecctype; |
73 | u_int32_t eccsize; | |
638d9838 NP |
74 | |
75 | /* | |
76 | * Reuse some of the above unused fields in the case of NOR flash | |
77 | * with configurable programming regions to avoid modifying the | |
78 | * user visible structure layout/size. Only valid when the | |
79 | * MTD_PROGRAM_REGIONS flag is set. | |
80 | * (Maybe we should have an union for those?) | |
81 | */ | |
82 | #define MTD_PROGREGION_SIZE(mtd) (mtd)->oobblock | |
83 | #define MTD_PROGREGION_CTRLMODE_VALID(mtd) (mtd)->oobsize | |
84 | #define MTD_PROGREGION_CTRLMODE_INVALID(mtd) (mtd)->ecctype | |
1da177e4 LT |
85 | |
86 | // Kernel-only stuff starts here. | |
87 | char *name; | |
88 | int index; | |
89 | ||
90 | // oobinfo is a nand_oobinfo structure, which can be set by iotcl (MEMSETOOBINFO) | |
91 | struct nand_oobinfo oobinfo; | |
61ecfa87 | 92 | u_int32_t oobavail; // Number of bytes in OOB area available for fs |
1da177e4 LT |
93 | |
94 | /* Data for variable erase regions. If numeraseregions is zero, | |
61ecfa87 | 95 | * it means that the whole device has erasesize as given above. |
1da177e4 LT |
96 | */ |
97 | int numeraseregions; | |
61ecfa87 | 98 | struct mtd_erase_region_info *eraseregions; |
1da177e4 LT |
99 | |
100 | /* This really shouldn't be here. It can go away in 2.5 */ | |
101 | u_int32_t bank_size; | |
102 | ||
103 | int (*erase) (struct mtd_info *mtd, struct erase_info *instr); | |
104 | ||
105 | /* This stuff for eXecute-In-Place */ | |
106 | int (*point) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char **mtdbuf); | |
107 | ||
108 | /* We probably shouldn't allow XIP if the unpoint isn't a NULL */ | |
109 | void (*unpoint) (struct mtd_info *mtd, u_char * addr, loff_t from, size_t len); | |
110 | ||
111 | ||
112 | int (*read) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf); | |
113 | int (*write) (struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf); | |
114 | ||
115 | 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); | |
116 | 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); | |
117 | ||
118 | int (*read_oob) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf); | |
119 | int (*write_oob) (struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf); | |
120 | ||
61ecfa87 TG |
121 | /* |
122 | * Methods to access the protection register area, present in some | |
1da177e4 | 123 | * flash devices. The user data is one time programmable but the |
61ecfa87 | 124 | * factory data is read only. |
1da177e4 | 125 | */ |
f77814dd | 126 | int (*get_fact_prot_info) (struct mtd_info *mtd, struct otp_info *buf, size_t len); |
1da177e4 | 127 | int (*read_fact_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf); |
f77814dd NP |
128 | int (*get_user_prot_info) (struct mtd_info *mtd, struct otp_info *buf, size_t len); |
129 | int (*read_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf); | |
1da177e4 | 130 | int (*write_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf); |
f77814dd | 131 | int (*lock_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len); |
1da177e4 LT |
132 | |
133 | /* kvec-based read/write methods. We need these especially for NAND flash, | |
134 | with its limited number of write cycles per erase. | |
61ecfa87 | 135 | NB: The 'count' parameter is the number of _vectors_, each of |
1da177e4 LT |
136 | which contains an (ofs, len) tuple. |
137 | */ | |
138 | int (*readv) (struct mtd_info *mtd, struct kvec *vecs, unsigned long count, loff_t from, size_t *retlen); | |
61ecfa87 | 139 | int (*readv_ecc) (struct mtd_info *mtd, struct kvec *vecs, unsigned long count, loff_t from, |
1da177e4 LT |
140 | size_t *retlen, u_char *eccbuf, struct nand_oobinfo *oobsel); |
141 | int (*writev) (struct mtd_info *mtd, const struct kvec *vecs, unsigned long count, loff_t to, size_t *retlen); | |
61ecfa87 | 142 | int (*writev_ecc) (struct mtd_info *mtd, const struct kvec *vecs, unsigned long count, loff_t to, |
1da177e4 LT |
143 | size_t *retlen, u_char *eccbuf, struct nand_oobinfo *oobsel); |
144 | ||
145 | /* Sync */ | |
146 | void (*sync) (struct mtd_info *mtd); | |
147 | ||
148 | /* Chip-supported device locking */ | |
149 | int (*lock) (struct mtd_info *mtd, loff_t ofs, size_t len); | |
150 | int (*unlock) (struct mtd_info *mtd, loff_t ofs, size_t len); | |
151 | ||
152 | /* Power Management functions */ | |
153 | int (*suspend) (struct mtd_info *mtd); | |
154 | void (*resume) (struct mtd_info *mtd); | |
155 | ||
156 | /* Bad block management functions */ | |
157 | int (*block_isbad) (struct mtd_info *mtd, loff_t ofs); | |
158 | int (*block_markbad) (struct mtd_info *mtd, loff_t ofs); | |
159 | ||
963a6fb0 NP |
160 | struct notifier_block reboot_notifier; /* default mode before reboot */ |
161 | ||
1da177e4 LT |
162 | void *priv; |
163 | ||
164 | struct module *owner; | |
165 | int usecount; | |
166 | }; | |
167 | ||
168 | ||
169 | /* Kernel-side ioctl definitions */ | |
170 | ||
171 | extern int add_mtd_device(struct mtd_info *mtd); | |
172 | extern int del_mtd_device (struct mtd_info *mtd); | |
173 | ||
174 | extern struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num); | |
175 | ||
176 | extern void put_mtd_device(struct mtd_info *mtd); | |
177 | ||
178 | ||
179 | struct mtd_notifier { | |
180 | void (*add)(struct mtd_info *mtd); | |
181 | void (*remove)(struct mtd_info *mtd); | |
182 | struct list_head list; | |
183 | }; | |
184 | ||
185 | ||
186 | extern void register_mtd_user (struct mtd_notifier *new); | |
187 | extern int unregister_mtd_user (struct mtd_notifier *old); | |
188 | ||
189 | int default_mtd_writev(struct mtd_info *mtd, const struct kvec *vecs, | |
190 | unsigned long count, loff_t to, size_t *retlen); | |
191 | ||
192 | int default_mtd_readv(struct mtd_info *mtd, struct kvec *vecs, | |
193 | unsigned long count, loff_t from, size_t *retlen); | |
194 | ||
195 | #define MTD_ERASE(mtd, args...) (*(mtd->erase))(mtd, args) | |
196 | #define MTD_POINT(mtd, a,b,c,d) (*(mtd->point))(mtd, a,b,c, (u_char **)(d)) | |
197 | #define MTD_UNPOINT(mtd, arg) (*(mtd->unpoint))(mtd, (u_char *)arg) | |
198 | #define MTD_READ(mtd, args...) (*(mtd->read))(mtd, args) | |
199 | #define MTD_WRITE(mtd, args...) (*(mtd->write))(mtd, args) | |
200 | #define MTD_READV(mtd, args...) (*(mtd->readv))(mtd, args) | |
201 | #define MTD_WRITEV(mtd, args...) (*(mtd->writev))(mtd, args) | |
202 | #define MTD_READECC(mtd, args...) (*(mtd->read_ecc))(mtd, args) | |
203 | #define MTD_WRITEECC(mtd, args...) (*(mtd->write_ecc))(mtd, args) | |
204 | #define MTD_READOOB(mtd, args...) (*(mtd->read_oob))(mtd, args) | |
205 | #define MTD_WRITEOOB(mtd, args...) (*(mtd->write_oob))(mtd, args) | |
61ecfa87 | 206 | #define MTD_SYNC(mtd) do { if (mtd->sync) (*(mtd->sync))(mtd); } while (0) |
1da177e4 LT |
207 | |
208 | ||
209 | #ifdef CONFIG_MTD_PARTITIONS | |
210 | void mtd_erase_callback(struct erase_info *instr); | |
211 | #else | |
212 | static inline void mtd_erase_callback(struct erase_info *instr) | |
213 | { | |
214 | if (instr->callback) | |
215 | instr->callback(instr); | |
216 | } | |
217 | #endif | |
218 | ||
219 | /* | |
220 | * Debugging macro and defines | |
221 | */ | |
222 | #define MTD_DEBUG_LEVEL0 (0) /* Quiet */ | |
223 | #define MTD_DEBUG_LEVEL1 (1) /* Audible */ | |
224 | #define MTD_DEBUG_LEVEL2 (2) /* Loud */ | |
225 | #define MTD_DEBUG_LEVEL3 (3) /* Noisy */ | |
226 | ||
227 | #ifdef CONFIG_MTD_DEBUG | |
228 | #define DEBUG(n, args...) \ | |
229 | do { \ | |
230 | if (n <= CONFIG_MTD_DEBUG_VERBOSE) \ | |
231 | printk(KERN_INFO args); \ | |
232 | } while(0) | |
233 | #else /* CONFIG_MTD_DEBUG */ | |
234 | #define DEBUG(n, args...) do { } while(0) | |
235 | ||
236 | #endif /* CONFIG_MTD_DEBUG */ | |
237 | ||
238 | #endif /* __MTD_MTD_H__ */ |