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 (4.7 kb)"
9 //config: select PLATFORM_LINUX
11 //config: Attach MTD device to an UBI device.
13 //config:config UBIDETACH
14 //config: bool "ubidetach (4.6 kb)"
16 //config: select PLATFORM_LINUX
18 //config: Detach MTD device from an UBI device.
20 //config:config UBIMKVOL
21 //config: bool "ubimkvol (5.8 kb)"
23 //config: select PLATFORM_LINUX
25 //config: Create a UBI volume.
27 //config:config UBIRMVOL
28 //config: bool "ubirmvol (5.2 kb)"
30 //config: select PLATFORM_LINUX
32 //config: Delete a UBI volume.
34 //config:config UBIRSVOL
35 //config: bool "ubirsvol (4.6 kb)"
37 //config: select PLATFORM_LINUX
39 //config: Resize a UBI volume.
41 //config:config UBIUPDATEVOL
42 //config: bool "ubiupdatevol (5.6 kb)"
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 UBI_APPLET_CNT (0 \
76 + ENABLE_UBIUPDATEVOL \
79 #define do_attach (ENABLE_UBIATTACH && (UBI_APPLET_CNT == 1 || applet_name[4] == 't'))
80 #define do_detach (ENABLE_UBIDETACH && (UBI_APPLET_CNT == 1 || applet_name[4] == 'e'))
81 #define do_mkvol (ENABLE_UBIMKVOL && (UBI_APPLET_CNT == 1 || applet_name[4] == 'k'))
82 #define do_rmvol (ENABLE_UBIRMVOL && (UBI_APPLET_CNT == 1 || applet_name[4] == 'm'))
83 #define do_rsvol (ENABLE_UBIRSVOL && (UBI_APPLET_CNT == 1 || applet_name[4] == 's'))
84 #define do_update (ENABLE_UBIUPDATEVOL && (UBI_APPLET_CNT == 1 || applet_name[4] == 'p'))
86 static unsigned get_num_from_file(const char *path, unsigned max, const char *errmsg)
88 char buf[sizeof(long long)*3];
89 unsigned long long num;
91 if (open_read_close(path, buf, sizeof(buf)) < 0)
92 bb_perror_msg_and_die(errmsg, path);
93 /* It can be \n terminated, xatoull won't work well */
94 if (sscanf(buf, "%llu", &num) != 1 || num > max)
95 bb_error_msg_and_die(errmsg, path);
99 /* To prevent malloc(1G) accidents */
100 #define MAX_SANE_ERASEBLOCK (16*1024*1024)
102 int ubi_tools_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
103 int ubi_tools_main(int argc UNUSED_PARAM, char **argv)
105 static const struct suffix_mult size_suffixes[] = {
107 { "MiB", 1024*1024 },
108 { "GiB", 1024*1024*1024 },
116 int dev_num = UBI_DEV_NUM_AUTO;
117 int vol_id = UBI_VOL_NUM_AUTO;
118 int vid_hdr_offset = 0;
120 unsigned long long size_bytes = size_bytes; /* for compiler */
121 char *size_bytes_str;
125 struct ubi_attach_req attach_req;
126 struct ubi_mkvol_req mkvol_req;
127 struct ubi_rsvol_req rsvol_req;
129 #define attach_req req_structs.attach_req
130 #define mkvol_req req_structs.mkvol_req
131 #define rsvol_req req_structs.rsvol_req
132 char path[sizeof("/sys/class/ubi/ubi%d_%d/usable_eb_size")
133 + 2 * sizeof(int)*3 + /*just in case:*/ 16];
134 #define path_sys_class_ubi_ubi (path + sizeof("/sys/class/ubi/ubi")-1)
136 strcpy(path, "/sys/class/ubi/ubi");
137 memset(&req_structs, 0, sizeof(req_structs));
139 #define OPTION_m (1 << 0)
140 #define OPTION_d (1 << 1)
141 #define OPTION_n (1 << 2)
142 #define OPTION_N (1 << 3)
143 #define OPTION_s (1 << 4)
144 #define OPTION_a (1 << 5)
145 #define OPTION_t (1 << 6)
147 opt_complementary = "-1";
148 opts = getopt32(argv, "md:+n:+N:s:a:+t:O:+",
150 &vol_name, &size_bytes_str, &alignment, &type,
155 opt_complementary = "-1";
156 opts = getopt32(argv, "s:at", &size_bytes_str);
159 opt_complementary = "-1";
160 opts = getopt32(argv, "m:+d:+n:+N:s:a:+t:",
161 &mtd_num, &dev_num, &vol_id,
162 &vol_name, &size_bytes_str, &alignment, &type
167 size_bytes = xatoull_sfx(size_bytes_str, size_suffixes);
171 fd = xopen(ubi_ctrl, O_RDWR);
172 //xfstat(fd, &st, ubi_ctrl);
173 //if (!S_ISCHR(st.st_mode))
174 // bb_error_msg_and_die("%s: not a char device", ubi_ctrl);
176 //usage:#define ubiattach_trivial_usage
177 //usage: "-m MTD_NUM [-d UBI_NUM] [-O VID_HDR_OFF] UBI_CTRL_DEV"
178 //usage:#define ubiattach_full_usage "\n\n"
179 //usage: "Attach MTD device to UBI\n"
180 //usage: "\n -m MTD_NUM MTD device number to attach"
181 //usage: "\n -d UBI_NUM UBI device number to assign"
182 //usage: "\n -O VID_HDR_OFF VID header offset"
184 if (!(opts & OPTION_m))
185 bb_error_msg_and_die("%s device not specified", "MTD");
187 attach_req.mtd_num = mtd_num;
188 attach_req.ubi_num = dev_num;
189 attach_req.vid_hdr_offset = vid_hdr_offset;
191 xioctl(fd, UBI_IOCATT, &attach_req);
194 //usage:#define ubidetach_trivial_usage
195 //usage: "-d UBI_NUM UBI_CTRL_DEV"
196 //usage:#define ubidetach_full_usage "\n\n"
197 //usage: "Detach MTD device from UBI\n"
198 //usage: "\n -d UBI_NUM UBI device number"
200 if (!(opts & OPTION_d))
201 bb_error_msg_and_die("%s device not specified", "UBI");
203 /* FIXME? kernel expects int32_t* here: */
204 xioctl(fd, UBI_IOCDET, &dev_num);
207 //usage:#define ubimkvol_trivial_usage
208 //usage: "-N NAME [-s SIZE | -m] UBI_DEVICE"
209 //usage:#define ubimkvol_full_usage "\n\n"
210 //usage: "Create UBI volume\n"
211 //usage: "\n -a ALIGNMENT Volume alignment (default 1)"
212 //usage: "\n -m Set volume size to maximum available"
213 //usage: "\n -n VOLID Volume ID. If not specified,"
214 //usage: "\n assigned automatically"
215 //usage: "\n -N NAME Volume name"
216 //usage: "\n -s SIZE Size in bytes"
217 //usage: "\n -t TYPE Volume type (static|dynamic)"
219 if (opts & OPTION_m) {
225 num = ubi_devnum_from_devname(ubi_ctrl);
226 p = path_sys_class_ubi_ubi + sprintf(path_sys_class_ubi_ubi, "%u/", num);
228 strcpy(p, "avail_eraseblocks");
229 leb_avail = get_num_from_file(path, UINT_MAX, "Can't get available eraseblocks from '%s'");
231 strcpy(p, "eraseblock_size");
232 leb_size = get_num_from_file(path, MAX_SANE_ERASEBLOCK, "Can't get eraseblock size from '%s'");
234 size_bytes = leb_avail * (unsigned long long)leb_size;
235 //if (size_bytes <= 0)
236 // bb_error_msg_and_die("%s invalid maximum size calculated", "UBI");
238 if (!(opts & OPTION_s))
239 bb_error_msg_and_die("size not specified");
241 if (!(opts & OPTION_N))
242 bb_error_msg_and_die("name not specified");
244 mkvol_req.vol_id = vol_id;
245 mkvol_req.vol_type = UBI_DYNAMIC_VOLUME;
246 if ((opts & OPTION_t) && type[0] == 's')
247 mkvol_req.vol_type = UBI_STATIC_VOLUME;
248 mkvol_req.alignment = alignment;
249 mkvol_req.bytes = size_bytes; /* signed int64_t */
250 strncpy(mkvol_req.name, vol_name, UBI_MAX_VOLUME_NAME);
251 mkvol_req.name_len = strlen(vol_name);
252 if (mkvol_req.name_len > UBI_MAX_VOLUME_NAME)
253 bb_error_msg_and_die("volume name too long: '%s'", vol_name);
255 xioctl(fd, UBI_IOCMKVOL, &mkvol_req);
258 //usage:#define ubirmvol_trivial_usage
259 //usage: "-n VOLID / -N VOLNAME UBI_DEVICE"
260 //usage:#define ubirmvol_full_usage "\n\n"
261 //usage: "Remove UBI volume\n"
262 //usage: "\n -n VOLID Volume ID"
263 //usage: "\n -N VOLNAME Volume name"
265 if (!(opts & (OPTION_n|OPTION_N)))
266 bb_error_msg_and_die("volume id not specified");
268 if (opts & OPTION_N) {
269 unsigned num = ubi_devnum_from_devname(ubi_ctrl);
270 vol_id = ubi_get_volid_by_name(num, vol_name);
273 if (sizeof(vol_id) != 4) {
274 /* kernel expects int32_t* in this ioctl */
276 xioctl(fd, UBI_IOCRMVOL, &t);
278 xioctl(fd, UBI_IOCRMVOL, &vol_id);
282 //usage:#define ubirsvol_trivial_usage
283 //usage: "-n VOLID -s SIZE UBI_DEVICE"
284 //usage:#define ubirsvol_full_usage "\n\n"
285 //usage: "Resize UBI volume\n"
286 //usage: "\n -n VOLID Volume ID"
287 //usage: "\n -s SIZE Size in bytes"
289 if (!(opts & OPTION_s))
290 bb_error_msg_and_die("size not specified");
291 if (!(opts & OPTION_n))
292 bb_error_msg_and_die("volume id not specified");
294 rsvol_req.bytes = size_bytes; /* signed int64_t */
295 rsvol_req.vol_id = vol_id;
297 xioctl(fd, UBI_IOCRSVOL, &rsvol_req);
300 //usage:#define ubiupdatevol_trivial_usage
301 //usage: "[-t | [-s SIZE] IMG_FILE] UBI_DEVICE"
302 //usage:#define ubiupdatevol_full_usage "\n\n"
303 //usage: "Update UBI volume\n"
304 //usage: "\n -t Truncate to zero size"
305 //usage: "\n -s SIZE Size in bytes to resize to"
309 if (opts & OPTION_t) {
310 /* truncate the volume by starting an update for size 0 */
312 /* this ioctl expects int64_t* parameter */
313 xioctl(fd, UBI_IOCVOLUP, &bytes64);
317 unsigned ubinum, volnum;
322 /* Assume that device is in normal format. */
323 /* Removes need for scanning sysfs tree as full libubi does. */
324 if (sscanf(ubi_ctrl, "/dev/ubi%u_%u", &ubinum, &volnum) != 2)
325 bb_error_msg_and_die("wrong format of UBI device name");
327 sprintf(path_sys_class_ubi_ubi, "%u_%u/usable_eb_size", ubinum, volnum);
328 leb_size = get_num_from_file(path, MAX_SANE_ERASEBLOCK, "Can't get usable eraseblock size from '%s'");
330 if (!(opts & OPTION_s)) {
333 xmove_fd(xopen(*argv, O_RDONLY), STDIN_FILENO);
334 xfstat(STDIN_FILENO, &st, *argv);
335 size_bytes = st.st_size;
338 bytes64 = size_bytes;
339 /* this ioctl expects signed int64_t* parameter */
340 xioctl(fd, UBI_IOCVOLUP, &bytes64);
342 input_data = xmalloc(leb_size);
343 while ((len = full_read(STDIN_FILENO, input_data, leb_size)) > 0) {
344 xwrite(fd, input_data, len);
347 bb_perror_msg_and_die("UBI volume update failed");
351 if (ENABLE_FEATURE_CLEAN_UP)