diff options
Diffstat (limited to 'include/mtd/mtd-abi.h')
-rw-r--r-- | include/mtd/mtd-abi.h | 122 |
1 files changed, 105 insertions, 17 deletions
diff --git a/include/mtd/mtd-abi.h b/include/mtd/mtd-abi.h index 2f7d45bcbd24..1a7e1d20adf9 100644 --- a/include/mtd/mtd-abi.h +++ b/include/mtd/mtd-abi.h | |||
@@ -45,6 +45,51 @@ struct mtd_oob_buf64 { | |||
45 | __u64 usr_ptr; | 45 | __u64 usr_ptr; |
46 | }; | 46 | }; |
47 | 47 | ||
48 | /** | ||
49 | * MTD operation modes | ||
50 | * | ||
51 | * @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 | ||
53 | * which are defined by the internal ecclayout | ||
54 | * @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. | ||
60 | */ | ||
61 | enum { | ||
62 | MTD_OPS_PLACE_OOB = 0, | ||
63 | MTD_OPS_AUTO_OOB = 1, | ||
64 | MTD_OPS_RAW = 2, | ||
65 | }; | ||
66 | |||
67 | /** | ||
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 | */ | ||
83 | struct 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 | |||
48 | #define MTD_ABSENT 0 | 93 | #define MTD_ABSENT 0 |
49 | #define MTD_RAM 1 | 94 | #define MTD_RAM 1 |
50 | #define MTD_ROM 2 | 95 | #define MTD_ROM 2 |
@@ -59,13 +104,13 @@ struct mtd_oob_buf64 { | |||
59 | #define MTD_NO_ERASE 0x1000 /* No erase necessary */ | 104 | #define MTD_NO_ERASE 0x1000 /* No erase necessary */ |
60 | #define MTD_POWERUP_LOCK 0x2000 /* Always locked after reset */ | 105 | #define MTD_POWERUP_LOCK 0x2000 /* Always locked after reset */ |
61 | 106 | ||
62 | // Some common devices / combinations of capabilities | 107 | /* Some common devices / combinations of capabilities */ |
63 | #define MTD_CAP_ROM 0 | 108 | #define MTD_CAP_ROM 0 |
64 | #define MTD_CAP_RAM (MTD_WRITEABLE | MTD_BIT_WRITEABLE | MTD_NO_ERASE) | 109 | #define MTD_CAP_RAM (MTD_WRITEABLE | MTD_BIT_WRITEABLE | MTD_NO_ERASE) |
65 | #define MTD_CAP_NORFLASH (MTD_WRITEABLE | MTD_BIT_WRITEABLE) | 110 | #define MTD_CAP_NORFLASH (MTD_WRITEABLE | MTD_BIT_WRITEABLE) |
66 | #define MTD_CAP_NANDFLASH (MTD_WRITEABLE) | 111 | #define MTD_CAP_NANDFLASH (MTD_WRITEABLE) |
67 | 112 | ||
68 | /* ECC byte placement */ | 113 | /* Obsolete ECC byte placement modes (used with obsolete MEMGETOOBSEL) */ |
69 | #define MTD_NANDECC_OFF 0 // Switch off ECC (Not recommended) | 114 | #define MTD_NANDECC_OFF 0 // Switch off ECC (Not recommended) |
70 | #define MTD_NANDECC_PLACE 1 // Use the given placement in the structure (YAFFS1 legacy mode) | 115 | #define MTD_NANDECC_PLACE 1 // Use the given placement in the structure (YAFFS1 legacy mode) |
71 | #define MTD_NANDECC_AUTOPLACE 2 // Use the default placement scheme | 116 | #define MTD_NANDECC_AUTOPLACE 2 // Use the default placement scheme |
@@ -80,21 +125,18 @@ struct mtd_oob_buf64 { | |||
80 | struct mtd_info_user { | 125 | struct mtd_info_user { |
81 | __u8 type; | 126 | __u8 type; |
82 | __u32 flags; | 127 | __u32 flags; |
83 | __u32 size; // Total size of the MTD | 128 | __u32 size; /* Total size of the MTD */ |
84 | __u32 erasesize; | 129 | __u32 erasesize; |
85 | __u32 writesize; | 130 | __u32 writesize; |
86 | __u32 oobsize; // Amount of OOB data per block (e.g. 16) | 131 | __u32 oobsize; /* Amount of OOB data per block (e.g. 16) */ |
87 | /* The below two fields are obsolete and broken, do not use them | 132 | __u64 padding; /* Old obsolete field; do not use */ |
88 | * (TODO: remove at some point) */ | ||
89 | __u32 ecctype; | ||
90 | __u32 eccsize; | ||
91 | }; | 133 | }; |
92 | 134 | ||
93 | struct region_info_user { | 135 | struct region_info_user { |
94 | __u32 offset; /* At which this region starts, | 136 | __u32 offset; /* At which this region starts, |
95 | * from the beginning of the MTD */ | 137 | * from the beginning of the MTD */ |
96 | __u32 erasesize; /* For this region */ | 138 | __u32 erasesize; /* For this region */ |
97 | __u32 numblocks; /* Number of blocks in this region */ | 139 | __u32 numblocks; /* Number of blocks in this region */ |
98 | __u32 regionindex; | 140 | __u32 regionindex; |
99 | }; | 141 | }; |
100 | 142 | ||
@@ -104,29 +146,61 @@ struct otp_info { | |||
104 | __u32 locked; | 146 | __u32 locked; |
105 | }; | 147 | }; |
106 | 148 | ||
149 | /* | ||
150 | * Note, the following ioctl existed in the past and was removed: | ||
151 | * #define MEMSETOOBSEL _IOW('M', 9, struct nand_oobinfo) | ||
152 | * Try to avoid adding a new ioctl with the same ioctl number. | ||
153 | */ | ||
154 | |||
155 | /* Get basic MTD characteristics info (better to use sysfs) */ | ||
107 | #define MEMGETINFO _IOR('M', 1, struct mtd_info_user) | 156 | #define MEMGETINFO _IOR('M', 1, struct mtd_info_user) |
157 | /* Erase segment of MTD */ | ||
108 | #define MEMERASE _IOW('M', 2, struct erase_info_user) | 158 | #define MEMERASE _IOW('M', 2, struct erase_info_user) |
159 | /* Write out-of-band data from MTD */ | ||
109 | #define MEMWRITEOOB _IOWR('M', 3, struct mtd_oob_buf) | 160 | #define MEMWRITEOOB _IOWR('M', 3, struct mtd_oob_buf) |
161 | /* Read out-of-band data from MTD */ | ||
110 | #define MEMREADOOB _IOWR('M', 4, struct mtd_oob_buf) | 162 | #define MEMREADOOB _IOWR('M', 4, struct mtd_oob_buf) |
163 | /* Lock a chip (for MTD that supports it) */ | ||
111 | #define MEMLOCK _IOW('M', 5, struct erase_info_user) | 164 | #define MEMLOCK _IOW('M', 5, struct erase_info_user) |
165 | /* Unlock a chip (for MTD that supports it) */ | ||
112 | #define MEMUNLOCK _IOW('M', 6, struct erase_info_user) | 166 | #define MEMUNLOCK _IOW('M', 6, struct erase_info_user) |
167 | /* Get the number of different erase regions */ | ||
113 | #define MEMGETREGIONCOUNT _IOR('M', 7, int) | 168 | #define MEMGETREGIONCOUNT _IOR('M', 7, int) |
169 | /* Get information about the erase region for a specific index */ | ||
114 | #define MEMGETREGIONINFO _IOWR('M', 8, struct region_info_user) | 170 | #define MEMGETREGIONINFO _IOWR('M', 8, struct region_info_user) |
115 | #define MEMSETOOBSEL _IOW('M', 9, struct nand_oobinfo) | 171 | /* Get info about OOB modes (e.g., RAW, PLACE, AUTO) - legacy interface */ |
116 | #define MEMGETOOBSEL _IOR('M', 10, struct nand_oobinfo) | 172 | #define MEMGETOOBSEL _IOR('M', 10, struct nand_oobinfo) |
173 | /* Check if an eraseblock is bad */ | ||
117 | #define MEMGETBADBLOCK _IOW('M', 11, __kernel_loff_t) | 174 | #define MEMGETBADBLOCK _IOW('M', 11, __kernel_loff_t) |
175 | /* Mark an eraseblock as bad */ | ||
118 | #define MEMSETBADBLOCK _IOW('M', 12, __kernel_loff_t) | 176 | #define MEMSETBADBLOCK _IOW('M', 12, __kernel_loff_t) |
177 | /* Set OTP (One-Time Programmable) mode (factory vs. user) */ | ||
119 | #define OTPSELECT _IOR('M', 13, int) | 178 | #define OTPSELECT _IOR('M', 13, int) |
179 | /* Get number of OTP (One-Time Programmable) regions */ | ||
120 | #define OTPGETREGIONCOUNT _IOW('M', 14, int) | 180 | #define OTPGETREGIONCOUNT _IOW('M', 14, int) |
181 | /* Get all OTP (One-Time Programmable) info about MTD */ | ||
121 | #define OTPGETREGIONINFO _IOW('M', 15, struct otp_info) | 182 | #define OTPGETREGIONINFO _IOW('M', 15, struct otp_info) |
183 | /* Lock a given range of user data (must be in mode %MTD_FILE_MODE_OTP_USER) */ | ||
122 | #define OTPLOCK _IOR('M', 16, struct otp_info) | 184 | #define OTPLOCK _IOR('M', 16, struct otp_info) |
185 | /* Get ECC layout (deprecated) */ | ||
123 | #define ECCGETLAYOUT _IOR('M', 17, struct nand_ecclayout_user) | 186 | #define ECCGETLAYOUT _IOR('M', 17, struct nand_ecclayout_user) |
187 | /* Get statistics about corrected/uncorrected errors */ | ||
124 | #define ECCGETSTATS _IOR('M', 18, struct mtd_ecc_stats) | 188 | #define ECCGETSTATS _IOR('M', 18, struct mtd_ecc_stats) |
189 | /* Set MTD mode on a per-file-descriptor basis (see "MTD file modes") */ | ||
125 | #define MTDFILEMODE _IO('M', 19) | 190 | #define MTDFILEMODE _IO('M', 19) |
191 | /* Erase segment of MTD (supports 64-bit address) */ | ||
126 | #define MEMERASE64 _IOW('M', 20, struct erase_info_user64) | 192 | #define MEMERASE64 _IOW('M', 20, struct erase_info_user64) |
193 | /* Write data to OOB (64-bit version) */ | ||
127 | #define MEMWRITEOOB64 _IOWR('M', 21, struct mtd_oob_buf64) | 194 | #define MEMWRITEOOB64 _IOWR('M', 21, struct mtd_oob_buf64) |
195 | /* Read data from OOB (64-bit version) */ | ||
128 | #define MEMREADOOB64 _IOWR('M', 22, struct mtd_oob_buf64) | 196 | #define MEMREADOOB64 _IOWR('M', 22, struct mtd_oob_buf64) |
197 | /* Check if chip is locked (for MTD that supports it) */ | ||
129 | #define MEMISLOCKED _IOR('M', 23, struct erase_info_user) | 198 | #define MEMISLOCKED _IOR('M', 23, struct erase_info_user) |
199 | /* | ||
200 | * Most generic write interface; can write in-band and/or out-of-band in various | ||
201 | * modes (see "struct mtd_write_req") | ||
202 | */ | ||
203 | #define MEMWRITE _IOWR('M', 24, struct mtd_write_req) | ||
130 | 204 | ||
131 | /* | 205 | /* |
132 | * Obsolete legacy interface. Keep it in order not to break userspace | 206 | * Obsolete legacy interface. Keep it in order not to break userspace |
@@ -177,13 +251,27 @@ struct mtd_ecc_stats { | |||
177 | }; | 251 | }; |
178 | 252 | ||
179 | /* | 253 | /* |
180 | * Read/write file modes for access to MTD | 254 | * MTD file modes - for read/write access to MTD |
255 | * | ||
256 | * @MTD_FILE_MODE_NORMAL: OTP disabled, ECC enabled | ||
257 | * @MTD_FILE_MODE_OTP_FACTORY: OTP enabled in factory mode | ||
258 | * @MTD_FILE_MODE_OTP_USER: OTP enabled in user mode | ||
259 | * @MTD_FILE_MODE_RAW: OTP disabled, ECC disabled | ||
260 | * | ||
261 | * These modes can be set via ioctl(MTDFILEMODE). The mode mode will be retained | ||
262 | * separately for each open file descriptor. | ||
263 | * | ||
264 | * Note: %MTD_FILE_MODE_RAW provides the same functionality as %MTD_OPS_RAW - | ||
265 | * raw access to the flash, without error correction or autoplacement schemes. | ||
266 | * Wherever possible, the MTD_OPS_* mode will override the MTD_FILE_MODE_* mode | ||
267 | * (e.g., when using ioctl(MEMWRITE)), but in some cases, the MTD_FILE_MODE is | ||
268 | * used out of necessity (e.g., `write()', ioctl(MEMWRITEOOB64)). | ||
181 | */ | 269 | */ |
182 | enum mtd_file_modes { | 270 | enum mtd_file_modes { |
183 | MTD_MODE_NORMAL = MTD_OTP_OFF, | 271 | MTD_FILE_MODE_NORMAL = MTD_OTP_OFF, |
184 | MTD_MODE_OTP_FACTORY = MTD_OTP_FACTORY, | 272 | MTD_FILE_MODE_OTP_FACTORY = MTD_OTP_FACTORY, |
185 | MTD_MODE_OTP_USER = MTD_OTP_USER, | 273 | MTD_FILE_MODE_OTP_USER = MTD_OTP_USER, |
186 | MTD_MODE_RAW, | 274 | MTD_FILE_MODE_RAW, |
187 | }; | 275 | }; |
188 | 276 | ||
189 | #endif /* __MTD_ABI_H__ */ | 277 | #endif /* __MTD_ABI_H__ */ |