drivers/mtd/ubi/build.c

   1 /*
   2  * Copyright (c) International Business Machines Corp., 2006
   3  * Copyright (c) Nokia Corporation, 2007
   4  *
   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.
   9  *
  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.
  14  *
  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
  18  *
  19  * Author: Artem Bityutskiy (Битюцкий Артём),
  20  *         Frank Haverkamp
  21  */
  22
  23 /*
  24  * This file includes UBI initialization and building of UBI devices.
  25  *
  26  * When UBI is initialized, it attaches all the MTD devices specified as the
  27  * module load parameters or the kernel boot parameters. If MTD devices were
  28  * specified, UBI does not attach any MTD device, but it is possible to do
  29  * later using the "UBI control device".
  30  *
  31  * At the moment we only attach UBI devices by scanning, which will become a
  32  * bottleneck when flashes reach certain large size. Then one may improve UBI
  33  * and add other methods, although it does not seem to be easy to do.
  34  */
  35
  36 #include <linux/err.h>
  37 #include <linux/module.h>
  38 #include <linux/moduleparam.h>
  39 #include <linux/stringify.h>
  40 #include <linux/stat.h>
  41 #include <linux/miscdevice.h>
  42 #include <linux/log2.h>
  43 #include <linux/kthread.h>
  44 #include <linux/reboot.h>
  45 #include <linux/kernel.h>
  46 #include "ubi.h"
  47
  48 /* Maximum length of the 'mtd=' parameter */
  49 #define MTD_PARAM_LEN_MAX 64
  50
  51 /**
  52  * struct mtd_dev_param - MTD device parameter description data structure.
  53  * @name: MTD device name or number string
  54  * @vid_hdr_offs: VID header offset
  55  */
  56 struct mtd_dev_param {
  57         char name[MTD_PARAM_LEN_MAX];
  58         int vid_hdr_offs;
  59 };
  60
  61 /* Numbers of elements set in the @mtd_dev_param array */
  62 static int __initdata mtd_devs;
  63
  64 /* MTD devices specification parameters */
  65 static struct mtd_dev_param __initdata mtd_dev_param[UBI_MAX_DEVICES];
  66
  67 /* Root UBI "class" object (corresponds to '/<sysfs>/class/ubi/') */
  68 struct class *ubi_class;
  69
  70 /* Slab cache for wear-leveling entries */
  71 struct kmem_cache *ubi_wl_entry_slab;
  72
  73 /* UBI control character device */
  74 static struct miscdevice ubi_ctrl_cdev = {
  75         .minor = MISC_DYNAMIC_MINOR,
  76         .name = "ubi_ctrl",
  77         .fops = &ubi_ctrl_cdev_operations,
  78 };
  79
  80 /* All UBI devices in system */
  81 static struct ubi_device *ubi_devices[UBI_MAX_DEVICES];
  82
  83 /* Serializes UBI devices creations and removals */
  84 DEFINE_MUTEX(ubi_devices_mutex);
  85
  86 /* Protects @ubi_devices and @ubi->ref_count */
  87 static DEFINE_SPINLOCK(ubi_devices_lock);
  88
  89 /* "Show" method for files in '/<sysfs>/class/ubi/' */
  90 static ssize_t ubi_version_show(struct class *class, char *buf)
  91 {
  92         return sprintf(buf, "%d\n", UBI_VERSION);
  93 }
  94
  95 /* UBI version attribute ('/<sysfs>/class/ubi/version') */
  96 static struct class_attribute ubi_version =
  97         __ATTR(version, S_IRUGO, ubi_version_show, NULL);
  98
  99 static ssize_t dev_attribute_show(struct device *dev,
 100                                   struct device_attribute *attr, char *buf);
 101
 102 /* UBI device attributes (correspond to files in '/<sysfs>/class/ubi/ubiX') */
 103 static struct device_attribute dev_eraseblock_size =
 104         __ATTR(eraseblock_size, S_IRUGO, dev_attribute_show, NULL);
 105 static struct device_attribute dev_avail_eraseblocks =
 106         __ATTR(avail_eraseblocks, S_IRUGO, dev_attribute_show, NULL);
 107 static struct device_attribute dev_total_eraseblocks =
 108         __ATTR(total_eraseblocks, S_IRUGO, dev_attribute_show, NULL);
 109 static struct device_attribute dev_volumes_count =
 110         __ATTR(volumes_count, S_IRUGO, dev_attribute_show, NULL);
 111 static struct device_attribute dev_max_ec =
 112         __ATTR(max_ec, S_IRUGO, dev_attribute_show, NULL);
 113 static struct device_attribute dev_reserved_for_bad =
 114         __ATTR(reserved_for_bad, S_IRUGO, dev_attribute_show, NULL);
 115 static struct device_attribute dev_bad_peb_count =
 116         __ATTR(bad_peb_count, S_IRUGO, dev_attribute_show, NULL);
 117 static struct device_attribute dev_max_vol_count =
 118         __ATTR(max_vol_count, S_IRUGO, dev_attribute_show, NULL);
 119 static struct device_attribute dev_min_io_size =
 120         __ATTR(min_io_size, S_IRUGO, dev_attribute_show, NULL);
 121 static struct device_attribute dev_bgt_enabled =
 122         __ATTR(bgt_enabled, S_IRUGO, dev_attribute_show, NULL);
 123 static struct device_attribute dev_mtd_num =
 124         __ATTR(mtd_num, S_IRUGO, dev_attribute_show, NULL);
 125
 126 /**
 127  * ubi_volume_notify - send a volume change notification.
 128  * @ubi: UBI device description object
 129  * @vol: volume description object of the changed volume
 130  * @ntype: notification type to send (%UBI_VOLUME_ADDED, etc)
 131  *
 132  * This is a helper function which notifies all subscribers about a volume
 133  * change event (creation, removal, re-sizing, re-naming, updating). Returns
 134  * zero in case of success and a negative error code in case of failure.
 135  */
 136 int ubi_volume_notify(struct ubi_device *ubi, struct ubi_volume *vol, int ntype)
 137 {
 138         struct ubi_notification nt;
 139
 140         ubi_do_get_device_info(ubi, &nt.di);
 141         ubi_do_get_volume_info(ubi, vol, &nt.vi);
 142         return blocking_notifier_call_chain(&ubi_notifiers, ntype, &nt);
 143 }
 144
 145 /**
 146  * ubi_notify_all - send a notification to all volumes.
 147  * @ubi: UBI device description object
 148  * @ntype: notification type to send (%UBI_VOLUME_ADDED, etc)
 149  * @nb: the notifier to call
 150  *
 151  * This function walks all volumes of UBI device @ubi and sends the @ntype
 152  * notification for each volume. If @nb is %NULL, then all registered notifiers
 153  * are called, otherwise only the @nb notifier is called. Returns the number of
 154  * sent notifications.
 155  */
 156 int ubi_notify_all(struct ubi_device *ubi, int ntype, struct notifier_block *nb)
 157 {
 158         struct ubi_notification nt;
 159         int i, count = 0;
 160
 161         ubi_do_get_device_info(ubi, &nt.di);
 162
 163         mutex_lock(&ubi->device_mutex);
 164         for (i = 0; i < ubi->vtbl_slots; i++) {
 165                 /*
 166                  * Since the @ubi->device is locked, and we are not going to
 167                  * change @ubi->volumes, we do not have to lock
 168                  * @ubi->volumes_lock.
 169                  */
 170                 if (!ubi->volumes[i])
 171                         continue;
 172
 173                 ubi_do_get_volume_info(ubi, ubi->volumes[i], &nt.vi);
 174                 if (nb)
 175                         nb->notifier_call(nb, ntype, &nt);
 176                 else
 177                         blocking_notifier_call_chain(&ubi_notifiers, ntype,
 178                                                      &nt);
 179                 count += 1;
 180         }
 181         mutex_unlock(&ubi->device_mutex);
 182
 183         return count;
 184 }
 185
 186 /**
 187  * ubi_enumerate_volumes - send "add" notification for all existing volumes.
 188  * @nb: the notifier to call
 189  *
 190  * This function walks all UBI devices and volumes and sends the
 191  * %UBI_VOLUME_ADDED notification for each volume. If @nb is %NULL, then all
 192  * registered notifiers are called, otherwise only the @nb notifier is called.
 193  * Returns the number of sent notifications.
 194  */
 195 int ubi_enumerate_volumes(struct notifier_block *nb)
 196 {
 197         int i, count = 0;
 198
 199         /*
 200          * Since the @ubi_devices_mutex is locked, and we are not going to
 201          * change @ubi_devices, we do not have to lock @ubi_devices_lock.
 202          */
 203         for (i = 0; i < UBI_MAX_DEVICES; i++) {
 204                 struct ubi_device *ubi = ubi_devices[i];
 205
 206                 if (!ubi)
 207                         continue;
 208                 count += ubi_notify_all(ubi, UBI_VOLUME_ADDED, nb);
 209         }
 210
 211         return count;
 212 }
 213
 214 /**
 215  * ubi_get_device - get UBI device.
 216  * @ubi_num: UBI device number
 217  *
 218  * This function returns UBI device description object for UBI device number
 219  * @ubi_num, or %NULL if the device does not exist. This function increases the
 220  * device reference count to prevent removal of the device. In other words, the
 221  * device cannot be removed if its reference count is not zero.
 222  */
 223 struct ubi_device *ubi_get_device(int ubi_num)
 224 {
 225         struct ubi_device *ubi;
 226
 227         spin_lock(&ubi_devices_lock);
 228         ubi = ubi_devices[ubi_num];
 229         if (ubi) {
 230                 ubi_assert(ubi->ref_count >= 0);
 231                 ubi->ref_count += 1;
 232                 get_device(&ubi->dev);
 233         }
 234         spin_unlock(&ubi_devices_lock);
 235
 236         return ubi;
 237 }
 238
 239 /**
 240  * ubi_put_device - drop an UBI device reference.
 241  * @ubi: UBI device description object
 242  */
 243 void ubi_put_device(struct ubi_device *ubi)
 244 {
 245         spin_lock(&ubi_devices_lock);
 246         ubi->ref_count -= 1;
 247         put_device(&ubi->dev);
 248         spin_unlock(&ubi_devices_lock);
 249 }
 250
 251 /**
 252  * ubi_get_by_major - get UBI device by character device major number.
 253  * @major: major number
 254  *
 255  * This function is similar to 'ubi_get_device()', but it searches the device
 256  * by its major number.
 257  */
 258 struct ubi_device *ubi_get_by_major(int major)
 259 {
 260         int i;
 261         struct ubi_device *ubi;
 262
 263         spin_lock(&ubi_devices_lock);
 264         for (i = 0; i < UBI_MAX_DEVICES; i++) {
 265                 ubi = ubi_devices[i];
 266                 if (ubi && MAJOR(ubi->cdev.dev) == major) {
 267                         ubi_assert(ubi->ref_count >= 0);
 268                         ubi->ref_count += 1;
 269                         get_device(&ubi->dev);
 270                         spin_unlock(&ubi_devices_lock);
 271                         return ubi;
 272                 }
 273         }
 274         spin_unlock(&ubi_devices_lock);
 275
 276         return NULL;
 277 }
 278
 279 /**
 280  * ubi_major2num - get UBI device number by character device major number.
 281  * @major: major number
 282  *
 283  * This function searches UBI device number object by its major number. If UBI
 284  * device was not found, this function returns -ENODEV, otherwise the UBI device
 285  * number is returned.
 286  */
 287 int ubi_major2num(int major)
 288 {
 289         int i, ubi_num = -ENODEV;
 290
 291         spin_lock(&ubi_devices_lock);
 292         for (i = 0; i < UBI_MAX_DEVICES; i++) {
 293                 struct ubi_device *ubi = ubi_devices[i];
 294
 295                 if (ubi && MAJOR(ubi->cdev.dev) == major) {
 296                         ubi_num = ubi->ubi_num;
 297                         break;
 298                 }
 299         }
 300         spin_unlock(&ubi_devices_lock);
 301
 302         return ubi_num;
 303 }
 304
 305 /* "Show" method for files in '/<sysfs>/class/ubi/ubiX/' */
 306 static ssize_t dev_attribute_show(struct device *dev,
 307                                   struct device_attribute *attr, char *buf)
 308 {
 309         ssize_t ret;
 310         struct ubi_device *ubi;
 311
 312         /*
 313          * The below code looks weird, but it actually makes sense. We get the
 314          * UBI device reference from the contained 'struct ubi_device'. But it
 315          * is unclear if the device was removed or not yet. Indeed, if the
 316          * device was removed before we increased its reference count,
 317          * 'ubi_get_device()' will return -ENODEV and we fail.
 318          *
 319          * Remember, 'struct ubi_device' is freed in the release function, so
 320          * we still can use 'ubi->ubi_num'.
 321          */
 322         ubi = container_of(dev, struct ubi_device, dev);
 323         ubi = ubi_get_device(ubi->ubi_num);
 324         if (!ubi)
 325                 return -ENODEV;
 326
 327         if (attr == &dev_eraseblock_size)
 328                 ret = sprintf(buf, "%d\n", ubi->leb_size);
 329         else if (attr == &dev_avail_eraseblocks)
 330                 ret = sprintf(buf, "%d\n", ubi->avail_pebs);
 331         else if (attr == &dev_total_eraseblocks)
 332                 ret = sprintf(buf, "%d\n", ubi->good_peb_count);
 333         else if (attr == &dev_volumes_count)
 334                 ret = sprintf(buf, "%d\n", ubi->vol_count - UBI_INT_VOL_COUNT);
 335         else if (attr == &dev_max_ec)
 336                 ret = sprintf(buf, "%d\n", ubi->max_ec);
 337         else if (attr == &dev_reserved_for_bad)
 338                 ret = sprintf(buf, "%d\n", ubi->beb_rsvd_pebs);
 339         else if (attr == &dev_bad_peb_count)
 340                 ret = sprintf(buf, "%d\n", ubi->bad_peb_count);
 341         else if (attr == &dev_max_vol_count)
 342                 ret = sprintf(buf, "%d\n", ubi->vtbl_slots);
 343         else if (attr == &dev_min_io_size)
 344                 ret = sprintf(buf, "%d\n", ubi->min_io_size);
 345         else if (attr == &dev_bgt_enabled)
 346                 ret = sprintf(buf, "%d\n", ubi->thread_enabled);
 347         else if (attr == &dev_mtd_num)
 348                 ret = sprintf(buf, "%d\n", ubi->mtd->index);
 349         else
 350                 ret = -EINVAL;
 351
 352         ubi_put_device(ubi);
 353         return ret;
 354 }
 355
 356 static void dev_release(struct device *dev)
 357 {
 358         struct ubi_device *ubi = container_of(dev, struct ubi_device, dev);
 359
 360         kfree(ubi);
 361 }
 362
 363 /**
 364  * ubi_sysfs_init - initialize sysfs for an UBI device.
 365  * @ubi: UBI device description object
 366  *
 367  * This function returns zero in case of success and a negative error code in
 368  * case of failure.
 369  */
 370 static int ubi_sysfs_init(struct ubi_device *ubi)
 371 {
 372         int err;
 373
 374         ubi->dev.release = dev_release;
 375         ubi->dev.devt = ubi->cdev.dev;
 376         ubi->dev.class = ubi_class;
 377         dev_set_name(&ubi->dev, UBI_NAME_STR"%d", ubi->ubi_num);
 378         err = device_register(&ubi->dev);
 379         if (err)
 380                 return err;
 381
 382         err = device_create_file(&ubi->dev, &dev_eraseblock_size);
 383         if (err)
 384                 return err;
 385         err = device_create_file(&ubi->dev, &dev_avail_eraseblocks);
 386         if (err)
 387                 return err;
 388         err = device_create_file(&ubi->dev, &dev_total_eraseblocks);
 389         if (err)
 390                 return err;
 391         err = device_create_file(&ubi->dev, &dev_volumes_count);
 392         if (err)
 393                 return err;
 394         err = device_create_file(&ubi->dev, &dev_max_ec);
 395         if (err)
 396                 return err;
 397         err = device_create_file(&ubi->dev, &dev_reserved_for_bad);
 398         if (err)
 399                 return err;
 400         err = device_create_file(&ubi->dev, &dev_bad_peb_count);
 401         if (err)
 402                 return err;
 403         err = device_create_file(&ubi->dev, &dev_max_vol_count);
 404         if (err)
 405                 return err;
 406         err = device_create_file(&ubi->dev, &dev_min_io_size);
 407         if (err)
 408                 return err;
 409         err = device_create_file(&ubi->dev, &dev_bgt_enabled);
 410         if (err)
 411                 return err;
 412         err = device_create_file(&ubi->dev, &dev_mtd_num);
 413         return err;
 414 }
 415
 416 /**
 417  * ubi_sysfs_close - close sysfs for an UBI device.
 418  * @ubi: UBI device description object
 419  */
 420 static void ubi_sysfs_close(struct ubi_device *ubi)
 421 {
 422         device_remove_file(&ubi->dev, &dev_mtd_num);
 423         device_remove_file(&ubi->dev, &dev_bgt_enabled);
 424         device_remove_file(&ubi->dev, &dev_min_io_size);
 425         device_remove_file(&ubi->dev, &dev_max_vol_count);
 426         device_remove_file(&ubi->dev, &dev_bad_peb_count);
 427         device_remove_file(&ubi->dev, &dev_reserved_for_bad);
 428         device_remove_file(&ubi->dev, &dev_max_ec);
 429         device_remove_file(&ubi->dev, &dev_volumes_count);
 430         device_remove_file(&ubi->dev, &dev_total_eraseblocks);
 431         device_remove_file(&ubi->dev, &dev_avail_eraseblocks);
 432         device_remove_file(&ubi->dev, &dev_eraseblock_size);
 433         device_unregister(&ubi->dev);
 434 }
 435
 436 /**
 437  * kill_volumes - destroy all volumes.
 438  * @ubi: UBI device description object
 439  */
 440 static void kill_volumes(struct ubi_device *ubi)
 441 {
 442         int i;
 443
 444         for (i = 0; i < ubi->vtbl_slots; i++)
 445                 if (ubi->volumes[i])
 446                         ubi_free_volume(ubi, ubi->volumes[i]);
 447 }
 448
 449 /**
 450  * free_user_volumes - free all user volumes.
 451  * @ubi: UBI device description object
 452  *
 453  * Normally the volumes are freed at the release function of the volume device
 454  * objects. However, on error paths the volumes have to be freed before the
 455  * device objects have been initialized.
 456  */
 457 static void free_user_volumes(struct ubi_device *ubi)
 458 {
 459         int i;
 460
 461         for (i = 0; i < ubi->vtbl_slots; i++)
 462                 if (ubi->volumes[i]) {
 463                         kfree(ubi->volumes[i]->eba_tbl);
 464                         kfree(ubi->volumes[i]);
 465                 }
 466 }
 467
 468 /**
 469  * uif_init - initialize user interfaces for an UBI device.
 470  * @ubi: UBI device description object
 471  *
 472  * This function returns zero in case of success and a negative error code in
 473  * case of failure. Note, this function destroys all volumes if it fails.
 474  */
 475 static int uif_init(struct ubi_device *ubi)
 476 {
 477         int i, err;
 478         dev_t dev;
 479
 480         sprintf(ubi->ubi_name, UBI_NAME_STR "%d", ubi->ubi_num);
 481
 482         /*
 483          * Major numbers for the UBI character devices are allocated
 484          * dynamically. Major numbers of volume character devices are
 485          * equivalent to ones of the corresponding UBI character device. Minor
 486          * numbers of UBI character devices are 0, while minor numbers of
 487          * volume character devices start from 1. Thus, we allocate one major
 488          * number and ubi->vtbl_slots + 1 minor numbers.
 489          */
 490         err = alloc_chrdev_region(&dev, 0, ubi->vtbl_slots + 1, ubi->ubi_name);
 491         if (err) {
 492                 ubi_err("cannot register UBI character devices");
 493                 return err;
 494         }
 495
 496         ubi_assert(MINOR(dev) == 0);
 497         cdev_init(&ubi->cdev, &ubi_cdev_operations);
 498         dbg_gen("%s major is %u", ubi->ubi_name, MAJOR(dev));
 499         ubi->cdev.owner = THIS_MODULE;
 500
 501         err = cdev_add(&ubi->cdev, dev, 1);
 502         if (err) {
 503                 ubi_err("cannot add character device");
 504                 goto out_unreg;
 505         }
 506
 507         err = ubi_sysfs_init(ubi);
 508         if (err)
 509                 goto out_sysfs;
 510
 511         for (i = 0; i < ubi->vtbl_slots; i++)
 512                 if (ubi->volumes[i]) {
 513                         err = ubi_add_volume(ubi, ubi->volumes[i]);
 514                         if (err) {
 515                                 ubi_err("cannot add volume %d", i);
 516                                 goto out_volumes;
 517                         }
 518                 }
 519
 520         return 0;
 521
 522 out_volumes:
 523         kill_volumes(ubi);
 524 out_sysfs:
 525         ubi_sysfs_close(ubi);
 526         cdev_del(&ubi->cdev);
 527 out_unreg:
 528         unregister_chrdev_region(ubi->cdev.dev, ubi->vtbl_slots + 1);
 529         ubi_err("cannot initialize UBI %s, error %d", ubi->ubi_name, err);
 530         return err;
 531 }
 532
 533 /**
 534  * uif_close - close user interfaces for an UBI device.
 535  * @ubi: UBI device description object
 536  *
 537  * Note, since this function un-registers UBI volume device objects (@vol->dev),
 538  * the memory allocated voe the volumes is freed as well (in the release
 539  * function).
 540  */
 541 static void uif_close(struct ubi_device *ubi)
 542 {
 543         kill_volumes(ubi);
 544         ubi_sysfs_close(ubi);
 545         cdev_del(&ubi->cdev);
 546         unregister_chrdev_region(ubi->cdev.dev, ubi->vtbl_slots + 1);
 547 }
 548
 549 /**
 550  * free_internal_volumes - free internal volumes.
 551  * @ubi: UBI device description object
 552  */
 553 static void free_internal_volumes(struct ubi_device *ubi)
 554 {
 555         int i;
 556
 557         for (i = ubi->vtbl_slots;
 558              i < ubi->vtbl_slots + UBI_INT_VOL_COUNT; i++) {
 559                 kfree(ubi->volumes[i]->eba_tbl);
 560                 kfree(ubi->volumes[i]);
 561         }
 562 }
 563
 564 /**
 565  * attach_by_scanning - attach an MTD device using scanning method.
 566  * @ubi: UBI device descriptor
 567  *
 568  * This function returns zero in case of success and a negative error code in
 569  * case of failure.
 570  *
 571  * Note, currently this is the only method to attach UBI devices. Hopefully in
 572  * the future we'll have more scalable attaching methods and avoid full media
 573  * scanning. But even in this case scanning will be needed as a fall-back
 574  * attaching method if there are some on-flash table corruptions.
 575  */
 576 static int attach_by_scanning(struct ubi_device *ubi)
 577 {
 578         int err;
 579         struct ubi_scan_info *si;
 580
 581         si = ubi_scan(ubi);
 582         if (IS_ERR(si))
 583                 return PTR_ERR(si);
 584
 585         ubi->bad_peb_count = si->bad_peb_count;
 586         ubi->good_peb_count = ubi->peb_count - ubi->bad_peb_count;
 587         ubi->max_ec = si->max_ec;
 588         ubi->mean_ec = si->mean_ec;
 589
 590         err = ubi_read_volume_table(ubi, si);
 591         if (err)
 592                 goto out_si;
 593
 594         err = ubi_wl_init_scan(ubi, si);
 595         if (err)
 596                 goto out_vtbl;
 597
 598         err = ubi_eba_init_scan(ubi, si);
 599         if (err)
 600                 goto out_wl;
 601
 602         ubi_scan_destroy_si(si);
 603         return 0;
 604
 605 out_wl:
 606         ubi_wl_close(ubi);
 607 out_vtbl:
 608         free_internal_volumes(ubi);
 609         vfree(ubi->vtbl);
 610 out_si:
 611         ubi_scan_destroy_si(si);
 612         return err;
 613 }
 614
 615 /**
 616  * io_init - initialize I/O sub-system for a given UBI device.
 617  * @ubi: UBI device description object
 618  *
 619  * If @ubi->vid_hdr_offset or @ubi->leb_start is zero, default offsets are
 620  * assumed:
 621  *   o EC header is always at offset zero - this cannot be changed;
 622  *   o VID header starts just after the EC header at the closest address
 623  *     aligned to @io->hdrs_min_io_size;
 624  *   o data starts just after the VID header at the closest address aligned to
 625  *     @io->min_io_size
 626  *
 627  * This function returns zero in case of success and a negative error code in
 628  * case of failure.
 629  */
 630 static int io_init(struct ubi_device *ubi)
 631 {
 632         if (ubi->mtd->numeraseregions != 0) {
 633                 /*
 634                  * Some flashes have several erase regions. Different regions
 635                  * may have different eraseblock size and other
 636                  * characteristics. It looks like mostly multi-region flashes
 637                  * have one "main" region and one or more small regions to
 638                  * store boot loader code or boot parameters or whatever. I
 639                  * guess we should just pick the largest region. But this is
 640                  * not implemented.
 641                  */
 642                 ubi_err("multiple regions, not implemented");
 643                 return -EINVAL;
 644         }
 645
 646         if (ubi->vid_hdr_offset < 0)
 647                 return -EINVAL;
 648
 649         /*
 650          * Note, in this implementation we support MTD devices with 0x7FFFFFFF
 651          * physical eraseblocks maximum.
 652          */
 653
 654         ubi->peb_size   = ubi->mtd->erasesize;
 655         ubi->peb_count  = mtd_div_by_eb(ubi->mtd->size, ubi->mtd);
 656         ubi->flash_size = ubi->mtd->size;
 657
 658         if (ubi->mtd->block_isbad && ubi->mtd->block_markbad)
 659                 ubi->bad_allowed = 1;
 660
 661         if (ubi->mtd->type == MTD_NORFLASH) {
 662                 ubi_assert(ubi->mtd->writesize == 1);
 663                 ubi->nor_flash = 1;
 664         }
 665
 666         ubi->min_io_size = ubi->mtd->writesize;
 667         ubi->hdrs_min_io_size = ubi->mtd->writesize >> ubi->mtd->subpage_sft;
 668
 669         /*
 670          * Make sure minimal I/O unit is power of 2. Note, there is no
 671          * fundamental reason for this assumption. It is just an optimization
 672          * which allows us to avoid costly division operations.
 673          */
 674         if (!is_power_of_2(ubi->min_io_size)) {
 675                 ubi_err("min. I/O unit (%d) is not power of 2",
 676                         ubi->min_io_size);
 677                 return -EINVAL;
 678         }
 679
 680         ubi_assert(ubi->hdrs_min_io_size > 0);
 681         ubi_assert(ubi->hdrs_min_io_size <= ubi->min_io_size);
 682         ubi_assert(ubi->min_io_size % ubi->hdrs_min_io_size == 0);
 683
 684         /* Calculate default aligned sizes of EC and VID headers */
 685         ubi->ec_hdr_alsize = ALIGN(UBI_EC_HDR_SIZE, ubi->hdrs_min_io_size);
 686         ubi->vid_hdr_alsize = ALIGN(UBI_VID_HDR_SIZE, ubi->hdrs_min_io_size);
 687
 688         dbg_msg("min_io_size      %d", ubi->min_io_size);
 689         dbg_msg("hdrs_min_io_size %d", ubi->hdrs_min_io_size);
 690         dbg_msg("ec_hdr_alsize    %d", ubi->ec_hdr_alsize);
 691         dbg_msg("vid_hdr_alsize   %d", ubi->vid_hdr_alsize);
 692
 693         if (ubi->vid_hdr_offset == 0)
 694                 /* Default offset */
 695                 ubi->vid_hdr_offset = ubi->vid_hdr_aloffset =
 696                                       ubi->ec_hdr_alsize;
 697         else {
 698                 ubi->vid_hdr_aloffset = ubi->vid_hdr_offset &
 699                                                 ~(ubi->hdrs_min_io_size - 1);
 700                 ubi->vid_hdr_shift = ubi->vid_hdr_offset -
 701                                                 ubi->vid_hdr_aloffset;
 702         }
 703
 704         /* Similar for the data offset */
 705         ubi->leb_start = ubi->vid_hdr_offset + UBI_EC_HDR_SIZE;
 706         ubi->leb_start = ALIGN(ubi->leb_start, ubi->min_io_size);
 707
 708         dbg_msg("vid_hdr_offset   %d", ubi->vid_hdr_offset);
 709         dbg_msg("vid_hdr_aloffset %d", ubi->vid_hdr_aloffset);
 710         dbg_msg("vid_hdr_shift    %d", ubi->vid_hdr_shift);
 711         dbg_msg("leb_start        %d", ubi->leb_start);
 712
 713         /* The shift must be aligned to 32-bit boundary */
 714         if (ubi->vid_hdr_shift % 4) {
 715                 ubi_err("unaligned VID header shift %d",
 716                         ubi->vid_hdr_shift);
 717                 return -EINVAL;
 718         }
 719
 720         /* Check sanity */
 721         if (ubi->vid_hdr_offset < UBI_EC_HDR_SIZE ||
 722             ubi->leb_start < ubi->vid_hdr_offset + UBI_VID_HDR_SIZE ||
 723             ubi->leb_start > ubi->peb_size - UBI_VID_HDR_SIZE ||
 724             ubi->leb_start & (ubi->min_io_size - 1)) {
 725                 ubi_err("bad VID header (%d) or data offsets (%d)",
 726                         ubi->vid_hdr_offset, ubi->leb_start);
 727                 return -EINVAL;
 728         }
 729
 730         /*
 731          * Set maximum amount of physical erroneous eraseblocks to be 10%.
 732          * Erroneous PEB are those which have read errors.
 733          */
 734         ubi->max_erroneous = ubi->peb_count / 10;
 735         if (ubi->max_erroneous < 16)
 736                 ubi->max_erroneous = 16;
 737         dbg_msg("max_erroneous    %d", ubi->max_erroneous);
 738
 739         /*
 740          * It may happen that EC and VID headers are situated in one minimal
 741          * I/O unit. In this case we can only accept this UBI image in
 742          * read-only mode.
 743          */
 744         if (ubi->vid_hdr_offset + UBI_VID_HDR_SIZE <= ubi->hdrs_min_io_size) {
 745                 ubi_warn("EC and VID headers are in the same minimal I/O unit, "
 746                          "switch to read-only mode");
 747                 ubi->ro_mode = 1;
 748         }
 749
 750         ubi->leb_size = ubi->peb_size - ubi->leb_start;
 751
 752         if (!(ubi->mtd->flags & MTD_WRITEABLE)) {
 753                 ubi_msg("MTD device %d is write-protected, attach in "
 754                         "read-only mode", ubi->mtd->index);
 755                 ubi->ro_mode = 1;
 756         }
 757
 758         ubi_msg("physical eraseblock size:   %d bytes (%d KiB)",
 759                 ubi->peb_size, ubi->peb_size >> 10);
 760         ubi_msg("logical eraseblock size:    %d bytes", ubi->leb_size);
 761         ubi_msg("smallest flash I/O unit:    %d", ubi->min_io_size);
 762         if (ubi->hdrs_min_io_size != ubi->min_io_size)
 763                 ubi_msg("sub-page size:              %d",
 764                         ubi->hdrs_min_io_size);
 765         ubi_msg("VID header offset:          %d (aligned %d)",
 766                 ubi->vid_hdr_offset, ubi->vid_hdr_aloffset);
 767         ubi_msg("data offset:                %d", ubi->leb_start);
 768
 769         /*
 770          * Note, ideally, we have to initialize ubi->bad_peb_count here. But
 771          * unfortunately, MTD does not provide this information. We should loop
 772          * over all physical eraseblocks and invoke mtd->block_is_bad() for
 773          * each physical eraseblock. So, we skip ubi->bad_peb_count
 774          * uninitialized and initialize it after scanning.
 775          */
 776
 777         return 0;
 778 }
 779
 780 /**
 781  * autoresize - re-size the volume which has the "auto-resize" flag set.
 782  * @ubi: UBI device description object
 783  * @vol_id: ID of the volume to re-size
 784  *
 785  * This function re-sizes the volume marked by the @UBI_VTBL_AUTORESIZE_FLG in
 786  * the volume table to the largest possible size. See comments in ubi-header.h
 787  * for more description of the flag. Returns zero in case of success and a
 788  * negative error code in case of failure.
 789  */
 790 static int autoresize(struct ubi_device *ubi, int vol_id)
 791 {
 792         struct ubi_volume_desc desc;
 793         struct ubi_volume *vol = ubi->volumes[vol_id];
 794         int err, old_reserved_pebs = vol->reserved_pebs;
 795
 796         /*
 797          * Clear the auto-resize flag in the volume in-memory copy of the
 798          * volume table, and 'ubi_resize_volume()' will propagate this change
 799          * to the flash.
 800          */
 801         ubi->vtbl[vol_id].flags &= ~UBI_VTBL_AUTORESIZE_FLG;
 802
 803         if (ubi->avail_pebs == 0) {
 804                 struct ubi_vtbl_record vtbl_rec;
 805
 806                 /*
 807                  * No available PEBs to re-size the volume, clear the flag on
 808                  * flash and exit.
 809                  */
 810                 memcpy(&vtbl_rec, &ubi->vtbl[vol_id],
 811                        sizeof(struct ubi_vtbl_record));
 812                 err = ubi_change_vtbl_record(ubi, vol_id, &vtbl_rec);
 813                 if (err)
 814                         ubi_err("cannot clean auto-resize flag for volume %d",
 815                                 vol_id);
 816         } else {
 817                 desc.vol = vol;
 818                 err = ubi_resize_volume(&desc,
 819                                         old_reserved_pebs + ubi->avail_pebs);
 820                 if (err)
 821                         ubi_err("cannot auto-resize volume %d", vol_id);
 822         }
 823
 824         if (err)
 825                 return err;
 826
 827         ubi_msg("volume %d (\"%s\") re-sized from %d to %d LEBs", vol_id,
 828                 vol->name, old_reserved_pebs, vol->reserved_pebs);
 829         return 0;
 830 }
 831
 832 /**
 833  * ubi_reboot_notifier - halt UBI transactions immediately prior to a reboot.
 834  * @n: reboot notifier object
 835  * @state: SYS_RESTART, SYS_HALT, or SYS_POWER_OFF
 836  * @cmd: pointer to command string for RESTART2
 837  *
 838  * This function stops the UBI background thread so that the flash device
 839  * remains quiescent when Linux restarts the system. Any queued work will be
 840  * discarded, but this function will block until do_work() finishes if an
 841  * operation is already in progress.
 842  *
 843  * This function solves a real-life problem observed on NOR flashes when an
 844  * PEB erase operation starts, then the system is rebooted before the erase is
 845  * finishes, and the boot loader gets confused and dies. So we prefer to finish
 846  * the ongoing operation before rebooting.
 847  */
 848 static int ubi_reboot_notifier(struct notifier_block *n, unsigned long state,
 849                                void *cmd)
 850 {
 851         struct ubi_device *ubi;
 852
 853         ubi = container_of(n, struct ubi_device, reboot_notifier);
 854         if (ubi->bgt_thread)
 855                 kthread_stop(ubi->bgt_thread);
 856         ubi_sync(ubi->ubi_num);
 857         return NOTIFY_DONE;
 858 }
 859
 860 /**
 861  * ubi_attach_mtd_dev - attach an MTD device.
 862  * @mtd: MTD device description object
 863  * @ubi_num: number to assign to the new UBI device
 864  * @vid_hdr_offset: VID header offset
 865  *
 866  * This function attaches MTD device @mtd_dev to UBI and assign @ubi_num number
 867  * to the newly created UBI device, unless @ubi_num is %UBI_DEV_NUM_AUTO, in
 868  * which case this function finds a vacant device number and assigns it
 869  * automatically. Returns the new UBI device number in case of success and a
 870  * negative error code in case of failure.
 871  *
 872  * Note, the invocations of this function has to be serialized by the
 873  * @ubi_devices_mutex.
 874  */
 875 int ubi_attach_mtd_dev(struct mtd_info *mtd, int ubi_num, int vid_hdr_offset)
 876 {
 877         struct ubi_device *ubi;
 878         int i, err, do_free = 1;
 879
 880         /*
 881          * Check if we already have the same MTD device attached.
 882          *
 883          * Note, this function assumes that UBI devices creations and deletions
 884          * are serialized, so it does not take the &ubi_devices_lock.
 885          */
 886         for (i = 0; i < UBI_MAX_DEVICES; i++) {
 887                 ubi = ubi_devices[i];
 888                 if (ubi && mtd->index == ubi->mtd->index) {
 889                         dbg_err("mtd%d is already attached to ubi%d",
 890                                 mtd->index, i);
 891                         return -EEXIST;
 892                 }
 893         }
 894
 895         /*
 896          * Make sure this MTD device is not emulated on top of an UBI volume
 897          * already. Well, generally this recursion works fine, but there are
 898          * different problems like the UBI module takes a reference to itself
 899          * by attaching (and thus, opening) the emulated MTD device. This
 900          * results in inability to unload the module. And in general it makes
 901          * no sense to attach emulated MTD devices, so we prohibit this.
 902          */
 903         if (mtd->type == MTD_UBIVOLUME) {
 904                 ubi_err("refuse attaching mtd%d - it is already emulated on "
 905                         "top of UBI", mtd->index);
 906                 return -EINVAL;
 907         }
 908
 909         if (ubi_num == UBI_DEV_NUM_AUTO) {
 910                 /* Search for an empty slot in the @ubi_devices array */
 911                 for (ubi_num = 0; ubi_num < UBI_MAX_DEVICES; ubi_num++)
 912                         if (!ubi_devices[ubi_num])
 913                                 break;
 914                 if (ubi_num == UBI_MAX_DEVICES) {
 915                         dbg_err("only %d UBI devices may be created",
 916                                 UBI_MAX_DEVICES);
 917                         return -ENFILE;
 918                 }
 919         } else {
 920                 if (ubi_num >= UBI_MAX_DEVICES)
 921                         return -EINVAL;
 922
 923                 /* Make sure ubi_num is not busy */
 924                 if (ubi_devices[ubi_num]) {
 925                         dbg_err("ubi%d already exists", ubi_num);
 926                         return -EEXIST;
 927                 }
 928         }
 929
 930         ubi = kzalloc(sizeof(struct ubi_device), GFP_KERNEL);
 931         if (!ubi)
 932                 return -ENOMEM;
 933
 934         ubi->mtd = mtd;
 935         ubi->ubi_num = ubi_num;
 936         ubi->vid_hdr_offset = vid_hdr_offset;
 937         ubi->autoresize_vol_id = -1;
 938
 939         mutex_init(&ubi->buf_mutex);
 940         mutex_init(&ubi->ckvol_mutex);
 941         mutex_init(&ubi->device_mutex);
 942         spin_lock_init(&ubi->volumes_lock);
 943
 944         ubi_msg("attaching mtd%d to ubi%d", mtd->index, ubi_num);
 945
 946         err = io_init(ubi);
 947         if (err)
 948                 goto out_free;
 949
 950         err = -ENOMEM;
 951         ubi->peb_buf1 = vmalloc(ubi->peb_size);
 952         if (!ubi->peb_buf1)
 953                 goto out_free;
 954
 955         ubi->peb_buf2 = vmalloc(ubi->peb_size);
 956         if (!ubi->peb_buf2)
 957                 goto out_free;
 958
 959 #ifdef CONFIG_MTD_UBI_DEBUG_PARANOID
 960         mutex_init(&ubi->dbg_buf_mutex);
 961         ubi->dbg_peb_buf = vmalloc(ubi->peb_size);
 962         if (!ubi->dbg_peb_buf)
 963                 goto out_free;
 964 #endif
 965
 966         err = attach_by_scanning(ubi);
 967         if (err) {
 968                 dbg_err("failed to attach by scanning, error %d", err);
 969                 goto out_free;
 970         }
 971
 972         if (ubi->autoresize_vol_id != -1) {
 973                 err = autoresize(ubi, ubi->autoresize_vol_id);
 974                 if (err)
 975                         goto out_detach;
 976         }
 977
 978         err = uif_init(ubi);
 979         if (err)
 980                 goto out_nofree;
 981
 982         ubi->bgt_thread = kthread_create(ubi_thread, ubi, ubi->bgt_name);
 983         if (IS_ERR(ubi->bgt_thread)) {
 984                 err = PTR_ERR(ubi->bgt_thread);
 985                 ubi_err("cannot spawn \"%s\", error %d", ubi->bgt_name,
 986                         err);
 987                 goto out_uif;
 988         }
 989
 990         ubi_msg("attached mtd%d to ubi%d", mtd->index, ubi_num);
 991         ubi_msg("MTD device name:            \"%s\"", mtd->name);
 992         ubi_msg("MTD device size:            %llu MiB", ubi->flash_size >> 20);
 993         ubi_msg("number of good PEBs:        %d", ubi->good_peb_count);
 994         ubi_msg("number of bad PEBs:         %d", ubi->bad_peb_count);
 995         ubi_msg("max. allowed volumes:       %d", ubi->vtbl_slots);
 996         ubi_msg("wear-leveling threshold:    %d", CONFIG_MTD_UBI_WL_THRESHOLD);
 997         ubi_msg("number of internal volumes: %d", UBI_INT_VOL_COUNT);
 998         ubi_msg("number of user volumes:     %d",
 999                 ubi->vol_count - UBI_INT_VOL_COUNT);
1000         ubi_msg("available PEBs:             %d", ubi->avail_pebs);
1001         ubi_msg("total number of reserved PEBs: %d", ubi->rsvd_pebs);
1002         ubi_msg("number of PEBs reserved for bad PEB handling: %d",
1003                 ubi->beb_rsvd_pebs);
1004         ubi_msg("max/mean erase counter: %d/%d", ubi->max_ec, ubi->mean_ec);
1005         ubi_msg("image sequence number: %d", ubi->image_seq);
1006
1007         /*
1008          * The below lock makes sure we do not race with 'ubi_thread()' which
1009          * checks @ubi->thread_enabled. Otherwise we may fail to wake it up.
1010          */
1011         spin_lock(&ubi->wl_lock);
1012         if (!DBG_DISABLE_BGT)
1013                 ubi->thread_enabled = 1;
1014         wake_up_process(ubi->bgt_thread);
1015         spin_unlock(&ubi->wl_lock);
1016
1017         /* Flash device priority is 0 - UBI needs to shut down first */
1018         ubi->reboot_notifier.priority = 1;
1019         ubi->reboot_notifier.notifier_call = ubi_reboot_notifier;
1020         register_reboot_notifier(&ubi->reboot_notifier);
1021
1022         ubi_devices[ubi_num] = ubi;
1023         ubi_notify_all(ubi, UBI_VOLUME_ADDED, NULL);
1024         return ubi_num;
1025
1026 out_uif:
1027         uif_close(ubi);
1028 out_nofree:
1029         do_free = 0;
1030 out_detach:
1031         ubi_wl_close(ubi);
1032         if (do_free)
1033                 free_user_volumes(ubi);
1034         free_internal_volumes(ubi);
1035         vfree(ubi->vtbl);
1036 out_free:
1037         vfree(ubi->peb_buf1);
1038         vfree(ubi->peb_buf2);
1039 #ifdef CONFIG_MTD_UBI_DEBUG_PARANOID
1040         vfree(ubi->dbg_peb_buf);
1041 #endif
1042         kfree(ubi);
1043         return err;
1044 }
1045
1046 /**
1047  * ubi_detach_mtd_dev - detach an MTD device.
1048  * @ubi_num: UBI device number to detach from
1049  * @anyway: detach MTD even if device reference count is not zero
1050  *
1051  * This function destroys an UBI device number @ubi_num and detaches the
1052  * underlying MTD device. Returns zero in case of success and %-EBUSY if the
1053  * UBI device is busy and cannot be destroyed, and %-EINVAL if it does not
1054  * exist.
1055  *
1056  * Note, the invocations of this function has to be serialized by the
1057  * @ubi_devices_mutex.
1058  */
1059 int ubi_detach_mtd_dev(int ubi_num, int anyway)
1060 {
1061         struct ubi_device *ubi;
1062
1063         if (ubi_num < 0 || ubi_num >= UBI_MAX_DEVICES)
1064                 return -EINVAL;
1065
1066         ubi = ubi_get_device(ubi_num);
1067         if (!ubi)
1068                 return -EINVAL;
1069
1070         spin_lock(&ubi_devices_lock);
1071         put_device(&ubi->dev);
1072         ubi->ref_count -= 1;
1073         if (ubi->ref_count) {
1074                 if (!anyway) {
1075                         spin_unlock(&ubi_devices_lock);
1076                         return -EBUSY;
1077                 }
1078                 /* This may only happen if there is a bug */
1079                 ubi_err("%s reference count %d, destroy anyway",
1080                         ubi->ubi_name, ubi->ref_count);
1081         }
1082         ubi_devices[ubi_num] = NULL;
1083         spin_unlock(&ubi_devices_lock);
1084
1085         ubi_assert(ubi_num == ubi->ubi_num);
1086         ubi_notify_all(ubi, UBI_VOLUME_REMOVED, NULL);
1087         dbg_msg("detaching mtd%d from ubi%d", ubi->mtd->index, ubi_num);
1088
1089         /*
1090          * Before freeing anything, we have to stop the background thread to
1091          * prevent it from doing anything on this device while we are freeing.
1092          */
1093         unregister_reboot_notifier(&ubi->reboot_notifier);
1094         if (ubi->bgt_thread)
1095                 kthread_stop(ubi->bgt_thread);
1096
1097         /*
1098          * Get a reference to the device in order to prevent 'dev_release()'
1099          * from freeing @ubi object.
1100          */
1101         get_device(&ubi->dev);
1102
1103         uif_close(ubi);
1104         ubi_wl_close(ubi);
1105         free_internal_volumes(ubi);
1106         vfree(ubi->vtbl);
1107         put_mtd_device(ubi->mtd);
1108         vfree(ubi->peb_buf1);
1109         vfree(ubi->peb_buf2);
1110 #ifdef CONFIG_MTD_UBI_DEBUG_PARANOID
1111         vfree(ubi->dbg_peb_buf);
1112 #endif
1113         ubi_msg("mtd%d is detached from ubi%d", ubi->mtd->index, ubi->ubi_num);
1114         put_device(&ubi->dev);
1115         return 0;
1116 }
1117
1118 /**
1119  * find_mtd_device - open an MTD device by its name or number.
1120  * @mtd_dev: name or number of the device
1121  *
1122  * This function tries to open and MTD device described by @mtd_dev string,
1123  * which is first treated as an ASCII number, and if it is not true, it is
1124  * treated as MTD device name. Returns MTD device description object in case of
1125  * success and a negative error code in case of failure.
1126  */
1127 static struct mtd_info * __init open_mtd_device(const char *mtd_dev)
1128 {
1129         struct mtd_info *mtd;
1130         int mtd_num;
1131         char *endp;
1132
1133         mtd_num = simple_strtoul(mtd_dev, &endp, 0);
1134         if (*endp != '\0' || mtd_dev == endp) {
1135                 /*
1136                  * This does not look like an ASCII integer, probably this is
1137                  * MTD device name.
1138                  */
1139                 mtd = get_mtd_device_nm(mtd_dev);
1140         } else
1141                 mtd = get_mtd_device(NULL, mtd_num);
1142
1143         return mtd;
1144 }
1145
1146 static int __init ubi_init(void)
1147 {
1148         int err, i, k;
1149
1150         /* Ensure that EC and VID headers have correct size */
1151         BUILD_BUG_ON(sizeof(struct ubi_ec_hdr) != 64);
1152         BUILD_BUG_ON(sizeof(struct ubi_vid_hdr) != 64);
1153
1154         if (mtd_devs > UBI_MAX_DEVICES) {
1155                 ubi_err("too many MTD devices, maximum is %d", UBI_MAX_DEVICES);
1156                 return -EINVAL;
1157         }
1158
1159         /* Create base sysfs directory and sysfs files */
1160         ubi_class = class_create(THIS_MODULE, UBI_NAME_STR);
1161         if (IS_ERR(ubi_class)) {
1162                 err = PTR_ERR(ubi_class);
1163                 ubi_err("cannot create UBI class");
1164                 goto out;
1165         }
1166
1167         err = class_create_file(ubi_class, &ubi_version);
1168         if (err) {
1169                 ubi_err("cannot create sysfs file");
1170                 goto out_class;
1171         }
1172
1173         err = misc_register(&ubi_ctrl_cdev);
1174         if (err) {
1175                 ubi_err("cannot register device");
1176                 goto out_version;
1177         }
1178
1179         ubi_wl_entry_slab = kmem_cache_create("ubi_wl_entry_slab",
1180                                               sizeof(struct ubi_wl_entry),
1181                                               0, 0, NULL);
1182         if (!ubi_wl_entry_slab)
1183                 goto out_dev_unreg;
1184
1185         /* Attach MTD devices */
1186         for (i = 0; i < mtd_devs; i++) {
1187                 struct mtd_dev_param *p = &mtd_dev_param[i];
1188                 struct mtd_info *mtd;
1189
1190                 cond_resched();
1191
1192                 mtd = open_mtd_device(p->name);
1193                 if (IS_ERR(mtd)) {
1194                         err = PTR_ERR(mtd);
1195                         goto out_detach;
1196                 }
1197
1198                 mutex_lock(&ubi_devices_mutex);
1199                 err = ubi_attach_mtd_dev(mtd, UBI_DEV_NUM_AUTO,
1200                                          p->vid_hdr_offs);
1201                 mutex_unlock(&ubi_devices_mutex);
1202                 if (err < 0) {
1203                         put_mtd_device(mtd);
1204                         ubi_err("cannot attach mtd%d", mtd->index);
1205                         goto out_detach;
1206                 }
1207         }
1208
1209         return 0;
1210
1211 out_detach:
1212         for (k = 0; k < i; k++)
1213                 if (ubi_devices[k]) {
1214                         mutex_lock(&ubi_devices_mutex);
1215                         ubi_detach_mtd_dev(ubi_devices[k]->ubi_num, 1);
1216                         mutex_unlock(&ubi_devices_mutex);
1217                 }
1218         kmem_cache_destroy(ubi_wl_entry_slab);
1219 out_dev_unreg:
1220         misc_deregister(&ubi_ctrl_cdev);
1221 out_version:
1222         class_remove_file(ubi_class, &ubi_version);
1223 out_class:
1224         class_destroy(ubi_class);
1225 out:
1226         ubi_err("UBI error: cannot initialize UBI, error %d", err);
1227         return err;
1228 }
1229 module_init(ubi_init);
1230
1231 static void __exit ubi_exit(void)
1232 {
1233         int i;
1234
1235         for (i = 0; i < UBI_MAX_DEVICES; i++)
1236                 if (ubi_devices[i]) {
1237                         mutex_lock(&ubi_devices_mutex);
1238                         ubi_detach_mtd_dev(ubi_devices[i]->ubi_num, 1);
1239                         mutex_unlock(&ubi_devices_mutex);
1240                 }
1241         kmem_cache_destroy(ubi_wl_entry_slab);
1242         misc_deregister(&ubi_ctrl_cdev);
1243         class_remove_file(ubi_class, &ubi_version);
1244         class_destroy(ubi_class);
1245 }
1246 module_exit(ubi_exit);
1247
1248 /**
1249  * bytes_str_to_int - convert a number of bytes string into an integer.
1250  * @str: the string to convert
1251  *
1252  * This function returns positive resulting integer in case of success and a
1253  * negative error code in case of failure.
1254  */
1255 static int __init bytes_str_to_int(const char *str)
1256 {
1257         char *endp;
1258         unsigned long result;
1259
1260         result = simple_strtoul(str, &endp, 0);
1261         if (str == endp || result >= INT_MAX) {
1262                 printk(KERN_ERR "UBI error: incorrect bytes count: \"%s\"\n",
1263                        str);
1264                 return -EINVAL;
1265         }
1266
1267         switch (*endp) {
1268         case 'G':
1269                 result *= 1024;
1270         case 'M':
1271                 result *= 1024;
1272         case 'K':
1273                 result *= 1024;
1274                 if (endp[1] == 'i' && endp[2] == 'B')
1275                         endp += 2;
1276         case '\0':
1277                 break;
1278         default:
1279                 printk(KERN_ERR "UBI error: incorrect bytes count: \"%s\"\n",
1280                        str);
1281                 return -EINVAL;
1282         }
1283
1284         return result;
1285 }
1286
1287 /**
1288  * ubi_mtd_param_parse - parse the 'mtd=' UBI parameter.
1289  * @val: the parameter value to parse
1290  * @kp: not used
1291  *
1292  * This function returns zero in case of success and a negative error code in
1293  * case of error.
1294  */
1295 static int __init ubi_mtd_param_parse(const char *val, struct kernel_param *kp)
1296 {
1297         int i, len;
1298         struct mtd_dev_param *p;
1299         char buf[MTD_PARAM_LEN_MAX];
1300         char *pbuf = &buf[0];
1301         char *tokens[2] = {NULL, NULL};
1302
1303         if (!val)
1304                 return -EINVAL;
1305
1306         if (mtd_devs == UBI_MAX_DEVICES) {
1307                 printk(KERN_ERR "UBI error: too many parameters, max. is %d\n",
1308                        UBI_MAX_DEVICES);
1309                 return -EINVAL;
1310         }
1311
1312         len = strnlen(val, MTD_PARAM_LEN_MAX);
1313         if (len == MTD_PARAM_LEN_MAX) {
1314                 printk(KERN_ERR "UBI error: parameter \"%s\" is too long, "
1315                        "max. is %d\n", val, MTD_PARAM_LEN_MAX);
1316                 return -EINVAL;
1317         }
1318
1319         if (len == 0) {
1320                 printk(KERN_WARNING "UBI warning: empty 'mtd=' parameter - "
1321                        "ignored\n");
1322                 return 0;
1323         }
1324
1325         strcpy(buf, val);
1326
1327         /* Get rid of the final newline */
1328         if (buf[len - 1] == '\n')
1329                 buf[len - 1] = '\0';
1330
1331         for (i = 0; i < 2; i++)
1332                 tokens[i] = strsep(&pbuf, ",");
1333
1334         if (pbuf) {
1335                 printk(KERN_ERR "UBI error: too many arguments at \"%s\"\n",
1336                        val);
1337                 return -EINVAL;
1338         }
1339
1340         p = &mtd_dev_param[mtd_devs];
1341         strcpy(&p->name[0], tokens[0]);
1342
1343         if (tokens[1])
1344                 p->vid_hdr_offs = bytes_str_to_int(tokens[1]);
1345
1346         if (p->vid_hdr_offs < 0)
1347                 return p->vid_hdr_offs;
1348
1349         mtd_devs += 1;
1350         return 0;
1351 }
1352
1353 module_param_call(mtd, ubi_mtd_param_parse, NULL, NULL, 000);
1354 MODULE_PARM_DESC(mtd, "MTD devices to attach. Parameter format: "
1355                       "mtd=<name|num>[,<vid_hdr_offs>].\n"
1356                       "Multiple \"mtd\" parameters may be specified.\n"
1357                       "MTD devices may be specified by their number or name.\n"
1358                       "Optional \"vid_hdr_offs\" parameter specifies UBI VID "
1359                       "header position and data starting position to be used "
1360                       "by UBI.\n"
1361                       "Example: mtd=content,1984 mtd=4 - attach MTD device"
1362                       "with name \"content\" using VID header offset 1984, and "
1363                       "MTD device number 4 with default VID header offset.");
1364
1365 MODULE_VERSION(__stringify(UBI_VERSION));
1366 MODULE_DESCRIPTION("UBI - Unsorted Block Images");
1367 MODULE_AUTHOR("Artem Bityutskiy");
1368 MODULE_LICENSE("GPL");