blob: f71dac4203948421595e0f79cad9140c70d7c903 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Thomas Gleixnere4f06482005-11-07 11:15:37 +00002 * $Id: mtd-abi.h,v 1.13 2005/11/07 11:14:56 gleixner Exp $
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
Thomas Gleixnere4f06482005-11-07 11:15:37 +00004 * Portions of MTD ABI definition which are shared by kernel and user space
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 */
6
7#ifndef __MTD_ABI_H__
8#define __MTD_ABI_H__
9
Linus Torvalds1da177e2005-04-16 15:20:36 -070010struct erase_info_user {
11 uint32_t start;
12 uint32_t length;
13};
14
15struct mtd_oob_buf {
16 uint32_t start;
17 uint32_t length;
18 unsigned char __user *ptr;
19};
20
21#define MTD_ABSENT 0
David Woodhouse21c8db92006-06-14 21:39:48 +010022#define MTD_RAM 1
23#define MTD_ROM 2
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#define MTD_NORFLASH 3
25#define MTD_NANDFLASH 4
Andrew Victor8f15fd52005-02-09 09:17:45 +000026#define MTD_DATAFLASH 6
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040027#define MTD_UBIVOLUME 7
Linus Torvalds1da177e2005-04-16 15:20:36 -070028
Joern Engel8ca9ed52006-05-22 23:17:23 +020029#define MTD_WRITEABLE 0x400 /* Device is writeable */
Joern Engel5fa43392006-05-22 23:18:29 +020030#define MTD_BIT_WRITEABLE 0x800 /* Single bits can be flipped */
Joern Engel92cbfdc2006-05-30 14:25:24 +020031#define MTD_NO_ERASE 0x1000 /* No erase necessary */
HÃ¥vard Skinnemoen187ef152006-09-22 10:07:08 +010032#define MTD_STUPID_LOCK 0x2000 /* Always locked after reset */
Linus Torvalds1da177e2005-04-16 15:20:36 -070033
34// Some common devices / combinations of capabilities
35#define MTD_CAP_ROM 0
Joern Engel92cbfdc2006-05-30 14:25:24 +020036#define MTD_CAP_RAM (MTD_WRITEABLE | MTD_BIT_WRITEABLE | MTD_NO_ERASE)
Joern Engel5fa43392006-05-22 23:18:29 +020037#define MTD_CAP_NORFLASH (MTD_WRITEABLE | MTD_BIT_WRITEABLE)
Joern Engel8ca9ed52006-05-22 23:17:23 +020038#define MTD_CAP_NANDFLASH (MTD_WRITEABLE)
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
Linus Torvalds1da177e2005-04-16 15:20:36 -070040/* ECC byte placement */
41#define MTD_NANDECC_OFF 0 // Switch off ECC (Not recommended)
42#define MTD_NANDECC_PLACE 1 // Use the given placement in the structure (YAFFS1 legacy mode)
43#define MTD_NANDECC_AUTOPLACE 2 // Use the default placement scheme
44#define MTD_NANDECC_PLACEONLY 3 // Use the given placement in the structure (Do not store ecc result on read)
Thomas Gleixner90e260c2005-05-19 17:10:26 +010045#define MTD_NANDECC_AUTOPL_USR 4 // Use the given autoplacement scheme rather than using the default
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
Nicolas Pitre31f42332005-02-08 17:45:55 +000047/* OTP mode selection */
48#define MTD_OTP_OFF 0
49#define MTD_OTP_FACTORY 1
50#define MTD_OTP_USER 2
51
Linus Torvalds1da177e2005-04-16 15:20:36 -070052struct mtd_info_user {
53 uint8_t type;
54 uint32_t flags;
55 uint32_t size; // Total size of the MTD
56 uint32_t erasesize;
Joern Engel28318772006-05-22 23:18:05 +020057 uint32_t writesize;
Linus Torvalds1da177e2005-04-16 15:20:36 -070058 uint32_t oobsize; // Amount of OOB data per block (e.g. 16)
Artem Bityutskiy64f60712007-01-30 10:50:43 +020059 /* The below two fields are obsolete and broken, do not use them
60 * (TODO: remove at some point) */
Linus Torvalds1da177e2005-04-16 15:20:36 -070061 uint32_t ecctype;
62 uint32_t eccsize;
63};
64
65struct region_info_user {
Thomas Gleixnere4f06482005-11-07 11:15:37 +000066 uint32_t offset; /* At which this region starts,
Linus Torvalds1da177e2005-04-16 15:20:36 -070067 * from the beginning of the MTD */
68 uint32_t erasesize; /* For this region */
69 uint32_t numblocks; /* Number of blocks in this region */
70 uint32_t regionindex;
71};
72
Nicolas Pitref77814d2005-02-08 17:11:19 +000073struct otp_info {
74 uint32_t start;
75 uint32_t length;
76 uint32_t locked;
77};
78
Thomas Gleixner5bd34c02006-05-27 22:16:10 +020079#define MEMGETINFO _IOR('M', 1, struct mtd_info_user)
80#define MEMERASE _IOW('M', 2, struct erase_info_user)
81#define MEMWRITEOOB _IOWR('M', 3, struct mtd_oob_buf)
82#define MEMREADOOB _IOWR('M', 4, struct mtd_oob_buf)
83#define MEMLOCK _IOW('M', 5, struct erase_info_user)
84#define MEMUNLOCK _IOW('M', 6, struct erase_info_user)
Linus Torvalds1da177e2005-04-16 15:20:36 -070085#define MEMGETREGIONCOUNT _IOR('M', 7, int)
86#define MEMGETREGIONINFO _IOWR('M', 8, struct region_info_user)
87#define MEMSETOOBSEL _IOW('M', 9, struct nand_oobinfo)
88#define MEMGETOOBSEL _IOR('M', 10, struct nand_oobinfo)
89#define MEMGETBADBLOCK _IOW('M', 11, loff_t)
90#define MEMSETBADBLOCK _IOW('M', 12, loff_t)
Nicolas Pitre31f42332005-02-08 17:45:55 +000091#define OTPSELECT _IOR('M', 13, int)
92#define OTPGETREGIONCOUNT _IOW('M', 14, int)
93#define OTPGETREGIONINFO _IOW('M', 15, struct otp_info)
Thomas Gleixner5bd34c02006-05-27 22:16:10 +020094#define OTPLOCK _IOR('M', 16, struct otp_info)
95#define ECCGETLAYOUT _IOR('M', 17, struct nand_ecclayout)
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +020096#define ECCGETSTATS _IOR('M', 18, struct mtd_ecc_stats)
97#define MTDFILEMODE _IO('M', 19)
Linus Torvalds1da177e2005-04-16 15:20:36 -070098
Thomas Gleixner5bd34c02006-05-27 22:16:10 +020099/*
100 * Obsolete legacy interface. Keep it in order not to break userspace
101 * interfaces
102 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103struct nand_oobinfo {
104 uint32_t useecc;
105 uint32_t eccbytes;
106 uint32_t oobfree[8][2];
107 uint32_t eccpos[32];
108};
109
Thomas Gleixner5bd34c02006-05-27 22:16:10 +0200110struct nand_oobfree {
111 uint32_t offset;
112 uint32_t length;
113};
114
115#define MTD_MAX_OOBFREE_ENTRIES 8
116/*
117 * ECC layout control structure. Exported to userspace for
118 * diagnosis and to allow creation of raw images
119 */
120struct nand_ecclayout {
121 uint32_t eccbytes;
122 uint32_t eccpos[64];
123 uint32_t oobavail;
124 struct nand_oobfree oobfree[MTD_MAX_OOBFREE_ENTRIES];
125};
126
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200127/**
Randy Dunlapea9b6dc2006-06-28 21:48:38 -0700128 * struct mtd_ecc_stats - error correction stats
Thomas Gleixnerf1a28c02006-05-30 00:37:34 +0200129 *
130 * @corrected: number of corrected bits
131 * @failed: number of uncorrectable errors
132 * @badblocks: number of bad blocks in this partition
133 * @bbtblocks: number of blocks reserved for bad block tables
134 */
135struct mtd_ecc_stats {
136 uint32_t corrected;
137 uint32_t failed;
138 uint32_t badblocks;
139 uint32_t bbtblocks;
140};
141
142/*
143 * Read/write file modes for access to MTD
144 */
145enum mtd_file_modes {
146 MTD_MODE_NORMAL = MTD_OTP_OFF,
147 MTD_MODE_OTP_FACTORY = MTD_OTP_FACTORY,
148 MTD_MODE_OTP_USER = MTD_OTP_USER,
149 MTD_MODE_RAW,
150};
151
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152#endif /* __MTD_ABI_H__ */