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