1a16046b1d97a148afc2609aa647c4888bacef3c
[linux-2.6.git] / include / mtd / mtd-abi.h
1 /*
2  * Copyright © 1999-2010 David Woodhouse <dwmw2@infradead.org> et al.
3  *
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.
8  *
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.
13  *
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
17  *
18  */
19
20 #ifndef __MTD_ABI_H__
21 #define __MTD_ABI_H__
22
23 #include <linux/types.h>
24
25 struct erase_info_user {
26         __u32 start;
27         __u32 length;
28 };
29
30 struct erase_info_user64 {
31         __u64 start;
32         __u64 length;
33 };
34
35 struct mtd_oob_buf {
36         __u32 start;
37         __u32 length;
38         unsigned char __user *ptr;
39 };
40
41 struct mtd_oob_buf64 {
42         __u64 start;
43         __u32 pad;
44         __u32 length;
45         __u64 usr_ptr;
46 };
47
48 /*
49  * MTD operation modes
50  *
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
55  *                      checking
56  */
57 enum {
58         MTD_OPS_PLACE_OOB = 0,
59         MTD_OPS_AUTO_OOB = 1,
60         MTD_OPS_RAW = 2,
61 };
62
63 struct mtd_write_req {
64         __u64 start;
65         __u64 len;
66         __u64 ooblen;
67         __u64 usr_data;
68         __u64 usr_oob;
69         __u8 mode;
70         __u8 padding[7];
71 };
72
73 #define MTD_ABSENT              0
74 #define MTD_RAM                 1
75 #define MTD_ROM                 2
76 #define MTD_NORFLASH            3
77 #define MTD_NANDFLASH           4
78 #define MTD_DATAFLASH           6
79 #define MTD_UBIVOLUME           7
80 #define MTD_MLCNANDFLASH        8
81
82 #define MTD_WRITEABLE           0x400   /* Device is writeable */
83 #define MTD_BIT_WRITEABLE       0x800   /* Single bits can be flipped */
84 #define MTD_NO_ERASE            0x1000  /* No erase necessary */
85 #define MTD_POWERUP_LOCK        0x2000  /* Always locked after reset */
86
87 // Some common devices / combinations of capabilities
88 #define MTD_CAP_ROM             0
89 #define MTD_CAP_RAM             (MTD_WRITEABLE | MTD_BIT_WRITEABLE | MTD_NO_ERASE)
90 #define MTD_CAP_NORFLASH        (MTD_WRITEABLE | MTD_BIT_WRITEABLE)
91 #define MTD_CAP_NANDFLASH       (MTD_WRITEABLE)
92
93 /* ECC byte placement */
94 #define MTD_NANDECC_OFF         0       // Switch off ECC (Not recommended)
95 #define MTD_NANDECC_PLACE       1       // Use the given placement in the structure (YAFFS1 legacy mode)
96 #define MTD_NANDECC_AUTOPLACE   2       // Use the default placement scheme
97 #define MTD_NANDECC_PLACEONLY   3       // Use the given placement in the structure (Do not store ecc result on read)
98 #define MTD_NANDECC_AUTOPL_USR  4       // Use the given autoplacement scheme rather than using the default
99
100 /* OTP mode selection */
101 #define MTD_OTP_OFF             0
102 #define MTD_OTP_FACTORY         1
103 #define MTD_OTP_USER            2
104
105 struct mtd_info_user {
106         __u8 type;
107         __u32 flags;
108         __u32 size;      // Total size of the MTD
109         __u32 erasesize;
110         __u32 writesize;
111         __u32 oobsize;   // Amount of OOB data per block (e.g. 16)
112         /* The below two fields are obsolete and broken, do not use them
113          * (TODO: remove at some point) */
114         __u32 ecctype;
115         __u32 eccsize;
116 };
117
118 struct region_info_user {
119         __u32 offset;           /* At which this region starts,
120                                          * from the beginning of the MTD */
121         __u32 erasesize;                /* For this region */
122         __u32 numblocks;                /* Number of blocks in this region */
123         __u32 regionindex;
124 };
125
126 struct otp_info {
127         __u32 start;
128         __u32 length;
129         __u32 locked;
130 };
131
132 /*
133  * Note, the following ioctl existed in the past and was removed:
134  * #define MEMSETOOBSEL           _IOW('M', 9, struct nand_oobinfo)
135  * Try to avoid adding a new ioctl with the same ioctl number.
136  */
137
138 #define MEMGETINFO              _IOR('M', 1, struct mtd_info_user)
139 #define MEMERASE                _IOW('M', 2, struct erase_info_user)
140 #define MEMWRITEOOB             _IOWR('M', 3, struct mtd_oob_buf)
141 #define MEMREADOOB              _IOWR('M', 4, struct mtd_oob_buf)
142 #define MEMLOCK                 _IOW('M', 5, struct erase_info_user)
143 #define MEMUNLOCK               _IOW('M', 6, struct erase_info_user)
144 #define MEMGETREGIONCOUNT       _IOR('M', 7, int)
145 #define MEMGETREGIONINFO        _IOWR('M', 8, struct region_info_user)
146 #define MEMGETOOBSEL            _IOR('M', 10, struct nand_oobinfo)
147 #define MEMGETBADBLOCK          _IOW('M', 11, __kernel_loff_t)
148 #define MEMSETBADBLOCK          _IOW('M', 12, __kernel_loff_t)
149 #define OTPSELECT               _IOR('M', 13, int)
150 #define OTPGETREGIONCOUNT       _IOW('M', 14, int)
151 #define OTPGETREGIONINFO        _IOW('M', 15, struct otp_info)
152 #define OTPLOCK                 _IOR('M', 16, struct otp_info)
153 #define ECCGETLAYOUT            _IOR('M', 17, struct nand_ecclayout_user)
154 #define ECCGETSTATS             _IOR('M', 18, struct mtd_ecc_stats)
155 #define MTDFILEMODE             _IO('M', 19)
156 #define MEMERASE64              _IOW('M', 20, struct erase_info_user64)
157 #define MEMWRITEOOB64           _IOWR('M', 21, struct mtd_oob_buf64)
158 #define MEMREADOOB64            _IOWR('M', 22, struct mtd_oob_buf64)
159 #define MEMISLOCKED             _IOR('M', 23, struct erase_info_user)
160 #define MEMWRITE                _IOWR('M', 24, struct mtd_write_req)
161
162 /*
163  * Obsolete legacy interface. Keep it in order not to break userspace
164  * interfaces
165  */
166 struct nand_oobinfo {
167         __u32 useecc;
168         __u32 eccbytes;
169         __u32 oobfree[8][2];
170         __u32 eccpos[32];
171 };
172
173 struct nand_oobfree {
174         __u32 offset;
175         __u32 length;
176 };
177
178 #define MTD_MAX_OOBFREE_ENTRIES 8
179 #define MTD_MAX_ECCPOS_ENTRIES  64
180 /*
181  * OBSOLETE: ECC layout control structure. Exported to user-space via ioctl
182  * ECCGETLAYOUT for backwards compatbility and should not be mistaken as a
183  * complete set of ECC information. The ioctl truncates the larger internal
184  * structure to retain binary compatibility with the static declaration of the
185  * ioctl. Note that the "MTD_MAX_..._ENTRIES" macros represent the max size of
186  * the user struct, not the MAX size of the internal struct nand_ecclayout.
187  */
188 struct nand_ecclayout_user {
189         __u32 eccbytes;
190         __u32 eccpos[MTD_MAX_ECCPOS_ENTRIES];
191         __u32 oobavail;
192         struct nand_oobfree oobfree[MTD_MAX_OOBFREE_ENTRIES];
193 };
194
195 /**
196  * struct mtd_ecc_stats - error correction stats
197  *
198  * @corrected:  number of corrected bits
199  * @failed:     number of uncorrectable errors
200  * @badblocks:  number of bad blocks in this partition
201  * @bbtblocks:  number of blocks reserved for bad block tables
202  */
203 struct mtd_ecc_stats {
204         __u32 corrected;
205         __u32 failed;
206         __u32 badblocks;
207         __u32 bbtblocks;
208 };
209
210 /*
211  * Read/write file modes for access to MTD
212  */
213 enum mtd_file_modes {
214         MTD_FILE_MODE_NORMAL = MTD_OTP_OFF,
215         MTD_FILE_MODE_OTP_FACTORY = MTD_OTP_FACTORY,
216         MTD_FILE_MODE_OTP_USER = MTD_OTP_USER,
217         MTD_FILE_MODE_RAW,
218 };
219
220 #endif /* __MTD_ABI_H__ */