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