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 * MTD_OPS_PLACE_OOB: oob data are placed at the given offset (default)
52 * MTD_OPS_AUTO_OOB: oob data are automatically placed at the free areas
53 * which are defined by the internal ecclayout
54 * MTD_OPS_RAW: mode to read or write oob and data without doing ECC
58 MTD_OPS_PLACE_OOB = 0,
66 #define MTD_NORFLASH 3
67 #define MTD_NANDFLASH 4
68 #define MTD_DATAFLASH 6
69 #define MTD_UBIVOLUME 7
70 #define MTD_MLCNANDFLASH 8
72 #define MTD_WRITEABLE 0x400 /* Device is writeable */
73 #define MTD_BIT_WRITEABLE 0x800 /* Single bits can be flipped */
74 #define MTD_NO_ERASE 0x1000 /* No erase necessary */
75 #define MTD_POWERUP_LOCK 0x2000 /* Always locked after reset */
77 // Some common devices / combinations of capabilities
79 #define MTD_CAP_RAM (MTD_WRITEABLE | MTD_BIT_WRITEABLE | MTD_NO_ERASE)
80 #define MTD_CAP_NORFLASH (MTD_WRITEABLE | MTD_BIT_WRITEABLE)
81 #define MTD_CAP_NANDFLASH (MTD_WRITEABLE)
83 /* ECC byte placement */
84 #define MTD_NANDECC_OFF 0 // Switch off ECC (Not recommended)
85 #define MTD_NANDECC_PLACE 1 // Use the given placement in the structure (YAFFS1 legacy mode)
86 #define MTD_NANDECC_AUTOPLACE 2 // Use the default placement scheme
87 #define MTD_NANDECC_PLACEONLY 3 // Use the given placement in the structure (Do not store ecc result on read)
88 #define MTD_NANDECC_AUTOPL_USR 4 // Use the given autoplacement scheme rather than using the default
90 /* OTP mode selection */
92 #define MTD_OTP_FACTORY 1
93 #define MTD_OTP_USER 2
95 struct mtd_info_user {
98 __u32 size; // Total size of the MTD
101 __u32 oobsize; // Amount of OOB data per block (e.g. 16)
102 /* The below two fields are obsolete and broken, do not use them
103 * (TODO: remove at some point) */
108 struct region_info_user {
109 __u32 offset; /* At which this region starts,
110 * from the beginning of the MTD */
111 __u32 erasesize; /* For this region */
112 __u32 numblocks; /* Number of blocks in this region */
123 * Note, the following ioctl existed in the past and was removed:
124 * #define MEMSETOOBSEL _IOW('M', 9, struct nand_oobinfo)
125 * Try to avoid adding a new ioctl with the same ioctl number.
128 #define MEMGETINFO _IOR('M', 1, struct mtd_info_user)
129 #define MEMERASE _IOW('M', 2, struct erase_info_user)
130 #define MEMWRITEOOB _IOWR('M', 3, struct mtd_oob_buf)
131 #define MEMREADOOB _IOWR('M', 4, struct mtd_oob_buf)
132 #define MEMLOCK _IOW('M', 5, struct erase_info_user)
133 #define MEMUNLOCK _IOW('M', 6, struct erase_info_user)
134 #define MEMGETREGIONCOUNT _IOR('M', 7, int)
135 #define MEMGETREGIONINFO _IOWR('M', 8, struct region_info_user)
136 #define MEMGETOOBSEL _IOR('M', 10, struct nand_oobinfo)
137 #define MEMGETBADBLOCK _IOW('M', 11, __kernel_loff_t)
138 #define MEMSETBADBLOCK _IOW('M', 12, __kernel_loff_t)
139 #define OTPSELECT _IOR('M', 13, int)
140 #define OTPGETREGIONCOUNT _IOW('M', 14, int)
141 #define OTPGETREGIONINFO _IOW('M', 15, struct otp_info)
142 #define OTPLOCK _IOR('M', 16, struct otp_info)
143 #define ECCGETLAYOUT _IOR('M', 17, struct nand_ecclayout_user)
144 #define ECCGETSTATS _IOR('M', 18, struct mtd_ecc_stats)
145 #define MTDFILEMODE _IO('M', 19)
146 #define MEMERASE64 _IOW('M', 20, struct erase_info_user64)
147 #define MEMWRITEOOB64 _IOWR('M', 21, struct mtd_oob_buf64)
148 #define MEMREADOOB64 _IOWR('M', 22, struct mtd_oob_buf64)
149 #define MEMISLOCKED _IOR('M', 23, struct erase_info_user)
152 * Obsolete legacy interface. Keep it in order not to break userspace
155 struct nand_oobinfo {
162 struct nand_oobfree {
167 #define MTD_MAX_OOBFREE_ENTRIES 8
168 #define MTD_MAX_ECCPOS_ENTRIES 64
170 * OBSOLETE: ECC layout control structure. Exported to user-space via ioctl
171 * ECCGETLAYOUT for backwards compatbility and should not be mistaken as a
172 * complete set of ECC information. The ioctl truncates the larger internal
173 * structure to retain binary compatibility with the static declaration of the
174 * ioctl. Note that the "MTD_MAX_..._ENTRIES" macros represent the max size of
175 * the user struct, not the MAX size of the internal struct nand_ecclayout.
177 struct nand_ecclayout_user {
179 __u32 eccpos[MTD_MAX_ECCPOS_ENTRIES];
181 struct nand_oobfree oobfree[MTD_MAX_OOBFREE_ENTRIES];
185 * struct mtd_ecc_stats - error correction stats
187 * @corrected: number of corrected bits
188 * @failed: number of uncorrectable errors
189 * @badblocks: number of bad blocks in this partition
190 * @bbtblocks: number of blocks reserved for bad block tables
192 struct mtd_ecc_stats {
200 * Read/write file modes for access to MTD
202 enum mtd_file_modes {
203 MTD_MODE_NORMAL = MTD_OTP_OFF,
204 MTD_MODE_OTP_FACTORY = MTD_OTP_FACTORY,
205 MTD_MODE_OTP_USER = MTD_OTP_USER,
209 #endif /* __MTD_ABI_H__ */