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