include/mtd/ubi-user.h

4  * SPDX-License-Identifier:    GPL-2.0+
20  * &struct ubi_attach_req object - UBI will attach the MTD device specified in
30  * UBI volume creation
37  * UBI volume deletion
40  * To delete a volume, the %UBI_IOCRMVOL ioctl command of the UBI character
41  * device should be used. A pointer to the 32-bit volume ID hast to be passed
44  * UBI volume re-size
47  * To re-size a volume, the %UBI_IOCRSVOL ioctl command of the UBI character
51  * UBI volumes re-name
54  * To re-name several volumes atomically at one go, the %UBI_IOCRNVOL command
58  * UBI volume update
61  * Volume update should be done via the %UBI_IOCVOLUP ioctl command of the
62  * corresponding UBI volume character device. A pointer to a 64-bit update
64  * this number of bytes to the volume character device. The update is finished
65  * when the claimed number of bytes is passed. So, the volume update sequence
77  * corresponding UBI volume character device should be used. This command
85  * ioctl command of the corresponding UBI volume character device. A pointer to
88  * should be done in case of the "volume update" ioctl).
96  * a physical eraseblock and returns.  Only non-mapped logical eraseblocks can
118  * Set an UBI volume property
121  * To set an UBI volume property the %UBI_IOCSETPROP ioctl command should be
129  * To create a R/O block device on top of an UBI volume the %UBI_IOCVOLCRBLK
138  * When a new UBI volume or UBI device is created, users may either specify the
139  * volume/device number they want to create or to let UBI automatically assign
142 #define UBI_VOL_NUM_AUTO (-1)
143 #define UBI_DEV_NUM_AUTO (-1)
145 /* Maximum volume name length */
152 /* Create an UBI volume */
154 /* Remove an UBI volume */
156 /* Re-size an UBI volume */
158 /* Re-name volumes */
170 /* ioctl commands of UBI volume character devices */
174 /* Start UBI volume update
189 /* Set an UBI volume property */
192 /* Create a R/O block device on top of an UBI volume */
200 /* Maximum amount of UBI volumes that can be re-named at one go */
204  * UBI volume type constants.
206  * @UBI_DYNAMIC_VOLUME: dynamic volume
207  * @UBI_STATIC_VOLUME:  static volume
215  * UBI set volume property ioctl constants.
217  * @UBI_VOL_PROP_DIRECT_WRITE: allow (any non-zero value) or disallow (value 0)
226  * struct ubi_attach_req - attach MTD device request.
242  * 512 in case of a 512 bytes page NAND flash with no sub-page support. Or
243  * it will be 512 in case of a 2KiB page NAND flash with 4 512-byte sub-pages.
246  * a different offset. For example, the boot-loader might do things faster if
247  * the VID header sits at the end of the first 2KiB NAND page with 4 sub-pages.
248  * As the boot-loader would not normally need to read EC headers (unless it
250  * example, but it real-life example. So, in this example, @vid_hdr_offer would
251  * be 2KiB-64 bytes = 1984. Note, that this position is not even 512-bytes
253  * sub-page of the first page and add needed padding.
259  *    1024 * (1 - MinNVB / MaxNVB)
260  * Which gives 20 for most NAND devices.  This limit is used in order to derive
262  * has more bad eraseblocks than this limit, UBI does not reserve any physical
264  * eraseblocks (if any). The accepted range is 0-768. If 0 is given, the
276  * struct ubi_mkvol_req - volume description data structure used in
277  *                        volume creation requests.
278  * @vol_id: volume number
279  * @alignment: volume alignment
280  * @bytes: volume size in bytes
281  * @vol_type: volume type (%UBI_DYNAMIC_VOLUME or %UBI_STATIC_VOLUME)
283  * @name_len: volume name length
285  * @name: volume name
287  * This structure is used by user-space programs when creating new volumes. The
290  * The @alignment field specifies the required alignment of the volume logical
295  * To put it differently, the logical eraseblock of this volume may be slightly
301  * a block device on top of an UBI volume. In this case, it is desirable to fit
302  * an integer number of blocks in logical eraseblocks of this UBI volume. With
303  * alignment it is possible to update this volume using plane UBI volume image
318  * struct ubi_rsvol_req - a data structure used in volume re-size requests.
319  * @vol_id: ID of the volume to re-size
320  * @bytes: new size of the volume in bytes
322  * Re-sizing is possible for both dynamic and static volumes. But while dynamic
323  * volumes may be re-sized arbitrarily, static volumes cannot be made to be
325  * volume, it must be wiped out first (by means of volume update operation with
334  * struct ubi_rnvol_req - volumes re-name request.
335  * @count: count of volumes to re-name
337  * @vol_id: ID of the volume to re-name
340  * @name: new volume name
342  * UBI allows to re-name up to %32 volumes at one go. The count of volumes to
343  * re-name is specified in the @count field. The ID of the volumes to re-name
346  * The UBI volume re-name operation is atomic, which means that should power cut
348  * use-cases of this command is atomic upgrade. Indeed, to upgrade, say, volumes
350  * then atomically re-name A1->A and B1->B, in which case old %A and %B will
353  * If it is not desirable to remove old A and B, the re-name request has to
354  * contain 4 entries: A1->A, A->A1, B1->B, B->B1, in which case old A1 and B1
357  * It is also OK to request: A1->A, A1->X, B1->B, B->Y, in which case old A1
360  * In other words, in case of re-naming into an existing volume name, the
361  * existing volume is removed, unless it is re-named as well at the same
362  * re-name request.
376  * struct ubi_leb_change_req - a data structure used in atomic LEB change
400  * struct ubi_map_req - a data structure used in map LEB requests.
413  * struct ubi_set_vol_prop_req - a data structure used to set an UBI volume
426  * struct ubi_blkcreate_req - a data structure used in block creation requests.