blob: 1927b0d78a998a1e01c37314884f3531fa6e90d9 [file] [log] [blame]
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001/*
David Woodhousea1452a32010-08-08 20:58:20 +01002 * Copyright © International Business Machines Corp., 2006
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04003 *
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
Arnd Bergmannccef7ab2009-02-26 00:51:41 +010024#include <linux/types.h>
25
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040026/*
Artem Bityutskiy9b79cc02007-12-18 18:22:16 +020027 * UBI device creation (the same as MTD device attachment)
28 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
29 *
30 * MTD devices may be attached using %UBI_IOCATT ioctl command of the UBI
31 * control device. The caller has to properly fill and pass
32 * &struct ubi_attach_req object - UBI will attach the MTD device specified in
33 * the request and return the newly created UBI device number as the ioctl
34 * return value.
35 *
36 * UBI device deletion (the same as MTD device detachment)
37 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
38 *
39 * An UBI device maybe deleted with %UBI_IOCDET ioctl command of the UBI
40 * control device.
41 *
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040042 * UBI volume creation
43 * ~~~~~~~~~~~~~~~~~~~
44 *
Artem Bityutskiyf7fc6f3f2009-01-07 16:10:58 +020045 * UBI volumes are created via the %UBI_IOCMKVOL ioctl command of UBI character
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040046 * device. A &struct ubi_mkvol_req object has to be properly filled and a
Artem Bityutskiyf7fc6f3f2009-01-07 16:10:58 +020047 * pointer to it has to be passed to the ioctl.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040048 *
49 * UBI volume deletion
50 * ~~~~~~~~~~~~~~~~~~~
51 *
Artem Bityutskiyf7fc6f3f2009-01-07 16:10:58 +020052 * To delete a volume, the %UBI_IOCRMVOL ioctl command of the UBI character
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040053 * device should be used. A pointer to the 32-bit volume ID hast to be passed
Artem Bityutskiyf7fc6f3f2009-01-07 16:10:58 +020054 * to the ioctl.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040055 *
56 * UBI volume re-size
57 * ~~~~~~~~~~~~~~~~~~
58 *
Artem Bityutskiyf7fc6f3f2009-01-07 16:10:58 +020059 * To re-size a volume, the %UBI_IOCRSVOL ioctl command of the UBI character
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040060 * device should be used. A &struct ubi_rsvol_req object has to be properly
Artem Bityutskiyf7fc6f3f2009-01-07 16:10:58 +020061 * filled and a pointer to it has to be passed to the ioctl.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040062 *
Artem Bityutskiyf40ac9c2008-07-13 21:47:47 +030063 * UBI volumes re-name
64 * ~~~~~~~~~~~~~~~~~~~
65 *
66 * To re-name several volumes atomically at one go, the %UBI_IOCRNVOL command
67 * of the UBI character device should be used. A &struct ubi_rnvol_req object
Artem Bityutskiyf7fc6f3f2009-01-07 16:10:58 +020068 * has to be properly filled and a pointer to it has to be passed to the ioctl.
Artem Bityutskiyf40ac9c2008-07-13 21:47:47 +030069 *
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040070 * UBI volume update
71 * ~~~~~~~~~~~~~~~~~
72 *
Artem Bityutskiyf7fc6f3f2009-01-07 16:10:58 +020073 * Volume update should be done via the %UBI_IOCVOLUP ioctl command of the
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040074 * corresponding UBI volume character device. A pointer to a 64-bit update
Artem Bityutskiyf7fc6f3f2009-01-07 16:10:58 +020075 * size should be passed to the ioctl. After this, UBI expects user to write
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040076 * this number of bytes to the volume character device. The update is finished
77 * when the claimed number of bytes is passed. So, the volume update sequence
78 * is something like:
79 *
80 * fd = open("/dev/my_volume");
81 * ioctl(fd, UBI_IOCVOLUP, &image_size);
82 * write(fd, buf, image_size);
83 * close(fd);
Artem Bityutskiy86613682008-01-24 16:15:14 +020084 *
Artem Bityutskiyf7fc6f3f2009-01-07 16:10:58 +020085 * Logical eraseblock erase
Artem Bityutskiy86613682008-01-24 16:15:14 +020086 * ~~~~~~~~~~~~~~~~~~~~~~~~
87 *
Artem Bityutskiyf7fc6f3f2009-01-07 16:10:58 +020088 * To erase a logical eraseblock, the %UBI_IOCEBER ioctl command of the
89 * corresponding UBI volume character device should be used. This command
90 * unmaps the requested logical eraseblock, makes sure the corresponding
91 * physical eraseblock is successfully erased, and returns.
92 *
93 * Atomic logical eraseblock change
94 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
95 *
96 * Atomic logical eraseblock change operation is called using the %UBI_IOCEBCH
97 * ioctl command of the corresponding UBI volume character device. A pointer to
98 * a &struct ubi_leb_change_req object has to be passed to the ioctl. Then the
99 * user is expected to write the requested amount of bytes (similarly to what
100 * should be done in case of the "volume update" ioctl).
101 *
102 * Logical eraseblock map
103 * ~~~~~~~~~~~~~~~~~~~~~
104 *
105 * To map a logical eraseblock to a physical eraseblock, the %UBI_IOCEBMAP
106 * ioctl command should be used. A pointer to a &struct ubi_map_req object is
107 * expected to be passed. The ioctl maps the requested logical eraseblock to
108 * a physical eraseblock and returns. Only non-mapped logical eraseblocks can
109 * be mapped. If the logical eraseblock specified in the request is already
110 * mapped to a physical eraseblock, the ioctl fails and returns error.
111 *
112 * Logical eraseblock unmap
113 * ~~~~~~~~~~~~~~~~~~~~~~~~
114 *
115 * To unmap a logical eraseblock to a physical eraseblock, the %UBI_IOCEBUNMAP
116 * ioctl command should be used. The ioctl unmaps the logical eraseblocks,
117 * schedules corresponding physical eraseblock for erasure, and returns. Unlike
118 * the "LEB erase" command, it does not wait for the physical eraseblock being
119 * erased. Note, the side effect of this is that if an unclean reboot happens
120 * after the unmap ioctl returns, you may find the LEB mapped again to the same
121 * physical eraseblock after the UBI is run again.
122 *
123 * Check if logical eraseblock is mapped
124 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
125 *
126 * To check if a logical eraseblock is mapped to a physical eraseblock, the
127 * %UBI_IOCEBISMAP ioctl command should be used. It returns %0 if the LEB is
128 * not mapped, and %1 if it is mapped.
Sidney Amani766fb952009-01-27 10:11:46 +0100129 *
130 * Set an UBI volume property
131 * ~~~~~~~~~~~~~~~~~~~~~~~~~
132 *
133 * To set an UBI volume property the %UBI_IOCSETPROP ioctl command should be
Artem Bityutskiy67484822011-03-15 16:25:38 +0200134 * used. A pointer to a &struct ubi_set_vol_prop_req object is expected to be
Sidney Amani766fb952009-01-27 10:11:46 +0100135 * passed. The object describes which property should be set, and to which value
136 * it should be set.
Ezequiel Garcia9d54c8a2014-02-25 13:25:22 -0300137 *
138 * Block devices on UBI volumes
139 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
140 *
Ezequiel Garcia463c5ee2014-03-05 11:16:14 -0300141 * To create a R/O block device on top of an UBI volume the %UBI_IOCVOLCRBLK
142 * should be used. A pointer to a &struct ubi_blkcreate_req object is expected
143 * to be passed, which is not used and reserved for future usage.
144 *
145 * Conversely, to remove a block device the %UBI_IOCVOLRMBLK should be used,
146 * which takes no arguments.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400147 */
148
149/*
Artem Bityutskiy9b79cc02007-12-18 18:22:16 +0200150 * When a new UBI volume or UBI device is created, users may either specify the
151 * volume/device number they want to create or to let UBI automatically assign
152 * the number using these constants.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400153 */
154#define UBI_VOL_NUM_AUTO (-1)
Artem Bityutskiy9b79cc02007-12-18 18:22:16 +0200155#define UBI_DEV_NUM_AUTO (-1)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400156
157/* Maximum volume name length */
158#define UBI_MAX_VOLUME_NAME 127
159
Artem Bityutskiyf7fc6f3f2009-01-07 16:10:58 +0200160/* ioctl commands of UBI character devices */
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400161
162#define UBI_IOC_MAGIC 'o'
163
164/* Create an UBI volume */
165#define UBI_IOCMKVOL _IOW(UBI_IOC_MAGIC, 0, struct ubi_mkvol_req)
166/* Remove an UBI volume */
Arnd Bergmannccef7ab2009-02-26 00:51:41 +0100167#define UBI_IOCRMVOL _IOW(UBI_IOC_MAGIC, 1, __s32)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400168/* Re-size an UBI volume */
169#define UBI_IOCRSVOL _IOW(UBI_IOC_MAGIC, 2, struct ubi_rsvol_req)
Artem Bityutskiyf40ac9c2008-07-13 21:47:47 +0300170/* Re-name volumes */
171#define UBI_IOCRNVOL _IOW(UBI_IOC_MAGIC, 3, struct ubi_rnvol_req)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400172
Artem Bityutskiyf7fc6f3f2009-01-07 16:10:58 +0200173/* ioctl commands of the UBI control character device */
Artem Bityutskiy9b79cc02007-12-18 18:22:16 +0200174
175#define UBI_CTRL_IOC_MAGIC 'o'
176
177/* Attach an MTD device */
178#define UBI_IOCATT _IOW(UBI_CTRL_IOC_MAGIC, 64, struct ubi_attach_req)
179/* Detach an MTD device */
Arnd Bergmannccef7ab2009-02-26 00:51:41 +0100180#define UBI_IOCDET _IOW(UBI_CTRL_IOC_MAGIC, 65, __s32)
Artem Bityutskiy9b79cc02007-12-18 18:22:16 +0200181
Artem Bityutskiyf7fc6f3f2009-01-07 16:10:58 +0200182/* ioctl commands of UBI volume character devices */
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400183
184#define UBI_VOL_IOC_MAGIC 'O'
185
Mike Frysinger95f9a4d2013-05-01 23:42:47 -0400186/* Start UBI volume update
187 * Note: This actually takes a pointer (__s64*), but we can't change
188 * that without breaking the ABI on 32bit systems
189 */
Arnd Bergmannccef7ab2009-02-26 00:51:41 +0100190#define UBI_IOCVOLUP _IOW(UBI_VOL_IOC_MAGIC, 0, __s64)
Artem Bityutskiyf7fc6f3f2009-01-07 16:10:58 +0200191/* LEB erasure command, used for debugging, disabled by default */
Arnd Bergmannccef7ab2009-02-26 00:51:41 +0100192#define UBI_IOCEBER _IOW(UBI_VOL_IOC_MAGIC, 1, __s32)
Artem Bityutskiyf7fc6f3f2009-01-07 16:10:58 +0200193/* Atomic LEB change command */
Arnd Bergmannccef7ab2009-02-26 00:51:41 +0100194#define UBI_IOCEBCH _IOW(UBI_VOL_IOC_MAGIC, 2, __s32)
Artem Bityutskiyf7fc6f3f2009-01-07 16:10:58 +0200195/* Map LEB command */
Corentin Chary141e6eb2009-01-05 14:44:11 +0100196#define UBI_IOCEBMAP _IOW(UBI_VOL_IOC_MAGIC, 3, struct ubi_map_req)
Artem Bityutskiyf7fc6f3f2009-01-07 16:10:58 +0200197/* Unmap LEB command */
Arnd Bergmannccef7ab2009-02-26 00:51:41 +0100198#define UBI_IOCEBUNMAP _IOW(UBI_VOL_IOC_MAGIC, 4, __s32)
Artem Bityutskiyf7fc6f3f2009-01-07 16:10:58 +0200199/* Check if LEB is mapped command */
Arnd Bergmannccef7ab2009-02-26 00:51:41 +0100200#define UBI_IOCEBISMAP _IOR(UBI_VOL_IOC_MAGIC, 5, __s32)
Sidney Amani766fb952009-01-27 10:11:46 +0100201/* Set an UBI volume property */
Artem Bityutskiy67484822011-03-15 16:25:38 +0200202#define UBI_IOCSETVOLPROP _IOW(UBI_VOL_IOC_MAGIC, 6, \
203 struct ubi_set_vol_prop_req)
Artem Bityutskiy8af87182014-03-05 13:01:56 +0200204/* Create a R/O block device on top of an UBI volume */
Ezequiel Garcia463c5ee2014-03-05 11:16:14 -0300205#define UBI_IOCVOLCRBLK _IOW(UBI_VOL_IOC_MAGIC, 7, struct ubi_blkcreate_req)
Artem Bityutskiy8af87182014-03-05 13:01:56 +0200206/* Remove the R/O block device */
207#define UBI_IOCVOLRMBLK _IO(UBI_VOL_IOC_MAGIC, 8)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400208
Artem Bityutskiy9b79cc02007-12-18 18:22:16 +0200209/* Maximum MTD device name length supported by UBI */
210#define MAX_UBI_MTD_NAME_LEN 127
211
Artem Bityutskiyf40ac9c2008-07-13 21:47:47 +0300212/* Maximum amount of UBI volumes that can be re-named at one go */
213#define UBI_MAX_RNVOL 32
214
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400215/*
216 * UBI volume type constants.
217 *
218 * @UBI_DYNAMIC_VOLUME: dynamic volume
219 * @UBI_STATIC_VOLUME: static volume
220 */
221enum {
222 UBI_DYNAMIC_VOLUME = 3,
Artem Bityutskiy86613682008-01-24 16:15:14 +0200223 UBI_STATIC_VOLUME = 4,
Artem Bityutskiy9b79cc02007-12-18 18:22:16 +0200224};
225
Sidney Amani766fb952009-01-27 10:11:46 +0100226/*
Artem Bityutskiye8e088d2011-03-15 16:37:57 +0200227 * UBI set volume property ioctl constants.
Sidney Amani766fb952009-01-27 10:11:46 +0100228 *
Artem Bityutskiye8e088d2011-03-15 16:37:57 +0200229 * @UBI_VOL_PROP_DIRECT_WRITE: allow (any non-zero value) or disallow (value 0)
230 * user to directly write and erase individual
231 * eraseblocks on dynamic volumes
Sidney Amani766fb952009-01-27 10:11:46 +0100232 */
233enum {
Artem Bityutskiye8e088d2011-03-15 16:37:57 +0200234 UBI_VOL_PROP_DIRECT_WRITE = 1,
Sidney Amani766fb952009-01-27 10:11:46 +0100235};
236
Artem Bityutskiy9b79cc02007-12-18 18:22:16 +0200237/**
238 * struct ubi_attach_req - attach MTD device request.
239 * @ubi_num: UBI device number to create
240 * @mtd_num: MTD device number to attach
241 * @vid_hdr_offset: VID header offset (use defaults if %0)
Richard Genouddb7e21c2012-08-20 18:00:15 +0200242 * @max_beb_per1024: maximum expected number of bad PEB per 1024 PEBs
Artem Bityutskiy9b79cc02007-12-18 18:22:16 +0200243 * @padding: reserved for future, not used, has to be zeroed
244 *
245 * This data structure is used to specify MTD device UBI has to attach and the
246 * parameters it has to use. The number which should be assigned to the new UBI
Artem Bityutskiy86613682008-01-24 16:15:14 +0200247 * device is passed in @ubi_num. UBI may automatically assign the number if
Artem Bityutskiy9b79cc02007-12-18 18:22:16 +0200248 * @UBI_DEV_NUM_AUTO is passed. In this case, the device number is returned in
249 * @ubi_num.
250 *
251 * Most applications should pass %0 in @vid_hdr_offset to make UBI use default
252 * offset of the VID header within physical eraseblocks. The default offset is
253 * the next min. I/O unit after the EC header. For example, it will be offset
254 * 512 in case of a 512 bytes page NAND flash with no sub-page support. Or
255 * it will be 512 in case of a 2KiB page NAND flash with 4 512-byte sub-pages.
256 *
257 * But in rare cases, if this optimizes things, the VID header may be placed to
Artem Bityutskiy9c9ec142008-07-18 13:19:52 +0300258 * a different offset. For example, the boot-loader might do things faster if
259 * the VID header sits at the end of the first 2KiB NAND page with 4 sub-pages.
260 * As the boot-loader would not normally need to read EC headers (unless it
261 * needs UBI in RW mode), it might be faster to calculate ECC. This is weird
262 * example, but it real-life example. So, in this example, @vid_hdr_offer would
263 * be 2KiB-64 bytes = 1984. Note, that this position is not even 512-bytes
264 * aligned, which is OK, as UBI is clever enough to realize this is 4th
265 * sub-page of the first page and add needed padding.
Richard Genouddb7e21c2012-08-20 18:00:15 +0200266 *
267 * The @max_beb_per1024 is the maximum amount of bad PEBs UBI expects on the
268 * UBI device per 1024 eraseblocks. This value is often given in an other form
269 * in the NAND datasheet (min NVB i.e. minimal number of valid blocks). The
270 * maximum expected bad eraseblocks per 1024 is then:
271 * 1024 * (1 - MinNVB / MaxNVB)
272 * Which gives 20 for most NAND devices. This limit is used in order to derive
273 * amount of eraseblock UBI reserves for handling new bad blocks. If the device
274 * has more bad eraseblocks than this limit, UBI does not reserve any physical
275 * eraseblocks for new bad eraseblocks, but attempts to use available
276 * eraseblocks (if any). The accepted range is 0-768. If 0 is given, the
277 * default kernel value of %CONFIG_MTD_UBI_BEB_LIMIT will be used.
Artem Bityutskiy9b79cc02007-12-18 18:22:16 +0200278 */
279struct ubi_attach_req {
Arnd Bergmannccef7ab2009-02-26 00:51:41 +0100280 __s32 ubi_num;
281 __s32 mtd_num;
282 __s32 vid_hdr_offset;
Richard Genouddb7e21c2012-08-20 18:00:15 +0200283 __s16 max_beb_per1024;
284 __s8 padding[10];
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400285};
286
287/**
288 * struct ubi_mkvol_req - volume description data structure used in
Artem Bityutskiy9b79cc02007-12-18 18:22:16 +0200289 * volume creation requests.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400290 * @vol_id: volume number
291 * @alignment: volume alignment
292 * @bytes: volume size in bytes
293 * @vol_type: volume type (%UBI_DYNAMIC_VOLUME or %UBI_STATIC_VOLUME)
Artem Bityutskiy9b79cc02007-12-18 18:22:16 +0200294 * @padding1: reserved for future, not used, has to be zeroed
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400295 * @name_len: volume name length
Artem Bityutskiy9b79cc02007-12-18 18:22:16 +0200296 * @padding2: reserved for future, not used, has to be zeroed
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400297 * @name: volume name
298 *
Artem Bityutskiy86613682008-01-24 16:15:14 +0200299 * This structure is used by user-space programs when creating new volumes. The
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400300 * @used_bytes field is only necessary when creating static volumes.
301 *
302 * The @alignment field specifies the required alignment of the volume logical
303 * eraseblock. This means, that the size of logical eraseblocks will be aligned
304 * to this number, i.e.,
305 * (UBI device logical eraseblock size) mod (@alignment) = 0.
306 *
307 * To put it differently, the logical eraseblock of this volume may be slightly
308 * shortened in order to make it properly aligned. The alignment has to be
309 * multiple of the flash minimal input/output unit, or %1 to utilize the entire
310 * available space of logical eraseblocks.
311 *
312 * The @alignment field may be useful, for example, when one wants to maintain
313 * a block device on top of an UBI volume. In this case, it is desirable to fit
314 * an integer number of blocks in logical eraseblocks of this UBI volume. With
315 * alignment it is possible to update this volume using plane UBI volume image
316 * BLOBs, without caring about how to properly align them.
317 */
318struct ubi_mkvol_req {
Arnd Bergmannccef7ab2009-02-26 00:51:41 +0100319 __s32 vol_id;
320 __s32 alignment;
321 __s64 bytes;
322 __s8 vol_type;
323 __s8 padding1;
324 __s16 name_len;
325 __s8 padding2[4];
Artem Bityutskiy9b79cc02007-12-18 18:22:16 +0200326 char name[UBI_MAX_VOLUME_NAME + 1];
Artem Bityutskiy36279242011-03-28 10:04:09 +0300327} __packed;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400328
329/**
330 * struct ubi_rsvol_req - a data structure used in volume re-size requests.
331 * @vol_id: ID of the volume to re-size
332 * @bytes: new size of the volume in bytes
333 *
334 * Re-sizing is possible for both dynamic and static volumes. But while dynamic
335 * volumes may be re-sized arbitrarily, static volumes cannot be made to be
Frederik Schwarzer025dfda2008-10-16 19:02:37 +0200336 * smaller than the number of bytes they bear. To arbitrarily shrink a static
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400337 * volume, it must be wiped out first (by means of volume update operation with
338 * zero number of bytes).
339 */
340struct ubi_rsvol_req {
Arnd Bergmannccef7ab2009-02-26 00:51:41 +0100341 __s64 bytes;
342 __s32 vol_id;
Artem Bityutskiy36279242011-03-28 10:04:09 +0300343} __packed;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400344
Artem Bityutskiy86613682008-01-24 16:15:14 +0200345/**
Artem Bityutskiyf40ac9c2008-07-13 21:47:47 +0300346 * struct ubi_rnvol_req - volumes re-name request.
347 * @count: count of volumes to re-name
348 * @padding1: reserved for future, not used, has to be zeroed
349 * @vol_id: ID of the volume to re-name
350 * @name_len: name length
351 * @padding2: reserved for future, not used, has to be zeroed
352 * @name: new volume name
353 *
354 * UBI allows to re-name up to %32 volumes at one go. The count of volumes to
355 * re-name is specified in the @count field. The ID of the volumes to re-name
356 * and the new names are specified in the @vol_id and @name fields.
357 *
358 * The UBI volume re-name operation is atomic, which means that should power cut
359 * happen, the volumes will have either old name or new name. So the possible
360 * use-cases of this command is atomic upgrade. Indeed, to upgrade, say, volumes
361 * A and B one may create temporary volumes %A1 and %B1 with the new contents,
362 * then atomically re-name A1->A and B1->B, in which case old %A and %B will
363 * be removed.
364 *
365 * If it is not desirable to remove old A and B, the re-name request has to
366 * contain 4 entries: A1->A, A->A1, B1->B, B->B1, in which case old A1 and B1
367 * become A and B, and old A and B will become A1 and B1.
368 *
369 * It is also OK to request: A1->A, A1->X, B1->B, B->Y, in which case old A1
370 * and B1 become A and B, and old A and B become X and Y.
371 *
372 * In other words, in case of re-naming into an existing volume name, the
373 * existing volume is removed, unless it is re-named as well at the same
374 * re-name request.
375 */
376struct ubi_rnvol_req {
Arnd Bergmannccef7ab2009-02-26 00:51:41 +0100377 __s32 count;
378 __s8 padding1[12];
Artem Bityutskiyf40ac9c2008-07-13 21:47:47 +0300379 struct {
Arnd Bergmannccef7ab2009-02-26 00:51:41 +0100380 __s32 vol_id;
381 __s16 name_len;
382 __s8 padding2[2];
Artem Bityutskiyf40ac9c2008-07-13 21:47:47 +0300383 char name[UBI_MAX_VOLUME_NAME + 1];
384 } ents[UBI_MAX_RNVOL];
Artem Bityutskiy36279242011-03-28 10:04:09 +0300385} __packed;
Artem Bityutskiyf40ac9c2008-07-13 21:47:47 +0300386
387/**
Artem Bityutskiyf7fc6f3f2009-01-07 16:10:58 +0200388 * struct ubi_leb_change_req - a data structure used in atomic LEB change
389 * requests.
Artem Bityutskiy86613682008-01-24 16:15:14 +0200390 * @lnum: logical eraseblock number to change
391 * @bytes: how many bytes will be written to the logical eraseblock
Artem Bityutskiy44156262012-05-14 19:49:35 +0300392 * @dtype: pass "3" for better compatibility with old kernels
Artem Bityutskiy86613682008-01-24 16:15:14 +0200393 * @padding: reserved for future, not used, has to be zeroed
Artem Bityutskiy44156262012-05-14 19:49:35 +0300394 *
395 * The @dtype field used to inform UBI about what kind of data will be written
396 * to the LEB: long term (value 1), short term (value 2), unknown (value 3).
397 * UBI tried to pick a PEB with lower erase counter for short term data and a
398 * PEB with higher erase counter for long term data. But this was not really
399 * used because users usually do not know this and could easily mislead UBI. We
400 * removed this feature in May 2012. UBI currently just ignores the @dtype
401 * field. But for better compatibility with older kernels it is recommended to
402 * set @dtype to 3 (unknown).
Artem Bityutskiy86613682008-01-24 16:15:14 +0200403 */
404struct ubi_leb_change_req {
Arnd Bergmannccef7ab2009-02-26 00:51:41 +0100405 __s32 lnum;
406 __s32 bytes;
Richard Weinbergera65a0eb2012-05-14 17:55:52 +0200407 __s8 dtype; /* obsolete, do not use! */
Arnd Bergmannccef7ab2009-02-26 00:51:41 +0100408 __s8 padding[7];
Artem Bityutskiy36279242011-03-28 10:04:09 +0300409} __packed;
Artem Bityutskiy86613682008-01-24 16:15:14 +0200410
Corentin Chary141e6eb2009-01-05 14:44:11 +0100411/**
Artem Bityutskiyf7fc6f3f2009-01-07 16:10:58 +0200412 * struct ubi_map_req - a data structure used in map LEB requests.
Artem Bityutskiy44156262012-05-14 19:49:35 +0300413 * @dtype: pass "3" for better compatibility with old kernels
Corentin Chary141e6eb2009-01-05 14:44:11 +0100414 * @lnum: logical eraseblock number to unmap
Corentin Chary141e6eb2009-01-05 14:44:11 +0100415 * @padding: reserved for future, not used, has to be zeroed
416 */
417struct ubi_map_req {
Arnd Bergmannccef7ab2009-02-26 00:51:41 +0100418 __s32 lnum;
Richard Weinbergera65a0eb2012-05-14 17:55:52 +0200419 __s8 dtype; /* obsolete, do not use! */
Arnd Bergmannccef7ab2009-02-26 00:51:41 +0100420 __s8 padding[3];
Artem Bityutskiy36279242011-03-28 10:04:09 +0300421} __packed;
Corentin Chary141e6eb2009-01-05 14:44:11 +0100422
Sidney Amani766fb952009-01-27 10:11:46 +0100423
424/**
Artem Bityutskiye8e088d2011-03-15 16:37:57 +0200425 * struct ubi_set_vol_prop_req - a data structure used to set an UBI volume
Artem Bityutskiy67484822011-03-15 16:25:38 +0200426 * property.
427 * @property: property to set (%UBI_VOL_PROP_DIRECT_WRITE)
Sidney Amani766fb952009-01-27 10:11:46 +0100428 * @padding: reserved for future, not used, has to be zeroed
429 * @value: value to set
430 */
Artem Bityutskiy67484822011-03-15 16:25:38 +0200431struct ubi_set_vol_prop_req {
Artem Bityutskiyfeddbb32011-03-28 10:12:25 +0300432 __u8 property;
433 __u8 padding[7];
434 __u64 value;
Artem Bityutskiy36279242011-03-28 10:04:09 +0300435} __packed;
Sidney Amani766fb952009-01-27 10:11:46 +0100436
Ezequiel Garcia463c5ee2014-03-05 11:16:14 -0300437/**
438 * struct ubi_blkcreate_req - a data structure used in block creation requests.
439 * @padding: reserved for future, not used, has to be zeroed
440 */
441struct ubi_blkcreate_req {
442 __s8 padding[128];
443} __packed;
444
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400445#endif /* __UBI_USER_H__ */