Blame view
include/mtd/mtd-abi.h
9.17 KB
1da177e4c Linux-2.6.12-rc2 |
1 |
/* |
a1452a377 mtd: Update copyr... |
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
* Copyright © 1999-2010 David Woodhouse <dwmw2@infradead.org> et al. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA * |
1da177e4c Linux-2.6.12-rc2 |
18 19 20 21 |
*/ #ifndef __MTD_ABI_H__ #define __MTD_ABI_H__ |
ccef7ab53 make MTD headers ... |
22 |
#include <linux/types.h> |
1da177e4c Linux-2.6.12-rc2 |
23 |
struct erase_info_user { |
ccef7ab53 make MTD headers ... |
24 25 |
__u32 start; __u32 length; |
1da177e4c Linux-2.6.12-rc2 |
26 |
}; |
0dc54e9f3 mtd: add MEMERASE... |
27 28 29 30 |
struct erase_info_user64 { __u64 start; __u64 length; }; |
1da177e4c Linux-2.6.12-rc2 |
31 |
struct mtd_oob_buf { |
ccef7ab53 make MTD headers ... |
32 33 |
__u32 start; __u32 length; |
1da177e4c Linux-2.6.12-rc2 |
34 35 |
unsigned char __user *ptr; }; |
aea7cea9f mtd: add OOB ioct... |
36 37 38 39 40 41 |
struct mtd_oob_buf64 { __u64 start; __u32 pad; __u32 length; __u64 usr_ptr; }; |
4180f24a7 mtd: document ABI |
42 |
/** |
0612b9ddc mtd: rename MTD_O... |
43 |
* MTD operation modes |
905c6bcdb mtd: move mtd_oob... |
44 |
* |
4180f24a7 mtd: document ABI |
45 46 |
* @MTD_OPS_PLACE_OOB: OOB data are placed at the given offset (default) * @MTD_OPS_AUTO_OOB: OOB data are automatically placed at the free areas |
0612b9ddc mtd: rename MTD_O... |
47 |
* which are defined by the internal ecclayout |
4180f24a7 mtd: document ABI |
48 49 50 51 52 53 |
* @MTD_OPS_RAW: data are transferred as-is, with no error correction; * this mode implies %MTD_OPS_PLACE_OOB * * These modes can be passed to ioctl(MEMWRITE) and are also used internally. * See notes on "MTD file modes" for discussion on %MTD_OPS_RAW vs. * %MTD_FILE_MODE_RAW. |
905c6bcdb mtd: move mtd_oob... |
54 55 |
*/ enum { |
0612b9ddc mtd: rename MTD_O... |
56 57 58 |
MTD_OPS_PLACE_OOB = 0, MTD_OPS_AUTO_OOB = 1, MTD_OPS_RAW = 2, |
905c6bcdb mtd: move mtd_oob... |
59 |
}; |
4180f24a7 mtd: document ABI |
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 |
/** * struct mtd_write_req - data structure for requesting a write operation * * @start: start address * @len: length of data buffer * @ooblen: length of OOB buffer * @usr_data: user-provided data buffer * @usr_oob: user-provided OOB buffer * @mode: MTD mode (see "MTD operation modes") * @padding: reserved, must be set to 0 * * This structure supports ioctl(MEMWRITE) operations, allowing data and/or OOB * writes in various modes. To write to OOB-only, set @usr_data == NULL, and to * write data-only, set @usr_oob == NULL. However, setting both @usr_data and * @usr_oob to NULL is not allowed. */ |
e99d8b089 mtd: add MEMWRITE... |
76 77 78 79 80 81 82 83 84 |
struct mtd_write_req { __u64 start; __u64 len; __u64 ooblen; __u64 usr_data; __u64 usr_oob; __u8 mode; __u8 padding[7]; }; |
1da177e4c Linux-2.6.12-rc2 |
85 |
#define MTD_ABSENT 0 |
21c8db9ef [MTD] Restore MTD... |
86 87 |
#define MTD_RAM 1 #define MTD_ROM 2 |
1da177e4c Linux-2.6.12-rc2 |
88 89 |
#define MTD_NORFLASH 3 #define MTD_NANDFLASH 4 |
8f15fd55f [JFFS2] Add suppo... |
90 |
#define MTD_DATAFLASH 6 |
801c135ce UBI: Unsorted Blo... |
91 |
#define MTD_UBIVOLUME 7 |
17a22826b mtd: Define MLC F... |
92 |
#define MTD_MLCNANDFLASH 8 |
1da177e4c Linux-2.6.12-rc2 |
93 |
|
8ca9ed5db [MTD] Use single ... |
94 |
#define MTD_WRITEABLE 0x400 /* Device is writeable */ |
5fa433942 [MTD] Introduce M... |
95 |
#define MTD_BIT_WRITEABLE 0x800 /* Single bits can be flipped */ |
92cbfdcc3 [MTD] replace MTD... |
96 |
#define MTD_NO_ERASE 0x1000 /* No erase necessary */ |
e619a75ff [MTD] Unlocking a... |
97 |
#define MTD_POWERUP_LOCK 0x2000 /* Always locked after reset */ |
1da177e4c Linux-2.6.12-rc2 |
98 |
|
4180f24a7 mtd: document ABI |
99 |
/* Some common devices / combinations of capabilities */ |
1da177e4c Linux-2.6.12-rc2 |
100 |
#define MTD_CAP_ROM 0 |
92cbfdcc3 [MTD] replace MTD... |
101 |
#define MTD_CAP_RAM (MTD_WRITEABLE | MTD_BIT_WRITEABLE | MTD_NO_ERASE) |
5fa433942 [MTD] Introduce M... |
102 |
#define MTD_CAP_NORFLASH (MTD_WRITEABLE | MTD_BIT_WRITEABLE) |
8ca9ed5db [MTD] Use single ... |
103 |
#define MTD_CAP_NANDFLASH (MTD_WRITEABLE) |
1da177e4c Linux-2.6.12-rc2 |
104 |
|
4180f24a7 mtd: document ABI |
105 |
/* Obsolete ECC byte placement modes (used with obsolete MEMGETOOBSEL) */ |
1da177e4c Linux-2.6.12-rc2 |
106 107 108 109 |
#define MTD_NANDECC_OFF 0 // Switch off ECC (Not recommended) #define MTD_NANDECC_PLACE 1 // Use the given placement in the structure (YAFFS1 legacy mode) #define MTD_NANDECC_AUTOPLACE 2 // Use the default placement scheme #define MTD_NANDECC_PLACEONLY 3 // Use the given placement in the structure (Do not store ecc result on read) |
90e260c84 [MTD] NAND: Honou... |
110 |
#define MTD_NANDECC_AUTOPL_USR 4 // Use the given autoplacement scheme rather than using the default |
1da177e4c Linux-2.6.12-rc2 |
111 |
|
31f4233ba [MTD] User interf... |
112 113 114 115 |
/* OTP mode selection */ #define MTD_OTP_OFF 0 #define MTD_OTP_FACTORY 1 #define MTD_OTP_USER 2 |
1da177e4c Linux-2.6.12-rc2 |
116 |
struct mtd_info_user { |
ccef7ab53 make MTD headers ... |
117 118 |
__u8 type; __u32 flags; |
4180f24a7 mtd: document ABI |
119 |
__u32 size; /* Total size of the MTD */ |
ccef7ab53 make MTD headers ... |
120 121 |
__u32 erasesize; __u32 writesize; |
4180f24a7 mtd: document ABI |
122 |
__u32 oobsize; /* Amount of OOB data per block (e.g. 16) */ |
19fb4341a mtd: kill old fie... |
123 |
__u64 padding; /* Old obsolete field; do not use */ |
1da177e4c Linux-2.6.12-rc2 |
124 125 126 |
}; struct region_info_user { |
ccef7ab53 make MTD headers ... |
127 |
__u32 offset; /* At which this region starts, |
4180f24a7 mtd: document ABI |
128 129 130 |
* from the beginning of the MTD */ __u32 erasesize; /* For this region */ __u32 numblocks; /* Number of blocks in this region */ |
ccef7ab53 make MTD headers ... |
131 |
__u32 regionindex; |
1da177e4c Linux-2.6.12-rc2 |
132 |
}; |
f77814dd5 [MTD] Support for... |
133 |
struct otp_info { |
ccef7ab53 make MTD headers ... |
134 135 136 |
__u32 start; __u32 length; __u32 locked; |
f77814dd5 [MTD] Support for... |
137 |
}; |
93fad71c2 mtd: remove MEMSE... |
138 139 140 141 142 |
/* * Note, the following ioctl existed in the past and was removed: * #define MEMSETOOBSEL _IOW('M', 9, struct nand_oobinfo) * Try to avoid adding a new ioctl with the same ioctl number. */ |
4180f24a7 mtd: document ABI |
143 |
/* Get basic MTD characteristics info (better to use sysfs) */ |
5bd34c091 [MTD] NAND Replac... |
144 |
#define MEMGETINFO _IOR('M', 1, struct mtd_info_user) |
4180f24a7 mtd: document ABI |
145 |
/* Erase segment of MTD */ |
5bd34c091 [MTD] NAND Replac... |
146 |
#define MEMERASE _IOW('M', 2, struct erase_info_user) |
4180f24a7 mtd: document ABI |
147 |
/* Write out-of-band data from MTD */ |
5bd34c091 [MTD] NAND Replac... |
148 |
#define MEMWRITEOOB _IOWR('M', 3, struct mtd_oob_buf) |
4180f24a7 mtd: document ABI |
149 |
/* Read out-of-band data from MTD */ |
5bd34c091 [MTD] NAND Replac... |
150 |
#define MEMREADOOB _IOWR('M', 4, struct mtd_oob_buf) |
4180f24a7 mtd: document ABI |
151 |
/* Lock a chip (for MTD that supports it) */ |
5bd34c091 [MTD] NAND Replac... |
152 |
#define MEMLOCK _IOW('M', 5, struct erase_info_user) |
4180f24a7 mtd: document ABI |
153 |
/* Unlock a chip (for MTD that supports it) */ |
5bd34c091 [MTD] NAND Replac... |
154 |
#define MEMUNLOCK _IOW('M', 6, struct erase_info_user) |
4180f24a7 mtd: document ABI |
155 |
/* Get the number of different erase regions */ |
1da177e4c Linux-2.6.12-rc2 |
156 |
#define MEMGETREGIONCOUNT _IOR('M', 7, int) |
4180f24a7 mtd: document ABI |
157 |
/* Get information about the erase region for a specific index */ |
1da177e4c Linux-2.6.12-rc2 |
158 |
#define MEMGETREGIONINFO _IOWR('M', 8, struct region_info_user) |
4180f24a7 mtd: document ABI |
159 |
/* Get info about OOB modes (e.g., RAW, PLACE, AUTO) - legacy interface */ |
1da177e4c Linux-2.6.12-rc2 |
160 |
#define MEMGETOOBSEL _IOR('M', 10, struct nand_oobinfo) |
4180f24a7 mtd: document ABI |
161 |
/* Check if an eraseblock is bad */ |
85efde6f4 make exported hea... |
162 |
#define MEMGETBADBLOCK _IOW('M', 11, __kernel_loff_t) |
4180f24a7 mtd: document ABI |
163 |
/* Mark an eraseblock as bad */ |
85efde6f4 make exported hea... |
164 |
#define MEMSETBADBLOCK _IOW('M', 12, __kernel_loff_t) |
4180f24a7 mtd: document ABI |
165 |
/* Set OTP (One-Time Programmable) mode (factory vs. user) */ |
31f4233ba [MTD] User interf... |
166 |
#define OTPSELECT _IOR('M', 13, int) |
4180f24a7 mtd: document ABI |
167 |
/* Get number of OTP (One-Time Programmable) regions */ |
31f4233ba [MTD] User interf... |
168 |
#define OTPGETREGIONCOUNT _IOW('M', 14, int) |
4180f24a7 mtd: document ABI |
169 |
/* Get all OTP (One-Time Programmable) info about MTD */ |
31f4233ba [MTD] User interf... |
170 |
#define OTPGETREGIONINFO _IOW('M', 15, struct otp_info) |
4180f24a7 mtd: document ABI |
171 |
/* Lock a given range of user data (must be in mode %MTD_FILE_MODE_OTP_USER) */ |
5bd34c091 [MTD] NAND Replac... |
172 |
#define OTPLOCK _IOR('M', 16, struct otp_info) |
4180f24a7 mtd: document ABI |
173 |
/* Get ECC layout (deprecated) */ |
cc26c3cd3 mtd: nand: expand... |
174 |
#define ECCGETLAYOUT _IOR('M', 17, struct nand_ecclayout_user) |
4180f24a7 mtd: document ABI |
175 |
/* Get statistics about corrected/uncorrected errors */ |
f1a28c028 [MTD] NAND Expose... |
176 |
#define ECCGETSTATS _IOR('M', 18, struct mtd_ecc_stats) |
4180f24a7 mtd: document ABI |
177 |
/* Set MTD mode on a per-file-descriptor basis (see "MTD file modes") */ |
f1a28c028 [MTD] NAND Expose... |
178 |
#define MTDFILEMODE _IO('M', 19) |
4180f24a7 mtd: document ABI |
179 |
/* Erase segment of MTD (supports 64-bit address) */ |
0dc54e9f3 mtd: add MEMERASE... |
180 |
#define MEMERASE64 _IOW('M', 20, struct erase_info_user64) |
4180f24a7 mtd: document ABI |
181 |
/* Write data to OOB (64-bit version) */ |
aea7cea9f mtd: add OOB ioct... |
182 |
#define MEMWRITEOOB64 _IOWR('M', 21, struct mtd_oob_buf64) |
4180f24a7 mtd: document ABI |
183 |
/* Read data from OOB (64-bit version) */ |
aea7cea9f mtd: add OOB ioct... |
184 |
#define MEMREADOOB64 _IOWR('M', 22, struct mtd_oob_buf64) |
4180f24a7 mtd: document ABI |
185 |
/* Check if chip is locked (for MTD that supports it) */ |
9938424f0 mtd: add an ioctl... |
186 |
#define MEMISLOCKED _IOR('M', 23, struct erase_info_user) |
4180f24a7 mtd: document ABI |
187 188 |
/* * Most generic write interface; can write in-band and/or out-of-band in various |
2b00668ff mtd: document tha... |
189 190 |
* modes (see "struct mtd_write_req"). This ioctl is not supported for flashes * without OOB, e.g., NOR flash. |
4180f24a7 mtd: document ABI |
191 |
*/ |
e99d8b089 mtd: add MEMWRITE... |
192 |
#define MEMWRITE _IOWR('M', 24, struct mtd_write_req) |
1da177e4c Linux-2.6.12-rc2 |
193 |
|
5bd34c091 [MTD] NAND Replac... |
194 195 196 197 |
/* * Obsolete legacy interface. Keep it in order not to break userspace * interfaces */ |
1da177e4c Linux-2.6.12-rc2 |
198 |
struct nand_oobinfo { |
ccef7ab53 make MTD headers ... |
199 200 201 202 |
__u32 useecc; __u32 eccbytes; __u32 oobfree[8][2]; __u32 eccpos[32]; |
1da177e4c Linux-2.6.12-rc2 |
203 |
}; |
5bd34c091 [MTD] NAND Replac... |
204 |
struct nand_oobfree { |
ccef7ab53 make MTD headers ... |
205 206 |
__u32 offset; __u32 length; |
5bd34c091 [MTD] NAND Replac... |
207 208 209 |
}; #define MTD_MAX_OOBFREE_ENTRIES 8 |
0ceacf36e mtd: edit comment... |
210 |
#define MTD_MAX_ECCPOS_ENTRIES 64 |
5bd34c091 [MTD] NAND Replac... |
211 |
/* |
0ceacf36e mtd: edit comment... |
212 213 214 215 216 217 |
* OBSOLETE: ECC layout control structure. Exported to user-space via ioctl * ECCGETLAYOUT for backwards compatbility and should not be mistaken as a * complete set of ECC information. The ioctl truncates the larger internal * structure to retain binary compatibility with the static declaration of the * ioctl. Note that the "MTD_MAX_..._ENTRIES" macros represent the max size of * the user struct, not the MAX size of the internal struct nand_ecclayout. |
5bd34c091 [MTD] NAND Replac... |
218 |
*/ |
cc26c3cd3 mtd: nand: expand... |
219 |
struct nand_ecclayout_user { |
ccef7ab53 make MTD headers ... |
220 |
__u32 eccbytes; |
0ceacf36e mtd: edit comment... |
221 |
__u32 eccpos[MTD_MAX_ECCPOS_ENTRIES]; |
ccef7ab53 make MTD headers ... |
222 |
__u32 oobavail; |
5bd34c091 [MTD] NAND Replac... |
223 224 |
struct nand_oobfree oobfree[MTD_MAX_OOBFREE_ENTRIES]; }; |
f1a28c028 [MTD] NAND Expose... |
225 |
/** |
ea9b6dcc1 MTD: kernel-doc f... |
226 |
* struct mtd_ecc_stats - error correction stats |
f1a28c028 [MTD] NAND Expose... |
227 228 229 230 231 232 233 |
* * @corrected: number of corrected bits * @failed: number of uncorrectable errors * @badblocks: number of bad blocks in this partition * @bbtblocks: number of blocks reserved for bad block tables */ struct mtd_ecc_stats { |
ccef7ab53 make MTD headers ... |
234 235 236 237 |
__u32 corrected; __u32 failed; __u32 badblocks; __u32 bbtblocks; |
f1a28c028 [MTD] NAND Expose... |
238 239 240 |
}; /* |
4180f24a7 mtd: document ABI |
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 |
* MTD file modes - for read/write access to MTD * * @MTD_FILE_MODE_NORMAL: OTP disabled, ECC enabled * @MTD_FILE_MODE_OTP_FACTORY: OTP enabled in factory mode * @MTD_FILE_MODE_OTP_USER: OTP enabled in user mode * @MTD_FILE_MODE_RAW: OTP disabled, ECC disabled * * These modes can be set via ioctl(MTDFILEMODE). The mode mode will be retained * separately for each open file descriptor. * * Note: %MTD_FILE_MODE_RAW provides the same functionality as %MTD_OPS_RAW - * raw access to the flash, without error correction or autoplacement schemes. * Wherever possible, the MTD_OPS_* mode will override the MTD_FILE_MODE_* mode * (e.g., when using ioctl(MEMWRITE)), but in some cases, the MTD_FILE_MODE is * used out of necessity (e.g., `write()', ioctl(MEMWRITEOOB64)). |
f1a28c028 [MTD] NAND Expose... |
256 257 |
*/ enum mtd_file_modes { |
beb133fc1 mtd: rename MTD_M... |
258 259 260 261 |
MTD_FILE_MODE_NORMAL = MTD_OTP_OFF, MTD_FILE_MODE_OTP_FACTORY = MTD_OTP_FACTORY, MTD_FILE_MODE_OTP_USER = MTD_OTP_USER, MTD_FILE_MODE_RAW, |
f1a28c028 [MTD] NAND Expose... |
262 |
}; |
1da177e4c Linux-2.6.12-rc2 |
263 |
#endif /* __MTD_ABI_H__ */ |