UBI: improve ioctl commentaries
[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  * Logical eraseblock erase
84  * ~~~~~~~~~~~~~~~~~~~~~~~~
85  *
86  * To erase a logical eraseblock, the %UBI_IOCEBER ioctl command of the
87  * corresponding UBI volume character device should be used. This command
88  * unmaps the requested logical eraseblock, makes sure the corresponding
89  * physical eraseblock is successfully erased, and returns.
90  *
91  * Atomic logical eraseblock change
92  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
93  *
94  * Atomic logical eraseblock change operation is called using the %UBI_IOCEBCH
95  * ioctl command of the corresponding UBI volume character device. A pointer to
96  * a &struct ubi_leb_change_req object has to be passed to the ioctl. Then the
97  * user is expected to write the requested amount of bytes (similarly to what
98  * should be done in case of the "volume update" ioctl).
99  *
100  * Logical eraseblock map
101  * ~~~~~~~~~~~~~~~~~~~~~
102  *
103  * To map a logical eraseblock to a physical eraseblock, the %UBI_IOCEBMAP
104  * ioctl command should be used. A pointer to a &struct ubi_map_req object is
105  * expected to be passed. The ioctl maps the requested logical eraseblock to
106  * a physical eraseblock and returns.  Only non-mapped logical eraseblocks can
107  * be mapped. If the logical eraseblock specified in the request is already
108  * mapped to a physical eraseblock, the ioctl fails and returns error.
109  *
110  * Logical eraseblock unmap
111  * ~~~~~~~~~~~~~~~~~~~~~~~~
112  *
113  * To unmap a logical eraseblock to a physical eraseblock, the %UBI_IOCEBUNMAP
114  * ioctl command should be used. The ioctl unmaps the logical eraseblocks,
115  * schedules corresponding physical eraseblock for erasure, and returns. Unlike
116  * the "LEB erase" command, it does not wait for the physical eraseblock being
117  * erased. Note, the side effect of this is that if an unclean reboot happens
118  * after the unmap ioctl returns, you may find the LEB mapped again to the same
119  * physical eraseblock after the UBI is run again.
120  *
121  * Check if logical eraseblock is mapped
122  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
123  *
124  * To check if a logical eraseblock is mapped to a physical eraseblock, the
125  * %UBI_IOCEBISMAP ioctl command should be used. It returns %0 if the LEB is
126  * not mapped, and %1 if it is mapped.
127  */
128
129 /*
130  * When a new UBI volume or UBI device is created, users may either specify the
131  * volume/device number they want to create or to let UBI automatically assign
132  * the number using these constants.
133  */
134 #define UBI_VOL_NUM_AUTO (-1)
135 #define UBI_DEV_NUM_AUTO (-1)
136
137 /* Maximum volume name length */
138 #define UBI_MAX_VOLUME_NAME 127
139
140 /* ioctl commands of UBI character devices */
141
142 #define UBI_IOC_MAGIC 'o'
143
144 /* Create an UBI volume */
145 #define UBI_IOCMKVOL _IOW(UBI_IOC_MAGIC, 0, struct ubi_mkvol_req)
146 /* Remove an UBI volume */
147 #define UBI_IOCRMVOL _IOW(UBI_IOC_MAGIC, 1, int32_t)
148 /* Re-size an UBI volume */
149 #define UBI_IOCRSVOL _IOW(UBI_IOC_MAGIC, 2, struct ubi_rsvol_req)
150 /* Re-name volumes */
151 #define UBI_IOCRNVOL _IOW(UBI_IOC_MAGIC, 3, struct ubi_rnvol_req)
152
153 /* ioctl commands of the UBI control character device */
154
155 #define UBI_CTRL_IOC_MAGIC 'o'
156
157 /* Attach an MTD device */
158 #define UBI_IOCATT _IOW(UBI_CTRL_IOC_MAGIC, 64, struct ubi_attach_req)
159 /* Detach an MTD device */
160 #define UBI_IOCDET _IOW(UBI_CTRL_IOC_MAGIC, 65, int32_t)
161
162 /* ioctl commands of UBI volume character devices */
163
164 #define UBI_VOL_IOC_MAGIC 'O'
165
166 /* Start UBI volume update */
167 #define UBI_IOCVOLUP _IOW(UBI_VOL_IOC_MAGIC, 0, int64_t)
168 /* LEB erasure command, used for debugging, disabled by default */
169 #define UBI_IOCEBER _IOW(UBI_VOL_IOC_MAGIC, 1, int32_t)
170 /* Atomic LEB change command */
171 #define UBI_IOCEBCH _IOW(UBI_VOL_IOC_MAGIC, 2, int32_t)
172 /* Map LEB command */
173 #define UBI_IOCEBMAP _IOW(UBI_VOL_IOC_MAGIC, 3, struct ubi_map_req)
174 /* Unmap LEB command */
175 #define UBI_IOCEBUNMAP _IOW(UBI_VOL_IOC_MAGIC, 4, int32_t)
176 /* Check if LEB is mapped command */
177 #define UBI_IOCEBISMAP _IOR(UBI_VOL_IOC_MAGIC, 5, int32_t)
178
179 /* Maximum MTD device name length supported by UBI */
180 #define MAX_UBI_MTD_NAME_LEN 127
181
182 /* Maximum amount of UBI volumes that can be re-named at one go */
183 #define UBI_MAX_RNVOL 32
184
185 /*
186  * UBI data type hint constants.
187  *
188  * UBI_LONGTERM: long-term data
189  * UBI_SHORTTERM: short-term data
190  * UBI_UNKNOWN: data persistence is unknown
191  *
192  * These constants are used when data is written to UBI volumes in order to
193  * help the UBI wear-leveling unit to find more appropriate physical
194  * eraseblocks.
195  */
196 enum {
197         UBI_LONGTERM  = 1,
198         UBI_SHORTTERM = 2,
199         UBI_UNKNOWN   = 3,
200 };
201
202 /*
203  * UBI volume type constants.
204  *
205  * @UBI_DYNAMIC_VOLUME: dynamic volume
206  * @UBI_STATIC_VOLUME:  static volume
207  */
208 enum {
209         UBI_DYNAMIC_VOLUME = 3,
210         UBI_STATIC_VOLUME  = 4,
211 };
212
213 /**
214  * struct ubi_attach_req - attach MTD device request.
215  * @ubi_num: UBI device number to create
216  * @mtd_num: MTD device number to attach
217  * @vid_hdr_offset: VID header offset (use defaults if %0)
218  * @padding: reserved for future, not used, has to be zeroed
219  *
220  * This data structure is used to specify MTD device UBI has to attach and the
221  * parameters it has to use. The number which should be assigned to the new UBI
222  * device is passed in @ubi_num. UBI may automatically assign the number if
223  * @UBI_DEV_NUM_AUTO is passed. In this case, the device number is returned in
224  * @ubi_num.
225  *
226  * Most applications should pass %0 in @vid_hdr_offset to make UBI use default
227  * offset of the VID header within physical eraseblocks. The default offset is
228  * the next min. I/O unit after the EC header. For example, it will be offset
229  * 512 in case of a 512 bytes page NAND flash with no sub-page support. Or
230  * it will be 512 in case of a 2KiB page NAND flash with 4 512-byte sub-pages.
231  *
232  * But in rare cases, if this optimizes things, the VID header may be placed to
233  * a different offset. For example, the boot-loader might do things faster if
234  * the VID header sits at the end of the first 2KiB NAND page with 4 sub-pages.
235  * As the boot-loader would not normally need to read EC headers (unless it
236  * needs UBI in RW mode), it might be faster to calculate ECC. This is weird
237  * example, but it real-life example. So, in this example, @vid_hdr_offer would
238  * be 2KiB-64 bytes = 1984. Note, that this position is not even 512-bytes
239  * aligned, which is OK, as UBI is clever enough to realize this is 4th
240  * sub-page of the first page and add needed padding.
241  */
242 struct ubi_attach_req {
243         int32_t ubi_num;
244         int32_t mtd_num;
245         int32_t vid_hdr_offset;
246         int8_t padding[12];
247 };
248
249 /**
250  * struct ubi_mkvol_req - volume description data structure used in
251  *                        volume creation requests.
252  * @vol_id: volume number
253  * @alignment: volume alignment
254  * @bytes: volume size in bytes
255  * @vol_type: volume type (%UBI_DYNAMIC_VOLUME or %UBI_STATIC_VOLUME)
256  * @padding1: reserved for future, not used, has to be zeroed
257  * @name_len: volume name length
258  * @padding2: reserved for future, not used, has to be zeroed
259  * @name: volume name
260  *
261  * This structure is used by user-space programs when creating new volumes. The
262  * @used_bytes field is only necessary when creating static volumes.
263  *
264  * The @alignment field specifies the required alignment of the volume logical
265  * eraseblock. This means, that the size of logical eraseblocks will be aligned
266  * to this number, i.e.,
267  *      (UBI device logical eraseblock size) mod (@alignment) = 0.
268  *
269  * To put it differently, the logical eraseblock of this volume may be slightly
270  * shortened in order to make it properly aligned. The alignment has to be
271  * multiple of the flash minimal input/output unit, or %1 to utilize the entire
272  * available space of logical eraseblocks.
273  *
274  * The @alignment field may be useful, for example, when one wants to maintain
275  * a block device on top of an UBI volume. In this case, it is desirable to fit
276  * an integer number of blocks in logical eraseblocks of this UBI volume. With
277  * alignment it is possible to update this volume using plane UBI volume image
278  * BLOBs, without caring about how to properly align them.
279  */
280 struct ubi_mkvol_req {
281         int32_t vol_id;
282         int32_t alignment;
283         int64_t bytes;
284         int8_t vol_type;
285         int8_t padding1;
286         int16_t name_len;
287         int8_t padding2[4];
288         char name[UBI_MAX_VOLUME_NAME + 1];
289 } __attribute__ ((packed));
290
291 /**
292  * struct ubi_rsvol_req - a data structure used in volume re-size requests.
293  * @vol_id: ID of the volume to re-size
294  * @bytes: new size of the volume in bytes
295  *
296  * Re-sizing is possible for both dynamic and static volumes. But while dynamic
297  * volumes may be re-sized arbitrarily, static volumes cannot be made to be
298  * smaller than the number of bytes they bear. To arbitrarily shrink a static
299  * volume, it must be wiped out first (by means of volume update operation with
300  * zero number of bytes).
301  */
302 struct ubi_rsvol_req {
303         int64_t bytes;
304         int32_t vol_id;
305 } __attribute__ ((packed));
306
307 /**
308  * struct ubi_rnvol_req - volumes re-name request.
309  * @count: count of volumes to re-name
310  * @padding1:  reserved for future, not used, has to be zeroed
311  * @vol_id: ID of the volume to re-name
312  * @name_len: name length
313  * @padding2:  reserved for future, not used, has to be zeroed
314  * @name: new volume name
315  *
316  * UBI allows to re-name up to %32 volumes at one go. The count of volumes to
317  * re-name is specified in the @count field. The ID of the volumes to re-name
318  * and the new names are specified in the @vol_id and @name fields.
319  *
320  * The UBI volume re-name operation is atomic, which means that should power cut
321  * happen, the volumes will have either old name or new name. So the possible
322  * use-cases of this command is atomic upgrade. Indeed, to upgrade, say, volumes
323  * A and B one may create temporary volumes %A1 and %B1 with the new contents,
324  * then atomically re-name A1->A and B1->B, in which case old %A and %B will
325  * be removed.
326  *
327  * If it is not desirable to remove old A and B, the re-name request has to
328  * contain 4 entries: A1->A, A->A1, B1->B, B->B1, in which case old A1 and B1
329  * become A and B, and old A and B will become A1 and B1.
330  *
331  * It is also OK to request: A1->A, A1->X, B1->B, B->Y, in which case old A1
332  * and B1 become A and B, and old A and B become X and Y.
333  *
334  * In other words, in case of re-naming into an existing volume name, the
335  * existing volume is removed, unless it is re-named as well at the same
336  * re-name request.
337  */
338 struct ubi_rnvol_req {
339         int32_t count;
340         int8_t padding1[12];
341         struct {
342                 int32_t vol_id;
343                 int16_t name_len;
344                 int8_t  padding2[2];
345                 char    name[UBI_MAX_VOLUME_NAME + 1];
346         } ents[UBI_MAX_RNVOL];
347 } __attribute__ ((packed));
348
349 /**
350  * struct ubi_leb_change_req - a data structure used in atomic LEB change
351  *                             requests.
352  * @lnum: logical eraseblock number to change
353  * @bytes: how many bytes will be written to the logical eraseblock
354  * @dtype: data type (%UBI_LONGTERM, %UBI_SHORTTERM, %UBI_UNKNOWN)
355  * @padding: reserved for future, not used, has to be zeroed
356  */
357 struct ubi_leb_change_req {
358         int32_t lnum;
359         int32_t bytes;
360         int8_t  dtype;
361         int8_t  padding[7];
362 } __attribute__ ((packed));
363
364 /**
365  * struct ubi_map_req - a data structure used in map LEB requests.
366  * @lnum: logical eraseblock number to unmap
367  * @dtype: data type (%UBI_LONGTERM, %UBI_SHORTTERM, %UBI_UNKNOWN)
368  * @padding: reserved for future, not used, has to be zeroed
369  */
370 struct ubi_map_req {
371         int32_t lnum;
372         int8_t  dtype;
373         int8_t  padding[3];
374 } __attribute__ ((packed));
375
376 #endif /* __UBI_USER_H__ */