mtdcore.c 21.8 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4
/*
 * Core registration and callback routines for MTD
 * drivers and users.
 *
D
David Woodhouse 已提交
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
 * Copyright © 1999-2010 David Woodhouse <dwmw2@infradead.org>
 * Copyright © 2006      Red Hat UK Limited 
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
L
Linus Torvalds 已提交
22 23 24 25 26
 */

#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/ptrace.h>
27
#include <linux/seq_file.h>
L
Linus Torvalds 已提交
28 29 30 31
#include <linux/string.h>
#include <linux/timer.h>
#include <linux/major.h>
#include <linux/fs.h>
32
#include <linux/err.h>
L
Linus Torvalds 已提交
33 34 35
#include <linux/ioctl.h>
#include <linux/init.h>
#include <linux/proc_fs.h>
36
#include <linux/idr.h>
37
#include <linux/backing-dev.h>
T
Tejun Heo 已提交
38
#include <linux/gfp.h>
L
Linus Torvalds 已提交
39 40

#include <linux/mtd/mtd.h>
41
#include <linux/mtd/partitions.h>
L
Linus Torvalds 已提交
42

43
#include "mtdcore.h"
44 45 46 47
/*
 * backing device capabilities for non-mappable devices (such as NAND flash)
 * - permits private mappings, copies are taken of the data
 */
48
static struct backing_dev_info mtd_bdi_unmappable = {
49 50 51 52 53 54 55 56
	.capabilities	= BDI_CAP_MAP_COPY,
};

/*
 * backing device capabilities for R/O mappable devices (such as ROM)
 * - permits private mappings, copies are taken of the data
 * - permits non-writable shared mappings
 */
57
static struct backing_dev_info mtd_bdi_ro_mappable = {
58 59 60 61 62 63 64 65 66
	.capabilities	= (BDI_CAP_MAP_COPY | BDI_CAP_MAP_DIRECT |
			   BDI_CAP_EXEC_MAP | BDI_CAP_READ_MAP),
};

/*
 * backing device capabilities for writable mappable devices (such as RAM)
 * - permits private mappings, copies are taken of the data
 * - permits non-writable shared mappings
 */
67
static struct backing_dev_info mtd_bdi_rw_mappable = {
68 69 70 71
	.capabilities	= (BDI_CAP_MAP_COPY | BDI_CAP_MAP_DIRECT |
			   BDI_CAP_EXEC_MAP | BDI_CAP_READ_MAP |
			   BDI_CAP_WRITE_MAP),
};
72

73 74 75 76 77 78 79 80 81
static int mtd_cls_suspend(struct device *dev, pm_message_t state);
static int mtd_cls_resume(struct device *dev);

static struct class mtd_class = {
	.name = "mtd",
	.owner = THIS_MODULE,
	.suspend = mtd_cls_suspend,
	.resume = mtd_cls_resume,
};
D
David Brownell 已提交
82

83 84
static DEFINE_IDR(mtd_idr);

85
/* These are exported solely for the purpose of mtd_blkdevs.c. You
L
Linus Torvalds 已提交
86
   should not use them for _anything_ else */
I
Ingo Molnar 已提交
87
DEFINE_MUTEX(mtd_table_mutex);
L
Linus Torvalds 已提交
88
EXPORT_SYMBOL_GPL(mtd_table_mutex);
89 90 91 92 93 94

struct mtd_info *__mtd_next_device(int i)
{
	return idr_get_next(&mtd_idr, &i);
}
EXPORT_SYMBOL_GPL(__mtd_next_device);
L
Linus Torvalds 已提交
95 96 97

static LIST_HEAD(mtd_notifiers);

D
David Brownell 已提交
98 99 100 101 102 103 104 105 106 107 108 109

#if defined(CONFIG_MTD_CHAR) || defined(CONFIG_MTD_CHAR_MODULE)
#define MTD_DEVT(index) MKDEV(MTD_CHAR_MAJOR, (index)*2)
#else
#define MTD_DEVT(index) 0
#endif

/* REVISIT once MTD uses the driver model better, whoever allocates
 * the mtd_info will probably want to use the release() hook...
 */
static void mtd_release(struct device *dev)
{
A
Artem Bityutskiy 已提交
110 111
	struct mtd_info *mtd = dev_get_drvdata(dev);
	dev_t index = MTD_DEVT(mtd->index);
D
David Brownell 已提交
112 113

	/* remove /dev/mtdXro node if needed */
114
	if (index)
115 116 117 118 119
		device_destroy(&mtd_class, index + 1);
}

static int mtd_cls_suspend(struct device *dev, pm_message_t state)
{
A
Artem Bityutskiy 已提交
120
	struct mtd_info *mtd = dev_get_drvdata(dev);
121 122

	if (mtd && mtd->suspend)
123
		return mtd_suspend(mtd);
124 125 126 127 128 129
	else
		return 0;
}

static int mtd_cls_resume(struct device *dev)
{
A
Artem Bityutskiy 已提交
130
	struct mtd_info *mtd = dev_get_drvdata(dev);
131

132
	if (mtd && mtd->resume)
133
		mtd_resume(mtd);
134
	return 0;
D
David Brownell 已提交
135 136 137 138 139
}

static ssize_t mtd_type_show(struct device *dev,
		struct device_attribute *attr, char *buf)
{
A
Artem Bityutskiy 已提交
140
	struct mtd_info *mtd = dev_get_drvdata(dev);
D
David Brownell 已提交
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
	char *type;

	switch (mtd->type) {
	case MTD_ABSENT:
		type = "absent";
		break;
	case MTD_RAM:
		type = "ram";
		break;
	case MTD_ROM:
		type = "rom";
		break;
	case MTD_NORFLASH:
		type = "nor";
		break;
	case MTD_NANDFLASH:
		type = "nand";
		break;
	case MTD_DATAFLASH:
		type = "dataflash";
		break;
	case MTD_UBIVOLUME:
		type = "ubi";
		break;
	default:
		type = "unknown";
	}

	return snprintf(buf, PAGE_SIZE, "%s\n", type);
}
171 172 173 174 175
static DEVICE_ATTR(type, S_IRUGO, mtd_type_show, NULL);

static ssize_t mtd_flags_show(struct device *dev,
		struct device_attribute *attr, char *buf)
{
A
Artem Bityutskiy 已提交
176
	struct mtd_info *mtd = dev_get_drvdata(dev);
177 178 179 180 181 182 183 184 185

	return snprintf(buf, PAGE_SIZE, "0x%lx\n", (unsigned long)mtd->flags);

}
static DEVICE_ATTR(flags, S_IRUGO, mtd_flags_show, NULL);

static ssize_t mtd_size_show(struct device *dev,
		struct device_attribute *attr, char *buf)
{
A
Artem Bityutskiy 已提交
186
	struct mtd_info *mtd = dev_get_drvdata(dev);
187 188 189 190 191 192 193 194 195 196

	return snprintf(buf, PAGE_SIZE, "%llu\n",
		(unsigned long long)mtd->size);

}
static DEVICE_ATTR(size, S_IRUGO, mtd_size_show, NULL);

static ssize_t mtd_erasesize_show(struct device *dev,
		struct device_attribute *attr, char *buf)
{
A
Artem Bityutskiy 已提交
197
	struct mtd_info *mtd = dev_get_drvdata(dev);
198 199 200 201 202 203 204 205 206

	return snprintf(buf, PAGE_SIZE, "%lu\n", (unsigned long)mtd->erasesize);

}
static DEVICE_ATTR(erasesize, S_IRUGO, mtd_erasesize_show, NULL);

static ssize_t mtd_writesize_show(struct device *dev,
		struct device_attribute *attr, char *buf)
{
A
Artem Bityutskiy 已提交
207
	struct mtd_info *mtd = dev_get_drvdata(dev);
208 209 210 211 212 213

	return snprintf(buf, PAGE_SIZE, "%lu\n", (unsigned long)mtd->writesize);

}
static DEVICE_ATTR(writesize, S_IRUGO, mtd_writesize_show, NULL);

214 215 216
static ssize_t mtd_subpagesize_show(struct device *dev,
		struct device_attribute *attr, char *buf)
{
A
Artem Bityutskiy 已提交
217
	struct mtd_info *mtd = dev_get_drvdata(dev);
218 219 220 221 222 223 224
	unsigned int subpagesize = mtd->writesize >> mtd->subpage_sft;

	return snprintf(buf, PAGE_SIZE, "%u\n", subpagesize);

}
static DEVICE_ATTR(subpagesize, S_IRUGO, mtd_subpagesize_show, NULL);

225 226 227
static ssize_t mtd_oobsize_show(struct device *dev,
		struct device_attribute *attr, char *buf)
{
A
Artem Bityutskiy 已提交
228
	struct mtd_info *mtd = dev_get_drvdata(dev);
229 230 231 232 233 234 235 236 237

	return snprintf(buf, PAGE_SIZE, "%lu\n", (unsigned long)mtd->oobsize);

}
static DEVICE_ATTR(oobsize, S_IRUGO, mtd_oobsize_show, NULL);

static ssize_t mtd_numeraseregions_show(struct device *dev,
		struct device_attribute *attr, char *buf)
{
A
Artem Bityutskiy 已提交
238
	struct mtd_info *mtd = dev_get_drvdata(dev);
239 240 241 242 243 244 245 246 247 248

	return snprintf(buf, PAGE_SIZE, "%u\n", mtd->numeraseregions);

}
static DEVICE_ATTR(numeraseregions, S_IRUGO, mtd_numeraseregions_show,
	NULL);

static ssize_t mtd_name_show(struct device *dev,
		struct device_attribute *attr, char *buf)
{
A
Artem Bityutskiy 已提交
249
	struct mtd_info *mtd = dev_get_drvdata(dev);
250 251 252 253 254

	return snprintf(buf, PAGE_SIZE, "%s\n", mtd->name);

}
static DEVICE_ATTR(name, S_IRUGO, mtd_name_show, NULL);
D
David Brownell 已提交
255 256

static struct attribute *mtd_attrs[] = {
257 258 259 260 261
	&dev_attr_type.attr,
	&dev_attr_flags.attr,
	&dev_attr_size.attr,
	&dev_attr_erasesize.attr,
	&dev_attr_writesize.attr,
262
	&dev_attr_subpagesize.attr,
263 264 265
	&dev_attr_oobsize.attr,
	&dev_attr_numeraseregions.attr,
	&dev_attr_name.attr,
D
David Brownell 已提交
266 267 268
	NULL,
};

H
H Hartley Sweeten 已提交
269
static struct attribute_group mtd_group = {
D
David Brownell 已提交
270 271 272
	.attrs		= mtd_attrs,
};

273
static const struct attribute_group *mtd_groups[] = {
D
David Brownell 已提交
274 275 276 277 278 279 280 281 282 283
	&mtd_group,
	NULL,
};

static struct device_type mtd_devtype = {
	.name		= "mtd",
	.groups		= mtd_groups,
	.release	= mtd_release,
};

L
Linus Torvalds 已提交
284 285 286 287 288 289 290
/**
 *	add_mtd_device - register an MTD device
 *	@mtd: pointer to new MTD device info structure
 *
 *	Add a device to the list of MTD devices present in the system, and
 *	notify each currently active MTD 'user' of its arrival. Returns
 *	zero on success or 1 on failure, which currently will only happen
291
 *	if there is insufficient memory or a sysfs error.
L
Linus Torvalds 已提交
292 293 294 295
 */

int add_mtd_device(struct mtd_info *mtd)
{
296 297
	struct mtd_notifier *not;
	int i, error;
L
Linus Torvalds 已提交
298

299 300 301 302 303 304 305 306 307 308 309 310 311 312
	if (!mtd->backing_dev_info) {
		switch (mtd->type) {
		case MTD_RAM:
			mtd->backing_dev_info = &mtd_bdi_rw_mappable;
			break;
		case MTD_ROM:
			mtd->backing_dev_info = &mtd_bdi_ro_mappable;
			break;
		default:
			mtd->backing_dev_info = &mtd_bdi_unmappable;
			break;
		}
	}

313
	BUG_ON(mtd->writesize == 0);
I
Ingo Molnar 已提交
314
	mutex_lock(&mtd_table_mutex);
L
Linus Torvalds 已提交
315

316 317 318 319 320
	do {
		if (!idr_pre_get(&mtd_idr, GFP_KERNEL))
			goto fail_locked;
		error = idr_get_new(&mtd_idr, mtd, &i);
	} while (error == -EAGAIN);
321

322 323
	if (error)
		goto fail_locked;
D
David Brownell 已提交
324

325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
	mtd->index = i;
	mtd->usecount = 0;

	if (is_power_of_2(mtd->erasesize))
		mtd->erasesize_shift = ffs(mtd->erasesize) - 1;
	else
		mtd->erasesize_shift = 0;

	if (is_power_of_2(mtd->writesize))
		mtd->writesize_shift = ffs(mtd->writesize) - 1;
	else
		mtd->writesize_shift = 0;

	mtd->erasesize_mask = (1 << mtd->erasesize_shift) - 1;
	mtd->writesize_mask = (1 << mtd->writesize_shift) - 1;

	/* Some chips always power up locked. Unlock them now */
	if ((mtd->flags & MTD_WRITEABLE)
	    && (mtd->flags & MTD_POWERUP_LOCK) && mtd->unlock) {
344
		if (mtd_unlock(mtd, 0, mtd->size))
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365
			printk(KERN_WARNING
			       "%s: unlock failed, writes may not work\n",
			       mtd->name);
	}

	/* Caller should have set dev.parent to match the
	 * physical device.
	 */
	mtd->dev.type = &mtd_devtype;
	mtd->dev.class = &mtd_class;
	mtd->dev.devt = MTD_DEVT(i);
	dev_set_name(&mtd->dev, "mtd%d", i);
	dev_set_drvdata(&mtd->dev, mtd);
	if (device_register(&mtd->dev) != 0)
		goto fail_added;

	if (MTD_DEVT(i))
		device_create(&mtd_class, mtd->dev.parent,
			      MTD_DEVT(i) + 1,
			      NULL, "mtd%dro", i);

366
	pr_debug("mtd: Giving out device %d to %s\n", i, mtd->name);
367 368 369 370 371 372 373 374 375 376 377 378
	/* No need to get a refcount on the module containing
	   the notifier, since we hold the mtd_table_mutex */
	list_for_each_entry(not, &mtd_notifiers, list)
		not->add(mtd);

	mutex_unlock(&mtd_table_mutex);
	/* We _know_ we aren't being removed, because
	   our caller is still holding us here. So none
	   of this try_ nonsense, and no bitching about it
	   either. :) */
	__module_get(THIS_MODULE);
	return 0;
379

380 381 382
fail_added:
	idr_remove(&mtd_idr, i);
fail_locked:
I
Ingo Molnar 已提交
383
	mutex_unlock(&mtd_table_mutex);
L
Linus Torvalds 已提交
384 385 386 387 388 389 390 391 392 393 394 395 396
	return 1;
}

/**
 *	del_mtd_device - unregister an MTD device
 *	@mtd: pointer to MTD device info structure
 *
 *	Remove a device from the list of MTD devices present in the system,
 *	and notify each currently active MTD 'user' of its departure.
 *	Returns zero on success or 1 on failure, which currently will happen
 *	if the requested device does not appear to be present in the list.
 */

397
int del_mtd_device(struct mtd_info *mtd)
L
Linus Torvalds 已提交
398 399
{
	int ret;
400
	struct mtd_notifier *not;
401

I
Ingo Molnar 已提交
402
	mutex_lock(&mtd_table_mutex);
L
Linus Torvalds 已提交
403

404
	if (idr_find(&mtd_idr, mtd->index) != mtd) {
L
Linus Torvalds 已提交
405
		ret = -ENODEV;
406 407 408 409 410 411 412 413 414
		goto out_error;
	}

	/* No need to get a refcount on the module containing
		the notifier, since we hold the mtd_table_mutex */
	list_for_each_entry(not, &mtd_notifiers, list)
		not->remove(mtd);

	if (mtd->usecount) {
415
		printk(KERN_NOTICE "Removing MTD device #%d (%s) with use count %d\n",
L
Linus Torvalds 已提交
416 417 418
		       mtd->index, mtd->name, mtd->usecount);
		ret = -EBUSY;
	} else {
419 420
		device_unregister(&mtd->dev);

421
		idr_remove(&mtd_idr, mtd->index);
L
Linus Torvalds 已提交
422 423 424 425 426

		module_put(THIS_MODULE);
		ret = 0;
	}

427
out_error:
I
Ingo Molnar 已提交
428
	mutex_unlock(&mtd_table_mutex);
L
Linus Torvalds 已提交
429 430 431
	return ret;
}

432 433 434 435 436 437
/**
 * mtd_device_parse_register - parse partitions and register an MTD device.
 *
 * @mtd: the MTD device to register
 * @types: the list of MTD partition probes to try, see
 *         'parse_mtd_partitions()' for more information
438
 * @parser_data: MTD partition parser-specific data
439 440 441 442 443 444 445 446 447 448 449 450 451 452
 * @parts: fallback partition information to register, if parsing fails;
 *         only valid if %nr_parts > %0
 * @nr_parts: the number of partitions in parts, if zero then the full
 *            MTD device is registered if no partition info is found
 *
 * This function aggregates MTD partitions parsing (done by
 * 'parse_mtd_partitions()') and MTD device and partitions registering. It
 * basically follows the most common pattern found in many MTD drivers:
 *
 * * It first tries to probe partitions on MTD device @mtd using parsers
 *   specified in @types (if @types is %NULL, then the default list of parsers
 *   is used, see 'parse_mtd_partitions()' for more information). If none are
 *   found this functions tries to fallback to information specified in
 *   @parts/@nr_parts.
B
Brian Norris 已提交
453
 * * If any partitioning info was found, this function registers the found
454 455 456 457 458 459 460
 *   partitions.
 * * If no partitions were found this function just registers the MTD device
 *   @mtd and exits.
 *
 * Returns zero in case of success and a negative error code in case of failure.
 */
int mtd_device_parse_register(struct mtd_info *mtd, const char **types,
461
			      struct mtd_part_parser_data *parser_data,
462 463 464 465 466 467
			      const struct mtd_partition *parts,
			      int nr_parts)
{
	int err;
	struct mtd_partition *real_parts;

468
	err = parse_mtd_partitions(mtd, types, &real_parts, parser_data);
469
	if (err <= 0 && nr_parts && parts) {
470 471
		real_parts = kmemdup(parts, sizeof(*parts) * nr_parts,
				     GFP_KERNEL);
472
		if (!real_parts)
473
			err = -ENOMEM;
474 475
		else
			err = nr_parts;
476 477 478 479 480 481 482 483 484 485 486 487 488 489 490
	}

	if (err > 0) {
		err = add_mtd_partitions(mtd, real_parts, err);
		kfree(real_parts);
	} else if (err == 0) {
		err = add_mtd_device(mtd);
		if (err == 1)
			err = -ENODEV;
	}

	return err;
}
EXPORT_SYMBOL_GPL(mtd_device_parse_register);

491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511
/**
 * mtd_device_unregister - unregister an existing MTD device.
 *
 * @master: the MTD device to unregister.  This will unregister both the master
 *          and any partitions if registered.
 */
int mtd_device_unregister(struct mtd_info *master)
{
	int err;

	err = del_mtd_partitions(master);
	if (err)
		return err;

	if (!device_is_registered(&master->dev))
		return 0;

	return del_mtd_device(master);
}
EXPORT_SYMBOL_GPL(mtd_device_unregister);

L
Linus Torvalds 已提交
512 513 514 515 516 517 518 519 520 521
/**
 *	register_mtd_user - register a 'user' of MTD devices.
 *	@new: pointer to notifier info structure
 *
 *	Registers a pair of callbacks function to be called upon addition
 *	or removal of MTD devices. Causes the 'add' callback to be immediately
 *	invoked for each MTD device currently present in the system.
 */
void register_mtd_user (struct mtd_notifier *new)
{
522
	struct mtd_info *mtd;
L
Linus Torvalds 已提交
523

I
Ingo Molnar 已提交
524
	mutex_lock(&mtd_table_mutex);
L
Linus Torvalds 已提交
525 526 527

	list_add(&new->list, &mtd_notifiers);

528
	__module_get(THIS_MODULE);
529

530 531
	mtd_for_each_device(mtd)
		new->add(mtd);
L
Linus Torvalds 已提交
532

I
Ingo Molnar 已提交
533
	mutex_unlock(&mtd_table_mutex);
L
Linus Torvalds 已提交
534
}
535
EXPORT_SYMBOL_GPL(register_mtd_user);
L
Linus Torvalds 已提交
536 537

/**
538 539
 *	unregister_mtd_user - unregister a 'user' of MTD devices.
 *	@old: pointer to notifier info structure
L
Linus Torvalds 已提交
540 541 542 543 544 545 546 547
 *
 *	Removes a callback function pair from the list of 'users' to be
 *	notified upon addition or removal of MTD devices. Causes the
 *	'remove' callback to be immediately invoked for each MTD device
 *	currently present in the system.
 */
int unregister_mtd_user (struct mtd_notifier *old)
{
548
	struct mtd_info *mtd;
L
Linus Torvalds 已提交
549

I
Ingo Molnar 已提交
550
	mutex_lock(&mtd_table_mutex);
L
Linus Torvalds 已提交
551 552 553

	module_put(THIS_MODULE);

554 555
	mtd_for_each_device(mtd)
		old->remove(mtd);
556

L
Linus Torvalds 已提交
557
	list_del(&old->list);
I
Ingo Molnar 已提交
558
	mutex_unlock(&mtd_table_mutex);
L
Linus Torvalds 已提交
559 560
	return 0;
}
561
EXPORT_SYMBOL_GPL(unregister_mtd_user);
L
Linus Torvalds 已提交
562 563 564 565 566 567 568 569 570

/**
 *	get_mtd_device - obtain a validated handle for an MTD device
 *	@mtd: last known address of the required MTD device
 *	@num: internal device number of the required MTD device
 *
 *	Given a number and NULL address, return the num'th entry in the device
 *	table, if any.	Given an address and num == -1, search the device table
 *	for a device with that address and return if it's still present. Given
571 572
 *	both, return the num'th driver only if its address matches. Return
 *	error code if not.
L
Linus Torvalds 已提交
573 574 575
 */
struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num)
{
576 577
	struct mtd_info *ret = NULL, *other;
	int err = -ENODEV;
L
Linus Torvalds 已提交
578

I
Ingo Molnar 已提交
579
	mutex_lock(&mtd_table_mutex);
L
Linus Torvalds 已提交
580 581

	if (num == -1) {
582 583 584 585 586 587
		mtd_for_each_device(other) {
			if (other == mtd) {
				ret = mtd;
				break;
			}
		}
588 589
	} else if (num >= 0) {
		ret = idr_find(&mtd_idr, num);
L
Linus Torvalds 已提交
590 591 592 593
		if (mtd && mtd != ret)
			ret = NULL;
	}

594 595 596
	if (!ret) {
		ret = ERR_PTR(err);
		goto out;
A
Artem Bityutskiy 已提交
597
	}
L
Linus Torvalds 已提交
598

599 600 601 602
	err = __get_mtd_device(ret);
	if (err)
		ret = ERR_PTR(err);
out:
603 604
	mutex_unlock(&mtd_table_mutex);
	return ret;
605
}
606
EXPORT_SYMBOL_GPL(get_mtd_device);
L
Linus Torvalds 已提交
607

608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625

int __get_mtd_device(struct mtd_info *mtd)
{
	int err;

	if (!try_module_get(mtd->owner))
		return -ENODEV;

	if (mtd->get_device) {
		err = mtd->get_device(mtd);

		if (err) {
			module_put(mtd->owner);
			return err;
		}
	}
	mtd->usecount++;
	return 0;
L
Linus Torvalds 已提交
626
}
627
EXPORT_SYMBOL_GPL(__get_mtd_device);
L
Linus Torvalds 已提交
628

629 630 631 632 633 634 635 636 637 638
/**
 *	get_mtd_device_nm - obtain a validated handle for an MTD device by
 *	device name
 *	@name: MTD device name to open
 *
 * 	This function returns MTD device description structure in case of
 * 	success and an error code in case of failure.
 */
struct mtd_info *get_mtd_device_nm(const char *name)
{
639 640
	int err = -ENODEV;
	struct mtd_info *mtd = NULL, *other;
641 642 643

	mutex_lock(&mtd_table_mutex);

644 645 646
	mtd_for_each_device(other) {
		if (!strcmp(name, other->name)) {
			mtd = other;
647 648 649 650
			break;
		}
	}

A
Artem Bityutskiy 已提交
651
	if (!mtd)
652 653
		goto out_unlock;

654 655
	err = __get_mtd_device(mtd);
	if (err)
656 657
		goto out_unlock;

A
Artem Bityutskiy 已提交
658 659
	mutex_unlock(&mtd_table_mutex);
	return mtd;
660 661 662

out_unlock:
	mutex_unlock(&mtd_table_mutex);
A
Artem Bityutskiy 已提交
663
	return ERR_PTR(err);
664
}
665
EXPORT_SYMBOL_GPL(get_mtd_device_nm);
666

L
Linus Torvalds 已提交
667 668
void put_mtd_device(struct mtd_info *mtd)
{
I
Ingo Molnar 已提交
669
	mutex_lock(&mtd_table_mutex);
670 671 672 673
	__put_mtd_device(mtd);
	mutex_unlock(&mtd_table_mutex);

}
674
EXPORT_SYMBOL_GPL(put_mtd_device);
675 676 677 678 679 680

void __put_mtd_device(struct mtd_info *mtd)
{
	--mtd->usecount;
	BUG_ON(mtd->usecount < 0);

A
Artem Bityutskiy 已提交
681 682
	if (mtd->put_device)
		mtd->put_device(mtd);
L
Linus Torvalds 已提交
683 684 685

	module_put(mtd->owner);
}
686
EXPORT_SYMBOL_GPL(__put_mtd_device);
L
Linus Torvalds 已提交
687

688 689 690 691 692 693 694 695 696 697
/*
 * default_mtd_writev - the default writev method
 * @mtd: mtd device description object pointer
 * @vecs: the vectors to write
 * @count: count of vectors in @vecs
 * @to: the MTD device offset to write to
 * @retlen: on exit contains the count of bytes written to the MTD device.
 *
 * This function returns zero in case of success and a negative error code in
 * case of failure.
L
Linus Torvalds 已提交
698 699 700 701 702 703 704 705
 */
int default_mtd_writev(struct mtd_info *mtd, const struct kvec *vecs,
		       unsigned long count, loff_t to, size_t *retlen)
{
	unsigned long i;
	size_t totlen = 0, thislen;
	int ret = 0;

706 707 708 709 710 711 712 713 714
	for (i = 0; i < count; i++) {
		if (!vecs[i].iov_len)
			continue;
		ret = mtd_write(mtd, to, vecs[i].iov_len, &thislen,
				vecs[i].iov_base);
		totlen += thislen;
		if (ret || thislen != vecs[i].iov_len)
			break;
		to += vecs[i].iov_len;
L
Linus Torvalds 已提交
715
	}
716
	*retlen = totlen;
L
Linus Torvalds 已提交
717 718
	return ret;
}
719
EXPORT_SYMBOL_GPL(default_mtd_writev);
L
Linus Torvalds 已提交
720

721 722
/**
 * mtd_kmalloc_up_to - allocate a contiguous buffer up to the specified size
723 724
 * @mtd: mtd device description object pointer
 * @size: a pointer to the ideal or maximum size of the allocation, points
725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769
 *        to the actual allocation size on success.
 *
 * This routine attempts to allocate a contiguous kernel buffer up to
 * the specified size, backing off the size of the request exponentially
 * until the request succeeds or until the allocation size falls below
 * the system page size. This attempts to make sure it does not adversely
 * impact system performance, so when allocating more than one page, we
 * ask the memory allocator to avoid re-trying, swapping, writing back
 * or performing I/O.
 *
 * Note, this function also makes sure that the allocated buffer is aligned to
 * the MTD device's min. I/O unit, i.e. the "mtd->writesize" value.
 *
 * This is called, for example by mtd_{read,write} and jffs2_scan_medium,
 * to handle smaller (i.e. degraded) buffer allocations under low- or
 * fragmented-memory situations where such reduced allocations, from a
 * requested ideal, are allowed.
 *
 * Returns a pointer to the allocated buffer on success; otherwise, NULL.
 */
void *mtd_kmalloc_up_to(const struct mtd_info *mtd, size_t *size)
{
	gfp_t flags = __GFP_NOWARN | __GFP_WAIT |
		       __GFP_NORETRY | __GFP_NO_KSWAPD;
	size_t min_alloc = max_t(size_t, mtd->writesize, PAGE_SIZE);
	void *kbuf;

	*size = min_t(size_t, *size, KMALLOC_MAX_SIZE);

	while (*size > min_alloc) {
		kbuf = kmalloc(*size, flags);
		if (kbuf)
			return kbuf;

		*size >>= 1;
		*size = ALIGN(*size, mtd->writesize);
	}

	/*
	 * For the last resort allocation allow 'kmalloc()' to do all sorts of
	 * things (write-back, dropping caches, etc) by using GFP_KERNEL.
	 */
	return kmalloc(*size, GFP_KERNEL);
}
EXPORT_SYMBOL_GPL(mtd_kmalloc_up_to);
L
Linus Torvalds 已提交
770

P
Pavel Machek 已提交
771 772
#ifdef CONFIG_PROC_FS

L
Linus Torvalds 已提交
773 774 775 776 777
/*====================================================================*/
/* Support for /proc/mtd */

static struct proc_dir_entry *proc_mtd;

778
static int mtd_proc_show(struct seq_file *m, void *v)
L
Linus Torvalds 已提交
779
{
780
	struct mtd_info *mtd;
L
Linus Torvalds 已提交
781

782
	seq_puts(m, "dev:    size   erasesize  name\n");
I
Ingo Molnar 已提交
783
	mutex_lock(&mtd_table_mutex);
784
	mtd_for_each_device(mtd) {
785 786 787
		seq_printf(m, "mtd%d: %8.8llx %8.8x \"%s\"\n",
			   mtd->index, (unsigned long long)mtd->size,
			   mtd->erasesize, mtd->name);
788
	}
I
Ingo Molnar 已提交
789
	mutex_unlock(&mtd_table_mutex);
790
	return 0;
L
Linus Torvalds 已提交
791 792
}

793 794 795 796 797 798 799 800 801 802 803
static int mtd_proc_open(struct inode *inode, struct file *file)
{
	return single_open(file, mtd_proc_show, NULL);
}

static const struct file_operations mtd_proc_ops = {
	.open		= mtd_proc_open,
	.read		= seq_read,
	.llseek		= seq_lseek,
	.release	= single_release,
};
804 805
#endif /* CONFIG_PROC_FS */

L
Linus Torvalds 已提交
806 807 808
/*====================================================================*/
/* Init code */

809 810 811 812 813 814 815 816 817 818 819 820 821 822
static int __init mtd_bdi_init(struct backing_dev_info *bdi, const char *name)
{
	int ret;

	ret = bdi_init(bdi);
	if (!ret)
		ret = bdi_register(bdi, NULL, name);

	if (ret)
		bdi_destroy(bdi);

	return ret;
}

L
Linus Torvalds 已提交
823 824
static int __init init_mtd(void)
{
825
	int ret;
826

827
	ret = class_register(&mtd_class);
828 829 830 831 832 833 834 835 836 837 838 839 840 841
	if (ret)
		goto err_reg;

	ret = mtd_bdi_init(&mtd_bdi_unmappable, "mtd-unmap");
	if (ret)
		goto err_bdi1;

	ret = mtd_bdi_init(&mtd_bdi_ro_mappable, "mtd-romap");
	if (ret)
		goto err_bdi2;

	ret = mtd_bdi_init(&mtd_bdi_rw_mappable, "mtd-rwmap");
	if (ret)
		goto err_bdi3;
842

843
#ifdef CONFIG_PROC_FS
844
	proc_mtd = proc_create("mtd", 0, NULL, &mtd_proc_ops);
845
#endif /* CONFIG_PROC_FS */
L
Linus Torvalds 已提交
846
	return 0;
847 848 849 850 851 852 853 854 855 856

err_bdi3:
	bdi_destroy(&mtd_bdi_ro_mappable);
err_bdi2:
	bdi_destroy(&mtd_bdi_unmappable);
err_bdi1:
	class_unregister(&mtd_class);
err_reg:
	pr_err("Error registering mtd class or bdi: %d\n", ret);
	return ret;
L
Linus Torvalds 已提交
857 858 859 860
}

static void __exit cleanup_mtd(void)
{
861
#ifdef CONFIG_PROC_FS
862
	if (proc_mtd)
L
Linus Torvalds 已提交
863
		remove_proc_entry( "mtd", NULL);
864
#endif /* CONFIG_PROC_FS */
865
	class_unregister(&mtd_class);
866 867 868
	bdi_destroy(&mtd_bdi_unmappable);
	bdi_destroy(&mtd_bdi_ro_mappable);
	bdi_destroy(&mtd_bdi_rw_mappable);
L
Linus Torvalds 已提交
869 870 871 872 873 874 875 876
}

module_init(init_mtd);
module_exit(cleanup_mtd);

MODULE_LICENSE("GPL");
MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org>");
MODULE_DESCRIPTION("Core MTD registration and access routines");