include/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 #ifndef __KERNEL__
  11 /* Urgh. The whole point of splitting this out into
  12    separate files was to avoid #ifdef __KERNEL__ */
  13 #define __user
  14 #endif
  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
  34 #define MTD_WRITEABLE           0x400   /* Device is writeable */
  35 #define MTD_BIT_WRITEABLE       0x800   /* Single bits can be flipped */
  36 #define MTD_NO_ERASE            0x1000  /* No erase necessary */
  37
  38 // Some common devices / combinations of capabilities
  39 #define MTD_CAP_ROM             0
  40 #define MTD_CAP_RAM             (MTD_WRITEABLE | MTD_BIT_WRITEABLE | MTD_NO_ERASE)
  41 #define MTD_CAP_NORFLASH        (MTD_WRITEABLE | MTD_BIT_WRITEABLE)
  42 #define MTD_CAP_NANDFLASH       (MTD_WRITEABLE)
  43
  44
  45 // Types of automatic ECC/Checksum available
  46 #define MTD_ECC_NONE            0       // No automatic ECC available
  47 #define MTD_ECC_RS_DiskOnChip   1       // Automatic ECC on DiskOnChip
  48 #define MTD_ECC_SW              2       // SW ECC for Toshiba & Samsung devices
  49
  50 /* ECC byte placement */
  51 #define MTD_NANDECC_OFF         0       // Switch off ECC (Not recommended)
  52 #define MTD_NANDECC_PLACE       1       // Use the given placement in the structure (YAFFS1 legacy mode)
  53 #define MTD_NANDECC_AUTOPLACE   2       // Use the default placement scheme
  54 #define MTD_NANDECC_PLACEONLY   3       // Use the given placement in the structure (Do not store ecc result on read)
  55 #define MTD_NANDECC_AUTOPL_USR  4       // Use the given autoplacement scheme rather than using the default
  56
  57 /* OTP mode selection */
  58 #define MTD_OTP_OFF             0
  59 #define MTD_OTP_FACTORY         1
  60 #define MTD_OTP_USER            2
  61
  62 struct mtd_info_user {
  63         uint8_t type;
  64         uint32_t flags;
  65         uint32_t size;   // Total size of the MTD
  66         uint32_t erasesize;
  67         uint32_t writesize;
  68         uint32_t oobsize;   // Amount of OOB data per block (e.g. 16)
  69         uint32_t ecctype;
  70         uint32_t eccsize;
  71 };
  72
  73 struct region_info_user {
  74         uint32_t offset;                /* At which this region starts,
  75                                          * from the beginning of the MTD */
  76         uint32_t erasesize;             /* For this region */
  77         uint32_t numblocks;             /* Number of blocks in this region */
  78         uint32_t regionindex;
  79 };
  80
  81 struct otp_info {
  82         uint32_t start;
  83         uint32_t length;
  84         uint32_t locked;
  85 };
  86
  87 #define MEMGETINFO              _IOR('M', 1, struct mtd_info_user)
  88 #define MEMERASE                _IOW('M', 2, struct erase_info_user)
  89 #define MEMWRITEOOB             _IOWR('M', 3, struct mtd_oob_buf)
  90 #define MEMREADOOB              _IOWR('M', 4, struct mtd_oob_buf)
  91 #define MEMLOCK                 _IOW('M', 5, struct erase_info_user)
  92 #define MEMUNLOCK               _IOW('M', 6, struct erase_info_user)
  93 #define MEMGETREGIONCOUNT       _IOR('M', 7, int)
  94 #define MEMGETREGIONINFO        _IOWR('M', 8, struct region_info_user)
  95 #define MEMSETOOBSEL            _IOW('M', 9, struct nand_oobinfo)
  96 #define MEMGETOOBSEL            _IOR('M', 10, struct nand_oobinfo)
  97 #define MEMGETBADBLOCK          _IOW('M', 11, loff_t)
  98 #define MEMSETBADBLOCK          _IOW('M', 12, loff_t)
  99 #define OTPSELECT               _IOR('M', 13, int)
 100 #define OTPGETREGIONCOUNT       _IOW('M', 14, int)
 101 #define OTPGETREGIONINFO        _IOW('M', 15, struct otp_info)
 102 #define OTPLOCK                 _IOR('M', 16, struct otp_info)
 103 #define ECCGETLAYOUT            _IOR('M', 17, struct nand_ecclayout)
 104 #define ECCGETSTATS             _IOR('M', 18, struct mtd_ecc_stats)
 105 #define MTDFILEMODE             _IO('M', 19)
 106
 107 /*
 108  * Obsolete legacy interface. Keep it in order not to break userspace
 109  * interfaces
 110  */
 111 struct nand_oobinfo {
 112         uint32_t useecc;
 113         uint32_t eccbytes;
 114         uint32_t oobfree[8][2];
 115         uint32_t eccpos[32];
 116 };
 117
 118 struct nand_oobfree {
 119         uint32_t offset;
 120         uint32_t length;
 121 };
 122
 123 #define MTD_MAX_OOBFREE_ENTRIES 8
 124 /*
 125  * ECC layout control structure. Exported to userspace for
 126  * diagnosis and to allow creation of raw images
 127  */
 128 struct nand_ecclayout {
 129         uint32_t eccbytes;
 130         uint32_t eccpos[64];
 131         uint32_t oobavail;
 132         struct nand_oobfree oobfree[MTD_MAX_OOBFREE_ENTRIES];
 133 };
 134
 135 /**
 136  * struct mtd_ecc_stats - error correction status
 137  *
 138  * @corrected:  number of corrected bits
 139  * @failed:     number of uncorrectable errors
 140  * @badblocks:  number of bad blocks in this partition
 141  * @bbtblocks:  number of blocks reserved for bad block tables
 142  */
 143 struct mtd_ecc_stats {
 144         uint32_t corrected;
 145         uint32_t failed;
 146         uint32_t badblocks;
 147         uint32_t bbtblocks;
 148 };
 149
 150 /*
 151  * Read/write file modes for access to MTD
 152  */
 153 enum mtd_file_modes {
 154         MTD_MODE_NORMAL = MTD_OTP_OFF,
 155         MTD_MODE_OTP_FACTORY = MTD_OTP_FACTORY,
 156         MTD_MODE_OTP_USER = MTD_OTP_USER,
 157         MTD_MODE_RAW,
 158 };
 159
 160 #endif /* __MTD_ABI_H__ */