1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32#include <linux/err.h>
33#include <linux/module.h>
34#include <linux/moduleparam.h>
35#include <linux/stringify.h>
36#include <linux/namei.h>
37#include <linux/stat.h>
38#include <linux/miscdevice.h>
39#include <linux/mtd/partitions.h>
40#include <linux/log2.h>
41#include <linux/kthread.h>
42#include <linux/kernel.h>
43#include <linux/slab.h>
44#include <linux/major.h>
45#include "ubi.h"
46
47
48#define MTD_PARAM_LEN_MAX 64
49
50
51#define MTD_PARAM_MAX_COUNT 4
52
53
54#define MAX_MTD_UBI_BEB_LIMIT 768
55
56#ifdef CONFIG_MTD_UBI_MODULE
57#define ubi_is_module() 1
58#else
59#define ubi_is_module() 0
60#endif
61
62
63
64
65
66
67
68
69struct mtd_dev_param {
70 char name[MTD_PARAM_LEN_MAX];
71 int ubi_num;
72 int vid_hdr_offs;
73 int max_beb_per1024;
74};
75
76
77static int __initdata mtd_devs;
78
79
80static struct mtd_dev_param __initdata mtd_dev_param[UBI_MAX_DEVICES];
81#ifdef CONFIG_MTD_UBI_FASTMAP
82
83static bool fm_autoconvert;
84#endif
85
86struct class *ubi_class;
87
88
89struct kmem_cache *ubi_wl_entry_slab;
90
91
92static struct miscdevice ubi_ctrl_cdev = {
93 .minor = MISC_DYNAMIC_MINOR,
94 .name = "ubi_ctrl",
95 .fops = &ubi_ctrl_cdev_operations,
96};
97
98
99static struct ubi_device *ubi_devices[UBI_MAX_DEVICES];
100
101
102DEFINE_MUTEX(ubi_devices_mutex);
103
104
105static DEFINE_SPINLOCK(ubi_devices_lock);
106
107
108static ssize_t ubi_version_show(struct class *class,
109 struct class_attribute *attr, char *buf)
110{
111 return sprintf(buf, "%d\n", UBI_VERSION);
112}
113
114
115static struct class_attribute ubi_version =
116 __ATTR(version, S_IRUGO, ubi_version_show, NULL);
117
118static ssize_t dev_attribute_show(struct device *dev,
119 struct device_attribute *attr, char *buf);
120
121
122static struct device_attribute dev_eraseblock_size =
123 __ATTR(eraseblock_size, S_IRUGO, dev_attribute_show, NULL);
124static struct device_attribute dev_avail_eraseblocks =
125 __ATTR(avail_eraseblocks, S_IRUGO, dev_attribute_show, NULL);
126static struct device_attribute dev_total_eraseblocks =
127 __ATTR(total_eraseblocks, S_IRUGO, dev_attribute_show, NULL);
128static struct device_attribute dev_volumes_count =
129 __ATTR(volumes_count, S_IRUGO, dev_attribute_show, NULL);
130static struct device_attribute dev_max_ec =
131 __ATTR(max_ec, S_IRUGO, dev_attribute_show, NULL);
132static struct device_attribute dev_reserved_for_bad =
133 __ATTR(reserved_for_bad, S_IRUGO, dev_attribute_show, NULL);
134static struct device_attribute dev_bad_peb_count =
135 __ATTR(bad_peb_count, S_IRUGO, dev_attribute_show, NULL);
136static struct device_attribute dev_max_vol_count =
137 __ATTR(max_vol_count, S_IRUGO, dev_attribute_show, NULL);
138static struct device_attribute dev_min_io_size =
139 __ATTR(min_io_size, S_IRUGO, dev_attribute_show, NULL);
140static struct device_attribute dev_bgt_enabled =
141 __ATTR(bgt_enabled, S_IRUGO, dev_attribute_show, NULL);
142static struct device_attribute dev_mtd_num =
143 __ATTR(mtd_num, S_IRUGO, dev_attribute_show, NULL);
144
145
146
147
148
149
150
151
152
153
154
155int ubi_volume_notify(struct ubi_device *ubi, struct ubi_volume *vol, int ntype)
156{
157 struct ubi_notification nt;
158
159 ubi_do_get_device_info(ubi, &nt.di);
160 ubi_do_get_volume_info(ubi, vol, &nt.vi);
161
162#ifdef CONFIG_MTD_UBI_FASTMAP
163 switch (ntype) {
164 case UBI_VOLUME_ADDED:
165 case UBI_VOLUME_REMOVED:
166 case UBI_VOLUME_RESIZED:
167 case UBI_VOLUME_RENAMED:
168 if (ubi_update_fastmap(ubi)) {
169 ubi_err(ubi, "Unable to update fastmap!");
170 ubi_ro_mode(ubi);
171 }
172 }
173#endif
174 return blocking_notifier_call_chain(&ubi_notifiers, ntype, &nt);
175}
176
177
178
179
180
181
182
183
184
185
186
187
188int ubi_notify_all(struct ubi_device *ubi, int ntype, struct notifier_block *nb)
189{
190 struct ubi_notification nt;
191 int i, count = 0;
192
193 ubi_do_get_device_info(ubi, &nt.di);
194
195 mutex_lock(&ubi->device_mutex);
196 for (i = 0; i < ubi->vtbl_slots; i++) {
197
198
199
200
201
202 if (!ubi->volumes[i])
203 continue;
204
205 ubi_do_get_volume_info(ubi, ubi->volumes[i], &nt.vi);
206 if (nb)
207 nb->notifier_call(nb, ntype, &nt);
208 else
209 blocking_notifier_call_chain(&ubi_notifiers, ntype,
210 &nt);
211 count += 1;
212 }
213 mutex_unlock(&ubi->device_mutex);
214
215 return count;
216}
217
218
219
220
221
222
223
224
225
226
227int ubi_enumerate_volumes(struct notifier_block *nb)
228{
229 int i, count = 0;
230
231
232
233
234
235 for (i = 0; i < UBI_MAX_DEVICES; i++) {
236 struct ubi_device *ubi = ubi_devices[i];
237
238 if (!ubi)
239 continue;
240 count += ubi_notify_all(ubi, UBI_VOLUME_ADDED, nb);
241 }
242
243 return count;
244}
245
246
247
248
249
250
251
252
253
254
255struct ubi_device *ubi_get_device(int ubi_num)
256{
257 struct ubi_device *ubi;
258
259 spin_lock(&ubi_devices_lock);
260 ubi = ubi_devices[ubi_num];
261 if (ubi) {
262 ubi_assert(ubi->ref_count >= 0);
263 ubi->ref_count += 1;
264 get_device(&ubi->dev);
265 }
266 spin_unlock(&ubi_devices_lock);
267
268 return ubi;
269}
270
271
272
273
274
275void ubi_put_device(struct ubi_device *ubi)
276{
277 spin_lock(&ubi_devices_lock);
278 ubi->ref_count -= 1;
279 put_device(&ubi->dev);
280 spin_unlock(&ubi_devices_lock);
281}
282
283
284
285
286
287
288
289
290struct ubi_device *ubi_get_by_major(int major)
291{
292 int i;
293 struct ubi_device *ubi;
294
295 spin_lock(&ubi_devices_lock);
296 for (i = 0; i < UBI_MAX_DEVICES; i++) {
297 ubi = ubi_devices[i];
298 if (ubi && MAJOR(ubi->cdev.dev) == major) {
299 ubi_assert(ubi->ref_count >= 0);
300 ubi->ref_count += 1;
301 get_device(&ubi->dev);
302 spin_unlock(&ubi_devices_lock);
303 return ubi;
304 }
305 }
306 spin_unlock(&ubi_devices_lock);
307
308 return NULL;
309}
310
311
312
313
314
315
316
317
318
319int ubi_major2num(int major)
320{
321 int i, ubi_num = -ENODEV;
322
323 spin_lock(&ubi_devices_lock);
324 for (i = 0; i < UBI_MAX_DEVICES; i++) {
325 struct ubi_device *ubi = ubi_devices[i];
326
327 if (ubi && MAJOR(ubi->cdev.dev) == major) {
328 ubi_num = ubi->ubi_num;
329 break;
330 }
331 }
332 spin_unlock(&ubi_devices_lock);
333
334 return ubi_num;
335}
336
337
338static ssize_t dev_attribute_show(struct device *dev,
339 struct device_attribute *attr, char *buf)
340{
341 ssize_t ret;
342 struct ubi_device *ubi;
343
344
345
346
347
348
349
350
351
352
353
354 ubi = container_of(dev, struct ubi_device, dev);
355 ubi = ubi_get_device(ubi->ubi_num);
356 if (!ubi)
357 return -ENODEV;
358
359 if (attr == &dev_eraseblock_size)
360 ret = sprintf(buf, "%d\n", ubi->leb_size);
361 else if (attr == &dev_avail_eraseblocks)
362 ret = sprintf(buf, "%d\n", ubi->avail_pebs);
363 else if (attr == &dev_total_eraseblocks)
364 ret = sprintf(buf, "%d\n", ubi->good_peb_count);
365 else if (attr == &dev_volumes_count)
366 ret = sprintf(buf, "%d\n", ubi->vol_count - UBI_INT_VOL_COUNT);
367 else if (attr == &dev_max_ec)
368 ret = sprintf(buf, "%d\n", ubi->max_ec);
369 else if (attr == &dev_reserved_for_bad)
370 ret = sprintf(buf, "%d\n", ubi->beb_rsvd_pebs);
371 else if (attr == &dev_bad_peb_count)
372 ret = sprintf(buf, "%d\n", ubi->bad_peb_count);
373 else if (attr == &dev_max_vol_count)
374 ret = sprintf(buf, "%d\n", ubi->vtbl_slots);
375 else if (attr == &dev_min_io_size)
376 ret = sprintf(buf, "%d\n", ubi->min_io_size);
377 else if (attr == &dev_bgt_enabled)
378 ret = sprintf(buf, "%d\n", ubi->thread_enabled);
379 else if (attr == &dev_mtd_num)
380 ret = sprintf(buf, "%d\n", ubi->mtd->index);
381 else
382 ret = -EINVAL;
383
384 ubi_put_device(ubi);
385 return ret;
386}
387
388static void dev_release(struct device *dev)
389{
390 struct ubi_device *ubi = container_of(dev, struct ubi_device, dev);
391
392 kfree(ubi);
393}
394
395
396
397
398
399
400
401
402
403
404static int ubi_sysfs_init(struct ubi_device *ubi, int *ref)
405{
406 int err;
407
408 ubi->dev.release = dev_release;
409 ubi->dev.devt = ubi->cdev.dev;
410 ubi->dev.class = ubi_class;
411 dev_set_name(&ubi->dev, UBI_NAME_STR"%d", ubi->ubi_num);
412 err = device_register(&ubi->dev);
413 if (err)
414 return err;
415
416 *ref = 1;
417 err = device_create_file(&ubi->dev, &dev_eraseblock_size);
418 if (err)
419 return err;
420 err = device_create_file(&ubi->dev, &dev_avail_eraseblocks);
421 if (err)
422 return err;
423 err = device_create_file(&ubi->dev, &dev_total_eraseblocks);
424 if (err)
425 return err;
426 err = device_create_file(&ubi->dev, &dev_volumes_count);
427 if (err)
428 return err;
429 err = device_create_file(&ubi->dev, &dev_max_ec);
430 if (err)
431 return err;
432 err = device_create_file(&ubi->dev, &dev_reserved_for_bad);
433 if (err)
434 return err;
435 err = device_create_file(&ubi->dev, &dev_bad_peb_count);
436 if (err)
437 return err;
438 err = device_create_file(&ubi->dev, &dev_max_vol_count);
439 if (err)
440 return err;
441 err = device_create_file(&ubi->dev, &dev_min_io_size);
442 if (err)
443 return err;
444 err = device_create_file(&ubi->dev, &dev_bgt_enabled);
445 if (err)
446 return err;
447 err = device_create_file(&ubi->dev, &dev_mtd_num);
448 return err;
449}
450
451
452
453
454
455static void ubi_sysfs_close(struct ubi_device *ubi)
456{
457 device_remove_file(&ubi->dev, &dev_mtd_num);
458 device_remove_file(&ubi->dev, &dev_bgt_enabled);
459 device_remove_file(&ubi->dev, &dev_min_io_size);
460 device_remove_file(&ubi->dev, &dev_max_vol_count);
461 device_remove_file(&ubi->dev, &dev_bad_peb_count);
462 device_remove_file(&ubi->dev, &dev_reserved_for_bad);
463 device_remove_file(&ubi->dev, &dev_max_ec);
464 device_remove_file(&ubi->dev, &dev_volumes_count);
465 device_remove_file(&ubi->dev, &dev_total_eraseblocks);
466 device_remove_file(&ubi->dev, &dev_avail_eraseblocks);
467 device_remove_file(&ubi->dev, &dev_eraseblock_size);
468 device_unregister(&ubi->dev);
469}
470
471
472
473
474
475static void kill_volumes(struct ubi_device *ubi)
476{
477 int i;
478
479 for (i = 0; i < ubi->vtbl_slots; i++)
480 if (ubi->volumes[i])
481 ubi_free_volume(ubi, ubi->volumes[i]);
482}
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502static int uif_init(struct ubi_device *ubi, int *ref)
503{
504 int i, err;
505 dev_t dev;
506
507 *ref = 0;
508 sprintf(ubi->ubi_name, UBI_NAME_STR "%d", ubi->ubi_num);
509
510
511
512
513
514
515
516
517
518 err = alloc_chrdev_region(&dev, 0, ubi->vtbl_slots + 1, ubi->ubi_name);
519 if (err) {
520 ubi_err(ubi, "cannot register UBI character devices");
521 return err;
522 }
523
524 ubi_assert(MINOR(dev) == 0);
525 cdev_init(&ubi->cdev, &ubi_cdev_operations);
526 dbg_gen("%s major is %u", ubi->ubi_name, MAJOR(dev));
527 ubi->cdev.owner = THIS_MODULE;
528
529 err = cdev_add(&ubi->cdev, dev, 1);
530 if (err) {
531 ubi_err(ubi, "cannot add character device");
532 goto out_unreg;
533 }
534
535 err = ubi_sysfs_init(ubi, ref);
536 if (err)
537 goto out_sysfs;
538
539 for (i = 0; i < ubi->vtbl_slots; i++)
540 if (ubi->volumes[i]) {
541 err = ubi_add_volume(ubi, ubi->volumes[i]);
542 if (err) {
543 ubi_err(ubi, "cannot add volume %d", i);
544 goto out_volumes;
545 }
546 }
547
548 return 0;
549
550out_volumes:
551 kill_volumes(ubi);
552out_sysfs:
553 if (*ref)
554 get_device(&ubi->dev);
555 ubi_sysfs_close(ubi);
556 cdev_del(&ubi->cdev);
557out_unreg:
558 unregister_chrdev_region(ubi->cdev.dev, ubi->vtbl_slots + 1);
559 ubi_err(ubi, "cannot initialize UBI %s, error %d",
560 ubi->ubi_name, err);
561 return err;
562}
563
564
565
566
567
568
569
570
571
572static void uif_close(struct ubi_device *ubi)
573{
574 kill_volumes(ubi);
575 ubi_sysfs_close(ubi);
576 cdev_del(&ubi->cdev);
577 unregister_chrdev_region(ubi->cdev.dev, ubi->vtbl_slots + 1);
578}
579
580
581
582
583
584void ubi_free_internal_volumes(struct ubi_device *ubi)
585{
586 int i;
587
588 for (i = ubi->vtbl_slots;
589 i < ubi->vtbl_slots + UBI_INT_VOL_COUNT; i++) {
590 kfree(ubi->volumes[i]->eba_tbl);
591 kfree(ubi->volumes[i]);
592 }
593}
594
595static int get_bad_peb_limit(const struct ubi_device *ubi, int max_beb_per1024)
596{
597 int limit, device_pebs;
598 uint64_t device_size;
599
600 if (!max_beb_per1024)
601 return 0;
602
603
604
605
606
607
608
609
610
611
612 device_size = mtd_get_device_size(ubi->mtd);
613 device_pebs = mtd_div_by_eb(device_size, ubi->mtd);
614 limit = mult_frac(device_pebs, max_beb_per1024, 1024);
615
616
617 if (mult_frac(limit, 1024, max_beb_per1024) < device_pebs)
618 limit += 1;
619
620 return limit;
621}
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639static int io_init(struct ubi_device *ubi, int max_beb_per1024)
640{
641 dbg_gen("sizeof(struct ubi_ainf_peb) %zu", sizeof(struct ubi_ainf_peb));
642 dbg_gen("sizeof(struct ubi_wl_entry) %zu", sizeof(struct ubi_wl_entry));
643
644 if (ubi->mtd->numeraseregions != 0) {
645
646
647
648
649
650
651
652
653
654 ubi_err(ubi, "multiple regions, not implemented");
655 return -EINVAL;
656 }
657
658 if (ubi->vid_hdr_offset < 0)
659 return -EINVAL;
660
661
662
663
664
665
666 ubi->peb_size = ubi->mtd->erasesize;
667 ubi->peb_count = mtd_div_by_eb(ubi->mtd->size, ubi->mtd);
668 ubi->flash_size = ubi->mtd->size;
669
670 if (mtd_can_have_bb(ubi->mtd)) {
671 ubi->bad_allowed = 1;
672 ubi->bad_peb_limit = get_bad_peb_limit(ubi, max_beb_per1024);
673 }
674
675 if (ubi->mtd->type == MTD_NORFLASH) {
676 ubi_assert(ubi->mtd->writesize == 1);
677 ubi->nor_flash = 1;
678 }
679
680 ubi->min_io_size = ubi->mtd->writesize;
681 ubi->hdrs_min_io_size = ubi->mtd->writesize >> ubi->mtd->subpage_sft;
682
683
684
685
686
687
688 if (!is_power_of_2(ubi->min_io_size)) {
689 ubi_err(ubi, "min. I/O unit (%d) is not power of 2",
690 ubi->min_io_size);
691 return -EINVAL;
692 }
693
694 ubi_assert(ubi->hdrs_min_io_size > 0);
695 ubi_assert(ubi->hdrs_min_io_size <= ubi->min_io_size);
696 ubi_assert(ubi->min_io_size % ubi->hdrs_min_io_size == 0);
697
698 ubi->max_write_size = ubi->mtd->writebufsize;
699
700
701
702
703 if (ubi->max_write_size < ubi->min_io_size ||
704 ubi->max_write_size % ubi->min_io_size ||
705 !is_power_of_2(ubi->max_write_size)) {
706 ubi_err(ubi, "bad write buffer size %d for %d min. I/O unit",
707 ubi->max_write_size, ubi->min_io_size);
708 return -EINVAL;
709 }
710
711
712 ubi->ec_hdr_alsize = ALIGN(UBI_EC_HDR_SIZE, ubi->hdrs_min_io_size);
713 ubi->vid_hdr_alsize = ALIGN(UBI_VID_HDR_SIZE, ubi->hdrs_min_io_size);
714
715 dbg_gen("min_io_size %d", ubi->min_io_size);
716 dbg_gen("max_write_size %d", ubi->max_write_size);
717 dbg_gen("hdrs_min_io_size %d", ubi->hdrs_min_io_size);
718 dbg_gen("ec_hdr_alsize %d", ubi->ec_hdr_alsize);
719 dbg_gen("vid_hdr_alsize %d", ubi->vid_hdr_alsize);
720
721 if (ubi->vid_hdr_offset == 0)
722
723 ubi->vid_hdr_offset = ubi->vid_hdr_aloffset =
724 ubi->ec_hdr_alsize;
725 else {
726 ubi->vid_hdr_aloffset = ubi->vid_hdr_offset &
727 ~(ubi->hdrs_min_io_size - 1);
728 ubi->vid_hdr_shift = ubi->vid_hdr_offset -
729 ubi->vid_hdr_aloffset;
730 }
731
732
733 ubi->leb_start = ubi->vid_hdr_offset + UBI_VID_HDR_SIZE;
734 ubi->leb_start = ALIGN(ubi->leb_start, ubi->min_io_size);
735
736 dbg_gen("vid_hdr_offset %d", ubi->vid_hdr_offset);
737 dbg_gen("vid_hdr_aloffset %d", ubi->vid_hdr_aloffset);
738 dbg_gen("vid_hdr_shift %d", ubi->vid_hdr_shift);
739 dbg_gen("leb_start %d", ubi->leb_start);
740
741
742 if (ubi->vid_hdr_shift % 4) {
743 ubi_err(ubi, "unaligned VID header shift %d",
744 ubi->vid_hdr_shift);
745 return -EINVAL;
746 }
747
748
749 if (ubi->vid_hdr_offset < UBI_EC_HDR_SIZE ||
750 ubi->leb_start < ubi->vid_hdr_offset + UBI_VID_HDR_SIZE ||
751 ubi->leb_start > ubi->peb_size - UBI_VID_HDR_SIZE ||
752 ubi->leb_start & (ubi->min_io_size - 1)) {
753 ubi_err(ubi, "bad VID header (%d) or data offsets (%d)",
754 ubi->vid_hdr_offset, ubi->leb_start);
755 return -EINVAL;
756 }
757
758
759
760
761
762 ubi->max_erroneous = ubi->peb_count / 10;
763 if (ubi->max_erroneous < 16)
764 ubi->max_erroneous = 16;
765 dbg_gen("max_erroneous %d", ubi->max_erroneous);
766
767
768
769
770
771
772 if (ubi->vid_hdr_offset + UBI_VID_HDR_SIZE <= ubi->hdrs_min_io_size) {
773 ubi_warn(ubi, "EC and VID headers are in the same minimal I/O unit, switch to read-only mode");
774 ubi->ro_mode = 1;
775 }
776
777 ubi->leb_size = ubi->peb_size - ubi->leb_start;
778
779 if (!(ubi->mtd->flags & MTD_WRITEABLE)) {
780 ubi_msg(ubi, "MTD device %d is write-protected, attach in read-only mode",
781 ubi->mtd->index);
782 ubi->ro_mode = 1;
783 }
784
785
786
787
788
789
790
791
792
793 return 0;
794}
795
796
797
798
799
800
801
802
803
804
805
806static int autoresize(struct ubi_device *ubi, int vol_id)
807{
808 struct ubi_volume_desc desc;
809 struct ubi_volume *vol = ubi->volumes[vol_id];
810 int err, old_reserved_pebs = vol->reserved_pebs;
811
812 if (ubi->ro_mode) {
813 ubi_warn(ubi, "skip auto-resize because of R/O mode");
814 return 0;
815 }
816
817
818
819
820
821
822 ubi->vtbl[vol_id].flags &= ~UBI_VTBL_AUTORESIZE_FLG;
823
824 if (ubi->avail_pebs == 0) {
825 struct ubi_vtbl_record vtbl_rec;
826
827
828
829
830
831 vtbl_rec = ubi->vtbl[vol_id];
832 err = ubi_change_vtbl_record(ubi, vol_id, &vtbl_rec);
833 if (err)
834 ubi_err(ubi, "cannot clean auto-resize flag for volume %d",
835 vol_id);
836 } else {
837 desc.vol = vol;
838 err = ubi_resize_volume(&desc,
839 old_reserved_pebs + ubi->avail_pebs);
840 if (err)
841 ubi_err(ubi, "cannot auto-resize volume %d",
842 vol_id);
843 }
844
845 if (err)
846 return err;
847
848 ubi_msg(ubi, "volume %d (\"%s\") re-sized from %d to %d LEBs",
849 vol_id, vol->name, old_reserved_pebs, vol->reserved_pebs);
850 return 0;
851}
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869int ubi_attach_mtd_dev(struct mtd_info *mtd, int ubi_num,
870 int vid_hdr_offset, int max_beb_per1024)
871{
872 struct ubi_device *ubi;
873 int i, err, ref = 0;
874
875 if (max_beb_per1024 < 0 || max_beb_per1024 > MAX_MTD_UBI_BEB_LIMIT)
876 return -EINVAL;
877
878 if (!max_beb_per1024)
879 max_beb_per1024 = CONFIG_MTD_UBI_BEB_LIMIT;
880
881
882
883
884
885
886
887 for (i = 0; i < UBI_MAX_DEVICES; i++) {
888 ubi = ubi_devices[i];
889 if (ubi && mtd->index == ubi->mtd->index) {
890 ubi_err(ubi, "mtd%d is already attached to ubi%d",
891 mtd->index, i);
892 return -EEXIST;
893 }
894 }
895
896
897
898
899
900
901
902
903
904 if (mtd->type == MTD_UBIVOLUME) {
905 ubi_err(ubi, "refuse attaching mtd%d - it is already emulated on top of UBI",
906 mtd->index);
907 return -EINVAL;
908 }
909
910 if (ubi_num == UBI_DEV_NUM_AUTO) {
911
912 for (ubi_num = 0; ubi_num < UBI_MAX_DEVICES; ubi_num++)
913 if (!ubi_devices[ubi_num])
914 break;
915 if (ubi_num == UBI_MAX_DEVICES) {
916 ubi_err(ubi, "only %d UBI devices may be created",
917 UBI_MAX_DEVICES);
918 return -ENFILE;
919 }
920 } else {
921 if (ubi_num >= UBI_MAX_DEVICES)
922 return -EINVAL;
923
924
925 if (ubi_devices[ubi_num]) {
926 ubi_err(ubi, "ubi%d already exists", ubi_num);
927 return -EEXIST;
928 }
929 }
930
931 ubi = kzalloc(sizeof(struct ubi_device), GFP_KERNEL);
932 if (!ubi)
933 return -ENOMEM;
934
935 ubi->mtd = mtd;
936 ubi->ubi_num = ubi_num;
937 ubi->vid_hdr_offset = vid_hdr_offset;
938 ubi->autoresize_vol_id = -1;
939
940#ifdef CONFIG_MTD_UBI_FASTMAP
941 ubi->fm_pool.used = ubi->fm_pool.size = 0;
942 ubi->fm_wl_pool.used = ubi->fm_wl_pool.size = 0;
943
944
945
946
947
948 ubi->fm_pool.max_size = min(((int)mtd_div_by_eb(ubi->mtd->size,
949 ubi->mtd) / 100) * 5, UBI_FM_MAX_POOL_SIZE);
950 if (ubi->fm_pool.max_size < UBI_FM_MIN_POOL_SIZE)
951 ubi->fm_pool.max_size = UBI_FM_MIN_POOL_SIZE;
952
953 ubi->fm_wl_pool.max_size = UBI_FM_WL_POOL_SIZE;
954 ubi->fm_disabled = !fm_autoconvert;
955
956 if (!ubi->fm_disabled && (int)mtd_div_by_eb(ubi->mtd->size, ubi->mtd)
957 <= UBI_FM_MAX_START) {
958 ubi_err(ubi, "More than %i PEBs are needed for fastmap, sorry.",
959 UBI_FM_MAX_START);
960 ubi->fm_disabled = 1;
961 }
962
963 ubi_msg(ubi, "default fastmap pool size: %d", ubi->fm_pool.max_size);
964 ubi_msg(ubi, "default fastmap WL pool size: %d",
965 ubi->fm_wl_pool.max_size);
966#else
967 ubi->fm_disabled = 1;
968#endif
969 mutex_init(&ubi->buf_mutex);
970 mutex_init(&ubi->ckvol_mutex);
971 mutex_init(&ubi->device_mutex);
972 spin_lock_init(&ubi->volumes_lock);
973 mutex_init(&ubi->fm_mutex);
974 init_rwsem(&ubi->fm_sem);
975
976 ubi_msg(ubi, "attaching mtd%d to ubi%d", mtd->index, ubi_num);
977
978 err = io_init(ubi, max_beb_per1024);
979 if (err)
980 goto out_free;
981
982 err = -ENOMEM;
983 ubi->peb_buf = vmalloc(ubi->peb_size);
984 if (!ubi->peb_buf)
985 goto out_free;
986
987#ifdef CONFIG_MTD_UBI_FASTMAP
988 ubi->fm_size = ubi_calc_fm_size(ubi);
989 ubi->fm_buf = vzalloc(ubi->fm_size);
990 if (!ubi->fm_buf)
991 goto out_free;
992#endif
993 err = ubi_attach(ubi, 0);
994 if (err) {
995 ubi_err(ubi, "failed to attach mtd%d, error %d",
996 mtd->index, err);
997 goto out_free;
998 }
999
1000 if (ubi->autoresize_vol_id != -1) {
1001 err = autoresize(ubi, ubi->autoresize_vol_id);
1002 if (err)
1003 goto out_detach;
1004 }
1005
1006 err = uif_init(ubi, &ref);
1007 if (err)
1008 goto out_detach;
1009
1010 err = ubi_debugfs_init_dev(ubi);
1011 if (err)
1012 goto out_uif;
1013
1014 ubi->bgt_thread = kthread_create(ubi_thread, ubi, "%s", ubi->bgt_name);
1015 if (IS_ERR(ubi->bgt_thread)) {
1016 err = PTR_ERR(ubi->bgt_thread);
1017 ubi_err(ubi, "cannot spawn \"%s\", error %d",
1018 ubi->bgt_name, err);
1019 goto out_debugfs;
1020 }
1021
1022 ubi_msg(ubi, "attached mtd%d (name \"%s\", size %llu MiB)",
1023 mtd->index, mtd->name, ubi->flash_size >> 20);
1024 ubi_msg(ubi, "PEB size: %d bytes (%d KiB), LEB size: %d bytes",
1025 ubi->peb_size, ubi->peb_size >> 10, ubi->leb_size);
1026 ubi_msg(ubi, "min./max. I/O unit sizes: %d/%d, sub-page size %d",
1027 ubi->min_io_size, ubi->max_write_size, ubi->hdrs_min_io_size);
1028 ubi_msg(ubi, "VID header offset: %d (aligned %d), data offset: %d",
1029 ubi->vid_hdr_offset, ubi->vid_hdr_aloffset, ubi->leb_start);
1030 ubi_msg(ubi, "good PEBs: %d, bad PEBs: %d, corrupted PEBs: %d",
1031 ubi->good_peb_count, ubi->bad_peb_count, ubi->corr_peb_count);
1032 ubi_msg(ubi, "user volume: %d, internal volumes: %d, max. volumes count: %d",
1033 ubi->vol_count - UBI_INT_VOL_COUNT, UBI_INT_VOL_COUNT,
1034 ubi->vtbl_slots);
1035 ubi_msg(ubi, "max/mean erase counter: %d/%d, WL threshold: %d, image sequence number: %u",
1036 ubi->max_ec, ubi->mean_ec, CONFIG_MTD_UBI_WL_THRESHOLD,
1037 ubi->image_seq);
1038 ubi_msg(ubi, "available PEBs: %d, total reserved PEBs: %d, PEBs reserved for bad PEB handling: %d",
1039 ubi->avail_pebs, ubi->rsvd_pebs, ubi->beb_rsvd_pebs);
1040
1041
1042
1043
1044
1045 spin_lock(&ubi->wl_lock);
1046 ubi->thread_enabled = 1;
1047 wake_up_process(ubi->bgt_thread);
1048 spin_unlock(&ubi->wl_lock);
1049
1050 ubi_devices[ubi_num] = ubi;
1051 ubi_notify_all(ubi, UBI_VOLUME_ADDED, NULL);
1052 return ubi_num;
1053
1054out_debugfs:
1055 ubi_debugfs_exit_dev(ubi);
1056out_uif:
1057 get_device(&ubi->dev);
1058 ubi_assert(ref);
1059 uif_close(ubi);
1060out_detach:
1061 ubi_wl_close(ubi);
1062 ubi_free_internal_volumes(ubi);
1063 vfree(ubi->vtbl);
1064out_free:
1065 vfree(ubi->peb_buf);
1066 vfree(ubi->fm_buf);
1067 if (ref)
1068 put_device(&ubi->dev);
1069 else
1070 kfree(ubi);
1071 return err;
1072}
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087int ubi_detach_mtd_dev(int ubi_num, int anyway)
1088{
1089 struct ubi_device *ubi;
1090
1091 if (ubi_num < 0 || ubi_num >= UBI_MAX_DEVICES)
1092 return -EINVAL;
1093
1094 ubi = ubi_get_device(ubi_num);
1095 if (!ubi)
1096 return -EINVAL;
1097
1098 spin_lock(&ubi_devices_lock);
1099 put_device(&ubi->dev);
1100 ubi->ref_count -= 1;
1101 if (ubi->ref_count) {
1102 if (!anyway) {
1103 spin_unlock(&ubi_devices_lock);
1104 return -EBUSY;
1105 }
1106
1107 ubi_err(ubi, "%s reference count %d, destroy anyway",
1108 ubi->ubi_name, ubi->ref_count);
1109 }
1110 ubi_devices[ubi_num] = NULL;
1111 spin_unlock(&ubi_devices_lock);
1112
1113 ubi_assert(ubi_num == ubi->ubi_num);
1114 ubi_notify_all(ubi, UBI_VOLUME_REMOVED, NULL);
1115 ubi_msg(ubi, "detaching mtd%d", ubi->mtd->index);
1116#ifdef CONFIG_MTD_UBI_FASTMAP
1117
1118
1119 ubi_update_fastmap(ubi);
1120#endif
1121
1122
1123
1124
1125 if (ubi->bgt_thread)
1126 kthread_stop(ubi->bgt_thread);
1127
1128
1129
1130
1131
1132 get_device(&ubi->dev);
1133
1134 ubi_debugfs_exit_dev(ubi);
1135 uif_close(ubi);
1136
1137 ubi_wl_close(ubi);
1138 ubi_free_internal_volumes(ubi);
1139 vfree(ubi->vtbl);
1140 put_mtd_device(ubi->mtd);
1141 vfree(ubi->peb_buf);
1142 vfree(ubi->fm_buf);
1143 ubi_msg(ubi, "mtd%d is detached", ubi->mtd->index);
1144 put_device(&ubi->dev);
1145 return 0;
1146}
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156static struct mtd_info * __init open_mtd_by_chdev(const char *mtd_dev)
1157{
1158 int err, major, minor, mode;
1159 struct path path;
1160
1161
1162 err = kern_path(mtd_dev, LOOKUP_FOLLOW, &path);
1163 if (err)
1164 return ERR_PTR(err);
1165
1166
1167 major = imajor(path.dentry->d_inode);
1168 minor = iminor(path.dentry->d_inode);
1169 mode = path.dentry->d_inode->i_mode;
1170 path_put(&path);
1171 if (major != MTD_CHAR_MAJOR || !S_ISCHR(mode))
1172 return ERR_PTR(-EINVAL);
1173
1174 if (minor & 1)
1175
1176
1177
1178
1179 return ERR_PTR(-EINVAL);
1180
1181 return get_mtd_device(NULL, minor / 2);
1182}
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194static struct mtd_info * __init open_mtd_device(const char *mtd_dev)
1195{
1196 struct mtd_info *mtd;
1197 int mtd_num;
1198 char *endp;
1199
1200 mtd_num = simple_strtoul(mtd_dev, &endp, 0);
1201 if (*endp != '\0' || mtd_dev == endp) {
1202
1203
1204
1205
1206 mtd = get_mtd_device_nm(mtd_dev);
1207 if (IS_ERR(mtd) && PTR_ERR(mtd) == -ENODEV)
1208
1209 mtd = open_mtd_by_chdev(mtd_dev);
1210 } else
1211 mtd = get_mtd_device(NULL, mtd_num);
1212
1213 return mtd;
1214}
1215
1216static int __init ubi_init(void)
1217{
1218 int err, i, k;
1219
1220
1221 BUILD_BUG_ON(sizeof(struct ubi_ec_hdr) != 64);
1222 BUILD_BUG_ON(sizeof(struct ubi_vid_hdr) != 64);
1223
1224 if (mtd_devs > UBI_MAX_DEVICES) {
1225 pr_err("UBI error: too many MTD devices, maximum is %d",
1226 UBI_MAX_DEVICES);
1227 return -EINVAL;
1228 }
1229
1230
1231 ubi_class = class_create(THIS_MODULE, UBI_NAME_STR);
1232 if (IS_ERR(ubi_class)) {
1233 err = PTR_ERR(ubi_class);
1234 pr_err("UBI error: cannot create UBI class");
1235 goto out;
1236 }
1237
1238 err = class_create_file(ubi_class, &ubi_version);
1239 if (err) {
1240 pr_err("UBI error: cannot create sysfs file");
1241 goto out_class;
1242 }
1243
1244 err = misc_register(&ubi_ctrl_cdev);
1245 if (err) {
1246 pr_err("UBI error: cannot register device");
1247 goto out_version;
1248 }
1249
1250 ubi_wl_entry_slab = kmem_cache_create("ubi_wl_entry_slab",
1251 sizeof(struct ubi_wl_entry),
1252 0, 0, NULL);
1253 if (!ubi_wl_entry_slab) {
1254 err = -ENOMEM;
1255 goto out_dev_unreg;
1256 }
1257
1258 err = ubi_debugfs_init();
1259 if (err)
1260 goto out_slab;
1261
1262
1263
1264 for (i = 0; i < mtd_devs; i++) {
1265 struct mtd_dev_param *p = &mtd_dev_param[i];
1266 struct mtd_info *mtd;
1267
1268 cond_resched();
1269
1270 mtd = open_mtd_device(p->name);
1271 if (IS_ERR(mtd)) {
1272 err = PTR_ERR(mtd);
1273 pr_err("UBI error: cannot open mtd %s, error %d",
1274 p->name, err);
1275
1276 if (ubi_is_module())
1277 goto out_detach;
1278 continue;
1279 }
1280
1281 mutex_lock(&ubi_devices_mutex);
1282 err = ubi_attach_mtd_dev(mtd, p->ubi_num,
1283 p->vid_hdr_offs, p->max_beb_per1024);
1284 mutex_unlock(&ubi_devices_mutex);
1285 if (err < 0) {
1286 pr_err("UBI error: cannot attach mtd%d",
1287 mtd->index);
1288 put_mtd_device(mtd);
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303 if (ubi_is_module())
1304 goto out_detach;
1305 }
1306 }
1307
1308 err = ubiblock_init();
1309 if (err) {
1310 pr_err("UBI error: block: cannot initialize, error %d", err);
1311
1312
1313 if (ubi_is_module())
1314 goto out_detach;
1315 }
1316
1317 return 0;
1318
1319out_detach:
1320 for (k = 0; k < i; k++)
1321 if (ubi_devices[k]) {
1322 mutex_lock(&ubi_devices_mutex);
1323 ubi_detach_mtd_dev(ubi_devices[k]->ubi_num, 1);
1324 mutex_unlock(&ubi_devices_mutex);
1325 }
1326 ubi_debugfs_exit();
1327out_slab:
1328 kmem_cache_destroy(ubi_wl_entry_slab);
1329out_dev_unreg:
1330 misc_deregister(&ubi_ctrl_cdev);
1331out_version:
1332 class_remove_file(ubi_class, &ubi_version);
1333out_class:
1334 class_destroy(ubi_class);
1335out:
1336 pr_err("UBI error: cannot initialize UBI, error %d", err);
1337 return err;
1338}
1339late_initcall(ubi_init);
1340
1341static void __exit ubi_exit(void)
1342{
1343 int i;
1344
1345 ubiblock_exit();
1346
1347 for (i = 0; i < UBI_MAX_DEVICES; i++)
1348 if (ubi_devices[i]) {
1349 mutex_lock(&ubi_devices_mutex);
1350 ubi_detach_mtd_dev(ubi_devices[i]->ubi_num, 1);
1351 mutex_unlock(&ubi_devices_mutex);
1352 }
1353 ubi_debugfs_exit();
1354 kmem_cache_destroy(ubi_wl_entry_slab);
1355 misc_deregister(&ubi_ctrl_cdev);
1356 class_remove_file(ubi_class, &ubi_version);
1357 class_destroy(ubi_class);
1358}
1359module_exit(ubi_exit);
1360
1361
1362
1363
1364
1365
1366
1367
1368static int __init bytes_str_to_int(const char *str)
1369{
1370 char *endp;
1371 unsigned long result;
1372
1373 result = simple_strtoul(str, &endp, 0);
1374 if (str == endp || result >= INT_MAX) {
1375 pr_err("UBI error: incorrect bytes count: \"%s\"\n", str);
1376 return -EINVAL;
1377 }
1378
1379 switch (*endp) {
1380 case 'G':
1381 result *= 1024;
1382 case 'M':
1383 result *= 1024;
1384 case 'K':
1385 result *= 1024;
1386 if (endp[1] == 'i' && endp[2] == 'B')
1387 endp += 2;
1388 case '\0':
1389 break;
1390 default:
1391 pr_err("UBI error: incorrect bytes count: \"%s\"\n", str);
1392 return -EINVAL;
1393 }
1394
1395 return result;
1396}
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406static int __init ubi_mtd_param_parse(const char *val, struct kernel_param *kp)
1407{
1408 int i, len;
1409 struct mtd_dev_param *p;
1410 char buf[MTD_PARAM_LEN_MAX];
1411 char *pbuf = &buf[0];
1412 char *tokens[MTD_PARAM_MAX_COUNT], *token;
1413
1414 if (!val)
1415 return -EINVAL;
1416
1417 if (mtd_devs == UBI_MAX_DEVICES) {
1418 pr_err("UBI error: too many parameters, max. is %d\n",
1419 UBI_MAX_DEVICES);
1420 return -EINVAL;
1421 }
1422
1423 len = strnlen(val, MTD_PARAM_LEN_MAX);
1424 if (len == MTD_PARAM_LEN_MAX) {
1425 pr_err("UBI error: parameter \"%s\" is too long, max. is %d\n",
1426 val, MTD_PARAM_LEN_MAX);
1427 return -EINVAL;
1428 }
1429
1430 if (len == 0) {
1431 pr_err("UBI warning: empty 'mtd=' parameter - ignored\n");
1432 return 0;
1433 }
1434
1435 strcpy(buf, val);
1436
1437
1438 if (buf[len - 1] == '\n')
1439 buf[len - 1] = '\0';
1440
1441 for (i = 0; i < MTD_PARAM_MAX_COUNT; i++)
1442 tokens[i] = strsep(&pbuf, ",");
1443
1444 if (pbuf) {
1445 pr_err("UBI error: too many arguments at \"%s\"\n", val);
1446 return -EINVAL;
1447 }
1448
1449 p = &mtd_dev_param[mtd_devs];
1450 strcpy(&p->name[0], tokens[0]);
1451
1452 token = tokens[1];
1453 if (token) {
1454 p->vid_hdr_offs = bytes_str_to_int(token);
1455
1456 if (p->vid_hdr_offs < 0)
1457 return p->vid_hdr_offs;
1458 }
1459
1460 token = tokens[2];
1461 if (token) {
1462 int err = kstrtoint(token, 10, &p->max_beb_per1024);
1463
1464 if (err) {
1465 pr_err("UBI error: bad value for max_beb_per1024 parameter: %s",
1466 token);
1467 return -EINVAL;
1468 }
1469 }
1470
1471 token = tokens[3];
1472 if (token) {
1473 int err = kstrtoint(token, 10, &p->ubi_num);
1474
1475 if (err) {
1476 pr_err("UBI error: bad value for ubi_num parameter: %s",
1477 token);
1478 return -EINVAL;
1479 }
1480 } else
1481 p->ubi_num = UBI_DEV_NUM_AUTO;
1482
1483 mtd_devs += 1;
1484 return 0;
1485}
1486
1487module_param_call(mtd, ubi_mtd_param_parse, NULL, NULL, 000);
1488MODULE_PARM_DESC(mtd, "MTD devices to attach. Parameter format: mtd=<name|num|path>[,<vid_hdr_offs>[,max_beb_per1024[,ubi_num]]].\n"
1489 "Multiple \"mtd\" parameters may be specified.\n"
1490 "MTD devices may be specified by their number, name, or path to the MTD character device node.\n"
1491 "Optional \"vid_hdr_offs\" parameter specifies UBI VID header position to be used by UBI. (default value if 0)\n"
1492 "Optional \"max_beb_per1024\" parameter specifies the maximum expected bad eraseblock per 1024 eraseblocks. (default value ("
1493 __stringify(CONFIG_MTD_UBI_BEB_LIMIT) ") if 0)\n"
1494 "Optional \"ubi_num\" parameter specifies UBI device number which have to be assigned to the newly created UBI device (assigned automatically by default)\n"
1495 "\n"
1496 "Example 1: mtd=/dev/mtd0 - attach MTD device /dev/mtd0.\n"
1497 "Example 2: mtd=content,1984 mtd=4 - attach MTD device with name \"content\" using VID header offset 1984, and MTD device number 4 with default VID header offset.\n"
1498 "Example 3: mtd=/dev/mtd1,0,25 - attach MTD device /dev/mtd1 using default VID header offset and reserve 25*nand_size_in_blocks/1024 erase blocks for bad block handling.\n"
1499 "Example 4: mtd=/dev/mtd1,0,0,5 - attach MTD device /dev/mtd1 to UBI 5 and using default values for the other fields.\n"
1500 "\t(e.g. if the NAND *chipset* has 4096 PEB, 100 will be reserved for this UBI device).");
1501#ifdef CONFIG_MTD_UBI_FASTMAP
1502module_param(fm_autoconvert, bool, 0644);
1503MODULE_PARM_DESC(fm_autoconvert, "Set this parameter to enable fastmap automatically on images without a fastmap.");
1504#endif
1505MODULE_VERSION(__stringify(UBI_VERSION));
1506MODULE_DESCRIPTION("UBI - Unsorted Block Images");
1507MODULE_AUTHOR("Artem Bityutskiy");
1508MODULE_LICENSE("GPL");
1509