blob: 374c46dff7dd65d3aea7eef69b22a332d727ad0f [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{
Fabio Estevam335a5f42012-01-12 01:25:04 -0200110 struct mtd_info __maybe_unused *mtd = dev_get_drvdata(dev);
Artem Bityutskiyd5de20a2011-12-29 18:00:29 +0200111 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
Artem Bityutskiy1a308712012-01-16 11:07:16 +0200122 return mtd ? mtd_suspend(mtd) : 0;
David Woodhouse15bce402009-04-05 07:40:58 -0700123}
124
125static int mtd_cls_resume(struct device *dev)
126{
Artem Bityutskiyd5de20a2011-12-29 18:00:29 +0200127 struct mtd_info *mtd = dev_get_drvdata(dev);
Artem Bityutskiy33c87b42011-12-30 16:11:14 +0200128
Brian Norris3ee5014185b2012-01-27 12:39:32 -0800129 if (mtd)
Artem Bityutskiyead995f2011-12-23 19:31:25 +0200130 mtd_resume(mtd);
David Woodhouse15bce402009-04-05 07:40:58 -0700131 return 0;
David Brownell1f24b5a2009-03-26 00:42:41 -0700132}
133
134static ssize_t mtd_type_show(struct device *dev,
135 struct device_attribute *attr, char *buf)
136{
Artem Bityutskiyd5de20a2011-12-29 18:00:29 +0200137 struct mtd_info *mtd = dev_get_drvdata(dev);
David Brownell1f24b5a2009-03-26 00:42:41 -0700138 char *type;
139
140 switch (mtd->type) {
141 case MTD_ABSENT:
142 type = "absent";
143 break;
144 case MTD_RAM:
145 type = "ram";
146 break;
147 case MTD_ROM:
148 type = "rom";
149 break;
150 case MTD_NORFLASH:
151 type = "nor";
152 break;
153 case MTD_NANDFLASH:
154 type = "nand";
155 break;
156 case MTD_DATAFLASH:
157 type = "dataflash";
158 break;
159 case MTD_UBIVOLUME:
160 type = "ubi";
161 break;
162 default:
163 type = "unknown";
164 }
165
166 return snprintf(buf, PAGE_SIZE, "%s\n", type);
167}
Kevin Cernekee694bb7f2009-04-03 13:00:45 -0700168static DEVICE_ATTR(type, S_IRUGO, mtd_type_show, NULL);
169
170static ssize_t mtd_flags_show(struct device *dev,
171 struct device_attribute *attr, char *buf)
172{
Artem Bityutskiyd5de20a2011-12-29 18:00:29 +0200173 struct mtd_info *mtd = dev_get_drvdata(dev);
Kevin Cernekee694bb7f2009-04-03 13:00:45 -0700174
175 return snprintf(buf, PAGE_SIZE, "0x%lx\n", (unsigned long)mtd->flags);
176
177}
178static DEVICE_ATTR(flags, S_IRUGO, mtd_flags_show, NULL);
179
180static ssize_t mtd_size_show(struct device *dev,
181 struct device_attribute *attr, char *buf)
182{
Artem Bityutskiyd5de20a2011-12-29 18:00:29 +0200183 struct mtd_info *mtd = dev_get_drvdata(dev);
Kevin Cernekee694bb7f2009-04-03 13:00:45 -0700184
185 return snprintf(buf, PAGE_SIZE, "%llu\n",
186 (unsigned long long)mtd->size);
187
188}
189static DEVICE_ATTR(size, S_IRUGO, mtd_size_show, NULL);
190
191static ssize_t mtd_erasesize_show(struct device *dev,
192 struct device_attribute *attr, char *buf)
193{
Artem Bityutskiyd5de20a2011-12-29 18:00:29 +0200194 struct mtd_info *mtd = dev_get_drvdata(dev);
Kevin Cernekee694bb7f2009-04-03 13:00:45 -0700195
196 return snprintf(buf, PAGE_SIZE, "%lu\n", (unsigned long)mtd->erasesize);
197
198}
199static DEVICE_ATTR(erasesize, S_IRUGO, mtd_erasesize_show, NULL);
200
201static ssize_t mtd_writesize_show(struct device *dev,
202 struct device_attribute *attr, char *buf)
203{
Artem Bityutskiyd5de20a2011-12-29 18:00:29 +0200204 struct mtd_info *mtd = dev_get_drvdata(dev);
Kevin Cernekee694bb7f2009-04-03 13:00:45 -0700205
206 return snprintf(buf, PAGE_SIZE, "%lu\n", (unsigned long)mtd->writesize);
207
208}
209static DEVICE_ATTR(writesize, S_IRUGO, mtd_writesize_show, NULL);
210
Artem Bityutskiye7693542009-04-18 12:29:42 +0300211static ssize_t mtd_subpagesize_show(struct device *dev,
212 struct device_attribute *attr, char *buf)
213{
Artem Bityutskiyd5de20a2011-12-29 18:00:29 +0200214 struct mtd_info *mtd = dev_get_drvdata(dev);
Artem Bityutskiye7693542009-04-18 12:29:42 +0300215 unsigned int subpagesize = mtd->writesize >> mtd->subpage_sft;
216
217 return snprintf(buf, PAGE_SIZE, "%u\n", subpagesize);
218
219}
220static DEVICE_ATTR(subpagesize, S_IRUGO, mtd_subpagesize_show, NULL);
221
Kevin Cernekee694bb7f2009-04-03 13:00:45 -0700222static ssize_t mtd_oobsize_show(struct device *dev,
223 struct device_attribute *attr, char *buf)
224{
Artem Bityutskiyd5de20a2011-12-29 18:00:29 +0200225 struct mtd_info *mtd = dev_get_drvdata(dev);
Kevin Cernekee694bb7f2009-04-03 13:00:45 -0700226
227 return snprintf(buf, PAGE_SIZE, "%lu\n", (unsigned long)mtd->oobsize);
228
229}
230static DEVICE_ATTR(oobsize, S_IRUGO, mtd_oobsize_show, NULL);
231
232static ssize_t mtd_numeraseregions_show(struct device *dev,
233 struct device_attribute *attr, char *buf)
234{
Artem Bityutskiyd5de20a2011-12-29 18:00:29 +0200235 struct mtd_info *mtd = dev_get_drvdata(dev);
Kevin Cernekee694bb7f2009-04-03 13:00:45 -0700236
237 return snprintf(buf, PAGE_SIZE, "%u\n", mtd->numeraseregions);
238
239}
240static DEVICE_ATTR(numeraseregions, S_IRUGO, mtd_numeraseregions_show,
241 NULL);
242
243static ssize_t mtd_name_show(struct device *dev,
244 struct device_attribute *attr, char *buf)
245{
Artem Bityutskiyd5de20a2011-12-29 18:00:29 +0200246 struct mtd_info *mtd = dev_get_drvdata(dev);
Kevin Cernekee694bb7f2009-04-03 13:00:45 -0700247
248 return snprintf(buf, PAGE_SIZE, "%s\n", mtd->name);
249
250}
251static DEVICE_ATTR(name, S_IRUGO, mtd_name_show, NULL);
David Brownell1f24b5a2009-03-26 00:42:41 -0700252
Mike Dunna9b672e2012-04-25 12:06:07 -0700253static ssize_t mtd_ecc_strength_show(struct device *dev,
254 struct device_attribute *attr, char *buf)
255{
256 struct mtd_info *mtd = dev_get_drvdata(dev);
257
258 return snprintf(buf, PAGE_SIZE, "%u\n", mtd->ecc_strength);
259}
260static DEVICE_ATTR(ecc_strength, S_IRUGO, mtd_ecc_strength_show, NULL);
261
Mike Dunnd062d4e2012-04-25 12:06:08 -0700262static ssize_t mtd_bitflip_threshold_show(struct device *dev,
263 struct device_attribute *attr,
264 char *buf)
265{
266 struct mtd_info *mtd = dev_get_drvdata(dev);
267
268 return snprintf(buf, PAGE_SIZE, "%u\n", mtd->bitflip_threshold);
269}
270
271static ssize_t mtd_bitflip_threshold_store(struct device *dev,
272 struct device_attribute *attr,
273 const char *buf, size_t count)
274{
275 struct mtd_info *mtd = dev_get_drvdata(dev);
276 unsigned int bitflip_threshold;
277 int retval;
278
279 retval = kstrtouint(buf, 0, &bitflip_threshold);
280 if (retval)
281 return retval;
282
283 mtd->bitflip_threshold = bitflip_threshold;
284 return count;
285}
286static DEVICE_ATTR(bitflip_threshold, S_IRUGO | S_IWUSR,
287 mtd_bitflip_threshold_show,
288 mtd_bitflip_threshold_store);
289
David Brownell1f24b5a2009-03-26 00:42:41 -0700290static struct attribute *mtd_attrs[] = {
Kevin Cernekee694bb7f2009-04-03 13:00:45 -0700291 &dev_attr_type.attr,
292 &dev_attr_flags.attr,
293 &dev_attr_size.attr,
294 &dev_attr_erasesize.attr,
295 &dev_attr_writesize.attr,
Artem Bityutskiye7693542009-04-18 12:29:42 +0300296 &dev_attr_subpagesize.attr,
Kevin Cernekee694bb7f2009-04-03 13:00:45 -0700297 &dev_attr_oobsize.attr,
298 &dev_attr_numeraseregions.attr,
299 &dev_attr_name.attr,
Mike Dunna9b672e2012-04-25 12:06:07 -0700300 &dev_attr_ecc_strength.attr,
Mike Dunnd062d4e2012-04-25 12:06:08 -0700301 &dev_attr_bitflip_threshold.attr,
David Brownell1f24b5a2009-03-26 00:42:41 -0700302 NULL,
303};
304
H Hartley Sweetenfca91082009-08-06 16:05:32 -0700305static struct attribute_group mtd_group = {
David Brownell1f24b5a2009-03-26 00:42:41 -0700306 .attrs = mtd_attrs,
307};
308
David Woodhouse6469f542009-09-20 05:55:36 -0700309static const struct attribute_group *mtd_groups[] = {
David Brownell1f24b5a2009-03-26 00:42:41 -0700310 &mtd_group,
311 NULL,
312};
313
314static struct device_type mtd_devtype = {
315 .name = "mtd",
316 .groups = mtd_groups,
317 .release = mtd_release,
318};
319
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320/**
321 * add_mtd_device - register an MTD device
322 * @mtd: pointer to new MTD device info structure
323 *
324 * Add a device to the list of MTD devices present in the system, and
325 * notify each currently active MTD 'user' of its arrival. Returns
326 * zero on success or 1 on failure, which currently will only happen
Ben Hutchingsb520e412010-01-29 20:59:42 +0000327 * if there is insufficient memory or a sysfs error.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328 */
329
330int add_mtd_device(struct mtd_info *mtd)
331{
Ben Hutchingsb520e412010-01-29 20:59:42 +0000332 struct mtd_notifier *not;
333 int i, error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334
David Howells402d3262009-02-12 10:40:00 +0000335 if (!mtd->backing_dev_info) {
336 switch (mtd->type) {
337 case MTD_RAM:
338 mtd->backing_dev_info = &mtd_bdi_rw_mappable;
339 break;
340 case MTD_ROM:
341 mtd->backing_dev_info = &mtd_bdi_ro_mappable;
342 break;
343 default:
344 mtd->backing_dev_info = &mtd_bdi_unmappable;
345 break;
346 }
347 }
348
Artem B. Bityutskiy783ed812006-06-14 19:53:44 +0400349 BUG_ON(mtd->writesize == 0);
Ingo Molnar48b19262006-03-31 02:29:41 -0800350 mutex_lock(&mtd_table_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351
Ben Hutchingsb520e412010-01-29 20:59:42 +0000352 do {
353 if (!idr_pre_get(&mtd_idr, GFP_KERNEL))
354 goto fail_locked;
355 error = idr_get_new(&mtd_idr, mtd, &i);
356 } while (error == -EAGAIN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357
Ben Hutchingsb520e412010-01-29 20:59:42 +0000358 if (error)
359 goto fail_locked;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360
Ben Hutchingsb520e412010-01-29 20:59:42 +0000361 mtd->index = i;
362 mtd->usecount = 0;
Adrian Hunter69423d92008-12-10 13:37:21 +0000363
Mike Dunnd062d4e2012-04-25 12:06:08 -0700364 /* default value if not set by driver */
365 if (mtd->bitflip_threshold == 0)
366 mtd->bitflip_threshold = mtd->ecc_strength;
367
Ben Hutchingsb520e412010-01-29 20:59:42 +0000368 if (is_power_of_2(mtd->erasesize))
369 mtd->erasesize_shift = ffs(mtd->erasesize) - 1;
370 else
371 mtd->erasesize_shift = 0;
Adrian Hunter69423d92008-12-10 13:37:21 +0000372
Ben Hutchingsb520e412010-01-29 20:59:42 +0000373 if (is_power_of_2(mtd->writesize))
374 mtd->writesize_shift = ffs(mtd->writesize) - 1;
375 else
376 mtd->writesize_shift = 0;
Adrian Hunter69423d92008-12-10 13:37:21 +0000377
Ben Hutchingsb520e412010-01-29 20:59:42 +0000378 mtd->erasesize_mask = (1 << mtd->erasesize_shift) - 1;
379 mtd->writesize_mask = (1 << mtd->writesize_shift) - 1;
Håvard Skinnemoen187ef152006-09-22 10:07:08 +0100380
Ben Hutchingsb520e412010-01-29 20:59:42 +0000381 /* Some chips always power up locked. Unlock them now */
Artem Bityutskiy38134562011-12-30 17:00:35 +0200382 if ((mtd->flags & MTD_WRITEABLE) && (mtd->flags & MTD_POWERUP_LOCK)) {
383 error = mtd_unlock(mtd, 0, mtd->size);
384 if (error && error != -EOPNOTSUPP)
Ben Hutchingsb520e412010-01-29 20:59:42 +0000385 printk(KERN_WARNING
386 "%s: unlock failed, writes may not work\n",
387 mtd->name);
388 }
David Brownell1f24b5a2009-03-26 00:42:41 -0700389
Ben Hutchingsb520e412010-01-29 20:59:42 +0000390 /* Caller should have set dev.parent to match the
391 * physical device.
392 */
393 mtd->dev.type = &mtd_devtype;
394 mtd->dev.class = &mtd_class;
395 mtd->dev.devt = MTD_DEVT(i);
396 dev_set_name(&mtd->dev, "mtd%d", i);
397 dev_set_drvdata(&mtd->dev, mtd);
398 if (device_register(&mtd->dev) != 0)
399 goto fail_added;
David Brownell1f24b5a2009-03-26 00:42:41 -0700400
Ben Hutchingsb520e412010-01-29 20:59:42 +0000401 if (MTD_DEVT(i))
402 device_create(&mtd_class, mtd->dev.parent,
403 MTD_DEVT(i) + 1,
404 NULL, "mtd%dro", i);
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000405
Brian Norris289c0522011-07-19 10:06:09 -0700406 pr_debug("mtd: Giving out device %d to %s\n", i, mtd->name);
Ben Hutchingsb520e412010-01-29 20:59:42 +0000407 /* No need to get a refcount on the module containing
408 the notifier, since we hold the mtd_table_mutex */
409 list_for_each_entry(not, &mtd_notifiers, list)
410 not->add(mtd);
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000411
Ingo Molnar48b19262006-03-31 02:29:41 -0800412 mutex_unlock(&mtd_table_mutex);
Ben Hutchingsb520e412010-01-29 20:59:42 +0000413 /* We _know_ we aren't being removed, because
414 our caller is still holding us here. So none
415 of this try_ nonsense, and no bitching about it
416 either. :) */
417 __module_get(THIS_MODULE);
418 return 0;
419
420fail_added:
421 idr_remove(&mtd_idr, i);
422fail_locked:
423 mutex_unlock(&mtd_table_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424 return 1;
425}
426
427/**
428 * del_mtd_device - unregister an MTD device
429 * @mtd: pointer to MTD device info structure
430 *
431 * Remove a device from the list of MTD devices present in the system,
432 * and notify each currently active MTD 'user' of its departure.
433 * Returns zero on success or 1 on failure, which currently will happen
434 * if the requested device does not appear to be present in the list.
435 */
436
Jamie Ileseea72d52011-05-23 10:23:42 +0100437int del_mtd_device(struct mtd_info *mtd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438{
439 int ret;
Maxim Levitsky75c0b842010-02-22 20:39:32 +0200440 struct mtd_notifier *not;
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000441
Ingo Molnar48b19262006-03-31 02:29:41 -0800442 mutex_lock(&mtd_table_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443
Ben Hutchingsb520e412010-01-29 20:59:42 +0000444 if (idr_find(&mtd_idr, mtd->index) != mtd) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 ret = -ENODEV;
Maxim Levitsky75c0b842010-02-22 20:39:32 +0200446 goto out_error;
447 }
448
449 /* No need to get a refcount on the module containing
450 the notifier, since we hold the mtd_table_mutex */
451 list_for_each_entry(not, &mtd_notifiers, list)
452 not->remove(mtd);
453
454 if (mtd->usecount) {
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000455 printk(KERN_NOTICE "Removing MTD device #%d (%s) with use count %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456 mtd->index, mtd->name, mtd->usecount);
457 ret = -EBUSY;
458 } else {
Kevin Cernekee694bb7f2009-04-03 13:00:45 -0700459 device_unregister(&mtd->dev);
460
Ben Hutchingsb520e412010-01-29 20:59:42 +0000461 idr_remove(&mtd_idr, mtd->index);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462
463 module_put(THIS_MODULE);
464 ret = 0;
465 }
466
Maxim Levitsky75c0b842010-02-22 20:39:32 +0200467out_error:
Ingo Molnar48b19262006-03-31 02:29:41 -0800468 mutex_unlock(&mtd_table_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 return ret;
470}
471
472/**
Dmitry Eremin-Solenikov1c4c2152011-03-25 22:26:25 +0300473 * mtd_device_parse_register - parse partitions and register an MTD device.
474 *
475 * @mtd: the MTD device to register
476 * @types: the list of MTD partition probes to try, see
477 * 'parse_mtd_partitions()' for more information
Dmitry Eremin-Solenikovc7975332011-06-10 18:18:28 +0400478 * @parser_data: MTD partition parser-specific data
Dmitry Eremin-Solenikov1c4c2152011-03-25 22:26:25 +0300479 * @parts: fallback partition information to register, if parsing fails;
480 * only valid if %nr_parts > %0
481 * @nr_parts: the number of partitions in parts, if zero then the full
482 * MTD device is registered if no partition info is found
483 *
484 * This function aggregates MTD partitions parsing (done by
485 * 'parse_mtd_partitions()') and MTD device and partitions registering. It
486 * basically follows the most common pattern found in many MTD drivers:
487 *
488 * * It first tries to probe partitions on MTD device @mtd using parsers
489 * specified in @types (if @types is %NULL, then the default list of parsers
490 * is used, see 'parse_mtd_partitions()' for more information). If none are
491 * found this functions tries to fallback to information specified in
492 * @parts/@nr_parts.
Brian Norris92394b5c2011-07-20 09:53:42 -0700493 * * If any partitioning info was found, this function registers the found
Dmitry Eremin-Solenikov1c4c2152011-03-25 22:26:25 +0300494 * partitions.
495 * * If no partitions were found this function just registers the MTD device
496 * @mtd and exits.
497 *
498 * Returns zero in case of success and a negative error code in case of failure.
499 */
500int mtd_device_parse_register(struct mtd_info *mtd, const char **types,
Dmitry Eremin-Solenikovc7975332011-06-10 18:18:28 +0400501 struct mtd_part_parser_data *parser_data,
Dmitry Eremin-Solenikov1c4c2152011-03-25 22:26:25 +0300502 const struct mtd_partition *parts,
503 int nr_parts)
504{
505 int err;
506 struct mtd_partition *real_parts;
507
Dmitry Eremin-Solenikovc7975332011-06-10 18:18:28 +0400508 err = parse_mtd_partitions(mtd, types, &real_parts, parser_data);
Jason Liu4d523b602011-08-24 19:26:28 +0800509 if (err <= 0 && nr_parts && parts) {
Dmitry Eremin-Solenikov1c4c2152011-03-25 22:26:25 +0300510 real_parts = kmemdup(parts, sizeof(*parts) * nr_parts,
511 GFP_KERNEL);
Jason Liu4d523b602011-08-24 19:26:28 +0800512 if (!real_parts)
Dmitry Eremin-Solenikov1c4c2152011-03-25 22:26:25 +0300513 err = -ENOMEM;
Jason Liu4d523b602011-08-24 19:26:28 +0800514 else
515 err = nr_parts;
Dmitry Eremin-Solenikov1c4c2152011-03-25 22:26:25 +0300516 }
517
518 if (err > 0) {
519 err = add_mtd_partitions(mtd, real_parts, err);
520 kfree(real_parts);
521 } else if (err == 0) {
522 err = add_mtd_device(mtd);
523 if (err == 1)
524 err = -ENODEV;
525 }
526
527 return err;
528}
529EXPORT_SYMBOL_GPL(mtd_device_parse_register);
530
531/**
Jamie Ilesf5671ab2011-05-23 17:15:46 +0100532 * mtd_device_unregister - unregister an existing MTD device.
533 *
534 * @master: the MTD device to unregister. This will unregister both the master
535 * and any partitions if registered.
536 */
537int mtd_device_unregister(struct mtd_info *master)
538{
539 int err;
540
541 err = del_mtd_partitions(master);
542 if (err)
543 return err;
544
545 if (!device_is_registered(&master->dev))
546 return 0;
547
548 return del_mtd_device(master);
549}
550EXPORT_SYMBOL_GPL(mtd_device_unregister);
551
552/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 * register_mtd_user - register a 'user' of MTD devices.
554 * @new: pointer to notifier info structure
555 *
556 * Registers a pair of callbacks function to be called upon addition
557 * or removal of MTD devices. Causes the 'add' callback to be immediately
558 * invoked for each MTD device currently present in the system.
559 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560void register_mtd_user (struct mtd_notifier *new)
561{
Ben Hutchingsf1332ba2010-01-29 20:57:11 +0000562 struct mtd_info *mtd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563
Ingo Molnar48b19262006-03-31 02:29:41 -0800564 mutex_lock(&mtd_table_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565
566 list_add(&new->list, &mtd_notifiers);
567
Wanlong Gaod5ca5122011-05-20 21:14:30 +0800568 __module_get(THIS_MODULE);
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000569
Ben Hutchingsf1332ba2010-01-29 20:57:11 +0000570 mtd_for_each_device(mtd)
571 new->add(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572
Ingo Molnar48b19262006-03-31 02:29:41 -0800573 mutex_unlock(&mtd_table_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574}
Artem Bityutskiy33c87b42011-12-30 16:11:14 +0200575EXPORT_SYMBOL_GPL(register_mtd_user);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576
577/**
Artem B. Bityuckiy49450792005-02-18 14:34:54 +0000578 * unregister_mtd_user - unregister a 'user' of MTD devices.
579 * @old: pointer to notifier info structure
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 *
581 * Removes a callback function pair from the list of 'users' to be
582 * notified upon addition or removal of MTD devices. Causes the
583 * 'remove' callback to be immediately invoked for each MTD device
584 * currently present in the system.
585 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586int unregister_mtd_user (struct mtd_notifier *old)
587{
Ben Hutchingsf1332ba2010-01-29 20:57:11 +0000588 struct mtd_info *mtd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589
Ingo Molnar48b19262006-03-31 02:29:41 -0800590 mutex_lock(&mtd_table_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591
592 module_put(THIS_MODULE);
593
Ben Hutchingsf1332ba2010-01-29 20:57:11 +0000594 mtd_for_each_device(mtd)
595 old->remove(mtd);
Thomas Gleixner97894cd2005-11-07 11:15:26 +0000596
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 list_del(&old->list);
Ingo Molnar48b19262006-03-31 02:29:41 -0800598 mutex_unlock(&mtd_table_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599 return 0;
600}
Artem Bityutskiy33c87b42011-12-30 16:11:14 +0200601EXPORT_SYMBOL_GPL(unregister_mtd_user);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602
603/**
604 * get_mtd_device - obtain a validated handle for an MTD device
605 * @mtd: last known address of the required MTD device
606 * @num: internal device number of the required MTD device
607 *
608 * Given a number and NULL address, return the num'th entry in the device
609 * table, if any. Given an address and num == -1, search the device table
610 * for a device with that address and return if it's still present. Given
Artem Bityutskiy9c740342006-10-11 14:52:47 +0300611 * both, return the num'th driver only if its address matches. Return
612 * error code if not.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num)
615{
Ben Hutchingsf1332ba2010-01-29 20:57:11 +0000616 struct mtd_info *ret = NULL, *other;
617 int err = -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618
Ingo Molnar48b19262006-03-31 02:29:41 -0800619 mutex_lock(&mtd_table_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620
621 if (num == -1) {
Ben Hutchingsf1332ba2010-01-29 20:57:11 +0000622 mtd_for_each_device(other) {
623 if (other == mtd) {
624 ret = mtd;
625 break;
626 }
627 }
Ben Hutchingsb520e412010-01-29 20:59:42 +0000628 } else if (num >= 0) {
629 ret = idr_find(&mtd_idr, num);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630 if (mtd && mtd != ret)
631 ret = NULL;
632 }
633
Maxim Levitsky3bd45652010-02-22 20:39:28 +0200634 if (!ret) {
635 ret = ERR_PTR(err);
636 goto out;
Artem Bityutskiy9fe912c2006-10-11 14:52:45 +0300637 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638
Maxim Levitsky3bd45652010-02-22 20:39:28 +0200639 err = __get_mtd_device(ret);
640 if (err)
641 ret = ERR_PTR(err);
642out:
Ingo Molnar48b19262006-03-31 02:29:41 -0800643 mutex_unlock(&mtd_table_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644 return ret;
Maxim Levitsky3bd45652010-02-22 20:39:28 +0200645}
Artem Bityutskiy33c87b42011-12-30 16:11:14 +0200646EXPORT_SYMBOL_GPL(get_mtd_device);
Artem Bityutskiy9c740342006-10-11 14:52:47 +0300647
Maxim Levitsky3bd45652010-02-22 20:39:28 +0200648
649int __get_mtd_device(struct mtd_info *mtd)
650{
651 int err;
652
653 if (!try_module_get(mtd->owner))
654 return -ENODEV;
655
Artem Bityutskiy3c3c10b2012-01-30 14:58:32 +0200656 if (mtd->_get_device) {
657 err = mtd->_get_device(mtd);
Maxim Levitsky3bd45652010-02-22 20:39:28 +0200658
659 if (err) {
660 module_put(mtd->owner);
661 return err;
662 }
663 }
664 mtd->usecount++;
665 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666}
Artem Bityutskiy33c87b42011-12-30 16:11:14 +0200667EXPORT_SYMBOL_GPL(__get_mtd_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668
Artem Bityutskiy77993082006-10-11 14:52:44 +0300669/**
670 * get_mtd_device_nm - obtain a validated handle for an MTD device by
671 * device name
672 * @name: MTD device name to open
673 *
674 * This function returns MTD device description structure in case of
675 * success and an error code in case of failure.
676 */
Artem Bityutskiy77993082006-10-11 14:52:44 +0300677struct mtd_info *get_mtd_device_nm(const char *name)
678{
Ben Hutchingsf1332ba2010-01-29 20:57:11 +0000679 int err = -ENODEV;
680 struct mtd_info *mtd = NULL, *other;
Artem Bityutskiy77993082006-10-11 14:52:44 +0300681
682 mutex_lock(&mtd_table_mutex);
683
Ben Hutchingsf1332ba2010-01-29 20:57:11 +0000684 mtd_for_each_device(other) {
685 if (!strcmp(name, other->name)) {
686 mtd = other;
Artem Bityutskiy77993082006-10-11 14:52:44 +0300687 break;
688 }
689 }
690
Artem Bityutskiy9fe912c2006-10-11 14:52:45 +0300691 if (!mtd)
Artem Bityutskiy77993082006-10-11 14:52:44 +0300692 goto out_unlock;
693
Wanlong Gao52534f22011-05-17 22:36:18 +0800694 err = __get_mtd_device(mtd);
695 if (err)
Artem Bityutskiy77993082006-10-11 14:52:44 +0300696 goto out_unlock;
697
Artem Bityutskiy77993082006-10-11 14:52:44 +0300698 mutex_unlock(&mtd_table_mutex);
699 return mtd;
Artem Bityutskiy9fe912c2006-10-11 14:52:45 +0300700
Artem Bityutskiy9fe912c2006-10-11 14:52:45 +0300701out_unlock:
702 mutex_unlock(&mtd_table_mutex);
703 return ERR_PTR(err);
Artem Bityutskiy77993082006-10-11 14:52:44 +0300704}
Artem Bityutskiy33c87b42011-12-30 16:11:14 +0200705EXPORT_SYMBOL_GPL(get_mtd_device_nm);
Artem Bityutskiy77993082006-10-11 14:52:44 +0300706
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707void put_mtd_device(struct mtd_info *mtd)
708{
Ingo Molnar48b19262006-03-31 02:29:41 -0800709 mutex_lock(&mtd_table_mutex);
Maxim Levitsky3bd45652010-02-22 20:39:28 +0200710 __put_mtd_device(mtd);
711 mutex_unlock(&mtd_table_mutex);
712
713}
Artem Bityutskiy33c87b42011-12-30 16:11:14 +0200714EXPORT_SYMBOL_GPL(put_mtd_device);
Maxim Levitsky3bd45652010-02-22 20:39:28 +0200715
716void __put_mtd_device(struct mtd_info *mtd)
717{
718 --mtd->usecount;
719 BUG_ON(mtd->usecount < 0);
720
Artem Bityutskiy3c3c10b2012-01-30 14:58:32 +0200721 if (mtd->_put_device)
722 mtd->_put_device(mtd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723
724 module_put(mtd->owner);
725}
Artem Bityutskiy33c87b42011-12-30 16:11:14 +0200726EXPORT_SYMBOL_GPL(__put_mtd_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727
Artem Bityutskiy52b02032011-12-30 15:57:25 +0200728/*
Artem Bityutskiy8273a0c2012-02-03 14:34:14 +0200729 * Erase is an asynchronous operation. Device drivers are supposed
730 * to call instr->callback() whenever the operation completes, even
731 * if it completes with a failure.
732 * Callers are supposed to pass a callback function and wait for it
733 * to be called before writing to the block.
734 */
735int mtd_erase(struct mtd_info *mtd, struct erase_info *instr)
736{
737 if (instr->addr > mtd->size || instr->len > mtd->size - instr->addr)
738 return -EINVAL;
Artem Bityutskiy664addc2012-02-03 18:13:23 +0200739 if (!(mtd->flags & MTD_WRITEABLE))
740 return -EROFS;
Shmulik Ladkani3b27dac2012-02-09 15:36:29 +0200741 instr->fail_addr = MTD_FAIL_ADDR_UNKNOWN;
Artem Bityutskiybcb1d232012-02-06 13:27:43 +0200742 if (!instr->len) {
743 instr->state = MTD_ERASE_DONE;
744 mtd_erase_callback(instr);
745 return 0;
746 }
Artem Bityutskiy8273a0c2012-02-03 14:34:14 +0200747 return mtd->_erase(mtd, instr);
748}
749EXPORT_SYMBOL_GPL(mtd_erase);
750
751/*
752 * This stuff for eXecute-In-Place. phys is optional and may be set to NULL.
753 */
754int mtd_point(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen,
755 void **virt, resource_size_t *phys)
756{
757 *retlen = 0;
Artem Bityutskiy0dd52352012-02-08 15:13:26 +0200758 *virt = NULL;
759 if (phys)
760 *phys = 0;
Artem Bityutskiy8273a0c2012-02-03 14:34:14 +0200761 if (!mtd->_point)
762 return -EOPNOTSUPP;
763 if (from < 0 || from > mtd->size || len > mtd->size - from)
764 return -EINVAL;
Artem Bityutskiybcb1d232012-02-06 13:27:43 +0200765 if (!len)
766 return 0;
Artem Bityutskiy8273a0c2012-02-03 14:34:14 +0200767 return mtd->_point(mtd, from, len, retlen, virt, phys);
768}
769EXPORT_SYMBOL_GPL(mtd_point);
770
771/* We probably shouldn't allow XIP if the unpoint isn't a NULL */
772int mtd_unpoint(struct mtd_info *mtd, loff_t from, size_t len)
773{
774 if (!mtd->_point)
775 return -EOPNOTSUPP;
776 if (from < 0 || from > mtd->size || len > mtd->size - from)
777 return -EINVAL;
Artem Bityutskiybcb1d232012-02-06 13:27:43 +0200778 if (!len)
779 return 0;
Artem Bityutskiy8273a0c2012-02-03 14:34:14 +0200780 return mtd->_unpoint(mtd, from, len);
781}
782EXPORT_SYMBOL_GPL(mtd_unpoint);
783
784/*
785 * Allow NOMMU mmap() to directly map the device (if not NULL)
786 * - return the address to which the offset maps
787 * - return -ENOSYS to indicate refusal to do the mapping
788 */
789unsigned long mtd_get_unmapped_area(struct mtd_info *mtd, unsigned long len,
790 unsigned long offset, unsigned long flags)
791{
792 if (!mtd->_get_unmapped_area)
793 return -EOPNOTSUPP;
794 if (offset > mtd->size || len > mtd->size - offset)
795 return -EINVAL;
796 return mtd->_get_unmapped_area(mtd, len, offset, flags);
797}
798EXPORT_SYMBOL_GPL(mtd_get_unmapped_area);
799
800int mtd_read(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen,
801 u_char *buf)
802{
Mike Dunnedbc45402012-04-25 12:06:11 -0700803 int ret_code;
Artem Bityutskiy834247e2012-02-06 12:39:07 +0200804 *retlen = 0;
Artem Bityutskiy8273a0c2012-02-03 14:34:14 +0200805 if (from < 0 || from > mtd->size || len > mtd->size - from)
806 return -EINVAL;
Artem Bityutskiybcb1d232012-02-06 13:27:43 +0200807 if (!len)
808 return 0;
Mike Dunnedbc45402012-04-25 12:06:11 -0700809
810 /*
811 * In the absence of an error, drivers return a non-negative integer
812 * representing the maximum number of bitflips that were corrected on
813 * any one ecc region (if applicable; zero otherwise).
814 */
815 ret_code = mtd->_read(mtd, from, len, retlen, buf);
816 if (unlikely(ret_code < 0))
817 return ret_code;
818 if (mtd->ecc_strength == 0)
819 return 0; /* device lacks ecc */
820 return ret_code >= mtd->bitflip_threshold ? -EUCLEAN : 0;
Artem Bityutskiy8273a0c2012-02-03 14:34:14 +0200821}
822EXPORT_SYMBOL_GPL(mtd_read);
823
824int mtd_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen,
825 const u_char *buf)
826{
827 *retlen = 0;
Artem Bityutskiy8273a0c2012-02-03 14:34:14 +0200828 if (to < 0 || to > mtd->size || len > mtd->size - to)
829 return -EINVAL;
Artem Bityutskiy664addc2012-02-03 18:13:23 +0200830 if (!mtd->_write || !(mtd->flags & MTD_WRITEABLE))
831 return -EROFS;
Artem Bityutskiybcb1d232012-02-06 13:27:43 +0200832 if (!len)
833 return 0;
Artem Bityutskiy8273a0c2012-02-03 14:34:14 +0200834 return mtd->_write(mtd, to, len, retlen, buf);
835}
836EXPORT_SYMBOL_GPL(mtd_write);
837
838/*
839 * In blackbox flight recorder like scenarios we want to make successful writes
840 * in interrupt context. panic_write() is only intended to be called when its
841 * known the kernel is about to panic and we need the write to succeed. Since
842 * the kernel is not going to be running for much longer, this function can
843 * break locks and delay to ensure the write succeeds (but not sleep).
844 */
845int mtd_panic_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen,
846 const u_char *buf)
847{
848 *retlen = 0;
849 if (!mtd->_panic_write)
850 return -EOPNOTSUPP;
851 if (to < 0 || to > mtd->size || len > mtd->size - to)
852 return -EINVAL;
Artem Bityutskiy664addc2012-02-03 18:13:23 +0200853 if (!(mtd->flags & MTD_WRITEABLE))
854 return -EROFS;
Artem Bityutskiybcb1d232012-02-06 13:27:43 +0200855 if (!len)
856 return 0;
Artem Bityutskiy8273a0c2012-02-03 14:34:14 +0200857 return mtd->_panic_write(mtd, to, len, retlen, buf);
858}
859EXPORT_SYMBOL_GPL(mtd_panic_write);
860
Brian Norrisd2d48482012-06-22 16:35:38 -0700861int mtd_read_oob(struct mtd_info *mtd, loff_t from, struct mtd_oob_ops *ops)
862{
Brian Norrise47f6852012-06-22 16:35:39 -0700863 int ret_code;
Brian Norrisd2d48482012-06-22 16:35:38 -0700864 ops->retlen = ops->oobretlen = 0;
865 if (!mtd->_read_oob)
866 return -EOPNOTSUPP;
Brian Norrise47f6852012-06-22 16:35:39 -0700867 /*
868 * In cases where ops->datbuf != NULL, mtd->_read_oob() has semantics
869 * similar to mtd->_read(), returning a non-negative integer
870 * representing max bitflips. In other cases, mtd->_read_oob() may
871 * return -EUCLEAN. In all cases, perform similar logic to mtd_read().
872 */
873 ret_code = mtd->_read_oob(mtd, from, ops);
874 if (unlikely(ret_code < 0))
875 return ret_code;
876 if (mtd->ecc_strength == 0)
877 return 0; /* device lacks ecc */
878 return ret_code >= mtd->bitflip_threshold ? -EUCLEAN : 0;
Brian Norrisd2d48482012-06-22 16:35:38 -0700879}
880EXPORT_SYMBOL_GPL(mtd_read_oob);
881
Artem Bityutskiyde3cac92012-02-08 16:37:14 +0200882/*
883 * Method to access the protection register area, present in some flash
884 * devices. The user data is one time programmable but the factory data is read
885 * only.
886 */
887int mtd_get_fact_prot_info(struct mtd_info *mtd, struct otp_info *buf,
888 size_t len)
889{
890 if (!mtd->_get_fact_prot_info)
891 return -EOPNOTSUPP;
892 if (!len)
893 return 0;
894 return mtd->_get_fact_prot_info(mtd, buf, len);
895}
896EXPORT_SYMBOL_GPL(mtd_get_fact_prot_info);
897
898int mtd_read_fact_prot_reg(struct mtd_info *mtd, loff_t from, size_t len,
899 size_t *retlen, u_char *buf)
900{
901 *retlen = 0;
902 if (!mtd->_read_fact_prot_reg)
903 return -EOPNOTSUPP;
904 if (!len)
905 return 0;
906 return mtd->_read_fact_prot_reg(mtd, from, len, retlen, buf);
907}
908EXPORT_SYMBOL_GPL(mtd_read_fact_prot_reg);
909
910int mtd_get_user_prot_info(struct mtd_info *mtd, struct otp_info *buf,
911 size_t len)
912{
913 if (!mtd->_get_user_prot_info)
914 return -EOPNOTSUPP;
915 if (!len)
916 return 0;
917 return mtd->_get_user_prot_info(mtd, buf, len);
918}
919EXPORT_SYMBOL_GPL(mtd_get_user_prot_info);
920
921int mtd_read_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len,
922 size_t *retlen, u_char *buf)
923{
924 *retlen = 0;
925 if (!mtd->_read_user_prot_reg)
926 return -EOPNOTSUPP;
927 if (!len)
928 return 0;
929 return mtd->_read_user_prot_reg(mtd, from, len, retlen, buf);
930}
931EXPORT_SYMBOL_GPL(mtd_read_user_prot_reg);
932
933int mtd_write_user_prot_reg(struct mtd_info *mtd, loff_t to, size_t len,
934 size_t *retlen, u_char *buf)
935{
936 *retlen = 0;
937 if (!mtd->_write_user_prot_reg)
938 return -EOPNOTSUPP;
939 if (!len)
940 return 0;
941 return mtd->_write_user_prot_reg(mtd, to, len, retlen, buf);
942}
943EXPORT_SYMBOL_GPL(mtd_write_user_prot_reg);
944
945int mtd_lock_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len)
946{
947 if (!mtd->_lock_user_prot_reg)
948 return -EOPNOTSUPP;
949 if (!len)
950 return 0;
951 return mtd->_lock_user_prot_reg(mtd, from, len);
952}
953EXPORT_SYMBOL_GPL(mtd_lock_user_prot_reg);
954
Artem Bityutskiy8273a0c2012-02-03 14:34:14 +0200955/* Chip-supported device locking */
956int mtd_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
957{
958 if (!mtd->_lock)
959 return -EOPNOTSUPP;
960 if (ofs < 0 || ofs > mtd->size || len > mtd->size - ofs)
961 return -EINVAL;
Artem Bityutskiybcb1d232012-02-06 13:27:43 +0200962 if (!len)
963 return 0;
Artem Bityutskiy8273a0c2012-02-03 14:34:14 +0200964 return mtd->_lock(mtd, ofs, len);
965}
966EXPORT_SYMBOL_GPL(mtd_lock);
967
968int mtd_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
969{
970 if (!mtd->_unlock)
971 return -EOPNOTSUPP;
972 if (ofs < 0 || ofs > mtd->size || len > mtd->size - ofs)
973 return -EINVAL;
Artem Bityutskiybcb1d232012-02-06 13:27:43 +0200974 if (!len)
975 return 0;
Artem Bityutskiy8273a0c2012-02-03 14:34:14 +0200976 return mtd->_unlock(mtd, ofs, len);
977}
978EXPORT_SYMBOL_GPL(mtd_unlock);
979
980int mtd_is_locked(struct mtd_info *mtd, loff_t ofs, uint64_t len)
981{
982 if (!mtd->_is_locked)
983 return -EOPNOTSUPP;
984 if (ofs < 0 || ofs > mtd->size || len > mtd->size - ofs)
985 return -EINVAL;
Artem Bityutskiybcb1d232012-02-06 13:27:43 +0200986 if (!len)
987 return 0;
Artem Bityutskiy8273a0c2012-02-03 14:34:14 +0200988 return mtd->_is_locked(mtd, ofs, len);
989}
990EXPORT_SYMBOL_GPL(mtd_is_locked);
991
992int mtd_block_isbad(struct mtd_info *mtd, loff_t ofs)
993{
994 if (!mtd->_block_isbad)
995 return 0;
996 if (ofs < 0 || ofs > mtd->size)
997 return -EINVAL;
998 return mtd->_block_isbad(mtd, ofs);
999}
1000EXPORT_SYMBOL_GPL(mtd_block_isbad);
1001
1002int mtd_block_markbad(struct mtd_info *mtd, loff_t ofs)
1003{
1004 if (!mtd->_block_markbad)
1005 return -EOPNOTSUPP;
1006 if (ofs < 0 || ofs > mtd->size)
1007 return -EINVAL;
Artem Bityutskiy664addc2012-02-03 18:13:23 +02001008 if (!(mtd->flags & MTD_WRITEABLE))
1009 return -EROFS;
Artem Bityutskiy8273a0c2012-02-03 14:34:14 +02001010 return mtd->_block_markbad(mtd, ofs);
1011}
1012EXPORT_SYMBOL_GPL(mtd_block_markbad);
1013
1014/*
Artem Bityutskiy52b02032011-12-30 15:57:25 +02001015 * default_mtd_writev - the default writev method
1016 * @mtd: mtd device description object pointer
1017 * @vecs: the vectors to write
1018 * @count: count of vectors in @vecs
1019 * @to: the MTD device offset to write to
1020 * @retlen: on exit contains the count of bytes written to the MTD device.
1021 *
1022 * This function returns zero in case of success and a negative error code in
1023 * case of failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024 */
Artem Bityutskiy1dbebd32011-12-30 16:23:41 +02001025static int default_mtd_writev(struct mtd_info *mtd, const struct kvec *vecs,
1026 unsigned long count, loff_t to, size_t *retlen)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027{
1028 unsigned long i;
1029 size_t totlen = 0, thislen;
1030 int ret = 0;
1031
Artem Bityutskiy52b02032011-12-30 15:57:25 +02001032 for (i = 0; i < count; i++) {
1033 if (!vecs[i].iov_len)
1034 continue;
1035 ret = mtd_write(mtd, to, vecs[i].iov_len, &thislen,
1036 vecs[i].iov_base);
1037 totlen += thislen;
1038 if (ret || thislen != vecs[i].iov_len)
1039 break;
1040 to += vecs[i].iov_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041 }
Artem Bityutskiy52b02032011-12-30 15:57:25 +02001042 *retlen = totlen;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043 return ret;
1044}
Artem Bityutskiy1dbebd32011-12-30 16:23:41 +02001045
1046/*
1047 * mtd_writev - the vector-based MTD write method
1048 * @mtd: mtd device description object pointer
1049 * @vecs: the vectors to write
1050 * @count: count of vectors in @vecs
1051 * @to: the MTD device offset to write to
1052 * @retlen: on exit contains the count of bytes written to the MTD device.
1053 *
1054 * This function returns zero in case of success and a negative error code in
1055 * case of failure.
1056 */
1057int mtd_writev(struct mtd_info *mtd, const struct kvec *vecs,
1058 unsigned long count, loff_t to, size_t *retlen)
1059{
1060 *retlen = 0;
Artem Bityutskiy664addc2012-02-03 18:13:23 +02001061 if (!(mtd->flags & MTD_WRITEABLE))
1062 return -EROFS;
Artem Bityutskiy3c3c10b2012-01-30 14:58:32 +02001063 if (!mtd->_writev)
Artem Bityutskiy1dbebd32011-12-30 16:23:41 +02001064 return default_mtd_writev(mtd, vecs, count, to, retlen);
Artem Bityutskiy3c3c10b2012-01-30 14:58:32 +02001065 return mtd->_writev(mtd, vecs, count, to, retlen);
Artem Bityutskiy1dbebd32011-12-30 16:23:41 +02001066}
1067EXPORT_SYMBOL_GPL(mtd_writev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068
Grant Erickson33b53712011-04-08 08:51:32 -07001069/**
1070 * mtd_kmalloc_up_to - allocate a contiguous buffer up to the specified size
Artem Bityutskiy52b02032011-12-30 15:57:25 +02001071 * @mtd: mtd device description object pointer
1072 * @size: a pointer to the ideal or maximum size of the allocation, points
Grant Erickson33b53712011-04-08 08:51:32 -07001073 * to the actual allocation size on success.
1074 *
1075 * This routine attempts to allocate a contiguous kernel buffer up to
1076 * the specified size, backing off the size of the request exponentially
1077 * until the request succeeds or until the allocation size falls below
1078 * the system page size. This attempts to make sure it does not adversely
1079 * impact system performance, so when allocating more than one page, we
Rik van Rielc6543452012-10-08 16:28:21 -07001080 * ask the memory allocator to avoid re-trying.
Grant Erickson33b53712011-04-08 08:51:32 -07001081 *
1082 * Note, this function also makes sure that the allocated buffer is aligned to
1083 * the MTD device's min. I/O unit, i.e. the "mtd->writesize" value.
1084 *
1085 * This is called, for example by mtd_{read,write} and jffs2_scan_medium,
1086 * to handle smaller (i.e. degraded) buffer allocations under low- or
1087 * fragmented-memory situations where such reduced allocations, from a
1088 * requested ideal, are allowed.
1089 *
1090 * Returns a pointer to the allocated buffer on success; otherwise, NULL.
1091 */
1092void *mtd_kmalloc_up_to(const struct mtd_info *mtd, size_t *size)
1093{
Rik van Rielc6543452012-10-08 16:28:21 -07001094 gfp_t flags = __GFP_NOWARN | __GFP_WAIT | __GFP_NORETRY;
Grant Erickson33b53712011-04-08 08:51:32 -07001095 size_t min_alloc = max_t(size_t, mtd->writesize, PAGE_SIZE);
1096 void *kbuf;
1097
1098 *size = min_t(size_t, *size, KMALLOC_MAX_SIZE);
1099
1100 while (*size > min_alloc) {
1101 kbuf = kmalloc(*size, flags);
1102 if (kbuf)
1103 return kbuf;
1104
1105 *size >>= 1;
1106 *size = ALIGN(*size, mtd->writesize);
1107 }
1108
1109 /*
1110 * For the last resort allocation allow 'kmalloc()' to do all sorts of
1111 * things (write-back, dropping caches, etc) by using GFP_KERNEL.
1112 */
1113 return kmalloc(*size, GFP_KERNEL);
1114}
Grant Erickson33b53712011-04-08 08:51:32 -07001115EXPORT_SYMBOL_GPL(mtd_kmalloc_up_to);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001116
Pavel Machek2d2dce02006-03-31 02:29:49 -08001117#ifdef CONFIG_PROC_FS
1118
Linus Torvalds1da177e2005-04-16 15:20:36 -07001119/*====================================================================*/
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120/* Support for /proc/mtd */
1121
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122static struct proc_dir_entry *proc_mtd;
1123
Alexey Dobriyan447d9bd2011-05-13 23:34:19 +03001124static int mtd_proc_show(struct seq_file *m, void *v)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125{
Ben Hutchingsf1332ba2010-01-29 20:57:11 +00001126 struct mtd_info *mtd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127
Alexey Dobriyan447d9bd2011-05-13 23:34:19 +03001128 seq_puts(m, "dev: size erasesize name\n");
Ingo Molnar48b19262006-03-31 02:29:41 -08001129 mutex_lock(&mtd_table_mutex);
Ben Hutchingsf1332ba2010-01-29 20:57:11 +00001130 mtd_for_each_device(mtd) {
Alexey Dobriyan447d9bd2011-05-13 23:34:19 +03001131 seq_printf(m, "mtd%d: %8.8llx %8.8x \"%s\"\n",
1132 mtd->index, (unsigned long long)mtd->size,
1133 mtd->erasesize, mtd->name);
Wanlong Gaod5ca5122011-05-20 21:14:30 +08001134 }
Ingo Molnar48b19262006-03-31 02:29:41 -08001135 mutex_unlock(&mtd_table_mutex);
Wanlong Gaod5ca5122011-05-20 21:14:30 +08001136 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001137}
1138
Alexey Dobriyan447d9bd2011-05-13 23:34:19 +03001139static int mtd_proc_open(struct inode *inode, struct file *file)
1140{
1141 return single_open(file, mtd_proc_show, NULL);
1142}
1143
1144static const struct file_operations mtd_proc_ops = {
1145 .open = mtd_proc_open,
1146 .read = seq_read,
1147 .llseek = seq_lseek,
1148 .release = single_release,
1149};
Kevin Cernekee45b09072009-04-04 11:03:04 -07001150#endif /* CONFIG_PROC_FS */
1151
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152/*====================================================================*/
1153/* Init code */
1154
Jens Axboe0661b1a2010-04-27 09:49:47 +02001155static int __init mtd_bdi_init(struct backing_dev_info *bdi, const char *name)
1156{
1157 int ret;
1158
1159 ret = bdi_init(bdi);
1160 if (!ret)
1161 ret = bdi_register(bdi, NULL, name);
1162
1163 if (ret)
1164 bdi_destroy(bdi);
1165
1166 return ret;
1167}
1168
Linus Torvalds1da177e2005-04-16 15:20:36 -07001169static int __init init_mtd(void)
1170{
David Woodhouse15bce402009-04-05 07:40:58 -07001171 int ret;
Kevin Cernekee694bb7f2009-04-03 13:00:45 -07001172
Jens Axboe0661b1a2010-04-27 09:49:47 +02001173 ret = class_register(&mtd_class);
1174 if (ret)
1175 goto err_reg;
1176
1177 ret = mtd_bdi_init(&mtd_bdi_unmappable, "mtd-unmap");
1178 if (ret)
1179 goto err_bdi1;
1180
1181 ret = mtd_bdi_init(&mtd_bdi_ro_mappable, "mtd-romap");
1182 if (ret)
1183 goto err_bdi2;
1184
1185 ret = mtd_bdi_init(&mtd_bdi_rw_mappable, "mtd-rwmap");
1186 if (ret)
1187 goto err_bdi3;
1188
Kevin Cernekee45b09072009-04-04 11:03:04 -07001189#ifdef CONFIG_PROC_FS
Alexey Dobriyan447d9bd2011-05-13 23:34:19 +03001190 proc_mtd = proc_create("mtd", 0, NULL, &mtd_proc_ops);
Kevin Cernekee45b09072009-04-04 11:03:04 -07001191#endif /* CONFIG_PROC_FS */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192 return 0;
Jens Axboe0661b1a2010-04-27 09:49:47 +02001193
1194err_bdi3:
1195 bdi_destroy(&mtd_bdi_ro_mappable);
1196err_bdi2:
1197 bdi_destroy(&mtd_bdi_unmappable);
1198err_bdi1:
1199 class_unregister(&mtd_class);
1200err_reg:
1201 pr_err("Error registering mtd class or bdi: %d\n", ret);
1202 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001203}
1204
1205static void __exit cleanup_mtd(void)
1206{
Kevin Cernekee45b09072009-04-04 11:03:04 -07001207#ifdef CONFIG_PROC_FS
Wanlong Gaod5ca5122011-05-20 21:14:30 +08001208 if (proc_mtd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209 remove_proc_entry( "mtd", NULL);
Kevin Cernekee45b09072009-04-04 11:03:04 -07001210#endif /* CONFIG_PROC_FS */
David Woodhouse15bce402009-04-05 07:40:58 -07001211 class_unregister(&mtd_class);
Jens Axboe0661b1a2010-04-27 09:49:47 +02001212 bdi_destroy(&mtd_bdi_unmappable);
1213 bdi_destroy(&mtd_bdi_ro_mappable);
1214 bdi_destroy(&mtd_bdi_rw_mappable);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215}
1216
1217module_init(init_mtd);
1218module_exit(cleanup_mtd);
1219
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220MODULE_LICENSE("GPL");
1221MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org>");
1222MODULE_DESCRIPTION("Core MTD registration and access routines");