UBI: add ioctl for map operation
[linux-3.10.git] / include / mtd / ubi-user.h
1 /*
2  * Copyright (c) International Business Machines Corp., 2006
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
12  * the 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Artem Bityutskiy (Битюцкий Артём)
19  */
20
21 #ifndef __UBI_USER_H__
22 #define __UBI_USER_H__
23
24 /*
25  * UBI device creation (the same as MTD device attachment)
26  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
27  *
28  * MTD devices may be attached using %UBI_IOCATT ioctl command of the UBI
29  * control device. The caller has to properly fill and pass
30  * &struct ubi_attach_req object - UBI will attach the MTD device specified in
31  * the request and return the newly created UBI device number as the ioctl
32  * return value.
33  *
34  * UBI device deletion (the same as MTD device detachment)
35  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
36  *
37  * An UBI device maybe deleted with %UBI_IOCDET ioctl command of the UBI
38  * control device.
39  *
40  * UBI volume creation
41  * ~~~~~~~~~~~~~~~~~~~
42  *
43  * UBI volumes are created via the %UBI_IOCMKVOL IOCTL command of UBI character
44  * device. A &struct ubi_mkvol_req object has to be properly filled and a
45  * pointer to it has to be passed to the IOCTL.
46  *
47  * UBI volume deletion
48  * ~~~~~~~~~~~~~~~~~~~
49  *
50  * To delete a volume, the %UBI_IOCRMVOL IOCTL command of the UBI character
51  * device should be used. A pointer to the 32-bit volume ID hast to be passed
52  * to the IOCTL.
53  *
54  * UBI volume re-size
55  * ~~~~~~~~~~~~~~~~~~
56  *
57  * To re-size a volume, the %UBI_IOCRSVOL IOCTL command of the UBI character
58  * device should be used. A &struct ubi_rsvol_req object has to be properly
59  * filled and a pointer to it has to be passed to the IOCTL.
60  *
61  * UBI volumes re-name
62  * ~~~~~~~~~~~~~~~~~~~
63  *
64  * To re-name several volumes atomically at one go, the %UBI_IOCRNVOL command
65  * of the UBI character device should be used. A &struct ubi_rnvol_req object
66  * has to be properly filled and a pointer to it has to be passed to the IOCTL.
67  *
68  * UBI volume update
69  * ~~~~~~~~~~~~~~~~~
70  *
71  * Volume update should be done via the %UBI_IOCVOLUP IOCTL command of the
72  * corresponding UBI volume character device. A pointer to a 64-bit update
73  * size should be passed to the IOCTL. After this, UBI expects user to write
74  * this number of bytes to the volume character device. The update is finished
75  * when the claimed number of bytes is passed. So, the volume update sequence
76  * is something like:
77  *
78  * fd = open("/dev/my_volume");
79  * ioctl(fd, UBI_IOCVOLUP, &image_size);
80  * write(fd, buf, image_size);
81  * close(fd);
82  *
83  * Atomic eraseblock change
84  * ~~~~~~~~~~~~~~~~~~~~~~~~
85  *
86  * Atomic eraseblock change operation is done via the %UBI_IOCEBCH IOCTL
87  * command of the corresponding UBI volume character device. A pointer to
88  * &struct ubi_leb_change_req has to be passed to the IOCTL. Then the user is
89  * expected to write the requested amount of bytes. This is similar to the
90  * "volume update" IOCTL.
91  */
92
93 /*
94  * When a new UBI volume or UBI device is created, users may either specify the
95  * volume/device number they want to create or to let UBI automatically assign
96  * the number using these constants.
97  */
98 #define UBI_VOL_NUM_AUTO (-1)
99 #define UBI_DEV_NUM_AUTO (-1)
100
101 /* Maximum volume name length */
102 #define UBI_MAX_VOLUME_NAME 127
103
104 /* IOCTL commands of UBI character devices */
105
106 #define UBI_IOC_MAGIC 'o'
107
108 /* Create an UBI volume */
109 #define UBI_IOCMKVOL _IOW(UBI_IOC_MAGIC, 0, struct ubi_mkvol_req)
110 /* Remove an UBI volume */
111 #define UBI_IOCRMVOL _IOW(UBI_IOC_MAGIC, 1, int32_t)
112 /* Re-size an UBI volume */
113 #define UBI_IOCRSVOL _IOW(UBI_IOC_MAGIC, 2, struct ubi_rsvol_req)
114 /* Re-name volumes */
115 #define UBI_IOCRNVOL _IOW(UBI_IOC_MAGIC, 3, struct ubi_rnvol_req)
116
117 /* IOCTL commands of the UBI control character device */
118
119 #define UBI_CTRL_IOC_MAGIC 'o'
120
121 /* Attach an MTD device */
122 #define UBI_IOCATT _IOW(UBI_CTRL_IOC_MAGIC, 64, struct ubi_attach_req)
123 /* Detach an MTD device */
124 #define UBI_IOCDET _IOW(UBI_CTRL_IOC_MAGIC, 65, int32_t)
125
126 /* IOCTL commands of UBI volume character devices */
127
128 #define UBI_VOL_IOC_MAGIC 'O'
129
130 /* Start UBI volume update */
131 #define UBI_IOCVOLUP _IOW(UBI_VOL_IOC_MAGIC, 0, int64_t)
132 /* An eraseblock erasure command, used for debugging, disabled by default */
133 #define UBI_IOCEBER _IOW(UBI_VOL_IOC_MAGIC, 1, int32_t)
134 /* An atomic eraseblock change command */
135 #define UBI_IOCEBCH _IOW(UBI_VOL_IOC_MAGIC, 2, int32_t)
136 /* Map an eraseblock, used for debugging, disabled by default */
137 #define UBI_IOCEBMAP _IOW(UBI_VOL_IOC_MAGIC, 3, struct ubi_map_req)
138
139
140 /* Maximum MTD device name length supported by UBI */
141 #define MAX_UBI_MTD_NAME_LEN 127
142
143 /* Maximum amount of UBI volumes that can be re-named at one go */
144 #define UBI_MAX_RNVOL 32
145
146 /*
147  * UBI data type hint constants.
148  *
149  * UBI_LONGTERM: long-term data
150  * UBI_SHORTTERM: short-term data
151  * UBI_UNKNOWN: data persistence is unknown
152  *
153  * These constants are used when data is written to UBI volumes in order to
154  * help the UBI wear-leveling unit to find more appropriate physical
155  * eraseblocks.
156  */
157 enum {
158         UBI_LONGTERM  = 1,
159         UBI_SHORTTERM = 2,
160         UBI_UNKNOWN   = 3,
161 };
162
163 /*
164  * UBI volume type constants.
165  *
166  * @UBI_DYNAMIC_VOLUME: dynamic volume
167  * @UBI_STATIC_VOLUME:  static volume
168  */
169 enum {
170         UBI_DYNAMIC_VOLUME = 3,
171         UBI_STATIC_VOLUME  = 4,
172 };
173
174 /**
175  * struct ubi_attach_req - attach MTD device request.
176  * @ubi_num: UBI device number to create
177  * @mtd_num: MTD device number to attach
178  * @vid_hdr_offset: VID header offset (use defaults if %0)
179  * @padding: reserved for future, not used, has to be zeroed
180  *
181  * This data structure is used to specify MTD device UBI has to attach and the
182  * parameters it has to use. The number which should be assigned to the new UBI
183  * device is passed in @ubi_num. UBI may automatically assign the number if
184  * @UBI_DEV_NUM_AUTO is passed. In this case, the device number is returned in
185  * @ubi_num.
186  *
187  * Most applications should pass %0 in @vid_hdr_offset to make UBI use default
188  * offset of the VID header within physical eraseblocks. The default offset is
189  * the next min. I/O unit after the EC header. For example, it will be offset
190  * 512 in case of a 512 bytes page NAND flash with no sub-page support. Or
191  * it will be 512 in case of a 2KiB page NAND flash with 4 512-byte sub-pages.
192  *
193  * But in rare cases, if this optimizes things, the VID header may be placed to
194  * a different offset. For example, the boot-loader might do things faster if
195  * the VID header sits at the end of the first 2KiB NAND page with 4 sub-pages.
196  * As the boot-loader would not normally need to read EC headers (unless it
197  * needs UBI in RW mode), it might be faster to calculate ECC. This is weird
198  * example, but it real-life example. So, in this example, @vid_hdr_offer would
199  * be 2KiB-64 bytes = 1984. Note, that this position is not even 512-bytes
200  * aligned, which is OK, as UBI is clever enough to realize this is 4th
201  * sub-page of the first page and add needed padding.
202  */
203 struct ubi_attach_req {
204         int32_t ubi_num;
205         int32_t mtd_num;
206         int32_t vid_hdr_offset;
207         int8_t padding[12];
208 };
209
210 /**
211  * struct ubi_mkvol_req - volume description data structure used in
212  *                        volume creation requests.
213  * @vol_id: volume number
214  * @alignment: volume alignment
215  * @bytes: volume size in bytes
216  * @vol_type: volume type (%UBI_DYNAMIC_VOLUME or %UBI_STATIC_VOLUME)
217  * @padding1: reserved for future, not used, has to be zeroed
218  * @name_len: volume name length
219  * @padding2: reserved for future, not used, has to be zeroed
220  * @name: volume name
221  *
222  * This structure is used by user-space programs when creating new volumes. The
223  * @used_bytes field is only necessary when creating static volumes.
224  *
225  * The @alignment field specifies the required alignment of the volume logical
226  * eraseblock. This means, that the size of logical eraseblocks will be aligned
227  * to this number, i.e.,
228  *      (UBI device logical eraseblock size) mod (@alignment) = 0.
229  *
230  * To put it differently, the logical eraseblock of this volume may be slightly
231  * shortened in order to make it properly aligned. The alignment has to be
232  * multiple of the flash minimal input/output unit, or %1 to utilize the entire
233  * available space of logical eraseblocks.
234  *
235  * The @alignment field may be useful, for example, when one wants to maintain
236  * a block device on top of an UBI volume. In this case, it is desirable to fit
237  * an integer number of blocks in logical eraseblocks of this UBI volume. With
238  * alignment it is possible to update this volume using plane UBI volume image
239  * BLOBs, without caring about how to properly align them.
240  */
241 struct ubi_mkvol_req {
242         int32_t vol_id;
243         int32_t alignment;
244         int64_t bytes;
245         int8_t vol_type;
246         int8_t padding1;
247         int16_t name_len;
248         int8_t padding2[4];
249         char name[UBI_MAX_VOLUME_NAME + 1];
250 } __attribute__ ((packed));
251
252 /**
253  * struct ubi_rsvol_req - a data structure used in volume re-size requests.
254  * @vol_id: ID of the volume to re-size
255  * @bytes: new size of the volume in bytes
256  *
257  * Re-sizing is possible for both dynamic and static volumes. But while dynamic
258  * volumes may be re-sized arbitrarily, static volumes cannot be made to be
259  * smaller than the number of bytes they bear. To arbitrarily shrink a static
260  * volume, it must be wiped out first (by means of volume update operation with
261  * zero number of bytes).
262  */
263 struct ubi_rsvol_req {
264         int64_t bytes;
265         int32_t vol_id;
266 } __attribute__ ((packed));
267
268 /**
269  * struct ubi_rnvol_req - volumes re-name request.
270  * @count: count of volumes to re-name
271  * @padding1:  reserved for future, not used, has to be zeroed
272  * @vol_id: ID of the volume to re-name
273  * @name_len: name length
274  * @padding2:  reserved for future, not used, has to be zeroed
275  * @name: new volume name
276  *
277  * UBI allows to re-name up to %32 volumes at one go. The count of volumes to
278  * re-name is specified in the @count field. The ID of the volumes to re-name
279  * and the new names are specified in the @vol_id and @name fields.
280  *
281  * The UBI volume re-name operation is atomic, which means that should power cut
282  * happen, the volumes will have either old name or new name. So the possible
283  * use-cases of this command is atomic upgrade. Indeed, to upgrade, say, volumes
284  * A and B one may create temporary volumes %A1 and %B1 with the new contents,
285  * then atomically re-name A1->A and B1->B, in which case old %A and %B will
286  * be removed.
287  *
288  * If it is not desirable to remove old A and B, the re-name request has to
289  * contain 4 entries: A1->A, A->A1, B1->B, B->B1, in which case old A1 and B1
290  * become A and B, and old A and B will become A1 and B1.
291  *
292  * It is also OK to request: A1->A, A1->X, B1->B, B->Y, in which case old A1
293  * and B1 become A and B, and old A and B become X and Y.
294  *
295  * In other words, in case of re-naming into an existing volume name, the
296  * existing volume is removed, unless it is re-named as well at the same
297  * re-name request.
298  */
299 struct ubi_rnvol_req {
300         int32_t count;
301         int8_t padding1[12];
302         struct {
303                 int32_t vol_id;
304                 int16_t name_len;
305                 int8_t  padding2[2];
306                 char    name[UBI_MAX_VOLUME_NAME + 1];
307         } ents[UBI_MAX_RNVOL];
308 } __attribute__ ((packed));
309
310 /**
311  * struct ubi_leb_change_req - a data structure used in atomic logical
312  *                             eraseblock change requests.
313  * @lnum: logical eraseblock number to change
314  * @bytes: how many bytes will be written to the logical eraseblock
315  * @dtype: data type (%UBI_LONGTERM, %UBI_SHORTTERM, %UBI_UNKNOWN)
316  * @padding: reserved for future, not used, has to be zeroed
317  */
318 struct ubi_leb_change_req {
319         int32_t lnum;
320         int32_t bytes;
321         int8_t  dtype;
322         int8_t  padding[7];
323 } __attribute__ ((packed));
324
325 /**
326  * struct ubi_map_req - a data structure used in map eraseblock requests.
327  * @lnum: logical eraseblock number to unmap
328  * @dtype: data type (%UBI_LONGTERM, %UBI_SHORTTERM, %UBI_UNKNOWN)
329  * @padding: reserved for future, not used, has to be zeroed
330  */
331 struct ubi_map_req {
332         int32_t lnum;
333         int8_t  dtype;
334         int8_t  padding[3];
335 } __attribute__ ((packed));
336
337 #endif /* __UBI_USER_H__ */