2 * $Id: mtd-abi.h,v 1.13 2005/11/07 11:14:56 gleixner Exp $
4 * Portions of MTD ABI definition which are shared by kernel and user space
10 #ifndef __KERNEL__ /* Urgh. The whole point of splitting this out into
11 separate files was to avoid #ifdef __KERNEL__ */
15 struct erase_info_user {
23 unsigned char __user *ptr;
29 #define MTD_NORFLASH 3
30 #define MTD_NANDFLASH 4
31 #define MTD_DATAFLASH 6
33 #define MTD_WRITEABLE 0x400 /* Device is writeable */
34 #define MTD_BIT_WRITEABLE 0x800 /* Single bits can be flipped */
35 #define MTD_NO_ERASE 0x1000 /* No erase necessary */
37 // Some common devices / combinations of capabilities
39 #define MTD_CAP_RAM (MTD_WRITEABLE | MTD_BIT_WRITEABLE | MTD_NO_ERASE)
40 #define MTD_CAP_NORFLASH (MTD_WRITEABLE | MTD_BIT_WRITEABLE)
41 #define MTD_CAP_NANDFLASH (MTD_WRITEABLE)
44 // Types of automatic ECC/Checksum available
45 #define MTD_ECC_NONE 0 // No automatic ECC available
46 #define MTD_ECC_RS_DiskOnChip 1 // Automatic ECC on DiskOnChip
47 #define MTD_ECC_SW 2 // SW ECC for Toshiba & Samsung devices
49 /* ECC byte placement */
50 #define MTD_NANDECC_OFF 0 // Switch off ECC (Not recommended)
51 #define MTD_NANDECC_PLACE 1 // Use the given placement in the structure (YAFFS1 legacy mode)
52 #define MTD_NANDECC_AUTOPLACE 2 // Use the default placement scheme
53 #define MTD_NANDECC_PLACEONLY 3 // Use the given placement in the structure (Do not store ecc result on read)
54 #define MTD_NANDECC_AUTOPL_USR 4 // Use the given autoplacement scheme rather than using the default
56 /* OTP mode selection */
58 #define MTD_OTP_FACTORY 1
59 #define MTD_OTP_USER 2
61 struct mtd_info_user {
64 uint32_t size; // Total size of the MTD
67 uint32_t oobsize; // Amount of OOB data per block (e.g. 16)
72 struct region_info_user {
73 uint32_t offset; /* At which this region starts,
74 * from the beginning of the MTD */
75 uint32_t erasesize; /* For this region */
76 uint32_t numblocks; /* Number of blocks in this region */
86 #define MEMGETINFO _IOR('M', 1, struct mtd_info_user)
87 #define MEMERASE _IOW('M', 2, struct erase_info_user)
88 #define MEMWRITEOOB _IOWR('M', 3, struct mtd_oob_buf)
89 #define MEMREADOOB _IOWR('M', 4, struct mtd_oob_buf)
90 #define MEMLOCK _IOW('M', 5, struct erase_info_user)
91 #define MEMUNLOCK _IOW('M', 6, struct erase_info_user)
92 #define MEMGETREGIONCOUNT _IOR('M', 7, int)
93 #define MEMGETREGIONINFO _IOWR('M', 8, struct region_info_user)
94 #define MEMSETOOBSEL _IOW('M', 9, struct nand_oobinfo)
95 #define MEMGETOOBSEL _IOR('M', 10, struct nand_oobinfo)
96 #define MEMGETBADBLOCK _IOW('M', 11, loff_t)
97 #define MEMSETBADBLOCK _IOW('M', 12, loff_t)
98 #define OTPSELECT _IOR('M', 13, int)
99 #define OTPGETREGIONCOUNT _IOW('M', 14, int)
100 #define OTPGETREGIONINFO _IOW('M', 15, struct otp_info)
101 #define OTPLOCK _IOR('M', 16, struct otp_info)
102 #define ECCGETLAYOUT _IOR('M', 17, struct nand_ecclayout)
103 #define ECCGETSTATS _IOR('M', 18, struct mtd_ecc_stats)
104 #define MTDFILEMODE _IO('M', 19)
107 * Obsolete legacy interface. Keep it in order not to break userspace
110 struct nand_oobinfo {
113 uint32_t oobfree[8][2];
117 struct nand_oobfree {
122 #define MTD_MAX_OOBFREE_ENTRIES 8
124 * ECC layout control structure. Exported to userspace for
125 * diagnosis and to allow creation of raw images
127 struct nand_ecclayout {
131 struct nand_oobfree oobfree[MTD_MAX_OOBFREE_ENTRIES];
135 * struct mtd_ecc_stats - error correction status
137 * @corrected: number of corrected bits
138 * @failed: number of uncorrectable errors
139 * @badblocks: number of bad blocks in this partition
140 * @bbtblocks: number of blocks reserved for bad block tables
142 struct mtd_ecc_stats {
150 * Read/write file modes for access to MTD
152 enum mtd_file_modes {
153 MTD_MODE_NORMAL = MTD_OTP_OFF,
154 MTD_MODE_OTP_FACTORY = MTD_OTP_FACTORY,
155 MTD_MODE_OTP_USER = MTD_OTP_USER,
159 #endif /* __MTD_ABI_H__ */