xref: /openbmc/linux/include/uapi/mtd/mtd-abi.h (revision c4f7ac64)
1 /* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */
2 /*
3  * Copyright © 1999-2010 David Woodhouse <dwmw2@infradead.org> et al.
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
18  *
19  */
20 
21 #ifndef __MTD_ABI_H__
22 #define __MTD_ABI_H__
23 
24 #include <linux/types.h>
25 
26 struct erase_info_user {
27 	__u32 start;
28 	__u32 length;
29 };
30 
31 struct erase_info_user64 {
32 	__u64 start;
33 	__u64 length;
34 };
35 
36 struct mtd_oob_buf {
37 	__u32 start;
38 	__u32 length;
39 	unsigned char __user *ptr;
40 };
41 
42 struct mtd_oob_buf64 {
43 	__u64 start;
44 	__u32 pad;
45 	__u32 length;
46 	__u64 usr_ptr;
47 };
48 
49 /**
50  * MTD operation modes
51  *
52  * @MTD_OPS_PLACE_OOB:	OOB data are placed at the given offset (default)
53  * @MTD_OPS_AUTO_OOB:	OOB data are automatically placed at the free areas
54  *			which are defined by the internal ecclayout
55  * @MTD_OPS_RAW:	data are transferred as-is, with no error correction;
56  *			this mode implies %MTD_OPS_PLACE_OOB
57  *
58  * These modes can be passed to ioctl(MEMWRITE) and are also used internally.
59  * See notes on "MTD file modes" for discussion on %MTD_OPS_RAW vs.
60  * %MTD_FILE_MODE_RAW.
61  */
62 enum {
63 	MTD_OPS_PLACE_OOB = 0,
64 	MTD_OPS_AUTO_OOB = 1,
65 	MTD_OPS_RAW = 2,
66 };
67 
68 /**
69  * struct mtd_write_req - data structure for requesting a write operation
70  *
71  * @start:	start address
72  * @len:	length of data buffer
73  * @ooblen:	length of OOB buffer
74  * @usr_data:	user-provided data buffer
75  * @usr_oob:	user-provided OOB buffer
76  * @mode:	MTD mode (see "MTD operation modes")
77  * @padding:	reserved, must be set to 0
78  *
79  * This structure supports ioctl(MEMWRITE) operations, allowing data and/or OOB
80  * writes in various modes. To write to OOB-only, set @usr_data == NULL, and to
81  * write data-only, set @usr_oob == NULL. However, setting both @usr_data and
82  * @usr_oob to NULL is not allowed.
83  */
84 struct mtd_write_req {
85 	__u64 start;
86 	__u64 len;
87 	__u64 ooblen;
88 	__u64 usr_data;
89 	__u64 usr_oob;
90 	__u8 mode;
91 	__u8 padding[7];
92 };
93 
94 #define MTD_ABSENT		0
95 #define MTD_RAM			1
96 #define MTD_ROM			2
97 #define MTD_NORFLASH		3
98 #define MTD_NANDFLASH		4	/* SLC NAND */
99 #define MTD_DATAFLASH		6
100 #define MTD_UBIVOLUME		7
101 #define MTD_MLCNANDFLASH	8	/* MLC NAND (including TLC) */
102 
103 #define MTD_WRITEABLE		0x400	/* Device is writeable */
104 #define MTD_BIT_WRITEABLE	0x800	/* Single bits can be flipped */
105 #define MTD_NO_ERASE		0x1000	/* No erase necessary */
106 #define MTD_POWERUP_LOCK	0x2000	/* Always locked after reset */
107 #define MTD_SLC_ON_MLC_EMULATION 0x4000	/* Emulate SLC behavior on MLC NANDs */
108 
109 /* Some common devices / combinations of capabilities */
110 #define MTD_CAP_ROM		0
111 #define MTD_CAP_RAM		(MTD_WRITEABLE | MTD_BIT_WRITEABLE | MTD_NO_ERASE)
112 #define MTD_CAP_NORFLASH	(MTD_WRITEABLE | MTD_BIT_WRITEABLE)
113 #define MTD_CAP_NANDFLASH	(MTD_WRITEABLE)
114 #define MTD_CAP_NVRAM		(MTD_WRITEABLE | MTD_BIT_WRITEABLE | MTD_NO_ERASE)
115 
116 /* Obsolete ECC byte placement modes (used with obsolete MEMGETOOBSEL) */
117 #define MTD_NANDECC_OFF		0	/* Switch off ECC (Not recommended) */
118 #define MTD_NANDECC_PLACE	1	/* Use the given placement in the structure (YAFFS1 legacy mode) */
119 #define MTD_NANDECC_AUTOPLACE	2	/* Use the default placement scheme */
120 #define MTD_NANDECC_PLACEONLY	3	/* Use the given placement in the structure (Do not store ecc result on read) */
121 #define MTD_NANDECC_AUTOPL_USR 	4	/* Use the given autoplacement scheme rather than using the default */
122 
123 /* OTP mode selection */
124 #define MTD_OTP_OFF		0
125 #define MTD_OTP_FACTORY		1
126 #define MTD_OTP_USER		2
127 
128 struct mtd_info_user {
129 	__u8 type;
130 	__u32 flags;
131 	__u32 size;	/* Total size of the MTD */
132 	__u32 erasesize;
133 	__u32 writesize;
134 	__u32 oobsize;	/* Amount of OOB data per block (e.g. 16) */
135 	__u64 padding;	/* Old obsolete field; do not use */
136 };
137 
138 struct region_info_user {
139 	__u32 offset;		/* At which this region starts,
140 				 * from the beginning of the MTD */
141 	__u32 erasesize;	/* For this region */
142 	__u32 numblocks;	/* Number of blocks in this region */
143 	__u32 regionindex;
144 };
145 
146 struct otp_info {
147 	__u32 start;
148 	__u32 length;
149 	__u32 locked;
150 };
151 
152 /*
153  * Note, the following ioctl existed in the past and was removed:
154  * #define MEMSETOOBSEL           _IOW('M', 9, struct nand_oobinfo)
155  * Try to avoid adding a new ioctl with the same ioctl number.
156  */
157 
158 /* Get basic MTD characteristics info (better to use sysfs) */
159 #define MEMGETINFO		_IOR('M', 1, struct mtd_info_user)
160 /* Erase segment of MTD */
161 #define MEMERASE		_IOW('M', 2, struct erase_info_user)
162 /* Write out-of-band data from MTD */
163 #define MEMWRITEOOB		_IOWR('M', 3, struct mtd_oob_buf)
164 /* Read out-of-band data from MTD */
165 #define MEMREADOOB		_IOWR('M', 4, struct mtd_oob_buf)
166 /* Lock a chip (for MTD that supports it) */
167 #define MEMLOCK			_IOW('M', 5, struct erase_info_user)
168 /* Unlock a chip (for MTD that supports it) */
169 #define MEMUNLOCK		_IOW('M', 6, struct erase_info_user)
170 /* Get the number of different erase regions */
171 #define MEMGETREGIONCOUNT	_IOR('M', 7, int)
172 /* Get information about the erase region for a specific index */
173 #define MEMGETREGIONINFO	_IOWR('M', 8, struct region_info_user)
174 /* Get info about OOB modes (e.g., RAW, PLACE, AUTO) - legacy interface */
175 #define MEMGETOOBSEL		_IOR('M', 10, struct nand_oobinfo)
176 /* Check if an eraseblock is bad */
177 #define MEMGETBADBLOCK		_IOW('M', 11, __kernel_loff_t)
178 /* Mark an eraseblock as bad */
179 #define MEMSETBADBLOCK		_IOW('M', 12, __kernel_loff_t)
180 /* Set OTP (One-Time Programmable) mode (factory vs. user) */
181 #define OTPSELECT		_IOR('M', 13, int)
182 /* Get number of OTP (One-Time Programmable) regions */
183 #define OTPGETREGIONCOUNT	_IOW('M', 14, int)
184 /* Get all OTP (One-Time Programmable) info about MTD */
185 #define OTPGETREGIONINFO	_IOW('M', 15, struct otp_info)
186 /* Lock a given range of user data (must be in mode %MTD_FILE_MODE_OTP_USER) */
187 #define OTPLOCK			_IOR('M', 16, struct otp_info)
188 /* Get ECC layout (deprecated) */
189 #define ECCGETLAYOUT		_IOR('M', 17, struct nand_ecclayout_user)
190 /* Get statistics about corrected/uncorrected errors */
191 #define ECCGETSTATS		_IOR('M', 18, struct mtd_ecc_stats)
192 /* Set MTD mode on a per-file-descriptor basis (see "MTD file modes") */
193 #define MTDFILEMODE		_IO('M', 19)
194 /* Erase segment of MTD (supports 64-bit address) */
195 #define MEMERASE64		_IOW('M', 20, struct erase_info_user64)
196 /* Write data to OOB (64-bit version) */
197 #define MEMWRITEOOB64		_IOWR('M', 21, struct mtd_oob_buf64)
198 /* Read data from OOB (64-bit version) */
199 #define MEMREADOOB64		_IOWR('M', 22, struct mtd_oob_buf64)
200 /* Check if chip is locked (for MTD that supports it) */
201 #define MEMISLOCKED		_IOR('M', 23, struct erase_info_user)
202 /*
203  * Most generic write interface; can write in-band and/or out-of-band in various
204  * modes (see "struct mtd_write_req"). This ioctl is not supported for flashes
205  * without OOB, e.g., NOR flash.
206  */
207 #define MEMWRITE		_IOWR('M', 24, struct mtd_write_req)
208 /* Erase a given range of user data (must be in mode %MTD_FILE_MODE_OTP_USER) */
209 #define OTPERASE		_IOW('M', 25, struct otp_info)
210 
211 /*
212  * Obsolete legacy interface. Keep it in order not to break userspace
213  * interfaces
214  */
215 struct nand_oobinfo {
216 	__u32 useecc;
217 	__u32 eccbytes;
218 	__u32 oobfree[8][2];
219 	__u32 eccpos[32];
220 };
221 
222 struct nand_oobfree {
223 	__u32 offset;
224 	__u32 length;
225 };
226 
227 #define MTD_MAX_OOBFREE_ENTRIES	8
228 #define MTD_MAX_ECCPOS_ENTRIES	64
229 /*
230  * OBSOLETE: ECC layout control structure. Exported to user-space via ioctl
231  * ECCGETLAYOUT for backwards compatbility and should not be mistaken as a
232  * complete set of ECC information. The ioctl truncates the larger internal
233  * structure to retain binary compatibility with the static declaration of the
234  * ioctl. Note that the "MTD_MAX_..._ENTRIES" macros represent the max size of
235  * the user struct, not the MAX size of the internal OOB layout representation.
236  */
237 struct nand_ecclayout_user {
238 	__u32 eccbytes;
239 	__u32 eccpos[MTD_MAX_ECCPOS_ENTRIES];
240 	__u32 oobavail;
241 	struct nand_oobfree oobfree[MTD_MAX_OOBFREE_ENTRIES];
242 };
243 
244 /**
245  * struct mtd_ecc_stats - error correction stats
246  *
247  * @corrected:	number of corrected bits
248  * @failed:	number of uncorrectable errors
249  * @badblocks:	number of bad blocks in this partition
250  * @bbtblocks:	number of blocks reserved for bad block tables
251  */
252 struct mtd_ecc_stats {
253 	__u32 corrected;
254 	__u32 failed;
255 	__u32 badblocks;
256 	__u32 bbtblocks;
257 };
258 
259 /*
260  * MTD file modes - for read/write access to MTD
261  *
262  * @MTD_FILE_MODE_NORMAL:	OTP disabled, ECC enabled
263  * @MTD_FILE_MODE_OTP_FACTORY:	OTP enabled in factory mode
264  * @MTD_FILE_MODE_OTP_USER:	OTP enabled in user mode
265  * @MTD_FILE_MODE_RAW:		OTP disabled, ECC disabled
266  *
267  * These modes can be set via ioctl(MTDFILEMODE). The mode will be retained
268  * separately for each open file descriptor.
269  *
270  * Note: %MTD_FILE_MODE_RAW provides the same functionality as %MTD_OPS_RAW -
271  * raw access to the flash, without error correction or autoplacement schemes.
272  * Wherever possible, the MTD_OPS_* mode will override the MTD_FILE_MODE_* mode
273  * (e.g., when using ioctl(MEMWRITE)), but in some cases, the MTD_FILE_MODE is
274  * used out of necessity (e.g., `write()', ioctl(MEMWRITEOOB64)).
275  */
276 enum mtd_file_modes {
277 	MTD_FILE_MODE_NORMAL = MTD_OTP_OFF,
278 	MTD_FILE_MODE_OTP_FACTORY = MTD_OTP_FACTORY,
279 	MTD_FILE_MODE_OTP_USER = MTD_OTP_USER,
280 	MTD_FILE_MODE_RAW,
281 };
282 
283 static inline int mtd_type_is_nand_user(const struct mtd_info_user *mtd)
284 {
285 	return mtd->type == MTD_NANDFLASH || mtd->type == MTD_MLCNANDFLASH;
286 }
287 
288 #endif /* __MTD_ABI_H__ */
289