uapi/mtd/ubi-user.h

1 /* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
33  * &struct ubi_attach_req object - UBI will attach the MTD device specified in
43  * UBI volume creation
50  * UBI volume deletion
53  * To delete a volume, the %UBI_IOCRMVOL ioctl command of the UBI character
54  * device should be used. A pointer to the 32-bit volume ID hast to be passed
57  * UBI volume re-size
60  * To re-size a volume, the %UBI_IOCRSVOL ioctl command of the UBI character
64  * UBI volumes re-name
67  * To re-name several volumes atomically at one go, the %UBI_IOCRNVOL command
71  * UBI volume update
74  * Volume update should be done via the %UBI_IOCVOLUP ioctl command of the
75  * corresponding UBI volume character device. A pointer to a 64-bit update
77  * this number of bytes to the volume character device. The update is finished
78  * when the claimed number of bytes is passed. So, the volume update sequence
90  * corresponding UBI volume character device should be used. This command
98  * ioctl command of the corresponding UBI volume character device. A pointer to
101  * should be done in case of the "volume update" ioctl).
109  * a physical eraseblock and returns.  Only non-mapped logical eraseblocks can
131  * Set an UBI volume property
134  * To set an UBI volume property the %UBI_IOCSETPROP ioctl command should be
142  * To create a R/O block device on top of an UBI volume the %UBI_IOCVOLCRBLK
151  * When a new UBI volume or UBI device is created, users may either specify the
152  * volume/device number they want to create or to let UBI automatically assign
155 #define UBI_VOL_NUM_AUTO (-1)
156 #define UBI_DEV_NUM_AUTO (-1)
158 /* Maximum volume name length */
165 /* Create an UBI volume */
167 /* Remove an UBI volume */
169 /* Re-size an UBI volume */
171 /* Re-name volumes */
188 /* ioctl commands of UBI volume character devices */
192 /* Start UBI volume update
207 /* Set an UBI volume property */
210 /* Create a R/O block device on top of an UBI volume */
218 /* Maximum amount of UBI volumes that can be re-named at one go */
222  * UBI volume type constants.
224  * @UBI_DYNAMIC_VOLUME: dynamic volume
225  * @UBI_STATIC_VOLUME:  static volume
233  * UBI set volume property ioctl constants.
235  * @UBI_VOL_PROP_DIRECT_WRITE: allow (any non-zero value) or disallow (value 0)
244  * struct ubi_attach_req - attach MTD device request.
262  * 512 in case of a 512 bytes page NAND flash with no sub-page support. Or
263  * it will be 512 in case of a 2KiB page NAND flash with 4 512-byte sub-pages.
266  * a different offset. For example, the boot-loader might do things faster if
267  * the VID header sits at the end of the first 2KiB NAND page with 4 sub-pages.
268  * As the boot-loader would not normally need to read EC headers (unless it
270  * example, but it real-life example. So, in this example, @vid_hdr_offer would
271  * be 2KiB-64 bytes = 1984. Note, that this position is not even 512-bytes
273  * sub-page of the first page and add needed padding.
279  *    1024 * (1 - MinNVB / MaxNVB)
280  * Which gives 20 for most NAND devices.  This limit is used in order to derive
282  * has more bad eraseblocks than this limit, UBI does not reserve any physical
284  * eraseblocks (if any). The accepted range is 0-768. If 0 is given, the
302  * UBI volume flags.
304  * @UBI_VOL_SKIP_CRC_CHECK_FLG: skip the CRC check done on a static volume at
306  *				should only be used if the volume user has a
316  * struct ubi_mkvol_req - volume description data structure used in
317  *                        volume creation requests.
318  * @vol_id: volume number
319  * @alignment: volume alignment
320  * @bytes: volume size in bytes
321  * @vol_type: volume type (%UBI_DYNAMIC_VOLUME or %UBI_STATIC_VOLUME)
322  * @flags: volume flags (%UBI_VOL_SKIP_CRC_CHECK_FLG)
323  * @name_len: volume name length
325  * @name: volume name
327  * This structure is used by user-space programs when creating new volumes. The
330  * The @alignment field specifies the required alignment of the volume logical
335  * To put it differently, the logical eraseblock of this volume may be slightly
341  * a block device on top of an UBI volume. In this case, it is desirable to fit
342  * an integer number of blocks in logical eraseblocks of this UBI volume. With
343  * alignment it is possible to update this volume using plane UBI volume image
358  * struct ubi_rsvol_req - a data structure used in volume re-size requests.
359  * @vol_id: ID of the volume to re-size
360  * @bytes: new size of the volume in bytes
362  * Re-sizing is possible for both dynamic and static volumes. But while dynamic
363  * volumes may be re-sized arbitrarily, static volumes cannot be made to be
365  * volume, it must be wiped out first (by means of volume update operation with
374  * struct ubi_rnvol_req - volumes re-name request.
375  * @count: count of volumes to re-name
377  * @vol_id: ID of the volume to re-name
380  * @name: new volume name
382  * UBI allows to re-name up to %32 volumes at one go. The count of volumes to
383  * re-name is specified in the @count field. The ID of the volumes to re-name
386  * The UBI volume re-name operation is atomic, which means that should power cut
388  * use-cases of this command is atomic upgrade. Indeed, to upgrade, say, volumes
390  * then atomically re-name A1->A and B1->B, in which case old %A and %B will
393  * If it is not desirable to remove old A and B, the re-name request has to
394  * contain 4 entries: A1->A, A->A1, B1->B, B->B1, in which case old A1 and B1
397  * It is also OK to request: A1->A, A1->X, B1->B, B->Y, in which case old A1
400  * In other words, in case of re-naming into an existing volume name, the
401  * existing volume is removed, unless it is re-named as well at the same
402  * re-name request.
416  * struct ubi_leb_change_req - a data structure used in atomic LEB change
440  * struct ubi_map_req - a data structure used in map LEB requests.
453  * struct ubi_set_vol_prop_req - a data structure used to set an UBI volume
466  * struct ubi_blkcreate_req - a data structure used in block creation requests.