mtdcore.c 9.34 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 22
#include <linux/ioctl.h>
#include <linux/init.h>
#include <linux/mtd/compatmac.h>
#include <linux/proc_fs.h>

#include <linux/mtd/mtd.h>

23 24
#include "mtdcore.h"

25
/* These are exported solely for the purpose of mtd_blkdevs.c. You
Linus Torvalds's avatar
Linus Torvalds committed
26
   should not use them for _anything_ else */
Ingo Molnar's avatar
Ingo Molnar committed
27
DEFINE_MUTEX(mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
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;

49
	BUG_ON(mtd->writesize == 0);
Ingo Molnar's avatar
Ingo Molnar committed
50
	mutex_lock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
51 52 53

	for (i=0; i < MAX_MTD_DEVICES; i++)
		if (!mtd_table[i]) {
54
			struct mtd_notifier *not;
Linus Torvalds's avatar
Linus Torvalds committed
55 56 57 58 59

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

60 61
			/* Some chips always power up locked. Unlock them now */
			if ((mtd->flags & MTD_WRITEABLE)
62
			    && (mtd->flags & MTD_POWERUP_LOCK) && mtd->unlock) {
63 64 65 66 67 68 69
				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
70 71 72
			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 */
73
			list_for_each_entry(not, &mtd_notifiers, list) {
Linus Torvalds's avatar
Linus Torvalds committed
74 75
				not->add(mtd);
			}
76

Ingo Molnar's avatar
Ingo Molnar committed
77
			mutex_unlock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
78 79 80 81 82 83 84
			/* 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;
		}
85

Ingo Molnar's avatar
Ingo Molnar committed
86
	mutex_unlock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
	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;
103

Ingo Molnar's avatar
Ingo Molnar committed
104
	mutex_lock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
105 106 107 108

	if (mtd_table[mtd->index] != mtd) {
		ret = -ENODEV;
	} else if (mtd->usecount) {
109
		printk(KERN_NOTICE "Removing MTD device #%d (%s) with use count %d\n",
Linus Torvalds's avatar
Linus Torvalds committed
110 111 112
		       mtd->index, mtd->name, mtd->usecount);
		ret = -EBUSY;
	} else {
113
		struct mtd_notifier *not;
Linus Torvalds's avatar
Linus Torvalds committed
114 115 116

		/* No need to get a refcount on the module containing
		   the notifier, since we hold the mtd_table_mutex */
117
		list_for_each_entry(not, &mtd_notifiers, list) {
Linus Torvalds's avatar
Linus Torvalds committed
118 119 120 121 122 123 124 125 126
			not->remove(mtd);
		}

		mtd_table[mtd->index] = NULL;

		module_put(THIS_MODULE);
		ret = 0;
	}

Ingo Molnar's avatar
Ingo Molnar committed
127
	mutex_unlock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
	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
144
	mutex_lock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
145 146 147 148

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

 	__module_get(THIS_MODULE);
149

Linus Torvalds's avatar
Linus Torvalds committed
150 151 152 153
	for (i=0; i< MAX_MTD_DEVICES; i++)
		if (mtd_table[i])
			new->add(mtd_table[i]);

Ingo Molnar's avatar
Ingo Molnar committed
154
	mutex_unlock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
155 156 157
}

/**
158 159
 *	unregister_mtd_user - unregister a 'user' of MTD devices.
 *	@old: pointer to notifier info structure
Linus Torvalds's avatar
Linus Torvalds committed
160 161 162 163 164 165 166 167 168 169 170
 *
 *	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
171
	mutex_lock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
172 173 174 175 176 177

	module_put(THIS_MODULE);

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

Linus Torvalds's avatar
Linus Torvalds committed
179
	list_del(&old->list);
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 186 187 188 189 190 191 192
	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
193 194
 *	both, return the num'th driver only if its address matches. Return
 *	error code if not.
Linus Torvalds's avatar
Linus Torvalds committed
195
 */
196

Linus Torvalds's avatar
Linus Torvalds committed
197 198 199
struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num)
{
	struct mtd_info *ret = NULL;
200
	int i, err = -ENODEV;
Linus Torvalds's avatar
Linus Torvalds committed
201

Ingo Molnar's avatar
Ingo Molnar committed
202
	mutex_lock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
203 204 205 206 207 208 209 210 211 212 213

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

214 215 216
	if (!ret)
		goto out_unlock;

217
	if (!try_module_get(ret->owner))
218 219
		goto out_unlock;

220 221 222 223
	if (ret->get_device) {
		err = ret->get_device(ret);
		if (err)
			goto out_put;
224
	}
Linus Torvalds's avatar
Linus Torvalds committed
225

226
	ret->usecount++;
227 228
	mutex_unlock(&mtd_table_mutex);
	return ret;
Linus Torvalds's avatar
Linus Torvalds committed
229

230 231
out_put:
	module_put(ret->owner);
232
out_unlock:
Ingo Molnar's avatar
Ingo Molnar committed
233
	mutex_unlock(&mtd_table_mutex);
234
	return ERR_PTR(err);
Linus Torvalds's avatar
Linus Torvalds committed
235 236
}

237 238 239 240 241 242 243 244 245 246 247
/**
 *	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)
{
248 249
	int i, err = -ENODEV;
	struct mtd_info *mtd = NULL;
250 251 252 253 254 255 256 257 258 259

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

260
	if (!mtd)
261 262 263 264 265
		goto out_unlock;

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

266 267 268 269 270 271
	if (mtd->get_device) {
		err = mtd->get_device(mtd);
		if (err)
			goto out_put;
	}

272
	mtd->usecount++;
273 274
	mutex_unlock(&mtd_table_mutex);
	return mtd;
275

276 277
out_put:
	module_put(mtd->owner);
278 279
out_unlock:
	mutex_unlock(&mtd_table_mutex);
280
	return ERR_PTR(err);
281 282
}

Linus Torvalds's avatar
Linus Torvalds committed
283 284 285 286
void put_mtd_device(struct mtd_info *mtd)
{
	int c;

Ingo Molnar's avatar
Ingo Molnar committed
287
	mutex_lock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
288
	c = --mtd->usecount;
289 290
	if (mtd->put_device)
		mtd->put_device(mtd);
Ingo Molnar's avatar
Ingo Molnar committed
291
	mutex_unlock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
292 293 294 295 296 297
	BUG_ON(c < 0);

	module_put(mtd->owner);
}

/* default_mtd_writev - default mtd writev method for MTD devices that
298
 *			don't implement their own
Linus Torvalds's avatar
Linus Torvalds committed
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
 */

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

326 327 328 329 330 331 332 333
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
334

335 336
#ifdef CONFIG_PROC_FS

Linus Torvalds's avatar
Linus Torvalds committed
337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
/*====================================================================*/
/* 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;

	return sprintf(buf, "mtd%d: %8.8x %8.8x \"%s\"\n", i, this->size,
		       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
359
	mutex_lock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376

	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
377
	mutex_unlock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
        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);

403 404
#endif /* CONFIG_PROC_FS */

Linus Torvalds's avatar
Linus Torvalds committed
405 406 407 408

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