mtdcore.c 9.46 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1
/*
2
 * $Id: mtdcore.c,v 1.47 2005/11/07 11:14:20 gleixner Exp $
Linus Torvalds's avatar
Linus Torvalds committed
3 4 5 6 7 8 9 10 11 12 13 14 15 16
 *
 * 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>
17
#include <linux/err.h>
Linus Torvalds's avatar
Linus Torvalds committed
18 19 20 21 22 23 24
#include <linux/ioctl.h>
#include <linux/init.h>
#include <linux/mtd/compatmac.h>
#include <linux/proc_fs.h>

#include <linux/mtd/mtd.h>

25 26
#include "mtdcore.h"

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

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

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

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

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

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

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

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

	if (mtd_table[mtd->index] != mtd) {
		ret = -ENODEV;
	} else if (mtd->usecount) {
111
		printk(KERN_NOTICE "Removing MTD device #%d (%s) with use count %d\n",
Linus Torvalds's avatar
Linus Torvalds committed
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
		       mtd->index, mtd->name, mtd->usecount);
		ret = -EBUSY;
	} else {
		struct list_head *this;

		/* No need to get a refcount on the module containing
		   the notifier, since we hold the mtd_table_mutex */
		list_for_each(this, &mtd_notifiers) {
			struct mtd_notifier *not = list_entry(this, struct mtd_notifier, list);
			not->remove(mtd);
		}

		mtd_table[mtd->index] = NULL;

		module_put(THIS_MODULE);
		ret = 0;
	}

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

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

 	__module_get(THIS_MODULE);
152

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

Ingo Molnar's avatar
Ingo Molnar committed
157
	mutex_unlock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
158 159 160
}

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

	module_put(THIS_MODULE);

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

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

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

Ingo Molnar's avatar
Ingo Molnar committed
205
	mutex_lock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
206 207 208 209 210 211 212 213 214 215 216

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

217 218 219
	if (!ret)
		goto out_unlock;

220
	if (!try_module_get(ret->owner))
221 222
		goto out_unlock;

223 224 225 226
	if (ret->get_device) {
		err = ret->get_device(ret);
		if (err)
			goto out_put;
227
	}
Linus Torvalds's avatar
Linus Torvalds committed
228

229
	ret->usecount++;
230 231
	mutex_unlock(&mtd_table_mutex);
	return ret;
Linus Torvalds's avatar
Linus Torvalds committed
232

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

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

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

263
	if (!mtd)
264 265 266 267 268
		goto out_unlock;

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

269 270 271 272 273 274
	if (mtd->get_device) {
		err = mtd->get_device(mtd);
		if (err)
			goto out_put;
	}

275
	mtd->usecount++;
276 277
	mutex_unlock(&mtd_table_mutex);
	return mtd;
278

279 280
out_put:
	module_put(mtd->owner);
281 282
out_unlock:
	mutex_unlock(&mtd_table_mutex);
283
	return ERR_PTR(err);
284 285
}

Linus Torvalds's avatar
Linus Torvalds committed
286 287 288 289
void put_mtd_device(struct mtd_info *mtd)
{
	int c;

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

	module_put(mtd->owner);
}

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

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

329 330 331 332 333 334 335 336
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
337

338 339
#ifdef CONFIG_PROC_FS

Linus Torvalds's avatar
Linus Torvalds committed
340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361
/*====================================================================*/
/* 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
362
	mutex_lock(&mtd_table_mutex);
Linus Torvalds's avatar
Linus Torvalds committed
363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379

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

406 407
#endif /* CONFIG_PROC_FS */

Linus Torvalds's avatar
Linus Torvalds committed
408 409 410 411

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