include/mtd/mtd-abi.h

   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
  25 struct erase_info_user {
  26         __u32 start;
  27         __u32 length;
  28 };
  29
  30 struct erase_info_user64 {
  31         __u64 start;
  32         __u64 length;
  33 };
  34
  35 struct mtd_oob_buf {
  36         __u32 start;
  37         __u32 length;
  38         unsigned char __user *ptr;
  39 };
  40
  41 struct mtd_oob_buf64 {
  42         __u64 start;
  43         __u32 pad;
  44         __u32 length;
  45         __u64 usr_ptr;
  46 };
  47
  48 #define MTD_ABSENT              0
  49 #define MTD_RAM                 1
  50 #define MTD_ROM                 2
  51 #define MTD_NORFLASH            3
  52 #define MTD_NANDFLASH           4
  53 #define MTD_DATAFLASH           6
  54 #define MTD_UBIVOLUME           7
  55
  56 #define MTD_WRITEABLE           0x400   /* Device is writeable */
  57 #define MTD_BIT_WRITEABLE       0x800   /* Single bits can be flipped */
  58 #define MTD_NO_ERASE            0x1000  /* No erase necessary */
  59 #define MTD_POWERUP_LOCK        0x2000  /* Always locked after reset */
  60
  61 // Some common devices / combinations of capabilities
  62 #define MTD_CAP_ROM             0
  63 #define MTD_CAP_RAM             (MTD_WRITEABLE | MTD_BIT_WRITEABLE | MTD_NO_ERASE)
  64 #define MTD_CAP_NORFLASH        (MTD_WRITEABLE | MTD_BIT_WRITEABLE)
  65 #define MTD_CAP_NANDFLASH       (MTD_WRITEABLE)
  66
  67 /* ECC byte placement */
  68 #define MTD_NANDECC_OFF         0       // Switch off ECC (Not recommended)
  69 #define MTD_NANDECC_PLACE       1       // Use the given placement in the structure (YAFFS1 legacy mode)
  70 #define MTD_NANDECC_AUTOPLACE   2       // Use the default placement scheme
  71 #define MTD_NANDECC_PLACEONLY   3       // Use the given placement in the structure (Do not store ecc result on read)
  72 #define MTD_NANDECC_AUTOPL_USR  4       // Use the given autoplacement scheme rather than using the default
  73
  74 /* OTP mode selection */
  75 #define MTD_OTP_OFF             0
  76 #define MTD_OTP_FACTORY         1
  77 #define MTD_OTP_USER            2
  78
  79 struct mtd_info_user {
  80         __u8 type;
  81         __u32 flags;
  82         __u32 size;      // Total size of the MTD
  83         __u32 erasesize;
  84         __u32 writesize;
  85         __u32 oobsize;   // Amount of OOB data per block (e.g. 16)
  86         /* The below two fields are obsolete and broken, do not use them
  87          * (TODO: remove at some point) */
  88         __u32 ecctype;
  89         __u32 eccsize;
  90 };
  91
  92 struct region_info_user {
  93         __u32 offset;           /* At which this region starts,
  94                                          * from the beginning of the MTD */
  95         __u32 erasesize;                /* For this region */
  96         __u32 numblocks;                /* Number of blocks in this region */
  97         __u32 regionindex;
  98 };
  99
 100 struct otp_info {
 101         __u32 start;
 102         __u32 length;
 103         __u32 locked;
 104 };
 105
 106 #define MEMGETINFO              _IOR('M', 1, struct mtd_info_user)
 107 #define MEMERASE                _IOW('M', 2, struct erase_info_user)
 108 #define MEMWRITEOOB             _IOWR('M', 3, struct mtd_oob_buf)
 109 #define MEMREADOOB              _IOWR('M', 4, struct mtd_oob_buf)
 110 #define MEMLOCK                 _IOW('M', 5, struct erase_info_user)
 111 #define MEMUNLOCK               _IOW('M', 6, struct erase_info_user)
 112 #define MEMGETREGIONCOUNT       _IOR('M', 7, int)
 113 #define MEMGETREGIONINFO        _IOWR('M', 8, struct region_info_user)
 114 #define MEMSETOOBSEL            _IOW('M', 9, struct nand_oobinfo)
 115 #define MEMGETOOBSEL            _IOR('M', 10, struct nand_oobinfo)
 116 #define MEMGETBADBLOCK          _IOW('M', 11, __kernel_loff_t)
 117 #define MEMSETBADBLOCK          _IOW('M', 12, __kernel_loff_t)
 118 #define OTPSELECT               _IOR('M', 13, int)
 119 #define OTPGETREGIONCOUNT       _IOW('M', 14, int)
 120 #define OTPGETREGIONINFO        _IOW('M', 15, struct otp_info)
 121 #define OTPLOCK                 _IOR('M', 16, struct otp_info)
 122 #define ECCGETLAYOUT            _IOR('M', 17, struct nand_ecclayout)
 123 #define ECCGETSTATS             _IOR('M', 18, struct mtd_ecc_stats)
 124 #define MTDFILEMODE             _IO('M', 19)
 125 #define MEMERASE64              _IOW('M', 20, struct erase_info_user64)
 126 #define MEMWRITEOOB64           _IOWR('M', 21, struct mtd_oob_buf64)
 127 #define MEMREADOOB64            _IOWR('M', 22, struct mtd_oob_buf64)
 128 #define MEMISLOCKED             _IOR('M', 23, struct erase_info_user)
 129
 130 /*
 131  * Obsolete legacy interface. Keep it in order not to break userspace
 132  * interfaces
 133  */
 134 struct nand_oobinfo {
 135         __u32 useecc;
 136         __u32 eccbytes;
 137         __u32 oobfree[8][2];
 138         __u32 eccpos[32];
 139 };
 140
 141 struct nand_oobfree {
 142         __u32 offset;
 143         __u32 length;
 144 };
 145
 146 #define MTD_MAX_OOBFREE_ENTRIES 8
 147 /*
 148  * ECC layout control structure. Exported to userspace for
 149  * diagnosis and to allow creation of raw images
 150  */
 151 struct nand_ecclayout {
 152         __u32 eccbytes;
 153         __u32 eccpos[64];
 154         __u32 oobavail;
 155         struct nand_oobfree oobfree[MTD_MAX_OOBFREE_ENTRIES];
 156 };
 157
 158 /**
 159  * struct mtd_ecc_stats - error correction stats
 160  *
 161  * @corrected:  number of corrected bits
 162  * @failed:     number of uncorrectable errors
 163  * @badblocks:  number of bad blocks in this partition
 164  * @bbtblocks:  number of blocks reserved for bad block tables
 165  */
 166 struct mtd_ecc_stats {
 167         __u32 corrected;
 168         __u32 failed;
 169         __u32 badblocks;
 170         __u32 bbtblocks;
 171 };
 172
 173 /*
 174  * Read/write file modes for access to MTD
 175  */
 176 enum mtd_file_modes {
 177         MTD_MODE_NORMAL = MTD_OTP_OFF,
 178         MTD_MODE_OTP_FACTORY = MTD_OTP_FACTORY,
 179         MTD_MODE_OTP_USER = MTD_OTP_USER,
 180         MTD_MODE_RAW,
 181 };
 182
 183 #endif /* __MTD_ABI_H__ */