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/types.h>
17 #include <linux/module.h>
18 #include <linux/uio.h>
19 #include <linux/notifier.h>
21 #include <linux/mtd/compatmac.h>
22 #include <mtd/mtd-abi.h>
24 #define MTD_CHAR_MAJOR 90
25 #define MTD_BLOCK_MAJOR 31
26 #define MAX_MTD_DEVICES 32
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
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. */
46 void (*callback
) (struct erase_info
*self
);
49 struct erase_info
*next
;
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 */
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
75 * struct mtd_oob_ops - oob operation operands
76 * @mode: operation mode
78 * @len: number of data bytes to write/read
80 * @retlen: number of data bytes written/read
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
103 u_int32_t size
; // Total size of the MTD
105 /* "Major" erase size for the device. Naïve users may take this
106 * to be the only erase size available, or may use the more detailed
107 * information below if they desire
110 /* Minimal writable flash unit size. In case of NOR flash it is 1 (even
111 * though individual bits can be cleared), in case of NAND flash it is
112 * one NAND page (or half, or one-fourths of it), in case of ECC-ed NOR
113 * it is of ECC block size, etc. It is illegal to have writesize = 0.
114 * Any driver registering a struct mtd_info must ensure a writesize of
119 u_int32_t oobsize
; // Amount of OOB data per block (e.g. 16)
121 // Kernel-only stuff starts here.
125 /* ecc layout structure pointer - read only ! */
126 struct nand_ecclayout
*ecclayout
;
128 /* Data for variable erase regions. If numeraseregions is zero,
129 * it means that the whole device has erasesize as given above.
132 struct mtd_erase_region_info
*eraseregions
;
134 /* This really shouldn't be here. It can go away in 2.5 */
137 int (*erase
) (struct mtd_info
*mtd
, struct erase_info
*instr
);
139 /* This stuff for eXecute-In-Place */
140 int (*point
) (struct mtd_info
*mtd
, loff_t from
, size_t len
, size_t *retlen
, u_char
**mtdbuf
);
142 /* We probably shouldn't allow XIP if the unpoint isn't a NULL */
143 void (*unpoint
) (struct mtd_info
*mtd
, u_char
* addr
, loff_t from
, size_t len
);
146 int (*read
) (struct mtd_info
*mtd
, loff_t from
, size_t len
, size_t *retlen
, u_char
*buf
);
147 int (*write
) (struct mtd_info
*mtd
, loff_t to
, size_t len
, size_t *retlen
, const u_char
*buf
);
149 int (*read_oob
) (struct mtd_info
*mtd
, loff_t from
,
150 struct mtd_oob_ops
*ops
);
151 int (*write_oob
) (struct mtd_info
*mtd
, loff_t to
,
152 struct mtd_oob_ops
*ops
);
155 * Methods to access the protection register area, present in some
156 * flash devices. The user data is one time programmable but the
157 * factory data is read only.
159 int (*get_fact_prot_info
) (struct mtd_info
*mtd
, struct otp_info
*buf
, size_t len
);
160 int (*read_fact_prot_reg
) (struct mtd_info
*mtd
, loff_t from
, size_t len
, size_t *retlen
, u_char
*buf
);
161 int (*get_user_prot_info
) (struct mtd_info
*mtd
, struct otp_info
*buf
, size_t len
);
162 int (*read_user_prot_reg
) (struct mtd_info
*mtd
, loff_t from
, size_t len
, size_t *retlen
, u_char
*buf
);
163 int (*write_user_prot_reg
) (struct mtd_info
*mtd
, loff_t from
, size_t len
, size_t *retlen
, u_char
*buf
);
164 int (*lock_user_prot_reg
) (struct mtd_info
*mtd
, loff_t from
, size_t len
);
166 /* kvec-based read/write methods.
167 NB: The 'count' parameter is the number of _vectors_, each of
168 which contains an (ofs, len) tuple.
170 int (*writev
) (struct mtd_info
*mtd
, const struct kvec
*vecs
, unsigned long count
, loff_t to
, size_t *retlen
);
173 void (*sync
) (struct mtd_info
*mtd
);
175 /* Chip-supported device locking */
176 int (*lock
) (struct mtd_info
*mtd
, loff_t ofs
, size_t len
);
177 int (*unlock
) (struct mtd_info
*mtd
, loff_t ofs
, size_t len
);
179 /* Power Management functions */
180 int (*suspend
) (struct mtd_info
*mtd
);
181 void (*resume
) (struct mtd_info
*mtd
);
183 /* Bad block management functions */
184 int (*block_isbad
) (struct mtd_info
*mtd
, loff_t ofs
);
185 int (*block_markbad
) (struct mtd_info
*mtd
, loff_t ofs
);
187 struct notifier_block reboot_notifier
; /* default mode before reboot */
189 /* ECC status information */
190 struct mtd_ecc_stats ecc_stats
;
191 /* Subpage shift (NAND) */
196 struct module
*owner
;
199 /* If the driver is something smart, like UBI, it may need to maintain
200 * its own reference counting. The below functions are only for driver.
201 * The driver may register its callbacks. These callbacks are not
202 * supposed to be called by MTD users */
203 int (*get_device
) (struct mtd_info
*mtd
);
204 void (*put_device
) (struct mtd_info
*mtd
);
208 /* Kernel-side ioctl definitions */
210 extern int add_mtd_device(struct mtd_info
*mtd
);
211 extern int del_mtd_device (struct mtd_info
*mtd
);
213 extern struct mtd_info
*get_mtd_device(struct mtd_info
*mtd
, int num
);
214 extern struct mtd_info
*get_mtd_device_nm(const char *name
);
216 extern void put_mtd_device(struct mtd_info
*mtd
);
219 struct mtd_notifier
{
220 void (*add
)(struct mtd_info
*mtd
);
221 void (*remove
)(struct mtd_info
*mtd
);
222 struct list_head list
;
226 extern void register_mtd_user (struct mtd_notifier
*new);
227 extern int unregister_mtd_user (struct mtd_notifier
*old
);
229 int default_mtd_writev(struct mtd_info
*mtd
, const struct kvec
*vecs
,
230 unsigned long count
, loff_t to
, size_t *retlen
);
232 int default_mtd_readv(struct mtd_info
*mtd
, struct kvec
*vecs
,
233 unsigned long count
, loff_t from
, size_t *retlen
);
235 #ifdef CONFIG_MTD_PARTITIONS
236 void mtd_erase_callback(struct erase_info
*instr
);
238 static inline void mtd_erase_callback(struct erase_info
*instr
)
241 instr
->callback(instr
);
246 * Debugging macro and defines
248 #define MTD_DEBUG_LEVEL0 (0) /* Quiet */
249 #define MTD_DEBUG_LEVEL1 (1) /* Audible */
250 #define MTD_DEBUG_LEVEL2 (2) /* Loud */
251 #define MTD_DEBUG_LEVEL3 (3) /* Noisy */
253 #ifdef CONFIG_MTD_DEBUG
254 #define DEBUG(n, args...) \
256 if (n <= CONFIG_MTD_DEBUG_VERBOSE) \
257 printk(KERN_INFO args); \
259 #else /* CONFIG_MTD_DEBUG */
260 #define DEBUG(n, args...) do { } while(0)
262 #endif /* CONFIG_MTD_DEBUG */
264 #endif /* __MTD_MTD_H__ */