blob: bc45ef9af17d8f94b3cd2bed56e6771837296082 [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>
Artem Bityutskiyf9b00802010-01-05 16:48:40 +020040#include <linux/namei.h>
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040041#include <linux/stat.h>
Artem Bityutskiy9f961b52007-12-16 16:59:31 +020042#include <linux/miscdevice.h>
Vignesh Babu7753f162007-06-12 10:31:05 +053043#include <linux/log2.h>
Artem Bityutskiycdfa7882007-12-17 20:33:20 +020044#include <linux/kthread.h>
Kevin Cernekeed9dd0882009-06-09 10:59:19 -070045#include <linux/reboot.h>
Roel Kluin774b1382009-10-16 14:00:17 +020046#include <linux/kernel.h>
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040047#include "ubi.h"
48
49/* Maximum length of the 'mtd=' parameter */
50#define MTD_PARAM_LEN_MAX 64
51
52/**
53 * struct mtd_dev_param - MTD device parameter description data structure.
Artem Bityutskiyf9b00802010-01-05 16:48:40 +020054 * @name: MTD character device node path, MTD device name, or MTD device number
55 * string
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040056 * @vid_hdr_offs: VID header offset
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040057 */
Artem Bityutskiy9c9ec142008-07-18 13:19:52 +030058struct mtd_dev_param {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040059 char name[MTD_PARAM_LEN_MAX];
60 int vid_hdr_offs;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040061};
62
63/* Numbers of elements set in the @mtd_dev_param array */
Artem Bityutskiy9e0c7ef2010-01-06 14:20:31 +020064static int __initdata mtd_devs;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040065
66/* MTD devices specification parameters */
Artem Bityutskiy9e0c7ef2010-01-06 14:20:31 +020067static struct mtd_dev_param __initdata mtd_dev_param[UBI_MAX_DEVICES];
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040068
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040069/* Root UBI "class" object (corresponds to '/<sysfs>/class/ubi/') */
70struct class *ubi_class;
71
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +020072/* Slab cache for wear-leveling entries */
73struct kmem_cache *ubi_wl_entry_slab;
74
Artem Bityutskiy9f961b52007-12-16 16:59:31 +020075/* UBI control character device */
76static struct miscdevice ubi_ctrl_cdev = {
77 .minor = MISC_DYNAMIC_MINOR,
78 .name = "ubi_ctrl",
79 .fops = &ubi_ctrl_cdev_operations,
80};
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +020081
Artem Bityutskiye73f4452007-12-17 17:37:26 +020082/* All UBI devices in system */
83static struct ubi_device *ubi_devices[UBI_MAX_DEVICES];
84
Artem Bityutskiycdfa7882007-12-17 20:33:20 +020085/* Serializes UBI devices creations and removals */
86DEFINE_MUTEX(ubi_devices_mutex);
87
Artem Bityutskiye73f4452007-12-17 17:37:26 +020088/* Protects @ubi_devices and @ubi->ref_count */
89static DEFINE_SPINLOCK(ubi_devices_lock);
90
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040091/* "Show" method for files in '/<sysfs>/class/ubi/' */
92static ssize_t ubi_version_show(struct class *class, char *buf)
93{
94 return sprintf(buf, "%d\n", UBI_VERSION);
95}
96
97/* UBI version attribute ('/<sysfs>/class/ubi/version') */
98static struct class_attribute ubi_version =
99 __ATTR(version, S_IRUGO, ubi_version_show, NULL);
100
101static ssize_t dev_attribute_show(struct device *dev,
102 struct device_attribute *attr, char *buf);
103
104/* UBI device attributes (correspond to files in '/<sysfs>/class/ubi/ubiX') */
105static struct device_attribute dev_eraseblock_size =
106 __ATTR(eraseblock_size, S_IRUGO, dev_attribute_show, NULL);
107static struct device_attribute dev_avail_eraseblocks =
108 __ATTR(avail_eraseblocks, S_IRUGO, dev_attribute_show, NULL);
109static struct device_attribute dev_total_eraseblocks =
110 __ATTR(total_eraseblocks, S_IRUGO, dev_attribute_show, NULL);
111static struct device_attribute dev_volumes_count =
112 __ATTR(volumes_count, S_IRUGO, dev_attribute_show, NULL);
113static struct device_attribute dev_max_ec =
114 __ATTR(max_ec, S_IRUGO, dev_attribute_show, NULL);
115static struct device_attribute dev_reserved_for_bad =
116 __ATTR(reserved_for_bad, S_IRUGO, dev_attribute_show, NULL);
117static struct device_attribute dev_bad_peb_count =
118 __ATTR(bad_peb_count, S_IRUGO, dev_attribute_show, NULL);
119static struct device_attribute dev_max_vol_count =
120 __ATTR(max_vol_count, S_IRUGO, dev_attribute_show, NULL);
121static struct device_attribute dev_min_io_size =
122 __ATTR(min_io_size, S_IRUGO, dev_attribute_show, NULL);
123static struct device_attribute dev_bgt_enabled =
124 __ATTR(bgt_enabled, S_IRUGO, dev_attribute_show, NULL);
Artem Bityutskiyb6b76ba2007-12-26 13:46:46 +0200125static struct device_attribute dev_mtd_num =
126 __ATTR(mtd_num, S_IRUGO, dev_attribute_show, NULL);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400127
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200128/**
Dmitry Pervushin0e0ee1c2009-04-29 19:29:38 +0400129 * ubi_volume_notify - send a volume change notification.
130 * @ubi: UBI device description object
131 * @vol: volume description object of the changed volume
132 * @ntype: notification type to send (%UBI_VOLUME_ADDED, etc)
133 *
134 * This is a helper function which notifies all subscribers about a volume
135 * change event (creation, removal, re-sizing, re-naming, updating). Returns
136 * zero in case of success and a negative error code in case of failure.
137 */
138int ubi_volume_notify(struct ubi_device *ubi, struct ubi_volume *vol, int ntype)
139{
140 struct ubi_notification nt;
141
142 ubi_do_get_device_info(ubi, &nt.di);
143 ubi_do_get_volume_info(ubi, vol, &nt.vi);
144 return blocking_notifier_call_chain(&ubi_notifiers, ntype, &nt);
145}
146
147/**
148 * ubi_notify_all - send a notification to all volumes.
149 * @ubi: UBI device description object
150 * @ntype: notification type to send (%UBI_VOLUME_ADDED, etc)
151 * @nb: the notifier to call
152 *
153 * This function walks all volumes of UBI device @ubi and sends the @ntype
154 * notification for each volume. If @nb is %NULL, then all registered notifiers
155 * are called, otherwise only the @nb notifier is called. Returns the number of
156 * sent notifications.
157 */
158int ubi_notify_all(struct ubi_device *ubi, int ntype, struct notifier_block *nb)
159{
160 struct ubi_notification nt;
161 int i, count = 0;
162
163 ubi_do_get_device_info(ubi, &nt.di);
164
165 mutex_lock(&ubi->device_mutex);
166 for (i = 0; i < ubi->vtbl_slots; i++) {
167 /*
168 * Since the @ubi->device is locked, and we are not going to
169 * change @ubi->volumes, we do not have to lock
170 * @ubi->volumes_lock.
171 */
172 if (!ubi->volumes[i])
173 continue;
174
175 ubi_do_get_volume_info(ubi, ubi->volumes[i], &nt.vi);
176 if (nb)
177 nb->notifier_call(nb, ntype, &nt);
178 else
179 blocking_notifier_call_chain(&ubi_notifiers, ntype,
180 &nt);
181 count += 1;
182 }
183 mutex_unlock(&ubi->device_mutex);
184
185 return count;
186}
187
188/**
189 * ubi_enumerate_volumes - send "add" notification for all existing volumes.
190 * @nb: the notifier to call
191 *
192 * This function walks all UBI devices and volumes and sends the
193 * %UBI_VOLUME_ADDED notification for each volume. If @nb is %NULL, then all
194 * registered notifiers are called, otherwise only the @nb notifier is called.
195 * Returns the number of sent notifications.
196 */
197int ubi_enumerate_volumes(struct notifier_block *nb)
198{
199 int i, count = 0;
200
201 /*
202 * Since the @ubi_devices_mutex is locked, and we are not going to
203 * change @ubi_devices, we do not have to lock @ubi_devices_lock.
204 */
205 for (i = 0; i < UBI_MAX_DEVICES; i++) {
206 struct ubi_device *ubi = ubi_devices[i];
207
208 if (!ubi)
209 continue;
210 count += ubi_notify_all(ubi, UBI_VOLUME_ADDED, nb);
211 }
212
213 return count;
214}
215
216/**
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200217 * ubi_get_device - get UBI device.
218 * @ubi_num: UBI device number
219 *
220 * This function returns UBI device description object for UBI device number
221 * @ubi_num, or %NULL if the device does not exist. This function increases the
222 * device reference count to prevent removal of the device. In other words, the
223 * device cannot be removed if its reference count is not zero.
224 */
225struct ubi_device *ubi_get_device(int ubi_num)
226{
227 struct ubi_device *ubi;
228
229 spin_lock(&ubi_devices_lock);
230 ubi = ubi_devices[ubi_num];
231 if (ubi) {
232 ubi_assert(ubi->ref_count >= 0);
233 ubi->ref_count += 1;
234 get_device(&ubi->dev);
235 }
236 spin_unlock(&ubi_devices_lock);
237
238 return ubi;
239}
240
241/**
242 * ubi_put_device - drop an UBI device reference.
243 * @ubi: UBI device description object
244 */
245void ubi_put_device(struct ubi_device *ubi)
246{
247 spin_lock(&ubi_devices_lock);
248 ubi->ref_count -= 1;
249 put_device(&ubi->dev);
250 spin_unlock(&ubi_devices_lock);
251}
252
253/**
Artem Bityutskiyebaaf1a2008-07-18 13:34:32 +0300254 * ubi_get_by_major - get UBI device by character device major number.
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200255 * @major: major number
256 *
257 * This function is similar to 'ubi_get_device()', but it searches the device
258 * by its major number.
259 */
260struct ubi_device *ubi_get_by_major(int major)
261{
262 int i;
263 struct ubi_device *ubi;
264
265 spin_lock(&ubi_devices_lock);
266 for (i = 0; i < UBI_MAX_DEVICES; i++) {
267 ubi = ubi_devices[i];
268 if (ubi && MAJOR(ubi->cdev.dev) == major) {
269 ubi_assert(ubi->ref_count >= 0);
270 ubi->ref_count += 1;
271 get_device(&ubi->dev);
272 spin_unlock(&ubi_devices_lock);
273 return ubi;
274 }
275 }
276 spin_unlock(&ubi_devices_lock);
277
278 return NULL;
279}
280
281/**
282 * ubi_major2num - get UBI device number by character device major number.
283 * @major: major number
284 *
285 * This function searches UBI device number object by its major number. If UBI
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200286 * device was not found, this function returns -ENODEV, otherwise the UBI device
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200287 * number is returned.
288 */
289int ubi_major2num(int major)
290{
291 int i, ubi_num = -ENODEV;
292
293 spin_lock(&ubi_devices_lock);
294 for (i = 0; i < UBI_MAX_DEVICES; i++) {
295 struct ubi_device *ubi = ubi_devices[i];
296
297 if (ubi && MAJOR(ubi->cdev.dev) == major) {
298 ubi_num = ubi->ubi_num;
299 break;
300 }
301 }
302 spin_unlock(&ubi_devices_lock);
303
304 return ubi_num;
305}
306
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400307/* "Show" method for files in '/<sysfs>/class/ubi/ubiX/' */
308static ssize_t dev_attribute_show(struct device *dev,
309 struct device_attribute *attr, char *buf)
310{
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200311 ssize_t ret;
312 struct ubi_device *ubi;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400313
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200314 /*
315 * The below code looks weird, but it actually makes sense. We get the
316 * UBI device reference from the contained 'struct ubi_device'. But it
317 * is unclear if the device was removed or not yet. Indeed, if the
318 * device was removed before we increased its reference count,
319 * 'ubi_get_device()' will return -ENODEV and we fail.
320 *
321 * Remember, 'struct ubi_device' is freed in the release function, so
322 * we still can use 'ubi->ubi_num'.
323 */
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400324 ubi = container_of(dev, struct ubi_device, dev);
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200325 ubi = ubi_get_device(ubi->ubi_num);
326 if (!ubi)
327 return -ENODEV;
328
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400329 if (attr == &dev_eraseblock_size)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200330 ret = sprintf(buf, "%d\n", ubi->leb_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400331 else if (attr == &dev_avail_eraseblocks)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200332 ret = sprintf(buf, "%d\n", ubi->avail_pebs);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400333 else if (attr == &dev_total_eraseblocks)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200334 ret = sprintf(buf, "%d\n", ubi->good_peb_count);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400335 else if (attr == &dev_volumes_count)
Artem Bityutskiy4b3cc342007-12-26 15:59:39 +0200336 ret = sprintf(buf, "%d\n", ubi->vol_count - UBI_INT_VOL_COUNT);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400337 else if (attr == &dev_max_ec)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200338 ret = sprintf(buf, "%d\n", ubi->max_ec);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400339 else if (attr == &dev_reserved_for_bad)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200340 ret = sprintf(buf, "%d\n", ubi->beb_rsvd_pebs);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400341 else if (attr == &dev_bad_peb_count)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200342 ret = sprintf(buf, "%d\n", ubi->bad_peb_count);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400343 else if (attr == &dev_max_vol_count)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200344 ret = sprintf(buf, "%d\n", ubi->vtbl_slots);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400345 else if (attr == &dev_min_io_size)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200346 ret = sprintf(buf, "%d\n", ubi->min_io_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400347 else if (attr == &dev_bgt_enabled)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200348 ret = sprintf(buf, "%d\n", ubi->thread_enabled);
Artem Bityutskiyb6b76ba2007-12-26 13:46:46 +0200349 else if (attr == &dev_mtd_num)
350 ret = sprintf(buf, "%d\n", ubi->mtd->index);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400351 else
Artem Bityutskiyb6b76ba2007-12-26 13:46:46 +0200352 ret = -EINVAL;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400353
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200354 ubi_put_device(ubi);
355 return ret;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400356}
357
Artem Bityutskiy36b477d2009-01-20 18:04:09 +0200358static void dev_release(struct device *dev)
359{
360 struct ubi_device *ubi = container_of(dev, struct ubi_device, dev);
361
362 kfree(ubi);
363}
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400364
365/**
366 * ubi_sysfs_init - initialize sysfs for an UBI device.
367 * @ubi: UBI device description object
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200368 * @ref: set to %1 on exit in case of failure if a reference to @ubi->dev was
369 * taken
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400370 *
371 * This function returns zero in case of success and a negative error code in
372 * case of failure.
373 */
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200374static int ubi_sysfs_init(struct ubi_device *ubi, int *ref)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400375{
376 int err;
377
378 ubi->dev.release = dev_release;
Artem Bityutskiy49dfc292007-12-15 18:13:56 +0200379 ubi->dev.devt = ubi->cdev.dev;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400380 ubi->dev.class = ubi_class;
Kay Sievers160bbab2008-12-23 10:00:14 +0000381 dev_set_name(&ubi->dev, UBI_NAME_STR"%d", ubi->ubi_num);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400382 err = device_register(&ubi->dev);
383 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200384 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400385
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200386 *ref = 1;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400387 err = device_create_file(&ubi->dev, &dev_eraseblock_size);
388 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200389 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400390 err = device_create_file(&ubi->dev, &dev_avail_eraseblocks);
391 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200392 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400393 err = device_create_file(&ubi->dev, &dev_total_eraseblocks);
394 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200395 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400396 err = device_create_file(&ubi->dev, &dev_volumes_count);
397 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200398 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400399 err = device_create_file(&ubi->dev, &dev_max_ec);
400 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200401 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400402 err = device_create_file(&ubi->dev, &dev_reserved_for_bad);
403 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200404 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400405 err = device_create_file(&ubi->dev, &dev_bad_peb_count);
406 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200407 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400408 err = device_create_file(&ubi->dev, &dev_max_vol_count);
409 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200410 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400411 err = device_create_file(&ubi->dev, &dev_min_io_size);
412 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200413 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400414 err = device_create_file(&ubi->dev, &dev_bgt_enabled);
Artem Bityutskiyb6b76ba2007-12-26 13:46:46 +0200415 if (err)
416 return err;
417 err = device_create_file(&ubi->dev, &dev_mtd_num);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400418 return err;
419}
420
421/**
422 * ubi_sysfs_close - close sysfs for an UBI device.
423 * @ubi: UBI device description object
424 */
425static void ubi_sysfs_close(struct ubi_device *ubi)
426{
Artem Bityutskiyb6b76ba2007-12-26 13:46:46 +0200427 device_remove_file(&ubi->dev, &dev_mtd_num);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400428 device_remove_file(&ubi->dev, &dev_bgt_enabled);
429 device_remove_file(&ubi->dev, &dev_min_io_size);
430 device_remove_file(&ubi->dev, &dev_max_vol_count);
431 device_remove_file(&ubi->dev, &dev_bad_peb_count);
432 device_remove_file(&ubi->dev, &dev_reserved_for_bad);
433 device_remove_file(&ubi->dev, &dev_max_ec);
434 device_remove_file(&ubi->dev, &dev_volumes_count);
435 device_remove_file(&ubi->dev, &dev_total_eraseblocks);
436 device_remove_file(&ubi->dev, &dev_avail_eraseblocks);
437 device_remove_file(&ubi->dev, &dev_eraseblock_size);
438 device_unregister(&ubi->dev);
439}
440
441/**
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200442 * kill_volumes - destroy all user volumes.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400443 * @ubi: UBI device description object
444 */
445static void kill_volumes(struct ubi_device *ubi)
446{
447 int i;
448
449 for (i = 0; i < ubi->vtbl_slots; i++)
450 if (ubi->volumes[i])
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200451 ubi_free_volume(ubi, ubi->volumes[i]);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400452}
453
454/**
455 * uif_init - initialize user interfaces for an UBI device.
456 * @ubi: UBI device description object
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200457 * @ref: set to %1 on exit in case of failure if a reference to @ubi->dev was
458 * taken, otherwise set to %0
459 *
460 * This function initializes various user interfaces for an UBI device. If the
461 * initialization fails at an early stage, this function frees all the
462 * resources it allocated, returns an error, and @ref is set to %0. However,
463 * if the initialization fails after the UBI device was registered in the
464 * driver core subsystem, this function takes a reference to @ubi->dev, because
465 * otherwise the release function ('dev_release()') would free whole @ubi
466 * object. The @ref argument is set to %1 in this case. The caller has to put
467 * this reference.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400468 *
469 * This function returns zero in case of success and a negative error code in
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200470 * case of failure.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400471 */
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200472static int uif_init(struct ubi_device *ubi, int *ref)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400473{
Artem Bityutskiy8c4c19f2009-01-20 17:48:02 +0200474 int i, err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400475 dev_t dev;
476
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200477 *ref = 0;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400478 sprintf(ubi->ubi_name, UBI_NAME_STR "%d", ubi->ubi_num);
479
480 /*
481 * Major numbers for the UBI character devices are allocated
482 * dynamically. Major numbers of volume character devices are
483 * equivalent to ones of the corresponding UBI character device. Minor
484 * numbers of UBI character devices are 0, while minor numbers of
485 * volume character devices start from 1. Thus, we allocate one major
486 * number and ubi->vtbl_slots + 1 minor numbers.
487 */
488 err = alloc_chrdev_region(&dev, 0, ubi->vtbl_slots + 1, ubi->ubi_name);
489 if (err) {
490 ubi_err("cannot register UBI character devices");
491 return err;
492 }
493
Artem Bityutskiy49dfc292007-12-15 18:13:56 +0200494 ubi_assert(MINOR(dev) == 0);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400495 cdev_init(&ubi->cdev, &ubi_cdev_operations);
Artem Bityutskiyc8566352008-07-16 17:40:22 +0300496 dbg_gen("%s major is %u", ubi->ubi_name, MAJOR(dev));
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400497 ubi->cdev.owner = THIS_MODULE;
498
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400499 err = cdev_add(&ubi->cdev, dev, 1);
500 if (err) {
Artem Bityutskiy01f7b302007-12-15 19:56:51 +0200501 ubi_err("cannot add character device");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400502 goto out_unreg;
503 }
504
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200505 err = ubi_sysfs_init(ubi, ref);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400506 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200507 goto out_sysfs;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400508
509 for (i = 0; i < ubi->vtbl_slots; i++)
510 if (ubi->volumes[i]) {
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200511 err = ubi_add_volume(ubi, ubi->volumes[i]);
Artem Bityutskiy01f7b302007-12-15 19:56:51 +0200512 if (err) {
513 ubi_err("cannot add volume %d", i);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400514 goto out_volumes;
Artem Bityutskiy01f7b302007-12-15 19:56:51 +0200515 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400516 }
517
518 return 0;
519
520out_volumes:
521 kill_volumes(ubi);
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200522out_sysfs:
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200523 if (*ref)
524 get_device(&ubi->dev);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400525 ubi_sysfs_close(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400526 cdev_del(&ubi->cdev);
527out_unreg:
Artem Bityutskiy49dfc292007-12-15 18:13:56 +0200528 unregister_chrdev_region(ubi->cdev.dev, ubi->vtbl_slots + 1);
Artem Bityutskiy01f7b302007-12-15 19:56:51 +0200529 ubi_err("cannot initialize UBI %s, error %d", ubi->ubi_name, err);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400530 return err;
531}
532
533/**
534 * uif_close - close user interfaces for an UBI device.
535 * @ubi: UBI device description object
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300536 *
537 * Note, since this function un-registers UBI volume device objects (@vol->dev),
538 * the memory allocated voe the volumes is freed as well (in the release
539 * function).
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400540 */
541static void uif_close(struct ubi_device *ubi)
542{
543 kill_volumes(ubi);
544 ubi_sysfs_close(ubi);
545 cdev_del(&ubi->cdev);
Artem Bityutskiy49dfc292007-12-15 18:13:56 +0200546 unregister_chrdev_region(ubi->cdev.dev, ubi->vtbl_slots + 1);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400547}
548
549/**
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300550 * free_internal_volumes - free internal volumes.
551 * @ubi: UBI device description object
552 */
553static void free_internal_volumes(struct ubi_device *ubi)
554{
555 int i;
556
557 for (i = ubi->vtbl_slots;
558 i < ubi->vtbl_slots + UBI_INT_VOL_COUNT; i++) {
559 kfree(ubi->volumes[i]->eba_tbl);
560 kfree(ubi->volumes[i]);
561 }
562}
563
564/**
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400565 * attach_by_scanning - attach an MTD device using scanning method.
566 * @ubi: UBI device descriptor
567 *
568 * This function returns zero in case of success and a negative error code in
569 * case of failure.
570 *
571 * Note, currently this is the only method to attach UBI devices. Hopefully in
572 * the future we'll have more scalable attaching methods and avoid full media
573 * scanning. But even in this case scanning will be needed as a fall-back
574 * attaching method if there are some on-flash table corruptions.
575 */
576static int attach_by_scanning(struct ubi_device *ubi)
577{
578 int err;
579 struct ubi_scan_info *si;
580
581 si = ubi_scan(ubi);
582 if (IS_ERR(si))
583 return PTR_ERR(si);
584
585 ubi->bad_peb_count = si->bad_peb_count;
586 ubi->good_peb_count = ubi->peb_count - ubi->bad_peb_count;
587 ubi->max_ec = si->max_ec;
588 ubi->mean_ec = si->mean_ec;
589
590 err = ubi_read_volume_table(ubi, si);
591 if (err)
592 goto out_si;
593
594 err = ubi_wl_init_scan(ubi, si);
595 if (err)
596 goto out_vtbl;
597
598 err = ubi_eba_init_scan(ubi, si);
599 if (err)
600 goto out_wl;
601
602 ubi_scan_destroy_si(si);
603 return 0;
604
605out_wl:
606 ubi_wl_close(ubi);
607out_vtbl:
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300608 free_internal_volumes(ubi);
Vinit Agnihotrid7f0c4d2007-06-15 15:31:22 +0530609 vfree(ubi->vtbl);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400610out_si:
611 ubi_scan_destroy_si(si);
612 return err;
613}
614
615/**
Artem Bityutskiy85c6e6e2008-07-16 10:25:56 +0300616 * io_init - initialize I/O sub-system for a given UBI device.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400617 * @ubi: UBI device description object
618 *
619 * If @ubi->vid_hdr_offset or @ubi->leb_start is zero, default offsets are
620 * assumed:
621 * o EC header is always at offset zero - this cannot be changed;
622 * o VID header starts just after the EC header at the closest address
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200623 * aligned to @io->hdrs_min_io_size;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400624 * o data starts just after the VID header at the closest address aligned to
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200625 * @io->min_io_size
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400626 *
627 * This function returns zero in case of success and a negative error code in
628 * case of failure.
629 */
630static int io_init(struct ubi_device *ubi)
631{
632 if (ubi->mtd->numeraseregions != 0) {
633 /*
634 * Some flashes have several erase regions. Different regions
635 * may have different eraseblock size and other
636 * characteristics. It looks like mostly multi-region flashes
637 * have one "main" region and one or more small regions to
638 * store boot loader code or boot parameters or whatever. I
639 * guess we should just pick the largest region. But this is
640 * not implemented.
641 */
642 ubi_err("multiple regions, not implemented");
643 return -EINVAL;
644 }
645
Artem Bityutskiydd38fcc2007-12-19 21:43:32 +0200646 if (ubi->vid_hdr_offset < 0)
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200647 return -EINVAL;
648
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400649 /*
650 * Note, in this implementation we support MTD devices with 0x7FFFFFFF
651 * physical eraseblocks maximum.
652 */
653
654 ubi->peb_size = ubi->mtd->erasesize;
Adrian Hunter69423d92008-12-10 13:37:21 +0000655 ubi->peb_count = mtd_div_by_eb(ubi->mtd->size, ubi->mtd);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400656 ubi->flash_size = ubi->mtd->size;
657
658 if (ubi->mtd->block_isbad && ubi->mtd->block_markbad)
659 ubi->bad_allowed = 1;
660
Artem Bityutskiyebf53f42009-07-06 08:57:53 +0300661 if (ubi->mtd->type == MTD_NORFLASH) {
662 ubi_assert(ubi->mtd->writesize == 1);
663 ubi->nor_flash = 1;
664 }
665
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400666 ubi->min_io_size = ubi->mtd->writesize;
667 ubi->hdrs_min_io_size = ubi->mtd->writesize >> ubi->mtd->subpage_sft;
668
Kyungmin Parkcadb40c2008-05-22 10:32:18 +0900669 /*
670 * Make sure minimal I/O unit is power of 2. Note, there is no
671 * fundamental reason for this assumption. It is just an optimization
672 * which allows us to avoid costly division operations.
673 */
Vignesh Babu7753f162007-06-12 10:31:05 +0530674 if (!is_power_of_2(ubi->min_io_size)) {
Artem Bityutskiy01f7b302007-12-15 19:56:51 +0200675 ubi_err("min. I/O unit (%d) is not power of 2",
676 ubi->min_io_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400677 return -EINVAL;
678 }
679
680 ubi_assert(ubi->hdrs_min_io_size > 0);
681 ubi_assert(ubi->hdrs_min_io_size <= ubi->min_io_size);
682 ubi_assert(ubi->min_io_size % ubi->hdrs_min_io_size == 0);
683
684 /* Calculate default aligned sizes of EC and VID headers */
685 ubi->ec_hdr_alsize = ALIGN(UBI_EC_HDR_SIZE, ubi->hdrs_min_io_size);
686 ubi->vid_hdr_alsize = ALIGN(UBI_VID_HDR_SIZE, ubi->hdrs_min_io_size);
687
688 dbg_msg("min_io_size %d", ubi->min_io_size);
689 dbg_msg("hdrs_min_io_size %d", ubi->hdrs_min_io_size);
690 dbg_msg("ec_hdr_alsize %d", ubi->ec_hdr_alsize);
691 dbg_msg("vid_hdr_alsize %d", ubi->vid_hdr_alsize);
692
693 if (ubi->vid_hdr_offset == 0)
694 /* Default offset */
695 ubi->vid_hdr_offset = ubi->vid_hdr_aloffset =
696 ubi->ec_hdr_alsize;
697 else {
698 ubi->vid_hdr_aloffset = ubi->vid_hdr_offset &
699 ~(ubi->hdrs_min_io_size - 1);
700 ubi->vid_hdr_shift = ubi->vid_hdr_offset -
701 ubi->vid_hdr_aloffset;
702 }
703
704 /* Similar for the data offset */
Artem Bityutskiyd5360582008-01-17 15:41:14 +0200705 ubi->leb_start = ubi->vid_hdr_offset + UBI_EC_HDR_SIZE;
Artem Bityutskiydd38fcc2007-12-19 21:43:32 +0200706 ubi->leb_start = ALIGN(ubi->leb_start, ubi->min_io_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400707
708 dbg_msg("vid_hdr_offset %d", ubi->vid_hdr_offset);
709 dbg_msg("vid_hdr_aloffset %d", ubi->vid_hdr_aloffset);
710 dbg_msg("vid_hdr_shift %d", ubi->vid_hdr_shift);
711 dbg_msg("leb_start %d", ubi->leb_start);
712
713 /* The shift must be aligned to 32-bit boundary */
714 if (ubi->vid_hdr_shift % 4) {
715 ubi_err("unaligned VID header shift %d",
716 ubi->vid_hdr_shift);
717 return -EINVAL;
718 }
719
720 /* Check sanity */
721 if (ubi->vid_hdr_offset < UBI_EC_HDR_SIZE ||
722 ubi->leb_start < ubi->vid_hdr_offset + UBI_VID_HDR_SIZE ||
723 ubi->leb_start > ubi->peb_size - UBI_VID_HDR_SIZE ||
Kyungmin Parkcadb40c2008-05-22 10:32:18 +0900724 ubi->leb_start & (ubi->min_io_size - 1)) {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400725 ubi_err("bad VID header (%d) or data offsets (%d)",
726 ubi->vid_hdr_offset, ubi->leb_start);
727 return -EINVAL;
728 }
729
730 /*
Artem Bityutskiyb86a2c52009-05-24 14:13:34 +0300731 * Set maximum amount of physical erroneous eraseblocks to be 10%.
732 * Erroneous PEB are those which have read errors.
733 */
734 ubi->max_erroneous = ubi->peb_count / 10;
735 if (ubi->max_erroneous < 16)
736 ubi->max_erroneous = 16;
737 dbg_msg("max_erroneous %d", ubi->max_erroneous);
738
739 /*
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400740 * It may happen that EC and VID headers are situated in one minimal
741 * I/O unit. In this case we can only accept this UBI image in
742 * read-only mode.
743 */
744 if (ubi->vid_hdr_offset + UBI_VID_HDR_SIZE <= ubi->hdrs_min_io_size) {
745 ubi_warn("EC and VID headers are in the same minimal I/O unit, "
746 "switch to read-only mode");
747 ubi->ro_mode = 1;
748 }
749
750 ubi->leb_size = ubi->peb_size - ubi->leb_start;
751
752 if (!(ubi->mtd->flags & MTD_WRITEABLE)) {
753 ubi_msg("MTD device %d is write-protected, attach in "
754 "read-only mode", ubi->mtd->index);
755 ubi->ro_mode = 1;
756 }
757
Artem Bityutskiy434b8252008-04-20 18:00:33 +0300758 ubi_msg("physical eraseblock size: %d bytes (%d KiB)",
759 ubi->peb_size, ubi->peb_size >> 10);
760 ubi_msg("logical eraseblock size: %d bytes", ubi->leb_size);
761 ubi_msg("smallest flash I/O unit: %d", ubi->min_io_size);
762 if (ubi->hdrs_min_io_size != ubi->min_io_size)
763 ubi_msg("sub-page size: %d",
764 ubi->hdrs_min_io_size);
765 ubi_msg("VID header offset: %d (aligned %d)",
766 ubi->vid_hdr_offset, ubi->vid_hdr_aloffset);
767 ubi_msg("data offset: %d", ubi->leb_start);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400768
769 /*
770 * Note, ideally, we have to initialize ubi->bad_peb_count here. But
771 * unfortunately, MTD does not provide this information. We should loop
772 * over all physical eraseblocks and invoke mtd->block_is_bad() for
773 * each physical eraseblock. So, we skip ubi->bad_peb_count
774 * uninitialized and initialize it after scanning.
775 */
776
777 return 0;
778}
779
780/**
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200781 * autoresize - re-size the volume which has the "auto-resize" flag set.
782 * @ubi: UBI device description object
783 * @vol_id: ID of the volume to re-size
784 *
785 * This function re-sizes the volume marked by the @UBI_VTBL_AUTORESIZE_FLG in
786 * the volume table to the largest possible size. See comments in ubi-header.h
787 * for more description of the flag. Returns zero in case of success and a
788 * negative error code in case of failure.
789 */
790static int autoresize(struct ubi_device *ubi, int vol_id)
791{
792 struct ubi_volume_desc desc;
793 struct ubi_volume *vol = ubi->volumes[vol_id];
794 int err, old_reserved_pebs = vol->reserved_pebs;
795
796 /*
797 * Clear the auto-resize flag in the volume in-memory copy of the
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300798 * volume table, and 'ubi_resize_volume()' will propagate this change
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200799 * to the flash.
800 */
801 ubi->vtbl[vol_id].flags &= ~UBI_VTBL_AUTORESIZE_FLG;
802
803 if (ubi->avail_pebs == 0) {
804 struct ubi_vtbl_record vtbl_rec;
805
806 /*
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300807 * No available PEBs to re-size the volume, clear the flag on
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200808 * flash and exit.
809 */
810 memcpy(&vtbl_rec, &ubi->vtbl[vol_id],
811 sizeof(struct ubi_vtbl_record));
812 err = ubi_change_vtbl_record(ubi, vol_id, &vtbl_rec);
813 if (err)
814 ubi_err("cannot clean auto-resize flag for volume %d",
815 vol_id);
816 } else {
817 desc.vol = vol;
818 err = ubi_resize_volume(&desc,
819 old_reserved_pebs + ubi->avail_pebs);
820 if (err)
821 ubi_err("cannot auto-resize volume %d", vol_id);
822 }
823
824 if (err)
825 return err;
826
827 ubi_msg("volume %d (\"%s\") re-sized from %d to %d LEBs", vol_id,
828 vol->name, old_reserved_pebs, vol->reserved_pebs);
829 return 0;
830}
831
832/**
Kevin Cernekeed9dd0882009-06-09 10:59:19 -0700833 * ubi_reboot_notifier - halt UBI transactions immediately prior to a reboot.
834 * @n: reboot notifier object
835 * @state: SYS_RESTART, SYS_HALT, or SYS_POWER_OFF
836 * @cmd: pointer to command string for RESTART2
837 *
838 * This function stops the UBI background thread so that the flash device
839 * remains quiescent when Linux restarts the system. Any queued work will be
840 * discarded, but this function will block until do_work() finishes if an
841 * operation is already in progress.
842 *
843 * This function solves a real-life problem observed on NOR flashes when an
844 * PEB erase operation starts, then the system is rebooted before the erase is
845 * finishes, and the boot loader gets confused and dies. So we prefer to finish
846 * the ongoing operation before rebooting.
847 */
848static int ubi_reboot_notifier(struct notifier_block *n, unsigned long state,
849 void *cmd)
850{
851 struct ubi_device *ubi;
852
853 ubi = container_of(n, struct ubi_device, reboot_notifier);
854 if (ubi->bgt_thread)
855 kthread_stop(ubi->bgt_thread);
856 ubi_sync(ubi->ubi_num);
857 return NOTIFY_DONE;
858}
859
860/**
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200861 * ubi_attach_mtd_dev - attach an MTD device.
Artem Bityutskiyebaaf1a2008-07-18 13:34:32 +0300862 * @mtd: MTD device description object
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200863 * @ubi_num: number to assign to the new UBI device
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400864 * @vid_hdr_offset: VID header offset
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400865 *
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200866 * This function attaches MTD device @mtd_dev to UBI and assign @ubi_num number
867 * to the newly created UBI device, unless @ubi_num is %UBI_DEV_NUM_AUTO, in
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300868 * which case this function finds a vacant device number and assigns it
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200869 * automatically. Returns the new UBI device number in case of success and a
870 * negative error code in case of failure.
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200871 *
872 * Note, the invocations of this function has to be serialized by the
873 * @ubi_devices_mutex.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400874 */
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200875int ubi_attach_mtd_dev(struct mtd_info *mtd, int ubi_num, int vid_hdr_offset)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400876{
877 struct ubi_device *ubi;
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200878 int i, err, ref = 0;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400879
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200880 /*
881 * Check if we already have the same MTD device attached.
882 *
883 * Note, this function assumes that UBI devices creations and deletions
884 * are serialized, so it does not take the &ubi_devices_lock.
885 */
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200886 for (i = 0; i < UBI_MAX_DEVICES; i++) {
Artem Bityutskiyb96bf4c2007-12-16 13:01:03 +0200887 ubi = ubi_devices[i];
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200888 if (ubi && mtd->index == ubi->mtd->index) {
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200889 dbg_err("mtd%d is already attached to ubi%d",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400890 mtd->index, i);
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200891 return -EEXIST;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400892 }
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200893 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400894
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200895 /*
896 * Make sure this MTD device is not emulated on top of an UBI volume
897 * already. Well, generally this recursion works fine, but there are
898 * different problems like the UBI module takes a reference to itself
899 * by attaching (and thus, opening) the emulated MTD device. This
900 * results in inability to unload the module. And in general it makes
901 * no sense to attach emulated MTD devices, so we prohibit this.
902 */
903 if (mtd->type == MTD_UBIVOLUME) {
904 ubi_err("refuse attaching mtd%d - it is already emulated on "
905 "top of UBI", mtd->index);
906 return -EINVAL;
907 }
Artem Bityutskiyb96bf4c2007-12-16 13:01:03 +0200908
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200909 if (ubi_num == UBI_DEV_NUM_AUTO) {
910 /* Search for an empty slot in the @ubi_devices array */
911 for (ubi_num = 0; ubi_num < UBI_MAX_DEVICES; ubi_num++)
912 if (!ubi_devices[ubi_num])
913 break;
914 if (ubi_num == UBI_MAX_DEVICES) {
Artem Bityutskiy9c9ec142008-07-18 13:19:52 +0300915 dbg_err("only %d UBI devices may be created",
916 UBI_MAX_DEVICES);
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200917 return -ENFILE;
918 }
919 } else {
920 if (ubi_num >= UBI_MAX_DEVICES)
921 return -EINVAL;
922
923 /* Make sure ubi_num is not busy */
924 if (ubi_devices[ubi_num]) {
925 dbg_err("ubi%d already exists", ubi_num);
926 return -EEXIST;
927 }
Artem Bityutskiyb96bf4c2007-12-16 13:01:03 +0200928 }
929
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200930 ubi = kzalloc(sizeof(struct ubi_device), GFP_KERNEL);
931 if (!ubi)
932 return -ENOMEM;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400933
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200934 ubi->mtd = mtd;
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200935 ubi->ubi_num = ubi_num;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400936 ubi->vid_hdr_offset = vid_hdr_offset;
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200937 ubi->autoresize_vol_id = -1;
938
939 mutex_init(&ubi->buf_mutex);
940 mutex_init(&ubi->ckvol_mutex);
Artem Bityutskiyf089c0b2009-05-07 11:46:49 +0300941 mutex_init(&ubi->device_mutex);
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200942 spin_lock_init(&ubi->volumes_lock);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200943
Artem Bityutskiy697fa972008-04-23 13:43:21 +0300944 ubi_msg("attaching mtd%d to ubi%d", mtd->index, ubi_num);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200945
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400946 err = io_init(ubi);
947 if (err)
948 goto out_free;
949
Stefan Roesead5942b2008-12-10 10:42:54 +0100950 err = -ENOMEM;
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300951 ubi->peb_buf1 = vmalloc(ubi->peb_size);
952 if (!ubi->peb_buf1)
953 goto out_free;
954
955 ubi->peb_buf2 = vmalloc(ubi->peb_size);
956 if (!ubi->peb_buf2)
Stefan Roesead5942b2008-12-10 10:42:54 +0100957 goto out_free;
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300958
Artem Bityutskiy2cb81e22009-05-12 15:10:03 +0300959#ifdef CONFIG_MTD_UBI_DEBUG_PARANOID
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300960 mutex_init(&ubi->dbg_buf_mutex);
961 ubi->dbg_peb_buf = vmalloc(ubi->peb_size);
962 if (!ubi->dbg_peb_buf)
Stefan Roesead5942b2008-12-10 10:42:54 +0100963 goto out_free;
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300964#endif
965
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400966 err = attach_by_scanning(ubi);
967 if (err) {
968 dbg_err("failed to attach by scanning, error %d", err);
969 goto out_free;
970 }
971
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200972 if (ubi->autoresize_vol_id != -1) {
973 err = autoresize(ubi, ubi->autoresize_vol_id);
974 if (err)
975 goto out_detach;
976 }
977
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200978 err = uif_init(ubi, &ref);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400979 if (err)
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200980 goto out_detach;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400981
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200982 ubi->bgt_thread = kthread_create(ubi_thread, ubi, ubi->bgt_name);
983 if (IS_ERR(ubi->bgt_thread)) {
984 err = PTR_ERR(ubi->bgt_thread);
985 ubi_err("cannot spawn \"%s\", error %d", ubi->bgt_name,
986 err);
987 goto out_uif;
988 }
989
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200990 ubi_msg("attached mtd%d to ubi%d", mtd->index, ubi_num);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200991 ubi_msg("MTD device name: \"%s\"", mtd->name);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400992 ubi_msg("MTD device size: %llu MiB", ubi->flash_size >> 20);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400993 ubi_msg("number of good PEBs: %d", ubi->good_peb_count);
994 ubi_msg("number of bad PEBs: %d", ubi->bad_peb_count);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400995 ubi_msg("max. allowed volumes: %d", ubi->vtbl_slots);
996 ubi_msg("wear-leveling threshold: %d", CONFIG_MTD_UBI_WL_THRESHOLD);
997 ubi_msg("number of internal volumes: %d", UBI_INT_VOL_COUNT);
998 ubi_msg("number of user volumes: %d",
999 ubi->vol_count - UBI_INT_VOL_COUNT);
1000 ubi_msg("available PEBs: %d", ubi->avail_pebs);
1001 ubi_msg("total number of reserved PEBs: %d", ubi->rsvd_pebs);
1002 ubi_msg("number of PEBs reserved for bad PEB handling: %d",
1003 ubi->beb_rsvd_pebs);
1004 ubi_msg("max/mean erase counter: %d/%d", ubi->max_ec, ubi->mean_ec);
Adrian Hunter0c6c7fa2009-06-26 14:58:01 +03001005 ubi_msg("image sequence number: %d", ubi->image_seq);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001006
Artem Bityutskiyddbd3b62009-05-23 13:44:09 +03001007 /*
1008 * The below lock makes sure we do not race with 'ubi_thread()' which
1009 * checks @ubi->thread_enabled. Otherwise we may fail to wake it up.
1010 */
1011 spin_lock(&ubi->wl_lock);
Artem Bityutskiyd37e6bf2008-07-24 18:28:11 +03001012 if (!DBG_DISABLE_BGT)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001013 ubi->thread_enabled = 1;
Artem Bityutskiyd37e6bf2008-07-24 18:28:11 +03001014 wake_up_process(ubi->bgt_thread);
Artem Bityutskiyddbd3b62009-05-23 13:44:09 +03001015 spin_unlock(&ubi->wl_lock);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001016
Kevin Cernekeed9dd0882009-06-09 10:59:19 -07001017 /* Flash device priority is 0 - UBI needs to shut down first */
1018 ubi->reboot_notifier.priority = 1;
1019 ubi->reboot_notifier.notifier_call = ubi_reboot_notifier;
1020 register_reboot_notifier(&ubi->reboot_notifier);
1021
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001022 ubi_devices[ubi_num] = ubi;
Dmitry Pervushin0e0ee1c2009-04-29 19:29:38 +04001023 ubi_notify_all(ubi, UBI_VOLUME_ADDED, NULL);
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001024 return ubi_num;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001025
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001026out_uif:
1027 uif_close(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001028out_detach:
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001029 ubi_wl_close(ubi);
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +03001030 free_internal_volumes(ubi);
Vinit Agnihotrid7f0c4d2007-06-15 15:31:22 +05301031 vfree(ubi->vtbl);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001032out_free:
Artem Bityutskiye88d6e102007-08-29 14:51:52 +03001033 vfree(ubi->peb_buf1);
1034 vfree(ubi->peb_buf2);
Artem Bityutskiy2cb81e22009-05-12 15:10:03 +03001035#ifdef CONFIG_MTD_UBI_DEBUG_PARANOID
Artem Bityutskiye88d6e102007-08-29 14:51:52 +03001036 vfree(ubi->dbg_peb_buf);
1037#endif
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +02001038 if (ref)
1039 put_device(&ubi->dev);
1040 else
1041 kfree(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001042 return err;
1043}
1044
1045/**
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001046 * ubi_detach_mtd_dev - detach an MTD device.
1047 * @ubi_num: UBI device number to detach from
1048 * @anyway: detach MTD even if device reference count is not zero
1049 *
1050 * This function destroys an UBI device number @ubi_num and detaches the
1051 * underlying MTD device. Returns zero in case of success and %-EBUSY if the
1052 * UBI device is busy and cannot be destroyed, and %-EINVAL if it does not
1053 * exist.
1054 *
1055 * Note, the invocations of this function has to be serialized by the
1056 * @ubi_devices_mutex.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001057 */
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001058int ubi_detach_mtd_dev(int ubi_num, int anyway)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001059{
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001060 struct ubi_device *ubi;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001061
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001062 if (ubi_num < 0 || ubi_num >= UBI_MAX_DEVICES)
1063 return -EINVAL;
1064
Dmitry Pervushin0e0ee1c2009-04-29 19:29:38 +04001065 ubi = ubi_get_device(ubi_num);
1066 if (!ubi)
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001067 return -EINVAL;
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001068
Dmitry Pervushin0e0ee1c2009-04-29 19:29:38 +04001069 spin_lock(&ubi_devices_lock);
1070 put_device(&ubi->dev);
1071 ubi->ref_count -= 1;
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001072 if (ubi->ref_count) {
1073 if (!anyway) {
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001074 spin_unlock(&ubi_devices_lock);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001075 return -EBUSY;
1076 }
1077 /* This may only happen if there is a bug */
1078 ubi_err("%s reference count %d, destroy anyway",
1079 ubi->ubi_name, ubi->ref_count);
1080 }
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001081 ubi_devices[ubi_num] = NULL;
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001082 spin_unlock(&ubi_devices_lock);
1083
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001084 ubi_assert(ubi_num == ubi->ubi_num);
Dmitry Pervushin0e0ee1c2009-04-29 19:29:38 +04001085 ubi_notify_all(ubi, UBI_VOLUME_REMOVED, NULL);
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001086 dbg_msg("detaching mtd%d from ubi%d", ubi->mtd->index, ubi_num);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001087
1088 /*
1089 * Before freeing anything, we have to stop the background thread to
1090 * prevent it from doing anything on this device while we are freeing.
1091 */
Kevin Cernekeed9dd0882009-06-09 10:59:19 -07001092 unregister_reboot_notifier(&ubi->reboot_notifier);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001093 if (ubi->bgt_thread)
1094 kthread_stop(ubi->bgt_thread);
1095
Artem Bityutskiy36b477d2009-01-20 18:04:09 +02001096 /*
1097 * Get a reference to the device in order to prevent 'dev_release()'
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +02001098 * from freeing the @ubi object.
Artem Bityutskiy36b477d2009-01-20 18:04:09 +02001099 */
1100 get_device(&ubi->dev);
1101
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001102 uif_close(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001103 ubi_wl_close(ubi);
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +03001104 free_internal_volumes(ubi);
Artem Bityutskiy92ad8f32007-05-06 16:12:54 +03001105 vfree(ubi->vtbl);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001106 put_mtd_device(ubi->mtd);
Artem Bityutskiye88d6e102007-08-29 14:51:52 +03001107 vfree(ubi->peb_buf1);
1108 vfree(ubi->peb_buf2);
Artem Bityutskiy2cb81e22009-05-12 15:10:03 +03001109#ifdef CONFIG_MTD_UBI_DEBUG_PARANOID
Artem Bityutskiye88d6e102007-08-29 14:51:52 +03001110 vfree(ubi->dbg_peb_buf);
1111#endif
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001112 ubi_msg("mtd%d is detached from ubi%d", ubi->mtd->index, ubi->ubi_num);
Artem Bityutskiy36b477d2009-01-20 18:04:09 +02001113 put_device(&ubi->dev);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001114 return 0;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001115}
1116
Artem Bityutskiy3a8d4642007-12-16 12:32:51 +02001117/**
Artem Bityutskiyf9b00802010-01-05 16:48:40 +02001118 * open_mtd_by_chdev - open an MTD device by its character device node path.
1119 * @mtd_dev: MTD character device node path
1120 *
1121 * This helper function opens an MTD device by its character node device path.
1122 * Returns MTD device description object in case of success and a negative
1123 * error code in case of failure.
1124 */
1125static struct mtd_info * __init open_mtd_by_chdev(const char *mtd_dev)
1126{
1127 int err, major, minor, mode;
1128 struct path path;
1129
1130 /* Probably this is an MTD character device node path */
1131 err = kern_path(mtd_dev, LOOKUP_FOLLOW, &path);
1132 if (err)
1133 return ERR_PTR(err);
1134
1135 /* MTD device number is defined by the major / minor numbers */
1136 major = imajor(path.dentry->d_inode);
1137 minor = iminor(path.dentry->d_inode);
1138 mode = path.dentry->d_inode->i_mode;
1139 path_put(&path);
1140 if (major != MTD_CHAR_MAJOR || !S_ISCHR(mode))
1141 return ERR_PTR(-EINVAL);
1142
1143 if (minor & 1)
1144 /*
1145 * Just do not think the "/dev/mtdrX" devices support is need,
1146 * so do not support them to avoid doing extra work.
1147 */
1148 return ERR_PTR(-EINVAL);
1149
1150 return get_mtd_device(NULL, minor / 2);
1151}
1152
1153/**
1154 * open_mtd_device - open MTD device by name, character device path, or number.
1155 * @mtd_dev: name, character device node path, or MTD device device number
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001156 *
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001157 * This function tries to open and MTD device described by @mtd_dev string,
Artem Bityutskiyf9b00802010-01-05 16:48:40 +02001158 * which is first treated as ASCII MTD device number, and if it is not true, it
1159 * is treated as MTD device name, and if that is also not true, it is treated
1160 * as MTD character device node path. Returns MTD device description object in
1161 * case of success and a negative error code in case of failure.
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001162 */
1163static struct mtd_info * __init open_mtd_device(const char *mtd_dev)
1164{
1165 struct mtd_info *mtd;
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001166 int mtd_num;
1167 char *endp;
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001168
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001169 mtd_num = simple_strtoul(mtd_dev, &endp, 0);
1170 if (*endp != '\0' || mtd_dev == endp) {
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001171 /*
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001172 * This does not look like an ASCII integer, probably this is
1173 * MTD device name.
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001174 */
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001175 mtd = get_mtd_device_nm(mtd_dev);
Artem Bityutskiyf9b00802010-01-05 16:48:40 +02001176 if (IS_ERR(mtd) && PTR_ERR(mtd) == -ENODEV)
1177 /* Probably this is an MTD character device node path */
1178 mtd = open_mtd_by_chdev(mtd_dev);
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001179 } else
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001180 mtd = get_mtd_device(NULL, mtd_num);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001181
1182 return mtd;
1183}
1184
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001185static int __init ubi_init(void)
1186{
1187 int err, i, k;
1188
1189 /* Ensure that EC and VID headers have correct size */
1190 BUILD_BUG_ON(sizeof(struct ubi_ec_hdr) != 64);
1191 BUILD_BUG_ON(sizeof(struct ubi_vid_hdr) != 64);
1192
1193 if (mtd_devs > UBI_MAX_DEVICES) {
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001194 ubi_err("too many MTD devices, maximum is %d", UBI_MAX_DEVICES);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001195 return -EINVAL;
1196 }
1197
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001198 /* Create base sysfs directory and sysfs files */
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001199 ubi_class = class_create(THIS_MODULE, UBI_NAME_STR);
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001200 if (IS_ERR(ubi_class)) {
1201 err = PTR_ERR(ubi_class);
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001202 ubi_err("cannot create UBI class");
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001203 goto out;
1204 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001205
1206 err = class_create_file(ubi_class, &ubi_version);
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001207 if (err) {
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001208 ubi_err("cannot create sysfs file");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001209 goto out_class;
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001210 }
1211
1212 err = misc_register(&ubi_ctrl_cdev);
1213 if (err) {
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001214 ubi_err("cannot register device");
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001215 goto out_version;
1216 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001217
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +02001218 ubi_wl_entry_slab = kmem_cache_create("ubi_wl_entry_slab",
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001219 sizeof(struct ubi_wl_entry),
1220 0, 0, NULL);
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +02001221 if (!ubi_wl_entry_slab)
Artem Bityutskiyb9a06622008-01-16 12:11:54 +02001222 goto out_dev_unreg;
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +02001223
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001224 /* Attach MTD devices */
1225 for (i = 0; i < mtd_devs; i++) {
1226 struct mtd_dev_param *p = &mtd_dev_param[i];
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001227 struct mtd_info *mtd;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001228
1229 cond_resched();
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001230
1231 mtd = open_mtd_device(p->name);
1232 if (IS_ERR(mtd)) {
1233 err = PTR_ERR(mtd);
1234 goto out_detach;
1235 }
1236
1237 mutex_lock(&ubi_devices_mutex);
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001238 err = ubi_attach_mtd_dev(mtd, UBI_DEV_NUM_AUTO,
1239 p->vid_hdr_offs);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001240 mutex_unlock(&ubi_devices_mutex);
1241 if (err < 0) {
1242 put_mtd_device(mtd);
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001243 ubi_err("cannot attach mtd%d", mtd->index);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001244 goto out_detach;
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001245 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001246 }
1247
1248 return 0;
1249
1250out_detach:
1251 for (k = 0; k < i; k++)
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001252 if (ubi_devices[k]) {
1253 mutex_lock(&ubi_devices_mutex);
1254 ubi_detach_mtd_dev(ubi_devices[k]->ubi_num, 1);
1255 mutex_unlock(&ubi_devices_mutex);
1256 }
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +02001257 kmem_cache_destroy(ubi_wl_entry_slab);
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001258out_dev_unreg:
1259 misc_deregister(&ubi_ctrl_cdev);
Artem Bityutskiy3a8d4642007-12-16 12:32:51 +02001260out_version:
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001261 class_remove_file(ubi_class, &ubi_version);
1262out_class:
1263 class_destroy(ubi_class);
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001264out:
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001265 ubi_err("UBI error: cannot initialize UBI, error %d", err);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001266 return err;
1267}
1268module_init(ubi_init);
1269
1270static void __exit ubi_exit(void)
1271{
Artem Bityutskiyb96bf4c2007-12-16 13:01:03 +02001272 int i;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001273
Artem Bityutskiyb96bf4c2007-12-16 13:01:03 +02001274 for (i = 0; i < UBI_MAX_DEVICES; i++)
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001275 if (ubi_devices[i]) {
1276 mutex_lock(&ubi_devices_mutex);
1277 ubi_detach_mtd_dev(ubi_devices[i]->ubi_num, 1);
1278 mutex_unlock(&ubi_devices_mutex);
1279 }
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +02001280 kmem_cache_destroy(ubi_wl_entry_slab);
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001281 misc_deregister(&ubi_ctrl_cdev);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001282 class_remove_file(ubi_class, &ubi_version);
1283 class_destroy(ubi_class);
1284}
1285module_exit(ubi_exit);
1286
1287/**
Artem Bityutskiyebaaf1a2008-07-18 13:34:32 +03001288 * bytes_str_to_int - convert a number of bytes string into an integer.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001289 * @str: the string to convert
1290 *
1291 * This function returns positive resulting integer in case of success and a
1292 * negative error code in case of failure.
1293 */
1294static int __init bytes_str_to_int(const char *str)
1295{
1296 char *endp;
1297 unsigned long result;
1298
1299 result = simple_strtoul(str, &endp, 0);
Roel Kluin774b1382009-10-16 14:00:17 +02001300 if (str == endp || result >= INT_MAX) {
Artem Bityutskiy458dbb32007-12-19 17:03:42 +02001301 printk(KERN_ERR "UBI error: incorrect bytes count: \"%s\"\n",
1302 str);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001303 return -EINVAL;
1304 }
1305
1306 switch (*endp) {
1307 case 'G':
1308 result *= 1024;
1309 case 'M':
1310 result *= 1024;
1311 case 'K':
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001312 result *= 1024;
Artem Bityutskiyaeddb872007-12-26 14:25:58 +02001313 if (endp[1] == 'i' && endp[2] == 'B')
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001314 endp += 2;
1315 case '\0':
1316 break;
1317 default:
Artem Bityutskiy458dbb32007-12-19 17:03:42 +02001318 printk(KERN_ERR "UBI error: incorrect bytes count: \"%s\"\n",
1319 str);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001320 return -EINVAL;
1321 }
1322
1323 return result;
1324}
1325
1326/**
1327 * ubi_mtd_param_parse - parse the 'mtd=' UBI parameter.
1328 * @val: the parameter value to parse
1329 * @kp: not used
1330 *
1331 * This function returns zero in case of success and a negative error code in
1332 * case of error.
1333 */
1334static int __init ubi_mtd_param_parse(const char *val, struct kernel_param *kp)
1335{
1336 int i, len;
1337 struct mtd_dev_param *p;
1338 char buf[MTD_PARAM_LEN_MAX];
1339 char *pbuf = &buf[0];
Artem Bityutskiyddc49392008-01-17 15:35:57 +02001340 char *tokens[2] = {NULL, NULL};
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001341
Artem Bityutskiy77c722d2007-12-16 16:46:57 +02001342 if (!val)
1343 return -EINVAL;
1344
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001345 if (mtd_devs == UBI_MAX_DEVICES) {
Artem Bityutskiy458dbb32007-12-19 17:03:42 +02001346 printk(KERN_ERR "UBI error: too many parameters, max. is %d\n",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001347 UBI_MAX_DEVICES);
1348 return -EINVAL;
1349 }
1350
1351 len = strnlen(val, MTD_PARAM_LEN_MAX);
1352 if (len == MTD_PARAM_LEN_MAX) {
Artem Bityutskiy458dbb32007-12-19 17:03:42 +02001353 printk(KERN_ERR "UBI error: parameter \"%s\" is too long, "
1354 "max. is %d\n", val, MTD_PARAM_LEN_MAX);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001355 return -EINVAL;
1356 }
1357
1358 if (len == 0) {
Artem Bityutskiy458dbb32007-12-19 17:03:42 +02001359 printk(KERN_WARNING "UBI warning: empty 'mtd=' parameter - "
1360 "ignored\n");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001361 return 0;
1362 }
1363
1364 strcpy(buf, val);
1365
1366 /* Get rid of the final newline */
1367 if (buf[len - 1] == '\n')
Artem Bityutskiy503990e2007-07-11 16:03:29 +03001368 buf[len - 1] = '\0';
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001369
Artem Bityutskiyddc49392008-01-17 15:35:57 +02001370 for (i = 0; i < 2; i++)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001371 tokens[i] = strsep(&pbuf, ",");
1372
1373 if (pbuf) {
Artem Bityutskiy458dbb32007-12-19 17:03:42 +02001374 printk(KERN_ERR "UBI error: too many arguments at \"%s\"\n",
1375 val);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001376 return -EINVAL;
1377 }
1378
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001379 p = &mtd_dev_param[mtd_devs];
1380 strcpy(&p->name[0], tokens[0]);
1381
1382 if (tokens[1])
1383 p->vid_hdr_offs = bytes_str_to_int(tokens[1]);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001384
1385 if (p->vid_hdr_offs < 0)
1386 return p->vid_hdr_offs;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001387
1388 mtd_devs += 1;
1389 return 0;
1390}
1391
1392module_param_call(mtd, ubi_mtd_param_parse, NULL, NULL, 000);
1393MODULE_PARM_DESC(mtd, "MTD devices to attach. Parameter format: "
Artem Bityutskiyf9b00802010-01-05 16:48:40 +02001394 "mtd=<name|num|path>[,<vid_hdr_offs>].\n"
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001395 "Multiple \"mtd\" parameters may be specified.\n"
Artem Bityutskiyf9b00802010-01-05 16:48:40 +02001396 "MTD devices may be specified by their number, name, or "
1397 "path to the MTD character device node.\n"
Artem Bityutskiydd38fcc2007-12-19 21:43:32 +02001398 "Optional \"vid_hdr_offs\" parameter specifies UBI VID "
Artem Bityutskiyf9b00802010-01-05 16:48:40 +02001399 "header position to be used by UBI.\n"
1400 "Example 1: mtd=/dev/mtd0 - attach MTD device "
1401 "/dev/mtd0.\n"
1402 "Example 2: mtd=content,1984 mtd=4 - attach MTD device "
Artem Bityutskiydd38fcc2007-12-19 21:43:32 +02001403 "with name \"content\" using VID header offset 1984, and "
1404 "MTD device number 4 with default VID header offset.");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001405
1406MODULE_VERSION(__stringify(UBI_VERSION));
1407MODULE_DESCRIPTION("UBI - Unsorted Block Images");
1408MODULE_AUTHOR("Artem Bityutskiy");
1409MODULE_LICENSE("GPL");