2 * $Id: mtd.h,v 1.61 2005/11/07 11:14:54 gleixner Exp $
4 * Copyright (C) 1999-2003 David Woodhouse <dwmw2@infradead.org> et al.
13 #error This is a kernel header. Perhaps include mtd-user.h instead?
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>
22 #include <linux/mtd/compatmac.h>
23 #include <mtd/mtd-abi.h>
25 #define MTD_CHAR_MAJOR 90
26 #define MTD_BLOCK_MAJOR 31
27 #define MAX_MTD_DEVICES 16
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
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. */
47 void (*callback) (struct erase_info *self);
50 struct erase_info *next;
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 */
60 * struct mtd_ecc_stats - error correction status
62 * @corrected: number of corrected bits
63 * @failed: number of uncorrectable errors
65 struct mtd_ecc_stats {
66 unsigned long corrected;
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
87 * struct mtd_oob_ops - oob operation operands
88 * @mode: operation mode
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.
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.
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
117 u_int32_t size; // Total size of the MTD
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
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
130 u_int32_t oobsize; // Amount of OOB data per block (e.g. 16)
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?)
141 #define MTD_PROGREGION_CTRLMODE_VALID(mtd) (mtd)->oobsize
142 #define MTD_PROGREGION_CTRLMODE_INVALID(mtd) (mtd)->ecctype
144 // Kernel-only stuff starts here.
148 /* ecc layout structure pointer - read only ! */
149 struct nand_ecclayout *ecclayout;
151 /* Data for variable erase regions. If numeraseregions is zero,
152 * it means that the whole device has erasesize as given above.
155 struct mtd_erase_region_info *eraseregions;
157 /* This really shouldn't be here. It can go away in 2.5 */
160 int (*erase) (struct mtd_info *mtd, struct erase_info *instr);
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);
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);
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);
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);
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.
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);
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.
193 int (*writev) (struct mtd_info *mtd, const struct kvec *vecs, unsigned long count, loff_t to, size_t *retlen);
196 void (*sync) (struct mtd_info *mtd);
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);
202 /* Power Management functions */
203 int (*suspend) (struct mtd_info *mtd);
204 void (*resume) (struct mtd_info *mtd);
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);
210 struct notifier_block reboot_notifier; /* default mode before reboot */
212 /* ECC status information */
213 struct mtd_ecc_stats ecc_stats;
217 struct module *owner;
222 /* Kernel-side ioctl definitions */
224 extern int add_mtd_device(struct mtd_info *mtd);
225 extern int del_mtd_device (struct mtd_info *mtd);
227 extern struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num);
229 extern void put_mtd_device(struct mtd_info *mtd);
232 struct mtd_notifier {
233 void (*add)(struct mtd_info *mtd);
234 void (*remove)(struct mtd_info *mtd);
235 struct list_head list;
239 extern void register_mtd_user (struct mtd_notifier *new);
240 extern int unregister_mtd_user (struct mtd_notifier *old);
242 int default_mtd_writev(struct mtd_info *mtd, const struct kvec *vecs,
243 unsigned long count, loff_t to, size_t *retlen);
245 int default_mtd_readv(struct mtd_info *mtd, struct kvec *vecs,
246 unsigned long count, loff_t from, size_t *retlen);
248 #ifdef CONFIG_MTD_PARTITIONS
249 void mtd_erase_callback(struct erase_info *instr);
251 static inline void mtd_erase_callback(struct erase_info *instr)
254 instr->callback(instr);
259 * Debugging macro and defines
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 */
266 #ifdef CONFIG_MTD_DEBUG
267 #define DEBUG(n, args...) \
269 if (n <= CONFIG_MTD_DEBUG_VERBOSE) \
270 printk(KERN_INFO args); \
272 #else /* CONFIG_MTD_DEBUG */
273 #define DEBUG(n, args...) do { } while(0)
275 #endif /* CONFIG_MTD_DEBUG */
277 #endif /* __MTD_MTD_H__ */