1 /* Ported to busybox from mtd-utils.
3 * Licensed under GPLv2, see file LICENSE in this source tree.
6 //config:config UBIATTACH
7 //config: bool "ubiattach"
9 //config: select PLATFORM_LINUX
11 //config: Attach MTD device to an UBI device.
13 //config:config UBIDETACH
14 //config: bool "ubidetach"
16 //config: select PLATFORM_LINUX
18 //config: Detach MTD device from an UBI device.
20 //config:config UBIMKVOL
21 //config: bool "ubimkvol"
23 //config: select PLATFORM_LINUX
25 //config: Create a UBI volume.
27 //config:config UBIRMVOL
28 //config: bool "ubirmvol"
30 //config: select PLATFORM_LINUX
32 //config: Delete a UBI volume.
34 //config:config UBIRSVOL
35 //config: bool "ubirsvol"
37 //config: select PLATFORM_LINUX
39 //config: Resize a UBI volume.
41 //config:config UBIUPDATEVOL
42 //config: bool "ubiupdatevol"
44 //config: select PLATFORM_LINUX
46 //config: Update a UBI volume.
48 // APPLET_ODDNAME:name main location suid_type help
49 //applet:IF_UBIATTACH( APPLET_ODDNAME(ubiattach, ubi_tools, BB_DIR_USR_SBIN, BB_SUID_DROP, ubiattach))
50 //applet:IF_UBIDETACH( APPLET_ODDNAME(ubidetach, ubi_tools, BB_DIR_USR_SBIN, BB_SUID_DROP, ubidetach))
51 //applet:IF_UBIMKVOL( APPLET_ODDNAME(ubimkvol, ubi_tools, BB_DIR_USR_SBIN, BB_SUID_DROP, ubimkvol))
52 //applet:IF_UBIRMVOL( APPLET_ODDNAME(ubirmvol, ubi_tools, BB_DIR_USR_SBIN, BB_SUID_DROP, ubirmvol))
53 //applet:IF_UBIRSVOL( APPLET_ODDNAME(ubirsvol, ubi_tools, BB_DIR_USR_SBIN, BB_SUID_DROP, ubirsvol))
54 //applet:IF_UBIUPDATEVOL(APPLET_ODDNAME(ubiupdatevol, ubi_tools, BB_DIR_USR_SBIN, BB_SUID_DROP, ubiupdatevol))
56 //kbuild:lib-$(CONFIG_UBIATTACH) += ubi_tools.o
57 //kbuild:lib-$(CONFIG_UBIDETACH) += ubi_tools.o
58 //kbuild:lib-$(CONFIG_UBIMKVOL) += ubi_tools.o
59 //kbuild:lib-$(CONFIG_UBIRMVOL) += ubi_tools.o
60 //kbuild:lib-$(CONFIG_UBIRSVOL) += ubi_tools.o
61 //kbuild:lib-$(CONFIG_UBIUPDATEVOL) += ubi_tools.o
64 /* Some versions of kernel have broken headers, need this hack */
66 # define __packed __attribute__((packed))
68 #include <mtd/ubi-user.h>
70 #define do_attach (ENABLE_UBIATTACH && applet_name[3] == 'a')
71 #define do_detach (ENABLE_UBIDETACH && applet_name[3] == 'd')
72 #define do_mkvol (ENABLE_UBIMKVOL && applet_name[3] == 'm')
73 #define do_rmvol (ENABLE_UBIRMVOL && applet_name[4] == 'm')
74 #define do_rsvol (ENABLE_UBIRSVOL && applet_name[4] == 's')
75 #define do_update (ENABLE_UBIUPDATEVOL && applet_name[3] == 'u')
77 static unsigned get_num_from_file(const char *path, unsigned max, const char *errmsg)
79 char buf[sizeof(long long)*3];
80 unsigned long long num;
82 if (open_read_close(path, buf, sizeof(buf)) < 0)
83 bb_perror_msg_and_die(errmsg, path);
84 /* It can be \n terminated, xatoull won't work well */
85 if (sscanf(buf, "%llu", &num) != 1 || num > max)
86 bb_error_msg_and_die(errmsg, path);
90 /* To prevent malloc(1G) accidents */
91 #define MAX_SANE_ERASEBLOCK (16*1024*1024)
93 int ubi_tools_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
94 int ubi_tools_main(int argc UNUSED_PARAM, char **argv)
96 static const struct suffix_mult size_suffixes[] = {
99 { "GiB", 1024*1024*1024 },
107 int dev_num = UBI_DEV_NUM_AUTO;
108 int vol_id = UBI_VOL_NUM_AUTO;
109 int vid_hdr_offset = 0;
111 unsigned long long size_bytes = size_bytes; /* for compiler */
112 char *size_bytes_str;
116 struct ubi_attach_req attach_req;
117 struct ubi_mkvol_req mkvol_req;
118 struct ubi_rsvol_req rsvol_req;
120 #define attach_req req_structs.attach_req
121 #define mkvol_req req_structs.mkvol_req
122 #define rsvol_req req_structs.rsvol_req
123 char path[sizeof("/sys/class/ubi/ubi%d_%d/usable_eb_size")
124 + 2 * sizeof(int)*3 + /*just in case:*/ 16];
125 #define path_sys_class_ubi_ubi (path + sizeof("/sys/class/ubi/ubi")-1)
127 strcpy(path, "/sys/class/ubi/ubi");
128 memset(&req_structs, 0, sizeof(req_structs));
130 #define OPTION_m (1 << 0)
131 #define OPTION_d (1 << 1)
132 #define OPTION_n (1 << 2)
133 #define OPTION_N (1 << 3)
134 #define OPTION_s (1 << 4)
135 #define OPTION_a (1 << 5)
136 #define OPTION_t (1 << 6)
138 opt_complementary = "-1";
139 opts = getopt32(argv, "md:+n:+N:s:a:+t:O:+",
141 &vol_name, &size_bytes_str, &alignment, &type,
146 opt_complementary = "-1";
147 opts = getopt32(argv, "s:at", &size_bytes_str);
150 opt_complementary = "-1";
151 opts = getopt32(argv, "m:+d:+n:+N:s:a:+t:",
152 &mtd_num, &dev_num, &vol_id,
153 &vol_name, &size_bytes_str, &alignment, &type
158 size_bytes = xatoull_sfx(size_bytes_str, size_suffixes);
162 fd = xopen(ubi_ctrl, O_RDWR);
163 //xfstat(fd, &st, ubi_ctrl);
164 //if (!S_ISCHR(st.st_mode))
165 // bb_error_msg_and_die("%s: not a char device", ubi_ctrl);
167 //usage:#define ubiattach_trivial_usage
168 //usage: "-m MTD_NUM [-d UBI_NUM] [-O VID_HDR_OFF] UBI_CTRL_DEV"
169 //usage:#define ubiattach_full_usage "\n\n"
170 //usage: "Attach MTD device to UBI\n"
171 //usage: "\n -m MTD_NUM MTD device number to attach"
172 //usage: "\n -d UBI_NUM UBI device number to assign"
173 //usage: "\n -O VID_HDR_OFF VID header offset"
175 if (!(opts & OPTION_m))
176 bb_error_msg_and_die("%s device not specified", "MTD");
178 attach_req.mtd_num = mtd_num;
179 attach_req.ubi_num = dev_num;
180 attach_req.vid_hdr_offset = vid_hdr_offset;
182 xioctl(fd, UBI_IOCATT, &attach_req);
185 //usage:#define ubidetach_trivial_usage
186 //usage: "-d UBI_NUM UBI_CTRL_DEV"
187 //usage:#define ubidetach_full_usage "\n\n"
188 //usage: "Detach MTD device from UBI\n"
189 //usage: "\n -d UBI_NUM UBI device number"
191 if (!(opts & OPTION_d))
192 bb_error_msg_and_die("%s device not specified", "UBI");
194 /* FIXME? kernel expects int32_t* here: */
195 xioctl(fd, UBI_IOCDET, &dev_num);
198 //usage:#define ubimkvol_trivial_usage
199 //usage: "-N NAME [-s SIZE | -m] UBI_DEVICE"
200 //usage:#define ubimkvol_full_usage "\n\n"
201 //usage: "Create UBI volume\n"
202 //usage: "\n -a ALIGNMENT Volume alignment (default 1)"
203 //usage: "\n -m Set volume size to maximum available"
204 //usage: "\n -n VOLID Volume ID. If not specified,"
205 //usage: "\n assigned automatically"
206 //usage: "\n -N NAME Volume name"
207 //usage: "\n -s SIZE Size in bytes"
208 //usage: "\n -t TYPE Volume type (static|dynamic)"
210 if (opts & OPTION_m) {
216 num = ubi_devnum_from_devname(ubi_ctrl);
217 p = path_sys_class_ubi_ubi + sprintf(path_sys_class_ubi_ubi, "%u/", num);
219 strcpy(p, "avail_eraseblocks");
220 leb_avail = get_num_from_file(path, UINT_MAX, "Can't get available eraseblocks from '%s'");
222 strcpy(p, "eraseblock_size");
223 leb_size = get_num_from_file(path, MAX_SANE_ERASEBLOCK, "Can't get eraseblock size from '%s'");
225 size_bytes = leb_avail * (unsigned long long)leb_size;
226 //if (size_bytes <= 0)
227 // bb_error_msg_and_die("%s invalid maximum size calculated", "UBI");
229 if (!(opts & OPTION_s))
230 bb_error_msg_and_die("size not specified");
232 if (!(opts & OPTION_N))
233 bb_error_msg_and_die("name not specified");
235 mkvol_req.vol_id = vol_id;
236 mkvol_req.vol_type = UBI_DYNAMIC_VOLUME;
237 if ((opts & OPTION_t) && type[0] == 's')
238 mkvol_req.vol_type = UBI_STATIC_VOLUME;
239 mkvol_req.alignment = alignment;
240 mkvol_req.bytes = size_bytes; /* signed int64_t */
241 strncpy(mkvol_req.name, vol_name, UBI_MAX_VOLUME_NAME);
242 mkvol_req.name_len = strlen(vol_name);
243 if (mkvol_req.name_len > UBI_MAX_VOLUME_NAME)
244 bb_error_msg_and_die("volume name too long: '%s'", vol_name);
246 xioctl(fd, UBI_IOCMKVOL, &mkvol_req);
249 //usage:#define ubirmvol_trivial_usage
250 //usage: "-n VOLID / -N VOLNAME UBI_DEVICE"
251 //usage:#define ubirmvol_full_usage "\n\n"
252 //usage: "Remove UBI volume\n"
253 //usage: "\n -n VOLID Volume ID"
254 //usage: "\n -N VOLNAME Volume name"
256 if (!(opts & (OPTION_n|OPTION_N)))
257 bb_error_msg_and_die("volume id not specified");
259 if (opts & OPTION_N) {
260 unsigned num = ubi_devnum_from_devname(ubi_ctrl);
261 vol_id = ubi_get_volid_by_name(num, vol_name);
264 if (sizeof(vol_id) != 4) {
265 /* kernel expects int32_t* in this ioctl */
267 xioctl(fd, UBI_IOCRMVOL, &t);
269 xioctl(fd, UBI_IOCRMVOL, &vol_id);
273 //usage:#define ubirsvol_trivial_usage
274 //usage: "-n VOLID -s SIZE UBI_DEVICE"
275 //usage:#define ubirsvol_full_usage "\n\n"
276 //usage: "Resize UBI volume\n"
277 //usage: "\n -n VOLID Volume ID"
278 //usage: "\n -s SIZE Size in bytes"
280 if (!(opts & OPTION_s))
281 bb_error_msg_and_die("size not specified");
282 if (!(opts & OPTION_n))
283 bb_error_msg_and_die("volume id not specified");
285 rsvol_req.bytes = size_bytes; /* signed int64_t */
286 rsvol_req.vol_id = vol_id;
288 xioctl(fd, UBI_IOCRSVOL, &rsvol_req);
291 //usage:#define ubiupdatevol_trivial_usage
292 //usage: "[-t | [-s SIZE] IMG_FILE] UBI_DEVICE"
293 //usage:#define ubiupdatevol_full_usage "\n\n"
294 //usage: "Update UBI volume\n"
295 //usage: "\n -t Truncate to zero size"
296 //usage: "\n -s SIZE Size in bytes to resize to"
300 if (opts & OPTION_t) {
301 /* truncate the volume by starting an update for size 0 */
303 /* this ioctl expects int64_t* parameter */
304 xioctl(fd, UBI_IOCVOLUP, &bytes64);
308 unsigned ubinum, volnum;
313 /* Assume that device is in normal format. */
314 /* Removes need for scanning sysfs tree as full libubi does. */
315 if (sscanf(ubi_ctrl, "/dev/ubi%u_%u", &ubinum, &volnum) != 2)
316 bb_error_msg_and_die("wrong format of UBI device name");
318 sprintf(path_sys_class_ubi_ubi, "%u_%u/usable_eb_size", ubinum, volnum);
319 leb_size = get_num_from_file(path, MAX_SANE_ERASEBLOCK, "Can't get usable eraseblock size from '%s'");
321 if (!(opts & OPTION_s)) {
324 xmove_fd(xopen(*argv, O_RDONLY), STDIN_FILENO);
325 xfstat(STDIN_FILENO, &st, *argv);
326 size_bytes = st.st_size;
329 bytes64 = size_bytes;
330 /* this ioctl expects signed int64_t* parameter */
331 xioctl(fd, UBI_IOCVOLUP, &bytes64);
333 input_data = xmalloc(leb_size);
334 while ((len = full_read(STDIN_FILENO, input_data, leb_size)) > 0) {
335 xwrite(fd, input_data, len);
338 bb_perror_msg_and_die("UBI volume update failed");
342 if (ENABLE_FEATURE_CLEAN_UP)