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.
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".
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.
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>
47 #define gprintk(fmt, x... ) printk( "%s: " fmt, __FUNCTION__ , ## x)
49 #define gprintk(x...) do { } while (0)
53 /* Maximum length of the 'mtd=' parameter */
54 #define MTD_PARAM_LEN_MAX 64
57 /* add by Nancy begin */
59 /* These are exported solely for the purpose of mtd_blkdevs.c. You
60 should not use them for _anything_ else */
61 DEFINE_MUTEX(vol_table_mutex);
62 struct ubi_volume *vol_table[UBI_MAX_VOLUMES];
64 EXPORT_SYMBOL_GPL(vol_table_mutex);
65 EXPORT_SYMBOL_GPL(vol_table);
67 static LIST_HEAD(vol_notifiers);
70 * add_mtd_device - register an MTD device
71 * @mtd: pointer to new MTD device info structure
73 * Add a device to the list of MTD devices present in the system, and
74 * notify each currently active MTD 'user' of its arrival. Returns
75 * zero on success or 1 on failure, which currently will only happen
76 * if the number of present devices exceeds MAX_MTD_DEVICES (i.e. 16)
79 int add_vol_device(struct ubi_volume *vol)
83 gprintk("1 vol->vol_id = %d, vol->ubi->ubi_num = %d\n", vol->vol_id, vol->ubi->ubi_num);
85 if( vol->ubi->ubi_num != 1 )
86 return 0; // just return
88 mutex_lock(&vol_table_mutex);
89 if( !vol_table[vol->vol_id] ) // vol->vol_id°¡ 0ÀÎ ³à¼®ÀÌ NULLÀÎ °æ¿ì
91 struct list_head *this;
93 vol_table[vol->vol_id] = vol;
94 gprintk("val_table add\n");
96 /* No need to get a refcount on the module containing
97 the notifier, since we hold the mtd_table_mutex */
98 list_for_each(this, &vol_notifiers) {
99 struct vol_notifier *not = list_entry(this, struct vol_notifier, list);
103 mutex_unlock(&vol_table_mutex);
104 /* We _know_ we aren't being removed, because
105 our caller is still holding us here. So none
106 of this try_ nonsense, and no bitching about it
108 __module_get(THIS_MODULE);
111 mutex_unlock(&vol_table_mutex);
116 * del_mtd_device - unregister an MTD device
117 * @mtd: pointer to MTD device info structure
119 * Remove a device from the list of MTD devices present in the system,
120 * and notify each currently active MTD 'user' of its departure.
121 * Returns zero on success or 1 on failure, which currently will happen
122 * if the requested device does not appear to be present in the list.
125 int del_vol_device (struct ubi_volume *vol)
129 mutex_lock(&vol_table_mutex);
130 if (vol_table[vol->vol_id] != vol) {
132 } else if (vol->readers ||vol->writers || vol->exclusive) {
133 printk(KERN_NOTICE "Removing MTD device #%d (%s) with use count 0\n",
134 vol->vol_id, vol->name);
137 struct list_head *this;
139 /* No need to get a refcount on the module containing
140 the notifier, since we hold the mtd_table_mutex */
141 list_for_each(this, &vol_notifiers) {
142 struct vol_notifier *not = list_entry(this, struct vol_notifier, list);
146 vol_table[vol->vol_id] = NULL;
148 module_put(THIS_MODULE);
151 mutex_unlock(&vol_table_mutex);
156 * register_mtd_user - register a 'user' of MTD devices.
157 * @new: pointer to notifier info structure
159 * Registers a pair of callbacks function to be called upon addition
160 * or removal of MTD devices. Causes the 'add' callback to be immediately
161 * invoked for each MTD device currently present in the system.
164 void register_vol_user(struct vol_notifier *new)
168 mutex_lock(&vol_table_mutex);
170 list_add(&new->list, &vol_notifiers);
172 __module_get(THIS_MODULE);
174 for (i=0; i< UBI_MAX_VOLUMES; i++)
176 new->add(vol_table[i]);
178 mutex_unlock(&vol_table_mutex);
182 * unregister_mtd_user - unregister a 'user' of MTD devices.
183 * @old: pointer to notifier info structure
185 * Removes a callback function pair from the list of 'users' to be
186 * notified upon addition or removal of MTD devices. Causes the
187 * 'remove' callback to be immediately invoked for each MTD device
188 * currently present in the system.
191 int unregister_vol_user(struct vol_notifier *old)
196 mutex_lock(&vol_table_mutex);
198 module_put(THIS_MODULE);
200 for (i=0; i< UBI_MAX_VOLUMES; i++)
202 old->remove(vol_table[i]);
204 list_del(&old->list);
205 mutex_unlock(&vol_table_mutex);
208 EXPORT_SYMBOL_GPL(add_vol_device);
209 EXPORT_SYMBOL_GPL(del_vol_device);
210 EXPORT_SYMBOL_GPL(register_vol_user);
211 EXPORT_SYMBOL_GPL(unregister_vol_user);
213 /* add by Nancy end*/
219 * struct mtd_dev_param - MTD device parameter description data structure.
220 * @name: MTD device name or number string
221 * @vid_hdr_offs: VID header offset
223 struct mtd_dev_param {
224 char name[MTD_PARAM_LEN_MAX];
228 /* Numbers of elements set in the @mtd_dev_param array */
231 /* MTD devices specification parameters */
232 static struct mtd_dev_param mtd_dev_param[UBI_MAX_DEVICES];
234 /* Root UBI "class" object (corresponds to '/<sysfs>/class/ubi/') */
235 struct class *ubi_class;
237 /* Slab cache for wear-leveling entries */
238 struct kmem_cache *ubi_wl_entry_slab;
240 /* UBI control character device */
241 static struct miscdevice ubi_ctrl_cdev = {
242 .minor = MISC_DYNAMIC_MINOR,
244 .fops = &ubi_ctrl_cdev_operations,
247 /* All UBI devices in system */
248 static struct ubi_device *ubi_devices[UBI_MAX_DEVICES];
250 /* Serializes UBI devices creations and removals */
251 DEFINE_MUTEX(ubi_devices_mutex);
253 /* Protects @ubi_devices and @ubi->ref_count */
254 static DEFINE_SPINLOCK(ubi_devices_lock);
255 EXPORT_SYMBOL_GPL(ubi_devices_lock);
257 /* "Show" method for files in '/<sysfs>/class/ubi/' */
258 static ssize_t ubi_version_show(struct class *class, char *buf)
260 return sprintf(buf, "%d\n", UBI_VERSION);
263 /* UBI version attribute ('/<sysfs>/class/ubi/version') */
264 static struct class_attribute ubi_version =
265 __ATTR(version, S_IRUGO, ubi_version_show, NULL);
267 static ssize_t dev_attribute_show(struct device *dev,
268 struct device_attribute *attr, char *buf);
270 /* UBI device attributes (correspond to files in '/<sysfs>/class/ubi/ubiX') */
271 static struct device_attribute dev_eraseblock_size =
272 __ATTR(eraseblock_size, S_IRUGO, dev_attribute_show, NULL);
273 static struct device_attribute dev_avail_eraseblocks =
274 __ATTR(avail_eraseblocks, S_IRUGO, dev_attribute_show, NULL);
275 static struct device_attribute dev_total_eraseblocks =
276 __ATTR(total_eraseblocks, S_IRUGO, dev_attribute_show, NULL);
277 static struct device_attribute dev_volumes_count =
278 __ATTR(volumes_count, S_IRUGO, dev_attribute_show, NULL);
279 static struct device_attribute dev_max_ec =
280 __ATTR(max_ec, S_IRUGO, dev_attribute_show, NULL);
281 static struct device_attribute dev_reserved_for_bad =
282 __ATTR(reserved_for_bad, S_IRUGO, dev_attribute_show, NULL);
283 static struct device_attribute dev_bad_peb_count =
284 __ATTR(bad_peb_count, S_IRUGO, dev_attribute_show, NULL);
285 static struct device_attribute dev_max_vol_count =
286 __ATTR(max_vol_count, S_IRUGO, dev_attribute_show, NULL);
287 static struct device_attribute dev_min_io_size =
288 __ATTR(min_io_size, S_IRUGO, dev_attribute_show, NULL);
289 static struct device_attribute dev_bgt_enabled =
290 __ATTR(bgt_enabled, S_IRUGO, dev_attribute_show, NULL);
291 static struct device_attribute dev_mtd_num =
292 __ATTR(mtd_num, S_IRUGO, dev_attribute_show, NULL);
295 * ubi_get_device - get UBI device.
296 * @ubi_num: UBI device number
298 * This function returns UBI device description object for UBI device number
299 * @ubi_num, or %NULL if the device does not exist. This function increases the
300 * device reference count to prevent removal of the device. In other words, the
301 * device cannot be removed if its reference count is not zero.
303 struct ubi_device *ubi_get_device(int ubi_num)
305 struct ubi_device *ubi;
307 spin_lock(&ubi_devices_lock);
308 ubi = ubi_devices[ubi_num];
310 ubi_assert(ubi->ref_count >= 0);
312 gprintk("ubi_num = %d, refcount = %d\n", ubi_num, ubi->ref_count);
313 get_device(&ubi->dev);
315 spin_unlock(&ubi_devices_lock);
321 * ubi_put_device - drop an UBI device reference.
322 * @ubi: UBI device description object
324 void ubi_put_device(struct ubi_device *ubi)
326 spin_lock(&ubi_devices_lock);
328 put_device(&ubi->dev);
329 spin_unlock(&ubi_devices_lock);
333 * ubi_get_by_major - get UBI device by character device major number.
334 * @major: major number
336 * This function is similar to 'ubi_get_device()', but it searches the device
337 * by its major number.
339 struct ubi_device *ubi_get_by_major(int major)
342 struct ubi_device *ubi;
344 spin_lock(&ubi_devices_lock);
345 for (i = 0; i < UBI_MAX_DEVICES; i++) {
346 ubi = ubi_devices[i];
347 if (ubi && MAJOR(ubi->cdev.dev) == major) {
348 ubi_assert(ubi->ref_count >= 0);
350 get_device(&ubi->dev);
351 spin_unlock(&ubi_devices_lock);
355 spin_unlock(&ubi_devices_lock);
361 * ubi_major2num - get UBI device number by character device major number.
362 * @major: major number
364 * This function searches UBI device number object by its major number. If UBI
365 * device was not found, this function returns -ENODEV, otherwise the UBI device
366 * number is returned.
368 int ubi_major2num(int major)
370 int i, ubi_num = -ENODEV;
372 spin_lock(&ubi_devices_lock);
373 for (i = 0; i < UBI_MAX_DEVICES; i++) {
374 struct ubi_device *ubi = ubi_devices[i];
375 gprintk("major = %d, i = %d, ubi->ubi_num = %d\n", major, i, ubi->ubi_num);
376 if ( (ubi && MAJOR(ubi->cdev.dev) == major) ||
377 (ubi && ubi->bdev_major == major)) {
379 ubi_num = ubi->ubi_num;
383 spin_unlock(&ubi_devices_lock);
387 EXPORT_SYMBOL_GPL(ubi_major2num);
390 /* "Show" method for files in '/<sysfs>/class/ubi/ubiX/' */
391 static ssize_t dev_attribute_show(struct device *dev,
392 struct device_attribute *attr, char *buf)
395 struct ubi_device *ubi;
398 * The below code looks weird, but it actually makes sense. We get the
399 * UBI device reference from the contained 'struct ubi_device'. But it
400 * is unclear if the device was removed or not yet. Indeed, if the
401 * device was removed before we increased its reference count,
402 * 'ubi_get_device()' will return -ENODEV and we fail.
404 * Remember, 'struct ubi_device' is freed in the release function, so
405 * we still can use 'ubi->ubi_num'.
407 ubi = container_of(dev, struct ubi_device, dev);
408 ubi = ubi_get_device(ubi->ubi_num);
412 if (attr == &dev_eraseblock_size)
413 ret = sprintf(buf, "%d\n", ubi->leb_size);
414 else if (attr == &dev_avail_eraseblocks)
415 ret = sprintf(buf, "%d\n", ubi->avail_pebs);
416 else if (attr == &dev_total_eraseblocks)
417 ret = sprintf(buf, "%d\n", ubi->good_peb_count);
418 else if (attr == &dev_volumes_count)
419 ret = sprintf(buf, "%d\n", ubi->vol_count - UBI_INT_VOL_COUNT);
420 else if (attr == &dev_max_ec)
421 ret = sprintf(buf, "%d\n", ubi->max_ec);
422 else if (attr == &dev_reserved_for_bad)
423 ret = sprintf(buf, "%d\n", ubi->beb_rsvd_pebs);
424 else if (attr == &dev_bad_peb_count)
425 ret = sprintf(buf, "%d\n", ubi->bad_peb_count);
426 else if (attr == &dev_max_vol_count)
427 ret = sprintf(buf, "%d\n", ubi->vtbl_slots);
428 else if (attr == &dev_min_io_size)
429 ret = sprintf(buf, "%d\n", ubi->min_io_size);
430 else if (attr == &dev_bgt_enabled)
431 ret = sprintf(buf, "%d\n", ubi->thread_enabled);
432 else if (attr == &dev_mtd_num)
433 ret = sprintf(buf, "%d\n", ubi->mtd->index);
441 static void dev_release(struct device *dev)
443 struct ubi_device *ubi = container_of(dev, struct ubi_device, dev);
449 * ubi_sysfs_init - initialize sysfs for an UBI device.
450 * @ubi: UBI device description object
452 * This function returns zero in case of success and a negative error code in
455 static int ubi_sysfs_init(struct ubi_device *ubi)
459 ubi->dev.release = dev_release;
460 ubi->dev.devt = ubi->cdev.dev;
461 ubi->dev.class = ubi_class;
462 sprintf(&ubi->dev.bus_id[0], UBI_NAME_STR"%d", ubi->ubi_num);
463 err = device_register(&ubi->dev);
467 err = device_create_file(&ubi->dev, &dev_eraseblock_size);
470 err = device_create_file(&ubi->dev, &dev_avail_eraseblocks);
473 err = device_create_file(&ubi->dev, &dev_total_eraseblocks);
476 err = device_create_file(&ubi->dev, &dev_volumes_count);
479 err = device_create_file(&ubi->dev, &dev_max_ec);
482 err = device_create_file(&ubi->dev, &dev_reserved_for_bad);
485 err = device_create_file(&ubi->dev, &dev_bad_peb_count);
488 err = device_create_file(&ubi->dev, &dev_max_vol_count);
491 err = device_create_file(&ubi->dev, &dev_min_io_size);
494 err = device_create_file(&ubi->dev, &dev_bgt_enabled);
497 err = device_create_file(&ubi->dev, &dev_mtd_num);
502 * ubi_sysfs_close - close sysfs for an UBI device.
503 * @ubi: UBI device description object
505 static void ubi_sysfs_close(struct ubi_device *ubi)
507 device_remove_file(&ubi->dev, &dev_mtd_num);
508 device_remove_file(&ubi->dev, &dev_bgt_enabled);
509 device_remove_file(&ubi->dev, &dev_min_io_size);
510 device_remove_file(&ubi->dev, &dev_max_vol_count);
511 device_remove_file(&ubi->dev, &dev_bad_peb_count);
512 device_remove_file(&ubi->dev, &dev_reserved_for_bad);
513 device_remove_file(&ubi->dev, &dev_max_ec);
514 device_remove_file(&ubi->dev, &dev_volumes_count);
515 device_remove_file(&ubi->dev, &dev_total_eraseblocks);
516 device_remove_file(&ubi->dev, &dev_avail_eraseblocks);
517 device_remove_file(&ubi->dev, &dev_eraseblock_size);
518 device_unregister(&ubi->dev);
522 * kill_volumes - destroy all volumes.
523 * @ubi: UBI device description object
525 static void kill_volumes(struct ubi_device *ubi)
529 for (i = 0; i < ubi->vtbl_slots; i++)
531 ubi_free_volume(ubi, ubi->volumes[i]);
535 * free_user_volumes - free all user volumes.
536 * @ubi: UBI device description object
538 * Normally the volumes are freed at the release function of the volume device
539 * objects. However, on error paths the volumes have to be freed before the
540 * device objects have been initialized.
542 static void free_user_volumes(struct ubi_device *ubi)
546 for (i = 0; i < ubi->vtbl_slots; i++)
547 if (ubi->volumes[i]) {
548 kfree(ubi->volumes[i]->eba_tbl);
549 kfree(ubi->volumes[i]);
554 * uif_init - initialize user interfaces for an UBI device.
555 * @ubi: UBI device description object
557 * This function returns zero in case of success and a negative error code in
558 * case of failure. Note, this function destroys all volumes if it failes.
560 static int uif_init(struct ubi_device *ubi)
565 sprintf(ubi->ubi_name, UBI_NAME_STR "%d", ubi->ubi_num);
568 * Major numbers for the UBI character devices are allocated
569 * dynamically. Major numbers of volume character devices are
570 * equivalent to ones of the corresponding UBI character device. Minor
571 * numbers of UBI character devices are 0, while minor numbers of
572 * volume character devices start from 1. Thus, we allocate one major
573 * number and ubi->vtbl_slots + 1 minor numbers.
575 err = alloc_chrdev_region(&dev, 0, ubi->vtbl_slots + 1, ubi->ubi_name);
577 ubi_err("cannot register UBI character devices");
581 ubi_assert(MINOR(dev) == 0);
582 cdev_init(&ubi->cdev, &ubi_cdev_operations);
583 dbg_gen("%s major is %u", ubi->ubi_name, MAJOR(dev));
584 ubi->cdev.owner = THIS_MODULE;
586 err = cdev_add(&ubi->cdev, dev, 1);
588 ubi_err("cannot add character device");
592 err = ubi_sysfs_init(ubi);
596 for (i = 0; i < ubi->vtbl_slots; i++)
597 if (ubi->volumes[i]) {
598 err = ubi_add_volume(ubi, ubi->volumes[i]);
600 ubi_err("cannot add volume %d", i);
610 ubi_sysfs_close(ubi);
611 cdev_del(&ubi->cdev);
613 unregister_chrdev_region(ubi->cdev.dev, ubi->vtbl_slots + 1);
614 ubi_err("cannot initialize UBI %s, error %d", ubi->ubi_name, err);
619 * uif_close - close user interfaces for an UBI device.
620 * @ubi: UBI device description object
622 * Note, since this function un-registers UBI volume device objects (@vol->dev),
623 * the memory allocated voe the volumes is freed as well (in the release
626 static void uif_close(struct ubi_device *ubi)
629 ubi_sysfs_close(ubi);
630 cdev_del(&ubi->cdev);
631 unregister_chrdev_region(ubi->cdev.dev, ubi->vtbl_slots + 1);
635 * free_internal_volumes - free internal volumes.
636 * @ubi: UBI device description object
638 static void free_internal_volumes(struct ubi_device *ubi)
642 for (i = ubi->vtbl_slots;
643 i < ubi->vtbl_slots + UBI_INT_VOL_COUNT; i++) {
644 kfree(ubi->volumes[i]->eba_tbl);
645 kfree(ubi->volumes[i]);
650 * attach_by_scanning - attach an MTD device using scanning method.
651 * @ubi: UBI device descriptor
653 * This function returns zero in case of success and a negative error code in
656 * Note, currently this is the only method to attach UBI devices. Hopefully in
657 * the future we'll have more scalable attaching methods and avoid full media
658 * scanning. But even in this case scanning will be needed as a fall-back
659 * attaching method if there are some on-flash table corruptions.
661 static int attach_by_scanning(struct ubi_device *ubi)
664 struct ubi_scan_info *si;
670 ubi->bad_peb_count = si->bad_peb_count;
671 ubi->good_peb_count = ubi->peb_count - ubi->bad_peb_count;
672 ubi->max_ec = si->max_ec;
673 ubi->mean_ec = si->mean_ec;
675 err = ubi_read_volume_table(ubi, si);
679 err = ubi_wl_init_scan(ubi, si);
683 err = ubi_eba_init_scan(ubi, si);
687 ubi_scan_destroy_si(si);
693 free_internal_volumes(ubi);
696 ubi_scan_destroy_si(si);
701 * io_init - initialize I/O sub-system for a given UBI device.
702 * @ubi: UBI device description object
704 * If @ubi->vid_hdr_offset or @ubi->leb_start is zero, default offsets are
706 * o EC header is always at offset zero - this cannot be changed;
707 * o VID header starts just after the EC header at the closest address
708 * aligned to @io->hdrs_min_io_size;
709 * o data starts just after the VID header at the closest address aligned to
712 * This function returns zero in case of success and a negative error code in
715 static int io_init(struct ubi_device *ubi)
717 if (ubi->mtd->numeraseregions != 0) {
719 * Some flashes have several erase regions. Different regions
720 * may have different eraseblock size and other
721 * characteristics. It looks like mostly multi-region flashes
722 * have one "main" region and one or more small regions to
723 * store boot loader code or boot parameters or whatever. I
724 * guess we should just pick the largest region. But this is
727 ubi_err("multiple regions, not implemented");
731 if (ubi->vid_hdr_offset < 0)
735 * Note, in this implementation we support MTD devices with 0x7FFFFFFF
736 * physical eraseblocks maximum.
739 ubi->peb_size = ubi->mtd->erasesize;
740 ubi->peb_count = ubi->mtd->size / ubi->mtd->erasesize;
741 ubi->flash_size = ubi->mtd->size;
743 if (ubi->mtd->block_isbad && ubi->mtd->block_markbad)
744 ubi->bad_allowed = 1;
746 ubi->min_io_size = ubi->mtd->writesize;
747 ubi->hdrs_min_io_size = ubi->mtd->writesize >> ubi->mtd->subpage_sft;
750 * Make sure minimal I/O unit is power of 2. Note, there is no
751 * fundamental reason for this assumption. It is just an optimization
752 * which allows us to avoid costly division operations.
754 if (!is_power_of_2(ubi->min_io_size)) {
755 ubi_err("min. I/O unit (%d) is not power of 2",
760 ubi_assert(ubi->hdrs_min_io_size > 0);
761 ubi_assert(ubi->hdrs_min_io_size <= ubi->min_io_size);
762 ubi_assert(ubi->min_io_size % ubi->hdrs_min_io_size == 0);
764 /* Calculate default aligned sizes of EC and VID headers */
765 ubi->ec_hdr_alsize = ALIGN(UBI_EC_HDR_SIZE, ubi->hdrs_min_io_size);
766 ubi->vid_hdr_alsize = ALIGN(UBI_VID_HDR_SIZE, ubi->hdrs_min_io_size);
768 dbg_msg("min_io_size %d", ubi->min_io_size);
769 dbg_msg("hdrs_min_io_size %d", ubi->hdrs_min_io_size);
770 dbg_msg("ec_hdr_alsize %d", ubi->ec_hdr_alsize);
771 dbg_msg("vid_hdr_alsize %d", ubi->vid_hdr_alsize);
773 if (ubi->vid_hdr_offset == 0)
775 ubi->vid_hdr_offset = ubi->vid_hdr_aloffset =
778 ubi->vid_hdr_aloffset = ubi->vid_hdr_offset &
779 ~(ubi->hdrs_min_io_size - 1);
780 ubi->vid_hdr_shift = ubi->vid_hdr_offset -
781 ubi->vid_hdr_aloffset;
784 /* Similar for the data offset */
785 ubi->leb_start = ubi->vid_hdr_offset + UBI_EC_HDR_SIZE;
786 ubi->leb_start = ALIGN(ubi->leb_start, ubi->min_io_size);
788 dbg_msg("vid_hdr_offset %d", ubi->vid_hdr_offset);
789 dbg_msg("vid_hdr_aloffset %d", ubi->vid_hdr_aloffset);
790 dbg_msg("vid_hdr_shift %d", ubi->vid_hdr_shift);
791 dbg_msg("leb_start %d", ubi->leb_start);
793 /* The shift must be aligned to 32-bit boundary */
794 if (ubi->vid_hdr_shift % 4) {
795 ubi_err("unaligned VID header shift %d",
801 if (ubi->vid_hdr_offset < UBI_EC_HDR_SIZE ||
802 ubi->leb_start < ubi->vid_hdr_offset + UBI_VID_HDR_SIZE ||
803 ubi->leb_start > ubi->peb_size - UBI_VID_HDR_SIZE ||
804 ubi->leb_start & (ubi->min_io_size - 1)) {
805 ubi_err("bad VID header (%d) or data offsets (%d)",
806 ubi->vid_hdr_offset, ubi->leb_start);
811 * It may happen that EC and VID headers are situated in one minimal
812 * I/O unit. In this case we can only accept this UBI image in
815 if (ubi->vid_hdr_offset + UBI_VID_HDR_SIZE <= ubi->hdrs_min_io_size) {
816 ubi_warn("EC and VID headers are in the same minimal I/O unit, "
817 "switch to read-only mode");
821 ubi->leb_size = ubi->peb_size - ubi->leb_start;
823 if (!(ubi->mtd->flags & MTD_WRITEABLE)) {
824 ubi_msg("MTD device %d is write-protected, attach in "
825 "read-only mode", ubi->mtd->index);
829 #ifdef CONFIG_POLLUX_KERNEL_BOOT_MESSAGE_ENABLE
830 ubi_msg("physical eraseblock size: %d bytes (%d KiB)",
831 ubi->peb_size, ubi->peb_size >> 10);
832 ubi_msg("logical eraseblock size: %d bytes", ubi->leb_size);
833 ubi_msg("smallest flash I/O unit: %d", ubi->min_io_size);
834 if (ubi->hdrs_min_io_size != ubi->min_io_size)
835 ubi_msg("sub-page size: %d",
836 ubi->hdrs_min_io_size);
837 ubi_msg("VID header offset: %d (aligned %d)",
838 ubi->vid_hdr_offset, ubi->vid_hdr_aloffset);
839 ubi_msg("data offset: %d", ubi->leb_start);
843 * Note, ideally, we have to initialize ubi->bad_peb_count here. But
844 * unfortunately, MTD does not provide this information. We should loop
845 * over all physical eraseblocks and invoke mtd->block_is_bad() for
846 * each physical eraseblock. So, we skip ubi->bad_peb_count
847 * uninitialized and initialize it after scanning.
854 * autoresize - re-size the volume which has the "auto-resize" flag set.
855 * @ubi: UBI device description object
856 * @vol_id: ID of the volume to re-size
858 * This function re-sizes the volume marked by the @UBI_VTBL_AUTORESIZE_FLG in
859 * the volume table to the largest possible size. See comments in ubi-header.h
860 * for more description of the flag. Returns zero in case of success and a
861 * negative error code in case of failure.
863 static int autoresize(struct ubi_device *ubi, int vol_id)
865 struct ubi_volume_desc desc;
866 struct ubi_volume *vol = ubi->volumes[vol_id];
867 int err, old_reserved_pebs = vol->reserved_pebs;
870 * Clear the auto-resize flag in the volume in-memory copy of the
871 * volume table, and 'ubi_resize_volume()' will propagate this change
874 ubi->vtbl[vol_id].flags &= ~UBI_VTBL_AUTORESIZE_FLG;
876 if (ubi->avail_pebs == 0) {
877 struct ubi_vtbl_record vtbl_rec;
880 * No available PEBs to re-size the volume, clear the flag on
883 memcpy(&vtbl_rec, &ubi->vtbl[vol_id],
884 sizeof(struct ubi_vtbl_record));
885 err = ubi_change_vtbl_record(ubi, vol_id, &vtbl_rec);
887 ubi_err("cannot clean auto-resize flag for volume %d",
891 err = ubi_resize_volume(&desc,
892 old_reserved_pebs + ubi->avail_pebs);
894 ubi_err("cannot auto-resize volume %d", vol_id);
900 ubi_msg("volume %d (\"%s\") re-sized from %d to %d LEBs", vol_id,
901 vol->name, old_reserved_pebs, vol->reserved_pebs);
907 static int bdev_init(struct ubi_device *ubi){
909 for(i=0; i<ubi->vtbl_slots; i++)
911 add_vol_device(ubi->volumes[i]);
918 * ubi_attach_mtd_dev - attach an MTD device.
919 * @mtd: MTD device description object
920 * @ubi_num: number to assign to the new UBI device
921 * @vid_hdr_offset: VID header offset
923 * This function attaches MTD device @mtd_dev to UBI and assign @ubi_num number
924 * to the newly created UBI device, unless @ubi_num is %UBI_DEV_NUM_AUTO, in
925 * which case this function finds a vacant device number and assigns it
926 * automatically. Returns the new UBI device number in case of success and a
927 * negative error code in case of failure.
929 * Note, the invocations of this function has to be serialized by the
930 * @ubi_devices_mutex.
932 int ubi_attach_mtd_dev(struct mtd_info *mtd, int ubi_num, int vid_hdr_offset)
934 struct ubi_device *ubi;
935 int i, err, do_free = 1;
938 * Check if we already have the same MTD device attached.
940 * Note, this function assumes that UBI devices creations and deletions
941 * are serialized, so it does not take the &ubi_devices_lock.
943 for (i = 0; i < UBI_MAX_DEVICES; i++) {
944 ubi = ubi_devices[i];
945 if (ubi && mtd->index == ubi->mtd->index) {
946 dbg_err("mtd%d is already attached to ubi%d",
953 * Make sure this MTD device is not emulated on top of an UBI volume
954 * already. Well, generally this recursion works fine, but there are
955 * different problems like the UBI module takes a reference to itself
956 * by attaching (and thus, opening) the emulated MTD device. This
957 * results in inability to unload the module. And in general it makes
958 * no sense to attach emulated MTD devices, so we prohibit this.
960 if (mtd->type == MTD_UBIVOLUME) {
961 ubi_err("refuse attaching mtd%d - it is already emulated on "
962 "top of UBI", mtd->index);
966 if (ubi_num == UBI_DEV_NUM_AUTO) {
967 /* Search for an empty slot in the @ubi_devices array */
968 for (ubi_num = 0; ubi_num < UBI_MAX_DEVICES; ubi_num++)
969 if (!ubi_devices[ubi_num])
971 if (ubi_num == UBI_MAX_DEVICES) {
972 dbg_err("only %d UBI devices may be created",
977 if (ubi_num >= UBI_MAX_DEVICES)
980 /* Make sure ubi_num is not busy */
981 if (ubi_devices[ubi_num]) {
982 dbg_err("ubi%d already exists", ubi_num);
987 ubi = kzalloc(sizeof(struct ubi_device), GFP_KERNEL);
992 ubi->ubi_num = ubi_num;
993 ubi->vid_hdr_offset = vid_hdr_offset;
994 ubi->autoresize_vol_id = -1;
996 mutex_init(&ubi->buf_mutex);
997 mutex_init(&ubi->ckvol_mutex);
998 mutex_init(&ubi->device_mutex);
999 spin_lock_init(&ubi->volumes_lock);
1001 #ifdef CONFIG_POLLUX_KERNEL_BOOT_MESSAGE_ENABLE
1002 ubi_msg("attaching mtd%d to ubi%d", mtd->index, ubi_num);
1010 ubi->peb_buf1 = vmalloc(ubi->peb_size);
1014 ubi->peb_buf2 = vmalloc(ubi->peb_size);
1018 #ifdef CONFIG_MTD_UBI_DEBUG_PARANOID
1019 mutex_init(&ubi->dbg_buf_mutex);
1020 ubi->dbg_peb_buf = vmalloc(ubi->peb_size);
1021 if (!ubi->dbg_peb_buf)
1025 err = attach_by_scanning(ubi);
1027 dbg_err("failed to attach by scanning, error %d", err);
1031 if (ubi->autoresize_vol_id != -1) {
1032 err = autoresize(ubi, ubi->autoresize_vol_id);
1037 err = uif_init(ubi);
1043 gprintk("..............aaaaaaaaaaaa...........\n");
1044 err = bdev_init(ubi);
1046 goto out_nofree; // ghcstop: change out_detach ==> out_nofree
1049 ubi->bgt_thread = kthread_create(ubi_thread, ubi, ubi->bgt_name);
1050 if (IS_ERR(ubi->bgt_thread)) {
1051 err = PTR_ERR(ubi->bgt_thread);
1052 ubi_err("cannot spawn \"%s\", error %d", ubi->bgt_name,
1057 #ifdef CONFIG_POLLUX_KERNEL_BOOT_MESSAGE_ENABLE
1058 ubi_msg("attached mtd%d to ubi%d", mtd->index, ubi_num);
1059 ubi_msg("MTD device name: \"%s\"", mtd->name);
1060 ubi_msg("MTD device size: %llu MiB", ubi->flash_size >> 20);
1061 ubi_msg("number of good PEBs: %d", ubi->good_peb_count);
1062 ubi_msg("number of bad PEBs: %d", ubi->bad_peb_count);
1063 ubi_msg("max. allowed volumes: %d", ubi->vtbl_slots);
1064 ubi_msg("wear-leveling threshold: %d", CONFIG_MTD_UBI_WL_THRESHOLD);
1065 ubi_msg("number of internal volumes: %d", UBI_INT_VOL_COUNT);
1066 ubi_msg("number of user volumes: %d",
1067 ubi->vol_count - UBI_INT_VOL_COUNT);
1068 ubi_msg("available PEBs: %d", ubi->avail_pebs);
1069 ubi_msg("total number of reserved PEBs: %d", ubi->rsvd_pebs);
1070 ubi_msg("number of PEBs reserved for bad PEB handling: %d",
1071 ubi->beb_rsvd_pebs);
1072 ubi_msg("max/mean erase counter: %d/%d", ubi->max_ec, ubi->mean_ec);
1076 if (!DBG_DISABLE_BGT)
1077 ubi->thread_enabled = 1;
1078 wake_up_process(ubi->bgt_thread);
1080 ubi_devices[ubi_num] = ubi;
1090 free_user_volumes(ubi);
1091 free_internal_volumes(ubi);
1094 vfree(ubi->peb_buf1);
1095 vfree(ubi->peb_buf2);
1096 #ifdef CONFIG_MTD_UBI_DEBUG_PARANOID
1097 vfree(ubi->dbg_peb_buf);
1104 * ubi_detach_mtd_dev - detach an MTD device.
1105 * @ubi_num: UBI device number to detach from
1106 * @anyway: detach MTD even if device reference count is not zero
1108 * This function destroys an UBI device number @ubi_num and detaches the
1109 * underlying MTD device. Returns zero in case of success and %-EBUSY if the
1110 * UBI device is busy and cannot be destroyed, and %-EINVAL if it does not
1113 * Note, the invocations of this function has to be serialized by the
1114 * @ubi_devices_mutex.
1116 int ubi_detach_mtd_dev(int ubi_num, int anyway)
1118 struct ubi_device *ubi;
1120 if (ubi_num < 0 || ubi_num >= UBI_MAX_DEVICES)
1123 spin_lock(&ubi_devices_lock);
1124 ubi = ubi_devices[ubi_num];
1126 spin_unlock(&ubi_devices_lock);
1130 if (ubi->ref_count) {
1132 spin_unlock(&ubi_devices_lock);
1135 /* This may only happen if there is a bug */
1136 ubi_err("%s reference count %d, destroy anyway",
1137 ubi->ubi_name, ubi->ref_count);
1139 ubi_devices[ubi_num] = NULL;
1140 spin_unlock(&ubi_devices_lock);
1142 ubi_assert(ubi_num == ubi->ubi_num);
1143 dbg_msg("detaching mtd%d from ubi%d", ubi->mtd->index, ubi_num);
1146 * Before freeing anything, we have to stop the background thread to
1147 * prevent it from doing anything on this device while we are freeing.
1149 if (ubi->bgt_thread)
1150 kthread_stop(ubi->bgt_thread);
1153 * Get a reference to the device in order to prevent 'dev_release()'
1154 * from freeing @ubi object.
1156 get_device(&ubi->dev);
1160 free_internal_volumes(ubi);
1162 put_mtd_device(ubi->mtd);
1163 vfree(ubi->peb_buf1);
1164 vfree(ubi->peb_buf2);
1165 #ifdef CONFIG_MTD_UBI_DEBUG_PARANOID
1166 vfree(ubi->dbg_peb_buf);
1168 ubi_msg("mtd%d is detached from ubi%d", ubi->mtd->index, ubi->ubi_num);
1169 put_device(&ubi->dev);
1174 * find_mtd_device - open an MTD device by its name or number.
1175 * @mtd_dev: name or number of the device
1177 * This function tries to open and MTD device described by @mtd_dev string,
1178 * which is first treated as an ASCII number, and if it is not true, it is
1179 * treated as MTD device name. Returns MTD device description object in case of
1180 * success and a negative error code in case of failure.
1182 static struct mtd_info * __init open_mtd_device(const char *mtd_dev)
1184 struct mtd_info *mtd;
1188 mtd_num = simple_strtoul(mtd_dev, &endp, 0);
1189 if (*endp != '\0' || mtd_dev == endp) {
1191 * This does not look like an ASCII integer, probably this is
1194 mtd = get_mtd_device_nm(mtd_dev);
1196 mtd = get_mtd_device(NULL, mtd_num);
1201 static int __init ubi_init(void)
1205 /* Ensure that EC and VID headers have correct size */
1206 BUILD_BUG_ON(sizeof(struct ubi_ec_hdr) != 64);
1207 BUILD_BUG_ON(sizeof(struct ubi_vid_hdr) != 64);
1209 if (mtd_devs > UBI_MAX_DEVICES) {
1210 ubi_err("too many MTD devices, maximum is %d", UBI_MAX_DEVICES);
1214 /* Create base sysfs directory and sysfs files */
1215 ubi_class = class_create(THIS_MODULE, UBI_NAME_STR);
1216 if (IS_ERR(ubi_class)) {
1217 err = PTR_ERR(ubi_class);
1218 ubi_err("cannot create UBI class");
1222 err = class_create_file(ubi_class, &ubi_version);
1224 ubi_err("cannot create sysfs file");
1228 err = misc_register(&ubi_ctrl_cdev);
1230 ubi_err("cannot register device");
1234 ubi_wl_entry_slab = kmem_cache_create("ubi_wl_entry_slab",
1235 sizeof(struct ubi_wl_entry),
1237 if (!ubi_wl_entry_slab)
1240 /* Attach MTD devices */
1241 for (i = 0; i < mtd_devs; i++) {
1242 struct mtd_dev_param *p = &mtd_dev_param[i];
1243 struct mtd_info *mtd;
1247 mtd = open_mtd_device(p->name);
1253 mutex_lock(&ubi_devices_mutex);
1254 err = ubi_attach_mtd_dev(mtd, UBI_DEV_NUM_AUTO,
1256 mutex_unlock(&ubi_devices_mutex);
1258 put_mtd_device(mtd);
1259 ubi_err("cannot attach mtd%d", mtd->index);
1267 for (k = 0; k < i; k++)
1268 if (ubi_devices[k]) {
1269 mutex_lock(&ubi_devices_mutex);
1270 ubi_detach_mtd_dev(ubi_devices[k]->ubi_num, 1);
1271 mutex_unlock(&ubi_devices_mutex);
1273 kmem_cache_destroy(ubi_wl_entry_slab);
1275 misc_deregister(&ubi_ctrl_cdev);
1277 class_remove_file(ubi_class, &ubi_version);
1279 class_destroy(ubi_class);
1281 ubi_err("UBI error: cannot initialize UBI, error %d", err);
1284 module_init(ubi_init);
1286 static void __exit ubi_exit(void)
1290 for (i = 0; i < UBI_MAX_DEVICES; i++)
1291 if (ubi_devices[i]) {
1292 mutex_lock(&ubi_devices_mutex);
1293 ubi_detach_mtd_dev(ubi_devices[i]->ubi_num, 1);
1294 mutex_unlock(&ubi_devices_mutex);
1296 kmem_cache_destroy(ubi_wl_entry_slab);
1297 misc_deregister(&ubi_ctrl_cdev);
1298 class_remove_file(ubi_class, &ubi_version);
1299 class_destroy(ubi_class);
1301 module_exit(ubi_exit);
1304 * bytes_str_to_int - convert a number of bytes string into an integer.
1305 * @str: the string to convert
1307 * This function returns positive resulting integer in case of success and a
1308 * negative error code in case of failure.
1310 static int __init bytes_str_to_int(const char *str)
1313 unsigned long result;
1315 result = simple_strtoul(str, &endp, 0);
1316 if (str == endp || result < 0) {
1317 printk(KERN_ERR "UBI error: incorrect bytes count: \"%s\"\n",
1329 if (endp[1] == 'i' && endp[2] == 'B')
1334 printk(KERN_ERR "UBI error: incorrect bytes count: \"%s\"\n",
1343 * ubi_mtd_param_parse - parse the 'mtd=' UBI parameter.
1344 * @val: the parameter value to parse
1347 * This function returns zero in case of success and a negative error code in
1350 static int __init ubi_mtd_param_parse(const char *val, struct kernel_param *kp)
1353 struct mtd_dev_param *p;
1354 char buf[MTD_PARAM_LEN_MAX];
1355 char *pbuf = &buf[0];
1356 char *tokens[2] = {NULL, NULL};
1361 if (mtd_devs == UBI_MAX_DEVICES) {
1362 printk(KERN_ERR "UBI error: too many parameters, max. is %d\n",
1367 len = strnlen(val, MTD_PARAM_LEN_MAX);
1368 if (len == MTD_PARAM_LEN_MAX) {
1369 printk(KERN_ERR "UBI error: parameter \"%s\" is too long, "
1370 "max. is %d\n", val, MTD_PARAM_LEN_MAX);
1375 printk(KERN_WARNING "UBI warning: empty 'mtd=' parameter - "
1382 /* Get rid of the final newline */
1383 if (buf[len - 1] == '\n')
1384 buf[len - 1] = '\0';
1386 for (i = 0; i < 2; i++)
1387 tokens[i] = strsep(&pbuf, ",");
1390 printk(KERN_ERR "UBI error: too many arguments at \"%s\"\n",
1395 p = &mtd_dev_param[mtd_devs];
1396 strcpy(&p->name[0], tokens[0]);
1399 p->vid_hdr_offs = bytes_str_to_int(tokens[1]);
1401 if (p->vid_hdr_offs < 0)
1402 return p->vid_hdr_offs;
1408 module_param_call(mtd, ubi_mtd_param_parse, NULL, NULL, 000);
1409 MODULE_PARM_DESC(mtd, "MTD devices to attach. Parameter format: "
1410 "mtd=<name|num>[,<vid_hdr_offs>].\n"
1411 "Multiple \"mtd\" parameters may be specified.\n"
1412 "MTD devices may be specified by their number or name.\n"
1413 "Optional \"vid_hdr_offs\" parameter specifies UBI VID "
1414 "header position and data starting position to be used "
1416 "Example: mtd=content,1984 mtd=4 - attach MTD device"
1417 "with name \"content\" using VID header offset 1984, and "
1418 "MTD device number 4 with default VID header offset.");
1420 MODULE_VERSION(__stringify(UBI_VERSION));
1421 MODULE_DESCRIPTION("UBI - Unsorted Block Images");
1422 MODULE_AUTHOR("Artem Bityutskiy");
1423 MODULE_LICENSE("GPL");