blob: 16556c4798da0c41cb3fa3f91c13239d278ff6ec [file] [log] [blame]
Wolfgang Denkac7eb8a32005-09-14 23:53:32 +02001/*
Wolfgang Denk932394a2005-08-17 12:55:25 +02002 * Copyright (C) 1999-2003 David Woodhouse <dwmw2@infradead.org> et al.
3 *
4 * Released under GPL
5 */
6
7#ifndef __MTD_MTD_H__
8#define __MTD_MTD_H__
William Juulcfa460a2007-10-31 13:53:06 +01009
Wolfgang Denk932394a2005-08-17 12:55:25 +020010#include <linux/types.h>
Stefan Roese8d2effe2009-05-11 16:03:55 +020011#include <div64.h>
Wolfgang Denk932394a2005-08-17 12:55:25 +020012#include <linux/mtd/mtd-abi.h>
13
William Juulcfa460a2007-10-31 13:53:06 +010014#define MTD_CHAR_MAJOR 90
15#define MTD_BLOCK_MAJOR 31
16#define MAX_MTD_DEVICES 32
Wolfgang Denk932394a2005-08-17 12:55:25 +020017
Wolfgang Denk53677ef2008-05-20 16:00:29 +020018#define MTD_ERASE_PENDING 0x01
Wolfgang Denk932394a2005-08-17 12:55:25 +020019#define MTD_ERASING 0x02
20#define MTD_ERASE_SUSPEND 0x04
21#define MTD_ERASE_DONE 0x08
22#define MTD_ERASE_FAILED 0x10
23
Stefan Roese8d2effe2009-05-11 16:03:55 +020024#define MTD_FAIL_ADDR_UNKNOWN -1LL
25
Kyungmin Parkd438d502008-08-13 09:11:02 +090026/*
27 * Enumeration for NAND/OneNAND flash chip state
28 */
29enum {
30 FL_READY,
31 FL_READING,
32 FL_WRITING,
33 FL_ERASING,
34 FL_SYNCING,
35 FL_CACHEDPRG,
36 FL_RESETING,
37 FL_UNLOCKING,
38 FL_LOCKING,
39 FL_PM_SUSPENDED,
40};
41
Wolfgang Denk932394a2005-08-17 12:55:25 +020042/* If the erase fails, fail_addr might indicate exactly which block failed. If
Stefan Roese8d2effe2009-05-11 16:03:55 +020043 fail_addr = MTD_FAIL_ADDR_UNKNOWN, the failure was not at the device level or was not
Wolfgang Denk932394a2005-08-17 12:55:25 +020044 specific to any particular block. */
45struct erase_info {
46 struct mtd_info *mtd;
Stefan Roese8d2effe2009-05-11 16:03:55 +020047 uint64_t addr;
48 uint64_t len;
49 uint64_t fail_addr;
Wolfgang Denk932394a2005-08-17 12:55:25 +020050 u_long time;
51 u_long retries;
52 u_int dev;
53 u_int cell;
54 void (*callback) (struct erase_info *self);
55 u_long priv;
56 u_char state;
57 struct erase_info *next;
58};
59
60struct mtd_erase_region_info {
Stefan Roese8d2effe2009-05-11 16:03:55 +020061 uint64_t offset; /* At which this region starts, from the beginning of the MTD */
Wolfgang Denk932394a2005-08-17 12:55:25 +020062 u_int32_t erasesize; /* For this region */
63 u_int32_t numblocks; /* Number of blocks of erasesize in this region */
William Juulcfa460a2007-10-31 13:53:06 +010064 unsigned long *lockmap; /* If keeping bitmap of locks */
65};
66
67/*
68 * oob operation modes
69 *
70 * MTD_OOB_PLACE: oob data are placed at the given offset
71 * MTD_OOB_AUTO: oob data are automatically placed at the free areas
72 * which are defined by the ecclayout
73 * MTD_OOB_RAW: mode to read raw data+oob in one chunk. The oob data
74 * is inserted into the data. Thats a raw image of the
75 * flash contents.
76 */
77typedef enum {
78 MTD_OOB_PLACE,
79 MTD_OOB_AUTO,
80 MTD_OOB_RAW,
81} mtd_oob_mode_t;
82
83/**
84 * struct mtd_oob_ops - oob operation operands
85 * @mode: operation mode
86 *
87 * @len: number of data bytes to write/read
88 *
89 * @retlen: number of data bytes written/read
90 *
91 * @ooblen: number of oob bytes to write/read
92 * @oobretlen: number of oob bytes written/read
93 * @ooboffs: offset of oob data in the oob area (only relevant when
94 * mode = MTD_OOB_PLACE)
95 * @datbuf: data buffer - if NULL only oob data are read/written
96 * @oobbuf: oob data buffer
97 *
98 * Note, it is allowed to read more then one OOB area at one go, but not write.
99 * The interface assumes that the OOB write requests program only one page's
100 * OOB area.
101 */
102struct mtd_oob_ops {
103 mtd_oob_mode_t mode;
104 size_t len;
105 size_t retlen;
106 size_t ooblen;
107 size_t oobretlen;
108 uint32_t ooboffs;
109 uint8_t *datbuf;
110 uint8_t *oobbuf;
Wolfgang Denk932394a2005-08-17 12:55:25 +0200111};
112
113struct mtd_info {
114 u_char type;
115 u_int32_t flags;
Wolfgang Denk8e5e9b92009-07-07 22:35:02 +0200116 uint64_t size; /* Total size of the MTD */
Wolfgang Denk932394a2005-08-17 12:55:25 +0200117
Wolfgang Denk8e5e9b92009-07-07 22:35:02 +0200118 /* "Major" erase size for the device. Naïve users may take this
Wolfgang Denk932394a2005-08-17 12:55:25 +0200119 * to be the only erase size available, or may use the more detailed
120 * information below if they desire
121 */
122 u_int32_t erasesize;
William Juulcfa460a2007-10-31 13:53:06 +0100123 /* Minimal writable flash unit size. In case of NOR flash it is 1 (even
124 * though individual bits can be cleared), in case of NAND flash it is
125 * one NAND page (or half, or one-fourths of it), in case of ECC-ed NOR
126 * it is of ECC block size, etc. It is illegal to have writesize = 0.
127 * Any driver registering a struct mtd_info must ensure a writesize of
128 * 1 or larger.
129 */
130 u_int32_t writesize;
Wolfgang Denk932394a2005-08-17 12:55:25 +0200131
Wolfgang Denk4b070802008-08-14 14:41:06 +0200132 u_int32_t oobsize; /* Amount of OOB data per block (e.g. 16) */
133 u_int32_t oobavail; /* Available OOB bytes per block */
Wolfgang Denk932394a2005-08-17 12:55:25 +0200134
Wolfgang Denk4b070802008-08-14 14:41:06 +0200135 /* Kernel-only stuff starts here. */
Scott Woodc45912d2008-10-24 16:20:43 -0500136 const char *name;
Wolfgang Denk932394a2005-08-17 12:55:25 +0200137 int index;
138
William Juulcfa460a2007-10-31 13:53:06 +0100139 /* ecc layout structure pointer - read only ! */
140 struct nand_ecclayout *ecclayout;
Wolfgang Denk932394a2005-08-17 12:55:25 +0200141
142 /* Data for variable erase regions. If numeraseregions is zero,
Wolfgang Denkac7eb8a32005-09-14 23:53:32 +0200143 * it means that the whole device has erasesize as given above.
Wolfgang Denk932394a2005-08-17 12:55:25 +0200144 */
145 int numeraseregions;
Wolfgang Denkac7eb8a32005-09-14 23:53:32 +0200146 struct mtd_erase_region_info *eraseregions;
Wolfgang Denk932394a2005-08-17 12:55:25 +0200147
Scott Woodc45912d2008-10-24 16:20:43 -0500148 /*
149 * Erase is an asynchronous operation. Device drivers are supposed
150 * to call instr->callback() whenever the operation completes, even
151 * if it completes with a failure.
152 * Callers are supposed to pass a callback function and wait for it
153 * to be called before writing to the block.
154 */
Wolfgang Denk932394a2005-08-17 12:55:25 +0200155 int (*erase) (struct mtd_info *mtd, struct erase_info *instr);
156
157 /* This stuff for eXecute-In-Place */
Scott Woodc45912d2008-10-24 16:20:43 -0500158 /* phys is optional and may be set to NULL */
159 int (*point) (struct mtd_info *mtd, loff_t from, size_t len,
160 size_t *retlen, void **virt, phys_addr_t *phys);
Wolfgang Denk932394a2005-08-17 12:55:25 +0200161
162 /* We probably shouldn't allow XIP if the unpoint isn't a NULL */
Scott Woodc45912d2008-10-24 16:20:43 -0500163 void (*unpoint) (struct mtd_info *mtd, loff_t from, size_t len);
Wolfgang Denk932394a2005-08-17 12:55:25 +0200164
165
166 int (*read) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
167 int (*write) (struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf);
168
Scott Woodc45912d2008-10-24 16:20:43 -0500169 /* In blackbox flight recorder like scenarios we want to make successful
170 writes in interrupt context. panic_write() is only intended to be
171 called when its known the kernel is about to panic and we need the
172 write to succeed. Since the kernel is not going to be running for much
173 longer, this function can break locks and delay to ensure the write
174 succeeds (but not sleep). */
175
176 int (*panic_write) (struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf);
177
William Juulcfa460a2007-10-31 13:53:06 +0100178 int (*read_oob) (struct mtd_info *mtd, loff_t from,
179 struct mtd_oob_ops *ops);
180 int (*write_oob) (struct mtd_info *mtd, loff_t to,
181 struct mtd_oob_ops *ops);
Wolfgang Denk932394a2005-08-17 12:55:25 +0200182
Wolfgang Denkac7eb8a32005-09-14 23:53:32 +0200183 /*
184 * Methods to access the protection register area, present in some
Wolfgang Denk932394a2005-08-17 12:55:25 +0200185 * flash devices. The user data is one time programmable but the
Wolfgang Denkac7eb8a32005-09-14 23:53:32 +0200186 * factory data is read only.
Wolfgang Denk932394a2005-08-17 12:55:25 +0200187 */
William Juulcfa460a2007-10-31 13:53:06 +0100188 int (*get_fact_prot_info) (struct mtd_info *mtd, struct otp_info *buf, size_t len);
Wolfgang Denk932394a2005-08-17 12:55:25 +0200189 int (*read_fact_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
William Juulcfa460a2007-10-31 13:53:06 +0100190 int (*get_user_prot_info) (struct mtd_info *mtd, struct otp_info *buf, size_t len);
191 int (*read_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
Wolfgang Denk932394a2005-08-17 12:55:25 +0200192 int (*write_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
William Juulcfa460a2007-10-31 13:53:06 +0100193 int (*lock_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len);
194
195/* XXX U-BOOT XXX */
Wolfgang Denk932394a2005-08-17 12:55:25 +0200196#if 0
William Juulcfa460a2007-10-31 13:53:06 +0100197 /* kvec-based read/write methods.
Wolfgang Denkac7eb8a32005-09-14 23:53:32 +0200198 NB: The 'count' parameter is the number of _vectors_, each of
Wolfgang Denk932394a2005-08-17 12:55:25 +0200199 which contains an (ofs, len) tuple.
200 */
Wolfgang Denk932394a2005-08-17 12:55:25 +0200201 int (*writev) (struct mtd_info *mtd, const struct kvec *vecs, unsigned long count, loff_t to, size_t *retlen);
Wolfgang Denk932394a2005-08-17 12:55:25 +0200202#endif
William Juulcfa460a2007-10-31 13:53:06 +0100203
Wolfgang Denk932394a2005-08-17 12:55:25 +0200204 /* Sync */
205 void (*sync) (struct mtd_info *mtd);
William Juulcfa460a2007-10-31 13:53:06 +0100206
Wolfgang Denk932394a2005-08-17 12:55:25 +0200207 /* Chip-supported device locking */
Stefan Roese8d2effe2009-05-11 16:03:55 +0200208 int (*lock) (struct mtd_info *mtd, loff_t ofs, uint64_t len);
209 int (*unlock) (struct mtd_info *mtd, loff_t ofs, uint64_t len);
Wolfgang Denk932394a2005-08-17 12:55:25 +0200210
211 /* Power Management functions */
212 int (*suspend) (struct mtd_info *mtd);
213 void (*resume) (struct mtd_info *mtd);
William Juulcfa460a2007-10-31 13:53:06 +0100214
Wolfgang Denk932394a2005-08-17 12:55:25 +0200215 /* Bad block management functions */
216 int (*block_isbad) (struct mtd_info *mtd, loff_t ofs);
217 int (*block_markbad) (struct mtd_info *mtd, loff_t ofs);
218
William Juulcfa460a2007-10-31 13:53:06 +0100219/* XXX U-BOOT XXX */
220#if 0
221 struct notifier_block reboot_notifier; /* default mode before reboot */
222#endif
223
224 /* ECC status information */
225 struct mtd_ecc_stats ecc_stats;
226 /* Subpage shift (NAND) */
227 int subpage_sft;
228
Wolfgang Denk932394a2005-08-17 12:55:25 +0200229 void *priv;
230
231 struct module *owner;
232 int usecount;
William Juulcfa460a2007-10-31 13:53:06 +0100233
234 /* If the driver is something smart, like UBI, it may need to maintain
235 * its own reference counting. The below functions are only for driver.
236 * The driver may register its callbacks. These callbacks are not
237 * supposed to be called by MTD users */
238 int (*get_device) (struct mtd_info *mtd);
239 void (*put_device) (struct mtd_info *mtd);
Wolfgang Denk932394a2005-08-17 12:55:25 +0200240};
241
Stefan Roese8d2effe2009-05-11 16:03:55 +0200242static inline uint32_t mtd_div_by_eb(uint64_t sz, struct mtd_info *mtd)
243{
244 do_div(sz, mtd->erasesize);
245 return sz;
246}
247
248static inline uint32_t mtd_mod_by_eb(uint64_t sz, struct mtd_info *mtd)
249{
250 return do_div(sz, mtd->erasesize);
251}
Wolfgang Denk932394a2005-08-17 12:55:25 +0200252
253 /* Kernel-side ioctl definitions */
254
255extern int add_mtd_device(struct mtd_info *mtd);
256extern int del_mtd_device (struct mtd_info *mtd);
257
258extern struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num);
William Juulcfa460a2007-10-31 13:53:06 +0100259extern struct mtd_info *get_mtd_device_nm(const char *name);
Wolfgang Denk932394a2005-08-17 12:55:25 +0200260
261extern void put_mtd_device(struct mtd_info *mtd);
262
William Juulcfa460a2007-10-31 13:53:06 +0100263/* XXX U-BOOT XXX */
Wolfgang Denk932394a2005-08-17 12:55:25 +0200264#if 0
265struct mtd_notifier {
266 void (*add)(struct mtd_info *mtd);
267 void (*remove)(struct mtd_info *mtd);
268 struct list_head list;
269};
270
Wolfgang Denk932394a2005-08-17 12:55:25 +0200271extern void register_mtd_user (struct mtd_notifier *new);
272extern int unregister_mtd_user (struct mtd_notifier *old);
273
274int default_mtd_writev(struct mtd_info *mtd, const struct kvec *vecs,
275 unsigned long count, loff_t to, size_t *retlen);
276
277int default_mtd_readv(struct mtd_info *mtd, struct kvec *vecs,
278 unsigned long count, loff_t from, size_t *retlen);
279#endif
280
Wolfgang Denk932394a2005-08-17 12:55:25 +0200281#ifdef CONFIG_MTD_PARTITIONS
282void mtd_erase_callback(struct erase_info *instr);
283#else
284static inline void mtd_erase_callback(struct erase_info *instr)
285{
286 if (instr->callback)
287 instr->callback(instr);
288}
289#endif
290
291/*
292 * Debugging macro and defines
293 */
294#define MTD_DEBUG_LEVEL0 (0) /* Quiet */
295#define MTD_DEBUG_LEVEL1 (1) /* Audible */
296#define MTD_DEBUG_LEVEL2 (2) /* Loud */
297#define MTD_DEBUG_LEVEL3 (3) /* Noisy */
298
299#ifdef CONFIG_MTD_DEBUG
Scott Wood3167c532008-06-20 12:38:57 -0500300#define MTDDEBUG(n, args...) \
Wolfgang Denk53677ef2008-05-20 16:00:29 +0200301 do { \
Wolfgang Denk932394a2005-08-17 12:55:25 +0200302 if (n <= CONFIG_MTD_DEBUG_VERBOSE) \
303 printk(KERN_INFO args); \
304 } while(0)
305#else /* CONFIG_MTD_DEBUG */
Scott Woodc45912d2008-10-24 16:20:43 -0500306#define MTDDEBUG(n, args...) \
307 do { \
308 if (0) \
309 printk(KERN_INFO args); \
310 } while(0)
Wolfgang Denk932394a2005-08-17 12:55:25 +0200311#endif /* CONFIG_MTD_DEBUG */
312
313#endif /* __MTD_MTD_H__ */