blob: 89660881aa3169aca91b2fbc4a824281b37bdc2f [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 */
Richard Genoudedac4932012-08-20 18:00:14 +020050#define MTD_PARAM_MAX_COUNT 3
Richard Genoud5993f9b2012-08-17 16:35:19 +020051
Richard Genoudd2f588f92012-08-20 18:00:13 +020052/* Maximum value for the number of bad PEBs per 1024 PEBs */
53#define MAX_MTD_UBI_BEB_LIMIT 768
54
Marc Kleine-Buddeaf7ad7a2010-05-05 10:17:25 +020055#ifdef CONFIG_MTD_UBI_MODULE
56#define ubi_is_module() 1
57#else
58#define ubi_is_module() 0
59#endif
60
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040061/**
62 * struct mtd_dev_param - MTD device parameter description data structure.
Artem Bityutskiyf9b00802010-01-05 16:48:40 +020063 * @name: MTD character device node path, MTD device name, or MTD device number
64 * string
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040065 * @vid_hdr_offs: VID header offset
Richard Genoudedac4932012-08-20 18:00:14 +020066 * @max_beb_per1024: maximum expected number of bad PEBs per 1024 PEBs
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040067 */
Artem Bityutskiy9c9ec142008-07-18 13:19:52 +030068struct mtd_dev_param {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040069 char name[MTD_PARAM_LEN_MAX];
70 int vid_hdr_offs;
Richard Genoudedac4932012-08-20 18:00:14 +020071 int max_beb_per1024;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040072};
73
74/* Numbers of elements set in the @mtd_dev_param array */
Artem Bityutskiy9e0c7ef2010-01-06 14:20:31 +020075static int __initdata mtd_devs;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040076
77/* MTD devices specification parameters */
Artem Bityutskiy9e0c7ef2010-01-06 14:20:31 +020078static struct mtd_dev_param __initdata mtd_dev_param[UBI_MAX_DEVICES];
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040079
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040080/* Root UBI "class" object (corresponds to '/<sysfs>/class/ubi/') */
81struct class *ubi_class;
82
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +020083/* Slab cache for wear-leveling entries */
84struct kmem_cache *ubi_wl_entry_slab;
85
Artem Bityutskiy9f961b52007-12-16 16:59:31 +020086/* UBI control character device */
87static struct miscdevice ubi_ctrl_cdev = {
88 .minor = MISC_DYNAMIC_MINOR,
89 .name = "ubi_ctrl",
90 .fops = &ubi_ctrl_cdev_operations,
91};
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +020092
Artem Bityutskiye73f4452007-12-17 17:37:26 +020093/* All UBI devices in system */
94static struct ubi_device *ubi_devices[UBI_MAX_DEVICES];
95
Artem Bityutskiycdfa7882007-12-17 20:33:20 +020096/* Serializes UBI devices creations and removals */
97DEFINE_MUTEX(ubi_devices_mutex);
98
Artem Bityutskiye73f4452007-12-17 17:37:26 +020099/* Protects @ubi_devices and @ubi->ref_count */
100static DEFINE_SPINLOCK(ubi_devices_lock);
101
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400102/* "Show" method for files in '/<sysfs>/class/ubi/' */
Artem Bityutskiyc174a082010-09-03 15:11:17 +0300103static ssize_t ubi_version_show(struct class *class,
104 struct class_attribute *attr, char *buf)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400105{
106 return sprintf(buf, "%d\n", UBI_VERSION);
107}
108
109/* UBI version attribute ('/<sysfs>/class/ubi/version') */
110static struct class_attribute ubi_version =
111 __ATTR(version, S_IRUGO, ubi_version_show, NULL);
112
113static ssize_t dev_attribute_show(struct device *dev,
114 struct device_attribute *attr, char *buf);
115
116/* UBI device attributes (correspond to files in '/<sysfs>/class/ubi/ubiX') */
117static struct device_attribute dev_eraseblock_size =
118 __ATTR(eraseblock_size, S_IRUGO, dev_attribute_show, NULL);
119static struct device_attribute dev_avail_eraseblocks =
120 __ATTR(avail_eraseblocks, S_IRUGO, dev_attribute_show, NULL);
121static struct device_attribute dev_total_eraseblocks =
122 __ATTR(total_eraseblocks, S_IRUGO, dev_attribute_show, NULL);
123static struct device_attribute dev_volumes_count =
124 __ATTR(volumes_count, S_IRUGO, dev_attribute_show, NULL);
125static struct device_attribute dev_max_ec =
126 __ATTR(max_ec, S_IRUGO, dev_attribute_show, NULL);
127static struct device_attribute dev_reserved_for_bad =
128 __ATTR(reserved_for_bad, S_IRUGO, dev_attribute_show, NULL);
129static struct device_attribute dev_bad_peb_count =
130 __ATTR(bad_peb_count, S_IRUGO, dev_attribute_show, NULL);
131static struct device_attribute dev_max_vol_count =
132 __ATTR(max_vol_count, S_IRUGO, dev_attribute_show, NULL);
133static struct device_attribute dev_min_io_size =
134 __ATTR(min_io_size, S_IRUGO, dev_attribute_show, NULL);
135static struct device_attribute dev_bgt_enabled =
136 __ATTR(bgt_enabled, S_IRUGO, dev_attribute_show, NULL);
Artem Bityutskiyb6b76ba2007-12-26 13:46:46 +0200137static struct device_attribute dev_mtd_num =
138 __ATTR(mtd_num, S_IRUGO, dev_attribute_show, NULL);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400139
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200140/**
Dmitry Pervushin0e0ee1c2009-04-29 19:29:38 +0400141 * ubi_volume_notify - send a volume change notification.
142 * @ubi: UBI device description object
143 * @vol: volume description object of the changed volume
144 * @ntype: notification type to send (%UBI_VOLUME_ADDED, etc)
145 *
146 * This is a helper function which notifies all subscribers about a volume
147 * change event (creation, removal, re-sizing, re-naming, updating). Returns
148 * zero in case of success and a negative error code in case of failure.
149 */
150int ubi_volume_notify(struct ubi_device *ubi, struct ubi_volume *vol, int ntype)
151{
152 struct ubi_notification nt;
153
154 ubi_do_get_device_info(ubi, &nt.di);
155 ubi_do_get_volume_info(ubi, vol, &nt.vi);
156 return blocking_notifier_call_chain(&ubi_notifiers, ntype, &nt);
157}
158
159/**
160 * ubi_notify_all - send a notification to all volumes.
161 * @ubi: UBI device description object
162 * @ntype: notification type to send (%UBI_VOLUME_ADDED, etc)
163 * @nb: the notifier to call
164 *
165 * This function walks all volumes of UBI device @ubi and sends the @ntype
166 * notification for each volume. If @nb is %NULL, then all registered notifiers
167 * are called, otherwise only the @nb notifier is called. Returns the number of
168 * sent notifications.
169 */
170int ubi_notify_all(struct ubi_device *ubi, int ntype, struct notifier_block *nb)
171{
172 struct ubi_notification nt;
173 int i, count = 0;
174
175 ubi_do_get_device_info(ubi, &nt.di);
176
177 mutex_lock(&ubi->device_mutex);
178 for (i = 0; i < ubi->vtbl_slots; i++) {
179 /*
180 * Since the @ubi->device is locked, and we are not going to
181 * change @ubi->volumes, we do not have to lock
182 * @ubi->volumes_lock.
183 */
184 if (!ubi->volumes[i])
185 continue;
186
187 ubi_do_get_volume_info(ubi, ubi->volumes[i], &nt.vi);
188 if (nb)
189 nb->notifier_call(nb, ntype, &nt);
190 else
191 blocking_notifier_call_chain(&ubi_notifiers, ntype,
192 &nt);
193 count += 1;
194 }
195 mutex_unlock(&ubi->device_mutex);
196
197 return count;
198}
199
200/**
201 * ubi_enumerate_volumes - send "add" notification for all existing volumes.
202 * @nb: the notifier to call
203 *
204 * This function walks all UBI devices and volumes and sends the
205 * %UBI_VOLUME_ADDED notification for each volume. If @nb is %NULL, then all
206 * registered notifiers are called, otherwise only the @nb notifier is called.
207 * Returns the number of sent notifications.
208 */
209int ubi_enumerate_volumes(struct notifier_block *nb)
210{
211 int i, count = 0;
212
213 /*
214 * Since the @ubi_devices_mutex is locked, and we are not going to
215 * change @ubi_devices, we do not have to lock @ubi_devices_lock.
216 */
217 for (i = 0; i < UBI_MAX_DEVICES; i++) {
218 struct ubi_device *ubi = ubi_devices[i];
219
220 if (!ubi)
221 continue;
222 count += ubi_notify_all(ubi, UBI_VOLUME_ADDED, nb);
223 }
224
225 return count;
226}
227
228/**
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200229 * ubi_get_device - get UBI device.
230 * @ubi_num: UBI device number
231 *
232 * This function returns UBI device description object for UBI device number
233 * @ubi_num, or %NULL if the device does not exist. This function increases the
234 * device reference count to prevent removal of the device. In other words, the
235 * device cannot be removed if its reference count is not zero.
236 */
237struct ubi_device *ubi_get_device(int ubi_num)
238{
239 struct ubi_device *ubi;
240
241 spin_lock(&ubi_devices_lock);
242 ubi = ubi_devices[ubi_num];
243 if (ubi) {
244 ubi_assert(ubi->ref_count >= 0);
245 ubi->ref_count += 1;
246 get_device(&ubi->dev);
247 }
248 spin_unlock(&ubi_devices_lock);
249
250 return ubi;
251}
252
253/**
254 * ubi_put_device - drop an UBI device reference.
255 * @ubi: UBI device description object
256 */
257void ubi_put_device(struct ubi_device *ubi)
258{
259 spin_lock(&ubi_devices_lock);
260 ubi->ref_count -= 1;
261 put_device(&ubi->dev);
262 spin_unlock(&ubi_devices_lock);
263}
264
265/**
Artem Bityutskiyebaaf1a2008-07-18 13:34:32 +0300266 * ubi_get_by_major - get UBI device by character device major number.
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200267 * @major: major number
268 *
269 * This function is similar to 'ubi_get_device()', but it searches the device
270 * by its major number.
271 */
272struct ubi_device *ubi_get_by_major(int major)
273{
274 int i;
275 struct ubi_device *ubi;
276
277 spin_lock(&ubi_devices_lock);
278 for (i = 0; i < UBI_MAX_DEVICES; i++) {
279 ubi = ubi_devices[i];
280 if (ubi && MAJOR(ubi->cdev.dev) == major) {
281 ubi_assert(ubi->ref_count >= 0);
282 ubi->ref_count += 1;
283 get_device(&ubi->dev);
284 spin_unlock(&ubi_devices_lock);
285 return ubi;
286 }
287 }
288 spin_unlock(&ubi_devices_lock);
289
290 return NULL;
291}
292
293/**
294 * ubi_major2num - get UBI device number by character device major number.
295 * @major: major number
296 *
297 * This function searches UBI device number object by its major number. If UBI
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200298 * device was not found, this function returns -ENODEV, otherwise the UBI device
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200299 * number is returned.
300 */
301int ubi_major2num(int major)
302{
303 int i, ubi_num = -ENODEV;
304
305 spin_lock(&ubi_devices_lock);
306 for (i = 0; i < UBI_MAX_DEVICES; i++) {
307 struct ubi_device *ubi = ubi_devices[i];
308
309 if (ubi && MAJOR(ubi->cdev.dev) == major) {
310 ubi_num = ubi->ubi_num;
311 break;
312 }
313 }
314 spin_unlock(&ubi_devices_lock);
315
316 return ubi_num;
317}
318
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400319/* "Show" method for files in '/<sysfs>/class/ubi/ubiX/' */
320static ssize_t dev_attribute_show(struct device *dev,
321 struct device_attribute *attr, char *buf)
322{
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200323 ssize_t ret;
324 struct ubi_device *ubi;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400325
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200326 /*
327 * The below code looks weird, but it actually makes sense. We get the
328 * UBI device reference from the contained 'struct ubi_device'. But it
329 * is unclear if the device was removed or not yet. Indeed, if the
330 * device was removed before we increased its reference count,
331 * 'ubi_get_device()' will return -ENODEV and we fail.
332 *
333 * Remember, 'struct ubi_device' is freed in the release function, so
334 * we still can use 'ubi->ubi_num'.
335 */
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400336 ubi = container_of(dev, struct ubi_device, dev);
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200337 ubi = ubi_get_device(ubi->ubi_num);
338 if (!ubi)
339 return -ENODEV;
340
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400341 if (attr == &dev_eraseblock_size)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200342 ret = sprintf(buf, "%d\n", ubi->leb_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400343 else if (attr == &dev_avail_eraseblocks)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200344 ret = sprintf(buf, "%d\n", ubi->avail_pebs);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400345 else if (attr == &dev_total_eraseblocks)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200346 ret = sprintf(buf, "%d\n", ubi->good_peb_count);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400347 else if (attr == &dev_volumes_count)
Artem Bityutskiy4b3cc342007-12-26 15:59:39 +0200348 ret = sprintf(buf, "%d\n", ubi->vol_count - UBI_INT_VOL_COUNT);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400349 else if (attr == &dev_max_ec)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200350 ret = sprintf(buf, "%d\n", ubi->max_ec);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400351 else if (attr == &dev_reserved_for_bad)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200352 ret = sprintf(buf, "%d\n", ubi->beb_rsvd_pebs);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400353 else if (attr == &dev_bad_peb_count)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200354 ret = sprintf(buf, "%d\n", ubi->bad_peb_count);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400355 else if (attr == &dev_max_vol_count)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200356 ret = sprintf(buf, "%d\n", ubi->vtbl_slots);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400357 else if (attr == &dev_min_io_size)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200358 ret = sprintf(buf, "%d\n", ubi->min_io_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400359 else if (attr == &dev_bgt_enabled)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200360 ret = sprintf(buf, "%d\n", ubi->thread_enabled);
Artem Bityutskiyb6b76ba2007-12-26 13:46:46 +0200361 else if (attr == &dev_mtd_num)
362 ret = sprintf(buf, "%d\n", ubi->mtd->index);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400363 else
Artem Bityutskiyb6b76ba2007-12-26 13:46:46 +0200364 ret = -EINVAL;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400365
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200366 ubi_put_device(ubi);
367 return ret;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400368}
369
Artem Bityutskiy36b477d2009-01-20 18:04:09 +0200370static void dev_release(struct device *dev)
371{
372 struct ubi_device *ubi = container_of(dev, struct ubi_device, dev);
373
374 kfree(ubi);
375}
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400376
377/**
378 * ubi_sysfs_init - initialize sysfs for an UBI device.
379 * @ubi: UBI device description object
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200380 * @ref: set to %1 on exit in case of failure if a reference to @ubi->dev was
381 * taken
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400382 *
383 * This function returns zero in case of success and a negative error code in
384 * case of failure.
385 */
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200386static int ubi_sysfs_init(struct ubi_device *ubi, int *ref)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400387{
388 int err;
389
390 ubi->dev.release = dev_release;
Artem Bityutskiy49dfc292007-12-15 18:13:56 +0200391 ubi->dev.devt = ubi->cdev.dev;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400392 ubi->dev.class = ubi_class;
Kay Sievers160bbab2008-12-23 10:00:14 +0000393 dev_set_name(&ubi->dev, UBI_NAME_STR"%d", ubi->ubi_num);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400394 err = device_register(&ubi->dev);
395 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200396 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400397
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200398 *ref = 1;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400399 err = device_create_file(&ubi->dev, &dev_eraseblock_size);
400 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200401 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400402 err = device_create_file(&ubi->dev, &dev_avail_eraseblocks);
403 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200404 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400405 err = device_create_file(&ubi->dev, &dev_total_eraseblocks);
406 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200407 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400408 err = device_create_file(&ubi->dev, &dev_volumes_count);
409 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200410 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400411 err = device_create_file(&ubi->dev, &dev_max_ec);
412 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200413 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400414 err = device_create_file(&ubi->dev, &dev_reserved_for_bad);
415 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200416 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400417 err = device_create_file(&ubi->dev, &dev_bad_peb_count);
418 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200419 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400420 err = device_create_file(&ubi->dev, &dev_max_vol_count);
421 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200422 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400423 err = device_create_file(&ubi->dev, &dev_min_io_size);
424 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200425 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400426 err = device_create_file(&ubi->dev, &dev_bgt_enabled);
Artem Bityutskiyb6b76ba2007-12-26 13:46:46 +0200427 if (err)
428 return err;
429 err = device_create_file(&ubi->dev, &dev_mtd_num);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400430 return err;
431}
432
433/**
434 * ubi_sysfs_close - close sysfs for an UBI device.
435 * @ubi: UBI device description object
436 */
437static void ubi_sysfs_close(struct ubi_device *ubi)
438{
Artem Bityutskiyb6b76ba2007-12-26 13:46:46 +0200439 device_remove_file(&ubi->dev, &dev_mtd_num);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400440 device_remove_file(&ubi->dev, &dev_bgt_enabled);
441 device_remove_file(&ubi->dev, &dev_min_io_size);
442 device_remove_file(&ubi->dev, &dev_max_vol_count);
443 device_remove_file(&ubi->dev, &dev_bad_peb_count);
444 device_remove_file(&ubi->dev, &dev_reserved_for_bad);
445 device_remove_file(&ubi->dev, &dev_max_ec);
446 device_remove_file(&ubi->dev, &dev_volumes_count);
447 device_remove_file(&ubi->dev, &dev_total_eraseblocks);
448 device_remove_file(&ubi->dev, &dev_avail_eraseblocks);
449 device_remove_file(&ubi->dev, &dev_eraseblock_size);
450 device_unregister(&ubi->dev);
451}
452
453/**
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200454 * kill_volumes - destroy all user volumes.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400455 * @ubi: UBI device description object
456 */
457static void kill_volumes(struct ubi_device *ubi)
458{
459 int i;
460
461 for (i = 0; i < ubi->vtbl_slots; i++)
462 if (ubi->volumes[i])
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200463 ubi_free_volume(ubi, ubi->volumes[i]);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400464}
465
466/**
467 * uif_init - initialize user interfaces for an UBI device.
468 * @ubi: UBI device description object
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200469 * @ref: set to %1 on exit in case of failure if a reference to @ubi->dev was
470 * taken, otherwise set to %0
471 *
472 * This function initializes various user interfaces for an UBI device. If the
473 * initialization fails at an early stage, this function frees all the
474 * resources it allocated, returns an error, and @ref is set to %0. However,
475 * if the initialization fails after the UBI device was registered in the
476 * driver core subsystem, this function takes a reference to @ubi->dev, because
477 * otherwise the release function ('dev_release()') would free whole @ubi
478 * object. The @ref argument is set to %1 in this case. The caller has to put
479 * this reference.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400480 *
481 * This function returns zero in case of success and a negative error code in
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200482 * case of failure.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400483 */
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200484static int uif_init(struct ubi_device *ubi, int *ref)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400485{
Artem Bityutskiy8c4c19f2009-01-20 17:48:02 +0200486 int i, err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400487 dev_t dev;
488
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200489 *ref = 0;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400490 sprintf(ubi->ubi_name, UBI_NAME_STR "%d", ubi->ubi_num);
491
492 /*
493 * Major numbers for the UBI character devices are allocated
494 * dynamically. Major numbers of volume character devices are
495 * equivalent to ones of the corresponding UBI character device. Minor
496 * numbers of UBI character devices are 0, while minor numbers of
497 * volume character devices start from 1. Thus, we allocate one major
498 * number and ubi->vtbl_slots + 1 minor numbers.
499 */
500 err = alloc_chrdev_region(&dev, 0, ubi->vtbl_slots + 1, ubi->ubi_name);
501 if (err) {
502 ubi_err("cannot register UBI character devices");
503 return err;
504 }
505
Artem Bityutskiy49dfc292007-12-15 18:13:56 +0200506 ubi_assert(MINOR(dev) == 0);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400507 cdev_init(&ubi->cdev, &ubi_cdev_operations);
Artem Bityutskiyc8566352008-07-16 17:40:22 +0300508 dbg_gen("%s major is %u", ubi->ubi_name, MAJOR(dev));
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400509 ubi->cdev.owner = THIS_MODULE;
510
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400511 err = cdev_add(&ubi->cdev, dev, 1);
512 if (err) {
Artem Bityutskiy01f7b302007-12-15 19:56:51 +0200513 ubi_err("cannot add character device");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400514 goto out_unreg;
515 }
516
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200517 err = ubi_sysfs_init(ubi, ref);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400518 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200519 goto out_sysfs;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400520
521 for (i = 0; i < ubi->vtbl_slots; i++)
522 if (ubi->volumes[i]) {
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200523 err = ubi_add_volume(ubi, ubi->volumes[i]);
Artem Bityutskiy01f7b302007-12-15 19:56:51 +0200524 if (err) {
525 ubi_err("cannot add volume %d", i);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400526 goto out_volumes;
Artem Bityutskiy01f7b302007-12-15 19:56:51 +0200527 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400528 }
529
530 return 0;
531
532out_volumes:
533 kill_volumes(ubi);
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200534out_sysfs:
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200535 if (*ref)
536 get_device(&ubi->dev);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400537 ubi_sysfs_close(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400538 cdev_del(&ubi->cdev);
539out_unreg:
Artem Bityutskiy49dfc292007-12-15 18:13:56 +0200540 unregister_chrdev_region(ubi->cdev.dev, ubi->vtbl_slots + 1);
Artem Bityutskiy01f7b302007-12-15 19:56:51 +0200541 ubi_err("cannot initialize UBI %s, error %d", ubi->ubi_name, err);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400542 return err;
543}
544
545/**
546 * uif_close - close user interfaces for an UBI device.
547 * @ubi: UBI device description object
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300548 *
549 * Note, since this function un-registers UBI volume device objects (@vol->dev),
550 * the memory allocated voe the volumes is freed as well (in the release
551 * function).
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400552 */
553static void uif_close(struct ubi_device *ubi)
554{
555 kill_volumes(ubi);
556 ubi_sysfs_close(ubi);
557 cdev_del(&ubi->cdev);
Artem Bityutskiy49dfc292007-12-15 18:13:56 +0200558 unregister_chrdev_region(ubi->cdev.dev, ubi->vtbl_slots + 1);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400559}
560
561/**
Artem Bityutskiy47e1ec72012-05-18 12:41:17 +0300562 * ubi_free_internal_volumes - free internal volumes.
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300563 * @ubi: UBI device description object
564 */
Artem Bityutskiy47e1ec72012-05-18 12:41:17 +0300565void ubi_free_internal_volumes(struct ubi_device *ubi)
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300566{
567 int i;
568
569 for (i = ubi->vtbl_slots;
570 i < ubi->vtbl_slots + UBI_INT_VOL_COUNT; i++) {
571 kfree(ubi->volumes[i]->eba_tbl);
572 kfree(ubi->volumes[i]);
573 }
574}
575
Richard Genoud95e6fb02012-08-17 16:35:18 +0200576static int get_bad_peb_limit(const struct ubi_device *ubi, int max_beb_per1024)
577{
578 int limit, device_pebs;
579 uint64_t device_size;
580
581 if (!max_beb_per1024)
582 return 0;
583
584 /*
585 * Here we are using size of the entire flash chip and
586 * not just the MTD partition size because the maximum
587 * number of bad eraseblocks is a percentage of the
588 * whole device and bad eraseblocks are not fairly
589 * distributed over the flash chip. So the worst case
590 * is that all the bad eraseblocks of the chip are in
591 * the MTD partition we are attaching (ubi->mtd).
592 */
593 device_size = mtd_get_device_size(ubi->mtd);
594 device_pebs = mtd_div_by_eb(device_size, ubi->mtd);
595 limit = mult_frac(device_pebs, max_beb_per1024, 1024);
596
597 /* Round it up */
598 if (mult_frac(limit, 1024, max_beb_per1024) < device_pebs)
599 limit += 1;
600
601 return limit;
602}
603
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300604/**
Artem Bityutskiy85c6e6e2008-07-16 10:25:56 +0300605 * io_init - initialize I/O sub-system for a given UBI device.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400606 * @ubi: UBI device description object
Richard Genoud256334c2012-08-20 18:00:11 +0200607 * @max_beb_per1024: maximum expected number of bad PEB per 1024 PEBs
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400608 *
609 * If @ubi->vid_hdr_offset or @ubi->leb_start is zero, default offsets are
610 * assumed:
611 * o EC header is always at offset zero - this cannot be changed;
612 * o VID header starts just after the EC header at the closest address
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200613 * aligned to @io->hdrs_min_io_size;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400614 * o data starts just after the VID header at the closest address aligned to
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200615 * @io->min_io_size
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400616 *
617 * This function returns zero in case of success and a negative error code in
618 * case of failure.
619 */
Richard Genoud256334c2012-08-20 18:00:11 +0200620static int io_init(struct ubi_device *ubi, int max_beb_per1024)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400621{
622 if (ubi->mtd->numeraseregions != 0) {
623 /*
624 * Some flashes have several erase regions. Different regions
625 * may have different eraseblock size and other
626 * characteristics. It looks like mostly multi-region flashes
627 * have one "main" region and one or more small regions to
628 * store boot loader code or boot parameters or whatever. I
629 * guess we should just pick the largest region. But this is
630 * not implemented.
631 */
632 ubi_err("multiple regions, not implemented");
633 return -EINVAL;
634 }
635
Artem Bityutskiydd38fcc2007-12-19 21:43:32 +0200636 if (ubi->vid_hdr_offset < 0)
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200637 return -EINVAL;
638
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400639 /*
640 * Note, in this implementation we support MTD devices with 0x7FFFFFFF
641 * physical eraseblocks maximum.
642 */
643
644 ubi->peb_size = ubi->mtd->erasesize;
Adrian Hunter69423d92008-12-10 13:37:21 +0000645 ubi->peb_count = mtd_div_by_eb(ubi->mtd->size, ubi->mtd);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400646 ubi->flash_size = ubi->mtd->size;
647
Shmulik Ladkani8beeb3b2012-07-04 11:06:00 +0300648 if (mtd_can_have_bb(ubi->mtd)) {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400649 ubi->bad_allowed = 1;
Richard Genoud95e6fb02012-08-17 16:35:18 +0200650 ubi->bad_peb_limit = get_bad_peb_limit(ubi, max_beb_per1024);
Shmulik Ladkani8beeb3b2012-07-04 11:06:00 +0300651 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400652
Artem Bityutskiyebf53f42009-07-06 08:57:53 +0300653 if (ubi->mtd->type == MTD_NORFLASH) {
654 ubi_assert(ubi->mtd->writesize == 1);
655 ubi->nor_flash = 1;
656 }
657
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400658 ubi->min_io_size = ubi->mtd->writesize;
659 ubi->hdrs_min_io_size = ubi->mtd->writesize >> ubi->mtd->subpage_sft;
660
Kyungmin Parkcadb40c2008-05-22 10:32:18 +0900661 /*
662 * Make sure minimal I/O unit is power of 2. Note, there is no
663 * fundamental reason for this assumption. It is just an optimization
664 * which allows us to avoid costly division operations.
665 */
Vignesh Babu7753f162007-06-12 10:31:05 +0530666 if (!is_power_of_2(ubi->min_io_size)) {
Artem Bityutskiy01f7b302007-12-15 19:56:51 +0200667 ubi_err("min. I/O unit (%d) is not power of 2",
668 ubi->min_io_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400669 return -EINVAL;
670 }
671
672 ubi_assert(ubi->hdrs_min_io_size > 0);
673 ubi_assert(ubi->hdrs_min_io_size <= ubi->min_io_size);
674 ubi_assert(ubi->min_io_size % ubi->hdrs_min_io_size == 0);
675
Artem Bityutskiy30b542e2011-01-30 18:37:33 +0200676 ubi->max_write_size = ubi->mtd->writebufsize;
677 /*
678 * Maximum write size has to be greater or equivalent to min. I/O
679 * size, and be multiple of min. I/O size.
680 */
681 if (ubi->max_write_size < ubi->min_io_size ||
682 ubi->max_write_size % ubi->min_io_size ||
683 !is_power_of_2(ubi->max_write_size)) {
684 ubi_err("bad write buffer size %d for %d min. I/O unit",
685 ubi->max_write_size, ubi->min_io_size);
686 return -EINVAL;
687 }
688
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400689 /* Calculate default aligned sizes of EC and VID headers */
690 ubi->ec_hdr_alsize = ALIGN(UBI_EC_HDR_SIZE, ubi->hdrs_min_io_size);
691 ubi->vid_hdr_alsize = ALIGN(UBI_VID_HDR_SIZE, ubi->hdrs_min_io_size);
692
693 dbg_msg("min_io_size %d", ubi->min_io_size);
Artem Bityutskiy30b542e2011-01-30 18:37:33 +0200694 dbg_msg("max_write_size %d", ubi->max_write_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400695 dbg_msg("hdrs_min_io_size %d", ubi->hdrs_min_io_size);
696 dbg_msg("ec_hdr_alsize %d", ubi->ec_hdr_alsize);
697 dbg_msg("vid_hdr_alsize %d", ubi->vid_hdr_alsize);
698
699 if (ubi->vid_hdr_offset == 0)
700 /* Default offset */
701 ubi->vid_hdr_offset = ubi->vid_hdr_aloffset =
702 ubi->ec_hdr_alsize;
703 else {
704 ubi->vid_hdr_aloffset = ubi->vid_hdr_offset &
705 ~(ubi->hdrs_min_io_size - 1);
706 ubi->vid_hdr_shift = ubi->vid_hdr_offset -
707 ubi->vid_hdr_aloffset;
708 }
709
710 /* Similar for the data offset */
John Ognesse8cfe002011-01-21 15:39:02 +0100711 ubi->leb_start = ubi->vid_hdr_offset + UBI_VID_HDR_SIZE;
Artem Bityutskiydd38fcc2007-12-19 21:43:32 +0200712 ubi->leb_start = ALIGN(ubi->leb_start, ubi->min_io_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400713
714 dbg_msg("vid_hdr_offset %d", ubi->vid_hdr_offset);
715 dbg_msg("vid_hdr_aloffset %d", ubi->vid_hdr_aloffset);
716 dbg_msg("vid_hdr_shift %d", ubi->vid_hdr_shift);
717 dbg_msg("leb_start %d", ubi->leb_start);
718
719 /* The shift must be aligned to 32-bit boundary */
720 if (ubi->vid_hdr_shift % 4) {
721 ubi_err("unaligned VID header shift %d",
722 ubi->vid_hdr_shift);
723 return -EINVAL;
724 }
725
726 /* Check sanity */
727 if (ubi->vid_hdr_offset < UBI_EC_HDR_SIZE ||
728 ubi->leb_start < ubi->vid_hdr_offset + UBI_VID_HDR_SIZE ||
729 ubi->leb_start > ubi->peb_size - UBI_VID_HDR_SIZE ||
Kyungmin Parkcadb40c2008-05-22 10:32:18 +0900730 ubi->leb_start & (ubi->min_io_size - 1)) {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400731 ubi_err("bad VID header (%d) or data offsets (%d)",
732 ubi->vid_hdr_offset, ubi->leb_start);
733 return -EINVAL;
734 }
735
736 /*
Artem Bityutskiyb86a2c52009-05-24 14:13:34 +0300737 * Set maximum amount of physical erroneous eraseblocks to be 10%.
738 * Erroneous PEB are those which have read errors.
739 */
740 ubi->max_erroneous = ubi->peb_count / 10;
741 if (ubi->max_erroneous < 16)
742 ubi->max_erroneous = 16;
743 dbg_msg("max_erroneous %d", ubi->max_erroneous);
744
745 /*
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400746 * It may happen that EC and VID headers are situated in one minimal
747 * I/O unit. In this case we can only accept this UBI image in
748 * read-only mode.
749 */
750 if (ubi->vid_hdr_offset + UBI_VID_HDR_SIZE <= ubi->hdrs_min_io_size) {
751 ubi_warn("EC and VID headers are in the same minimal I/O unit, "
752 "switch to read-only mode");
753 ubi->ro_mode = 1;
754 }
755
756 ubi->leb_size = ubi->peb_size - ubi->leb_start;
757
758 if (!(ubi->mtd->flags & MTD_WRITEABLE)) {
759 ubi_msg("MTD device %d is write-protected, attach in "
760 "read-only mode", ubi->mtd->index);
761 ubi->ro_mode = 1;
762 }
763
Artem Bityutskiy434b8252008-04-20 18:00:33 +0300764 ubi_msg("physical eraseblock size: %d bytes (%d KiB)",
765 ubi->peb_size, ubi->peb_size >> 10);
766 ubi_msg("logical eraseblock size: %d bytes", ubi->leb_size);
767 ubi_msg("smallest flash I/O unit: %d", ubi->min_io_size);
768 if (ubi->hdrs_min_io_size != ubi->min_io_size)
769 ubi_msg("sub-page size: %d",
770 ubi->hdrs_min_io_size);
771 ubi_msg("VID header offset: %d (aligned %d)",
772 ubi->vid_hdr_offset, ubi->vid_hdr_aloffset);
773 ubi_msg("data offset: %d", ubi->leb_start);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400774
775 /*
Artem Bityutskiyfbd01072012-05-17 16:12:26 +0300776 * Note, ideally, we have to initialize @ubi->bad_peb_count here. But
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400777 * unfortunately, MTD does not provide this information. We should loop
778 * over all physical eraseblocks and invoke mtd->block_is_bad() for
Artem Bityutskiyfbd01072012-05-17 16:12:26 +0300779 * each physical eraseblock. So, we leave @ubi->bad_peb_count
780 * uninitialized so far.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400781 */
782
783 return 0;
784}
785
786/**
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200787 * autoresize - re-size the volume which has the "auto-resize" flag set.
788 * @ubi: UBI device description object
789 * @vol_id: ID of the volume to re-size
790 *
Artem Bityutskiyfbd01072012-05-17 16:12:26 +0300791 * This function re-sizes the volume marked by the %UBI_VTBL_AUTORESIZE_FLG in
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200792 * the volume table to the largest possible size. See comments in ubi-header.h
793 * for more description of the flag. Returns zero in case of success and a
794 * negative error code in case of failure.
795 */
796static int autoresize(struct ubi_device *ubi, int vol_id)
797{
798 struct ubi_volume_desc desc;
799 struct ubi_volume *vol = ubi->volumes[vol_id];
800 int err, old_reserved_pebs = vol->reserved_pebs;
801
Artem Bityutskiyabb3e012012-08-18 14:11:42 +0200802 if (ubi->ro_mode) {
803 ubi_warn("skip auto-resize because of R/O mode");
804 return 0;
805 }
806
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200807 /*
808 * Clear the auto-resize flag in the volume in-memory copy of the
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300809 * volume table, and 'ubi_resize_volume()' will propagate this change
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200810 * to the flash.
811 */
812 ubi->vtbl[vol_id].flags &= ~UBI_VTBL_AUTORESIZE_FLG;
813
814 if (ubi->avail_pebs == 0) {
815 struct ubi_vtbl_record vtbl_rec;
816
817 /*
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300818 * No available PEBs to re-size the volume, clear the flag on
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200819 * flash and exit.
820 */
821 memcpy(&vtbl_rec, &ubi->vtbl[vol_id],
822 sizeof(struct ubi_vtbl_record));
823 err = ubi_change_vtbl_record(ubi, vol_id, &vtbl_rec);
824 if (err)
825 ubi_err("cannot clean auto-resize flag for volume %d",
826 vol_id);
827 } else {
828 desc.vol = vol;
829 err = ubi_resize_volume(&desc,
830 old_reserved_pebs + ubi->avail_pebs);
831 if (err)
832 ubi_err("cannot auto-resize volume %d", vol_id);
833 }
834
835 if (err)
836 return err;
837
838 ubi_msg("volume %d (\"%s\") re-sized from %d to %d LEBs", vol_id,
839 vol->name, old_reserved_pebs, vol->reserved_pebs);
840 return 0;
841}
842
843/**
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200844 * ubi_attach_mtd_dev - attach an MTD device.
Artem Bityutskiyebaaf1a2008-07-18 13:34:32 +0300845 * @mtd: MTD device description object
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200846 * @ubi_num: number to assign to the new UBI device
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400847 * @vid_hdr_offset: VID header offset
Richard Genoudedac4932012-08-20 18:00:14 +0200848 * @max_beb_per1024: maximum expected number of bad PEB per 1024 PEBs
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400849 *
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200850 * This function attaches MTD device @mtd_dev to UBI and assign @ubi_num number
851 * to the newly created UBI device, unless @ubi_num is %UBI_DEV_NUM_AUTO, in
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300852 * which case this function finds a vacant device number and assigns it
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200853 * automatically. Returns the new UBI device number in case of success and a
854 * negative error code in case of failure.
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200855 *
856 * Note, the invocations of this function has to be serialized by the
857 * @ubi_devices_mutex.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400858 */
Richard Genoud256334c2012-08-20 18:00:11 +0200859int ubi_attach_mtd_dev(struct mtd_info *mtd, int ubi_num,
860 int vid_hdr_offset, int max_beb_per1024)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400861{
862 struct ubi_device *ubi;
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200863 int i, err, ref = 0;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400864
Richard Genoudd2f588f92012-08-20 18:00:13 +0200865 if (max_beb_per1024 < 0 || max_beb_per1024 > MAX_MTD_UBI_BEB_LIMIT)
866 return -EINVAL;
867
868 if (!max_beb_per1024)
869 max_beb_per1024 = CONFIG_MTD_UBI_BEB_LIMIT;
870
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200871 /*
872 * Check if we already have the same MTD device attached.
873 *
874 * Note, this function assumes that UBI devices creations and deletions
875 * are serialized, so it does not take the &ubi_devices_lock.
876 */
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200877 for (i = 0; i < UBI_MAX_DEVICES; i++) {
Artem Bityutskiyb96bf4c2007-12-16 13:01:03 +0200878 ubi = ubi_devices[i];
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200879 if (ubi && mtd->index == ubi->mtd->index) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300880 ubi_err("mtd%d is already attached to ubi%d",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400881 mtd->index, i);
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200882 return -EEXIST;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400883 }
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200884 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400885
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200886 /*
887 * Make sure this MTD device is not emulated on top of an UBI volume
888 * already. Well, generally this recursion works fine, but there are
889 * different problems like the UBI module takes a reference to itself
890 * by attaching (and thus, opening) the emulated MTD device. This
891 * results in inability to unload the module. And in general it makes
892 * no sense to attach emulated MTD devices, so we prohibit this.
893 */
894 if (mtd->type == MTD_UBIVOLUME) {
895 ubi_err("refuse attaching mtd%d - it is already emulated on "
896 "top of UBI", mtd->index);
897 return -EINVAL;
898 }
Artem Bityutskiyb96bf4c2007-12-16 13:01:03 +0200899
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200900 if (ubi_num == UBI_DEV_NUM_AUTO) {
901 /* Search for an empty slot in the @ubi_devices array */
902 for (ubi_num = 0; ubi_num < UBI_MAX_DEVICES; ubi_num++)
903 if (!ubi_devices[ubi_num])
904 break;
905 if (ubi_num == UBI_MAX_DEVICES) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300906 ubi_err("only %d UBI devices may be created",
Artem Bityutskiy9c9ec142008-07-18 13:19:52 +0300907 UBI_MAX_DEVICES);
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200908 return -ENFILE;
909 }
910 } else {
911 if (ubi_num >= UBI_MAX_DEVICES)
912 return -EINVAL;
913
914 /* Make sure ubi_num is not busy */
915 if (ubi_devices[ubi_num]) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300916 ubi_err("ubi%d already exists", ubi_num);
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200917 return -EEXIST;
918 }
Artem Bityutskiyb96bf4c2007-12-16 13:01:03 +0200919 }
920
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200921 ubi = kzalloc(sizeof(struct ubi_device), GFP_KERNEL);
922 if (!ubi)
923 return -ENOMEM;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400924
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200925 ubi->mtd = mtd;
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200926 ubi->ubi_num = ubi_num;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400927 ubi->vid_hdr_offset = vid_hdr_offset;
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200928 ubi->autoresize_vol_id = -1;
929
930 mutex_init(&ubi->buf_mutex);
931 mutex_init(&ubi->ckvol_mutex);
Artem Bityutskiyf089c0b2009-05-07 11:46:49 +0300932 mutex_init(&ubi->device_mutex);
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200933 spin_lock_init(&ubi->volumes_lock);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200934
Artem Bityutskiy697fa972008-04-23 13:43:21 +0300935 ubi_msg("attaching mtd%d to ubi%d", mtd->index, ubi_num);
Artem Bityutskiy227423d2012-05-17 06:23:22 +0300936 dbg_msg("sizeof(struct ubi_ainf_peb) %zu", sizeof(struct ubi_ainf_peb));
Artem Bityutskiy6c1e8752010-10-31 17:54:14 +0200937 dbg_msg("sizeof(struct ubi_wl_entry) %zu", sizeof(struct ubi_wl_entry));
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200938
Richard Genoud256334c2012-08-20 18:00:11 +0200939 err = io_init(ubi, max_beb_per1024);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400940 if (err)
941 goto out_free;
942
Stefan Roesead5942b2008-12-10 10:42:54 +0100943 err = -ENOMEM;
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +0200944 ubi->peb_buf = vmalloc(ubi->peb_size);
945 if (!ubi->peb_buf)
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300946 goto out_free;
947
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +0300948 err = ubi_debugging_init_dev(ubi);
949 if (err)
950 goto out_free;
951
Artem Bityutskiy47e1ec72012-05-18 12:41:17 +0300952 err = ubi_attach(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400953 if (err) {
Artem Bityutskiy47e1ec72012-05-18 12:41:17 +0300954 ubi_err("failed to attach mtd%d, error %d", mtd->index, err);
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +0300955 goto out_debugging;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400956 }
957
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200958 if (ubi->autoresize_vol_id != -1) {
959 err = autoresize(ubi, ubi->autoresize_vol_id);
960 if (err)
961 goto out_detach;
962 }
963
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200964 err = uif_init(ubi, &ref);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400965 if (err)
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200966 goto out_detach;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400967
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +0300968 err = ubi_debugfs_init_dev(ubi);
969 if (err)
970 goto out_uif;
971
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200972 ubi->bgt_thread = kthread_create(ubi_thread, ubi, ubi->bgt_name);
973 if (IS_ERR(ubi->bgt_thread)) {
974 err = PTR_ERR(ubi->bgt_thread);
975 ubi_err("cannot spawn \"%s\", error %d", ubi->bgt_name,
976 err);
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +0300977 goto out_debugfs;
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200978 }
979
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200980 ubi_msg("attached mtd%d to ubi%d", mtd->index, ubi_num);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200981 ubi_msg("MTD device name: \"%s\"", mtd->name);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400982 ubi_msg("MTD device size: %llu MiB", ubi->flash_size >> 20);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400983 ubi_msg("number of good PEBs: %d", ubi->good_peb_count);
984 ubi_msg("number of bad PEBs: %d", ubi->bad_peb_count);
Artem Bityutskiy5fc01ab2010-09-03 23:08:15 +0300985 ubi_msg("number of corrupted PEBs: %d", ubi->corr_peb_count);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400986 ubi_msg("max. allowed volumes: %d", ubi->vtbl_slots);
987 ubi_msg("wear-leveling threshold: %d", CONFIG_MTD_UBI_WL_THRESHOLD);
988 ubi_msg("number of internal volumes: %d", UBI_INT_VOL_COUNT);
989 ubi_msg("number of user volumes: %d",
990 ubi->vol_count - UBI_INT_VOL_COUNT);
991 ubi_msg("available PEBs: %d", ubi->avail_pebs);
992 ubi_msg("total number of reserved PEBs: %d", ubi->rsvd_pebs);
993 ubi_msg("number of PEBs reserved for bad PEB handling: %d",
994 ubi->beb_rsvd_pebs);
995 ubi_msg("max/mean erase counter: %d/%d", ubi->max_ec, ubi->mean_ec);
Artem Bityutskiy5739dd72012-08-22 16:28:18 +0300996 ubi_msg("image sequence number: %u", ubi->image_seq);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400997
Artem Bityutskiyddbd3b62009-05-23 13:44:09 +0300998 /*
999 * The below lock makes sure we do not race with 'ubi_thread()' which
1000 * checks @ubi->thread_enabled. Otherwise we may fail to wake it up.
1001 */
1002 spin_lock(&ubi->wl_lock);
Artem Bityutskiy28237e42011-03-15 10:30:40 +02001003 ubi->thread_enabled = 1;
Artem Bityutskiyd37e6bf2008-07-24 18:28:11 +03001004 wake_up_process(ubi->bgt_thread);
Artem Bityutskiyddbd3b62009-05-23 13:44:09 +03001005 spin_unlock(&ubi->wl_lock);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001006
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001007 ubi_devices[ubi_num] = ubi;
Dmitry Pervushin0e0ee1c2009-04-29 19:29:38 +04001008 ubi_notify_all(ubi, UBI_VOLUME_ADDED, NULL);
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001009 return ubi_num;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001010
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001011out_debugfs:
1012 ubi_debugfs_exit_dev(ubi);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001013out_uif:
Artem Bityutskiy01a41102011-05-18 18:08:05 +03001014 get_device(&ubi->dev);
1015 ubi_assert(ref);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001016 uif_close(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001017out_detach:
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001018 ubi_wl_close(ubi);
Artem Bityutskiy47e1ec72012-05-18 12:41:17 +03001019 ubi_free_internal_volumes(ubi);
Vinit Agnihotrid7f0c4d2007-06-15 15:31:22 +05301020 vfree(ubi->vtbl);
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001021out_debugging:
1022 ubi_debugging_exit_dev(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001023out_free:
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +02001024 vfree(ubi->peb_buf);
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +02001025 if (ref)
1026 put_device(&ubi->dev);
1027 else
1028 kfree(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001029 return err;
1030}
1031
1032/**
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001033 * ubi_detach_mtd_dev - detach an MTD device.
1034 * @ubi_num: UBI device number to detach from
1035 * @anyway: detach MTD even if device reference count is not zero
1036 *
1037 * This function destroys an UBI device number @ubi_num and detaches the
1038 * underlying MTD device. Returns zero in case of success and %-EBUSY if the
1039 * UBI device is busy and cannot be destroyed, and %-EINVAL if it does not
1040 * exist.
1041 *
1042 * Note, the invocations of this function has to be serialized by the
1043 * @ubi_devices_mutex.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001044 */
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001045int ubi_detach_mtd_dev(int ubi_num, int anyway)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001046{
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001047 struct ubi_device *ubi;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001048
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001049 if (ubi_num < 0 || ubi_num >= UBI_MAX_DEVICES)
1050 return -EINVAL;
1051
Dmitry Pervushin0e0ee1c2009-04-29 19:29:38 +04001052 ubi = ubi_get_device(ubi_num);
1053 if (!ubi)
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001054 return -EINVAL;
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001055
Dmitry Pervushin0e0ee1c2009-04-29 19:29:38 +04001056 spin_lock(&ubi_devices_lock);
1057 put_device(&ubi->dev);
1058 ubi->ref_count -= 1;
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001059 if (ubi->ref_count) {
1060 if (!anyway) {
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001061 spin_unlock(&ubi_devices_lock);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001062 return -EBUSY;
1063 }
1064 /* This may only happen if there is a bug */
1065 ubi_err("%s reference count %d, destroy anyway",
1066 ubi->ubi_name, ubi->ref_count);
1067 }
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001068 ubi_devices[ubi_num] = NULL;
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001069 spin_unlock(&ubi_devices_lock);
1070
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001071 ubi_assert(ubi_num == ubi->ubi_num);
Dmitry Pervushin0e0ee1c2009-04-29 19:29:38 +04001072 ubi_notify_all(ubi, UBI_VOLUME_REMOVED, NULL);
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001073 dbg_msg("detaching mtd%d from ubi%d", ubi->mtd->index, ubi_num);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001074
1075 /*
1076 * Before freeing anything, we have to stop the background thread to
1077 * prevent it from doing anything on this device while we are freeing.
1078 */
1079 if (ubi->bgt_thread)
1080 kthread_stop(ubi->bgt_thread);
1081
Artem Bityutskiy36b477d2009-01-20 18:04:09 +02001082 /*
1083 * Get a reference to the device in order to prevent 'dev_release()'
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +02001084 * from freeing the @ubi object.
Artem Bityutskiy36b477d2009-01-20 18:04:09 +02001085 */
1086 get_device(&ubi->dev);
1087
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001088 ubi_debugfs_exit_dev(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001089 uif_close(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001090 ubi_wl_close(ubi);
Artem Bityutskiy47e1ec72012-05-18 12:41:17 +03001091 ubi_free_internal_volumes(ubi);
Artem Bityutskiy92ad8f32007-05-06 16:12:54 +03001092 vfree(ubi->vtbl);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001093 put_mtd_device(ubi->mtd);
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001094 ubi_debugging_exit_dev(ubi);
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +02001095 vfree(ubi->peb_buf);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001096 ubi_msg("mtd%d is detached from ubi%d", ubi->mtd->index, ubi->ubi_num);
Artem Bityutskiy36b477d2009-01-20 18:04:09 +02001097 put_device(&ubi->dev);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001098 return 0;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001099}
1100
Artem Bityutskiy3a8d4642007-12-16 12:32:51 +02001101/**
Artem Bityutskiyf9b00802010-01-05 16:48:40 +02001102 * open_mtd_by_chdev - open an MTD device by its character device node path.
1103 * @mtd_dev: MTD character device node path
1104 *
1105 * This helper function opens an MTD device by its character node device path.
1106 * Returns MTD device description object in case of success and a negative
1107 * error code in case of failure.
1108 */
1109static struct mtd_info * __init open_mtd_by_chdev(const char *mtd_dev)
1110{
1111 int err, major, minor, mode;
1112 struct path path;
1113
1114 /* Probably this is an MTD character device node path */
1115 err = kern_path(mtd_dev, LOOKUP_FOLLOW, &path);
1116 if (err)
1117 return ERR_PTR(err);
1118
1119 /* MTD device number is defined by the major / minor numbers */
1120 major = imajor(path.dentry->d_inode);
1121 minor = iminor(path.dentry->d_inode);
1122 mode = path.dentry->d_inode->i_mode;
1123 path_put(&path);
1124 if (major != MTD_CHAR_MAJOR || !S_ISCHR(mode))
1125 return ERR_PTR(-EINVAL);
1126
1127 if (minor & 1)
1128 /*
1129 * Just do not think the "/dev/mtdrX" devices support is need,
1130 * so do not support them to avoid doing extra work.
1131 */
1132 return ERR_PTR(-EINVAL);
1133
1134 return get_mtd_device(NULL, minor / 2);
1135}
1136
1137/**
1138 * open_mtd_device - open MTD device by name, character device path, or number.
1139 * @mtd_dev: name, character device node path, or MTD device device number
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001140 *
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001141 * This function tries to open and MTD device described by @mtd_dev string,
Artem Bityutskiyf9b00802010-01-05 16:48:40 +02001142 * which is first treated as ASCII MTD device number, and if it is not true, it
1143 * is treated as MTD device name, and if that is also not true, it is treated
1144 * as MTD character device node path. Returns MTD device description object in
1145 * case of success and a negative error code in case of failure.
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001146 */
1147static struct mtd_info * __init open_mtd_device(const char *mtd_dev)
1148{
1149 struct mtd_info *mtd;
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001150 int mtd_num;
1151 char *endp;
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001152
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001153 mtd_num = simple_strtoul(mtd_dev, &endp, 0);
1154 if (*endp != '\0' || mtd_dev == endp) {
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001155 /*
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001156 * This does not look like an ASCII integer, probably this is
1157 * MTD device name.
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001158 */
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001159 mtd = get_mtd_device_nm(mtd_dev);
Artem Bityutskiyf9b00802010-01-05 16:48:40 +02001160 if (IS_ERR(mtd) && PTR_ERR(mtd) == -ENODEV)
1161 /* Probably this is an MTD character device node path */
1162 mtd = open_mtd_by_chdev(mtd_dev);
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001163 } else
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001164 mtd = get_mtd_device(NULL, mtd_num);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001165
1166 return mtd;
1167}
1168
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001169static int __init ubi_init(void)
1170{
1171 int err, i, k;
1172
1173 /* Ensure that EC and VID headers have correct size */
1174 BUILD_BUG_ON(sizeof(struct ubi_ec_hdr) != 64);
1175 BUILD_BUG_ON(sizeof(struct ubi_vid_hdr) != 64);
1176
1177 if (mtd_devs > UBI_MAX_DEVICES) {
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001178 ubi_err("too many MTD devices, maximum is %d", UBI_MAX_DEVICES);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001179 return -EINVAL;
1180 }
1181
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001182 /* Create base sysfs directory and sysfs files */
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001183 ubi_class = class_create(THIS_MODULE, UBI_NAME_STR);
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001184 if (IS_ERR(ubi_class)) {
1185 err = PTR_ERR(ubi_class);
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001186 ubi_err("cannot create UBI class");
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001187 goto out;
1188 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001189
1190 err = class_create_file(ubi_class, &ubi_version);
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001191 if (err) {
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001192 ubi_err("cannot create sysfs file");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001193 goto out_class;
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001194 }
1195
1196 err = misc_register(&ubi_ctrl_cdev);
1197 if (err) {
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001198 ubi_err("cannot register device");
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001199 goto out_version;
1200 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001201
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +02001202 ubi_wl_entry_slab = kmem_cache_create("ubi_wl_entry_slab",
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001203 sizeof(struct ubi_wl_entry),
1204 0, 0, NULL);
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +02001205 if (!ubi_wl_entry_slab)
Artem Bityutskiyb9a06622008-01-16 12:11:54 +02001206 goto out_dev_unreg;
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +02001207
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001208 err = ubi_debugfs_init();
1209 if (err)
1210 goto out_slab;
1211
1212
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001213 /* Attach MTD devices */
1214 for (i = 0; i < mtd_devs; i++) {
1215 struct mtd_dev_param *p = &mtd_dev_param[i];
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001216 struct mtd_info *mtd;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001217
1218 cond_resched();
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001219
1220 mtd = open_mtd_device(p->name);
1221 if (IS_ERR(mtd)) {
1222 err = PTR_ERR(mtd);
1223 goto out_detach;
1224 }
1225
1226 mutex_lock(&ubi_devices_mutex);
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001227 err = ubi_attach_mtd_dev(mtd, UBI_DEV_NUM_AUTO,
Richard Genoudedac4932012-08-20 18:00:14 +02001228 p->vid_hdr_offs, p->max_beb_per1024);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001229 mutex_unlock(&ubi_devices_mutex);
1230 if (err < 0) {
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001231 ubi_err("cannot attach mtd%d", mtd->index);
Marc Kleine-Buddeaf7ad7a2010-05-05 10:17:25 +02001232 put_mtd_device(mtd);
1233
1234 /*
1235 * Originally UBI stopped initializing on any error.
1236 * However, later on it was found out that this
1237 * behavior is not very good when UBI is compiled into
1238 * the kernel and the MTD devices to attach are passed
1239 * through the command line. Indeed, UBI failure
1240 * stopped whole boot sequence.
1241 *
1242 * To fix this, we changed the behavior for the
1243 * non-module case, but preserved the old behavior for
1244 * the module case, just for compatibility. This is a
1245 * little inconsistent, though.
1246 */
1247 if (ubi_is_module())
1248 goto out_detach;
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001249 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001250 }
1251
1252 return 0;
1253
1254out_detach:
1255 for (k = 0; k < i; k++)
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001256 if (ubi_devices[k]) {
1257 mutex_lock(&ubi_devices_mutex);
1258 ubi_detach_mtd_dev(ubi_devices[k]->ubi_num, 1);
1259 mutex_unlock(&ubi_devices_mutex);
1260 }
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001261 ubi_debugfs_exit();
1262out_slab:
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +02001263 kmem_cache_destroy(ubi_wl_entry_slab);
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001264out_dev_unreg:
1265 misc_deregister(&ubi_ctrl_cdev);
Artem Bityutskiy3a8d4642007-12-16 12:32:51 +02001266out_version:
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001267 class_remove_file(ubi_class, &ubi_version);
1268out_class:
1269 class_destroy(ubi_class);
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001270out:
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001271 ubi_err("UBI error: cannot initialize UBI, error %d", err);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001272 return err;
1273}
1274module_init(ubi_init);
1275
1276static void __exit ubi_exit(void)
1277{
Artem Bityutskiyb96bf4c2007-12-16 13:01:03 +02001278 int i;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001279
Artem Bityutskiyb96bf4c2007-12-16 13:01:03 +02001280 for (i = 0; i < UBI_MAX_DEVICES; i++)
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001281 if (ubi_devices[i]) {
1282 mutex_lock(&ubi_devices_mutex);
1283 ubi_detach_mtd_dev(ubi_devices[i]->ubi_num, 1);
1284 mutex_unlock(&ubi_devices_mutex);
1285 }
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001286 ubi_debugfs_exit();
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +02001287 kmem_cache_destroy(ubi_wl_entry_slab);
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001288 misc_deregister(&ubi_ctrl_cdev);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001289 class_remove_file(ubi_class, &ubi_version);
1290 class_destroy(ubi_class);
1291}
1292module_exit(ubi_exit);
1293
1294/**
Artem Bityutskiyebaaf1a2008-07-18 13:34:32 +03001295 * bytes_str_to_int - convert a number of bytes string into an integer.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001296 * @str: the string to convert
1297 *
1298 * This function returns positive resulting integer in case of success and a
1299 * negative error code in case of failure.
1300 */
1301static int __init bytes_str_to_int(const char *str)
1302{
1303 char *endp;
1304 unsigned long result;
1305
1306 result = simple_strtoul(str, &endp, 0);
Roel Kluin774b1382009-10-16 14:00:17 +02001307 if (str == endp || result >= INT_MAX) {
Artem Bityutskiy458dbb32007-12-19 17:03:42 +02001308 printk(KERN_ERR "UBI error: incorrect bytes count: \"%s\"\n",
1309 str);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001310 return -EINVAL;
1311 }
1312
1313 switch (*endp) {
1314 case 'G':
1315 result *= 1024;
1316 case 'M':
1317 result *= 1024;
1318 case 'K':
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001319 result *= 1024;
Artem Bityutskiyaeddb872007-12-26 14:25:58 +02001320 if (endp[1] == 'i' && endp[2] == 'B')
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001321 endp += 2;
1322 case '\0':
1323 break;
1324 default:
Artem Bityutskiy458dbb32007-12-19 17:03:42 +02001325 printk(KERN_ERR "UBI error: incorrect bytes count: \"%s\"\n",
1326 str);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001327 return -EINVAL;
1328 }
1329
1330 return result;
1331}
1332
1333/**
1334 * ubi_mtd_param_parse - parse the 'mtd=' UBI parameter.
1335 * @val: the parameter value to parse
1336 * @kp: not used
1337 *
1338 * This function returns zero in case of success and a negative error code in
1339 * case of error.
1340 */
1341static int __init ubi_mtd_param_parse(const char *val, struct kernel_param *kp)
1342{
1343 int i, len;
1344 struct mtd_dev_param *p;
1345 char buf[MTD_PARAM_LEN_MAX];
1346 char *pbuf = &buf[0];
Richard Genoud5993f9b2012-08-17 16:35:19 +02001347 char *tokens[MTD_PARAM_MAX_COUNT];
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001348
Artem Bityutskiy77c722d2007-12-16 16:46:57 +02001349 if (!val)
1350 return -EINVAL;
1351
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001352 if (mtd_devs == UBI_MAX_DEVICES) {
Artem Bityutskiy458dbb32007-12-19 17:03:42 +02001353 printk(KERN_ERR "UBI error: too many parameters, max. is %d\n",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001354 UBI_MAX_DEVICES);
1355 return -EINVAL;
1356 }
1357
1358 len = strnlen(val, MTD_PARAM_LEN_MAX);
1359 if (len == MTD_PARAM_LEN_MAX) {
Artem Bityutskiy458dbb32007-12-19 17:03:42 +02001360 printk(KERN_ERR "UBI error: parameter \"%s\" is too long, "
1361 "max. is %d\n", val, MTD_PARAM_LEN_MAX);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001362 return -EINVAL;
1363 }
1364
1365 if (len == 0) {
Artem Bityutskiy458dbb32007-12-19 17:03:42 +02001366 printk(KERN_WARNING "UBI warning: empty 'mtd=' parameter - "
1367 "ignored\n");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001368 return 0;
1369 }
1370
1371 strcpy(buf, val);
1372
1373 /* Get rid of the final newline */
1374 if (buf[len - 1] == '\n')
Artem Bityutskiy503990e2007-07-11 16:03:29 +03001375 buf[len - 1] = '\0';
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001376
Richard Genoud5993f9b2012-08-17 16:35:19 +02001377 for (i = 0; i < MTD_PARAM_MAX_COUNT; i++)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001378 tokens[i] = strsep(&pbuf, ",");
1379
1380 if (pbuf) {
Artem Bityutskiy458dbb32007-12-19 17:03:42 +02001381 printk(KERN_ERR "UBI error: too many arguments at \"%s\"\n",
1382 val);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001383 return -EINVAL;
1384 }
1385
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001386 p = &mtd_dev_param[mtd_devs];
1387 strcpy(&p->name[0], tokens[0]);
1388
1389 if (tokens[1])
1390 p->vid_hdr_offs = bytes_str_to_int(tokens[1]);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001391
1392 if (p->vid_hdr_offs < 0)
1393 return p->vid_hdr_offs;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001394
Richard Genoudedac4932012-08-20 18:00:14 +02001395 if (tokens[2]) {
1396 int err = kstrtoint(tokens[2], 10, &p->max_beb_per1024);
1397
1398 if (err) {
1399 printk(KERN_ERR "UBI error: bad value for "
1400 "max_beb_per1024 parameter: %s", tokens[2]);
1401 return -EINVAL;
1402 }
1403 }
1404
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001405 mtd_devs += 1;
1406 return 0;
1407}
1408
1409module_param_call(mtd, ubi_mtd_param_parse, NULL, NULL, 000);
Richard Genoudedac4932012-08-20 18:00:14 +02001410MODULE_PARM_DESC(mtd, "MTD devices to attach. Parameter format: mtd=<name|num|path>[,<vid_hdr_offs>[,max_beb_per1024]].\n"
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001411 "Multiple \"mtd\" parameters may be specified.\n"
Richard Genoudedac4932012-08-20 18:00:14 +02001412 "MTD devices may be specified by their number, name, or path to the MTD character device node.\n"
1413 "Optional \"vid_hdr_offs\" parameter specifies UBI VID header position to be used by UBI. (default value if 0)\n"
1414 "Optional \"max_beb_per1024\" parameter specifies the maximum expected bad eraseblock per 1024 eraseblocks. (default value ("
1415 __stringify(CONFIG_MTD_UBI_BEB_LIMIT) ") if 0)\n"
1416 "\n"
1417 "Example 1: mtd=/dev/mtd0 - attach MTD device /dev/mtd0.\n"
1418 "Example 2: mtd=content,1984 mtd=4 - attach MTD device with name \"content\" using VID header offset 1984, and MTD device number 4 with default VID header offset.\n"
1419 "Example 3: mtd=/dev/mtd1,0,25 - attach MTD device /dev/mtd1 using default VID header offset and reserve 25*nand_size_in_blocks/1024 erase blocks for bad block handling.\n"
1420 "\t(e.g. if the NAND *chipset* has 4096 PEB, 100 will be reserved for this UBI device).");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001421
1422MODULE_VERSION(__stringify(UBI_VERSION));
1423MODULE_DESCRIPTION("UBI - Unsorted Block Images");
1424MODULE_AUTHOR("Artem Bityutskiy");
1425MODULE_LICENSE("GPL");