mtdcore.c 9.7 KB
Newer Older
L
Linus Torvalds 已提交
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>
L
Linus Torvalds 已提交
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
L
Linus Torvalds 已提交
26
   should not use them for _anything_ else */
I
Ingo Molnar 已提交
27
DEFINE_MUTEX(mtd_table_mutex);
L
Linus Torvalds 已提交
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);
I
Ingo Molnar 已提交
50
	mutex_lock(&mtd_table_mutex);
L
Linus Torvalds 已提交
51 52 53

	for (i=0; i < MAX_MTD_DEVICES; i++)
		if (!mtd_table[i]) {
54
			struct mtd_notifier *not;
L
Linus Torvalds 已提交
55 56 57 58 59

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

60 61 62 63 64 65 66 67 68 69 70 71 72
			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;

73 74
			/* Some chips always power up locked. Unlock them now */
			if ((mtd->flags & MTD_WRITEABLE)
75
			    && (mtd->flags & MTD_POWERUP_LOCK) && mtd->unlock) {
76 77 78 79 80 81 82
				if (mtd->unlock(mtd, 0, mtd->size))
					printk(KERN_WARNING
					       "%s: unlock failed, "
					       "writes may not work\n",
					       mtd->name);
			}

L
Linus Torvalds 已提交
83 84 85
			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 */
86
			list_for_each_entry(not, &mtd_notifiers, list)
L
Linus Torvalds 已提交
87
				not->add(mtd);
88

I
Ingo Molnar 已提交
89
			mutex_unlock(&mtd_table_mutex);
L
Linus Torvalds 已提交
90 91 92 93 94 95 96
			/* 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;
		}
97

I
Ingo Molnar 已提交
98
	mutex_unlock(&mtd_table_mutex);
L
Linus Torvalds 已提交
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
	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;
115

I
Ingo Molnar 已提交
116
	mutex_lock(&mtd_table_mutex);
L
Linus Torvalds 已提交
117 118 119 120

	if (mtd_table[mtd->index] != mtd) {
		ret = -ENODEV;
	} else if (mtd->usecount) {
121
		printk(KERN_NOTICE "Removing MTD device #%d (%s) with use count %d\n",
L
Linus Torvalds 已提交
122 123 124
		       mtd->index, mtd->name, mtd->usecount);
		ret = -EBUSY;
	} else {
125
		struct mtd_notifier *not;
L
Linus Torvalds 已提交
126 127 128

		/* No need to get a refcount on the module containing
		   the notifier, since we hold the mtd_table_mutex */
129
		list_for_each_entry(not, &mtd_notifiers, list)
L
Linus Torvalds 已提交
130 131 132 133 134 135 136 137
			not->remove(mtd);

		mtd_table[mtd->index] = NULL;

		module_put(THIS_MODULE);
		ret = 0;
	}

I
Ingo Molnar 已提交
138
	mutex_unlock(&mtd_table_mutex);
L
Linus Torvalds 已提交
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154
	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;

I
Ingo Molnar 已提交
155
	mutex_lock(&mtd_table_mutex);
L
Linus Torvalds 已提交
156 157 158 159

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

 	__module_get(THIS_MODULE);
160

L
Linus Torvalds 已提交
161 162 163 164
	for (i=0; i< MAX_MTD_DEVICES; i++)
		if (mtd_table[i])
			new->add(mtd_table[i]);

I
Ingo Molnar 已提交
165
	mutex_unlock(&mtd_table_mutex);
L
Linus Torvalds 已提交
166 167 168
}

/**
169 170
 *	unregister_mtd_user - unregister a 'user' of MTD devices.
 *	@old: pointer to notifier info structure
L
Linus Torvalds 已提交
171 172 173 174 175 176 177 178 179 180 181
 *
 *	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;

I
Ingo Molnar 已提交
182
	mutex_lock(&mtd_table_mutex);
L
Linus Torvalds 已提交
183 184 185 186 187 188

	module_put(THIS_MODULE);

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

L
Linus Torvalds 已提交
190
	list_del(&old->list);
I
Ingo Molnar 已提交
191
	mutex_unlock(&mtd_table_mutex);
L
Linus Torvalds 已提交
192 193 194 195 196 197 198 199 200 201 202 203
	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
204 205
 *	both, return the num'th driver only if its address matches. Return
 *	error code if not.
L
Linus Torvalds 已提交
206
 */
207

L
Linus Torvalds 已提交
208 209 210
struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num)
{
	struct mtd_info *ret = NULL;
211
	int i, err = -ENODEV;
L
Linus Torvalds 已提交
212

I
Ingo Molnar 已提交
213
	mutex_lock(&mtd_table_mutex);
L
Linus Torvalds 已提交
214 215 216 217 218 219 220 221 222 223 224

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

A
Artem Bityutskiy 已提交
225 226 227
	if (!ret)
		goto out_unlock;

228
	if (!try_module_get(ret->owner))
A
Artem Bityutskiy 已提交
229 230
		goto out_unlock;

231 232 233 234
	if (ret->get_device) {
		err = ret->get_device(ret);
		if (err)
			goto out_put;
A
Artem Bityutskiy 已提交
235
	}
L
Linus Torvalds 已提交
236

A
Artem Bityutskiy 已提交
237
	ret->usecount++;
238 239
	mutex_unlock(&mtd_table_mutex);
	return ret;
L
Linus Torvalds 已提交
240

241 242
out_put:
	module_put(ret->owner);
A
Artem Bityutskiy 已提交
243
out_unlock:
I
Ingo Molnar 已提交
244
	mutex_unlock(&mtd_table_mutex);
245
	return ERR_PTR(err);
L
Linus Torvalds 已提交
246 247
}

248 249 250 251 252 253 254 255 256 257 258
/**
 *	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)
{
A
Artem Bityutskiy 已提交
259 260
	int i, err = -ENODEV;
	struct mtd_info *mtd = NULL;
261 262 263 264 265 266 267 268 269 270

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

A
Artem Bityutskiy 已提交
271
	if (!mtd)
272 273 274 275 276
		goto out_unlock;

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

A
Artem Bityutskiy 已提交
277 278 279 280 281 282
	if (mtd->get_device) {
		err = mtd->get_device(mtd);
		if (err)
			goto out_put;
	}

283
	mtd->usecount++;
A
Artem Bityutskiy 已提交
284 285
	mutex_unlock(&mtd_table_mutex);
	return mtd;
286

A
Artem Bityutskiy 已提交
287 288
out_put:
	module_put(mtd->owner);
289 290
out_unlock:
	mutex_unlock(&mtd_table_mutex);
A
Artem Bityutskiy 已提交
291
	return ERR_PTR(err);
292 293
}

L
Linus Torvalds 已提交
294 295 296 297
void put_mtd_device(struct mtd_info *mtd)
{
	int c;

I
Ingo Molnar 已提交
298
	mutex_lock(&mtd_table_mutex);
L
Linus Torvalds 已提交
299
	c = --mtd->usecount;
A
Artem Bityutskiy 已提交
300 301
	if (mtd->put_device)
		mtd->put_device(mtd);
I
Ingo Molnar 已提交
302
	mutex_unlock(&mtd_table_mutex);
L
Linus Torvalds 已提交
303 304 305 306 307 308
	BUG_ON(c < 0);

	module_put(mtd->owner);
}

/* default_mtd_writev - default mtd writev method for MTD devices that
309
 *			don't implement their own
L
Linus Torvalds 已提交
310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
 */

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

337 338 339 340 341 342 343 344
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);
L
Linus Torvalds 已提交
345

P
Pavel Machek 已提交
346 347
#ifdef CONFIG_PROC_FS

L
Linus Torvalds 已提交
348 349 350 351 352 353 354 355 356 357 358 359
/*====================================================================*/
/* 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;

360 361
	return sprintf(buf, "mtd%d: %8.8llx %8.8x \"%s\"\n", i,
		       (unsigned long long)this->size,
L
Linus Torvalds 已提交
362 363 364 365 366 367 368 369 370
		       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;

I
Ingo Molnar 已提交
371
	mutex_lock(&mtd_table_mutex);
L
Linus Torvalds 已提交
372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388

	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:
I
Ingo Molnar 已提交
389
	mutex_unlock(&mtd_table_mutex);
L
Linus Torvalds 已提交
390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
        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);

P
Pavel Machek 已提交
415 416
#endif /* CONFIG_PROC_FS */

L
Linus Torvalds 已提交
417 418 419 420

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