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 */
62 u_int32_t size
; // Total size of the MTD
64 /* "Major" erase size for the device. Naïve users may take this
65 * to be the only erase size available, or may use the more detailed
66 * information below if they desire
69 /* Smallest availlable size for writing to the device. For NAND,
70 * this is the page size, for some NOR chips, the size of ECC
75 u_int32_t oobsize
; // Amount of OOB data per block (e.g. 16)
80 * Reuse some of the above unused fields in the case of NOR flash
81 * with configurable programming regions to avoid modifying the
82 * user visible structure layout/size. Only valid when the
83 * MTD_PROGRAM_REGIONS flag is set.
84 * (Maybe we should have an union for those?)
86 #define MTD_PROGREGION_CTRLMODE_VALID(mtd) (mtd)->oobsize
87 #define MTD_PROGREGION_CTRLMODE_INVALID(mtd) (mtd)->ecctype
89 // Kernel-only stuff starts here.
93 // oobinfo is a nand_oobinfo structure, which can be set by iotcl (MEMSETOOBINFO)
94 struct nand_oobinfo oobinfo
;
95 u_int32_t oobavail
; // Number of bytes in OOB area available for fs
97 /* Data for variable erase regions. If numeraseregions is zero,
98 * it means that the whole device has erasesize as given above.
101 struct mtd_erase_region_info
*eraseregions
;
103 /* This really shouldn't be here. It can go away in 2.5 */
106 int (*erase
) (struct mtd_info
*mtd
, struct erase_info
*instr
);
108 /* This stuff for eXecute-In-Place */
109 int (*point
) (struct mtd_info
*mtd
, loff_t from
, size_t len
, size_t *retlen
, u_char
**mtdbuf
);
111 /* We probably shouldn't allow XIP if the unpoint isn't a NULL */
112 void (*unpoint
) (struct mtd_info
*mtd
, u_char
* addr
, loff_t from
, size_t len
);
115 int (*read
) (struct mtd_info
*mtd
, loff_t from
, size_t len
, size_t *retlen
, u_char
*buf
);
116 int (*write
) (struct mtd_info
*mtd
, loff_t to
, size_t len
, size_t *retlen
, const u_char
*buf
);
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
);
122 * Methods to access the protection register area, present in some
123 * flash devices. The user data is one time programmable but the
124 * factory data is read only.
126 int (*get_fact_prot_info
) (struct mtd_info
*mtd
, struct otp_info
*buf
, size_t len
);
127 int (*read_fact_prot_reg
) (struct mtd_info
*mtd
, loff_t from
, size_t len
, size_t *retlen
, u_char
*buf
);
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
);
130 int (*write_user_prot_reg
) (struct mtd_info
*mtd
, loff_t from
, size_t len
, size_t *retlen
, u_char
*buf
);
131 int (*lock_user_prot_reg
) (struct mtd_info
*mtd
, loff_t from
, size_t len
);
133 /* kvec-based read/write methods.
134 NB: The 'count' parameter is the number of _vectors_, each of
135 which contains an (ofs, len) tuple.
137 int (*writev
) (struct mtd_info
*mtd
, const struct kvec
*vecs
, unsigned long count
, loff_t to
, size_t *retlen
);
140 void (*sync
) (struct mtd_info
*mtd
);
142 /* Chip-supported device locking */
143 int (*lock
) (struct mtd_info
*mtd
, loff_t ofs
, size_t len
);
144 int (*unlock
) (struct mtd_info
*mtd
, loff_t ofs
, size_t len
);
146 /* Power Management functions */
147 int (*suspend
) (struct mtd_info
*mtd
);
148 void (*resume
) (struct mtd_info
*mtd
);
150 /* Bad block management functions */
151 int (*block_isbad
) (struct mtd_info
*mtd
, loff_t ofs
);
152 int (*block_markbad
) (struct mtd_info
*mtd
, loff_t ofs
);
154 struct notifier_block reboot_notifier
; /* default mode before reboot */
158 struct module
*owner
;
163 /* Kernel-side ioctl definitions */
165 extern int add_mtd_device(struct mtd_info
*mtd
);
166 extern int del_mtd_device (struct mtd_info
*mtd
);
168 extern struct mtd_info
*get_mtd_device(struct mtd_info
*mtd
, int num
);
170 extern void put_mtd_device(struct mtd_info
*mtd
);
173 struct mtd_notifier
{
174 void (*add
)(struct mtd_info
*mtd
);
175 void (*remove
)(struct mtd_info
*mtd
);
176 struct list_head list
;
180 extern void register_mtd_user (struct mtd_notifier
*new);
181 extern int unregister_mtd_user (struct mtd_notifier
*old
);
183 int default_mtd_writev(struct mtd_info
*mtd
, const struct kvec
*vecs
,
184 unsigned long count
, loff_t to
, size_t *retlen
);
186 int default_mtd_readv(struct mtd_info
*mtd
, struct kvec
*vecs
,
187 unsigned long count
, loff_t from
, size_t *retlen
);
189 #define MTD_ERASE(mtd, args...) (*(mtd->erase))(mtd, args)
190 #define MTD_POINT(mtd, a,b,c,d) (*(mtd->point))(mtd, a,b,c, (u_char **)(d))
191 #define MTD_UNPOINT(mtd, arg) (*(mtd->unpoint))(mtd, (u_char *)arg)
192 #define MTD_READ(mtd, args...) (*(mtd->read))(mtd, args)
193 #define MTD_WRITE(mtd, args...) (*(mtd->write))(mtd, args)
194 #define MTD_READV(mtd, args...) (*(mtd->readv))(mtd, args)
195 #define MTD_WRITEV(mtd, args...) (*(mtd->writev))(mtd, args)
196 #define MTD_READECC(mtd, args...) (*(mtd->read_ecc))(mtd, args)
197 #define MTD_WRITEECC(mtd, args...) (*(mtd->write_ecc))(mtd, args)
198 #define MTD_READOOB(mtd, args...) (*(mtd->read_oob))(mtd, args)
199 #define MTD_WRITEOOB(mtd, args...) (*(mtd->write_oob))(mtd, args)
200 #define MTD_SYNC(mtd) do { if (mtd->sync) (*(mtd->sync))(mtd); } while (0)
203 #ifdef CONFIG_MTD_PARTITIONS
204 void mtd_erase_callback(struct erase_info
*instr
);
206 static inline void mtd_erase_callback(struct erase_info
*instr
)
209 instr
->callback(instr
);
214 * Debugging macro and defines
216 #define MTD_DEBUG_LEVEL0 (0) /* Quiet */
217 #define MTD_DEBUG_LEVEL1 (1) /* Audible */
218 #define MTD_DEBUG_LEVEL2 (2) /* Loud */
219 #define MTD_DEBUG_LEVEL3 (3) /* Noisy */
221 #ifdef CONFIG_MTD_DEBUG
222 #define DEBUG(n, args...) \
224 if (n <= CONFIG_MTD_DEBUG_VERBOSE) \
225 printk(KERN_INFO args); \
227 #else /* CONFIG_MTD_DEBUG */
228 #define DEBUG(n, args...) do { } while(0)
230 #endif /* CONFIG_MTD_DEBUG */
232 #endif /* __MTD_MTD_H__ */