blob: 85a3f197e7f0bd854ed2cfbb7b4a354b98ebb3b3 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002 * Core registration and callback routines for MTD
3 * drivers and users.
4 *
David Woodhousea1452a32010-08-08 20:58:20 +01005 * Copyright © 1999-2010 David Woodhouse <dwmw2@infradead.org>
6 * Copyright © 2006 Red Hat UK Limited
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070022 */
23
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/module.h>
25#include <linux/kernel.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070026#include <linux/ptrace.h>
Alexey Dobriyan447d9bd2011-05-13 23:34:19 +030027#include <linux/seq_file.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/string.h>
29#include <linux/timer.h>
30#include <linux/major.h>
31#include <linux/fs.h>
Artem Bityutskiy77993082006-10-11 14:52:44 +030032#include <linux/err.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#include <linux/ioctl.h>
34#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#include <linux/proc_fs.h>
Ben Hutchingsb520e412010-01-29 20:59:42 +000036#include <linux/idr.h>
Jörn Engela33eb6b2010-04-27 09:40:52 +020037#include <linux/backing-dev.h>
Tejun Heo05d71b462010-03-30 02:52:39 +090038#include <linux/gfp.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
40#include <linux/mtd/mtd.h>
Jamie Ilesf5671ab2011-05-23 17:15:46 +010041#include <linux/mtd/partitions.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
Ben Dooks356d70f2007-05-28 20:28:34 +010043#include "mtdcore.h"
Jörn Engela33eb6b2010-04-27 09:40:52 +020044/*
45 * backing device capabilities for non-mappable devices (such as NAND flash)
46 * - permits private mappings, copies are taken of the data
47 */
H Hartley Sweetenca91fac2011-01-11 18:37:25 -060048static struct backing_dev_info mtd_bdi_unmappable = {
Jörn Engela33eb6b2010-04-27 09:40:52 +020049 .capabilities = BDI_CAP_MAP_COPY,
50};
51
52/*
53 * backing device capabilities for R/O mappable devices (such as ROM)
54 * - permits private mappings, copies are taken of the data
55 * - permits non-writable shared mappings
56 */
H Hartley Sweetenca91fac2011-01-11 18:37:25 -060057static struct backing_dev_info mtd_bdi_ro_mappable = {
Jörn Engela33eb6b2010-04-27 09:40:52 +020058 .capabilities = (BDI_CAP_MAP_COPY | BDI_CAP_MAP_DIRECT |
59 BDI_CAP_EXEC_MAP | BDI_CAP_READ_MAP),
60};
61
62/*
63 * backing device capabilities for writable mappable devices (such as RAM)
64 * - permits private mappings, copies are taken of the data
65 * - permits non-writable shared mappings
66 */
H Hartley Sweetenca91fac2011-01-11 18:37:25 -060067static struct backing_dev_info mtd_bdi_rw_mappable = {
Jörn Engela33eb6b2010-04-27 09:40:52 +020068 .capabilities = (BDI_CAP_MAP_COPY | BDI_CAP_MAP_DIRECT |
69 BDI_CAP_EXEC_MAP | BDI_CAP_READ_MAP |
70 BDI_CAP_WRITE_MAP),
71};
Ben Dooks356d70f2007-05-28 20:28:34 +010072
David Woodhouse15bce402009-04-05 07:40:58 -070073static int mtd_cls_suspend(struct device *dev, pm_message_t state);
74static int mtd_cls_resume(struct device *dev);
David Brownell1f24b5a2009-03-26 00:42:41 -070075
David Woodhouse15bce402009-04-05 07:40:58 -070076static struct class mtd_class = {
77 .name = "mtd",
78 .owner = THIS_MODULE,
79 .suspend = mtd_cls_suspend,
80 .resume = mtd_cls_resume,
81};
David Brownell1f24b5a2009-03-26 00:42:41 -070082
Ben Hutchingsb520e412010-01-29 20:59:42 +000083static DEFINE_IDR(mtd_idr);
84
Thomas Gleixner97894cd2005-11-07 11:15:26 +000085/* These are exported solely for the purpose of mtd_blkdevs.c. You
Linus Torvalds1da177e2005-04-16 15:20:36 -070086 should not use them for _anything_ else */
Ingo Molnar48b19262006-03-31 02:29:41 -080087DEFINE_MUTEX(mtd_table_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -070088EXPORT_SYMBOL_GPL(mtd_table_mutex);
Ben Hutchingsb520e412010-01-29 20:59:42 +000089
90struct mtd_info *__mtd_next_device(int i)
91{
92 return idr_get_next(&mtd_idr, &i);
93}
94EXPORT_SYMBOL_GPL(__mtd_next_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -070095
96static LIST_HEAD(mtd_notifiers);
97
David Brownell1f24b5a2009-03-26 00:42:41 -070098
99#if defined(CONFIG_MTD_CHAR) || defined(CONFIG_MTD_CHAR_MODULE)
100#define MTD_DEVT(index) MKDEV(MTD_CHAR_MAJOR, (index)*2)
101#else
102#define MTD_DEVT(index) 0
103#endif
104
105/* REVISIT once MTD uses the driver model better, whoever allocates
106 * the mtd_info will probably want to use the release() hook...
107 */
108static void mtd_release(struct device *dev)
109{
Artem Bityutskiyd5de20a2011-12-29 18:00:29 +0200110 struct mtd_info *mtd = dev_get_drvdata(dev);
111 dev_t index = MTD_DEVT(mtd->index);
David Brownell1f24b5a2009-03-26 00:42:41 -0700112
113 /* remove /dev/mtdXro node if needed */
Denis V. Lunev2fdb1142009-04-12 08:14:46 +0100114 if (index)
David Woodhouse15bce402009-04-05 07:40:58 -0700115 device_destroy(&mtd_class, index + 1);
116}
117
118static int mtd_cls_suspend(struct device *dev, pm_message_t state)
119{
Artem Bityutskiyd5de20a2011-12-29 18:00:29 +0200120 struct mtd_info *mtd = dev_get_drvdata(dev);
Saeed Bishara6afc4fd2009-07-28 04:56:43 -0700121
122 if (mtd && mtd->suspend)
Artem Bityutskiy3fe4bae2011-12-23 19:25:16 +0200123 return mtd_suspend(mtd);
David Woodhouse15bce402009-04-05 07:40:58 -0700124 else
125 return 0;
126}
127
128static int mtd_cls_resume(struct device *dev)
129{
Artem Bityutskiyd5de20a2011-12-29 18:00:29 +0200130 struct mtd_info *mtd = dev_get_drvdata(dev);
David Woodhouse15bce402009-04-05 07:40:58 -0700131
Saeed Bishara6afc4fd2009-07-28 04:56:43 -0700132 if (mtd && mtd->resume)
Artem Bityutskiyead995f2011-12-23 19:31:25 +0200133 mtd_resume(mtd);
David Woodhouse15bce402009-04-05 07:40:58 -0700134 return 0;
David Brownell1f24b5a2009-03-26 00:42:41 -0700135}
136
137static ssize_t mtd_type_show(struct device *dev,
138 struct device_attribute *attr, char *buf)
139{
Artem Bityutskiyd5de20a2011-12-29 18:00:29 +0200140 struct mtd_info *mtd = dev_get_drvdata(dev);
David Brownell1f24b5a2009-03-26 00:42:41 -0700141 char *type;
142
143 switch (mtd->type) {
144 case MTD_ABSENT:
145 type = "absent";
146 break;
147 case MTD_RAM:
148 type = "ram";
149 break;
150 case MTD_ROM:
151 type = "rom";
152 break;
153 case MTD_NORFLASH:
154 type = "nor";
155 break;
156 case MTD_NANDFLASH:
157 type = "nand";
158 break;
159 case MTD_DATAFLASH:
160 type = "dataflash";
161 break;
162 case MTD_UBIVOLUME:
163 type = "ubi";
164 break;
165 default:
166 type = "unknown";
167 }
168
169 return snprintf(buf, PAGE_SIZE, "%s\n", type);
170}
Kevin Cernekee694bb7f2009-04-03 13:00:45 -0700171static DEVICE_ATTR(type, S_IRUGO, mtd_type_show, NULL);
172
173static ssize_t mtd_flags_show(struct device *dev,
174 struct device_attribute *attr, char *buf)
175{
Artem Bityutskiyd5de20a2011-12-29 18:00:29 +0200176 struct mtd_info *mtd = dev_get_drvdata(dev);
Kevin Cernekee694bb7f2009-04-03 13:00:45 -0700177
178 return snprintf(buf, PAGE_SIZE, "0x%lx\n", (unsigned long)mtd->flags);
179
180}
181static DEVICE_ATTR(flags, S_IRUGO, mtd_flags_show, NULL);
182
183static ssize_t mtd_size_show(struct device *dev,
184 struct device_attribute *attr, char *buf)
185{
Artem Bityutskiyd5de20a2011-12-29 18:00:29 +0200186 struct mtd_info *mtd = dev_get_drvdata(dev);
Kevin Cernekee694bb7f2009-04-03 13:00:45 -0700187
188 return snprintf(buf, PAGE_SIZE, "%llu\n",
189 (unsigned long long)mtd->size);
190
191}
192static DEVICE_ATTR(size, S_IRUGO, mtd_size_show, NULL);
193
194static ssize_t mtd_erasesize_show(struct device *dev,
195 struct device_attribute *attr, char *buf)
196{
Artem Bityutskiyd5de20a2011-12-29 18:00:29 +0200197 struct mtd_info *mtd = dev_get_drvdata(dev);
Kevin Cernekee694bb7f2009-04-03 13:00:45 -0700198
199 return snprintf(buf, PAGE_SIZE, "%lu\n", (unsigned long)mtd->erasesize);
200
201}
202static DEVICE_ATTR(erasesize, S_IRUGO, mtd_erasesize_show, NULL);
203
204static ssize_t mtd_writesize_show(struct device *dev,
205 struct device_attribute *attr, char *buf)
206{
Artem Bityutskiyd5de20a2011-12-29 18:00:29 +0200207 struct mtd_info *mtd = dev_get_drvdata(dev);
Kevin Cernekee694bb7f2009-04-03 13:00:45 -0700208
209 return snprintf(buf, PAGE_SIZE, "%lu\n", (unsigned long)mtd->writesize);
210
211}
212static DEVICE_ATTR(writesize, S_IRUGO, mtd_writesize_show, NULL);
213
Artem Bityutskiye7693542009-04-18 12:29:42 +0300214static ssize_t mtd_subpagesize_show(struct device *dev,
215 struct device_attribute *attr, char *buf)
216{
Artem Bityutskiyd5de20a2011-12-29 18:00:29 +0200217 struct mtd_info *mtd = dev_get_drvdata(dev);
Artem Bityutskiye7693542009-04-18 12:29:42 +0300218 unsigned int subpagesize = mtd->writesize >> mtd->subpage_sft;
219
220 return snprintf(buf, PAGE_SIZE, "%u\n", subpagesize);
221
222}
223static DEVICE_ATTR(subpagesize, S_IRUGO, mtd_subpagesize_show, NULL);
224
Kevin Cernekee694bb7f2009-04-03 13:00:45 -0700225static ssize_t mtd_oobsize_show(struct device *dev,
226 struct device_attribute *attr, char *buf)
227{
Artem Bityutskiyd5de20a2011-12-29 18:00:29 +0200228 struct mtd_info *mtd = dev_get_drvdata(dev);
Kevin Cernekee694bb7f2009-04-03 13:00:45 -0700229
230 return snprintf(buf, PAGE_SIZE, "%lu\n", (unsigned long)mtd->oobsize);
231
232}
233static DEVICE_ATTR(oobsize, S_IRUGO, mtd_oobsize_show, NULL);
234
235static ssize_t mtd_numeraseregions_show(struct device *dev,
236 struct device_attribute *attr, char *buf)
237{
Artem Bityutskiyd5de20a2011-12-29 18:00:29 +0200238 struct mtd_info *mtd = dev_get_drvdata(dev);
Kevin Cernekee694bb7f2009-04-03 13:00:45 -0700239
240 return snprintf(buf, PAGE_SIZE, "%u\n", mtd->numeraseregions);
241
242}
243static DEVICE_ATTR(numeraseregions, S_IRUGO, mtd_numeraseregions_show,
244 NULL);
245
246static ssize_t mtd_name_show(struct device *dev,
247 struct device_attribute *attr, char *buf)
248{
Artem Bityutskiyd5de20a2011-12-29 18:00:29 +0200249 struct mtd_info *mtd = dev_get_drvdata(dev);
Kevin Cernekee694bb7f2009-04-03 13:00:45 -0700250
251 return snprintf(buf, PAGE_SIZE, "%s\n", mtd->name);
252
253}
254static DEVICE_ATTR(name, S_IRUGO, mtd_name_show, NULL);
David Brownell1f24b5a2009-03-26 00:42:41 -0700255
256static struct attribute *mtd_attrs[] = {
Kevin Cernekee694bb7f2009-04-03 13:00:45 -0700257 &dev_attr_type.attr,
258 &dev_attr_flags.attr,
259 &dev_attr_size.attr,
260 &dev_attr_erasesize.attr,
261 &dev_attr_writesize.attr,
Artem Bityutskiye7693542009-04-18 12:29:42 +0300262 &dev_attr_subpagesize.attr,
Kevin Cernekee694bb7f2009-04-03 13:00:45 -0700263 &dev_attr_oobsize.attr,
264 &dev_attr_numeraseregions.attr,
265 &dev_attr_name.attr,
David Brownell1f24b5a2009-03-26 00:42:41 -0700266 NULL,
267};
268
H Hartley Sweetenfca91082009-08-06 16:05:32 -0700269static struct attribute_group mtd_group = {
David Brownell1f24b5a2009-03-26 00:42:41 -0700270 .attrs = mtd_attrs,
271};
272
David Woodhouse6469f542009-09-20 05:55:36 -0700273static const struct attribute_group *mtd_groups[] = {
David Brownell1f24b5a2009-03-26 00:42:41 -0700274 &mtd_group,
275 NULL,
276};
277
278static struct device_type mtd_devtype = {
279 .name = "mtd",
280 .groups = mtd_groups,
281 .release = mtd_release,
282};
283
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284/**
285 * add_mtd_device - register an MTD device
286 * @mtd: pointer to new MTD device info structure
287 *
288 * Add a device to the list of MTD devices present in the system, and
289 * notify each currently active MTD 'user' of its arrival. Returns
290 * zero on success or 1 on failure, which currently will only happen
Ben Hutchingsb520e412010-01-29 20:59:42 +0000291 * if there is insufficient memory or a sysfs error.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292 */
293
294int add_mtd_device(struct mtd_info *mtd)
295{
Ben Hutchingsb520e412010-01-29 20:59:42 +0000296 struct mtd_notifier *not;
297 int i, error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298
David Howells402d3262009-02-12 10:40:00 +0000299 if (!mtd->backing_dev_info) {
300 switch (mtd->type) {
301 case MTD_RAM:
302 mtd->backing_dev_info = &mtd_bdi_rw_mappable;
303 break;
304 case MTD_ROM:
305 mtd->backing_dev_info = &mtd_bdi_ro_mappable;
306 break;
307 default:
308 mtd->backing_dev_info = &mtd_bdi_unmappable;
309 break;
310 }
311 }
312
Artem B. Bityutskiy783ed812006-06-14 19:53:44 +0400313 BUG_ON(mtd->writesize == 0);
Ingo Molnar48b19262006-03-31 02:29:41 -0800314 mutex_lock(&mtd_table_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315
Ben Hutchingsb520e412010-01-29 20:59:42 +0000316 do {
317 if (!idr_pre_get(&mtd_idr, GFP_KERNEL))
318 goto fail_locked;
319 error = idr_get_new(&mtd_idr, mtd, &i);
320 } while (error == -EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321
Ben Hutchingsb520e412010-01-29 20:59:42 +0000322 if (error)
323 goto fail_locked;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324
Ben Hutchingsb520e412010-01-29 20:59:42 +0000325 mtd->index = i;
326 mtd->usecount = 0;
Adrian Hunter69423d92008-12-10 13:37:21 +0000327
Ben Hutchingsb520e412010-01-29 20:59:42 +0000328 if (is_power_of_2(mtd->erasesize))
329 mtd->erasesize_shift = ffs(mtd->erasesize) - 1;
330 else
331 mtd->erasesize_shift = 0;
Adrian Hunter69423d92008-12-10 13:37:21 +0000332
Ben Hutchingsb520e412010-01-29 20:59:42 +0000333 if (is_power_of_2(mtd->writesize))
334 mtd->writesize_shift = ffs(mtd->writesize) - 1;
335 else
336 mtd->writesize_shift = 0;
Adrian Hunter69423d92008-12-10 13:37:21 +0000337
Ben Hutchingsb520e412010-01-29 20:59:42 +0000338 mtd->erasesize_mask = (1 << mtd->erasesize_shift) - 1;
339 mtd->writesize_mask = (1 << mtd->writesize_shift) - 1;
Håvard Skinnemoen187ef152006-09-22 10:07:08 +0100340
Ben Hutchingsb520e412010-01-29 20:59:42 +0000341 /* Some chips always power up locked. Unlock them now */
342 if ((mtd->flags & MTD_WRITEABLE)
343 && (mtd->flags & MTD_POWERUP_LOCK) && mtd->unlock) {
Artem Bityutskiyb66005c2011-12-23 19:18:22 +0200344 if (mtd_unlock(mtd, 0, mtd->size))
Ben Hutchingsb520e412010-01-29 20:59:42 +0000345 printk(KERN_WARNING
346 "%s: unlock failed, writes may not work\n",
347 mtd->name);
348 }
David Brownell1f24b5a2009-03-26 00:42:41 -0700349
Ben Hutchingsb520e412010-01-29 20:59:42 +0000350 /* Caller should have set dev.parent to match the
351 * physical device.
352 */
353 mtd->dev.type = &mtd_devtype;
354 mtd->dev.class = &mtd_class;
355 mtd->dev.devt = MTD_DEVT(i);
356 dev_set_name(&mtd->dev, "mtd%d", i);
357 dev_set_drvdata(&mtd->dev, mtd);
358 if (device_register(&mtd->dev) != 0)
359 goto fail_added;
David Brownell1f24b5a2009-03-26 00:42:41 -0700360
Ben Hutchingsb520e412010-01-29 20:59:42 +0000361 if (MTD_DEVT(i))
362 device_create(&mtd_class, mtd->dev.parent,
363 MTD_DEVT(i) + 1,
364 NULL, "mtd%dro", i);
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000365
Brian Norris289c0522011-07-19 10:06:09 -0700366 pr_debug("mtd: Giving out device %d to %s\n", i, mtd->name);
Ben Hutchingsb520e412010-01-29 20:59:42 +0000367 /* No need to get a refcount on the module containing
368 the notifier, since we hold the mtd_table_mutex */
369 list_for_each_entry(not, &mtd_notifiers, list)
370 not->add(mtd);
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000371
Ingo Molnar48b19262006-03-31 02:29:41 -0800372 mutex_unlock(&mtd_table_mutex);
Ben Hutchingsb520e412010-01-29 20:59:42 +0000373 /* We _know_ we aren't being removed, because
374 our caller is still holding us here. So none
375 of this try_ nonsense, and no bitching about it
376 either. :) */
377 __module_get(THIS_MODULE);
378 return 0;
379
380fail_added:
381 idr_remove(&mtd_idr, i);
382fail_locked:
383 mutex_unlock(&mtd_table_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384 return 1;
385}
386
387/**
388 * del_mtd_device - unregister an MTD device
389 * @mtd: pointer to MTD device info structure
390 *
391 * Remove a device from the list of MTD devices present in the system,
392 * and notify each currently active MTD 'user' of its departure.
393 * Returns zero on success or 1 on failure, which currently will happen
394 * if the requested device does not appear to be present in the list.
395 */
396
Jamie Ileseea72d52011-05-23 10:23:42 +0100397int del_mtd_device(struct mtd_info *mtd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398{
399 int ret;
Maxim Levitsky75c0b842010-02-22 20:39:32 +0200400 struct mtd_notifier *not;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000401
Ingo Molnar48b19262006-03-31 02:29:41 -0800402 mutex_lock(&mtd_table_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403
Ben Hutchingsb520e412010-01-29 20:59:42 +0000404 if (idr_find(&mtd_idr, mtd->index) != mtd) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405 ret = -ENODEV;
Maxim Levitsky75c0b842010-02-22 20:39:32 +0200406 goto out_error;
407 }
408
409 /* No need to get a refcount on the module containing
410 the notifier, since we hold the mtd_table_mutex */
411 list_for_each_entry(not, &mtd_notifiers, list)
412 not->remove(mtd);
413
414 if (mtd->usecount) {
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000415 printk(KERN_NOTICE "Removing MTD device #%d (%s) with use count %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416 mtd->index, mtd->name, mtd->usecount);
417 ret = -EBUSY;
418 } else {
Kevin Cernekee694bb7f2009-04-03 13:00:45 -0700419 device_unregister(&mtd->dev);
420
Ben Hutchingsb520e412010-01-29 20:59:42 +0000421 idr_remove(&mtd_idr, mtd->index);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422
423 module_put(THIS_MODULE);
424 ret = 0;
425 }
426
Maxim Levitsky75c0b842010-02-22 20:39:32 +0200427out_error:
Ingo Molnar48b19262006-03-31 02:29:41 -0800428 mutex_unlock(&mtd_table_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429 return ret;
430}
431
432/**
Dmitry Eremin-Solenikov1c4c2152011-03-25 22:26:25 +0300433 * mtd_device_parse_register - parse partitions and register an MTD device.
434 *
435 * @mtd: the MTD device to register
436 * @types: the list of MTD partition probes to try, see
437 * 'parse_mtd_partitions()' for more information
Dmitry Eremin-Solenikovc7975332011-06-10 18:18:28 +0400438 * @parser_data: MTD partition parser-specific data
Dmitry Eremin-Solenikov1c4c2152011-03-25 22:26:25 +0300439 * @parts: fallback partition information to register, if parsing fails;
440 * only valid if %nr_parts > %0
441 * @nr_parts: the number of partitions in parts, if zero then the full
442 * MTD device is registered if no partition info is found
443 *
444 * This function aggregates MTD partitions parsing (done by
445 * 'parse_mtd_partitions()') and MTD device and partitions registering. It
446 * basically follows the most common pattern found in many MTD drivers:
447 *
448 * * It first tries to probe partitions on MTD device @mtd using parsers
449 * specified in @types (if @types is %NULL, then the default list of parsers
450 * is used, see 'parse_mtd_partitions()' for more information). If none are
451 * found this functions tries to fallback to information specified in
452 * @parts/@nr_parts.
Brian Norris92394b5c2011-07-20 09:53:42 -0700453 * * If any partitioning info was found, this function registers the found
Dmitry Eremin-Solenikov1c4c2152011-03-25 22:26:25 +0300454 * partitions.
455 * * If no partitions were found this function just registers the MTD device
456 * @mtd and exits.
457 *
458 * Returns zero in case of success and a negative error code in case of failure.
459 */
460int mtd_device_parse_register(struct mtd_info *mtd, const char **types,
Dmitry Eremin-Solenikovc7975332011-06-10 18:18:28 +0400461 struct mtd_part_parser_data *parser_data,
Dmitry Eremin-Solenikov1c4c2152011-03-25 22:26:25 +0300462 const struct mtd_partition *parts,
463 int nr_parts)
464{
465 int err;
466 struct mtd_partition *real_parts;
467
Dmitry Eremin-Solenikovc7975332011-06-10 18:18:28 +0400468 err = parse_mtd_partitions(mtd, types, &real_parts, parser_data);
Jason Liu4d523b602011-08-24 19:26:28 +0800469 if (err <= 0 && nr_parts && parts) {
Dmitry Eremin-Solenikov1c4c2152011-03-25 22:26:25 +0300470 real_parts = kmemdup(parts, sizeof(*parts) * nr_parts,
471 GFP_KERNEL);
Jason Liu4d523b602011-08-24 19:26:28 +0800472 if (!real_parts)
Dmitry Eremin-Solenikov1c4c2152011-03-25 22:26:25 +0300473 err = -ENOMEM;
Jason Liu4d523b602011-08-24 19:26:28 +0800474 else
475 err = nr_parts;
Dmitry Eremin-Solenikov1c4c2152011-03-25 22:26:25 +0300476 }
477
478 if (err > 0) {
479 err = add_mtd_partitions(mtd, real_parts, err);
480 kfree(real_parts);
481 } else if (err == 0) {
482 err = add_mtd_device(mtd);
483 if (err == 1)
484 err = -ENODEV;
485 }
486
487 return err;
488}
489EXPORT_SYMBOL_GPL(mtd_device_parse_register);
490
491/**
Jamie Ilesf5671ab2011-05-23 17:15:46 +0100492 * mtd_device_unregister - unregister an existing MTD device.
493 *
494 * @master: the MTD device to unregister. This will unregister both the master
495 * and any partitions if registered.
496 */
497int mtd_device_unregister(struct mtd_info *master)
498{
499 int err;
500
501 err = del_mtd_partitions(master);
502 if (err)
503 return err;
504
505 if (!device_is_registered(&master->dev))
506 return 0;
507
508 return del_mtd_device(master);
509}
510EXPORT_SYMBOL_GPL(mtd_device_unregister);
511
512/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513 * register_mtd_user - register a 'user' of MTD devices.
514 * @new: pointer to notifier info structure
515 *
516 * Registers a pair of callbacks function to be called upon addition
517 * or removal of MTD devices. Causes the 'add' callback to be immediately
518 * invoked for each MTD device currently present in the system.
519 */
520
521void register_mtd_user (struct mtd_notifier *new)
522{
Ben Hutchingsf1332ba2010-01-29 20:57:11 +0000523 struct mtd_info *mtd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524
Ingo Molnar48b19262006-03-31 02:29:41 -0800525 mutex_lock(&mtd_table_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526
527 list_add(&new->list, &mtd_notifiers);
528
Wanlong Gaod5ca5122011-05-20 21:14:30 +0800529 __module_get(THIS_MODULE);
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000530
Ben Hutchingsf1332ba2010-01-29 20:57:11 +0000531 mtd_for_each_device(mtd)
532 new->add(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533
Ingo Molnar48b19262006-03-31 02:29:41 -0800534 mutex_unlock(&mtd_table_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535}
536
537/**
Artem B. Bityuckiy49450792005-02-18 14:34:54 +0000538 * unregister_mtd_user - unregister a 'user' of MTD devices.
539 * @old: pointer to notifier info structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540 *
541 * Removes a callback function pair from the list of 'users' to be
542 * notified upon addition or removal of MTD devices. Causes the
543 * 'remove' callback to be immediately invoked for each MTD device
544 * currently present in the system.
545 */
546
547int unregister_mtd_user (struct mtd_notifier *old)
548{
Ben Hutchingsf1332ba2010-01-29 20:57:11 +0000549 struct mtd_info *mtd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550
Ingo Molnar48b19262006-03-31 02:29:41 -0800551 mutex_lock(&mtd_table_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552
553 module_put(THIS_MODULE);
554
Ben Hutchingsf1332ba2010-01-29 20:57:11 +0000555 mtd_for_each_device(mtd)
556 old->remove(mtd);
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000557
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558 list_del(&old->list);
Ingo Molnar48b19262006-03-31 02:29:41 -0800559 mutex_unlock(&mtd_table_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560 return 0;
561}
562
563
564/**
565 * get_mtd_device - obtain a validated handle for an MTD device
566 * @mtd: last known address of the required MTD device
567 * @num: internal device number of the required MTD device
568 *
569 * Given a number and NULL address, return the num'th entry in the device
570 * table, if any. Given an address and num == -1, search the device table
571 * for a device with that address and return if it's still present. Given
Artem Bityutskiy9c740342006-10-11 14:52:47 +0300572 * both, return the num'th driver only if its address matches. Return
573 * error code if not.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 */
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000575
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num)
577{
Ben Hutchingsf1332ba2010-01-29 20:57:11 +0000578 struct mtd_info *ret = NULL, *other;
579 int err = -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580
Ingo Molnar48b19262006-03-31 02:29:41 -0800581 mutex_lock(&mtd_table_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582
583 if (num == -1) {
Ben Hutchingsf1332ba2010-01-29 20:57:11 +0000584 mtd_for_each_device(other) {
585 if (other == mtd) {
586 ret = mtd;
587 break;
588 }
589 }
Ben Hutchingsb520e412010-01-29 20:59:42 +0000590 } else if (num >= 0) {
591 ret = idr_find(&mtd_idr, num);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592 if (mtd && mtd != ret)
593 ret = NULL;
594 }
595
Maxim Levitsky3bd45652010-02-22 20:39:28 +0200596 if (!ret) {
597 ret = ERR_PTR(err);
598 goto out;
Artem Bityutskiy9fe912c2006-10-11 14:52:45 +0300599 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600
Maxim Levitsky3bd45652010-02-22 20:39:28 +0200601 err = __get_mtd_device(ret);
602 if (err)
603 ret = ERR_PTR(err);
604out:
Ingo Molnar48b19262006-03-31 02:29:41 -0800605 mutex_unlock(&mtd_table_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 return ret;
Maxim Levitsky3bd45652010-02-22 20:39:28 +0200607}
Artem Bityutskiy9c740342006-10-11 14:52:47 +0300608
Maxim Levitsky3bd45652010-02-22 20:39:28 +0200609
610int __get_mtd_device(struct mtd_info *mtd)
611{
612 int err;
613
614 if (!try_module_get(mtd->owner))
615 return -ENODEV;
616
617 if (mtd->get_device) {
Maxim Levitsky3bd45652010-02-22 20:39:28 +0200618 err = mtd->get_device(mtd);
619
620 if (err) {
621 module_put(mtd->owner);
622 return err;
623 }
624 }
625 mtd->usecount++;
626 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627}
628
Artem Bityutskiy77993082006-10-11 14:52:44 +0300629/**
630 * get_mtd_device_nm - obtain a validated handle for an MTD device by
631 * device name
632 * @name: MTD device name to open
633 *
634 * This function returns MTD device description structure in case of
635 * success and an error code in case of failure.
636 */
637
638struct mtd_info *get_mtd_device_nm(const char *name)
639{
Ben Hutchingsf1332ba2010-01-29 20:57:11 +0000640 int err = -ENODEV;
641 struct mtd_info *mtd = NULL, *other;
Artem Bityutskiy77993082006-10-11 14:52:44 +0300642
643 mutex_lock(&mtd_table_mutex);
644
Ben Hutchingsf1332ba2010-01-29 20:57:11 +0000645 mtd_for_each_device(other) {
646 if (!strcmp(name, other->name)) {
647 mtd = other;
Artem Bityutskiy77993082006-10-11 14:52:44 +0300648 break;
649 }
650 }
651
Artem Bityutskiy9fe912c2006-10-11 14:52:45 +0300652 if (!mtd)
Artem Bityutskiy77993082006-10-11 14:52:44 +0300653 goto out_unlock;
654
Wanlong Gao52534f22011-05-17 22:36:18 +0800655 err = __get_mtd_device(mtd);
656 if (err)
Artem Bityutskiy77993082006-10-11 14:52:44 +0300657 goto out_unlock;
658
Artem Bityutskiy77993082006-10-11 14:52:44 +0300659 mutex_unlock(&mtd_table_mutex);
660 return mtd;
Artem Bityutskiy9fe912c2006-10-11 14:52:45 +0300661
Artem Bityutskiy9fe912c2006-10-11 14:52:45 +0300662out_unlock:
663 mutex_unlock(&mtd_table_mutex);
664 return ERR_PTR(err);
Artem Bityutskiy77993082006-10-11 14:52:44 +0300665}
666
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667void put_mtd_device(struct mtd_info *mtd)
668{
Ingo Molnar48b19262006-03-31 02:29:41 -0800669 mutex_lock(&mtd_table_mutex);
Maxim Levitsky3bd45652010-02-22 20:39:28 +0200670 __put_mtd_device(mtd);
671 mutex_unlock(&mtd_table_mutex);
672
673}
674
675void __put_mtd_device(struct mtd_info *mtd)
676{
677 --mtd->usecount;
678 BUG_ON(mtd->usecount < 0);
679
Artem Bityutskiy9fe912c2006-10-11 14:52:45 +0300680 if (mtd->put_device)
681 mtd->put_device(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682
683 module_put(mtd->owner);
684}
685
Artem Bityutskiy52b02032011-12-30 15:57:25 +0200686/*
687 * default_mtd_writev - the default writev method
688 * @mtd: mtd device description object pointer
689 * @vecs: the vectors to write
690 * @count: count of vectors in @vecs
691 * @to: the MTD device offset to write to
692 * @retlen: on exit contains the count of bytes written to the MTD device.
693 *
694 * This function returns zero in case of success and a negative error code in
695 * case of failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697int default_mtd_writev(struct mtd_info *mtd, const struct kvec *vecs,
698 unsigned long count, loff_t to, size_t *retlen)
699{
700 unsigned long i;
701 size_t totlen = 0, thislen;
702 int ret = 0;
703
Artem Bityutskiy52b02032011-12-30 15:57:25 +0200704 for (i = 0; i < count; i++) {
705 if (!vecs[i].iov_len)
706 continue;
707 ret = mtd_write(mtd, to, vecs[i].iov_len, &thislen,
708 vecs[i].iov_base);
709 totlen += thislen;
710 if (ret || thislen != vecs[i].iov_len)
711 break;
712 to += vecs[i].iov_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713 }
Artem Bityutskiy52b02032011-12-30 15:57:25 +0200714 *retlen = totlen;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715 return ret;
716}
717
Grant Erickson33b53712011-04-08 08:51:32 -0700718/**
719 * mtd_kmalloc_up_to - allocate a contiguous buffer up to the specified size
Artem Bityutskiy52b02032011-12-30 15:57:25 +0200720 * @mtd: mtd device description object pointer
721 * @size: a pointer to the ideal or maximum size of the allocation, points
Grant Erickson33b53712011-04-08 08:51:32 -0700722 * to the actual allocation size on success.
723 *
724 * This routine attempts to allocate a contiguous kernel buffer up to
725 * the specified size, backing off the size of the request exponentially
726 * until the request succeeds or until the allocation size falls below
727 * the system page size. This attempts to make sure it does not adversely
728 * impact system performance, so when allocating more than one page, we
729 * ask the memory allocator to avoid re-trying, swapping, writing back
730 * or performing I/O.
731 *
732 * Note, this function also makes sure that the allocated buffer is aligned to
733 * the MTD device's min. I/O unit, i.e. the "mtd->writesize" value.
734 *
735 * This is called, for example by mtd_{read,write} and jffs2_scan_medium,
736 * to handle smaller (i.e. degraded) buffer allocations under low- or
737 * fragmented-memory situations where such reduced allocations, from a
738 * requested ideal, are allowed.
739 *
740 * Returns a pointer to the allocated buffer on success; otherwise, NULL.
741 */
742void *mtd_kmalloc_up_to(const struct mtd_info *mtd, size_t *size)
743{
744 gfp_t flags = __GFP_NOWARN | __GFP_WAIT |
745 __GFP_NORETRY | __GFP_NO_KSWAPD;
746 size_t min_alloc = max_t(size_t, mtd->writesize, PAGE_SIZE);
747 void *kbuf;
748
749 *size = min_t(size_t, *size, KMALLOC_MAX_SIZE);
750
751 while (*size > min_alloc) {
752 kbuf = kmalloc(*size, flags);
753 if (kbuf)
754 return kbuf;
755
756 *size >>= 1;
757 *size = ALIGN(*size, mtd->writesize);
758 }
759
760 /*
761 * For the last resort allocation allow 'kmalloc()' to do all sorts of
762 * things (write-back, dropping caches, etc) by using GFP_KERNEL.
763 */
764 return kmalloc(*size, GFP_KERNEL);
765}
766
David Woodhousedd36f262006-11-29 16:33:03 +0000767EXPORT_SYMBOL_GPL(get_mtd_device);
768EXPORT_SYMBOL_GPL(get_mtd_device_nm);
Maxim Levitsky3bd45652010-02-22 20:39:28 +0200769EXPORT_SYMBOL_GPL(__get_mtd_device);
David Woodhousedd36f262006-11-29 16:33:03 +0000770EXPORT_SYMBOL_GPL(put_mtd_device);
Maxim Levitsky3bd45652010-02-22 20:39:28 +0200771EXPORT_SYMBOL_GPL(__put_mtd_device);
David Woodhousedd36f262006-11-29 16:33:03 +0000772EXPORT_SYMBOL_GPL(register_mtd_user);
773EXPORT_SYMBOL_GPL(unregister_mtd_user);
774EXPORT_SYMBOL_GPL(default_mtd_writev);
Grant Erickson33b53712011-04-08 08:51:32 -0700775EXPORT_SYMBOL_GPL(mtd_kmalloc_up_to);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776
Pavel Machek2d2dce02006-03-31 02:29:49 -0800777#ifdef CONFIG_PROC_FS
778
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779/*====================================================================*/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780/* Support for /proc/mtd */
781
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782static struct proc_dir_entry *proc_mtd;
783
Alexey Dobriyan447d9bd2011-05-13 23:34:19 +0300784static int mtd_proc_show(struct seq_file *m, void *v)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785{
Ben Hutchingsf1332ba2010-01-29 20:57:11 +0000786 struct mtd_info *mtd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787
Alexey Dobriyan447d9bd2011-05-13 23:34:19 +0300788 seq_puts(m, "dev: size erasesize name\n");
Ingo Molnar48b19262006-03-31 02:29:41 -0800789 mutex_lock(&mtd_table_mutex);
Ben Hutchingsf1332ba2010-01-29 20:57:11 +0000790 mtd_for_each_device(mtd) {
Alexey Dobriyan447d9bd2011-05-13 23:34:19 +0300791 seq_printf(m, "mtd%d: %8.8llx %8.8x \"%s\"\n",
792 mtd->index, (unsigned long long)mtd->size,
793 mtd->erasesize, mtd->name);
Wanlong Gaod5ca5122011-05-20 21:14:30 +0800794 }
Ingo Molnar48b19262006-03-31 02:29:41 -0800795 mutex_unlock(&mtd_table_mutex);
Wanlong Gaod5ca5122011-05-20 21:14:30 +0800796 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797}
798
Alexey Dobriyan447d9bd2011-05-13 23:34:19 +0300799static int mtd_proc_open(struct inode *inode, struct file *file)
800{
801 return single_open(file, mtd_proc_show, NULL);
802}
803
804static const struct file_operations mtd_proc_ops = {
805 .open = mtd_proc_open,
806 .read = seq_read,
807 .llseek = seq_lseek,
808 .release = single_release,
809};
Kevin Cernekee45b09072009-04-04 11:03:04 -0700810#endif /* CONFIG_PROC_FS */
811
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812/*====================================================================*/
813/* Init code */
814
Jens Axboe0661b1a2010-04-27 09:49:47 +0200815static int __init mtd_bdi_init(struct backing_dev_info *bdi, const char *name)
816{
817 int ret;
818
819 ret = bdi_init(bdi);
820 if (!ret)
821 ret = bdi_register(bdi, NULL, name);
822
823 if (ret)
824 bdi_destroy(bdi);
825
826 return ret;
827}
828
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829static int __init init_mtd(void)
830{
David Woodhouse15bce402009-04-05 07:40:58 -0700831 int ret;
Kevin Cernekee694bb7f2009-04-03 13:00:45 -0700832
Jens Axboe0661b1a2010-04-27 09:49:47 +0200833 ret = class_register(&mtd_class);
834 if (ret)
835 goto err_reg;
836
837 ret = mtd_bdi_init(&mtd_bdi_unmappable, "mtd-unmap");
838 if (ret)
839 goto err_bdi1;
840
841 ret = mtd_bdi_init(&mtd_bdi_ro_mappable, "mtd-romap");
842 if (ret)
843 goto err_bdi2;
844
845 ret = mtd_bdi_init(&mtd_bdi_rw_mappable, "mtd-rwmap");
846 if (ret)
847 goto err_bdi3;
848
Kevin Cernekee45b09072009-04-04 11:03:04 -0700849#ifdef CONFIG_PROC_FS
Alexey Dobriyan447d9bd2011-05-13 23:34:19 +0300850 proc_mtd = proc_create("mtd", 0, NULL, &mtd_proc_ops);
Kevin Cernekee45b09072009-04-04 11:03:04 -0700851#endif /* CONFIG_PROC_FS */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852 return 0;
Jens Axboe0661b1a2010-04-27 09:49:47 +0200853
854err_bdi3:
855 bdi_destroy(&mtd_bdi_ro_mappable);
856err_bdi2:
857 bdi_destroy(&mtd_bdi_unmappable);
858err_bdi1:
859 class_unregister(&mtd_class);
860err_reg:
861 pr_err("Error registering mtd class or bdi: %d\n", ret);
862 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863}
864
865static void __exit cleanup_mtd(void)
866{
Kevin Cernekee45b09072009-04-04 11:03:04 -0700867#ifdef CONFIG_PROC_FS
Wanlong Gaod5ca5122011-05-20 21:14:30 +0800868 if (proc_mtd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869 remove_proc_entry( "mtd", NULL);
Kevin Cernekee45b09072009-04-04 11:03:04 -0700870#endif /* CONFIG_PROC_FS */
David Woodhouse15bce402009-04-05 07:40:58 -0700871 class_unregister(&mtd_class);
Jens Axboe0661b1a2010-04-27 09:49:47 +0200872 bdi_destroy(&mtd_bdi_unmappable);
873 bdi_destroy(&mtd_bdi_ro_mappable);
874 bdi_destroy(&mtd_bdi_rw_mappable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700875}
876
877module_init(init_mtd);
878module_exit(cleanup_mtd);
879
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880MODULE_LICENSE("GPL");
881MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org>");
882MODULE_DESCRIPTION("Core MTD registration and access routines");