Commit | Line | Data |
---|---|---|
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". | |
30 | * | |
31 | * At the moment we only attach UBI devices by scanning, which will become a | |
32 | * bottleneck when flashes reach certain large size. Then one may improve UBI | |
33 | * and add other methods, although it does not seem to be easy to do. | |
801c135c AB |
34 | */ |
35 | ||
36 | #include <linux/err.h> | |
37 | #include <linux/module.h> | |
38 | #include <linux/moduleparam.h> | |
39 | #include <linux/stringify.h> | |
40 | #include <linux/stat.h> | |
9f961b57 | 41 | #include <linux/miscdevice.h> |
7753f169 | 42 | #include <linux/log2.h> |
cdfa788a | 43 | #include <linux/kthread.h> |
801c135c AB |
44 | #include "ubi.h" |
45 | ||
46 | /* Maximum length of the 'mtd=' parameter */ | |
47 | #define MTD_PARAM_LEN_MAX 64 | |
48 | ||
49 | /** | |
50 | * struct mtd_dev_param - MTD device parameter description data structure. | |
51 | * @name: MTD device name or number string | |
52 | * @vid_hdr_offs: VID header offset | |
801c135c AB |
53 | */ |
54 | struct mtd_dev_param | |
55 | { | |
56 | char name[MTD_PARAM_LEN_MAX]; | |
57 | int vid_hdr_offs; | |
801c135c AB |
58 | }; |
59 | ||
60 | /* Numbers of elements set in the @mtd_dev_param array */ | |
61 | static int mtd_devs = 0; | |
62 | ||
63 | /* MTD devices specification parameters */ | |
64 | static struct mtd_dev_param mtd_dev_param[UBI_MAX_DEVICES]; | |
65 | ||
801c135c AB |
66 | /* Root UBI "class" object (corresponds to '/<sysfs>/class/ubi/') */ |
67 | struct class *ubi_class; | |
68 | ||
3a8d4642 AB |
69 | /* Slab cache for lock-tree entries */ |
70 | struct kmem_cache *ubi_ltree_slab; | |
71 | ||
06b68ba1 AB |
72 | /* Slab cache for wear-leveling entries */ |
73 | struct kmem_cache *ubi_wl_entry_slab; | |
74 | ||
9f961b57 AB |
75 | /* UBI control character device */ |
76 | static struct miscdevice ubi_ctrl_cdev = { | |
77 | .minor = MISC_DYNAMIC_MINOR, | |
78 | .name = "ubi_ctrl", | |
79 | .fops = &ubi_ctrl_cdev_operations, | |
80 | }; | |
06b68ba1 | 81 | |
e73f4459 AB |
82 | /* All UBI devices in system */ |
83 | static struct ubi_device *ubi_devices[UBI_MAX_DEVICES]; | |
84 | ||
cdfa788a AB |
85 | /* Serializes UBI devices creations and removals */ |
86 | DEFINE_MUTEX(ubi_devices_mutex); | |
87 | ||
e73f4459 AB |
88 | /* Protects @ubi_devices and @ubi->ref_count */ |
89 | static DEFINE_SPINLOCK(ubi_devices_lock); | |
90 | ||
801c135c AB |
91 | /* "Show" method for files in '/<sysfs>/class/ubi/' */ |
92 | static ssize_t ubi_version_show(struct class *class, char *buf) | |
93 | { | |
94 | return sprintf(buf, "%d\n", UBI_VERSION); | |
95 | } | |
96 | ||
97 | /* UBI version attribute ('/<sysfs>/class/ubi/version') */ | |
98 | static struct class_attribute ubi_version = | |
99 | __ATTR(version, S_IRUGO, ubi_version_show, NULL); | |
100 | ||
101 | static ssize_t dev_attribute_show(struct device *dev, | |
102 | struct device_attribute *attr, char *buf); | |
103 | ||
104 | /* UBI device attributes (correspond to files in '/<sysfs>/class/ubi/ubiX') */ | |
105 | static struct device_attribute dev_eraseblock_size = | |
106 | __ATTR(eraseblock_size, S_IRUGO, dev_attribute_show, NULL); | |
107 | static struct device_attribute dev_avail_eraseblocks = | |
108 | __ATTR(avail_eraseblocks, S_IRUGO, dev_attribute_show, NULL); | |
109 | static struct device_attribute dev_total_eraseblocks = | |
110 | __ATTR(total_eraseblocks, S_IRUGO, dev_attribute_show, NULL); | |
111 | static struct device_attribute dev_volumes_count = | |
112 | __ATTR(volumes_count, S_IRUGO, dev_attribute_show, NULL); | |
113 | static struct device_attribute dev_max_ec = | |
114 | __ATTR(max_ec, S_IRUGO, dev_attribute_show, NULL); | |
115 | static struct device_attribute dev_reserved_for_bad = | |
116 | __ATTR(reserved_for_bad, S_IRUGO, dev_attribute_show, NULL); | |
117 | static struct device_attribute dev_bad_peb_count = | |
118 | __ATTR(bad_peb_count, S_IRUGO, dev_attribute_show, NULL); | |
119 | static struct device_attribute dev_max_vol_count = | |
120 | __ATTR(max_vol_count, S_IRUGO, dev_attribute_show, NULL); | |
121 | static struct device_attribute dev_min_io_size = | |
122 | __ATTR(min_io_size, S_IRUGO, dev_attribute_show, NULL); | |
123 | static struct device_attribute dev_bgt_enabled = | |
124 | __ATTR(bgt_enabled, S_IRUGO, dev_attribute_show, NULL); | |
125 | ||
e73f4459 AB |
126 | /** |
127 | * ubi_get_device - get UBI device. | |
128 | * @ubi_num: UBI device number | |
129 | * | |
130 | * This function returns UBI device description object for UBI device number | |
131 | * @ubi_num, or %NULL if the device does not exist. This function increases the | |
132 | * device reference count to prevent removal of the device. In other words, the | |
133 | * device cannot be removed if its reference count is not zero. | |
134 | */ | |
135 | struct ubi_device *ubi_get_device(int ubi_num) | |
136 | { | |
137 | struct ubi_device *ubi; | |
138 | ||
139 | spin_lock(&ubi_devices_lock); | |
140 | ubi = ubi_devices[ubi_num]; | |
141 | if (ubi) { | |
142 | ubi_assert(ubi->ref_count >= 0); | |
143 | ubi->ref_count += 1; | |
144 | get_device(&ubi->dev); | |
145 | } | |
146 | spin_unlock(&ubi_devices_lock); | |
147 | ||
148 | return ubi; | |
149 | } | |
150 | ||
151 | /** | |
152 | * ubi_put_device - drop an UBI device reference. | |
153 | * @ubi: UBI device description object | |
154 | */ | |
155 | void ubi_put_device(struct ubi_device *ubi) | |
156 | { | |
157 | spin_lock(&ubi_devices_lock); | |
158 | ubi->ref_count -= 1; | |
159 | put_device(&ubi->dev); | |
160 | spin_unlock(&ubi_devices_lock); | |
161 | } | |
162 | ||
163 | /** | |
164 | * ubi_get_by_major - get UBI device description object by character device | |
165 | * major number. | |
166 | * @major: major number | |
167 | * | |
168 | * This function is similar to 'ubi_get_device()', but it searches the device | |
169 | * by its major number. | |
170 | */ | |
171 | struct ubi_device *ubi_get_by_major(int major) | |
172 | { | |
173 | int i; | |
174 | struct ubi_device *ubi; | |
175 | ||
176 | spin_lock(&ubi_devices_lock); | |
177 | for (i = 0; i < UBI_MAX_DEVICES; i++) { | |
178 | ubi = ubi_devices[i]; | |
179 | if (ubi && MAJOR(ubi->cdev.dev) == major) { | |
180 | ubi_assert(ubi->ref_count >= 0); | |
181 | ubi->ref_count += 1; | |
182 | get_device(&ubi->dev); | |
183 | spin_unlock(&ubi_devices_lock); | |
184 | return ubi; | |
185 | } | |
186 | } | |
187 | spin_unlock(&ubi_devices_lock); | |
188 | ||
189 | return NULL; | |
190 | } | |
191 | ||
192 | /** | |
193 | * ubi_major2num - get UBI device number by character device major number. | |
194 | * @major: major number | |
195 | * | |
196 | * This function searches UBI device number object by its major number. If UBI | |
cdfa788a | 197 | * device was not found, this function returns -ENODEV, otherwise the UBI device |
e73f4459 AB |
198 | * number is returned. |
199 | */ | |
200 | int ubi_major2num(int major) | |
201 | { | |
202 | int i, ubi_num = -ENODEV; | |
203 | ||
204 | spin_lock(&ubi_devices_lock); | |
205 | for (i = 0; i < UBI_MAX_DEVICES; i++) { | |
206 | struct ubi_device *ubi = ubi_devices[i]; | |
207 | ||
208 | if (ubi && MAJOR(ubi->cdev.dev) == major) { | |
209 | ubi_num = ubi->ubi_num; | |
210 | break; | |
211 | } | |
212 | } | |
213 | spin_unlock(&ubi_devices_lock); | |
214 | ||
215 | return ubi_num; | |
216 | } | |
217 | ||
801c135c AB |
218 | /* "Show" method for files in '/<sysfs>/class/ubi/ubiX/' */ |
219 | static ssize_t dev_attribute_show(struct device *dev, | |
220 | struct device_attribute *attr, char *buf) | |
221 | { | |
e73f4459 AB |
222 | ssize_t ret; |
223 | struct ubi_device *ubi; | |
801c135c | 224 | |
e73f4459 AB |
225 | /* |
226 | * The below code looks weird, but it actually makes sense. We get the | |
227 | * UBI device reference from the contained 'struct ubi_device'. But it | |
228 | * is unclear if the device was removed or not yet. Indeed, if the | |
229 | * device was removed before we increased its reference count, | |
230 | * 'ubi_get_device()' will return -ENODEV and we fail. | |
231 | * | |
232 | * Remember, 'struct ubi_device' is freed in the release function, so | |
233 | * we still can use 'ubi->ubi_num'. | |
234 | */ | |
801c135c | 235 | ubi = container_of(dev, struct ubi_device, dev); |
e73f4459 AB |
236 | ubi = ubi_get_device(ubi->ubi_num); |
237 | if (!ubi) | |
238 | return -ENODEV; | |
239 | ||
801c135c | 240 | if (attr == &dev_eraseblock_size) |
e73f4459 | 241 | ret = sprintf(buf, "%d\n", ubi->leb_size); |
801c135c | 242 | else if (attr == &dev_avail_eraseblocks) |
e73f4459 | 243 | ret = sprintf(buf, "%d\n", ubi->avail_pebs); |
801c135c | 244 | else if (attr == &dev_total_eraseblocks) |
e73f4459 | 245 | ret = sprintf(buf, "%d\n", ubi->good_peb_count); |
801c135c | 246 | else if (attr == &dev_volumes_count) |
e73f4459 | 247 | ret = sprintf(buf, "%d\n", ubi->vol_count); |
801c135c | 248 | else if (attr == &dev_max_ec) |
e73f4459 | 249 | ret = sprintf(buf, "%d\n", ubi->max_ec); |
801c135c | 250 | else if (attr == &dev_reserved_for_bad) |
e73f4459 | 251 | ret = sprintf(buf, "%d\n", ubi->beb_rsvd_pebs); |
801c135c | 252 | else if (attr == &dev_bad_peb_count) |
e73f4459 | 253 | ret = sprintf(buf, "%d\n", ubi->bad_peb_count); |
801c135c | 254 | else if (attr == &dev_max_vol_count) |
e73f4459 | 255 | ret = sprintf(buf, "%d\n", ubi->vtbl_slots); |
801c135c | 256 | else if (attr == &dev_min_io_size) |
e73f4459 | 257 | ret = sprintf(buf, "%d\n", ubi->min_io_size); |
801c135c | 258 | else if (attr == &dev_bgt_enabled) |
e73f4459 | 259 | ret = sprintf(buf, "%d\n", ubi->thread_enabled); |
801c135c AB |
260 | else |
261 | BUG(); | |
262 | ||
e73f4459 AB |
263 | ubi_put_device(ubi); |
264 | return ret; | |
801c135c AB |
265 | } |
266 | ||
267 | /* Fake "release" method for UBI devices */ | |
268 | static void dev_release(struct device *dev) { } | |
269 | ||
270 | /** | |
271 | * ubi_sysfs_init - initialize sysfs for an UBI device. | |
272 | * @ubi: UBI device description object | |
273 | * | |
274 | * This function returns zero in case of success and a negative error code in | |
275 | * case of failure. | |
276 | */ | |
277 | static int ubi_sysfs_init(struct ubi_device *ubi) | |
278 | { | |
279 | int err; | |
280 | ||
281 | ubi->dev.release = dev_release; | |
49dfc299 | 282 | ubi->dev.devt = ubi->cdev.dev; |
801c135c AB |
283 | ubi->dev.class = ubi_class; |
284 | sprintf(&ubi->dev.bus_id[0], UBI_NAME_STR"%d", ubi->ubi_num); | |
285 | err = device_register(&ubi->dev); | |
286 | if (err) | |
db6e5770 | 287 | return err; |
801c135c AB |
288 | |
289 | err = device_create_file(&ubi->dev, &dev_eraseblock_size); | |
290 | if (err) | |
db6e5770 | 291 | return err; |
801c135c AB |
292 | err = device_create_file(&ubi->dev, &dev_avail_eraseblocks); |
293 | if (err) | |
db6e5770 | 294 | return err; |
801c135c AB |
295 | err = device_create_file(&ubi->dev, &dev_total_eraseblocks); |
296 | if (err) | |
db6e5770 | 297 | return err; |
801c135c AB |
298 | err = device_create_file(&ubi->dev, &dev_volumes_count); |
299 | if (err) | |
db6e5770 | 300 | return err; |
801c135c AB |
301 | err = device_create_file(&ubi->dev, &dev_max_ec); |
302 | if (err) | |
db6e5770 | 303 | return err; |
801c135c AB |
304 | err = device_create_file(&ubi->dev, &dev_reserved_for_bad); |
305 | if (err) | |
db6e5770 | 306 | return err; |
801c135c AB |
307 | err = device_create_file(&ubi->dev, &dev_bad_peb_count); |
308 | if (err) | |
db6e5770 | 309 | return err; |
801c135c AB |
310 | err = device_create_file(&ubi->dev, &dev_max_vol_count); |
311 | if (err) | |
db6e5770 | 312 | return err; |
801c135c AB |
313 | err = device_create_file(&ubi->dev, &dev_min_io_size); |
314 | if (err) | |
db6e5770 | 315 | return err; |
801c135c | 316 | err = device_create_file(&ubi->dev, &dev_bgt_enabled); |
801c135c AB |
317 | return err; |
318 | } | |
319 | ||
320 | /** | |
321 | * ubi_sysfs_close - close sysfs for an UBI device. | |
322 | * @ubi: UBI device description object | |
323 | */ | |
324 | static void ubi_sysfs_close(struct ubi_device *ubi) | |
325 | { | |
326 | device_remove_file(&ubi->dev, &dev_bgt_enabled); | |
327 | device_remove_file(&ubi->dev, &dev_min_io_size); | |
328 | device_remove_file(&ubi->dev, &dev_max_vol_count); | |
329 | device_remove_file(&ubi->dev, &dev_bad_peb_count); | |
330 | device_remove_file(&ubi->dev, &dev_reserved_for_bad); | |
331 | device_remove_file(&ubi->dev, &dev_max_ec); | |
332 | device_remove_file(&ubi->dev, &dev_volumes_count); | |
333 | device_remove_file(&ubi->dev, &dev_total_eraseblocks); | |
334 | device_remove_file(&ubi->dev, &dev_avail_eraseblocks); | |
335 | device_remove_file(&ubi->dev, &dev_eraseblock_size); | |
336 | device_unregister(&ubi->dev); | |
337 | } | |
338 | ||
339 | /** | |
340 | * kill_volumes - destroy all volumes. | |
341 | * @ubi: UBI device description object | |
342 | */ | |
343 | static void kill_volumes(struct ubi_device *ubi) | |
344 | { | |
345 | int i; | |
346 | ||
347 | for (i = 0; i < ubi->vtbl_slots; i++) | |
348 | if (ubi->volumes[i]) | |
89b96b69 | 349 | ubi_free_volume(ubi, ubi->volumes[i]); |
801c135c AB |
350 | } |
351 | ||
352 | /** | |
353 | * uif_init - initialize user interfaces for an UBI device. | |
354 | * @ubi: UBI device description object | |
355 | * | |
356 | * This function returns zero in case of success and a negative error code in | |
357 | * case of failure. | |
358 | */ | |
359 | static int uif_init(struct ubi_device *ubi) | |
360 | { | |
361 | int i, err; | |
362 | dev_t dev; | |
363 | ||
cae0a771 | 364 | mutex_init(&ubi->volumes_mutex); |
801c135c AB |
365 | spin_lock_init(&ubi->volumes_lock); |
366 | ||
367 | sprintf(ubi->ubi_name, UBI_NAME_STR "%d", ubi->ubi_num); | |
368 | ||
369 | /* | |
370 | * Major numbers for the UBI character devices are allocated | |
371 | * dynamically. Major numbers of volume character devices are | |
372 | * equivalent to ones of the corresponding UBI character device. Minor | |
373 | * numbers of UBI character devices are 0, while minor numbers of | |
374 | * volume character devices start from 1. Thus, we allocate one major | |
375 | * number and ubi->vtbl_slots + 1 minor numbers. | |
376 | */ | |
377 | err = alloc_chrdev_region(&dev, 0, ubi->vtbl_slots + 1, ubi->ubi_name); | |
378 | if (err) { | |
379 | ubi_err("cannot register UBI character devices"); | |
380 | return err; | |
381 | } | |
382 | ||
49dfc299 | 383 | ubi_assert(MINOR(dev) == 0); |
801c135c | 384 | cdev_init(&ubi->cdev, &ubi_cdev_operations); |
49dfc299 | 385 | dbg_msg("%s major is %u", ubi->ubi_name, MAJOR(dev)); |
801c135c AB |
386 | ubi->cdev.owner = THIS_MODULE; |
387 | ||
801c135c AB |
388 | err = cdev_add(&ubi->cdev, dev, 1); |
389 | if (err) { | |
01f7b309 | 390 | ubi_err("cannot add character device"); |
801c135c AB |
391 | goto out_unreg; |
392 | } | |
393 | ||
394 | err = ubi_sysfs_init(ubi); | |
395 | if (err) | |
db6e5770 | 396 | goto out_sysfs; |
801c135c AB |
397 | |
398 | for (i = 0; i < ubi->vtbl_slots; i++) | |
399 | if (ubi->volumes[i]) { | |
89b96b69 | 400 | err = ubi_add_volume(ubi, ubi->volumes[i]); |
01f7b309 AB |
401 | if (err) { |
402 | ubi_err("cannot add volume %d", i); | |
801c135c | 403 | goto out_volumes; |
01f7b309 | 404 | } |
801c135c AB |
405 | } |
406 | ||
407 | return 0; | |
408 | ||
409 | out_volumes: | |
410 | kill_volumes(ubi); | |
db6e5770 | 411 | out_sysfs: |
801c135c | 412 | ubi_sysfs_close(ubi); |
801c135c AB |
413 | cdev_del(&ubi->cdev); |
414 | out_unreg: | |
49dfc299 | 415 | unregister_chrdev_region(ubi->cdev.dev, ubi->vtbl_slots + 1); |
01f7b309 | 416 | ubi_err("cannot initialize UBI %s, error %d", ubi->ubi_name, err); |
801c135c AB |
417 | return err; |
418 | } | |
419 | ||
420 | /** | |
421 | * uif_close - close user interfaces for an UBI device. | |
422 | * @ubi: UBI device description object | |
423 | */ | |
424 | static void uif_close(struct ubi_device *ubi) | |
425 | { | |
426 | kill_volumes(ubi); | |
427 | ubi_sysfs_close(ubi); | |
428 | cdev_del(&ubi->cdev); | |
49dfc299 | 429 | unregister_chrdev_region(ubi->cdev.dev, ubi->vtbl_slots + 1); |
801c135c AB |
430 | } |
431 | ||
432 | /** | |
433 | * attach_by_scanning - attach an MTD device using scanning method. | |
434 | * @ubi: UBI device descriptor | |
435 | * | |
436 | * This function returns zero in case of success and a negative error code in | |
437 | * case of failure. | |
438 | * | |
439 | * Note, currently this is the only method to attach UBI devices. Hopefully in | |
440 | * the future we'll have more scalable attaching methods and avoid full media | |
441 | * scanning. But even in this case scanning will be needed as a fall-back | |
442 | * attaching method if there are some on-flash table corruptions. | |
443 | */ | |
444 | static int attach_by_scanning(struct ubi_device *ubi) | |
445 | { | |
446 | int err; | |
447 | struct ubi_scan_info *si; | |
448 | ||
449 | si = ubi_scan(ubi); | |
450 | if (IS_ERR(si)) | |
451 | return PTR_ERR(si); | |
452 | ||
453 | ubi->bad_peb_count = si->bad_peb_count; | |
454 | ubi->good_peb_count = ubi->peb_count - ubi->bad_peb_count; | |
455 | ubi->max_ec = si->max_ec; | |
456 | ubi->mean_ec = si->mean_ec; | |
457 | ||
458 | err = ubi_read_volume_table(ubi, si); | |
459 | if (err) | |
460 | goto out_si; | |
461 | ||
462 | err = ubi_wl_init_scan(ubi, si); | |
463 | if (err) | |
464 | goto out_vtbl; | |
465 | ||
466 | err = ubi_eba_init_scan(ubi, si); | |
467 | if (err) | |
468 | goto out_wl; | |
469 | ||
470 | ubi_scan_destroy_si(si); | |
471 | return 0; | |
472 | ||
473 | out_wl: | |
474 | ubi_wl_close(ubi); | |
475 | out_vtbl: | |
d7f0c4dc | 476 | vfree(ubi->vtbl); |
801c135c AB |
477 | out_si: |
478 | ubi_scan_destroy_si(si); | |
479 | return err; | |
480 | } | |
481 | ||
482 | /** | |
483 | * io_init - initialize I/O unit for a given UBI device. | |
484 | * @ubi: UBI device description object | |
485 | * | |
486 | * If @ubi->vid_hdr_offset or @ubi->leb_start is zero, default offsets are | |
487 | * assumed: | |
488 | * o EC header is always at offset zero - this cannot be changed; | |
489 | * o VID header starts just after the EC header at the closest address | |
cdfa788a | 490 | * aligned to @io->hdrs_min_io_size; |
801c135c | 491 | * o data starts just after the VID header at the closest address aligned to |
cdfa788a | 492 | * @io->min_io_size |
801c135c AB |
493 | * |
494 | * This function returns zero in case of success and a negative error code in | |
495 | * case of failure. | |
496 | */ | |
497 | static int io_init(struct ubi_device *ubi) | |
498 | { | |
499 | if (ubi->mtd->numeraseregions != 0) { | |
500 | /* | |
501 | * Some flashes have several erase regions. Different regions | |
502 | * may have different eraseblock size and other | |
503 | * characteristics. It looks like mostly multi-region flashes | |
504 | * have one "main" region and one or more small regions to | |
505 | * store boot loader code or boot parameters or whatever. I | |
506 | * guess we should just pick the largest region. But this is | |
507 | * not implemented. | |
508 | */ | |
509 | ubi_err("multiple regions, not implemented"); | |
510 | return -EINVAL; | |
511 | } | |
512 | ||
dd38fccf | 513 | if (ubi->vid_hdr_offset < 0) |
cdfa788a AB |
514 | return -EINVAL; |
515 | ||
801c135c AB |
516 | /* |
517 | * Note, in this implementation we support MTD devices with 0x7FFFFFFF | |
518 | * physical eraseblocks maximum. | |
519 | */ | |
520 | ||
521 | ubi->peb_size = ubi->mtd->erasesize; | |
522 | ubi->peb_count = ubi->mtd->size / ubi->mtd->erasesize; | |
523 | ubi->flash_size = ubi->mtd->size; | |
524 | ||
525 | if (ubi->mtd->block_isbad && ubi->mtd->block_markbad) | |
526 | ubi->bad_allowed = 1; | |
527 | ||
528 | ubi->min_io_size = ubi->mtd->writesize; | |
529 | ubi->hdrs_min_io_size = ubi->mtd->writesize >> ubi->mtd->subpage_sft; | |
530 | ||
531 | /* Make sure minimal I/O unit is power of 2 */ | |
7753f169 | 532 | if (!is_power_of_2(ubi->min_io_size)) { |
01f7b309 AB |
533 | ubi_err("min. I/O unit (%d) is not power of 2", |
534 | ubi->min_io_size); | |
801c135c AB |
535 | return -EINVAL; |
536 | } | |
537 | ||
538 | ubi_assert(ubi->hdrs_min_io_size > 0); | |
539 | ubi_assert(ubi->hdrs_min_io_size <= ubi->min_io_size); | |
540 | ubi_assert(ubi->min_io_size % ubi->hdrs_min_io_size == 0); | |
541 | ||
542 | /* Calculate default aligned sizes of EC and VID headers */ | |
543 | ubi->ec_hdr_alsize = ALIGN(UBI_EC_HDR_SIZE, ubi->hdrs_min_io_size); | |
544 | ubi->vid_hdr_alsize = ALIGN(UBI_VID_HDR_SIZE, ubi->hdrs_min_io_size); | |
545 | ||
546 | dbg_msg("min_io_size %d", ubi->min_io_size); | |
547 | dbg_msg("hdrs_min_io_size %d", ubi->hdrs_min_io_size); | |
548 | dbg_msg("ec_hdr_alsize %d", ubi->ec_hdr_alsize); | |
549 | dbg_msg("vid_hdr_alsize %d", ubi->vid_hdr_alsize); | |
550 | ||
551 | if (ubi->vid_hdr_offset == 0) | |
552 | /* Default offset */ | |
553 | ubi->vid_hdr_offset = ubi->vid_hdr_aloffset = | |
554 | ubi->ec_hdr_alsize; | |
555 | else { | |
556 | ubi->vid_hdr_aloffset = ubi->vid_hdr_offset & | |
557 | ~(ubi->hdrs_min_io_size - 1); | |
558 | ubi->vid_hdr_shift = ubi->vid_hdr_offset - | |
559 | ubi->vid_hdr_aloffset; | |
560 | } | |
561 | ||
562 | /* Similar for the data offset */ | |
dd38fccf AB |
563 | ubi->leb_start = ubi->vid_hdr_offset + ubi->vid_hdr_alsize; |
564 | ubi->leb_start = ALIGN(ubi->leb_start, ubi->min_io_size); | |
801c135c AB |
565 | |
566 | dbg_msg("vid_hdr_offset %d", ubi->vid_hdr_offset); | |
567 | dbg_msg("vid_hdr_aloffset %d", ubi->vid_hdr_aloffset); | |
568 | dbg_msg("vid_hdr_shift %d", ubi->vid_hdr_shift); | |
569 | dbg_msg("leb_start %d", ubi->leb_start); | |
570 | ||
571 | /* The shift must be aligned to 32-bit boundary */ | |
572 | if (ubi->vid_hdr_shift % 4) { | |
573 | ubi_err("unaligned VID header shift %d", | |
574 | ubi->vid_hdr_shift); | |
575 | return -EINVAL; | |
576 | } | |
577 | ||
578 | /* Check sanity */ | |
579 | if (ubi->vid_hdr_offset < UBI_EC_HDR_SIZE || | |
580 | ubi->leb_start < ubi->vid_hdr_offset + UBI_VID_HDR_SIZE || | |
581 | ubi->leb_start > ubi->peb_size - UBI_VID_HDR_SIZE || | |
582 | ubi->leb_start % ubi->min_io_size) { | |
583 | ubi_err("bad VID header (%d) or data offsets (%d)", | |
584 | ubi->vid_hdr_offset, ubi->leb_start); | |
585 | return -EINVAL; | |
586 | } | |
587 | ||
588 | /* | |
589 | * It may happen that EC and VID headers are situated in one minimal | |
590 | * I/O unit. In this case we can only accept this UBI image in | |
591 | * read-only mode. | |
592 | */ | |
593 | if (ubi->vid_hdr_offset + UBI_VID_HDR_SIZE <= ubi->hdrs_min_io_size) { | |
594 | ubi_warn("EC and VID headers are in the same minimal I/O unit, " | |
595 | "switch to read-only mode"); | |
596 | ubi->ro_mode = 1; | |
597 | } | |
598 | ||
599 | ubi->leb_size = ubi->peb_size - ubi->leb_start; | |
600 | ||
601 | if (!(ubi->mtd->flags & MTD_WRITEABLE)) { | |
602 | ubi_msg("MTD device %d is write-protected, attach in " | |
603 | "read-only mode", ubi->mtd->index); | |
604 | ubi->ro_mode = 1; | |
605 | } | |
606 | ||
607 | dbg_msg("leb_size %d", ubi->leb_size); | |
608 | dbg_msg("ro_mode %d", ubi->ro_mode); | |
609 | ||
610 | /* | |
611 | * Note, ideally, we have to initialize ubi->bad_peb_count here. But | |
612 | * unfortunately, MTD does not provide this information. We should loop | |
613 | * over all physical eraseblocks and invoke mtd->block_is_bad() for | |
614 | * each physical eraseblock. So, we skip ubi->bad_peb_count | |
615 | * uninitialized and initialize it after scanning. | |
616 | */ | |
617 | ||
618 | return 0; | |
619 | } | |
620 | ||
621 | /** | |
cdfa788a AB |
622 | * ubi_attach_mtd_dev - attach an MTD device. |
623 | * @mtd_dev: MTD device description object | |
801c135c | 624 | * @vid_hdr_offset: VID header offset |
801c135c AB |
625 | * |
626 | * This function attaches an MTD device to UBI. It first treats @mtd_dev as the | |
627 | * MTD device name, and tries to open it by this name. If it is unable to open, | |
628 | * it tries to convert @mtd_dev to an integer and open the MTD device by its | |
cdfa788a AB |
629 | * number. Returns new UBI device's number in case of success and a negative |
630 | * error code in case of failure. | |
631 | * | |
632 | * Note, the invocations of this function has to be serialized by the | |
633 | * @ubi_devices_mutex. | |
801c135c | 634 | */ |
dd38fccf | 635 | int ubi_attach_mtd_dev(struct mtd_info *mtd, int vid_hdr_offset) |
801c135c AB |
636 | { |
637 | struct ubi_device *ubi; | |
801c135c AB |
638 | int i, err; |
639 | ||
cdfa788a AB |
640 | /* |
641 | * Check if we already have the same MTD device attached. | |
642 | * | |
643 | * Note, this function assumes that UBI devices creations and deletions | |
644 | * are serialized, so it does not take the &ubi_devices_lock. | |
645 | */ | |
b96bf4c3 AB |
646 | for (i = 0; i < UBI_MAX_DEVICES; i++) |
647 | ubi = ubi_devices[i]; | |
cdfa788a | 648 | if (ubi && mtd->index == ubi->mtd->index) { |
801c135c AB |
649 | ubi_err("mtd%d is already attached to ubi%d", |
650 | mtd->index, i); | |
cdfa788a | 651 | return -EINVAL; |
801c135c AB |
652 | } |
653 | ||
b96bf4c3 | 654 | /* Search for an empty slot in the @ubi_devices array */ |
b96bf4c3 | 655 | for (i = 0; i < UBI_MAX_DEVICES; i++) |
cdfa788a | 656 | if (!ubi_devices[i]) |
b96bf4c3 | 657 | break; |
b96bf4c3 | 658 | |
cdfa788a | 659 | if (i == UBI_MAX_DEVICES) { |
b96bf4c3 | 660 | ubi_err("only %d UBI devices may be created", UBI_MAX_DEVICES); |
cdfa788a | 661 | return -ENFILE; |
b96bf4c3 AB |
662 | } |
663 | ||
cdfa788a AB |
664 | ubi = kzalloc(sizeof(struct ubi_device), GFP_KERNEL); |
665 | if (!ubi) | |
666 | return -ENOMEM; | |
801c135c | 667 | |
cdfa788a AB |
668 | ubi->mtd = mtd; |
669 | ubi->ubi_num = i; | |
801c135c | 670 | ubi->vid_hdr_offset = vid_hdr_offset; |
cdfa788a | 671 | |
dd38fccf AB |
672 | dbg_msg("attaching mtd%d to ubi%d: VID header offset %d", |
673 | mtd->index, ubi->ubi_num, vid_hdr_offset); | |
cdfa788a | 674 | |
801c135c AB |
675 | err = io_init(ubi); |
676 | if (err) | |
677 | goto out_free; | |
678 | ||
e88d6e10 AB |
679 | mutex_init(&ubi->buf_mutex); |
680 | ubi->peb_buf1 = vmalloc(ubi->peb_size); | |
681 | if (!ubi->peb_buf1) | |
682 | goto out_free; | |
683 | ||
684 | ubi->peb_buf2 = vmalloc(ubi->peb_size); | |
685 | if (!ubi->peb_buf2) | |
686 | goto out_free; | |
687 | ||
688 | #ifdef CONFIG_MTD_UBI_DEBUG | |
689 | mutex_init(&ubi->dbg_buf_mutex); | |
690 | ubi->dbg_peb_buf = vmalloc(ubi->peb_size); | |
691 | if (!ubi->dbg_peb_buf) | |
692 | goto out_free; | |
693 | #endif | |
694 | ||
801c135c AB |
695 | err = attach_by_scanning(ubi); |
696 | if (err) { | |
697 | dbg_err("failed to attach by scanning, error %d", err); | |
698 | goto out_free; | |
699 | } | |
700 | ||
701 | err = uif_init(ubi); | |
702 | if (err) | |
703 | goto out_detach; | |
704 | ||
cdfa788a AB |
705 | ubi->bgt_thread = kthread_create(ubi_thread, ubi, ubi->bgt_name); |
706 | if (IS_ERR(ubi->bgt_thread)) { | |
707 | err = PTR_ERR(ubi->bgt_thread); | |
708 | ubi_err("cannot spawn \"%s\", error %d", ubi->bgt_name, | |
709 | err); | |
710 | goto out_uif; | |
711 | } | |
712 | ||
713 | ubi_msg("attached mtd%d to ubi%d", mtd->index, ubi->ubi_num); | |
714 | ubi_msg("MTD device name: \"%s\"", mtd->name); | |
801c135c AB |
715 | ubi_msg("MTD device size: %llu MiB", ubi->flash_size >> 20); |
716 | ubi_msg("physical eraseblock size: %d bytes (%d KiB)", | |
717 | ubi->peb_size, ubi->peb_size >> 10); | |
718 | ubi_msg("logical eraseblock size: %d bytes", ubi->leb_size); | |
719 | ubi_msg("number of good PEBs: %d", ubi->good_peb_count); | |
720 | ubi_msg("number of bad PEBs: %d", ubi->bad_peb_count); | |
721 | ubi_msg("smallest flash I/O unit: %d", ubi->min_io_size); | |
722 | ubi_msg("VID header offset: %d (aligned %d)", | |
723 | ubi->vid_hdr_offset, ubi->vid_hdr_aloffset); | |
724 | ubi_msg("data offset: %d", ubi->leb_start); | |
725 | ubi_msg("max. allowed volumes: %d", ubi->vtbl_slots); | |
726 | ubi_msg("wear-leveling threshold: %d", CONFIG_MTD_UBI_WL_THRESHOLD); | |
727 | ubi_msg("number of internal volumes: %d", UBI_INT_VOL_COUNT); | |
728 | ubi_msg("number of user volumes: %d", | |
729 | ubi->vol_count - UBI_INT_VOL_COUNT); | |
730 | ubi_msg("available PEBs: %d", ubi->avail_pebs); | |
731 | ubi_msg("total number of reserved PEBs: %d", ubi->rsvd_pebs); | |
732 | ubi_msg("number of PEBs reserved for bad PEB handling: %d", | |
733 | ubi->beb_rsvd_pebs); | |
734 | ubi_msg("max/mean erase counter: %d/%d", ubi->max_ec, ubi->mean_ec); | |
735 | ||
736 | /* Enable the background thread */ | |
737 | if (!DBG_DISABLE_BGT) { | |
738 | ubi->thread_enabled = 1; | |
739 | wake_up_process(ubi->bgt_thread); | |
740 | } | |
741 | ||
b96bf4c3 | 742 | ubi_devices[ubi->ubi_num] = ubi; |
cdfa788a | 743 | return ubi->ubi_num; |
801c135c | 744 | |
cdfa788a AB |
745 | out_uif: |
746 | uif_close(ubi); | |
801c135c AB |
747 | out_detach: |
748 | ubi_eba_close(ubi); | |
749 | ubi_wl_close(ubi); | |
d7f0c4dc | 750 | vfree(ubi->vtbl); |
801c135c | 751 | out_free: |
e88d6e10 AB |
752 | vfree(ubi->peb_buf1); |
753 | vfree(ubi->peb_buf2); | |
754 | #ifdef CONFIG_MTD_UBI_DEBUG | |
755 | vfree(ubi->dbg_peb_buf); | |
756 | #endif | |
801c135c | 757 | kfree(ubi); |
801c135c AB |
758 | return err; |
759 | } | |
760 | ||
761 | /** | |
cdfa788a AB |
762 | * ubi_detach_mtd_dev - detach an MTD device. |
763 | * @ubi_num: UBI device number to detach from | |
764 | * @anyway: detach MTD even if device reference count is not zero | |
765 | * | |
766 | * This function destroys an UBI device number @ubi_num and detaches the | |
767 | * underlying MTD device. Returns zero in case of success and %-EBUSY if the | |
768 | * UBI device is busy and cannot be destroyed, and %-EINVAL if it does not | |
769 | * exist. | |
770 | * | |
771 | * Note, the invocations of this function has to be serialized by the | |
772 | * @ubi_devices_mutex. | |
801c135c | 773 | */ |
cdfa788a | 774 | int ubi_detach_mtd_dev(int ubi_num, int anyway) |
801c135c | 775 | { |
cdfa788a AB |
776 | struct ubi_device *ubi; |
777 | ||
778 | if (ubi_num < 0 || ubi_num >= UBI_MAX_DEVICES) | |
779 | return -EINVAL; | |
780 | ||
781 | spin_lock(&ubi_devices_lock); | |
782 | ubi = ubi_devices[ubi_num]; | |
783 | if (!ubi) { | |
784 | spin_lock(&ubi_devices_lock); | |
785 | return -EINVAL; | |
786 | } | |
787 | ||
788 | if (ubi->ref_count) { | |
789 | if (!anyway) { | |
790 | spin_lock(&ubi_devices_lock); | |
791 | return -EBUSY; | |
792 | } | |
793 | /* This may only happen if there is a bug */ | |
794 | ubi_err("%s reference count %d, destroy anyway", | |
795 | ubi->ubi_name, ubi->ref_count); | |
796 | } | |
797 | ubi_devices[ubi->ubi_num] = NULL; | |
798 | spin_unlock(&ubi_devices_lock); | |
799 | ||
800 | dbg_msg("detaching mtd%d from ubi%d", ubi->mtd->index, ubi->ubi_num); | |
801 | ||
802 | /* | |
803 | * Before freeing anything, we have to stop the background thread to | |
804 | * prevent it from doing anything on this device while we are freeing. | |
805 | */ | |
806 | if (ubi->bgt_thread) | |
807 | kthread_stop(ubi->bgt_thread); | |
801c135c | 808 | |
801c135c AB |
809 | uif_close(ubi); |
810 | ubi_eba_close(ubi); | |
811 | ubi_wl_close(ubi); | |
92ad8f37 | 812 | vfree(ubi->vtbl); |
801c135c | 813 | put_mtd_device(ubi->mtd); |
e88d6e10 AB |
814 | vfree(ubi->peb_buf1); |
815 | vfree(ubi->peb_buf2); | |
816 | #ifdef CONFIG_MTD_UBI_DEBUG | |
817 | vfree(ubi->dbg_peb_buf); | |
818 | #endif | |
cdfa788a AB |
819 | ubi_msg("mtd%d is detached from ubi%d", ubi->mtd->index, ubi->ubi_num); |
820 | kfree(ubi); | |
821 | return 0; | |
801c135c AB |
822 | } |
823 | ||
3a8d4642 AB |
824 | /** |
825 | * ltree_entry_ctor - lock tree entries slab cache constructor. | |
826 | * @obj: the lock-tree entry to construct | |
827 | * @cache: the lock tree entry slab cache | |
828 | * @flags: constructor flags | |
829 | */ | |
830 | static void ltree_entry_ctor(struct kmem_cache *cache, void *obj) | |
831 | { | |
832 | struct ubi_ltree_entry *le = obj; | |
833 | ||
834 | le->users = 0; | |
835 | init_rwsem(&le->mutex); | |
836 | } | |
837 | ||
cdfa788a AB |
838 | /** |
839 | * find_mtd_device - open an MTD device by its name or number. | |
840 | * @mtd_dev: name or number of the device | |
841 | * | |
842 | * This function tries to open and MTD device with name @mtd_dev, and if it | |
843 | * fails, then it tries to interpret the @mtd_dev string as an ASCII-coded | |
844 | * integer and open an MTD device with this number. Returns MTD device | |
845 | * description object in case of success and a negative error code in case of | |
846 | * failure. | |
847 | */ | |
848 | static struct mtd_info * __init open_mtd_device(const char *mtd_dev) | |
849 | { | |
850 | struct mtd_info *mtd; | |
851 | ||
852 | mtd = get_mtd_device_nm(mtd_dev); | |
853 | if (IS_ERR(mtd)) { | |
854 | int mtd_num; | |
855 | char *endp; | |
856 | ||
857 | if (PTR_ERR(mtd) != -ENODEV) | |
858 | return mtd; | |
859 | ||
860 | /* | |
861 | * Probably this is not MTD device name but MTD device number - | |
862 | * check this out. | |
863 | */ | |
864 | mtd_num = simple_strtoul(mtd_dev, &endp, 0); | |
865 | if (*endp != '\0' || mtd_dev == endp) { | |
866 | ubi_err("incorrect MTD device: \"%s\"", mtd_dev); | |
867 | return ERR_PTR(-ENODEV); | |
868 | } | |
869 | ||
870 | mtd = get_mtd_device(NULL, mtd_num); | |
871 | if (IS_ERR(mtd)) | |
872 | return mtd; | |
873 | } | |
874 | ||
875 | return mtd; | |
876 | } | |
877 | ||
801c135c AB |
878 | static int __init ubi_init(void) |
879 | { | |
880 | int err, i, k; | |
881 | ||
882 | /* Ensure that EC and VID headers have correct size */ | |
883 | BUILD_BUG_ON(sizeof(struct ubi_ec_hdr) != 64); | |
884 | BUILD_BUG_ON(sizeof(struct ubi_vid_hdr) != 64); | |
885 | ||
886 | if (mtd_devs > UBI_MAX_DEVICES) { | |
458dbb3d AB |
887 | printk(KERN_ERR "UBI error: too many MTD devices, " |
888 | "maximum is %d\n", UBI_MAX_DEVICES); | |
801c135c AB |
889 | return -EINVAL; |
890 | } | |
891 | ||
9f961b57 | 892 | /* Create base sysfs directory and sysfs files */ |
801c135c | 893 | ubi_class = class_create(THIS_MODULE, UBI_NAME_STR); |
9f961b57 AB |
894 | if (IS_ERR(ubi_class)) { |
895 | err = PTR_ERR(ubi_class); | |
896 | printk(KERN_ERR "UBI error: cannot create UBI class\n"); | |
897 | goto out; | |
898 | } | |
801c135c AB |
899 | |
900 | err = class_create_file(ubi_class, &ubi_version); | |
9f961b57 AB |
901 | if (err) { |
902 | printk(KERN_ERR "UBI error: cannot create sysfs file\n"); | |
801c135c | 903 | goto out_class; |
9f961b57 AB |
904 | } |
905 | ||
906 | err = misc_register(&ubi_ctrl_cdev); | |
907 | if (err) { | |
908 | printk(KERN_ERR "UBI error: cannot register device\n"); | |
909 | goto out_version; | |
910 | } | |
801c135c | 911 | |
3a8d4642 AB |
912 | ubi_ltree_slab = kmem_cache_create("ubi_ltree_slab", |
913 | sizeof(struct ubi_ltree_entry), 0, | |
914 | 0, <ree_entry_ctor); | |
915 | if (!ubi_ltree_slab) | |
9f961b57 | 916 | goto out_dev_unreg; |
3a8d4642 | 917 | |
06b68ba1 AB |
918 | ubi_wl_entry_slab = kmem_cache_create("ubi_wl_entry_slab", |
919 | sizeof(struct ubi_wl_entry), | |
920 | 0, 0, NULL); | |
921 | if (!ubi_wl_entry_slab) | |
922 | goto out_ltree; | |
923 | ||
801c135c AB |
924 | /* Attach MTD devices */ |
925 | for (i = 0; i < mtd_devs; i++) { | |
926 | struct mtd_dev_param *p = &mtd_dev_param[i]; | |
cdfa788a | 927 | struct mtd_info *mtd; |
801c135c AB |
928 | |
929 | cond_resched(); | |
cdfa788a AB |
930 | |
931 | mtd = open_mtd_device(p->name); | |
932 | if (IS_ERR(mtd)) { | |
933 | err = PTR_ERR(mtd); | |
934 | goto out_detach; | |
935 | } | |
936 | ||
937 | mutex_lock(&ubi_devices_mutex); | |
dd38fccf | 938 | err = ubi_attach_mtd_dev(mtd, p->vid_hdr_offs); |
cdfa788a AB |
939 | mutex_unlock(&ubi_devices_mutex); |
940 | if (err < 0) { | |
941 | put_mtd_device(mtd); | |
9f961b57 AB |
942 | printk(KERN_ERR "UBI error: cannot attach %s\n", |
943 | p->name); | |
801c135c | 944 | goto out_detach; |
9f961b57 | 945 | } |
801c135c AB |
946 | } |
947 | ||
948 | return 0; | |
949 | ||
950 | out_detach: | |
951 | for (k = 0; k < i; k++) | |
cdfa788a AB |
952 | if (ubi_devices[k]) { |
953 | mutex_lock(&ubi_devices_mutex); | |
954 | ubi_detach_mtd_dev(ubi_devices[k]->ubi_num, 1); | |
955 | mutex_unlock(&ubi_devices_mutex); | |
956 | } | |
06b68ba1 AB |
957 | kmem_cache_destroy(ubi_wl_entry_slab); |
958 | out_ltree: | |
3a8d4642 | 959 | kmem_cache_destroy(ubi_ltree_slab); |
9f961b57 AB |
960 | out_dev_unreg: |
961 | misc_deregister(&ubi_ctrl_cdev); | |
3a8d4642 | 962 | out_version: |
801c135c AB |
963 | class_remove_file(ubi_class, &ubi_version); |
964 | out_class: | |
965 | class_destroy(ubi_class); | |
9f961b57 AB |
966 | out: |
967 | printk(KERN_ERR "UBI error: cannot initialize UBI, error %d\n", err); | |
801c135c AB |
968 | return err; |
969 | } | |
970 | module_init(ubi_init); | |
971 | ||
972 | static void __exit ubi_exit(void) | |
973 | { | |
b96bf4c3 | 974 | int i; |
801c135c | 975 | |
b96bf4c3 | 976 | for (i = 0; i < UBI_MAX_DEVICES; i++) |
cdfa788a AB |
977 | if (ubi_devices[i]) { |
978 | mutex_lock(&ubi_devices_mutex); | |
979 | ubi_detach_mtd_dev(ubi_devices[i]->ubi_num, 1); | |
980 | mutex_unlock(&ubi_devices_mutex); | |
981 | } | |
06b68ba1 | 982 | kmem_cache_destroy(ubi_wl_entry_slab); |
3a8d4642 | 983 | kmem_cache_destroy(ubi_ltree_slab); |
9f961b57 | 984 | misc_deregister(&ubi_ctrl_cdev); |
801c135c AB |
985 | class_remove_file(ubi_class, &ubi_version); |
986 | class_destroy(ubi_class); | |
987 | } | |
988 | module_exit(ubi_exit); | |
989 | ||
990 | /** | |
991 | * bytes_str_to_int - convert a string representing number of bytes to an | |
992 | * integer. | |
993 | * @str: the string to convert | |
994 | * | |
995 | * This function returns positive resulting integer in case of success and a | |
996 | * negative error code in case of failure. | |
997 | */ | |
998 | static int __init bytes_str_to_int(const char *str) | |
999 | { | |
1000 | char *endp; | |
1001 | unsigned long result; | |
1002 | ||
1003 | result = simple_strtoul(str, &endp, 0); | |
1004 | if (str == endp || result < 0) { | |
458dbb3d AB |
1005 | printk(KERN_ERR "UBI error: incorrect bytes count: \"%s\"\n", |
1006 | str); | |
801c135c AB |
1007 | return -EINVAL; |
1008 | } | |
1009 | ||
1010 | switch (*endp) { | |
1011 | case 'G': | |
1012 | result *= 1024; | |
1013 | case 'M': | |
1014 | result *= 1024; | |
1015 | case 'K': | |
1016 | case 'k': | |
1017 | result *= 1024; | |
1018 | if (endp[1] == 'i' && (endp[2] == '\0' || | |
1019 | endp[2] == 'B' || endp[2] == 'b')) | |
1020 | endp += 2; | |
1021 | case '\0': | |
1022 | break; | |
1023 | default: | |
458dbb3d AB |
1024 | printk(KERN_ERR "UBI error: incorrect bytes count: \"%s\"\n", |
1025 | str); | |
801c135c AB |
1026 | return -EINVAL; |
1027 | } | |
1028 | ||
1029 | return result; | |
1030 | } | |
1031 | ||
1032 | /** | |
1033 | * ubi_mtd_param_parse - parse the 'mtd=' UBI parameter. | |
1034 | * @val: the parameter value to parse | |
1035 | * @kp: not used | |
1036 | * | |
1037 | * This function returns zero in case of success and a negative error code in | |
1038 | * case of error. | |
1039 | */ | |
1040 | static int __init ubi_mtd_param_parse(const char *val, struct kernel_param *kp) | |
1041 | { | |
1042 | int i, len; | |
1043 | struct mtd_dev_param *p; | |
1044 | char buf[MTD_PARAM_LEN_MAX]; | |
1045 | char *pbuf = &buf[0]; | |
1046 | char *tokens[3] = {NULL, NULL, NULL}; | |
1047 | ||
77c722dd AB |
1048 | if (!val) |
1049 | return -EINVAL; | |
1050 | ||
801c135c | 1051 | if (mtd_devs == UBI_MAX_DEVICES) { |
458dbb3d | 1052 | printk(KERN_ERR "UBI error: too many parameters, max. is %d\n", |
801c135c AB |
1053 | UBI_MAX_DEVICES); |
1054 | return -EINVAL; | |
1055 | } | |
1056 | ||
1057 | len = strnlen(val, MTD_PARAM_LEN_MAX); | |
1058 | if (len == MTD_PARAM_LEN_MAX) { | |
458dbb3d AB |
1059 | printk(KERN_ERR "UBI error: parameter \"%s\" is too long, " |
1060 | "max. is %d\n", val, MTD_PARAM_LEN_MAX); | |
801c135c AB |
1061 | return -EINVAL; |
1062 | } | |
1063 | ||
1064 | if (len == 0) { | |
458dbb3d AB |
1065 | printk(KERN_WARNING "UBI warning: empty 'mtd=' parameter - " |
1066 | "ignored\n"); | |
801c135c AB |
1067 | return 0; |
1068 | } | |
1069 | ||
1070 | strcpy(buf, val); | |
1071 | ||
1072 | /* Get rid of the final newline */ | |
1073 | if (buf[len - 1] == '\n') | |
503990eb | 1074 | buf[len - 1] = '\0'; |
801c135c AB |
1075 | |
1076 | for (i = 0; i < 3; i++) | |
1077 | tokens[i] = strsep(&pbuf, ","); | |
1078 | ||
1079 | if (pbuf) { | |
458dbb3d AB |
1080 | printk(KERN_ERR "UBI error: too many arguments at \"%s\"\n", |
1081 | val); | |
801c135c AB |
1082 | return -EINVAL; |
1083 | } | |
1084 | ||
801c135c AB |
1085 | p = &mtd_dev_param[mtd_devs]; |
1086 | strcpy(&p->name[0], tokens[0]); | |
1087 | ||
1088 | if (tokens[1]) | |
1089 | p->vid_hdr_offs = bytes_str_to_int(tokens[1]); | |
801c135c AB |
1090 | |
1091 | if (p->vid_hdr_offs < 0) | |
1092 | return p->vid_hdr_offs; | |
801c135c AB |
1093 | |
1094 | mtd_devs += 1; | |
1095 | return 0; | |
1096 | } | |
1097 | ||
1098 | module_param_call(mtd, ubi_mtd_param_parse, NULL, NULL, 000); | |
1099 | MODULE_PARM_DESC(mtd, "MTD devices to attach. Parameter format: " | |
dd38fccf | 1100 | "mtd=<name|num>[,<vid_hdr_offs>].\n" |
801c135c | 1101 | "Multiple \"mtd\" parameters may be specified.\n" |
dd38fccf AB |
1102 | "MTD devices may be specified by their number or name.\n" |
1103 | "Optional \"vid_hdr_offs\" parameter specifies UBI VID " | |
1104 | "header position and data starting position to be used " | |
1105 | "by UBI.\n" | |
1106 | "Example: mtd=content,1984 mtd=4 - attach MTD device" | |
1107 | "with name \"content\" using VID header offset 1984, and " | |
1108 | "MTD device number 4 with default VID header offset."); | |
801c135c AB |
1109 | |
1110 | MODULE_VERSION(__stringify(UBI_VERSION)); | |
1111 | MODULE_DESCRIPTION("UBI - Unsorted Block Images"); | |
1112 | MODULE_AUTHOR("Artem Bityutskiy"); | |
1113 | MODULE_LICENSE("GPL"); |