[JFFS2] Add support for JFFS2-on-Dataflash devices.
[linux-2.6.git] / include / mtd / mtd-abi.h
1 /*
2  * $Id: mtd-abi.h,v 1.10 2005/02/09 09:17:42 pavlov 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_PEROM               5
32 #define MTD_DATAFLASH           6
33 #define MTD_OTHER               14
34 #define MTD_UNKNOWN             15
35
36 #define MTD_CLEAR_BITS          1       // Bits can be cleared (flash)
37 #define MTD_SET_BITS            2       // Bits can be set
38 #define MTD_ERASEABLE           4       // Has an erase function
39 #define MTD_WRITEB_WRITEABLE    8       // Direct IO is possible
40 #define MTD_VOLATILE            16      // Set for RAMs
41 #define MTD_XIP                 32      // eXecute-In-Place possible
42 #define MTD_OOB                 64      // Out-of-band data (NAND flash)
43 #define MTD_ECC                 128     // Device capable of automatic ECC
44 #define MTD_NO_VIRTBLOCKS       256     // Virtual blocks not allowed
45
46 // Some common devices / combinations of capabilities
47 #define MTD_CAP_ROM             0
48 #define MTD_CAP_RAM             (MTD_CLEAR_BITS|MTD_SET_BITS|MTD_WRITEB_WRITEABLE)
49 #define MTD_CAP_NORFLASH        (MTD_CLEAR_BITS|MTD_ERASEABLE)
50 #define MTD_CAP_NANDFLASH       (MTD_CLEAR_BITS|MTD_ERASEABLE|MTD_OOB)
51 #define MTD_WRITEABLE           (MTD_CLEAR_BITS|MTD_SET_BITS)
52
53
54 // Types of automatic ECC/Checksum available
55 #define MTD_ECC_NONE            0       // No automatic ECC available
56 #define MTD_ECC_RS_DiskOnChip   1       // Automatic ECC on DiskOnChip
57 #define MTD_ECC_SW              2       // SW ECC for Toshiba & Samsung devices
58
59 /* ECC byte placement */
60 #define MTD_NANDECC_OFF         0       // Switch off ECC (Not recommended)
61 #define MTD_NANDECC_PLACE       1       // Use the given placement in the structure (YAFFS1 legacy mode)
62 #define MTD_NANDECC_AUTOPLACE   2       // Use the default placement scheme
63 #define MTD_NANDECC_PLACEONLY   3       // Use the given placement in the structure (Do not store ecc result on read)
64
65 /* OTP mode selection */
66 #define MTD_OTP_OFF             0
67 #define MTD_OTP_FACTORY         1
68 #define MTD_OTP_USER            2
69
70 struct mtd_info_user {
71         uint8_t type;
72         uint32_t flags;
73         uint32_t size;   // Total size of the MTD
74         uint32_t erasesize;
75         uint32_t oobblock;  // Size of OOB blocks (e.g. 512)
76         uint32_t oobsize;   // Amount of OOB data per block (e.g. 16)
77         uint32_t ecctype;
78         uint32_t eccsize;
79 };
80
81 struct region_info_user {
82         uint32_t offset;                /* At which this region starts, 
83                                          * from the beginning of the MTD */
84         uint32_t erasesize;             /* For this region */
85         uint32_t numblocks;             /* Number of blocks in this region */
86         uint32_t regionindex;
87 };
88
89 struct otp_info {
90         uint32_t start;
91         uint32_t length;
92         uint32_t locked;
93 };
94
95 #define MEMGETINFO              _IOR('M', 1, struct mtd_info_user)
96 #define MEMERASE                _IOW('M', 2, struct erase_info_user)
97 #define MEMWRITEOOB             _IOWR('M', 3, struct mtd_oob_buf)
98 #define MEMREADOOB              _IOWR('M', 4, struct mtd_oob_buf)
99 #define MEMLOCK                 _IOW('M', 5, struct erase_info_user)
100 #define MEMUNLOCK               _IOW('M', 6, struct erase_info_user)
101 #define MEMGETREGIONCOUNT       _IOR('M', 7, int)
102 #define MEMGETREGIONINFO        _IOWR('M', 8, struct region_info_user)
103 #define MEMSETOOBSEL            _IOW('M', 9, struct nand_oobinfo)
104 #define MEMGETOOBSEL            _IOR('M', 10, struct nand_oobinfo)
105 #define MEMGETBADBLOCK          _IOW('M', 11, loff_t)
106 #define MEMSETBADBLOCK          _IOW('M', 12, loff_t)
107 #define OTPSELECT               _IOR('M', 13, int)
108 #define OTPGETREGIONCOUNT       _IOW('M', 14, int)
109 #define OTPGETREGIONINFO        _IOW('M', 15, struct otp_info)
110 #define OTPLOCK         _IOR('M', 16, struct otp_info)
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 #endif /* __MTD_ABI_H__ */