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