blob: 344b4cb49d4ea1a1075653ed788377b16925095b [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 Bityutskiy9e0c7ef32010-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 Bityutskiy9e0c7ef32010-01-06 14:20:31 +020078static struct mtd_dev_param __initdata mtd_dev_param[UBI_MAX_DEVICES];
Richard Weinberger77e6c2f2012-09-26 17:51:45 +020079#ifdef CONFIG_MTD_UBI_FASTMAP
80/* UBI module parameter to enable fastmap automatically on non-fastmap images */
81static bool fm_autoconvert;
82#endif
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040083/* Root UBI "class" object (corresponds to '/<sysfs>/class/ubi/') */
84struct class *ubi_class;
85
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +020086/* Slab cache for wear-leveling entries */
87struct kmem_cache *ubi_wl_entry_slab;
88
Artem Bityutskiy9f961b52007-12-16 16:59:31 +020089/* UBI control character device */
90static struct miscdevice ubi_ctrl_cdev = {
91 .minor = MISC_DYNAMIC_MINOR,
92 .name = "ubi_ctrl",
93 .fops = &ubi_ctrl_cdev_operations,
94};
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +020095
Artem Bityutskiye73f4452007-12-17 17:37:26 +020096/* All UBI devices in system */
97static struct ubi_device *ubi_devices[UBI_MAX_DEVICES];
98
Artem Bityutskiycdfa7882007-12-17 20:33:20 +020099/* Serializes UBI devices creations and removals */
100DEFINE_MUTEX(ubi_devices_mutex);
101
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200102/* Protects @ubi_devices and @ubi->ref_count */
103static DEFINE_SPINLOCK(ubi_devices_lock);
104
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400105/* "Show" method for files in '/<sysfs>/class/ubi/' */
Artem Bityutskiyc174a082010-09-03 15:11:17 +0300106static ssize_t ubi_version_show(struct class *class,
107 struct class_attribute *attr, char *buf)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400108{
109 return sprintf(buf, "%d\n", UBI_VERSION);
110}
111
112/* UBI version attribute ('/<sysfs>/class/ubi/version') */
113static struct class_attribute ubi_version =
114 __ATTR(version, S_IRUGO, ubi_version_show, NULL);
115
116static ssize_t dev_attribute_show(struct device *dev,
117 struct device_attribute *attr, char *buf);
118
119/* UBI device attributes (correspond to files in '/<sysfs>/class/ubi/ubiX') */
120static struct device_attribute dev_eraseblock_size =
121 __ATTR(eraseblock_size, S_IRUGO, dev_attribute_show, NULL);
122static struct device_attribute dev_avail_eraseblocks =
123 __ATTR(avail_eraseblocks, S_IRUGO, dev_attribute_show, NULL);
124static struct device_attribute dev_total_eraseblocks =
125 __ATTR(total_eraseblocks, S_IRUGO, dev_attribute_show, NULL);
126static struct device_attribute dev_volumes_count =
127 __ATTR(volumes_count, S_IRUGO, dev_attribute_show, NULL);
128static struct device_attribute dev_max_ec =
129 __ATTR(max_ec, S_IRUGO, dev_attribute_show, NULL);
130static struct device_attribute dev_reserved_for_bad =
131 __ATTR(reserved_for_bad, S_IRUGO, dev_attribute_show, NULL);
132static struct device_attribute dev_bad_peb_count =
133 __ATTR(bad_peb_count, S_IRUGO, dev_attribute_show, NULL);
134static struct device_attribute dev_max_vol_count =
135 __ATTR(max_vol_count, S_IRUGO, dev_attribute_show, NULL);
136static struct device_attribute dev_min_io_size =
137 __ATTR(min_io_size, S_IRUGO, dev_attribute_show, NULL);
138static struct device_attribute dev_bgt_enabled =
139 __ATTR(bgt_enabled, S_IRUGO, dev_attribute_show, NULL);
Artem Bityutskiyb6b76ba2007-12-26 13:46:46 +0200140static struct device_attribute dev_mtd_num =
141 __ATTR(mtd_num, S_IRUGO, dev_attribute_show, NULL);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400142
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200143/**
Dmitry Pervushin0e0ee1c2009-04-29 19:29:38 +0400144 * ubi_volume_notify - send a volume change notification.
145 * @ubi: UBI device description object
146 * @vol: volume description object of the changed volume
147 * @ntype: notification type to send (%UBI_VOLUME_ADDED, etc)
148 *
149 * This is a helper function which notifies all subscribers about a volume
150 * change event (creation, removal, re-sizing, re-naming, updating). Returns
151 * zero in case of success and a negative error code in case of failure.
152 */
153int ubi_volume_notify(struct ubi_device *ubi, struct ubi_volume *vol, int ntype)
154{
155 struct ubi_notification nt;
156
157 ubi_do_get_device_info(ubi, &nt.di);
158 ubi_do_get_volume_info(ubi, vol, &nt.vi);
Richard Weinberger77e6c2f2012-09-26 17:51:45 +0200159
160#ifdef CONFIG_MTD_UBI_FASTMAP
161 switch (ntype) {
162 case UBI_VOLUME_ADDED:
163 case UBI_VOLUME_REMOVED:
164 case UBI_VOLUME_RESIZED:
165 case UBI_VOLUME_RENAMED:
166 if (ubi_update_fastmap(ubi)) {
167 ubi_err("Unable to update fastmap!");
168 ubi_ro_mode(ubi);
169 }
170 }
171#endif
Dmitry Pervushin0e0ee1c2009-04-29 19:29:38 +0400172 return blocking_notifier_call_chain(&ubi_notifiers, ntype, &nt);
173}
174
175/**
176 * ubi_notify_all - send a notification to all volumes.
177 * @ubi: UBI device description object
178 * @ntype: notification type to send (%UBI_VOLUME_ADDED, etc)
179 * @nb: the notifier to call
180 *
181 * This function walks all volumes of UBI device @ubi and sends the @ntype
182 * notification for each volume. If @nb is %NULL, then all registered notifiers
183 * are called, otherwise only the @nb notifier is called. Returns the number of
184 * sent notifications.
185 */
186int ubi_notify_all(struct ubi_device *ubi, int ntype, struct notifier_block *nb)
187{
188 struct ubi_notification nt;
189 int i, count = 0;
190
191 ubi_do_get_device_info(ubi, &nt.di);
192
193 mutex_lock(&ubi->device_mutex);
194 for (i = 0; i < ubi->vtbl_slots; i++) {
195 /*
196 * Since the @ubi->device is locked, and we are not going to
197 * change @ubi->volumes, we do not have to lock
198 * @ubi->volumes_lock.
199 */
200 if (!ubi->volumes[i])
201 continue;
202
203 ubi_do_get_volume_info(ubi, ubi->volumes[i], &nt.vi);
204 if (nb)
205 nb->notifier_call(nb, ntype, &nt);
206 else
207 blocking_notifier_call_chain(&ubi_notifiers, ntype,
208 &nt);
209 count += 1;
210 }
211 mutex_unlock(&ubi->device_mutex);
212
213 return count;
214}
215
216/**
217 * ubi_enumerate_volumes - send "add" notification for all existing volumes.
218 * @nb: the notifier to call
219 *
220 * This function walks all UBI devices and volumes and sends the
221 * %UBI_VOLUME_ADDED notification for each volume. If @nb is %NULL, then all
222 * registered notifiers are called, otherwise only the @nb notifier is called.
223 * Returns the number of sent notifications.
224 */
225int ubi_enumerate_volumes(struct notifier_block *nb)
226{
227 int i, count = 0;
228
229 /*
230 * Since the @ubi_devices_mutex is locked, and we are not going to
231 * change @ubi_devices, we do not have to lock @ubi_devices_lock.
232 */
233 for (i = 0; i < UBI_MAX_DEVICES; i++) {
234 struct ubi_device *ubi = ubi_devices[i];
235
236 if (!ubi)
237 continue;
238 count += ubi_notify_all(ubi, UBI_VOLUME_ADDED, nb);
239 }
240
241 return count;
242}
243
244/**
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200245 * ubi_get_device - get UBI device.
246 * @ubi_num: UBI device number
247 *
248 * This function returns UBI device description object for UBI device number
249 * @ubi_num, or %NULL if the device does not exist. This function increases the
250 * device reference count to prevent removal of the device. In other words, the
251 * device cannot be removed if its reference count is not zero.
252 */
253struct ubi_device *ubi_get_device(int ubi_num)
254{
255 struct ubi_device *ubi;
256
257 spin_lock(&ubi_devices_lock);
258 ubi = ubi_devices[ubi_num];
259 if (ubi) {
260 ubi_assert(ubi->ref_count >= 0);
261 ubi->ref_count += 1;
262 get_device(&ubi->dev);
263 }
264 spin_unlock(&ubi_devices_lock);
265
266 return ubi;
267}
268
269/**
270 * ubi_put_device - drop an UBI device reference.
271 * @ubi: UBI device description object
272 */
273void ubi_put_device(struct ubi_device *ubi)
274{
275 spin_lock(&ubi_devices_lock);
276 ubi->ref_count -= 1;
277 put_device(&ubi->dev);
278 spin_unlock(&ubi_devices_lock);
279}
280
281/**
Artem Bityutskiyebaaf1a2008-07-18 13:34:32 +0300282 * ubi_get_by_major - get UBI device by character device major number.
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200283 * @major: major number
284 *
285 * This function is similar to 'ubi_get_device()', but it searches the device
286 * by its major number.
287 */
288struct ubi_device *ubi_get_by_major(int major)
289{
290 int i;
291 struct ubi_device *ubi;
292
293 spin_lock(&ubi_devices_lock);
294 for (i = 0; i < UBI_MAX_DEVICES; i++) {
295 ubi = ubi_devices[i];
296 if (ubi && MAJOR(ubi->cdev.dev) == major) {
297 ubi_assert(ubi->ref_count >= 0);
298 ubi->ref_count += 1;
299 get_device(&ubi->dev);
300 spin_unlock(&ubi_devices_lock);
301 return ubi;
302 }
303 }
304 spin_unlock(&ubi_devices_lock);
305
306 return NULL;
307}
308
309/**
310 * ubi_major2num - get UBI device number by character device major number.
311 * @major: major number
312 *
313 * This function searches UBI device number object by its major number. If UBI
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200314 * device was not found, this function returns -ENODEV, otherwise the UBI device
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200315 * number is returned.
316 */
317int ubi_major2num(int major)
318{
319 int i, ubi_num = -ENODEV;
320
321 spin_lock(&ubi_devices_lock);
322 for (i = 0; i < UBI_MAX_DEVICES; i++) {
323 struct ubi_device *ubi = ubi_devices[i];
324
325 if (ubi && MAJOR(ubi->cdev.dev) == major) {
326 ubi_num = ubi->ubi_num;
327 break;
328 }
329 }
330 spin_unlock(&ubi_devices_lock);
331
332 return ubi_num;
333}
334
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400335/* "Show" method for files in '/<sysfs>/class/ubi/ubiX/' */
336static ssize_t dev_attribute_show(struct device *dev,
337 struct device_attribute *attr, char *buf)
338{
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200339 ssize_t ret;
340 struct ubi_device *ubi;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400341
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200342 /*
343 * The below code looks weird, but it actually makes sense. We get the
344 * UBI device reference from the contained 'struct ubi_device'. But it
345 * is unclear if the device was removed or not yet. Indeed, if the
346 * device was removed before we increased its reference count,
347 * 'ubi_get_device()' will return -ENODEV and we fail.
348 *
349 * Remember, 'struct ubi_device' is freed in the release function, so
350 * we still can use 'ubi->ubi_num'.
351 */
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400352 ubi = container_of(dev, struct ubi_device, dev);
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200353 ubi = ubi_get_device(ubi->ubi_num);
354 if (!ubi)
355 return -ENODEV;
356
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400357 if (attr == &dev_eraseblock_size)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200358 ret = sprintf(buf, "%d\n", ubi->leb_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400359 else if (attr == &dev_avail_eraseblocks)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200360 ret = sprintf(buf, "%d\n", ubi->avail_pebs);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400361 else if (attr == &dev_total_eraseblocks)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200362 ret = sprintf(buf, "%d\n", ubi->good_peb_count);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400363 else if (attr == &dev_volumes_count)
Artem Bityutskiy4b3cc342007-12-26 15:59:39 +0200364 ret = sprintf(buf, "%d\n", ubi->vol_count - UBI_INT_VOL_COUNT);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400365 else if (attr == &dev_max_ec)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200366 ret = sprintf(buf, "%d\n", ubi->max_ec);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400367 else if (attr == &dev_reserved_for_bad)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200368 ret = sprintf(buf, "%d\n", ubi->beb_rsvd_pebs);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400369 else if (attr == &dev_bad_peb_count)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200370 ret = sprintf(buf, "%d\n", ubi->bad_peb_count);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400371 else if (attr == &dev_max_vol_count)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200372 ret = sprintf(buf, "%d\n", ubi->vtbl_slots);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400373 else if (attr == &dev_min_io_size)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200374 ret = sprintf(buf, "%d\n", ubi->min_io_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400375 else if (attr == &dev_bgt_enabled)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200376 ret = sprintf(buf, "%d\n", ubi->thread_enabled);
Artem Bityutskiyb6b76ba2007-12-26 13:46:46 +0200377 else if (attr == &dev_mtd_num)
378 ret = sprintf(buf, "%d\n", ubi->mtd->index);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400379 else
Artem Bityutskiyb6b76ba2007-12-26 13:46:46 +0200380 ret = -EINVAL;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400381
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200382 ubi_put_device(ubi);
383 return ret;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400384}
385
Artem Bityutskiy36b477d2009-01-20 18:04:09 +0200386static void dev_release(struct device *dev)
387{
388 struct ubi_device *ubi = container_of(dev, struct ubi_device, dev);
389
390 kfree(ubi);
391}
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400392
393/**
394 * ubi_sysfs_init - initialize sysfs for an UBI device.
395 * @ubi: UBI device description object
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200396 * @ref: set to %1 on exit in case of failure if a reference to @ubi->dev was
397 * taken
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400398 *
399 * This function returns zero in case of success and a negative error code in
400 * case of failure.
401 */
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200402static int ubi_sysfs_init(struct ubi_device *ubi, int *ref)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400403{
404 int err;
405
406 ubi->dev.release = dev_release;
Artem Bityutskiy49dfc292007-12-15 18:13:56 +0200407 ubi->dev.devt = ubi->cdev.dev;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400408 ubi->dev.class = ubi_class;
Kay Sievers160bbab2008-12-23 10:00:14 +0000409 dev_set_name(&ubi->dev, UBI_NAME_STR"%d", ubi->ubi_num);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400410 err = device_register(&ubi->dev);
411 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200412 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400413
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200414 *ref = 1;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400415 err = device_create_file(&ubi->dev, &dev_eraseblock_size);
416 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200417 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400418 err = device_create_file(&ubi->dev, &dev_avail_eraseblocks);
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_total_eraseblocks);
422 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200423 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400424 err = device_create_file(&ubi->dev, &dev_volumes_count);
425 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200426 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400427 err = device_create_file(&ubi->dev, &dev_max_ec);
428 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200429 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400430 err = device_create_file(&ubi->dev, &dev_reserved_for_bad);
431 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200432 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400433 err = device_create_file(&ubi->dev, &dev_bad_peb_count);
434 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200435 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400436 err = device_create_file(&ubi->dev, &dev_max_vol_count);
437 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200438 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400439 err = device_create_file(&ubi->dev, &dev_min_io_size);
440 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200441 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400442 err = device_create_file(&ubi->dev, &dev_bgt_enabled);
Artem Bityutskiyb6b76ba2007-12-26 13:46:46 +0200443 if (err)
444 return err;
445 err = device_create_file(&ubi->dev, &dev_mtd_num);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400446 return err;
447}
448
449/**
450 * ubi_sysfs_close - close sysfs for an UBI device.
451 * @ubi: UBI device description object
452 */
453static void ubi_sysfs_close(struct ubi_device *ubi)
454{
Artem Bityutskiyb6b76ba2007-12-26 13:46:46 +0200455 device_remove_file(&ubi->dev, &dev_mtd_num);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400456 device_remove_file(&ubi->dev, &dev_bgt_enabled);
457 device_remove_file(&ubi->dev, &dev_min_io_size);
458 device_remove_file(&ubi->dev, &dev_max_vol_count);
459 device_remove_file(&ubi->dev, &dev_bad_peb_count);
460 device_remove_file(&ubi->dev, &dev_reserved_for_bad);
461 device_remove_file(&ubi->dev, &dev_max_ec);
462 device_remove_file(&ubi->dev, &dev_volumes_count);
463 device_remove_file(&ubi->dev, &dev_total_eraseblocks);
464 device_remove_file(&ubi->dev, &dev_avail_eraseblocks);
465 device_remove_file(&ubi->dev, &dev_eraseblock_size);
466 device_unregister(&ubi->dev);
467}
468
469/**
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200470 * kill_volumes - destroy all user volumes.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400471 * @ubi: UBI device description object
472 */
473static void kill_volumes(struct ubi_device *ubi)
474{
475 int i;
476
477 for (i = 0; i < ubi->vtbl_slots; i++)
478 if (ubi->volumes[i])
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200479 ubi_free_volume(ubi, ubi->volumes[i]);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400480}
481
482/**
483 * uif_init - initialize user interfaces for an UBI device.
484 * @ubi: UBI device description object
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200485 * @ref: set to %1 on exit in case of failure if a reference to @ubi->dev was
486 * taken, otherwise set to %0
487 *
488 * This function initializes various user interfaces for an UBI device. If the
489 * initialization fails at an early stage, this function frees all the
490 * resources it allocated, returns an error, and @ref is set to %0. However,
491 * if the initialization fails after the UBI device was registered in the
492 * driver core subsystem, this function takes a reference to @ubi->dev, because
493 * otherwise the release function ('dev_release()') would free whole @ubi
494 * object. The @ref argument is set to %1 in this case. The caller has to put
495 * this reference.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400496 *
497 * This function returns zero in case of success and a negative error code in
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200498 * case of failure.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400499 */
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200500static int uif_init(struct ubi_device *ubi, int *ref)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400501{
Artem Bityutskiy8c4c19f2009-01-20 17:48:02 +0200502 int i, err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400503 dev_t dev;
504
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200505 *ref = 0;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400506 sprintf(ubi->ubi_name, UBI_NAME_STR "%d", ubi->ubi_num);
507
508 /*
509 * Major numbers for the UBI character devices are allocated
510 * dynamically. Major numbers of volume character devices are
511 * equivalent to ones of the corresponding UBI character device. Minor
512 * numbers of UBI character devices are 0, while minor numbers of
513 * volume character devices start from 1. Thus, we allocate one major
514 * number and ubi->vtbl_slots + 1 minor numbers.
515 */
516 err = alloc_chrdev_region(&dev, 0, ubi->vtbl_slots + 1, ubi->ubi_name);
517 if (err) {
518 ubi_err("cannot register UBI character devices");
519 return err;
520 }
521
Artem Bityutskiy49dfc292007-12-15 18:13:56 +0200522 ubi_assert(MINOR(dev) == 0);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400523 cdev_init(&ubi->cdev, &ubi_cdev_operations);
Artem Bityutskiyc8566352008-07-16 17:40:22 +0300524 dbg_gen("%s major is %u", ubi->ubi_name, MAJOR(dev));
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400525 ubi->cdev.owner = THIS_MODULE;
526
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400527 err = cdev_add(&ubi->cdev, dev, 1);
528 if (err) {
Artem Bityutskiy01f7b302007-12-15 19:56:51 +0200529 ubi_err("cannot add character device");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400530 goto out_unreg;
531 }
532
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200533 err = ubi_sysfs_init(ubi, ref);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400534 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200535 goto out_sysfs;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400536
537 for (i = 0; i < ubi->vtbl_slots; i++)
538 if (ubi->volumes[i]) {
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200539 err = ubi_add_volume(ubi, ubi->volumes[i]);
Artem Bityutskiy01f7b302007-12-15 19:56:51 +0200540 if (err) {
541 ubi_err("cannot add volume %d", i);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400542 goto out_volumes;
Artem Bityutskiy01f7b302007-12-15 19:56:51 +0200543 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400544 }
545
546 return 0;
547
548out_volumes:
549 kill_volumes(ubi);
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200550out_sysfs:
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200551 if (*ref)
552 get_device(&ubi->dev);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400553 ubi_sysfs_close(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400554 cdev_del(&ubi->cdev);
555out_unreg:
Artem Bityutskiy49dfc292007-12-15 18:13:56 +0200556 unregister_chrdev_region(ubi->cdev.dev, ubi->vtbl_slots + 1);
Artem Bityutskiy01f7b302007-12-15 19:56:51 +0200557 ubi_err("cannot initialize UBI %s, error %d", ubi->ubi_name, err);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400558 return err;
559}
560
561/**
562 * uif_close - close user interfaces for an UBI device.
563 * @ubi: UBI device description object
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300564 *
565 * Note, since this function un-registers UBI volume device objects (@vol->dev),
566 * the memory allocated voe the volumes is freed as well (in the release
567 * function).
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400568 */
569static void uif_close(struct ubi_device *ubi)
570{
571 kill_volumes(ubi);
572 ubi_sysfs_close(ubi);
573 cdev_del(&ubi->cdev);
Artem Bityutskiy49dfc292007-12-15 18:13:56 +0200574 unregister_chrdev_region(ubi->cdev.dev, ubi->vtbl_slots + 1);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400575}
576
577/**
Artem Bityutskiy47e1ec72012-05-18 12:41:17 +0300578 * ubi_free_internal_volumes - free internal volumes.
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300579 * @ubi: UBI device description object
580 */
Artem Bityutskiy47e1ec72012-05-18 12:41:17 +0300581void ubi_free_internal_volumes(struct ubi_device *ubi)
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300582{
583 int i;
584
585 for (i = ubi->vtbl_slots;
586 i < ubi->vtbl_slots + UBI_INT_VOL_COUNT; i++) {
587 kfree(ubi->volumes[i]->eba_tbl);
588 kfree(ubi->volumes[i]);
589 }
590}
591
Richard Genoud95e6fb02012-08-17 16:35:18 +0200592static int get_bad_peb_limit(const struct ubi_device *ubi, int max_beb_per1024)
593{
594 int limit, device_pebs;
595 uint64_t device_size;
596
597 if (!max_beb_per1024)
598 return 0;
599
600 /*
601 * Here we are using size of the entire flash chip and
602 * not just the MTD partition size because the maximum
603 * number of bad eraseblocks is a percentage of the
604 * whole device and bad eraseblocks are not fairly
605 * distributed over the flash chip. So the worst case
606 * is that all the bad eraseblocks of the chip are in
607 * the MTD partition we are attaching (ubi->mtd).
608 */
609 device_size = mtd_get_device_size(ubi->mtd);
610 device_pebs = mtd_div_by_eb(device_size, ubi->mtd);
611 limit = mult_frac(device_pebs, max_beb_per1024, 1024);
612
613 /* Round it up */
614 if (mult_frac(limit, 1024, max_beb_per1024) < device_pebs)
615 limit += 1;
616
617 return limit;
618}
619
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300620/**
Artem Bityutskiy85c6e6e2008-07-16 10:25:56 +0300621 * io_init - initialize I/O sub-system for a given UBI device.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400622 * @ubi: UBI device description object
Richard Genoud256334c2012-08-20 18:00:11 +0200623 * @max_beb_per1024: maximum expected number of bad PEB per 1024 PEBs
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400624 *
625 * If @ubi->vid_hdr_offset or @ubi->leb_start is zero, default offsets are
626 * assumed:
627 * o EC header is always at offset zero - this cannot be changed;
628 * o VID header starts just after the EC header at the closest address
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200629 * aligned to @io->hdrs_min_io_size;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400630 * o data starts just after the VID header at the closest address aligned to
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200631 * @io->min_io_size
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400632 *
633 * This function returns zero in case of success and a negative error code in
634 * case of failure.
635 */
Richard Genoud256334c2012-08-20 18:00:11 +0200636static int io_init(struct ubi_device *ubi, int max_beb_per1024)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400637{
Artem Bityutskiy719bb842012-08-27 17:14:58 +0300638 dbg_gen("sizeof(struct ubi_ainf_peb) %zu", sizeof(struct ubi_ainf_peb));
639 dbg_gen("sizeof(struct ubi_wl_entry) %zu", sizeof(struct ubi_wl_entry));
640
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400641 if (ubi->mtd->numeraseregions != 0) {
642 /*
643 * Some flashes have several erase regions. Different regions
644 * may have different eraseblock size and other
645 * characteristics. It looks like mostly multi-region flashes
646 * have one "main" region and one or more small regions to
647 * store boot loader code or boot parameters or whatever. I
648 * guess we should just pick the largest region. But this is
649 * not implemented.
650 */
651 ubi_err("multiple regions, not implemented");
652 return -EINVAL;
653 }
654
Artem Bityutskiydd38fcc2007-12-19 21:43:32 +0200655 if (ubi->vid_hdr_offset < 0)
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200656 return -EINVAL;
657
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400658 /*
659 * Note, in this implementation we support MTD devices with 0x7FFFFFFF
660 * physical eraseblocks maximum.
661 */
662
663 ubi->peb_size = ubi->mtd->erasesize;
Adrian Hunter69423d92008-12-10 13:37:21 +0000664 ubi->peb_count = mtd_div_by_eb(ubi->mtd->size, ubi->mtd);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400665 ubi->flash_size = ubi->mtd->size;
666
Shmulik Ladkani8beeb3b2012-07-04 11:06:00 +0300667 if (mtd_can_have_bb(ubi->mtd)) {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400668 ubi->bad_allowed = 1;
Richard Genoud95e6fb02012-08-17 16:35:18 +0200669 ubi->bad_peb_limit = get_bad_peb_limit(ubi, max_beb_per1024);
Shmulik Ladkani8beeb3b2012-07-04 11:06:00 +0300670 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400671
Artem Bityutskiyebf53f42009-07-06 08:57:53 +0300672 if (ubi->mtd->type == MTD_NORFLASH) {
673 ubi_assert(ubi->mtd->writesize == 1);
674 ubi->nor_flash = 1;
675 }
676
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400677 ubi->min_io_size = ubi->mtd->writesize;
678 ubi->hdrs_min_io_size = ubi->mtd->writesize >> ubi->mtd->subpage_sft;
679
Kyungmin Parkcadb40c2008-05-22 10:32:18 +0900680 /*
681 * Make sure minimal I/O unit is power of 2. Note, there is no
682 * fundamental reason for this assumption. It is just an optimization
683 * which allows us to avoid costly division operations.
684 */
Vignesh Babu7753f162007-06-12 10:31:05 +0530685 if (!is_power_of_2(ubi->min_io_size)) {
Artem Bityutskiy01f7b302007-12-15 19:56:51 +0200686 ubi_err("min. I/O unit (%d) is not power of 2",
687 ubi->min_io_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400688 return -EINVAL;
689 }
690
691 ubi_assert(ubi->hdrs_min_io_size > 0);
692 ubi_assert(ubi->hdrs_min_io_size <= ubi->min_io_size);
693 ubi_assert(ubi->min_io_size % ubi->hdrs_min_io_size == 0);
694
Artem Bityutskiy30b542e2011-01-30 18:37:33 +0200695 ubi->max_write_size = ubi->mtd->writebufsize;
696 /*
697 * Maximum write size has to be greater or equivalent to min. I/O
698 * size, and be multiple of min. I/O size.
699 */
700 if (ubi->max_write_size < ubi->min_io_size ||
701 ubi->max_write_size % ubi->min_io_size ||
702 !is_power_of_2(ubi->max_write_size)) {
703 ubi_err("bad write buffer size %d for %d min. I/O unit",
704 ubi->max_write_size, ubi->min_io_size);
705 return -EINVAL;
706 }
707
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400708 /* Calculate default aligned sizes of EC and VID headers */
709 ubi->ec_hdr_alsize = ALIGN(UBI_EC_HDR_SIZE, ubi->hdrs_min_io_size);
710 ubi->vid_hdr_alsize = ALIGN(UBI_VID_HDR_SIZE, ubi->hdrs_min_io_size);
711
Artem Bityutskiy719bb842012-08-27 17:14:58 +0300712 dbg_gen("min_io_size %d", ubi->min_io_size);
713 dbg_gen("max_write_size %d", ubi->max_write_size);
714 dbg_gen("hdrs_min_io_size %d", ubi->hdrs_min_io_size);
715 dbg_gen("ec_hdr_alsize %d", ubi->ec_hdr_alsize);
716 dbg_gen("vid_hdr_alsize %d", ubi->vid_hdr_alsize);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400717
718 if (ubi->vid_hdr_offset == 0)
719 /* Default offset */
720 ubi->vid_hdr_offset = ubi->vid_hdr_aloffset =
721 ubi->ec_hdr_alsize;
722 else {
723 ubi->vid_hdr_aloffset = ubi->vid_hdr_offset &
724 ~(ubi->hdrs_min_io_size - 1);
725 ubi->vid_hdr_shift = ubi->vid_hdr_offset -
726 ubi->vid_hdr_aloffset;
727 }
728
729 /* Similar for the data offset */
John Ognesse8cfe002011-01-21 15:39:02 +0100730 ubi->leb_start = ubi->vid_hdr_offset + UBI_VID_HDR_SIZE;
Artem Bityutskiydd38fcc2007-12-19 21:43:32 +0200731 ubi->leb_start = ALIGN(ubi->leb_start, ubi->min_io_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400732
Artem Bityutskiy719bb842012-08-27 17:14:58 +0300733 dbg_gen("vid_hdr_offset %d", ubi->vid_hdr_offset);
734 dbg_gen("vid_hdr_aloffset %d", ubi->vid_hdr_aloffset);
735 dbg_gen("vid_hdr_shift %d", ubi->vid_hdr_shift);
736 dbg_gen("leb_start %d", ubi->leb_start);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400737
738 /* The shift must be aligned to 32-bit boundary */
739 if (ubi->vid_hdr_shift % 4) {
740 ubi_err("unaligned VID header shift %d",
741 ubi->vid_hdr_shift);
742 return -EINVAL;
743 }
744
745 /* Check sanity */
746 if (ubi->vid_hdr_offset < UBI_EC_HDR_SIZE ||
747 ubi->leb_start < ubi->vid_hdr_offset + UBI_VID_HDR_SIZE ||
748 ubi->leb_start > ubi->peb_size - UBI_VID_HDR_SIZE ||
Kyungmin Parkcadb40c2008-05-22 10:32:18 +0900749 ubi->leb_start & (ubi->min_io_size - 1)) {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400750 ubi_err("bad VID header (%d) or data offsets (%d)",
751 ubi->vid_hdr_offset, ubi->leb_start);
752 return -EINVAL;
753 }
754
755 /*
Artem Bityutskiyb86a2c52009-05-24 14:13:34 +0300756 * Set maximum amount of physical erroneous eraseblocks to be 10%.
757 * Erroneous PEB are those which have read errors.
758 */
759 ubi->max_erroneous = ubi->peb_count / 10;
760 if (ubi->max_erroneous < 16)
761 ubi->max_erroneous = 16;
Artem Bityutskiy719bb842012-08-27 17:14:58 +0300762 dbg_gen("max_erroneous %d", ubi->max_erroneous);
Artem Bityutskiyb86a2c52009-05-24 14:13:34 +0300763
764 /*
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400765 * It may happen that EC and VID headers are situated in one minimal
766 * I/O unit. In this case we can only accept this UBI image in
767 * read-only mode.
768 */
769 if (ubi->vid_hdr_offset + UBI_VID_HDR_SIZE <= ubi->hdrs_min_io_size) {
Artem Bityutskiy049333c2012-08-27 14:43:54 +0300770 ubi_warn("EC and VID headers are in the same minimal I/O unit, switch to read-only mode");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400771 ubi->ro_mode = 1;
772 }
773
774 ubi->leb_size = ubi->peb_size - ubi->leb_start;
775
776 if (!(ubi->mtd->flags & MTD_WRITEABLE)) {
Artem Bityutskiy049333c2012-08-27 14:43:54 +0300777 ubi_msg("MTD device %d is write-protected, attach in read-only mode",
778 ubi->mtd->index);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400779 ubi->ro_mode = 1;
780 }
781
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400782 /*
Artem Bityutskiyfbd01072012-05-17 16:12:26 +0300783 * Note, ideally, we have to initialize @ubi->bad_peb_count here. But
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400784 * unfortunately, MTD does not provide this information. We should loop
785 * over all physical eraseblocks and invoke mtd->block_is_bad() for
Artem Bityutskiyfbd01072012-05-17 16:12:26 +0300786 * each physical eraseblock. So, we leave @ubi->bad_peb_count
787 * uninitialized so far.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400788 */
789
790 return 0;
791}
792
793/**
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200794 * autoresize - re-size the volume which has the "auto-resize" flag set.
795 * @ubi: UBI device description object
796 * @vol_id: ID of the volume to re-size
797 *
Artem Bityutskiyfbd01072012-05-17 16:12:26 +0300798 * This function re-sizes the volume marked by the %UBI_VTBL_AUTORESIZE_FLG in
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200799 * the volume table to the largest possible size. See comments in ubi-header.h
800 * for more description of the flag. Returns zero in case of success and a
801 * negative error code in case of failure.
802 */
803static int autoresize(struct ubi_device *ubi, int vol_id)
804{
805 struct ubi_volume_desc desc;
806 struct ubi_volume *vol = ubi->volumes[vol_id];
807 int err, old_reserved_pebs = vol->reserved_pebs;
808
Artem Bityutskiyabb3e012012-08-18 14:11:42 +0200809 if (ubi->ro_mode) {
810 ubi_warn("skip auto-resize because of R/O mode");
811 return 0;
812 }
813
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200814 /*
815 * Clear the auto-resize flag in the volume in-memory copy of the
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300816 * volume table, and 'ubi_resize_volume()' will propagate this change
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200817 * to the flash.
818 */
819 ubi->vtbl[vol_id].flags &= ~UBI_VTBL_AUTORESIZE_FLG;
820
821 if (ubi->avail_pebs == 0) {
822 struct ubi_vtbl_record vtbl_rec;
823
824 /*
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300825 * No available PEBs to re-size the volume, clear the flag on
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200826 * flash and exit.
827 */
828 memcpy(&vtbl_rec, &ubi->vtbl[vol_id],
829 sizeof(struct ubi_vtbl_record));
830 err = ubi_change_vtbl_record(ubi, vol_id, &vtbl_rec);
831 if (err)
832 ubi_err("cannot clean auto-resize flag for volume %d",
833 vol_id);
834 } else {
835 desc.vol = vol;
836 err = ubi_resize_volume(&desc,
837 old_reserved_pebs + ubi->avail_pebs);
838 if (err)
839 ubi_err("cannot auto-resize volume %d", vol_id);
840 }
841
842 if (err)
843 return err;
844
845 ubi_msg("volume %d (\"%s\") re-sized from %d to %d LEBs", vol_id,
846 vol->name, old_reserved_pebs, vol->reserved_pebs);
847 return 0;
848}
849
850/**
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200851 * ubi_attach_mtd_dev - attach an MTD device.
Artem Bityutskiyebaaf1a2008-07-18 13:34:32 +0300852 * @mtd: MTD device description object
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200853 * @ubi_num: number to assign to the new UBI device
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400854 * @vid_hdr_offset: VID header offset
Richard Genoudedac4932012-08-20 18:00:14 +0200855 * @max_beb_per1024: maximum expected number of bad PEB per 1024 PEBs
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400856 *
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200857 * This function attaches MTD device @mtd_dev to UBI and assign @ubi_num number
858 * to the newly created UBI device, unless @ubi_num is %UBI_DEV_NUM_AUTO, in
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300859 * which case this function finds a vacant device number and assigns it
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200860 * automatically. Returns the new UBI device number in case of success and a
861 * negative error code in case of failure.
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200862 *
863 * Note, the invocations of this function has to be serialized by the
864 * @ubi_devices_mutex.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400865 */
Richard Genoud256334c2012-08-20 18:00:11 +0200866int ubi_attach_mtd_dev(struct mtd_info *mtd, int ubi_num,
867 int vid_hdr_offset, int max_beb_per1024)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400868{
869 struct ubi_device *ubi;
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200870 int i, err, ref = 0;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400871
Richard Genoudd2f588f92012-08-20 18:00:13 +0200872 if (max_beb_per1024 < 0 || max_beb_per1024 > MAX_MTD_UBI_BEB_LIMIT)
873 return -EINVAL;
874
875 if (!max_beb_per1024)
876 max_beb_per1024 = CONFIG_MTD_UBI_BEB_LIMIT;
877
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200878 /*
879 * Check if we already have the same MTD device attached.
880 *
881 * Note, this function assumes that UBI devices creations and deletions
882 * are serialized, so it does not take the &ubi_devices_lock.
883 */
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200884 for (i = 0; i < UBI_MAX_DEVICES; i++) {
Artem Bityutskiyb96bf4c2007-12-16 13:01:03 +0200885 ubi = ubi_devices[i];
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200886 if (ubi && mtd->index == ubi->mtd->index) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300887 ubi_err("mtd%d is already attached to ubi%d",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400888 mtd->index, i);
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200889 return -EEXIST;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400890 }
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200891 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400892
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200893 /*
894 * Make sure this MTD device is not emulated on top of an UBI volume
895 * already. Well, generally this recursion works fine, but there are
896 * different problems like the UBI module takes a reference to itself
897 * by attaching (and thus, opening) the emulated MTD device. This
898 * results in inability to unload the module. And in general it makes
899 * no sense to attach emulated MTD devices, so we prohibit this.
900 */
901 if (mtd->type == MTD_UBIVOLUME) {
Artem Bityutskiy049333c2012-08-27 14:43:54 +0300902 ubi_err("refuse attaching mtd%d - it is already emulated on top of UBI",
903 mtd->index);
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200904 return -EINVAL;
905 }
Artem Bityutskiyb96bf4c2007-12-16 13:01:03 +0200906
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200907 if (ubi_num == UBI_DEV_NUM_AUTO) {
908 /* Search for an empty slot in the @ubi_devices array */
909 for (ubi_num = 0; ubi_num < UBI_MAX_DEVICES; ubi_num++)
910 if (!ubi_devices[ubi_num])
911 break;
912 if (ubi_num == UBI_MAX_DEVICES) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300913 ubi_err("only %d UBI devices may be created",
Artem Bityutskiy9c9ec142008-07-18 13:19:52 +0300914 UBI_MAX_DEVICES);
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200915 return -ENFILE;
916 }
917 } else {
918 if (ubi_num >= UBI_MAX_DEVICES)
919 return -EINVAL;
920
921 /* Make sure ubi_num is not busy */
922 if (ubi_devices[ubi_num]) {
Artem Bityutskiye2986822012-05-16 18:39:56 +0300923 ubi_err("ubi%d already exists", ubi_num);
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200924 return -EEXIST;
925 }
Artem Bityutskiyb96bf4c2007-12-16 13:01:03 +0200926 }
927
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200928 ubi = kzalloc(sizeof(struct ubi_device), GFP_KERNEL);
929 if (!ubi)
930 return -ENOMEM;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400931
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200932 ubi->mtd = mtd;
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200933 ubi->ubi_num = ubi_num;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400934 ubi->vid_hdr_offset = vid_hdr_offset;
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200935 ubi->autoresize_vol_id = -1;
936
Richard Weinberger77e6c2f2012-09-26 17:51:45 +0200937#ifdef CONFIG_MTD_UBI_FASTMAP
938 ubi->fm_pool.used = ubi->fm_pool.size = 0;
939 ubi->fm_wl_pool.used = ubi->fm_wl_pool.size = 0;
940
941 /*
942 * fm_pool.max_size is 5% of the total number of PEBs but it's also
943 * between UBI_FM_MAX_POOL_SIZE and UBI_FM_MIN_POOL_SIZE.
944 */
945 ubi->fm_pool.max_size = min(((int)mtd_div_by_eb(ubi->mtd->size,
946 ubi->mtd) / 100) * 5, UBI_FM_MAX_POOL_SIZE);
947 if (ubi->fm_pool.max_size < UBI_FM_MIN_POOL_SIZE)
948 ubi->fm_pool.max_size = UBI_FM_MIN_POOL_SIZE;
949
950 ubi->fm_wl_pool.max_size = UBI_FM_WL_POOL_SIZE;
951 ubi->fm_disabled = !fm_autoconvert;
952
953 if (!ubi->fm_disabled && (int)mtd_div_by_eb(ubi->mtd->size, ubi->mtd)
954 <= UBI_FM_MAX_START) {
955 ubi_err("More than %i PEBs are needed for fastmap, sorry.",
956 UBI_FM_MAX_START);
957 ubi->fm_disabled = 1;
958 }
959
960 ubi_msg("default fastmap pool size: %d", ubi->fm_pool.max_size);
961 ubi_msg("default fastmap WL pool size: %d", ubi->fm_wl_pool.max_size);
962#else
963 ubi->fm_disabled = 1;
964#endif
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200965 mutex_init(&ubi->buf_mutex);
966 mutex_init(&ubi->ckvol_mutex);
Artem Bityutskiyf089c0b2009-05-07 11:46:49 +0300967 mutex_init(&ubi->device_mutex);
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200968 spin_lock_init(&ubi->volumes_lock);
Richard Weinberger77e6c2f2012-09-26 17:51:45 +0200969 mutex_init(&ubi->fm_mutex);
970 init_rwsem(&ubi->fm_sem);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200971
Artem Bityutskiy697fa9722008-04-23 13:43:21 +0300972 ubi_msg("attaching mtd%d to ubi%d", mtd->index, ubi_num);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200973
Richard Genoud256334c2012-08-20 18:00:11 +0200974 err = io_init(ubi, max_beb_per1024);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400975 if (err)
976 goto out_free;
977
Stefan Roesead5942b2008-12-10 10:42:54 +0100978 err = -ENOMEM;
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +0200979 ubi->peb_buf = vmalloc(ubi->peb_size);
980 if (!ubi->peb_buf)
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300981 goto out_free;
982
Richard Weinberger77e6c2f2012-09-26 17:51:45 +0200983#ifdef CONFIG_MTD_UBI_FASTMAP
984 ubi->fm_size = ubi_calc_fm_size(ubi);
985 ubi->fm_buf = vzalloc(ubi->fm_size);
986 if (!ubi->fm_buf)
987 goto out_free;
988#endif
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +0300989 err = ubi_debugging_init_dev(ubi);
990 if (err)
991 goto out_free;
992
Richard Weinbergerdac6e202012-09-26 17:51:47 +0200993 err = ubi_attach(ubi, 0);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400994 if (err) {
Artem Bityutskiy47e1ec72012-05-18 12:41:17 +0300995 ubi_err("failed to attach mtd%d, error %d", mtd->index, err);
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +0300996 goto out_debugging;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400997 }
998
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200999 if (ubi->autoresize_vol_id != -1) {
1000 err = autoresize(ubi, ubi->autoresize_vol_id);
1001 if (err)
1002 goto out_detach;
1003 }
1004
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +02001005 err = uif_init(ubi, &ref);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001006 if (err)
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +02001007 goto out_detach;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001008
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001009 err = ubi_debugfs_init_dev(ubi);
1010 if (err)
1011 goto out_uif;
1012
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001013 ubi->bgt_thread = kthread_create(ubi_thread, ubi, ubi->bgt_name);
1014 if (IS_ERR(ubi->bgt_thread)) {
1015 err = PTR_ERR(ubi->bgt_thread);
1016 ubi_err("cannot spawn \"%s\", error %d", ubi->bgt_name,
1017 err);
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001018 goto out_debugfs;
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001019 }
1020
Artem Bityutskiy719bb842012-08-27 17:14:58 +03001021 ubi_msg("attached mtd%d (name \"%s\", size %llu MiB) to ubi%d",
1022 mtd->index, mtd->name, ubi->flash_size >> 20, ubi_num);
1023 ubi_msg("PEB size: %d bytes (%d KiB), LEB size: %d bytes",
1024 ubi->peb_size, ubi->peb_size >> 10, ubi->leb_size);
1025 ubi_msg("min./max. I/O unit sizes: %d/%d, sub-page size %d",
1026 ubi->min_io_size, ubi->max_write_size, ubi->hdrs_min_io_size);
1027 ubi_msg("VID header offset: %d (aligned %d), data offset: %d",
1028 ubi->vid_hdr_offset, ubi->vid_hdr_aloffset, ubi->leb_start);
1029 ubi_msg("good PEBs: %d, bad PEBs: %d, corrupted PEBs: %d",
1030 ubi->good_peb_count, ubi->bad_peb_count, ubi->corr_peb_count);
1031 ubi_msg("user volume: %d, internal volumes: %d, max. volumes count: %d",
1032 ubi->vol_count - UBI_INT_VOL_COUNT, UBI_INT_VOL_COUNT,
1033 ubi->vtbl_slots);
1034 ubi_msg("max/mean erase counter: %d/%d, WL threshold: %d, image sequence number: %u",
1035 ubi->max_ec, ubi->mean_ec, CONFIG_MTD_UBI_WL_THRESHOLD,
1036 ubi->image_seq);
1037 ubi_msg("available PEBs: %d, total reserved PEBs: %d, PEBs reserved for bad PEB handling: %d",
1038 ubi->avail_pebs, ubi->rsvd_pebs, ubi->beb_rsvd_pebs);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001039
Artem Bityutskiyddbd3b62009-05-23 13:44:09 +03001040 /*
1041 * The below lock makes sure we do not race with 'ubi_thread()' which
1042 * checks @ubi->thread_enabled. Otherwise we may fail to wake it up.
1043 */
1044 spin_lock(&ubi->wl_lock);
Artem Bityutskiy28237e42011-03-15 10:30:40 +02001045 ubi->thread_enabled = 1;
Artem Bityutskiyd37e6bf2008-07-24 18:28:11 +03001046 wake_up_process(ubi->bgt_thread);
Artem Bityutskiyddbd3b62009-05-23 13:44:09 +03001047 spin_unlock(&ubi->wl_lock);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001048
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001049 ubi_devices[ubi_num] = ubi;
Dmitry Pervushin0e0ee1c2009-04-29 19:29:38 +04001050 ubi_notify_all(ubi, UBI_VOLUME_ADDED, NULL);
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001051 return ubi_num;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001052
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001053out_debugfs:
1054 ubi_debugfs_exit_dev(ubi);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001055out_uif:
Artem Bityutskiy01a41102011-05-18 18:08:05 +03001056 get_device(&ubi->dev);
1057 ubi_assert(ref);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001058 uif_close(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001059out_detach:
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001060 ubi_wl_close(ubi);
Artem Bityutskiy47e1ec72012-05-18 12:41:17 +03001061 ubi_free_internal_volumes(ubi);
Vinit Agnihotrid7f0c4d2007-06-15 15:31:22 +05301062 vfree(ubi->vtbl);
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001063out_debugging:
1064 ubi_debugging_exit_dev(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001065out_free:
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +02001066 vfree(ubi->peb_buf);
Richard Weinberger77e6c2f2012-09-26 17:51:45 +02001067 vfree(ubi->fm_buf);
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +02001068 if (ref)
1069 put_device(&ubi->dev);
1070 else
1071 kfree(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001072 return err;
1073}
1074
1075/**
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001076 * ubi_detach_mtd_dev - detach an MTD device.
1077 * @ubi_num: UBI device number to detach from
1078 * @anyway: detach MTD even if device reference count is not zero
1079 *
1080 * This function destroys an UBI device number @ubi_num and detaches the
1081 * underlying MTD device. Returns zero in case of success and %-EBUSY if the
1082 * UBI device is busy and cannot be destroyed, and %-EINVAL if it does not
1083 * exist.
1084 *
1085 * Note, the invocations of this function has to be serialized by the
1086 * @ubi_devices_mutex.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001087 */
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001088int ubi_detach_mtd_dev(int ubi_num, int anyway)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001089{
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001090 struct ubi_device *ubi;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001091
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001092 if (ubi_num < 0 || ubi_num >= UBI_MAX_DEVICES)
1093 return -EINVAL;
1094
Dmitry Pervushin0e0ee1c2009-04-29 19:29:38 +04001095 ubi = ubi_get_device(ubi_num);
1096 if (!ubi)
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001097 return -EINVAL;
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001098
Dmitry Pervushin0e0ee1c2009-04-29 19:29:38 +04001099 spin_lock(&ubi_devices_lock);
1100 put_device(&ubi->dev);
1101 ubi->ref_count -= 1;
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001102 if (ubi->ref_count) {
1103 if (!anyway) {
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001104 spin_unlock(&ubi_devices_lock);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001105 return -EBUSY;
1106 }
1107 /* This may only happen if there is a bug */
1108 ubi_err("%s reference count %d, destroy anyway",
1109 ubi->ubi_name, ubi->ref_count);
1110 }
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001111 ubi_devices[ubi_num] = NULL;
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001112 spin_unlock(&ubi_devices_lock);
1113
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001114 ubi_assert(ubi_num == ubi->ubi_num);
Dmitry Pervushin0e0ee1c2009-04-29 19:29:38 +04001115 ubi_notify_all(ubi, UBI_VOLUME_REMOVED, NULL);
Artem Bityutskiy719bb842012-08-27 17:14:58 +03001116 ubi_msg("detaching mtd%d from ubi%d", ubi->mtd->index, ubi_num);
Richard Weinberger77e6c2f2012-09-26 17:51:45 +02001117#ifdef CONFIG_MTD_UBI_FASTMAP
1118 /* If we don't write a new fastmap at detach time we lose all
1119 * EC updates that have been made since the last written fastmap. */
1120 ubi_update_fastmap(ubi);
1121#endif
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001122 /*
1123 * Before freeing anything, we have to stop the background thread to
1124 * prevent it from doing anything on this device while we are freeing.
1125 */
1126 if (ubi->bgt_thread)
1127 kthread_stop(ubi->bgt_thread);
1128
Artem Bityutskiy36b477d2009-01-20 18:04:09 +02001129 /*
1130 * Get a reference to the device in order to prevent 'dev_release()'
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +02001131 * from freeing the @ubi object.
Artem Bityutskiy36b477d2009-01-20 18:04:09 +02001132 */
1133 get_device(&ubi->dev);
1134
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001135 ubi_debugfs_exit_dev(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001136 uif_close(ubi);
Richard Weinberger77e6c2f2012-09-26 17:51:45 +02001137
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001138 ubi_wl_close(ubi);
Artem Bityutskiy47e1ec72012-05-18 12:41:17 +03001139 ubi_free_internal_volumes(ubi);
Artem Bityutskiy92ad8f32007-05-06 16:12:54 +03001140 vfree(ubi->vtbl);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001141 put_mtd_device(ubi->mtd);
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001142 ubi_debugging_exit_dev(ubi);
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +02001143 vfree(ubi->peb_buf);
Richard Weinberger77e6c2f2012-09-26 17:51:45 +02001144 vfree(ubi->fm_buf);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001145 ubi_msg("mtd%d is detached from ubi%d", ubi->mtd->index, ubi->ubi_num);
Artem Bityutskiy36b477d2009-01-20 18:04:09 +02001146 put_device(&ubi->dev);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001147 return 0;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001148}
1149
Artem Bityutskiy3a8d4642007-12-16 12:32:51 +02001150/**
Artem Bityutskiyf9b00802010-01-05 16:48:40 +02001151 * open_mtd_by_chdev - open an MTD device by its character device node path.
1152 * @mtd_dev: MTD character device node path
1153 *
1154 * This helper function opens an MTD device by its character node device path.
1155 * Returns MTD device description object in case of success and a negative
1156 * error code in case of failure.
1157 */
1158static struct mtd_info * __init open_mtd_by_chdev(const char *mtd_dev)
1159{
1160 int err, major, minor, mode;
1161 struct path path;
1162
1163 /* Probably this is an MTD character device node path */
1164 err = kern_path(mtd_dev, LOOKUP_FOLLOW, &path);
1165 if (err)
1166 return ERR_PTR(err);
1167
1168 /* MTD device number is defined by the major / minor numbers */
1169 major = imajor(path.dentry->d_inode);
1170 minor = iminor(path.dentry->d_inode);
1171 mode = path.dentry->d_inode->i_mode;
1172 path_put(&path);
1173 if (major != MTD_CHAR_MAJOR || !S_ISCHR(mode))
1174 return ERR_PTR(-EINVAL);
1175
1176 if (minor & 1)
1177 /*
1178 * Just do not think the "/dev/mtdrX" devices support is need,
1179 * so do not support them to avoid doing extra work.
1180 */
1181 return ERR_PTR(-EINVAL);
1182
1183 return get_mtd_device(NULL, minor / 2);
1184}
1185
1186/**
1187 * open_mtd_device - open MTD device by name, character device path, or number.
1188 * @mtd_dev: name, character device node path, or MTD device device number
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001189 *
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001190 * This function tries to open and MTD device described by @mtd_dev string,
Artem Bityutskiyf9b00802010-01-05 16:48:40 +02001191 * which is first treated as ASCII MTD device number, and if it is not true, it
1192 * is treated as MTD device name, and if that is also not true, it is treated
1193 * as MTD character device node path. Returns MTD device description object in
1194 * case of success and a negative error code in case of failure.
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001195 */
1196static struct mtd_info * __init open_mtd_device(const char *mtd_dev)
1197{
1198 struct mtd_info *mtd;
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001199 int mtd_num;
1200 char *endp;
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001201
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001202 mtd_num = simple_strtoul(mtd_dev, &endp, 0);
1203 if (*endp != '\0' || mtd_dev == endp) {
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001204 /*
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001205 * This does not look like an ASCII integer, probably this is
1206 * MTD device name.
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001207 */
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001208 mtd = get_mtd_device_nm(mtd_dev);
Artem Bityutskiyf9b00802010-01-05 16:48:40 +02001209 if (IS_ERR(mtd) && PTR_ERR(mtd) == -ENODEV)
1210 /* Probably this is an MTD character device node path */
1211 mtd = open_mtd_by_chdev(mtd_dev);
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001212 } else
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001213 mtd = get_mtd_device(NULL, mtd_num);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001214
1215 return mtd;
1216}
1217
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001218static int __init ubi_init(void)
1219{
1220 int err, i, k;
1221
1222 /* Ensure that EC and VID headers have correct size */
1223 BUILD_BUG_ON(sizeof(struct ubi_ec_hdr) != 64);
1224 BUILD_BUG_ON(sizeof(struct ubi_vid_hdr) != 64);
1225
1226 if (mtd_devs > UBI_MAX_DEVICES) {
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001227 ubi_err("too many MTD devices, maximum is %d", UBI_MAX_DEVICES);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001228 return -EINVAL;
1229 }
1230
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001231 /* Create base sysfs directory and sysfs files */
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001232 ubi_class = class_create(THIS_MODULE, UBI_NAME_STR);
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001233 if (IS_ERR(ubi_class)) {
1234 err = PTR_ERR(ubi_class);
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001235 ubi_err("cannot create UBI class");
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001236 goto out;
1237 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001238
1239 err = class_create_file(ubi_class, &ubi_version);
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001240 if (err) {
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001241 ubi_err("cannot create sysfs file");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001242 goto out_class;
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001243 }
1244
1245 err = misc_register(&ubi_ctrl_cdev);
1246 if (err) {
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001247 ubi_err("cannot register device");
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001248 goto out_version;
1249 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001250
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +02001251 ubi_wl_entry_slab = kmem_cache_create("ubi_wl_entry_slab",
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001252 sizeof(struct ubi_wl_entry),
1253 0, 0, NULL);
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +02001254 if (!ubi_wl_entry_slab)
Artem Bityutskiyb9a06622008-01-16 12:11:54 +02001255 goto out_dev_unreg;
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +02001256
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001257 err = ubi_debugfs_init();
1258 if (err)
1259 goto out_slab;
1260
1261
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001262 /* Attach MTD devices */
1263 for (i = 0; i < mtd_devs; i++) {
1264 struct mtd_dev_param *p = &mtd_dev_param[i];
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001265 struct mtd_info *mtd;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001266
1267 cond_resched();
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001268
1269 mtd = open_mtd_device(p->name);
1270 if (IS_ERR(mtd)) {
1271 err = PTR_ERR(mtd);
1272 goto out_detach;
1273 }
1274
1275 mutex_lock(&ubi_devices_mutex);
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001276 err = ubi_attach_mtd_dev(mtd, UBI_DEV_NUM_AUTO,
Richard Genoudedac4932012-08-20 18:00:14 +02001277 p->vid_hdr_offs, p->max_beb_per1024);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001278 mutex_unlock(&ubi_devices_mutex);
1279 if (err < 0) {
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001280 ubi_err("cannot attach mtd%d", mtd->index);
Marc Kleine-Buddeaf7ad7a2010-05-05 10:17:25 +02001281 put_mtd_device(mtd);
1282
1283 /*
1284 * Originally UBI stopped initializing on any error.
1285 * However, later on it was found out that this
1286 * behavior is not very good when UBI is compiled into
1287 * the kernel and the MTD devices to attach are passed
1288 * through the command line. Indeed, UBI failure
1289 * stopped whole boot sequence.
1290 *
1291 * To fix this, we changed the behavior for the
1292 * non-module case, but preserved the old behavior for
1293 * the module case, just for compatibility. This is a
1294 * little inconsistent, though.
1295 */
1296 if (ubi_is_module())
1297 goto out_detach;
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001298 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001299 }
1300
1301 return 0;
1302
1303out_detach:
1304 for (k = 0; k < i; k++)
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001305 if (ubi_devices[k]) {
1306 mutex_lock(&ubi_devices_mutex);
1307 ubi_detach_mtd_dev(ubi_devices[k]->ubi_num, 1);
1308 mutex_unlock(&ubi_devices_mutex);
1309 }
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001310 ubi_debugfs_exit();
1311out_slab:
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +02001312 kmem_cache_destroy(ubi_wl_entry_slab);
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001313out_dev_unreg:
1314 misc_deregister(&ubi_ctrl_cdev);
Artem Bityutskiy3a8d4642007-12-16 12:32:51 +02001315out_version:
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001316 class_remove_file(ubi_class, &ubi_version);
1317out_class:
1318 class_destroy(ubi_class);
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001319out:
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001320 ubi_err("UBI error: cannot initialize UBI, error %d", err);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001321 return err;
1322}
Jiang Lucf38aca2012-08-08 10:31:01 +08001323late_initcall(ubi_init);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001324
1325static void __exit ubi_exit(void)
1326{
Artem Bityutskiyb96bf4c2007-12-16 13:01:03 +02001327 int i;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001328
Artem Bityutskiyb96bf4c2007-12-16 13:01:03 +02001329 for (i = 0; i < UBI_MAX_DEVICES; i++)
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001330 if (ubi_devices[i]) {
1331 mutex_lock(&ubi_devices_mutex);
1332 ubi_detach_mtd_dev(ubi_devices[i]->ubi_num, 1);
1333 mutex_unlock(&ubi_devices_mutex);
1334 }
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001335 ubi_debugfs_exit();
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +02001336 kmem_cache_destroy(ubi_wl_entry_slab);
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001337 misc_deregister(&ubi_ctrl_cdev);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001338 class_remove_file(ubi_class, &ubi_version);
1339 class_destroy(ubi_class);
1340}
1341module_exit(ubi_exit);
1342
1343/**
Artem Bityutskiyebaaf1a2008-07-18 13:34:32 +03001344 * bytes_str_to_int - convert a number of bytes string into an integer.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001345 * @str: the string to convert
1346 *
1347 * This function returns positive resulting integer in case of success and a
1348 * negative error code in case of failure.
1349 */
1350static int __init bytes_str_to_int(const char *str)
1351{
1352 char *endp;
1353 unsigned long result;
1354
1355 result = simple_strtoul(str, &endp, 0);
Roel Kluin774b1382009-10-16 14:00:17 +02001356 if (str == endp || result >= INT_MAX) {
Artem Bityutskiye28453b2012-08-27 15:13:05 +03001357 ubi_err("UBI error: incorrect bytes count: \"%s\"\n", str);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001358 return -EINVAL;
1359 }
1360
1361 switch (*endp) {
1362 case 'G':
1363 result *= 1024;
1364 case 'M':
1365 result *= 1024;
1366 case 'K':
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001367 result *= 1024;
Artem Bityutskiyaeddb872007-12-26 14:25:58 +02001368 if (endp[1] == 'i' && endp[2] == 'B')
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001369 endp += 2;
1370 case '\0':
1371 break;
1372 default:
Artem Bityutskiye28453b2012-08-27 15:13:05 +03001373 ubi_err("UBI error: incorrect bytes count: \"%s\"\n", str);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001374 return -EINVAL;
1375 }
1376
1377 return result;
1378}
1379
1380/**
1381 * ubi_mtd_param_parse - parse the 'mtd=' UBI parameter.
1382 * @val: the parameter value to parse
1383 * @kp: not used
1384 *
1385 * This function returns zero in case of success and a negative error code in
1386 * case of error.
1387 */
1388static int __init ubi_mtd_param_parse(const char *val, struct kernel_param *kp)
1389{
1390 int i, len;
1391 struct mtd_dev_param *p;
1392 char buf[MTD_PARAM_LEN_MAX];
1393 char *pbuf = &buf[0];
Richard Genoud5993f9b2012-08-17 16:35:19 +02001394 char *tokens[MTD_PARAM_MAX_COUNT];
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001395
Artem Bityutskiy77c722d2007-12-16 16:46:57 +02001396 if (!val)
1397 return -EINVAL;
1398
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001399 if (mtd_devs == UBI_MAX_DEVICES) {
Artem Bityutskiye28453b2012-08-27 15:13:05 +03001400 ubi_err("UBI error: too many parameters, max. is %d\n",
1401 UBI_MAX_DEVICES);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001402 return -EINVAL;
1403 }
1404
1405 len = strnlen(val, MTD_PARAM_LEN_MAX);
1406 if (len == MTD_PARAM_LEN_MAX) {
Artem Bityutskiye28453b2012-08-27 15:13:05 +03001407 ubi_err("UBI error: parameter \"%s\" is too long, max. is %d\n",
1408 val, MTD_PARAM_LEN_MAX);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001409 return -EINVAL;
1410 }
1411
1412 if (len == 0) {
Artem Bityutskiye28453b2012-08-27 15:13:05 +03001413 pr_warn("UBI warning: empty 'mtd=' parameter - ignored\n");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001414 return 0;
1415 }
1416
1417 strcpy(buf, val);
1418
1419 /* Get rid of the final newline */
1420 if (buf[len - 1] == '\n')
Artem Bityutskiy503990e2007-07-11 16:03:29 +03001421 buf[len - 1] = '\0';
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001422
Richard Genoud5993f9b2012-08-17 16:35:19 +02001423 for (i = 0; i < MTD_PARAM_MAX_COUNT; i++)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001424 tokens[i] = strsep(&pbuf, ",");
1425
1426 if (pbuf) {
Artem Bityutskiye28453b2012-08-27 15:13:05 +03001427 ubi_err("UBI error: too many arguments at \"%s\"\n", val);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001428 return -EINVAL;
1429 }
1430
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001431 p = &mtd_dev_param[mtd_devs];
1432 strcpy(&p->name[0], tokens[0]);
1433
1434 if (tokens[1])
1435 p->vid_hdr_offs = bytes_str_to_int(tokens[1]);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001436
1437 if (p->vid_hdr_offs < 0)
1438 return p->vid_hdr_offs;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001439
Richard Genoudedac4932012-08-20 18:00:14 +02001440 if (tokens[2]) {
1441 int err = kstrtoint(tokens[2], 10, &p->max_beb_per1024);
1442
1443 if (err) {
Artem Bityutskiye28453b2012-08-27 15:13:05 +03001444 ubi_err("UBI error: bad value for max_beb_per1024 parameter: %s",
1445 tokens[2]);
Richard Genoudedac4932012-08-20 18:00:14 +02001446 return -EINVAL;
1447 }
1448 }
1449
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001450 mtd_devs += 1;
1451 return 0;
1452}
1453
1454module_param_call(mtd, ubi_mtd_param_parse, NULL, NULL, 000);
Richard Genoudedac4932012-08-20 18:00:14 +02001455MODULE_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 +04001456 "Multiple \"mtd\" parameters may be specified.\n"
Richard Genoudedac4932012-08-20 18:00:14 +02001457 "MTD devices may be specified by their number, name, or path to the MTD character device node.\n"
1458 "Optional \"vid_hdr_offs\" parameter specifies UBI VID header position to be used by UBI. (default value if 0)\n"
1459 "Optional \"max_beb_per1024\" parameter specifies the maximum expected bad eraseblock per 1024 eraseblocks. (default value ("
1460 __stringify(CONFIG_MTD_UBI_BEB_LIMIT) ") if 0)\n"
1461 "\n"
1462 "Example 1: mtd=/dev/mtd0 - attach MTD device /dev/mtd0.\n"
1463 "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"
1464 "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"
1465 "\t(e.g. if the NAND *chipset* has 4096 PEB, 100 will be reserved for this UBI device).");
Richard Weinberger77e6c2f2012-09-26 17:51:45 +02001466#ifdef CONFIG_MTD_UBI_FASTMAP
1467module_param(fm_autoconvert, bool, 0644);
1468MODULE_PARM_DESC(fm_autoconvert, "Set this parameter to enable fastmap automatically on images without a fastmap.");
1469#endif
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001470MODULE_VERSION(__stringify(UBI_VERSION));
1471MODULE_DESCRIPTION("UBI - Unsorted Block Images");
1472MODULE_AUTHOR("Artem Bityutskiy");
1473MODULE_LICENSE("GPL");