blob: ff4425de15276c06a005f49825b637946cf64b6f [file] [log] [blame]
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001/*
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/*
Artem Bityutskiy9f961b52007-12-16 16:59:31 +020024 * 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.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040034 */
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>
Artem Bityutskiy9f961b52007-12-16 16:59:31 +020041#include <linux/miscdevice.h>
Vignesh Babu7753f162007-06-12 10:31:05 +053042#include <linux/log2.h>
Artem Bityutskiycdfa7882007-12-17 20:33:20 +020043#include <linux/kthread.h>
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040044#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
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040053 */
54struct mtd_dev_param
55{
56 char name[MTD_PARAM_LEN_MAX];
57 int vid_hdr_offs;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040058};
59
60/* Numbers of elements set in the @mtd_dev_param array */
61static int mtd_devs = 0;
62
63/* MTD devices specification parameters */
64static struct mtd_dev_param mtd_dev_param[UBI_MAX_DEVICES];
65
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040066/* Root UBI "class" object (corresponds to '/<sysfs>/class/ubi/') */
67struct class *ubi_class;
68
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +020069/* Slab cache for wear-leveling entries */
70struct kmem_cache *ubi_wl_entry_slab;
71
Artem Bityutskiy9f961b52007-12-16 16:59:31 +020072/* UBI control character device */
73static struct miscdevice ubi_ctrl_cdev = {
74 .minor = MISC_DYNAMIC_MINOR,
75 .name = "ubi_ctrl",
76 .fops = &ubi_ctrl_cdev_operations,
77};
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +020078
Artem Bityutskiye73f4452007-12-17 17:37:26 +020079/* All UBI devices in system */
80static struct ubi_device *ubi_devices[UBI_MAX_DEVICES];
81
Artem Bityutskiycdfa7882007-12-17 20:33:20 +020082/* Serializes UBI devices creations and removals */
83DEFINE_MUTEX(ubi_devices_mutex);
84
Artem Bityutskiye73f4452007-12-17 17:37:26 +020085/* Protects @ubi_devices and @ubi->ref_count */
86static DEFINE_SPINLOCK(ubi_devices_lock);
87
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040088/* "Show" method for files in '/<sysfs>/class/ubi/' */
89static ssize_t ubi_version_show(struct class *class, char *buf)
90{
91 return sprintf(buf, "%d\n", UBI_VERSION);
92}
93
94/* UBI version attribute ('/<sysfs>/class/ubi/version') */
95static struct class_attribute ubi_version =
96 __ATTR(version, S_IRUGO, ubi_version_show, NULL);
97
98static ssize_t dev_attribute_show(struct device *dev,
99 struct device_attribute *attr, char *buf);
100
101/* UBI device attributes (correspond to files in '/<sysfs>/class/ubi/ubiX') */
102static struct device_attribute dev_eraseblock_size =
103 __ATTR(eraseblock_size, S_IRUGO, dev_attribute_show, NULL);
104static struct device_attribute dev_avail_eraseblocks =
105 __ATTR(avail_eraseblocks, S_IRUGO, dev_attribute_show, NULL);
106static struct device_attribute dev_total_eraseblocks =
107 __ATTR(total_eraseblocks, S_IRUGO, dev_attribute_show, NULL);
108static struct device_attribute dev_volumes_count =
109 __ATTR(volumes_count, S_IRUGO, dev_attribute_show, NULL);
110static struct device_attribute dev_max_ec =
111 __ATTR(max_ec, S_IRUGO, dev_attribute_show, NULL);
112static struct device_attribute dev_reserved_for_bad =
113 __ATTR(reserved_for_bad, S_IRUGO, dev_attribute_show, NULL);
114static struct device_attribute dev_bad_peb_count =
115 __ATTR(bad_peb_count, S_IRUGO, dev_attribute_show, NULL);
116static struct device_attribute dev_max_vol_count =
117 __ATTR(max_vol_count, S_IRUGO, dev_attribute_show, NULL);
118static struct device_attribute dev_min_io_size =
119 __ATTR(min_io_size, S_IRUGO, dev_attribute_show, NULL);
120static struct device_attribute dev_bgt_enabled =
121 __ATTR(bgt_enabled, S_IRUGO, dev_attribute_show, NULL);
Artem Bityutskiyb6b76ba2007-12-26 13:46:46 +0200122static struct device_attribute dev_mtd_num =
123 __ATTR(mtd_num, S_IRUGO, dev_attribute_show, NULL);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400124
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200125/**
126 * ubi_get_device - get UBI device.
127 * @ubi_num: UBI device number
128 *
129 * This function returns UBI device description object for UBI device number
130 * @ubi_num, or %NULL if the device does not exist. This function increases the
131 * device reference count to prevent removal of the device. In other words, the
132 * device cannot be removed if its reference count is not zero.
133 */
134struct ubi_device *ubi_get_device(int ubi_num)
135{
136 struct ubi_device *ubi;
137
138 spin_lock(&ubi_devices_lock);
139 ubi = ubi_devices[ubi_num];
140 if (ubi) {
141 ubi_assert(ubi->ref_count >= 0);
142 ubi->ref_count += 1;
143 get_device(&ubi->dev);
144 }
145 spin_unlock(&ubi_devices_lock);
146
147 return ubi;
148}
149
150/**
151 * ubi_put_device - drop an UBI device reference.
152 * @ubi: UBI device description object
153 */
154void ubi_put_device(struct ubi_device *ubi)
155{
156 spin_lock(&ubi_devices_lock);
157 ubi->ref_count -= 1;
158 put_device(&ubi->dev);
159 spin_unlock(&ubi_devices_lock);
160}
161
162/**
163 * ubi_get_by_major - get UBI device description object by character device
164 * major number.
165 * @major: major number
166 *
167 * This function is similar to 'ubi_get_device()', but it searches the device
168 * by its major number.
169 */
170struct ubi_device *ubi_get_by_major(int major)
171{
172 int i;
173 struct ubi_device *ubi;
174
175 spin_lock(&ubi_devices_lock);
176 for (i = 0; i < UBI_MAX_DEVICES; i++) {
177 ubi = ubi_devices[i];
178 if (ubi && MAJOR(ubi->cdev.dev) == major) {
179 ubi_assert(ubi->ref_count >= 0);
180 ubi->ref_count += 1;
181 get_device(&ubi->dev);
182 spin_unlock(&ubi_devices_lock);
183 return ubi;
184 }
185 }
186 spin_unlock(&ubi_devices_lock);
187
188 return NULL;
189}
190
191/**
192 * ubi_major2num - get UBI device number by character device major number.
193 * @major: major number
194 *
195 * This function searches UBI device number object by its major number. If UBI
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200196 * device was not found, this function returns -ENODEV, otherwise the UBI device
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200197 * number is returned.
198 */
199int ubi_major2num(int major)
200{
201 int i, ubi_num = -ENODEV;
202
203 spin_lock(&ubi_devices_lock);
204 for (i = 0; i < UBI_MAX_DEVICES; i++) {
205 struct ubi_device *ubi = ubi_devices[i];
206
207 if (ubi && MAJOR(ubi->cdev.dev) == major) {
208 ubi_num = ubi->ubi_num;
209 break;
210 }
211 }
212 spin_unlock(&ubi_devices_lock);
213
214 return ubi_num;
215}
216
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400217/* "Show" method for files in '/<sysfs>/class/ubi/ubiX/' */
218static ssize_t dev_attribute_show(struct device *dev,
219 struct device_attribute *attr, char *buf)
220{
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200221 ssize_t ret;
222 struct ubi_device *ubi;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400223
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200224 /*
225 * The below code looks weird, but it actually makes sense. We get the
226 * UBI device reference from the contained 'struct ubi_device'. But it
227 * is unclear if the device was removed or not yet. Indeed, if the
228 * device was removed before we increased its reference count,
229 * 'ubi_get_device()' will return -ENODEV and we fail.
230 *
231 * Remember, 'struct ubi_device' is freed in the release function, so
232 * we still can use 'ubi->ubi_num'.
233 */
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400234 ubi = container_of(dev, struct ubi_device, dev);
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200235 ubi = ubi_get_device(ubi->ubi_num);
236 if (!ubi)
237 return -ENODEV;
238
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400239 if (attr == &dev_eraseblock_size)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200240 ret = sprintf(buf, "%d\n", ubi->leb_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400241 else if (attr == &dev_avail_eraseblocks)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200242 ret = sprintf(buf, "%d\n", ubi->avail_pebs);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400243 else if (attr == &dev_total_eraseblocks)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200244 ret = sprintf(buf, "%d\n", ubi->good_peb_count);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400245 else if (attr == &dev_volumes_count)
Artem Bityutskiy4b3cc342007-12-26 15:59:39 +0200246 ret = sprintf(buf, "%d\n", ubi->vol_count - UBI_INT_VOL_COUNT);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400247 else if (attr == &dev_max_ec)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200248 ret = sprintf(buf, "%d\n", ubi->max_ec);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400249 else if (attr == &dev_reserved_for_bad)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200250 ret = sprintf(buf, "%d\n", ubi->beb_rsvd_pebs);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400251 else if (attr == &dev_bad_peb_count)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200252 ret = sprintf(buf, "%d\n", ubi->bad_peb_count);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400253 else if (attr == &dev_max_vol_count)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200254 ret = sprintf(buf, "%d\n", ubi->vtbl_slots);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400255 else if (attr == &dev_min_io_size)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200256 ret = sprintf(buf, "%d\n", ubi->min_io_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400257 else if (attr == &dev_bgt_enabled)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200258 ret = sprintf(buf, "%d\n", ubi->thread_enabled);
Artem Bityutskiyb6b76ba2007-12-26 13:46:46 +0200259 else if (attr == &dev_mtd_num)
260 ret = sprintf(buf, "%d\n", ubi->mtd->index);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400261 else
Artem Bityutskiyb6b76ba2007-12-26 13:46:46 +0200262 ret = -EINVAL;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400263
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200264 ubi_put_device(ubi);
265 return ret;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400266}
267
268/* Fake "release" method for UBI devices */
269static void dev_release(struct device *dev) { }
270
271/**
272 * ubi_sysfs_init - initialize sysfs for an UBI device.
273 * @ubi: UBI device description object
274 *
275 * This function returns zero in case of success and a negative error code in
276 * case of failure.
277 */
278static int ubi_sysfs_init(struct ubi_device *ubi)
279{
280 int err;
281
282 ubi->dev.release = dev_release;
Artem Bityutskiy49dfc292007-12-15 18:13:56 +0200283 ubi->dev.devt = ubi->cdev.dev;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400284 ubi->dev.class = ubi_class;
285 sprintf(&ubi->dev.bus_id[0], UBI_NAME_STR"%d", ubi->ubi_num);
286 err = device_register(&ubi->dev);
287 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200288 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400289
290 err = device_create_file(&ubi->dev, &dev_eraseblock_size);
291 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200292 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400293 err = device_create_file(&ubi->dev, &dev_avail_eraseblocks);
294 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200295 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400296 err = device_create_file(&ubi->dev, &dev_total_eraseblocks);
297 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200298 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400299 err = device_create_file(&ubi->dev, &dev_volumes_count);
300 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200301 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400302 err = device_create_file(&ubi->dev, &dev_max_ec);
303 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200304 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400305 err = device_create_file(&ubi->dev, &dev_reserved_for_bad);
306 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200307 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400308 err = device_create_file(&ubi->dev, &dev_bad_peb_count);
309 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200310 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400311 err = device_create_file(&ubi->dev, &dev_max_vol_count);
312 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200313 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400314 err = device_create_file(&ubi->dev, &dev_min_io_size);
315 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200316 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400317 err = device_create_file(&ubi->dev, &dev_bgt_enabled);
Artem Bityutskiyb6b76ba2007-12-26 13:46:46 +0200318 if (err)
319 return err;
320 err = device_create_file(&ubi->dev, &dev_mtd_num);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400321 return err;
322}
323
324/**
325 * ubi_sysfs_close - close sysfs for an UBI device.
326 * @ubi: UBI device description object
327 */
328static void ubi_sysfs_close(struct ubi_device *ubi)
329{
Artem Bityutskiyb6b76ba2007-12-26 13:46:46 +0200330 device_remove_file(&ubi->dev, &dev_mtd_num);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400331 device_remove_file(&ubi->dev, &dev_bgt_enabled);
332 device_remove_file(&ubi->dev, &dev_min_io_size);
333 device_remove_file(&ubi->dev, &dev_max_vol_count);
334 device_remove_file(&ubi->dev, &dev_bad_peb_count);
335 device_remove_file(&ubi->dev, &dev_reserved_for_bad);
336 device_remove_file(&ubi->dev, &dev_max_ec);
337 device_remove_file(&ubi->dev, &dev_volumes_count);
338 device_remove_file(&ubi->dev, &dev_total_eraseblocks);
339 device_remove_file(&ubi->dev, &dev_avail_eraseblocks);
340 device_remove_file(&ubi->dev, &dev_eraseblock_size);
341 device_unregister(&ubi->dev);
342}
343
344/**
345 * kill_volumes - destroy all volumes.
346 * @ubi: UBI device description object
347 */
348static void kill_volumes(struct ubi_device *ubi)
349{
350 int i;
351
352 for (i = 0; i < ubi->vtbl_slots; i++)
353 if (ubi->volumes[i])
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200354 ubi_free_volume(ubi, ubi->volumes[i]);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400355}
356
357/**
358 * uif_init - initialize user interfaces for an UBI device.
359 * @ubi: UBI device description object
360 *
361 * This function returns zero in case of success and a negative error code in
362 * case of failure.
363 */
364static int uif_init(struct ubi_device *ubi)
365{
366 int i, err;
367 dev_t dev;
368
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400369 sprintf(ubi->ubi_name, UBI_NAME_STR "%d", ubi->ubi_num);
370
371 /*
372 * Major numbers for the UBI character devices are allocated
373 * dynamically. Major numbers of volume character devices are
374 * equivalent to ones of the corresponding UBI character device. Minor
375 * numbers of UBI character devices are 0, while minor numbers of
376 * volume character devices start from 1. Thus, we allocate one major
377 * number and ubi->vtbl_slots + 1 minor numbers.
378 */
379 err = alloc_chrdev_region(&dev, 0, ubi->vtbl_slots + 1, ubi->ubi_name);
380 if (err) {
381 ubi_err("cannot register UBI character devices");
382 return err;
383 }
384
Artem Bityutskiy49dfc292007-12-15 18:13:56 +0200385 ubi_assert(MINOR(dev) == 0);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400386 cdev_init(&ubi->cdev, &ubi_cdev_operations);
Artem Bityutskiy49dfc292007-12-15 18:13:56 +0200387 dbg_msg("%s major is %u", ubi->ubi_name, MAJOR(dev));
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400388 ubi->cdev.owner = THIS_MODULE;
389
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400390 err = cdev_add(&ubi->cdev, dev, 1);
391 if (err) {
Artem Bityutskiy01f7b302007-12-15 19:56:51 +0200392 ubi_err("cannot add character device");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400393 goto out_unreg;
394 }
395
396 err = ubi_sysfs_init(ubi);
397 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200398 goto out_sysfs;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400399
400 for (i = 0; i < ubi->vtbl_slots; i++)
401 if (ubi->volumes[i]) {
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200402 err = ubi_add_volume(ubi, ubi->volumes[i]);
Artem Bityutskiy01f7b302007-12-15 19:56:51 +0200403 if (err) {
404 ubi_err("cannot add volume %d", i);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400405 goto out_volumes;
Artem Bityutskiy01f7b302007-12-15 19:56:51 +0200406 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400407 }
408
409 return 0;
410
411out_volumes:
412 kill_volumes(ubi);
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200413out_sysfs:
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400414 ubi_sysfs_close(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400415 cdev_del(&ubi->cdev);
416out_unreg:
Artem Bityutskiy49dfc292007-12-15 18:13:56 +0200417 unregister_chrdev_region(ubi->cdev.dev, ubi->vtbl_slots + 1);
Artem Bityutskiy01f7b302007-12-15 19:56:51 +0200418 ubi_err("cannot initialize UBI %s, error %d", ubi->ubi_name, err);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400419 return err;
420}
421
422/**
423 * uif_close - close user interfaces for an UBI device.
424 * @ubi: UBI device description object
425 */
426static void uif_close(struct ubi_device *ubi)
427{
428 kill_volumes(ubi);
429 ubi_sysfs_close(ubi);
430 cdev_del(&ubi->cdev);
Artem Bityutskiy49dfc292007-12-15 18:13:56 +0200431 unregister_chrdev_region(ubi->cdev.dev, ubi->vtbl_slots + 1);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400432}
433
434/**
435 * attach_by_scanning - attach an MTD device using scanning method.
436 * @ubi: UBI device descriptor
437 *
438 * This function returns zero in case of success and a negative error code in
439 * case of failure.
440 *
441 * Note, currently this is the only method to attach UBI devices. Hopefully in
442 * the future we'll have more scalable attaching methods and avoid full media
443 * scanning. But even in this case scanning will be needed as a fall-back
444 * attaching method if there are some on-flash table corruptions.
445 */
446static int attach_by_scanning(struct ubi_device *ubi)
447{
448 int err;
449 struct ubi_scan_info *si;
450
451 si = ubi_scan(ubi);
452 if (IS_ERR(si))
453 return PTR_ERR(si);
454
455 ubi->bad_peb_count = si->bad_peb_count;
456 ubi->good_peb_count = ubi->peb_count - ubi->bad_peb_count;
457 ubi->max_ec = si->max_ec;
458 ubi->mean_ec = si->mean_ec;
459
460 err = ubi_read_volume_table(ubi, si);
461 if (err)
462 goto out_si;
463
464 err = ubi_wl_init_scan(ubi, si);
465 if (err)
466 goto out_vtbl;
467
468 err = ubi_eba_init_scan(ubi, si);
469 if (err)
470 goto out_wl;
471
472 ubi_scan_destroy_si(si);
473 return 0;
474
475out_wl:
476 ubi_wl_close(ubi);
477out_vtbl:
Vinit Agnihotrid7f0c4d2007-06-15 15:31:22 +0530478 vfree(ubi->vtbl);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400479out_si:
480 ubi_scan_destroy_si(si);
481 return err;
482}
483
484/**
485 * io_init - initialize I/O unit for a given UBI device.
486 * @ubi: UBI device description object
487 *
488 * If @ubi->vid_hdr_offset or @ubi->leb_start is zero, default offsets are
489 * assumed:
490 * o EC header is always at offset zero - this cannot be changed;
491 * o VID header starts just after the EC header at the closest address
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200492 * aligned to @io->hdrs_min_io_size;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400493 * o data starts just after the VID header at the closest address aligned to
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200494 * @io->min_io_size
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400495 *
496 * This function returns zero in case of success and a negative error code in
497 * case of failure.
498 */
499static int io_init(struct ubi_device *ubi)
500{
501 if (ubi->mtd->numeraseregions != 0) {
502 /*
503 * Some flashes have several erase regions. Different regions
504 * may have different eraseblock size and other
505 * characteristics. It looks like mostly multi-region flashes
506 * have one "main" region and one or more small regions to
507 * store boot loader code or boot parameters or whatever. I
508 * guess we should just pick the largest region. But this is
509 * not implemented.
510 */
511 ubi_err("multiple regions, not implemented");
512 return -EINVAL;
513 }
514
Artem Bityutskiydd38fcc2007-12-19 21:43:32 +0200515 if (ubi->vid_hdr_offset < 0)
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200516 return -EINVAL;
517
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400518 /*
519 * Note, in this implementation we support MTD devices with 0x7FFFFFFF
520 * physical eraseblocks maximum.
521 */
522
523 ubi->peb_size = ubi->mtd->erasesize;
524 ubi->peb_count = ubi->mtd->size / ubi->mtd->erasesize;
525 ubi->flash_size = ubi->mtd->size;
526
527 if (ubi->mtd->block_isbad && ubi->mtd->block_markbad)
528 ubi->bad_allowed = 1;
529
530 ubi->min_io_size = ubi->mtd->writesize;
531 ubi->hdrs_min_io_size = ubi->mtd->writesize >> ubi->mtd->subpage_sft;
532
Kyungmin Parkcadb40c2008-05-22 10:32:18 +0900533 /*
534 * Make sure minimal I/O unit is power of 2. Note, there is no
535 * fundamental reason for this assumption. It is just an optimization
536 * which allows us to avoid costly division operations.
537 */
Vignesh Babu7753f162007-06-12 10:31:05 +0530538 if (!is_power_of_2(ubi->min_io_size)) {
Artem Bityutskiy01f7b302007-12-15 19:56:51 +0200539 ubi_err("min. I/O unit (%d) is not power of 2",
540 ubi->min_io_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400541 return -EINVAL;
542 }
543
544 ubi_assert(ubi->hdrs_min_io_size > 0);
545 ubi_assert(ubi->hdrs_min_io_size <= ubi->min_io_size);
546 ubi_assert(ubi->min_io_size % ubi->hdrs_min_io_size == 0);
547
548 /* Calculate default aligned sizes of EC and VID headers */
549 ubi->ec_hdr_alsize = ALIGN(UBI_EC_HDR_SIZE, ubi->hdrs_min_io_size);
550 ubi->vid_hdr_alsize = ALIGN(UBI_VID_HDR_SIZE, ubi->hdrs_min_io_size);
551
552 dbg_msg("min_io_size %d", ubi->min_io_size);
553 dbg_msg("hdrs_min_io_size %d", ubi->hdrs_min_io_size);
554 dbg_msg("ec_hdr_alsize %d", ubi->ec_hdr_alsize);
555 dbg_msg("vid_hdr_alsize %d", ubi->vid_hdr_alsize);
556
557 if (ubi->vid_hdr_offset == 0)
558 /* Default offset */
559 ubi->vid_hdr_offset = ubi->vid_hdr_aloffset =
560 ubi->ec_hdr_alsize;
561 else {
562 ubi->vid_hdr_aloffset = ubi->vid_hdr_offset &
563 ~(ubi->hdrs_min_io_size - 1);
564 ubi->vid_hdr_shift = ubi->vid_hdr_offset -
565 ubi->vid_hdr_aloffset;
566 }
567
568 /* Similar for the data offset */
Artem Bityutskiyd5360582008-01-17 15:41:14 +0200569 ubi->leb_start = ubi->vid_hdr_offset + UBI_EC_HDR_SIZE;
Artem Bityutskiydd38fcc2007-12-19 21:43:32 +0200570 ubi->leb_start = ALIGN(ubi->leb_start, ubi->min_io_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400571
572 dbg_msg("vid_hdr_offset %d", ubi->vid_hdr_offset);
573 dbg_msg("vid_hdr_aloffset %d", ubi->vid_hdr_aloffset);
574 dbg_msg("vid_hdr_shift %d", ubi->vid_hdr_shift);
575 dbg_msg("leb_start %d", ubi->leb_start);
576
577 /* The shift must be aligned to 32-bit boundary */
578 if (ubi->vid_hdr_shift % 4) {
579 ubi_err("unaligned VID header shift %d",
580 ubi->vid_hdr_shift);
581 return -EINVAL;
582 }
583
584 /* Check sanity */
585 if (ubi->vid_hdr_offset < UBI_EC_HDR_SIZE ||
586 ubi->leb_start < ubi->vid_hdr_offset + UBI_VID_HDR_SIZE ||
587 ubi->leb_start > ubi->peb_size - UBI_VID_HDR_SIZE ||
Kyungmin Parkcadb40c2008-05-22 10:32:18 +0900588 ubi->leb_start & (ubi->min_io_size - 1)) {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400589 ubi_err("bad VID header (%d) or data offsets (%d)",
590 ubi->vid_hdr_offset, ubi->leb_start);
591 return -EINVAL;
592 }
593
594 /*
595 * It may happen that EC and VID headers are situated in one minimal
596 * I/O unit. In this case we can only accept this UBI image in
597 * read-only mode.
598 */
599 if (ubi->vid_hdr_offset + UBI_VID_HDR_SIZE <= ubi->hdrs_min_io_size) {
600 ubi_warn("EC and VID headers are in the same minimal I/O unit, "
601 "switch to read-only mode");
602 ubi->ro_mode = 1;
603 }
604
605 ubi->leb_size = ubi->peb_size - ubi->leb_start;
606
607 if (!(ubi->mtd->flags & MTD_WRITEABLE)) {
608 ubi_msg("MTD device %d is write-protected, attach in "
609 "read-only mode", ubi->mtd->index);
610 ubi->ro_mode = 1;
611 }
612
Artem Bityutskiy434b8252008-04-20 18:00:33 +0300613 ubi_msg("physical eraseblock size: %d bytes (%d KiB)",
614 ubi->peb_size, ubi->peb_size >> 10);
615 ubi_msg("logical eraseblock size: %d bytes", ubi->leb_size);
616 ubi_msg("smallest flash I/O unit: %d", ubi->min_io_size);
617 if (ubi->hdrs_min_io_size != ubi->min_io_size)
618 ubi_msg("sub-page size: %d",
619 ubi->hdrs_min_io_size);
620 ubi_msg("VID header offset: %d (aligned %d)",
621 ubi->vid_hdr_offset, ubi->vid_hdr_aloffset);
622 ubi_msg("data offset: %d", ubi->leb_start);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400623
624 /*
625 * Note, ideally, we have to initialize ubi->bad_peb_count here. But
626 * unfortunately, MTD does not provide this information. We should loop
627 * over all physical eraseblocks and invoke mtd->block_is_bad() for
628 * each physical eraseblock. So, we skip ubi->bad_peb_count
629 * uninitialized and initialize it after scanning.
630 */
631
632 return 0;
633}
634
635/**
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200636 * autoresize - re-size the volume which has the "auto-resize" flag set.
637 * @ubi: UBI device description object
638 * @vol_id: ID of the volume to re-size
639 *
640 * This function re-sizes the volume marked by the @UBI_VTBL_AUTORESIZE_FLG in
641 * the volume table to the largest possible size. See comments in ubi-header.h
642 * for more description of the flag. Returns zero in case of success and a
643 * negative error code in case of failure.
644 */
645static int autoresize(struct ubi_device *ubi, int vol_id)
646{
647 struct ubi_volume_desc desc;
648 struct ubi_volume *vol = ubi->volumes[vol_id];
649 int err, old_reserved_pebs = vol->reserved_pebs;
650
651 /*
652 * Clear the auto-resize flag in the volume in-memory copy of the
653 * volume table, and 'ubi_resize_volume()' will propogate this change
654 * to the flash.
655 */
656 ubi->vtbl[vol_id].flags &= ~UBI_VTBL_AUTORESIZE_FLG;
657
658 if (ubi->avail_pebs == 0) {
659 struct ubi_vtbl_record vtbl_rec;
660
661 /*
662 * No avalilable PEBs to re-size the volume, clear the flag on
663 * flash and exit.
664 */
665 memcpy(&vtbl_rec, &ubi->vtbl[vol_id],
666 sizeof(struct ubi_vtbl_record));
667 err = ubi_change_vtbl_record(ubi, vol_id, &vtbl_rec);
668 if (err)
669 ubi_err("cannot clean auto-resize flag for volume %d",
670 vol_id);
671 } else {
672 desc.vol = vol;
673 err = ubi_resize_volume(&desc,
674 old_reserved_pebs + ubi->avail_pebs);
675 if (err)
676 ubi_err("cannot auto-resize volume %d", vol_id);
677 }
678
679 if (err)
680 return err;
681
682 ubi_msg("volume %d (\"%s\") re-sized from %d to %d LEBs", vol_id,
683 vol->name, old_reserved_pebs, vol->reserved_pebs);
684 return 0;
685}
686
687/**
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200688 * ubi_attach_mtd_dev - attach an MTD device.
689 * @mtd_dev: MTD device description object
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200690 * @ubi_num: number to assign to the new UBI device
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400691 * @vid_hdr_offset: VID header offset
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400692 *
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200693 * This function attaches MTD device @mtd_dev to UBI and assign @ubi_num number
694 * to the newly created UBI device, unless @ubi_num is %UBI_DEV_NUM_AUTO, in
695 * which case this function finds a vacant device nubert and assings it
696 * automatically. Returns the new UBI device number in case of success and a
697 * negative error code in case of failure.
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200698 *
699 * Note, the invocations of this function has to be serialized by the
700 * @ubi_devices_mutex.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400701 */
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200702int ubi_attach_mtd_dev(struct mtd_info *mtd, int ubi_num, int vid_hdr_offset)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400703{
704 struct ubi_device *ubi;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400705 int i, err;
706
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200707 /*
708 * Check if we already have the same MTD device attached.
709 *
710 * Note, this function assumes that UBI devices creations and deletions
711 * are serialized, so it does not take the &ubi_devices_lock.
712 */
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200713 for (i = 0; i < UBI_MAX_DEVICES; i++) {
Artem Bityutskiyb96bf4c2007-12-16 13:01:03 +0200714 ubi = ubi_devices[i];
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200715 if (ubi && mtd->index == ubi->mtd->index) {
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200716 dbg_err("mtd%d is already attached to ubi%d",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400717 mtd->index, i);
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200718 return -EEXIST;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400719 }
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200720 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400721
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200722 /*
723 * Make sure this MTD device is not emulated on top of an UBI volume
724 * already. Well, generally this recursion works fine, but there are
725 * different problems like the UBI module takes a reference to itself
726 * by attaching (and thus, opening) the emulated MTD device. This
727 * results in inability to unload the module. And in general it makes
728 * no sense to attach emulated MTD devices, so we prohibit this.
729 */
730 if (mtd->type == MTD_UBIVOLUME) {
731 ubi_err("refuse attaching mtd%d - it is already emulated on "
732 "top of UBI", mtd->index);
733 return -EINVAL;
734 }
Artem Bityutskiyb96bf4c2007-12-16 13:01:03 +0200735
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200736 if (ubi_num == UBI_DEV_NUM_AUTO) {
737 /* Search for an empty slot in the @ubi_devices array */
738 for (ubi_num = 0; ubi_num < UBI_MAX_DEVICES; ubi_num++)
739 if (!ubi_devices[ubi_num])
740 break;
741 if (ubi_num == UBI_MAX_DEVICES) {
742 dbg_err("only %d UBI devices may be created", UBI_MAX_DEVICES);
743 return -ENFILE;
744 }
745 } else {
746 if (ubi_num >= UBI_MAX_DEVICES)
747 return -EINVAL;
748
749 /* Make sure ubi_num is not busy */
750 if (ubi_devices[ubi_num]) {
751 dbg_err("ubi%d already exists", ubi_num);
752 return -EEXIST;
753 }
Artem Bityutskiyb96bf4c2007-12-16 13:01:03 +0200754 }
755
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200756 ubi = kzalloc(sizeof(struct ubi_device), GFP_KERNEL);
757 if (!ubi)
758 return -ENOMEM;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400759
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200760 ubi->mtd = mtd;
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200761 ubi->ubi_num = ubi_num;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400762 ubi->vid_hdr_offset = vid_hdr_offset;
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200763 ubi->autoresize_vol_id = -1;
764
765 mutex_init(&ubi->buf_mutex);
766 mutex_init(&ubi->ckvol_mutex);
767 mutex_init(&ubi->volumes_mutex);
768 spin_lock_init(&ubi->volumes_lock);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200769
Artem Bityutskiy697fa972008-04-23 13:43:21 +0300770 ubi_msg("attaching mtd%d to ubi%d", mtd->index, ubi_num);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200771
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400772 err = io_init(ubi);
773 if (err)
774 goto out_free;
775
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300776 ubi->peb_buf1 = vmalloc(ubi->peb_size);
777 if (!ubi->peb_buf1)
778 goto out_free;
779
780 ubi->peb_buf2 = vmalloc(ubi->peb_size);
781 if (!ubi->peb_buf2)
782 goto out_free;
783
784#ifdef CONFIG_MTD_UBI_DEBUG
785 mutex_init(&ubi->dbg_buf_mutex);
786 ubi->dbg_peb_buf = vmalloc(ubi->peb_size);
787 if (!ubi->dbg_peb_buf)
788 goto out_free;
789#endif
790
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400791 err = attach_by_scanning(ubi);
792 if (err) {
793 dbg_err("failed to attach by scanning, error %d", err);
794 goto out_free;
795 }
796
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200797 if (ubi->autoresize_vol_id != -1) {
798 err = autoresize(ubi, ubi->autoresize_vol_id);
799 if (err)
800 goto out_detach;
801 }
802
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400803 err = uif_init(ubi);
804 if (err)
805 goto out_detach;
806
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200807 ubi->bgt_thread = kthread_create(ubi_thread, ubi, ubi->bgt_name);
808 if (IS_ERR(ubi->bgt_thread)) {
809 err = PTR_ERR(ubi->bgt_thread);
810 ubi_err("cannot spawn \"%s\", error %d", ubi->bgt_name,
811 err);
812 goto out_uif;
813 }
814
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200815 ubi_msg("attached mtd%d to ubi%d", mtd->index, ubi_num);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200816 ubi_msg("MTD device name: \"%s\"", mtd->name);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400817 ubi_msg("MTD device size: %llu MiB", ubi->flash_size >> 20);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400818 ubi_msg("number of good PEBs: %d", ubi->good_peb_count);
819 ubi_msg("number of bad PEBs: %d", ubi->bad_peb_count);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400820 ubi_msg("max. allowed volumes: %d", ubi->vtbl_slots);
821 ubi_msg("wear-leveling threshold: %d", CONFIG_MTD_UBI_WL_THRESHOLD);
822 ubi_msg("number of internal volumes: %d", UBI_INT_VOL_COUNT);
823 ubi_msg("number of user volumes: %d",
824 ubi->vol_count - UBI_INT_VOL_COUNT);
825 ubi_msg("available PEBs: %d", ubi->avail_pebs);
826 ubi_msg("total number of reserved PEBs: %d", ubi->rsvd_pebs);
827 ubi_msg("number of PEBs reserved for bad PEB handling: %d",
828 ubi->beb_rsvd_pebs);
829 ubi_msg("max/mean erase counter: %d/%d", ubi->max_ec, ubi->mean_ec);
830
831 /* Enable the background thread */
832 if (!DBG_DISABLE_BGT) {
833 ubi->thread_enabled = 1;
834 wake_up_process(ubi->bgt_thread);
835 }
836
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200837 ubi_devices[ubi_num] = ubi;
838 return ubi_num;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400839
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200840out_uif:
841 uif_close(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400842out_detach:
843 ubi_eba_close(ubi);
844 ubi_wl_close(ubi);
Vinit Agnihotrid7f0c4d2007-06-15 15:31:22 +0530845 vfree(ubi->vtbl);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400846out_free:
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300847 vfree(ubi->peb_buf1);
848 vfree(ubi->peb_buf2);
849#ifdef CONFIG_MTD_UBI_DEBUG
850 vfree(ubi->dbg_peb_buf);
851#endif
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400852 kfree(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400853 return err;
854}
855
856/**
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200857 * ubi_detach_mtd_dev - detach an MTD device.
858 * @ubi_num: UBI device number to detach from
859 * @anyway: detach MTD even if device reference count is not zero
860 *
861 * This function destroys an UBI device number @ubi_num and detaches the
862 * underlying MTD device. Returns zero in case of success and %-EBUSY if the
863 * UBI device is busy and cannot be destroyed, and %-EINVAL if it does not
864 * exist.
865 *
866 * Note, the invocations of this function has to be serialized by the
867 * @ubi_devices_mutex.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400868 */
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200869int ubi_detach_mtd_dev(int ubi_num, int anyway)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400870{
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200871 struct ubi_device *ubi;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400872
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200873 if (ubi_num < 0 || ubi_num >= UBI_MAX_DEVICES)
874 return -EINVAL;
875
876 spin_lock(&ubi_devices_lock);
877 ubi = ubi_devices[ubi_num];
878 if (!ubi) {
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200879 spin_unlock(&ubi_devices_lock);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200880 return -EINVAL;
881 }
882
883 if (ubi->ref_count) {
884 if (!anyway) {
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200885 spin_unlock(&ubi_devices_lock);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200886 return -EBUSY;
887 }
888 /* This may only happen if there is a bug */
889 ubi_err("%s reference count %d, destroy anyway",
890 ubi->ubi_name, ubi->ref_count);
891 }
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200892 ubi_devices[ubi_num] = NULL;
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200893 spin_unlock(&ubi_devices_lock);
894
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200895 ubi_assert(ubi_num == ubi->ubi_num);
896 dbg_msg("detaching mtd%d from ubi%d", ubi->mtd->index, ubi_num);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200897
898 /*
899 * Before freeing anything, we have to stop the background thread to
900 * prevent it from doing anything on this device while we are freeing.
901 */
902 if (ubi->bgt_thread)
903 kthread_stop(ubi->bgt_thread);
904
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400905 uif_close(ubi);
906 ubi_eba_close(ubi);
907 ubi_wl_close(ubi);
Artem Bityutskiy92ad8f32007-05-06 16:12:54 +0300908 vfree(ubi->vtbl);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400909 put_mtd_device(ubi->mtd);
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300910 vfree(ubi->peb_buf1);
911 vfree(ubi->peb_buf2);
912#ifdef CONFIG_MTD_UBI_DEBUG
913 vfree(ubi->dbg_peb_buf);
914#endif
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200915 ubi_msg("mtd%d is detached from ubi%d", ubi->mtd->index, ubi->ubi_num);
916 kfree(ubi);
917 return 0;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400918}
919
Artem Bityutskiy3a8d4642007-12-16 12:32:51 +0200920/**
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200921 * find_mtd_device - open an MTD device by its name or number.
922 * @mtd_dev: name or number of the device
923 *
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +0200924 * This function tries to open and MTD device described by @mtd_dev string,
925 * which is first treated as an ASCII number, and if it is not true, it is
926 * treated as MTD device name. Returns MTD device description object in case of
927 * success and a negative error code in case of failure.
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200928 */
929static struct mtd_info * __init open_mtd_device(const char *mtd_dev)
930{
931 struct mtd_info *mtd;
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +0200932 int mtd_num;
933 char *endp;
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200934
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +0200935 mtd_num = simple_strtoul(mtd_dev, &endp, 0);
936 if (*endp != '\0' || mtd_dev == endp) {
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200937 /*
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +0200938 * This does not look like an ASCII integer, probably this is
939 * MTD device name.
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200940 */
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +0200941 mtd = get_mtd_device_nm(mtd_dev);
942 } else
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200943 mtd = get_mtd_device(NULL, mtd_num);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200944
945 return mtd;
946}
947
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400948static int __init ubi_init(void)
949{
950 int err, i, k;
951
952 /* Ensure that EC and VID headers have correct size */
953 BUILD_BUG_ON(sizeof(struct ubi_ec_hdr) != 64);
954 BUILD_BUG_ON(sizeof(struct ubi_vid_hdr) != 64);
955
956 if (mtd_devs > UBI_MAX_DEVICES) {
Artem Bityutskiyc4506092008-02-12 16:36:41 +0200957 ubi_err("too many MTD devices, maximum is %d", UBI_MAX_DEVICES);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400958 return -EINVAL;
959 }
960
Artem Bityutskiy9f961b52007-12-16 16:59:31 +0200961 /* Create base sysfs directory and sysfs files */
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400962 ubi_class = class_create(THIS_MODULE, UBI_NAME_STR);
Artem Bityutskiy9f961b52007-12-16 16:59:31 +0200963 if (IS_ERR(ubi_class)) {
964 err = PTR_ERR(ubi_class);
Artem Bityutskiyc4506092008-02-12 16:36:41 +0200965 ubi_err("cannot create UBI class");
Artem Bityutskiy9f961b52007-12-16 16:59:31 +0200966 goto out;
967 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400968
969 err = class_create_file(ubi_class, &ubi_version);
Artem Bityutskiy9f961b52007-12-16 16:59:31 +0200970 if (err) {
Artem Bityutskiyc4506092008-02-12 16:36:41 +0200971 ubi_err("cannot create sysfs file");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400972 goto out_class;
Artem Bityutskiy9f961b52007-12-16 16:59:31 +0200973 }
974
975 err = misc_register(&ubi_ctrl_cdev);
976 if (err) {
Artem Bityutskiyc4506092008-02-12 16:36:41 +0200977 ubi_err("cannot register device");
Artem Bityutskiy9f961b52007-12-16 16:59:31 +0200978 goto out_version;
979 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400980
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +0200981 ubi_wl_entry_slab = kmem_cache_create("ubi_wl_entry_slab",
Artem Bityutskiyc4506092008-02-12 16:36:41 +0200982 sizeof(struct ubi_wl_entry),
983 0, 0, NULL);
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +0200984 if (!ubi_wl_entry_slab)
Artem Bityutskiyb9a06622008-01-16 12:11:54 +0200985 goto out_dev_unreg;
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +0200986
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400987 /* Attach MTD devices */
988 for (i = 0; i < mtd_devs; i++) {
989 struct mtd_dev_param *p = &mtd_dev_param[i];
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200990 struct mtd_info *mtd;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400991
992 cond_resched();
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200993
994 mtd = open_mtd_device(p->name);
995 if (IS_ERR(mtd)) {
996 err = PTR_ERR(mtd);
997 goto out_detach;
998 }
999
1000 mutex_lock(&ubi_devices_mutex);
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001001 err = ubi_attach_mtd_dev(mtd, UBI_DEV_NUM_AUTO,
1002 p->vid_hdr_offs);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001003 mutex_unlock(&ubi_devices_mutex);
1004 if (err < 0) {
1005 put_mtd_device(mtd);
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001006 ubi_err("cannot attach mtd%d", mtd->index);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001007 goto out_detach;
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001008 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001009 }
1010
1011 return 0;
1012
1013out_detach:
1014 for (k = 0; k < i; k++)
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001015 if (ubi_devices[k]) {
1016 mutex_lock(&ubi_devices_mutex);
1017 ubi_detach_mtd_dev(ubi_devices[k]->ubi_num, 1);
1018 mutex_unlock(&ubi_devices_mutex);
1019 }
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +02001020 kmem_cache_destroy(ubi_wl_entry_slab);
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001021out_dev_unreg:
1022 misc_deregister(&ubi_ctrl_cdev);
Artem Bityutskiy3a8d4642007-12-16 12:32:51 +02001023out_version:
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001024 class_remove_file(ubi_class, &ubi_version);
1025out_class:
1026 class_destroy(ubi_class);
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001027out:
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001028 ubi_err("UBI error: cannot initialize UBI, error %d", err);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001029 return err;
1030}
1031module_init(ubi_init);
1032
1033static void __exit ubi_exit(void)
1034{
Artem Bityutskiyb96bf4c2007-12-16 13:01:03 +02001035 int i;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001036
Artem Bityutskiyb96bf4c2007-12-16 13:01:03 +02001037 for (i = 0; i < UBI_MAX_DEVICES; i++)
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001038 if (ubi_devices[i]) {
1039 mutex_lock(&ubi_devices_mutex);
1040 ubi_detach_mtd_dev(ubi_devices[i]->ubi_num, 1);
1041 mutex_unlock(&ubi_devices_mutex);
1042 }
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +02001043 kmem_cache_destroy(ubi_wl_entry_slab);
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001044 misc_deregister(&ubi_ctrl_cdev);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001045 class_remove_file(ubi_class, &ubi_version);
1046 class_destroy(ubi_class);
1047}
1048module_exit(ubi_exit);
1049
1050/**
1051 * bytes_str_to_int - convert a string representing number of bytes to an
1052 * integer.
1053 * @str: the string to convert
1054 *
1055 * This function returns positive resulting integer in case of success and a
1056 * negative error code in case of failure.
1057 */
1058static int __init bytes_str_to_int(const char *str)
1059{
1060 char *endp;
1061 unsigned long result;
1062
1063 result = simple_strtoul(str, &endp, 0);
1064 if (str == endp || result < 0) {
Artem Bityutskiy458dbb32007-12-19 17:03:42 +02001065 printk(KERN_ERR "UBI error: incorrect bytes count: \"%s\"\n",
1066 str);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001067 return -EINVAL;
1068 }
1069
1070 switch (*endp) {
1071 case 'G':
1072 result *= 1024;
1073 case 'M':
1074 result *= 1024;
1075 case 'K':
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001076 result *= 1024;
Artem Bityutskiyaeddb872007-12-26 14:25:58 +02001077 if (endp[1] == 'i' && endp[2] == 'B')
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001078 endp += 2;
1079 case '\0':
1080 break;
1081 default:
Artem Bityutskiy458dbb32007-12-19 17:03:42 +02001082 printk(KERN_ERR "UBI error: incorrect bytes count: \"%s\"\n",
1083 str);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001084 return -EINVAL;
1085 }
1086
1087 return result;
1088}
1089
1090/**
1091 * ubi_mtd_param_parse - parse the 'mtd=' UBI parameter.
1092 * @val: the parameter value to parse
1093 * @kp: not used
1094 *
1095 * This function returns zero in case of success and a negative error code in
1096 * case of error.
1097 */
1098static int __init ubi_mtd_param_parse(const char *val, struct kernel_param *kp)
1099{
1100 int i, len;
1101 struct mtd_dev_param *p;
1102 char buf[MTD_PARAM_LEN_MAX];
1103 char *pbuf = &buf[0];
Artem Bityutskiyddc49392008-01-17 15:35:57 +02001104 char *tokens[2] = {NULL, NULL};
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001105
Artem Bityutskiy77c722d2007-12-16 16:46:57 +02001106 if (!val)
1107 return -EINVAL;
1108
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001109 if (mtd_devs == UBI_MAX_DEVICES) {
Artem Bityutskiy458dbb32007-12-19 17:03:42 +02001110 printk(KERN_ERR "UBI error: too many parameters, max. is %d\n",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001111 UBI_MAX_DEVICES);
1112 return -EINVAL;
1113 }
1114
1115 len = strnlen(val, MTD_PARAM_LEN_MAX);
1116 if (len == MTD_PARAM_LEN_MAX) {
Artem Bityutskiy458dbb32007-12-19 17:03:42 +02001117 printk(KERN_ERR "UBI error: parameter \"%s\" is too long, "
1118 "max. is %d\n", val, MTD_PARAM_LEN_MAX);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001119 return -EINVAL;
1120 }
1121
1122 if (len == 0) {
Artem Bityutskiy458dbb32007-12-19 17:03:42 +02001123 printk(KERN_WARNING "UBI warning: empty 'mtd=' parameter - "
1124 "ignored\n");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001125 return 0;
1126 }
1127
1128 strcpy(buf, val);
1129
1130 /* Get rid of the final newline */
1131 if (buf[len - 1] == '\n')
Artem Bityutskiy503990e2007-07-11 16:03:29 +03001132 buf[len - 1] = '\0';
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001133
Artem Bityutskiyddc49392008-01-17 15:35:57 +02001134 for (i = 0; i < 2; i++)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001135 tokens[i] = strsep(&pbuf, ",");
1136
1137 if (pbuf) {
Artem Bityutskiy458dbb32007-12-19 17:03:42 +02001138 printk(KERN_ERR "UBI error: too many arguments at \"%s\"\n",
1139 val);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001140 return -EINVAL;
1141 }
1142
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001143 p = &mtd_dev_param[mtd_devs];
1144 strcpy(&p->name[0], tokens[0]);
1145
1146 if (tokens[1])
1147 p->vid_hdr_offs = bytes_str_to_int(tokens[1]);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001148
1149 if (p->vid_hdr_offs < 0)
1150 return p->vid_hdr_offs;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001151
1152 mtd_devs += 1;
1153 return 0;
1154}
1155
1156module_param_call(mtd, ubi_mtd_param_parse, NULL, NULL, 000);
1157MODULE_PARM_DESC(mtd, "MTD devices to attach. Parameter format: "
Artem Bityutskiydd38fcc2007-12-19 21:43:32 +02001158 "mtd=<name|num>[,<vid_hdr_offs>].\n"
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001159 "Multiple \"mtd\" parameters may be specified.\n"
Artem Bityutskiydd38fcc2007-12-19 21:43:32 +02001160 "MTD devices may be specified by their number or name.\n"
1161 "Optional \"vid_hdr_offs\" parameter specifies UBI VID "
1162 "header position and data starting position to be used "
1163 "by UBI.\n"
1164 "Example: mtd=content,1984 mtd=4 - attach MTD device"
1165 "with name \"content\" using VID header offset 1984, and "
1166 "MTD device number 4 with default VID header offset.");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001167
1168MODULE_VERSION(__stringify(UBI_VERSION));
1169MODULE_DESCRIPTION("UBI - Unsorted Block Images");
1170MODULE_AUTHOR("Artem Bityutskiy");
1171MODULE_LICENSE("GPL");