f913c30d7b8976754e4c0008eb5c2db8eca44e08
[linux-3.10.git] / include / mtd / mtd-abi.h
1 /*
2  * $Id: mtd-abi.h,v 1.13 2005/11/07 11:14:56 gleixner Exp $
3  *
4  * Portions of MTD ABI definition which are shared by kernel and user space
5  */
6
7 #ifndef __MTD_ABI_H__
8 #define __MTD_ABI_H__
9
10 struct erase_info_user {
11         uint32_t start;
12         uint32_t length;
13 };
14
15 struct mtd_oob_buf {
16         uint32_t start;
17         uint32_t length;
18         unsigned char __user *ptr;
19 };
20
21 #define MTD_ABSENT              0
22 #define MTD_RAM                 1
23 #define MTD_ROM                 2
24 #define MTD_NORFLASH            3
25 #define MTD_NANDFLASH           4
26 #define MTD_DATAFLASH           6
27
28 #define MTD_WRITEABLE           0x400   /* Device is writeable */
29 #define MTD_BIT_WRITEABLE       0x800   /* Single bits can be flipped */
30 #define MTD_NO_ERASE            0x1000  /* No erase necessary */
31 #define MTD_STUPID_LOCK         0x2000  /* Always locked after reset */
32
33 // Some common devices / combinations of capabilities
34 #define MTD_CAP_ROM             0
35 #define MTD_CAP_RAM             (MTD_WRITEABLE | MTD_BIT_WRITEABLE | MTD_NO_ERASE)
36 #define MTD_CAP_NORFLASH        (MTD_WRITEABLE | MTD_BIT_WRITEABLE)
37 #define MTD_CAP_NANDFLASH       (MTD_WRITEABLE)
38
39
40 // Types of automatic ECC/Checksum available
41 #define MTD_ECC_NONE            0       // No automatic ECC available
42 #define MTD_ECC_RS_DiskOnChip   1       // Automatic ECC on DiskOnChip
43 #define MTD_ECC_SW              2       // SW ECC for Toshiba & Samsung devices
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         uint8_t type;
59         uint32_t flags;
60         uint32_t size;   // Total size of the MTD
61         uint32_t erasesize;
62         uint32_t writesize;
63         uint32_t oobsize;   // Amount of OOB data per block (e.g. 16)
64         uint32_t ecctype;
65         uint32_t eccsize;
66 };
67
68 struct region_info_user {
69         uint32_t offset;                /* At which this region starts,
70                                          * from the beginning of the MTD */
71         uint32_t erasesize;             /* For this region */
72         uint32_t numblocks;             /* Number of blocks in this region */
73         uint32_t regionindex;
74 };
75
76 struct otp_info {
77         uint32_t start;
78         uint32_t length;
79         uint32_t locked;
80 };
81
82 #define MEMGETINFO              _IOR('M', 1, struct mtd_info_user)
83 #define MEMERASE                _IOW('M', 2, struct erase_info_user)
84 #define MEMWRITEOOB             _IOWR('M', 3, struct mtd_oob_buf)
85 #define MEMREADOOB              _IOWR('M', 4, struct mtd_oob_buf)
86 #define MEMLOCK                 _IOW('M', 5, struct erase_info_user)
87 #define MEMUNLOCK               _IOW('M', 6, struct erase_info_user)
88 #define MEMGETREGIONCOUNT       _IOR('M', 7, int)
89 #define MEMGETREGIONINFO        _IOWR('M', 8, struct region_info_user)
90 #define MEMSETOOBSEL            _IOW('M', 9, struct nand_oobinfo)
91 #define MEMGETOOBSEL            _IOR('M', 10, struct nand_oobinfo)
92 #define MEMGETBADBLOCK          _IOW('M', 11, loff_t)
93 #define MEMSETBADBLOCK          _IOW('M', 12, loff_t)
94 #define OTPSELECT               _IOR('M', 13, int)
95 #define OTPGETREGIONCOUNT       _IOW('M', 14, int)
96 #define OTPGETREGIONINFO        _IOW('M', 15, struct otp_info)
97 #define OTPLOCK                 _IOR('M', 16, struct otp_info)
98 #define ECCGETLAYOUT            _IOR('M', 17, struct nand_ecclayout)
99 #define ECCGETSTATS             _IOR('M', 18, struct mtd_ecc_stats)
100 #define MTDFILEMODE             _IO('M', 19)
101
102 /*
103  * Obsolete legacy interface. Keep it in order not to break userspace
104  * interfaces
105  */
106 struct nand_oobinfo {
107         uint32_t useecc;
108         uint32_t eccbytes;
109         uint32_t oobfree[8][2];
110         uint32_t eccpos[32];
111 };
112
113 struct nand_oobfree {
114         uint32_t offset;
115         uint32_t length;
116 };
117
118 #define MTD_MAX_OOBFREE_ENTRIES 8
119 /*
120  * ECC layout control structure. Exported to userspace for
121  * diagnosis and to allow creation of raw images
122  */
123 struct nand_ecclayout {
124         uint32_t eccbytes;
125         uint32_t eccpos[64];
126         uint32_t oobavail;
127         struct nand_oobfree oobfree[MTD_MAX_OOBFREE_ENTRIES];
128 };
129
130 /**
131  * struct mtd_ecc_stats - error correction stats
132  *
133  * @corrected:  number of corrected bits
134  * @failed:     number of uncorrectable errors
135  * @badblocks:  number of bad blocks in this partition
136  * @bbtblocks:  number of blocks reserved for bad block tables
137  */
138 struct mtd_ecc_stats {
139         uint32_t corrected;
140         uint32_t failed;
141         uint32_t badblocks;
142         uint32_t bbtblocks;
143 };
144
145 /*
146  * Read/write file modes for access to MTD
147  */
148 enum mtd_file_modes {
149         MTD_MODE_NORMAL = MTD_OTP_OFF,
150         MTD_MODE_OTP_FACTORY = MTD_OTP_FACTORY,
151         MTD_MODE_OTP_USER = MTD_OTP_USER,
152         MTD_MODE_RAW,
153 };
154
155 #endif /* __MTD_ABI_H__ */