2 * Interface to Linux block layer for MTD 'translation layers'.
4 * Copyright © 2003-2010 David Woodhouse <dwmw2@infradead.org>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 #include <linux/kernel.h>
23 #include <linux/slab.h>
24 #include <linux/module.h>
25 #include <linux/list.h>
27 #include <linux/mtd/blktrans.h>
28 #include <linux/mtd/mtd.h>
29 #include <linux/blkdev.h>
30 #include <linux/blkpg.h>
31 #include <linux/spinlock.h>
32 #include <linux/hdreg.h>
33 #include <linux/init.h>
34 #include <linux/mutex.h>
35 #include <linux/kthread.h>
36 #include <asm/uaccess.h>
40 static LIST_HEAD(blktrans_majors);
41 static DEFINE_MUTEX(blktrans_ref_mutex);
44 static void blktrans_dev_release(struct kref *kref)
46 struct mtd_blktrans_dev *dev =
47 container_of(kref, struct mtd_blktrans_dev, ref);
49 dev->disk->private_data = NULL;
50 blk_cleanup_queue(dev->rq);
56 static struct mtd_blktrans_dev *blktrans_dev_get(struct gendisk *disk)
58 struct mtd_blktrans_dev *dev;
60 mutex_lock(&blktrans_ref_mutex);
61 dev = disk->private_data;
67 mutex_unlock(&blktrans_ref_mutex);
71 static void blktrans_dev_put(struct mtd_blktrans_dev *dev)
73 mutex_lock(&blktrans_ref_mutex);
74 kref_put(&dev->ref, blktrans_dev_release);
75 mutex_unlock(&blktrans_ref_mutex);
79 static int do_blktrans_request(struct mtd_blktrans_ops *tr,
80 struct mtd_blktrans_dev *dev,
83 unsigned long block, nsect;
86 block = blk_rq_pos(req) << 9 >> tr->blkshift;
87 nsect = blk_rq_cur_bytes(req) >> tr->blkshift;
88 #else //modify by zyf for cap>=4GB 20110120
89 block = blk_rq_pos(req);
90 nsect = blk_rq_cur_bytes(req) >> tr->blkshift;
95 block = blk_rq_pos(req) >> (tr->blkshift - 9);
99 block = blk_rq_pos(req) << (9 - tr->blkshift);
106 if (req->cmd_type != REQ_TYPE_FS)
109 if (blk_rq_pos(req) + blk_rq_cur_sectors(req) >
110 get_capacity(req->rq_disk))
113 if (req->cmd_flags & REQ_DISCARD)
114 return tr->discard(dev, block, nsect);
116 switch(rq_data_dir(req)) {
118 //for (; nsect > 0; nsect--, block++, buf += tr->blksize)
119 if (tr->readsect(dev, block,nsect, buf))
121 rq_flush_dcache_pages(req);
127 rq_flush_dcache_pages(req);
128 //for (; nsect > 0; nsect--, block++, buf += tr->blksize)
129 if (tr->writesect(dev, block,nsect, buf))
133 printk(KERN_NOTICE "Unknown request %u\n", rq_data_dir(req));
138 int mtd_blktrans_cease_background(struct mtd_blktrans_dev *dev)
140 if (kthread_should_stop())
145 EXPORT_SYMBOL_GPL(mtd_blktrans_cease_background);
147 static int mtd_blktrans_thread(void *arg)
149 struct mtd_blktrans_dev *dev = arg;
150 struct mtd_blktrans_ops *tr = dev->tr;
151 struct request_queue *rq = dev->rq;
152 struct request *req = NULL;
153 int background_done = 0;
155 spin_lock_irq(rq->queue_lock);
157 while (!kthread_should_stop()) {
160 dev->bg_stop = false;
161 if (!req && !(req = blk_fetch_request(rq))) {
162 if (tr->background && !background_done) {
163 spin_unlock_irq(rq->queue_lock);
164 mutex_lock(&dev->lock);
166 mutex_unlock(&dev->lock);
167 spin_lock_irq(rq->queue_lock);
169 * Do background processing just once per idle
172 background_done = !dev->bg_stop;
175 set_current_state(TASK_INTERRUPTIBLE);
177 if (kthread_should_stop())
178 set_current_state(TASK_RUNNING);
180 spin_unlock_irq(rq->queue_lock);
182 spin_lock_irq(rq->queue_lock);
186 spin_unlock_irq(rq->queue_lock);
188 mutex_lock(&dev->lock);
189 res = do_blktrans_request(dev->tr, dev, req);
190 mutex_unlock(&dev->lock);
192 spin_lock_irq(rq->queue_lock);
194 if (!__blk_end_request_cur(req, res))
201 __blk_end_request_all(req, -EIO);
203 spin_unlock_irq(rq->queue_lock);
209 #define MTD_RW_SECTORS (2048) // 2048 (BLK_SAFE_MAX_SECTORS+1)
210 static char * mtd_rw_buffer; //[MTD_RW_SECTORS*512] __attribute__((aligned(4096)));
211 struct mutex mtd_rw_buffer_lock;
212 static int req_check_buffer_align(struct request *req,char **pbuf)
216 struct req_iterator iter;
219 char *nextbuffer = 0;
220 unsigned long block, nsect;
221 block = blk_rq_pos(req);
222 nsect = blk_rq_cur_bytes(req) >> 9;
223 rq_for_each_segment(bv, req, iter)
225 buffer = page_address(bv->bv_page) + bv->bv_offset;
233 if(nextbuffer!=buffer)
238 nextbuffer = buffer+bv->bv_len;
245 int mtd_blktrans_cease_background(struct mtd_blktrans_dev *dev)
247 if (kthread_should_stop())
252 EXPORT_SYMBOL_GPL(mtd_blktrans_cease_background);
254 static int mtd_blktrans_thread(void *arg)
256 struct mtd_blktrans_dev *dev = arg;
257 struct mtd_blktrans_ops *tr = dev->tr;
258 struct request_queue *rq = dev->rq;
259 struct request *req = NULL;
260 int background_done = 0;
262 unsigned long block, data_len;
264 struct req_iterator rq_iter;
265 struct bio_vec *bvec;
268 set_user_nice(current,-20);
269 spin_lock_irq(rq->queue_lock);
271 while (!kthread_should_stop()) {
274 dev->bg_stop = false;
275 if (!req && !(req = blk_fetch_request(rq))) {
276 if (tr->background && !background_done) {
277 spin_unlock_irq(rq->queue_lock);
278 mutex_lock(&dev->lock);
280 mutex_unlock(&dev->lock);
281 spin_lock_irq(rq->queue_lock);
283 * Do background processing just once per idle
286 background_done = !dev->bg_stop;
289 set_current_state(TASK_INTERRUPTIBLE);
291 if (kthread_should_stop())
292 set_current_state(TASK_RUNNING);
294 spin_unlock_irq(rq->queue_lock);
296 spin_lock_irq(rq->queue_lock);
299 if ((req->cmd_type != REQ_TYPE_FS) || (blk_rq_pos(req) + blk_rq_sectors(req) > get_capacity(req->rq_disk)))
301 __blk_end_request_all(req, -EIO);
306 spin_unlock_irq(rq->queue_lock);
307 mutex_lock(&dev->lock);
309 block = blk_rq_pos(req);
313 cmd_flag = rq_data_dir(req);
315 if(cmd_flag == READ && mtd_rw_buffer)
319 req_check_buffer_align(req,&buf);
320 nsect = req->__data_len >> 9;
321 if( nsect > MTD_RW_SECTORS ) {
322 printk("%s..%d::nsect=%d,too large , may be error!\n",__FILE__,__LINE__, nsect );
323 nsect = MTD_RW_SECTORS;
326 if(buf == mtd_rw_buffer )
327 mutex_lock(&mtd_rw_buffer_lock);
328 if (tr->readsect(dev, block,nsect, buf))
330 if( buf == mtd_rw_buffer )
333 rq_for_each_segment(bvec, req, rq_iter)
335 memcpy( page_address(bvec->bv_page) + bvec->bv_offset , p , bvec->bv_len );
336 flush_dcache_page(bvec->bv_page); //zyf rq_flush_dcache_pages(req);
339 mutex_unlock(&mtd_rw_buffer_lock);
341 //rq_flush_dcache_pages(req);
345 rq_for_each_segment(bvec, req, rq_iter)
347 //printk("%d buf = %x, lba = %llx , nsec=%x ,offset = %x\n",i,page_address(bvec->bv_page) + bvec->bv_offset,((rq_iter.bio)->bi_sector),(bvec->bv_len),(bvec->bv_offset));
349 flush_dcache_page(bvec->bv_page); //zyf rq_flush_dcache_pages(req);
350 if((page_address(bvec->bv_page) + bvec->bv_offset) == (buf + data_len))
352 data_len += bvec->bv_len;
358 //printk("buf = %x, lba = %lx , nsec=%x \n",buf,block,data_len);
362 if (tr->readsect(dev, block,data_len>>9, buf))
364 //rq_flush_dcache_pages(req);
367 //if (!tr->writesect)
369 //rq_flush_dcache_pages(req);
370 if (tr->writesect(dev, block,data_len>>9, buf))
374 //printk(KERN_NOTICE "Unknown request %u\n", rq_data_dir(req));
379 block += data_len>>9;
380 buf = (page_address(bvec->bv_page) + bvec->bv_offset);
381 data_len = bvec->bv_len;
387 //printk("buf = %x, lba = %lx , nsec=%x \n",buf,block,data_len);
391 if (tr->readsect(dev, block,data_len>>9, buf))
393 //rq_flush_dcache_pages(req);
396 //if (!tr->writesect)
398 //rq_flush_dcache_pages(req);
399 if (tr->writesect(dev, block,data_len>>9, buf))
403 //printk(KERN_NOTICE "Unknown request %u\n", rq_data_dir(req));
409 mutex_unlock(&dev->lock);
410 spin_lock_irq(rq->queue_lock);
411 //printk("__blk_end_request_all %d\n",res);
412 __blk_end_request_all(req, res);
418 __blk_end_request_all(req, -EIO);
420 spin_unlock_irq(rq->queue_lock);
425 static void mtd_blktrans_request(struct request_queue *rq)
427 struct mtd_blktrans_dev *dev;
428 struct request *req = NULL;
433 while ((req = blk_fetch_request(rq)) != NULL)
434 __blk_end_request_all(req, -ENODEV);
437 wake_up_process(dev->thread);
441 static int blktrans_open(struct block_device *bdev, fmode_t mode)
443 struct mtd_blktrans_dev *dev = blktrans_dev_get(bdev->bd_disk);
447 return -ERESTARTSYS; /* FIXME: busy loop! -arnd*/
449 mutex_lock(&dev->lock);
455 __module_get(dev->tr->owner);
461 ret = dev->tr->open(dev);
466 ret = __get_mtd_device(dev->mtd);
472 mutex_unlock(&dev->lock);
473 blktrans_dev_put(dev);
477 if (dev->tr->release)
478 dev->tr->release(dev);
480 module_put(dev->tr->owner);
481 kref_put(&dev->ref, blktrans_dev_release);
482 mutex_unlock(&dev->lock);
483 blktrans_dev_put(dev);
487 static int blktrans_release(struct gendisk *disk, fmode_t mode)
489 struct mtd_blktrans_dev *dev = blktrans_dev_get(disk);
495 mutex_lock(&dev->lock);
500 kref_put(&dev->ref, blktrans_dev_release);
501 module_put(dev->tr->owner);
504 ret = dev->tr->release ? dev->tr->release(dev) : 0;
505 __put_mtd_device(dev->mtd);
508 mutex_unlock(&dev->lock);
509 blktrans_dev_put(dev);
513 static int blktrans_getgeo(struct block_device *bdev, struct hd_geometry *geo)
515 struct mtd_blktrans_dev *dev = blktrans_dev_get(bdev->bd_disk);
521 mutex_lock(&dev->lock);
526 ret = dev->tr->getgeo ? dev->tr->getgeo(dev, geo) : 0;
528 mutex_unlock(&dev->lock);
529 blktrans_dev_put(dev);
533 static int blktrans_ioctl(struct block_device *bdev, fmode_t mode,
534 unsigned int cmd, unsigned long arg)
536 struct mtd_blktrans_dev *dev = blktrans_dev_get(bdev->bd_disk);
542 mutex_lock(&dev->lock);
549 ret = dev->tr->flush ? dev->tr->flush(dev) : 0;
555 mutex_unlock(&dev->lock);
556 blktrans_dev_put(dev);
560 static const struct block_device_operations mtd_blktrans_ops = {
561 .owner = THIS_MODULE,
562 .open = blktrans_open,
563 .release = blktrans_release,
564 .ioctl = blktrans_ioctl,
565 .getgeo = blktrans_getgeo,
568 int add_mtd_blktrans_dev(struct mtd_blktrans_dev *new)
570 struct mtd_blktrans_ops *tr = new->tr;
571 struct mtd_blktrans_dev *d;
572 int last_devnum = -1;
576 if (mutex_trylock(&mtd_table_mutex)) {
577 mutex_unlock(&mtd_table_mutex);
581 mutex_lock(&blktrans_ref_mutex);
582 list_for_each_entry(d, &tr->devs, list) {
583 if (new->devnum == -1) {
584 /* Use first free number */
585 if (d->devnum != last_devnum+1) {
586 /* Found a free devnum. Plug it in here */
587 new->devnum = last_devnum+1;
588 list_add_tail(&new->list, &d->list);
591 } else if (d->devnum == new->devnum) {
592 /* Required number taken */
593 mutex_unlock(&blktrans_ref_mutex);
595 } else if (d->devnum > new->devnum) {
596 /* Required number was free */
597 list_add_tail(&new->list, &d->list);
600 last_devnum = d->devnum;
604 if (new->devnum == -1)
605 new->devnum = last_devnum+1;
607 /* Check that the device and any partitions will get valid
608 * minor numbers and that the disk naming code below can cope
609 * with this number. */
610 if (new->devnum > (MINORMASK >> tr->part_bits) ||
611 (tr->part_bits && new->devnum >= 27 * 26)) {
612 mutex_unlock(&blktrans_ref_mutex);
616 list_add_tail(&new->list, &tr->devs);
618 mutex_unlock(&blktrans_ref_mutex);
620 mutex_init(&new->lock);
621 kref_init(&new->ref);
627 gd = alloc_disk(1 << tr->part_bits);
633 gd->private_data = new;
634 gd->major = tr->major;
635 gd->first_minor = (new->devnum) << tr->part_bits;
636 gd->fops = &mtd_blktrans_ops;
639 if (new->devnum < 26)
640 snprintf(gd->disk_name, sizeof(gd->disk_name),
641 "%s%c", tr->name, 'a' + new->devnum);
643 snprintf(gd->disk_name, sizeof(gd->disk_name),
645 'a' - 1 + new->devnum / 26,
646 'a' + new->devnum % 26);
648 snprintf(gd->disk_name, sizeof(gd->disk_name),
649 "%s%d", tr->name, new->devnum);
651 /* 2.5 has capacity in units of 512 bytes while still
652 having BLOCK_SIZE_BITS set to 10. Just to keep us amused. */
653 //set_capacity(gd, (new->size * tr->blksize) >> 9);
654 set_capacity(gd, (new->size >> 9) * tr->blksize); //modify by zyf for cap>=4GB 20110120
656 /* Create the request queue */
657 spin_lock_init(&new->queue_lock);
658 new->rq = blk_init_queue(mtd_blktrans_request, &new->queue_lock);
663 new->rq->queuedata = new;
664 blk_queue_logical_block_size(new->rq, tr->blksize);
667 blk_queue_max_hw_sectors(new->rq,MTD_RW_SECTORS);
668 //blk_queue_max_segment_size(new->rq,MTD_RW_SECTORS);
669 blk_queue_max_segments(new->rq, MTD_RW_SECTORS);// /PAGE_CACHE_SIZE
673 queue_flag_set_unlocked(QUEUE_FLAG_DISCARD, new->rq);
674 new->rq->limits.max_discard_sectors = UINT_MAX;
679 /* Create processing thread */
680 /* TODO: workqueue ? */
681 new->thread = kthread_run(mtd_blktrans_thread, new,
682 "%s%d", tr->name, new->mtd->index);
683 if (IS_ERR(new->thread)) {
684 ret = PTR_ERR(new->thread);
687 gd->driverfs_dev = &new->mtd->dev;
694 if (new->disk_attributes) {
695 ret = sysfs_create_group(&disk_to_dev(gd)->kobj,
696 new->disk_attributes);
701 blk_cleanup_queue(new->rq);
705 list_del(&new->list);
710 int del_mtd_blktrans_dev(struct mtd_blktrans_dev *old)
714 if (mutex_trylock(&mtd_table_mutex)) {
715 mutex_unlock(&mtd_table_mutex);
719 if (old->disk_attributes)
720 sysfs_remove_group(&disk_to_dev(old->disk)->kobj,
721 old->disk_attributes);
723 /* Stop new requests to arrive */
724 del_gendisk(old->disk);
727 /* Stop the thread */
728 kthread_stop(old->thread);
730 /* Kill current requests */
731 spin_lock_irqsave(&old->queue_lock, flags);
732 old->rq->queuedata = NULL;
733 blk_start_queue(old->rq);
734 spin_unlock_irqrestore(&old->queue_lock, flags);
736 /* If the device is currently open, tell trans driver to close it,
737 then put mtd device, and don't touch it again */
738 mutex_lock(&old->lock);
740 if (old->tr->release)
741 old->tr->release(old);
742 __put_mtd_device(old->mtd);
747 mutex_unlock(&old->lock);
748 blktrans_dev_put(old);
752 static void blktrans_notify_remove(struct mtd_info *mtd)
754 struct mtd_blktrans_ops *tr;
755 struct mtd_blktrans_dev *dev, *next;
757 list_for_each_entry(tr, &blktrans_majors, list)
758 list_for_each_entry_safe(dev, next, &tr->devs, list)
763 static void blktrans_notify_add(struct mtd_info *mtd)
765 struct mtd_blktrans_ops *tr;
767 if (mtd->type == MTD_ABSENT)
770 list_for_each_entry(tr, &blktrans_majors, list)
771 tr->add_mtd(tr, mtd);
774 static struct mtd_notifier blktrans_notifier = {
775 .add = blktrans_notify_add,
776 .remove = blktrans_notify_remove,
779 int register_mtd_blktrans(struct mtd_blktrans_ops *tr)
781 struct mtd_info *mtd;
784 mutex_init(&mtd_rw_buffer_lock);
785 mtd_rw_buffer = kmalloc(MTD_RW_SECTORS*512, GFP_KERNEL | GFP_DMA);
787 /* Register the notifier if/when the first device type is
788 registered, to prevent the link/init ordering from fucking
790 if (!blktrans_notifier.list.next)
791 register_mtd_user(&blktrans_notifier);
794 mutex_lock(&mtd_table_mutex);
796 ret = register_blkdev(tr->major, tr->name);
798 printk(KERN_WARNING "Unable to register %s block device on major %d: %d\n",
799 tr->name, tr->major, ret);
800 mutex_unlock(&mtd_table_mutex);
807 tr->blkshift = ffs(tr->blksize) - 1;
809 INIT_LIST_HEAD(&tr->devs);
810 list_add(&tr->list, &blktrans_majors);
812 mtd_for_each_device(mtd)
813 if (mtd->type != MTD_ABSENT)
814 tr->add_mtd(tr, mtd);
816 mutex_unlock(&mtd_table_mutex);
820 int deregister_mtd_blktrans(struct mtd_blktrans_ops *tr)
822 struct mtd_blktrans_dev *dev, *next;
824 mutex_lock(&mtd_table_mutex);
826 /* Remove it from the list of active majors */
829 list_for_each_entry_safe(dev, next, &tr->devs, list)
832 unregister_blkdev(tr->major, tr->name);
833 mutex_unlock(&mtd_table_mutex);
835 BUG_ON(!list_empty(&tr->devs));
839 static void __exit mtd_blktrans_exit(void)
841 /* No race here -- if someone's currently in register_mtd_blktrans
842 we're screwed anyway. */
843 if (blktrans_notifier.list.next)
844 unregister_mtd_user(&blktrans_notifier);
847 module_exit(mtd_blktrans_exit);
849 EXPORT_SYMBOL_GPL(register_mtd_blktrans);
850 EXPORT_SYMBOL_GPL(deregister_mtd_blktrans);
851 EXPORT_SYMBOL_GPL(add_mtd_blktrans_dev);
852 EXPORT_SYMBOL_GPL(del_mtd_blktrans_dev);
854 MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org>");
855 MODULE_LICENSE("GPL");
856 MODULE_DESCRIPTION("Common interface to block layer for MTD 'translation layers'");