blob: 79fb2044d1144d1b56db4023de32a2ebf9b92202 [file] [log] [blame]
Baruch Siach3324c962010-06-16 12:22:58 +02001/* Ported to busybox from mtd-utils.
2 *
Denys Vlasenko0ef64bd2010-08-16 20:14:46 +02003 * Licensed under GPLv2, see file LICENSE in this source tree.
Baruch Siach3324c962010-06-16 12:22:58 +02004 */
5
Baruch Siach3324c962010-06-16 12:22:58 +02006//config:config UBIATTACH
7//config: bool "ubiattach"
Reuben Dowle3e2834f2011-02-05 03:18:08 +01008//config: default y
Denys Vlasenkoe3b1a1f2011-02-26 22:24:08 +01009//config: select PLATFORM_LINUX
Baruch Siach3324c962010-06-16 12:22:58 +020010//config: help
11//config: Attach MTD device to an UBI device.
12//config:
13//config:config UBIDETACH
14//config: bool "ubidetach"
Reuben Dowle3e2834f2011-02-05 03:18:08 +010015//config: default y
Denys Vlasenkoe3b1a1f2011-02-26 22:24:08 +010016//config: select PLATFORM_LINUX
Baruch Siach3324c962010-06-16 12:22:58 +020017//config: help
18//config: Detach MTD device from an UBI device.
Reuben Dowle3e2834f2011-02-05 03:18:08 +010019//config:
20//config:config UBIMKVOL
21//config: bool "ubimkvol"
22//config: default y
Denys Vlasenkoe3b1a1f2011-02-26 22:24:08 +010023//config: select PLATFORM_LINUX
Reuben Dowle3e2834f2011-02-05 03:18:08 +010024//config: help
25//config: Create a UBI volume.
26//config:
27//config:config UBIRMVOL
28//config: bool "ubirmvol"
29//config: default y
Denys Vlasenkoe3b1a1f2011-02-26 22:24:08 +010030//config: select PLATFORM_LINUX
Reuben Dowle3e2834f2011-02-05 03:18:08 +010031//config: help
32//config: Delete a UBI volume.
33//config:
34//config:config UBIRSVOL
35//config: bool "ubirsvol"
36//config: default y
Denys Vlasenkoe3b1a1f2011-02-26 22:24:08 +010037//config: select PLATFORM_LINUX
Reuben Dowle3e2834f2011-02-05 03:18:08 +010038//config: help
39//config: Resize a UBI volume.
Reuben Dowlea6108422011-04-26 04:27:48 +020040//config:
41//config:config UBIUPDATEVOL
42//config: bool "ubiupdatevol"
43//config: default y
44//config: select PLATFORM_LINUX
45//config: help
46//config: Update a UBI volume.
Reuben Dowle3e2834f2011-02-05 03:18:08 +010047
48//applet:IF_UBIATTACH(APPLET_ODDNAME(ubiattach, ubi_tools, BB_DIR_USR_SBIN, BB_SUID_DROP, ubiattach))
49//applet:IF_UBIDETACH(APPLET_ODDNAME(ubidetach, ubi_tools, BB_DIR_USR_SBIN, BB_SUID_DROP, ubidetach))
50//applet:IF_UBIMKVOL(APPLET_ODDNAME(ubimkvol, ubi_tools, BB_DIR_USR_SBIN, BB_SUID_DROP, ubimkvol))
51//applet:IF_UBIRMVOL(APPLET_ODDNAME(ubirmvol, ubi_tools, BB_DIR_USR_SBIN, BB_SUID_DROP, ubirmvol))
52//applet:IF_UBIRSVOL(APPLET_ODDNAME(ubirsvol, ubi_tools, BB_DIR_USR_SBIN, BB_SUID_DROP, ubirsvol))
Reuben Dowlea6108422011-04-26 04:27:48 +020053//applet:IF_UBIUPDATEVOL(APPLET_ODDNAME(ubiupdatevol, ubi_tools, BB_DIR_USR_SBIN, BB_SUID_DROP, ubiupdatevol))
Reuben Dowle3e2834f2011-02-05 03:18:08 +010054
Denys Vlasenkod1993f12011-04-26 04:32:05 +020055//kbuild:lib-$(CONFIG_UBIATTACH) += ubi_tools.o
56//kbuild:lib-$(CONFIG_UBIDETACH) += ubi_tools.o
57//kbuild:lib-$(CONFIG_UBIMKVOL) += ubi_tools.o
58//kbuild:lib-$(CONFIG_UBIRMVOL) += ubi_tools.o
59//kbuild:lib-$(CONFIG_UBIRSVOL) += ubi_tools.o
60//kbuild:lib-$(CONFIG_UBIUPDATEVOL) += ubi_tools.o
Baruch Siach3324c962010-06-16 12:22:58 +020061
62#include "libbb.h"
Denys Vlasenko7fe1e3f2012-03-11 18:04:14 +010063/* Some versions of kernel have broken headers, need this hack */
64#ifndef __packed
65# define __packed __attribute__((packed))
66#endif
Baruch Siach3324c962010-06-16 12:22:58 +020067#include <mtd/ubi-user.h>
68
Reuben Dowle3e2834f2011-02-05 03:18:08 +010069#define do_attach (ENABLE_UBIATTACH && applet_name[3] == 'a')
70#define do_detach (ENABLE_UBIDETACH && applet_name[3] == 'd')
71#define do_mkvol (ENABLE_UBIMKVOL && applet_name[3] == 'm')
72#define do_rmvol (ENABLE_UBIRMVOL && applet_name[4] == 'm')
73#define do_rsvol (ENABLE_UBIRSVOL && applet_name[4] == 's')
Reuben Dowlea6108422011-04-26 04:27:48 +020074#define do_update (ENABLE_UBIUPDATEVOL && applet_name[3] == 'u')
Baruch Siach3324c962010-06-16 12:22:58 +020075
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +020076static unsigned get_num_from_file(const char *path, unsigned max, const char *errmsg)
77{
78 char buf[sizeof(long long)*3];
79 unsigned long long num;
Denys Vlasenko0bfb9c22011-04-26 04:31:03 +020080
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +020081 if (open_read_close(path, buf, sizeof(buf)) < 0)
82 bb_perror_msg_and_die(errmsg, path);
83 /* It can be \n terminated, xatoull won't work well */
84 if (sscanf(buf, "%llu", &num) != 1 || num > max)
85 bb_error_msg_and_die(errmsg, path);
86 return num;
87}
88
89/* To prevent malloc(1G) accidents */
90#define MAX_SANE_ERASEBLOCK (16*1024*1024)
Baruch Siach3324c962010-06-16 12:22:58 +020091
Reuben Dowle3e2834f2011-02-05 03:18:08 +010092int ubi_tools_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
93int ubi_tools_main(int argc UNUSED_PARAM, char **argv)
Baruch Siach3324c962010-06-16 12:22:58 +020094{
95 unsigned opts;
96 char *ubi_ctrl;
Baruch Siach3324c962010-06-16 12:22:58 +020097 int fd;
98 int mtd_num;
99 int dev_num = UBI_DEV_NUM_AUTO;
Reuben Dowle3e2834f2011-02-05 03:18:08 +0100100 int vol_id = UBI_VOL_NUM_AUTO;
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200101 char *vol_name;
102 unsigned long long size_bytes = size_bytes; /* for compiler */
103 char *size_bytes_str;
Reuben Dowle3e2834f2011-02-05 03:18:08 +0100104 int alignment = 1;
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200105 char *type;
106 union {
107 struct ubi_attach_req attach_req;
108 struct ubi_mkvol_req mkvol_req;
109 struct ubi_rsvol_req rsvol_req;
110 } req_structs;
111#define attach_req req_structs.attach_req
112#define mkvol_req req_structs.mkvol_req
113#define rsvol_req req_structs.rsvol_req
114 char path[sizeof("/sys/class/ubi/ubi%d_%d/usable_eb_size")
115 + 2 * sizeof(int)*3 + /*just in case:*/ 16];
116#define path_sys_class_ubi_ubi (path + sizeof("/sys/class/ubi/ubi")-1)
117
118 strcpy(path_sys_class_ubi_ubi, "/sys/class/ubi/ubi");
119 memset(&req_structs, 0, sizeof(req_structs));
Baruch Siach3324c962010-06-16 12:22:58 +0200120
Paul B. Hensonf86404f2013-06-02 17:48:05 -0700121 if (do_mkvol) {
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200122 opt_complementary = "-1:d+:n+:a+";
123 opts = getopt32(argv, "md:n:N:s:a:t:",
Paul B. Hensonf86404f2013-06-02 17:48:05 -0700124 &dev_num, &vol_id,
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200125 &vol_name, &size_bytes_str, &alignment, &type
Paul B. Hensonf86404f2013-06-02 17:48:05 -0700126 );
127 } else {
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200128 opt_complementary = "-1:m+:d+:n+:a+";
129 opts = getopt32(argv, "m:d:n:N:s:a:t:",
Paul B. Hensonf86404f2013-06-02 17:48:05 -0700130 &mtd_num, &dev_num, &vol_id,
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200131 &vol_name, &size_bytes_str, &alignment, &type
Paul B. Hensonf86404f2013-06-02 17:48:05 -0700132 );
133 }
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200134#define OPTION_m (1 << 0)
135#define OPTION_d (1 << 1)
136#define OPTION_n (1 << 2)
137#define OPTION_N (1 << 3)
138#define OPTION_s (1 << 4)
139#define OPTION_a (1 << 5)
140#define OPTION_t (1 << 6)
141
142 if (opts & OPTION_s)
143 size_bytes = xatoull(size_bytes_str);
144 argv += optind;
145 ubi_ctrl = *argv;
Baruch Siach3324c962010-06-16 12:22:58 +0200146
147 fd = xopen(ubi_ctrl, O_RDWR);
Denys Vlasenko8d3e2252010-08-31 12:42:06 +0200148 //xfstat(fd, &st, ubi_ctrl);
Baruch Siach3324c962010-06-16 12:22:58 +0200149 //if (!S_ISCHR(st.st_mode))
Denys Vlasenko8d3e2252010-08-31 12:42:06 +0200150 // bb_error_msg_and_die("%s: not a char device", ubi_ctrl);
Baruch Siach3324c962010-06-16 12:22:58 +0200151
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200152//usage:#define ubiattach_trivial_usage
153//usage: "-m MTD_NUM [-d UBI_NUM] UBI_CTRL_DEV"
154//usage:#define ubiattach_full_usage "\n\n"
155//usage: "Attach MTD device to UBI\n"
156//usage: "\n -m MTD_NUM MTD device number to attach"
157//usage: "\n -d UBI_NUM UBI device number to assign"
Baruch Siach3324c962010-06-16 12:22:58 +0200158 if (do_attach) {
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200159 if (!(opts & OPTION_m))
Baruch Siach3324c962010-06-16 12:22:58 +0200160 bb_error_msg_and_die("%s device not specified", "MTD");
161
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200162 attach_req.mtd_num = mtd_num;
163 attach_req.ubi_num = dev_num;
Baruch Siach3324c962010-06-16 12:22:58 +0200164
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200165 xioctl(fd, UBI_IOCATT, &attach_req);
Reuben Dowle3e2834f2011-02-05 03:18:08 +0100166 } else
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200167
168//usage:#define ubidetach_trivial_usage
169//usage: "-d UBI_NUM UBI_CTRL_DEV"
170//usage:#define ubidetach_full_usage "\n\n"
171//usage: "Detach MTD device from UBI\n"
172//usage: "\n -d UBI_NUM UBI device number"
Reuben Dowle3e2834f2011-02-05 03:18:08 +0100173 if (do_detach) {
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200174 if (!(opts & OPTION_d))
Baruch Siach3324c962010-06-16 12:22:58 +0200175 bb_error_msg_and_die("%s device not specified", "UBI");
176
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200177 /* FIXME? kernel expects int32_t* here: */
Baruch Siach3324c962010-06-16 12:22:58 +0200178 xioctl(fd, UBI_IOCDET, &dev_num);
Reuben Dowle3e2834f2011-02-05 03:18:08 +0100179 } else
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200180
181//usage:#define ubimkvol_trivial_usage
182//usage: "UBI_DEVICE -N NAME [-s SIZE | -m]"
183//usage:#define ubimkvol_full_usage "\n\n"
184//usage: "Create UBI volume\n"
185//usage: "\n -a ALIGNMENT Volume alignment (default 1)"
186//usage: "\n -m Set volume size to maximum available"
187//usage: "\n -n VOLID Volume ID. If not specified,"
188//usage: "\n assigned automatically"
189//usage: "\n -N NAME Volume name"
190//usage: "\n -s SIZE Size in bytes"
191//usage: "\n -t TYPE Volume type (static|dynamic)"
Reuben Dowle3e2834f2011-02-05 03:18:08 +0100192 if (do_mkvol) {
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200193 if (opts & OPTION_m) {
Paul B. Hensonf86404f2013-06-02 17:48:05 -0700194 unsigned leb_avail;
195 unsigned leb_size;
196 unsigned num;
Paul B. Hensonf86404f2013-06-02 17:48:05 -0700197 char *p;
Paul B. Hensonf86404f2013-06-02 17:48:05 -0700198
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200199 if (sscanf(ubi_ctrl, "/dev/ubi%u", &num) != 1)
200 bb_error_msg_and_die("wrong format of UBI device name");
201
202 p = path_sys_class_ubi_ubi + sprintf(path_sys_class_ubi_ubi, "%u/", num);
Paul B. Hensonf86404f2013-06-02 17:48:05 -0700203
204 strcpy(p, "avail_eraseblocks");
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200205 leb_avail = get_num_from_file(path, UINT_MAX, "Can't get available eraseblocks from '%s'");
Paul B. Hensonf86404f2013-06-02 17:48:05 -0700206
207 strcpy(p, "eraseblock_size");
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200208 leb_size = get_num_from_file(path, MAX_SANE_ERASEBLOCK, "Can't get eraseblock size from '%s'");
Paul B. Hensonf86404f2013-06-02 17:48:05 -0700209
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200210 size_bytes = leb_avail * (unsigned long long)leb_size;
211 //if (size_bytes <= 0)
212 // bb_error_msg_and_die("%s invalid maximum size calculated", "UBI");
Paul B. Hensonf86404f2013-06-02 17:48:05 -0700213 } else
Reuben Dowle3e2834f2011-02-05 03:18:08 +0100214 if (!(opts & OPTION_s))
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200215 bb_error_msg_and_die("size not specified");
216
Reuben Dowle3e2834f2011-02-05 03:18:08 +0100217 if (!(opts & OPTION_N))
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200218 bb_error_msg_and_die("name not specified");
Reuben Dowle3e2834f2011-02-05 03:18:08 +0100219
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200220 mkvol_req.vol_id = vol_id;
221 mkvol_req.vol_type = UBI_DYNAMIC_VOLUME;
222 if ((opts & OPTION_t) && type[0] == 's')
223 mkvol_req.vol_type = UBI_STATIC_VOLUME;
224 mkvol_req.alignment = alignment;
225 mkvol_req.bytes = size_bytes; /* signed int64_t */
226 strncpy(mkvol_req.name, vol_name, UBI_MAX_VOLUME_NAME);
227 mkvol_req.name_len = strlen(vol_name);
228 if (mkvol_req.name_len > UBI_MAX_VOLUME_NAME)
229 bb_error_msg_and_die("volume name too long: '%s'", vol_name);
Reuben Dowle3e2834f2011-02-05 03:18:08 +0100230
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200231 xioctl(fd, UBI_IOCMKVOL, &mkvol_req);
Reuben Dowle3e2834f2011-02-05 03:18:08 +0100232 } else
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200233
234//usage:#define ubirmvol_trivial_usage
235//usage: "UBI_DEVICE -n VOLID"
236//usage:#define ubirmvol_full_usage "\n\n"
237//usage: "Remove UBI volume\n"
238//usage: "\n -n VOLID Volume ID"
Reuben Dowle3e2834f2011-02-05 03:18:08 +0100239 if (do_rmvol) {
240 if (!(opts & OPTION_n))
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200241 bb_error_msg_and_die("volume id not specified");
Reuben Dowle3e2834f2011-02-05 03:18:08 +0100242
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200243 /* FIXME? kernel expects int32_t* here: */
Reuben Dowle3e2834f2011-02-05 03:18:08 +0100244 xioctl(fd, UBI_IOCRMVOL, &vol_id);
245 } else
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200246
247//usage:#define ubirsvol_trivial_usage
248//usage: "UBI_DEVICE -n VOLID -s SIZE"
249//usage:#define ubirsvol_full_usage "\n\n"
250//usage: "Resize UBI volume\n"
251//usage: "\n -n VOLID Volume ID"
252//usage: "\n -s SIZE Size in bytes"
Reuben Dowle3e2834f2011-02-05 03:18:08 +0100253 if (do_rsvol) {
Reuben Dowle3e2834f2011-02-05 03:18:08 +0100254 if (!(opts & OPTION_s))
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200255 bb_error_msg_and_die("size not specified");
Reuben Dowle3e2834f2011-02-05 03:18:08 +0100256 if (!(opts & OPTION_n))
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200257 bb_error_msg_and_die("volume id not specified");
Reuben Dowle3e2834f2011-02-05 03:18:08 +0100258
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200259 rsvol_req.bytes = size_bytes; /* signed int64_t */
260 rsvol_req.vol_id = vol_id;
Reuben Dowle3e2834f2011-02-05 03:18:08 +0100261
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200262 xioctl(fd, UBI_IOCRSVOL, &rsvol_req);
Reuben Dowlea6108422011-04-26 04:27:48 +0200263 } else
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200264
265//usage:#define ubiupdatevol_trivial_usage
266//usage: "UBI_DEVICE [-t | [-s SIZE] IMG_FILE]"
267//usage:#define ubiupdatevol_full_usage "\n\n"
268//usage: "Update UBI volume\n"
269//usage: "\n -t Truncate to zero size"
270//usage: "\n -s SIZE Size in bytes to resize to"
Reuben Dowlea6108422011-04-26 04:27:48 +0200271 if (do_update) {
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200272 int64_t bytes64;
Reuben Dowlea6108422011-04-26 04:27:48 +0200273
274 if (opts & OPTION_t) {
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200275 /* truncate the volume by starting an update for size 0 */
276 bytes64 = 0;
277 /* this ioctl expects int64_t* parameter */
278 xioctl(fd, UBI_IOCVOLUP, &bytes64);
Reuben Dowlea6108422011-04-26 04:27:48 +0200279 }
280 else {
281 struct stat st;
Reuben Dowlea6108422011-04-26 04:27:48 +0200282 unsigned ubinum, volnum;
283 unsigned leb_size;
284 ssize_t len;
285 char *input_data;
286
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200287 /* Assume that device is in normal format. */
288 /* Removes need for scanning sysfs tree as full libubi does. */
Reuben Dowlea6108422011-04-26 04:27:48 +0200289 if (sscanf(ubi_ctrl, "/dev/ubi%u_%u", &ubinum, &volnum) != 2)
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200290 bb_error_msg_and_die("wrong format of UBI device name");
Reuben Dowlea6108422011-04-26 04:27:48 +0200291
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200292 sprintf(path_sys_class_ubi_ubi, "%u_%u/usable_eb_size", ubinum, volnum);
293 leb_size = get_num_from_file(path, MAX_SANE_ERASEBLOCK, "Can't get usable eraseblock size from '%s'");
Reuben Dowlea6108422011-04-26 04:27:48 +0200294
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200295 if (!(opts & OPTION_s)) {
296 if (!*argv)
Reuben Dowlea6108422011-04-26 04:27:48 +0200297 bb_show_usage();
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200298 xstat(*argv, &st);
Reuben Dowlea6108422011-04-26 04:27:48 +0200299 size_bytes = st.st_size;
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200300 xmove_fd(xopen(*argv, O_RDONLY), STDIN_FILENO);
Reuben Dowlea6108422011-04-26 04:27:48 +0200301 }
302
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200303 bytes64 = size_bytes;
304 /* this ioctl expects signed int64_t* parameter */
305 xioctl(fd, UBI_IOCVOLUP, &bytes64);
Reuben Dowlea6108422011-04-26 04:27:48 +0200306
307 input_data = xmalloc(leb_size);
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200308 while ((len = full_read(STDIN_FILENO, input_data, leb_size)) > 0) {
Reuben Dowlea6108422011-04-26 04:27:48 +0200309 xwrite(fd, input_data, len);
310 }
311 if (len < 0)
Denys Vlasenko65bdf0b2013-06-30 02:38:18 +0200312 bb_perror_msg_and_die("UBI volume update failed");
Reuben Dowlea6108422011-04-26 04:27:48 +0200313 }
Baruch Siach3324c962010-06-16 12:22:58 +0200314 }
315
316 if (ENABLE_FEATURE_CLEAN_UP)
317 close(fd);
318
319 return EXIT_SUCCESS;
320}