2 * $Id: mtdcore.c,v 1.47 2005/11/07 11:14:20 gleixner Exp $
4 * Core registration and callback routines for MTD
9 #include <linux/module.h>
10 #include <linux/kernel.h>
11 #include <linux/ptrace.h>
12 #include <linux/slab.h>
13 #include <linux/string.h>
14 #include <linux/timer.h>
15 #include <linux/major.h>
17 #include <linux/err.h>
18 #include <linux/ioctl.h>
19 #include <linux/init.h>
20 #include <linux/mtd/compatmac.h>
21 #include <linux/proc_fs.h>
23 #include <linux/mtd/mtd.h>
27 /* These are exported solely for the purpose of mtd_blkdevs.c. You
28 should not use them for _anything_ else */
29 DEFINE_MUTEX(mtd_table_mutex
);
30 struct mtd_info
*mtd_table
[MAX_MTD_DEVICES
];
32 EXPORT_SYMBOL_GPL(mtd_table_mutex
);
33 EXPORT_SYMBOL_GPL(mtd_table
);
35 static LIST_HEAD(mtd_notifiers
);
38 * add_mtd_device - register an MTD device
39 * @mtd: pointer to new MTD device info structure
41 * Add a device to the list of MTD devices present in the system, and
42 * notify each currently active MTD 'user' of its arrival. Returns
43 * zero on success or 1 on failure, which currently will only happen
44 * if the number of present devices exceeds MAX_MTD_DEVICES (i.e. 16)
47 int add_mtd_device(struct mtd_info
*mtd
)
51 BUG_ON(mtd
->writesize
== 0);
52 mutex_lock(&mtd_table_mutex
);
54 for (i
=0; i
< MAX_MTD_DEVICES
; i
++)
56 struct list_head
*this;
62 /* Some chips always power up locked. Unlock them now */
63 if ((mtd
->flags
& MTD_WRITEABLE
)
64 && (mtd
->flags
& MTD_STUPID_LOCK
) && mtd
->unlock
) {
65 if (mtd
->unlock(mtd
, 0, mtd
->size
))
68 "writes may not work\n",
72 DEBUG(0, "mtd: Giving out device %d to %s\n",i
, mtd
->name
);
73 /* No need to get a refcount on the module containing
74 the notifier, since we hold the mtd_table_mutex */
75 list_for_each(this, &mtd_notifiers
) {
76 struct mtd_notifier
*not = list_entry(this, struct mtd_notifier
, list
);
80 mutex_unlock(&mtd_table_mutex
);
81 /* We _know_ we aren't being removed, because
82 our caller is still holding us here. So none
83 of this try_ nonsense, and no bitching about it
85 __module_get(THIS_MODULE
);
89 mutex_unlock(&mtd_table_mutex
);
94 * del_mtd_device - unregister an MTD device
95 * @mtd: pointer to MTD device info structure
97 * Remove a device from the list of MTD devices present in the system,
98 * and notify each currently active MTD 'user' of its departure.
99 * Returns zero on success or 1 on failure, which currently will happen
100 * if the requested device does not appear to be present in the list.
103 int del_mtd_device (struct mtd_info
*mtd
)
107 mutex_lock(&mtd_table_mutex
);
109 if (mtd_table
[mtd
->index
] != mtd
) {
111 } else if (mtd
->usecount
) {
112 printk(KERN_NOTICE
"Removing MTD device #%d (%s) with use count %d\n",
113 mtd
->index
, mtd
->name
, mtd
->usecount
);
116 struct list_head
*this;
118 /* No need to get a refcount on the module containing
119 the notifier, since we hold the mtd_table_mutex */
120 list_for_each(this, &mtd_notifiers
) {
121 struct mtd_notifier
*not = list_entry(this, struct mtd_notifier
, list
);
125 mtd_table
[mtd
->index
] = NULL
;
127 module_put(THIS_MODULE
);
131 mutex_unlock(&mtd_table_mutex
);
136 * register_mtd_user - register a 'user' of MTD devices.
137 * @new: pointer to notifier info structure
139 * Registers a pair of callbacks function to be called upon addition
140 * or removal of MTD devices. Causes the 'add' callback to be immediately
141 * invoked for each MTD device currently present in the system.
144 void register_mtd_user (struct mtd_notifier
*new)
148 mutex_lock(&mtd_table_mutex
);
150 list_add(&new->list
, &mtd_notifiers
);
152 __module_get(THIS_MODULE
);
154 for (i
=0; i
< MAX_MTD_DEVICES
; i
++)
156 new->add(mtd_table
[i
]);
158 mutex_unlock(&mtd_table_mutex
);
162 * unregister_mtd_user - unregister a 'user' of MTD devices.
163 * @old: pointer to notifier info structure
165 * Removes a callback function pair from the list of 'users' to be
166 * notified upon addition or removal of MTD devices. Causes the
167 * 'remove' callback to be immediately invoked for each MTD device
168 * currently present in the system.
171 int unregister_mtd_user (struct mtd_notifier
*old
)
175 mutex_lock(&mtd_table_mutex
);
177 module_put(THIS_MODULE
);
179 for (i
=0; i
< MAX_MTD_DEVICES
; i
++)
181 old
->remove(mtd_table
[i
]);
183 list_del(&old
->list
);
184 mutex_unlock(&mtd_table_mutex
);
190 * get_mtd_device - obtain a validated handle for an MTD device
191 * @mtd: last known address of the required MTD device
192 * @num: internal device number of the required MTD device
194 * Given a number and NULL address, return the num'th entry in the device
195 * table, if any. Given an address and num == -1, search the device table
196 * for a device with that address and return if it's still present. Given
197 * both, return the num'th driver only if its address matches. Return
201 struct mtd_info
*get_mtd_device(struct mtd_info
*mtd
, int num
)
203 struct mtd_info
*ret
= NULL
;
204 int i
, err
= -ENODEV
;
206 mutex_lock(&mtd_table_mutex
);
209 for (i
=0; i
< MAX_MTD_DEVICES
; i
++)
210 if (mtd_table
[i
] == mtd
)
212 } else if (num
< MAX_MTD_DEVICES
) {
213 ret
= mtd_table
[num
];
214 if (mtd
&& mtd
!= ret
)
221 if (!try_module_get(ret
->owner
))
224 if (ret
->get_device
) {
225 err
= ret
->get_device(ret
);
231 mutex_unlock(&mtd_table_mutex
);
235 module_put(ret
->owner
);
237 mutex_unlock(&mtd_table_mutex
);
242 * get_mtd_device_nm - obtain a validated handle for an MTD device by
244 * @name: MTD device name to open
246 * This function returns MTD device description structure in case of
247 * success and an error code in case of failure.
250 struct mtd_info
*get_mtd_device_nm(const char *name
)
252 int i
, err
= -ENODEV
;
253 struct mtd_info
*mtd
= NULL
;
255 mutex_lock(&mtd_table_mutex
);
257 for (i
= 0; i
< MAX_MTD_DEVICES
; i
++) {
258 if (mtd_table
[i
] && !strcmp(name
, mtd_table
[i
]->name
)) {
267 if (!try_module_get(mtd
->owner
))
270 if (mtd
->get_device
) {
271 err
= mtd
->get_device(mtd
);
277 mutex_unlock(&mtd_table_mutex
);
281 module_put(mtd
->owner
);
283 mutex_unlock(&mtd_table_mutex
);
287 void put_mtd_device(struct mtd_info
*mtd
)
291 mutex_lock(&mtd_table_mutex
);
294 mtd
->put_device(mtd
);
295 mutex_unlock(&mtd_table_mutex
);
298 module_put(mtd
->owner
);
301 /* default_mtd_writev - default mtd writev method for MTD devices that
302 * don't implement their own
305 int default_mtd_writev(struct mtd_info
*mtd
, const struct kvec
*vecs
,
306 unsigned long count
, loff_t to
, size_t *retlen
)
309 size_t totlen
= 0, thislen
;
315 for (i
=0; i
<count
; i
++) {
316 if (!vecs
[i
].iov_len
)
318 ret
= mtd
->write(mtd
, to
, vecs
[i
].iov_len
, &thislen
, vecs
[i
].iov_base
);
320 if (ret
|| thislen
!= vecs
[i
].iov_len
)
322 to
+= vecs
[i
].iov_len
;
330 EXPORT_SYMBOL_GPL(add_mtd_device
);
331 EXPORT_SYMBOL_GPL(del_mtd_device
);
332 EXPORT_SYMBOL_GPL(get_mtd_device
);
333 EXPORT_SYMBOL_GPL(get_mtd_device_nm
);
334 EXPORT_SYMBOL_GPL(put_mtd_device
);
335 EXPORT_SYMBOL_GPL(register_mtd_user
);
336 EXPORT_SYMBOL_GPL(unregister_mtd_user
);
337 EXPORT_SYMBOL_GPL(default_mtd_writev
);
339 #ifdef CONFIG_PROC_FS
341 /*====================================================================*/
342 /* Support for /proc/mtd */
344 static struct proc_dir_entry
*proc_mtd
;
346 static inline int mtd_proc_info (char *buf
, int i
)
348 struct mtd_info
*this = mtd_table
[i
];
353 return sprintf(buf
, "mtd%d: %8.8x %8.8x \"%s\"\n", i
, this->size
,
354 this->erasesize
, this->name
);
357 static int mtd_read_proc (char *page
, char **start
, off_t off
, int count
,
358 int *eof
, void *data_unused
)
363 mutex_lock(&mtd_table_mutex
);
365 len
= sprintf(page
, "dev: size erasesize name\n");
366 for (i
=0; i
< MAX_MTD_DEVICES
; i
++) {
368 l
= mtd_proc_info(page
+ len
, i
);
370 if (len
+begin
> off
+count
)
372 if (len
+begin
< off
) {
381 mutex_unlock(&mtd_table_mutex
);
382 if (off
>= len
+begin
)
384 *start
= page
+ (off
-begin
);
385 return ((count
< begin
+len
-off
) ? count
: begin
+len
-off
);
388 /*====================================================================*/
391 static int __init
init_mtd(void)
393 if ((proc_mtd
= create_proc_entry( "mtd", 0, NULL
)))
394 proc_mtd
->read_proc
= mtd_read_proc
;
398 static void __exit
cleanup_mtd(void)
401 remove_proc_entry( "mtd", NULL
);
404 module_init(init_mtd
);
405 module_exit(cleanup_mtd
);
407 #endif /* CONFIG_PROC_FS */
410 MODULE_LICENSE("GPL");
411 MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org>");
412 MODULE_DESCRIPTION("Core MTD registration and access routines");