include/mtd/ubi-user.h

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
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).
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
145 /* Maximum volume name length */
152 /* Create an UBI volume */
154 /* Remove an UBI volume */
156 /* Re-size an UBI volume */
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 */
204  * UBI volume type constants.
206  * @UBI_DYNAMIC_VOLUME: dynamic volume
207  * @UBI_STATIC_VOLUME:  static volume
215  * UBI set volume property ioctl constants.
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
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
325  * volume, it must be wiped out first (by means of volume update operation with
337  * @vol_id: ID of the volume to re-name
340  * @name: new volume name
346  * The UBI volume re-name operation is atomic, which means that should power cut
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
413  * struct ubi_set_vol_prop_req - a data structure used to set an UBI volume