2 * drivers/s390/char/tape_core.c
3 * basic function of the tape device driver
5 * S390 and zSeries version
6 * Copyright IBM Corp. 2001,2006
7 * Author(s): Carsten Otte <cotte@de.ibm.com>
8 * Michael Holzheu <holzheu@de.ibm.com>
9 * Tuan Ngo-Anh <ngoanh@de.ibm.com>
10 * Martin Schwidefsky <schwidefsky@de.ibm.com>
11 * Stefan Bader <shbader@de.ibm.com>
14 #include <linux/module.h>
15 #include <linux/init.h> // for kernel parameters
16 #include <linux/kmod.h> // for requesting modules
17 #include <linux/spinlock.h> // for locks
18 #include <linux/vmalloc.h>
19 #include <linux/list.h>
21 #include <asm/types.h> // for variable types
23 #define TAPE_DBF_AREA tape_core_dbf
28 #define PRINTK_HEADER "TAPE_CORE: "
29 #define LONG_BUSY_TIMEOUT 180 /* seconds */
31 static void __tape_do_irq (struct ccw_device
*, unsigned long, struct irb
*);
32 static void tape_delayed_next_request(struct work_struct
*);
33 static void tape_long_busy_timeout(unsigned long data
);
36 * One list to contain all tape devices of all disciplines, so
37 * we can assign the devices to minor numbers of the same major
38 * The list is protected by the rwlock
40 static LIST_HEAD(tape_device_list
);
41 static DEFINE_RWLOCK(tape_device_lock
);
44 * Pointer to debug area.
46 debug_info_t
*TAPE_DBF_AREA
= NULL
;
47 EXPORT_SYMBOL(TAPE_DBF_AREA
);
50 * Printable strings for tape enumerations.
52 const char *tape_state_verbose
[TS_SIZE
] =
54 [TS_UNUSED
] = "UNUSED",
55 [TS_IN_USE
] = "IN_USE",
56 [TS_BLKUSE
] = "BLKUSE",
58 [TS_NOT_OPER
] = "NOT_OP"
61 const char *tape_op_verbose
[TO_SIZE
] =
63 [TO_BLOCK
] = "BLK", [TO_BSB
] = "BSB",
64 [TO_BSF
] = "BSF", [TO_DSE
] = "DSE",
65 [TO_FSB
] = "FSB", [TO_FSF
] = "FSF",
66 [TO_LBL
] = "LBL", [TO_NOP
] = "NOP",
67 [TO_RBA
] = "RBA", [TO_RBI
] = "RBI",
68 [TO_RFO
] = "RFO", [TO_REW
] = "REW",
69 [TO_RUN
] = "RUN", [TO_WRI
] = "WRI",
70 [TO_WTM
] = "WTM", [TO_MSEN
] = "MSN",
71 [TO_LOAD
] = "LOA", [TO_READ_CONFIG
] = "RCF",
72 [TO_READ_ATTMSG
] = "RAT",
73 [TO_DIS
] = "DIS", [TO_ASSIGN
] = "ASS",
74 [TO_UNASSIGN
] = "UAS", [TO_CRYPT_ON
] = "CON",
75 [TO_CRYPT_OFF
] = "COF", [TO_KEKL_SET
] = "KLS",
76 [TO_KEKL_QUERY
] = "KLQ",[TO_RDC
] = "RDC",
79 static int devid_to_int(struct ccw_dev_id
*dev_id
)
81 return dev_id
->devno
+ (dev_id
->ssid
<< 16);
85 * Some channel attached tape specific attributes.
87 * FIXME: In the future the first_minor and blocksize attribute should be
88 * replaced by a link to the cdev tree.
91 tape_medium_state_show(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
93 struct tape_device
*tdev
;
95 tdev
= (struct tape_device
*) dev
->driver_data
;
96 return scnprintf(buf
, PAGE_SIZE
, "%i\n", tdev
->medium_state
);
100 DEVICE_ATTR(medium_state
, 0444, tape_medium_state_show
, NULL
);
103 tape_first_minor_show(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
105 struct tape_device
*tdev
;
107 tdev
= (struct tape_device
*) dev
->driver_data
;
108 return scnprintf(buf
, PAGE_SIZE
, "%i\n", tdev
->first_minor
);
112 DEVICE_ATTR(first_minor
, 0444, tape_first_minor_show
, NULL
);
115 tape_state_show(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
117 struct tape_device
*tdev
;
119 tdev
= (struct tape_device
*) dev
->driver_data
;
120 return scnprintf(buf
, PAGE_SIZE
, "%s\n", (tdev
->first_minor
< 0) ?
121 "OFFLINE" : tape_state_verbose
[tdev
->tape_state
]);
125 DEVICE_ATTR(state
, 0444, tape_state_show
, NULL
);
128 tape_operation_show(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
130 struct tape_device
*tdev
;
133 tdev
= (struct tape_device
*) dev
->driver_data
;
134 if (tdev
->first_minor
< 0)
135 return scnprintf(buf
, PAGE_SIZE
, "N/A\n");
137 spin_lock_irq(get_ccwdev_lock(tdev
->cdev
));
138 if (list_empty(&tdev
->req_queue
))
139 rc
= scnprintf(buf
, PAGE_SIZE
, "---\n");
141 struct tape_request
*req
;
143 req
= list_entry(tdev
->req_queue
.next
, struct tape_request
,
145 rc
= scnprintf(buf
,PAGE_SIZE
, "%s\n", tape_op_verbose
[req
->op
]);
147 spin_unlock_irq(get_ccwdev_lock(tdev
->cdev
));
152 DEVICE_ATTR(operation
, 0444, tape_operation_show
, NULL
);
155 tape_blocksize_show(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
157 struct tape_device
*tdev
;
159 tdev
= (struct tape_device
*) dev
->driver_data
;
161 return scnprintf(buf
, PAGE_SIZE
, "%i\n", tdev
->char_data
.block_size
);
165 DEVICE_ATTR(blocksize
, 0444, tape_blocksize_show
, NULL
);
167 static struct attribute
*tape_attrs
[] = {
168 &dev_attr_medium_state
.attr
,
169 &dev_attr_first_minor
.attr
,
170 &dev_attr_state
.attr
,
171 &dev_attr_operation
.attr
,
172 &dev_attr_blocksize
.attr
,
176 static struct attribute_group tape_attr_group
= {
181 * Tape state functions
184 tape_state_set(struct tape_device
*device
, enum tape_state newstate
)
188 if (device
->tape_state
== TS_NOT_OPER
) {
189 DBF_EVENT(3, "ts_set err: not oper\n");
192 DBF_EVENT(4, "ts. dev: %x\n", device
->first_minor
);
193 DBF_EVENT(4, "old ts:\t\n");
194 if (device
->tape_state
< TS_SIZE
&& device
->tape_state
>=0 )
195 str
= tape_state_verbose
[device
->tape_state
];
198 DBF_EVENT(4, "%s\n", str
);
199 DBF_EVENT(4, "new ts:\t\n");
200 if (newstate
< TS_SIZE
&& newstate
>= 0)
201 str
= tape_state_verbose
[newstate
];
204 DBF_EVENT(4, "%s\n", str
);
205 device
->tape_state
= newstate
;
206 wake_up(&device
->state_change_wq
);
210 tape_med_state_set(struct tape_device
*device
, enum tape_medium_state newstate
)
212 if (device
->medium_state
== newstate
)
216 device
->tape_generic_status
|= GMT_DR_OPEN(~0);
217 PRINT_INFO("(%s): Tape is unloaded\n",
218 device
->cdev
->dev
.bus_id
);
221 device
->tape_generic_status
&= ~GMT_DR_OPEN(~0);
222 PRINT_INFO("(%s): Tape has been mounted\n",
223 device
->cdev
->dev
.bus_id
);
229 device
->medium_state
= newstate
;
230 wake_up(&device
->state_change_wq
);
234 * Stop running ccw. Has to be called with the device lock held.
237 __tape_cancel_io(struct tape_device
*device
, struct tape_request
*request
)
242 /* Check if interrupt has already been processed */
243 if (request
->callback
== NULL
)
247 for (retries
= 0; retries
< 5; retries
++) {
248 rc
= ccw_device_clear(device
->cdev
, (long) request
);
252 request
->status
= TAPE_REQUEST_DONE
;
255 request
->status
= TAPE_REQUEST_CANCEL
;
256 schedule_delayed_work(&device
->tape_dnr
, 0);
259 DBF_EXCEPTION(2, "device gone, retry\n");
262 DBF_EXCEPTION(2, "I/O error, retry\n");
273 * Add device into the sorted list, giving it the first
274 * available minor number.
277 tape_assign_minor(struct tape_device
*device
)
279 struct tape_device
*tmp
;
283 write_lock(&tape_device_lock
);
284 list_for_each_entry(tmp
, &tape_device_list
, node
) {
285 if (minor
< tmp
->first_minor
)
287 minor
+= TAPE_MINORS_PER_DEV
;
290 write_unlock(&tape_device_lock
);
293 device
->first_minor
= minor
;
294 list_add_tail(&device
->node
, &tmp
->node
);
295 write_unlock(&tape_device_lock
);
299 /* remove device from the list */
301 tape_remove_minor(struct tape_device
*device
)
303 write_lock(&tape_device_lock
);
304 list_del_init(&device
->node
);
305 device
->first_minor
= -1;
306 write_unlock(&tape_device_lock
);
310 * Set a device online.
312 * This function is called by the common I/O layer to move a device from the
313 * detected but offline into the online state.
314 * If we return an error (RC < 0) the device remains in the offline state. This
315 * can happen if the device is assigned somewhere else, for example.
318 tape_generic_online(struct tape_device
*device
,
319 struct tape_discipline
*discipline
)
323 DBF_LH(6, "tape_enable_device(%p, %p)\n", device
, discipline
);
325 if (device
->tape_state
!= TS_INIT
) {
326 DBF_LH(3, "Tapestate not INIT (%d)\n", device
->tape_state
);
330 init_timer(&device
->lb_timeout
);
331 device
->lb_timeout
.function
= tape_long_busy_timeout
;
333 /* Let the discipline have a go at the device. */
334 device
->discipline
= discipline
;
335 if (!try_module_get(discipline
->owner
)) {
336 PRINT_ERR("Cannot get module. Module gone.\n");
340 rc
= discipline
->setup_device(device
);
343 rc
= tape_assign_minor(device
);
347 rc
= tapechar_setup_device(device
);
350 rc
= tapeblock_setup_device(device
);
354 tape_state_set(device
, TS_UNUSED
);
356 DBF_LH(3, "(%08x): Drive set online\n", device
->cdev_id
);
361 tapechar_cleanup_device(device
);
363 device
->discipline
->cleanup_device(device
);
364 device
->discipline
= NULL
;
366 tape_remove_minor(device
);
368 module_put(discipline
->owner
);
373 tape_cleanup_device(struct tape_device
*device
)
375 tapeblock_cleanup_device(device
);
376 tapechar_cleanup_device(device
);
377 device
->discipline
->cleanup_device(device
);
378 module_put(device
->discipline
->owner
);
379 tape_remove_minor(device
);
380 tape_med_state_set(device
, MS_UNKNOWN
);
384 * Set device offline.
386 * Called by the common I/O layer if the drive should set offline on user
387 * request. We may prevent this by returning an error.
388 * Manual offline is only allowed while the drive is not in use.
391 tape_generic_offline(struct tape_device
*device
)
394 PRINT_ERR("tape_generic_offline: no such device\n");
398 DBF_LH(3, "(%08x): tape_generic_offline(%p)\n",
399 device
->cdev_id
, device
);
401 spin_lock_irq(get_ccwdev_lock(device
->cdev
));
402 switch (device
->tape_state
) {
405 spin_unlock_irq(get_ccwdev_lock(device
->cdev
));
408 tape_state_set(device
, TS_INIT
);
409 spin_unlock_irq(get_ccwdev_lock(device
->cdev
));
410 tape_cleanup_device(device
);
413 DBF_EVENT(3, "(%08x): Set offline failed "
416 PRINT_WARN("(%s): Set offline failed "
418 device
->cdev
->dev
.bus_id
);
419 spin_unlock_irq(get_ccwdev_lock(device
->cdev
));
423 DBF_LH(3, "(%08x): Drive set offline.\n", device
->cdev_id
);
428 * Allocate memory for a new device structure.
430 static struct tape_device
*
431 tape_alloc_device(void)
433 struct tape_device
*device
;
435 device
= kzalloc(sizeof(struct tape_device
), GFP_KERNEL
);
436 if (device
== NULL
) {
437 DBF_EXCEPTION(2, "ti:no mem\n");
438 PRINT_INFO ("can't allocate memory for "
439 "tape info structure\n");
440 return ERR_PTR(-ENOMEM
);
442 device
->modeset_byte
= kmalloc(1, GFP_KERNEL
| GFP_DMA
);
443 if (device
->modeset_byte
== NULL
) {
444 DBF_EXCEPTION(2, "ti:no mem\n");
445 PRINT_INFO("can't allocate memory for modeset byte\n");
447 return ERR_PTR(-ENOMEM
);
449 INIT_LIST_HEAD(&device
->req_queue
);
450 INIT_LIST_HEAD(&device
->node
);
451 init_waitqueue_head(&device
->state_change_wq
);
452 init_waitqueue_head(&device
->wait_queue
);
453 device
->tape_state
= TS_INIT
;
454 device
->medium_state
= MS_UNKNOWN
;
455 *device
->modeset_byte
= 0;
456 device
->first_minor
= -1;
457 atomic_set(&device
->ref_count
, 1);
458 INIT_DELAYED_WORK(&device
->tape_dnr
, tape_delayed_next_request
);
464 * Get a reference to an existing device structure. This will automatically
465 * increment the reference count.
468 tape_get_device_reference(struct tape_device
*device
)
470 DBF_EVENT(4, "tape_get_device_reference(%p) = %i\n", device
,
471 atomic_inc_return(&device
->ref_count
));
477 * Decrease the reference counter of a devices structure. If the
478 * reference counter reaches zero free the device structure.
479 * The function returns a NULL pointer to be used by the caller
480 * for clearing reference pointers.
483 tape_put_device(struct tape_device
*device
)
487 remain
= atomic_dec_return(&device
->ref_count
);
489 DBF_EVENT(4, "tape_put_device(%p) -> %i\n", device
, remain
);
492 DBF_EVENT(4, "put device without reference\n");
493 PRINT_ERR("put device without reference\n");
495 DBF_EVENT(4, "tape_free_device(%p)\n", device
);
496 kfree(device
->modeset_byte
);
505 * Find tape device by a device index.
508 tape_get_device(int devindex
)
510 struct tape_device
*device
, *tmp
;
512 device
= ERR_PTR(-ENODEV
);
513 read_lock(&tape_device_lock
);
514 list_for_each_entry(tmp
, &tape_device_list
, node
) {
515 if (tmp
->first_minor
/ TAPE_MINORS_PER_DEV
== devindex
) {
516 device
= tape_get_device_reference(tmp
);
520 read_unlock(&tape_device_lock
);
525 * Driverfs tape probe function.
528 tape_generic_probe(struct ccw_device
*cdev
)
530 struct tape_device
*device
;
532 struct ccw_dev_id dev_id
;
534 device
= tape_alloc_device();
537 ccw_device_set_options(cdev
, CCWDEV_DO_PATHGROUP
);
538 ret
= sysfs_create_group(&cdev
->dev
.kobj
, &tape_attr_group
);
540 tape_put_device(device
);
541 PRINT_ERR("probe failed for tape device %s\n", cdev
->dev
.bus_id
);
544 cdev
->dev
.driver_data
= device
;
545 cdev
->handler
= __tape_do_irq
;
547 ccw_device_get_id(cdev
, &dev_id
);
548 device
->cdev_id
= devid_to_int(&dev_id
);
549 PRINT_INFO("tape device %s found\n", cdev
->dev
.bus_id
);
554 __tape_discard_requests(struct tape_device
*device
)
556 struct tape_request
* request
;
557 struct list_head
* l
, *n
;
559 list_for_each_safe(l
, n
, &device
->req_queue
) {
560 request
= list_entry(l
, struct tape_request
, list
);
561 if (request
->status
== TAPE_REQUEST_IN_IO
)
562 request
->status
= TAPE_REQUEST_DONE
;
563 list_del(&request
->list
);
565 /* Decrease ref_count for removed request. */
566 request
->device
= tape_put_device(device
);
568 if (request
->callback
!= NULL
)
569 request
->callback(request
, request
->callback_data
);
574 * Driverfs tape remove function.
576 * This function is called whenever the common I/O layer detects the device
577 * gone. This can happen at any time and we cannot refuse.
580 tape_generic_remove(struct ccw_device
*cdev
)
582 struct tape_device
* device
;
584 device
= cdev
->dev
.driver_data
;
586 PRINT_ERR("No device pointer in tape_generic_remove!\n");
589 DBF_LH(3, "(%08x): tape_generic_remove(%p)\n", device
->cdev_id
, cdev
);
591 spin_lock_irq(get_ccwdev_lock(device
->cdev
));
592 switch (device
->tape_state
) {
594 tape_state_set(device
, TS_NOT_OPER
);
599 spin_unlock_irq(get_ccwdev_lock(device
->cdev
));
603 * Need only to release the device.
605 tape_state_set(device
, TS_NOT_OPER
);
606 spin_unlock_irq(get_ccwdev_lock(device
->cdev
));
607 tape_cleanup_device(device
);
611 * There may be requests on the queue. We will not get
612 * an interrupt for a request that was running. So we
613 * just post them all as I/O errors.
615 DBF_EVENT(3, "(%08x): Drive in use vanished!\n",
617 PRINT_WARN("(%s): Drive in use vanished - "
619 device
->cdev
->dev
.bus_id
);
620 PRINT_WARN("State was %i\n", device
->tape_state
);
621 tape_state_set(device
, TS_NOT_OPER
);
622 __tape_discard_requests(device
);
623 spin_unlock_irq(get_ccwdev_lock(device
->cdev
));
624 tape_cleanup_device(device
);
627 if (cdev
->dev
.driver_data
!= NULL
) {
628 sysfs_remove_group(&cdev
->dev
.kobj
, &tape_attr_group
);
629 cdev
->dev
.driver_data
= tape_put_device(cdev
->dev
.driver_data
);
634 * Allocate a new tape ccw request
636 struct tape_request
*
637 tape_alloc_request(int cplength
, int datasize
)
639 struct tape_request
*request
;
641 if (datasize
> PAGE_SIZE
|| (cplength
*sizeof(struct ccw1
)) > PAGE_SIZE
)
644 DBF_LH(6, "tape_alloc_request(%d, %d)\n", cplength
, datasize
);
646 request
= kzalloc(sizeof(struct tape_request
), GFP_KERNEL
);
647 if (request
== NULL
) {
648 DBF_EXCEPTION(1, "cqra nomem\n");
649 return ERR_PTR(-ENOMEM
);
651 /* allocate channel program */
653 request
->cpaddr
= kcalloc(cplength
, sizeof(struct ccw1
),
654 GFP_ATOMIC
| GFP_DMA
);
655 if (request
->cpaddr
== NULL
) {
656 DBF_EXCEPTION(1, "cqra nomem\n");
658 return ERR_PTR(-ENOMEM
);
661 /* alloc small kernel buffer */
663 request
->cpdata
= kzalloc(datasize
, GFP_KERNEL
| GFP_DMA
);
664 if (request
->cpdata
== NULL
) {
665 DBF_EXCEPTION(1, "cqra nomem\n");
666 kfree(request
->cpaddr
);
668 return ERR_PTR(-ENOMEM
);
671 DBF_LH(6, "New request %p(%p/%p)\n", request
, request
->cpaddr
,
678 * Free tape ccw request
681 tape_free_request (struct tape_request
* request
)
683 DBF_LH(6, "Free request %p\n", request
);
685 if (request
->device
!= NULL
) {
686 request
->device
= tape_put_device(request
->device
);
688 kfree(request
->cpdata
);
689 kfree(request
->cpaddr
);
694 __tape_start_io(struct tape_device
*device
, struct tape_request
*request
)
698 #ifdef CONFIG_S390_TAPE_BLOCK
699 if (request
->op
== TO_BLOCK
)
700 device
->discipline
->check_locate(device
, request
);
702 rc
= ccw_device_start(
705 (unsigned long) request
,
710 request
->status
= TAPE_REQUEST_IN_IO
;
711 } else if (rc
== -EBUSY
) {
712 /* The common I/O subsystem is currently busy. Retry later. */
713 request
->status
= TAPE_REQUEST_QUEUED
;
714 schedule_delayed_work(&device
->tape_dnr
, 0);
717 /* Start failed. Remove request and indicate failure. */
718 DBF_EVENT(1, "tape: start request failed with RC = %i\n", rc
);
724 __tape_start_next_request(struct tape_device
*device
)
726 struct list_head
*l
, *n
;
727 struct tape_request
*request
;
730 DBF_LH(6, "__tape_start_next_request(%p)\n", device
);
732 * Try to start each request on request queue until one is
733 * started successful.
735 list_for_each_safe(l
, n
, &device
->req_queue
) {
736 request
= list_entry(l
, struct tape_request
, list
);
739 * Avoid race condition if bottom-half was triggered more than
742 if (request
->status
== TAPE_REQUEST_IN_IO
)
745 * Request has already been stopped. We have to wait until
746 * the request is removed from the queue in the interrupt
749 if (request
->status
== TAPE_REQUEST_DONE
)
753 * We wanted to cancel the request but the common I/O layer
754 * was busy at that time. This can only happen if this
755 * function is called by delayed_next_request.
756 * Otherwise we start the next request on the queue.
758 if (request
->status
== TAPE_REQUEST_CANCEL
) {
759 rc
= __tape_cancel_io(device
, request
);
761 rc
= __tape_start_io(device
, request
);
766 /* Set ending status. */
768 request
->status
= TAPE_REQUEST_DONE
;
770 /* Remove from request queue. */
771 list_del(&request
->list
);
774 if (request
->callback
!= NULL
)
775 request
->callback(request
, request
->callback_data
);
780 tape_delayed_next_request(struct work_struct
*work
)
782 struct tape_device
*device
=
783 container_of(work
, struct tape_device
, tape_dnr
.work
);
785 DBF_LH(6, "tape_delayed_next_request(%p)\n", device
);
786 spin_lock_irq(get_ccwdev_lock(device
->cdev
));
787 __tape_start_next_request(device
);
788 spin_unlock_irq(get_ccwdev_lock(device
->cdev
));
791 static void tape_long_busy_timeout(unsigned long data
)
793 struct tape_request
*request
;
794 struct tape_device
*device
;
796 device
= (struct tape_device
*) data
;
797 spin_lock_irq(get_ccwdev_lock(device
->cdev
));
798 request
= list_entry(device
->req_queue
.next
, struct tape_request
, list
);
799 if (request
->status
!= TAPE_REQUEST_LONG_BUSY
)
801 DBF_LH(6, "%08x: Long busy timeout.\n", device
->cdev_id
);
802 __tape_start_next_request(device
);
803 device
->lb_timeout
.data
= (unsigned long) tape_put_device(device
);
804 spin_unlock_irq(get_ccwdev_lock(device
->cdev
));
809 struct tape_device
* device
,
810 struct tape_request
* request
,
813 DBF_LH(6, "__tape_end_request(%p, %p, %i)\n", device
, request
, rc
);
816 request
->status
= TAPE_REQUEST_DONE
;
818 /* Remove from request queue. */
819 list_del(&request
->list
);
822 if (request
->callback
!= NULL
)
823 request
->callback(request
, request
->callback_data
);
826 /* Start next request. */
827 if (!list_empty(&device
->req_queue
))
828 __tape_start_next_request(device
);
832 * Write sense data to console/dbf
835 tape_dump_sense(struct tape_device
* device
, struct tape_request
*request
,
840 PRINT_INFO("-------------------------------------------------\n");
841 PRINT_INFO("DSTAT : %02x CSTAT: %02x CPA: %04x\n",
842 irb
->scsw
.cmd
.dstat
, irb
->scsw
.cmd
.cstat
, irb
->scsw
.cmd
.cpa
);
843 PRINT_INFO("DEVICE: %s\n", device
->cdev
->dev
.bus_id
);
845 PRINT_INFO("OP : %s\n", tape_op_verbose
[request
->op
]);
847 sptr
= (unsigned int *) irb
->ecw
;
848 PRINT_INFO("Sense data: %08X %08X %08X %08X \n",
849 sptr
[0], sptr
[1], sptr
[2], sptr
[3]);
850 PRINT_INFO("Sense data: %08X %08X %08X %08X \n",
851 sptr
[4], sptr
[5], sptr
[6], sptr
[7]);
852 PRINT_INFO("--------------------------------------------------\n");
856 * Write sense data to dbf
859 tape_dump_sense_dbf(struct tape_device
*device
, struct tape_request
*request
,
866 op
= tape_op_verbose
[request
->op
];
869 DBF_EVENT(3, "DSTAT : %02x CSTAT: %02x\n",
870 irb
->scsw
.cmd
.dstat
, irb
->scsw
.cmd
.cstat
);
871 DBF_EVENT(3, "DEVICE: %08x OP\t: %s\n", device
->cdev_id
, op
);
872 sptr
= (unsigned int *) irb
->ecw
;
873 DBF_EVENT(3, "%08x %08x\n", sptr
[0], sptr
[1]);
874 DBF_EVENT(3, "%08x %08x\n", sptr
[2], sptr
[3]);
875 DBF_EVENT(3, "%08x %08x\n", sptr
[4], sptr
[5]);
876 DBF_EVENT(3, "%08x %08x\n", sptr
[6], sptr
[7]);
880 * I/O helper function. Adds the request to the request queue
881 * and starts it if the tape is idle. Has to be called with
882 * the device lock held.
885 __tape_start_request(struct tape_device
*device
, struct tape_request
*request
)
889 switch (request
->op
) {
895 if (device
->tape_state
== TS_INIT
)
897 if (device
->tape_state
== TS_UNUSED
)
900 if (device
->tape_state
== TS_BLKUSE
)
902 if (device
->tape_state
!= TS_IN_USE
)
906 /* Increase use count of device for the added request. */
907 request
->device
= tape_get_device_reference(device
);
909 if (list_empty(&device
->req_queue
)) {
910 /* No other requests are on the queue. Start this one. */
911 rc
= __tape_start_io(device
, request
);
915 DBF_LH(5, "Request %p added for execution.\n", request
);
916 list_add(&request
->list
, &device
->req_queue
);
918 DBF_LH(5, "Request %p add to queue.\n", request
);
919 request
->status
= TAPE_REQUEST_QUEUED
;
920 list_add_tail(&request
->list
, &device
->req_queue
);
926 * Add the request to the request queue, try to start it if the
927 * tape is idle. Return without waiting for end of i/o.
930 tape_do_io_async(struct tape_device
*device
, struct tape_request
*request
)
934 DBF_LH(6, "tape_do_io_async(%p, %p)\n", device
, request
);
936 spin_lock_irq(get_ccwdev_lock(device
->cdev
));
937 /* Add request to request queue and try to start it. */
938 rc
= __tape_start_request(device
, request
);
939 spin_unlock_irq(get_ccwdev_lock(device
->cdev
));
944 * tape_do_io/__tape_wake_up
945 * Add the request to the request queue, try to start it if the
946 * tape is idle and wait uninterruptible for its completion.
949 __tape_wake_up(struct tape_request
*request
, void *data
)
951 request
->callback
= NULL
;
952 wake_up((wait_queue_head_t
*) data
);
956 tape_do_io(struct tape_device
*device
, struct tape_request
*request
)
960 spin_lock_irq(get_ccwdev_lock(device
->cdev
));
962 request
->callback
= __tape_wake_up
;
963 request
->callback_data
= &device
->wait_queue
;
964 /* Add request to request queue and try to start it. */
965 rc
= __tape_start_request(device
, request
);
966 spin_unlock_irq(get_ccwdev_lock(device
->cdev
));
969 /* Request added to the queue. Wait for its completion. */
970 wait_event(device
->wait_queue
, (request
->callback
== NULL
));
971 /* Get rc from request */
976 * tape_do_io_interruptible/__tape_wake_up_interruptible
977 * Add the request to the request queue, try to start it if the
978 * tape is idle and wait uninterruptible for its completion.
981 __tape_wake_up_interruptible(struct tape_request
*request
, void *data
)
983 request
->callback
= NULL
;
984 wake_up_interruptible((wait_queue_head_t
*) data
);
988 tape_do_io_interruptible(struct tape_device
*device
,
989 struct tape_request
*request
)
993 spin_lock_irq(get_ccwdev_lock(device
->cdev
));
995 request
->callback
= __tape_wake_up_interruptible
;
996 request
->callback_data
= &device
->wait_queue
;
997 rc
= __tape_start_request(device
, request
);
998 spin_unlock_irq(get_ccwdev_lock(device
->cdev
));
1001 /* Request added to the queue. Wait for its completion. */
1002 rc
= wait_event_interruptible(device
->wait_queue
,
1003 (request
->callback
== NULL
));
1004 if (rc
!= -ERESTARTSYS
)
1005 /* Request finished normally. */
1008 /* Interrupted by a signal. We have to stop the current request. */
1009 spin_lock_irq(get_ccwdev_lock(device
->cdev
));
1010 rc
= __tape_cancel_io(device
, request
);
1011 spin_unlock_irq(get_ccwdev_lock(device
->cdev
));
1013 /* Wait for the interrupt that acknowledges the halt. */
1015 rc
= wait_event_interruptible(
1017 (request
->callback
== NULL
)
1019 } while (rc
== -ERESTARTSYS
);
1021 DBF_EVENT(3, "IO stopped on %08x\n", device
->cdev_id
);
1031 tape_cancel_io(struct tape_device
*device
, struct tape_request
*request
)
1035 spin_lock_irq(get_ccwdev_lock(device
->cdev
));
1036 rc
= __tape_cancel_io(device
, request
);
1037 spin_unlock_irq(get_ccwdev_lock(device
->cdev
));
1042 * Tape interrupt routine, called from the ccw_device layer
1045 __tape_do_irq (struct ccw_device
*cdev
, unsigned long intparm
, struct irb
*irb
)
1047 struct tape_device
*device
;
1048 struct tape_request
*request
;
1051 device
= (struct tape_device
*) cdev
->dev
.driver_data
;
1052 if (device
== NULL
) {
1053 PRINT_ERR("could not get device structure for %s "
1054 "in interrupt\n", cdev
->dev
.bus_id
);
1057 request
= (struct tape_request
*) intparm
;
1059 DBF_LH(6, "__tape_do_irq(device=%p, request=%p)\n", device
, request
);
1061 /* On special conditions irb is an error pointer */
1063 /* FIXME: What to do with the request? */
1064 switch (PTR_ERR(irb
)) {
1066 PRINT_WARN("(%s): Request timed out\n",
1069 __tape_end_request(device
, request
, -EIO
);
1072 PRINT_ERR("(%s): Unexpected i/o error %li\n",
1080 * If the condition code is not zero and the start function bit is
1081 * still set, this is an deferred error and the last start I/O did
1082 * not succeed. At this point the condition that caused the deferred
1083 * error might still apply. So we just schedule the request to be
1086 if (irb
->scsw
.cmd
.cc
!= 0 &&
1087 (irb
->scsw
.cmd
.fctl
& SCSW_FCTL_START_FUNC
) &&
1088 (request
->status
== TAPE_REQUEST_IN_IO
)) {
1089 DBF_EVENT(3,"(%08x): deferred cc=%i, fctl=%i. restarting\n",
1090 device
->cdev_id
, irb
->scsw
.cmd
.cc
, irb
->scsw
.cmd
.fctl
);
1091 request
->status
= TAPE_REQUEST_QUEUED
;
1092 schedule_delayed_work(&device
->tape_dnr
, HZ
);
1096 /* May be an unsolicited irq */
1098 request
->rescnt
= irb
->scsw
.cmd
.count
;
1099 else if ((irb
->scsw
.cmd
.dstat
== 0x85 || irb
->scsw
.cmd
.dstat
== 0x80) &&
1100 !list_empty(&device
->req_queue
)) {
1101 /* Not Ready to Ready after long busy ? */
1102 struct tape_request
*req
;
1103 req
= list_entry(device
->req_queue
.next
,
1104 struct tape_request
, list
);
1105 if (req
->status
== TAPE_REQUEST_LONG_BUSY
) {
1106 DBF_EVENT(3, "(%08x): del timer\n", device
->cdev_id
);
1107 if (del_timer(&device
->lb_timeout
)) {
1108 device
->lb_timeout
.data
= (unsigned long)
1109 tape_put_device(device
);
1110 __tape_start_next_request(device
);
1115 if (irb
->scsw
.cmd
.dstat
!= 0x0c) {
1116 /* Set the 'ONLINE' flag depending on sense byte 1 */
1117 if(*(((__u8
*) irb
->ecw
) + 1) & SENSE_DRIVE_ONLINE
)
1118 device
->tape_generic_status
|= GMT_ONLINE(~0);
1120 device
->tape_generic_status
&= ~GMT_ONLINE(~0);
1123 * Any request that does not come back with channel end
1124 * and device end is unusual. Log the sense data.
1126 DBF_EVENT(3,"-- Tape Interrupthandler --\n");
1127 tape_dump_sense_dbf(device
, request
, irb
);
1129 /* Upon normal completion the device _is_ online */
1130 device
->tape_generic_status
|= GMT_ONLINE(~0);
1132 if (device
->tape_state
== TS_NOT_OPER
) {
1133 DBF_EVENT(6, "tape:device is not operational\n");
1138 * Request that were canceled still come back with an interrupt.
1139 * To detect these request the state will be set to TAPE_REQUEST_DONE.
1141 if(request
!= NULL
&& request
->status
== TAPE_REQUEST_DONE
) {
1142 __tape_end_request(device
, request
, -EIO
);
1146 rc
= device
->discipline
->irq(device
, request
, irb
);
1148 * rc < 0 : request finished unsuccessfully.
1149 * rc == TAPE_IO_SUCCESS: request finished successfully.
1150 * rc == TAPE_IO_PENDING: request is still running. Ignore rc.
1151 * rc == TAPE_IO_RETRY: request finished but needs another go.
1152 * rc == TAPE_IO_STOP: request needs to get terminated.
1155 case TAPE_IO_SUCCESS
:
1156 /* Upon normal completion the device _is_ online */
1157 device
->tape_generic_status
|= GMT_ONLINE(~0);
1158 __tape_end_request(device
, request
, rc
);
1160 case TAPE_IO_PENDING
:
1162 case TAPE_IO_LONG_BUSY
:
1163 device
->lb_timeout
.data
=
1164 (unsigned long)tape_get_device_reference(device
);
1165 device
->lb_timeout
.expires
= jiffies
+
1166 LONG_BUSY_TIMEOUT
* HZ
;
1167 DBF_EVENT(3, "(%08x): add timer\n", device
->cdev_id
);
1168 add_timer(&device
->lb_timeout
);
1169 request
->status
= TAPE_REQUEST_LONG_BUSY
;
1172 rc
= __tape_start_io(device
, request
);
1174 __tape_end_request(device
, request
, rc
);
1177 rc
= __tape_cancel_io(device
, request
);
1179 __tape_end_request(device
, request
, rc
);
1183 DBF_EVENT(6, "xunknownrc\n");
1184 PRINT_ERR("Invalid return code from discipline "
1185 "interrupt function.\n");
1186 __tape_end_request(device
, request
, -EIO
);
1188 __tape_end_request(device
, request
, rc
);
1195 * Tape device open function used by tape_char & tape_block frontends.
1198 tape_open(struct tape_device
*device
)
1202 spin_lock(get_ccwdev_lock(device
->cdev
));
1203 if (device
->tape_state
== TS_NOT_OPER
) {
1204 DBF_EVENT(6, "TAPE:nodev\n");
1206 } else if (device
->tape_state
== TS_IN_USE
) {
1207 DBF_EVENT(6, "TAPE:dbusy\n");
1209 } else if (device
->tape_state
== TS_BLKUSE
) {
1210 DBF_EVENT(6, "TAPE:dbusy\n");
1212 } else if (device
->discipline
!= NULL
&&
1213 !try_module_get(device
->discipline
->owner
)) {
1214 DBF_EVENT(6, "TAPE:nodisc\n");
1217 tape_state_set(device
, TS_IN_USE
);
1220 spin_unlock(get_ccwdev_lock(device
->cdev
));
1225 * Tape device release function used by tape_char & tape_block frontends.
1228 tape_release(struct tape_device
*device
)
1230 spin_lock(get_ccwdev_lock(device
->cdev
));
1231 if (device
->tape_state
== TS_IN_USE
)
1232 tape_state_set(device
, TS_UNUSED
);
1233 module_put(device
->discipline
->owner
);
1234 spin_unlock(get_ccwdev_lock(device
->cdev
));
1239 * Execute a magnetic tape command a number of times.
1242 tape_mtop(struct tape_device
*device
, int mt_op
, int mt_count
)
1247 DBF_EVENT(6, "TAPE:mtio\n");
1248 DBF_EVENT(6, "TAPE:ioop: %x\n", mt_op
);
1249 DBF_EVENT(6, "TAPE:arg: %x\n", mt_count
);
1251 if (mt_op
< 0 || mt_op
>= TAPE_NR_MTOPS
)
1253 fn
= device
->discipline
->mtop_array
[mt_op
];
1257 /* We assume that the backends can handle count up to 500. */
1258 if (mt_op
== MTBSR
|| mt_op
== MTFSR
|| mt_op
== MTFSF
||
1259 mt_op
== MTBSF
|| mt_op
== MTFSFM
|| mt_op
== MTBSFM
) {
1261 for (; mt_count
> 500; mt_count
-= 500)
1262 if ((rc
= fn(device
, 500)) != 0)
1265 rc
= fn(device
, mt_count
);
1267 rc
= fn(device
, mt_count
);
1273 * Tape init function.
1278 TAPE_DBF_AREA
= debug_register ( "tape", 2, 2, 4*sizeof(long));
1279 debug_register_view(TAPE_DBF_AREA
, &debug_sprintf_view
);
1280 #ifdef DBF_LIKE_HELL
1281 debug_set_level(TAPE_DBF_AREA
, 6);
1283 DBF_EVENT(3, "tape init\n");
1291 * Tape exit function.
1296 DBF_EVENT(6, "tape exit\n");
1298 /* Get rid of the frontends */
1301 tape_proc_cleanup();
1302 debug_unregister (TAPE_DBF_AREA
);
1305 MODULE_AUTHOR("(C) 2001 IBM Deutschland Entwicklung GmbH by Carsten Otte and "
1306 "Michael Holzheu (cotte@de.ibm.com,holzheu@de.ibm.com)");
1307 MODULE_DESCRIPTION("Linux on zSeries channel attached tape device driver");
1308 MODULE_LICENSE("GPL");
1310 module_init(tape_init
);
1311 module_exit(tape_exit
);
1313 EXPORT_SYMBOL(tape_generic_remove
);
1314 EXPORT_SYMBOL(tape_generic_probe
);
1315 EXPORT_SYMBOL(tape_generic_online
);
1316 EXPORT_SYMBOL(tape_generic_offline
);
1317 EXPORT_SYMBOL(tape_put_device
);
1318 EXPORT_SYMBOL(tape_get_device_reference
);
1319 EXPORT_SYMBOL(tape_state_verbose
);
1320 EXPORT_SYMBOL(tape_op_verbose
);
1321 EXPORT_SYMBOL(tape_state_set
);
1322 EXPORT_SYMBOL(tape_med_state_set
);
1323 EXPORT_SYMBOL(tape_alloc_request
);
1324 EXPORT_SYMBOL(tape_free_request
);
1325 EXPORT_SYMBOL(tape_dump_sense
);
1326 EXPORT_SYMBOL(tape_dump_sense_dbf
);
1327 EXPORT_SYMBOL(tape_do_io
);
1328 EXPORT_SYMBOL(tape_do_io_async
);
1329 EXPORT_SYMBOL(tape_do_io_interruptible
);
1330 EXPORT_SYMBOL(tape_cancel_io
);
1331 EXPORT_SYMBOL(tape_mtop
);