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