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