[MTD] Introduce writesize
[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_ECC                 128     // Device capable of automatic ECC
34 #define MTD_PROGRAM_REGIONS     512     // Configurable Programming Regions
35 #define MTD_WRITEABLE           0x400   /* Device is writeable */
36
37 // Some common devices / combinations of capabilities
38 #define MTD_CAP_ROM             0
39 #define MTD_CAP_RAM             (MTD_WRITEABLE)
40 #define MTD_CAP_NORFLASH        (MTD_WRITEABLE)
41 #define MTD_CAP_NANDFLASH       (MTD_WRITEABLE)
42
43
44 // Types of automatic ECC/Checksum available
45 #define MTD_ECC_NONE            0       // No automatic ECC available
46 #define MTD_ECC_RS_DiskOnChip   1       // Automatic ECC on DiskOnChip
47 #define MTD_ECC_SW              2       // SW ECC for Toshiba & Samsung devices
48
49 /* ECC byte placement */
50 #define MTD_NANDECC_OFF         0       // Switch off ECC (Not recommended)
51 #define MTD_NANDECC_PLACE       1       // Use the given placement in the structure (YAFFS1 legacy mode)
52 #define MTD_NANDECC_AUTOPLACE   2       // Use the default placement scheme
53 #define MTD_NANDECC_PLACEONLY   3       // Use the given placement in the structure (Do not store ecc result on read)
54 #define MTD_NANDECC_AUTOPL_USR  4       // Use the given autoplacement scheme rather than using the default
55
56 /* OTP mode selection */
57 #define MTD_OTP_OFF             0
58 #define MTD_OTP_FACTORY         1
59 #define MTD_OTP_USER            2
60
61 struct mtd_info_user {
62         uint8_t type;
63         uint32_t flags;
64         uint32_t size;   // Total size of the MTD
65         uint32_t erasesize;
66         uint32_t writesize;
67         uint32_t oobsize;   // Amount of OOB data per block (e.g. 16)
68         uint32_t ecctype;
69         uint32_t eccsize;
70 };
71
72 struct region_info_user {
73         uint32_t offset;                /* At which this region starts,
74                                          * from the beginning of the MTD */
75         uint32_t erasesize;             /* For this region */
76         uint32_t numblocks;             /* Number of blocks in this region */
77         uint32_t regionindex;
78 };
79
80 struct otp_info {
81         uint32_t start;
82         uint32_t length;
83         uint32_t locked;
84 };
85
86 #define MEMGETINFO              _IOR('M', 1, struct mtd_info_user)
87 #define MEMERASE                _IOW('M', 2, struct erase_info_user)
88 #define MEMWRITEOOB             _IOWR('M', 3, struct mtd_oob_buf)
89 #define MEMREADOOB              _IOWR('M', 4, struct mtd_oob_buf)
90 #define MEMLOCK                 _IOW('M', 5, struct erase_info_user)
91 #define MEMUNLOCK               _IOW('M', 6, struct erase_info_user)
92 #define MEMGETREGIONCOUNT       _IOR('M', 7, int)
93 #define MEMGETREGIONINFO        _IOWR('M', 8, struct region_info_user)
94 #define MEMSETOOBSEL            _IOW('M', 9, struct nand_oobinfo)
95 #define MEMGETOOBSEL            _IOR('M', 10, struct nand_oobinfo)
96 #define MEMGETBADBLOCK          _IOW('M', 11, loff_t)
97 #define MEMSETBADBLOCK          _IOW('M', 12, loff_t)
98 #define OTPSELECT               _IOR('M', 13, int)
99 #define OTPGETREGIONCOUNT       _IOW('M', 14, int)
100 #define OTPGETREGIONINFO        _IOW('M', 15, struct otp_info)
101 #define OTPLOCK         _IOR('M', 16, struct otp_info)
102
103 struct nand_oobinfo {
104         uint32_t useecc;
105         uint32_t eccbytes;
106         uint32_t oobfree[8][2];
107         uint32_t eccpos[32];
108 };
109
110 #endif /* __MTD_ABI_H__ */