2 * (C) 2003 David Woodhouse <dwmw2@infradead.org>
4 * Interface to Linux 2.5 block layer for MTD 'translation layers'.
8 #include <linux/kernel.h>
9 #include <linux/slab.h>
10 #include <linux/module.h>
11 #include <linux/list.h>
13 #include <linux/mtd/blktrans.h>
14 #include <linux/mtd/mtd.h>
15 #include <linux/blkdev.h>
16 #include <linux/blkpg.h>
17 #include <linux/freezer.h>
18 #include <linux/spinlock.h>
19 #include <linux/hdreg.h>
20 #include <linux/init.h>
21 #include <linux/mutex.h>
22 #include <linux/kthread.h>
23 #include <asm/uaccess.h>
27 static LIST_HEAD(blktrans_majors);
29 struct mtd_blkcore_priv {
30 struct task_struct *thread;
31 struct request_queue *rq;
32 spinlock_t queue_lock;
35 static int blktrans_discard_request(struct request_queue *q,
38 req->cmd_type = REQ_TYPE_LINUX_BLOCK;
39 req->cmd[0] = REQ_LB_OP_DISCARD;
43 static int do_blktrans_request(struct mtd_blktrans_ops *tr,
44 struct mtd_blktrans_dev *dev,
47 unsigned long block, nsect;
50 block = req->sector << 9 >> tr->blkshift;
51 nsect = req->current_nr_sectors << 9 >> tr->blkshift;
55 if (req->cmd_type == REQ_TYPE_LINUX_BLOCK &&
56 req->cmd[0] == REQ_LB_OP_DISCARD)
57 return !tr->discard(dev, block, nsect);
59 if (!blk_fs_request(req))
62 if (req->sector + req->current_nr_sectors > get_capacity(req->rq_disk))
65 switch(rq_data_dir(req)) {
67 for (; nsect > 0; nsect--, block++, buf += tr->blksize)
68 if (tr->readsect(dev, block, buf))
76 for (; nsect > 0; nsect--, block++, buf += tr->blksize)
77 if (tr->writesect(dev, block, buf))
82 printk(KERN_NOTICE "Unknown request %u\n", rq_data_dir(req));
87 static int mtd_blktrans_thread(void *arg)
89 struct mtd_blktrans_ops *tr = arg;
90 struct request_queue *rq = tr->blkcore_priv->rq;
92 /* we might get involved when memory gets low, so use PF_MEMALLOC */
93 current->flags |= PF_MEMALLOC;
95 spin_lock_irq(rq->queue_lock);
96 while (!kthread_should_stop()) {
98 struct mtd_blktrans_dev *dev;
101 req = elv_next_request(rq);
104 set_current_state(TASK_INTERRUPTIBLE);
105 spin_unlock_irq(rq->queue_lock);
107 spin_lock_irq(rq->queue_lock);
111 dev = req->rq_disk->private_data;
114 spin_unlock_irq(rq->queue_lock);
116 mutex_lock(&dev->lock);
117 res = do_blktrans_request(tr, dev, req);
118 mutex_unlock(&dev->lock);
120 spin_lock_irq(rq->queue_lock);
122 end_request(req, res);
124 spin_unlock_irq(rq->queue_lock);
129 static void mtd_blktrans_request(struct request_queue *rq)
131 struct mtd_blktrans_ops *tr = rq->queuedata;
132 wake_up_process(tr->blkcore_priv->thread);
136 static int blktrans_open(struct inode *i, struct file *f)
138 struct mtd_blktrans_dev *dev;
139 struct mtd_blktrans_ops *tr;
142 dev = i->i_bdev->bd_disk->private_data;
145 if (!try_module_get(dev->mtd->owner))
148 if (!try_module_get(tr->owner))
151 /* FIXME: Locking. A hot pluggable device can go away
152 (del_mtd_device can be called for it) without its module
154 dev->mtd->usecount++;
157 if (tr->open && (ret = tr->open(dev))) {
158 dev->mtd->usecount--;
159 module_put(dev->mtd->owner);
161 module_put(tr->owner);
167 static int blktrans_release(struct inode *i, struct file *f)
169 struct mtd_blktrans_dev *dev;
170 struct mtd_blktrans_ops *tr;
173 dev = i->i_bdev->bd_disk->private_data;
177 ret = tr->release(dev);
180 dev->mtd->usecount--;
181 module_put(dev->mtd->owner);
182 module_put(tr->owner);
188 static int blktrans_getgeo(struct block_device *bdev, struct hd_geometry *geo)
190 struct mtd_blktrans_dev *dev = bdev->bd_disk->private_data;
193 return dev->tr->getgeo(dev, geo);
197 static int blktrans_ioctl(struct inode *inode, struct file *file,
198 unsigned int cmd, unsigned long arg)
200 struct mtd_blktrans_dev *dev = inode->i_bdev->bd_disk->private_data;
201 struct mtd_blktrans_ops *tr = dev->tr;
206 return tr->flush(dev);
207 /* The core code did the work, we had nothing to do. */
214 static struct block_device_operations mtd_blktrans_ops = {
215 .owner = THIS_MODULE,
216 .open = blktrans_open,
217 .release = blktrans_release,
218 .ioctl = blktrans_ioctl,
219 .getgeo = blktrans_getgeo,
222 int add_mtd_blktrans_dev(struct mtd_blktrans_dev *new)
224 struct mtd_blktrans_ops *tr = new->tr;
225 struct mtd_blktrans_dev *d;
226 int last_devnum = -1;
229 if (mutex_trylock(&mtd_table_mutex)) {
230 mutex_unlock(&mtd_table_mutex);
234 list_for_each_entry(d, &tr->devs, list) {
235 if (new->devnum == -1) {
236 /* Use first free number */
237 if (d->devnum != last_devnum+1) {
238 /* Found a free devnum. Plug it in here */
239 new->devnum = last_devnum+1;
240 list_add_tail(&new->list, &d->list);
243 } else if (d->devnum == new->devnum) {
244 /* Required number taken */
246 } else if (d->devnum > new->devnum) {
247 /* Required number was free */
248 list_add_tail(&new->list, &d->list);
251 last_devnum = d->devnum;
253 if (new->devnum == -1)
254 new->devnum = last_devnum+1;
256 if ((new->devnum << tr->part_bits) > 256) {
260 list_add_tail(&new->list, &tr->devs);
262 mutex_init(&new->lock);
266 gd = alloc_disk(1 << tr->part_bits);
268 list_del(&new->list);
271 gd->major = tr->major;
272 gd->first_minor = (new->devnum) << tr->part_bits;
273 gd->fops = &mtd_blktrans_ops;
276 if (new->devnum < 26)
277 snprintf(gd->disk_name, sizeof(gd->disk_name),
278 "%s%c", tr->name, 'a' + new->devnum);
280 snprintf(gd->disk_name, sizeof(gd->disk_name),
282 'a' - 1 + new->devnum / 26,
283 'a' + new->devnum % 26);
285 snprintf(gd->disk_name, sizeof(gd->disk_name),
286 "%s%d", tr->name, new->devnum);
288 /* 2.5 has capacity in units of 512 bytes while still
289 having BLOCK_SIZE_BITS set to 10. Just to keep us amused. */
290 set_capacity(gd, (new->size * tr->blksize) >> 9);
292 gd->private_data = new;
293 new->blkcore_priv = gd;
294 gd->queue = tr->blkcore_priv->rq;
304 int del_mtd_blktrans_dev(struct mtd_blktrans_dev *old)
306 if (mutex_trylock(&mtd_table_mutex)) {
307 mutex_unlock(&mtd_table_mutex);
311 list_del(&old->list);
313 del_gendisk(old->blkcore_priv);
314 put_disk(old->blkcore_priv);
319 static void blktrans_notify_remove(struct mtd_info *mtd)
321 struct mtd_blktrans_ops *tr;
322 struct mtd_blktrans_dev *dev, *next;
324 list_for_each_entry(tr, &blktrans_majors, list)
325 list_for_each_entry_safe(dev, next, &tr->devs, list)
330 static void blktrans_notify_add(struct mtd_info *mtd)
332 struct mtd_blktrans_ops *tr;
334 if (mtd->type == MTD_ABSENT)
337 list_for_each_entry(tr, &blktrans_majors, list)
338 tr->add_mtd(tr, mtd);
341 static struct mtd_notifier blktrans_notifier = {
342 .add = blktrans_notify_add,
343 .remove = blktrans_notify_remove,
346 int register_mtd_blktrans(struct mtd_blktrans_ops *tr)
350 /* Register the notifier if/when the first device type is
351 registered, to prevent the link/init ordering from fucking
353 if (!blktrans_notifier.list.next)
354 register_mtd_user(&blktrans_notifier);
356 tr->blkcore_priv = kzalloc(sizeof(*tr->blkcore_priv), GFP_KERNEL);
357 if (!tr->blkcore_priv)
360 mutex_lock(&mtd_table_mutex);
362 ret = register_blkdev(tr->major, tr->name);
364 printk(KERN_WARNING "Unable to register %s block device on major %d: %d\n",
365 tr->name, tr->major, ret);
366 kfree(tr->blkcore_priv);
367 mutex_unlock(&mtd_table_mutex);
370 spin_lock_init(&tr->blkcore_priv->queue_lock);
372 tr->blkcore_priv->rq = blk_init_queue(mtd_blktrans_request, &tr->blkcore_priv->queue_lock);
373 if (!tr->blkcore_priv->rq) {
374 unregister_blkdev(tr->major, tr->name);
375 kfree(tr->blkcore_priv);
376 mutex_unlock(&mtd_table_mutex);
380 tr->blkcore_priv->rq->queuedata = tr;
381 blk_queue_hardsect_size(tr->blkcore_priv->rq, tr->blksize);
383 blk_queue_set_discard(tr->blkcore_priv->rq,
384 blktrans_discard_request);
386 tr->blkshift = ffs(tr->blksize) - 1;
388 tr->blkcore_priv->thread = kthread_run(mtd_blktrans_thread, tr,
390 if (IS_ERR(tr->blkcore_priv->thread)) {
391 blk_cleanup_queue(tr->blkcore_priv->rq);
392 unregister_blkdev(tr->major, tr->name);
393 kfree(tr->blkcore_priv);
394 mutex_unlock(&mtd_table_mutex);
395 return PTR_ERR(tr->blkcore_priv->thread);
398 INIT_LIST_HEAD(&tr->devs);
399 list_add(&tr->list, &blktrans_majors);
401 for (i=0; i<MAX_MTD_DEVICES; i++) {
402 if (mtd_table[i] && mtd_table[i]->type != MTD_ABSENT)
403 tr->add_mtd(tr, mtd_table[i]);
406 mutex_unlock(&mtd_table_mutex);
411 int deregister_mtd_blktrans(struct mtd_blktrans_ops *tr)
413 struct mtd_blktrans_dev *dev, *next;
415 mutex_lock(&mtd_table_mutex);
417 /* Clean up the kernel thread */
418 kthread_stop(tr->blkcore_priv->thread);
420 /* Remove it from the list of active majors */
423 list_for_each_entry_safe(dev, next, &tr->devs, list)
426 blk_cleanup_queue(tr->blkcore_priv->rq);
427 unregister_blkdev(tr->major, tr->name);
429 mutex_unlock(&mtd_table_mutex);
431 kfree(tr->blkcore_priv);
433 BUG_ON(!list_empty(&tr->devs));
437 static void __exit mtd_blktrans_exit(void)
439 /* No race here -- if someone's currently in register_mtd_blktrans
440 we're screwed anyway. */
441 if (blktrans_notifier.list.next)
442 unregister_mtd_user(&blktrans_notifier);
445 module_exit(mtd_blktrans_exit);
447 EXPORT_SYMBOL_GPL(register_mtd_blktrans);
448 EXPORT_SYMBOL_GPL(deregister_mtd_blktrans);
449 EXPORT_SYMBOL_GPL(add_mtd_blktrans_dev);
450 EXPORT_SYMBOL_GPL(del_mtd_blktrans_dev);
452 MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org>");
453 MODULE_LICENSE("GPL");
454 MODULE_DESCRIPTION("Common interface to block layer for MTD 'translation layers'");