b0a67b7ffdcd2697b1b281c4b3ff1c1733214216
[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 #ifndef __KERNEL__ 
11 /* Urgh. The whole point of splitting this out into
12    separate files was to avoid #ifdef __KERNEL__ */
13 #define __user
14 #endif
15
16 struct erase_info_user {
17         uint32_t start;
18         uint32_t length;
19 };
20
21 struct mtd_oob_buf {
22         uint32_t start;
23         uint32_t length;
24         unsigned char __user *ptr;
25 };
26
27 #define MTD_ABSENT              0
28 #define MTD_RAM                 1
29 #define MTD_ROM                 2
30 #define MTD_NORFLASH            3
31 #define MTD_NANDFLASH           4
32 #define MTD_DATAFLASH           6
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_STUPID_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
46 // Types of automatic ECC/Checksum available
47 #define MTD_ECC_NONE            0       // No automatic ECC available
48 #define MTD_ECC_RS_DiskOnChip   1       // Automatic ECC on DiskOnChip
49 #define MTD_ECC_SW              2       // SW ECC for Toshiba & Samsung devices
50
51 /* ECC byte placement */
52 #define MTD_NANDECC_OFF         0       // Switch off ECC (Not recommended)
53 #define MTD_NANDECC_PLACE       1       // Use the given placement in the structure (YAFFS1 legacy mode)
54 #define MTD_NANDECC_AUTOPLACE   2       // Use the default placement scheme
55 #define MTD_NANDECC_PLACEONLY   3       // Use the given placement in the structure (Do not store ecc result on read)
56 #define MTD_NANDECC_AUTOPL_USR  4       // Use the given autoplacement scheme rather than using the default
57
58 /* OTP mode selection */
59 #define MTD_OTP_OFF             0
60 #define MTD_OTP_FACTORY         1
61 #define MTD_OTP_USER            2
62
63 struct mtd_info_user {
64         uint8_t type;
65         uint32_t flags;
66         uint32_t size;   // Total size of the MTD
67         uint32_t erasesize;
68         uint32_t writesize;
69         uint32_t oobsize;   // Amount of OOB data per block (e.g. 16)
70         uint32_t ecctype;
71         uint32_t eccsize;
72 };
73
74 struct region_info_user {
75         uint32_t offset;                /* At which this region starts,
76                                          * from the beginning of the MTD */
77         uint32_t erasesize;             /* For this region */
78         uint32_t numblocks;             /* Number of blocks in this region */
79         uint32_t regionindex;
80 };
81
82 struct otp_info {
83         uint32_t start;
84         uint32_t length;
85         uint32_t locked;
86 };
87
88 #define MEMGETINFO              _IOR('M', 1, struct mtd_info_user)
89 #define MEMERASE                _IOW('M', 2, struct erase_info_user)
90 #define MEMWRITEOOB             _IOWR('M', 3, struct mtd_oob_buf)
91 #define MEMREADOOB              _IOWR('M', 4, struct mtd_oob_buf)
92 #define MEMLOCK                 _IOW('M', 5, struct erase_info_user)
93 #define MEMUNLOCK               _IOW('M', 6, struct erase_info_user)
94 #define MEMGETREGIONCOUNT       _IOR('M', 7, int)
95 #define MEMGETREGIONINFO        _IOWR('M', 8, struct region_info_user)
96 #define MEMSETOOBSEL            _IOW('M', 9, struct nand_oobinfo)
97 #define MEMGETOOBSEL            _IOR('M', 10, struct nand_oobinfo)
98 #define MEMGETBADBLOCK          _IOW('M', 11, loff_t)
99 #define MEMSETBADBLOCK          _IOW('M', 12, loff_t)
100 #define OTPSELECT               _IOR('M', 13, int)
101 #define OTPGETREGIONCOUNT       _IOW('M', 14, int)
102 #define OTPGETREGIONINFO        _IOW('M', 15, struct otp_info)
103 #define OTPLOCK                 _IOR('M', 16, struct otp_info)
104 #define ECCGETLAYOUT            _IOR('M', 17, struct nand_ecclayout)
105 #define ECCGETSTATS             _IOR('M', 18, struct mtd_ecc_stats)
106 #define MTDFILEMODE             _IO('M', 19)
107
108 /*
109  * Obsolete legacy interface. Keep it in order not to break userspace
110  * interfaces
111  */
112 struct nand_oobinfo {
113         uint32_t useecc;
114         uint32_t eccbytes;
115         uint32_t oobfree[8][2];
116         uint32_t eccpos[32];
117 };
118
119 struct nand_oobfree {
120         uint32_t offset;
121         uint32_t length;
122 };
123
124 #define MTD_MAX_OOBFREE_ENTRIES 8
125 /*
126  * ECC layout control structure. Exported to userspace for
127  * diagnosis and to allow creation of raw images
128  */
129 struct nand_ecclayout {
130         uint32_t eccbytes;
131         uint32_t eccpos[64];
132         uint32_t oobavail;
133         struct nand_oobfree oobfree[MTD_MAX_OOBFREE_ENTRIES];
134 };
135
136 /**
137  * struct mtd_ecc_stats - error correction stats
138  *
139  * @corrected:  number of corrected bits
140  * @failed:     number of uncorrectable errors
141  * @badblocks:  number of bad blocks in this partition
142  * @bbtblocks:  number of blocks reserved for bad block tables
143  */
144 struct mtd_ecc_stats {
145         uint32_t corrected;
146         uint32_t failed;
147         uint32_t badblocks;
148         uint32_t bbtblocks;
149 };
150
151 /*
152  * Read/write file modes for access to MTD
153  */
154 enum mtd_file_modes {
155         MTD_MODE_NORMAL = MTD_OTP_OFF,
156         MTD_MODE_OTP_FACTORY = MTD_OTP_FACTORY,
157         MTD_MODE_OTP_USER = MTD_OTP_USER,
158         MTD_MODE_RAW,
159 };
160
161 #endif /* __MTD_ABI_H__ */