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