blob: c510aff289a88d077d9e42c6854bfdcd1533e3be [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{
Denis V. Lunev2fdb1142009-04-12 08:14:46 +0100110 dev_t index = MTD_DEVT(dev_to_mtd(dev)->index);
David Brownell1f24b5a2009-03-26 00:42:41 -0700111
112 /* remove /dev/mtdXro node if needed */
Denis V. Lunev2fdb1142009-04-12 08:14:46 +0100113 if (index)
David Woodhouse15bce402009-04-05 07:40:58 -0700114 device_destroy(&mtd_class, index + 1);
115}
116
117static int mtd_cls_suspend(struct device *dev, pm_message_t state)
118{
119 struct mtd_info *mtd = dev_to_mtd(dev);
Saeed Bishara6afc4fd2009-07-28 04:56:43 -0700120
121 if (mtd && mtd->suspend)
David Woodhouse15bce402009-04-05 07:40:58 -0700122 return mtd->suspend(mtd);
123 else
124 return 0;
125}
126
127static int mtd_cls_resume(struct device *dev)
128{
129 struct mtd_info *mtd = dev_to_mtd(dev);
130
Saeed Bishara6afc4fd2009-07-28 04:56:43 -0700131 if (mtd && mtd->resume)
David Woodhouse15bce402009-04-05 07:40:58 -0700132 mtd->resume(mtd);
133 return 0;
David Brownell1f24b5a2009-03-26 00:42:41 -0700134}
135
136static ssize_t mtd_type_show(struct device *dev,
137 struct device_attribute *attr, char *buf)
138{
139 struct mtd_info *mtd = dev_to_mtd(dev);
140 char *type;
141
142 switch (mtd->type) {
143 case MTD_ABSENT:
144 type = "absent";
145 break;
146 case MTD_RAM:
147 type = "ram";
148 break;
149 case MTD_ROM:
150 type = "rom";
151 break;
152 case MTD_NORFLASH:
153 type = "nor";
154 break;
155 case MTD_NANDFLASH:
156 type = "nand";
157 break;
158 case MTD_DATAFLASH:
159 type = "dataflash";
160 break;
161 case MTD_UBIVOLUME:
162 type = "ubi";
163 break;
164 default:
165 type = "unknown";
166 }
167
168 return snprintf(buf, PAGE_SIZE, "%s\n", type);
169}
Kevin Cernekee694bb7f2009-04-03 13:00:45 -0700170static DEVICE_ATTR(type, S_IRUGO, mtd_type_show, NULL);
171
172static ssize_t mtd_flags_show(struct device *dev,
173 struct device_attribute *attr, char *buf)
174{
175 struct mtd_info *mtd = dev_to_mtd(dev);
176
177 return snprintf(buf, PAGE_SIZE, "0x%lx\n", (unsigned long)mtd->flags);
178
179}
180static DEVICE_ATTR(flags, S_IRUGO, mtd_flags_show, NULL);
181
182static ssize_t mtd_size_show(struct device *dev,
183 struct device_attribute *attr, char *buf)
184{
185 struct mtd_info *mtd = dev_to_mtd(dev);
186
187 return snprintf(buf, PAGE_SIZE, "%llu\n",
188 (unsigned long long)mtd->size);
189
190}
191static DEVICE_ATTR(size, S_IRUGO, mtd_size_show, NULL);
192
193static ssize_t mtd_erasesize_show(struct device *dev,
194 struct device_attribute *attr, char *buf)
195{
196 struct mtd_info *mtd = dev_to_mtd(dev);
197
198 return snprintf(buf, PAGE_SIZE, "%lu\n", (unsigned long)mtd->erasesize);
199
200}
201static DEVICE_ATTR(erasesize, S_IRUGO, mtd_erasesize_show, NULL);
202
203static ssize_t mtd_writesize_show(struct device *dev,
204 struct device_attribute *attr, char *buf)
205{
206 struct mtd_info *mtd = dev_to_mtd(dev);
207
208 return snprintf(buf, PAGE_SIZE, "%lu\n", (unsigned long)mtd->writesize);
209
210}
211static DEVICE_ATTR(writesize, S_IRUGO, mtd_writesize_show, NULL);
212
Artem Bityutskiye7693542009-04-18 12:29:42 +0300213static ssize_t mtd_subpagesize_show(struct device *dev,
214 struct device_attribute *attr, char *buf)
215{
216 struct mtd_info *mtd = dev_to_mtd(dev);
217 unsigned int subpagesize = mtd->writesize >> mtd->subpage_sft;
218
219 return snprintf(buf, PAGE_SIZE, "%u\n", subpagesize);
220
221}
222static DEVICE_ATTR(subpagesize, S_IRUGO, mtd_subpagesize_show, NULL);
223
Kevin Cernekee694bb7f2009-04-03 13:00:45 -0700224static ssize_t mtd_oobsize_show(struct device *dev,
225 struct device_attribute *attr, char *buf)
226{
227 struct mtd_info *mtd = dev_to_mtd(dev);
228
229 return snprintf(buf, PAGE_SIZE, "%lu\n", (unsigned long)mtd->oobsize);
230
231}
232static DEVICE_ATTR(oobsize, S_IRUGO, mtd_oobsize_show, NULL);
233
234static ssize_t mtd_numeraseregions_show(struct device *dev,
235 struct device_attribute *attr, char *buf)
236{
237 struct mtd_info *mtd = dev_to_mtd(dev);
238
239 return snprintf(buf, PAGE_SIZE, "%u\n", mtd->numeraseregions);
240
241}
242static DEVICE_ATTR(numeraseregions, S_IRUGO, mtd_numeraseregions_show,
243 NULL);
244
245static ssize_t mtd_name_show(struct device *dev,
246 struct device_attribute *attr, char *buf)
247{
248 struct mtd_info *mtd = dev_to_mtd(dev);
249
250 return snprintf(buf, PAGE_SIZE, "%s\n", mtd->name);
251
252}
253static DEVICE_ATTR(name, S_IRUGO, mtd_name_show, NULL);
David Brownell1f24b5a2009-03-26 00:42:41 -0700254
255static struct attribute *mtd_attrs[] = {
Kevin Cernekee694bb7f2009-04-03 13:00:45 -0700256 &dev_attr_type.attr,
257 &dev_attr_flags.attr,
258 &dev_attr_size.attr,
259 &dev_attr_erasesize.attr,
260 &dev_attr_writesize.attr,
Artem Bityutskiye7693542009-04-18 12:29:42 +0300261 &dev_attr_subpagesize.attr,
Kevin Cernekee694bb7f2009-04-03 13:00:45 -0700262 &dev_attr_oobsize.attr,
263 &dev_attr_numeraseregions.attr,
264 &dev_attr_name.attr,
David Brownell1f24b5a2009-03-26 00:42:41 -0700265 NULL,
266};
267
H Hartley Sweetenfca91082009-08-06 16:05:32 -0700268static struct attribute_group mtd_group = {
David Brownell1f24b5a2009-03-26 00:42:41 -0700269 .attrs = mtd_attrs,
270};
271
David Woodhouse6469f542009-09-20 05:55:36 -0700272static const struct attribute_group *mtd_groups[] = {
David Brownell1f24b5a2009-03-26 00:42:41 -0700273 &mtd_group,
274 NULL,
275};
276
277static struct device_type mtd_devtype = {
278 .name = "mtd",
279 .groups = mtd_groups,
280 .release = mtd_release,
281};
282
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283/**
284 * add_mtd_device - register an MTD device
285 * @mtd: pointer to new MTD device info structure
286 *
287 * Add a device to the list of MTD devices present in the system, and
288 * notify each currently active MTD 'user' of its arrival. Returns
289 * zero on success or 1 on failure, which currently will only happen
Ben Hutchingsb520e412010-01-29 20:59:42 +0000290 * if there is insufficient memory or a sysfs error.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291 */
292
293int add_mtd_device(struct mtd_info *mtd)
294{
Ben Hutchingsb520e412010-01-29 20:59:42 +0000295 struct mtd_notifier *not;
296 int i, error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297
David Howells402d3262009-02-12 10:40:00 +0000298 if (!mtd->backing_dev_info) {
299 switch (mtd->type) {
300 case MTD_RAM:
301 mtd->backing_dev_info = &mtd_bdi_rw_mappable;
302 break;
303 case MTD_ROM:
304 mtd->backing_dev_info = &mtd_bdi_ro_mappable;
305 break;
306 default:
307 mtd->backing_dev_info = &mtd_bdi_unmappable;
308 break;
309 }
310 }
311
Artem B. Bityutskiy783ed812006-06-14 19:53:44 +0400312 BUG_ON(mtd->writesize == 0);
Ingo Molnar48b19262006-03-31 02:29:41 -0800313 mutex_lock(&mtd_table_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314
Ben Hutchingsb520e412010-01-29 20:59:42 +0000315 do {
316 if (!idr_pre_get(&mtd_idr, GFP_KERNEL))
317 goto fail_locked;
318 error = idr_get_new(&mtd_idr, mtd, &i);
319 } while (error == -EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320
Ben Hutchingsb520e412010-01-29 20:59:42 +0000321 if (error)
322 goto fail_locked;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323
Ben Hutchingsb520e412010-01-29 20:59:42 +0000324 mtd->index = i;
325 mtd->usecount = 0;
Adrian Hunter69423d92008-12-10 13:37:21 +0000326
Ben Hutchingsb520e412010-01-29 20:59:42 +0000327 if (is_power_of_2(mtd->erasesize))
328 mtd->erasesize_shift = ffs(mtd->erasesize) - 1;
329 else
330 mtd->erasesize_shift = 0;
Adrian Hunter69423d92008-12-10 13:37:21 +0000331
Ben Hutchingsb520e412010-01-29 20:59:42 +0000332 if (is_power_of_2(mtd->writesize))
333 mtd->writesize_shift = ffs(mtd->writesize) - 1;
334 else
335 mtd->writesize_shift = 0;
Adrian Hunter69423d92008-12-10 13:37:21 +0000336
Ben Hutchingsb520e412010-01-29 20:59:42 +0000337 mtd->erasesize_mask = (1 << mtd->erasesize_shift) - 1;
338 mtd->writesize_mask = (1 << mtd->writesize_shift) - 1;
Håvard Skinnemoen187ef152006-09-22 10:07:08 +0100339
Ben Hutchingsb520e412010-01-29 20:59:42 +0000340 /* Some chips always power up locked. Unlock them now */
341 if ((mtd->flags & MTD_WRITEABLE)
342 && (mtd->flags & MTD_POWERUP_LOCK) && mtd->unlock) {
343 if (mtd->unlock(mtd, 0, mtd->size))
344 printk(KERN_WARNING
345 "%s: unlock failed, writes may not work\n",
346 mtd->name);
347 }
David Brownell1f24b5a2009-03-26 00:42:41 -0700348
Ben Hutchingsb520e412010-01-29 20:59:42 +0000349 /* Caller should have set dev.parent to match the
350 * physical device.
351 */
352 mtd->dev.type = &mtd_devtype;
353 mtd->dev.class = &mtd_class;
354 mtd->dev.devt = MTD_DEVT(i);
355 dev_set_name(&mtd->dev, "mtd%d", i);
356 dev_set_drvdata(&mtd->dev, mtd);
357 if (device_register(&mtd->dev) != 0)
358 goto fail_added;
David Brownell1f24b5a2009-03-26 00:42:41 -0700359
Ben Hutchingsb520e412010-01-29 20:59:42 +0000360 if (MTD_DEVT(i))
361 device_create(&mtd_class, mtd->dev.parent,
362 MTD_DEVT(i) + 1,
363 NULL, "mtd%dro", i);
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000364
Ben Hutchingsb520e412010-01-29 20:59:42 +0000365 DEBUG(0, "mtd: Giving out device %d to %s\n", i, mtd->name);
366 /* No need to get a refcount on the module containing
367 the notifier, since we hold the mtd_table_mutex */
368 list_for_each_entry(not, &mtd_notifiers, list)
369 not->add(mtd);
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000370
Ingo Molnar48b19262006-03-31 02:29:41 -0800371 mutex_unlock(&mtd_table_mutex);
Ben Hutchingsb520e412010-01-29 20:59:42 +0000372 /* We _know_ we aren't being removed, because
373 our caller is still holding us here. So none
374 of this try_ nonsense, and no bitching about it
375 either. :) */
376 __module_get(THIS_MODULE);
377 return 0;
378
379fail_added:
380 idr_remove(&mtd_idr, i);
381fail_locked:
382 mutex_unlock(&mtd_table_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383 return 1;
384}
385
386/**
387 * del_mtd_device - unregister an MTD device
388 * @mtd: pointer to MTD device info structure
389 *
390 * Remove a device from the list of MTD devices present in the system,
391 * and notify each currently active MTD 'user' of its departure.
392 * Returns zero on success or 1 on failure, which currently will happen
393 * if the requested device does not appear to be present in the list.
394 */
395
Jamie Ileseea72d52011-05-23 10:23:42 +0100396int del_mtd_device(struct mtd_info *mtd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397{
398 int ret;
Maxim Levitsky75c0b842010-02-22 20:39:32 +0200399 struct mtd_notifier *not;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000400
Ingo Molnar48b19262006-03-31 02:29:41 -0800401 mutex_lock(&mtd_table_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402
Ben Hutchingsb520e412010-01-29 20:59:42 +0000403 if (idr_find(&mtd_idr, mtd->index) != mtd) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404 ret = -ENODEV;
Maxim Levitsky75c0b842010-02-22 20:39:32 +0200405 goto out_error;
406 }
407
408 /* No need to get a refcount on the module containing
409 the notifier, since we hold the mtd_table_mutex */
410 list_for_each_entry(not, &mtd_notifiers, list)
411 not->remove(mtd);
412
413 if (mtd->usecount) {
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000414 printk(KERN_NOTICE "Removing MTD device #%d (%s) with use count %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415 mtd->index, mtd->name, mtd->usecount);
416 ret = -EBUSY;
417 } else {
Kevin Cernekee694bb7f2009-04-03 13:00:45 -0700418 device_unregister(&mtd->dev);
419
Ben Hutchingsb520e412010-01-29 20:59:42 +0000420 idr_remove(&mtd_idr, mtd->index);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421
422 module_put(THIS_MODULE);
423 ret = 0;
424 }
425
Maxim Levitsky75c0b842010-02-22 20:39:32 +0200426out_error:
Ingo Molnar48b19262006-03-31 02:29:41 -0800427 mutex_unlock(&mtd_table_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428 return ret;
429}
430
431/**
Jamie Ilesf5671ab2011-05-23 17:15:46 +0100432 * mtd_device_register - register an MTD device.
433 *
434 * @master: the MTD device to register
435 * @parts: the partitions to register - only valid if nr_parts > 0
436 * @nr_parts: the number of partitions in parts. If zero then the full MTD
437 * device is registered
438 *
439 * Register an MTD device with the system and optionally, a number of
440 * partitions. If nr_parts is 0 then the whole device is registered, otherwise
441 * only the partitions are registered. To register both the full device *and*
442 * the partitions, call mtd_device_register() twice, once with nr_parts == 0
443 * and once equal to the number of partitions.
444 */
445int mtd_device_register(struct mtd_info *master,
446 const struct mtd_partition *parts,
447 int nr_parts)
448{
449 return parts ? add_mtd_partitions(master, parts, nr_parts) :
450 add_mtd_device(master);
451}
452EXPORT_SYMBOL_GPL(mtd_device_register);
453
454/**
455 * mtd_device_unregister - unregister an existing MTD device.
456 *
457 * @master: the MTD device to unregister. This will unregister both the master
458 * and any partitions if registered.
459 */
460int mtd_device_unregister(struct mtd_info *master)
461{
462 int err;
463
464 err = del_mtd_partitions(master);
465 if (err)
466 return err;
467
468 if (!device_is_registered(&master->dev))
469 return 0;
470
471 return del_mtd_device(master);
472}
473EXPORT_SYMBOL_GPL(mtd_device_unregister);
474
475/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476 * register_mtd_user - register a 'user' of MTD devices.
477 * @new: pointer to notifier info structure
478 *
479 * Registers a pair of callbacks function to be called upon addition
480 * or removal of MTD devices. Causes the 'add' callback to be immediately
481 * invoked for each MTD device currently present in the system.
482 */
483
484void register_mtd_user (struct mtd_notifier *new)
485{
Ben Hutchingsf1332ba2010-01-29 20:57:11 +0000486 struct mtd_info *mtd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487
Ingo Molnar48b19262006-03-31 02:29:41 -0800488 mutex_lock(&mtd_table_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489
490 list_add(&new->list, &mtd_notifiers);
491
Wanlong Gaod5ca5122011-05-20 21:14:30 +0800492 __module_get(THIS_MODULE);
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000493
Ben Hutchingsf1332ba2010-01-29 20:57:11 +0000494 mtd_for_each_device(mtd)
495 new->add(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496
Ingo Molnar48b19262006-03-31 02:29:41 -0800497 mutex_unlock(&mtd_table_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498}
499
500/**
Artem B. Bityuckiy49450792005-02-18 14:34:54 +0000501 * unregister_mtd_user - unregister a 'user' of MTD devices.
502 * @old: pointer to notifier info structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 *
504 * Removes a callback function pair from the list of 'users' to be
505 * notified upon addition or removal of MTD devices. Causes the
506 * 'remove' callback to be immediately invoked for each MTD device
507 * currently present in the system.
508 */
509
510int unregister_mtd_user (struct mtd_notifier *old)
511{
Ben Hutchingsf1332ba2010-01-29 20:57:11 +0000512 struct mtd_info *mtd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513
Ingo Molnar48b19262006-03-31 02:29:41 -0800514 mutex_lock(&mtd_table_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515
516 module_put(THIS_MODULE);
517
Ben Hutchingsf1332ba2010-01-29 20:57:11 +0000518 mtd_for_each_device(mtd)
519 old->remove(mtd);
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000520
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 list_del(&old->list);
Ingo Molnar48b19262006-03-31 02:29:41 -0800522 mutex_unlock(&mtd_table_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523 return 0;
524}
525
526
527/**
528 * get_mtd_device - obtain a validated handle for an MTD device
529 * @mtd: last known address of the required MTD device
530 * @num: internal device number of the required MTD device
531 *
532 * Given a number and NULL address, return the num'th entry in the device
533 * table, if any. Given an address and num == -1, search the device table
534 * for a device with that address and return if it's still present. Given
Artem Bityutskiy9c740342006-10-11 14:52:47 +0300535 * both, return the num'th driver only if its address matches. Return
536 * error code if not.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 */
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000538
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num)
540{
Ben Hutchingsf1332ba2010-01-29 20:57:11 +0000541 struct mtd_info *ret = NULL, *other;
542 int err = -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543
Ingo Molnar48b19262006-03-31 02:29:41 -0800544 mutex_lock(&mtd_table_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545
546 if (num == -1) {
Ben Hutchingsf1332ba2010-01-29 20:57:11 +0000547 mtd_for_each_device(other) {
548 if (other == mtd) {
549 ret = mtd;
550 break;
551 }
552 }
Ben Hutchingsb520e412010-01-29 20:59:42 +0000553 } else if (num >= 0) {
554 ret = idr_find(&mtd_idr, num);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555 if (mtd && mtd != ret)
556 ret = NULL;
557 }
558
Maxim Levitsky3bd45652010-02-22 20:39:28 +0200559 if (!ret) {
560 ret = ERR_PTR(err);
561 goto out;
Artem Bityutskiy9fe912c2006-10-11 14:52:45 +0300562 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563
Maxim Levitsky3bd45652010-02-22 20:39:28 +0200564 err = __get_mtd_device(ret);
565 if (err)
566 ret = ERR_PTR(err);
567out:
Ingo Molnar48b19262006-03-31 02:29:41 -0800568 mutex_unlock(&mtd_table_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569 return ret;
Maxim Levitsky3bd45652010-02-22 20:39:28 +0200570}
Artem Bityutskiy9c740342006-10-11 14:52:47 +0300571
Maxim Levitsky3bd45652010-02-22 20:39:28 +0200572
573int __get_mtd_device(struct mtd_info *mtd)
574{
575 int err;
576
577 if (!try_module_get(mtd->owner))
578 return -ENODEV;
579
580 if (mtd->get_device) {
Maxim Levitsky3bd45652010-02-22 20:39:28 +0200581 err = mtd->get_device(mtd);
582
583 if (err) {
584 module_put(mtd->owner);
585 return err;
586 }
587 }
588 mtd->usecount++;
589 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590}
591
Artem Bityutskiy77993082006-10-11 14:52:44 +0300592/**
593 * get_mtd_device_nm - obtain a validated handle for an MTD device by
594 * device name
595 * @name: MTD device name to open
596 *
597 * This function returns MTD device description structure in case of
598 * success and an error code in case of failure.
599 */
600
601struct mtd_info *get_mtd_device_nm(const char *name)
602{
Ben Hutchingsf1332ba2010-01-29 20:57:11 +0000603 int err = -ENODEV;
604 struct mtd_info *mtd = NULL, *other;
Artem Bityutskiy77993082006-10-11 14:52:44 +0300605
606 mutex_lock(&mtd_table_mutex);
607
Ben Hutchingsf1332ba2010-01-29 20:57:11 +0000608 mtd_for_each_device(other) {
609 if (!strcmp(name, other->name)) {
610 mtd = other;
Artem Bityutskiy77993082006-10-11 14:52:44 +0300611 break;
612 }
613 }
614
Artem Bityutskiy9fe912c2006-10-11 14:52:45 +0300615 if (!mtd)
Artem Bityutskiy77993082006-10-11 14:52:44 +0300616 goto out_unlock;
617
Wanlong Gao52534f22011-05-17 22:36:18 +0800618 err = __get_mtd_device(mtd);
619 if (err)
Artem Bityutskiy77993082006-10-11 14:52:44 +0300620 goto out_unlock;
621
Artem Bityutskiy77993082006-10-11 14:52:44 +0300622 mutex_unlock(&mtd_table_mutex);
623 return mtd;
Artem Bityutskiy9fe912c2006-10-11 14:52:45 +0300624
Artem Bityutskiy9fe912c2006-10-11 14:52:45 +0300625out_unlock:
626 mutex_unlock(&mtd_table_mutex);
627 return ERR_PTR(err);
Artem Bityutskiy77993082006-10-11 14:52:44 +0300628}
629
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630void put_mtd_device(struct mtd_info *mtd)
631{
Ingo Molnar48b19262006-03-31 02:29:41 -0800632 mutex_lock(&mtd_table_mutex);
Maxim Levitsky3bd45652010-02-22 20:39:28 +0200633 __put_mtd_device(mtd);
634 mutex_unlock(&mtd_table_mutex);
635
636}
637
638void __put_mtd_device(struct mtd_info *mtd)
639{
640 --mtd->usecount;
641 BUG_ON(mtd->usecount < 0);
642
Artem Bityutskiy9fe912c2006-10-11 14:52:45 +0300643 if (mtd->put_device)
644 mtd->put_device(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645
646 module_put(mtd->owner);
647}
648
649/* default_mtd_writev - default mtd writev method for MTD devices that
David Woodhousedd36f262006-11-29 16:33:03 +0000650 * don't implement their own
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 */
652
653int default_mtd_writev(struct mtd_info *mtd, const struct kvec *vecs,
654 unsigned long count, loff_t to, size_t *retlen)
655{
656 unsigned long i;
657 size_t totlen = 0, thislen;
658 int ret = 0;
659
660 if(!mtd->write) {
661 ret = -EROFS;
662 } else {
663 for (i=0; i<count; i++) {
664 if (!vecs[i].iov_len)
665 continue;
666 ret = mtd->write(mtd, to, vecs[i].iov_len, &thislen, vecs[i].iov_base);
667 totlen += thislen;
668 if (ret || thislen != vecs[i].iov_len)
669 break;
670 to += vecs[i].iov_len;
671 }
672 }
673 if (retlen)
674 *retlen = totlen;
675 return ret;
676}
677
Grant Erickson33b53712011-04-08 08:51:32 -0700678/**
679 * mtd_kmalloc_up_to - allocate a contiguous buffer up to the specified size
680 * @size: A pointer to the ideal or maximum size of the allocation. Points
681 * to the actual allocation size on success.
682 *
683 * This routine attempts to allocate a contiguous kernel buffer up to
684 * the specified size, backing off the size of the request exponentially
685 * until the request succeeds or until the allocation size falls below
686 * the system page size. This attempts to make sure it does not adversely
687 * impact system performance, so when allocating more than one page, we
688 * ask the memory allocator to avoid re-trying, swapping, writing back
689 * or performing I/O.
690 *
691 * Note, this function also makes sure that the allocated buffer is aligned to
692 * the MTD device's min. I/O unit, i.e. the "mtd->writesize" value.
693 *
694 * This is called, for example by mtd_{read,write} and jffs2_scan_medium,
695 * to handle smaller (i.e. degraded) buffer allocations under low- or
696 * fragmented-memory situations where such reduced allocations, from a
697 * requested ideal, are allowed.
698 *
699 * Returns a pointer to the allocated buffer on success; otherwise, NULL.
700 */
701void *mtd_kmalloc_up_to(const struct mtd_info *mtd, size_t *size)
702{
703 gfp_t flags = __GFP_NOWARN | __GFP_WAIT |
704 __GFP_NORETRY | __GFP_NO_KSWAPD;
705 size_t min_alloc = max_t(size_t, mtd->writesize, PAGE_SIZE);
706 void *kbuf;
707
708 *size = min_t(size_t, *size, KMALLOC_MAX_SIZE);
709
710 while (*size > min_alloc) {
711 kbuf = kmalloc(*size, flags);
712 if (kbuf)
713 return kbuf;
714
715 *size >>= 1;
716 *size = ALIGN(*size, mtd->writesize);
717 }
718
719 /*
720 * For the last resort allocation allow 'kmalloc()' to do all sorts of
721 * things (write-back, dropping caches, etc) by using GFP_KERNEL.
722 */
723 return kmalloc(*size, GFP_KERNEL);
724}
725
David Woodhousedd36f262006-11-29 16:33:03 +0000726EXPORT_SYMBOL_GPL(get_mtd_device);
727EXPORT_SYMBOL_GPL(get_mtd_device_nm);
Maxim Levitsky3bd45652010-02-22 20:39:28 +0200728EXPORT_SYMBOL_GPL(__get_mtd_device);
David Woodhousedd36f262006-11-29 16:33:03 +0000729EXPORT_SYMBOL_GPL(put_mtd_device);
Maxim Levitsky3bd45652010-02-22 20:39:28 +0200730EXPORT_SYMBOL_GPL(__put_mtd_device);
David Woodhousedd36f262006-11-29 16:33:03 +0000731EXPORT_SYMBOL_GPL(register_mtd_user);
732EXPORT_SYMBOL_GPL(unregister_mtd_user);
733EXPORT_SYMBOL_GPL(default_mtd_writev);
Grant Erickson33b53712011-04-08 08:51:32 -0700734EXPORT_SYMBOL_GPL(mtd_kmalloc_up_to);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735
Pavel Machek2d2dce02006-03-31 02:29:49 -0800736#ifdef CONFIG_PROC_FS
737
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738/*====================================================================*/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739/* Support for /proc/mtd */
740
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741static struct proc_dir_entry *proc_mtd;
742
Alexey Dobriyan447d9bd2011-05-13 23:34:19 +0300743static int mtd_proc_show(struct seq_file *m, void *v)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744{
Ben Hutchingsf1332ba2010-01-29 20:57:11 +0000745 struct mtd_info *mtd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746
Alexey Dobriyan447d9bd2011-05-13 23:34:19 +0300747 seq_puts(m, "dev: size erasesize name\n");
Ingo Molnar48b19262006-03-31 02:29:41 -0800748 mutex_lock(&mtd_table_mutex);
Ben Hutchingsf1332ba2010-01-29 20:57:11 +0000749 mtd_for_each_device(mtd) {
Alexey Dobriyan447d9bd2011-05-13 23:34:19 +0300750 seq_printf(m, "mtd%d: %8.8llx %8.8x \"%s\"\n",
751 mtd->index, (unsigned long long)mtd->size,
752 mtd->erasesize, mtd->name);
Wanlong Gaod5ca5122011-05-20 21:14:30 +0800753 }
Ingo Molnar48b19262006-03-31 02:29:41 -0800754 mutex_unlock(&mtd_table_mutex);
Wanlong Gaod5ca5122011-05-20 21:14:30 +0800755 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756}
757
Alexey Dobriyan447d9bd2011-05-13 23:34:19 +0300758static int mtd_proc_open(struct inode *inode, struct file *file)
759{
760 return single_open(file, mtd_proc_show, NULL);
761}
762
763static const struct file_operations mtd_proc_ops = {
764 .open = mtd_proc_open,
765 .read = seq_read,
766 .llseek = seq_lseek,
767 .release = single_release,
768};
Kevin Cernekee45b09072009-04-04 11:03:04 -0700769#endif /* CONFIG_PROC_FS */
770
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771/*====================================================================*/
772/* Init code */
773
Jens Axboe0661b1a2010-04-27 09:49:47 +0200774static int __init mtd_bdi_init(struct backing_dev_info *bdi, const char *name)
775{
776 int ret;
777
778 ret = bdi_init(bdi);
779 if (!ret)
780 ret = bdi_register(bdi, NULL, name);
781
782 if (ret)
783 bdi_destroy(bdi);
784
785 return ret;
786}
787
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788static int __init init_mtd(void)
789{
David Woodhouse15bce402009-04-05 07:40:58 -0700790 int ret;
Kevin Cernekee694bb7f2009-04-03 13:00:45 -0700791
Jens Axboe0661b1a2010-04-27 09:49:47 +0200792 ret = class_register(&mtd_class);
793 if (ret)
794 goto err_reg;
795
796 ret = mtd_bdi_init(&mtd_bdi_unmappable, "mtd-unmap");
797 if (ret)
798 goto err_bdi1;
799
800 ret = mtd_bdi_init(&mtd_bdi_ro_mappable, "mtd-romap");
801 if (ret)
802 goto err_bdi2;
803
804 ret = mtd_bdi_init(&mtd_bdi_rw_mappable, "mtd-rwmap");
805 if (ret)
806 goto err_bdi3;
807
Kevin Cernekee45b09072009-04-04 11:03:04 -0700808#ifdef CONFIG_PROC_FS
Alexey Dobriyan447d9bd2011-05-13 23:34:19 +0300809 proc_mtd = proc_create("mtd", 0, NULL, &mtd_proc_ops);
Kevin Cernekee45b09072009-04-04 11:03:04 -0700810#endif /* CONFIG_PROC_FS */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811 return 0;
Jens Axboe0661b1a2010-04-27 09:49:47 +0200812
813err_bdi3:
814 bdi_destroy(&mtd_bdi_ro_mappable);
815err_bdi2:
816 bdi_destroy(&mtd_bdi_unmappable);
817err_bdi1:
818 class_unregister(&mtd_class);
819err_reg:
820 pr_err("Error registering mtd class or bdi: %d\n", ret);
821 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822}
823
824static void __exit cleanup_mtd(void)
825{
Kevin Cernekee45b09072009-04-04 11:03:04 -0700826#ifdef CONFIG_PROC_FS
Wanlong Gaod5ca5122011-05-20 21:14:30 +0800827 if (proc_mtd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 remove_proc_entry( "mtd", NULL);
Kevin Cernekee45b09072009-04-04 11:03:04 -0700829#endif /* CONFIG_PROC_FS */
David Woodhouse15bce402009-04-05 07:40:58 -0700830 class_unregister(&mtd_class);
Jens Axboe0661b1a2010-04-27 09:49:47 +0200831 bdi_destroy(&mtd_bdi_unmappable);
832 bdi_destroy(&mtd_bdi_ro_mappable);
833 bdi_destroy(&mtd_bdi_rw_mappable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834}
835
836module_init(init_mtd);
837module_exit(cleanup_mtd);
838
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839MODULE_LICENSE("GPL");
840MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org>");
841MODULE_DESCRIPTION("Core MTD registration and access routines");