blob: c17f8e03abc8d5a2ddcf31daf1fc9dcb0cca7864 [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".
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040030 */
31
32#include <linux/err.h>
33#include <linux/module.h>
34#include <linux/moduleparam.h>
35#include <linux/stringify.h>
Artem Bityutskiyf9b00802010-01-05 16:48:40 +020036#include <linux/namei.h>
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040037#include <linux/stat.h>
Artem Bityutskiy9f961b52007-12-16 16:59:31 +020038#include <linux/miscdevice.h>
Richard Genoudba4087e2012-07-10 18:23:41 +020039#include <linux/mtd/partitions.h>
Vignesh Babu7753f162007-06-12 10:31:05 +053040#include <linux/log2.h>
Artem Bityutskiycdfa7882007-12-17 20:33:20 +020041#include <linux/kthread.h>
Roel Kluin774b1382009-10-16 14:00:17 +020042#include <linux/kernel.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090043#include <linux/slab.h>
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040044#include "ubi.h"
45
46/* Maximum length of the 'mtd=' parameter */
47#define MTD_PARAM_LEN_MAX 64
48
Marc Kleine-Buddeaf7ad7a2010-05-05 10:17:25 +020049#ifdef CONFIG_MTD_UBI_MODULE
50#define ubi_is_module() 1
51#else
52#define ubi_is_module() 0
53#endif
54
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040055/**
56 * struct mtd_dev_param - MTD device parameter description data structure.
Artem Bityutskiyf9b00802010-01-05 16:48:40 +020057 * @name: MTD character device node path, MTD device name, or MTD device number
58 * string
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040059 * @vid_hdr_offs: VID header offset
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040060 */
Artem Bityutskiy9c9ec142008-07-18 13:19:52 +030061struct mtd_dev_param {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040062 char name[MTD_PARAM_LEN_MAX];
63 int vid_hdr_offs;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040064};
65
66/* Numbers of elements set in the @mtd_dev_param array */
Artem Bityutskiy9e0c7ef32010-01-06 14:20:31 +020067static int __initdata mtd_devs;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040068
69/* MTD devices specification parameters */
Artem Bityutskiy9e0c7ef32010-01-06 14:20:31 +020070static struct mtd_dev_param __initdata mtd_dev_param[UBI_MAX_DEVICES];
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040071
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040072/* Root UBI "class" object (corresponds to '/<sysfs>/class/ubi/') */
73struct class *ubi_class;
74
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +020075/* Slab cache for wear-leveling entries */
76struct kmem_cache *ubi_wl_entry_slab;
77
Artem Bityutskiy9f961b52007-12-16 16:59:31 +020078/* UBI control character device */
79static struct miscdevice ubi_ctrl_cdev = {
80 .minor = MISC_DYNAMIC_MINOR,
81 .name = "ubi_ctrl",
82 .fops = &ubi_ctrl_cdev_operations,
83};
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +020084
Artem Bityutskiye73f4452007-12-17 17:37:26 +020085/* All UBI devices in system */
86static struct ubi_device *ubi_devices[UBI_MAX_DEVICES];
87
Artem Bityutskiycdfa7882007-12-17 20:33:20 +020088/* Serializes UBI devices creations and removals */
89DEFINE_MUTEX(ubi_devices_mutex);
90
Artem Bityutskiye73f4452007-12-17 17:37:26 +020091/* Protects @ubi_devices and @ubi->ref_count */
92static DEFINE_SPINLOCK(ubi_devices_lock);
93
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040094/* "Show" method for files in '/<sysfs>/class/ubi/' */
Artem Bityutskiyc174a082010-09-03 15:11:17 +030095static ssize_t ubi_version_show(struct class *class,
96 struct class_attribute *attr, char *buf)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040097{
98 return sprintf(buf, "%d\n", UBI_VERSION);
99}
100
101/* UBI version attribute ('/<sysfs>/class/ubi/version') */
102static struct class_attribute ubi_version =
103 __ATTR(version, S_IRUGO, ubi_version_show, NULL);
104
105static ssize_t dev_attribute_show(struct device *dev,
106 struct device_attribute *attr, char *buf);
107
108/* UBI device attributes (correspond to files in '/<sysfs>/class/ubi/ubiX') */
109static struct device_attribute dev_eraseblock_size =
110 __ATTR(eraseblock_size, S_IRUGO, dev_attribute_show, NULL);
111static struct device_attribute dev_avail_eraseblocks =
112 __ATTR(avail_eraseblocks, S_IRUGO, dev_attribute_show, NULL);
113static struct device_attribute dev_total_eraseblocks =
114 __ATTR(total_eraseblocks, S_IRUGO, dev_attribute_show, NULL);
115static struct device_attribute dev_volumes_count =
116 __ATTR(volumes_count, S_IRUGO, dev_attribute_show, NULL);
117static struct device_attribute dev_max_ec =
118 __ATTR(max_ec, S_IRUGO, dev_attribute_show, NULL);
119static struct device_attribute dev_reserved_for_bad =
120 __ATTR(reserved_for_bad, S_IRUGO, dev_attribute_show, NULL);
121static struct device_attribute dev_bad_peb_count =
122 __ATTR(bad_peb_count, S_IRUGO, dev_attribute_show, NULL);
123static struct device_attribute dev_max_vol_count =
124 __ATTR(max_vol_count, S_IRUGO, dev_attribute_show, NULL);
125static struct device_attribute dev_min_io_size =
126 __ATTR(min_io_size, S_IRUGO, dev_attribute_show, NULL);
127static struct device_attribute dev_bgt_enabled =
128 __ATTR(bgt_enabled, S_IRUGO, dev_attribute_show, NULL);
Artem Bityutskiyb6b76ba2007-12-26 13:46:46 +0200129static struct device_attribute dev_mtd_num =
130 __ATTR(mtd_num, S_IRUGO, dev_attribute_show, NULL);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400131
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200132/**
Dmitry Pervushin0e0ee1c2009-04-29 19:29:38 +0400133 * ubi_volume_notify - send a volume change notification.
134 * @ubi: UBI device description object
135 * @vol: volume description object of the changed volume
136 * @ntype: notification type to send (%UBI_VOLUME_ADDED, etc)
137 *
138 * This is a helper function which notifies all subscribers about a volume
139 * change event (creation, removal, re-sizing, re-naming, updating). Returns
140 * zero in case of success and a negative error code in case of failure.
141 */
142int ubi_volume_notify(struct ubi_device *ubi, struct ubi_volume *vol, int ntype)
143{
144 struct ubi_notification nt;
145
146 ubi_do_get_device_info(ubi, &nt.di);
147 ubi_do_get_volume_info(ubi, vol, &nt.vi);
148 return blocking_notifier_call_chain(&ubi_notifiers, ntype, &nt);
149}
150
151/**
152 * ubi_notify_all - send a notification to all volumes.
153 * @ubi: UBI device description object
154 * @ntype: notification type to send (%UBI_VOLUME_ADDED, etc)
155 * @nb: the notifier to call
156 *
157 * This function walks all volumes of UBI device @ubi and sends the @ntype
158 * notification for each volume. If @nb is %NULL, then all registered notifiers
159 * are called, otherwise only the @nb notifier is called. Returns the number of
160 * sent notifications.
161 */
162int ubi_notify_all(struct ubi_device *ubi, int ntype, struct notifier_block *nb)
163{
164 struct ubi_notification nt;
165 int i, count = 0;
166
167 ubi_do_get_device_info(ubi, &nt.di);
168
169 mutex_lock(&ubi->device_mutex);
170 for (i = 0; i < ubi->vtbl_slots; i++) {
171 /*
172 * Since the @ubi->device is locked, and we are not going to
173 * change @ubi->volumes, we do not have to lock
174 * @ubi->volumes_lock.
175 */
176 if (!ubi->volumes[i])
177 continue;
178
179 ubi_do_get_volume_info(ubi, ubi->volumes[i], &nt.vi);
180 if (nb)
181 nb->notifier_call(nb, ntype, &nt);
182 else
183 blocking_notifier_call_chain(&ubi_notifiers, ntype,
184 &nt);
185 count += 1;
186 }
187 mutex_unlock(&ubi->device_mutex);
188
189 return count;
190}
191
192/**
193 * ubi_enumerate_volumes - send "add" notification for all existing volumes.
194 * @nb: the notifier to call
195 *
196 * This function walks all UBI devices and volumes and sends the
197 * %UBI_VOLUME_ADDED notification for each volume. If @nb is %NULL, then all
198 * registered notifiers are called, otherwise only the @nb notifier is called.
199 * Returns the number of sent notifications.
200 */
201int ubi_enumerate_volumes(struct notifier_block *nb)
202{
203 int i, count = 0;
204
205 /*
206 * Since the @ubi_devices_mutex is locked, and we are not going to
207 * change @ubi_devices, we do not have to lock @ubi_devices_lock.
208 */
209 for (i = 0; i < UBI_MAX_DEVICES; i++) {
210 struct ubi_device *ubi = ubi_devices[i];
211
212 if (!ubi)
213 continue;
214 count += ubi_notify_all(ubi, UBI_VOLUME_ADDED, nb);
215 }
216
217 return count;
218}
219
220/**
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200221 * ubi_get_device - get UBI device.
222 * @ubi_num: UBI device number
223 *
224 * This function returns UBI device description object for UBI device number
225 * @ubi_num, or %NULL if the device does not exist. This function increases the
226 * device reference count to prevent removal of the device. In other words, the
227 * device cannot be removed if its reference count is not zero.
228 */
229struct ubi_device *ubi_get_device(int ubi_num)
230{
231 struct ubi_device *ubi;
232
233 spin_lock(&ubi_devices_lock);
234 ubi = ubi_devices[ubi_num];
235 if (ubi) {
236 ubi_assert(ubi->ref_count >= 0);
237 ubi->ref_count += 1;
238 get_device(&ubi->dev);
239 }
240 spin_unlock(&ubi_devices_lock);
241
242 return ubi;
243}
244
245/**
246 * ubi_put_device - drop an UBI device reference.
247 * @ubi: UBI device description object
248 */
249void ubi_put_device(struct ubi_device *ubi)
250{
251 spin_lock(&ubi_devices_lock);
252 ubi->ref_count -= 1;
253 put_device(&ubi->dev);
254 spin_unlock(&ubi_devices_lock);
255}
256
257/**
Artem Bityutskiyebaaf1a2008-07-18 13:34:32 +0300258 * ubi_get_by_major - get UBI device by character device major number.
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200259 * @major: major number
260 *
261 * This function is similar to 'ubi_get_device()', but it searches the device
262 * by its major number.
263 */
264struct ubi_device *ubi_get_by_major(int major)
265{
266 int i;
267 struct ubi_device *ubi;
268
269 spin_lock(&ubi_devices_lock);
270 for (i = 0; i < UBI_MAX_DEVICES; i++) {
271 ubi = ubi_devices[i];
272 if (ubi && MAJOR(ubi->cdev.dev) == major) {
273 ubi_assert(ubi->ref_count >= 0);
274 ubi->ref_count += 1;
275 get_device(&ubi->dev);
276 spin_unlock(&ubi_devices_lock);
277 return ubi;
278 }
279 }
280 spin_unlock(&ubi_devices_lock);
281
282 return NULL;
283}
284
285/**
286 * ubi_major2num - get UBI device number by character device major number.
287 * @major: major number
288 *
289 * This function searches UBI device number object by its major number. If UBI
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200290 * device was not found, this function returns -ENODEV, otherwise the UBI device
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200291 * number is returned.
292 */
293int ubi_major2num(int major)
294{
295 int i, ubi_num = -ENODEV;
296
297 spin_lock(&ubi_devices_lock);
298 for (i = 0; i < UBI_MAX_DEVICES; i++) {
299 struct ubi_device *ubi = ubi_devices[i];
300
301 if (ubi && MAJOR(ubi->cdev.dev) == major) {
302 ubi_num = ubi->ubi_num;
303 break;
304 }
305 }
306 spin_unlock(&ubi_devices_lock);
307
308 return ubi_num;
309}
310
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400311/* "Show" method for files in '/<sysfs>/class/ubi/ubiX/' */
312static ssize_t dev_attribute_show(struct device *dev,
313 struct device_attribute *attr, char *buf)
314{
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200315 ssize_t ret;
316 struct ubi_device *ubi;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400317
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200318 /*
319 * The below code looks weird, but it actually makes sense. We get the
320 * UBI device reference from the contained 'struct ubi_device'. But it
321 * is unclear if the device was removed or not yet. Indeed, if the
322 * device was removed before we increased its reference count,
323 * 'ubi_get_device()' will return -ENODEV and we fail.
324 *
325 * Remember, 'struct ubi_device' is freed in the release function, so
326 * we still can use 'ubi->ubi_num'.
327 */
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400328 ubi = container_of(dev, struct ubi_device, dev);
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200329 ubi = ubi_get_device(ubi->ubi_num);
330 if (!ubi)
331 return -ENODEV;
332
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400333 if (attr == &dev_eraseblock_size)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200334 ret = sprintf(buf, "%d\n", ubi->leb_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400335 else if (attr == &dev_avail_eraseblocks)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200336 ret = sprintf(buf, "%d\n", ubi->avail_pebs);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400337 else if (attr == &dev_total_eraseblocks)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200338 ret = sprintf(buf, "%d\n", ubi->good_peb_count);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400339 else if (attr == &dev_volumes_count)
Artem Bityutskiy4b3cc342007-12-26 15:59:39 +0200340 ret = sprintf(buf, "%d\n", ubi->vol_count - UBI_INT_VOL_COUNT);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400341 else if (attr == &dev_max_ec)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200342 ret = sprintf(buf, "%d\n", ubi->max_ec);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400343 else if (attr == &dev_reserved_for_bad)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200344 ret = sprintf(buf, "%d\n", ubi->beb_rsvd_pebs);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400345 else if (attr == &dev_bad_peb_count)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200346 ret = sprintf(buf, "%d\n", ubi->bad_peb_count);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400347 else if (attr == &dev_max_vol_count)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200348 ret = sprintf(buf, "%d\n", ubi->vtbl_slots);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400349 else if (attr == &dev_min_io_size)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200350 ret = sprintf(buf, "%d\n", ubi->min_io_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400351 else if (attr == &dev_bgt_enabled)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200352 ret = sprintf(buf, "%d\n", ubi->thread_enabled);
Artem Bityutskiyb6b76ba2007-12-26 13:46:46 +0200353 else if (attr == &dev_mtd_num)
354 ret = sprintf(buf, "%d\n", ubi->mtd->index);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400355 else
Artem Bityutskiyb6b76ba2007-12-26 13:46:46 +0200356 ret = -EINVAL;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400357
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200358 ubi_put_device(ubi);
359 return ret;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400360}
361
Artem Bityutskiy36b477d2009-01-20 18:04:09 +0200362static void dev_release(struct device *dev)
363{
364 struct ubi_device *ubi = container_of(dev, struct ubi_device, dev);
365
366 kfree(ubi);
367}
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400368
369/**
370 * ubi_sysfs_init - initialize sysfs for an UBI device.
371 * @ubi: UBI device description object
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200372 * @ref: set to %1 on exit in case of failure if a reference to @ubi->dev was
373 * taken
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400374 *
375 * This function returns zero in case of success and a negative error code in
376 * case of failure.
377 */
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200378static int ubi_sysfs_init(struct ubi_device *ubi, int *ref)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400379{
380 int err;
381
382 ubi->dev.release = dev_release;
Artem Bityutskiy49dfc292007-12-15 18:13:56 +0200383 ubi->dev.devt = ubi->cdev.dev;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400384 ubi->dev.class = ubi_class;
Kay Sievers160bbab2008-12-23 10:00:14 +0000385 dev_set_name(&ubi->dev, UBI_NAME_STR"%d", ubi->ubi_num);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400386 err = device_register(&ubi->dev);
387 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200388 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400389
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200390 *ref = 1;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400391 err = device_create_file(&ubi->dev, &dev_eraseblock_size);
392 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200393 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400394 err = device_create_file(&ubi->dev, &dev_avail_eraseblocks);
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_total_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_volumes_count);
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_max_ec);
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_reserved_for_bad);
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_bad_peb_count);
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_max_vol_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_min_io_size);
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_bgt_enabled);
Artem Bityutskiyb6b76ba2007-12-26 13:46:46 +0200419 if (err)
420 return err;
421 err = device_create_file(&ubi->dev, &dev_mtd_num);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400422 return err;
423}
424
425/**
426 * ubi_sysfs_close - close sysfs for an UBI device.
427 * @ubi: UBI device description object
428 */
429static void ubi_sysfs_close(struct ubi_device *ubi)
430{
Artem Bityutskiyb6b76ba2007-12-26 13:46:46 +0200431 device_remove_file(&ubi->dev, &dev_mtd_num);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400432 device_remove_file(&ubi->dev, &dev_bgt_enabled);
433 device_remove_file(&ubi->dev, &dev_min_io_size);
434 device_remove_file(&ubi->dev, &dev_max_vol_count);
435 device_remove_file(&ubi->dev, &dev_bad_peb_count);
436 device_remove_file(&ubi->dev, &dev_reserved_for_bad);
437 device_remove_file(&ubi->dev, &dev_max_ec);
438 device_remove_file(&ubi->dev, &dev_volumes_count);
439 device_remove_file(&ubi->dev, &dev_total_eraseblocks);
440 device_remove_file(&ubi->dev, &dev_avail_eraseblocks);
441 device_remove_file(&ubi->dev, &dev_eraseblock_size);
442 device_unregister(&ubi->dev);
443}
444
445/**
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200446 * kill_volumes - destroy all user volumes.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400447 * @ubi: UBI device description object
448 */
449static void kill_volumes(struct ubi_device *ubi)
450{
451 int i;
452
453 for (i = 0; i < ubi->vtbl_slots; i++)
454 if (ubi->volumes[i])
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200455 ubi_free_volume(ubi, ubi->volumes[i]);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400456}
457
458/**
459 * uif_init - initialize user interfaces for an UBI device.
460 * @ubi: UBI device description object
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200461 * @ref: set to %1 on exit in case of failure if a reference to @ubi->dev was
462 * taken, otherwise set to %0
463 *
464 * This function initializes various user interfaces for an UBI device. If the
465 * initialization fails at an early stage, this function frees all the
466 * resources it allocated, returns an error, and @ref is set to %0. However,
467 * if the initialization fails after the UBI device was registered in the
468 * driver core subsystem, this function takes a reference to @ubi->dev, because
469 * otherwise the release function ('dev_release()') would free whole @ubi
470 * object. The @ref argument is set to %1 in this case. The caller has to put
471 * this reference.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400472 *
473 * This function returns zero in case of success and a negative error code in
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200474 * case of failure.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400475 */
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200476static int uif_init(struct ubi_device *ubi, int *ref)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400477{
Artem Bityutskiy8c4c19f2009-01-20 17:48:02 +0200478 int i, err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400479 dev_t dev;
480
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200481 *ref = 0;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400482 sprintf(ubi->ubi_name, UBI_NAME_STR "%d", ubi->ubi_num);
483
484 /*
485 * Major numbers for the UBI character devices are allocated
486 * dynamically. Major numbers of volume character devices are
487 * equivalent to ones of the corresponding UBI character device. Minor
488 * numbers of UBI character devices are 0, while minor numbers of
489 * volume character devices start from 1. Thus, we allocate one major
490 * number and ubi->vtbl_slots + 1 minor numbers.
491 */
492 err = alloc_chrdev_region(&dev, 0, ubi->vtbl_slots + 1, ubi->ubi_name);
493 if (err) {
494 ubi_err("cannot register UBI character devices");
495 return err;
496 }
497
Artem Bityutskiy49dfc292007-12-15 18:13:56 +0200498 ubi_assert(MINOR(dev) == 0);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400499 cdev_init(&ubi->cdev, &ubi_cdev_operations);
Artem Bityutskiyc8566352008-07-16 17:40:22 +0300500 dbg_gen("%s major is %u", ubi->ubi_name, MAJOR(dev));
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400501 ubi->cdev.owner = THIS_MODULE;
502
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400503 err = cdev_add(&ubi->cdev, dev, 1);
504 if (err) {
Artem Bityutskiy01f7b302007-12-15 19:56:51 +0200505 ubi_err("cannot add character device");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400506 goto out_unreg;
507 }
508
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200509 err = ubi_sysfs_init(ubi, ref);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400510 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200511 goto out_sysfs;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400512
513 for (i = 0; i < ubi->vtbl_slots; i++)
514 if (ubi->volumes[i]) {
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200515 err = ubi_add_volume(ubi, ubi->volumes[i]);
Artem Bityutskiy01f7b302007-12-15 19:56:51 +0200516 if (err) {
517 ubi_err("cannot add volume %d", i);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400518 goto out_volumes;
Artem Bityutskiy01f7b302007-12-15 19:56:51 +0200519 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400520 }
521
522 return 0;
523
524out_volumes:
525 kill_volumes(ubi);
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200526out_sysfs:
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200527 if (*ref)
528 get_device(&ubi->dev);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400529 ubi_sysfs_close(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400530 cdev_del(&ubi->cdev);
531out_unreg:
Artem Bityutskiy49dfc292007-12-15 18:13:56 +0200532 unregister_chrdev_region(ubi->cdev.dev, ubi->vtbl_slots + 1);
Artem Bityutskiy01f7b302007-12-15 19:56:51 +0200533 ubi_err("cannot initialize UBI %s, error %d", ubi->ubi_name, err);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400534 return err;
535}
536
537/**
538 * uif_close - close user interfaces for an UBI device.
539 * @ubi: UBI device description object
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300540 *
541 * Note, since this function un-registers UBI volume device objects (@vol->dev),
542 * the memory allocated voe the volumes is freed as well (in the release
543 * function).
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400544 */
545static void uif_close(struct ubi_device *ubi)
546{
547 kill_volumes(ubi);
548 ubi_sysfs_close(ubi);
549 cdev_del(&ubi->cdev);
Artem Bityutskiy49dfc292007-12-15 18:13:56 +0200550 unregister_chrdev_region(ubi->cdev.dev, ubi->vtbl_slots + 1);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400551}
552
553/**
Artem Bityutskiy47e1ec72012-05-18 12:41:17 +0300554 * ubi_free_internal_volumes - free internal volumes.
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300555 * @ubi: UBI device description object
556 */
Artem Bityutskiy47e1ec72012-05-18 12:41:17 +0300557void ubi_free_internal_volumes(struct ubi_device *ubi)
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300558{
559 int i;
560
561 for (i = ubi->vtbl_slots;
562 i < ubi->vtbl_slots + UBI_INT_VOL_COUNT; i++) {
563 kfree(ubi->volumes[i]->eba_tbl);
564 kfree(ubi->volumes[i]);
565 }
566}
567
Richard Genoud95e6fb02012-08-17 16:35:18 +0200568static int get_bad_peb_limit(const struct ubi_device *ubi, int max_beb_per1024)
569{
570 int limit, device_pebs;
571 uint64_t device_size;
572
573 if (!max_beb_per1024)
574 return 0;
575
576 /*
577 * Here we are using size of the entire flash chip and
578 * not just the MTD partition size because the maximum
579 * number of bad eraseblocks is a percentage of the
580 * whole device and bad eraseblocks are not fairly
581 * distributed over the flash chip. So the worst case
582 * is that all the bad eraseblocks of the chip are in
583 * the MTD partition we are attaching (ubi->mtd).
584 */
585 device_size = mtd_get_device_size(ubi->mtd);
586 device_pebs = mtd_div_by_eb(device_size, ubi->mtd);
587 limit = mult_frac(device_pebs, max_beb_per1024, 1024);
588
589 /* Round it up */
590 if (mult_frac(limit, 1024, max_beb_per1024) < device_pebs)
591 limit += 1;
592
593 return limit;
594}
595
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300596/**
Artem Bityutskiy85c6e6e2008-07-16 10:25:56 +0300597 * io_init - initialize I/O sub-system for a given UBI device.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400598 * @ubi: UBI device description object
599 *
600 * If @ubi->vid_hdr_offset or @ubi->leb_start is zero, default offsets are
601 * assumed:
602 * o EC header is always at offset zero - this cannot be changed;
603 * o VID header starts just after the EC header at the closest address
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200604 * aligned to @io->hdrs_min_io_size;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400605 * o data starts just after the VID header at the closest address aligned to
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200606 * @io->min_io_size
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400607 *
608 * This function returns zero in case of success and a negative error code in
609 * case of failure.
610 */
611static int io_init(struct ubi_device *ubi)
612{
Richard Genoud95e6fb02012-08-17 16:35:18 +0200613 const int max_beb_per1024 = CONFIG_MTD_UBI_BEB_LIMIT;
614
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400615 if (ubi->mtd->numeraseregions != 0) {
616 /*
617 * Some flashes have several erase regions. Different regions
618 * may have different eraseblock size and other
619 * characteristics. It looks like mostly multi-region flashes
620 * have one "main" region and one or more small regions to
621 * store boot loader code or boot parameters or whatever. I
622 * guess we should just pick the largest region. But this is
623 * not implemented.
624 */
625 ubi_err("multiple regions, not implemented");
626 return -EINVAL;
627 }
628
Artem Bityutskiydd38fcc2007-12-19 21:43:32 +0200629 if (ubi->vid_hdr_offset < 0)
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200630 return -EINVAL;
631
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400632 /*
633 * Note, in this implementation we support MTD devices with 0x7FFFFFFF
634 * physical eraseblocks maximum.
635 */
636
637 ubi->peb_size = ubi->mtd->erasesize;
Adrian Hunter69423d92008-12-10 13:37:21 +0000638 ubi->peb_count = mtd_div_by_eb(ubi->mtd->size, ubi->mtd);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400639 ubi->flash_size = ubi->mtd->size;
640
Shmulik Ladkani8beeb3b2012-07-04 11:06:00 +0300641 if (mtd_can_have_bb(ubi->mtd)) {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400642 ubi->bad_allowed = 1;
Richard Genoud95e6fb02012-08-17 16:35:18 +0200643 ubi->bad_peb_limit = get_bad_peb_limit(ubi, max_beb_per1024);
Shmulik Ladkani8beeb3b2012-07-04 11:06:00 +0300644 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400645
Artem Bityutskiyebf53f42009-07-06 08:57:53 +0300646 if (ubi->mtd->type == MTD_NORFLASH) {
647 ubi_assert(ubi->mtd->writesize == 1);
648 ubi->nor_flash = 1;
649 }
650
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400651 ubi->min_io_size = ubi->mtd->writesize;
652 ubi->hdrs_min_io_size = ubi->mtd->writesize >> ubi->mtd->subpage_sft;
653
Kyungmin Parkcadb40c2008-05-22 10:32:18 +0900654 /*
655 * Make sure minimal I/O unit is power of 2. Note, there is no
656 * fundamental reason for this assumption. It is just an optimization
657 * which allows us to avoid costly division operations.
658 */
Vignesh Babu7753f162007-06-12 10:31:05 +0530659 if (!is_power_of_2(ubi->min_io_size)) {
Artem Bityutskiy01f7b302007-12-15 19:56:51 +0200660 ubi_err("min. I/O unit (%d) is not power of 2",
661 ubi->min_io_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400662 return -EINVAL;
663 }
664
665 ubi_assert(ubi->hdrs_min_io_size > 0);
666 ubi_assert(ubi->hdrs_min_io_size <= ubi->min_io_size);
667 ubi_assert(ubi->min_io_size % ubi->hdrs_min_io_size == 0);
668
Artem Bityutskiy30b542e2011-01-30 18:37:33 +0200669 ubi->max_write_size = ubi->mtd->writebufsize;
670 /*
671 * Maximum write size has to be greater or equivalent to min. I/O
672 * size, and be multiple of min. I/O size.
673 */
674 if (ubi->max_write_size < ubi->min_io_size ||
675 ubi->max_write_size % ubi->min_io_size ||
676 !is_power_of_2(ubi->max_write_size)) {
677 ubi_err("bad write buffer size %d for %d min. I/O unit",
678 ubi->max_write_size, ubi->min_io_size);
679 return -EINVAL;
680 }
681
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400682 /* Calculate default aligned sizes of EC and VID headers */
683 ubi->ec_hdr_alsize = ALIGN(UBI_EC_HDR_SIZE, ubi->hdrs_min_io_size);
684 ubi->vid_hdr_alsize = ALIGN(UBI_VID_HDR_SIZE, ubi->hdrs_min_io_size);
685
686 dbg_msg("min_io_size %d", ubi->min_io_size);
Artem Bityutskiy30b542e2011-01-30 18:37:33 +0200687 dbg_msg("max_write_size %d", ubi->max_write_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400688 dbg_msg("hdrs_min_io_size %d", ubi->hdrs_min_io_size);
689 dbg_msg("ec_hdr_alsize %d", ubi->ec_hdr_alsize);
690 dbg_msg("vid_hdr_alsize %d", ubi->vid_hdr_alsize);
691
692 if (ubi->vid_hdr_offset == 0)
693 /* Default offset */
694 ubi->vid_hdr_offset = ubi->vid_hdr_aloffset =
695 ubi->ec_hdr_alsize;
696 else {
697 ubi->vid_hdr_aloffset = ubi->vid_hdr_offset &
698 ~(ubi->hdrs_min_io_size - 1);
699 ubi->vid_hdr_shift = ubi->vid_hdr_offset -
700 ubi->vid_hdr_aloffset;
701 }
702
703 /* Similar for the data offset */
John Ognesse8cfe002011-01-21 15:39:02 +0100704 ubi->leb_start = ubi->vid_hdr_offset + UBI_VID_HDR_SIZE;
Artem Bityutskiydd38fcc2007-12-19 21:43:32 +0200705 ubi->leb_start = ALIGN(ubi->leb_start, ubi->min_io_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400706
707 dbg_msg("vid_hdr_offset %d", ubi->vid_hdr_offset);
708 dbg_msg("vid_hdr_aloffset %d", ubi->vid_hdr_aloffset);
709 dbg_msg("vid_hdr_shift %d", ubi->vid_hdr_shift);
710 dbg_msg("leb_start %d", ubi->leb_start);
711
712 /* The shift must be aligned to 32-bit boundary */
713 if (ubi->vid_hdr_shift % 4) {
714 ubi_err("unaligned VID header shift %d",
715 ubi->vid_hdr_shift);
716 return -EINVAL;
717 }
718
719 /* Check sanity */
720 if (ubi->vid_hdr_offset < UBI_EC_HDR_SIZE ||
721 ubi->leb_start < ubi->vid_hdr_offset + UBI_VID_HDR_SIZE ||
722 ubi->leb_start > ubi->peb_size - UBI_VID_HDR_SIZE ||
Kyungmin Parkcadb40c2008-05-22 10:32:18 +0900723 ubi->leb_start & (ubi->min_io_size - 1)) {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400724 ubi_err("bad VID header (%d) or data offsets (%d)",
725 ubi->vid_hdr_offset, ubi->leb_start);
726 return -EINVAL;
727 }
728
729 /*
Artem Bityutskiyb86a2c52009-05-24 14:13:34 +0300730 * Set maximum amount of physical erroneous eraseblocks to be 10%.
731 * Erroneous PEB are those which have read errors.
732 */
733 ubi->max_erroneous = ubi->peb_count / 10;
734 if (ubi->max_erroneous < 16)
735 ubi->max_erroneous = 16;
736 dbg_msg("max_erroneous %d", ubi->max_erroneous);
737
738 /*
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400739 * It may happen that EC and VID headers are situated in one minimal
740 * I/O unit. In this case we can only accept this UBI image in
741 * read-only mode.
742 */
743 if (ubi->vid_hdr_offset + UBI_VID_HDR_SIZE <= ubi->hdrs_min_io_size) {
744 ubi_warn("EC and VID headers are in the same minimal I/O unit, "
745 "switch to read-only mode");
746 ubi->ro_mode = 1;
747 }
748
749 ubi->leb_size = ubi->peb_size - ubi->leb_start;
750
751 if (!(ubi->mtd->flags & MTD_WRITEABLE)) {
752 ubi_msg("MTD device %d is write-protected, attach in "
753 "read-only mode", ubi->mtd->index);
754 ubi->ro_mode = 1;
755 }
756
Artem Bityutskiy434b8252008-04-20 18:00:33 +0300757 ubi_msg("physical eraseblock size: %d bytes (%d KiB)",
758 ubi->peb_size, ubi->peb_size >> 10);
759 ubi_msg("logical eraseblock size: %d bytes", ubi->leb_size);
760 ubi_msg("smallest flash I/O unit: %d", ubi->min_io_size);
761 if (ubi->hdrs_min_io_size != ubi->min_io_size)
762 ubi_msg("sub-page size: %d",
763 ubi->hdrs_min_io_size);
764 ubi_msg("VID header offset: %d (aligned %d)",
765 ubi->vid_hdr_offset, ubi->vid_hdr_aloffset);
766 ubi_msg("data offset: %d", ubi->leb_start);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400767
768 /*
Artem Bityutskiyfbd01072012-05-17 16:12:26 +0300769 * Note, ideally, we have to initialize @ubi->bad_peb_count here. But
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400770 * unfortunately, MTD does not provide this information. We should loop
771 * over all physical eraseblocks and invoke mtd->block_is_bad() for
Artem Bityutskiyfbd01072012-05-17 16:12:26 +0300772 * each physical eraseblock. So, we leave @ubi->bad_peb_count
773 * uninitialized so far.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400774 */
775
776 return 0;
777}
778
779/**
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200780 * autoresize - re-size the volume which has the "auto-resize" flag set.
781 * @ubi: UBI device description object
782 * @vol_id: ID of the volume to re-size
783 *
Artem Bityutskiyfbd01072012-05-17 16:12:26 +0300784 * This function re-sizes the volume marked by the %UBI_VTBL_AUTORESIZE_FLG in
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200785 * the volume table to the largest possible size. See comments in ubi-header.h
786 * for more description of the flag. Returns zero in case of success and a
787 * negative error code in case of failure.
788 */
789static int autoresize(struct ubi_device *ubi, int vol_id)
790{
791 struct ubi_volume_desc desc;
792 struct ubi_volume *vol = ubi->volumes[vol_id];
793 int err, old_reserved_pebs = vol->reserved_pebs;
794
795 /*
796 * Clear the auto-resize flag in the volume in-memory copy of the
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300797 * volume table, and 'ubi_resize_volume()' will propagate this change
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200798 * to the flash.
799 */
800 ubi->vtbl[vol_id].flags &= ~UBI_VTBL_AUTORESIZE_FLG;
801
802 if (ubi->avail_pebs == 0) {
803 struct ubi_vtbl_record vtbl_rec;
804
805 /*
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300806 * No available PEBs to re-size the volume, clear the flag on
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200807 * flash and exit.
808 */
809 memcpy(&vtbl_rec, &ubi->vtbl[vol_id],
810 sizeof(struct ubi_vtbl_record));
811 err = ubi_change_vtbl_record(ubi, vol_id, &vtbl_rec);
812 if (err)
813 ubi_err("cannot clean auto-resize flag for volume %d",
814 vol_id);
815 } else {
816 desc.vol = vol;
817 err = ubi_resize_volume(&desc,
818 old_reserved_pebs + ubi->avail_pebs);
819 if (err)
820 ubi_err("cannot auto-resize volume %d", vol_id);
821 }
822
823 if (err)
824 return err;
825
826 ubi_msg("volume %d (\"%s\") re-sized from %d to %d LEBs", vol_id,
827 vol->name, old_reserved_pebs, vol->reserved_pebs);
828 return 0;
829}
830
831/**
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200832 * ubi_attach_mtd_dev - attach an MTD device.
Artem Bityutskiyebaaf1a2008-07-18 13:34:32 +0300833 * @mtd: MTD device description object
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200834 * @ubi_num: number to assign to the new UBI device
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400835 * @vid_hdr_offset: VID header offset
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400836 *
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200837 * This function attaches MTD device @mtd_dev to UBI and assign @ubi_num number
838 * to the newly created UBI device, unless @ubi_num is %UBI_DEV_NUM_AUTO, in
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300839 * which case this function finds a vacant device number and assigns it
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200840 * automatically. Returns the new UBI device number in case of success and a
841 * negative error code in case of failure.
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200842 *
843 * Note, the invocations of this function has to be serialized by the
844 * @ubi_devices_mutex.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400845 */
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200846int ubi_attach_mtd_dev(struct mtd_info *mtd, int ubi_num, int vid_hdr_offset)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400847{
848 struct ubi_device *ubi;
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200849 int i, err, ref = 0;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400850
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200851 /*
852 * Check if we already have the same MTD device attached.
853 *
854 * Note, this function assumes that UBI devices creations and deletions
855 * are serialized, so it does not take the &ubi_devices_lock.
856 */
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200857 for (i = 0; i < UBI_MAX_DEVICES; i++) {
Artem Bityutskiyb96bf4c2007-12-16 13:01:03 +0200858 ubi = ubi_devices[i];
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200859 if (ubi && mtd->index == ubi->mtd->index) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300860 ubi_err("mtd%d is already attached to ubi%d",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400861 mtd->index, i);
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200862 return -EEXIST;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400863 }
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200864 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400865
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200866 /*
867 * Make sure this MTD device is not emulated on top of an UBI volume
868 * already. Well, generally this recursion works fine, but there are
869 * different problems like the UBI module takes a reference to itself
870 * by attaching (and thus, opening) the emulated MTD device. This
871 * results in inability to unload the module. And in general it makes
872 * no sense to attach emulated MTD devices, so we prohibit this.
873 */
874 if (mtd->type == MTD_UBIVOLUME) {
875 ubi_err("refuse attaching mtd%d - it is already emulated on "
876 "top of UBI", mtd->index);
877 return -EINVAL;
878 }
Artem Bityutskiyb96bf4c2007-12-16 13:01:03 +0200879
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200880 if (ubi_num == UBI_DEV_NUM_AUTO) {
881 /* Search for an empty slot in the @ubi_devices array */
882 for (ubi_num = 0; ubi_num < UBI_MAX_DEVICES; ubi_num++)
883 if (!ubi_devices[ubi_num])
884 break;
885 if (ubi_num == UBI_MAX_DEVICES) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300886 ubi_err("only %d UBI devices may be created",
Artem Bityutskiy9c9ec142008-07-18 13:19:52 +0300887 UBI_MAX_DEVICES);
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200888 return -ENFILE;
889 }
890 } else {
891 if (ubi_num >= UBI_MAX_DEVICES)
892 return -EINVAL;
893
894 /* Make sure ubi_num is not busy */
895 if (ubi_devices[ubi_num]) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300896 ubi_err("ubi%d already exists", ubi_num);
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200897 return -EEXIST;
898 }
Artem Bityutskiyb96bf4c2007-12-16 13:01:03 +0200899 }
900
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200901 ubi = kzalloc(sizeof(struct ubi_device), GFP_KERNEL);
902 if (!ubi)
903 return -ENOMEM;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400904
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200905 ubi->mtd = mtd;
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200906 ubi->ubi_num = ubi_num;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400907 ubi->vid_hdr_offset = vid_hdr_offset;
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200908 ubi->autoresize_vol_id = -1;
909
910 mutex_init(&ubi->buf_mutex);
911 mutex_init(&ubi->ckvol_mutex);
Artem Bityutskiyf089c0b2009-05-07 11:46:49 +0300912 mutex_init(&ubi->device_mutex);
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200913 spin_lock_init(&ubi->volumes_lock);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200914
Artem Bityutskiy697fa9722008-04-23 13:43:21 +0300915 ubi_msg("attaching mtd%d to ubi%d", mtd->index, ubi_num);
Artem Bityutskiy227423d2012-05-17 06:23:22 +0300916 dbg_msg("sizeof(struct ubi_ainf_peb) %zu", sizeof(struct ubi_ainf_peb));
Artem Bityutskiy6c1e8752010-10-31 17:54:14 +0200917 dbg_msg("sizeof(struct ubi_wl_entry) %zu", sizeof(struct ubi_wl_entry));
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200918
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400919 err = io_init(ubi);
920 if (err)
921 goto out_free;
922
Stefan Roesead5942b2008-12-10 10:42:54 +0100923 err = -ENOMEM;
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +0200924 ubi->peb_buf = vmalloc(ubi->peb_size);
925 if (!ubi->peb_buf)
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300926 goto out_free;
927
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +0300928 err = ubi_debugging_init_dev(ubi);
929 if (err)
930 goto out_free;
931
Artem Bityutskiy47e1ec72012-05-18 12:41:17 +0300932 err = ubi_attach(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400933 if (err) {
Artem Bityutskiy47e1ec72012-05-18 12:41:17 +0300934 ubi_err("failed to attach mtd%d, error %d", mtd->index, err);
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +0300935 goto out_debugging;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400936 }
937
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200938 if (ubi->autoresize_vol_id != -1) {
939 err = autoresize(ubi, ubi->autoresize_vol_id);
940 if (err)
941 goto out_detach;
942 }
943
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200944 err = uif_init(ubi, &ref);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400945 if (err)
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200946 goto out_detach;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400947
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +0300948 err = ubi_debugfs_init_dev(ubi);
949 if (err)
950 goto out_uif;
951
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200952 ubi->bgt_thread = kthread_create(ubi_thread, ubi, ubi->bgt_name);
953 if (IS_ERR(ubi->bgt_thread)) {
954 err = PTR_ERR(ubi->bgt_thread);
955 ubi_err("cannot spawn \"%s\", error %d", ubi->bgt_name,
956 err);
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +0300957 goto out_debugfs;
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200958 }
959
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200960 ubi_msg("attached mtd%d to ubi%d", mtd->index, ubi_num);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200961 ubi_msg("MTD device name: \"%s\"", mtd->name);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400962 ubi_msg("MTD device size: %llu MiB", ubi->flash_size >> 20);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400963 ubi_msg("number of good PEBs: %d", ubi->good_peb_count);
964 ubi_msg("number of bad PEBs: %d", ubi->bad_peb_count);
Artem Bityutskiy5fc01ab2010-09-03 23:08:15 +0300965 ubi_msg("number of corrupted PEBs: %d", ubi->corr_peb_count);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400966 ubi_msg("max. allowed volumes: %d", ubi->vtbl_slots);
967 ubi_msg("wear-leveling threshold: %d", CONFIG_MTD_UBI_WL_THRESHOLD);
968 ubi_msg("number of internal volumes: %d", UBI_INT_VOL_COUNT);
969 ubi_msg("number of user volumes: %d",
970 ubi->vol_count - UBI_INT_VOL_COUNT);
971 ubi_msg("available PEBs: %d", ubi->avail_pebs);
972 ubi_msg("total number of reserved PEBs: %d", ubi->rsvd_pebs);
973 ubi_msg("number of PEBs reserved for bad PEB handling: %d",
974 ubi->beb_rsvd_pebs);
975 ubi_msg("max/mean erase counter: %d/%d", ubi->max_ec, ubi->mean_ec);
Artem Bityutskiy5739dd72012-08-22 16:28:18 +0300976 ubi_msg("image sequence number: %u", ubi->image_seq);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400977
Artem Bityutskiyddbd3b62009-05-23 13:44:09 +0300978 /*
979 * The below lock makes sure we do not race with 'ubi_thread()' which
980 * checks @ubi->thread_enabled. Otherwise we may fail to wake it up.
981 */
982 spin_lock(&ubi->wl_lock);
Artem Bityutskiy28237e42011-03-15 10:30:40 +0200983 ubi->thread_enabled = 1;
Artem Bityutskiyd37e6bf2008-07-24 18:28:11 +0300984 wake_up_process(ubi->bgt_thread);
Artem Bityutskiyddbd3b62009-05-23 13:44:09 +0300985 spin_unlock(&ubi->wl_lock);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400986
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200987 ubi_devices[ubi_num] = ubi;
Dmitry Pervushin0e0ee1c2009-04-29 19:29:38 +0400988 ubi_notify_all(ubi, UBI_VOLUME_ADDED, NULL);
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200989 return ubi_num;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400990
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +0300991out_debugfs:
992 ubi_debugfs_exit_dev(ubi);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200993out_uif:
Artem Bityutskiy01a41102011-05-18 18:08:05 +0300994 get_device(&ubi->dev);
995 ubi_assert(ref);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200996 uif_close(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400997out_detach:
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400998 ubi_wl_close(ubi);
Artem Bityutskiy47e1ec72012-05-18 12:41:17 +0300999 ubi_free_internal_volumes(ubi);
Vinit Agnihotrid7f0c4d2007-06-15 15:31:22 +05301000 vfree(ubi->vtbl);
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001001out_debugging:
1002 ubi_debugging_exit_dev(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001003out_free:
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +02001004 vfree(ubi->peb_buf);
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +02001005 if (ref)
1006 put_device(&ubi->dev);
1007 else
1008 kfree(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001009 return err;
1010}
1011
1012/**
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001013 * ubi_detach_mtd_dev - detach an MTD device.
1014 * @ubi_num: UBI device number to detach from
1015 * @anyway: detach MTD even if device reference count is not zero
1016 *
1017 * This function destroys an UBI device number @ubi_num and detaches the
1018 * underlying MTD device. Returns zero in case of success and %-EBUSY if the
1019 * UBI device is busy and cannot be destroyed, and %-EINVAL if it does not
1020 * exist.
1021 *
1022 * Note, the invocations of this function has to be serialized by the
1023 * @ubi_devices_mutex.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001024 */
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001025int ubi_detach_mtd_dev(int ubi_num, int anyway)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001026{
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001027 struct ubi_device *ubi;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001028
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001029 if (ubi_num < 0 || ubi_num >= UBI_MAX_DEVICES)
1030 return -EINVAL;
1031
Dmitry Pervushin0e0ee1c2009-04-29 19:29:38 +04001032 ubi = ubi_get_device(ubi_num);
1033 if (!ubi)
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001034 return -EINVAL;
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001035
Dmitry Pervushin0e0ee1c2009-04-29 19:29:38 +04001036 spin_lock(&ubi_devices_lock);
1037 put_device(&ubi->dev);
1038 ubi->ref_count -= 1;
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001039 if (ubi->ref_count) {
1040 if (!anyway) {
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001041 spin_unlock(&ubi_devices_lock);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001042 return -EBUSY;
1043 }
1044 /* This may only happen if there is a bug */
1045 ubi_err("%s reference count %d, destroy anyway",
1046 ubi->ubi_name, ubi->ref_count);
1047 }
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001048 ubi_devices[ubi_num] = NULL;
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001049 spin_unlock(&ubi_devices_lock);
1050
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001051 ubi_assert(ubi_num == ubi->ubi_num);
Dmitry Pervushin0e0ee1c2009-04-29 19:29:38 +04001052 ubi_notify_all(ubi, UBI_VOLUME_REMOVED, NULL);
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001053 dbg_msg("detaching mtd%d from ubi%d", ubi->mtd->index, ubi_num);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001054
1055 /*
1056 * Before freeing anything, we have to stop the background thread to
1057 * prevent it from doing anything on this device while we are freeing.
1058 */
1059 if (ubi->bgt_thread)
1060 kthread_stop(ubi->bgt_thread);
1061
Artem Bityutskiy36b477d2009-01-20 18:04:09 +02001062 /*
1063 * Get a reference to the device in order to prevent 'dev_release()'
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +02001064 * from freeing the @ubi object.
Artem Bityutskiy36b477d2009-01-20 18:04:09 +02001065 */
1066 get_device(&ubi->dev);
1067
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001068 ubi_debugfs_exit_dev(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001069 uif_close(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001070 ubi_wl_close(ubi);
Artem Bityutskiy47e1ec72012-05-18 12:41:17 +03001071 ubi_free_internal_volumes(ubi);
Artem Bityutskiy92ad8f32007-05-06 16:12:54 +03001072 vfree(ubi->vtbl);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001073 put_mtd_device(ubi->mtd);
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001074 ubi_debugging_exit_dev(ubi);
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +02001075 vfree(ubi->peb_buf);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001076 ubi_msg("mtd%d is detached from ubi%d", ubi->mtd->index, ubi->ubi_num);
Artem Bityutskiy36b477d2009-01-20 18:04:09 +02001077 put_device(&ubi->dev);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001078 return 0;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001079}
1080
Artem Bityutskiy3a8d4642007-12-16 12:32:51 +02001081/**
Artem Bityutskiyf9b00802010-01-05 16:48:40 +02001082 * open_mtd_by_chdev - open an MTD device by its character device node path.
1083 * @mtd_dev: MTD character device node path
1084 *
1085 * This helper function opens an MTD device by its character node device path.
1086 * Returns MTD device description object in case of success and a negative
1087 * error code in case of failure.
1088 */
1089static struct mtd_info * __init open_mtd_by_chdev(const char *mtd_dev)
1090{
1091 int err, major, minor, mode;
1092 struct path path;
1093
1094 /* Probably this is an MTD character device node path */
1095 err = kern_path(mtd_dev, LOOKUP_FOLLOW, &path);
1096 if (err)
1097 return ERR_PTR(err);
1098
1099 /* MTD device number is defined by the major / minor numbers */
1100 major = imajor(path.dentry->d_inode);
1101 minor = iminor(path.dentry->d_inode);
1102 mode = path.dentry->d_inode->i_mode;
1103 path_put(&path);
1104 if (major != MTD_CHAR_MAJOR || !S_ISCHR(mode))
1105 return ERR_PTR(-EINVAL);
1106
1107 if (minor & 1)
1108 /*
1109 * Just do not think the "/dev/mtdrX" devices support is need,
1110 * so do not support them to avoid doing extra work.
1111 */
1112 return ERR_PTR(-EINVAL);
1113
1114 return get_mtd_device(NULL, minor / 2);
1115}
1116
1117/**
1118 * open_mtd_device - open MTD device by name, character device path, or number.
1119 * @mtd_dev: name, character device node path, or MTD device device number
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001120 *
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001121 * This function tries to open and MTD device described by @mtd_dev string,
Artem Bityutskiyf9b00802010-01-05 16:48:40 +02001122 * which is first treated as ASCII MTD device number, and if it is not true, it
1123 * is treated as MTD device name, and if that is also not true, it is treated
1124 * as MTD character device node path. Returns MTD device description object in
1125 * case of success and a negative error code in case of failure.
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001126 */
1127static struct mtd_info * __init open_mtd_device(const char *mtd_dev)
1128{
1129 struct mtd_info *mtd;
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001130 int mtd_num;
1131 char *endp;
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001132
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001133 mtd_num = simple_strtoul(mtd_dev, &endp, 0);
1134 if (*endp != '\0' || mtd_dev == endp) {
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001135 /*
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001136 * This does not look like an ASCII integer, probably this is
1137 * MTD device name.
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001138 */
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001139 mtd = get_mtd_device_nm(mtd_dev);
Artem Bityutskiyf9b00802010-01-05 16:48:40 +02001140 if (IS_ERR(mtd) && PTR_ERR(mtd) == -ENODEV)
1141 /* Probably this is an MTD character device node path */
1142 mtd = open_mtd_by_chdev(mtd_dev);
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001143 } else
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001144 mtd = get_mtd_device(NULL, mtd_num);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001145
1146 return mtd;
1147}
1148
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001149static int __init ubi_init(void)
1150{
1151 int err, i, k;
1152
1153 /* Ensure that EC and VID headers have correct size */
1154 BUILD_BUG_ON(sizeof(struct ubi_ec_hdr) != 64);
1155 BUILD_BUG_ON(sizeof(struct ubi_vid_hdr) != 64);
1156
1157 if (mtd_devs > UBI_MAX_DEVICES) {
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001158 ubi_err("too many MTD devices, maximum is %d", UBI_MAX_DEVICES);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001159 return -EINVAL;
1160 }
1161
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001162 /* Create base sysfs directory and sysfs files */
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001163 ubi_class = class_create(THIS_MODULE, UBI_NAME_STR);
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001164 if (IS_ERR(ubi_class)) {
1165 err = PTR_ERR(ubi_class);
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001166 ubi_err("cannot create UBI class");
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001167 goto out;
1168 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001169
1170 err = class_create_file(ubi_class, &ubi_version);
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001171 if (err) {
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001172 ubi_err("cannot create sysfs file");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001173 goto out_class;
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001174 }
1175
1176 err = misc_register(&ubi_ctrl_cdev);
1177 if (err) {
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001178 ubi_err("cannot register device");
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001179 goto out_version;
1180 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001181
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +02001182 ubi_wl_entry_slab = kmem_cache_create("ubi_wl_entry_slab",
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001183 sizeof(struct ubi_wl_entry),
1184 0, 0, NULL);
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +02001185 if (!ubi_wl_entry_slab)
Artem Bityutskiyb9a06622008-01-16 12:11:54 +02001186 goto out_dev_unreg;
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +02001187
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001188 err = ubi_debugfs_init();
1189 if (err)
1190 goto out_slab;
1191
1192
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001193 /* Attach MTD devices */
1194 for (i = 0; i < mtd_devs; i++) {
1195 struct mtd_dev_param *p = &mtd_dev_param[i];
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001196 struct mtd_info *mtd;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001197
1198 cond_resched();
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001199
1200 mtd = open_mtd_device(p->name);
1201 if (IS_ERR(mtd)) {
1202 err = PTR_ERR(mtd);
1203 goto out_detach;
1204 }
1205
1206 mutex_lock(&ubi_devices_mutex);
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001207 err = ubi_attach_mtd_dev(mtd, UBI_DEV_NUM_AUTO,
1208 p->vid_hdr_offs);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001209 mutex_unlock(&ubi_devices_mutex);
1210 if (err < 0) {
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001211 ubi_err("cannot attach mtd%d", mtd->index);
Marc Kleine-Buddeaf7ad7a2010-05-05 10:17:25 +02001212 put_mtd_device(mtd);
1213
1214 /*
1215 * Originally UBI stopped initializing on any error.
1216 * However, later on it was found out that this
1217 * behavior is not very good when UBI is compiled into
1218 * the kernel and the MTD devices to attach are passed
1219 * through the command line. Indeed, UBI failure
1220 * stopped whole boot sequence.
1221 *
1222 * To fix this, we changed the behavior for the
1223 * non-module case, but preserved the old behavior for
1224 * the module case, just for compatibility. This is a
1225 * little inconsistent, though.
1226 */
1227 if (ubi_is_module())
1228 goto out_detach;
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001229 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001230 }
1231
1232 return 0;
1233
1234out_detach:
1235 for (k = 0; k < i; k++)
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001236 if (ubi_devices[k]) {
1237 mutex_lock(&ubi_devices_mutex);
1238 ubi_detach_mtd_dev(ubi_devices[k]->ubi_num, 1);
1239 mutex_unlock(&ubi_devices_mutex);
1240 }
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001241 ubi_debugfs_exit();
1242out_slab:
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +02001243 kmem_cache_destroy(ubi_wl_entry_slab);
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001244out_dev_unreg:
1245 misc_deregister(&ubi_ctrl_cdev);
Artem Bityutskiy3a8d4642007-12-16 12:32:51 +02001246out_version:
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001247 class_remove_file(ubi_class, &ubi_version);
1248out_class:
1249 class_destroy(ubi_class);
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001250out:
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001251 ubi_err("UBI error: cannot initialize UBI, error %d", err);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001252 return err;
1253}
1254module_init(ubi_init);
1255
1256static void __exit ubi_exit(void)
1257{
Artem Bityutskiyb96bf4c2007-12-16 13:01:03 +02001258 int i;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001259
Artem Bityutskiyb96bf4c2007-12-16 13:01:03 +02001260 for (i = 0; i < UBI_MAX_DEVICES; i++)
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001261 if (ubi_devices[i]) {
1262 mutex_lock(&ubi_devices_mutex);
1263 ubi_detach_mtd_dev(ubi_devices[i]->ubi_num, 1);
1264 mutex_unlock(&ubi_devices_mutex);
1265 }
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001266 ubi_debugfs_exit();
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +02001267 kmem_cache_destroy(ubi_wl_entry_slab);
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001268 misc_deregister(&ubi_ctrl_cdev);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001269 class_remove_file(ubi_class, &ubi_version);
1270 class_destroy(ubi_class);
1271}
1272module_exit(ubi_exit);
1273
1274/**
Artem Bityutskiyebaaf1a2008-07-18 13:34:32 +03001275 * bytes_str_to_int - convert a number of bytes string into an integer.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001276 * @str: the string to convert
1277 *
1278 * This function returns positive resulting integer in case of success and a
1279 * negative error code in case of failure.
1280 */
1281static int __init bytes_str_to_int(const char *str)
1282{
1283 char *endp;
1284 unsigned long result;
1285
1286 result = simple_strtoul(str, &endp, 0);
Roel Kluin774b1382009-10-16 14:00:17 +02001287 if (str == endp || result >= INT_MAX) {
Artem Bityutskiy458dbb32007-12-19 17:03:42 +02001288 printk(KERN_ERR "UBI error: incorrect bytes count: \"%s\"\n",
1289 str);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001290 return -EINVAL;
1291 }
1292
1293 switch (*endp) {
1294 case 'G':
1295 result *= 1024;
1296 case 'M':
1297 result *= 1024;
1298 case 'K':
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001299 result *= 1024;
Artem Bityutskiyaeddb872007-12-26 14:25:58 +02001300 if (endp[1] == 'i' && endp[2] == 'B')
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001301 endp += 2;
1302 case '\0':
1303 break;
1304 default:
Artem Bityutskiy458dbb32007-12-19 17:03:42 +02001305 printk(KERN_ERR "UBI error: incorrect bytes count: \"%s\"\n",
1306 str);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001307 return -EINVAL;
1308 }
1309
1310 return result;
1311}
1312
1313/**
1314 * ubi_mtd_param_parse - parse the 'mtd=' UBI parameter.
1315 * @val: the parameter value to parse
1316 * @kp: not used
1317 *
1318 * This function returns zero in case of success and a negative error code in
1319 * case of error.
1320 */
1321static int __init ubi_mtd_param_parse(const char *val, struct kernel_param *kp)
1322{
1323 int i, len;
1324 struct mtd_dev_param *p;
1325 char buf[MTD_PARAM_LEN_MAX];
1326 char *pbuf = &buf[0];
Artem Bityutskiyddc49392008-01-17 15:35:57 +02001327 char *tokens[2] = {NULL, NULL};
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001328
Artem Bityutskiy77c722d2007-12-16 16:46:57 +02001329 if (!val)
1330 return -EINVAL;
1331
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001332 if (mtd_devs == UBI_MAX_DEVICES) {
Artem Bityutskiy458dbb32007-12-19 17:03:42 +02001333 printk(KERN_ERR "UBI error: too many parameters, max. is %d\n",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001334 UBI_MAX_DEVICES);
1335 return -EINVAL;
1336 }
1337
1338 len = strnlen(val, MTD_PARAM_LEN_MAX);
1339 if (len == MTD_PARAM_LEN_MAX) {
Artem Bityutskiy458dbb32007-12-19 17:03:42 +02001340 printk(KERN_ERR "UBI error: parameter \"%s\" is too long, "
1341 "max. is %d\n", val, MTD_PARAM_LEN_MAX);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001342 return -EINVAL;
1343 }
1344
1345 if (len == 0) {
Artem Bityutskiy458dbb32007-12-19 17:03:42 +02001346 printk(KERN_WARNING "UBI warning: empty 'mtd=' parameter - "
1347 "ignored\n");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001348 return 0;
1349 }
1350
1351 strcpy(buf, val);
1352
1353 /* Get rid of the final newline */
1354 if (buf[len - 1] == '\n')
Artem Bityutskiy503990e2007-07-11 16:03:29 +03001355 buf[len - 1] = '\0';
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001356
Artem Bityutskiyddc49392008-01-17 15:35:57 +02001357 for (i = 0; i < 2; i++)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001358 tokens[i] = strsep(&pbuf, ",");
1359
1360 if (pbuf) {
Artem Bityutskiy458dbb32007-12-19 17:03:42 +02001361 printk(KERN_ERR "UBI error: too many arguments at \"%s\"\n",
1362 val);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001363 return -EINVAL;
1364 }
1365
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001366 p = &mtd_dev_param[mtd_devs];
1367 strcpy(&p->name[0], tokens[0]);
1368
1369 if (tokens[1])
1370 p->vid_hdr_offs = bytes_str_to_int(tokens[1]);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001371
1372 if (p->vid_hdr_offs < 0)
1373 return p->vid_hdr_offs;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001374
1375 mtd_devs += 1;
1376 return 0;
1377}
1378
1379module_param_call(mtd, ubi_mtd_param_parse, NULL, NULL, 000);
1380MODULE_PARM_DESC(mtd, "MTD devices to attach. Parameter format: "
Artem Bityutskiyf9b00802010-01-05 16:48:40 +02001381 "mtd=<name|num|path>[,<vid_hdr_offs>].\n"
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001382 "Multiple \"mtd\" parameters may be specified.\n"
Artem Bityutskiyf9b00802010-01-05 16:48:40 +02001383 "MTD devices may be specified by their number, name, or "
1384 "path to the MTD character device node.\n"
Artem Bityutskiydd38fcc2007-12-19 21:43:32 +02001385 "Optional \"vid_hdr_offs\" parameter specifies UBI VID "
Artem Bityutskiyf9b00802010-01-05 16:48:40 +02001386 "header position to be used by UBI.\n"
1387 "Example 1: mtd=/dev/mtd0 - attach MTD device "
1388 "/dev/mtd0.\n"
1389 "Example 2: mtd=content,1984 mtd=4 - attach MTD device "
Artem Bityutskiydd38fcc2007-12-19 21:43:32 +02001390 "with name \"content\" using VID header offset 1984, and "
1391 "MTD device number 4 with default VID header offset.");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001392
1393MODULE_VERSION(__stringify(UBI_VERSION));
1394MODULE_DESCRIPTION("UBI - Unsorted Block Images");
1395MODULE_AUTHOR("Artem Bityutskiy");
1396MODULE_LICENSE("GPL");