2 * drivers/s390/char/tape_34xx.c
3 * tape device discipline for 3480/3490 tapes.
5 * Copyright (C) IBM Corp. 2001,2006
6 * Author(s): Carsten Otte <cotte@de.ibm.com>
7 * Tuan Ngo-Anh <ngoanh@de.ibm.com>
8 * Martin Schwidefsky <schwidefsky@de.ibm.com>
11 #include <linux/module.h>
12 #include <linux/init.h>
13 #include <linux/bio.h>
14 #include <linux/workqueue.h>
16 #define TAPE_DBF_AREA tape_34xx_dbf
21 #define PRINTK_HEADER "TAPE_34XX: "
24 * Pointer to debug area.
26 debug_info_t *TAPE_DBF_AREA = NULL;
27 EXPORT_SYMBOL(TAPE_DBF_AREA);
29 #define TAPE34XX_FMT_3480 0
30 #define TAPE34XX_FMT_3480_2_XF 1
31 #define TAPE34XX_FMT_3480_XF 2
33 struct tape_34xx_block_id {
34 unsigned int wrap : 1;
35 unsigned int segment : 7;
36 unsigned int format : 2;
37 unsigned int block : 22;
41 * A list of block ID's is used to faster seek blocks.
43 struct tape_34xx_sbid {
44 struct list_head list;
45 struct tape_34xx_block_id bid;
48 static void tape_34xx_delete_sbid_from(struct tape_device *, int);
51 * Medium sense for 34xx tapes. There is no 'real' medium sense call.
52 * So we just do a normal sense.
55 tape_34xx_medium_sense(struct tape_device *device)
57 struct tape_request *request;
61 request = tape_alloc_request(1, 32);
62 if (IS_ERR(request)) {
63 DBF_EXCEPTION(6, "MSEN fail\n");
64 return PTR_ERR(request);
67 request->op = TO_MSEN;
68 tape_ccw_end(request->cpaddr, SENSE, 32, request->cpdata);
70 rc = tape_do_io_interruptible(device, request);
71 if (request->rc == 0) {
72 sense = request->cpdata;
75 * This isn't quite correct. But since INTERVENTION_REQUIRED
76 * means that the drive is 'neither ready nor on-line' it is
77 * only slightly inaccurate to say there is no tape loaded if
78 * the drive isn't online...
80 if (sense[0] & SENSE_INTERVENTION_REQUIRED)
81 tape_med_state_set(device, MS_UNLOADED);
83 tape_med_state_set(device, MS_LOADED);
85 if (sense[1] & SENSE_WRITE_PROTECT)
86 device->tape_generic_status |= GMT_WR_PROT(~0);
88 device->tape_generic_status &= ~GMT_WR_PROT(~0);
90 DBF_EVENT(4, "tape_34xx: medium sense failed with rc=%d\n",
93 tape_free_request(request);
98 struct tape_34xx_work {
99 struct tape_device *device;
101 struct work_struct work;
105 * These functions are currently used only to schedule a medium_sense for
106 * later execution. This is because we get an interrupt whenever a medium
107 * is inserted but cannot call tape_do_io* from an interrupt context.
108 * Maybe that's useful for other actions we want to start from the
112 tape_34xx_work_handler(struct work_struct *work)
114 struct tape_34xx_work *p =
115 container_of(work, struct tape_34xx_work, work);
119 tape_34xx_medium_sense(p->device);
122 DBF_EVENT(3, "T34XX: internal error: unknown work\n");
125 p->device = tape_put_device(p->device);
130 tape_34xx_schedule_work(struct tape_device *device, enum tape_op op)
132 struct tape_34xx_work *p;
134 if ((p = kzalloc(sizeof(*p), GFP_ATOMIC)) == NULL)
137 INIT_WORK(&p->work, tape_34xx_work_handler);
139 p->device = tape_get_device_reference(device);
142 schedule_work(&p->work);
147 * Done Handler is called when dev stat = DEVICE-END (successful operation)
150 tape_34xx_done(struct tape_request *request)
152 DBF_EVENT(6, "%s done\n", tape_op_verbose[request->op]);
154 switch (request->op) {
161 tape_34xx_delete_sbid_from(request->device, 0);
166 return TAPE_IO_SUCCESS;
170 tape_34xx_erp_failed(struct tape_request *request, int rc)
172 DBF_EVENT(3, "Error recovery failed for %s (RC=%d)\n",
173 tape_op_verbose[request->op], rc);
178 tape_34xx_erp_succeeded(struct tape_request *request)
180 DBF_EVENT(3, "Error Recovery successful for %s\n",
181 tape_op_verbose[request->op]);
182 return tape_34xx_done(request);
186 tape_34xx_erp_retry(struct tape_request *request)
188 DBF_EVENT(3, "xerp retr %s\n", tape_op_verbose[request->op]);
189 return TAPE_IO_RETRY;
193 * This function is called, when no request is outstanding and we get an
197 tape_34xx_unsolicited_irq(struct tape_device *device, struct irb *irb)
199 if (irb->scsw.dstat == 0x85 /* READY */) {
200 /* A medium was inserted in the drive. */
201 DBF_EVENT(6, "xuud med\n");
202 tape_34xx_delete_sbid_from(device, 0);
203 tape_34xx_schedule_work(device, TO_MSEN);
205 DBF_EVENT(3, "unsol.irq! dev end: %08x\n", device->cdev_id);
206 PRINT_WARN("Unsolicited IRQ (Device End) caught.\n");
207 tape_dump_sense(device, NULL, irb);
209 return TAPE_IO_SUCCESS;
213 * Read Opposite Error Recovery Function:
214 * Used, when Read Forward does not work
217 tape_34xx_erp_read_opposite(struct tape_device *device,
218 struct tape_request *request)
220 if (request->op == TO_RFO) {
222 * We did read forward, but the data could not be read
223 * *correctly*. We transform the request to a read backward
226 tape_std_read_backward(device, request);
227 return tape_34xx_erp_retry(request);
229 if (request->op != TO_RBA)
230 PRINT_ERR("read_opposite called with state:%s\n",
231 tape_op_verbose[request->op]);
233 * We tried to read forward and backward, but hat no
236 return tape_34xx_erp_failed(request, -EIO);
240 tape_34xx_erp_bug(struct tape_device *device, struct tape_request *request,
241 struct irb *irb, int no)
243 if (request->op != TO_ASSIGN) {
244 PRINT_WARN("An unexpected condition #%d was caught in "
245 "tape error recovery.\n", no);
246 PRINT_WARN("Please report this incident.\n");
248 PRINT_WARN("Operation of tape:%s\n",
249 tape_op_verbose[request->op]);
250 tape_dump_sense(device, request, irb);
252 return tape_34xx_erp_failed(request, -EIO);
256 * Handle data overrun between cu and drive. The channel speed might
260 tape_34xx_erp_overrun(struct tape_device *device, struct tape_request *request,
263 if (irb->ecw[3] == 0x40) {
264 PRINT_WARN ("Data overrun error between control-unit "
265 "and drive. Use a faster channel connection, "
267 return tape_34xx_erp_failed(request, -EIO);
269 return tape_34xx_erp_bug(device, request, irb, -1);
273 * Handle record sequence error.
276 tape_34xx_erp_sequence(struct tape_device *device,
277 struct tape_request *request, struct irb *irb)
279 if (irb->ecw[3] == 0x41) {
281 * cu detected incorrect block-id sequence on tape.
283 PRINT_WARN("Illegal block-id sequence found!\n");
284 return tape_34xx_erp_failed(request, -EIO);
287 * Record sequence error bit is set, but erpa does not
288 * show record sequence error.
290 return tape_34xx_erp_bug(device, request, irb, -2);
294 * This function analyses the tape's sense-data in case of a unit-check.
295 * If possible, it tries to recover from the error. Else the user is
296 * informed about the problem.
299 tape_34xx_unit_check(struct tape_device *device, struct tape_request *request,
302 int inhibit_cu_recovery;
305 inhibit_cu_recovery = (*device->modeset_byte & 0x80) ? 1 : 0;
308 #ifdef CONFIG_S390_TAPE_BLOCK
309 if (request->op == TO_BLOCK) {
311 * Recovery for block device requests. Set the block_position
312 * to something invalid and retry.
314 device->blk_data.block_position = -1;
315 if (request->retries-- <= 0)
316 return tape_34xx_erp_failed(request, -EIO);
318 return tape_34xx_erp_retry(request);
323 sense[0] & SENSE_COMMAND_REJECT &&
324 sense[1] & SENSE_WRITE_PROTECT
327 request->op == TO_DSE ||
328 request->op == TO_WRI ||
329 request->op == TO_WTM
331 /* medium is write protected */
332 return tape_34xx_erp_failed(request, -EACCES);
334 return tape_34xx_erp_bug(device, request, irb, -3);
339 * Special cases for various tape-states when reaching
340 * end of recorded area
342 * FIXME: Maybe a special case of the special case:
343 * sense[0] == SENSE_EQUIPMENT_CHECK &&
344 * sense[1] == SENSE_DRIVE_ONLINE &&
345 * sense[3] == 0x47 (Volume Fenced)
347 * This was caused by continued FSF or FSR after an
351 sense[0] == SENSE_DATA_CHECK ||
352 sense[0] == SENSE_EQUIPMENT_CHECK ||
353 sense[0] == SENSE_EQUIPMENT_CHECK + SENSE_DEFERRED_UNIT_CHECK
355 sense[1] == SENSE_DRIVE_ONLINE ||
356 sense[1] == SENSE_BEGINNING_OF_TAPE + SENSE_WRITE_MODE
358 switch (request->op) {
360 * sense[0] == SENSE_DATA_CHECK &&
361 * sense[1] == SENSE_DRIVE_ONLINE
362 * sense[3] == 0x36 (End Of Data)
364 * Further seeks might return a 'Volume Fenced'.
368 /* Trying to seek beyond end of recorded area */
369 return tape_34xx_erp_failed(request, -ENOSPC);
371 return tape_34xx_erp_retry(request);
374 * sense[0] == SENSE_DATA_CHECK &&
375 * sense[1] == SENSE_DRIVE_ONLINE &&
376 * sense[3] == 0x36 (End Of Data)
379 /* Block could not be located. */
380 tape_34xx_delete_sbid_from(device, 0);
381 return tape_34xx_erp_failed(request, -EIO);
384 /* Read beyond end of recorded area -> 0 bytes read */
385 return tape_34xx_erp_failed(request, 0);
388 * sense[0] == SENSE_EQUIPMENT_CHECK &&
389 * sense[1] == SENSE_DRIVE_ONLINE &&
390 * sense[3] == 0x38 (Physical End Of Volume)
393 /* Writing at physical end of volume */
394 return tape_34xx_erp_failed(request, -ENOSPC);
396 PRINT_ERR("Invalid op in %s:%i\n",
397 __FUNCTION__, __LINE__);
398 return tape_34xx_erp_failed(request, 0);
402 /* Sensing special bits */
403 if (sense[0] & SENSE_BUS_OUT_CHECK)
404 return tape_34xx_erp_retry(request);
406 if (sense[0] & SENSE_DATA_CHECK) {
408 * hardware failure, damaged tape or improper
409 * operating conditions
413 /* a read data check occurred */
414 if ((sense[2] & SENSE_TAPE_SYNC_MODE) ||
416 // data check is not permanent, may be
417 // recovered. We always use async-mode with
418 // cu-recovery, so this should *never* happen.
419 return tape_34xx_erp_bug(device, request,
422 /* data check is permanent, CU recovery has failed */
423 PRINT_WARN("Permanent read error\n");
424 return tape_34xx_erp_failed(request, -EIO);
426 // a write data check occurred
427 if ((sense[2] & SENSE_TAPE_SYNC_MODE) ||
429 // data check is not permanent, may be
430 // recovered. We always use async-mode with
431 // cu-recovery, so this should *never* happen.
432 return tape_34xx_erp_bug(device, request,
435 // data check is permanent, cu-recovery has failed
436 PRINT_WARN("Permanent write error\n");
437 return tape_34xx_erp_failed(request, -EIO);
439 /* Data Check (read opposite) occurred. */
440 return tape_34xx_erp_read_opposite(device, request);
442 /* ID-Mark at tape start couldn't be written */
443 PRINT_WARN("ID-Mark could not be written.\n");
444 return tape_34xx_erp_failed(request, -EIO);
446 /* Tape void. Tried to read beyond end of device. */
447 PRINT_WARN("Read beyond end of recorded area.\n");
448 return tape_34xx_erp_failed(request, -ENOSPC);
450 /* Record sequence error. */
451 PRINT_WARN("Invalid block-id sequence found.\n");
452 return tape_34xx_erp_failed(request, -EIO);
454 /* all data checks for 3480 should result in one of
455 * the above erpa-codes. For 3490, other data-check
456 * conditions do exist. */
457 if (device->cdev->id.driver_info == tape_3480)
458 return tape_34xx_erp_bug(device, request,
463 if (sense[0] & SENSE_OVERRUN)
464 return tape_34xx_erp_overrun(device, request, irb);
466 if (sense[1] & SENSE_RECORD_SEQUENCE_ERR)
467 return tape_34xx_erp_sequence(device, request, irb);
469 /* Sensing erpa codes */
472 /* Unit check with erpa code 0. Report and ignore. */
473 PRINT_WARN("Non-error sense was found. "
474 "Unit-check will be ignored.\n");
475 return TAPE_IO_SUCCESS;
478 * Data streaming not operational. CU will switch to
479 * interlock mode. Reissue the command.
481 PRINT_WARN("Data streaming not operational. "
482 "Switching to interlock-mode.\n");
483 return tape_34xx_erp_retry(request);
486 * Path equipment check. Might be drive adapter error, buffer
487 * error on the lower interface, internal path not usable,
488 * or error during cartridge load.
490 PRINT_WARN("A path equipment check occurred. One of the "
491 "following conditions occurred:\n");
492 PRINT_WARN("drive adapter error, buffer error on the lower "
493 "interface, internal path not usable, error "
494 "during cartridge load.\n");
495 return tape_34xx_erp_failed(request, -EIO);
498 * Load display check. Load display was command was issued,
499 * but the drive is displaying a drive check message. Can
500 * be threated as "device end".
502 return tape_34xx_erp_succeeded(request);
505 * Command reject. May indicate illegal channel program or
506 * buffer over/underrun. Since all channel programs are
507 * issued by this driver and ought be correct, we assume a
508 * over/underrun situation and retry the channel program.
510 return tape_34xx_erp_retry(request);
513 * Function incompatible. Either the tape is idrc compressed
514 * but the hardware isn't capable to do idrc, or a perform
515 * subsystem func is issued and the CU is not on-line.
517 PRINT_WARN ("Function incompatible. Try to switch off idrc\n");
518 return tape_34xx_erp_failed(request, -EIO);
521 * Unsolicited environmental data. An internal counter
522 * overflows, we can ignore this and reissue the cmd.
524 return tape_34xx_erp_retry(request);
527 * Environmental data present. Indicates either unload
528 * completed ok or read buffered log command completed ok.
530 if (request->op == TO_RUN) {
531 /* Rewind unload completed ok. */
532 tape_med_state_set(device, MS_UNLOADED);
533 return tape_34xx_erp_succeeded(request);
535 /* tape_34xx doesn't use read buffered log commands. */
536 return tape_34xx_erp_bug(device, request, irb, sense[3]);
539 * Permanent equipment check. CU has tried recovery, but
542 return tape_34xx_erp_failed(request, -EIO);
544 /* Data security erase failure. */
545 if (request->op == TO_DSE)
546 return tape_34xx_erp_failed(request, -EIO);
547 /* Data security erase failure, but no such command issued. */
548 return tape_34xx_erp_bug(device, request, irb, sense[3]);
551 * Not capable. This indicates either that the drive fails
552 * reading the format id mark or that that format specified
553 * is not supported by the drive.
555 PRINT_WARN("Drive not capable processing the tape format!\n");
556 return tape_34xx_erp_failed(request, -EMEDIUMTYPE);
558 /* The medium is write protected. */
559 PRINT_WARN("Medium is write protected!\n");
560 return tape_34xx_erp_failed(request, -EACCES);
562 // Tension loss. We cannot recover this, it's an I/O error.
563 PRINT_WARN("The drive lost tape tension.\n");
564 return tape_34xx_erp_failed(request, -EIO);
567 * Load Failure. The cartridge was not inserted correctly or
568 * the tape is not threaded correctly.
570 PRINT_WARN("Cartridge load failure. Reload the cartridge "
572 tape_34xx_delete_sbid_from(device, 0);
573 return tape_34xx_erp_failed(request, -EIO);
576 * Unload failure. The drive cannot maintain tape tension
577 * and control tape movement during an unload operation.
579 PRINT_WARN("Failure during cartridge unload. "
580 "Please try manually.\n");
581 if (request->op == TO_RUN)
582 return tape_34xx_erp_failed(request, -EIO);
583 return tape_34xx_erp_bug(device, request, irb, sense[3]);
586 * Drive equipment check. One of the following:
587 * - cu cannot recover from a drive detected error
588 * - a check code message is shown on drive display
589 * - the cartridge loader does not respond correctly
590 * - a failure occurs during an index, load, or unload cycle
592 PRINT_WARN("Equipment check! Please check the drive and "
593 "the cartridge loader.\n");
594 return tape_34xx_erp_failed(request, -EIO);
596 if (device->cdev->id.driver_info == tape_3490)
598 return tape_34xx_erp_failed(request, -EIO);
599 /* This erpa is reserved for 3480 */
600 return tape_34xx_erp_bug(device, request, irb, sense[3]);
603 * Tape length error. The tape is shorter than reported in
604 * the beginning-of-tape data.
606 PRINT_WARN("Tape length error.\n");
607 return tape_34xx_erp_failed(request, -EIO);
610 * Physical end of tape. A read/write operation reached
611 * the physical end of tape.
613 if (request->op==TO_WRI ||
614 request->op==TO_DSE ||
616 return tape_34xx_erp_failed(request, -ENOSPC);
617 return tape_34xx_erp_failed(request, -EIO);
619 /* Backward at Beginning of tape. */
620 return tape_34xx_erp_failed(request, -EIO);
622 /* Drive switched to not ready. */
623 PRINT_WARN("Drive not ready. Turn the ready/not ready switch "
624 "to ready position and try again.\n");
625 return tape_34xx_erp_failed(request, -EIO);
627 /* Manual rewind or unload. This causes an I/O error. */
628 PRINT_WARN("Medium was rewound or unloaded manually.\n");
629 tape_34xx_delete_sbid_from(device, 0);
630 return tape_34xx_erp_failed(request, -EIO);
633 * Degraded mode. A condition that can cause degraded
634 * performance is detected.
636 PRINT_WARN("Subsystem is running in degraded mode.\n");
637 return tape_34xx_erp_retry(request);
639 /* Drive not ready. */
640 tape_34xx_delete_sbid_from(device, 0);
641 tape_med_state_set(device, MS_UNLOADED);
642 /* Some commands commands are successful even in this case */
643 if (sense[1] & SENSE_DRIVE_ONLINE) {
644 switch(request->op) {
649 return tape_34xx_done(request);
655 PRINT_WARN("The drive is not ready.\n");
656 return tape_34xx_erp_failed(request, -ENOMEDIUM);
658 /* Locate Block unsuccessful. */
659 if (request->op != TO_BLOCK && request->op != TO_LBL)
660 /* No locate block was issued. */
661 return tape_34xx_erp_bug(device, request,
663 return tape_34xx_erp_failed(request, -EIO);
665 /* The drive is assigned to a different channel path. */
666 PRINT_WARN("The drive is assigned elsewhere.\n");
667 return tape_34xx_erp_failed(request, -EIO);
670 * Drive not on-line. Drive may be switched offline,
671 * the power supply may be switched off or
672 * the drive address may not be set correctly.
674 PRINT_WARN("The drive is not on-line.");
675 return tape_34xx_erp_failed(request, -EIO);
677 /* Volume fenced. CU reports volume integrity is lost. */
678 PRINT_WARN("Volume fenced. The volume integrity is lost.\n");
679 tape_34xx_delete_sbid_from(device, 0);
680 return tape_34xx_erp_failed(request, -EIO);
682 /* Log sense data and retry request. */
683 return tape_34xx_erp_retry(request);
685 /* Bus out check. A parity check error on the bus was found. */
686 PRINT_WARN("Bus out check. A data transfer over the bus "
687 "has been corrupted.\n");
688 return tape_34xx_erp_failed(request, -EIO);
690 /* Control unit erp failed. */
691 PRINT_WARN("The control unit I/O error recovery failed.\n");
692 return tape_34xx_erp_failed(request, -EIO);
695 * CU and drive incompatible. The drive requests micro-program
696 * patches, which are not available on the CU.
698 PRINT_WARN("The drive needs microprogram patches from the "
699 "control unit, which are not available.\n");
700 return tape_34xx_erp_failed(request, -EIO);
703 * Recovered Check-One failure. Cu develops a hardware error,
704 * but is able to recover.
706 return tape_34xx_erp_retry(request);
708 if (device->cdev->id.driver_info == tape_3490)
710 * Resetting event received. Since the driver does
711 * not support resetting event recovery (which has to
712 * be handled by the I/O Layer), retry our command.
714 return tape_34xx_erp_retry(request);
715 /* This erpa is reserved for 3480. */
716 return tape_34xx_erp_bug(device, request, irb, sense[3]);
718 if (device->cdev->id.driver_info == tape_3490) {
720 * Maximum block size exceeded. This indicates, that
721 * the block to be written is larger than allowed for
724 PRINT_WARN("Maximum block size for buffered "
726 return tape_34xx_erp_failed(request, -ENOBUFS);
728 /* This erpa is reserved for 3480. */
729 return tape_34xx_erp_bug(device, request, irb, sense[3]);
732 * Read buffered log (Overflow). CU is running in extended
733 * buffered log mode, and a counter overflows. This should
734 * never happen, since we're never running in extended
737 return tape_34xx_erp_retry(request);
740 * Read buffered log (EOV). EOF processing occurs while the
741 * CU is in extended buffered log mode. This should never
742 * happen, since we're never running in extended buffered
745 return tape_34xx_erp_retry(request);
747 /* End of Volume complete. Rewind unload completed ok. */
748 if (request->op == TO_RUN) {
749 tape_med_state_set(device, MS_UNLOADED);
750 tape_34xx_delete_sbid_from(device, 0);
751 return tape_34xx_erp_succeeded(request);
753 return tape_34xx_erp_bug(device, request, irb, sense[3]);
755 /* Global command intercept. */
756 return tape_34xx_erp_retry(request);
758 /* Channel interface recovery (temporary). */
759 return tape_34xx_erp_retry(request);
761 /* Channel interface recovery (permanent). */
762 PRINT_WARN("A permanent channel interface error occurred.\n");
763 return tape_34xx_erp_failed(request, -EIO);
765 /* Channel protocol error. */
766 PRINT_WARN("A channel protocol error occurred.\n");
767 return tape_34xx_erp_failed(request, -EIO);
769 if (device->cdev->id.driver_info == tape_3480) {
770 /* Attention intercept. */
771 PRINT_WARN("An attention intercept occurred, "
772 "which will be recovered.\n");
773 return tape_34xx_erp_retry(request);
775 /* Global status intercept. */
776 PRINT_WARN("An global status intercept was received, "
777 "which will be recovered.\n");
778 return tape_34xx_erp_retry(request);
782 * Tape length incompatible. The tape inserted is too long,
783 * which could cause damage to the tape or the drive.
785 PRINT_WARN("Tape Length Incompatible\n");
786 PRINT_WARN("Tape length exceeds IBM enhanced capacity "
787 "cartdridge length or a medium\n");
788 PRINT_WARN("with EC-CST identification mark has been mounted "
789 "in a device that writes\n");
790 PRINT_WARN("3480 or 3480 XF format.\n");
791 return tape_34xx_erp_failed(request, -EIO);
793 /* Format 3480 XF incompatible */
794 if (sense[1] & SENSE_BEGINNING_OF_TAPE)
795 /* The tape will get overwritten. */
796 return tape_34xx_erp_retry(request);
797 PRINT_WARN("Format 3480 XF Incompatible\n");
798 PRINT_WARN("Medium has been created in 3480 format. "
799 "To change the format writes\n");
800 PRINT_WARN("must be issued at BOT.\n");
801 return tape_34xx_erp_failed(request, -EIO);
803 /* Format 3480-2 XF incompatible */
804 PRINT_WARN("Format 3480-2 XF Incompatible\n");
805 PRINT_WARN("Device can only read 3480 or 3480 XF format.\n");
806 return tape_34xx_erp_failed(request, -EIO);
808 /* Tape length violation. */
809 PRINT_WARN("Tape Length Violation\n");
810 PRINT_WARN("The mounted tape exceeds IBM Enhanced Capacity "
811 "Cartdridge System Tape length.\n");
812 PRINT_WARN("This may cause damage to the drive or tape when "
813 "processing to the EOV\n");
814 return tape_34xx_erp_failed(request, -EMEDIUMTYPE);
816 /* Compaction algorithm incompatible. */
817 PRINT_WARN("Compaction Algorithm Incompatible\n");
818 PRINT_WARN("The volume is recorded using an incompatible "
819 "compaction algorithm,\n");
820 PRINT_WARN("which is not supported by the device.\n");
821 return tape_34xx_erp_failed(request, -EMEDIUMTYPE);
823 /* The following erpas should have been covered earlier. */
824 case 0x23: /* Read data check. */
825 case 0x25: /* Write data check. */
826 case 0x26: /* Data check (read opposite). */
827 case 0x28: /* Write id mark check. */
828 case 0x31: /* Tape void. */
829 case 0x40: /* Overrun error. */
830 case 0x41: /* Record sequence error. */
831 /* All other erpas are reserved for future use. */
833 return tape_34xx_erp_bug(device, request, irb, sense[3]);
838 * 3480/3490 interrupt handler
841 tape_34xx_irq(struct tape_device *device, struct tape_request *request,
845 return tape_34xx_unsolicited_irq(device, irb);
847 if ((irb->scsw.dstat & DEV_STAT_UNIT_EXCEP) &&
848 (irb->scsw.dstat & DEV_STAT_DEV_END) &&
849 (request->op == TO_WRI)) {
850 /* Write at end of volume */
851 PRINT_INFO("End of volume\n"); /* XXX */
852 return tape_34xx_erp_failed(request, -ENOSPC);
855 if (irb->scsw.dstat & DEV_STAT_UNIT_CHECK)
856 return tape_34xx_unit_check(device, request, irb);
858 if (irb->scsw.dstat & DEV_STAT_DEV_END) {
860 * A unit exception occurs on skipping over a tapemark block.
862 if (irb->scsw.dstat & DEV_STAT_UNIT_EXCEP) {
863 if (request->op == TO_BSB || request->op == TO_FSB)
866 DBF_EVENT(5, "Unit Exception!\n");
868 return tape_34xx_done(request);
871 DBF_EVENT(6, "xunknownirq\n");
872 PRINT_ERR("Unexpected interrupt.\n");
873 PRINT_ERR("Current op is: %s", tape_op_verbose[request->op]);
874 tape_dump_sense(device, request, irb);
882 tape_34xx_ioctl(struct tape_device *device, unsigned int cmd, unsigned long arg)
884 if (cmd == TAPE390_DISPLAY) {
885 struct display_struct disp;
887 if (copy_from_user(&disp, (char __user *) arg, sizeof(disp)) != 0)
890 return tape_std_display(device, &disp);
896 tape_34xx_append_new_sbid(struct tape_34xx_block_id bid, struct list_head *l)
898 struct tape_34xx_sbid * new_sbid;
900 new_sbid = kmalloc(sizeof(*new_sbid), GFP_ATOMIC);
905 list_add(&new_sbid->list, l);
909 * Build up the search block ID list. The block ID consists of a logical
910 * block number and a hardware specific part. The hardware specific part
911 * helps the tape drive to speed up searching for a specific block.
914 tape_34xx_add_sbid(struct tape_device *device, struct tape_34xx_block_id bid)
916 struct list_head * sbid_list;
917 struct tape_34xx_sbid * sbid;
918 struct list_head * l;
921 * immediately return if there is no list at all or the block to add
922 * is located in segment 1 of wrap 0 because this position is used
923 * if no hardware position data is supplied.
925 sbid_list = (struct list_head *) device->discdata;
926 if (!sbid_list || (bid.segment < 2 && bid.wrap == 0))
930 * Search the position where to insert the new entry. Hardware
931 * acceleration uses only the segment and wrap number. So we
932 * need only one entry for a specific wrap/segment combination.
933 * If there is a block with a lower number but the same hard-
934 * ware position data we just update the block number in the
937 list_for_each(l, sbid_list) {
938 sbid = list_entry(l, struct tape_34xx_sbid, list);
941 (sbid->bid.segment == bid.segment) &&
942 (sbid->bid.wrap == bid.wrap)
944 if (bid.block < sbid->bid.block)
950 /* Sort in according to logical block number. */
951 if (bid.block < sbid->bid.block) {
952 tape_34xx_append_new_sbid(bid, l->prev);
956 /* List empty or new block bigger than last entry. */
958 tape_34xx_append_new_sbid(bid, l->prev);
960 DBF_LH(4, "Current list is:\n");
961 list_for_each(l, sbid_list) {
962 sbid = list_entry(l, struct tape_34xx_sbid, list);
963 DBF_LH(4, "%d:%03d@%05d\n",
972 * Delete all entries from the search block ID list that belong to tape blocks
973 * equal or higher than the given number.
976 tape_34xx_delete_sbid_from(struct tape_device *device, int from)
978 struct list_head * sbid_list;
979 struct tape_34xx_sbid * sbid;
980 struct list_head * l;
981 struct list_head * n;
983 sbid_list = (struct list_head *) device->discdata;
987 list_for_each_safe(l, n, sbid_list) {
988 sbid = list_entry(l, struct tape_34xx_sbid, list);
989 if (sbid->bid.block >= from) {
990 DBF_LH(4, "Delete sbid %d:%03d@%05d\n",
1002 * Merge hardware position data into a block id.
1005 tape_34xx_merge_sbid(
1006 struct tape_device * device,
1007 struct tape_34xx_block_id * bid
1009 struct tape_34xx_sbid * sbid;
1010 struct tape_34xx_sbid * sbid_to_use;
1011 struct list_head * sbid_list;
1012 struct list_head * l;
1014 sbid_list = (struct list_head *) device->discdata;
1018 if (!sbid_list || list_empty(sbid_list))
1022 list_for_each(l, sbid_list) {
1023 sbid = list_entry(l, struct tape_34xx_sbid, list);
1025 if (sbid->bid.block >= bid->block)
1030 bid->wrap = sbid_to_use->bid.wrap;
1031 bid->segment = sbid_to_use->bid.segment;
1032 DBF_LH(4, "Use %d:%03d@%05d for %05d\n",
1033 sbid_to_use->bid.wrap,
1034 sbid_to_use->bid.segment,
1035 sbid_to_use->bid.block,
1042 tape_34xx_setup_device(struct tape_device * device)
1045 struct list_head * discdata;
1047 DBF_EVENT(6, "34xx device setup\n");
1048 if ((rc = tape_std_assign(device)) == 0) {
1049 if ((rc = tape_34xx_medium_sense(device)) != 0) {
1050 DBF_LH(3, "34xx medium sense returned %d\n", rc);
1053 discdata = kmalloc(sizeof(struct list_head), GFP_KERNEL);
1055 INIT_LIST_HEAD(discdata);
1056 device->discdata = discdata;
1063 tape_34xx_cleanup_device(struct tape_device *device)
1065 tape_std_unassign(device);
1067 if (device->discdata) {
1068 tape_34xx_delete_sbid_from(device, 0);
1069 kfree(device->discdata);
1070 device->discdata = NULL;
1076 * MTTELL: Tell block. Return the number of block relative to current file.
1079 tape_34xx_mttell(struct tape_device *device, int mt_count)
1082 struct tape_34xx_block_id cbid;
1083 struct tape_34xx_block_id dbid;
1084 } __attribute__ ((packed)) block_id;
1087 rc = tape_std_read_block_id(device, (__u64 *) &block_id);
1091 tape_34xx_add_sbid(device, block_id.cbid);
1092 return block_id.cbid.block;
1096 * MTSEEK: seek to the specified block.
1099 tape_34xx_mtseek(struct tape_device *device, int mt_count)
1101 struct tape_request *request;
1102 struct tape_34xx_block_id * bid;
1104 if (mt_count > 0x3fffff) {
1105 DBF_EXCEPTION(6, "xsee parm\n");
1108 request = tape_alloc_request(3, 4);
1109 if (IS_ERR(request))
1110 return PTR_ERR(request);
1113 request->op = TO_LBL;
1114 bid = (struct tape_34xx_block_id *) request->cpdata;
1115 bid->format = (*device->modeset_byte & 0x08) ?
1116 TAPE34XX_FMT_3480_XF : TAPE34XX_FMT_3480;
1117 bid->block = mt_count;
1118 tape_34xx_merge_sbid(device, bid);
1120 tape_ccw_cc(request->cpaddr, MODE_SET_DB, 1, device->modeset_byte);
1121 tape_ccw_cc(request->cpaddr + 1, LOCATE, 4, request->cpdata);
1122 tape_ccw_end(request->cpaddr + 2, NOP, 0, NULL);
1125 return tape_do_io_free(device, request);
1128 #ifdef CONFIG_S390_TAPE_BLOCK
1130 * Tape block read for 34xx.
1132 static struct tape_request *
1133 tape_34xx_bread(struct tape_device *device, struct request *req)
1135 struct tape_request *request;
1141 struct req_iterator iter;
1142 struct tape_34xx_block_id * start_block;
1144 DBF_EVENT(6, "xBREDid:");
1146 /* Count the number of blocks for the request. */
1147 rq_for_each_segment(bv, req, iter)
1148 count += bv->bv_len >> (TAPEBLOCK_HSEC_S2B + 9);
1150 /* Allocate the ccw request. */
1151 request = tape_alloc_request(3+count+1, 8);
1152 if (IS_ERR(request))
1156 request->op = TO_BLOCK;
1157 start_block = (struct tape_34xx_block_id *) request->cpdata;
1158 start_block->block = req->sector >> TAPEBLOCK_HSEC_S2B;
1159 DBF_EVENT(6, "start_block = %i\n", start_block->block);
1161 ccw = request->cpaddr;
1162 ccw = tape_ccw_cc(ccw, MODE_SET_DB, 1, device->modeset_byte);
1165 * We always setup a nop after the mode set ccw. This slot is
1166 * used in tape_std_check_locate to insert a locate ccw if the
1167 * current tape position doesn't match the start block to be read.
1168 * The second nop will be filled with a read block id which is in
1169 * turn used by tape_34xx_free_bread to populate the segment bid
1172 ccw = tape_ccw_cc(ccw, NOP, 0, NULL);
1173 ccw = tape_ccw_cc(ccw, NOP, 0, NULL);
1175 rq_for_each_segment(bv, req, iter) {
1176 dst = kmap(bv->bv_page) + bv->bv_offset;
1177 for (off = 0; off < bv->bv_len; off += TAPEBLOCK_HSEC_SIZE) {
1178 ccw->flags = CCW_FLAG_CC;
1179 ccw->cmd_code = READ_FORWARD;
1180 ccw->count = TAPEBLOCK_HSEC_SIZE;
1181 set_normalized_cda(ccw, (void*) __pa(dst));
1183 dst += TAPEBLOCK_HSEC_SIZE;
1187 ccw = tape_ccw_end(ccw, NOP, 0, NULL);
1188 DBF_EVENT(6, "xBREDccwg\n");
1193 tape_34xx_free_bread (struct tape_request *request)
1197 ccw = request->cpaddr;
1198 if ((ccw + 2)->cmd_code == READ_BLOCK_ID) {
1200 struct tape_34xx_block_id cbid;
1201 struct tape_34xx_block_id dbid;
1202 } __attribute__ ((packed)) *rbi_data;
1204 rbi_data = request->cpdata;
1206 if (request->device)
1207 tape_34xx_add_sbid(request->device, rbi_data->cbid);
1210 /* Last ccw is a nop and doesn't need clear_normalized_cda */
1211 for (; ccw->flags & CCW_FLAG_CC; ccw++)
1212 if (ccw->cmd_code == READ_FORWARD)
1213 clear_normalized_cda(ccw);
1214 tape_free_request(request);
1218 * check_locate is called just before the tape request is passed to
1219 * the common io layer for execution. It has to check the current
1220 * tape position and insert a locate ccw if it doesn't match the
1221 * start block for the request.
1224 tape_34xx_check_locate(struct tape_device *device, struct tape_request *request)
1226 struct tape_34xx_block_id * start_block;
1228 start_block = (struct tape_34xx_block_id *) request->cpdata;
1229 if (start_block->block == device->blk_data.block_position)
1232 DBF_LH(4, "Block seek(%06d+%06d)\n", start_block->block, device->bof);
1233 start_block->wrap = 0;
1234 start_block->segment = 1;
1235 start_block->format = (*device->modeset_byte & 0x08) ?
1236 TAPE34XX_FMT_3480_XF :
1238 start_block->block = start_block->block + device->bof;
1239 tape_34xx_merge_sbid(device, start_block);
1240 tape_ccw_cc(request->cpaddr + 1, LOCATE, 4, request->cpdata);
1241 tape_ccw_cc(request->cpaddr + 2, READ_BLOCK_ID, 8, request->cpdata);
1246 * List of 3480/3490 magnetic tape commands.
1248 static tape_mtop_fn tape_34xx_mtop[TAPE_NR_MTOPS] = {
1249 [MTRESET] = tape_std_mtreset,
1250 [MTFSF] = tape_std_mtfsf,
1251 [MTBSF] = tape_std_mtbsf,
1252 [MTFSR] = tape_std_mtfsr,
1253 [MTBSR] = tape_std_mtbsr,
1254 [MTWEOF] = tape_std_mtweof,
1255 [MTREW] = tape_std_mtrew,
1256 [MTOFFL] = tape_std_mtoffl,
1257 [MTNOP] = tape_std_mtnop,
1258 [MTRETEN] = tape_std_mtreten,
1259 [MTBSFM] = tape_std_mtbsfm,
1260 [MTFSFM] = tape_std_mtfsfm,
1261 [MTEOM] = tape_std_mteom,
1262 [MTERASE] = tape_std_mterase,
1266 [MTSETBLK] = tape_std_mtsetblk,
1267 [MTSETDENSITY] = NULL,
1268 [MTSEEK] = tape_34xx_mtseek,
1269 [MTTELL] = tape_34xx_mttell,
1270 [MTSETDRVBUFFER] = NULL,
1276 [MTLOAD] = tape_std_mtload,
1277 [MTUNLOAD] = tape_std_mtunload,
1278 [MTCOMPRESSION] = tape_std_mtcompression,
1284 * Tape discipline structure for 3480 and 3490.
1286 static struct tape_discipline tape_discipline_34xx = {
1287 .owner = THIS_MODULE,
1288 .setup_device = tape_34xx_setup_device,
1289 .cleanup_device = tape_34xx_cleanup_device,
1290 .process_eov = tape_std_process_eov,
1291 .irq = tape_34xx_irq,
1292 .read_block = tape_std_read_block,
1293 .write_block = tape_std_write_block,
1294 #ifdef CONFIG_S390_TAPE_BLOCK
1295 .bread = tape_34xx_bread,
1296 .free_bread = tape_34xx_free_bread,
1297 .check_locate = tape_34xx_check_locate,
1299 .ioctl_fn = tape_34xx_ioctl,
1300 .mtop_array = tape_34xx_mtop
1303 static struct ccw_device_id tape_34xx_ids[] = {
1304 { CCW_DEVICE_DEVTYPE(0x3480, 0, 0x3480, 0), .driver_info = tape_3480},
1305 { CCW_DEVICE_DEVTYPE(0x3490, 0, 0x3490, 0), .driver_info = tape_3490},
1306 { /* end of list */ },
1310 tape_34xx_online(struct ccw_device *cdev)
1312 return tape_generic_online(
1313 cdev->dev.driver_data,
1314 &tape_discipline_34xx
1319 tape_34xx_offline(struct ccw_device *cdev)
1321 return tape_generic_offline(cdev->dev.driver_data);
1324 static struct ccw_driver tape_34xx_driver = {
1325 .name = "tape_34xx",
1326 .owner = THIS_MODULE,
1327 .ids = tape_34xx_ids,
1328 .probe = tape_generic_probe,
1329 .remove = tape_generic_remove,
1330 .set_online = tape_34xx_online,
1331 .set_offline = tape_34xx_offline,
1335 tape_34xx_init (void)
1339 TAPE_DBF_AREA = debug_register ( "tape_34xx", 2, 2, 4*sizeof(long));
1340 debug_register_view(TAPE_DBF_AREA, &debug_sprintf_view);
1341 #ifdef DBF_LIKE_HELL
1342 debug_set_level(TAPE_DBF_AREA, 6);
1345 DBF_EVENT(3, "34xx init\n");
1346 /* Register driver for 3480/3490 tapes. */
1347 rc = ccw_driver_register(&tape_34xx_driver);
1349 DBF_EVENT(3, "34xx init failed\n");
1351 DBF_EVENT(3, "34xx registered\n");
1356 tape_34xx_exit(void)
1358 ccw_driver_unregister(&tape_34xx_driver);
1360 debug_unregister(TAPE_DBF_AREA);
1363 MODULE_DEVICE_TABLE(ccw, tape_34xx_ids);
1364 MODULE_AUTHOR("(C) 2001-2002 IBM Deutschland Entwicklung GmbH");
1365 MODULE_DESCRIPTION("Linux on zSeries channel attached 3480 tape device driver");
1366 MODULE_LICENSE("GPL");
1368 module_init(tape_34xx_init);
1369 module_exit(tape_34xx_exit);