blob: 37be05bbfbc87a84cf405e762d1c17cfd9f107ff [file] [log] [blame]
Thomas Gleixner61ecfa82005-11-07 11:15:31 +00001/*
David Woodhousea1452a32010-08-08 20:58:20 +01002 * Copyright © 1999-2010 David Woodhouse <dwmw2@infradead.org> et al.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
David Woodhousea1452a32010-08-08 20:58:20 +01004 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
17 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070018 */
19
20#ifndef __MTD_MTD_H__
21#define __MTD_MTD_H__
22
Linus Torvalds1da177e2005-04-16 15:20:36 -070023#include <linux/types.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/uio.h>
Nicolas Pitre963a6fb2005-04-01 02:59:56 +010025#include <linux/notifier.h>
David Brownell1f24b5a2009-03-26 00:42:41 -070026#include <linux/device.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <mtd/mtd-abi.h>
29
Adrian Hunter69423d92008-12-10 13:37:21 +000030#include <asm/div64.h>
31
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#define MTD_CHAR_MAJOR 90
33#define MTD_BLOCK_MAJOR 31
Linus Torvalds1da177e2005-04-16 15:20:36 -070034
35#define MTD_ERASE_PENDING 0x01
36#define MTD_ERASING 0x02
37#define MTD_ERASE_SUSPEND 0x04
38#define MTD_ERASE_DONE 0x08
39#define MTD_ERASE_FAILED 0x10
40
Adrian Hunter69423d92008-12-10 13:37:21 +000041#define MTD_FAIL_ADDR_UNKNOWN -1LL
Adrian Hunterbb0eb212008-08-12 12:40:50 +030042
Linus Torvalds1da177e2005-04-16 15:20:36 -070043/* If the erase fails, fail_addr might indicate exactly which block failed. If
Adrian Hunterbb0eb212008-08-12 12:40:50 +030044 fail_addr = MTD_FAIL_ADDR_UNKNOWN, the failure was not at the device level or was not
Linus Torvalds1da177e2005-04-16 15:20:36 -070045 specific to any particular block. */
46struct erase_info {
47 struct mtd_info *mtd;
Adrian Hunter69423d92008-12-10 13:37:21 +000048 uint64_t addr;
49 uint64_t len;
50 uint64_t fail_addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -070051 u_long time;
52 u_long retries;
David Woodhouse26cdb672008-12-10 14:08:12 +000053 unsigned dev;
54 unsigned cell;
Linus Torvalds1da177e2005-04-16 15:20:36 -070055 void (*callback) (struct erase_info *self);
56 u_long priv;
57 u_char state;
58 struct erase_info *next;
59};
60
61struct mtd_erase_region_info {
Adrian Hunter69423d92008-12-10 13:37:21 +000062 uint64_t offset; /* At which this region starts, from the beginning of the MTD */
David Woodhouse26cdb672008-12-10 14:08:12 +000063 uint32_t erasesize; /* For this region */
64 uint32_t numblocks; /* Number of blocks of erasesize in this region */
Rodolfo Giometti0ecbc812007-03-26 21:45:43 -080065 unsigned long *lockmap; /* If keeping bitmap of locks */
Linus Torvalds1da177e2005-04-16 15:20:36 -070066};
67
Thomas Gleixner8593fbc2006-05-29 03:26:58 +020068/*
69 * oob operation modes
70 *
71 * MTD_OOB_PLACE: oob data are placed at the given offset
72 * MTD_OOB_AUTO: oob data are automatically placed at the free areas
73 * which are defined by the ecclayout
Maxim Levitskyb64d39d2010-02-22 20:39:37 +020074 * MTD_OOB_RAW: mode to read oob and data without doing ECC checking
Thomas Gleixner8593fbc2006-05-29 03:26:58 +020075 */
76typedef enum {
77 MTD_OOB_PLACE,
78 MTD_OOB_AUTO,
79 MTD_OOB_RAW,
80} mtd_oob_mode_t;
81
82/**
83 * struct mtd_oob_ops - oob operation operands
84 * @mode: operation mode
85 *
Vitaly Wool70145682006-11-03 18:20:38 +030086 * @len: number of data bytes to write/read
Thomas Gleixner8593fbc2006-05-29 03:26:58 +020087 *
Vitaly Wool70145682006-11-03 18:20:38 +030088 * @retlen: number of data bytes written/read
Thomas Gleixner8593fbc2006-05-29 03:26:58 +020089 *
Vitaly Wool70145682006-11-03 18:20:38 +030090 * @ooblen: number of oob bytes to write/read
91 * @oobretlen: number of oob bytes written/read
Thomas Gleixner8593fbc2006-05-29 03:26:58 +020092 * @ooboffs: offset of oob data in the oob area (only relevant when
93 * mode = MTD_OOB_PLACE)
94 * @datbuf: data buffer - if NULL only oob data are read/written
95 * @oobbuf: oob data buffer
Artem Bityutskiy73a44212007-01-31 11:43:13 +020096 *
Frederik Schwarzer025dfda2008-10-16 19:02:37 +020097 * Note, it is allowed to read more than one OOB area at one go, but not write.
Artem Bityutskiy73a44212007-01-31 11:43:13 +020098 * The interface assumes that the OOB write requests program only one page's
99 * OOB area.
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200100 */
101struct mtd_oob_ops {
102 mtd_oob_mode_t mode;
103 size_t len;
104 size_t retlen;
105 size_t ooblen;
Vitaly Wool70145682006-11-03 18:20:38 +0300106 size_t oobretlen;
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200107 uint32_t ooboffs;
108 uint8_t *datbuf;
109 uint8_t *oobbuf;
110};
111
Brian Norriscc26c3c2010-08-24 18:12:00 -0700112#define MTD_MAX_OOBFREE_ENTRIES_LARGE 32
113#define MTD_MAX_ECCPOS_ENTRIES_LARGE 448
Brian Norriscc26c3c2010-08-24 18:12:00 -0700114/*
Brian Norris0ceacf32010-09-19 23:57:12 -0700115 * Internal ECC layout control structure. For historical reasons, there is a
116 * similar, smaller struct nand_ecclayout_user (in mtd-abi.h) that is retained
117 * for export to user-space via the ECCGETLAYOUT ioctl.
118 * nand_ecclayout should be expandable in the future simply by the above macros.
Brian Norriscc26c3c2010-08-24 18:12:00 -0700119 */
120struct nand_ecclayout {
121 __u32 eccbytes;
122 __u32 eccpos[MTD_MAX_ECCPOS_ENTRIES_LARGE];
123 __u32 oobavail;
124 struct nand_oobfree oobfree[MTD_MAX_OOBFREE_ENTRIES_LARGE];
125};
126
Paul Gortmakerde477252011-05-26 13:46:22 -0400127struct module; /* only needed for owner field in mtd_info */
128
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129struct mtd_info {
130 u_char type;
David Woodhouse26cdb672008-12-10 14:08:12 +0000131 uint32_t flags;
Adrian Hunter69423d92008-12-10 13:37:21 +0000132 uint64_t size; // Total size of the MTD
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133
David Woodhouse151e7652006-05-14 01:51:54 +0100134 /* "Major" erase size for the device. Naïve users may take this
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 * to be the only erase size available, or may use the more detailed
136 * information below if they desire
137 */
David Woodhouse26cdb672008-12-10 14:08:12 +0000138 uint32_t erasesize;
Artem B. Bityutskiy783ed812006-06-14 19:53:44 +0400139 /* Minimal writable flash unit size. In case of NOR flash it is 1 (even
140 * though individual bits can be cleared), in case of NAND flash it is
141 * one NAND page (or half, or one-fourths of it), in case of ECC-ed NOR
142 * it is of ECC block size, etc. It is illegal to have writesize = 0.
143 * Any driver registering a struct mtd_info must ensure a writesize of
144 * 1 or larger.
Joern Engel28318772006-05-22 23:18:05 +0200145 */
David Woodhouse26cdb672008-12-10 14:08:12 +0000146 uint32_t writesize;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147
Anatolij Gustschin0e4ca7e2010-12-16 23:42:14 +0100148 /*
149 * Size of the write buffer used by the MTD. MTD devices having a write
150 * buffer can write multiple writesize chunks at a time. E.g. while
151 * writing 4 * writesize bytes to a device with 2 * writesize bytes
152 * buffer the MTD driver can (but doesn't have to) do 2 writesize
153 * operations, but not 4. Currently, all NANDs have writebufsize
154 * equivalent to writesize (NAND page size). Some NOR flashes do have
155 * writebufsize greater than writesize.
156 */
157 uint32_t writebufsize;
158
David Woodhouse26cdb672008-12-10 14:08:12 +0000159 uint32_t oobsize; // Amount of OOB data per block (e.g. 16)
160 uint32_t oobavail; // Available OOB bytes per block
Nicolas Pitre638d9832005-08-06 05:40:46 +0100161
Adrian Hunter69423d92008-12-10 13:37:21 +0000162 /*
163 * If erasesize is a power of 2 then the shift is stored in
164 * erasesize_shift otherwise erasesize_shift is zero. Ditto writesize.
165 */
166 unsigned int erasesize_shift;
167 unsigned int writesize_shift;
168 /* Masks based on erasesize_shift and writesize_shift */
169 unsigned int erasesize_mask;
170 unsigned int writesize_mask;
Nicolas Pitre638d9832005-08-06 05:40:46 +0100171
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172 // Kernel-only stuff starts here.
Greg Kroah-Hartmaneadcf0d2008-07-02 12:46:22 -0700173 const char *name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174 int index;
175
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200176 /* ecc layout structure pointer - read only ! */
177 struct nand_ecclayout *ecclayout;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178
179 /* Data for variable erase regions. If numeraseregions is zero,
Thomas Gleixner61ecfa82005-11-07 11:15:31 +0000180 * it means that the whole device has erasesize as given above.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181 */
182 int numeraseregions;
Thomas Gleixner61ecfa82005-11-07 11:15:31 +0000183 struct mtd_erase_region_info *eraseregions;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184
Jörn Engelb38178e2007-09-21 15:41:44 +0200185 /*
186 * Erase is an asynchronous operation. Device drivers are supposed
187 * to call instr->callback() whenever the operation completes, even
188 * if it completes with a failure.
189 * Callers are supposed to pass a callback function and wait for it
190 * to be called before writing to the block.
191 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192 int (*erase) (struct mtd_info *mtd, struct erase_info *instr);
193
194 /* This stuff for eXecute-In-Place */
Jared Hulberta98889f2008-04-29 23:26:49 -0700195 /* phys is optional and may be set to NULL */
196 int (*point) (struct mtd_info *mtd, loff_t from, size_t len,
197 size_t *retlen, void **virt, resource_size_t *phys);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198
199 /* We probably shouldn't allow XIP if the unpoint isn't a NULL */
Jared Hulberta98889f2008-04-29 23:26:49 -0700200 void (*unpoint) (struct mtd_info *mtd, loff_t from, size_t len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201
David Howells402d3262009-02-12 10:40:00 +0000202 /* Allow NOMMU mmap() to directly map the device (if not NULL)
203 * - return the address to which the offset maps
204 * - return -ENOSYS to indicate refusal to do the mapping
205 */
206 unsigned long (*get_unmapped_area) (struct mtd_info *mtd,
207 unsigned long len,
208 unsigned long offset,
209 unsigned long flags);
210
211 /* Backing device capabilities for this device
212 * - provides mmap capabilities
213 */
214 struct backing_dev_info *backing_dev_info;
215
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216
217 int (*read) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
218 int (*write) (struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf);
219
Richard Purdie388bbb02008-02-06 10:17:15 +0000220 /* In blackbox flight recorder like scenarios we want to make successful
221 writes in interrupt context. panic_write() is only intended to be
222 called when its known the kernel is about to panic and we need the
223 write to succeed. Since the kernel is not going to be running for much
224 longer, this function can break locks and delay to ensure the write
225 succeeds (but not sleep). */
226
227 int (*panic_write) (struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf);
228
Thomas Gleixner8593fbc2006-05-29 03:26:58 +0200229 int (*read_oob) (struct mtd_info *mtd, loff_t from,
230 struct mtd_oob_ops *ops);
231 int (*write_oob) (struct mtd_info *mtd, loff_t to,
232 struct mtd_oob_ops *ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233
Thomas Gleixner61ecfa82005-11-07 11:15:31 +0000234 /*
235 * Methods to access the protection register area, present in some
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236 * flash devices. The user data is one time programmable but the
Thomas Gleixner61ecfa82005-11-07 11:15:31 +0000237 * factory data is read only.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 */
Nicolas Pitref77814d2005-02-08 17:11:19 +0000239 int (*get_fact_prot_info) (struct mtd_info *mtd, struct otp_info *buf, size_t len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 int (*read_fact_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
Nicolas Pitref77814d2005-02-08 17:11:19 +0000241 int (*get_user_prot_info) (struct mtd_info *mtd, struct otp_info *buf, size_t len);
242 int (*read_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243 int (*write_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
Nicolas Pitref77814d2005-02-08 17:11:19 +0000244 int (*lock_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245
Thomas Gleixner2528e8c2006-05-23 16:10:00 +0200246 /* kvec-based read/write methods.
Thomas Gleixner61ecfa82005-11-07 11:15:31 +0000247 NB: The 'count' parameter is the number of _vectors_, each of
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248 which contains an (ofs, len) tuple.
249 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250 int (*writev) (struct mtd_info *mtd, const struct kvec *vecs, unsigned long count, loff_t to, size_t *retlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251
252 /* Sync */
253 void (*sync) (struct mtd_info *mtd);
254
255 /* Chip-supported device locking */
Adrian Hunter69423d92008-12-10 13:37:21 +0000256 int (*lock) (struct mtd_info *mtd, loff_t ofs, uint64_t len);
257 int (*unlock) (struct mtd_info *mtd, loff_t ofs, uint64_t len);
Richard Cochran99384242010-06-14 18:10:33 +0200258 int (*is_locked) (struct mtd_info *mtd, loff_t ofs, uint64_t len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259
260 /* Power Management functions */
261 int (*suspend) (struct mtd_info *mtd);
262 void (*resume) (struct mtd_info *mtd);
263
264 /* Bad block management functions */
265 int (*block_isbad) (struct mtd_info *mtd, loff_t ofs);
266 int (*block_markbad) (struct mtd_info *mtd, loff_t ofs);
267
Nicolas Pitre963a6fb2005-04-01 02:59:56 +0100268 struct notifier_block reboot_notifier; /* default mode before reboot */
269
Thomas Gleixner7fac4642006-05-25 09:57:31 +0200270 /* ECC status information */
271 struct mtd_ecc_stats ecc_stats;
Thomas Gleixner29072b92006-09-28 15:38:36 +0200272 /* Subpage shift (NAND) */
273 int subpage_sft;
Thomas Gleixner7fac4642006-05-25 09:57:31 +0200274
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 void *priv;
276
277 struct module *owner;
David Brownell1f24b5a2009-03-26 00:42:41 -0700278 struct device dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279 int usecount;
Artem Bityutskiy9fe912c2006-10-11 14:52:45 +0300280
281 /* If the driver is something smart, like UBI, it may need to maintain
282 * its own reference counting. The below functions are only for driver.
283 * The driver may register its callbacks. These callbacks are not
284 * supposed to be called by MTD users */
285 int (*get_device) (struct mtd_info *mtd);
286 void (*put_device) (struct mtd_info *mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287};
288
David Brownell1f24b5a2009-03-26 00:42:41 -0700289static inline struct mtd_info *dev_to_mtd(struct device *dev)
290{
Saeed Bishara6afc4fd2009-07-28 04:56:43 -0700291 return dev ? dev_get_drvdata(dev) : NULL;
David Brownell1f24b5a2009-03-26 00:42:41 -0700292}
293
David Woodhouse26cdb672008-12-10 14:08:12 +0000294static inline uint32_t mtd_div_by_eb(uint64_t sz, struct mtd_info *mtd)
Adrian Hunter69423d92008-12-10 13:37:21 +0000295{
296 if (mtd->erasesize_shift)
297 return sz >> mtd->erasesize_shift;
298 do_div(sz, mtd->erasesize);
299 return sz;
300}
301
David Woodhouse26cdb672008-12-10 14:08:12 +0000302static inline uint32_t mtd_mod_by_eb(uint64_t sz, struct mtd_info *mtd)
Adrian Hunter69423d92008-12-10 13:37:21 +0000303{
304 if (mtd->erasesize_shift)
305 return sz & mtd->erasesize_mask;
306 return do_div(sz, mtd->erasesize);
307}
308
David Woodhouse26cdb672008-12-10 14:08:12 +0000309static inline uint32_t mtd_div_by_ws(uint64_t sz, struct mtd_info *mtd)
Adrian Hunter69423d92008-12-10 13:37:21 +0000310{
311 if (mtd->writesize_shift)
312 return sz >> mtd->writesize_shift;
313 do_div(sz, mtd->writesize);
314 return sz;
315}
316
David Woodhouse26cdb672008-12-10 14:08:12 +0000317static inline uint32_t mtd_mod_by_ws(uint64_t sz, struct mtd_info *mtd)
Adrian Hunter69423d92008-12-10 13:37:21 +0000318{
319 if (mtd->writesize_shift)
320 return sz & mtd->writesize_mask;
321 return do_div(sz, mtd->writesize);
322}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323
324 /* Kernel-side ioctl definitions */
325
Jamie Ilesf5671ab2011-05-23 17:15:46 +0100326struct mtd_partition;
327
328extern int mtd_device_register(struct mtd_info *master,
329 const struct mtd_partition *parts,
330 int nr_parts);
331extern int mtd_device_unregister(struct mtd_info *master);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332extern struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num);
Maxim Levitsky3bd45652010-02-22 20:39:28 +0200333extern int __get_mtd_device(struct mtd_info *mtd);
334extern void __put_mtd_device(struct mtd_info *mtd);
Artem Bityutskiy77993082006-10-11 14:52:44 +0300335extern struct mtd_info *get_mtd_device_nm(const char *name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336extern void put_mtd_device(struct mtd_info *mtd);
337
338
339struct mtd_notifier {
340 void (*add)(struct mtd_info *mtd);
341 void (*remove)(struct mtd_info *mtd);
342 struct list_head list;
343};
344
345
346extern void register_mtd_user (struct mtd_notifier *new);
347extern int unregister_mtd_user (struct mtd_notifier *old);
348
349int default_mtd_writev(struct mtd_info *mtd, const struct kvec *vecs,
350 unsigned long count, loff_t to, size_t *retlen);
351
352int default_mtd_readv(struct mtd_info *mtd, struct kvec *vecs,
353 unsigned long count, loff_t from, size_t *retlen);
354
Grant Erickson33b53712011-04-08 08:51:32 -0700355void *mtd_kmalloc_up_to(const struct mtd_info *mtd, size_t *size);
356
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357void mtd_erase_callback(struct erase_info *instr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358
359/*
360 * Debugging macro and defines
361 */
362#define MTD_DEBUG_LEVEL0 (0) /* Quiet */
363#define MTD_DEBUG_LEVEL1 (1) /* Audible */
364#define MTD_DEBUG_LEVEL2 (2) /* Loud */
365#define MTD_DEBUG_LEVEL3 (3) /* Noisy */
366
367#ifdef CONFIG_MTD_DEBUG
368#define DEBUG(n, args...) \
Thomas Gleixnerf4a43cf2006-05-28 11:01:53 +0200369 do { \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370 if (n <= CONFIG_MTD_DEBUG_VERBOSE) \
371 printk(KERN_INFO args); \
372 } while(0)
373#else /* CONFIG_MTD_DEBUG */
David Brownell95b1bc22008-07-29 22:28:12 -0700374#define DEBUG(n, args...) \
375 do { \
376 if (0) \
377 printk(KERN_INFO args); \
378 } while(0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379
380#endif /* CONFIG_MTD_DEBUG */
381
382#endif /* __MTD_MTD_H__ */