uapi/mtd/mtd-abi.h

1 /* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */
3  * Copyright © 1999-2010 David Woodhouse <dwmw2@infradead.org> et al.
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
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * You should have received a copy of the GNU General Public License
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
55  * @MTD_OPS_RAW:	data are transferred as-is, with no error correction;
69  * struct mtd_write_req - data structure for requesting a write operation
72  * @len:	length of data buffer (only lower 32 bits are used)
73  * @ooblen:	length of OOB buffer (only lower 32 bits are used)
74  * @usr_data:	user-provided data buffer
75  * @usr_oob:	user-provided OOB buffer
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
95  * struct mtd_read_req_ecc_stats - ECC statistics for a read operation
97  * @uncorrectable_errors: the number of uncorrectable errors that happened
99  * @corrected_bitflips: the number of bitflips corrected during the read
101  * @max_bitflips: the maximum number of bitflips detected in any single ECC
104  *		  region of the MTD device should be moved somewhere else to
114  * struct mtd_read_req - data structure for requesting a read operation
117  * @len:	length of data buffer (only lower 32 bits are used)
118  * @ooblen:	length of OOB buffer (only lower 32 bits are used)
119  * @usr_data:	user-provided data buffer
120  * @usr_oob:	user-provided OOB buffer
126  * reads in various modes. To read from OOB-only, set @usr_data == NULL, and to
127  * read data-only, set @usr_oob == NULL. However, setting both @usr_data and
156 /* Some common devices / combinations of capabilities */
178 	__u32 size;	/* Total size of the MTD */
181 	__u32 oobsize;	/* Amount of OOB data per block (e.g. 16) */
187 				 * from the beginning of the MTD */
189 	__u32 numblocks;	/* Number of blocks in this region */
207 /* Erase segment of MTD */
209 /* Write out-of-band data from MTD */
211 /* Read out-of-band data from MTD */
217 /* Get the number of different erase regions */
221 /* Get info about OOB modes (e.g., RAW, PLACE, AUTO) - legacy interface */
227 /* Set OTP (One-Time Programmable) mode (factory vs. user) */
229 /* Get number of OTP (One-Time Programmable) regions */
231 /* Get all OTP (One-Time Programmable) info about MTD */
233 /* Lock a given range of user data (must be in mode %MTD_FILE_MODE_OTP_USER) */
239 /* Set MTD mode on a per-file-descriptor basis (see "MTD file modes") */
241 /* Erase segment of MTD (supports 64-bit address) */
243 /* Write data to OOB (64-bit version) */
245 /* Read data from OOB (64-bit version) */
250  * Most generic write interface; can write in-band and/or out-of-band in various
255 /* Erase a given range of user data (must be in mode %MTD_FILE_MODE_OTP_USER) */
258  * Most generic read interface; can read in-band and/or out-of-band in various
283  * OBSOLETE: ECC layout control structure. Exported to user-space via ioctl
285  * complete set of ECC information. The ioctl truncates the larger internal
286  * structure to retain binary compatibility with the static declaration of the
287  * ioctl. Note that the "MTD_MAX_..._ENTRIES" macros represent the max size of
288  * the user struct, not the MAX size of the internal OOB layout representation.
298  * struct mtd_ecc_stats - error correction stats
300  * @corrected:	number of corrected bits
301  * @failed:	number of uncorrectable errors
302  * @badblocks:	number of bad blocks in this partition
303  * @bbtblocks:	number of blocks reserved for bad block tables
313  * MTD file modes - for read/write access to MTD
323  * Note: %MTD_FILE_MODE_RAW provides the same functionality as %MTD_OPS_RAW -
327  * MTD_FILE_MODE is used out of necessity (e.g., `write()',
339 	return mtd->type == MTD_NANDFLASH || mtd->type == MTD_MLCNANDFLASH;  in mtd_type_is_nand_user()