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