1/* 2 * 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 * 18 */ 19 20#ifndef __MTD_ABI_H__ 21#define __MTD_ABI_H__ 22 23#include <linux/types.h> 24 25struct erase_info_user { 26 __u32 start; 27 __u32 length; 28}; 29 30struct erase_info_user64 { 31 __u64 start; 32 __u64 length; 33}; 34 35struct mtd_oob_buf { 36 __u32 start; 37 __u32 length; 38 unsigned char __user *ptr; 39}; 40 41struct mtd_oob_buf64 { 42 __u64 start; 43 __u32 pad; 44 __u32 length; 45 __u64 usr_ptr; 46}; 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 */ 61enum { 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 */ 83struct 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 93#define MTD_ABSENT 0 94#define MTD_RAM 1 95#define MTD_ROM 2 96#define MTD_NORFLASH 3 97#define MTD_NANDFLASH 4 /* SLC NAND */ 98#define MTD_DATAFLASH 6 99#define MTD_UBIVOLUME 7 100#define MTD_MLCNANDFLASH 8 /* MLC NAND (including TLC) */ 101 102#define MTD_WRITEABLE 0x400 /* Device is writeable */ 103#define MTD_BIT_WRITEABLE 0x800 /* Single bits can be flipped */ 104#define MTD_NO_ERASE 0x1000 /* No erase necessary */ 105#define MTD_POWERUP_LOCK 0x2000 /* Always locked after reset */ 106 107/* Some common devices / combinations of capabilities */ 108#define MTD_CAP_ROM 0 109#define MTD_CAP_RAM (MTD_WRITEABLE | MTD_BIT_WRITEABLE | MTD_NO_ERASE) 110#define MTD_CAP_NORFLASH (MTD_WRITEABLE | MTD_BIT_WRITEABLE) 111#define MTD_CAP_NANDFLASH (MTD_WRITEABLE) 112#define MTD_CAP_NVRAM (MTD_WRITEABLE | MTD_BIT_WRITEABLE | MTD_NO_ERASE) 113 114/* Obsolete ECC byte placement modes (used with obsolete MEMGETOOBSEL) */ 115#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) 119#define MTD_NANDECC_AUTOPL_USR 4 // Use the given autoplacement scheme rather than using the default 120 121/* OTP mode selection */ 122#define MTD_OTP_OFF 0 123#define MTD_OTP_FACTORY 1 124#define MTD_OTP_USER 2 125 126struct mtd_info_user { 127 __u8 type; 128 __u32 flags; 129 __u32 size; /* Total size of the MTD */ 130 __u32 erasesize; 131 __u32 writesize; 132 __u32 oobsize; /* Amount of OOB data per block (e.g. 16) */ 133 __u64 padding; /* Old obsolete field; do not use */ 134}; 135 136struct region_info_user { 137 __u32 offset; /* At which this region starts, 138 * from the beginning of the MTD */ 139 __u32 erasesize; /* For this region */ 140 __u32 numblocks; /* Number of blocks in this region */ 141 __u32 regionindex; 142}; 143 144struct otp_info { 145 __u32 start; 146 __u32 length; 147 __u32 locked; 148}; 149 150/* 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 156/* Get basic MTD characteristics info (better to use sysfs) */ 157#define MEMGETINFO _IOR('M', 1, struct mtd_info_user) 158/* Erase segment of MTD */ 159#define MEMERASE _IOW('M', 2, struct erase_info_user) 160/* Write out-of-band data from MTD */ 161#define MEMWRITEOOB _IOWR('M', 3, struct mtd_oob_buf) 162/* Read out-of-band data from MTD */ 163#define MEMREADOOB _IOWR('M', 4, struct mtd_oob_buf) 164/* Lock a chip (for MTD that supports it) */ 165#define MEMLOCK _IOW('M', 5, struct erase_info_user) 166/* Unlock a chip (for MTD that supports it) */ 167#define MEMUNLOCK _IOW('M', 6, struct erase_info_user) 168/* Get the number of different erase regions */ 169#define MEMGETREGIONCOUNT _IOR('M', 7, int) 170/* Get information about the erase region for a specific index */ 171#define MEMGETREGIONINFO _IOWR('M', 8, struct region_info_user) 172/* Get info about OOB modes (e.g., RAW, PLACE, AUTO) - legacy interface */ 173#define MEMGETOOBSEL _IOR('M', 10, struct nand_oobinfo) 174/* Check if an eraseblock is bad */ 175#define MEMGETBADBLOCK _IOW('M', 11, __kernel_loff_t) 176/* Mark an eraseblock as bad */ 177#define MEMSETBADBLOCK _IOW('M', 12, __kernel_loff_t) 178/* Set OTP (One-Time Programmable) mode (factory vs. user) */ 179#define OTPSELECT _IOR('M', 13, int) 180/* Get number of OTP (One-Time Programmable) regions */ 181#define OTPGETREGIONCOUNT _IOW('M', 14, int) 182/* Get all OTP (One-Time Programmable) info about MTD */ 183#define OTPGETREGIONINFO _IOW('M', 15, struct otp_info) 184/* Lock a given range of user data (must be in mode %MTD_FILE_MODE_OTP_USER) */ 185#define OTPLOCK _IOR('M', 16, struct otp_info) 186/* Get ECC layout (deprecated) */ 187#define ECCGETLAYOUT _IOR('M', 17, struct nand_ecclayout_user) 188/* Get statistics about corrected/uncorrected errors */ 189#define ECCGETSTATS _IOR('M', 18, struct mtd_ecc_stats) 190/* Set MTD mode on a per-file-descriptor basis (see "MTD file modes") */ 191#define MTDFILEMODE _IO('M', 19) 192/* Erase segment of MTD (supports 64-bit address) */ 193#define MEMERASE64 _IOW('M', 20, struct erase_info_user64) 194/* Write data to OOB (64-bit version) */ 195#define MEMWRITEOOB64 _IOWR('M', 21, struct mtd_oob_buf64) 196/* Read data from OOB (64-bit version) */ 197#define MEMREADOOB64 _IOWR('M', 22, struct mtd_oob_buf64) 198/* Check if chip is locked (for MTD that supports it) */ 199#define MEMISLOCKED _IOR('M', 23, struct erase_info_user) 200/* 201 * Most generic write interface; can write in-band and/or out-of-band in various 202 * modes (see "struct mtd_write_req"). This ioctl is not supported for flashes 203 * without OOB, e.g., NOR flash. 204 */ 205#define MEMWRITE _IOWR('M', 24, struct mtd_write_req) 206 207/* 208 * Obsolete legacy interface. Keep it in order not to break userspace 209 * interfaces 210 */ 211struct nand_oobinfo { 212 __u32 useecc; 213 __u32 eccbytes; 214 __u32 oobfree[8][2]; 215 __u32 eccpos[32]; 216}; 217 218struct nand_oobfree { 219 __u32 offset; 220 __u32 length; 221}; 222 223#define MTD_MAX_OOBFREE_ENTRIES 8 224#define MTD_MAX_ECCPOS_ENTRIES 64 225/* 226 * 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. 232 */ 233struct nand_ecclayout_user { 234 __u32 eccbytes; 235 __u32 eccpos[MTD_MAX_ECCPOS_ENTRIES]; 236 __u32 oobavail; 237 struct nand_oobfree oobfree[MTD_MAX_OOBFREE_ENTRIES]; 238}; 239 240/** 241 * struct mtd_ecc_stats - error correction stats 242 * 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 { 249 __u32 corrected; 250 __u32 failed; 251 __u32 badblocks; 252 __u32 bbtblocks; 253}; 254 255/* 256 * 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)). 271 */ 272enum mtd_file_modes { 273 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, 277}; 278 279/* 280 * MTD locking states - return codes for ioctl(MEMISLOCKED) 281 * 282 * @MTD_IS_UNLOCKED: Specified region is completely unlocked 283 * @MTD_IS_LOCKED: Specified region is completely locked 284 * @MTD_IS_PARTIALLY_LOCKED: Specified region is partially locked 285 */ 286enum mtd_locking_states { 287 MTD_IS_UNLOCKED, 288 MTD_IS_LOCKED, 289 MTD_IS_PARTIALLY_LOCKED, 290}; 291 292static inline int mtd_type_is_nand_user(const struct mtd_info_user *mtd) 293{ 294 return mtd->type == MTD_NANDFLASH || mtd->type == MTD_MLCNANDFLASH; 295} 296 297#endif /* __MTD_ABI_H__ */ 298