mtdcore.c 12.3 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/*
 * Core registration and callback routines for MTD
 * drivers and users.
 *
 */

#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/ptrace.h>
#include <linux/slab.h>
#include <linux/string.h>
#include <linux/timer.h>
#include <linux/major.h>
#include <linux/fs.h>
15
#include <linux/err.h>
Linus Torvalds's avatar
Linus Torvalds committed
16 17 18 19 20 21
#include <linux/ioctl.h>
#include <linux/init.h>
#include <linux/mtd/compatmac.h>
#include <linux/proc_fs.h>

#include <linux/mtd/mtd.h>
22
#include "internal.h"
Linus Torvalds's avatar
Linus Torvalds committed
23

24 25
#include "mtdcore.h"

David Brownell's avatar
David Brownell committed
26 27 28

static struct class *mtd_class;

29
/* These are exported solely for the purpose of mtd_blkdevs.c. You
Linus Torvalds's avatar
Linus Torvalds committed
30
   should not use them for _anything_ else */
Ingo Molnar's avatar
Ingo Molnar committed
31
DEFINE_MUTEX(mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
32 33 34 35 36 37 38
struct mtd_info *mtd_table[MAX_MTD_DEVICES];

EXPORT_SYMBOL_GPL(mtd_table_mutex);
EXPORT_SYMBOL_GPL(mtd_table);

static LIST_HEAD(mtd_notifiers);

David Brownell's avatar
David Brownell committed
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114

#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)
{
	struct mtd_info *mtd = dev_to_mtd(dev);

	/* remove /dev/mtdXro node if needed */
	if (MTD_DEVT(mtd->index))
		device_destroy(mtd_class, MTD_DEVT(mtd->index) + 1);
}

static ssize_t mtd_type_show(struct device *dev,
		struct device_attribute *attr, char *buf)
{
	struct mtd_info *mtd = dev_to_mtd(dev);
	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);
}
static DEVICE_ATTR(mtd_type, S_IRUGO, mtd_type_show, NULL);

static struct attribute *mtd_attrs[] = {
	&dev_attr_mtd_type.attr,
	/* FIXME provide a /proc/mtd superset */
	NULL,
};

struct attribute_group mtd_group = {
	.attrs		= mtd_attrs,
};

struct attribute_group *mtd_groups[] = {
	&mtd_group,
	NULL,
};

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

Linus Torvalds's avatar
Linus Torvalds committed
115 116 117 118 119 120 121 122
/**
 *	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
 *	if the number of present devices exceeds MAX_MTD_DEVICES (i.e. 16)
David Brownell's avatar
David Brownell committed
123
 *	or there's a sysfs error.
Linus Torvalds's avatar
Linus Torvalds committed
124 125 126 127 128 129
 */

int add_mtd_device(struct mtd_info *mtd)
{
	int i;

130 131 132 133 134 135 136 137 138 139 140 141 142 143
	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;
		}
	}

144
	BUG_ON(mtd->writesize == 0);
Ingo Molnar's avatar
Ingo Molnar committed
145
	mutex_lock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
146 147 148

	for (i=0; i < MAX_MTD_DEVICES; i++)
		if (!mtd_table[i]) {
149
			struct mtd_notifier *not;
Linus Torvalds's avatar
Linus Torvalds committed
150 151 152 153 154

			mtd_table[i] = mtd;
			mtd->index = i;
			mtd->usecount = 0;

155 156 157 158 159 160 161 162 163 164 165 166 167
			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;

168 169
			/* Some chips always power up locked. Unlock them now */
			if ((mtd->flags & MTD_WRITEABLE)
170
			    && (mtd->flags & MTD_POWERUP_LOCK) && mtd->unlock) {
171 172 173 174 175 176 177
				if (mtd->unlock(mtd, 0, mtd->size))
					printk(KERN_WARNING
					       "%s: unlock failed, "
					       "writes may not work\n",
					       mtd->name);
			}

David Brownell's avatar
David Brownell committed
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
			/* 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);
			if (device_register(&mtd->dev) != 0) {
				mtd_table[i] = NULL;
				break;
			}

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

Linus Torvalds's avatar
Linus Torvalds committed
195 196 197
			DEBUG(0, "mtd: Giving out device %d to %s\n",i, mtd->name);
			/* No need to get a refcount on the module containing
			   the notifier, since we hold the mtd_table_mutex */
198
			list_for_each_entry(not, &mtd_notifiers, list)
Linus Torvalds's avatar
Linus Torvalds committed
199
				not->add(mtd);
200

Ingo Molnar's avatar
Ingo Molnar committed
201
			mutex_unlock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
202 203 204 205 206 207 208
			/* 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;
		}
209

Ingo Molnar's avatar
Ingo Molnar committed
210
	mutex_unlock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
	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.
 */

int del_mtd_device (struct mtd_info *mtd)
{
	int ret;
227

Ingo Molnar's avatar
Ingo Molnar committed
228
	mutex_lock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
229 230 231 232

	if (mtd_table[mtd->index] != mtd) {
		ret = -ENODEV;
	} else if (mtd->usecount) {
233
		printk(KERN_NOTICE "Removing MTD device #%d (%s) with use count %d\n",
Linus Torvalds's avatar
Linus Torvalds committed
234 235 236
		       mtd->index, mtd->name, mtd->usecount);
		ret = -EBUSY;
	} else {
237
		struct mtd_notifier *not;
Linus Torvalds's avatar
Linus Torvalds committed
238 239 240

		/* No need to get a refcount on the module containing
		   the notifier, since we hold the mtd_table_mutex */
241
		list_for_each_entry(not, &mtd_notifiers, list)
Linus Torvalds's avatar
Linus Torvalds committed
242 243 244 245 246 247 248 249
			not->remove(mtd);

		mtd_table[mtd->index] = NULL;

		module_put(THIS_MODULE);
		ret = 0;
	}

Ingo Molnar's avatar
Ingo Molnar committed
250
	mutex_unlock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
	return ret;
}

/**
 *	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)
{
	int i;

Ingo Molnar's avatar
Ingo Molnar committed
267
	mutex_lock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
268 269 270 271

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

 	__module_get(THIS_MODULE);
272

Linus Torvalds's avatar
Linus Torvalds committed
273 274 275 276
	for (i=0; i< MAX_MTD_DEVICES; i++)
		if (mtd_table[i])
			new->add(mtd_table[i]);

Ingo Molnar's avatar
Ingo Molnar committed
277
	mutex_unlock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
278 279 280
}

/**
281 282
 *	unregister_mtd_user - unregister a 'user' of MTD devices.
 *	@old: pointer to notifier info structure
Linus Torvalds's avatar
Linus Torvalds committed
283 284 285 286 287 288 289 290 291 292 293
 *
 *	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)
{
	int i;

Ingo Molnar's avatar
Ingo Molnar committed
294
	mutex_lock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
295 296 297 298 299 300

	module_put(THIS_MODULE);

	for (i=0; i< MAX_MTD_DEVICES; i++)
		if (mtd_table[i])
			old->remove(mtd_table[i]);
301

Linus Torvalds's avatar
Linus Torvalds committed
302
	list_del(&old->list);
Ingo Molnar's avatar
Ingo Molnar committed
303
	mutex_unlock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
304 305 306 307 308 309 310 311 312 313 314 315
	return 0;
}


/**
 *	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
316 317
 *	both, return the num'th driver only if its address matches. Return
 *	error code if not.
Linus Torvalds's avatar
Linus Torvalds committed
318
 */
319

Linus Torvalds's avatar
Linus Torvalds committed
320 321 322
struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num)
{
	struct mtd_info *ret = NULL;
323
	int i, err = -ENODEV;
Linus Torvalds's avatar
Linus Torvalds committed
324

Ingo Molnar's avatar
Ingo Molnar committed
325
	mutex_lock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
326 327 328 329 330 331 332 333 334 335 336

	if (num == -1) {
		for (i=0; i< MAX_MTD_DEVICES; i++)
			if (mtd_table[i] == mtd)
				ret = mtd_table[i];
	} else if (num < MAX_MTD_DEVICES) {
		ret = mtd_table[num];
		if (mtd && mtd != ret)
			ret = NULL;
	}

337 338 339
	if (!ret)
		goto out_unlock;

340
	if (!try_module_get(ret->owner))
341 342
		goto out_unlock;

343 344 345 346
	if (ret->get_device) {
		err = ret->get_device(ret);
		if (err)
			goto out_put;
347
	}
Linus Torvalds's avatar
Linus Torvalds committed
348

349
	ret->usecount++;
350 351
	mutex_unlock(&mtd_table_mutex);
	return ret;
Linus Torvalds's avatar
Linus Torvalds committed
352

353 354
out_put:
	module_put(ret->owner);
355
out_unlock:
Ingo Molnar's avatar
Ingo Molnar committed
356
	mutex_unlock(&mtd_table_mutex);
357
	return ERR_PTR(err);
Linus Torvalds's avatar
Linus Torvalds committed
358 359
}

360 361 362 363 364 365 366 367 368 369 370
/**
 *	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)
{
371 372
	int i, err = -ENODEV;
	struct mtd_info *mtd = NULL;
373 374 375 376 377 378 379 380 381 382

	mutex_lock(&mtd_table_mutex);

	for (i = 0; i < MAX_MTD_DEVICES; i++) {
		if (mtd_table[i] && !strcmp(name, mtd_table[i]->name)) {
			mtd = mtd_table[i];
			break;
		}
	}

383
	if (!mtd)
384 385 386 387 388
		goto out_unlock;

	if (!try_module_get(mtd->owner))
		goto out_unlock;

389 390 391 392 393 394
	if (mtd->get_device) {
		err = mtd->get_device(mtd);
		if (err)
			goto out_put;
	}

395
	mtd->usecount++;
396 397
	mutex_unlock(&mtd_table_mutex);
	return mtd;
398

399 400
out_put:
	module_put(mtd->owner);
401 402
out_unlock:
	mutex_unlock(&mtd_table_mutex);
403
	return ERR_PTR(err);
404 405
}

Linus Torvalds's avatar
Linus Torvalds committed
406 407 408 409
void put_mtd_device(struct mtd_info *mtd)
{
	int c;

Ingo Molnar's avatar
Ingo Molnar committed
410
	mutex_lock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
411
	c = --mtd->usecount;
412 413
	if (mtd->put_device)
		mtd->put_device(mtd);
Ingo Molnar's avatar
Ingo Molnar committed
414
	mutex_unlock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
415 416 417 418 419 420
	BUG_ON(c < 0);

	module_put(mtd->owner);
}

/* default_mtd_writev - default mtd writev method for MTD devices that
421
 *			don't implement their own
Linus Torvalds's avatar
Linus Torvalds committed
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448
 */

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;

	if(!mtd->write) {
		ret = -EROFS;
	} else {
		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;
		}
	}
	if (retlen)
		*retlen = totlen;
	return ret;
}

449 450 451 452 453 454 455 456
EXPORT_SYMBOL_GPL(add_mtd_device);
EXPORT_SYMBOL_GPL(del_mtd_device);
EXPORT_SYMBOL_GPL(get_mtd_device);
EXPORT_SYMBOL_GPL(get_mtd_device_nm);
EXPORT_SYMBOL_GPL(put_mtd_device);
EXPORT_SYMBOL_GPL(register_mtd_user);
EXPORT_SYMBOL_GPL(unregister_mtd_user);
EXPORT_SYMBOL_GPL(default_mtd_writev);
Linus Torvalds's avatar
Linus Torvalds committed
457

David Brownell's avatar
David Brownell committed
458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475
static int __init mtd_setup(void)
{
	mtd_class = class_create(THIS_MODULE, "mtd");

	if (IS_ERR(mtd_class)) {
		pr_err("Error creating mtd class.\n");
		return PTR_ERR(mtd_class);
	}
	return 0;
}
core_initcall(mtd_setup);

static void __exit mtd_teardown(void)
{
	class_destroy(mtd_class);
}
__exitcall(mtd_teardown);

476 477
#ifdef CONFIG_PROC_FS

Linus Torvalds's avatar
Linus Torvalds committed
478 479 480 481 482 483 484 485 486 487 488 489
/*====================================================================*/
/* Support for /proc/mtd */

static struct proc_dir_entry *proc_mtd;

static inline int mtd_proc_info (char *buf, int i)
{
	struct mtd_info *this = mtd_table[i];

	if (!this)
		return 0;

490 491
	return sprintf(buf, "mtd%d: %8.8llx %8.8x \"%s\"\n", i,
		       (unsigned long long)this->size,
Linus Torvalds's avatar
Linus Torvalds committed
492 493 494 495 496 497 498 499 500
		       this->erasesize, this->name);
}

static int mtd_read_proc (char *page, char **start, off_t off, int count,
			  int *eof, void *data_unused)
{
	int len, l, i;
        off_t   begin = 0;

Ingo Molnar's avatar
Ingo Molnar committed
501
	mutex_lock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518

	len = sprintf(page, "dev:    size   erasesize  name\n");
        for (i=0; i< MAX_MTD_DEVICES; i++) {

                l = mtd_proc_info(page + len, i);
                len += l;
                if (len+begin > off+count)
                        goto done;
                if (len+begin < off) {
                        begin += len;
                        len = 0;
                }
        }

        *eof = 1;

done:
Ingo Molnar's avatar
Ingo Molnar committed
519
	mutex_unlock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544
        if (off >= len+begin)
                return 0;
        *start = page + (off-begin);
        return ((count < begin+len-off) ? count : begin+len-off);
}

/*====================================================================*/
/* Init code */

static int __init init_mtd(void)
{
	if ((proc_mtd = create_proc_entry( "mtd", 0, NULL )))
		proc_mtd->read_proc = mtd_read_proc;
	return 0;
}

static void __exit cleanup_mtd(void)
{
        if (proc_mtd)
		remove_proc_entry( "mtd", NULL);
}

module_init(init_mtd);
module_exit(cleanup_mtd);

545 546
#endif /* CONFIG_PROC_FS */

Linus Torvalds's avatar
Linus Torvalds committed
547 548 549 550

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