blob: 763bb6950402ba44ac2d2375589f5c4c08a37a58 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
David Woodhousea1452a32010-08-08 20:58:20 +01002 * Copyright © 1999-2010 David Woodhouse <dwmw2@infradead.org> et al.
3 *
4 * 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_ABI_H__
21#define __MTD_ABI_H__
22
Arnd Bergmannccef7ab2009-02-26 00:51:41 +010023#include <linux/types.h>
24
Linus Torvalds1da177e2005-04-16 15:20:36 -070025struct erase_info_user {
Arnd Bergmannccef7ab2009-02-26 00:51:41 +010026 __u32 start;
27 __u32 length;
Linus Torvalds1da177e2005-04-16 15:20:36 -070028};
29
Kevin Cernekee0dc54e92009-04-08 22:52:28 -070030struct erase_info_user64 {
31 __u64 start;
32 __u64 length;
33};
34
Linus Torvalds1da177e2005-04-16 15:20:36 -070035struct mtd_oob_buf {
Arnd Bergmannccef7ab2009-02-26 00:51:41 +010036 __u32 start;
37 __u32 length;
Linus Torvalds1da177e2005-04-16 15:20:36 -070038 unsigned char __user *ptr;
39};
40
Kevin Cernekeeaea7cea2009-04-08 22:53:49 -070041struct mtd_oob_buf64 {
42 __u64 start;
43 __u32 pad;
44 __u32 length;
45 __u64 usr_ptr;
46};
47
Brian Norris4180f242011-08-30 18:45:44 -070048/**
Brian Norris0612b9d2011-08-30 18:45:40 -070049 * MTD operation modes
Brian Norris905c6bc2011-08-30 18:45:39 -070050 *
Brian Norris4180f242011-08-30 18:45:44 -070051 * @MTD_OPS_PLACE_OOB: OOB data are placed at the given offset (default)
52 * @MTD_OPS_AUTO_OOB: OOB data are automatically placed at the free areas
Brian Norris0612b9d2011-08-30 18:45:40 -070053 * which are defined by the internal ecclayout
Brian Norris4180f242011-08-30 18:45:44 -070054 * @MTD_OPS_RAW: data are transferred as-is, with no error correction;
55 * this mode implies %MTD_OPS_PLACE_OOB
56 *
57 * These modes can be passed to ioctl(MEMWRITE) and are also used internally.
58 * See notes on "MTD file modes" for discussion on %MTD_OPS_RAW vs.
59 * %MTD_FILE_MODE_RAW.
Brian Norris905c6bc2011-08-30 18:45:39 -070060 */
61enum {
Brian Norris0612b9d2011-08-30 18:45:40 -070062 MTD_OPS_PLACE_OOB = 0,
63 MTD_OPS_AUTO_OOB = 1,
64 MTD_OPS_RAW = 2,
Brian Norris905c6bc2011-08-30 18:45:39 -070065};
66
Brian Norris4180f242011-08-30 18:45:44 -070067/**
68 * struct mtd_write_req - data structure for requesting a write operation
69 *
70 * @start: start address
71 * @len: length of data buffer
72 * @ooblen: length of OOB buffer
73 * @usr_data: user-provided data buffer
74 * @usr_oob: user-provided OOB buffer
75 * @mode: MTD mode (see "MTD operation modes")
76 * @padding: reserved, must be set to 0
77 *
78 * This structure supports ioctl(MEMWRITE) operations, allowing data and/or OOB
79 * writes in various modes. To write to OOB-only, set @usr_data == NULL, and to
80 * write data-only, set @usr_oob == NULL. However, setting both @usr_data and
81 * @usr_oob to NULL is not allowed.
82 */
Brian Norrise99d8b02011-09-09 09:59:03 -070083struct mtd_write_req {
84 __u64 start;
85 __u64 len;
86 __u64 ooblen;
87 __u64 usr_data;
88 __u64 usr_oob;
89 __u8 mode;
90 __u8 padding[7];
91};
92
Linus Torvalds1da177e2005-04-16 15:20:36 -070093#define MTD_ABSENT 0
David Woodhouse21c8db92006-06-14 21:39:48 +010094#define MTD_RAM 1
95#define MTD_ROM 2
Linus Torvalds1da177e2005-04-16 15:20:36 -070096#define MTD_NORFLASH 3
Huang Shijiefda5b0e2013-09-25 14:58:16 +080097#define MTD_NANDFLASH 4 /* SLC NAND */
Andrew Victor8f15fd52005-02-09 09:17:45 +000098#define MTD_DATAFLASH 6
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040099#define MTD_UBIVOLUME 7
Huang Shijiefda5b0e2013-09-25 14:58:16 +0800100#define MTD_MLCNANDFLASH 8 /* MLC NAND (including TLC) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
Joern Engel8ca9ed52006-05-22 23:17:23 +0200102#define MTD_WRITEABLE 0x400 /* Device is writeable */
Joern Engel5fa43392006-05-22 23:18:29 +0200103#define MTD_BIT_WRITEABLE 0x800 /* Single bits can be flipped */
Joern Engel92cbfdc2006-05-30 14:25:24 +0200104#define MTD_NO_ERASE 0x1000 /* No erase necessary */
Justin Treone619a752008-01-30 10:25:49 -0800105#define MTD_POWERUP_LOCK 0x2000 /* Always locked after reset */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106
Brian Norris4180f242011-08-30 18:45:44 -0700107/* Some common devices / combinations of capabilities */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108#define MTD_CAP_ROM 0
Joern Engel92cbfdc2006-05-30 14:25:24 +0200109#define MTD_CAP_RAM (MTD_WRITEABLE | MTD_BIT_WRITEABLE | MTD_NO_ERASE)
Joern Engel5fa43392006-05-22 23:18:29 +0200110#define MTD_CAP_NORFLASH (MTD_WRITEABLE | MTD_BIT_WRITEABLE)
Joern Engel8ca9ed52006-05-22 23:17:23 +0200111#define MTD_CAP_NANDFLASH (MTD_WRITEABLE)
Vincenzo Aliberti96ba9dd2014-05-15 23:19:32 +0200112#define MTD_CAP_NVRAM (MTD_WRITEABLE | MTD_BIT_WRITEABLE | MTD_NO_ERASE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113
Brian Norris4180f242011-08-30 18:45:44 -0700114/* Obsolete ECC byte placement modes (used with obsolete MEMGETOOBSEL) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115#define MTD_NANDECC_OFF 0 // Switch off ECC (Not recommended)
116#define MTD_NANDECC_PLACE 1 // Use the given placement in the structure (YAFFS1 legacy mode)
117#define MTD_NANDECC_AUTOPLACE 2 // Use the default placement scheme
118#define MTD_NANDECC_PLACEONLY 3 // Use the given placement in the structure (Do not store ecc result on read)
Thomas Gleixner90e260c2005-05-19 17:10:26 +0100119#define MTD_NANDECC_AUTOPL_USR 4 // Use the given autoplacement scheme rather than using the default
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120
Nicolas Pitre31f42332005-02-08 17:45:55 +0000121/* OTP mode selection */
122#define MTD_OTP_OFF 0
123#define MTD_OTP_FACTORY 1
124#define MTD_OTP_USER 2
125
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126struct mtd_info_user {
Arnd Bergmannccef7ab2009-02-26 00:51:41 +0100127 __u8 type;
128 __u32 flags;
Brian Norris4180f242011-08-30 18:45:44 -0700129 __u32 size; /* Total size of the MTD */
Arnd Bergmannccef7ab2009-02-26 00:51:41 +0100130 __u32 erasesize;
131 __u32 writesize;
Brian Norris4180f242011-08-30 18:45:44 -0700132 __u32 oobsize; /* Amount of OOB data per block (e.g. 16) */
Brian Norris19fb4342011-08-30 18:45:46 -0700133 __u64 padding; /* Old obsolete field; do not use */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134};
135
136struct region_info_user {
Arnd Bergmannccef7ab2009-02-26 00:51:41 +0100137 __u32 offset; /* At which this region starts,
Brian Norris4180f242011-08-30 18:45:44 -0700138 * from the beginning of the MTD */
139 __u32 erasesize; /* For this region */
140 __u32 numblocks; /* Number of blocks in this region */
Arnd Bergmannccef7ab2009-02-26 00:51:41 +0100141 __u32 regionindex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142};
143
Nicolas Pitref77814d2005-02-08 17:11:19 +0000144struct otp_info {
Arnd Bergmannccef7ab2009-02-26 00:51:41 +0100145 __u32 start;
146 __u32 length;
147 __u32 locked;
Nicolas Pitref77814d2005-02-08 17:11:19 +0000148};
149
Brian Norris93fad712011-08-23 17:17:34 -0700150/*
151 * Note, the following ioctl existed in the past and was removed:
152 * #define MEMSETOOBSEL _IOW('M', 9, struct nand_oobinfo)
153 * Try to avoid adding a new ioctl with the same ioctl number.
154 */
155
Brian Norris4180f242011-08-30 18:45:44 -0700156/* Get basic MTD characteristics info (better to use sysfs) */
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200157#define MEMGETINFO _IOR('M', 1, struct mtd_info_user)
Brian Norris4180f242011-08-30 18:45:44 -0700158/* Erase segment of MTD */
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200159#define MEMERASE _IOW('M', 2, struct erase_info_user)
Brian Norris4180f242011-08-30 18:45:44 -0700160/* Write out-of-band data from MTD */
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200161#define MEMWRITEOOB _IOWR('M', 3, struct mtd_oob_buf)
Brian Norris4180f242011-08-30 18:45:44 -0700162/* Read out-of-band data from MTD */
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200163#define MEMREADOOB _IOWR('M', 4, struct mtd_oob_buf)
Brian Norris4180f242011-08-30 18:45:44 -0700164/* Lock a chip (for MTD that supports it) */
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200165#define MEMLOCK _IOW('M', 5, struct erase_info_user)
Brian Norris4180f242011-08-30 18:45:44 -0700166/* Unlock a chip (for MTD that supports it) */
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200167#define MEMUNLOCK _IOW('M', 6, struct erase_info_user)
Brian Norris4180f242011-08-30 18:45:44 -0700168/* Get the number of different erase regions */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169#define MEMGETREGIONCOUNT _IOR('M', 7, int)
Brian Norris4180f242011-08-30 18:45:44 -0700170/* Get information about the erase region for a specific index */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171#define MEMGETREGIONINFO _IOWR('M', 8, struct region_info_user)
Brian Norris4180f242011-08-30 18:45:44 -0700172/* Get info about OOB modes (e.g., RAW, PLACE, AUTO) - legacy interface */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173#define MEMGETOOBSEL _IOR('M', 10, struct nand_oobinfo)
Brian Norris4180f242011-08-30 18:45:44 -0700174/* Check if an eraseblock is bad */
Arnd Bergmann85efde62009-02-26 00:51:39 +0100175#define MEMGETBADBLOCK _IOW('M', 11, __kernel_loff_t)
Brian Norris4180f242011-08-30 18:45:44 -0700176/* Mark an eraseblock as bad */
Arnd Bergmann85efde62009-02-26 00:51:39 +0100177#define MEMSETBADBLOCK _IOW('M', 12, __kernel_loff_t)
Brian Norris4180f242011-08-30 18:45:44 -0700178/* Set OTP (One-Time Programmable) mode (factory vs. user) */
Nicolas Pitre31f42332005-02-08 17:45:55 +0000179#define OTPSELECT _IOR('M', 13, int)
Brian Norris4180f242011-08-30 18:45:44 -0700180/* Get number of OTP (One-Time Programmable) regions */
Nicolas Pitre31f42332005-02-08 17:45:55 +0000181#define OTPGETREGIONCOUNT _IOW('M', 14, int)
Brian Norris4180f242011-08-30 18:45:44 -0700182/* Get all OTP (One-Time Programmable) info about MTD */
Nicolas Pitre31f42332005-02-08 17:45:55 +0000183#define OTPGETREGIONINFO _IOW('M', 15, struct otp_info)
Brian Norris4180f242011-08-30 18:45:44 -0700184/* Lock a given range of user data (must be in mode %MTD_FILE_MODE_OTP_USER) */
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200185#define OTPLOCK _IOR('M', 16, struct otp_info)
Brian Norris4180f242011-08-30 18:45:44 -0700186/* Get ECC layout (deprecated) */
Brian Norriscc26c3c2010-08-24 18:12:00 -0700187#define ECCGETLAYOUT _IOR('M', 17, struct nand_ecclayout_user)
Brian Norris4180f242011-08-30 18:45:44 -0700188/* Get statistics about corrected/uncorrected errors */
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200189#define ECCGETSTATS _IOR('M', 18, struct mtd_ecc_stats)
Brian Norris4180f242011-08-30 18:45:44 -0700190/* Set MTD mode on a per-file-descriptor basis (see "MTD file modes") */
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200191#define MTDFILEMODE _IO('M', 19)
Brian Norris4180f242011-08-30 18:45:44 -0700192/* Erase segment of MTD (supports 64-bit address) */
Kevin Cernekee0dc54e92009-04-08 22:52:28 -0700193#define MEMERASE64 _IOW('M', 20, struct erase_info_user64)
Brian Norris4180f242011-08-30 18:45:44 -0700194/* Write data to OOB (64-bit version) */
Kevin Cernekeeaea7cea2009-04-08 22:53:49 -0700195#define MEMWRITEOOB64 _IOWR('M', 21, struct mtd_oob_buf64)
Brian Norris4180f242011-08-30 18:45:44 -0700196/* Read data from OOB (64-bit version) */
Kevin Cernekeeaea7cea2009-04-08 22:53:49 -0700197#define MEMREADOOB64 _IOWR('M', 22, struct mtd_oob_buf64)
Brian Norris4180f242011-08-30 18:45:44 -0700198/* Check if chip is locked (for MTD that supports it) */
Richard Cochran99384242010-06-14 18:10:33 +0200199#define MEMISLOCKED _IOR('M', 23, struct erase_info_user)
Brian Norris4180f242011-08-30 18:45:44 -0700200/*
201 * Most generic write interface; can write in-band and/or out-of-band in various
Artem Bityutskiy2b006682011-12-12 23:24:59 +0200202 * modes (see "struct mtd_write_req"). This ioctl is not supported for flashes
203 * without OOB, e.g., NOR flash.
Brian Norris4180f242011-08-30 18:45:44 -0700204 */
Brian Norrise99d8b02011-09-09 09:59:03 -0700205#define MEMWRITE _IOWR('M', 24, struct mtd_write_req)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200207/*
208 * Obsolete legacy interface. Keep it in order not to break userspace
209 * interfaces
210 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211struct nand_oobinfo {
Arnd Bergmannccef7ab2009-02-26 00:51:41 +0100212 __u32 useecc;
213 __u32 eccbytes;
214 __u32 oobfree[8][2];
215 __u32 eccpos[32];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216};
217
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200218struct nand_oobfree {
Arnd Bergmannccef7ab2009-02-26 00:51:41 +0100219 __u32 offset;
220 __u32 length;
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200221};
222
223#define MTD_MAX_OOBFREE_ENTRIES 8
Brian Norris0ceacf32010-09-19 23:57:12 -0700224#define MTD_MAX_ECCPOS_ENTRIES 64
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200225/*
Brian Norris0ceacf32010-09-19 23:57:12 -0700226 * OBSOLETE: ECC layout control structure. Exported to user-space via ioctl
227 * ECCGETLAYOUT for backwards compatbility and should not be mistaken as a
228 * complete set of ECC information. The ioctl truncates the larger internal
229 * structure to retain binary compatibility with the static declaration of the
230 * ioctl. Note that the "MTD_MAX_..._ENTRIES" macros represent the max size of
231 * the user struct, not the MAX size of the internal struct nand_ecclayout.
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200232 */
Brian Norriscc26c3c2010-08-24 18:12:00 -0700233struct nand_ecclayout_user {
Arnd Bergmannccef7ab2009-02-26 00:51:41 +0100234 __u32 eccbytes;
Brian Norris0ceacf32010-09-19 23:57:12 -0700235 __u32 eccpos[MTD_MAX_ECCPOS_ENTRIES];
Arnd Bergmannccef7ab2009-02-26 00:51:41 +0100236 __u32 oobavail;
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200237 struct nand_oobfree oobfree[MTD_MAX_OOBFREE_ENTRIES];
238};
239
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200240/**
Randy Dunlapea9b6dc2006-06-28 21:48:38 -0700241 * struct mtd_ecc_stats - error correction stats
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200242 *
243 * @corrected: number of corrected bits
244 * @failed: number of uncorrectable errors
245 * @badblocks: number of bad blocks in this partition
246 * @bbtblocks: number of blocks reserved for bad block tables
247 */
248struct mtd_ecc_stats {
Arnd Bergmannccef7ab2009-02-26 00:51:41 +0100249 __u32 corrected;
250 __u32 failed;
251 __u32 badblocks;
252 __u32 bbtblocks;
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200253};
254
255/*
Brian Norris4180f242011-08-30 18:45:44 -0700256 * MTD file modes - for read/write access to MTD
257 *
258 * @MTD_FILE_MODE_NORMAL: OTP disabled, ECC enabled
259 * @MTD_FILE_MODE_OTP_FACTORY: OTP enabled in factory mode
260 * @MTD_FILE_MODE_OTP_USER: OTP enabled in user mode
261 * @MTD_FILE_MODE_RAW: OTP disabled, ECC disabled
262 *
263 * These modes can be set via ioctl(MTDFILEMODE). The mode mode will be retained
264 * separately for each open file descriptor.
265 *
266 * Note: %MTD_FILE_MODE_RAW provides the same functionality as %MTD_OPS_RAW -
267 * raw access to the flash, without error correction or autoplacement schemes.
268 * Wherever possible, the MTD_OPS_* mode will override the MTD_FILE_MODE_* mode
269 * (e.g., when using ioctl(MEMWRITE)), but in some cases, the MTD_FILE_MODE is
270 * used out of necessity (e.g., `write()', ioctl(MEMWRITEOOB64)).
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200271 */
272enum mtd_file_modes {
Brian Norrisbeb133f2011-08-30 18:45:41 -0700273 MTD_FILE_MODE_NORMAL = MTD_OTP_OFF,
274 MTD_FILE_MODE_OTP_FACTORY = MTD_OTP_FACTORY,
275 MTD_FILE_MODE_OTP_USER = MTD_OTP_USER,
276 MTD_FILE_MODE_RAW,
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200277};
278
Huang Shijie4f8a3ba2013-09-25 14:58:18 +0800279static inline int mtd_type_is_nand_user(const struct mtd_info_user *mtd)
280{
281 return mtd->type == MTD_NANDFLASH || mtd->type == MTD_MLCNANDFLASH;
282}
283
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284#endif /* __MTD_ABI_H__ */