include/linux/mtd/mtd-abi.h

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