MTD/JFFS2: remove CVS keywords
[deliverable/linux.git] / drivers / mtd / mtdcore.c
CommitLineData
1da177e4 1/*
1da177e4
LT
2 * Core registration and callback routines for MTD
3 * drivers and users.
4 *
5 */
6
1da177e4
LT
7#include <linux/module.h>
8#include <linux/kernel.h>
1da177e4
LT
9#include <linux/ptrace.h>
10#include <linux/slab.h>
11#include <linux/string.h>
12#include <linux/timer.h>
13#include <linux/major.h>
14#include <linux/fs.h>
7799308f 15#include <linux/err.h>
1da177e4
LT
16#include <linux/ioctl.h>
17#include <linux/init.h>
18#include <linux/mtd/compatmac.h>
1da177e4 19#include <linux/proc_fs.h>
1da177e4
LT
20
21#include <linux/mtd/mtd.h>
22
356d70f1
BD
23#include "mtdcore.h"
24
97894cda 25/* These are exported solely for the purpose of mtd_blkdevs.c. You
1da177e4 26 should not use them for _anything_ else */
48b19268 27DEFINE_MUTEX(mtd_table_mutex);
1da177e4
LT
28struct mtd_info *mtd_table[MAX_MTD_DEVICES];
29
30EXPORT_SYMBOL_GPL(mtd_table_mutex);
31EXPORT_SYMBOL_GPL(mtd_table);
32
33static LIST_HEAD(mtd_notifiers);
34
35/**
36 * add_mtd_device - register an MTD device
37 * @mtd: pointer to new MTD device info structure
38 *
39 * Add a device to the list of MTD devices present in the system, and
40 * notify each currently active MTD 'user' of its arrival. Returns
41 * zero on success or 1 on failure, which currently will only happen
42 * if the number of present devices exceeds MAX_MTD_DEVICES (i.e. 16)
43 */
44
45int add_mtd_device(struct mtd_info *mtd)
46{
47 int i;
48
783ed81f 49 BUG_ON(mtd->writesize == 0);
48b19268 50 mutex_lock(&mtd_table_mutex);
1da177e4
LT
51
52 for (i=0; i < MAX_MTD_DEVICES; i++)
53 if (!mtd_table[i]) {
2606c797 54 struct mtd_notifier *not;
1da177e4
LT
55
56 mtd_table[i] = mtd;
57 mtd->index = i;
58 mtd->usecount = 0;
59
187ef152
HS
60 /* Some chips always power up locked. Unlock them now */
61 if ((mtd->flags & MTD_WRITEABLE)
e619a75f 62 && (mtd->flags & MTD_POWERUP_LOCK) && mtd->unlock) {
187ef152
HS
63 if (mtd->unlock(mtd, 0, mtd->size))
64 printk(KERN_WARNING
65 "%s: unlock failed, "
66 "writes may not work\n",
67 mtd->name);
68 }
69
1da177e4
LT
70 DEBUG(0, "mtd: Giving out device %d to %s\n",i, mtd->name);
71 /* No need to get a refcount on the module containing
72 the notifier, since we hold the mtd_table_mutex */
2606c797 73 list_for_each_entry(not, &mtd_notifiers, list) {
1da177e4
LT
74 not->add(mtd);
75 }
97894cda 76
48b19268 77 mutex_unlock(&mtd_table_mutex);
1da177e4
LT
78 /* We _know_ we aren't being removed, because
79 our caller is still holding us here. So none
80 of this try_ nonsense, and no bitching about it
81 either. :) */
82 __module_get(THIS_MODULE);
83 return 0;
84 }
97894cda 85
48b19268 86 mutex_unlock(&mtd_table_mutex);
1da177e4
LT
87 return 1;
88}
89
90/**
91 * del_mtd_device - unregister an MTD device
92 * @mtd: pointer to MTD device info structure
93 *
94 * Remove a device from the list of MTD devices present in the system,
95 * and notify each currently active MTD 'user' of its departure.
96 * Returns zero on success or 1 on failure, which currently will happen
97 * if the requested device does not appear to be present in the list.
98 */
99
100int del_mtd_device (struct mtd_info *mtd)
101{
102 int ret;
97894cda 103
48b19268 104 mutex_lock(&mtd_table_mutex);
1da177e4
LT
105
106 if (mtd_table[mtd->index] != mtd) {
107 ret = -ENODEV;
108 } else if (mtd->usecount) {
97894cda 109 printk(KERN_NOTICE "Removing MTD device #%d (%s) with use count %d\n",
1da177e4
LT
110 mtd->index, mtd->name, mtd->usecount);
111 ret = -EBUSY;
112 } else {
856613c9 113 struct mtd_notifier *not;
1da177e4
LT
114
115 /* No need to get a refcount on the module containing
116 the notifier, since we hold the mtd_table_mutex */
856613c9 117 list_for_each_entry(not, &mtd_notifiers, list) {
1da177e4
LT
118 not->remove(mtd);
119 }
120
121 mtd_table[mtd->index] = NULL;
122
123 module_put(THIS_MODULE);
124 ret = 0;
125 }
126
48b19268 127 mutex_unlock(&mtd_table_mutex);
1da177e4
LT
128 return ret;
129}
130
131/**
132 * register_mtd_user - register a 'user' of MTD devices.
133 * @new: pointer to notifier info structure
134 *
135 * Registers a pair of callbacks function to be called upon addition
136 * or removal of MTD devices. Causes the 'add' callback to be immediately
137 * invoked for each MTD device currently present in the system.
138 */
139
140void register_mtd_user (struct mtd_notifier *new)
141{
142 int i;
143
48b19268 144 mutex_lock(&mtd_table_mutex);
1da177e4
LT
145
146 list_add(&new->list, &mtd_notifiers);
147
148 __module_get(THIS_MODULE);
97894cda 149
1da177e4
LT
150 for (i=0; i< MAX_MTD_DEVICES; i++)
151 if (mtd_table[i])
152 new->add(mtd_table[i]);
153
48b19268 154 mutex_unlock(&mtd_table_mutex);
1da177e4
LT
155}
156
157/**
49450795
AB
158 * unregister_mtd_user - unregister a 'user' of MTD devices.
159 * @old: pointer to notifier info structure
1da177e4
LT
160 *
161 * Removes a callback function pair from the list of 'users' to be
162 * notified upon addition or removal of MTD devices. Causes the
163 * 'remove' callback to be immediately invoked for each MTD device
164 * currently present in the system.
165 */
166
167int unregister_mtd_user (struct mtd_notifier *old)
168{
169 int i;
170
48b19268 171 mutex_lock(&mtd_table_mutex);
1da177e4
LT
172
173 module_put(THIS_MODULE);
174
175 for (i=0; i< MAX_MTD_DEVICES; i++)
176 if (mtd_table[i])
177 old->remove(mtd_table[i]);
97894cda 178
1da177e4 179 list_del(&old->list);
48b19268 180 mutex_unlock(&mtd_table_mutex);
1da177e4
LT
181 return 0;
182}
183
184
185/**
186 * get_mtd_device - obtain a validated handle for an MTD device
187 * @mtd: last known address of the required MTD device
188 * @num: internal device number of the required MTD device
189 *
190 * Given a number and NULL address, return the num'th entry in the device
191 * table, if any. Given an address and num == -1, search the device table
192 * for a device with that address and return if it's still present. Given
9c74034f
AB
193 * both, return the num'th driver only if its address matches. Return
194 * error code if not.
1da177e4 195 */
97894cda 196
1da177e4
LT
197struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num)
198{
199 struct mtd_info *ret = NULL;
9c74034f 200 int i, err = -ENODEV;
1da177e4 201
48b19268 202 mutex_lock(&mtd_table_mutex);
1da177e4
LT
203
204 if (num == -1) {
205 for (i=0; i< MAX_MTD_DEVICES; i++)
206 if (mtd_table[i] == mtd)
207 ret = mtd_table[i];
208 } else if (num < MAX_MTD_DEVICES) {
209 ret = mtd_table[num];
210 if (mtd && mtd != ret)
211 ret = NULL;
212 }
213
9fe912ce
AB
214 if (!ret)
215 goto out_unlock;
216
9c74034f 217 if (!try_module_get(ret->owner))
9fe912ce 218 goto out_unlock;
9fe912ce 219
9c74034f
AB
220 if (ret->get_device) {
221 err = ret->get_device(ret);
222 if (err)
223 goto out_put;
9fe912ce 224 }
1da177e4 225
9fe912ce 226 ret->usecount++;
9c74034f
AB
227 mutex_unlock(&mtd_table_mutex);
228 return ret;
1da177e4 229
9c74034f
AB
230out_put:
231 module_put(ret->owner);
9fe912ce 232out_unlock:
48b19268 233 mutex_unlock(&mtd_table_mutex);
9c74034f 234 return ERR_PTR(err);
1da177e4
LT
235}
236
7799308f
AB
237/**
238 * get_mtd_device_nm - obtain a validated handle for an MTD device by
239 * device name
240 * @name: MTD device name to open
241 *
242 * This function returns MTD device description structure in case of
243 * success and an error code in case of failure.
244 */
245
246struct mtd_info *get_mtd_device_nm(const char *name)
247{
9fe912ce
AB
248 int i, err = -ENODEV;
249 struct mtd_info *mtd = NULL;
7799308f
AB
250
251 mutex_lock(&mtd_table_mutex);
252
253 for (i = 0; i < MAX_MTD_DEVICES; i++) {
254 if (mtd_table[i] && !strcmp(name, mtd_table[i]->name)) {
255 mtd = mtd_table[i];
256 break;
257 }
258 }
259
9fe912ce 260 if (!mtd)
7799308f
AB
261 goto out_unlock;
262
263 if (!try_module_get(mtd->owner))
264 goto out_unlock;
265
9fe912ce
AB
266 if (mtd->get_device) {
267 err = mtd->get_device(mtd);
268 if (err)
269 goto out_put;
270 }
271
7799308f 272 mtd->usecount++;
9fe912ce
AB
273 mutex_unlock(&mtd_table_mutex);
274 return mtd;
7799308f 275
9fe912ce
AB
276out_put:
277 module_put(mtd->owner);
7799308f
AB
278out_unlock:
279 mutex_unlock(&mtd_table_mutex);
9fe912ce 280 return ERR_PTR(err);
7799308f
AB
281}
282
1da177e4
LT
283void put_mtd_device(struct mtd_info *mtd)
284{
285 int c;
286
48b19268 287 mutex_lock(&mtd_table_mutex);
1da177e4 288 c = --mtd->usecount;
9fe912ce
AB
289 if (mtd->put_device)
290 mtd->put_device(mtd);
48b19268 291 mutex_unlock(&mtd_table_mutex);
1da177e4
LT
292 BUG_ON(c < 0);
293
294 module_put(mtd->owner);
295}
296
297/* default_mtd_writev - default mtd writev method for MTD devices that
dd36f267 298 * don't implement their own
1da177e4
LT
299 */
300
301int default_mtd_writev(struct mtd_info *mtd, const struct kvec *vecs,
302 unsigned long count, loff_t to, size_t *retlen)
303{
304 unsigned long i;
305 size_t totlen = 0, thislen;
306 int ret = 0;
307
308 if(!mtd->write) {
309 ret = -EROFS;
310 } else {
311 for (i=0; i<count; i++) {
312 if (!vecs[i].iov_len)
313 continue;
314 ret = mtd->write(mtd, to, vecs[i].iov_len, &thislen, vecs[i].iov_base);
315 totlen += thislen;
316 if (ret || thislen != vecs[i].iov_len)
317 break;
318 to += vecs[i].iov_len;
319 }
320 }
321 if (retlen)
322 *retlen = totlen;
323 return ret;
324}
325
dd36f267
DW
326EXPORT_SYMBOL_GPL(add_mtd_device);
327EXPORT_SYMBOL_GPL(del_mtd_device);
328EXPORT_SYMBOL_GPL(get_mtd_device);
329EXPORT_SYMBOL_GPL(get_mtd_device_nm);
330EXPORT_SYMBOL_GPL(put_mtd_device);
331EXPORT_SYMBOL_GPL(register_mtd_user);
332EXPORT_SYMBOL_GPL(unregister_mtd_user);
333EXPORT_SYMBOL_GPL(default_mtd_writev);
1da177e4 334
2d2dce0e
PM
335#ifdef CONFIG_PROC_FS
336
1da177e4
LT
337/*====================================================================*/
338/* Support for /proc/mtd */
339
1da177e4
LT
340static struct proc_dir_entry *proc_mtd;
341
342static inline int mtd_proc_info (char *buf, int i)
343{
344 struct mtd_info *this = mtd_table[i];
345
346 if (!this)
347 return 0;
348
349 return sprintf(buf, "mtd%d: %8.8x %8.8x \"%s\"\n", i, this->size,
350 this->erasesize, this->name);
351}
352
353static int mtd_read_proc (char *page, char **start, off_t off, int count,
354 int *eof, void *data_unused)
355{
356 int len, l, i;
357 off_t begin = 0;
358
48b19268 359 mutex_lock(&mtd_table_mutex);
1da177e4
LT
360
361 len = sprintf(page, "dev: size erasesize name\n");
362 for (i=0; i< MAX_MTD_DEVICES; i++) {
363
364 l = mtd_proc_info(page + len, i);
365 len += l;
366 if (len+begin > off+count)
367 goto done;
368 if (len+begin < off) {
369 begin += len;
370 len = 0;
371 }
372 }
373
374 *eof = 1;
375
376done:
48b19268 377 mutex_unlock(&mtd_table_mutex);
1da177e4
LT
378 if (off >= len+begin)
379 return 0;
380 *start = page + (off-begin);
381 return ((count < begin+len-off) ? count : begin+len-off);
382}
383
1da177e4
LT
384/*====================================================================*/
385/* Init code */
386
387static int __init init_mtd(void)
388{
1da177e4
LT
389 if ((proc_mtd = create_proc_entry( "mtd", 0, NULL )))
390 proc_mtd->read_proc = mtd_read_proc;
1da177e4
LT
391 return 0;
392}
393
394static void __exit cleanup_mtd(void)
395{
1da177e4
LT
396 if (proc_mtd)
397 remove_proc_entry( "mtd", NULL);
1da177e4
LT
398}
399
400module_init(init_mtd);
401module_exit(cleanup_mtd);
402
2d2dce0e
PM
403#endif /* CONFIG_PROC_FS */
404
1da177e4
LT
405
406MODULE_LICENSE("GPL");
407MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org>");
408MODULE_DESCRIPTION("Core MTD registration and access routines");
This page took 0.251814 seconds and 5 git commands to generate.