fa2524157846afeebecbe9fffeb86844a1d392fb
[linux-2.6.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__ /* Urgh. The whole point of splitting this out into
11                     separate files was to avoid #ifdef __KERNEL__ */
12 #define __user
13 #endif
14
15 struct erase_info_user {
16         uint32_t start;
17         uint32_t length;
18 };
19
20 struct mtd_oob_buf {
21         uint32_t start;
22         uint32_t 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
33 #define MTD_CLEAR_BITS          1       // Bits can be cleared (flash)
34 #define MTD_SET_BITS            2       // Bits can be set
35 #define MTD_ECC                 128     // Device capable of automatic ECC
36 #define MTD_PROGRAM_REGIONS     512     // Configurable Programming Regions
37
38 // Some common devices / combinations of capabilities
39 #define MTD_CAP_ROM             0
40 #define MTD_CAP_RAM             (MTD_CLEAR_BITS|MTD_SET_BITS)
41 #define MTD_CAP_NORFLASH        (MTD_CLEAR_BITS)
42 #define MTD_CAP_NANDFLASH       (MTD_CLEAR_BITS)
43 #define MTD_WRITEABLE           (MTD_CLEAR_BITS|MTD_SET_BITS)
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 oobblock;  // Size of OOB blocks (e.g. 512)
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
105 struct nand_oobinfo {
106         uint32_t useecc;
107         uint32_t eccbytes;
108         uint32_t oobfree[8][2];
109         uint32_t eccpos[32];
110 };
111
112 #endif /* __MTD_ABI_H__ */