mtd: add MEMERASE64 ioctl for >4GiB devices
[linux-2.6.git] / include / mtd / mtd-abi.h
1 /*
2  * Portions of MTD ABI definition which are shared by kernel and user space
3  */
4
5 #ifndef __MTD_ABI_H__
6 #define __MTD_ABI_H__
7
8 #include <linux/types.h>
9
10 struct erase_info_user {
11         __u32 start;
12         __u32 length;
13 };
14
15 struct erase_info_user64 {
16         __u64 start;
17         __u64 length;
18 };
19
20 struct mtd_oob_buf {
21         __u32 start;
22         __u32 length;
23         unsigned char __user *ptr;
24 };
25
26 #define MTD_ABSENT              0
27 #define MTD_RAM                 1
28 #define MTD_ROM                 2
29 #define MTD_NORFLASH            3
30 #define MTD_NANDFLASH           4
31 #define MTD_DATAFLASH           6
32 #define MTD_UBIVOLUME           7
33
34 #define MTD_WRITEABLE           0x400   /* Device is writeable */
35 #define MTD_BIT_WRITEABLE       0x800   /* Single bits can be flipped */
36 #define MTD_NO_ERASE            0x1000  /* No erase necessary */
37 #define MTD_POWERUP_LOCK        0x2000  /* Always locked after reset */
38
39 // Some common devices / combinations of capabilities
40 #define MTD_CAP_ROM             0
41 #define MTD_CAP_RAM             (MTD_WRITEABLE | MTD_BIT_WRITEABLE | MTD_NO_ERASE)
42 #define MTD_CAP_NORFLASH        (MTD_WRITEABLE | MTD_BIT_WRITEABLE)
43 #define MTD_CAP_NANDFLASH       (MTD_WRITEABLE)
44
45 /* ECC byte placement */
46 #define MTD_NANDECC_OFF         0       // Switch off ECC (Not recommended)
47 #define MTD_NANDECC_PLACE       1       // Use the given placement in the structure (YAFFS1 legacy mode)
48 #define MTD_NANDECC_AUTOPLACE   2       // Use the default placement scheme
49 #define MTD_NANDECC_PLACEONLY   3       // Use the given placement in the structure (Do not store ecc result on read)
50 #define MTD_NANDECC_AUTOPL_USR  4       // Use the given autoplacement scheme rather than using the default
51
52 /* OTP mode selection */
53 #define MTD_OTP_OFF             0
54 #define MTD_OTP_FACTORY         1
55 #define MTD_OTP_USER            2
56
57 struct mtd_info_user {
58         __u8 type;
59         __u32 flags;
60         __u32 size;      // Total size of the MTD
61         __u32 erasesize;
62         __u32 writesize;
63         __u32 oobsize;   // Amount of OOB data per block (e.g. 16)
64         /* The below two fields are obsolete and broken, do not use them
65          * (TODO: remove at some point) */
66         __u32 ecctype;
67         __u32 eccsize;
68 };
69
70 struct region_info_user {
71         __u32 offset;           /* At which this region starts,
72                                          * from the beginning of the MTD */
73         __u32 erasesize;                /* For this region */
74         __u32 numblocks;                /* Number of blocks in this region */
75         __u32 regionindex;
76 };
77
78 struct otp_info {
79         __u32 start;
80         __u32 length;
81         __u32 locked;
82 };
83
84 #define MEMGETINFO              _IOR('M', 1, struct mtd_info_user)
85 #define MEMERASE                _IOW('M', 2, struct erase_info_user)
86 #define MEMWRITEOOB             _IOWR('M', 3, struct mtd_oob_buf)
87 #define MEMREADOOB              _IOWR('M', 4, struct mtd_oob_buf)
88 #define MEMLOCK                 _IOW('M', 5, struct erase_info_user)
89 #define MEMUNLOCK               _IOW('M', 6, struct erase_info_user)
90 #define MEMGETREGIONCOUNT       _IOR('M', 7, int)
91 #define MEMGETREGIONINFO        _IOWR('M', 8, struct region_info_user)
92 #define MEMSETOOBSEL            _IOW('M', 9, struct nand_oobinfo)
93 #define MEMGETOOBSEL            _IOR('M', 10, struct nand_oobinfo)
94 #define MEMGETBADBLOCK          _IOW('M', 11, __kernel_loff_t)
95 #define MEMSETBADBLOCK          _IOW('M', 12, __kernel_loff_t)
96 #define OTPSELECT               _IOR('M', 13, int)
97 #define OTPGETREGIONCOUNT       _IOW('M', 14, int)
98 #define OTPGETREGIONINFO        _IOW('M', 15, struct otp_info)
99 #define OTPLOCK                 _IOR('M', 16, struct otp_info)
100 #define ECCGETLAYOUT            _IOR('M', 17, struct nand_ecclayout)
101 #define ECCGETSTATS             _IOR('M', 18, struct mtd_ecc_stats)
102 #define MTDFILEMODE             _IO('M', 19)
103 #define MEMERASE64              _IOW('M', 20, struct erase_info_user64)
104
105 /*
106  * Obsolete legacy interface. Keep it in order not to break userspace
107  * interfaces
108  */
109 struct nand_oobinfo {
110         __u32 useecc;
111         __u32 eccbytes;
112         __u32 oobfree[8][2];
113         __u32 eccpos[32];
114 };
115
116 struct nand_oobfree {
117         __u32 offset;
118         __u32 length;
119 };
120
121 #define MTD_MAX_OOBFREE_ENTRIES 8
122 /*
123  * ECC layout control structure. Exported to userspace for
124  * diagnosis and to allow creation of raw images
125  */
126 struct nand_ecclayout {
127         __u32 eccbytes;
128         __u32 eccpos[64];
129         __u32 oobavail;
130         struct nand_oobfree oobfree[MTD_MAX_OOBFREE_ENTRIES];
131 };
132
133 /**
134  * struct mtd_ecc_stats - error correction stats
135  *
136  * @corrected:  number of corrected bits
137  * @failed:     number of uncorrectable errors
138  * @badblocks:  number of bad blocks in this partition
139  * @bbtblocks:  number of blocks reserved for bad block tables
140  */
141 struct mtd_ecc_stats {
142         __u32 corrected;
143         __u32 failed;
144         __u32 badblocks;
145         __u32 bbtblocks;
146 };
147
148 /*
149  * Read/write file modes for access to MTD
150  */
151 enum mtd_file_modes {
152         MTD_MODE_NORMAL = MTD_OTP_OFF,
153         MTD_MODE_OTP_FACTORY = MTD_OTP_FACTORY,
154         MTD_MODE_OTP_USER = MTD_OTP_USER,
155         MTD_MODE_RAW,
156 };
157
158 #endif /* __MTD_ABI_H__ */