mtdcore.c 10 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"

26
/* These are exported solely for the purpose of mtd_blkdevs.c. You
Linus Torvalds's avatar
Linus Torvalds committed
27
   should not use them for _anything_ else */
Ingo Molnar's avatar
Ingo Molnar committed
28
DEFINE_MUTEX(mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
struct mtd_info *mtd_table[MAX_MTD_DEVICES];

EXPORT_SYMBOL_GPL(mtd_table_mutex);
EXPORT_SYMBOL_GPL(mtd_table);

static LIST_HEAD(mtd_notifiers);

/**
 *	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)
 */

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

50 51 52 53 54 55 56 57 58 59 60 61 62 63
	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;
		}
	}

64
	BUG_ON(mtd->writesize == 0);
Ingo Molnar's avatar
Ingo Molnar committed
65
	mutex_lock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
66 67 68

	for (i=0; i < MAX_MTD_DEVICES; i++)
		if (!mtd_table[i]) {
69
			struct mtd_notifier *not;
Linus Torvalds's avatar
Linus Torvalds committed
70 71 72 73 74

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

75 76 77 78 79 80 81 82 83 84 85 86 87
			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;

88 89
			/* Some chips always power up locked. Unlock them now */
			if ((mtd->flags & MTD_WRITEABLE)
90
			    && (mtd->flags & MTD_POWERUP_LOCK) && mtd->unlock) {
91 92 93 94 95 96 97
				if (mtd->unlock(mtd, 0, mtd->size))
					printk(KERN_WARNING
					       "%s: unlock failed, "
					       "writes may not work\n",
					       mtd->name);
			}

Linus Torvalds's avatar
Linus Torvalds committed
98 99 100
			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 */
101
			list_for_each_entry(not, &mtd_notifiers, list)
Linus Torvalds's avatar
Linus Torvalds committed
102
				not->add(mtd);
103

Ingo Molnar's avatar
Ingo Molnar committed
104
			mutex_unlock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
105 106 107 108 109 110 111
			/* 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;
		}
112

Ingo Molnar's avatar
Ingo Molnar committed
113
	mutex_unlock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
	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;
130

Ingo Molnar's avatar
Ingo Molnar committed
131
	mutex_lock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
132 133 134 135

	if (mtd_table[mtd->index] != mtd) {
		ret = -ENODEV;
	} else if (mtd->usecount) {
136
		printk(KERN_NOTICE "Removing MTD device #%d (%s) with use count %d\n",
Linus Torvalds's avatar
Linus Torvalds committed
137 138 139
		       mtd->index, mtd->name, mtd->usecount);
		ret = -EBUSY;
	} else {
140
		struct mtd_notifier *not;
Linus Torvalds's avatar
Linus Torvalds committed
141 142 143

		/* No need to get a refcount on the module containing
		   the notifier, since we hold the mtd_table_mutex */
144
		list_for_each_entry(not, &mtd_notifiers, list)
Linus Torvalds's avatar
Linus Torvalds committed
145 146 147 148 149 150 151 152
			not->remove(mtd);

		mtd_table[mtd->index] = NULL;

		module_put(THIS_MODULE);
		ret = 0;
	}

Ingo Molnar's avatar
Ingo Molnar committed
153
	mutex_unlock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
	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
170
	mutex_lock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
171 172 173 174

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

 	__module_get(THIS_MODULE);
175

Linus Torvalds's avatar
Linus Torvalds committed
176 177 178 179
	for (i=0; i< MAX_MTD_DEVICES; i++)
		if (mtd_table[i])
			new->add(mtd_table[i]);

Ingo Molnar's avatar
Ingo Molnar committed
180
	mutex_unlock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
181 182 183
}

/**
184 185
 *	unregister_mtd_user - unregister a 'user' of MTD devices.
 *	@old: pointer to notifier info structure
Linus Torvalds's avatar
Linus Torvalds committed
186 187 188 189 190 191 192 193 194 195 196
 *
 *	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
197
	mutex_lock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
198 199 200 201 202 203

	module_put(THIS_MODULE);

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

Linus Torvalds's avatar
Linus Torvalds committed
205
	list_del(&old->list);
Ingo Molnar's avatar
Ingo Molnar committed
206
	mutex_unlock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
207 208 209 210 211 212 213 214 215 216 217 218
	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
219 220
 *	both, return the num'th driver only if its address matches. Return
 *	error code if not.
Linus Torvalds's avatar
Linus Torvalds committed
221
 */
222

Linus Torvalds's avatar
Linus Torvalds committed
223 224 225
struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num)
{
	struct mtd_info *ret = NULL;
226
	int i, err = -ENODEV;
Linus Torvalds's avatar
Linus Torvalds committed
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 233 234 235 236 237 238 239

	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;
	}

240 241 242
	if (!ret)
		goto out_unlock;

243
	if (!try_module_get(ret->owner))
244 245
		goto out_unlock;

246 247 248 249
	if (ret->get_device) {
		err = ret->get_device(ret);
		if (err)
			goto out_put;
250
	}
Linus Torvalds's avatar
Linus Torvalds committed
251

252
	ret->usecount++;
253 254
	mutex_unlock(&mtd_table_mutex);
	return ret;
Linus Torvalds's avatar
Linus Torvalds committed
255

256 257
out_put:
	module_put(ret->owner);
258
out_unlock:
Ingo Molnar's avatar
Ingo Molnar committed
259
	mutex_unlock(&mtd_table_mutex);
260
	return ERR_PTR(err);
Linus Torvalds's avatar
Linus Torvalds committed
261 262
}

263 264 265 266 267 268 269 270 271 272 273
/**
 *	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)
{
274 275
	int i, err = -ENODEV;
	struct mtd_info *mtd = NULL;
276 277 278 279 280 281 282 283 284 285

	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;
		}
	}

286
	if (!mtd)
287 288 289 290 291
		goto out_unlock;

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

292 293 294 295 296 297
	if (mtd->get_device) {
		err = mtd->get_device(mtd);
		if (err)
			goto out_put;
	}

298
	mtd->usecount++;
299 300
	mutex_unlock(&mtd_table_mutex);
	return mtd;
301

302 303
out_put:
	module_put(mtd->owner);
304 305
out_unlock:
	mutex_unlock(&mtd_table_mutex);
306
	return ERR_PTR(err);
307 308
}

Linus Torvalds's avatar
Linus Torvalds committed
309 310 311 312
void put_mtd_device(struct mtd_info *mtd)
{
	int c;

Ingo Molnar's avatar
Ingo Molnar committed
313
	mutex_lock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
314
	c = --mtd->usecount;
315 316
	if (mtd->put_device)
		mtd->put_device(mtd);
Ingo Molnar's avatar
Ingo Molnar committed
317
	mutex_unlock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
318 319 320 321 322 323
	BUG_ON(c < 0);

	module_put(mtd->owner);
}

/* default_mtd_writev - default mtd writev method for MTD devices that
324
 *			don't implement their own
Linus Torvalds's avatar
Linus Torvalds committed
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351
 */

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;
}

352 353 354 355 356 357 358 359
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
360

361 362
#ifdef CONFIG_PROC_FS

Linus Torvalds's avatar
Linus Torvalds committed
363 364 365 366 367 368 369 370 371 372 373 374
/*====================================================================*/
/* 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;

375 376
	return sprintf(buf, "mtd%d: %8.8llx %8.8x \"%s\"\n", i,
		       (unsigned long long)this->size,
Linus Torvalds's avatar
Linus Torvalds committed
377 378 379 380 381 382 383 384 385
		       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
386
	mutex_lock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403

	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
404
	mutex_unlock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
        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);

430 431
#endif /* CONFIG_PROC_FS */

Linus Torvalds's avatar
Linus Torvalds committed
432 433 434 435

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