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/mutex.h>
34 #include <asm/uaccess.h>
38 static LIST_HEAD(blktrans_majors
);
39 static DEFINE_MUTEX(blktrans_ref_mutex
);
41 static void blktrans_dev_release(struct kref
*kref
)
43 struct mtd_blktrans_dev
*dev
=
44 container_of(kref
, struct mtd_blktrans_dev
, ref
);
46 dev
->disk
->private_data
= NULL
;
47 blk_cleanup_queue(dev
->rq
);
53 static struct mtd_blktrans_dev
*blktrans_dev_get(struct gendisk
*disk
)
55 struct mtd_blktrans_dev
*dev
;
57 mutex_lock(&blktrans_ref_mutex
);
58 dev
= disk
->private_data
;
64 mutex_unlock(&blktrans_ref_mutex
);
68 static void blktrans_dev_put(struct mtd_blktrans_dev
*dev
)
70 mutex_lock(&blktrans_ref_mutex
);
71 kref_put(&dev
->ref
, blktrans_dev_release
);
72 mutex_unlock(&blktrans_ref_mutex
);
76 static int do_blktrans_request(struct mtd_blktrans_ops
*tr
,
77 struct mtd_blktrans_dev
*dev
,
80 unsigned long block
, nsect
;
83 block
= blk_rq_pos(req
) << 9 >> tr
->blkshift
;
84 nsect
= blk_rq_cur_bytes(req
) >> tr
->blkshift
;
85 buf
= bio_data(req
->bio
);
87 if (req
->cmd_type
!= REQ_TYPE_FS
)
90 if (req_op(req
) == REQ_OP_FLUSH
)
91 return tr
->flush(dev
);
93 if (blk_rq_pos(req
) + blk_rq_cur_sectors(req
) >
94 get_capacity(req
->rq_disk
))
97 if (req_op(req
) == REQ_OP_DISCARD
)
98 return tr
->discard(dev
, block
, nsect
);
100 if (rq_data_dir(req
) == READ
) {
101 for (; nsect
> 0; nsect
--, block
++, buf
+= tr
->blksize
)
102 if (tr
->readsect(dev
, block
, buf
))
104 rq_flush_dcache_pages(req
);
110 rq_flush_dcache_pages(req
);
111 for (; nsect
> 0; nsect
--, block
++, buf
+= tr
->blksize
)
112 if (tr
->writesect(dev
, block
, buf
))
118 int mtd_blktrans_cease_background(struct mtd_blktrans_dev
*dev
)
122 EXPORT_SYMBOL_GPL(mtd_blktrans_cease_background
);
124 static void mtd_blktrans_work(struct work_struct
*work
)
126 struct mtd_blktrans_dev
*dev
=
127 container_of(work
, struct mtd_blktrans_dev
, work
);
128 struct mtd_blktrans_ops
*tr
= dev
->tr
;
129 struct request_queue
*rq
= dev
->rq
;
130 struct request
*req
= NULL
;
131 int background_done
= 0;
133 spin_lock_irq(rq
->queue_lock
);
138 dev
->bg_stop
= false;
139 if (!req
&& !(req
= blk_fetch_request(rq
))) {
140 if (tr
->background
&& !background_done
) {
141 spin_unlock_irq(rq
->queue_lock
);
142 mutex_lock(&dev
->lock
);
144 mutex_unlock(&dev
->lock
);
145 spin_lock_irq(rq
->queue_lock
);
147 * Do background processing just once per idle
150 background_done
= !dev
->bg_stop
;
156 spin_unlock_irq(rq
->queue_lock
);
158 mutex_lock(&dev
->lock
);
159 res
= do_blktrans_request(dev
->tr
, dev
, req
);
160 mutex_unlock(&dev
->lock
);
162 spin_lock_irq(rq
->queue_lock
);
164 if (!__blk_end_request_cur(req
, res
))
170 spin_unlock_irq(rq
->queue_lock
);
173 static void mtd_blktrans_request(struct request_queue
*rq
)
175 struct mtd_blktrans_dev
*dev
;
176 struct request
*req
= NULL
;
181 while ((req
= blk_fetch_request(rq
)) != NULL
)
182 __blk_end_request_all(req
, -ENODEV
);
184 queue_work(dev
->wq
, &dev
->work
);
187 static int blktrans_open(struct block_device
*bdev
, fmode_t mode
)
189 struct mtd_blktrans_dev
*dev
= blktrans_dev_get(bdev
->bd_disk
);
193 return -ERESTARTSYS
; /* FIXME: busy loop! -arnd*/
195 mutex_lock(&mtd_table_mutex
);
196 mutex_lock(&dev
->lock
);
202 __module_get(dev
->tr
->owner
);
208 ret
= dev
->tr
->open(dev
);
213 ret
= __get_mtd_device(dev
->mtd
);
216 dev
->file_mode
= mode
;
220 mutex_unlock(&dev
->lock
);
221 mutex_unlock(&mtd_table_mutex
);
222 blktrans_dev_put(dev
);
226 if (dev
->tr
->release
)
227 dev
->tr
->release(dev
);
229 module_put(dev
->tr
->owner
);
230 kref_put(&dev
->ref
, blktrans_dev_release
);
231 mutex_unlock(&dev
->lock
);
232 mutex_unlock(&mtd_table_mutex
);
233 blktrans_dev_put(dev
);
237 static void blktrans_release(struct gendisk
*disk
, fmode_t mode
)
239 struct mtd_blktrans_dev
*dev
= blktrans_dev_get(disk
);
244 mutex_lock(&mtd_table_mutex
);
245 mutex_lock(&dev
->lock
);
250 kref_put(&dev
->ref
, blktrans_dev_release
);
251 module_put(dev
->tr
->owner
);
254 if (dev
->tr
->release
)
255 dev
->tr
->release(dev
);
256 __put_mtd_device(dev
->mtd
);
259 mutex_unlock(&dev
->lock
);
260 mutex_unlock(&mtd_table_mutex
);
261 blktrans_dev_put(dev
);
264 static int blktrans_getgeo(struct block_device
*bdev
, struct hd_geometry
*geo
)
266 struct mtd_blktrans_dev
*dev
= blktrans_dev_get(bdev
->bd_disk
);
272 mutex_lock(&dev
->lock
);
277 ret
= dev
->tr
->getgeo
? dev
->tr
->getgeo(dev
, geo
) : -ENOTTY
;
279 mutex_unlock(&dev
->lock
);
280 blktrans_dev_put(dev
);
284 static int blktrans_ioctl(struct block_device
*bdev
, fmode_t mode
,
285 unsigned int cmd
, unsigned long arg
)
287 struct mtd_blktrans_dev
*dev
= blktrans_dev_get(bdev
->bd_disk
);
293 mutex_lock(&dev
->lock
);
300 ret
= dev
->tr
->flush
? dev
->tr
->flush(dev
) : 0;
306 mutex_unlock(&dev
->lock
);
307 blktrans_dev_put(dev
);
311 static const struct block_device_operations mtd_block_ops
= {
312 .owner
= THIS_MODULE
,
313 .open
= blktrans_open
,
314 .release
= blktrans_release
,
315 .ioctl
= blktrans_ioctl
,
316 .getgeo
= blktrans_getgeo
,
319 int add_mtd_blktrans_dev(struct mtd_blktrans_dev
*new)
321 struct mtd_blktrans_ops
*tr
= new->tr
;
322 struct mtd_blktrans_dev
*d
;
323 int last_devnum
= -1;
327 if (mutex_trylock(&mtd_table_mutex
)) {
328 mutex_unlock(&mtd_table_mutex
);
332 mutex_lock(&blktrans_ref_mutex
);
333 list_for_each_entry(d
, &tr
->devs
, list
) {
334 if (new->devnum
== -1) {
335 /* Use first free number */
336 if (d
->devnum
!= last_devnum
+1) {
337 /* Found a free devnum. Plug it in here */
338 new->devnum
= last_devnum
+1;
339 list_add_tail(&new->list
, &d
->list
);
342 } else if (d
->devnum
== new->devnum
) {
343 /* Required number taken */
344 mutex_unlock(&blktrans_ref_mutex
);
346 } else if (d
->devnum
> new->devnum
) {
347 /* Required number was free */
348 list_add_tail(&new->list
, &d
->list
);
351 last_devnum
= d
->devnum
;
355 if (new->devnum
== -1)
356 new->devnum
= last_devnum
+1;
358 /* Check that the device and any partitions will get valid
359 * minor numbers and that the disk naming code below can cope
360 * with this number. */
361 if (new->devnum
> (MINORMASK
>> tr
->part_bits
) ||
362 (tr
->part_bits
&& new->devnum
>= 27 * 26)) {
363 mutex_unlock(&blktrans_ref_mutex
);
367 list_add_tail(&new->list
, &tr
->devs
);
369 mutex_unlock(&blktrans_ref_mutex
);
371 mutex_init(&new->lock
);
372 kref_init(&new->ref
);
378 gd
= alloc_disk(1 << tr
->part_bits
);
384 gd
->private_data
= new;
385 gd
->major
= tr
->major
;
386 gd
->first_minor
= (new->devnum
) << tr
->part_bits
;
387 gd
->fops
= &mtd_block_ops
;
390 if (new->devnum
< 26)
391 snprintf(gd
->disk_name
, sizeof(gd
->disk_name
),
392 "%s%c", tr
->name
, 'a' + new->devnum
);
394 snprintf(gd
->disk_name
, sizeof(gd
->disk_name
),
396 'a' - 1 + new->devnum
/ 26,
397 'a' + new->devnum
% 26);
399 snprintf(gd
->disk_name
, sizeof(gd
->disk_name
),
400 "%s%d", tr
->name
, new->devnum
);
402 set_capacity(gd
, ((u64
)new->size
* tr
->blksize
) >> 9);
404 /* Create the request queue */
405 spin_lock_init(&new->queue_lock
);
406 new->rq
= blk_init_queue(mtd_blktrans_request
, &new->queue_lock
);
412 blk_queue_write_cache(new->rq
, true, false);
414 new->rq
->queuedata
= new;
415 blk_queue_logical_block_size(new->rq
, tr
->blksize
);
417 queue_flag_set_unlocked(QUEUE_FLAG_NONROT
, new->rq
);
418 queue_flag_clear_unlocked(QUEUE_FLAG_ADD_RANDOM
, new->rq
);
421 queue_flag_set_unlocked(QUEUE_FLAG_DISCARD
, new->rq
);
422 blk_queue_max_discard_sectors(new->rq
, UINT_MAX
);
427 /* Create processing workqueue */
428 new->wq
= alloc_workqueue("%s%d", 0, 0,
429 tr
->name
, new->mtd
->index
);
432 INIT_WORK(&new->work
, mtd_blktrans_work
);
437 device_add_disk(&new->mtd
->dev
, gd
);
439 if (new->disk_attributes
) {
440 ret
= sysfs_create_group(&disk_to_dev(gd
)->kobj
,
441 new->disk_attributes
);
446 blk_cleanup_queue(new->rq
);
450 list_del(&new->list
);
455 int del_mtd_blktrans_dev(struct mtd_blktrans_dev
*old
)
459 if (mutex_trylock(&mtd_table_mutex
)) {
460 mutex_unlock(&mtd_table_mutex
);
464 if (old
->disk_attributes
)
465 sysfs_remove_group(&disk_to_dev(old
->disk
)->kobj
,
466 old
->disk_attributes
);
468 /* Stop new requests to arrive */
469 del_gendisk(old
->disk
);
471 /* Stop workqueue. This will perform any pending request. */
472 destroy_workqueue(old
->wq
);
474 /* Kill current requests */
475 spin_lock_irqsave(&old
->queue_lock
, flags
);
476 old
->rq
->queuedata
= NULL
;
477 blk_start_queue(old
->rq
);
478 spin_unlock_irqrestore(&old
->queue_lock
, flags
);
480 /* If the device is currently open, tell trans driver to close it,
481 then put mtd device, and don't touch it again */
482 mutex_lock(&old
->lock
);
484 if (old
->tr
->release
)
485 old
->tr
->release(old
);
486 __put_mtd_device(old
->mtd
);
491 mutex_unlock(&old
->lock
);
492 blktrans_dev_put(old
);
496 static void blktrans_notify_remove(struct mtd_info
*mtd
)
498 struct mtd_blktrans_ops
*tr
;
499 struct mtd_blktrans_dev
*dev
, *next
;
501 list_for_each_entry(tr
, &blktrans_majors
, list
)
502 list_for_each_entry_safe(dev
, next
, &tr
->devs
, list
)
507 static void blktrans_notify_add(struct mtd_info
*mtd
)
509 struct mtd_blktrans_ops
*tr
;
511 if (mtd
->type
== MTD_ABSENT
)
514 list_for_each_entry(tr
, &blktrans_majors
, list
)
515 tr
->add_mtd(tr
, mtd
);
518 static struct mtd_notifier blktrans_notifier
= {
519 .add
= blktrans_notify_add
,
520 .remove
= blktrans_notify_remove
,
523 int register_mtd_blktrans(struct mtd_blktrans_ops
*tr
)
525 struct mtd_info
*mtd
;
528 /* Register the notifier if/when the first device type is
529 registered, to prevent the link/init ordering from fucking
531 if (!blktrans_notifier
.list
.next
)
532 register_mtd_user(&blktrans_notifier
);
535 mutex_lock(&mtd_table_mutex
);
537 ret
= register_blkdev(tr
->major
, tr
->name
);
539 printk(KERN_WARNING
"Unable to register %s block device on major %d: %d\n",
540 tr
->name
, tr
->major
, ret
);
541 mutex_unlock(&mtd_table_mutex
);
548 tr
->blkshift
= ffs(tr
->blksize
) - 1;
550 INIT_LIST_HEAD(&tr
->devs
);
551 list_add(&tr
->list
, &blktrans_majors
);
553 mtd_for_each_device(mtd
)
554 if (mtd
->type
!= MTD_ABSENT
)
555 tr
->add_mtd(tr
, mtd
);
557 mutex_unlock(&mtd_table_mutex
);
561 int deregister_mtd_blktrans(struct mtd_blktrans_ops
*tr
)
563 struct mtd_blktrans_dev
*dev
, *next
;
565 mutex_lock(&mtd_table_mutex
);
567 /* Remove it from the list of active majors */
570 list_for_each_entry_safe(dev
, next
, &tr
->devs
, list
)
573 unregister_blkdev(tr
->major
, tr
->name
);
574 mutex_unlock(&mtd_table_mutex
);
576 BUG_ON(!list_empty(&tr
->devs
));
580 static void __exit
mtd_blktrans_exit(void)
582 /* No race here -- if someone's currently in register_mtd_blktrans
583 we're screwed anyway. */
584 if (blktrans_notifier
.list
.next
)
585 unregister_mtd_user(&blktrans_notifier
);
588 module_exit(mtd_blktrans_exit
);
590 EXPORT_SYMBOL_GPL(register_mtd_blktrans
);
591 EXPORT_SYMBOL_GPL(deregister_mtd_blktrans
);
592 EXPORT_SYMBOL_GPL(add_mtd_blktrans_dev
);
593 EXPORT_SYMBOL_GPL(del_mtd_blktrans_dev
);
595 MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org>");
596 MODULE_LICENSE("GPL");
597 MODULE_DESCRIPTION("Common interface to block layer for MTD 'translation layers'");