Version:  2.6.34 2.6.35 2.6.36 2.6.37 2.6.38 2.6.39 3.0 3.1 3.2 3.3 3.4 3.5 3.6 3.7 3.8 3.9 3.10 3.11 3.12 3.13 3.14

Linux/include/mtd/mtd-abi.h

  1 /*
  2  * Copyright © 1999-2010 David Woodhouse <dwmw2@infradead.org> et al.
  3  *
  4  * This program is free software; you can redistribute it and/or modify
  5  * it under the terms of the GNU General Public License as published by
  6  * the Free Software Foundation; either version 2 of the License, or
  7  * (at your option) any later version.
  8  *
  9  * This program is distributed in the hope that it will be useful,
 10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
 11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 12  * GNU General Public License for more details.
 13  *
 14  * You should have received a copy of the GNU General Public License
 15  * along with this program; if not, write to the Free Software
 16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 17  *
 18  */
 19 
 20 #ifndef __MTD_ABI_H__
 21 #define __MTD_ABI_H__
 22 
 23 #include <linux/types.h>
 24 
 25 struct erase_info_user {
 26         __u32 start;
 27         __u32 length;
 28 };
 29 
 30 struct erase_info_user64 {
 31         __u64 start;
 32         __u64 length;
 33 };
 34 
 35 struct mtd_oob_buf {
 36         __u32 start;
 37         __u32 length;
 38         unsigned char __user *ptr;
 39 };
 40 
 41 struct mtd_oob_buf64 {
 42         __u64 start;
 43         __u32 pad;
 44         __u32 length;
 45         __u64 usr_ptr;
 46 };
 47 
 48 #define MTD_ABSENT              0
 49 #define MTD_RAM                 1
 50 #define MTD_ROM                 2
 51 #define MTD_NORFLASH            3
 52 #define MTD_NANDFLASH           4
 53 #define MTD_DATAFLASH           6
 54 #define MTD_UBIVOLUME           7
 55 #define MTD_MLCNANDFLASH        8
 56 
 57 #define MTD_WRITEABLE           0x400   /* Device is writeable */
 58 #define MTD_BIT_WRITEABLE       0x800   /* Single bits can be flipped */
 59 #define MTD_NO_ERASE            0x1000  /* No erase necessary */
 60 #define MTD_POWERUP_LOCK        0x2000  /* Always locked after reset */
 61 
 62 // Some common devices / combinations of capabilities
 63 #define MTD_CAP_ROM             0
 64 #define MTD_CAP_RAM             (MTD_WRITEABLE | MTD_BIT_WRITEABLE | MTD_NO_ERASE)
 65 #define MTD_CAP_NORFLASH        (MTD_WRITEABLE | MTD_BIT_WRITEABLE)
 66 #define MTD_CAP_NANDFLASH       (MTD_WRITEABLE)
 67 
 68 /* ECC byte placement */
 69 #define MTD_NANDECC_OFF         0       // Switch off ECC (Not recommended)
 70 #define MTD_NANDECC_PLACE       1       // Use the given placement in the structure (YAFFS1 legacy mode)
 71 #define MTD_NANDECC_AUTOPLACE   2       // Use the default placement scheme
 72 #define MTD_NANDECC_PLACEONLY   3       // Use the given placement in the structure (Do not store ecc result on read)
 73 #define MTD_NANDECC_AUTOPL_USR  4       // Use the given autoplacement scheme rather than using the default
 74 
 75 /* OTP mode selection */
 76 #define MTD_OTP_OFF             0
 77 #define MTD_OTP_FACTORY         1
 78 #define MTD_OTP_USER            2
 79 
 80 struct mtd_info_user {
 81         __u8 type;
 82         __u32 flags;
 83         __u32 size;      // Total size of the MTD
 84         __u32 erasesize;
 85         __u32 writesize;
 86         __u32 oobsize;   // Amount of OOB data per block (e.g. 16)
 87         /* The below two fields are obsolete and broken, do not use them
 88          * (TODO: remove at some point) */
 89         __u32 ecctype;
 90         __u32 eccsize;
 91 };
 92 
 93 struct region_info_user {
 94         __u32 offset;           /* At which this region starts,
 95                                          * from the beginning of the MTD */
 96         __u32 erasesize;                /* For this region */
 97         __u32 numblocks;                /* Number of blocks in this region */
 98         __u32 regionindex;
 99 };
100 
101 struct otp_info {
102         __u32 start;
103         __u32 length;
104         __u32 locked;
105 };
106 
107 #define MEMGETINFO              _IOR('M', 1, struct mtd_info_user)
108 #define MEMERASE                _IOW('M', 2, struct erase_info_user)
109 #define MEMWRITEOOB             _IOWR('M', 3, struct mtd_oob_buf)
110 #define MEMREADOOB              _IOWR('M', 4, struct mtd_oob_buf)
111 #define MEMLOCK                 _IOW('M', 5, struct erase_info_user)
112 #define MEMUNLOCK               _IOW('M', 6, struct erase_info_user)
113 #define MEMGETREGIONCOUNT       _IOR('M', 7, int)
114 #define MEMGETREGIONINFO        _IOWR('M', 8, struct region_info_user)
115 #define MEMSETOOBSEL            _IOW('M', 9, struct nand_oobinfo)
116 #define MEMGETOOBSEL            _IOR('M', 10, struct nand_oobinfo)
117 #define MEMGETBADBLOCK          _IOW('M', 11, __kernel_loff_t)
118 #define MEMSETBADBLOCK          _IOW('M', 12, __kernel_loff_t)
119 #define OTPSELECT               _IOR('M', 13, int)
120 #define OTPGETREGIONCOUNT       _IOW('M', 14, int)
121 #define OTPGETREGIONINFO        _IOW('M', 15, struct otp_info)
122 #define OTPLOCK                 _IOR('M', 16, struct otp_info)
123 #define ECCGETLAYOUT            _IOR('M', 17, struct nand_ecclayout_user)
124 #define ECCGETSTATS             _IOR('M', 18, struct mtd_ecc_stats)
125 #define MTDFILEMODE             _IO('M', 19)
126 #define MEMERASE64              _IOW('M', 20, struct erase_info_user64)
127 #define MEMWRITEOOB64           _IOWR('M', 21, struct mtd_oob_buf64)
128 #define MEMREADOOB64            _IOWR('M', 22, struct mtd_oob_buf64)
129 #define MEMISLOCKED             _IOR('M', 23, struct erase_info_user)
130 
131 /*
132  * Obsolete legacy interface. Keep it in order not to break userspace
133  * interfaces
134  */
135 struct nand_oobinfo {
136         __u32 useecc;
137         __u32 eccbytes;
138         __u32 oobfree[8][2];
139         __u32 eccpos[32];
140 };
141 
142 struct nand_oobfree {
143         __u32 offset;
144         __u32 length;
145 };
146 
147 #define MTD_MAX_OOBFREE_ENTRIES 8
148 #define MTD_MAX_ECCPOS_ENTRIES  64
149 /*
150  * OBSOLETE: ECC layout control structure. Exported to user-space via ioctl
151  * ECCGETLAYOUT for backwards compatbility and should not be mistaken as a
152  * complete set of ECC information. The ioctl truncates the larger internal
153  * structure to retain binary compatibility with the static declaration of the
154  * ioctl. Note that the "MTD_MAX_..._ENTRIES" macros represent the max size of
155  * the user struct, not the MAX size of the internal struct nand_ecclayout.
156  */
157 struct nand_ecclayout_user {
158         __u32 eccbytes;
159         __u32 eccpos[MTD_MAX_ECCPOS_ENTRIES];
160         __u32 oobavail;
161         struct nand_oobfree oobfree[MTD_MAX_OOBFREE_ENTRIES];
162 };
163 
164 /**
165  * struct mtd_ecc_stats - error correction stats
166  *
167  * @corrected:  number of corrected bits
168  * @failed:     number of uncorrectable errors
169  * @badblocks:  number of bad blocks in this partition
170  * @bbtblocks:  number of blocks reserved for bad block tables
171  */
172 struct mtd_ecc_stats {
173         __u32 corrected;
174         __u32 failed;
175         __u32 badblocks;
176         __u32 bbtblocks;
177 };
178 
179 /*
180  * Read/write file modes for access to MTD
181  */
182 enum mtd_file_modes {
183         MTD_MODE_NORMAL = MTD_OTP_OFF,
184         MTD_MODE_OTP_FACTORY = MTD_OTP_FACTORY,
185         MTD_MODE_OTP_USER = MTD_OTP_USER,
186         MTD_MODE_RAW,
187 };
188 
189 #endif /* __MTD_ABI_H__ */
190 

This page was automatically generated by LXR 0.3.1 (source).  •  Linux is a registered trademark of Linus Torvalds  •  Contact us