blob: 8a4eb7c3e0f40b2220722312dda1550356d86396 [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
Richard Genoud5993f9b2012-08-17 16:35:19 +020049/* Maximum number of comma-separated items in the 'mtd=' parameter */
50#define MTD_PARAM_MAX_COUNT 2
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 Bityutskiy47e1ec72012-05-18 12:41:17 +0300557 * ubi_free_internal_volumes - free internal volumes.
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300558 * @ubi: UBI device description object
559 */
Artem Bityutskiy47e1ec72012-05-18 12:41:17 +0300560void ubi_free_internal_volumes(struct ubi_device *ubi)
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300561{
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
Richard Genoud95e6fb02012-08-17 16:35:18 +0200571static int get_bad_peb_limit(const struct ubi_device *ubi, int max_beb_per1024)
572{
573 int limit, device_pebs;
574 uint64_t device_size;
575
576 if (!max_beb_per1024)
577 return 0;
578
579 /*
580 * Here we are using size of the entire flash chip and
581 * not just the MTD partition size because the maximum
582 * number of bad eraseblocks is a percentage of the
583 * whole device and bad eraseblocks are not fairly
584 * distributed over the flash chip. So the worst case
585 * is that all the bad eraseblocks of the chip are in
586 * the MTD partition we are attaching (ubi->mtd).
587 */
588 device_size = mtd_get_device_size(ubi->mtd);
589 device_pebs = mtd_div_by_eb(device_size, ubi->mtd);
590 limit = mult_frac(device_pebs, max_beb_per1024, 1024);
591
592 /* Round it up */
593 if (mult_frac(limit, 1024, max_beb_per1024) < device_pebs)
594 limit += 1;
595
596 return limit;
597}
598
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300599/**
Artem Bityutskiy85c6e6e2008-07-16 10:25:56 +0300600 * io_init - initialize I/O sub-system for a given UBI device.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400601 * @ubi: UBI device description object
Richard Genoud256334c2012-08-20 18:00:11 +0200602 * @max_beb_per1024: maximum expected number of bad PEB per 1024 PEBs
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400603 *
604 * If @ubi->vid_hdr_offset or @ubi->leb_start is zero, default offsets are
605 * assumed:
606 * o EC header is always at offset zero - this cannot be changed;
607 * o VID header starts just after the EC header at the closest address
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200608 * aligned to @io->hdrs_min_io_size;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400609 * o data starts just after the VID header at the closest address aligned to
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200610 * @io->min_io_size
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400611 *
612 * This function returns zero in case of success and a negative error code in
613 * case of failure.
614 */
Richard Genoud256334c2012-08-20 18:00:11 +0200615static int io_init(struct ubi_device *ubi, int max_beb_per1024)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400616{
617 if (ubi->mtd->numeraseregions != 0) {
618 /*
619 * Some flashes have several erase regions. Different regions
620 * may have different eraseblock size and other
621 * characteristics. It looks like mostly multi-region flashes
622 * have one "main" region and one or more small regions to
623 * store boot loader code or boot parameters or whatever. I
624 * guess we should just pick the largest region. But this is
625 * not implemented.
626 */
627 ubi_err("multiple regions, not implemented");
628 return -EINVAL;
629 }
630
Artem Bityutskiydd38fcc2007-12-19 21:43:32 +0200631 if (ubi->vid_hdr_offset < 0)
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200632 return -EINVAL;
633
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400634 /*
635 * Note, in this implementation we support MTD devices with 0x7FFFFFFF
636 * physical eraseblocks maximum.
637 */
638
639 ubi->peb_size = ubi->mtd->erasesize;
Adrian Hunter69423d92008-12-10 13:37:21 +0000640 ubi->peb_count = mtd_div_by_eb(ubi->mtd->size, ubi->mtd);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400641 ubi->flash_size = ubi->mtd->size;
642
Shmulik Ladkani8beeb3b2012-07-04 11:06:00 +0300643 if (mtd_can_have_bb(ubi->mtd)) {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400644 ubi->bad_allowed = 1;
Richard Genoud95e6fb02012-08-17 16:35:18 +0200645 ubi->bad_peb_limit = get_bad_peb_limit(ubi, max_beb_per1024);
Shmulik Ladkani8beeb3b2012-07-04 11:06:00 +0300646 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400647
Artem Bityutskiyebf53f42009-07-06 08:57:53 +0300648 if (ubi->mtd->type == MTD_NORFLASH) {
649 ubi_assert(ubi->mtd->writesize == 1);
650 ubi->nor_flash = 1;
651 }
652
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400653 ubi->min_io_size = ubi->mtd->writesize;
654 ubi->hdrs_min_io_size = ubi->mtd->writesize >> ubi->mtd->subpage_sft;
655
Kyungmin Parkcadb40c2008-05-22 10:32:18 +0900656 /*
657 * Make sure minimal I/O unit is power of 2. Note, there is no
658 * fundamental reason for this assumption. It is just an optimization
659 * which allows us to avoid costly division operations.
660 */
Vignesh Babu7753f162007-06-12 10:31:05 +0530661 if (!is_power_of_2(ubi->min_io_size)) {
Artem Bityutskiy01f7b302007-12-15 19:56:51 +0200662 ubi_err("min. I/O unit (%d) is not power of 2",
663 ubi->min_io_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400664 return -EINVAL;
665 }
666
667 ubi_assert(ubi->hdrs_min_io_size > 0);
668 ubi_assert(ubi->hdrs_min_io_size <= ubi->min_io_size);
669 ubi_assert(ubi->min_io_size % ubi->hdrs_min_io_size == 0);
670
Artem Bityutskiy30b542e2011-01-30 18:37:33 +0200671 ubi->max_write_size = ubi->mtd->writebufsize;
672 /*
673 * Maximum write size has to be greater or equivalent to min. I/O
674 * size, and be multiple of min. I/O size.
675 */
676 if (ubi->max_write_size < ubi->min_io_size ||
677 ubi->max_write_size % ubi->min_io_size ||
678 !is_power_of_2(ubi->max_write_size)) {
679 ubi_err("bad write buffer size %d for %d min. I/O unit",
680 ubi->max_write_size, ubi->min_io_size);
681 return -EINVAL;
682 }
683
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400684 /* Calculate default aligned sizes of EC and VID headers */
685 ubi->ec_hdr_alsize = ALIGN(UBI_EC_HDR_SIZE, ubi->hdrs_min_io_size);
686 ubi->vid_hdr_alsize = ALIGN(UBI_VID_HDR_SIZE, ubi->hdrs_min_io_size);
687
688 dbg_msg("min_io_size %d", ubi->min_io_size);
Artem Bityutskiy30b542e2011-01-30 18:37:33 +0200689 dbg_msg("max_write_size %d", ubi->max_write_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400690 dbg_msg("hdrs_min_io_size %d", ubi->hdrs_min_io_size);
691 dbg_msg("ec_hdr_alsize %d", ubi->ec_hdr_alsize);
692 dbg_msg("vid_hdr_alsize %d", ubi->vid_hdr_alsize);
693
694 if (ubi->vid_hdr_offset == 0)
695 /* Default offset */
696 ubi->vid_hdr_offset = ubi->vid_hdr_aloffset =
697 ubi->ec_hdr_alsize;
698 else {
699 ubi->vid_hdr_aloffset = ubi->vid_hdr_offset &
700 ~(ubi->hdrs_min_io_size - 1);
701 ubi->vid_hdr_shift = ubi->vid_hdr_offset -
702 ubi->vid_hdr_aloffset;
703 }
704
705 /* Similar for the data offset */
John Ognesse8cfe002011-01-21 15:39:02 +0100706 ubi->leb_start = ubi->vid_hdr_offset + UBI_VID_HDR_SIZE;
Artem Bityutskiydd38fcc2007-12-19 21:43:32 +0200707 ubi->leb_start = ALIGN(ubi->leb_start, ubi->min_io_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400708
709 dbg_msg("vid_hdr_offset %d", ubi->vid_hdr_offset);
710 dbg_msg("vid_hdr_aloffset %d", ubi->vid_hdr_aloffset);
711 dbg_msg("vid_hdr_shift %d", ubi->vid_hdr_shift);
712 dbg_msg("leb_start %d", ubi->leb_start);
713
714 /* The shift must be aligned to 32-bit boundary */
715 if (ubi->vid_hdr_shift % 4) {
716 ubi_err("unaligned VID header shift %d",
717 ubi->vid_hdr_shift);
718 return -EINVAL;
719 }
720
721 /* Check sanity */
722 if (ubi->vid_hdr_offset < UBI_EC_HDR_SIZE ||
723 ubi->leb_start < ubi->vid_hdr_offset + UBI_VID_HDR_SIZE ||
724 ubi->leb_start > ubi->peb_size - UBI_VID_HDR_SIZE ||
Kyungmin Parkcadb40c2008-05-22 10:32:18 +0900725 ubi->leb_start & (ubi->min_io_size - 1)) {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400726 ubi_err("bad VID header (%d) or data offsets (%d)",
727 ubi->vid_hdr_offset, ubi->leb_start);
728 return -EINVAL;
729 }
730
731 /*
Artem Bityutskiyb86a2c52009-05-24 14:13:34 +0300732 * Set maximum amount of physical erroneous eraseblocks to be 10%.
733 * Erroneous PEB are those which have read errors.
734 */
735 ubi->max_erroneous = ubi->peb_count / 10;
736 if (ubi->max_erroneous < 16)
737 ubi->max_erroneous = 16;
738 dbg_msg("max_erroneous %d", ubi->max_erroneous);
739
740 /*
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400741 * It may happen that EC and VID headers are situated in one minimal
742 * I/O unit. In this case we can only accept this UBI image in
743 * read-only mode.
744 */
745 if (ubi->vid_hdr_offset + UBI_VID_HDR_SIZE <= ubi->hdrs_min_io_size) {
746 ubi_warn("EC and VID headers are in the same minimal I/O unit, "
747 "switch to read-only mode");
748 ubi->ro_mode = 1;
749 }
750
751 ubi->leb_size = ubi->peb_size - ubi->leb_start;
752
753 if (!(ubi->mtd->flags & MTD_WRITEABLE)) {
754 ubi_msg("MTD device %d is write-protected, attach in "
755 "read-only mode", ubi->mtd->index);
756 ubi->ro_mode = 1;
757 }
758
Artem Bityutskiy434b8252008-04-20 18:00:33 +0300759 ubi_msg("physical eraseblock size: %d bytes (%d KiB)",
760 ubi->peb_size, ubi->peb_size >> 10);
761 ubi_msg("logical eraseblock size: %d bytes", ubi->leb_size);
762 ubi_msg("smallest flash I/O unit: %d", ubi->min_io_size);
763 if (ubi->hdrs_min_io_size != ubi->min_io_size)
764 ubi_msg("sub-page size: %d",
765 ubi->hdrs_min_io_size);
766 ubi_msg("VID header offset: %d (aligned %d)",
767 ubi->vid_hdr_offset, ubi->vid_hdr_aloffset);
768 ubi_msg("data offset: %d", ubi->leb_start);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400769
770 /*
Artem Bityutskiyfbd01072012-05-17 16:12:26 +0300771 * Note, ideally, we have to initialize @ubi->bad_peb_count here. But
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400772 * unfortunately, MTD does not provide this information. We should loop
773 * over all physical eraseblocks and invoke mtd->block_is_bad() for
Artem Bityutskiyfbd01072012-05-17 16:12:26 +0300774 * each physical eraseblock. So, we leave @ubi->bad_peb_count
775 * uninitialized so far.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400776 */
777
778 return 0;
779}
780
781/**
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200782 * autoresize - re-size the volume which has the "auto-resize" flag set.
783 * @ubi: UBI device description object
784 * @vol_id: ID of the volume to re-size
785 *
Artem Bityutskiyfbd01072012-05-17 16:12:26 +0300786 * This function re-sizes the volume marked by the %UBI_VTBL_AUTORESIZE_FLG in
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200787 * the volume table to the largest possible size. See comments in ubi-header.h
788 * for more description of the flag. Returns zero in case of success and a
789 * negative error code in case of failure.
790 */
791static int autoresize(struct ubi_device *ubi, int vol_id)
792{
793 struct ubi_volume_desc desc;
794 struct ubi_volume *vol = ubi->volumes[vol_id];
795 int err, old_reserved_pebs = vol->reserved_pebs;
796
797 /*
798 * Clear the auto-resize flag in the volume in-memory copy of the
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300799 * volume table, and 'ubi_resize_volume()' will propagate this change
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200800 * to the flash.
801 */
802 ubi->vtbl[vol_id].flags &= ~UBI_VTBL_AUTORESIZE_FLG;
803
804 if (ubi->avail_pebs == 0) {
805 struct ubi_vtbl_record vtbl_rec;
806
807 /*
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300808 * No available PEBs to re-size the volume, clear the flag on
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200809 * flash and exit.
810 */
811 memcpy(&vtbl_rec, &ubi->vtbl[vol_id],
812 sizeof(struct ubi_vtbl_record));
813 err = ubi_change_vtbl_record(ubi, vol_id, &vtbl_rec);
814 if (err)
815 ubi_err("cannot clean auto-resize flag for volume %d",
816 vol_id);
817 } else {
818 desc.vol = vol;
819 err = ubi_resize_volume(&desc,
820 old_reserved_pebs + ubi->avail_pebs);
821 if (err)
822 ubi_err("cannot auto-resize volume %d", vol_id);
823 }
824
825 if (err)
826 return err;
827
828 ubi_msg("volume %d (\"%s\") re-sized from %d to %d LEBs", vol_id,
829 vol->name, old_reserved_pebs, vol->reserved_pebs);
830 return 0;
831}
832
833/**
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200834 * ubi_attach_mtd_dev - attach an MTD device.
Artem Bityutskiyebaaf1a2008-07-18 13:34:32 +0300835 * @mtd: MTD device description object
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200836 * @ubi_num: number to assign to the new UBI device
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400837 * @vid_hdr_offset: VID header offset
Richard Genoud256334c2012-08-20 18:00:11 +0200838 * @max_beb_per1024: maximum number of expected bad blocks per 1024 PEBs
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400839 *
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200840 * This function attaches MTD device @mtd_dev to UBI and assign @ubi_num number
841 * to the newly created UBI device, unless @ubi_num is %UBI_DEV_NUM_AUTO, in
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300842 * which case this function finds a vacant device number and assigns it
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200843 * automatically. Returns the new UBI device number in case of success and a
844 * negative error code in case of failure.
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200845 *
846 * Note, the invocations of this function has to be serialized by the
847 * @ubi_devices_mutex.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400848 */
Richard Genoud256334c2012-08-20 18:00:11 +0200849int ubi_attach_mtd_dev(struct mtd_info *mtd, int ubi_num,
850 int vid_hdr_offset, int max_beb_per1024)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400851{
852 struct ubi_device *ubi;
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200853 int i, err, ref = 0;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400854
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200855 /*
856 * Check if we already have the same MTD device attached.
857 *
858 * Note, this function assumes that UBI devices creations and deletions
859 * are serialized, so it does not take the &ubi_devices_lock.
860 */
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200861 for (i = 0; i < UBI_MAX_DEVICES; i++) {
Artem Bityutskiyb96bf4c2007-12-16 13:01:03 +0200862 ubi = ubi_devices[i];
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200863 if (ubi && mtd->index == ubi->mtd->index) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300864 ubi_err("mtd%d is already attached to ubi%d",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400865 mtd->index, i);
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200866 return -EEXIST;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400867 }
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200868 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400869
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200870 /*
871 * Make sure this MTD device is not emulated on top of an UBI volume
872 * already. Well, generally this recursion works fine, but there are
873 * different problems like the UBI module takes a reference to itself
874 * by attaching (and thus, opening) the emulated MTD device. This
875 * results in inability to unload the module. And in general it makes
876 * no sense to attach emulated MTD devices, so we prohibit this.
877 */
878 if (mtd->type == MTD_UBIVOLUME) {
879 ubi_err("refuse attaching mtd%d - it is already emulated on "
880 "top of UBI", mtd->index);
881 return -EINVAL;
882 }
Artem Bityutskiyb96bf4c2007-12-16 13:01:03 +0200883
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200884 if (ubi_num == UBI_DEV_NUM_AUTO) {
885 /* Search for an empty slot in the @ubi_devices array */
886 for (ubi_num = 0; ubi_num < UBI_MAX_DEVICES; ubi_num++)
887 if (!ubi_devices[ubi_num])
888 break;
889 if (ubi_num == UBI_MAX_DEVICES) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300890 ubi_err("only %d UBI devices may be created",
Artem Bityutskiy9c9ec142008-07-18 13:19:52 +0300891 UBI_MAX_DEVICES);
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200892 return -ENFILE;
893 }
894 } else {
895 if (ubi_num >= UBI_MAX_DEVICES)
896 return -EINVAL;
897
898 /* Make sure ubi_num is not busy */
899 if (ubi_devices[ubi_num]) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300900 ubi_err("ubi%d already exists", ubi_num);
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200901 return -EEXIST;
902 }
Artem Bityutskiyb96bf4c2007-12-16 13:01:03 +0200903 }
904
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200905 ubi = kzalloc(sizeof(struct ubi_device), GFP_KERNEL);
906 if (!ubi)
907 return -ENOMEM;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400908
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200909 ubi->mtd = mtd;
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200910 ubi->ubi_num = ubi_num;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400911 ubi->vid_hdr_offset = vid_hdr_offset;
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200912 ubi->autoresize_vol_id = -1;
913
914 mutex_init(&ubi->buf_mutex);
915 mutex_init(&ubi->ckvol_mutex);
Artem Bityutskiyf089c0b2009-05-07 11:46:49 +0300916 mutex_init(&ubi->device_mutex);
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200917 spin_lock_init(&ubi->volumes_lock);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200918
Artem Bityutskiy697fa972008-04-23 13:43:21 +0300919 ubi_msg("attaching mtd%d to ubi%d", mtd->index, ubi_num);
Artem Bityutskiy227423d2012-05-17 06:23:22 +0300920 dbg_msg("sizeof(struct ubi_ainf_peb) %zu", sizeof(struct ubi_ainf_peb));
Artem Bityutskiy6c1e8752010-10-31 17:54:14 +0200921 dbg_msg("sizeof(struct ubi_wl_entry) %zu", sizeof(struct ubi_wl_entry));
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200922
Richard Genoud256334c2012-08-20 18:00:11 +0200923 err = io_init(ubi, max_beb_per1024);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400924 if (err)
925 goto out_free;
926
Stefan Roesead5942b2008-12-10 10:42:54 +0100927 err = -ENOMEM;
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +0200928 ubi->peb_buf = vmalloc(ubi->peb_size);
929 if (!ubi->peb_buf)
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300930 goto out_free;
931
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +0300932 err = ubi_debugging_init_dev(ubi);
933 if (err)
934 goto out_free;
935
Artem Bityutskiy47e1ec72012-05-18 12:41:17 +0300936 err = ubi_attach(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400937 if (err) {
Artem Bityutskiy47e1ec72012-05-18 12:41:17 +0300938 ubi_err("failed to attach mtd%d, error %d", mtd->index, err);
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +0300939 goto out_debugging;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400940 }
941
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200942 if (ubi->autoresize_vol_id != -1) {
943 err = autoresize(ubi, ubi->autoresize_vol_id);
944 if (err)
945 goto out_detach;
946 }
947
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200948 err = uif_init(ubi, &ref);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400949 if (err)
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200950 goto out_detach;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400951
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +0300952 err = ubi_debugfs_init_dev(ubi);
953 if (err)
954 goto out_uif;
955
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200956 ubi->bgt_thread = kthread_create(ubi_thread, ubi, ubi->bgt_name);
957 if (IS_ERR(ubi->bgt_thread)) {
958 err = PTR_ERR(ubi->bgt_thread);
959 ubi_err("cannot spawn \"%s\", error %d", ubi->bgt_name,
960 err);
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +0300961 goto out_debugfs;
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200962 }
963
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200964 ubi_msg("attached mtd%d to ubi%d", mtd->index, ubi_num);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200965 ubi_msg("MTD device name: \"%s\"", mtd->name);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400966 ubi_msg("MTD device size: %llu MiB", ubi->flash_size >> 20);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400967 ubi_msg("number of good PEBs: %d", ubi->good_peb_count);
968 ubi_msg("number of bad PEBs: %d", ubi->bad_peb_count);
Artem Bityutskiy5fc01ab2010-09-03 23:08:15 +0300969 ubi_msg("number of corrupted PEBs: %d", ubi->corr_peb_count);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400970 ubi_msg("max. allowed volumes: %d", ubi->vtbl_slots);
971 ubi_msg("wear-leveling threshold: %d", CONFIG_MTD_UBI_WL_THRESHOLD);
972 ubi_msg("number of internal volumes: %d", UBI_INT_VOL_COUNT);
973 ubi_msg("number of user volumes: %d",
974 ubi->vol_count - UBI_INT_VOL_COUNT);
975 ubi_msg("available PEBs: %d", ubi->avail_pebs);
976 ubi_msg("total number of reserved PEBs: %d", ubi->rsvd_pebs);
977 ubi_msg("number of PEBs reserved for bad PEB handling: %d",
978 ubi->beb_rsvd_pebs);
979 ubi_msg("max/mean erase counter: %d/%d", ubi->max_ec, ubi->mean_ec);
Artem Bityutskiy5739dd72012-08-22 16:28:18 +0300980 ubi_msg("image sequence number: %u", ubi->image_seq);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400981
Artem Bityutskiyddbd3b62009-05-23 13:44:09 +0300982 /*
983 * The below lock makes sure we do not race with 'ubi_thread()' which
984 * checks @ubi->thread_enabled. Otherwise we may fail to wake it up.
985 */
986 spin_lock(&ubi->wl_lock);
Artem Bityutskiy28237e42011-03-15 10:30:40 +0200987 ubi->thread_enabled = 1;
Artem Bityutskiyd37e6bf2008-07-24 18:28:11 +0300988 wake_up_process(ubi->bgt_thread);
Artem Bityutskiyddbd3b62009-05-23 13:44:09 +0300989 spin_unlock(&ubi->wl_lock);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400990
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200991 ubi_devices[ubi_num] = ubi;
Dmitry Pervushin0e0ee1c2009-04-29 19:29:38 +0400992 ubi_notify_all(ubi, UBI_VOLUME_ADDED, NULL);
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200993 return ubi_num;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400994
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +0300995out_debugfs:
996 ubi_debugfs_exit_dev(ubi);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200997out_uif:
Artem Bityutskiy01a41102011-05-18 18:08:05 +0300998 get_device(&ubi->dev);
999 ubi_assert(ref);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001000 uif_close(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001001out_detach:
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001002 ubi_wl_close(ubi);
Artem Bityutskiy47e1ec72012-05-18 12:41:17 +03001003 ubi_free_internal_volumes(ubi);
Vinit Agnihotrid7f0c4d2007-06-15 15:31:22 +05301004 vfree(ubi->vtbl);
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001005out_debugging:
1006 ubi_debugging_exit_dev(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001007out_free:
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +02001008 vfree(ubi->peb_buf);
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +02001009 if (ref)
1010 put_device(&ubi->dev);
1011 else
1012 kfree(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001013 return err;
1014}
1015
1016/**
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001017 * ubi_detach_mtd_dev - detach an MTD device.
1018 * @ubi_num: UBI device number to detach from
1019 * @anyway: detach MTD even if device reference count is not zero
1020 *
1021 * This function destroys an UBI device number @ubi_num and detaches the
1022 * underlying MTD device. Returns zero in case of success and %-EBUSY if the
1023 * UBI device is busy and cannot be destroyed, and %-EINVAL if it does not
1024 * exist.
1025 *
1026 * Note, the invocations of this function has to be serialized by the
1027 * @ubi_devices_mutex.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001028 */
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001029int ubi_detach_mtd_dev(int ubi_num, int anyway)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001030{
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001031 struct ubi_device *ubi;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001032
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001033 if (ubi_num < 0 || ubi_num >= UBI_MAX_DEVICES)
1034 return -EINVAL;
1035
Dmitry Pervushin0e0ee1c2009-04-29 19:29:38 +04001036 ubi = ubi_get_device(ubi_num);
1037 if (!ubi)
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001038 return -EINVAL;
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001039
Dmitry Pervushin0e0ee1c2009-04-29 19:29:38 +04001040 spin_lock(&ubi_devices_lock);
1041 put_device(&ubi->dev);
1042 ubi->ref_count -= 1;
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001043 if (ubi->ref_count) {
1044 if (!anyway) {
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001045 spin_unlock(&ubi_devices_lock);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001046 return -EBUSY;
1047 }
1048 /* This may only happen if there is a bug */
1049 ubi_err("%s reference count %d, destroy anyway",
1050 ubi->ubi_name, ubi->ref_count);
1051 }
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001052 ubi_devices[ubi_num] = NULL;
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001053 spin_unlock(&ubi_devices_lock);
1054
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001055 ubi_assert(ubi_num == ubi->ubi_num);
Dmitry Pervushin0e0ee1c2009-04-29 19:29:38 +04001056 ubi_notify_all(ubi, UBI_VOLUME_REMOVED, NULL);
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001057 dbg_msg("detaching mtd%d from ubi%d", ubi->mtd->index, ubi_num);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001058
1059 /*
1060 * Before freeing anything, we have to stop the background thread to
1061 * prevent it from doing anything on this device while we are freeing.
1062 */
1063 if (ubi->bgt_thread)
1064 kthread_stop(ubi->bgt_thread);
1065
Artem Bityutskiy36b477d2009-01-20 18:04:09 +02001066 /*
1067 * Get a reference to the device in order to prevent 'dev_release()'
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +02001068 * from freeing the @ubi object.
Artem Bityutskiy36b477d2009-01-20 18:04:09 +02001069 */
1070 get_device(&ubi->dev);
1071
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001072 ubi_debugfs_exit_dev(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001073 uif_close(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001074 ubi_wl_close(ubi);
Artem Bityutskiy47e1ec72012-05-18 12:41:17 +03001075 ubi_free_internal_volumes(ubi);
Artem Bityutskiy92ad8f32007-05-06 16:12:54 +03001076 vfree(ubi->vtbl);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001077 put_mtd_device(ubi->mtd);
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001078 ubi_debugging_exit_dev(ubi);
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +02001079 vfree(ubi->peb_buf);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001080 ubi_msg("mtd%d is detached from ubi%d", ubi->mtd->index, ubi->ubi_num);
Artem Bityutskiy36b477d2009-01-20 18:04:09 +02001081 put_device(&ubi->dev);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001082 return 0;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001083}
1084
Artem Bityutskiy3a8d4642007-12-16 12:32:51 +02001085/**
Artem Bityutskiyf9b00802010-01-05 16:48:40 +02001086 * open_mtd_by_chdev - open an MTD device by its character device node path.
1087 * @mtd_dev: MTD character device node path
1088 *
1089 * This helper function opens an MTD device by its character node device path.
1090 * Returns MTD device description object in case of success and a negative
1091 * error code in case of failure.
1092 */
1093static struct mtd_info * __init open_mtd_by_chdev(const char *mtd_dev)
1094{
1095 int err, major, minor, mode;
1096 struct path path;
1097
1098 /* Probably this is an MTD character device node path */
1099 err = kern_path(mtd_dev, LOOKUP_FOLLOW, &path);
1100 if (err)
1101 return ERR_PTR(err);
1102
1103 /* MTD device number is defined by the major / minor numbers */
1104 major = imajor(path.dentry->d_inode);
1105 minor = iminor(path.dentry->d_inode);
1106 mode = path.dentry->d_inode->i_mode;
1107 path_put(&path);
1108 if (major != MTD_CHAR_MAJOR || !S_ISCHR(mode))
1109 return ERR_PTR(-EINVAL);
1110
1111 if (minor & 1)
1112 /*
1113 * Just do not think the "/dev/mtdrX" devices support is need,
1114 * so do not support them to avoid doing extra work.
1115 */
1116 return ERR_PTR(-EINVAL);
1117
1118 return get_mtd_device(NULL, minor / 2);
1119}
1120
1121/**
1122 * open_mtd_device - open MTD device by name, character device path, or number.
1123 * @mtd_dev: name, character device node path, or MTD device device number
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001124 *
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001125 * This function tries to open and MTD device described by @mtd_dev string,
Artem Bityutskiyf9b00802010-01-05 16:48:40 +02001126 * which is first treated as ASCII MTD device number, and if it is not true, it
1127 * is treated as MTD device name, and if that is also not true, it is treated
1128 * as MTD character device node path. Returns MTD device description object in
1129 * case of success and a negative error code in case of failure.
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001130 */
1131static struct mtd_info * __init open_mtd_device(const char *mtd_dev)
1132{
1133 struct mtd_info *mtd;
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001134 int mtd_num;
1135 char *endp;
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001136
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001137 mtd_num = simple_strtoul(mtd_dev, &endp, 0);
1138 if (*endp != '\0' || mtd_dev == endp) {
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001139 /*
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001140 * This does not look like an ASCII integer, probably this is
1141 * MTD device name.
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001142 */
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001143 mtd = get_mtd_device_nm(mtd_dev);
Artem Bityutskiyf9b00802010-01-05 16:48:40 +02001144 if (IS_ERR(mtd) && PTR_ERR(mtd) == -ENODEV)
1145 /* Probably this is an MTD character device node path */
1146 mtd = open_mtd_by_chdev(mtd_dev);
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001147 } else
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001148 mtd = get_mtd_device(NULL, mtd_num);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001149
1150 return mtd;
1151}
1152
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001153static int __init ubi_init(void)
1154{
1155 int err, i, k;
1156
1157 /* Ensure that EC and VID headers have correct size */
1158 BUILD_BUG_ON(sizeof(struct ubi_ec_hdr) != 64);
1159 BUILD_BUG_ON(sizeof(struct ubi_vid_hdr) != 64);
1160
1161 if (mtd_devs > UBI_MAX_DEVICES) {
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001162 ubi_err("too many MTD devices, maximum is %d", UBI_MAX_DEVICES);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001163 return -EINVAL;
1164 }
1165
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001166 /* Create base sysfs directory and sysfs files */
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001167 ubi_class = class_create(THIS_MODULE, UBI_NAME_STR);
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001168 if (IS_ERR(ubi_class)) {
1169 err = PTR_ERR(ubi_class);
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001170 ubi_err("cannot create UBI class");
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001171 goto out;
1172 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001173
1174 err = class_create_file(ubi_class, &ubi_version);
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001175 if (err) {
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001176 ubi_err("cannot create sysfs file");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001177 goto out_class;
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001178 }
1179
1180 err = misc_register(&ubi_ctrl_cdev);
1181 if (err) {
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001182 ubi_err("cannot register device");
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001183 goto out_version;
1184 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001185
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +02001186 ubi_wl_entry_slab = kmem_cache_create("ubi_wl_entry_slab",
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001187 sizeof(struct ubi_wl_entry),
1188 0, 0, NULL);
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +02001189 if (!ubi_wl_entry_slab)
Artem Bityutskiyb9a06622008-01-16 12:11:54 +02001190 goto out_dev_unreg;
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +02001191
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001192 err = ubi_debugfs_init();
1193 if (err)
1194 goto out_slab;
1195
1196
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001197 /* Attach MTD devices */
1198 for (i = 0; i < mtd_devs; i++) {
1199 struct mtd_dev_param *p = &mtd_dev_param[i];
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001200 struct mtd_info *mtd;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001201
1202 cond_resched();
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001203
1204 mtd = open_mtd_device(p->name);
1205 if (IS_ERR(mtd)) {
1206 err = PTR_ERR(mtd);
1207 goto out_detach;
1208 }
1209
1210 mutex_lock(&ubi_devices_mutex);
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001211 err = ubi_attach_mtd_dev(mtd, UBI_DEV_NUM_AUTO,
Richard Genoud256334c2012-08-20 18:00:11 +02001212 p->vid_hdr_offs,
1213 CONFIG_MTD_UBI_BEB_LIMIT);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001214 mutex_unlock(&ubi_devices_mutex);
1215 if (err < 0) {
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001216 ubi_err("cannot attach mtd%d", mtd->index);
Marc Kleine-Buddeaf7ad7a2010-05-05 10:17:25 +02001217 put_mtd_device(mtd);
1218
1219 /*
1220 * Originally UBI stopped initializing on any error.
1221 * However, later on it was found out that this
1222 * behavior is not very good when UBI is compiled into
1223 * the kernel and the MTD devices to attach are passed
1224 * through the command line. Indeed, UBI failure
1225 * stopped whole boot sequence.
1226 *
1227 * To fix this, we changed the behavior for the
1228 * non-module case, but preserved the old behavior for
1229 * the module case, just for compatibility. This is a
1230 * little inconsistent, though.
1231 */
1232 if (ubi_is_module())
1233 goto out_detach;
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001234 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001235 }
1236
1237 return 0;
1238
1239out_detach:
1240 for (k = 0; k < i; k++)
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001241 if (ubi_devices[k]) {
1242 mutex_lock(&ubi_devices_mutex);
1243 ubi_detach_mtd_dev(ubi_devices[k]->ubi_num, 1);
1244 mutex_unlock(&ubi_devices_mutex);
1245 }
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001246 ubi_debugfs_exit();
1247out_slab:
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 Bityutskiy2a734bb2011-05-18 14:53:05 +03001271 ubi_debugfs_exit();
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +02001272 kmem_cache_destroy(ubi_wl_entry_slab);
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001273 misc_deregister(&ubi_ctrl_cdev);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001274 class_remove_file(ubi_class, &ubi_version);
1275 class_destroy(ubi_class);
1276}
1277module_exit(ubi_exit);
1278
1279/**
Artem Bityutskiyebaaf1a2008-07-18 13:34:32 +03001280 * bytes_str_to_int - convert a number of bytes string into an integer.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001281 * @str: the string to convert
1282 *
1283 * This function returns positive resulting integer in case of success and a
1284 * negative error code in case of failure.
1285 */
1286static int __init bytes_str_to_int(const char *str)
1287{
1288 char *endp;
1289 unsigned long result;
1290
1291 result = simple_strtoul(str, &endp, 0);
Roel Kluin774b1382009-10-16 14:00:17 +02001292 if (str == endp || result >= INT_MAX) {
Artem Bityutskiy458dbb32007-12-19 17:03:42 +02001293 printk(KERN_ERR "UBI error: incorrect bytes count: \"%s\"\n",
1294 str);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001295 return -EINVAL;
1296 }
1297
1298 switch (*endp) {
1299 case 'G':
1300 result *= 1024;
1301 case 'M':
1302 result *= 1024;
1303 case 'K':
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001304 result *= 1024;
Artem Bityutskiyaeddb872007-12-26 14:25:58 +02001305 if (endp[1] == 'i' && endp[2] == 'B')
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001306 endp += 2;
1307 case '\0':
1308 break;
1309 default:
Artem Bityutskiy458dbb32007-12-19 17:03:42 +02001310 printk(KERN_ERR "UBI error: incorrect bytes count: \"%s\"\n",
1311 str);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001312 return -EINVAL;
1313 }
1314
1315 return result;
1316}
1317
1318/**
1319 * ubi_mtd_param_parse - parse the 'mtd=' UBI parameter.
1320 * @val: the parameter value to parse
1321 * @kp: not used
1322 *
1323 * This function returns zero in case of success and a negative error code in
1324 * case of error.
1325 */
1326static int __init ubi_mtd_param_parse(const char *val, struct kernel_param *kp)
1327{
1328 int i, len;
1329 struct mtd_dev_param *p;
1330 char buf[MTD_PARAM_LEN_MAX];
1331 char *pbuf = &buf[0];
Richard Genoud5993f9b2012-08-17 16:35:19 +02001332 char *tokens[MTD_PARAM_MAX_COUNT];
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001333
Artem Bityutskiy77c722d2007-12-16 16:46:57 +02001334 if (!val)
1335 return -EINVAL;
1336
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001337 if (mtd_devs == UBI_MAX_DEVICES) {
Artem Bityutskiy458dbb32007-12-19 17:03:42 +02001338 printk(KERN_ERR "UBI error: too many parameters, max. is %d\n",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001339 UBI_MAX_DEVICES);
1340 return -EINVAL;
1341 }
1342
1343 len = strnlen(val, MTD_PARAM_LEN_MAX);
1344 if (len == MTD_PARAM_LEN_MAX) {
Artem Bityutskiy458dbb32007-12-19 17:03:42 +02001345 printk(KERN_ERR "UBI error: parameter \"%s\" is too long, "
1346 "max. is %d\n", val, MTD_PARAM_LEN_MAX);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001347 return -EINVAL;
1348 }
1349
1350 if (len == 0) {
Artem Bityutskiy458dbb32007-12-19 17:03:42 +02001351 printk(KERN_WARNING "UBI warning: empty 'mtd=' parameter - "
1352 "ignored\n");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001353 return 0;
1354 }
1355
1356 strcpy(buf, val);
1357
1358 /* Get rid of the final newline */
1359 if (buf[len - 1] == '\n')
Artem Bityutskiy503990e2007-07-11 16:03:29 +03001360 buf[len - 1] = '\0';
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001361
Richard Genoud5993f9b2012-08-17 16:35:19 +02001362 for (i = 0; i < MTD_PARAM_MAX_COUNT; i++)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001363 tokens[i] = strsep(&pbuf, ",");
1364
1365 if (pbuf) {
Artem Bityutskiy458dbb32007-12-19 17:03:42 +02001366 printk(KERN_ERR "UBI error: too many arguments at \"%s\"\n",
1367 val);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001368 return -EINVAL;
1369 }
1370
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001371 p = &mtd_dev_param[mtd_devs];
1372 strcpy(&p->name[0], tokens[0]);
1373
1374 if (tokens[1])
1375 p->vid_hdr_offs = bytes_str_to_int(tokens[1]);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001376
1377 if (p->vid_hdr_offs < 0)
1378 return p->vid_hdr_offs;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001379
1380 mtd_devs += 1;
1381 return 0;
1382}
1383
1384module_param_call(mtd, ubi_mtd_param_parse, NULL, NULL, 000);
1385MODULE_PARM_DESC(mtd, "MTD devices to attach. Parameter format: "
Artem Bityutskiyf9b00802010-01-05 16:48:40 +02001386 "mtd=<name|num|path>[,<vid_hdr_offs>].\n"
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001387 "Multiple \"mtd\" parameters may be specified.\n"
Artem Bityutskiyf9b00802010-01-05 16:48:40 +02001388 "MTD devices may be specified by their number, name, or "
1389 "path to the MTD character device node.\n"
Artem Bityutskiydd38fcc2007-12-19 21:43:32 +02001390 "Optional \"vid_hdr_offs\" parameter specifies UBI VID "
Artem Bityutskiyf9b00802010-01-05 16:48:40 +02001391 "header position to be used by UBI.\n"
1392 "Example 1: mtd=/dev/mtd0 - attach MTD device "
1393 "/dev/mtd0.\n"
1394 "Example 2: mtd=content,1984 mtd=4 - attach MTD device "
Artem Bityutskiydd38fcc2007-12-19 21:43:32 +02001395 "with name \"content\" using VID header offset 1984, and "
1396 "MTD device number 4 with default VID header offset.");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001397
1398MODULE_VERSION(__stringify(UBI_VERSION));
1399MODULE_DESCRIPTION("UBI - Unsorted Block Images");
1400MODULE_AUTHOR("Artem Bityutskiy");
1401MODULE_LICENSE("GPL");