uapi/mtd/ubi-user.h

28  * UBI device creation (the same as MTD device attachment)
31  * MTD devices may be attached using %UBI_IOCATT ioctl command of the UBI
33  * &struct ubi_attach_req object - UBI will attach the MTD device specified in
34  * the request and return the newly created UBI device number as the ioctl
37  * UBI device deletion (the same as MTD device detachment)
40  * An UBI device maybe deleted with %UBI_IOCDET ioctl command of the UBI
43  * UBI volume creation
46  * UBI volumes are created via the %UBI_IOCMKVOL ioctl command of UBI character
50  * UBI volume deletion
53  * To delete a volume, the %UBI_IOCRMVOL ioctl command of the UBI character
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
68  * of the UBI character device should be used. A &struct ubi_rnvol_req object
71  * UBI volume update
75  * corresponding UBI volume character device. A pointer to a 64-bit update
76  * size should be passed to the ioctl. After this, UBI expects user to write
90  * corresponding UBI volume character device should be used. This command
98  * ioctl command of the corresponding UBI volume character device. A pointer to
122  * physical eraseblock after the UBI is run again.
131  * Set an UBI volume property
134  * To set an UBI volume property the %UBI_IOCSETPROP ioctl command should be
139  * Block devices on UBI volumes
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
161 /* ioctl commands of UBI character devices */
165 /* Create an UBI volume */
167 /* Remove an UBI volume */
169 /* Re-size an UBI volume */
179 /* ioctl commands of the UBI control character device */
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 */
215 /* Maximum MTD device name length supported by UBI */
218 /* Maximum amount of UBI volumes that can be re-named at one go */
222  * UBI volume type constants.
233  * UBI set volume property ioctl constants.
245  * @ubi_num: UBI device number to create
253  * This data structure is used to specify MTD device UBI has to attach and the
254  * parameters it has to use. The number which should be assigned to the new UBI
255  * device is passed in @ubi_num. UBI may automatically assign the number if
259  * Most applications should pass %0 in @vid_hdr_offset to make UBI use default
269  * needs UBI in RW mode), it might be faster to calculate ECC. This is weird
272  * aligned, which is OK, as UBI is clever enough to realize this is 4th
275  * The @max_beb_per1024 is the maximum amount of bad PEBs UBI expects on the
276  * UBI device per 1024 eraseblocks.  This value is often given in an other form
281  * amount of eraseblock UBI reserves for handling new bad blocks. If the device
282  * has more bad eraseblocks than this limit, UBI does not reserve any physical
287  * If @disable_fm is not zero, ubi doesn't create new fastmap even the module
302  * UBI volume flags.
333  *	(UBI device logical eraseblock size) mod (@alignment) = 0.
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
382  * UBI allows to re-name up to %32 volumes at one go. The count of volumes to
386  * The UBI volume re-name operation is atomic, which means that should power cut
423  * The @dtype field used to inform UBI about what kind of data will be written
425  * UBI tried to pick a PEB with lower erase counter for short term data and a
427  * used because users usually do not know this and could easily mislead UBI. We
428  * removed this feature in May 2012. UBI currently just ignores the @dtype
453  * struct ubi_set_vol_prop_req - a data structure used to set an UBI volume