2 * Copyright (C) 2000 Jens Axboe <axboe@suse.de>
3 * Copyright (C) 2001-2004 Peter Osterlund <petero2@telia.com>
4 * Copyright (C) 2006 Thomas Maier <balagi@justmail.de>
6 * May be copied or modified under the terms of the GNU General Public
7 * License. See linux/COPYING for more information.
9 * Packet writing layer for ATAPI and SCSI CD-RW, DVD+RW, DVD-RW and
12 * Theory of operation:
14 * At the lowest level, there is the standard driver for the CD/DVD device,
15 * typically ide-cd.c or sr.c. This driver can handle read and write requests,
16 * but it doesn't know anything about the special restrictions that apply to
17 * packet writing. One restriction is that write requests must be aligned to
18 * packet boundaries on the physical media, and the size of a write request
19 * must be equal to the packet size. Another restriction is that a
20 * GPCMD_FLUSH_CACHE command has to be issued to the drive before a read
21 * command, if the previous command was a write.
23 * The purpose of the packet writing driver is to hide these restrictions from
24 * higher layers, such as file systems, and present a block device that can be
25 * randomly read and written using 2kB-sized blocks.
27 * The lowest layer in the packet writing driver is the packet I/O scheduler.
28 * Its data is defined by the struct packet_iosched and includes two bio
29 * queues with pending read and write requests. These queues are processed
30 * by the pkt_iosched_process_queue() function. The write requests in this
31 * queue are already properly aligned and sized. This layer is responsible for
32 * issuing the flush cache commands and scheduling the I/O in a good order.
34 * The next layer transforms unaligned write requests to aligned writes. This
35 * transformation requires reading missing pieces of data from the underlying
36 * block device, assembling the pieces to full packets and queuing them to the
37 * packet I/O scheduler.
39 * At the top layer there is a custom make_request_fn function that forwards
40 * read requests directly to the iosched queue and puts write requests in the
41 * unaligned write queue. A kernel thread performs the necessary read
42 * gathering to convert the unaligned writes to aligned writes and then feeds
43 * them to the packet I/O scheduler.
45 *************************************************************************/
47 #include <linux/pktcdvd.h>
48 #include <linux/module.h>
49 #include <linux/types.h>
50 #include <linux/kernel.h>
51 #include <linux/compat.h>
52 #include <linux/kthread.h>
53 #include <linux/errno.h>
54 #include <linux/spinlock.h>
55 #include <linux/file.h>
56 #include <linux/proc_fs.h>
57 #include <linux/seq_file.h>
58 #include <linux/miscdevice.h>
59 #include <linux/freezer.h>
60 #include <linux/mutex.h>
61 #include <linux/slab.h>
62 #include <scsi/scsi_cmnd.h>
63 #include <scsi/scsi_ioctl.h>
64 #include <scsi/scsi.h>
65 #include <linux/debugfs.h>
66 #include <linux/device.h>
68 #include <asm/uaccess.h>
70 #define DRIVER_NAME "pktcdvd"
73 #define DPRINTK(fmt, args...) printk(KERN_NOTICE fmt, ##args)
75 #define DPRINTK(fmt, args...)
79 #define VPRINTK(fmt, args...) printk(KERN_NOTICE fmt, ##args)
81 #define VPRINTK(fmt, args...)
84 #define MAX_SPEED 0xffff
86 #define ZONE(sector, pd) (((sector) + (pd)->offset) & ~((pd)->settings.size - 1))
88 static DEFINE_MUTEX(pktcdvd_mutex
);
89 static struct pktcdvd_device
*pkt_devs
[MAX_WRITERS
];
90 static struct proc_dir_entry
*pkt_proc
;
91 static int pktdev_major
;
92 static int write_congestion_on
= PKT_WRITE_CONGESTION_ON
;
93 static int write_congestion_off
= PKT_WRITE_CONGESTION_OFF
;
94 static struct mutex ctl_mutex
; /* Serialize open/close/setup/teardown */
95 static mempool_t
*psd_pool
;
97 static struct class *class_pktcdvd
= NULL
; /* /sys/class/pktcdvd */
98 static struct dentry
*pkt_debugfs_root
= NULL
; /* /sys/kernel/debug/pktcdvd */
100 /* forward declaration */
101 static int pkt_setup_dev(dev_t dev
, dev_t
* pkt_dev
);
102 static int pkt_remove_dev(dev_t pkt_dev
);
103 static int pkt_seq_show(struct seq_file
*m
, void *p
);
108 * create and register a pktcdvd kernel object.
110 static struct pktcdvd_kobj
* pkt_kobj_create(struct pktcdvd_device
*pd
,
112 struct kobject
* parent
,
113 struct kobj_type
* ktype
)
115 struct pktcdvd_kobj
*p
;
118 p
= kzalloc(sizeof(*p
), GFP_KERNEL
);
122 error
= kobject_init_and_add(&p
->kobj
, ktype
, parent
, "%s", name
);
124 kobject_put(&p
->kobj
);
127 kobject_uevent(&p
->kobj
, KOBJ_ADD
);
131 * remove a pktcdvd kernel object.
133 static void pkt_kobj_remove(struct pktcdvd_kobj
*p
)
136 kobject_put(&p
->kobj
);
139 * default release function for pktcdvd kernel objects.
141 static void pkt_kobj_release(struct kobject
*kobj
)
143 kfree(to_pktcdvdkobj(kobj
));
147 /**********************************************************
149 * sysfs interface for pktcdvd
150 * by (C) 2006 Thomas Maier <balagi@justmail.de>
152 **********************************************************/
154 #define DEF_ATTR(_obj,_name,_mode) \
155 static struct attribute _obj = { .name = _name, .mode = _mode }
157 /**********************************************************
158 /sys/class/pktcdvd/pktcdvd[0-7]/
161 stat/packets_finished
166 write_queue/congestion_off
167 write_queue/congestion_on
168 **********************************************************/
170 DEF_ATTR(kobj_pkt_attr_st1
, "reset", 0200);
171 DEF_ATTR(kobj_pkt_attr_st2
, "packets_started", 0444);
172 DEF_ATTR(kobj_pkt_attr_st3
, "packets_finished", 0444);
173 DEF_ATTR(kobj_pkt_attr_st4
, "kb_written", 0444);
174 DEF_ATTR(kobj_pkt_attr_st5
, "kb_read", 0444);
175 DEF_ATTR(kobj_pkt_attr_st6
, "kb_read_gather", 0444);
177 static struct attribute
*kobj_pkt_attrs_stat
[] = {
187 DEF_ATTR(kobj_pkt_attr_wq1
, "size", 0444);
188 DEF_ATTR(kobj_pkt_attr_wq2
, "congestion_off", 0644);
189 DEF_ATTR(kobj_pkt_attr_wq3
, "congestion_on", 0644);
191 static struct attribute
*kobj_pkt_attrs_wqueue
[] = {
198 static ssize_t
kobj_pkt_show(struct kobject
*kobj
,
199 struct attribute
*attr
, char *data
)
201 struct pktcdvd_device
*pd
= to_pktcdvdkobj(kobj
)->pd
;
204 if (strcmp(attr
->name
, "packets_started") == 0) {
205 n
= sprintf(data
, "%lu\n", pd
->stats
.pkt_started
);
207 } else if (strcmp(attr
->name
, "packets_finished") == 0) {
208 n
= sprintf(data
, "%lu\n", pd
->stats
.pkt_ended
);
210 } else if (strcmp(attr
->name
, "kb_written") == 0) {
211 n
= sprintf(data
, "%lu\n", pd
->stats
.secs_w
>> 1);
213 } else if (strcmp(attr
->name
, "kb_read") == 0) {
214 n
= sprintf(data
, "%lu\n", pd
->stats
.secs_r
>> 1);
216 } else if (strcmp(attr
->name
, "kb_read_gather") == 0) {
217 n
= sprintf(data
, "%lu\n", pd
->stats
.secs_rg
>> 1);
219 } else if (strcmp(attr
->name
, "size") == 0) {
220 spin_lock(&pd
->lock
);
221 v
= pd
->bio_queue_size
;
222 spin_unlock(&pd
->lock
);
223 n
= sprintf(data
, "%d\n", v
);
225 } else if (strcmp(attr
->name
, "congestion_off") == 0) {
226 spin_lock(&pd
->lock
);
227 v
= pd
->write_congestion_off
;
228 spin_unlock(&pd
->lock
);
229 n
= sprintf(data
, "%d\n", v
);
231 } else if (strcmp(attr
->name
, "congestion_on") == 0) {
232 spin_lock(&pd
->lock
);
233 v
= pd
->write_congestion_on
;
234 spin_unlock(&pd
->lock
);
235 n
= sprintf(data
, "%d\n", v
);
240 static void init_write_congestion_marks(int* lo
, int* hi
)
244 *hi
= min(*hi
, 1000000);
248 *lo
= min(*lo
, *hi
- 100);
257 static ssize_t
kobj_pkt_store(struct kobject
*kobj
,
258 struct attribute
*attr
,
259 const char *data
, size_t len
)
261 struct pktcdvd_device
*pd
= to_pktcdvdkobj(kobj
)->pd
;
264 if (strcmp(attr
->name
, "reset") == 0 && len
> 0) {
265 pd
->stats
.pkt_started
= 0;
266 pd
->stats
.pkt_ended
= 0;
267 pd
->stats
.secs_w
= 0;
268 pd
->stats
.secs_rg
= 0;
269 pd
->stats
.secs_r
= 0;
271 } else if (strcmp(attr
->name
, "congestion_off") == 0
272 && sscanf(data
, "%d", &val
) == 1) {
273 spin_lock(&pd
->lock
);
274 pd
->write_congestion_off
= val
;
275 init_write_congestion_marks(&pd
->write_congestion_off
,
276 &pd
->write_congestion_on
);
277 spin_unlock(&pd
->lock
);
279 } else if (strcmp(attr
->name
, "congestion_on") == 0
280 && sscanf(data
, "%d", &val
) == 1) {
281 spin_lock(&pd
->lock
);
282 pd
->write_congestion_on
= val
;
283 init_write_congestion_marks(&pd
->write_congestion_off
,
284 &pd
->write_congestion_on
);
285 spin_unlock(&pd
->lock
);
290 static const struct sysfs_ops kobj_pkt_ops
= {
291 .show
= kobj_pkt_show
,
292 .store
= kobj_pkt_store
294 static struct kobj_type kobj_pkt_type_stat
= {
295 .release
= pkt_kobj_release
,
296 .sysfs_ops
= &kobj_pkt_ops
,
297 .default_attrs
= kobj_pkt_attrs_stat
299 static struct kobj_type kobj_pkt_type_wqueue
= {
300 .release
= pkt_kobj_release
,
301 .sysfs_ops
= &kobj_pkt_ops
,
302 .default_attrs
= kobj_pkt_attrs_wqueue
305 static void pkt_sysfs_dev_new(struct pktcdvd_device
*pd
)
308 pd
->dev
= device_create(class_pktcdvd
, NULL
, MKDEV(0, 0), NULL
,
314 pd
->kobj_stat
= pkt_kobj_create(pd
, "stat",
316 &kobj_pkt_type_stat
);
317 pd
->kobj_wqueue
= pkt_kobj_create(pd
, "write_queue",
319 &kobj_pkt_type_wqueue
);
323 static void pkt_sysfs_dev_remove(struct pktcdvd_device
*pd
)
325 pkt_kobj_remove(pd
->kobj_stat
);
326 pkt_kobj_remove(pd
->kobj_wqueue
);
328 device_unregister(pd
->dev
);
332 /********************************************************************
335 remove unmap packet dev
336 device_map show mappings
337 *******************************************************************/
339 static void class_pktcdvd_release(struct class *cls
)
343 static ssize_t
class_pktcdvd_show_map(struct class *c
,
344 struct class_attribute
*attr
,
349 mutex_lock_nested(&ctl_mutex
, SINGLE_DEPTH_NESTING
);
350 for (idx
= 0; idx
< MAX_WRITERS
; idx
++) {
351 struct pktcdvd_device
*pd
= pkt_devs
[idx
];
354 n
+= sprintf(data
+n
, "%s %u:%u %u:%u\n",
356 MAJOR(pd
->pkt_dev
), MINOR(pd
->pkt_dev
),
357 MAJOR(pd
->bdev
->bd_dev
),
358 MINOR(pd
->bdev
->bd_dev
));
360 mutex_unlock(&ctl_mutex
);
364 static ssize_t
class_pktcdvd_store_add(struct class *c
,
365 struct class_attribute
*attr
,
369 unsigned int major
, minor
;
371 if (sscanf(buf
, "%u:%u", &major
, &minor
) == 2) {
372 /* pkt_setup_dev() expects caller to hold reference to self */
373 if (!try_module_get(THIS_MODULE
))
376 pkt_setup_dev(MKDEV(major
, minor
), NULL
);
378 module_put(THIS_MODULE
);
386 static ssize_t
class_pktcdvd_store_remove(struct class *c
,
387 struct class_attribute
*attr
,
391 unsigned int major
, minor
;
392 if (sscanf(buf
, "%u:%u", &major
, &minor
) == 2) {
393 pkt_remove_dev(MKDEV(major
, minor
));
399 static struct class_attribute class_pktcdvd_attrs
[] = {
400 __ATTR(add
, 0200, NULL
, class_pktcdvd_store_add
),
401 __ATTR(remove
, 0200, NULL
, class_pktcdvd_store_remove
),
402 __ATTR(device_map
, 0444, class_pktcdvd_show_map
, NULL
),
407 static int pkt_sysfs_init(void)
412 * create control files in sysfs
413 * /sys/class/pktcdvd/...
415 class_pktcdvd
= kzalloc(sizeof(*class_pktcdvd
), GFP_KERNEL
);
418 class_pktcdvd
->name
= DRIVER_NAME
;
419 class_pktcdvd
->owner
= THIS_MODULE
;
420 class_pktcdvd
->class_release
= class_pktcdvd_release
;
421 class_pktcdvd
->class_attrs
= class_pktcdvd_attrs
;
422 ret
= class_register(class_pktcdvd
);
424 kfree(class_pktcdvd
);
425 class_pktcdvd
= NULL
;
426 printk(DRIVER_NAME
": failed to create class pktcdvd\n");
432 static void pkt_sysfs_cleanup(void)
435 class_destroy(class_pktcdvd
);
436 class_pktcdvd
= NULL
;
439 /********************************************************************
442 /sys/kernel/debug/pktcdvd[0-7]/
445 *******************************************************************/
447 static int pkt_debugfs_seq_show(struct seq_file
*m
, void *p
)
449 return pkt_seq_show(m
, p
);
452 static int pkt_debugfs_fops_open(struct inode
*inode
, struct file
*file
)
454 return single_open(file
, pkt_debugfs_seq_show
, inode
->i_private
);
457 static const struct file_operations debug_fops
= {
458 .open
= pkt_debugfs_fops_open
,
461 .release
= single_release
,
462 .owner
= THIS_MODULE
,
465 static void pkt_debugfs_dev_new(struct pktcdvd_device
*pd
)
467 if (!pkt_debugfs_root
)
469 pd
->dfs_f_info
= NULL
;
470 pd
->dfs_d_root
= debugfs_create_dir(pd
->name
, pkt_debugfs_root
);
471 if (IS_ERR(pd
->dfs_d_root
)) {
472 pd
->dfs_d_root
= NULL
;
475 pd
->dfs_f_info
= debugfs_create_file("info", S_IRUGO
,
476 pd
->dfs_d_root
, pd
, &debug_fops
);
477 if (IS_ERR(pd
->dfs_f_info
)) {
478 pd
->dfs_f_info
= NULL
;
483 static void pkt_debugfs_dev_remove(struct pktcdvd_device
*pd
)
485 if (!pkt_debugfs_root
)
488 debugfs_remove(pd
->dfs_f_info
);
489 pd
->dfs_f_info
= NULL
;
491 debugfs_remove(pd
->dfs_d_root
);
492 pd
->dfs_d_root
= NULL
;
495 static void pkt_debugfs_init(void)
497 pkt_debugfs_root
= debugfs_create_dir(DRIVER_NAME
, NULL
);
498 if (IS_ERR(pkt_debugfs_root
)) {
499 pkt_debugfs_root
= NULL
;
504 static void pkt_debugfs_cleanup(void)
506 if (!pkt_debugfs_root
)
508 debugfs_remove(pkt_debugfs_root
);
509 pkt_debugfs_root
= NULL
;
512 /* ----------------------------------------------------------*/
515 static void pkt_bio_finished(struct pktcdvd_device
*pd
)
517 BUG_ON(atomic_read(&pd
->cdrw
.pending_bios
) <= 0);
518 if (atomic_dec_and_test(&pd
->cdrw
.pending_bios
)) {
519 VPRINTK(DRIVER_NAME
": queue empty\n");
520 atomic_set(&pd
->iosched
.attention
, 1);
521 wake_up(&pd
->wqueue
);
526 * Allocate a packet_data struct
528 static struct packet_data
*pkt_alloc_packet_data(int frames
)
531 struct packet_data
*pkt
;
533 pkt
= kzalloc(sizeof(struct packet_data
), GFP_KERNEL
);
537 pkt
->frames
= frames
;
538 pkt
->w_bio
= bio_kmalloc(GFP_KERNEL
, frames
);
542 for (i
= 0; i
< frames
/ FRAMES_PER_PAGE
; i
++) {
543 pkt
->pages
[i
] = alloc_page(GFP_KERNEL
|__GFP_ZERO
);
548 spin_lock_init(&pkt
->lock
);
549 bio_list_init(&pkt
->orig_bios
);
551 for (i
= 0; i
< frames
; i
++) {
552 struct bio
*bio
= bio_kmalloc(GFP_KERNEL
, 1);
556 pkt
->r_bios
[i
] = bio
;
562 for (i
= 0; i
< frames
; i
++) {
563 struct bio
*bio
= pkt
->r_bios
[i
];
569 for (i
= 0; i
< frames
/ FRAMES_PER_PAGE
; i
++)
571 __free_page(pkt
->pages
[i
]);
580 * Free a packet_data struct
582 static void pkt_free_packet_data(struct packet_data
*pkt
)
586 for (i
= 0; i
< pkt
->frames
; i
++) {
587 struct bio
*bio
= pkt
->r_bios
[i
];
591 for (i
= 0; i
< pkt
->frames
/ FRAMES_PER_PAGE
; i
++)
592 __free_page(pkt
->pages
[i
]);
597 static void pkt_shrink_pktlist(struct pktcdvd_device
*pd
)
599 struct packet_data
*pkt
, *next
;
601 BUG_ON(!list_empty(&pd
->cdrw
.pkt_active_list
));
603 list_for_each_entry_safe(pkt
, next
, &pd
->cdrw
.pkt_free_list
, list
) {
604 pkt_free_packet_data(pkt
);
606 INIT_LIST_HEAD(&pd
->cdrw
.pkt_free_list
);
609 static int pkt_grow_pktlist(struct pktcdvd_device
*pd
, int nr_packets
)
611 struct packet_data
*pkt
;
613 BUG_ON(!list_empty(&pd
->cdrw
.pkt_free_list
));
615 while (nr_packets
> 0) {
616 pkt
= pkt_alloc_packet_data(pd
->settings
.size
>> 2);
618 pkt_shrink_pktlist(pd
);
621 pkt
->id
= nr_packets
;
623 list_add(&pkt
->list
, &pd
->cdrw
.pkt_free_list
);
629 static inline struct pkt_rb_node
*pkt_rbtree_next(struct pkt_rb_node
*node
)
631 struct rb_node
*n
= rb_next(&node
->rb_node
);
634 return rb_entry(n
, struct pkt_rb_node
, rb_node
);
637 static void pkt_rbtree_erase(struct pktcdvd_device
*pd
, struct pkt_rb_node
*node
)
639 rb_erase(&node
->rb_node
, &pd
->bio_queue
);
640 mempool_free(node
, pd
->rb_pool
);
641 pd
->bio_queue_size
--;
642 BUG_ON(pd
->bio_queue_size
< 0);
646 * Find the first node in the pd->bio_queue rb tree with a starting sector >= s.
648 static struct pkt_rb_node
*pkt_rbtree_find(struct pktcdvd_device
*pd
, sector_t s
)
650 struct rb_node
*n
= pd
->bio_queue
.rb_node
;
651 struct rb_node
*next
;
652 struct pkt_rb_node
*tmp
;
655 BUG_ON(pd
->bio_queue_size
> 0);
660 tmp
= rb_entry(n
, struct pkt_rb_node
, rb_node
);
661 if (s
<= tmp
->bio
->bi_sector
)
670 if (s
> tmp
->bio
->bi_sector
) {
671 tmp
= pkt_rbtree_next(tmp
);
675 BUG_ON(s
> tmp
->bio
->bi_sector
);
680 * Insert a node into the pd->bio_queue rb tree.
682 static void pkt_rbtree_insert(struct pktcdvd_device
*pd
, struct pkt_rb_node
*node
)
684 struct rb_node
**p
= &pd
->bio_queue
.rb_node
;
685 struct rb_node
*parent
= NULL
;
686 sector_t s
= node
->bio
->bi_sector
;
687 struct pkt_rb_node
*tmp
;
691 tmp
= rb_entry(parent
, struct pkt_rb_node
, rb_node
);
692 if (s
< tmp
->bio
->bi_sector
)
697 rb_link_node(&node
->rb_node
, parent
, p
);
698 rb_insert_color(&node
->rb_node
, &pd
->bio_queue
);
699 pd
->bio_queue_size
++;
703 * Send a packet_command to the underlying block device and
704 * wait for completion.
706 static int pkt_generic_packet(struct pktcdvd_device
*pd
, struct packet_command
*cgc
)
708 struct request_queue
*q
= bdev_get_queue(pd
->bdev
);
712 rq
= blk_get_request(q
, (cgc
->data_direction
== CGC_DATA_WRITE
) ?
713 WRITE
: READ
, __GFP_WAIT
);
716 if (blk_rq_map_kern(q
, rq
, cgc
->buffer
, cgc
->buflen
, __GFP_WAIT
))
720 rq
->cmd_len
= COMMAND_SIZE(cgc
->cmd
[0]);
721 memcpy(rq
->cmd
, cgc
->cmd
, CDROM_PACKET_SIZE
);
724 rq
->cmd_type
= REQ_TYPE_BLOCK_PC
;
726 rq
->cmd_flags
|= REQ_QUIET
;
728 blk_execute_rq(rq
->q
, pd
->bdev
->bd_disk
, rq
, 0);
737 * A generic sense dump / resolve mechanism should be implemented across
738 * all ATAPI + SCSI devices.
740 static void pkt_dump_sense(struct packet_command
*cgc
)
742 static char *info
[9] = { "No sense", "Recovered error", "Not ready",
743 "Medium error", "Hardware error", "Illegal request",
744 "Unit attention", "Data protect", "Blank check" };
746 struct request_sense
*sense
= cgc
->sense
;
748 printk(DRIVER_NAME
":");
749 for (i
= 0; i
< CDROM_PACKET_SIZE
; i
++)
750 printk(" %02x", cgc
->cmd
[i
]);
754 printk("no sense\n");
758 printk("sense %02x.%02x.%02x", sense
->sense_key
, sense
->asc
, sense
->ascq
);
760 if (sense
->sense_key
> 8) {
761 printk(" (INVALID)\n");
765 printk(" (%s)\n", info
[sense
->sense_key
]);
769 * flush the drive cache to media
771 static int pkt_flush_cache(struct pktcdvd_device
*pd
)
773 struct packet_command cgc
;
775 init_cdrom_command(&cgc
, NULL
, 0, CGC_DATA_NONE
);
776 cgc
.cmd
[0] = GPCMD_FLUSH_CACHE
;
780 * the IMMED bit -- we default to not setting it, although that
781 * would allow a much faster close, this is safer
786 return pkt_generic_packet(pd
, &cgc
);
790 * speed is given as the normal factor, e.g. 4 for 4x
792 static noinline_for_stack
int pkt_set_speed(struct pktcdvd_device
*pd
,
793 unsigned write_speed
, unsigned read_speed
)
795 struct packet_command cgc
;
796 struct request_sense sense
;
799 init_cdrom_command(&cgc
, NULL
, 0, CGC_DATA_NONE
);
801 cgc
.cmd
[0] = GPCMD_SET_SPEED
;
802 cgc
.cmd
[2] = (read_speed
>> 8) & 0xff;
803 cgc
.cmd
[3] = read_speed
& 0xff;
804 cgc
.cmd
[4] = (write_speed
>> 8) & 0xff;
805 cgc
.cmd
[5] = write_speed
& 0xff;
807 if ((ret
= pkt_generic_packet(pd
, &cgc
)))
808 pkt_dump_sense(&cgc
);
814 * Queue a bio for processing by the low-level CD device. Must be called
815 * from process context.
817 static void pkt_queue_bio(struct pktcdvd_device
*pd
, struct bio
*bio
)
819 spin_lock(&pd
->iosched
.lock
);
820 if (bio_data_dir(bio
) == READ
)
821 bio_list_add(&pd
->iosched
.read_queue
, bio
);
823 bio_list_add(&pd
->iosched
.write_queue
, bio
);
824 spin_unlock(&pd
->iosched
.lock
);
826 atomic_set(&pd
->iosched
.attention
, 1);
827 wake_up(&pd
->wqueue
);
831 * Process the queued read/write requests. This function handles special
832 * requirements for CDRW drives:
833 * - A cache flush command must be inserted before a read request if the
834 * previous request was a write.
835 * - Switching between reading and writing is slow, so don't do it more often
837 * - Optimize for throughput at the expense of latency. This means that streaming
838 * writes will never be interrupted by a read, but if the drive has to seek
839 * before the next write, switch to reading instead if there are any pending
841 * - Set the read speed according to current usage pattern. When only reading
842 * from the device, it's best to use the highest possible read speed, but
843 * when switching often between reading and writing, it's better to have the
844 * same read and write speeds.
846 static void pkt_iosched_process_queue(struct pktcdvd_device
*pd
)
849 if (atomic_read(&pd
->iosched
.attention
) == 0)
851 atomic_set(&pd
->iosched
.attention
, 0);
855 int reads_queued
, writes_queued
;
857 spin_lock(&pd
->iosched
.lock
);
858 reads_queued
= !bio_list_empty(&pd
->iosched
.read_queue
);
859 writes_queued
= !bio_list_empty(&pd
->iosched
.write_queue
);
860 spin_unlock(&pd
->iosched
.lock
);
862 if (!reads_queued
&& !writes_queued
)
865 if (pd
->iosched
.writing
) {
866 int need_write_seek
= 1;
867 spin_lock(&pd
->iosched
.lock
);
868 bio
= bio_list_peek(&pd
->iosched
.write_queue
);
869 spin_unlock(&pd
->iosched
.lock
);
870 if (bio
&& (bio
->bi_sector
== pd
->iosched
.last_write
))
872 if (need_write_seek
&& reads_queued
) {
873 if (atomic_read(&pd
->cdrw
.pending_bios
) > 0) {
874 VPRINTK(DRIVER_NAME
": write, waiting\n");
878 pd
->iosched
.writing
= 0;
881 if (!reads_queued
&& writes_queued
) {
882 if (atomic_read(&pd
->cdrw
.pending_bios
) > 0) {
883 VPRINTK(DRIVER_NAME
": read, waiting\n");
886 pd
->iosched
.writing
= 1;
890 spin_lock(&pd
->iosched
.lock
);
891 if (pd
->iosched
.writing
)
892 bio
= bio_list_pop(&pd
->iosched
.write_queue
);
894 bio
= bio_list_pop(&pd
->iosched
.read_queue
);
895 spin_unlock(&pd
->iosched
.lock
);
900 if (bio_data_dir(bio
) == READ
)
901 pd
->iosched
.successive_reads
+= bio
->bi_size
>> 10;
903 pd
->iosched
.successive_reads
= 0;
904 pd
->iosched
.last_write
= bio_end_sector(bio
);
906 if (pd
->iosched
.successive_reads
>= HI_SPEED_SWITCH
) {
907 if (pd
->read_speed
== pd
->write_speed
) {
908 pd
->read_speed
= MAX_SPEED
;
909 pkt_set_speed(pd
, pd
->write_speed
, pd
->read_speed
);
912 if (pd
->read_speed
!= pd
->write_speed
) {
913 pd
->read_speed
= pd
->write_speed
;
914 pkt_set_speed(pd
, pd
->write_speed
, pd
->read_speed
);
918 atomic_inc(&pd
->cdrw
.pending_bios
);
919 generic_make_request(bio
);
924 * Special care is needed if the underlying block device has a small
925 * max_phys_segments value.
927 static int pkt_set_segment_merging(struct pktcdvd_device
*pd
, struct request_queue
*q
)
929 if ((pd
->settings
.size
<< 9) / CD_FRAMESIZE
930 <= queue_max_segments(q
)) {
932 * The cdrom device can handle one segment/frame
934 clear_bit(PACKET_MERGE_SEGS
, &pd
->flags
);
936 } else if ((pd
->settings
.size
<< 9) / PAGE_SIZE
937 <= queue_max_segments(q
)) {
939 * We can handle this case at the expense of some extra memory
940 * copies during write operations
942 set_bit(PACKET_MERGE_SEGS
, &pd
->flags
);
945 printk(DRIVER_NAME
": cdrom max_phys_segments too small\n");
951 * Copy all data for this packet to pkt->pages[], so that
952 * a) The number of required segments for the write bio is minimized, which
953 * is necessary for some scsi controllers.
954 * b) The data can be used as cache to avoid read requests if we receive a
955 * new write request for the same zone.
957 static void pkt_make_local_copy(struct packet_data
*pkt
, struct bio_vec
*bvec
)
961 /* Copy all data to pkt->pages[] */
964 for (f
= 0; f
< pkt
->frames
; f
++) {
965 if (bvec
[f
].bv_page
!= pkt
->pages
[p
]) {
966 void *vfrom
= kmap_atomic(bvec
[f
].bv_page
) + bvec
[f
].bv_offset
;
967 void *vto
= page_address(pkt
->pages
[p
]) + offs
;
968 memcpy(vto
, vfrom
, CD_FRAMESIZE
);
969 kunmap_atomic(vfrom
);
970 bvec
[f
].bv_page
= pkt
->pages
[p
];
971 bvec
[f
].bv_offset
= offs
;
973 BUG_ON(bvec
[f
].bv_offset
!= offs
);
975 offs
+= CD_FRAMESIZE
;
976 if (offs
>= PAGE_SIZE
) {
983 static void pkt_end_io_read(struct bio
*bio
, int err
)
985 struct packet_data
*pkt
= bio
->bi_private
;
986 struct pktcdvd_device
*pd
= pkt
->pd
;
989 VPRINTK("pkt_end_io_read: bio=%p sec0=%llx sec=%llx err=%d\n", bio
,
990 (unsigned long long)pkt
->sector
, (unsigned long long)bio
->bi_sector
, err
);
993 atomic_inc(&pkt
->io_errors
);
994 if (atomic_dec_and_test(&pkt
->io_wait
)) {
995 atomic_inc(&pkt
->run_sm
);
996 wake_up(&pd
->wqueue
);
998 pkt_bio_finished(pd
);
1001 static void pkt_end_io_packet_write(struct bio
*bio
, int err
)
1003 struct packet_data
*pkt
= bio
->bi_private
;
1004 struct pktcdvd_device
*pd
= pkt
->pd
;
1007 VPRINTK("pkt_end_io_packet_write: id=%d, err=%d\n", pkt
->id
, err
);
1009 pd
->stats
.pkt_ended
++;
1011 pkt_bio_finished(pd
);
1012 atomic_dec(&pkt
->io_wait
);
1013 atomic_inc(&pkt
->run_sm
);
1014 wake_up(&pd
->wqueue
);
1018 * Schedule reads for the holes in a packet
1020 static void pkt_gather_data(struct pktcdvd_device
*pd
, struct packet_data
*pkt
)
1022 int frames_read
= 0;
1025 char written
[PACKET_MAX_SIZE
];
1027 BUG_ON(bio_list_empty(&pkt
->orig_bios
));
1029 atomic_set(&pkt
->io_wait
, 0);
1030 atomic_set(&pkt
->io_errors
, 0);
1033 * Figure out which frames we need to read before we can write.
1035 memset(written
, 0, sizeof(written
));
1036 spin_lock(&pkt
->lock
);
1037 bio_list_for_each(bio
, &pkt
->orig_bios
) {
1038 int first_frame
= (bio
->bi_sector
- pkt
->sector
) / (CD_FRAMESIZE
>> 9);
1039 int num_frames
= bio
->bi_size
/ CD_FRAMESIZE
;
1040 pd
->stats
.secs_w
+= num_frames
* (CD_FRAMESIZE
>> 9);
1041 BUG_ON(first_frame
< 0);
1042 BUG_ON(first_frame
+ num_frames
> pkt
->frames
);
1043 for (f
= first_frame
; f
< first_frame
+ num_frames
; f
++)
1046 spin_unlock(&pkt
->lock
);
1048 if (pkt
->cache_valid
) {
1049 VPRINTK("pkt_gather_data: zone %llx cached\n",
1050 (unsigned long long)pkt
->sector
);
1055 * Schedule reads for missing parts of the packet.
1057 for (f
= 0; f
< pkt
->frames
; f
++) {
1063 bio
= pkt
->r_bios
[f
];
1065 bio
->bi_sector
= pkt
->sector
+ f
* (CD_FRAMESIZE
>> 9);
1066 bio
->bi_bdev
= pd
->bdev
;
1067 bio
->bi_end_io
= pkt_end_io_read
;
1068 bio
->bi_private
= pkt
;
1070 p
= (f
* CD_FRAMESIZE
) / PAGE_SIZE
;
1071 offset
= (f
* CD_FRAMESIZE
) % PAGE_SIZE
;
1072 VPRINTK("pkt_gather_data: Adding frame %d, page:%p offs:%d\n",
1073 f
, pkt
->pages
[p
], offset
);
1074 if (!bio_add_page(bio
, pkt
->pages
[p
], CD_FRAMESIZE
, offset
))
1077 atomic_inc(&pkt
->io_wait
);
1079 pkt_queue_bio(pd
, bio
);
1084 VPRINTK("pkt_gather_data: need %d frames for zone %llx\n",
1085 frames_read
, (unsigned long long)pkt
->sector
);
1086 pd
->stats
.pkt_started
++;
1087 pd
->stats
.secs_rg
+= frames_read
* (CD_FRAMESIZE
>> 9);
1091 * Find a packet matching zone, or the least recently used packet if
1092 * there is no match.
1094 static struct packet_data
*pkt_get_packet_data(struct pktcdvd_device
*pd
, int zone
)
1096 struct packet_data
*pkt
;
1098 list_for_each_entry(pkt
, &pd
->cdrw
.pkt_free_list
, list
) {
1099 if (pkt
->sector
== zone
|| pkt
->list
.next
== &pd
->cdrw
.pkt_free_list
) {
1100 list_del_init(&pkt
->list
);
1101 if (pkt
->sector
!= zone
)
1102 pkt
->cache_valid
= 0;
1110 static void pkt_put_packet_data(struct pktcdvd_device
*pd
, struct packet_data
*pkt
)
1112 if (pkt
->cache_valid
) {
1113 list_add(&pkt
->list
, &pd
->cdrw
.pkt_free_list
);
1115 list_add_tail(&pkt
->list
, &pd
->cdrw
.pkt_free_list
);
1120 * recover a failed write, query for relocation if possible
1122 * returns 1 if recovery is possible, or 0 if not
1125 static int pkt_start_recovery(struct packet_data
*pkt
)
1128 * FIXME. We need help from the file system to implement
1129 * recovery handling.
1133 struct request
*rq
= pkt
->rq
;
1134 struct pktcdvd_device
*pd
= rq
->rq_disk
->private_data
;
1135 struct block_device
*pkt_bdev
;
1136 struct super_block
*sb
= NULL
;
1137 unsigned long old_block
, new_block
;
1138 sector_t new_sector
;
1140 pkt_bdev
= bdget(kdev_t_to_nr(pd
->pkt_dev
));
1142 sb
= get_super(pkt_bdev
);
1149 if (!sb
->s_op
->relocate_blocks
)
1152 old_block
= pkt
->sector
/ (CD_FRAMESIZE
>> 9);
1153 if (sb
->s_op
->relocate_blocks(sb
, old_block
, &new_block
))
1156 new_sector
= new_block
* (CD_FRAMESIZE
>> 9);
1157 pkt
->sector
= new_sector
;
1159 bio_reset(pkt
->bio
);
1160 pkt
->bio
->bi_bdev
= pd
->bdev
;
1161 pkt
->bio
->bi_rw
= REQ_WRITE
;
1162 pkt
->bio
->bi_sector
= new_sector
;
1163 pkt
->bio
->bi_size
= pkt
->frames
* CD_FRAMESIZE
;
1164 pkt
->bio
->bi_vcnt
= pkt
->frames
;
1166 pkt
->bio
->bi_end_io
= pkt_end_io_packet_write
;
1167 pkt
->bio
->bi_private
= pkt
;
1178 static inline void pkt_set_state(struct packet_data
*pkt
, enum packet_data_state state
)
1180 #if PACKET_DEBUG > 1
1181 static const char *state_name
[] = {
1182 "IDLE", "WAITING", "READ_WAIT", "WRITE_WAIT", "RECOVERY", "FINISHED"
1184 enum packet_data_state old_state
= pkt
->state
;
1185 VPRINTK("pkt %2d : s=%6llx %s -> %s\n", pkt
->id
, (unsigned long long)pkt
->sector
,
1186 state_name
[old_state
], state_name
[state
]);
1192 * Scan the work queue to see if we can start a new packet.
1193 * returns non-zero if any work was done.
1195 static int pkt_handle_queue(struct pktcdvd_device
*pd
)
1197 struct packet_data
*pkt
, *p
;
1198 struct bio
*bio
= NULL
;
1199 sector_t zone
= 0; /* Suppress gcc warning */
1200 struct pkt_rb_node
*node
, *first_node
;
1204 VPRINTK("handle_queue\n");
1206 atomic_set(&pd
->scan_queue
, 0);
1208 if (list_empty(&pd
->cdrw
.pkt_free_list
)) {
1209 VPRINTK("handle_queue: no pkt\n");
1214 * Try to find a zone we are not already working on.
1216 spin_lock(&pd
->lock
);
1217 first_node
= pkt_rbtree_find(pd
, pd
->current_sector
);
1219 n
= rb_first(&pd
->bio_queue
);
1221 first_node
= rb_entry(n
, struct pkt_rb_node
, rb_node
);
1226 zone
= ZONE(bio
->bi_sector
, pd
);
1227 list_for_each_entry(p
, &pd
->cdrw
.pkt_active_list
, list
) {
1228 if (p
->sector
== zone
) {
1235 node
= pkt_rbtree_next(node
);
1237 n
= rb_first(&pd
->bio_queue
);
1239 node
= rb_entry(n
, struct pkt_rb_node
, rb_node
);
1241 if (node
== first_node
)
1244 spin_unlock(&pd
->lock
);
1246 VPRINTK("handle_queue: no bio\n");
1250 pkt
= pkt_get_packet_data(pd
, zone
);
1252 pd
->current_sector
= zone
+ pd
->settings
.size
;
1254 BUG_ON(pkt
->frames
!= pd
->settings
.size
>> 2);
1255 pkt
->write_size
= 0;
1258 * Scan work queue for bios in the same zone and link them
1261 spin_lock(&pd
->lock
);
1262 VPRINTK("pkt_handle_queue: looking for zone %llx\n", (unsigned long long)zone
);
1263 while ((node
= pkt_rbtree_find(pd
, zone
)) != NULL
) {
1265 VPRINTK("pkt_handle_queue: found zone=%llx\n",
1266 (unsigned long long)ZONE(bio
->bi_sector
, pd
));
1267 if (ZONE(bio
->bi_sector
, pd
) != zone
)
1269 pkt_rbtree_erase(pd
, node
);
1270 spin_lock(&pkt
->lock
);
1271 bio_list_add(&pkt
->orig_bios
, bio
);
1272 pkt
->write_size
+= bio
->bi_size
/ CD_FRAMESIZE
;
1273 spin_unlock(&pkt
->lock
);
1275 /* check write congestion marks, and if bio_queue_size is
1276 below, wake up any waiters */
1277 wakeup
= (pd
->write_congestion_on
> 0
1278 && pd
->bio_queue_size
<= pd
->write_congestion_off
);
1279 spin_unlock(&pd
->lock
);
1281 clear_bdi_congested(&pd
->disk
->queue
->backing_dev_info
,
1285 pkt
->sleep_time
= max(PACKET_WAIT_TIME
, 1);
1286 pkt_set_state(pkt
, PACKET_WAITING_STATE
);
1287 atomic_set(&pkt
->run_sm
, 1);
1289 spin_lock(&pd
->cdrw
.active_list_lock
);
1290 list_add(&pkt
->list
, &pd
->cdrw
.pkt_active_list
);
1291 spin_unlock(&pd
->cdrw
.active_list_lock
);
1297 * Assemble a bio to write one packet and queue the bio for processing
1298 * by the underlying block device.
1300 static void pkt_start_write(struct pktcdvd_device
*pd
, struct packet_data
*pkt
)
1303 struct bio_vec
*bvec
= pkt
->w_bio
->bi_io_vec
;
1305 bio_reset(pkt
->w_bio
);
1306 pkt
->w_bio
->bi_sector
= pkt
->sector
;
1307 pkt
->w_bio
->bi_bdev
= pd
->bdev
;
1308 pkt
->w_bio
->bi_end_io
= pkt_end_io_packet_write
;
1309 pkt
->w_bio
->bi_private
= pkt
;
1312 for (f
= 0; f
< pkt
->frames
; f
++) {
1313 bvec
[f
].bv_page
= pkt
->pages
[(f
* CD_FRAMESIZE
) / PAGE_SIZE
];
1314 bvec
[f
].bv_offset
= (f
* CD_FRAMESIZE
) % PAGE_SIZE
;
1315 if (!bio_add_page(pkt
->w_bio
, bvec
[f
].bv_page
, CD_FRAMESIZE
, bvec
[f
].bv_offset
))
1318 VPRINTK(DRIVER_NAME
": vcnt=%d\n", pkt
->w_bio
->bi_vcnt
);
1321 * Fill-in bvec with data from orig_bios.
1323 spin_lock(&pkt
->lock
);
1324 bio_copy_data(pkt
->w_bio
, pkt
->orig_bios
.head
);
1326 pkt_set_state(pkt
, PACKET_WRITE_WAIT_STATE
);
1327 spin_unlock(&pkt
->lock
);
1329 VPRINTK("pkt_start_write: Writing %d frames for zone %llx\n",
1330 pkt
->write_size
, (unsigned long long)pkt
->sector
);
1332 if (test_bit(PACKET_MERGE_SEGS
, &pd
->flags
) || (pkt
->write_size
< pkt
->frames
)) {
1333 pkt_make_local_copy(pkt
, bvec
);
1334 pkt
->cache_valid
= 1;
1336 pkt
->cache_valid
= 0;
1339 /* Start the write request */
1340 atomic_set(&pkt
->io_wait
, 1);
1341 pkt
->w_bio
->bi_rw
= WRITE
;
1342 pkt_queue_bio(pd
, pkt
->w_bio
);
1345 static void pkt_finish_packet(struct packet_data
*pkt
, int uptodate
)
1350 pkt
->cache_valid
= 0;
1352 /* Finish all bios corresponding to this packet */
1353 while ((bio
= bio_list_pop(&pkt
->orig_bios
)))
1354 bio_endio(bio
, uptodate
? 0 : -EIO
);
1357 static void pkt_run_state_machine(struct pktcdvd_device
*pd
, struct packet_data
*pkt
)
1361 VPRINTK("run_state_machine: pkt %d\n", pkt
->id
);
1364 switch (pkt
->state
) {
1365 case PACKET_WAITING_STATE
:
1366 if ((pkt
->write_size
< pkt
->frames
) && (pkt
->sleep_time
> 0))
1369 pkt
->sleep_time
= 0;
1370 pkt_gather_data(pd
, pkt
);
1371 pkt_set_state(pkt
, PACKET_READ_WAIT_STATE
);
1374 case PACKET_READ_WAIT_STATE
:
1375 if (atomic_read(&pkt
->io_wait
) > 0)
1378 if (atomic_read(&pkt
->io_errors
) > 0) {
1379 pkt_set_state(pkt
, PACKET_RECOVERY_STATE
);
1381 pkt_start_write(pd
, pkt
);
1385 case PACKET_WRITE_WAIT_STATE
:
1386 if (atomic_read(&pkt
->io_wait
) > 0)
1389 if (test_bit(BIO_UPTODATE
, &pkt
->w_bio
->bi_flags
)) {
1390 pkt_set_state(pkt
, PACKET_FINISHED_STATE
);
1392 pkt_set_state(pkt
, PACKET_RECOVERY_STATE
);
1396 case PACKET_RECOVERY_STATE
:
1397 if (pkt_start_recovery(pkt
)) {
1398 pkt_start_write(pd
, pkt
);
1400 VPRINTK("No recovery possible\n");
1401 pkt_set_state(pkt
, PACKET_FINISHED_STATE
);
1405 case PACKET_FINISHED_STATE
:
1406 uptodate
= test_bit(BIO_UPTODATE
, &pkt
->w_bio
->bi_flags
);
1407 pkt_finish_packet(pkt
, uptodate
);
1417 static void pkt_handle_packets(struct pktcdvd_device
*pd
)
1419 struct packet_data
*pkt
, *next
;
1421 VPRINTK("pkt_handle_packets\n");
1424 * Run state machine for active packets
1426 list_for_each_entry(pkt
, &pd
->cdrw
.pkt_active_list
, list
) {
1427 if (atomic_read(&pkt
->run_sm
) > 0) {
1428 atomic_set(&pkt
->run_sm
, 0);
1429 pkt_run_state_machine(pd
, pkt
);
1434 * Move no longer active packets to the free list
1436 spin_lock(&pd
->cdrw
.active_list_lock
);
1437 list_for_each_entry_safe(pkt
, next
, &pd
->cdrw
.pkt_active_list
, list
) {
1438 if (pkt
->state
== PACKET_FINISHED_STATE
) {
1439 list_del(&pkt
->list
);
1440 pkt_put_packet_data(pd
, pkt
);
1441 pkt_set_state(pkt
, PACKET_IDLE_STATE
);
1442 atomic_set(&pd
->scan_queue
, 1);
1445 spin_unlock(&pd
->cdrw
.active_list_lock
);
1448 static void pkt_count_states(struct pktcdvd_device
*pd
, int *states
)
1450 struct packet_data
*pkt
;
1453 for (i
= 0; i
< PACKET_NUM_STATES
; i
++)
1456 spin_lock(&pd
->cdrw
.active_list_lock
);
1457 list_for_each_entry(pkt
, &pd
->cdrw
.pkt_active_list
, list
) {
1458 states
[pkt
->state
]++;
1460 spin_unlock(&pd
->cdrw
.active_list_lock
);
1464 * kcdrwd is woken up when writes have been queued for one of our
1465 * registered devices
1467 static int kcdrwd(void *foobar
)
1469 struct pktcdvd_device
*pd
= foobar
;
1470 struct packet_data
*pkt
;
1471 long min_sleep_time
, residue
;
1473 set_user_nice(current
, -20);
1477 DECLARE_WAITQUEUE(wait
, current
);
1480 * Wait until there is something to do
1482 add_wait_queue(&pd
->wqueue
, &wait
);
1484 set_current_state(TASK_INTERRUPTIBLE
);
1486 /* Check if we need to run pkt_handle_queue */
1487 if (atomic_read(&pd
->scan_queue
) > 0)
1490 /* Check if we need to run the state machine for some packet */
1491 list_for_each_entry(pkt
, &pd
->cdrw
.pkt_active_list
, list
) {
1492 if (atomic_read(&pkt
->run_sm
) > 0)
1496 /* Check if we need to process the iosched queues */
1497 if (atomic_read(&pd
->iosched
.attention
) != 0)
1500 /* Otherwise, go to sleep */
1501 if (PACKET_DEBUG
> 1) {
1502 int states
[PACKET_NUM_STATES
];
1503 pkt_count_states(pd
, states
);
1504 VPRINTK("kcdrwd: i:%d ow:%d rw:%d ww:%d rec:%d fin:%d\n",
1505 states
[0], states
[1], states
[2], states
[3],
1506 states
[4], states
[5]);
1509 min_sleep_time
= MAX_SCHEDULE_TIMEOUT
;
1510 list_for_each_entry(pkt
, &pd
->cdrw
.pkt_active_list
, list
) {
1511 if (pkt
->sleep_time
&& pkt
->sleep_time
< min_sleep_time
)
1512 min_sleep_time
= pkt
->sleep_time
;
1515 VPRINTK("kcdrwd: sleeping\n");
1516 residue
= schedule_timeout(min_sleep_time
);
1517 VPRINTK("kcdrwd: wake up\n");
1519 /* make swsusp happy with our thread */
1522 list_for_each_entry(pkt
, &pd
->cdrw
.pkt_active_list
, list
) {
1523 if (!pkt
->sleep_time
)
1525 pkt
->sleep_time
-= min_sleep_time
- residue
;
1526 if (pkt
->sleep_time
<= 0) {
1527 pkt
->sleep_time
= 0;
1528 atomic_inc(&pkt
->run_sm
);
1532 if (kthread_should_stop())
1536 set_current_state(TASK_RUNNING
);
1537 remove_wait_queue(&pd
->wqueue
, &wait
);
1539 if (kthread_should_stop())
1543 * if pkt_handle_queue returns true, we can queue
1546 while (pkt_handle_queue(pd
))
1550 * Handle packet state machine
1552 pkt_handle_packets(pd
);
1555 * Handle iosched queues
1557 pkt_iosched_process_queue(pd
);
1563 static void pkt_print_settings(struct pktcdvd_device
*pd
)
1565 printk(DRIVER_NAME
": %s packets, ", pd
->settings
.fp
? "Fixed" : "Variable");
1566 printk("%u blocks, ", pd
->settings
.size
>> 2);
1567 printk("Mode-%c disc\n", pd
->settings
.block_mode
== 8 ? '1' : '2');
1570 static int pkt_mode_sense(struct pktcdvd_device
*pd
, struct packet_command
*cgc
, int page_code
, int page_control
)
1572 memset(cgc
->cmd
, 0, sizeof(cgc
->cmd
));
1574 cgc
->cmd
[0] = GPCMD_MODE_SENSE_10
;
1575 cgc
->cmd
[2] = page_code
| (page_control
<< 6);
1576 cgc
->cmd
[7] = cgc
->buflen
>> 8;
1577 cgc
->cmd
[8] = cgc
->buflen
& 0xff;
1578 cgc
->data_direction
= CGC_DATA_READ
;
1579 return pkt_generic_packet(pd
, cgc
);
1582 static int pkt_mode_select(struct pktcdvd_device
*pd
, struct packet_command
*cgc
)
1584 memset(cgc
->cmd
, 0, sizeof(cgc
->cmd
));
1585 memset(cgc
->buffer
, 0, 2);
1586 cgc
->cmd
[0] = GPCMD_MODE_SELECT_10
;
1587 cgc
->cmd
[1] = 0x10; /* PF */
1588 cgc
->cmd
[7] = cgc
->buflen
>> 8;
1589 cgc
->cmd
[8] = cgc
->buflen
& 0xff;
1590 cgc
->data_direction
= CGC_DATA_WRITE
;
1591 return pkt_generic_packet(pd
, cgc
);
1594 static int pkt_get_disc_info(struct pktcdvd_device
*pd
, disc_information
*di
)
1596 struct packet_command cgc
;
1599 /* set up command and get the disc info */
1600 init_cdrom_command(&cgc
, di
, sizeof(*di
), CGC_DATA_READ
);
1601 cgc
.cmd
[0] = GPCMD_READ_DISC_INFO
;
1602 cgc
.cmd
[8] = cgc
.buflen
= 2;
1605 if ((ret
= pkt_generic_packet(pd
, &cgc
)))
1608 /* not all drives have the same disc_info length, so requeue
1609 * packet with the length the drive tells us it can supply
1611 cgc
.buflen
= be16_to_cpu(di
->disc_information_length
) +
1612 sizeof(di
->disc_information_length
);
1614 if (cgc
.buflen
> sizeof(disc_information
))
1615 cgc
.buflen
= sizeof(disc_information
);
1617 cgc
.cmd
[8] = cgc
.buflen
;
1618 return pkt_generic_packet(pd
, &cgc
);
1621 static int pkt_get_track_info(struct pktcdvd_device
*pd
, __u16 track
, __u8 type
, track_information
*ti
)
1623 struct packet_command cgc
;
1626 init_cdrom_command(&cgc
, ti
, 8, CGC_DATA_READ
);
1627 cgc
.cmd
[0] = GPCMD_READ_TRACK_RZONE_INFO
;
1628 cgc
.cmd
[1] = type
& 3;
1629 cgc
.cmd
[4] = (track
& 0xff00) >> 8;
1630 cgc
.cmd
[5] = track
& 0xff;
1634 if ((ret
= pkt_generic_packet(pd
, &cgc
)))
1637 cgc
.buflen
= be16_to_cpu(ti
->track_information_length
) +
1638 sizeof(ti
->track_information_length
);
1640 if (cgc
.buflen
> sizeof(track_information
))
1641 cgc
.buflen
= sizeof(track_information
);
1643 cgc
.cmd
[8] = cgc
.buflen
;
1644 return pkt_generic_packet(pd
, &cgc
);
1647 static noinline_for_stack
int pkt_get_last_written(struct pktcdvd_device
*pd
,
1650 disc_information di
;
1651 track_information ti
;
1655 if ((ret
= pkt_get_disc_info(pd
, &di
)))
1658 last_track
= (di
.last_track_msb
<< 8) | di
.last_track_lsb
;
1659 if ((ret
= pkt_get_track_info(pd
, last_track
, 1, &ti
)))
1662 /* if this track is blank, try the previous. */
1665 if ((ret
= pkt_get_track_info(pd
, last_track
, 1, &ti
)))
1669 /* if last recorded field is valid, return it. */
1671 *last_written
= be32_to_cpu(ti
.last_rec_address
);
1673 /* make it up instead */
1674 *last_written
= be32_to_cpu(ti
.track_start
) +
1675 be32_to_cpu(ti
.track_size
);
1677 *last_written
-= (be32_to_cpu(ti
.free_blocks
) + 7);
1683 * write mode select package based on pd->settings
1685 static noinline_for_stack
int pkt_set_write_settings(struct pktcdvd_device
*pd
)
1687 struct packet_command cgc
;
1688 struct request_sense sense
;
1689 write_param_page
*wp
;
1693 /* doesn't apply to DVD+RW or DVD-RAM */
1694 if ((pd
->mmc3_profile
== 0x1a) || (pd
->mmc3_profile
== 0x12))
1697 memset(buffer
, 0, sizeof(buffer
));
1698 init_cdrom_command(&cgc
, buffer
, sizeof(*wp
), CGC_DATA_READ
);
1700 if ((ret
= pkt_mode_sense(pd
, &cgc
, GPMODE_WRITE_PARMS_PAGE
, 0))) {
1701 pkt_dump_sense(&cgc
);
1705 size
= 2 + ((buffer
[0] << 8) | (buffer
[1] & 0xff));
1706 pd
->mode_offset
= (buffer
[6] << 8) | (buffer
[7] & 0xff);
1707 if (size
> sizeof(buffer
))
1708 size
= sizeof(buffer
);
1713 init_cdrom_command(&cgc
, buffer
, size
, CGC_DATA_READ
);
1715 if ((ret
= pkt_mode_sense(pd
, &cgc
, GPMODE_WRITE_PARMS_PAGE
, 0))) {
1716 pkt_dump_sense(&cgc
);
1721 * write page is offset header + block descriptor length
1723 wp
= (write_param_page
*) &buffer
[sizeof(struct mode_page_header
) + pd
->mode_offset
];
1725 wp
->fp
= pd
->settings
.fp
;
1726 wp
->track_mode
= pd
->settings
.track_mode
;
1727 wp
->write_type
= pd
->settings
.write_type
;
1728 wp
->data_block_type
= pd
->settings
.block_mode
;
1730 wp
->multi_session
= 0;
1732 #ifdef PACKET_USE_LS
1737 if (wp
->data_block_type
== PACKET_BLOCK_MODE1
) {
1738 wp
->session_format
= 0;
1740 } else if (wp
->data_block_type
== PACKET_BLOCK_MODE2
) {
1741 wp
->session_format
= 0x20;
1745 memcpy(&wp
->mcn
[1], PACKET_MCN
, sizeof(wp
->mcn
) - 1);
1751 printk(DRIVER_NAME
": write mode wrong %d\n", wp
->data_block_type
);
1754 wp
->packet_size
= cpu_to_be32(pd
->settings
.size
>> 2);
1756 cgc
.buflen
= cgc
.cmd
[8] = size
;
1757 if ((ret
= pkt_mode_select(pd
, &cgc
))) {
1758 pkt_dump_sense(&cgc
);
1762 pkt_print_settings(pd
);
1767 * 1 -- we can write to this track, 0 -- we can't
1769 static int pkt_writable_track(struct pktcdvd_device
*pd
, track_information
*ti
)
1771 switch (pd
->mmc3_profile
) {
1772 case 0x1a: /* DVD+RW */
1773 case 0x12: /* DVD-RAM */
1774 /* The track is always writable on DVD+RW/DVD-RAM */
1780 if (!ti
->packet
|| !ti
->fp
)
1784 * "good" settings as per Mt Fuji.
1786 if (ti
->rt
== 0 && ti
->blank
== 0)
1789 if (ti
->rt
== 0 && ti
->blank
== 1)
1792 if (ti
->rt
== 1 && ti
->blank
== 0)
1795 printk(DRIVER_NAME
": bad state %d-%d-%d\n", ti
->rt
, ti
->blank
, ti
->packet
);
1800 * 1 -- we can write to this disc, 0 -- we can't
1802 static int pkt_writable_disc(struct pktcdvd_device
*pd
, disc_information
*di
)
1804 switch (pd
->mmc3_profile
) {
1805 case 0x0a: /* CD-RW */
1806 case 0xffff: /* MMC3 not supported */
1808 case 0x1a: /* DVD+RW */
1809 case 0x13: /* DVD-RW */
1810 case 0x12: /* DVD-RAM */
1813 VPRINTK(DRIVER_NAME
": Wrong disc profile (%x)\n", pd
->mmc3_profile
);
1818 * for disc type 0xff we should probably reserve a new track.
1819 * but i'm not sure, should we leave this to user apps? probably.
1821 if (di
->disc_type
== 0xff) {
1822 printk(DRIVER_NAME
": Unknown disc. No track?\n");
1826 if (di
->disc_type
!= 0x20 && di
->disc_type
!= 0) {
1827 printk(DRIVER_NAME
": Wrong disc type (%x)\n", di
->disc_type
);
1831 if (di
->erasable
== 0) {
1832 printk(DRIVER_NAME
": Disc not erasable\n");
1836 if (di
->border_status
== PACKET_SESSION_RESERVED
) {
1837 printk(DRIVER_NAME
": Can't write to last track (reserved)\n");
1844 static noinline_for_stack
int pkt_probe_settings(struct pktcdvd_device
*pd
)
1846 struct packet_command cgc
;
1847 unsigned char buf
[12];
1848 disc_information di
;
1849 track_information ti
;
1852 init_cdrom_command(&cgc
, buf
, sizeof(buf
), CGC_DATA_READ
);
1853 cgc
.cmd
[0] = GPCMD_GET_CONFIGURATION
;
1855 ret
= pkt_generic_packet(pd
, &cgc
);
1856 pd
->mmc3_profile
= ret
? 0xffff : buf
[6] << 8 | buf
[7];
1858 memset(&di
, 0, sizeof(disc_information
));
1859 memset(&ti
, 0, sizeof(track_information
));
1861 if ((ret
= pkt_get_disc_info(pd
, &di
))) {
1862 printk("failed get_disc\n");
1866 if (!pkt_writable_disc(pd
, &di
))
1869 pd
->type
= di
.erasable
? PACKET_CDRW
: PACKET_CDR
;
1871 track
= 1; /* (di.last_track_msb << 8) | di.last_track_lsb; */
1872 if ((ret
= pkt_get_track_info(pd
, track
, 1, &ti
))) {
1873 printk(DRIVER_NAME
": failed get_track\n");
1877 if (!pkt_writable_track(pd
, &ti
)) {
1878 printk(DRIVER_NAME
": can't write to this track\n");
1883 * we keep packet size in 512 byte units, makes it easier to
1884 * deal with request calculations.
1886 pd
->settings
.size
= be32_to_cpu(ti
.fixed_packet_size
) << 2;
1887 if (pd
->settings
.size
== 0) {
1888 printk(DRIVER_NAME
": detected zero packet size!\n");
1891 if (pd
->settings
.size
> PACKET_MAX_SECTORS
) {
1892 printk(DRIVER_NAME
": packet size is too big\n");
1895 pd
->settings
.fp
= ti
.fp
;
1896 pd
->offset
= (be32_to_cpu(ti
.track_start
) << 2) & (pd
->settings
.size
- 1);
1899 pd
->nwa
= be32_to_cpu(ti
.next_writable
);
1900 set_bit(PACKET_NWA_VALID
, &pd
->flags
);
1904 * in theory we could use lra on -RW media as well and just zero
1905 * blocks that haven't been written yet, but in practice that
1906 * is just a no-go. we'll use that for -R, naturally.
1909 pd
->lra
= be32_to_cpu(ti
.last_rec_address
);
1910 set_bit(PACKET_LRA_VALID
, &pd
->flags
);
1912 pd
->lra
= 0xffffffff;
1913 set_bit(PACKET_LRA_VALID
, &pd
->flags
);
1919 pd
->settings
.link_loss
= 7;
1920 pd
->settings
.write_type
= 0; /* packet */
1921 pd
->settings
.track_mode
= ti
.track_mode
;
1924 * mode1 or mode2 disc
1926 switch (ti
.data_mode
) {
1928 pd
->settings
.block_mode
= PACKET_BLOCK_MODE1
;
1931 pd
->settings
.block_mode
= PACKET_BLOCK_MODE2
;
1934 printk(DRIVER_NAME
": unknown data mode\n");
1941 * enable/disable write caching on drive
1943 static noinline_for_stack
int pkt_write_caching(struct pktcdvd_device
*pd
,
1946 struct packet_command cgc
;
1947 struct request_sense sense
;
1948 unsigned char buf
[64];
1951 init_cdrom_command(&cgc
, buf
, sizeof(buf
), CGC_DATA_READ
);
1953 cgc
.buflen
= pd
->mode_offset
+ 12;
1956 * caching mode page might not be there, so quiet this command
1960 if ((ret
= pkt_mode_sense(pd
, &cgc
, GPMODE_WCACHING_PAGE
, 0)))
1963 buf
[pd
->mode_offset
+ 10] |= (!!set
<< 2);
1965 cgc
.buflen
= cgc
.cmd
[8] = 2 + ((buf
[0] << 8) | (buf
[1] & 0xff));
1966 ret
= pkt_mode_select(pd
, &cgc
);
1968 printk(DRIVER_NAME
": write caching control failed\n");
1969 pkt_dump_sense(&cgc
);
1970 } else if (!ret
&& set
)
1971 printk(DRIVER_NAME
": enabled write caching on %s\n", pd
->name
);
1975 static int pkt_lock_door(struct pktcdvd_device
*pd
, int lockflag
)
1977 struct packet_command cgc
;
1979 init_cdrom_command(&cgc
, NULL
, 0, CGC_DATA_NONE
);
1980 cgc
.cmd
[0] = GPCMD_PREVENT_ALLOW_MEDIUM_REMOVAL
;
1981 cgc
.cmd
[4] = lockflag
? 1 : 0;
1982 return pkt_generic_packet(pd
, &cgc
);
1986 * Returns drive maximum write speed
1988 static noinline_for_stack
int pkt_get_max_speed(struct pktcdvd_device
*pd
,
1989 unsigned *write_speed
)
1991 struct packet_command cgc
;
1992 struct request_sense sense
;
1993 unsigned char buf
[256+18];
1994 unsigned char *cap_buf
;
1997 cap_buf
= &buf
[sizeof(struct mode_page_header
) + pd
->mode_offset
];
1998 init_cdrom_command(&cgc
, buf
, sizeof(buf
), CGC_DATA_UNKNOWN
);
2001 ret
= pkt_mode_sense(pd
, &cgc
, GPMODE_CAPABILITIES_PAGE
, 0);
2003 cgc
.buflen
= pd
->mode_offset
+ cap_buf
[1] + 2 +
2004 sizeof(struct mode_page_header
);
2005 ret
= pkt_mode_sense(pd
, &cgc
, GPMODE_CAPABILITIES_PAGE
, 0);
2007 pkt_dump_sense(&cgc
);
2012 offset
= 20; /* Obsoleted field, used by older drives */
2013 if (cap_buf
[1] >= 28)
2014 offset
= 28; /* Current write speed selected */
2015 if (cap_buf
[1] >= 30) {
2016 /* If the drive reports at least one "Logical Unit Write
2017 * Speed Performance Descriptor Block", use the information
2018 * in the first block. (contains the highest speed)
2020 int num_spdb
= (cap_buf
[30] << 8) + cap_buf
[31];
2025 *write_speed
= (cap_buf
[offset
] << 8) | cap_buf
[offset
+ 1];
2029 /* These tables from cdrecord - I don't have orange book */
2030 /* standard speed CD-RW (1-4x) */
2031 static char clv_to_speed
[16] = {
2032 /* 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 */
2033 0, 2, 4, 6, 8, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
2035 /* high speed CD-RW (-10x) */
2036 static char hs_clv_to_speed
[16] = {
2037 /* 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 */
2038 0, 2, 4, 6, 10, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
2040 /* ultra high speed CD-RW */
2041 static char us_clv_to_speed
[16] = {
2042 /* 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 */
2043 0, 2, 4, 8, 0, 0,16, 0,24,32,40,48, 0, 0, 0, 0
2047 * reads the maximum media speed from ATIP
2049 static noinline_for_stack
int pkt_media_speed(struct pktcdvd_device
*pd
,
2052 struct packet_command cgc
;
2053 struct request_sense sense
;
2054 unsigned char buf
[64];
2055 unsigned int size
, st
, sp
;
2058 init_cdrom_command(&cgc
, buf
, 2, CGC_DATA_READ
);
2060 cgc
.cmd
[0] = GPCMD_READ_TOC_PMA_ATIP
;
2062 cgc
.cmd
[2] = 4; /* READ ATIP */
2064 ret
= pkt_generic_packet(pd
, &cgc
);
2066 pkt_dump_sense(&cgc
);
2069 size
= ((unsigned int) buf
[0]<<8) + buf
[1] + 2;
2070 if (size
> sizeof(buf
))
2073 init_cdrom_command(&cgc
, buf
, size
, CGC_DATA_READ
);
2075 cgc
.cmd
[0] = GPCMD_READ_TOC_PMA_ATIP
;
2079 ret
= pkt_generic_packet(pd
, &cgc
);
2081 pkt_dump_sense(&cgc
);
2085 if (!(buf
[6] & 0x40)) {
2086 printk(DRIVER_NAME
": Disc type is not CD-RW\n");
2089 if (!(buf
[6] & 0x4)) {
2090 printk(DRIVER_NAME
": A1 values on media are not valid, maybe not CDRW?\n");
2094 st
= (buf
[6] >> 3) & 0x7; /* disc sub-type */
2096 sp
= buf
[16] & 0xf; /* max speed from ATIP A1 field */
2098 /* Info from cdrecord */
2100 case 0: /* standard speed */
2101 *speed
= clv_to_speed
[sp
];
2103 case 1: /* high speed */
2104 *speed
= hs_clv_to_speed
[sp
];
2106 case 2: /* ultra high speed */
2107 *speed
= us_clv_to_speed
[sp
];
2110 printk(DRIVER_NAME
": Unknown disc sub-type %d\n",st
);
2114 printk(DRIVER_NAME
": Max. media speed: %d\n",*speed
);
2117 printk(DRIVER_NAME
": Unknown speed %d for sub-type %d\n",sp
,st
);
2122 static noinline_for_stack
int pkt_perform_opc(struct pktcdvd_device
*pd
)
2124 struct packet_command cgc
;
2125 struct request_sense sense
;
2128 VPRINTK(DRIVER_NAME
": Performing OPC\n");
2130 init_cdrom_command(&cgc
, NULL
, 0, CGC_DATA_NONE
);
2132 cgc
.timeout
= 60*HZ
;
2133 cgc
.cmd
[0] = GPCMD_SEND_OPC
;
2135 if ((ret
= pkt_generic_packet(pd
, &cgc
)))
2136 pkt_dump_sense(&cgc
);
2140 static int pkt_open_write(struct pktcdvd_device
*pd
)
2143 unsigned int write_speed
, media_write_speed
, read_speed
;
2145 if ((ret
= pkt_probe_settings(pd
))) {
2146 VPRINTK(DRIVER_NAME
": %s failed probe\n", pd
->name
);
2150 if ((ret
= pkt_set_write_settings(pd
))) {
2151 DPRINTK(DRIVER_NAME
": %s failed saving write settings\n", pd
->name
);
2155 pkt_write_caching(pd
, USE_WCACHING
);
2157 if ((ret
= pkt_get_max_speed(pd
, &write_speed
)))
2158 write_speed
= 16 * 177;
2159 switch (pd
->mmc3_profile
) {
2160 case 0x13: /* DVD-RW */
2161 case 0x1a: /* DVD+RW */
2162 case 0x12: /* DVD-RAM */
2163 DPRINTK(DRIVER_NAME
": write speed %ukB/s\n", write_speed
);
2166 if ((ret
= pkt_media_speed(pd
, &media_write_speed
)))
2167 media_write_speed
= 16;
2168 write_speed
= min(write_speed
, media_write_speed
* 177);
2169 DPRINTK(DRIVER_NAME
": write speed %ux\n", write_speed
/ 176);
2172 read_speed
= write_speed
;
2174 if ((ret
= pkt_set_speed(pd
, write_speed
, read_speed
))) {
2175 DPRINTK(DRIVER_NAME
": %s couldn't set write speed\n", pd
->name
);
2178 pd
->write_speed
= write_speed
;
2179 pd
->read_speed
= read_speed
;
2181 if ((ret
= pkt_perform_opc(pd
))) {
2182 DPRINTK(DRIVER_NAME
": %s Optimum Power Calibration failed\n", pd
->name
);
2189 * called at open time.
2191 static int pkt_open_dev(struct pktcdvd_device
*pd
, fmode_t write
)
2195 struct request_queue
*q
;
2198 * We need to re-open the cdrom device without O_NONBLOCK to be able
2199 * to read/write from/to it. It is already opened in O_NONBLOCK mode
2200 * so bdget() can't fail.
2202 bdget(pd
->bdev
->bd_dev
);
2203 if ((ret
= blkdev_get(pd
->bdev
, FMODE_READ
| FMODE_EXCL
, pd
)))
2206 if ((ret
= pkt_get_last_written(pd
, &lba
))) {
2207 printk(DRIVER_NAME
": pkt_get_last_written failed\n");
2211 set_capacity(pd
->disk
, lba
<< 2);
2212 set_capacity(pd
->bdev
->bd_disk
, lba
<< 2);
2213 bd_set_size(pd
->bdev
, (loff_t
)lba
<< 11);
2215 q
= bdev_get_queue(pd
->bdev
);
2217 if ((ret
= pkt_open_write(pd
)))
2220 * Some CDRW drives can not handle writes larger than one packet,
2221 * even if the size is a multiple of the packet size.
2223 spin_lock_irq(q
->queue_lock
);
2224 blk_queue_max_hw_sectors(q
, pd
->settings
.size
);
2225 spin_unlock_irq(q
->queue_lock
);
2226 set_bit(PACKET_WRITABLE
, &pd
->flags
);
2228 pkt_set_speed(pd
, MAX_SPEED
, MAX_SPEED
);
2229 clear_bit(PACKET_WRITABLE
, &pd
->flags
);
2232 if ((ret
= pkt_set_segment_merging(pd
, q
)))
2236 if (!pkt_grow_pktlist(pd
, CONFIG_CDROM_PKTCDVD_BUFFERS
)) {
2237 printk(DRIVER_NAME
": not enough memory for buffers\n");
2241 printk(DRIVER_NAME
": %lukB available on disc\n", lba
<< 1);
2247 blkdev_put(pd
->bdev
, FMODE_READ
| FMODE_EXCL
);
2253 * called when the device is closed. makes sure that the device flushes
2254 * the internal cache before we close.
2256 static void pkt_release_dev(struct pktcdvd_device
*pd
, int flush
)
2258 if (flush
&& pkt_flush_cache(pd
))
2259 DPRINTK(DRIVER_NAME
": %s not flushing cache\n", pd
->name
);
2261 pkt_lock_door(pd
, 0);
2263 pkt_set_speed(pd
, MAX_SPEED
, MAX_SPEED
);
2264 blkdev_put(pd
->bdev
, FMODE_READ
| FMODE_EXCL
);
2266 pkt_shrink_pktlist(pd
);
2269 static struct pktcdvd_device
*pkt_find_dev_from_minor(unsigned int dev_minor
)
2271 if (dev_minor
>= MAX_WRITERS
)
2273 return pkt_devs
[dev_minor
];
2276 static int pkt_open(struct block_device
*bdev
, fmode_t mode
)
2278 struct pktcdvd_device
*pd
= NULL
;
2281 VPRINTK(DRIVER_NAME
": entering open\n");
2283 mutex_lock(&pktcdvd_mutex
);
2284 mutex_lock(&ctl_mutex
);
2285 pd
= pkt_find_dev_from_minor(MINOR(bdev
->bd_dev
));
2290 BUG_ON(pd
->refcnt
< 0);
2293 if (pd
->refcnt
> 1) {
2294 if ((mode
& FMODE_WRITE
) &&
2295 !test_bit(PACKET_WRITABLE
, &pd
->flags
)) {
2300 ret
= pkt_open_dev(pd
, mode
& FMODE_WRITE
);
2304 * needed here as well, since ext2 (among others) may change
2305 * the blocksize at mount time
2307 set_blocksize(bdev
, CD_FRAMESIZE
);
2310 mutex_unlock(&ctl_mutex
);
2311 mutex_unlock(&pktcdvd_mutex
);
2317 VPRINTK(DRIVER_NAME
": failed open (%d)\n", ret
);
2318 mutex_unlock(&ctl_mutex
);
2319 mutex_unlock(&pktcdvd_mutex
);
2323 static void pkt_close(struct gendisk
*disk
, fmode_t mode
)
2325 struct pktcdvd_device
*pd
= disk
->private_data
;
2327 mutex_lock(&pktcdvd_mutex
);
2328 mutex_lock(&ctl_mutex
);
2330 BUG_ON(pd
->refcnt
< 0);
2331 if (pd
->refcnt
== 0) {
2332 int flush
= test_bit(PACKET_WRITABLE
, &pd
->flags
);
2333 pkt_release_dev(pd
, flush
);
2335 mutex_unlock(&ctl_mutex
);
2336 mutex_unlock(&pktcdvd_mutex
);
2340 static void pkt_end_io_read_cloned(struct bio
*bio
, int err
)
2342 struct packet_stacked_data
*psd
= bio
->bi_private
;
2343 struct pktcdvd_device
*pd
= psd
->pd
;
2346 bio_endio(psd
->bio
, err
);
2347 mempool_free(psd
, psd_pool
);
2348 pkt_bio_finished(pd
);
2351 static void pkt_make_request(struct request_queue
*q
, struct bio
*bio
)
2353 struct pktcdvd_device
*pd
;
2354 char b
[BDEVNAME_SIZE
];
2356 struct packet_data
*pkt
;
2357 int was_empty
, blocked_bio
;
2358 struct pkt_rb_node
*node
;
2362 printk(DRIVER_NAME
": %s incorrect request queue\n", bdevname(bio
->bi_bdev
, b
));
2367 * Clone READ bios so we can have our own bi_end_io callback.
2369 if (bio_data_dir(bio
) == READ
) {
2370 struct bio
*cloned_bio
= bio_clone(bio
, GFP_NOIO
);
2371 struct packet_stacked_data
*psd
= mempool_alloc(psd_pool
, GFP_NOIO
);
2375 cloned_bio
->bi_bdev
= pd
->bdev
;
2376 cloned_bio
->bi_private
= psd
;
2377 cloned_bio
->bi_end_io
= pkt_end_io_read_cloned
;
2378 pd
->stats
.secs_r
+= bio_sectors(bio
);
2379 pkt_queue_bio(pd
, cloned_bio
);
2383 if (!test_bit(PACKET_WRITABLE
, &pd
->flags
)) {
2384 printk(DRIVER_NAME
": WRITE for ro device %s (%llu)\n",
2385 pd
->name
, (unsigned long long)bio
->bi_sector
);
2389 if (!bio
->bi_size
|| (bio
->bi_size
% CD_FRAMESIZE
)) {
2390 printk(DRIVER_NAME
": wrong bio size\n");
2394 blk_queue_bounce(q
, &bio
);
2396 zone
= ZONE(bio
->bi_sector
, pd
);
2397 VPRINTK("pkt_make_request: start = %6llx stop = %6llx\n",
2398 (unsigned long long)bio
->bi_sector
,
2399 (unsigned long long)bio_end_sector(bio
));
2401 /* Check if we have to split the bio */
2403 struct bio_pair
*bp
;
2407 last_zone
= ZONE(bio_end_sector(bio
) - 1, pd
);
2408 if (last_zone
!= zone
) {
2409 BUG_ON(last_zone
!= zone
+ pd
->settings
.size
);
2410 first_sectors
= last_zone
- bio
->bi_sector
;
2411 bp
= bio_split(bio
, first_sectors
);
2413 pkt_make_request(q
, &bp
->bio1
);
2414 pkt_make_request(q
, &bp
->bio2
);
2415 bio_pair_release(bp
);
2421 * If we find a matching packet in state WAITING or READ_WAIT, we can
2422 * just append this bio to that packet.
2424 spin_lock(&pd
->cdrw
.active_list_lock
);
2426 list_for_each_entry(pkt
, &pd
->cdrw
.pkt_active_list
, list
) {
2427 if (pkt
->sector
== zone
) {
2428 spin_lock(&pkt
->lock
);
2429 if ((pkt
->state
== PACKET_WAITING_STATE
) ||
2430 (pkt
->state
== PACKET_READ_WAIT_STATE
)) {
2431 bio_list_add(&pkt
->orig_bios
, bio
);
2432 pkt
->write_size
+= bio
->bi_size
/ CD_FRAMESIZE
;
2433 if ((pkt
->write_size
>= pkt
->frames
) &&
2434 (pkt
->state
== PACKET_WAITING_STATE
)) {
2435 atomic_inc(&pkt
->run_sm
);
2436 wake_up(&pd
->wqueue
);
2438 spin_unlock(&pkt
->lock
);
2439 spin_unlock(&pd
->cdrw
.active_list_lock
);
2444 spin_unlock(&pkt
->lock
);
2447 spin_unlock(&pd
->cdrw
.active_list_lock
);
2450 * Test if there is enough room left in the bio work queue
2451 * (queue size >= congestion on mark).
2452 * If not, wait till the work queue size is below the congestion off mark.
2454 spin_lock(&pd
->lock
);
2455 if (pd
->write_congestion_on
> 0
2456 && pd
->bio_queue_size
>= pd
->write_congestion_on
) {
2457 set_bdi_congested(&q
->backing_dev_info
, BLK_RW_ASYNC
);
2459 spin_unlock(&pd
->lock
);
2460 congestion_wait(BLK_RW_ASYNC
, HZ
);
2461 spin_lock(&pd
->lock
);
2462 } while(pd
->bio_queue_size
> pd
->write_congestion_off
);
2464 spin_unlock(&pd
->lock
);
2467 * No matching packet found. Store the bio in the work queue.
2469 node
= mempool_alloc(pd
->rb_pool
, GFP_NOIO
);
2471 spin_lock(&pd
->lock
);
2472 BUG_ON(pd
->bio_queue_size
< 0);
2473 was_empty
= (pd
->bio_queue_size
== 0);
2474 pkt_rbtree_insert(pd
, node
);
2475 spin_unlock(&pd
->lock
);
2478 * Wake up the worker thread.
2480 atomic_set(&pd
->scan_queue
, 1);
2482 /* This wake_up is required for correct operation */
2483 wake_up(&pd
->wqueue
);
2484 } else if (!list_empty(&pd
->cdrw
.pkt_free_list
) && !blocked_bio
) {
2486 * This wake up is not required for correct operation,
2487 * but improves performance in some cases.
2489 wake_up(&pd
->wqueue
);
2498 static int pkt_merge_bvec(struct request_queue
*q
, struct bvec_merge_data
*bmd
,
2499 struct bio_vec
*bvec
)
2501 struct pktcdvd_device
*pd
= q
->queuedata
;
2502 sector_t zone
= ZONE(bmd
->bi_sector
, pd
);
2503 int used
= ((bmd
->bi_sector
- zone
) << 9) + bmd
->bi_size
;
2504 int remaining
= (pd
->settings
.size
<< 9) - used
;
2508 * A bio <= PAGE_SIZE must be allowed. If it crosses a packet
2509 * boundary, pkt_make_request() will split the bio.
2511 remaining2
= PAGE_SIZE
- bmd
->bi_size
;
2512 remaining
= max(remaining
, remaining2
);
2514 BUG_ON(remaining
< 0);
2518 static void pkt_init_queue(struct pktcdvd_device
*pd
)
2520 struct request_queue
*q
= pd
->disk
->queue
;
2522 blk_queue_make_request(q
, pkt_make_request
);
2523 blk_queue_logical_block_size(q
, CD_FRAMESIZE
);
2524 blk_queue_max_hw_sectors(q
, PACKET_MAX_SECTORS
);
2525 blk_queue_merge_bvec(q
, pkt_merge_bvec
);
2529 static int pkt_seq_show(struct seq_file
*m
, void *p
)
2531 struct pktcdvd_device
*pd
= m
->private;
2533 char bdev_buf
[BDEVNAME_SIZE
];
2534 int states
[PACKET_NUM_STATES
];
2536 seq_printf(m
, "Writer %s mapped to %s:\n", pd
->name
,
2537 bdevname(pd
->bdev
, bdev_buf
));
2539 seq_printf(m
, "\nSettings:\n");
2540 seq_printf(m
, "\tpacket size:\t\t%dkB\n", pd
->settings
.size
/ 2);
2542 if (pd
->settings
.write_type
== 0)
2546 seq_printf(m
, "\twrite type:\t\t%s\n", msg
);
2548 seq_printf(m
, "\tpacket type:\t\t%s\n", pd
->settings
.fp
? "Fixed" : "Variable");
2549 seq_printf(m
, "\tlink loss:\t\t%d\n", pd
->settings
.link_loss
);
2551 seq_printf(m
, "\ttrack mode:\t\t%d\n", pd
->settings
.track_mode
);
2553 if (pd
->settings
.block_mode
== PACKET_BLOCK_MODE1
)
2555 else if (pd
->settings
.block_mode
== PACKET_BLOCK_MODE2
)
2559 seq_printf(m
, "\tblock mode:\t\t%s\n", msg
);
2561 seq_printf(m
, "\nStatistics:\n");
2562 seq_printf(m
, "\tpackets started:\t%lu\n", pd
->stats
.pkt_started
);
2563 seq_printf(m
, "\tpackets ended:\t\t%lu\n", pd
->stats
.pkt_ended
);
2564 seq_printf(m
, "\twritten:\t\t%lukB\n", pd
->stats
.secs_w
>> 1);
2565 seq_printf(m
, "\tread gather:\t\t%lukB\n", pd
->stats
.secs_rg
>> 1);
2566 seq_printf(m
, "\tread:\t\t\t%lukB\n", pd
->stats
.secs_r
>> 1);
2568 seq_printf(m
, "\nMisc:\n");
2569 seq_printf(m
, "\treference count:\t%d\n", pd
->refcnt
);
2570 seq_printf(m
, "\tflags:\t\t\t0x%lx\n", pd
->flags
);
2571 seq_printf(m
, "\tread speed:\t\t%ukB/s\n", pd
->read_speed
);
2572 seq_printf(m
, "\twrite speed:\t\t%ukB/s\n", pd
->write_speed
);
2573 seq_printf(m
, "\tstart offset:\t\t%lu\n", pd
->offset
);
2574 seq_printf(m
, "\tmode page offset:\t%u\n", pd
->mode_offset
);
2576 seq_printf(m
, "\nQueue state:\n");
2577 seq_printf(m
, "\tbios queued:\t\t%d\n", pd
->bio_queue_size
);
2578 seq_printf(m
, "\tbios pending:\t\t%d\n", atomic_read(&pd
->cdrw
.pending_bios
));
2579 seq_printf(m
, "\tcurrent sector:\t\t0x%llx\n", (unsigned long long)pd
->current_sector
);
2581 pkt_count_states(pd
, states
);
2582 seq_printf(m
, "\tstate:\t\t\ti:%d ow:%d rw:%d ww:%d rec:%d fin:%d\n",
2583 states
[0], states
[1], states
[2], states
[3], states
[4], states
[5]);
2585 seq_printf(m
, "\twrite congestion marks:\toff=%d on=%d\n",
2586 pd
->write_congestion_off
,
2587 pd
->write_congestion_on
);
2591 static int pkt_seq_open(struct inode
*inode
, struct file
*file
)
2593 return single_open(file
, pkt_seq_show
, PDE_DATA(inode
));
2596 static const struct file_operations pkt_proc_fops
= {
2597 .open
= pkt_seq_open
,
2599 .llseek
= seq_lseek
,
2600 .release
= single_release
2603 static int pkt_new_dev(struct pktcdvd_device
*pd
, dev_t dev
)
2607 char b
[BDEVNAME_SIZE
];
2608 struct block_device
*bdev
;
2610 if (pd
->pkt_dev
== dev
) {
2611 printk(DRIVER_NAME
": Recursive setup not allowed\n");
2614 for (i
= 0; i
< MAX_WRITERS
; i
++) {
2615 struct pktcdvd_device
*pd2
= pkt_devs
[i
];
2618 if (pd2
->bdev
->bd_dev
== dev
) {
2619 printk(DRIVER_NAME
": %s already setup\n", bdevname(pd2
->bdev
, b
));
2622 if (pd2
->pkt_dev
== dev
) {
2623 printk(DRIVER_NAME
": Can't chain pktcdvd devices\n");
2631 ret
= blkdev_get(bdev
, FMODE_READ
| FMODE_NDELAY
, NULL
);
2635 /* This is safe, since we have a reference from open(). */
2636 __module_get(THIS_MODULE
);
2639 set_blocksize(bdev
, CD_FRAMESIZE
);
2643 atomic_set(&pd
->cdrw
.pending_bios
, 0);
2644 pd
->cdrw
.thread
= kthread_run(kcdrwd
, pd
, "%s", pd
->name
);
2645 if (IS_ERR(pd
->cdrw
.thread
)) {
2646 printk(DRIVER_NAME
": can't start kernel thread\n");
2651 proc_create_data(pd
->name
, 0, pkt_proc
, &pkt_proc_fops
, pd
);
2652 DPRINTK(DRIVER_NAME
": writer %s mapped to %s\n", pd
->name
, bdevname(bdev
, b
));
2656 blkdev_put(bdev
, FMODE_READ
| FMODE_NDELAY
);
2657 /* This is safe: open() is still holding a reference. */
2658 module_put(THIS_MODULE
);
2662 static int pkt_ioctl(struct block_device
*bdev
, fmode_t mode
, unsigned int cmd
, unsigned long arg
)
2664 struct pktcdvd_device
*pd
= bdev
->bd_disk
->private_data
;
2667 VPRINTK("pkt_ioctl: cmd %x, dev %d:%d\n", cmd
,
2668 MAJOR(bdev
->bd_dev
), MINOR(bdev
->bd_dev
));
2670 mutex_lock(&pktcdvd_mutex
);
2674 * The door gets locked when the device is opened, so we
2675 * have to unlock it or else the eject command fails.
2677 if (pd
->refcnt
== 1)
2678 pkt_lock_door(pd
, 0);
2681 * forward selected CDROM ioctls to CD-ROM, for UDF
2683 case CDROMMULTISESSION
:
2684 case CDROMREADTOCENTRY
:
2685 case CDROM_LAST_WRITTEN
:
2686 case CDROM_SEND_PACKET
:
2687 case SCSI_IOCTL_SEND_COMMAND
:
2688 ret
= __blkdev_driver_ioctl(pd
->bdev
, mode
, cmd
, arg
);
2692 VPRINTK(DRIVER_NAME
": Unknown ioctl for %s (%x)\n", pd
->name
, cmd
);
2695 mutex_unlock(&pktcdvd_mutex
);
2700 static unsigned int pkt_check_events(struct gendisk
*disk
,
2701 unsigned int clearing
)
2703 struct pktcdvd_device
*pd
= disk
->private_data
;
2704 struct gendisk
*attached_disk
;
2710 attached_disk
= pd
->bdev
->bd_disk
;
2711 if (!attached_disk
|| !attached_disk
->fops
->check_events
)
2713 return attached_disk
->fops
->check_events(attached_disk
, clearing
);
2716 static const struct block_device_operations pktcdvd_ops
= {
2717 .owner
= THIS_MODULE
,
2719 .release
= pkt_close
,
2721 .check_events
= pkt_check_events
,
2724 static char *pktcdvd_devnode(struct gendisk
*gd
, umode_t
*mode
)
2726 return kasprintf(GFP_KERNEL
, "pktcdvd/%s", gd
->disk_name
);
2730 * Set up mapping from pktcdvd device to CD-ROM device.
2732 static int pkt_setup_dev(dev_t dev
, dev_t
* pkt_dev
)
2736 struct pktcdvd_device
*pd
;
2737 struct gendisk
*disk
;
2739 mutex_lock_nested(&ctl_mutex
, SINGLE_DEPTH_NESTING
);
2741 for (idx
= 0; idx
< MAX_WRITERS
; idx
++)
2744 if (idx
== MAX_WRITERS
) {
2745 printk(DRIVER_NAME
": max %d writers supported\n", MAX_WRITERS
);
2750 pd
= kzalloc(sizeof(struct pktcdvd_device
), GFP_KERNEL
);
2754 pd
->rb_pool
= mempool_create_kmalloc_pool(PKT_RB_POOL_SIZE
,
2755 sizeof(struct pkt_rb_node
));
2759 INIT_LIST_HEAD(&pd
->cdrw
.pkt_free_list
);
2760 INIT_LIST_HEAD(&pd
->cdrw
.pkt_active_list
);
2761 spin_lock_init(&pd
->cdrw
.active_list_lock
);
2763 spin_lock_init(&pd
->lock
);
2764 spin_lock_init(&pd
->iosched
.lock
);
2765 bio_list_init(&pd
->iosched
.read_queue
);
2766 bio_list_init(&pd
->iosched
.write_queue
);
2767 sprintf(pd
->name
, DRIVER_NAME
"%d", idx
);
2768 init_waitqueue_head(&pd
->wqueue
);
2769 pd
->bio_queue
= RB_ROOT
;
2771 pd
->write_congestion_on
= write_congestion_on
;
2772 pd
->write_congestion_off
= write_congestion_off
;
2774 disk
= alloc_disk(1);
2778 disk
->major
= pktdev_major
;
2779 disk
->first_minor
= idx
;
2780 disk
->fops
= &pktcdvd_ops
;
2781 disk
->flags
= GENHD_FL_REMOVABLE
;
2782 strcpy(disk
->disk_name
, pd
->name
);
2783 disk
->devnode
= pktcdvd_devnode
;
2784 disk
->private_data
= pd
;
2785 disk
->queue
= blk_alloc_queue(GFP_KERNEL
);
2789 pd
->pkt_dev
= MKDEV(pktdev_major
, idx
);
2790 ret
= pkt_new_dev(pd
, dev
);
2794 /* inherit events of the host device */
2795 disk
->events
= pd
->bdev
->bd_disk
->events
;
2796 disk
->async_events
= pd
->bdev
->bd_disk
->async_events
;
2800 pkt_sysfs_dev_new(pd
);
2801 pkt_debugfs_dev_new(pd
);
2805 *pkt_dev
= pd
->pkt_dev
;
2807 mutex_unlock(&ctl_mutex
);
2811 blk_cleanup_queue(disk
->queue
);
2816 mempool_destroy(pd
->rb_pool
);
2819 mutex_unlock(&ctl_mutex
);
2820 printk(DRIVER_NAME
": setup of pktcdvd device failed\n");
2825 * Tear down mapping from pktcdvd device to CD-ROM device.
2827 static int pkt_remove_dev(dev_t pkt_dev
)
2829 struct pktcdvd_device
*pd
;
2833 mutex_lock_nested(&ctl_mutex
, SINGLE_DEPTH_NESTING
);
2835 for (idx
= 0; idx
< MAX_WRITERS
; idx
++) {
2837 if (pd
&& (pd
->pkt_dev
== pkt_dev
))
2840 if (idx
== MAX_WRITERS
) {
2841 DPRINTK(DRIVER_NAME
": dev not setup\n");
2846 if (pd
->refcnt
> 0) {
2850 if (!IS_ERR(pd
->cdrw
.thread
))
2851 kthread_stop(pd
->cdrw
.thread
);
2853 pkt_devs
[idx
] = NULL
;
2855 pkt_debugfs_dev_remove(pd
);
2856 pkt_sysfs_dev_remove(pd
);
2858 blkdev_put(pd
->bdev
, FMODE_READ
| FMODE_NDELAY
);
2860 remove_proc_entry(pd
->name
, pkt_proc
);
2861 DPRINTK(DRIVER_NAME
": writer %s unmapped\n", pd
->name
);
2863 del_gendisk(pd
->disk
);
2864 blk_cleanup_queue(pd
->disk
->queue
);
2867 mempool_destroy(pd
->rb_pool
);
2870 /* This is safe: open() is still holding a reference. */
2871 module_put(THIS_MODULE
);
2874 mutex_unlock(&ctl_mutex
);
2878 static void pkt_get_status(struct pkt_ctrl_command
*ctrl_cmd
)
2880 struct pktcdvd_device
*pd
;
2882 mutex_lock_nested(&ctl_mutex
, SINGLE_DEPTH_NESTING
);
2884 pd
= pkt_find_dev_from_minor(ctrl_cmd
->dev_index
);
2886 ctrl_cmd
->dev
= new_encode_dev(pd
->bdev
->bd_dev
);
2887 ctrl_cmd
->pkt_dev
= new_encode_dev(pd
->pkt_dev
);
2890 ctrl_cmd
->pkt_dev
= 0;
2892 ctrl_cmd
->num_devices
= MAX_WRITERS
;
2894 mutex_unlock(&ctl_mutex
);
2897 static long pkt_ctl_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
2899 void __user
*argp
= (void __user
*)arg
;
2900 struct pkt_ctrl_command ctrl_cmd
;
2904 if (cmd
!= PACKET_CTRL_CMD
)
2907 if (copy_from_user(&ctrl_cmd
, argp
, sizeof(struct pkt_ctrl_command
)))
2910 switch (ctrl_cmd
.command
) {
2911 case PKT_CTRL_CMD_SETUP
:
2912 if (!capable(CAP_SYS_ADMIN
))
2914 ret
= pkt_setup_dev(new_decode_dev(ctrl_cmd
.dev
), &pkt_dev
);
2915 ctrl_cmd
.pkt_dev
= new_encode_dev(pkt_dev
);
2917 case PKT_CTRL_CMD_TEARDOWN
:
2918 if (!capable(CAP_SYS_ADMIN
))
2920 ret
= pkt_remove_dev(new_decode_dev(ctrl_cmd
.pkt_dev
));
2922 case PKT_CTRL_CMD_STATUS
:
2923 pkt_get_status(&ctrl_cmd
);
2929 if (copy_to_user(argp
, &ctrl_cmd
, sizeof(struct pkt_ctrl_command
)))
2934 #ifdef CONFIG_COMPAT
2935 static long pkt_ctl_compat_ioctl(struct file
*file
, unsigned int cmd
, unsigned long arg
)
2937 return pkt_ctl_ioctl(file
, cmd
, (unsigned long)compat_ptr(arg
));
2941 static const struct file_operations pkt_ctl_fops
= {
2942 .open
= nonseekable_open
,
2943 .unlocked_ioctl
= pkt_ctl_ioctl
,
2944 #ifdef CONFIG_COMPAT
2945 .compat_ioctl
= pkt_ctl_compat_ioctl
,
2947 .owner
= THIS_MODULE
,
2948 .llseek
= no_llseek
,
2951 static struct miscdevice pkt_misc
= {
2952 .minor
= MISC_DYNAMIC_MINOR
,
2953 .name
= DRIVER_NAME
,
2954 .nodename
= "pktcdvd/control",
2955 .fops
= &pkt_ctl_fops
2958 static int __init
pkt_init(void)
2962 mutex_init(&ctl_mutex
);
2964 psd_pool
= mempool_create_kmalloc_pool(PSD_POOL_SIZE
,
2965 sizeof(struct packet_stacked_data
));
2969 ret
= register_blkdev(pktdev_major
, DRIVER_NAME
);
2971 printk(DRIVER_NAME
": Unable to register block device\n");
2977 ret
= pkt_sysfs_init();
2983 ret
= misc_register(&pkt_misc
);
2985 printk(DRIVER_NAME
": Unable to register misc device\n");
2989 pkt_proc
= proc_mkdir("driver/"DRIVER_NAME
, NULL
);
2994 pkt_debugfs_cleanup();
2995 pkt_sysfs_cleanup();
2997 unregister_blkdev(pktdev_major
, DRIVER_NAME
);
2999 mempool_destroy(psd_pool
);
3003 static void __exit
pkt_exit(void)
3005 remove_proc_entry("driver/"DRIVER_NAME
, NULL
);
3006 misc_deregister(&pkt_misc
);
3008 pkt_debugfs_cleanup();
3009 pkt_sysfs_cleanup();
3011 unregister_blkdev(pktdev_major
, DRIVER_NAME
);
3012 mempool_destroy(psd_pool
);
3015 MODULE_DESCRIPTION("Packet writing layer for CD/DVD drives");
3016 MODULE_AUTHOR("Jens Axboe <axboe@suse.de>");
3017 MODULE_LICENSE("GPL");
3019 module_init(pkt_init
);
3020 module_exit(pkt_exit
);