2 * Copyright (c) International Business Machines Corp., 2006
3 * Copyright (c) Nokia Corporation, 2007
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
13 * the GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 * Author: Artem Bityutskiy (Битюцкий Артём),
24 * This file includes UBI initialization and building of UBI devices. At the
25 * moment UBI devices may only be added while UBI is initialized, but dynamic
26 * device add/remove functionality is planned. Also, at the moment we only
27 * attach UBI devices by scanning, which will become a bottleneck when flashes
28 * reach certain large size. Then one may improve UBI and add other methods.
31 #include <linux/err.h>
32 #include <linux/module.h>
33 #include <linux/moduleparam.h>
34 #include <linux/stringify.h>
35 #include <linux/stat.h>
36 #include <linux/log2.h>
39 /* Maximum length of the 'mtd=' parameter */
40 #define MTD_PARAM_LEN_MAX 64
43 * struct mtd_dev_param - MTD device parameter description data structure.
44 * @name: MTD device name or number string
45 * @vid_hdr_offs: VID header offset
46 * @data_offs: data offset
50 char name[MTD_PARAM_LEN_MAX];
55 /* Numbers of elements set in the @mtd_dev_param array */
56 static int mtd_devs = 0;
58 /* MTD devices specification parameters */
59 static struct mtd_dev_param mtd_dev_param[UBI_MAX_DEVICES];
61 /* Number of UBI devices in system */
64 /* All UBI devices in system */
65 struct ubi_device *ubi_devices[UBI_MAX_DEVICES];
67 /* Root UBI "class" object (corresponds to '/<sysfs>/class/ubi/') */
68 struct class *ubi_class;
70 /* "Show" method for files in '/<sysfs>/class/ubi/' */
71 static ssize_t ubi_version_show(struct class *class, char *buf)
73 return sprintf(buf, "%d\n", UBI_VERSION);
76 /* UBI version attribute ('/<sysfs>/class/ubi/version') */
77 static struct class_attribute ubi_version =
78 __ATTR(version, S_IRUGO, ubi_version_show, NULL);
80 static ssize_t dev_attribute_show(struct device *dev,
81 struct device_attribute *attr, char *buf);
83 /* UBI device attributes (correspond to files in '/<sysfs>/class/ubi/ubiX') */
84 static struct device_attribute dev_eraseblock_size =
85 __ATTR(eraseblock_size, S_IRUGO, dev_attribute_show, NULL);
86 static struct device_attribute dev_avail_eraseblocks =
87 __ATTR(avail_eraseblocks, S_IRUGO, dev_attribute_show, NULL);
88 static struct device_attribute dev_total_eraseblocks =
89 __ATTR(total_eraseblocks, S_IRUGO, dev_attribute_show, NULL);
90 static struct device_attribute dev_volumes_count =
91 __ATTR(volumes_count, S_IRUGO, dev_attribute_show, NULL);
92 static struct device_attribute dev_max_ec =
93 __ATTR(max_ec, S_IRUGO, dev_attribute_show, NULL);
94 static struct device_attribute dev_reserved_for_bad =
95 __ATTR(reserved_for_bad, S_IRUGO, dev_attribute_show, NULL);
96 static struct device_attribute dev_bad_peb_count =
97 __ATTR(bad_peb_count, S_IRUGO, dev_attribute_show, NULL);
98 static struct device_attribute dev_max_vol_count =
99 __ATTR(max_vol_count, S_IRUGO, dev_attribute_show, NULL);
100 static struct device_attribute dev_min_io_size =
101 __ATTR(min_io_size, S_IRUGO, dev_attribute_show, NULL);
102 static struct device_attribute dev_bgt_enabled =
103 __ATTR(bgt_enabled, S_IRUGO, dev_attribute_show, NULL);
105 /* "Show" method for files in '/<sysfs>/class/ubi/ubiX/' */
106 static ssize_t dev_attribute_show(struct device *dev,
107 struct device_attribute *attr, char *buf)
109 const struct ubi_device *ubi;
111 ubi = container_of(dev, struct ubi_device, dev);
112 if (attr == &dev_eraseblock_size)
113 return sprintf(buf, "%d\n", ubi->leb_size);
114 else if (attr == &dev_avail_eraseblocks)
115 return sprintf(buf, "%d\n", ubi->avail_pebs);
116 else if (attr == &dev_total_eraseblocks)
117 return sprintf(buf, "%d\n", ubi->good_peb_count);
118 else if (attr == &dev_volumes_count)
119 return sprintf(buf, "%d\n", ubi->vol_count);
120 else if (attr == &dev_max_ec)
121 return sprintf(buf, "%d\n", ubi->max_ec);
122 else if (attr == &dev_reserved_for_bad)
123 return sprintf(buf, "%d\n", ubi->beb_rsvd_pebs);
124 else if (attr == &dev_bad_peb_count)
125 return sprintf(buf, "%d\n", ubi->bad_peb_count);
126 else if (attr == &dev_max_vol_count)
127 return sprintf(buf, "%d\n", ubi->vtbl_slots);
128 else if (attr == &dev_min_io_size)
129 return sprintf(buf, "%d\n", ubi->min_io_size);
130 else if (attr == &dev_bgt_enabled)
131 return sprintf(buf, "%d\n", ubi->thread_enabled);
138 /* Fake "release" method for UBI devices */
139 static void dev_release(struct device *dev) { }
142 * ubi_sysfs_init - initialize sysfs for an UBI device.
143 * @ubi: UBI device description object
145 * This function returns zero in case of success and a negative error code in
148 static int ubi_sysfs_init(struct ubi_device *ubi)
152 ubi->dev.release = dev_release;
153 ubi->dev.devt = ubi->cdev.dev;
154 ubi->dev.class = ubi_class;
155 sprintf(&ubi->dev.bus_id[0], UBI_NAME_STR"%d", ubi->ubi_num);
156 err = device_register(&ubi->dev);
160 err = device_create_file(&ubi->dev, &dev_eraseblock_size);
163 err = device_create_file(&ubi->dev, &dev_avail_eraseblocks);
165 goto out_eraseblock_size;
166 err = device_create_file(&ubi->dev, &dev_total_eraseblocks);
168 goto out_avail_eraseblocks;
169 err = device_create_file(&ubi->dev, &dev_volumes_count);
171 goto out_total_eraseblocks;
172 err = device_create_file(&ubi->dev, &dev_max_ec);
174 goto out_volumes_count;
175 err = device_create_file(&ubi->dev, &dev_reserved_for_bad);
177 goto out_volumes_max_ec;
178 err = device_create_file(&ubi->dev, &dev_bad_peb_count);
180 goto out_reserved_for_bad;
181 err = device_create_file(&ubi->dev, &dev_max_vol_count);
183 goto out_bad_peb_count;
184 err = device_create_file(&ubi->dev, &dev_min_io_size);
186 goto out_max_vol_count;
187 err = device_create_file(&ubi->dev, &dev_bgt_enabled);
189 goto out_min_io_size;
194 device_remove_file(&ubi->dev, &dev_min_io_size);
196 device_remove_file(&ubi->dev, &dev_max_vol_count);
198 device_remove_file(&ubi->dev, &dev_bad_peb_count);
199 out_reserved_for_bad:
200 device_remove_file(&ubi->dev, &dev_reserved_for_bad);
202 device_remove_file(&ubi->dev, &dev_max_ec);
204 device_remove_file(&ubi->dev, &dev_volumes_count);
205 out_total_eraseblocks:
206 device_remove_file(&ubi->dev, &dev_total_eraseblocks);
207 out_avail_eraseblocks:
208 device_remove_file(&ubi->dev, &dev_avail_eraseblocks);
210 device_remove_file(&ubi->dev, &dev_eraseblock_size);
212 device_unregister(&ubi->dev);
214 ubi_err("failed to initialize sysfs for %s, error %d",
220 * ubi_sysfs_close - close sysfs for an UBI device.
221 * @ubi: UBI device description object
223 static void ubi_sysfs_close(struct ubi_device *ubi)
225 device_remove_file(&ubi->dev, &dev_bgt_enabled);
226 device_remove_file(&ubi->dev, &dev_min_io_size);
227 device_remove_file(&ubi->dev, &dev_max_vol_count);
228 device_remove_file(&ubi->dev, &dev_bad_peb_count);
229 device_remove_file(&ubi->dev, &dev_reserved_for_bad);
230 device_remove_file(&ubi->dev, &dev_max_ec);
231 device_remove_file(&ubi->dev, &dev_volumes_count);
232 device_remove_file(&ubi->dev, &dev_total_eraseblocks);
233 device_remove_file(&ubi->dev, &dev_avail_eraseblocks);
234 device_remove_file(&ubi->dev, &dev_eraseblock_size);
235 device_unregister(&ubi->dev);
239 * kill_volumes - destroy all volumes.
240 * @ubi: UBI device description object
242 static void kill_volumes(struct ubi_device *ubi)
246 for (i = 0; i < ubi->vtbl_slots; i++)
248 ubi_free_volume(ubi, i);
252 * uif_init - initialize user interfaces for an UBI device.
253 * @ubi: UBI device description object
255 * This function returns zero in case of success and a negative error code in
258 static int uif_init(struct ubi_device *ubi)
263 mutex_init(&ubi->vtbl_mutex);
264 spin_lock_init(&ubi->volumes_lock);
266 sprintf(ubi->ubi_name, UBI_NAME_STR "%d", ubi->ubi_num);
269 * Major numbers for the UBI character devices are allocated
270 * dynamically. Major numbers of volume character devices are
271 * equivalent to ones of the corresponding UBI character device. Minor
272 * numbers of UBI character devices are 0, while minor numbers of
273 * volume character devices start from 1. Thus, we allocate one major
274 * number and ubi->vtbl_slots + 1 minor numbers.
276 err = alloc_chrdev_region(&dev, 0, ubi->vtbl_slots + 1, ubi->ubi_name);
278 ubi_err("cannot register UBI character devices");
282 ubi_assert(MINOR(dev) == 0);
283 cdev_init(&ubi->cdev, &ubi_cdev_operations);
284 dbg_msg("%s major is %u", ubi->ubi_name, MAJOR(dev));
285 ubi->cdev.owner = THIS_MODULE;
287 err = cdev_add(&ubi->cdev, dev, 1);
289 ubi_err("cannot add character device");
293 err = ubi_sysfs_init(ubi);
297 for (i = 0; i < ubi->vtbl_slots; i++)
298 if (ubi->volumes[i]) {
299 err = ubi_add_volume(ubi, i);
301 ubi_err("cannot add volume %d", i);
310 ubi_sysfs_close(ubi);
312 cdev_del(&ubi->cdev);
314 unregister_chrdev_region(ubi->cdev.dev, ubi->vtbl_slots + 1);
315 ubi_err("cannot initialize UBI %s, error %d", ubi->ubi_name, err);
320 * uif_close - close user interfaces for an UBI device.
321 * @ubi: UBI device description object
323 static void uif_close(struct ubi_device *ubi)
326 ubi_sysfs_close(ubi);
327 cdev_del(&ubi->cdev);
328 unregister_chrdev_region(ubi->cdev.dev, ubi->vtbl_slots + 1);
332 * attach_by_scanning - attach an MTD device using scanning method.
333 * @ubi: UBI device descriptor
335 * This function returns zero in case of success and a negative error code in
338 * Note, currently this is the only method to attach UBI devices. Hopefully in
339 * the future we'll have more scalable attaching methods and avoid full media
340 * scanning. But even in this case scanning will be needed as a fall-back
341 * attaching method if there are some on-flash table corruptions.
343 static int attach_by_scanning(struct ubi_device *ubi)
346 struct ubi_scan_info *si;
352 ubi->bad_peb_count = si->bad_peb_count;
353 ubi->good_peb_count = ubi->peb_count - ubi->bad_peb_count;
354 ubi->max_ec = si->max_ec;
355 ubi->mean_ec = si->mean_ec;
357 err = ubi_read_volume_table(ubi, si);
361 err = ubi_wl_init_scan(ubi, si);
365 err = ubi_eba_init_scan(ubi, si);
369 ubi_scan_destroy_si(si);
377 ubi_scan_destroy_si(si);
382 * io_init - initialize I/O unit for a given UBI device.
383 * @ubi: UBI device description object
385 * If @ubi->vid_hdr_offset or @ubi->leb_start is zero, default offsets are
387 * o EC header is always at offset zero - this cannot be changed;
388 * o VID header starts just after the EC header at the closest address
389 * aligned to @io->@hdrs_min_io_size;
390 * o data starts just after the VID header at the closest address aligned to
393 * This function returns zero in case of success and a negative error code in
396 static int io_init(struct ubi_device *ubi)
398 if (ubi->mtd->numeraseregions != 0) {
400 * Some flashes have several erase regions. Different regions
401 * may have different eraseblock size and other
402 * characteristics. It looks like mostly multi-region flashes
403 * have one "main" region and one or more small regions to
404 * store boot loader code or boot parameters or whatever. I
405 * guess we should just pick the largest region. But this is
408 ubi_err("multiple regions, not implemented");
413 * Note, in this implementation we support MTD devices with 0x7FFFFFFF
414 * physical eraseblocks maximum.
417 ubi->peb_size = ubi->mtd->erasesize;
418 ubi->peb_count = ubi->mtd->size / ubi->mtd->erasesize;
419 ubi->flash_size = ubi->mtd->size;
421 if (ubi->mtd->block_isbad && ubi->mtd->block_markbad)
422 ubi->bad_allowed = 1;
424 ubi->min_io_size = ubi->mtd->writesize;
425 ubi->hdrs_min_io_size = ubi->mtd->writesize >> ubi->mtd->subpage_sft;
427 /* Make sure minimal I/O unit is power of 2 */
428 if (!is_power_of_2(ubi->min_io_size)) {
429 ubi_err("min. I/O unit (%d) is not power of 2",
434 ubi_assert(ubi->hdrs_min_io_size > 0);
435 ubi_assert(ubi->hdrs_min_io_size <= ubi->min_io_size);
436 ubi_assert(ubi->min_io_size % ubi->hdrs_min_io_size == 0);
438 /* Calculate default aligned sizes of EC and VID headers */
439 ubi->ec_hdr_alsize = ALIGN(UBI_EC_HDR_SIZE, ubi->hdrs_min_io_size);
440 ubi->vid_hdr_alsize = ALIGN(UBI_VID_HDR_SIZE, ubi->hdrs_min_io_size);
442 dbg_msg("min_io_size %d", ubi->min_io_size);
443 dbg_msg("hdrs_min_io_size %d", ubi->hdrs_min_io_size);
444 dbg_msg("ec_hdr_alsize %d", ubi->ec_hdr_alsize);
445 dbg_msg("vid_hdr_alsize %d", ubi->vid_hdr_alsize);
447 if (ubi->vid_hdr_offset == 0)
449 ubi->vid_hdr_offset = ubi->vid_hdr_aloffset =
452 ubi->vid_hdr_aloffset = ubi->vid_hdr_offset &
453 ~(ubi->hdrs_min_io_size - 1);
454 ubi->vid_hdr_shift = ubi->vid_hdr_offset -
455 ubi->vid_hdr_aloffset;
458 /* Similar for the data offset */
459 if (ubi->leb_start == 0) {
460 ubi->leb_start = ubi->vid_hdr_offset + ubi->vid_hdr_alsize;
461 ubi->leb_start = ALIGN(ubi->leb_start, ubi->min_io_size);
464 dbg_msg("vid_hdr_offset %d", ubi->vid_hdr_offset);
465 dbg_msg("vid_hdr_aloffset %d", ubi->vid_hdr_aloffset);
466 dbg_msg("vid_hdr_shift %d", ubi->vid_hdr_shift);
467 dbg_msg("leb_start %d", ubi->leb_start);
469 /* The shift must be aligned to 32-bit boundary */
470 if (ubi->vid_hdr_shift % 4) {
471 ubi_err("unaligned VID header shift %d",
477 if (ubi->vid_hdr_offset < UBI_EC_HDR_SIZE ||
478 ubi->leb_start < ubi->vid_hdr_offset + UBI_VID_HDR_SIZE ||
479 ubi->leb_start > ubi->peb_size - UBI_VID_HDR_SIZE ||
480 ubi->leb_start % ubi->min_io_size) {
481 ubi_err("bad VID header (%d) or data offsets (%d)",
482 ubi->vid_hdr_offset, ubi->leb_start);
487 * It may happen that EC and VID headers are situated in one minimal
488 * I/O unit. In this case we can only accept this UBI image in
491 if (ubi->vid_hdr_offset + UBI_VID_HDR_SIZE <= ubi->hdrs_min_io_size) {
492 ubi_warn("EC and VID headers are in the same minimal I/O unit, "
493 "switch to read-only mode");
497 ubi->leb_size = ubi->peb_size - ubi->leb_start;
499 if (!(ubi->mtd->flags & MTD_WRITEABLE)) {
500 ubi_msg("MTD device %d is write-protected, attach in "
501 "read-only mode", ubi->mtd->index);
505 dbg_msg("leb_size %d", ubi->leb_size);
506 dbg_msg("ro_mode %d", ubi->ro_mode);
509 * Note, ideally, we have to initialize ubi->bad_peb_count here. But
510 * unfortunately, MTD does not provide this information. We should loop
511 * over all physical eraseblocks and invoke mtd->block_is_bad() for
512 * each physical eraseblock. So, we skip ubi->bad_peb_count
513 * uninitialized and initialize it after scanning.
520 * attach_mtd_dev - attach an MTD device.
521 * @mtd_dev: MTD device name or number string
522 * @vid_hdr_offset: VID header offset
523 * @data_offset: data offset
525 * This function attaches an MTD device to UBI. It first treats @mtd_dev as the
526 * MTD device name, and tries to open it by this name. If it is unable to open,
527 * it tries to convert @mtd_dev to an integer and open the MTD device by its
528 * number. Returns zero in case of success and a negative error code in case of
531 static int attach_mtd_dev(const char *mtd_dev, int vid_hdr_offset,
534 struct ubi_device *ubi;
535 struct mtd_info *mtd;
538 mtd = get_mtd_device_nm(mtd_dev);
543 if (PTR_ERR(mtd) != -ENODEV)
547 * Probably this is not MTD device name but MTD device number -
550 mtd_num = simple_strtoul(mtd_dev, &endp, 0);
551 if (*endp != '\0' || mtd_dev == endp) {
552 ubi_err("incorrect MTD device: \"%s\"", mtd_dev);
556 mtd = get_mtd_device(NULL, mtd_num);
561 /* Check if we already have the same MTD device attached */
562 for (i = 0; i < ubi_devices_cnt; i++)
563 if (ubi_devices[i]->mtd->index == mtd->index) {
564 ubi_err("mtd%d is already attached to ubi%d",
570 ubi = ubi_devices[ubi_devices_cnt] = kzalloc(sizeof(struct ubi_device),
577 ubi->ubi_num = ubi_devices_cnt;
580 dbg_msg("attaching mtd%d to ubi%d: VID header offset %d data offset %d",
581 ubi->mtd->index, ubi_devices_cnt, vid_hdr_offset, data_offset);
583 ubi->vid_hdr_offset = vid_hdr_offset;
584 ubi->leb_start = data_offset;
589 mutex_init(&ubi->buf_mutex);
590 ubi->peb_buf1 = vmalloc(ubi->peb_size);
594 ubi->peb_buf2 = vmalloc(ubi->peb_size);
598 #ifdef CONFIG_MTD_UBI_DEBUG
599 mutex_init(&ubi->dbg_buf_mutex);
600 ubi->dbg_peb_buf = vmalloc(ubi->peb_size);
601 if (!ubi->dbg_peb_buf)
605 err = attach_by_scanning(ubi);
607 dbg_err("failed to attach by scanning, error %d", err);
615 ubi_msg("attached mtd%d to ubi%d", ubi->mtd->index, ubi_devices_cnt);
616 ubi_msg("MTD device name: \"%s\"", ubi->mtd->name);
617 ubi_msg("MTD device size: %llu MiB", ubi->flash_size >> 20);
618 ubi_msg("physical eraseblock size: %d bytes (%d KiB)",
619 ubi->peb_size, ubi->peb_size >> 10);
620 ubi_msg("logical eraseblock size: %d bytes", ubi->leb_size);
621 ubi_msg("number of good PEBs: %d", ubi->good_peb_count);
622 ubi_msg("number of bad PEBs: %d", ubi->bad_peb_count);
623 ubi_msg("smallest flash I/O unit: %d", ubi->min_io_size);
624 ubi_msg("VID header offset: %d (aligned %d)",
625 ubi->vid_hdr_offset, ubi->vid_hdr_aloffset);
626 ubi_msg("data offset: %d", ubi->leb_start);
627 ubi_msg("max. allowed volumes: %d", ubi->vtbl_slots);
628 ubi_msg("wear-leveling threshold: %d", CONFIG_MTD_UBI_WL_THRESHOLD);
629 ubi_msg("number of internal volumes: %d", UBI_INT_VOL_COUNT);
630 ubi_msg("number of user volumes: %d",
631 ubi->vol_count - UBI_INT_VOL_COUNT);
632 ubi_msg("available PEBs: %d", ubi->avail_pebs);
633 ubi_msg("total number of reserved PEBs: %d", ubi->rsvd_pebs);
634 ubi_msg("number of PEBs reserved for bad PEB handling: %d",
636 ubi_msg("max/mean erase counter: %d/%d", ubi->max_ec, ubi->mean_ec);
638 /* Enable the background thread */
639 if (!DBG_DISABLE_BGT) {
640 ubi->thread_enabled = 1;
641 wake_up_process(ubi->bgt_thread);
644 ubi_devices_cnt += 1;
652 vfree(ubi->peb_buf1);
653 vfree(ubi->peb_buf2);
654 #ifdef CONFIG_MTD_UBI_DEBUG
655 vfree(ubi->dbg_peb_buf);
660 ubi_devices[ubi_devices_cnt] = NULL;
665 * detach_mtd_dev - detach an MTD device.
666 * @ubi: UBI device description object
668 static void detach_mtd_dev(struct ubi_device *ubi)
670 int ubi_num = ubi->ubi_num, mtd_num = ubi->mtd->index;
672 dbg_msg("detaching mtd%d from ubi%d", ubi->mtd->index, ubi_num);
677 put_mtd_device(ubi->mtd);
678 vfree(ubi->peb_buf1);
679 vfree(ubi->peb_buf2);
680 #ifdef CONFIG_MTD_UBI_DEBUG
681 vfree(ubi->dbg_peb_buf);
683 kfree(ubi_devices[ubi_num]);
684 ubi_devices[ubi_num] = NULL;
685 ubi_devices_cnt -= 1;
686 ubi_assert(ubi_devices_cnt >= 0);
687 ubi_msg("mtd%d is detached from ubi%d", mtd_num, ubi_num);
690 static int __init ubi_init(void)
694 /* Ensure that EC and VID headers have correct size */
695 BUILD_BUG_ON(sizeof(struct ubi_ec_hdr) != 64);
696 BUILD_BUG_ON(sizeof(struct ubi_vid_hdr) != 64);
698 if (mtd_devs > UBI_MAX_DEVICES) {
699 printk("UBI error: too many MTD devices, maximum is %d\n",
704 ubi_class = class_create(THIS_MODULE, UBI_NAME_STR);
705 if (IS_ERR(ubi_class))
706 return PTR_ERR(ubi_class);
708 err = class_create_file(ubi_class, &ubi_version);
712 /* Attach MTD devices */
713 for (i = 0; i < mtd_devs; i++) {
714 struct mtd_dev_param *p = &mtd_dev_param[i];
717 err = attach_mtd_dev(p->name, p->vid_hdr_offs, p->data_offs);
725 for (k = 0; k < i; k++)
726 detach_mtd_dev(ubi_devices[k]);
727 class_remove_file(ubi_class, &ubi_version);
729 class_destroy(ubi_class);
732 module_init(ubi_init);
734 static void __exit ubi_exit(void)
736 int i, n = ubi_devices_cnt;
738 for (i = 0; i < n; i++)
739 detach_mtd_dev(ubi_devices[i]);
740 class_remove_file(ubi_class, &ubi_version);
741 class_destroy(ubi_class);
743 module_exit(ubi_exit);
746 * bytes_str_to_int - convert a string representing number of bytes to an
748 * @str: the string to convert
750 * This function returns positive resulting integer in case of success and a
751 * negative error code in case of failure.
753 static int __init bytes_str_to_int(const char *str)
756 unsigned long result;
758 result = simple_strtoul(str, &endp, 0);
759 if (str == endp || result < 0) {
760 printk("UBI error: incorrect bytes count: \"%s\"\n", str);
772 if (endp[1] == 'i' && (endp[2] == '\0' ||
773 endp[2] == 'B' || endp[2] == 'b'))
778 printk("UBI error: incorrect bytes count: \"%s\"\n", str);
786 * ubi_mtd_param_parse - parse the 'mtd=' UBI parameter.
787 * @val: the parameter value to parse
790 * This function returns zero in case of success and a negative error code in
793 static int __init ubi_mtd_param_parse(const char *val, struct kernel_param *kp)
796 struct mtd_dev_param *p;
797 char buf[MTD_PARAM_LEN_MAX];
798 char *pbuf = &buf[0];
799 char *tokens[3] = {NULL, NULL, NULL};
801 if (mtd_devs == UBI_MAX_DEVICES) {
802 printk("UBI error: too many parameters, max. is %d\n",
807 len = strnlen(val, MTD_PARAM_LEN_MAX);
808 if (len == MTD_PARAM_LEN_MAX) {
809 printk("UBI error: parameter \"%s\" is too long, max. is %d\n",
810 val, MTD_PARAM_LEN_MAX);
815 printk("UBI warning: empty 'mtd=' parameter - ignored\n");
821 /* Get rid of the final newline */
822 if (buf[len - 1] == '\n')
825 for (i = 0; i < 3; i++)
826 tokens[i] = strsep(&pbuf, ",");
829 printk("UBI error: too many arguments at \"%s\"\n", val);
833 p = &mtd_dev_param[mtd_devs];
834 strcpy(&p->name[0], tokens[0]);
837 p->vid_hdr_offs = bytes_str_to_int(tokens[1]);
839 p->data_offs = bytes_str_to_int(tokens[2]);
841 if (p->vid_hdr_offs < 0)
842 return p->vid_hdr_offs;
843 if (p->data_offs < 0)
850 module_param_call(mtd, ubi_mtd_param_parse, NULL, NULL, 000);
851 MODULE_PARM_DESC(mtd, "MTD devices to attach. Parameter format: "
852 "mtd=<name|num>[,<vid_hdr_offs>,<data_offs>]. "
853 "Multiple \"mtd\" parameters may be specified.\n"
854 "MTD devices may be specified by their number or name. "
855 "Optional \"vid_hdr_offs\" and \"data_offs\" parameters "
856 "specify UBI VID header position and data starting "
857 "position to be used by UBI.\n"
858 "Example: mtd=content,1984,2048 mtd=4 - attach MTD device"
859 "with name content using VID header offset 1984 and data "
860 "start 2048, and MTD device number 4 using default "
863 MODULE_VERSION(__stringify(UBI_VERSION));
864 MODULE_DESCRIPTION("UBI - Unsorted Block Images");
865 MODULE_AUTHOR("Artem Bityutskiy");
866 MODULE_LICENSE("GPL");