blob: 85d54f37e28ff25d88fe055838593413170659ad [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>
Ezequiel Garciaf83c3832013-10-13 18:05:23 -030044#include <linux/major.h>
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040045#include "ubi.h"
46
47/* Maximum length of the 'mtd=' parameter */
48#define MTD_PARAM_LEN_MAX 64
49
Richard Genoud5993f9b2012-08-17 16:35:19 +020050/* Maximum number of comma-separated items in the 'mtd=' parameter */
Mike Frysinger83ff59a2013-05-03 14:55:23 -040051#define MTD_PARAM_MAX_COUNT 4
Richard Genoud5993f9b2012-08-17 16:35:19 +020052
Richard Genoudd2f588f92012-08-20 18:00:13 +020053/* Maximum value for the number of bad PEBs per 1024 PEBs */
54#define MAX_MTD_UBI_BEB_LIMIT 768
55
Marc Kleine-Buddeaf7ad7a2010-05-05 10:17:25 +020056#ifdef CONFIG_MTD_UBI_MODULE
57#define ubi_is_module() 1
58#else
59#define ubi_is_module() 0
60#endif
61
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040062/**
63 * struct mtd_dev_param - MTD device parameter description data structure.
Artem Bityutskiyf9b00802010-01-05 16:48:40 +020064 * @name: MTD character device node path, MTD device name, or MTD device number
65 * string
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040066 * @vid_hdr_offs: VID header offset
Richard Genoudedac4932012-08-20 18:00:14 +020067 * @max_beb_per1024: maximum expected number of bad PEBs per 1024 PEBs
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040068 */
Artem Bityutskiy9c9ec142008-07-18 13:19:52 +030069struct mtd_dev_param {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040070 char name[MTD_PARAM_LEN_MAX];
Mike Frysinger83ff59a2013-05-03 14:55:23 -040071 int ubi_num;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040072 int vid_hdr_offs;
Richard Genoudedac4932012-08-20 18:00:14 +020073 int max_beb_per1024;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040074};
75
76/* Numbers of elements set in the @mtd_dev_param array */
Artem Bityutskiy9e0c7ef32010-01-06 14:20:31 +020077static int __initdata mtd_devs;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040078
79/* MTD devices specification parameters */
Artem Bityutskiy9e0c7ef32010-01-06 14:20:31 +020080static struct mtd_dev_param __initdata mtd_dev_param[UBI_MAX_DEVICES];
Richard Weinberger77e6c2f2012-09-26 17:51:45 +020081#ifdef CONFIG_MTD_UBI_FASTMAP
82/* UBI module parameter to enable fastmap automatically on non-fastmap images */
83static bool fm_autoconvert;
Richard Weinberger479c2c02014-10-08 15:14:09 +020084static bool fm_debug;
Richard Weinberger77e6c2f2012-09-26 17:51:45 +020085#endif
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +040086
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +020087/* Slab cache for wear-leveling entries */
88struct kmem_cache *ubi_wl_entry_slab;
89
Artem Bityutskiy9f961b52007-12-16 16:59:31 +020090/* UBI control character device */
91static struct miscdevice ubi_ctrl_cdev = {
92 .minor = MISC_DYNAMIC_MINOR,
93 .name = "ubi_ctrl",
94 .fops = &ubi_ctrl_cdev_operations,
95};
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +020096
Artem Bityutskiye73f4452007-12-17 17:37:26 +020097/* All UBI devices in system */
98static struct ubi_device *ubi_devices[UBI_MAX_DEVICES];
99
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200100/* Serializes UBI devices creations and removals */
101DEFINE_MUTEX(ubi_devices_mutex);
102
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200103/* Protects @ubi_devices and @ubi->ref_count */
104static DEFINE_SPINLOCK(ubi_devices_lock);
105
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400106/* "Show" method for files in '/<sysfs>/class/ubi/' */
Artem Bityutskiyc174a082010-09-03 15:11:17 +0300107static ssize_t ubi_version_show(struct class *class,
108 struct class_attribute *attr, char *buf)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400109{
110 return sprintf(buf, "%d\n", UBI_VERSION);
111}
112
113/* UBI version attribute ('/<sysfs>/class/ubi/version') */
Takashi Iwai53cd2552015-05-15 16:20:05 +0800114static struct class_attribute ubi_class_attrs[] = {
115 __ATTR(version, S_IRUGO, ubi_version_show, NULL),
116 __ATTR_NULL
117};
118
119/* Root UBI "class" object (corresponds to '/<sysfs>/class/ubi/') */
120struct class ubi_class = {
121 .name = UBI_NAME_STR,
122 .owner = THIS_MODULE,
123 .class_attrs = ubi_class_attrs,
124};
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400125
126static ssize_t dev_attribute_show(struct device *dev,
127 struct device_attribute *attr, char *buf);
128
129/* UBI device attributes (correspond to files in '/<sysfs>/class/ubi/ubiX') */
130static struct device_attribute dev_eraseblock_size =
131 __ATTR(eraseblock_size, S_IRUGO, dev_attribute_show, NULL);
132static struct device_attribute dev_avail_eraseblocks =
133 __ATTR(avail_eraseblocks, S_IRUGO, dev_attribute_show, NULL);
134static struct device_attribute dev_total_eraseblocks =
135 __ATTR(total_eraseblocks, S_IRUGO, dev_attribute_show, NULL);
136static struct device_attribute dev_volumes_count =
137 __ATTR(volumes_count, S_IRUGO, dev_attribute_show, NULL);
138static struct device_attribute dev_max_ec =
139 __ATTR(max_ec, S_IRUGO, dev_attribute_show, NULL);
140static struct device_attribute dev_reserved_for_bad =
141 __ATTR(reserved_for_bad, S_IRUGO, dev_attribute_show, NULL);
142static struct device_attribute dev_bad_peb_count =
143 __ATTR(bad_peb_count, S_IRUGO, dev_attribute_show, NULL);
144static struct device_attribute dev_max_vol_count =
145 __ATTR(max_vol_count, S_IRUGO, dev_attribute_show, NULL);
146static struct device_attribute dev_min_io_size =
147 __ATTR(min_io_size, S_IRUGO, dev_attribute_show, NULL);
148static struct device_attribute dev_bgt_enabled =
149 __ATTR(bgt_enabled, S_IRUGO, dev_attribute_show, NULL);
Artem Bityutskiyb6b76ba2007-12-26 13:46:46 +0200150static struct device_attribute dev_mtd_num =
151 __ATTR(mtd_num, S_IRUGO, dev_attribute_show, NULL);
Ezequiel Garcia525bab72016-04-28 18:13:58 -0300152static struct device_attribute dev_ro_mode =
153 __ATTR(ro_mode, S_IRUGO, dev_attribute_show, NULL);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400154
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200155/**
Dmitry Pervushin0e0ee1c2009-04-29 19:29:38 +0400156 * ubi_volume_notify - send a volume change notification.
157 * @ubi: UBI device description object
158 * @vol: volume description object of the changed volume
159 * @ntype: notification type to send (%UBI_VOLUME_ADDED, etc)
160 *
161 * This is a helper function which notifies all subscribers about a volume
162 * change event (creation, removal, re-sizing, re-naming, updating). Returns
163 * zero in case of success and a negative error code in case of failure.
164 */
165int ubi_volume_notify(struct ubi_device *ubi, struct ubi_volume *vol, int ntype)
166{
Richard Weinberger84b678f2014-10-06 15:14:16 +0200167 int ret;
Dmitry Pervushin0e0ee1c2009-04-29 19:29:38 +0400168 struct ubi_notification nt;
169
170 ubi_do_get_device_info(ubi, &nt.di);
171 ubi_do_get_volume_info(ubi, vol, &nt.vi);
Richard Weinberger77e6c2f2012-09-26 17:51:45 +0200172
Richard Weinberger77e6c2f2012-09-26 17:51:45 +0200173 switch (ntype) {
174 case UBI_VOLUME_ADDED:
175 case UBI_VOLUME_REMOVED:
176 case UBI_VOLUME_RESIZED:
177 case UBI_VOLUME_RENAMED:
Richard Weinberger84b678f2014-10-06 15:14:16 +0200178 ret = ubi_update_fastmap(ubi);
179 if (ret)
180 ubi_msg(ubi, "Unable to write a new fastmap: %i", ret);
Richard Weinberger77e6c2f2012-09-26 17:51:45 +0200181 }
Richard Weinberger84b678f2014-10-06 15:14:16 +0200182
Dmitry Pervushin0e0ee1c2009-04-29 19:29:38 +0400183 return blocking_notifier_call_chain(&ubi_notifiers, ntype, &nt);
184}
185
186/**
187 * ubi_notify_all - send a notification to all volumes.
188 * @ubi: UBI device description object
189 * @ntype: notification type to send (%UBI_VOLUME_ADDED, etc)
190 * @nb: the notifier to call
191 *
192 * This function walks all volumes of UBI device @ubi and sends the @ntype
193 * notification for each volume. If @nb is %NULL, then all registered notifiers
194 * are called, otherwise only the @nb notifier is called. Returns the number of
195 * sent notifications.
196 */
197int ubi_notify_all(struct ubi_device *ubi, int ntype, struct notifier_block *nb)
198{
199 struct ubi_notification nt;
200 int i, count = 0;
201
202 ubi_do_get_device_info(ubi, &nt.di);
203
204 mutex_lock(&ubi->device_mutex);
205 for (i = 0; i < ubi->vtbl_slots; i++) {
206 /*
207 * Since the @ubi->device is locked, and we are not going to
208 * change @ubi->volumes, we do not have to lock
209 * @ubi->volumes_lock.
210 */
211 if (!ubi->volumes[i])
212 continue;
213
214 ubi_do_get_volume_info(ubi, ubi->volumes[i], &nt.vi);
215 if (nb)
216 nb->notifier_call(nb, ntype, &nt);
217 else
218 blocking_notifier_call_chain(&ubi_notifiers, ntype,
219 &nt);
220 count += 1;
221 }
222 mutex_unlock(&ubi->device_mutex);
223
224 return count;
225}
226
227/**
228 * ubi_enumerate_volumes - send "add" notification for all existing volumes.
229 * @nb: the notifier to call
230 *
231 * This function walks all UBI devices and volumes and sends the
232 * %UBI_VOLUME_ADDED notification for each volume. If @nb is %NULL, then all
233 * registered notifiers are called, otherwise only the @nb notifier is called.
234 * Returns the number of sent notifications.
235 */
236int ubi_enumerate_volumes(struct notifier_block *nb)
237{
238 int i, count = 0;
239
240 /*
241 * Since the @ubi_devices_mutex is locked, and we are not going to
242 * change @ubi_devices, we do not have to lock @ubi_devices_lock.
243 */
244 for (i = 0; i < UBI_MAX_DEVICES; i++) {
245 struct ubi_device *ubi = ubi_devices[i];
246
247 if (!ubi)
248 continue;
249 count += ubi_notify_all(ubi, UBI_VOLUME_ADDED, nb);
250 }
251
252 return count;
253}
254
255/**
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200256 * ubi_get_device - get UBI device.
257 * @ubi_num: UBI device number
258 *
259 * This function returns UBI device description object for UBI device number
260 * @ubi_num, or %NULL if the device does not exist. This function increases the
261 * device reference count to prevent removal of the device. In other words, the
262 * device cannot be removed if its reference count is not zero.
263 */
264struct ubi_device *ubi_get_device(int ubi_num)
265{
266 struct ubi_device *ubi;
267
268 spin_lock(&ubi_devices_lock);
269 ubi = ubi_devices[ubi_num];
270 if (ubi) {
271 ubi_assert(ubi->ref_count >= 0);
272 ubi->ref_count += 1;
273 get_device(&ubi->dev);
274 }
275 spin_unlock(&ubi_devices_lock);
276
277 return ubi;
278}
279
280/**
281 * ubi_put_device - drop an UBI device reference.
282 * @ubi: UBI device description object
283 */
284void ubi_put_device(struct ubi_device *ubi)
285{
286 spin_lock(&ubi_devices_lock);
287 ubi->ref_count -= 1;
288 put_device(&ubi->dev);
289 spin_unlock(&ubi_devices_lock);
290}
291
292/**
Artem Bityutskiyebaaf1a2008-07-18 13:34:32 +0300293 * ubi_get_by_major - get UBI device by character device major number.
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200294 * @major: major number
295 *
296 * This function is similar to 'ubi_get_device()', but it searches the device
297 * by its major number.
298 */
299struct ubi_device *ubi_get_by_major(int major)
300{
301 int i;
302 struct ubi_device *ubi;
303
304 spin_lock(&ubi_devices_lock);
305 for (i = 0; i < UBI_MAX_DEVICES; i++) {
306 ubi = ubi_devices[i];
307 if (ubi && MAJOR(ubi->cdev.dev) == major) {
308 ubi_assert(ubi->ref_count >= 0);
309 ubi->ref_count += 1;
310 get_device(&ubi->dev);
311 spin_unlock(&ubi_devices_lock);
312 return ubi;
313 }
314 }
315 spin_unlock(&ubi_devices_lock);
316
317 return NULL;
318}
319
320/**
321 * ubi_major2num - get UBI device number by character device major number.
322 * @major: major number
323 *
324 * This function searches UBI device number object by its major number. If UBI
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200325 * device was not found, this function returns -ENODEV, otherwise the UBI device
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200326 * number is returned.
327 */
328int ubi_major2num(int major)
329{
330 int i, ubi_num = -ENODEV;
331
332 spin_lock(&ubi_devices_lock);
333 for (i = 0; i < UBI_MAX_DEVICES; i++) {
334 struct ubi_device *ubi = ubi_devices[i];
335
336 if (ubi && MAJOR(ubi->cdev.dev) == major) {
337 ubi_num = ubi->ubi_num;
338 break;
339 }
340 }
341 spin_unlock(&ubi_devices_lock);
342
343 return ubi_num;
344}
345
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400346/* "Show" method for files in '/<sysfs>/class/ubi/ubiX/' */
347static ssize_t dev_attribute_show(struct device *dev,
348 struct device_attribute *attr, char *buf)
349{
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200350 ssize_t ret;
351 struct ubi_device *ubi;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400352
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200353 /*
354 * The below code looks weird, but it actually makes sense. We get the
355 * UBI device reference from the contained 'struct ubi_device'. But it
356 * is unclear if the device was removed or not yet. Indeed, if the
357 * device was removed before we increased its reference count,
358 * 'ubi_get_device()' will return -ENODEV and we fail.
359 *
360 * Remember, 'struct ubi_device' is freed in the release function, so
361 * we still can use 'ubi->ubi_num'.
362 */
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400363 ubi = container_of(dev, struct ubi_device, dev);
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200364 ubi = ubi_get_device(ubi->ubi_num);
365 if (!ubi)
366 return -ENODEV;
367
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400368 if (attr == &dev_eraseblock_size)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200369 ret = sprintf(buf, "%d\n", ubi->leb_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400370 else if (attr == &dev_avail_eraseblocks)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200371 ret = sprintf(buf, "%d\n", ubi->avail_pebs);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400372 else if (attr == &dev_total_eraseblocks)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200373 ret = sprintf(buf, "%d\n", ubi->good_peb_count);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400374 else if (attr == &dev_volumes_count)
Artem Bityutskiy4b3cc342007-12-26 15:59:39 +0200375 ret = sprintf(buf, "%d\n", ubi->vol_count - UBI_INT_VOL_COUNT);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400376 else if (attr == &dev_max_ec)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200377 ret = sprintf(buf, "%d\n", ubi->max_ec);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400378 else if (attr == &dev_reserved_for_bad)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200379 ret = sprintf(buf, "%d\n", ubi->beb_rsvd_pebs);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400380 else if (attr == &dev_bad_peb_count)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200381 ret = sprintf(buf, "%d\n", ubi->bad_peb_count);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400382 else if (attr == &dev_max_vol_count)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200383 ret = sprintf(buf, "%d\n", ubi->vtbl_slots);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400384 else if (attr == &dev_min_io_size)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200385 ret = sprintf(buf, "%d\n", ubi->min_io_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400386 else if (attr == &dev_bgt_enabled)
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200387 ret = sprintf(buf, "%d\n", ubi->thread_enabled);
Artem Bityutskiyb6b76ba2007-12-26 13:46:46 +0200388 else if (attr == &dev_mtd_num)
389 ret = sprintf(buf, "%d\n", ubi->mtd->index);
Ezequiel Garcia525bab72016-04-28 18:13:58 -0300390 else if (attr == &dev_ro_mode)
391 ret = sprintf(buf, "%d\n", ubi->ro_mode);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400392 else
Artem Bityutskiyb6b76ba2007-12-26 13:46:46 +0200393 ret = -EINVAL;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400394
Artem Bityutskiye73f4452007-12-17 17:37:26 +0200395 ubi_put_device(ubi);
396 return ret;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400397}
398
Takashi Iwai53cd2552015-05-15 16:20:05 +0800399static struct attribute *ubi_dev_attrs[] = {
400 &dev_eraseblock_size.attr,
401 &dev_avail_eraseblocks.attr,
402 &dev_total_eraseblocks.attr,
403 &dev_volumes_count.attr,
404 &dev_max_ec.attr,
405 &dev_reserved_for_bad.attr,
406 &dev_bad_peb_count.attr,
407 &dev_max_vol_count.attr,
408 &dev_min_io_size.attr,
409 &dev_bgt_enabled.attr,
410 &dev_mtd_num.attr,
Ezequiel Garcia525bab72016-04-28 18:13:58 -0300411 &dev_ro_mode.attr,
Takashi Iwai53cd2552015-05-15 16:20:05 +0800412 NULL
413};
414ATTRIBUTE_GROUPS(ubi_dev);
415
Artem Bityutskiy36b477d2009-01-20 18:04:09 +0200416static void dev_release(struct device *dev)
417{
418 struct ubi_device *ubi = container_of(dev, struct ubi_device, dev);
419
420 kfree(ubi);
421}
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400422
423/**
424 * ubi_sysfs_init - initialize sysfs for an UBI device.
425 * @ubi: UBI device description object
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200426 * @ref: set to %1 on exit in case of failure if a reference to @ubi->dev was
427 * taken
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400428 *
429 * This function returns zero in case of success and a negative error code in
430 * case of failure.
431 */
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200432static int ubi_sysfs_init(struct ubi_device *ubi, int *ref)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400433{
434 int err;
435
436 ubi->dev.release = dev_release;
Artem Bityutskiy49dfc292007-12-15 18:13:56 +0200437 ubi->dev.devt = ubi->cdev.dev;
Takashi Iwai53cd2552015-05-15 16:20:05 +0800438 ubi->dev.class = &ubi_class;
439 ubi->dev.groups = ubi_dev_groups;
Kay Sievers160bbab2008-12-23 10:00:14 +0000440 dev_set_name(&ubi->dev, UBI_NAME_STR"%d", ubi->ubi_num);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400441 err = device_register(&ubi->dev);
442 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200443 return err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400444
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200445 *ref = 1;
Takashi Iwai53cd2552015-05-15 16:20:05 +0800446 return 0;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400447}
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 B. Bityutskiy801c1352006-06-27 12:22:22 +0400455 device_unregister(&ubi->dev);
456}
457
458/**
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200459 * kill_volumes - destroy all user volumes.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400460 * @ubi: UBI device description object
461 */
462static void kill_volumes(struct ubi_device *ubi)
463{
464 int i;
465
466 for (i = 0; i < ubi->vtbl_slots; i++)
467 if (ubi->volumes[i])
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200468 ubi_free_volume(ubi, ubi->volumes[i]);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400469}
470
471/**
472 * uif_init - initialize user interfaces for an UBI device.
473 * @ubi: UBI device description object
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200474 * @ref: set to %1 on exit in case of failure if a reference to @ubi->dev was
475 * taken, otherwise set to %0
476 *
477 * This function initializes various user interfaces for an UBI device. If the
478 * initialization fails at an early stage, this function frees all the
479 * resources it allocated, returns an error, and @ref is set to %0. However,
480 * if the initialization fails after the UBI device was registered in the
481 * driver core subsystem, this function takes a reference to @ubi->dev, because
482 * otherwise the release function ('dev_release()') would free whole @ubi
483 * object. The @ref argument is set to %1 in this case. The caller has to put
484 * this reference.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400485 *
486 * This function returns zero in case of success and a negative error code in
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200487 * case of failure.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400488 */
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200489static int uif_init(struct ubi_device *ubi, int *ref)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400490{
Artem Bityutskiy8c4c19f2009-01-20 17:48:02 +0200491 int i, err;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400492 dev_t dev;
493
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200494 *ref = 0;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400495 sprintf(ubi->ubi_name, UBI_NAME_STR "%d", ubi->ubi_num);
496
497 /*
498 * Major numbers for the UBI character devices are allocated
499 * dynamically. Major numbers of volume character devices are
500 * equivalent to ones of the corresponding UBI character device. Minor
501 * numbers of UBI character devices are 0, while minor numbers of
502 * volume character devices start from 1. Thus, we allocate one major
503 * number and ubi->vtbl_slots + 1 minor numbers.
504 */
505 err = alloc_chrdev_region(&dev, 0, ubi->vtbl_slots + 1, ubi->ubi_name);
506 if (err) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300507 ubi_err(ubi, "cannot register UBI character devices");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400508 return err;
509 }
510
Artem Bityutskiy49dfc292007-12-15 18:13:56 +0200511 ubi_assert(MINOR(dev) == 0);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400512 cdev_init(&ubi->cdev, &ubi_cdev_operations);
Artem Bityutskiyc8566352008-07-16 17:40:22 +0300513 dbg_gen("%s major is %u", ubi->ubi_name, MAJOR(dev));
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400514 ubi->cdev.owner = THIS_MODULE;
515
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400516 err = cdev_add(&ubi->cdev, dev, 1);
517 if (err) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300518 ubi_err(ubi, "cannot add character device");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400519 goto out_unreg;
520 }
521
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200522 err = ubi_sysfs_init(ubi, ref);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400523 if (err)
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200524 goto out_sysfs;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400525
526 for (i = 0; i < ubi->vtbl_slots; i++)
527 if (ubi->volumes[i]) {
Artem Bityutskiy89b96b62007-12-16 20:00:38 +0200528 err = ubi_add_volume(ubi, ubi->volumes[i]);
Artem Bityutskiy01f7b302007-12-15 19:56:51 +0200529 if (err) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300530 ubi_err(ubi, "cannot add volume %d", i);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400531 goto out_volumes;
Artem Bityutskiy01f7b302007-12-15 19:56:51 +0200532 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400533 }
534
535 return 0;
536
537out_volumes:
538 kill_volumes(ubi);
Artem Bityutskiydb6e5772007-12-17 15:48:49 +0200539out_sysfs:
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200540 if (*ref)
541 get_device(&ubi->dev);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400542 ubi_sysfs_close(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400543 cdev_del(&ubi->cdev);
544out_unreg:
Artem Bityutskiy49dfc292007-12-15 18:13:56 +0200545 unregister_chrdev_region(ubi->cdev.dev, ubi->vtbl_slots + 1);
Tanya Brokhman326087032014-10-20 19:57:00 +0300546 ubi_err(ubi, "cannot initialize UBI %s, error %d",
547 ubi->ubi_name, err);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400548 return err;
549}
550
551/**
552 * uif_close - close user interfaces for an UBI device.
553 * @ubi: UBI device description object
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300554 *
555 * Note, since this function un-registers UBI volume device objects (@vol->dev),
556 * the memory allocated voe the volumes is freed as well (in the release
557 * function).
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400558 */
559static void uif_close(struct ubi_device *ubi)
560{
561 kill_volumes(ubi);
562 ubi_sysfs_close(ubi);
563 cdev_del(&ubi->cdev);
Artem Bityutskiy49dfc292007-12-15 18:13:56 +0200564 unregister_chrdev_region(ubi->cdev.dev, ubi->vtbl_slots + 1);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400565}
566
567/**
Artem Bityutskiy47e1ec72012-05-18 12:41:17 +0300568 * ubi_free_internal_volumes - free internal volumes.
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300569 * @ubi: UBI device description object
570 */
Artem Bityutskiy47e1ec72012-05-18 12:41:17 +0300571void ubi_free_internal_volumes(struct ubi_device *ubi)
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300572{
573 int i;
574
575 for (i = ubi->vtbl_slots;
576 i < ubi->vtbl_slots + UBI_INT_VOL_COUNT; i++) {
Boris Brezillon799dca32016-09-16 16:59:25 +0200577 ubi_eba_replace_table(ubi->volumes[i], NULL);
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300578 kfree(ubi->volumes[i]);
579 }
580}
581
Richard Genoud95e6fb02012-08-17 16:35:18 +0200582static int get_bad_peb_limit(const struct ubi_device *ubi, int max_beb_per1024)
583{
584 int limit, device_pebs;
585 uint64_t device_size;
586
587 if (!max_beb_per1024)
588 return 0;
589
590 /*
591 * Here we are using size of the entire flash chip and
592 * not just the MTD partition size because the maximum
593 * number of bad eraseblocks is a percentage of the
594 * whole device and bad eraseblocks are not fairly
595 * distributed over the flash chip. So the worst case
596 * is that all the bad eraseblocks of the chip are in
597 * the MTD partition we are attaching (ubi->mtd).
598 */
599 device_size = mtd_get_device_size(ubi->mtd);
600 device_pebs = mtd_div_by_eb(device_size, ubi->mtd);
601 limit = mult_frac(device_pebs, max_beb_per1024, 1024);
602
603 /* Round it up */
604 if (mult_frac(limit, 1024, max_beb_per1024) < device_pebs)
605 limit += 1;
606
607 return limit;
608}
609
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300610/**
Artem Bityutskiy85c6e6e2008-07-16 10:25:56 +0300611 * io_init - initialize I/O sub-system for a given UBI device.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400612 * @ubi: UBI device description object
Richard Genoud256334c2012-08-20 18:00:11 +0200613 * @max_beb_per1024: maximum expected number of bad PEB per 1024 PEBs
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400614 *
615 * If @ubi->vid_hdr_offset or @ubi->leb_start is zero, default offsets are
616 * assumed:
617 * o EC header is always at offset zero - this cannot be changed;
618 * o VID header starts just after the EC header at the closest address
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200619 * aligned to @io->hdrs_min_io_size;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400620 * o data starts just after the VID header at the closest address aligned to
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200621 * @io->min_io_size
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400622 *
623 * This function returns zero in case of success and a negative error code in
624 * case of failure.
625 */
Richard Genoud256334c2012-08-20 18:00:11 +0200626static int io_init(struct ubi_device *ubi, int max_beb_per1024)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400627{
Artem Bityutskiy719bb842012-08-27 17:14:58 +0300628 dbg_gen("sizeof(struct ubi_ainf_peb) %zu", sizeof(struct ubi_ainf_peb));
629 dbg_gen("sizeof(struct ubi_wl_entry) %zu", sizeof(struct ubi_wl_entry));
630
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400631 if (ubi->mtd->numeraseregions != 0) {
632 /*
633 * Some flashes have several erase regions. Different regions
634 * may have different eraseblock size and other
635 * characteristics. It looks like mostly multi-region flashes
636 * have one "main" region and one or more small regions to
637 * store boot loader code or boot parameters or whatever. I
638 * guess we should just pick the largest region. But this is
639 * not implemented.
640 */
Tanya Brokhman326087032014-10-20 19:57:00 +0300641 ubi_err(ubi, "multiple regions, not implemented");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400642 return -EINVAL;
643 }
644
Artem Bityutskiydd38fcc2007-12-19 21:43:32 +0200645 if (ubi->vid_hdr_offset < 0)
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200646 return -EINVAL;
647
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400648 /*
649 * Note, in this implementation we support MTD devices with 0x7FFFFFFF
650 * physical eraseblocks maximum.
651 */
652
653 ubi->peb_size = ubi->mtd->erasesize;
Adrian Hunter69423d92008-12-10 13:37:21 +0000654 ubi->peb_count = mtd_div_by_eb(ubi->mtd->size, ubi->mtd);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400655 ubi->flash_size = ubi->mtd->size;
656
Shmulik Ladkani8beeb3b2012-07-04 11:06:00 +0300657 if (mtd_can_have_bb(ubi->mtd)) {
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400658 ubi->bad_allowed = 1;
Richard Genoud95e6fb02012-08-17 16:35:18 +0200659 ubi->bad_peb_limit = get_bad_peb_limit(ubi, max_beb_per1024);
Shmulik Ladkani8beeb3b2012-07-04 11:06:00 +0300660 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400661
Artem Bityutskiyebf53f42009-07-06 08:57:53 +0300662 if (ubi->mtd->type == MTD_NORFLASH) {
663 ubi_assert(ubi->mtd->writesize == 1);
664 ubi->nor_flash = 1;
665 }
666
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400667 ubi->min_io_size = ubi->mtd->writesize;
668 ubi->hdrs_min_io_size = ubi->mtd->writesize >> ubi->mtd->subpage_sft;
669
Kyungmin Parkcadb40c2008-05-22 10:32:18 +0900670 /*
671 * Make sure minimal I/O unit is power of 2. Note, there is no
672 * fundamental reason for this assumption. It is just an optimization
673 * which allows us to avoid costly division operations.
674 */
Vignesh Babu7753f162007-06-12 10:31:05 +0530675 if (!is_power_of_2(ubi->min_io_size)) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300676 ubi_err(ubi, "min. I/O unit (%d) is not power of 2",
Artem Bityutskiy01f7b302007-12-15 19:56:51 +0200677 ubi->min_io_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400678 return -EINVAL;
679 }
680
681 ubi_assert(ubi->hdrs_min_io_size > 0);
682 ubi_assert(ubi->hdrs_min_io_size <= ubi->min_io_size);
683 ubi_assert(ubi->min_io_size % ubi->hdrs_min_io_size == 0);
684
Artem Bityutskiy30b542e2011-01-30 18:37:33 +0200685 ubi->max_write_size = ubi->mtd->writebufsize;
686 /*
687 * Maximum write size has to be greater or equivalent to min. I/O
688 * size, and be multiple of min. I/O size.
689 */
690 if (ubi->max_write_size < ubi->min_io_size ||
691 ubi->max_write_size % ubi->min_io_size ||
692 !is_power_of_2(ubi->max_write_size)) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300693 ubi_err(ubi, "bad write buffer size %d for %d min. I/O unit",
Artem Bityutskiy30b542e2011-01-30 18:37:33 +0200694 ubi->max_write_size, ubi->min_io_size);
695 return -EINVAL;
696 }
697
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400698 /* Calculate default aligned sizes of EC and VID headers */
699 ubi->ec_hdr_alsize = ALIGN(UBI_EC_HDR_SIZE, ubi->hdrs_min_io_size);
700 ubi->vid_hdr_alsize = ALIGN(UBI_VID_HDR_SIZE, ubi->hdrs_min_io_size);
701
Artem Bityutskiy719bb842012-08-27 17:14:58 +0300702 dbg_gen("min_io_size %d", ubi->min_io_size);
703 dbg_gen("max_write_size %d", ubi->max_write_size);
704 dbg_gen("hdrs_min_io_size %d", ubi->hdrs_min_io_size);
705 dbg_gen("ec_hdr_alsize %d", ubi->ec_hdr_alsize);
706 dbg_gen("vid_hdr_alsize %d", ubi->vid_hdr_alsize);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400707
708 if (ubi->vid_hdr_offset == 0)
709 /* Default offset */
710 ubi->vid_hdr_offset = ubi->vid_hdr_aloffset =
711 ubi->ec_hdr_alsize;
712 else {
713 ubi->vid_hdr_aloffset = ubi->vid_hdr_offset &
714 ~(ubi->hdrs_min_io_size - 1);
715 ubi->vid_hdr_shift = ubi->vid_hdr_offset -
716 ubi->vid_hdr_aloffset;
717 }
718
719 /* Similar for the data offset */
John Ognesse8cfe002011-01-21 15:39:02 +0100720 ubi->leb_start = ubi->vid_hdr_offset + UBI_VID_HDR_SIZE;
Artem Bityutskiydd38fcc2007-12-19 21:43:32 +0200721 ubi->leb_start = ALIGN(ubi->leb_start, ubi->min_io_size);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400722
Artem Bityutskiy719bb842012-08-27 17:14:58 +0300723 dbg_gen("vid_hdr_offset %d", ubi->vid_hdr_offset);
724 dbg_gen("vid_hdr_aloffset %d", ubi->vid_hdr_aloffset);
725 dbg_gen("vid_hdr_shift %d", ubi->vid_hdr_shift);
726 dbg_gen("leb_start %d", ubi->leb_start);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400727
728 /* The shift must be aligned to 32-bit boundary */
729 if (ubi->vid_hdr_shift % 4) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300730 ubi_err(ubi, "unaligned VID header shift %d",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400731 ubi->vid_hdr_shift);
732 return -EINVAL;
733 }
734
735 /* Check sanity */
736 if (ubi->vid_hdr_offset < UBI_EC_HDR_SIZE ||
737 ubi->leb_start < ubi->vid_hdr_offset + UBI_VID_HDR_SIZE ||
738 ubi->leb_start > ubi->peb_size - UBI_VID_HDR_SIZE ||
Kyungmin Parkcadb40c2008-05-22 10:32:18 +0900739 ubi->leb_start & (ubi->min_io_size - 1)) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300740 ubi_err(ubi, "bad VID header (%d) or data offsets (%d)",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400741 ubi->vid_hdr_offset, ubi->leb_start);
742 return -EINVAL;
743 }
744
745 /*
Artem Bityutskiyb86a2c52009-05-24 14:13:34 +0300746 * Set maximum amount of physical erroneous eraseblocks to be 10%.
747 * Erroneous PEB are those which have read errors.
748 */
749 ubi->max_erroneous = ubi->peb_count / 10;
750 if (ubi->max_erroneous < 16)
751 ubi->max_erroneous = 16;
Artem Bityutskiy719bb842012-08-27 17:14:58 +0300752 dbg_gen("max_erroneous %d", ubi->max_erroneous);
Artem Bityutskiyb86a2c52009-05-24 14:13:34 +0300753
754 /*
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400755 * It may happen that EC and VID headers are situated in one minimal
756 * I/O unit. In this case we can only accept this UBI image in
757 * read-only mode.
758 */
759 if (ubi->vid_hdr_offset + UBI_VID_HDR_SIZE <= ubi->hdrs_min_io_size) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300760 ubi_warn(ubi, "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 +0400761 ubi->ro_mode = 1;
762 }
763
764 ubi->leb_size = ubi->peb_size - ubi->leb_start;
765
766 if (!(ubi->mtd->flags & MTD_WRITEABLE)) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300767 ubi_msg(ubi, "MTD device %d is write-protected, attach in read-only mode",
Artem Bityutskiy049333c2012-08-27 14:43:54 +0300768 ubi->mtd->index);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400769 ubi->ro_mode = 1;
770 }
771
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400772 /*
Artem Bityutskiyfbd01072012-05-17 16:12:26 +0300773 * Note, ideally, we have to initialize @ubi->bad_peb_count here. But
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400774 * unfortunately, MTD does not provide this information. We should loop
775 * over all physical eraseblocks and invoke mtd->block_is_bad() for
Artem Bityutskiyfbd01072012-05-17 16:12:26 +0300776 * each physical eraseblock. So, we leave @ubi->bad_peb_count
777 * uninitialized so far.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400778 */
779
780 return 0;
781}
782
783/**
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200784 * autoresize - re-size the volume which has the "auto-resize" flag set.
785 * @ubi: UBI device description object
786 * @vol_id: ID of the volume to re-size
787 *
Artem Bityutskiyfbd01072012-05-17 16:12:26 +0300788 * This function re-sizes the volume marked by the %UBI_VTBL_AUTORESIZE_FLG in
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200789 * the volume table to the largest possible size. See comments in ubi-header.h
790 * for more description of the flag. Returns zero in case of success and a
791 * negative error code in case of failure.
792 */
793static int autoresize(struct ubi_device *ubi, int vol_id)
794{
795 struct ubi_volume_desc desc;
796 struct ubi_volume *vol = ubi->volumes[vol_id];
797 int err, old_reserved_pebs = vol->reserved_pebs;
798
Artem Bityutskiyabb3e012012-08-18 14:11:42 +0200799 if (ubi->ro_mode) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300800 ubi_warn(ubi, "skip auto-resize because of R/O mode");
Artem Bityutskiyabb3e012012-08-18 14:11:42 +0200801 return 0;
802 }
803
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200804 /*
805 * Clear the auto-resize flag in the volume in-memory copy of the
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300806 * volume table, and 'ubi_resize_volume()' will propagate this change
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200807 * to the flash.
808 */
809 ubi->vtbl[vol_id].flags &= ~UBI_VTBL_AUTORESIZE_FLG;
810
811 if (ubi->avail_pebs == 0) {
812 struct ubi_vtbl_record vtbl_rec;
813
814 /*
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300815 * No available PEBs to re-size the volume, clear the flag on
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200816 * flash and exit.
817 */
Ezequiel Garciad856c132012-11-23 08:58:05 -0300818 vtbl_rec = ubi->vtbl[vol_id];
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200819 err = ubi_change_vtbl_record(ubi, vol_id, &vtbl_rec);
820 if (err)
Tanya Brokhman326087032014-10-20 19:57:00 +0300821 ubi_err(ubi, "cannot clean auto-resize flag for volume %d",
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200822 vol_id);
823 } else {
824 desc.vol = vol;
825 err = ubi_resize_volume(&desc,
826 old_reserved_pebs + ubi->avail_pebs);
827 if (err)
Tanya Brokhman326087032014-10-20 19:57:00 +0300828 ubi_err(ubi, "cannot auto-resize volume %d",
829 vol_id);
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200830 }
831
832 if (err)
833 return err;
834
Tanya Brokhman326087032014-10-20 19:57:00 +0300835 ubi_msg(ubi, "volume %d (\"%s\") re-sized from %d to %d LEBs",
836 vol_id, vol->name, old_reserved_pebs, vol->reserved_pebs);
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200837 return 0;
838}
839
840/**
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200841 * ubi_attach_mtd_dev - attach an MTD device.
Artem Bityutskiyebaaf1a2008-07-18 13:34:32 +0300842 * @mtd: MTD device description object
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200843 * @ubi_num: number to assign to the new UBI device
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400844 * @vid_hdr_offset: VID header offset
Richard Genoudedac4932012-08-20 18:00:14 +0200845 * @max_beb_per1024: maximum expected number of bad PEB per 1024 PEBs
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400846 *
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200847 * This function attaches MTD device @mtd_dev to UBI and assign @ubi_num number
848 * to the newly created UBI device, unless @ubi_num is %UBI_DEV_NUM_AUTO, in
Artem Bityutskiy505d1ca2008-06-04 17:00:35 +0300849 * which case this function finds a vacant device number and assigns it
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200850 * automatically. Returns the new UBI device number in case of success and a
851 * negative error code in case of failure.
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200852 *
853 * Note, the invocations of this function has to be serialized by the
854 * @ubi_devices_mutex.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400855 */
Richard Genoud256334c2012-08-20 18:00:11 +0200856int ubi_attach_mtd_dev(struct mtd_info *mtd, int ubi_num,
857 int vid_hdr_offset, int max_beb_per1024)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400858{
859 struct ubi_device *ubi;
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200860 int i, err, ref = 0;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400861
Richard Genoudd2f588f92012-08-20 18:00:13 +0200862 if (max_beb_per1024 < 0 || max_beb_per1024 > MAX_MTD_UBI_BEB_LIMIT)
863 return -EINVAL;
864
865 if (!max_beb_per1024)
866 max_beb_per1024 = CONFIG_MTD_UBI_BEB_LIMIT;
867
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200868 /*
869 * Check if we already have the same MTD device attached.
870 *
871 * Note, this function assumes that UBI devices creations and deletions
872 * are serialized, so it does not take the &ubi_devices_lock.
873 */
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200874 for (i = 0; i < UBI_MAX_DEVICES; i++) {
Artem Bityutskiyb96bf4c2007-12-16 13:01:03 +0200875 ubi = ubi_devices[i];
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200876 if (ubi && mtd->index == ubi->mtd->index) {
Richard Weinbergerbc743f32016-07-04 22:06:51 +0200877 pr_err("ubi: mtd%d is already attached to ubi%d",
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400878 mtd->index, i);
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200879 return -EEXIST;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400880 }
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200881 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400882
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200883 /*
884 * Make sure this MTD device is not emulated on top of an UBI volume
885 * already. Well, generally this recursion works fine, but there are
886 * different problems like the UBI module takes a reference to itself
887 * by attaching (and thus, opening) the emulated MTD device. This
888 * results in inability to unload the module. And in general it makes
889 * no sense to attach emulated MTD devices, so we prohibit this.
890 */
891 if (mtd->type == MTD_UBIVOLUME) {
Richard Weinbergerbc743f32016-07-04 22:06:51 +0200892 pr_err("ubi: refuse attaching mtd%d - it is already emulated on top of UBI",
Artem Bityutskiy049333c2012-08-27 14:43:54 +0300893 mtd->index);
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200894 return -EINVAL;
895 }
Artem Bityutskiyb96bf4c2007-12-16 13:01:03 +0200896
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200897 if (ubi_num == UBI_DEV_NUM_AUTO) {
898 /* Search for an empty slot in the @ubi_devices array */
899 for (ubi_num = 0; ubi_num < UBI_MAX_DEVICES; ubi_num++)
900 if (!ubi_devices[ubi_num])
901 break;
902 if (ubi_num == UBI_MAX_DEVICES) {
Richard Weinbergerbc743f32016-07-04 22:06:51 +0200903 pr_err("ubi: only %d UBI devices may be created",
Artem Bityutskiy9c9ec142008-07-18 13:19:52 +0300904 UBI_MAX_DEVICES);
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200905 return -ENFILE;
906 }
907 } else {
908 if (ubi_num >= UBI_MAX_DEVICES)
909 return -EINVAL;
910
911 /* Make sure ubi_num is not busy */
912 if (ubi_devices[ubi_num]) {
Richard Weinbergerbc743f32016-07-04 22:06:51 +0200913 pr_err("ubi: ubi%i already exists", ubi_num);
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200914 return -EEXIST;
915 }
Artem Bityutskiyb96bf4c2007-12-16 13:01:03 +0200916 }
917
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200918 ubi = kzalloc(sizeof(struct ubi_device), GFP_KERNEL);
919 if (!ubi)
920 return -ENOMEM;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400921
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200922 ubi->mtd = mtd;
Artem Bityutskiy897a3162007-12-18 18:23:39 +0200923 ubi->ubi_num = ubi_num;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400924 ubi->vid_hdr_offset = vid_hdr_offset;
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200925 ubi->autoresize_vol_id = -1;
926
Richard Weinberger77e6c2f2012-09-26 17:51:45 +0200927#ifdef CONFIG_MTD_UBI_FASTMAP
928 ubi->fm_pool.used = ubi->fm_pool.size = 0;
929 ubi->fm_wl_pool.used = ubi->fm_wl_pool.size = 0;
930
931 /*
932 * fm_pool.max_size is 5% of the total number of PEBs but it's also
933 * between UBI_FM_MAX_POOL_SIZE and UBI_FM_MIN_POOL_SIZE.
934 */
935 ubi->fm_pool.max_size = min(((int)mtd_div_by_eb(ubi->mtd->size,
936 ubi->mtd) / 100) * 5, UBI_FM_MAX_POOL_SIZE);
shengyong212240d2015-05-26 10:07:05 +0000937 ubi->fm_pool.max_size = max(ubi->fm_pool.max_size,
938 UBI_FM_MIN_POOL_SIZE);
Richard Weinberger77e6c2f2012-09-26 17:51:45 +0200939
Richard Weinberger68e32262014-10-08 14:55:58 +0200940 ubi->fm_wl_pool.max_size = ubi->fm_pool.max_size / 2;
Richard Weinberger77e6c2f2012-09-26 17:51:45 +0200941 ubi->fm_disabled = !fm_autoconvert;
Richard Weinberger479c2c02014-10-08 15:14:09 +0200942 if (fm_debug)
943 ubi_enable_dbg_chk_fastmap(ubi);
Richard Weinberger77e6c2f2012-09-26 17:51:45 +0200944
945 if (!ubi->fm_disabled && (int)mtd_div_by_eb(ubi->mtd->size, ubi->mtd)
946 <= UBI_FM_MAX_START) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300947 ubi_err(ubi, "More than %i PEBs are needed for fastmap, sorry.",
Richard Weinberger77e6c2f2012-09-26 17:51:45 +0200948 UBI_FM_MAX_START);
949 ubi->fm_disabled = 1;
950 }
951
Tanya Brokhman326087032014-10-20 19:57:00 +0300952 ubi_msg(ubi, "default fastmap pool size: %d", ubi->fm_pool.max_size);
953 ubi_msg(ubi, "default fastmap WL pool size: %d",
954 ubi->fm_wl_pool.max_size);
Richard Weinberger77e6c2f2012-09-26 17:51:45 +0200955#else
956 ubi->fm_disabled = 1;
957#endif
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200958 mutex_init(&ubi->buf_mutex);
959 mutex_init(&ubi->ckvol_mutex);
Artem Bityutskiyf089c0b2009-05-07 11:46:49 +0300960 mutex_init(&ubi->device_mutex);
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200961 spin_lock_init(&ubi->volumes_lock);
Richard Weinberger111ab0b2014-11-10 16:28:08 +0100962 init_rwsem(&ubi->fm_protect);
963 init_rwsem(&ubi->fm_eba_sem);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200964
Tanya Brokhman45fc5c82014-11-09 13:06:25 +0200965 ubi_msg(ubi, "attaching mtd%d", mtd->index);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +0200966
Richard Genoud256334c2012-08-20 18:00:11 +0200967 err = io_init(ubi, max_beb_per1024);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400968 if (err)
969 goto out_free;
970
Stefan Roesead5942b2008-12-10 10:42:54 +0100971 err = -ENOMEM;
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +0200972 ubi->peb_buf = vmalloc(ubi->peb_size);
973 if (!ubi->peb_buf)
Artem Bityutskiye88d6e102007-08-29 14:51:52 +0300974 goto out_free;
975
Richard Weinberger77e6c2f2012-09-26 17:51:45 +0200976#ifdef CONFIG_MTD_UBI_FASTMAP
977 ubi->fm_size = ubi_calc_fm_size(ubi);
978 ubi->fm_buf = vzalloc(ubi->fm_size);
979 if (!ubi->fm_buf)
980 goto out_free;
981#endif
Richard Weinbergerdac6e202012-09-26 17:51:47 +0200982 err = ubi_attach(ubi, 0);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400983 if (err) {
Tanya Brokhman326087032014-10-20 19:57:00 +0300984 ubi_err(ubi, "failed to attach mtd%d, error %d",
985 mtd->index, err);
Ezequiel Garciaeab73772012-11-28 09:18:30 -0300986 goto out_free;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400987 }
988
Artem Bityutskiy4ccf8cf2008-01-16 15:44:24 +0200989 if (ubi->autoresize_vol_id != -1) {
990 err = autoresize(ubi, ubi->autoresize_vol_id);
991 if (err)
992 goto out_detach;
993 }
994
Iosif Harutyunov714fb872016-07-22 23:22:42 +0000995 /* Make device "available" before it becomes accessible via sysfs */
996 ubi_devices[ubi_num] = ubi;
997
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +0200998 err = uif_init(ubi, &ref);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +0400999 if (err)
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +02001000 goto out_detach;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001001
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001002 err = ubi_debugfs_init_dev(ubi);
1003 if (err)
1004 goto out_uif;
1005
Kees Cookf1701682013-07-03 15:04:58 -07001006 ubi->bgt_thread = kthread_create(ubi_thread, ubi, "%s", ubi->bgt_name);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001007 if (IS_ERR(ubi->bgt_thread)) {
1008 err = PTR_ERR(ubi->bgt_thread);
Tanya Brokhman326087032014-10-20 19:57:00 +03001009 ubi_err(ubi, "cannot spawn \"%s\", error %d",
1010 ubi->bgt_name, err);
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001011 goto out_debugfs;
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001012 }
1013
Tanya Brokhman326087032014-10-20 19:57:00 +03001014 ubi_msg(ubi, "attached mtd%d (name \"%s\", size %llu MiB)",
1015 mtd->index, mtd->name, ubi->flash_size >> 20);
1016 ubi_msg(ubi, "PEB size: %d bytes (%d KiB), LEB size: %d bytes",
Artem Bityutskiy719bb842012-08-27 17:14:58 +03001017 ubi->peb_size, ubi->peb_size >> 10, ubi->leb_size);
Tanya Brokhman326087032014-10-20 19:57:00 +03001018 ubi_msg(ubi, "min./max. I/O unit sizes: %d/%d, sub-page size %d",
Artem Bityutskiy719bb842012-08-27 17:14:58 +03001019 ubi->min_io_size, ubi->max_write_size, ubi->hdrs_min_io_size);
Tanya Brokhman326087032014-10-20 19:57:00 +03001020 ubi_msg(ubi, "VID header offset: %d (aligned %d), data offset: %d",
Artem Bityutskiy719bb842012-08-27 17:14:58 +03001021 ubi->vid_hdr_offset, ubi->vid_hdr_aloffset, ubi->leb_start);
Tanya Brokhman326087032014-10-20 19:57:00 +03001022 ubi_msg(ubi, "good PEBs: %d, bad PEBs: %d, corrupted PEBs: %d",
Artem Bityutskiy719bb842012-08-27 17:14:58 +03001023 ubi->good_peb_count, ubi->bad_peb_count, ubi->corr_peb_count);
Tanya Brokhman326087032014-10-20 19:57:00 +03001024 ubi_msg(ubi, "user volume: %d, internal volumes: %d, max. volumes count: %d",
Artem Bityutskiy719bb842012-08-27 17:14:58 +03001025 ubi->vol_count - UBI_INT_VOL_COUNT, UBI_INT_VOL_COUNT,
1026 ubi->vtbl_slots);
Tanya Brokhman326087032014-10-20 19:57:00 +03001027 ubi_msg(ubi, "max/mean erase counter: %d/%d, WL threshold: %d, image sequence number: %u",
Artem Bityutskiy719bb842012-08-27 17:14:58 +03001028 ubi->max_ec, ubi->mean_ec, CONFIG_MTD_UBI_WL_THRESHOLD,
1029 ubi->image_seq);
Tanya Brokhman326087032014-10-20 19:57:00 +03001030 ubi_msg(ubi, "available PEBs: %d, total reserved PEBs: %d, PEBs reserved for bad PEB handling: %d",
Artem Bityutskiy719bb842012-08-27 17:14:58 +03001031 ubi->avail_pebs, ubi->rsvd_pebs, ubi->beb_rsvd_pebs);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001032
Artem Bityutskiyddbd3b62009-05-23 13:44:09 +03001033 /*
1034 * The below lock makes sure we do not race with 'ubi_thread()' which
1035 * checks @ubi->thread_enabled. Otherwise we may fail to wake it up.
1036 */
1037 spin_lock(&ubi->wl_lock);
Artem Bityutskiy28237e42011-03-15 10:30:40 +02001038 ubi->thread_enabled = 1;
Artem Bityutskiyd37e6bf2008-07-24 18:28:11 +03001039 wake_up_process(ubi->bgt_thread);
Artem Bityutskiyddbd3b62009-05-23 13:44:09 +03001040 spin_unlock(&ubi->wl_lock);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001041
Dmitry Pervushin0e0ee1c2009-04-29 19:29:38 +04001042 ubi_notify_all(ubi, UBI_VOLUME_ADDED, NULL);
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001043 return ubi_num;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001044
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001045out_debugfs:
1046 ubi_debugfs_exit_dev(ubi);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001047out_uif:
Artem Bityutskiy01a41102011-05-18 18:08:05 +03001048 get_device(&ubi->dev);
1049 ubi_assert(ref);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001050 uif_close(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001051out_detach:
Iosif Harutyunov714fb872016-07-22 23:22:42 +00001052 ubi_devices[ubi_num] = NULL;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001053 ubi_wl_close(ubi);
Artem Bityutskiy47e1ec72012-05-18 12:41:17 +03001054 ubi_free_internal_volumes(ubi);
Vinit Agnihotrid7f0c4d2007-06-15 15:31:22 +05301055 vfree(ubi->vtbl);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001056out_free:
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +02001057 vfree(ubi->peb_buf);
Richard Weinberger77e6c2f2012-09-26 17:51:45 +02001058 vfree(ubi->fm_buf);
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +02001059 if (ref)
1060 put_device(&ubi->dev);
1061 else
1062 kfree(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001063 return err;
1064}
1065
1066/**
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001067 * ubi_detach_mtd_dev - detach an MTD device.
1068 * @ubi_num: UBI device number to detach from
1069 * @anyway: detach MTD even if device reference count is not zero
1070 *
1071 * This function destroys an UBI device number @ubi_num and detaches the
1072 * underlying MTD device. Returns zero in case of success and %-EBUSY if the
1073 * UBI device is busy and cannot be destroyed, and %-EINVAL if it does not
1074 * exist.
1075 *
1076 * Note, the invocations of this function has to be serialized by the
1077 * @ubi_devices_mutex.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001078 */
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001079int ubi_detach_mtd_dev(int ubi_num, int anyway)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001080{
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001081 struct ubi_device *ubi;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001082
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001083 if (ubi_num < 0 || ubi_num >= UBI_MAX_DEVICES)
1084 return -EINVAL;
1085
Dmitry Pervushin0e0ee1c2009-04-29 19:29:38 +04001086 ubi = ubi_get_device(ubi_num);
1087 if (!ubi)
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001088 return -EINVAL;
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001089
Dmitry Pervushin0e0ee1c2009-04-29 19:29:38 +04001090 spin_lock(&ubi_devices_lock);
1091 put_device(&ubi->dev);
1092 ubi->ref_count -= 1;
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001093 if (ubi->ref_count) {
1094 if (!anyway) {
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001095 spin_unlock(&ubi_devices_lock);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001096 return -EBUSY;
1097 }
1098 /* This may only happen if there is a bug */
Tanya Brokhman326087032014-10-20 19:57:00 +03001099 ubi_err(ubi, "%s reference count %d, destroy anyway",
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001100 ubi->ubi_name, ubi->ref_count);
1101 }
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001102 ubi_devices[ubi_num] = NULL;
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001103 spin_unlock(&ubi_devices_lock);
1104
Artem Bityutskiy897a3162007-12-18 18:23:39 +02001105 ubi_assert(ubi_num == ubi->ubi_num);
Dmitry Pervushin0e0ee1c2009-04-29 19:29:38 +04001106 ubi_notify_all(ubi, UBI_VOLUME_REMOVED, NULL);
Tanya Brokhman326087032014-10-20 19:57:00 +03001107 ubi_msg(ubi, "detaching mtd%d", ubi->mtd->index);
Richard Weinberger77e6c2f2012-09-26 17:51:45 +02001108#ifdef CONFIG_MTD_UBI_FASTMAP
1109 /* If we don't write a new fastmap at detach time we lose all
Richard Weinberger24b7a342014-10-06 15:18:41 +02001110 * EC updates that have been made since the last written fastmap.
1111 * In case of fastmap debugging we omit the update to simulate an
1112 * unclean shutdown. */
1113 if (!ubi_dbg_chk_fastmap(ubi))
1114 ubi_update_fastmap(ubi);
Richard Weinberger77e6c2f2012-09-26 17:51:45 +02001115#endif
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001116 /*
1117 * Before freeing anything, we have to stop the background thread to
1118 * prevent it from doing anything on this device while we are freeing.
1119 */
1120 if (ubi->bgt_thread)
1121 kthread_stop(ubi->bgt_thread);
1122
Artem Bityutskiy36b477d2009-01-20 18:04:09 +02001123 /*
1124 * Get a reference to the device in order to prevent 'dev_release()'
Artem Bityutskiy0bf1c432010-01-12 12:26:42 +02001125 * from freeing the @ubi object.
Artem Bityutskiy36b477d2009-01-20 18:04:09 +02001126 */
1127 get_device(&ubi->dev);
1128
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001129 ubi_debugfs_exit_dev(ubi);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001130 uif_close(ubi);
Richard Weinberger77e6c2f2012-09-26 17:51:45 +02001131
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001132 ubi_wl_close(ubi);
Artem Bityutskiy47e1ec72012-05-18 12:41:17 +03001133 ubi_free_internal_volumes(ubi);
Artem Bityutskiy92ad8f32007-05-06 16:12:54 +03001134 vfree(ubi->vtbl);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001135 put_mtd_device(ubi->mtd);
Artem Bityutskiy0ca39d72012-03-08 15:29:37 +02001136 vfree(ubi->peb_buf);
Richard Weinberger77e6c2f2012-09-26 17:51:45 +02001137 vfree(ubi->fm_buf);
Tanya Brokhman326087032014-10-20 19:57:00 +03001138 ubi_msg(ubi, "mtd%d is detached", ubi->mtd->index);
Artem Bityutskiy36b477d2009-01-20 18:04:09 +02001139 put_device(&ubi->dev);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001140 return 0;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001141}
1142
Artem Bityutskiy3a8d4642007-12-16 12:32:51 +02001143/**
Artem Bityutskiyf9b00802010-01-05 16:48:40 +02001144 * open_mtd_by_chdev - open an MTD device by its character device node path.
1145 * @mtd_dev: MTD character device node path
1146 *
1147 * This helper function opens an MTD device by its character node device path.
1148 * Returns MTD device description object in case of success and a negative
1149 * error code in case of failure.
1150 */
1151static struct mtd_info * __init open_mtd_by_chdev(const char *mtd_dev)
1152{
Richard Weinberger61edc3f2016-06-13 00:49:04 +02001153 int err, minor;
Richard Weinberger1a498ec2016-06-13 00:49:03 +02001154 struct path path;
Richard Weinberger61edc3f2016-06-13 00:49:04 +02001155 struct kstat stat;
Artem Bityutskiyf9b00802010-01-05 16:48:40 +02001156
1157 /* Probably this is an MTD character device node path */
Richard Weinberger1a498ec2016-06-13 00:49:03 +02001158 err = kern_path(mtd_dev, LOOKUP_FOLLOW, &path);
Artem Bityutskiyf9b00802010-01-05 16:48:40 +02001159 if (err)
1160 return ERR_PTR(err);
1161
Richard Weinberger61edc3f2016-06-13 00:49:04 +02001162 err = vfs_getattr(&path, &stat);
Richard Weinberger1a498ec2016-06-13 00:49:03 +02001163 path_put(&path);
Richard Weinberger61edc3f2016-06-13 00:49:04 +02001164 if (err)
1165 return ERR_PTR(err);
1166
1167 /* MTD device number is defined by the major / minor numbers */
1168 if (MAJOR(stat.rdev) != MTD_CHAR_MAJOR || !S_ISCHR(stat.mode))
Artem Bityutskiyf9b00802010-01-05 16:48:40 +02001169 return ERR_PTR(-EINVAL);
1170
Richard Weinberger61edc3f2016-06-13 00:49:04 +02001171 minor = MINOR(stat.rdev);
1172
Artem Bityutskiyf9b00802010-01-05 16:48:40 +02001173 if (minor & 1)
1174 /*
1175 * Just do not think the "/dev/mtdrX" devices support is need,
1176 * so do not support them to avoid doing extra work.
1177 */
1178 return ERR_PTR(-EINVAL);
1179
1180 return get_mtd_device(NULL, minor / 2);
1181}
1182
1183/**
1184 * open_mtd_device - open MTD device by name, character device path, or number.
1185 * @mtd_dev: name, character device node path, or MTD device device number
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001186 *
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001187 * This function tries to open and MTD device described by @mtd_dev string,
Artem Bityutskiyf9b00802010-01-05 16:48:40 +02001188 * which is first treated as ASCII MTD device number, and if it is not true, it
1189 * is treated as MTD device name, and if that is also not true, it is treated
1190 * as MTD character device node path. Returns MTD device description object in
1191 * case of success and a negative error code in case of failure.
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001192 */
1193static struct mtd_info * __init open_mtd_device(const char *mtd_dev)
1194{
1195 struct mtd_info *mtd;
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001196 int mtd_num;
1197 char *endp;
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001198
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001199 mtd_num = simple_strtoul(mtd_dev, &endp, 0);
1200 if (*endp != '\0' || mtd_dev == endp) {
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001201 /*
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001202 * This does not look like an ASCII integer, probably this is
1203 * MTD device name.
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001204 */
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001205 mtd = get_mtd_device_nm(mtd_dev);
Artem Bityutskiyf9b00802010-01-05 16:48:40 +02001206 if (IS_ERR(mtd) && PTR_ERR(mtd) == -ENODEV)
1207 /* Probably this is an MTD character device node path */
1208 mtd = open_mtd_by_chdev(mtd_dev);
Artem Bityutskiyd1f3dd62007-12-25 19:17:00 +02001209 } else
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001210 mtd = get_mtd_device(NULL, mtd_num);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001211
1212 return mtd;
1213}
1214
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001215static int __init ubi_init(void)
1216{
1217 int err, i, k;
1218
1219 /* Ensure that EC and VID headers have correct size */
1220 BUILD_BUG_ON(sizeof(struct ubi_ec_hdr) != 64);
1221 BUILD_BUG_ON(sizeof(struct ubi_vid_hdr) != 64);
1222
1223 if (mtd_devs > UBI_MAX_DEVICES) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001224 pr_err("UBI error: too many MTD devices, maximum is %d",
1225 UBI_MAX_DEVICES);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001226 return -EINVAL;
1227 }
1228
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001229 /* Create base sysfs directory and sysfs files */
Takashi Iwai53cd2552015-05-15 16:20:05 +08001230 err = class_register(&ubi_class);
1231 if (err < 0)
1232 return err;
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001233
1234 err = misc_register(&ubi_ctrl_cdev);
1235 if (err) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001236 pr_err("UBI error: cannot register device");
Takashi Iwai53cd2552015-05-15 16:20:05 +08001237 goto out;
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001238 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001239
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +02001240 ubi_wl_entry_slab = kmem_cache_create("ubi_wl_entry_slab",
Artem Bityutskiyc4506092008-02-12 16:36:41 +02001241 sizeof(struct ubi_wl_entry),
1242 0, 0, NULL);
Julia Lawall4d525142013-12-29 23:47:19 +01001243 if (!ubi_wl_entry_slab) {
1244 err = -ENOMEM;
Artem Bityutskiyb9a06622008-01-16 12:11:54 +02001245 goto out_dev_unreg;
Julia Lawall4d525142013-12-29 23:47:19 +01001246 }
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +02001247
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001248 err = ubi_debugfs_init();
1249 if (err)
1250 goto out_slab;
1251
1252
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001253 /* Attach MTD devices */
1254 for (i = 0; i < mtd_devs; i++) {
1255 struct mtd_dev_param *p = &mtd_dev_param[i];
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001256 struct mtd_info *mtd;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001257
1258 cond_resched();
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001259
1260 mtd = open_mtd_device(p->name);
1261 if (IS_ERR(mtd)) {
1262 err = PTR_ERR(mtd);
Tanya Brokhman326087032014-10-20 19:57:00 +03001263 pr_err("UBI error: cannot open mtd %s, error %d",
1264 p->name, err);
Mike Frysinger1557b9e2013-04-22 21:40:16 -04001265 /* See comment below re-ubi_is_module(). */
1266 if (ubi_is_module())
1267 goto out_detach;
1268 continue;
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001269 }
1270
1271 mutex_lock(&ubi_devices_mutex);
Mike Frysinger83ff59a2013-05-03 14:55:23 -04001272 err = ubi_attach_mtd_dev(mtd, p->ubi_num,
Richard Genoudedac4932012-08-20 18:00:14 +02001273 p->vid_hdr_offs, p->max_beb_per1024);
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001274 mutex_unlock(&ubi_devices_mutex);
1275 if (err < 0) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001276 pr_err("UBI error: cannot attach mtd%d",
1277 mtd->index);
Marc Kleine-Buddeaf7ad7a2010-05-05 10:17:25 +02001278 put_mtd_device(mtd);
1279
1280 /*
1281 * Originally UBI stopped initializing on any error.
1282 * However, later on it was found out that this
1283 * behavior is not very good when UBI is compiled into
1284 * the kernel and the MTD devices to attach are passed
1285 * through the command line. Indeed, UBI failure
1286 * stopped whole boot sequence.
1287 *
1288 * To fix this, we changed the behavior for the
1289 * non-module case, but preserved the old behavior for
1290 * the module case, just for compatibility. This is a
1291 * little inconsistent, though.
1292 */
1293 if (ubi_is_module())
1294 goto out_detach;
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001295 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001296 }
1297
Ezequiel Garcia9d54c8a2014-02-25 13:25:22 -03001298 err = ubiblock_init();
1299 if (err) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001300 pr_err("UBI error: block: cannot initialize, error %d", err);
Ezequiel Garcia9d54c8a2014-02-25 13:25:22 -03001301
1302 /* See comment above re-ubi_is_module(). */
1303 if (ubi_is_module())
1304 goto out_detach;
1305 }
1306
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001307 return 0;
1308
1309out_detach:
1310 for (k = 0; k < i; k++)
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001311 if (ubi_devices[k]) {
1312 mutex_lock(&ubi_devices_mutex);
1313 ubi_detach_mtd_dev(ubi_devices[k]->ubi_num, 1);
1314 mutex_unlock(&ubi_devices_mutex);
1315 }
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001316 ubi_debugfs_exit();
1317out_slab:
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +02001318 kmem_cache_destroy(ubi_wl_entry_slab);
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001319out_dev_unreg:
1320 misc_deregister(&ubi_ctrl_cdev);
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001321out:
Takashi Iwai53cd2552015-05-15 16:20:05 +08001322 class_unregister(&ubi_class);
Tanya Brokhman326087032014-10-20 19:57:00 +03001323 pr_err("UBI error: cannot initialize UBI, error %d", err);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001324 return err;
1325}
Jiang Lucf38aca2012-08-08 10:31:01 +08001326late_initcall(ubi_init);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001327
1328static void __exit ubi_exit(void)
1329{
Artem Bityutskiyb96bf4c2007-12-16 13:01:03 +02001330 int i;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001331
Ezequiel Garcia9d54c8a2014-02-25 13:25:22 -03001332 ubiblock_exit();
1333
Artem Bityutskiyb96bf4c2007-12-16 13:01:03 +02001334 for (i = 0; i < UBI_MAX_DEVICES; i++)
Artem Bityutskiycdfa7882007-12-17 20:33:20 +02001335 if (ubi_devices[i]) {
1336 mutex_lock(&ubi_devices_mutex);
1337 ubi_detach_mtd_dev(ubi_devices[i]->ubi_num, 1);
1338 mutex_unlock(&ubi_devices_mutex);
1339 }
Artem Bityutskiy2a734bb2011-05-18 14:53:05 +03001340 ubi_debugfs_exit();
Artem Bityutskiy06b68ba2007-12-16 12:49:01 +02001341 kmem_cache_destroy(ubi_wl_entry_slab);
Artem Bityutskiy9f961b52007-12-16 16:59:31 +02001342 misc_deregister(&ubi_ctrl_cdev);
Takashi Iwai53cd2552015-05-15 16:20:05 +08001343 class_unregister(&ubi_class);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001344}
1345module_exit(ubi_exit);
1346
1347/**
Artem Bityutskiyebaaf1a2008-07-18 13:34:32 +03001348 * bytes_str_to_int - convert a number of bytes string into an integer.
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001349 * @str: the string to convert
1350 *
1351 * This function returns positive resulting integer in case of success and a
1352 * negative error code in case of failure.
1353 */
1354static int __init bytes_str_to_int(const char *str)
1355{
1356 char *endp;
1357 unsigned long result;
1358
1359 result = simple_strtoul(str, &endp, 0);
Roel Kluin774b1382009-10-16 14:00:17 +02001360 if (str == endp || result >= INT_MAX) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001361 pr_err("UBI error: incorrect bytes count: \"%s\"\n", str);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001362 return -EINVAL;
1363 }
1364
1365 switch (*endp) {
1366 case 'G':
1367 result *= 1024;
1368 case 'M':
1369 result *= 1024;
1370 case 'K':
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001371 result *= 1024;
Artem Bityutskiyaeddb872007-12-26 14:25:58 +02001372 if (endp[1] == 'i' && endp[2] == 'B')
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001373 endp += 2;
1374 case '\0':
1375 break;
1376 default:
Tanya Brokhman326087032014-10-20 19:57:00 +03001377 pr_err("UBI error: incorrect bytes count: \"%s\"\n", str);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001378 return -EINVAL;
1379 }
1380
1381 return result;
1382}
1383
1384/**
1385 * ubi_mtd_param_parse - parse the 'mtd=' UBI parameter.
1386 * @val: the parameter value to parse
1387 * @kp: not used
1388 *
1389 * This function returns zero in case of success and a negative error code in
1390 * case of error.
1391 */
1392static int __init ubi_mtd_param_parse(const char *val, struct kernel_param *kp)
1393{
1394 int i, len;
1395 struct mtd_dev_param *p;
1396 char buf[MTD_PARAM_LEN_MAX];
1397 char *pbuf = &buf[0];
Mike Frysinger83ff59a2013-05-03 14:55:23 -04001398 char *tokens[MTD_PARAM_MAX_COUNT], *token;
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001399
Artem Bityutskiy77c722d2007-12-16 16:46:57 +02001400 if (!val)
1401 return -EINVAL;
1402
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001403 if (mtd_devs == UBI_MAX_DEVICES) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001404 pr_err("UBI error: too many parameters, max. is %d\n",
1405 UBI_MAX_DEVICES);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001406 return -EINVAL;
1407 }
1408
1409 len = strnlen(val, MTD_PARAM_LEN_MAX);
1410 if (len == MTD_PARAM_LEN_MAX) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001411 pr_err("UBI error: parameter \"%s\" is too long, max. is %d\n",
1412 val, MTD_PARAM_LEN_MAX);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001413 return -EINVAL;
1414 }
1415
1416 if (len == 0) {
Tanya Brokhman45fc5c82014-11-09 13:06:25 +02001417 pr_warn("UBI warning: empty 'mtd=' parameter - ignored\n");
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001418 return 0;
1419 }
1420
1421 strcpy(buf, val);
1422
1423 /* Get rid of the final newline */
1424 if (buf[len - 1] == '\n')
Artem Bityutskiy503990e2007-07-11 16:03:29 +03001425 buf[len - 1] = '\0';
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001426
Richard Genoud5993f9b2012-08-17 16:35:19 +02001427 for (i = 0; i < MTD_PARAM_MAX_COUNT; i++)
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001428 tokens[i] = strsep(&pbuf, ",");
1429
1430 if (pbuf) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001431 pr_err("UBI error: too many arguments at \"%s\"\n", val);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001432 return -EINVAL;
1433 }
1434
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001435 p = &mtd_dev_param[mtd_devs];
1436 strcpy(&p->name[0], tokens[0]);
1437
Mike Frysinger83ff59a2013-05-03 14:55:23 -04001438 token = tokens[1];
1439 if (token) {
1440 p->vid_hdr_offs = bytes_str_to_int(token);
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001441
Mike Frysinger83ff59a2013-05-03 14:55:23 -04001442 if (p->vid_hdr_offs < 0)
1443 return p->vid_hdr_offs;
1444 }
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001445
Mike Frysinger83ff59a2013-05-03 14:55:23 -04001446 token = tokens[2];
1447 if (token) {
1448 int err = kstrtoint(token, 10, &p->max_beb_per1024);
Richard Genoudedac4932012-08-20 18:00:14 +02001449
1450 if (err) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001451 pr_err("UBI error: bad value for max_beb_per1024 parameter: %s",
1452 token);
Richard Genoudedac4932012-08-20 18:00:14 +02001453 return -EINVAL;
1454 }
1455 }
1456
Mike Frysinger83ff59a2013-05-03 14:55:23 -04001457 token = tokens[3];
1458 if (token) {
1459 int err = kstrtoint(token, 10, &p->ubi_num);
1460
1461 if (err) {
Tanya Brokhman326087032014-10-20 19:57:00 +03001462 pr_err("UBI error: bad value for ubi_num parameter: %s",
1463 token);
Mike Frysinger83ff59a2013-05-03 14:55:23 -04001464 return -EINVAL;
1465 }
1466 } else
1467 p->ubi_num = UBI_DEV_NUM_AUTO;
1468
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001469 mtd_devs += 1;
1470 return 0;
1471}
1472
1473module_param_call(mtd, ubi_mtd_param_parse, NULL, NULL, 000);
Mike Frysinger83ff59a2013-05-03 14:55:23 -04001474MODULE_PARM_DESC(mtd, "MTD devices to attach. Parameter format: mtd=<name|num|path>[,<vid_hdr_offs>[,max_beb_per1024[,ubi_num]]].\n"
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001475 "Multiple \"mtd\" parameters may be specified.\n"
Richard Genoudedac4932012-08-20 18:00:14 +02001476 "MTD devices may be specified by their number, name, or path to the MTD character device node.\n"
1477 "Optional \"vid_hdr_offs\" parameter specifies UBI VID header position to be used by UBI. (default value if 0)\n"
1478 "Optional \"max_beb_per1024\" parameter specifies the maximum expected bad eraseblock per 1024 eraseblocks. (default value ("
1479 __stringify(CONFIG_MTD_UBI_BEB_LIMIT) ") if 0)\n"
Mike Frysinger83ff59a2013-05-03 14:55:23 -04001480 "Optional \"ubi_num\" parameter specifies UBI device number which have to be assigned to the newly created UBI device (assigned automatically by default)\n"
Richard Genoudedac4932012-08-20 18:00:14 +02001481 "\n"
1482 "Example 1: mtd=/dev/mtd0 - attach MTD device /dev/mtd0.\n"
1483 "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"
1484 "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"
Mike Frysinger83ff59a2013-05-03 14:55:23 -04001485 "Example 4: mtd=/dev/mtd1,0,0,5 - attach MTD device /dev/mtd1 to UBI 5 and using default values for the other fields.\n"
Richard Genoudedac4932012-08-20 18:00:14 +02001486 "\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 +02001487#ifdef CONFIG_MTD_UBI_FASTMAP
1488module_param(fm_autoconvert, bool, 0644);
1489MODULE_PARM_DESC(fm_autoconvert, "Set this parameter to enable fastmap automatically on images without a fastmap.");
Richard Weinberger479c2c02014-10-08 15:14:09 +02001490module_param(fm_debug, bool, 0);
1491MODULE_PARM_DESC(fm_debug, "Set this parameter to enable fastmap debugging by default. Warning, this will make fastmap slow!");
Richard Weinberger77e6c2f2012-09-26 17:51:45 +02001492#endif
Artem B. Bityutskiy801c1352006-06-27 12:22:22 +04001493MODULE_VERSION(__stringify(UBI_VERSION));
1494MODULE_DESCRIPTION("UBI - Unsorted Block Images");
1495MODULE_AUTHOR("Artem Bityutskiy");
1496MODULE_LICENSE("GPL");