2 * $Id: mtd.h,v 1.54 2004/07/15 01:13:12 dwmw2 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/version.h>
18 #include <linux/types.h>
19 #include <linux/module.h>
20 #include <linux/uio.h>
22 #include <mtd/mtd-abi.h>
24 #define MTD_CHAR_MAJOR 90
25 #define MTD_BLOCK_MAJOR 31
26 #define MAX_MTD_DEVICES 16
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 u_int32_t size; // Total size of the MTD
63 /* "Major" erase size for the device. Naïve users may take this
64 * to be the only erase size available, or may use the more detailed
65 * information below if they desire
69 u_int32_t oobblock; // Size of OOB blocks (e.g. 512)
70 u_int32_t oobsize; // Amount of OOB data per block (e.g. 16)
71 u_int32_t oobavail; // Number of bytes in OOB area available for fs
76 // Kernel-only stuff starts here.
80 // oobinfo is a nand_oobinfo structure, which can be set by iotcl (MEMSETOOBINFO)
81 struct nand_oobinfo oobinfo;
83 /* Data for variable erase regions. If numeraseregions is zero,
84 * it means that the whole device has erasesize as given above.
87 struct mtd_erase_region_info *eraseregions;
89 /* This really shouldn't be here. It can go away in 2.5 */
92 int (*erase) (struct mtd_info *mtd, struct erase_info *instr);
94 /* This stuff for eXecute-In-Place */
95 int (*point) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char **mtdbuf);
97 /* We probably shouldn't allow XIP if the unpoint isn't a NULL */
98 void (*unpoint) (struct mtd_info *mtd, u_char * addr, loff_t from, size_t len);
101 int (*read) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
102 int (*write) (struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf);
104 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);
105 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);
107 int (*read_oob) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
108 int (*write_oob) (struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf);
111 * Methods to access the protection register area, present in some
112 * flash devices. The user data is one time programmable but the
113 * factory data is read only.
115 int (*read_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
117 int (*read_fact_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
119 /* This function is not yet implemented */
120 int (*write_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
122 /* kvec-based read/write methods. We need these especially for NAND flash,
123 with its limited number of write cycles per erase.
124 NB: The 'count' parameter is the number of _vectors_, each of
125 which contains an (ofs, len) tuple.
127 int (*readv) (struct mtd_info *mtd, struct kvec *vecs, unsigned long count, loff_t from, size_t *retlen);
128 int (*readv_ecc) (struct mtd_info *mtd, struct kvec *vecs, unsigned long count, loff_t from,
129 size_t *retlen, u_char *eccbuf, struct nand_oobinfo *oobsel);
130 int (*writev) (struct mtd_info *mtd, const struct kvec *vecs, unsigned long count, loff_t to, size_t *retlen);
131 int (*writev_ecc) (struct mtd_info *mtd, const struct kvec *vecs, unsigned long count, loff_t to,
132 size_t *retlen, u_char *eccbuf, struct nand_oobinfo *oobsel);
135 void (*sync) (struct mtd_info *mtd);
137 /* Chip-supported device locking */
138 int (*lock) (struct mtd_info *mtd, loff_t ofs, size_t len);
139 int (*unlock) (struct mtd_info *mtd, loff_t ofs, size_t len);
141 /* Power Management functions */
142 int (*suspend) (struct mtd_info *mtd);
143 void (*resume) (struct mtd_info *mtd);
145 /* Bad block management functions */
146 int (*block_isbad) (struct mtd_info *mtd, loff_t ofs);
147 int (*block_markbad) (struct mtd_info *mtd, loff_t ofs);
151 struct module *owner;
156 /* Kernel-side ioctl definitions */
158 extern int add_mtd_device(struct mtd_info *mtd);
159 extern int del_mtd_device (struct mtd_info *mtd);
161 extern struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num);
163 extern void put_mtd_device(struct mtd_info *mtd);
166 struct mtd_notifier {
167 void (*add)(struct mtd_info *mtd);
168 void (*remove)(struct mtd_info *mtd);
169 struct list_head list;
173 extern void register_mtd_user (struct mtd_notifier *new);
174 extern int unregister_mtd_user (struct mtd_notifier *old);
176 int default_mtd_writev(struct mtd_info *mtd, const struct kvec *vecs,
177 unsigned long count, loff_t to, size_t *retlen);
179 int default_mtd_readv(struct mtd_info *mtd, struct kvec *vecs,
180 unsigned long count, loff_t from, size_t *retlen);
182 #define MTD_ERASE(mtd, args...) (*(mtd->erase))(mtd, args)
183 #define MTD_POINT(mtd, a,b,c,d) (*(mtd->point))(mtd, a,b,c, (u_char **)(d))
184 #define MTD_UNPOINT(mtd, arg) (*(mtd->unpoint))(mtd, (u_char *)arg)
185 #define MTD_READ(mtd, args...) (*(mtd->read))(mtd, args)
186 #define MTD_WRITE(mtd, args...) (*(mtd->write))(mtd, args)
187 #define MTD_READV(mtd, args...) (*(mtd->readv))(mtd, args)
188 #define MTD_WRITEV(mtd, args...) (*(mtd->writev))(mtd, args)
189 #define MTD_READECC(mtd, args...) (*(mtd->read_ecc))(mtd, args)
190 #define MTD_WRITEECC(mtd, args...) (*(mtd->write_ecc))(mtd, args)
191 #define MTD_READOOB(mtd, args...) (*(mtd->read_oob))(mtd, args)
192 #define MTD_WRITEOOB(mtd, args...) (*(mtd->write_oob))(mtd, args)
193 #define MTD_SYNC(mtd) do { if (mtd->sync) (*(mtd->sync))(mtd); } while (0)
196 * Debugging macro and defines
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 */
203 #ifdef CONFIG_MTD_DEBUG
204 #define DEBUG(n, args...) \
206 if (n <= CONFIG_MTD_DEBUG_VERBOSE) \
207 printk(KERN_INFO args); \
209 #else /* CONFIG_MTD_DEBUG */
210 #define DEBUG(n, args...) do { } while(0)
212 #endif /* CONFIG_MTD_DEBUG */
214 #endif /* __MTD_MTD_H__ */