include/mtd/mtd-abi.h

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