2 * Copyright © 1999-2010 David Woodhouse <dwmw2@infradead.org> et al.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
23 #include <linux/types.h>
25 struct erase_info_user {
30 struct erase_info_user64 {
38 unsigned char __user *ptr;
41 struct mtd_oob_buf64 {
51 #define MTD_NORFLASH 3
52 #define MTD_NANDFLASH 4
53 #define MTD_DATAFLASH 6
54 #define MTD_UBIVOLUME 7
55 #define MTD_MLCNANDFLASH 8
57 #define MTD_WRITEABLE 0x400 /* Device is writeable */
58 #define MTD_BIT_WRITEABLE 0x800 /* Single bits can be flipped */
59 #define MTD_NO_ERASE 0x1000 /* No erase necessary */
60 #define MTD_POWERUP_LOCK 0x2000 /* Always locked after reset */
62 // Some common devices / combinations of capabilities
64 #define MTD_CAP_RAM (MTD_WRITEABLE | MTD_BIT_WRITEABLE | MTD_NO_ERASE)
65 #define MTD_CAP_NORFLASH (MTD_WRITEABLE | MTD_BIT_WRITEABLE)
66 #define MTD_CAP_NANDFLASH (MTD_WRITEABLE)
68 /* ECC byte placement */
69 #define MTD_NANDECC_OFF 0 // Switch off ECC (Not recommended)
70 #define MTD_NANDECC_PLACE 1 // Use the given placement in the structure (YAFFS1 legacy mode)
71 #define MTD_NANDECC_AUTOPLACE 2 // Use the default placement scheme
72 #define MTD_NANDECC_PLACEONLY 3 // Use the given placement in the structure (Do not store ecc result on read)
73 #define MTD_NANDECC_AUTOPL_USR 4 // Use the given autoplacement scheme rather than using the default
75 /* OTP mode selection */
77 #define MTD_OTP_FACTORY 1
78 #define MTD_OTP_USER 2
80 struct mtd_info_user {
83 __u32 size; // Total size of the MTD
86 __u32 oobsize; // Amount of OOB data per block (e.g. 16)
87 /* The below two fields are obsolete and broken, do not use them
88 * (TODO: remove at some point) */
93 struct region_info_user {
94 __u32 offset; /* At which this region starts,
95 * from the beginning of the MTD */
96 __u32 erasesize; /* For this region */
97 __u32 numblocks; /* Number of blocks in this region */
107 #define MEMGETINFO _IOR('M', 1, struct mtd_info_user)
108 #define MEMERASE _IOW('M', 2, struct erase_info_user)
109 #define MEMWRITEOOB _IOWR('M', 3, struct mtd_oob_buf)
110 #define MEMREADOOB _IOWR('M', 4, struct mtd_oob_buf)
111 #define MEMLOCK _IOW('M', 5, struct erase_info_user)
112 #define MEMUNLOCK _IOW('M', 6, struct erase_info_user)
113 #define MEMGETREGIONCOUNT _IOR('M', 7, int)
114 #define MEMGETREGIONINFO _IOWR('M', 8, struct region_info_user)
115 #define MEMSETOOBSEL _IOW('M', 9, struct nand_oobinfo)
116 #define MEMGETOOBSEL _IOR('M', 10, struct nand_oobinfo)
117 #define MEMGETBADBLOCK _IOW('M', 11, __kernel_loff_t)
118 #define MEMSETBADBLOCK _IOW('M', 12, __kernel_loff_t)
119 #define OTPSELECT _IOR('M', 13, int)
120 #define OTPGETREGIONCOUNT _IOW('M', 14, int)
121 #define OTPGETREGIONINFO _IOW('M', 15, struct otp_info)
122 #define OTPLOCK _IOR('M', 16, struct otp_info)
123 #define ECCGETLAYOUT _IOR('M', 17, struct nand_ecclayout_user)
124 #define ECCGETSTATS _IOR('M', 18, struct mtd_ecc_stats)
125 #define MTDFILEMODE _IO('M', 19)
126 #define MEMERASE64 _IOW('M', 20, struct erase_info_user64)
127 #define MEMWRITEOOB64 _IOWR('M', 21, struct mtd_oob_buf64)
128 #define MEMREADOOB64 _IOWR('M', 22, struct mtd_oob_buf64)
129 #define MEMISLOCKED _IOR('M', 23, struct erase_info_user)
132 * Obsolete legacy interface. Keep it in order not to break userspace
135 struct nand_oobinfo {
142 struct nand_oobfree {
147 #define MTD_MAX_OOBFREE_ENTRIES 8
148 #define MTD_MAX_ECCPOS_ENTRIES 64
150 * OBSOLETE: ECC layout control structure. Exported to user-space via ioctl
151 * ECCGETLAYOUT for backwards compatbility and should not be mistaken as a
152 * complete set of ECC information. The ioctl truncates the larger internal
153 * structure to retain binary compatibility with the static declaration of the
154 * ioctl. Note that the "MTD_MAX_..._ENTRIES" macros represent the max size of
155 * the user struct, not the MAX size of the internal struct nand_ecclayout.
157 struct nand_ecclayout_user {
159 __u32 eccpos[MTD_MAX_ECCPOS_ENTRIES];
161 struct nand_oobfree oobfree[MTD_MAX_OOBFREE_ENTRIES];
165 * struct mtd_ecc_stats - error correction stats
167 * @corrected: number of corrected bits
168 * @failed: number of uncorrectable errors
169 * @badblocks: number of bad blocks in this partition
170 * @bbtblocks: number of blocks reserved for bad block tables
172 struct mtd_ecc_stats {
180 * Read/write file modes for access to MTD
182 enum mtd_file_modes {
183 MTD_MODE_NORMAL = MTD_OTP_OFF,
184 MTD_MODE_OTP_FACTORY = MTD_OTP_FACTORY,
185 MTD_MODE_OTP_USER = MTD_OTP_USER,
189 #endif /* __MTD_ABI_H__ */