blob: 5ebe280225d60a69f28bc81c5c4593a47e017365 [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>
Roel Kluin774b1382009-10-16 14:00:17 +020045#include <linux/kernel.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090046#include <linux/slab.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
Marc Kleine-Buddeaf7ad7a2010-05-05 10:17:25 +020052#ifdef CONFIG_MTD_UBI_MODULE
53#define ubi_is_module() 1
54#else
55#define ubi_is_module() 0
56#endif
57
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040058/**
59 * struct mtd_dev_param - MTD device parameter description data structure.
Artem Bityutskiyf9b00802010-01-05 16:48:40 +020060 * @name: MTD character device node path, MTD device name, or MTD device number
61 * string
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040062 * @vid_hdr_offs: VID header offset
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040063 */
Artem Bityutskiy9c9ec142008-07-18 13:19:52 +030064struct mtd_dev_param {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040065 char name[MTD_PARAM_LEN_MAX];
66 int vid_hdr_offs;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040067};
68
69/* Numbers of elements set in the @mtd_dev_param array */
Artem Bityutskiy9e0c7ef2010-01-06 14:20:31 +020070static int __initdata mtd_devs;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040071
72/* MTD devices specification parameters */
Artem Bityutskiy9e0c7ef2010-01-06 14:20:31 +020073static struct mtd_dev_param __initdata mtd_dev_param[UBI_MAX_DEVICES];
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040074
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040075/* Root UBI "class" object (corresponds to '/<sysfs>/class/ubi/') */
76struct class *ubi_class;
77
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +020078/* Slab cache for wear-leveling entries */
79struct kmem_cache *ubi_wl_entry_slab;
80
Artem Bityutskiy9f961b52007-12-16 16:59:31 +020081/* UBI control character device */
82static struct miscdevice ubi_ctrl_cdev = {
83 .minor = MISC_DYNAMIC_MINOR,
84 .name = "ubi_ctrl",
85 .fops = &ubi_ctrl_cdev_operations,
86};
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +020087
Artem Bityutskiye73f4452007-12-17 17:37:26 +020088/* All UBI devices in system */
89static struct ubi_device *ubi_devices[UBI_MAX_DEVICES];
90
Artem Bityutskiycdfa7882007-12-17 20:33:20 +020091/* Serializes UBI devices creations and removals */
92DEFINE_MUTEX(ubi_devices_mutex);
93
Artem Bityutskiye73f4452007-12-17 17:37:26 +020094/* Protects @ubi_devices and @ubi->ref_count */
95static DEFINE_SPINLOCK(ubi_devices_lock);
96
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040097/* "Show" method for files in '/<sysfs>/class/ubi/' */
Artem Bityutskiyc174a082010-09-03 15:11:17 +030098static ssize_t ubi_version_show(struct class *class,
99 struct class_attribute *attr, char *buf)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400100{
101 return sprintf(buf, "%d\n", UBI_VERSION);
102}
103
104/* UBI version attribute ('/<sysfs>/class/ubi/version') */
105static struct class_attribute ubi_version =
106 __ATTR(version, S_IRUGO, ubi_version_show, NULL);
107
108static ssize_t dev_attribute_show(struct device *dev,
109 struct device_attribute *attr, char *buf);
110
111/* UBI device attributes (correspond to files in '/<sysfs>/class/ubi/ubiX') */
112static struct device_attribute dev_eraseblock_size =
113 __ATTR(eraseblock_size, S_IRUGO, dev_attribute_show, NULL);
114static struct device_attribute dev_avail_eraseblocks =
115 __ATTR(avail_eraseblocks, S_IRUGO, dev_attribute_show, NULL);
116static struct device_attribute dev_total_eraseblocks =
117 __ATTR(total_eraseblocks, S_IRUGO, dev_attribute_show, NULL);
118static struct device_attribute dev_volumes_count =
119 __ATTR(volumes_count, S_IRUGO, dev_attribute_show, NULL);
120static struct device_attribute dev_max_ec =
121 __ATTR(max_ec, S_IRUGO, dev_attribute_show, NULL);
122static struct device_attribute dev_reserved_for_bad =
123 __ATTR(reserved_for_bad, S_IRUGO, dev_attribute_show, NULL);
124static struct device_attribute dev_bad_peb_count =
125 __ATTR(bad_peb_count, S_IRUGO, dev_attribute_show, NULL);
126static struct device_attribute dev_max_vol_count =
127 __ATTR(max_vol_count, S_IRUGO, dev_attribute_show, NULL);
128static struct device_attribute dev_min_io_size =
129 __ATTR(min_io_size, S_IRUGO, dev_attribute_show, NULL);
130static struct device_attribute dev_bgt_enabled =
131 __ATTR(bgt_enabled, S_IRUGO, dev_attribute_show, NULL);
Artem Bityutskiyb6b76ba2007-12-26 13:46:46 +0200132static struct device_attribute dev_mtd_num =
133 __ATTR(mtd_num, S_IRUGO, dev_attribute_show, NULL);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400134
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200135/**
Dmitry Pervushin0e0ee1c2009-04-29 19:29:38 +0400136 * ubi_volume_notify - send a volume change notification.
137 * @ubi: UBI device description object
138 * @vol: volume description object of the changed volume
139 * @ntype: notification type to send (%UBI_VOLUME_ADDED, etc)
140 *
141 * This is a helper function which notifies all subscribers about a volume
142 * change event (creation, removal, re-sizing, re-naming, updating). Returns
143 * zero in case of success and a negative error code in case of failure.
144 */
145int ubi_volume_notify(struct ubi_device *ubi, struct ubi_volume *vol, int ntype)
146{
147 struct ubi_notification nt;
148
149 ubi_do_get_device_info(ubi, &nt.di);
150 ubi_do_get_volume_info(ubi, vol, &nt.vi);
151 return blocking_notifier_call_chain(&ubi_notifiers, ntype, &nt);
152}
153
154/**
155 * ubi_notify_all - send a notification to all volumes.
156 * @ubi: UBI device description object
157 * @ntype: notification type to send (%UBI_VOLUME_ADDED, etc)
158 * @nb: the notifier to call
159 *
160 * This function walks all volumes of UBI device @ubi and sends the @ntype
161 * notification for each volume. If @nb is %NULL, then all registered notifiers
162 * are called, otherwise only the @nb notifier is called. Returns the number of
163 * sent notifications.
164 */
165int ubi_notify_all(struct ubi_device *ubi, int ntype, struct notifier_block *nb)
166{
167 struct ubi_notification nt;
168 int i, count = 0;
169
170 ubi_do_get_device_info(ubi, &nt.di);
171
172 mutex_lock(&ubi->device_mutex);
173 for (i = 0; i < ubi->vtbl_slots; i++) {
174 /*
175 * Since the @ubi->device is locked, and we are not going to
176 * change @ubi->volumes, we do not have to lock
177 * @ubi->volumes_lock.
178 */
179 if (!ubi->volumes[i])
180 continue;
181
182 ubi_do_get_volume_info(ubi, ubi->volumes[i], &nt.vi);
183 if (nb)
184 nb->notifier_call(nb, ntype, &nt);
185 else
186 blocking_notifier_call_chain(&ubi_notifiers, ntype,
187 &nt);
188 count += 1;
189 }
190 mutex_unlock(&ubi->device_mutex);
191
192 return count;
193}
194
195/**
196 * ubi_enumerate_volumes - send "add" notification for all existing volumes.
197 * @nb: the notifier to call
198 *
199 * This function walks all UBI devices and volumes and sends the
200 * %UBI_VOLUME_ADDED notification for each volume. If @nb is %NULL, then all
201 * registered notifiers are called, otherwise only the @nb notifier is called.
202 * Returns the number of sent notifications.
203 */
204int ubi_enumerate_volumes(struct notifier_block *nb)
205{
206 int i, count = 0;
207
208 /*
209 * Since the @ubi_devices_mutex is locked, and we are not going to
210 * change @ubi_devices, we do not have to lock @ubi_devices_lock.
211 */
212 for (i = 0; i < UBI_MAX_DEVICES; i++) {
213 struct ubi_device *ubi = ubi_devices[i];
214
215 if (!ubi)
216 continue;
217 count += ubi_notify_all(ubi, UBI_VOLUME_ADDED, nb);
218 }
219
220 return count;
221}
222
223/**
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200224 * ubi_get_device - get UBI device.
225 * @ubi_num: UBI device number
226 *
227 * This function returns UBI device description object for UBI device number
228 * @ubi_num, or %NULL if the device does not exist. This function increases the
229 * device reference count to prevent removal of the device. In other words, the
230 * device cannot be removed if its reference count is not zero.
231 */
232struct ubi_device *ubi_get_device(int ubi_num)
233{
234 struct ubi_device *ubi;
235
236 spin_lock(&ubi_devices_lock);
237 ubi = ubi_devices[ubi_num];
238 if (ubi) {
239 ubi_assert(ubi->ref_count >= 0);
240 ubi->ref_count += 1;
241 get_device(&ubi->dev);
242 }
243 spin_unlock(&ubi_devices_lock);
244
245 return ubi;
246}
247
248/**
249 * ubi_put_device - drop an UBI device reference.
250 * @ubi: UBI device description object
251 */
252void ubi_put_device(struct ubi_device *ubi)
253{
254 spin_lock(&ubi_devices_lock);
255 ubi->ref_count -= 1;
256 put_device(&ubi->dev);
257 spin_unlock(&ubi_devices_lock);
258}
259
260/**
Artem Bityutskiyebaaf1a2008-07-18 13:34:32 +0300261 * ubi_get_by_major - get UBI device by character device major number.
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200262 * @major: major number
263 *
264 * This function is similar to 'ubi_get_device()', but it searches the device
265 * by its major number.
266 */
267struct ubi_device *ubi_get_by_major(int major)
268{
269 int i;
270 struct ubi_device *ubi;
271
272 spin_lock(&ubi_devices_lock);
273 for (i = 0; i < UBI_MAX_DEVICES; i++) {
274 ubi = ubi_devices[i];
275 if (ubi && MAJOR(ubi->cdev.dev) == major) {
276 ubi_assert(ubi->ref_count >= 0);
277 ubi->ref_count += 1;
278 get_device(&ubi->dev);
279 spin_unlock(&ubi_devices_lock);
280 return ubi;
281 }
282 }
283 spin_unlock(&ubi_devices_lock);
284
285 return NULL;
286}
287
288/**
289 * ubi_major2num - get UBI device number by character device major number.
290 * @major: major number
291 *
292 * This function searches UBI device number object by its major number. If UBI
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200293 * device was not found, this function returns -ENODEV, otherwise the UBI device
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200294 * number is returned.
295 */
296int ubi_major2num(int major)
297{
298 int i, ubi_num = -ENODEV;
299
300 spin_lock(&ubi_devices_lock);
301 for (i = 0; i < UBI_MAX_DEVICES; i++) {
302 struct ubi_device *ubi = ubi_devices[i];
303
304 if (ubi && MAJOR(ubi->cdev.dev) == major) {
305 ubi_num = ubi->ubi_num;
306 break;
307 }
308 }
309 spin_unlock(&ubi_devices_lock);
310
311 return ubi_num;
312}
313
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400314/* "Show" method for files in '/<sysfs>/class/ubi/ubiX/' */
315static ssize_t dev_attribute_show(struct device *dev,
316 struct device_attribute *attr, char *buf)
317{
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200318 ssize_t ret;
319 struct ubi_device *ubi;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400320
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200321 /*
322 * The below code looks weird, but it actually makes sense. We get the
323 * UBI device reference from the contained 'struct ubi_device'. But it
324 * is unclear if the device was removed or not yet. Indeed, if the
325 * device was removed before we increased its reference count,
326 * 'ubi_get_device()' will return -ENODEV and we fail.
327 *
328 * Remember, 'struct ubi_device' is freed in the release function, so
329 * we still can use 'ubi->ubi_num'.
330 */
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400331 ubi = container_of(dev, struct ubi_device, dev);
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200332 ubi = ubi_get_device(ubi->ubi_num);
333 if (!ubi)
334 return -ENODEV;
335
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400336 if (attr == &dev_eraseblock_size)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200337 ret = sprintf(buf, "%d\n", ubi->leb_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400338 else if (attr == &dev_avail_eraseblocks)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200339 ret = sprintf(buf, "%d\n", ubi->avail_pebs);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400340 else if (attr == &dev_total_eraseblocks)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200341 ret = sprintf(buf, "%d\n", ubi->good_peb_count);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400342 else if (attr == &dev_volumes_count)
Artem Bityutskiy4b3cc342007-12-26 15:59:39 +0200343 ret = sprintf(buf, "%d\n", ubi->vol_count - UBI_INT_VOL_COUNT);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400344 else if (attr == &dev_max_ec)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200345 ret = sprintf(buf, "%d\n", ubi->max_ec);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400346 else if (attr == &dev_reserved_for_bad)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200347 ret = sprintf(buf, "%d\n", ubi->beb_rsvd_pebs);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400348 else if (attr == &dev_bad_peb_count)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200349 ret = sprintf(buf, "%d\n", ubi->bad_peb_count);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400350 else if (attr == &dev_max_vol_count)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200351 ret = sprintf(buf, "%d\n", ubi->vtbl_slots);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400352 else if (attr == &dev_min_io_size)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200353 ret = sprintf(buf, "%d\n", ubi->min_io_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400354 else if (attr == &dev_bgt_enabled)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200355 ret = sprintf(buf, "%d\n", ubi->thread_enabled);
Artem Bityutskiyb6b76ba2007-12-26 13:46:46 +0200356 else if (attr == &dev_mtd_num)
357 ret = sprintf(buf, "%d\n", ubi->mtd->index);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400358 else
Artem Bityutskiyb6b76ba2007-12-26 13:46:46 +0200359 ret = -EINVAL;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400360
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200361 ubi_put_device(ubi);
362 return ret;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400363}
364
Artem Bityutskiy36b477d2009-01-20 18:04:09 +0200365static void dev_release(struct device *dev)
366{
367 struct ubi_device *ubi = container_of(dev, struct ubi_device, dev);
368
369 kfree(ubi);
370}
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400371
372/**
373 * ubi_sysfs_init - initialize sysfs for an UBI device.
374 * @ubi: UBI device description object
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200375 * @ref: set to %1 on exit in case of failure if a reference to @ubi->dev was
376 * taken
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400377 *
378 * This function returns zero in case of success and a negative error code in
379 * case of failure.
380 */
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200381static int ubi_sysfs_init(struct ubi_device *ubi, int *ref)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400382{
383 int err;
384
385 ubi->dev.release = dev_release;
Artem Bityutskiy49dfc292007-12-15 18:13:56 +0200386 ubi->dev.devt = ubi->cdev.dev;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400387 ubi->dev.class = ubi_class;
Kay Sievers160bbab2008-12-23 10:00:14 +0000388 dev_set_name(&ubi->dev, UBI_NAME_STR"%d", ubi->ubi_num);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400389 err = device_register(&ubi->dev);
390 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200391 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400392
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200393 *ref = 1;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400394 err = device_create_file(&ubi->dev, &dev_eraseblock_size);
395 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200396 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400397 err = device_create_file(&ubi->dev, &dev_avail_eraseblocks);
398 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200399 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400400 err = device_create_file(&ubi->dev, &dev_total_eraseblocks);
401 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200402 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400403 err = device_create_file(&ubi->dev, &dev_volumes_count);
404 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200405 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400406 err = device_create_file(&ubi->dev, &dev_max_ec);
407 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200408 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400409 err = device_create_file(&ubi->dev, &dev_reserved_for_bad);
410 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200411 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400412 err = device_create_file(&ubi->dev, &dev_bad_peb_count);
413 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200414 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400415 err = device_create_file(&ubi->dev, &dev_max_vol_count);
416 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200417 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400418 err = device_create_file(&ubi->dev, &dev_min_io_size);
419 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200420 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400421 err = device_create_file(&ubi->dev, &dev_bgt_enabled);
Artem Bityutskiyb6b76ba2007-12-26 13:46:46 +0200422 if (err)
423 return err;
424 err = device_create_file(&ubi->dev, &dev_mtd_num);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400425 return err;
426}
427
428/**
429 * ubi_sysfs_close - close sysfs for an UBI device.
430 * @ubi: UBI device description object
431 */
432static void ubi_sysfs_close(struct ubi_device *ubi)
433{
Artem Bityutskiyb6b76ba2007-12-26 13:46:46 +0200434 device_remove_file(&ubi->dev, &dev_mtd_num);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400435 device_remove_file(&ubi->dev, &dev_bgt_enabled);
436 device_remove_file(&ubi->dev, &dev_min_io_size);
437 device_remove_file(&ubi->dev, &dev_max_vol_count);
438 device_remove_file(&ubi->dev, &dev_bad_peb_count);
439 device_remove_file(&ubi->dev, &dev_reserved_for_bad);
440 device_remove_file(&ubi->dev, &dev_max_ec);
441 device_remove_file(&ubi->dev, &dev_volumes_count);
442 device_remove_file(&ubi->dev, &dev_total_eraseblocks);
443 device_remove_file(&ubi->dev, &dev_avail_eraseblocks);
444 device_remove_file(&ubi->dev, &dev_eraseblock_size);
445 device_unregister(&ubi->dev);
446}
447
448/**
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200449 * kill_volumes - destroy all user volumes.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400450 * @ubi: UBI device description object
451 */
452static void kill_volumes(struct ubi_device *ubi)
453{
454 int i;
455
456 for (i = 0; i < ubi->vtbl_slots; i++)
457 if (ubi->volumes[i])
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200458 ubi_free_volume(ubi, ubi->volumes[i]);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400459}
460
461/**
462 * uif_init - initialize user interfaces for an UBI device.
463 * @ubi: UBI device description object
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200464 * @ref: set to %1 on exit in case of failure if a reference to @ubi->dev was
465 * taken, otherwise set to %0
466 *
467 * This function initializes various user interfaces for an UBI device. If the
468 * initialization fails at an early stage, this function frees all the
469 * resources it allocated, returns an error, and @ref is set to %0. However,
470 * if the initialization fails after the UBI device was registered in the
471 * driver core subsystem, this function takes a reference to @ubi->dev, because
472 * otherwise the release function ('dev_release()') would free whole @ubi
473 * object. The @ref argument is set to %1 in this case. The caller has to put
474 * this reference.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400475 *
476 * This function returns zero in case of success and a negative error code in
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200477 * case of failure.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400478 */
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200479static int uif_init(struct ubi_device *ubi, int *ref)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400480{
Artem Bityutskiy8c4c19f2009-01-20 17:48:02 +0200481 int i, err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400482 dev_t dev;
483
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200484 *ref = 0;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400485 sprintf(ubi->ubi_name, UBI_NAME_STR "%d", ubi->ubi_num);
486
487 /*
488 * Major numbers for the UBI character devices are allocated
489 * dynamically. Major numbers of volume character devices are
490 * equivalent to ones of the corresponding UBI character device. Minor
491 * numbers of UBI character devices are 0, while minor numbers of
492 * volume character devices start from 1. Thus, we allocate one major
493 * number and ubi->vtbl_slots + 1 minor numbers.
494 */
495 err = alloc_chrdev_region(&dev, 0, ubi->vtbl_slots + 1, ubi->ubi_name);
496 if (err) {
497 ubi_err("cannot register UBI character devices");
498 return err;
499 }
500
Artem Bityutskiy49dfc292007-12-15 18:13:56 +0200501 ubi_assert(MINOR(dev) == 0);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400502 cdev_init(&ubi->cdev, &ubi_cdev_operations);
Artem Bityutskiyc8566352008-07-16 17:40:22 +0300503 dbg_gen("%s major is %u", ubi->ubi_name, MAJOR(dev));
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400504 ubi->cdev.owner = THIS_MODULE;
505
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400506 err = cdev_add(&ubi->cdev, dev, 1);
507 if (err) {
Artem Bityutskiy01f7b302007-12-15 19:56:51 +0200508 ubi_err("cannot add character device");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400509 goto out_unreg;
510 }
511
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200512 err = ubi_sysfs_init(ubi, ref);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400513 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200514 goto out_sysfs;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400515
516 for (i = 0; i < ubi->vtbl_slots; i++)
517 if (ubi->volumes[i]) {
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200518 err = ubi_add_volume(ubi, ubi->volumes[i]);
Artem Bityutskiy01f7b302007-12-15 19:56:51 +0200519 if (err) {
520 ubi_err("cannot add volume %d", i);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400521 goto out_volumes;
Artem Bityutskiy01f7b302007-12-15 19:56:51 +0200522 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400523 }
524
525 return 0;
526
527out_volumes:
528 kill_volumes(ubi);
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200529out_sysfs:
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200530 if (*ref)
531 get_device(&ubi->dev);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400532 ubi_sysfs_close(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400533 cdev_del(&ubi->cdev);
534out_unreg:
Artem Bityutskiy49dfc292007-12-15 18:13:56 +0200535 unregister_chrdev_region(ubi->cdev.dev, ubi->vtbl_slots + 1);
Artem Bityutskiy01f7b302007-12-15 19:56:51 +0200536 ubi_err("cannot initialize UBI %s, error %d", ubi->ubi_name, err);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400537 return err;
538}
539
540/**
541 * uif_close - close user interfaces for an UBI device.
542 * @ubi: UBI device description object
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300543 *
544 * Note, since this function un-registers UBI volume device objects (@vol->dev),
545 * the memory allocated voe the volumes is freed as well (in the release
546 * function).
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400547 */
548static void uif_close(struct ubi_device *ubi)
549{
550 kill_volumes(ubi);
551 ubi_sysfs_close(ubi);
552 cdev_del(&ubi->cdev);
Artem Bityutskiy49dfc292007-12-15 18:13:56 +0200553 unregister_chrdev_region(ubi->cdev.dev, ubi->vtbl_slots + 1);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400554}
555
556/**
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300557 * free_internal_volumes - free internal volumes.
558 * @ubi: UBI device description object
559 */
560static void free_internal_volumes(struct ubi_device *ubi)
561{
562 int i;
563
564 for (i = ubi->vtbl_slots;
565 i < ubi->vtbl_slots + UBI_INT_VOL_COUNT; i++) {
566 kfree(ubi->volumes[i]->eba_tbl);
567 kfree(ubi->volumes[i]);
568 }
569}
570
571/**
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400572 * attach_by_scanning - attach an MTD device using scanning method.
573 * @ubi: UBI device descriptor
574 *
575 * This function returns zero in case of success and a negative error code in
576 * case of failure.
577 *
578 * Note, currently this is the only method to attach UBI devices. Hopefully in
579 * the future we'll have more scalable attaching methods and avoid full media
580 * scanning. But even in this case scanning will be needed as a fall-back
581 * attaching method if there are some on-flash table corruptions.
582 */
583static int attach_by_scanning(struct ubi_device *ubi)
584{
585 int err;
586 struct ubi_scan_info *si;
587
588 si = ubi_scan(ubi);
589 if (IS_ERR(si))
590 return PTR_ERR(si);
591
592 ubi->bad_peb_count = si->bad_peb_count;
593 ubi->good_peb_count = ubi->peb_count - ubi->bad_peb_count;
Artem Bityutskiy5fc01ab2010-09-03 23:08:15 +0300594 ubi->corr_peb_count = si->corr_peb_count;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400595 ubi->max_ec = si->max_ec;
596 ubi->mean_ec = si->mean_ec;
Artem Bityutskiy64d4b4c2010-07-30 14:59:50 +0300597 ubi_msg("max. sequence number: %llu", si->max_sqnum);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400598
599 err = ubi_read_volume_table(ubi, si);
600 if (err)
601 goto out_si;
602
603 err = ubi_wl_init_scan(ubi, si);
604 if (err)
605 goto out_vtbl;
606
607 err = ubi_eba_init_scan(ubi, si);
608 if (err)
609 goto out_wl;
610
611 ubi_scan_destroy_si(si);
612 return 0;
613
614out_wl:
615 ubi_wl_close(ubi);
616out_vtbl:
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300617 free_internal_volumes(ubi);
Vinit Agnihotrid7f0c4d2007-06-15 15:31:22 +0530618 vfree(ubi->vtbl);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400619out_si:
620 ubi_scan_destroy_si(si);
621 return err;
622}
623
624/**
Artem Bityutskiy85c6e6e2008-07-16 10:25:56 +0300625 * io_init - initialize I/O sub-system for a given UBI device.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400626 * @ubi: UBI device description object
627 *
628 * If @ubi->vid_hdr_offset or @ubi->leb_start is zero, default offsets are
629 * assumed:
630 * o EC header is always at offset zero - this cannot be changed;
631 * o VID header starts just after the EC header at the closest address
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200632 * aligned to @io->hdrs_min_io_size;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400633 * o data starts just after the VID header at the closest address aligned to
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200634 * @io->min_io_size
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400635 *
636 * This function returns zero in case of success and a negative error code in
637 * case of failure.
638 */
639static int io_init(struct ubi_device *ubi)
640{
641 if (ubi->mtd->numeraseregions != 0) {
642 /*
643 * Some flashes have several erase regions. Different regions
644 * may have different eraseblock size and other
645 * characteristics. It looks like mostly multi-region flashes
646 * have one "main" region and one or more small regions to
647 * store boot loader code or boot parameters or whatever. I
648 * guess we should just pick the largest region. But this is
649 * not implemented.
650 */
651 ubi_err("multiple regions, not implemented");
652 return -EINVAL;
653 }
654
Artem Bityutskiydd38fcc2007-12-19 21:43:32 +0200655 if (ubi->vid_hdr_offset < 0)
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200656 return -EINVAL;
657
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400658 /*
659 * Note, in this implementation we support MTD devices with 0x7FFFFFFF
660 * physical eraseblocks maximum.
661 */
662
663 ubi->peb_size = ubi->mtd->erasesize;
Adrian Hunter69423d92008-12-10 13:37:21 +0000664 ubi->peb_count = mtd_div_by_eb(ubi->mtd->size, ubi->mtd);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400665 ubi->flash_size = ubi->mtd->size;
666
667 if (ubi->mtd->block_isbad && ubi->mtd->block_markbad)
668 ubi->bad_allowed = 1;
669
Artem Bityutskiyebf53f42009-07-06 08:57:53 +0300670 if (ubi->mtd->type == MTD_NORFLASH) {
671 ubi_assert(ubi->mtd->writesize == 1);
672 ubi->nor_flash = 1;
673 }
674
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400675 ubi->min_io_size = ubi->mtd->writesize;
676 ubi->hdrs_min_io_size = ubi->mtd->writesize >> ubi->mtd->subpage_sft;
677
Kyungmin Parkcadb40c2008-05-22 10:32:18 +0900678 /*
679 * Make sure minimal I/O unit is power of 2. Note, there is no
680 * fundamental reason for this assumption. It is just an optimization
681 * which allows us to avoid costly division operations.
682 */
Vignesh Babu7753f162007-06-12 10:31:05 +0530683 if (!is_power_of_2(ubi->min_io_size)) {
Artem Bityutskiy01f7b302007-12-15 19:56:51 +0200684 ubi_err("min. I/O unit (%d) is not power of 2",
685 ubi->min_io_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400686 return -EINVAL;
687 }
688
689 ubi_assert(ubi->hdrs_min_io_size > 0);
690 ubi_assert(ubi->hdrs_min_io_size <= ubi->min_io_size);
691 ubi_assert(ubi->min_io_size % ubi->hdrs_min_io_size == 0);
692
693 /* Calculate default aligned sizes of EC and VID headers */
694 ubi->ec_hdr_alsize = ALIGN(UBI_EC_HDR_SIZE, ubi->hdrs_min_io_size);
695 ubi->vid_hdr_alsize = ALIGN(UBI_VID_HDR_SIZE, ubi->hdrs_min_io_size);
696
697 dbg_msg("min_io_size %d", ubi->min_io_size);
698 dbg_msg("hdrs_min_io_size %d", ubi->hdrs_min_io_size);
699 dbg_msg("ec_hdr_alsize %d", ubi->ec_hdr_alsize);
700 dbg_msg("vid_hdr_alsize %d", ubi->vid_hdr_alsize);
701
702 if (ubi->vid_hdr_offset == 0)
703 /* Default offset */
704 ubi->vid_hdr_offset = ubi->vid_hdr_aloffset =
705 ubi->ec_hdr_alsize;
706 else {
707 ubi->vid_hdr_aloffset = ubi->vid_hdr_offset &
708 ~(ubi->hdrs_min_io_size - 1);
709 ubi->vid_hdr_shift = ubi->vid_hdr_offset -
710 ubi->vid_hdr_aloffset;
711 }
712
713 /* Similar for the data offset */
Artem Bityutskiyd5360582008-01-17 15:41:14 +0200714 ubi->leb_start = ubi->vid_hdr_offset + UBI_EC_HDR_SIZE;
Artem Bityutskiydd38fcc2007-12-19 21:43:32 +0200715 ubi->leb_start = ALIGN(ubi->leb_start, ubi->min_io_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400716
717 dbg_msg("vid_hdr_offset %d", ubi->vid_hdr_offset);
718 dbg_msg("vid_hdr_aloffset %d", ubi->vid_hdr_aloffset);
719 dbg_msg("vid_hdr_shift %d", ubi->vid_hdr_shift);
720 dbg_msg("leb_start %d", ubi->leb_start);
721
722 /* The shift must be aligned to 32-bit boundary */
723 if (ubi->vid_hdr_shift % 4) {
724 ubi_err("unaligned VID header shift %d",
725 ubi->vid_hdr_shift);
726 return -EINVAL;
727 }
728
729 /* Check sanity */
730 if (ubi->vid_hdr_offset < UBI_EC_HDR_SIZE ||
731 ubi->leb_start < ubi->vid_hdr_offset + UBI_VID_HDR_SIZE ||
732 ubi->leb_start > ubi->peb_size - UBI_VID_HDR_SIZE ||
Kyungmin Parkcadb40c2008-05-22 10:32:18 +0900733 ubi->leb_start & (ubi->min_io_size - 1)) {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400734 ubi_err("bad VID header (%d) or data offsets (%d)",
735 ubi->vid_hdr_offset, ubi->leb_start);
736 return -EINVAL;
737 }
738
739 /*
Artem Bityutskiyb86a2c52009-05-24 14:13:34 +0300740 * Set maximum amount of physical erroneous eraseblocks to be 10%.
741 * Erroneous PEB are those which have read errors.
742 */
743 ubi->max_erroneous = ubi->peb_count / 10;
744 if (ubi->max_erroneous < 16)
745 ubi->max_erroneous = 16;
746 dbg_msg("max_erroneous %d", ubi->max_erroneous);
747
748 /*
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400749 * It may happen that EC and VID headers are situated in one minimal
750 * I/O unit. In this case we can only accept this UBI image in
751 * read-only mode.
752 */
753 if (ubi->vid_hdr_offset + UBI_VID_HDR_SIZE <= ubi->hdrs_min_io_size) {
754 ubi_warn("EC and VID headers are in the same minimal I/O unit, "
755 "switch to read-only mode");
756 ubi->ro_mode = 1;
757 }
758
759 ubi->leb_size = ubi->peb_size - ubi->leb_start;
760
761 if (!(ubi->mtd->flags & MTD_WRITEABLE)) {
762 ubi_msg("MTD device %d is write-protected, attach in "
763 "read-only mode", ubi->mtd->index);
764 ubi->ro_mode = 1;
765 }
766
Artem Bityutskiy434b8252008-04-20 18:00:33 +0300767 ubi_msg("physical eraseblock size: %d bytes (%d KiB)",
768 ubi->peb_size, ubi->peb_size >> 10);
769 ubi_msg("logical eraseblock size: %d bytes", ubi->leb_size);
770 ubi_msg("smallest flash I/O unit: %d", ubi->min_io_size);
771 if (ubi->hdrs_min_io_size != ubi->min_io_size)
772 ubi_msg("sub-page size: %d",
773 ubi->hdrs_min_io_size);
774 ubi_msg("VID header offset: %d (aligned %d)",
775 ubi->vid_hdr_offset, ubi->vid_hdr_aloffset);
776 ubi_msg("data offset: %d", ubi->leb_start);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400777
778 /*
779 * Note, ideally, we have to initialize ubi->bad_peb_count here. But
780 * unfortunately, MTD does not provide this information. We should loop
781 * over all physical eraseblocks and invoke mtd->block_is_bad() for
782 * each physical eraseblock. So, we skip ubi->bad_peb_count
783 * uninitialized and initialize it after scanning.
784 */
785
786 return 0;
787}
788
789/**
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200790 * autoresize - re-size the volume which has the "auto-resize" flag set.
791 * @ubi: UBI device description object
792 * @vol_id: ID of the volume to re-size
793 *
794 * This function re-sizes the volume marked by the @UBI_VTBL_AUTORESIZE_FLG in
795 * the volume table to the largest possible size. See comments in ubi-header.h
796 * for more description of the flag. Returns zero in case of success and a
797 * negative error code in case of failure.
798 */
799static int autoresize(struct ubi_device *ubi, int vol_id)
800{
801 struct ubi_volume_desc desc;
802 struct ubi_volume *vol = ubi->volumes[vol_id];
803 int err, old_reserved_pebs = vol->reserved_pebs;
804
805 /*
806 * Clear the auto-resize flag in the volume in-memory copy of the
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300807 * volume table, and 'ubi_resize_volume()' will propagate this change
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200808 * to the flash.
809 */
810 ubi->vtbl[vol_id].flags &= ~UBI_VTBL_AUTORESIZE_FLG;
811
812 if (ubi->avail_pebs == 0) {
813 struct ubi_vtbl_record vtbl_rec;
814
815 /*
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300816 * No available PEBs to re-size the volume, clear the flag on
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200817 * flash and exit.
818 */
819 memcpy(&vtbl_rec, &ubi->vtbl[vol_id],
820 sizeof(struct ubi_vtbl_record));
821 err = ubi_change_vtbl_record(ubi, vol_id, &vtbl_rec);
822 if (err)
823 ubi_err("cannot clean auto-resize flag for volume %d",
824 vol_id);
825 } else {
826 desc.vol = vol;
827 err = ubi_resize_volume(&desc,
828 old_reserved_pebs + ubi->avail_pebs);
829 if (err)
830 ubi_err("cannot auto-resize volume %d", vol_id);
831 }
832
833 if (err)
834 return err;
835
836 ubi_msg("volume %d (\"%s\") re-sized from %d to %d LEBs", vol_id,
837 vol->name, old_reserved_pebs, vol->reserved_pebs);
838 return 0;
839}
840
841/**
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200842 * ubi_attach_mtd_dev - attach an MTD device.
Artem Bityutskiyebaaf1a2008-07-18 13:34:32 +0300843 * @mtd: MTD device description object
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200844 * @ubi_num: number to assign to the new UBI device
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400845 * @vid_hdr_offset: VID header offset
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400846 *
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200847 * This function attaches MTD device @mtd_dev to UBI and assign @ubi_num number
848 * to the newly created UBI device, unless @ubi_num is %UBI_DEV_NUM_AUTO, in
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300849 * which case this function finds a vacant device number and assigns it
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200850 * automatically. Returns the new UBI device number in case of success and a
851 * negative error code in case of failure.
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200852 *
853 * Note, the invocations of this function has to be serialized by the
854 * @ubi_devices_mutex.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400855 */
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200856int ubi_attach_mtd_dev(struct mtd_info *mtd, int ubi_num, int vid_hdr_offset)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400857{
858 struct ubi_device *ubi;
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200859 int i, err, ref = 0;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400860
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200861 /*
862 * Check if we already have the same MTD device attached.
863 *
864 * Note, this function assumes that UBI devices creations and deletions
865 * are serialized, so it does not take the &ubi_devices_lock.
866 */
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200867 for (i = 0; i < UBI_MAX_DEVICES; i++) {
Artem Bityutskiyb96bf4c2007-12-16 13:01:03 +0200868 ubi = ubi_devices[i];
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200869 if (ubi && mtd->index == ubi->mtd->index) {
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200870 dbg_err("mtd%d is already attached to ubi%d",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400871 mtd->index, i);
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200872 return -EEXIST;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400873 }
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200874 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400875
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200876 /*
877 * Make sure this MTD device is not emulated on top of an UBI volume
878 * already. Well, generally this recursion works fine, but there are
879 * different problems like the UBI module takes a reference to itself
880 * by attaching (and thus, opening) the emulated MTD device. This
881 * results in inability to unload the module. And in general it makes
882 * no sense to attach emulated MTD devices, so we prohibit this.
883 */
884 if (mtd->type == MTD_UBIVOLUME) {
885 ubi_err("refuse attaching mtd%d - it is already emulated on "
886 "top of UBI", mtd->index);
887 return -EINVAL;
888 }
Artem Bityutskiyb96bf4c2007-12-16 13:01:03 +0200889
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200890 if (ubi_num == UBI_DEV_NUM_AUTO) {
891 /* Search for an empty slot in the @ubi_devices array */
892 for (ubi_num = 0; ubi_num < UBI_MAX_DEVICES; ubi_num++)
893 if (!ubi_devices[ubi_num])
894 break;
895 if (ubi_num == UBI_MAX_DEVICES) {
Artem Bityutskiy9c9ec142008-07-18 13:19:52 +0300896 dbg_err("only %d UBI devices may be created",
897 UBI_MAX_DEVICES);
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200898 return -ENFILE;
899 }
900 } else {
901 if (ubi_num >= UBI_MAX_DEVICES)
902 return -EINVAL;
903
904 /* Make sure ubi_num is not busy */
905 if (ubi_devices[ubi_num]) {
906 dbg_err("ubi%d already exists", ubi_num);
907 return -EEXIST;
908 }
Artem Bityutskiyb96bf4c2007-12-16 13:01:03 +0200909 }
910
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200911 ubi = kzalloc(sizeof(struct ubi_device), GFP_KERNEL);
912 if (!ubi)
913 return -ENOMEM;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400914
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200915 ubi->mtd = mtd;
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200916 ubi->ubi_num = ubi_num;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400917 ubi->vid_hdr_offset = vid_hdr_offset;
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200918 ubi->autoresize_vol_id = -1;
919
920 mutex_init(&ubi->buf_mutex);
921 mutex_init(&ubi->ckvol_mutex);
Artem Bityutskiyf089c0b2009-05-07 11:46:49 +0300922 mutex_init(&ubi->device_mutex);
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200923 spin_lock_init(&ubi->volumes_lock);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200924
Artem Bityutskiy697fa972008-04-23 13:43:21 +0300925 ubi_msg("attaching mtd%d to ubi%d", mtd->index, ubi_num);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200926
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400927 err = io_init(ubi);
928 if (err)
929 goto out_free;
930
Stefan Roesead5942b2008-12-10 10:42:54 +0100931 err = -ENOMEM;
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300932 ubi->peb_buf1 = vmalloc(ubi->peb_size);
933 if (!ubi->peb_buf1)
934 goto out_free;
935
936 ubi->peb_buf2 = vmalloc(ubi->peb_size);
937 if (!ubi->peb_buf2)
Stefan Roesead5942b2008-12-10 10:42:54 +0100938 goto out_free;
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300939
Artem Bityutskiy2cb81e22009-05-12 15:10:03 +0300940#ifdef CONFIG_MTD_UBI_DEBUG_PARANOID
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300941 mutex_init(&ubi->dbg_buf_mutex);
942 ubi->dbg_peb_buf = vmalloc(ubi->peb_size);
943 if (!ubi->dbg_peb_buf)
Stefan Roesead5942b2008-12-10 10:42:54 +0100944 goto out_free;
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300945#endif
946
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400947 err = attach_by_scanning(ubi);
948 if (err) {
949 dbg_err("failed to attach by scanning, error %d", err);
950 goto out_free;
951 }
952
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200953 if (ubi->autoresize_vol_id != -1) {
954 err = autoresize(ubi, ubi->autoresize_vol_id);
955 if (err)
956 goto out_detach;
957 }
958
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200959 err = uif_init(ubi, &ref);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400960 if (err)
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200961 goto out_detach;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400962
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200963 ubi->bgt_thread = kthread_create(ubi_thread, ubi, ubi->bgt_name);
964 if (IS_ERR(ubi->bgt_thread)) {
965 err = PTR_ERR(ubi->bgt_thread);
966 ubi_err("cannot spawn \"%s\", error %d", ubi->bgt_name,
967 err);
968 goto out_uif;
969 }
970
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200971 ubi_msg("attached mtd%d to ubi%d", mtd->index, ubi_num);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200972 ubi_msg("MTD device name: \"%s\"", mtd->name);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400973 ubi_msg("MTD device size: %llu MiB", ubi->flash_size >> 20);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400974 ubi_msg("number of good PEBs: %d", ubi->good_peb_count);
975 ubi_msg("number of bad PEBs: %d", ubi->bad_peb_count);
Artem Bityutskiy5fc01ab2010-09-03 23:08:15 +0300976 ubi_msg("number of corrupted PEBs: %d", ubi->corr_peb_count);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400977 ubi_msg("max. allowed volumes: %d", ubi->vtbl_slots);
978 ubi_msg("wear-leveling threshold: %d", CONFIG_MTD_UBI_WL_THRESHOLD);
979 ubi_msg("number of internal volumes: %d", UBI_INT_VOL_COUNT);
980 ubi_msg("number of user volumes: %d",
981 ubi->vol_count - UBI_INT_VOL_COUNT);
982 ubi_msg("available PEBs: %d", ubi->avail_pebs);
983 ubi_msg("total number of reserved PEBs: %d", ubi->rsvd_pebs);
984 ubi_msg("number of PEBs reserved for bad PEB handling: %d",
985 ubi->beb_rsvd_pebs);
986 ubi_msg("max/mean erase counter: %d/%d", ubi->max_ec, ubi->mean_ec);
Artem Bityutskiy64d4b4c2010-07-30 14:59:50 +0300987 ubi_msg("image sequence number: %d", ubi->image_seq);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400988
Artem Bityutskiyddbd3b62009-05-23 13:44:09 +0300989 /*
990 * The below lock makes sure we do not race with 'ubi_thread()' which
991 * checks @ubi->thread_enabled. Otherwise we may fail to wake it up.
992 */
993 spin_lock(&ubi->wl_lock);
Artem Bityutskiyd37e6bf2008-07-24 18:28:11 +0300994 if (!DBG_DISABLE_BGT)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400995 ubi->thread_enabled = 1;
Artem Bityutskiyd37e6bf2008-07-24 18:28:11 +0300996 wake_up_process(ubi->bgt_thread);
Artem Bityutskiyddbd3b62009-05-23 13:44:09 +0300997 spin_unlock(&ubi->wl_lock);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400998
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200999 ubi_devices[ubi_num] = ubi;
Dmitry Pervushin0e0ee1c2009-04-29 19:29:38 +04001000 ubi_notify_all(ubi, UBI_VOLUME_ADDED, NULL);
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001001 return ubi_num;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001002
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001003out_uif:
1004 uif_close(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001005out_detach:
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001006 ubi_wl_close(ubi);
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +03001007 free_internal_volumes(ubi);
Vinit Agnihotrid7f0c4d2007-06-15 15:31:22 +05301008 vfree(ubi->vtbl);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001009out_free:
Artem Bityutskiye88d6e102007-08-29 14:51:52 +03001010 vfree(ubi->peb_buf1);
1011 vfree(ubi->peb_buf2);
Artem Bityutskiy2cb81e22009-05-12 15:10:03 +03001012#ifdef CONFIG_MTD_UBI_DEBUG_PARANOID
Artem Bityutskiye88d6e102007-08-29 14:51:52 +03001013 vfree(ubi->dbg_peb_buf);
1014#endif
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +02001015 if (ref)
1016 put_device(&ubi->dev);
1017 else
1018 kfree(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001019 return err;
1020}
1021
1022/**
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001023 * ubi_detach_mtd_dev - detach an MTD device.
1024 * @ubi_num: UBI device number to detach from
1025 * @anyway: detach MTD even if device reference count is not zero
1026 *
1027 * This function destroys an UBI device number @ubi_num and detaches the
1028 * underlying MTD device. Returns zero in case of success and %-EBUSY if the
1029 * UBI device is busy and cannot be destroyed, and %-EINVAL if it does not
1030 * exist.
1031 *
1032 * Note, the invocations of this function has to be serialized by the
1033 * @ubi_devices_mutex.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001034 */
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001035int ubi_detach_mtd_dev(int ubi_num, int anyway)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001036{
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001037 struct ubi_device *ubi;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001038
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001039 if (ubi_num < 0 || ubi_num >= UBI_MAX_DEVICES)
1040 return -EINVAL;
1041
Dmitry Pervushin0e0ee1c2009-04-29 19:29:38 +04001042 ubi = ubi_get_device(ubi_num);
1043 if (!ubi)
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001044 return -EINVAL;
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001045
Dmitry Pervushin0e0ee1c2009-04-29 19:29:38 +04001046 spin_lock(&ubi_devices_lock);
1047 put_device(&ubi->dev);
1048 ubi->ref_count -= 1;
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001049 if (ubi->ref_count) {
1050 if (!anyway) {
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001051 spin_unlock(&ubi_devices_lock);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001052 return -EBUSY;
1053 }
1054 /* This may only happen if there is a bug */
1055 ubi_err("%s reference count %d, destroy anyway",
1056 ubi->ubi_name, ubi->ref_count);
1057 }
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001058 ubi_devices[ubi_num] = NULL;
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001059 spin_unlock(&ubi_devices_lock);
1060
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001061 ubi_assert(ubi_num == ubi->ubi_num);
Dmitry Pervushin0e0ee1c2009-04-29 19:29:38 +04001062 ubi_notify_all(ubi, UBI_VOLUME_REMOVED, NULL);
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001063 dbg_msg("detaching mtd%d from ubi%d", ubi->mtd->index, ubi_num);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001064
1065 /*
1066 * Before freeing anything, we have to stop the background thread to
1067 * prevent it from doing anything on this device while we are freeing.
1068 */
1069 if (ubi->bgt_thread)
1070 kthread_stop(ubi->bgt_thread);
1071
Artem Bityutskiy36b477d2009-01-20 18:04:09 +02001072 /*
1073 * Get a reference to the device in order to prevent 'dev_release()'
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +02001074 * from freeing the @ubi object.
Artem Bityutskiy36b477d2009-01-20 18:04:09 +02001075 */
1076 get_device(&ubi->dev);
1077
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001078 uif_close(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001079 ubi_wl_close(ubi);
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +03001080 free_internal_volumes(ubi);
Artem Bityutskiy92ad8f32007-05-06 16:12:54 +03001081 vfree(ubi->vtbl);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001082 put_mtd_device(ubi->mtd);
Artem Bityutskiye88d6e102007-08-29 14:51:52 +03001083 vfree(ubi->peb_buf1);
1084 vfree(ubi->peb_buf2);
Artem Bityutskiy2cb81e22009-05-12 15:10:03 +03001085#ifdef CONFIG_MTD_UBI_DEBUG_PARANOID
Artem Bityutskiye88d6e102007-08-29 14:51:52 +03001086 vfree(ubi->dbg_peb_buf);
1087#endif
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001088 ubi_msg("mtd%d is detached from ubi%d", ubi->mtd->index, ubi->ubi_num);
Artem Bityutskiy36b477d2009-01-20 18:04:09 +02001089 put_device(&ubi->dev);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001090 return 0;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001091}
1092
Artem Bityutskiy3a8d4642007-12-16 12:32:51 +02001093/**
Artem Bityutskiyf9b00802010-01-05 16:48:40 +02001094 * open_mtd_by_chdev - open an MTD device by its character device node path.
1095 * @mtd_dev: MTD character device node path
1096 *
1097 * This helper function opens an MTD device by its character node device path.
1098 * Returns MTD device description object in case of success and a negative
1099 * error code in case of failure.
1100 */
1101static struct mtd_info * __init open_mtd_by_chdev(const char *mtd_dev)
1102{
1103 int err, major, minor, mode;
1104 struct path path;
1105
1106 /* Probably this is an MTD character device node path */
1107 err = kern_path(mtd_dev, LOOKUP_FOLLOW, &path);
1108 if (err)
1109 return ERR_PTR(err);
1110
1111 /* MTD device number is defined by the major / minor numbers */
1112 major = imajor(path.dentry->d_inode);
1113 minor = iminor(path.dentry->d_inode);
1114 mode = path.dentry->d_inode->i_mode;
1115 path_put(&path);
1116 if (major != MTD_CHAR_MAJOR || !S_ISCHR(mode))
1117 return ERR_PTR(-EINVAL);
1118
1119 if (minor & 1)
1120 /*
1121 * Just do not think the "/dev/mtdrX" devices support is need,
1122 * so do not support them to avoid doing extra work.
1123 */
1124 return ERR_PTR(-EINVAL);
1125
1126 return get_mtd_device(NULL, minor / 2);
1127}
1128
1129/**
1130 * open_mtd_device - open MTD device by name, character device path, or number.
1131 * @mtd_dev: name, character device node path, or MTD device device number
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001132 *
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001133 * This function tries to open and MTD device described by @mtd_dev string,
Artem Bityutskiyf9b00802010-01-05 16:48:40 +02001134 * which is first treated as ASCII MTD device number, and if it is not true, it
1135 * is treated as MTD device name, and if that is also not true, it is treated
1136 * as MTD character device node path. Returns MTD device description object in
1137 * case of success and a negative error code in case of failure.
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001138 */
1139static struct mtd_info * __init open_mtd_device(const char *mtd_dev)
1140{
1141 struct mtd_info *mtd;
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001142 int mtd_num;
1143 char *endp;
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001144
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001145 mtd_num = simple_strtoul(mtd_dev, &endp, 0);
1146 if (*endp != '\0' || mtd_dev == endp) {
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001147 /*
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001148 * This does not look like an ASCII integer, probably this is
1149 * MTD device name.
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001150 */
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001151 mtd = get_mtd_device_nm(mtd_dev);
Artem Bityutskiyf9b00802010-01-05 16:48:40 +02001152 if (IS_ERR(mtd) && PTR_ERR(mtd) == -ENODEV)
1153 /* Probably this is an MTD character device node path */
1154 mtd = open_mtd_by_chdev(mtd_dev);
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001155 } else
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001156 mtd = get_mtd_device(NULL, mtd_num);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001157
1158 return mtd;
1159}
1160
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001161static int __init ubi_init(void)
1162{
1163 int err, i, k;
1164
1165 /* Ensure that EC and VID headers have correct size */
1166 BUILD_BUG_ON(sizeof(struct ubi_ec_hdr) != 64);
1167 BUILD_BUG_ON(sizeof(struct ubi_vid_hdr) != 64);
1168
1169 if (mtd_devs > UBI_MAX_DEVICES) {
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001170 ubi_err("too many MTD devices, maximum is %d", UBI_MAX_DEVICES);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001171 return -EINVAL;
1172 }
1173
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001174 /* Create base sysfs directory and sysfs files */
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001175 ubi_class = class_create(THIS_MODULE, UBI_NAME_STR);
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001176 if (IS_ERR(ubi_class)) {
1177 err = PTR_ERR(ubi_class);
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001178 ubi_err("cannot create UBI class");
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001179 goto out;
1180 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001181
1182 err = class_create_file(ubi_class, &ubi_version);
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001183 if (err) {
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001184 ubi_err("cannot create sysfs file");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001185 goto out_class;
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001186 }
1187
1188 err = misc_register(&ubi_ctrl_cdev);
1189 if (err) {
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001190 ubi_err("cannot register device");
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001191 goto out_version;
1192 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001193
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +02001194 ubi_wl_entry_slab = kmem_cache_create("ubi_wl_entry_slab",
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001195 sizeof(struct ubi_wl_entry),
1196 0, 0, NULL);
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +02001197 if (!ubi_wl_entry_slab)
Artem Bityutskiyb9a06622008-01-16 12:11:54 +02001198 goto out_dev_unreg;
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +02001199
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001200 /* Attach MTD devices */
1201 for (i = 0; i < mtd_devs; i++) {
1202 struct mtd_dev_param *p = &mtd_dev_param[i];
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001203 struct mtd_info *mtd;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001204
1205 cond_resched();
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001206
1207 mtd = open_mtd_device(p->name);
1208 if (IS_ERR(mtd)) {
1209 err = PTR_ERR(mtd);
1210 goto out_detach;
1211 }
1212
1213 mutex_lock(&ubi_devices_mutex);
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001214 err = ubi_attach_mtd_dev(mtd, UBI_DEV_NUM_AUTO,
1215 p->vid_hdr_offs);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001216 mutex_unlock(&ubi_devices_mutex);
1217 if (err < 0) {
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001218 ubi_err("cannot attach mtd%d", mtd->index);
Marc Kleine-Buddeaf7ad7a2010-05-05 10:17:25 +02001219 put_mtd_device(mtd);
1220
1221 /*
1222 * Originally UBI stopped initializing on any error.
1223 * However, later on it was found out that this
1224 * behavior is not very good when UBI is compiled into
1225 * the kernel and the MTD devices to attach are passed
1226 * through the command line. Indeed, UBI failure
1227 * stopped whole boot sequence.
1228 *
1229 * To fix this, we changed the behavior for the
1230 * non-module case, but preserved the old behavior for
1231 * the module case, just for compatibility. This is a
1232 * little inconsistent, though.
1233 */
1234 if (ubi_is_module())
1235 goto out_detach;
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001236 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001237 }
1238
1239 return 0;
1240
1241out_detach:
1242 for (k = 0; k < i; k++)
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001243 if (ubi_devices[k]) {
1244 mutex_lock(&ubi_devices_mutex);
1245 ubi_detach_mtd_dev(ubi_devices[k]->ubi_num, 1);
1246 mutex_unlock(&ubi_devices_mutex);
1247 }
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +02001248 kmem_cache_destroy(ubi_wl_entry_slab);
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001249out_dev_unreg:
1250 misc_deregister(&ubi_ctrl_cdev);
Artem Bityutskiy3a8d4642007-12-16 12:32:51 +02001251out_version:
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001252 class_remove_file(ubi_class, &ubi_version);
1253out_class:
1254 class_destroy(ubi_class);
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001255out:
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001256 ubi_err("UBI error: cannot initialize UBI, error %d", err);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001257 return err;
1258}
1259module_init(ubi_init);
1260
1261static void __exit ubi_exit(void)
1262{
Artem Bityutskiyb96bf4c2007-12-16 13:01:03 +02001263 int i;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001264
Artem Bityutskiyb96bf4c2007-12-16 13:01:03 +02001265 for (i = 0; i < UBI_MAX_DEVICES; i++)
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001266 if (ubi_devices[i]) {
1267 mutex_lock(&ubi_devices_mutex);
1268 ubi_detach_mtd_dev(ubi_devices[i]->ubi_num, 1);
1269 mutex_unlock(&ubi_devices_mutex);
1270 }
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +02001271 kmem_cache_destroy(ubi_wl_entry_slab);
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001272 misc_deregister(&ubi_ctrl_cdev);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001273 class_remove_file(ubi_class, &ubi_version);
1274 class_destroy(ubi_class);
1275}
1276module_exit(ubi_exit);
1277
1278/**
Artem Bityutskiyebaaf1a2008-07-18 13:34:32 +03001279 * bytes_str_to_int - convert a number of bytes string into an integer.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001280 * @str: the string to convert
1281 *
1282 * This function returns positive resulting integer in case of success and a
1283 * negative error code in case of failure.
1284 */
1285static int __init bytes_str_to_int(const char *str)
1286{
1287 char *endp;
1288 unsigned long result;
1289
1290 result = simple_strtoul(str, &endp, 0);
Roel Kluin774b1382009-10-16 14:00:17 +02001291 if (str == endp || result >= INT_MAX) {
Artem Bityutskiy458dbb32007-12-19 17:03:42 +02001292 printk(KERN_ERR "UBI error: incorrect bytes count: \"%s\"\n",
1293 str);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001294 return -EINVAL;
1295 }
1296
1297 switch (*endp) {
1298 case 'G':
1299 result *= 1024;
1300 case 'M':
1301 result *= 1024;
1302 case 'K':
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001303 result *= 1024;
Artem Bityutskiyaeddb872007-12-26 14:25:58 +02001304 if (endp[1] == 'i' && endp[2] == 'B')
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001305 endp += 2;
1306 case '\0':
1307 break;
1308 default:
Artem Bityutskiy458dbb32007-12-19 17:03:42 +02001309 printk(KERN_ERR "UBI error: incorrect bytes count: \"%s\"\n",
1310 str);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001311 return -EINVAL;
1312 }
1313
1314 return result;
1315}
1316
1317/**
1318 * ubi_mtd_param_parse - parse the 'mtd=' UBI parameter.
1319 * @val: the parameter value to parse
1320 * @kp: not used
1321 *
1322 * This function returns zero in case of success and a negative error code in
1323 * case of error.
1324 */
1325static int __init ubi_mtd_param_parse(const char *val, struct kernel_param *kp)
1326{
1327 int i, len;
1328 struct mtd_dev_param *p;
1329 char buf[MTD_PARAM_LEN_MAX];
1330 char *pbuf = &buf[0];
Artem Bityutskiyddc49392008-01-17 15:35:57 +02001331 char *tokens[2] = {NULL, NULL};
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001332
Artem Bityutskiy77c722d2007-12-16 16:46:57 +02001333 if (!val)
1334 return -EINVAL;
1335
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001336 if (mtd_devs == UBI_MAX_DEVICES) {
Artem Bityutskiy458dbb32007-12-19 17:03:42 +02001337 printk(KERN_ERR "UBI error: too many parameters, max. is %d\n",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001338 UBI_MAX_DEVICES);
1339 return -EINVAL;
1340 }
1341
1342 len = strnlen(val, MTD_PARAM_LEN_MAX);
1343 if (len == MTD_PARAM_LEN_MAX) {
Artem Bityutskiy458dbb32007-12-19 17:03:42 +02001344 printk(KERN_ERR "UBI error: parameter \"%s\" is too long, "
1345 "max. is %d\n", val, MTD_PARAM_LEN_MAX);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001346 return -EINVAL;
1347 }
1348
1349 if (len == 0) {
Artem Bityutskiy458dbb32007-12-19 17:03:42 +02001350 printk(KERN_WARNING "UBI warning: empty 'mtd=' parameter - "
1351 "ignored\n");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001352 return 0;
1353 }
1354
1355 strcpy(buf, val);
1356
1357 /* Get rid of the final newline */
1358 if (buf[len - 1] == '\n')
Artem Bityutskiy503990e2007-07-11 16:03:29 +03001359 buf[len - 1] = '\0';
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001360
Artem Bityutskiyddc49392008-01-17 15:35:57 +02001361 for (i = 0; i < 2; i++)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001362 tokens[i] = strsep(&pbuf, ",");
1363
1364 if (pbuf) {
Artem Bityutskiy458dbb32007-12-19 17:03:42 +02001365 printk(KERN_ERR "UBI error: too many arguments at \"%s\"\n",
1366 val);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001367 return -EINVAL;
1368 }
1369
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001370 p = &mtd_dev_param[mtd_devs];
1371 strcpy(&p->name[0], tokens[0]);
1372
1373 if (tokens[1])
1374 p->vid_hdr_offs = bytes_str_to_int(tokens[1]);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001375
1376 if (p->vid_hdr_offs < 0)
1377 return p->vid_hdr_offs;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001378
1379 mtd_devs += 1;
1380 return 0;
1381}
1382
1383module_param_call(mtd, ubi_mtd_param_parse, NULL, NULL, 000);
1384MODULE_PARM_DESC(mtd, "MTD devices to attach. Parameter format: "
Artem Bityutskiyf9b00802010-01-05 16:48:40 +02001385 "mtd=<name|num|path>[,<vid_hdr_offs>].\n"
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001386 "Multiple \"mtd\" parameters may be specified.\n"
Artem Bityutskiyf9b00802010-01-05 16:48:40 +02001387 "MTD devices may be specified by their number, name, or "
1388 "path to the MTD character device node.\n"
Artem Bityutskiydd38fcc2007-12-19 21:43:32 +02001389 "Optional \"vid_hdr_offs\" parameter specifies UBI VID "
Artem Bityutskiyf9b00802010-01-05 16:48:40 +02001390 "header position to be used by UBI.\n"
1391 "Example 1: mtd=/dev/mtd0 - attach MTD device "
1392 "/dev/mtd0.\n"
1393 "Example 2: mtd=content,1984 mtd=4 - attach MTD device "
Artem Bityutskiydd38fcc2007-12-19 21:43:32 +02001394 "with name \"content\" using VID header offset 1984, and "
1395 "MTD device number 4 with default VID header offset.");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001396
1397MODULE_VERSION(__stringify(UBI_VERSION));
1398MODULE_DESCRIPTION("UBI - Unsorted Block Images");
1399MODULE_AUTHOR("Artem Bityutskiy");
1400MODULE_LICENSE("GPL");