include/mtd/mtd-abi.h

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