From 9ba41c4dc891e38c92126bfcc4c366d765841da0 Mon Sep 17 00:00:00 2001 From: Artem Bityutskiy Date: Wed, 26 Dec 2007 15:12:26 +0200 Subject: ubi-utils: add ubiattach and ubidetach Add 2 new utilities to attach and detach UBI devices. Signed-off-by: Artem Bityutskiy --- ubi-utils/src/libubi.c | 123 +++++++++++++++++++++++-- ubi-utils/src/libubi_int.h | 2 + ubi-utils/src/ubiattach.c | 224 +++++++++++++++++++++++++++++++++++++++++++++ ubi-utils/src/ubicrc32.c | 4 +- ubi-utils/src/ubidetach.c | 200 ++++++++++++++++++++++++++++++++++++++++ ubi-utils/src/ubimkvol.c | 8 +- ubi-utils/src/ubinfo.c | 6 +- ubi-utils/src/ubirmvol.c | 8 +- ubi-utils/src/ubiupdate.c | 4 +- 9 files changed, 556 insertions(+), 23 deletions(-) create mode 100644 ubi-utils/src/ubiattach.c create mode 100644 ubi-utils/src/ubidetach.c (limited to 'ubi-utils/src') diff --git a/ubi-utils/src/libubi.c b/ubi-utils/src/libubi.c index 32d988e..855aa82 100644 --- a/ubi-utils/src/libubi.c +++ b/ubi-utils/src/libubi.c @@ -434,7 +434,7 @@ static int vol_node2nums(struct libubi *lib, const char *node, int *dev_num, } if (i > info.highest_dev_num) { - errno = ENOENT; + errno = ENODEV; return -1; } @@ -442,12 +442,13 @@ static int vol_node2nums(struct libubi *lib, const char *node, int *dev_num, sprintf(file, lib->ubi_vol, i, minor - 1); fd = open(file, O_RDONLY); if (fd == -1) { - errno = ENOENT; + errno = ENODEV; return -1; } *dev_num = i; *vol_id = minor - 1; + errno = 0; return 0; } @@ -503,12 +504,40 @@ static int dev_node2num(struct libubi *lib, const char *node, int *dev_num) errno = EINVAL; return -1; } + errno = 0; *dev_num = i; return 0; } } - errno = ENOENT; + errno = ENODEV; + return -1; +} + +static int mtd_num2ubi_dev(struct libubi *lib, int mtd_num, int *dev_num) +{ + struct ubi_info info; + int i, ret, mtd_num1; + + if (ubi_get_info((libubi_t *)lib, &info)) + return -1; + + for (i = info.lowest_dev_num; i <= info.highest_dev_num; i++) { + ret = dev_read_int(lib->dev_mtd_num, i, &mtd_num1); + if (ret) { + if (errno == ENOENT) + continue; + return -1; + } + + if (mtd_num1 == mtd_num) { + errno = 0; + *dev_num = i; + return 0; + } + } + + errno = ENODEV; return -1; } @@ -596,6 +625,10 @@ libubi_t libubi_open(void) if (!lib->dev_min_io_size) goto out_error; + lib->dev_mtd_num = mkpath(lib->ubi_dev, DEV_MTD_NUM); + if (!lib->dev_mtd_num) + goto out_error; + lib->ubi_vol = mkpath(lib->sysfs_ubi, UBI_VOL_NAME_PATT); if (!lib->ubi_vol) goto out_error; @@ -661,6 +694,7 @@ void libubi_close(libubi_t desc) free(lib->vol_dev); free(lib->vol_type); free(lib->ubi_vol); + free(lib->dev_mtd_num); free(lib->dev_min_io_size); free(lib->dev_max_vols); free(lib->dev_bad_rsvd); @@ -679,6 +713,74 @@ void libubi_close(libubi_t desc) free(lib); } +int ubi_attach_mtd(libubi_t desc, const char *node, + struct ubi_attach_request *req) +{ + int fd, ret; + struct ubi_attach_req r; + + memset(&r, sizeof(struct ubi_attach_req), '\0'); + + desc = desc; + r.ubi_num = req->dev_num; + r.mtd_num = req->mtd_num; + r.vid_hdr_offset = req->vid_hdr_offset; + + fd = open(node, O_RDONLY); + if (fd == -1) + return -1; + + ret = ioctl(fd, UBI_IOCATT, &r); + close(fd); + if (ret == -1) + return -1; + + req->dev_num = r.ubi_num; + +#ifdef UDEV_SETTLE_HACK + if (system("udevsettle") == -1) + return -1; + if (system("udevsettle") == -1) + return -1; +#endif + + return ret; +} + +int ubi_detach_mtd(libubi_t desc, const char *node, int mtd_num) +{ + int ret, ubi_dev; + + ret = mtd_num2ubi_dev(desc, mtd_num, &ubi_dev); + if (ret == -1) + return ret; + + return ubi_remove_dev(desc, node, ubi_dev); +} + +int ubi_remove_dev(libubi_t desc, const char *node, int ubi_dev) +{ + int fd, ret; + + desc = desc; + + fd = open(node, O_RDONLY); + if (fd == -1) + return -1; + ret = ioctl(fd, UBI_IOCDET, &ubi_dev); + if (ret == -1) + goto out_close; + +#ifdef UDEV_SETTLE_HACK + if (system("udevsettle") == -1) + return -1; +#endif + +out_close: + close(fd); + return ret; +} + int ubi_node_type(libubi_t desc, const char *node) { struct stat st; @@ -842,16 +944,18 @@ int ubi_mkvol(libubi_t desc, const char *node, struct ubi_mkvol_request *req) return -1; ret = ioctl(fd, UBI_IOCMKVOL, &r); - if (ret == 0) - req->vol_id = r.vol_id; + if (ret == -1) + goto out_close; - close(fd); + req->vol_id = r.vol_id; #ifdef UDEV_SETTLE_HACK if (system("udevsettle") == -1) return -1; #endif +out_close: + close(fd); return ret; } @@ -865,13 +969,16 @@ int ubi_rmvol(libubi_t desc, const char *node, int vol_id) return -1; ret = ioctl(fd, UBI_IOCRMVOL, &vol_id); - close(fd); + if (ret == -1) + goto out_close; #ifdef UDEV_SETTLE_HACK if (system("udevsettle") == -1) return -1; #endif +out_close: + close(fd); return ret; } @@ -880,7 +987,7 @@ int ubi_rsvol(libubi_t desc, const char *node, int vol_id, long long bytes) int fd, ret; struct ubi_rsvol_req req; - desc = desc; + desc = desc; fd = open(node, O_RDONLY); if (fd == -1) return -1; diff --git a/ubi-utils/src/libubi_int.h b/ubi-utils/src/libubi_int.h index 4c26eb5..6490864 100644 --- a/ubi-utils/src/libubi_int.h +++ b/ubi-utils/src/libubi_int.h @@ -58,6 +58,7 @@ extern "C" { #define DEV_MAX_RSVD "reserved_for_bad" #define DEV_MAX_VOLS "max_vol_count" #define DEV_MIN_IO_SIZE "min_io_size" +#define DEV_MTD_NUM "mtd_num" #define UBI_VOL_NAME_PATT "ubi%d_%d" #define VOL_TYPE "type" @@ -114,6 +115,7 @@ struct libubi char *dev_bad_rsvd; char *dev_max_vols; char *dev_min_io_size; + char *dev_mtd_num; char *ubi_vol; char *vol_type; char *vol_dev; diff --git a/ubi-utils/src/ubiattach.c b/ubi-utils/src/ubiattach.c new file mode 100644 index 0000000..3476a3d --- /dev/null +++ b/ubi-utils/src/ubiattach.c @@ -0,0 +1,224 @@ +/* + * Copyright (C) 2007 Nokia Corporation. + * + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 as published by + * the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + * more details. + * + * You should have received a copy of the GNU General Public License along with + * this program; if not, write to the Free Software Foundation, Inc., 51 + * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/* + * An utility to attach MTD devices to UBI. + * + * Author: Artem Bityutskiy + */ + +#include +#include +#include +#include +#include +#include + +#include +#include "common.h" + +#define PROGRAM_VERSION "1.0" +#define PROGRAM_NAME "ubiattach" + +/* The variables below are set by command line arguments */ +struct args { + int devn; + int mtdn; + int vidoffs; + const char *node; +}; + +static struct args myargs = { + .devn = UBI_DEV_NUM_AUTO, + .mtdn = -1, + .vidoffs = 0, + .node = NULL, +}; + +static const char *doc = PROGRAM_NAME " version " PROGRAM_VERSION + " - a tool to attach MTD device to UBI."; + +static const char *optionsstr = +"-d, --devn= the number to assign to the newly created UBI device\n" +" (the number is assigned automatically if this is not\n" +" specified\n" +"-m, --mtdn= MTD device number to attach\n" +"-o, --vid-hdr-offset VID header offset (do not specify this unless you\n" +" really know what you do and the optimal defaults wukk\n" +" be used)\n" +"-h, --help print help message\n" +"-V, --version print program version"; + +static const char *usage = +"Usage: " PROGRAM_NAME " [-m ] [-d ]\n" +"\t\t[--mtdn=] [--devn ]\n" +"Example 1: " PROGRAM_NAME " /dev/ubi_ctrl -m 0 - attach MTD device 0 (mtd0) to UBI\n" +"Example 2: " PROGRAM_NAME " /dev/ubi_ctrl -m 0 -d 3 - attach MTD device 0 (mtd0) to UBI and\n" +" and create UBI device number 3 (ubi3)"; + +static const struct option long_options[] = { + { .name = "devn", .has_arg = 1, .flag = NULL, .val = 'd' }, + { .name = "mtdn", .has_arg = 1, .flag = NULL, .val = 'm' }, + { .name = "vid-hdr-offset", .has_arg = 1, .flag = NULL, .val = 'o' }, + { .name = "help", .has_arg = 0, .flag = NULL, .val = 'h' }, + { .name = "version", .has_arg = 0, .flag = NULL, .val = 'V' }, + { NULL, 0, NULL, 0}, +}; + +static int parse_opt(int argc, char * const argv[]) +{ + while (1) { + int key; + char *endp; + + key = getopt_long(argc, argv, "m:d:ohV", long_options, NULL); + if (key == -1) + break; + + switch (key) { + case 'd': + myargs.devn = strtoul(optarg, &endp, 0); + if (*endp != '\0' || endp == optarg || myargs.devn < 0) { + errmsg("bad UBI device number: \"%s\"", optarg); + return -1; + } + + break; + + case 'm': + myargs.mtdn = strtoul(optarg, &endp, 0); + if (*endp != '\0' || endp == optarg || myargs.mtdn < 0) { + errmsg("bad MTD device number: \"%s\"", optarg); + return -1; + } + + break; + + case 'o': + myargs.vidoffs = strtoul(optarg, &endp, 0); + if (*endp != '\0' || endp == optarg || myargs.vidoffs <= 0) { + errmsg("bad VID header offset: \"%s\"", optarg); + return -1; + } + + break; + + case 'h': + fprintf(stderr, "%s\n\n", doc); + fprintf(stderr, "%s\n\n", usage); + fprintf(stderr, "%s\n", optionsstr); + exit(0); + + case 'V': + fprintf(stderr, "%s\n", PROGRAM_VERSION); + exit(0); + + case ':': + errmsg("parameter is missing"); + return -1; + + default: + fprintf(stderr, "Use -h for help\n"); + exit(-1); + } + } + + if (optind == argc) { + errmsg("UBI control device name was not specified (use -h for help)"); + return -1; + } else if (optind != argc - 1) { + errmsg("more then one UBI control device specified (use -h for help)"); + return -1; + } + + if (myargs.mtdn == -1) { + errmsg("MTD device number was not specified (use -h for help)"); + return -1; + } + + myargs.node = argv[optind]; + return 0; +} + +int main(int argc, char * const argv[]) +{ + int err; + libubi_t libubi; + struct ubi_info ubi_info; + struct ubi_dev_info dev_info; + struct ubi_attach_request req; + + err = parse_opt(argc, argv); + if (err) + return -1; + + libubi = libubi_open(); + if (libubi == NULL) { + errmsg("cannot open libubi"); + perror("libubi_open"); + return -1; + } + + /* + * Make sure the kernel is fresh enough and this feature is supported. + */ + err = ubi_get_info(libubi, &ubi_info); + if (err) { + errmsg("cannot get UBI information"); + perror("ubi_get_info"); + goto out_libubi; + } + + if (ubi_info.ctrl_major == -1) { + errmsg("MTD attach/detach feature is not supported by your kernel"); + goto out_libubi; + } + + req.dev_num = myargs.devn; + req.mtd_num = myargs.mtdn; + req.vid_hdr_offset = myargs.vidoffs; + + err = ubi_attach_mtd(libubi, myargs.node, &req); + if (err) { + errmsg("cannot attach mtd%d", myargs.mtdn); + perror("ubi_attach_mtd"); + goto out_libubi; + } + + /* Print some information about the new UBI device */ + err = ubi_get_dev_info1(libubi, req.dev_num, &dev_info); + if (err) { + errmsg("cannot get information about newly created UBI device"); + perror("ubi_get_dev_info1"); + goto out_libubi; + } + + printf("UBI device number %d, total %d LEBs (", dev_info.dev_num, dev_info.total_lebs); + ubiutils_print_bytes(dev_info.total_bytes, 0); + printf("), available %d LEBs (", dev_info.avail_lebs); + ubiutils_print_bytes(dev_info.avail_bytes, 0); + printf("), LEB size "); + ubiutils_print_bytes(dev_info.leb_size, 1); + printf("\n"); + + libubi_close(libubi); + return 0; + +out_libubi: + libubi_close(libubi); + return -1; +} diff --git a/ubi-utils/src/ubicrc32.c b/ubi-utils/src/ubicrc32.c index 034cb10..cde3104 100644 --- a/ubi-utils/src/ubicrc32.c +++ b/ubi-utils/src/ubicrc32.c @@ -39,8 +39,8 @@ #define PROGRAM_VERSION "1.2" #define PROGRAM_NAME "ubicrc32" -static const char *doc = "Version " PROGRAM_VERSION "\n" - PROGRAM_NAME " - a tool to calculate CRC32 with UBI start value (0xFFFFFFFF)"; +static const char *doc = PROGRAM_NAME " version " PROGRAM_VERSION + " - a tool to calculate CRC32 with UBI start value (0xFFFFFFFF)"; static const char *optionsstr = "-h, --help print help message\n" diff --git a/ubi-utils/src/ubidetach.c b/ubi-utils/src/ubidetach.c new file mode 100644 index 0000000..cde21d0 --- /dev/null +++ b/ubi-utils/src/ubidetach.c @@ -0,0 +1,200 @@ +/* + * Copyright (C) 2007 Nokia Corporation. + * + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 as published by + * the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + * more details. + * + * You should have received a copy of the GNU General Public License along with + * this program; if not, write to the Free Software Foundation, Inc., 51 + * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/* + * An utility to delete UBI devices (detach MTD devices from UBI). + * + * Author: Artem Bityutskiy + */ + +#include +#include +#include +#include +#include +#include + +#include +#include "common.h" + +#define PROGRAM_VERSION "1.0" +#define PROGRAM_NAME "ubidetach" + +/* The variables below are set by command line arguments */ +struct args { + int devn; + int mtdn; + const char *node; +}; + +static struct args myargs = { + .devn = UBI_DEV_NUM_AUTO, + .mtdn = -1, + .node = NULL, +}; + +static const char *doc = PROGRAM_NAME " version " PROGRAM_VERSION +" - a tool to remove UBI devices (detach MTD devices from UBI)"; + +static const char *optionsstr = +"-d, --devn= UBI device number to delete\n" +"-m, --mtdn= or altrnatively, MTD device number to detach -\n" +" this will delete corresponding UBI device\n" +"-h, --help print help message\n" +"-V, --version print program version"; + +static const char *usage = +"Usage: " PROGRAM_NAME " [-d ] [-m ]\n" +"\t\t[--devn ] [--mtdn=]\n" +"Example 1: " PROGRAM_NAME " /dev/ubi_ctrl -d 2 - delete UBI device 2 (ubi2)\n" +"Example 2: " PROGRAM_NAME " /dev/ubi_ctrl -m 0 - detach MTD device 0 (mtd0)"; + +static const struct option long_options[] = { + { .name = "devn", .has_arg = 1, .flag = NULL, .val = 'd' }, + { .name = "mtdn", .has_arg = 1, .flag = NULL, .val = 'm' }, + { .name = "help", .has_arg = 0, .flag = NULL, .val = 'h' }, + { .name = "version", .has_arg = 0, .flag = NULL, .val = 'V' }, + { NULL, 0, NULL, 0}, +}; + +static int parse_opt(int argc, char * const argv[]) +{ + while (1) { + int key; + char *endp; + + key = getopt_long(argc, argv, "m:d:hV", long_options, NULL); + if (key == -1) + break; + + switch (key) { + case 'd': + myargs.devn = strtoul(optarg, &endp, 0); + if (*endp != '\0' || endp == optarg || myargs.devn < 0) { + errmsg("bad UBI device number: \"%s\"", optarg); + return -1; + } + + break; + + case 'm': + myargs.mtdn = strtoul(optarg, &endp, 0); + if (*endp != '\0' || endp == optarg || myargs.mtdn < 0) { + errmsg("bad MTD device number: \"%s\"", optarg); + return -1; + } + + break; + + case 'h': + fprintf(stderr, "%s\n\n", doc); + fprintf(stderr, "%s\n\n", usage); + fprintf(stderr, "%s\n", optionsstr); + exit(0); + + case 'V': + fprintf(stderr, "%s\n", PROGRAM_VERSION); + exit(0); + + case ':': + errmsg("parameter is missing"); + return -1; + + default: + fprintf(stderr, "Use -h for help\n"); + exit(-1); + } + } + + if (optind == argc) { + errmsg("UBI control device name was not specified (use -h for help)"); + return -1; + } else if (optind != argc - 1) { + errmsg("more then one UBI control device specified (use -h for help)"); + return -1; + } + + if (myargs.mtdn == -1 && myargs.devn == -1) { + errmsg("neither MTD nor UBI devices were specified (use -h for help)"); + return -1; + } + + if (myargs.mtdn != -1 && myargs.devn != -1) { + errmsg("specify either MTD or UBI device (use -h for help)"); + return -1; + } + + myargs.node = argv[optind]; + return 0; +} + +int main(int argc, char * const argv[]) +{ + int err; + libubi_t libubi; + struct ubi_info ubi_info; + + err = parse_opt(argc, argv); + if (err) + return -1; + + libubi = libubi_open(); + if (libubi == NULL) { + errmsg("cannot open libubi"); + perror("libubi_open"); + return -1; + } + + /* + * Make sure the kernel is fresh enough and this feature is supported. + */ + err = ubi_get_info(libubi, &ubi_info); + if (err) { + errmsg("cannot get UBI information"); + perror("ubi_get_info"); + goto out_libubi; + } + + if (ubi_info.ctrl_major == -1) { + errmsg("MTD detach/detach feature is not supported by your kernel"); + goto out_libubi; + } + + if (myargs.devn != -1) { + err = ubi_remove_dev(libubi, myargs.node, myargs.devn); + if (err) { + errmsg("cannot remove ubi%d", myargs.devn); + perror("ubi_remove_dev"); + goto out_libubi; + } + } else { + err = ubi_detach_mtd(libubi, myargs.node, myargs.mtdn); + if (err) { + errmsg("cannot detach mtd%d", myargs.mtdn); + perror("ubi_detach_mtd"); + goto out_libubi; + } + } + + libubi_close(libubi); + return 0; + +out_libubi: + libubi_close(libubi); + return -1; +} + diff --git a/ubi-utils/src/ubimkvol.c b/ubi-utils/src/ubimkvol.c index 38c737d..42b61b8 100644 --- a/ubi-utils/src/ubimkvol.c +++ b/ubi-utils/src/ubimkvol.c @@ -36,7 +36,7 @@ #define PROGRAM_VERSION "1.6" #define PROGRAM_NAME "ubimkvol" -/* The variables below is set by command line arguments */ +/* The variables below are set by command line arguments */ struct args { int vol_id; int vol_type; @@ -61,8 +61,8 @@ static struct args myargs = { .maxavs = 0, }; -static const char *doc = "Version " PROGRAM_VERSION "\n" - PROGRAM_NAME " - a tool to create UBI volumes."; +static const char *doc = PROGRAM_NAME " version " PROGRAM_VERSION + " - a tool to create UBI volumes."; static const char *optionsstr = "-a, --alignment= volume alignment (default is 1)\n" @@ -228,7 +228,7 @@ static int parse_opt(int argc, char * const argv[]) errmsg("UBI device name was not specified (use -h for help)"); return -1; } else if (optind != argc - 1) { - errmsg("more then one UBI devices specified (use -h for help)"); + errmsg("more then one UBI device specified (use -h for help)"); return -1; } diff --git a/ubi-utils/src/ubinfo.c b/ubi-utils/src/ubinfo.c index c907335..35c70a1 100644 --- a/ubi-utils/src/ubinfo.c +++ b/ubi-utils/src/ubinfo.c @@ -34,7 +34,7 @@ #define PROGRAM_VERSION "1.0" #define PROGRAM_NAME "ubinfo" -/* The variables below is set by command line arguments */ +/* The variables below are set by command line arguments */ struct args { int devn; int vol_id; @@ -49,8 +49,8 @@ static struct args myargs = { .node = NULL, }; -static const char *doc = "Version " PROGRAM_VERSION "\n" - PROGRAM_NAME " - a tool to print UBI information."; +static const char *doc = PROGRAM_NAME " version " PROGRAM_VERSION + " - a tool to print UBI information."; static const char *optionsstr = "-d, --devn= UBI device number to get information about\n" diff --git a/ubi-utils/src/ubirmvol.c b/ubi-utils/src/ubirmvol.c index 5f35525..60bcdc0 100644 --- a/ubi-utils/src/ubirmvol.c +++ b/ubi-utils/src/ubirmvol.c @@ -36,7 +36,7 @@ #define PROGRAM_VERSION "1.5" #define PROGRAM_NAME "ubirmvol" -/* The variables below is set by command line arguments */ +/* The variables below are set by command line arguments */ struct args { int vol_id; const char *node; @@ -47,8 +47,8 @@ static struct args myargs = { .node = NULL, }; -static const char *doc = "Version: " PROGRAM_VERSION "\n" - PROGRAM_NAME " - a tool to remove UBI volumes."; +static const char *doc = PROGRAM_NAME " version " PROGRAM_VERSION + " - a tool to remove UBI volumes."; static const char *optionsstr = " -n, --vol_id= volume ID to remove\n" @@ -121,7 +121,7 @@ static int parse_opt(int argc, char * const argv[]) errmsg("UBI device name was not specified (use -h for help)"); return -1; } else if (optind != argc - 1) { - errmsg("more then one UBI devices specified (use -h for help)"); + errmsg("more then one UBI device specified (use -h for help)"); return -1; } diff --git a/ubi-utils/src/ubiupdate.c b/ubi-utils/src/ubiupdate.c index 1b9188e..75222d4 100644 --- a/ubi-utils/src/ubiupdate.c +++ b/ubi-utils/src/ubiupdate.c @@ -53,8 +53,8 @@ static struct args myargs = { .img = NULL, }; -static const char *doc = "Version " PROGRAM_VERSION "\n" - PROGRAM_NAME " - a tool to write data to UBI volumes."; +static const char *doc = PROGRAM_NAME " version " PROGRAM_VERSION + " - a tool to write data to UBI volumes."; static const char *optionsstr = "-n, --vol_id= ID of UBI volume to update\n" -- cgit v1.2.3