summaryrefslogtreecommitdiff
path: root/include/mtd/ubi-user.h
diff options
context:
space:
mode:
authorAdrian Hunter <ext-adrian.hunter@nokia.com>2007-03-16 18:06:30 +0200
committerArtem Bityutskiy <Artem.Bityutskiy@nokia.com>2007-03-29 17:15:35 +0300
commit55d6da34828c784b7f3f9ffddb4a6dd5bdf65d46 (patch)
tree7f6f4705da3571dec5300e054d4cba42316fc729 /include/mtd/ubi-user.h
parent8bc5349626f1a83f49dd400ca6f45e0bb8347a4e (diff)
UBI-Utils: Updated headers for latest UBI
Signed-off-by: Adrian Hunter <ext-adrian.hunter@nokia.com>
Diffstat (limited to 'include/mtd/ubi-user.h')
-rw-r--r--include/mtd/ubi-user.h66
1 files changed, 48 insertions, 18 deletions
diff --git a/include/mtd/ubi-user.h b/include/mtd/ubi-user.h
index 0eb1470..bb0aca6 100644
--- a/include/mtd/ubi-user.h
+++ b/include/mtd/ubi-user.h
@@ -21,9 +21,43 @@
#ifndef __UBI_USER_H__
#define __UBI_USER_H__
-#ifndef __KERNEL__
-#define __user
-#endif
+/*
+ * UBI volume creation
+ * ~~~~~~~~~~~~~~~~~~~
+ *
+ * UBI volumes are created via the %UBI_IOCMKVOL IOCTL command of UBI character
+ * device. A &struct ubi_mkvol_req object has to be properly filled and a
+ * pointer to it has to be passed to the IOCTL.
+ *
+ * UBI volume deletion
+ * ~~~~~~~~~~~~~~~~~~~
+ *
+ * To delete a volume, the %UBI_IOCRMVOL IOCTL command of the UBI character
+ * device should be used. A pointer to the 32-bit volume ID hast to be passed
+ * to the IOCTL.
+ *
+ * UBI volume re-size
+ * ~~~~~~~~~~~~~~~~~~
+ *
+ * To re-size a volume, the %UBI_IOCRSVOL IOCTL command of the UBI character
+ * device should be used. A &struct ubi_rsvol_req object has to be properly
+ * filled and a pointer to it has to be passed to the IOCTL.
+ *
+ * UBI volume update
+ * ~~~~~~~~~~~~~~~~~
+ *
+ * Volume update should be done via the %UBI_IOCVOLUP IOCTL command of the
+ * corresponding UBI volume character device. A pointer to a 64-bit update
+ * size should be passed to the IOCTL. After then, UBI expects user to write
+ * this number of bytes to the volume character device. The update is finished
+ * when the claimed number of bytes is passed. So, the volume update sequence
+ * is something like:
+ *
+ * fd = open("/dev/my_volume");
+ * ioctl(fd, UBI_IOCVOLUP, &image_size);
+ * write(fd, buf, image_size);
+ * close(fd);
+ */
/*
* When a new volume is created, users may either specify the volume number they
@@ -35,9 +69,7 @@
/* Maximum volume name length */
#define UBI_MAX_VOLUME_NAME 127
-/*
- * IOCTL commands of UBI character devices
- */
+/* IOCTL commands of UBI character devices */
#define UBI_IOC_MAGIC 'o'
@@ -48,16 +80,14 @@
/* Re-size an UBI volume */
#define UBI_IOCRSVOL _IOW(UBI_IOC_MAGIC, 2, struct ubi_rsvol_req)
-/*
- * IOCTL commands of UBI volume character devices.
- */
+/* IOCTL commands of UBI volume character devices */
#define UBI_VOL_IOC_MAGIC 'O'
/* Start UBI volume update */
#define UBI_IOCVOLUP _IOW(UBI_VOL_IOC_MAGIC, 0, int64_t)
-/* An eraseblock erasure command, used for debugging, disabled by dafault */
-#define UBI_IOCEBER _IOW(UBI_VOL_IOC_MAGIC, 0, int32_t)
+/* An eraseblock erasure command, used for debugging, disabled by default */
+#define UBI_IOCEBER _IOW(UBI_VOL_IOC_MAGIC, 1, int32_t)
/*
* UBI volume type constants.
@@ -73,13 +103,13 @@ enum {
/**
* struct ubi_mkvol_req - volume description data structure used in
* volume creation requests.
- *
* @vol_id: volume number
* @alignment: volume alignment
* @bytes: volume size in bytes
* @vol_type: volume type (%UBI_DYNAMIC_VOLUME or %UBI_STATIC_VOLUME)
- * @padding: reserved for future, not used
+ * @padding1: reserved for future, not used
* @name_len: volume name length
+ * @padding2: reserved for future, not used
* @name: volume name
*
* This structure is used by userspace programs when creating new volumes. The
@@ -88,7 +118,7 @@ enum {
* The @alignment field specifies the required alignment of the volume logical
* eraseblock. This means, that the size of logical eraseblocks will be aligned
* to this number, i.e.,
- * (UBI device logical eraseblock size) mod (@alignment) = 0.
+ * (UBI device logical eraseblock size) mod (@alignment) = 0.
*
* To put it differently, the logical eraseblock of this volume may be slightly
* shortened in order to make it properly aligned. The alignment has to be
@@ -99,21 +129,21 @@ enum {
* a block device on top of an UBI volume. In this case, it is desirable to fit
* an integer number of blocks in logical eraseblocks of this UBI volume. With
* alignment it is possible to update this volume using plane UBI volume image
- * BLOBs, without caring about how to properly write them.
+ * BLOBs, without caring about how to properly align them.
*/
struct ubi_mkvol_req {
int32_t vol_id;
int32_t alignment;
int64_t bytes;
int8_t vol_type;
- int8_t padding[9];
+ int8_t padding1;
int16_t name_len;
- __user const char *name;
+ int8_t padding2[4];
+ char name[UBI_MAX_VOLUME_NAME+1];
} __attribute__ ((packed));
/**
* struct ubi_rsvol_req - a data structure used in volume re-size requests.
- *
* @vol_id: ID of the volume to re-size
* @bytes: new size of the volume in bytes
*