2 * drivers/s390/char/tape_std.c
3 * standard tape device functions for ibm tapes.
5 * S390 and zSeries version
6 * Copyright (C) 2001,2002 IBM Deutschland Entwicklung GmbH, IBM Corporation
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 #define KMSG_COMPONENT "tape"
15 #define pr_fmt(fmt) KMSG_COMPONENT ": " fmt
17 #include <linux/stddef.h>
18 #include <linux/kernel.h>
19 #include <linux/bio.h>
20 #include <linux/timer.h>
22 #include <asm/types.h>
23 #include <asm/idals.h>
24 #include <asm/ebcdic.h>
25 #include <asm/tape390.h>
27 #define TAPE_DBF_AREA tape_core_dbf
36 tape_std_assign_timeout(unsigned long data
)
38 struct tape_request
* request
;
39 struct tape_device
* device
;
42 request
= (struct tape_request
*) data
;
43 device
= request
->device
;
46 DBF_EVENT(3, "%08x: Assignment timeout. Device busy.\n",
48 rc
= tape_cancel_io(device
, request
);
50 DBF_EVENT(3, "(%s): Assign timeout: Cancel failed with rc = %i\n",
51 dev_name(&device
->cdev
->dev
), rc
);
55 tape_std_assign(struct tape_device
*device
)
58 struct timer_list timeout
;
59 struct tape_request
*request
;
61 request
= tape_alloc_request(2, 11);
63 return PTR_ERR(request
);
65 request
->op
= TO_ASSIGN
;
66 tape_ccw_cc(request
->cpaddr
, ASSIGN
, 11, request
->cpdata
);
67 tape_ccw_end(request
->cpaddr
+ 1, NOP
, 0, NULL
);
70 * The assign command sometimes blocks if the device is assigned
71 * to another host (actually this shouldn't happen but it does).
72 * So we set up a timeout for this call.
74 init_timer_on_stack(&timeout
);
75 timeout
.function
= tape_std_assign_timeout
;
76 timeout
.data
= (unsigned long) request
;
77 timeout
.expires
= jiffies
+ 2 * HZ
;
80 rc
= tape_do_io_interruptible(device
, request
);
85 DBF_EVENT(3, "%08x: assign failed - device might be busy\n",
88 DBF_EVENT(3, "%08x: Tape assigned\n", device
->cdev_id
);
90 tape_free_request(request
);
98 tape_std_unassign (struct tape_device
*device
)
101 struct tape_request
*request
;
103 if (device
->tape_state
== TS_NOT_OPER
) {
104 DBF_EVENT(3, "(%08x): Can't unassign device\n",
109 request
= tape_alloc_request(2, 11);
111 return PTR_ERR(request
);
113 request
->op
= TO_UNASSIGN
;
114 tape_ccw_cc(request
->cpaddr
, UNASSIGN
, 11, request
->cpdata
);
115 tape_ccw_end(request
->cpaddr
+ 1, NOP
, 0, NULL
);
117 if ((rc
= tape_do_io(device
, request
)) != 0) {
118 DBF_EVENT(3, "%08x: Unassign failed\n", device
->cdev_id
);
120 DBF_EVENT(3, "%08x: Tape unassigned\n", device
->cdev_id
);
122 tape_free_request(request
);
127 * TAPE390_DISPLAY: Show a string on the tape display.
130 tape_std_display(struct tape_device
*device
, struct display_struct
*disp
)
132 struct tape_request
*request
;
135 request
= tape_alloc_request(2, 17);
136 if (IS_ERR(request
)) {
137 DBF_EVENT(3, "TAPE: load display failed\n");
138 return PTR_ERR(request
);
140 request
->op
= TO_DIS
;
142 *(unsigned char *) request
->cpdata
= disp
->cntrl
;
143 DBF_EVENT(5, "TAPE: display cntrl=%04x\n", disp
->cntrl
);
144 memcpy(((unsigned char *) request
->cpdata
) + 1, disp
->message1
, 8);
145 memcpy(((unsigned char *) request
->cpdata
) + 9, disp
->message2
, 8);
146 ASCEBC(((unsigned char*) request
->cpdata
) + 1, 16);
148 tape_ccw_cc(request
->cpaddr
, LOAD_DISPLAY
, 17, request
->cpdata
);
149 tape_ccw_end(request
->cpaddr
+ 1, NOP
, 0, NULL
);
151 rc
= tape_do_io_interruptible(device
, request
);
152 tape_free_request(request
);
160 tape_std_read_block_id(struct tape_device
*device
, __u64
*id
)
162 struct tape_request
*request
;
165 request
= tape_alloc_request(3, 8);
167 return PTR_ERR(request
);
168 request
->op
= TO_RBI
;
170 tape_ccw_cc(request
->cpaddr
, MODE_SET_DB
, 1, device
->modeset_byte
);
171 tape_ccw_cc(request
->cpaddr
+ 1, READ_BLOCK_ID
, 8, request
->cpdata
);
172 tape_ccw_end(request
->cpaddr
+ 2, NOP
, 0, NULL
);
174 rc
= tape_do_io(device
, request
);
176 /* Get result from read buffer. */
177 *id
= *(__u64
*) request
->cpdata
;
178 tape_free_request(request
);
183 tape_std_terminate_write(struct tape_device
*device
)
187 if(device
->required_tapemarks
== 0)
190 DBF_LH(5, "tape%d: terminate write %dxEOF\n", device
->first_minor
,
191 device
->required_tapemarks
);
193 rc
= tape_mtop(device
, MTWEOF
, device
->required_tapemarks
);
197 device
->required_tapemarks
= 0;
198 return tape_mtop(device
, MTBSR
, 1);
202 * MTLOAD: Loads the tape.
203 * The default implementation just wait until the tape medium state changes
207 tape_std_mtload(struct tape_device
*device
, int count
)
209 return wait_event_interruptible(device
->state_change_wq
,
210 (device
->medium_state
== MS_LOADED
));
214 * MTSETBLK: Set block size.
217 tape_std_mtsetblk(struct tape_device
*device
, int count
)
219 struct idal_buffer
*new;
221 DBF_LH(6, "tape_std_mtsetblk(%d)\n", count
);
224 * Just set block_size to 0. tapechar_read/tapechar_write
225 * will realloc the idal buffer if a bigger one than the
228 device
->char_data
.block_size
= 0;
231 if (device
->char_data
.idal_buf
!= NULL
&&
232 device
->char_data
.idal_buf
->size
== count
)
233 /* We already have a idal buffer of that size. */
236 if (count
> MAX_BLOCKSIZE
) {
237 DBF_EVENT(3, "Invalid block size (%d > %d) given.\n",
238 count
, MAX_BLOCKSIZE
);
242 /* Allocate a new idal buffer. */
243 new = idal_buffer_alloc(count
, 0);
246 if (device
->char_data
.idal_buf
!= NULL
)
247 idal_buffer_free(device
->char_data
.idal_buf
);
248 device
->char_data
.idal_buf
= new;
249 device
->char_data
.block_size
= count
;
251 DBF_LH(6, "new blocksize is %d\n", device
->char_data
.block_size
);
257 * MTRESET: Set block size to 0.
260 tape_std_mtreset(struct tape_device
*device
, int count
)
262 DBF_EVENT(6, "TCHAR:devreset:\n");
263 device
->char_data
.block_size
= 0;
268 * MTFSF: Forward space over 'count' file marks. The tape is positioned
269 * at the EOT (End of Tape) side of the file mark.
272 tape_std_mtfsf(struct tape_device
*device
, int mt_count
)
274 struct tape_request
*request
;
277 request
= tape_alloc_request(mt_count
+ 2, 0);
279 return PTR_ERR(request
);
280 request
->op
= TO_FSF
;
282 ccw
= tape_ccw_cc(request
->cpaddr
, MODE_SET_DB
, 1,
283 device
->modeset_byte
);
284 ccw
= tape_ccw_repeat(ccw
, FORSPACEFILE
, mt_count
);
285 ccw
= tape_ccw_end(ccw
, NOP
, 0, NULL
);
288 return tape_do_io_free(device
, request
);
292 * MTFSR: Forward space over 'count' tape blocks (blocksize is set
296 tape_std_mtfsr(struct tape_device
*device
, int mt_count
)
298 struct tape_request
*request
;
302 request
= tape_alloc_request(mt_count
+ 2, 0);
304 return PTR_ERR(request
);
305 request
->op
= TO_FSB
;
307 ccw
= tape_ccw_cc(request
->cpaddr
, MODE_SET_DB
, 1,
308 device
->modeset_byte
);
309 ccw
= tape_ccw_repeat(ccw
, FORSPACEBLOCK
, mt_count
);
310 ccw
= tape_ccw_end(ccw
, NOP
, 0, NULL
);
313 rc
= tape_do_io(device
, request
);
314 if (rc
== 0 && request
->rescnt
> 0) {
315 DBF_LH(3, "FSR over tapemark\n");
318 tape_free_request(request
);
324 * MTBSR: Backward space over 'count' tape blocks.
325 * (blocksize is set via MTSETBLK.
328 tape_std_mtbsr(struct tape_device
*device
, int mt_count
)
330 struct tape_request
*request
;
334 request
= tape_alloc_request(mt_count
+ 2, 0);
336 return PTR_ERR(request
);
337 request
->op
= TO_BSB
;
339 ccw
= tape_ccw_cc(request
->cpaddr
, MODE_SET_DB
, 1,
340 device
->modeset_byte
);
341 ccw
= tape_ccw_repeat(ccw
, BACKSPACEBLOCK
, mt_count
);
342 ccw
= tape_ccw_end(ccw
, NOP
, 0, NULL
);
345 rc
= tape_do_io(device
, request
);
346 if (rc
== 0 && request
->rescnt
> 0) {
347 DBF_LH(3, "BSR over tapemark\n");
350 tape_free_request(request
);
356 * MTWEOF: Write 'count' file marks at the current position.
359 tape_std_mtweof(struct tape_device
*device
, int mt_count
)
361 struct tape_request
*request
;
364 request
= tape_alloc_request(mt_count
+ 2, 0);
366 return PTR_ERR(request
);
367 request
->op
= TO_WTM
;
369 ccw
= tape_ccw_cc(request
->cpaddr
, MODE_SET_DB
, 1,
370 device
->modeset_byte
);
371 ccw
= tape_ccw_repeat(ccw
, WRITETAPEMARK
, mt_count
);
372 ccw
= tape_ccw_end(ccw
, NOP
, 0, NULL
);
375 return tape_do_io_free(device
, request
);
379 * MTBSFM: Backward space over 'count' file marks.
380 * The tape is positioned at the BOT (Begin Of Tape) side of the
381 * last skipped file mark.
384 tape_std_mtbsfm(struct tape_device
*device
, int mt_count
)
386 struct tape_request
*request
;
389 request
= tape_alloc_request(mt_count
+ 2, 0);
391 return PTR_ERR(request
);
392 request
->op
= TO_BSF
;
394 ccw
= tape_ccw_cc(request
->cpaddr
, MODE_SET_DB
, 1,
395 device
->modeset_byte
);
396 ccw
= tape_ccw_repeat(ccw
, BACKSPACEFILE
, mt_count
);
397 ccw
= tape_ccw_end(ccw
, NOP
, 0, NULL
);
400 return tape_do_io_free(device
, request
);
404 * MTBSF: Backward space over 'count' file marks. The tape is positioned at
405 * the EOT (End of Tape) side of the last skipped file mark.
408 tape_std_mtbsf(struct tape_device
*device
, int mt_count
)
410 struct tape_request
*request
;
414 request
= tape_alloc_request(mt_count
+ 2, 0);
416 return PTR_ERR(request
);
417 request
->op
= TO_BSF
;
419 ccw
= tape_ccw_cc(request
->cpaddr
, MODE_SET_DB
, 1,
420 device
->modeset_byte
);
421 ccw
= tape_ccw_repeat(ccw
, BACKSPACEFILE
, mt_count
);
422 ccw
= tape_ccw_end(ccw
, NOP
, 0, NULL
);
424 rc
= tape_do_io_free(device
, request
);
426 rc
= tape_mtop(device
, MTFSR
, 1);
434 * MTFSFM: Forward space over 'count' file marks.
435 * The tape is positioned at the BOT (Begin Of Tape) side
436 * of the last skipped file mark.
439 tape_std_mtfsfm(struct tape_device
*device
, int mt_count
)
441 struct tape_request
*request
;
445 request
= tape_alloc_request(mt_count
+ 2, 0);
447 return PTR_ERR(request
);
448 request
->op
= TO_FSF
;
450 ccw
= tape_ccw_cc(request
->cpaddr
, MODE_SET_DB
, 1,
451 device
->modeset_byte
);
452 ccw
= tape_ccw_repeat(ccw
, FORSPACEFILE
, mt_count
);
453 ccw
= tape_ccw_end(ccw
, NOP
, 0, NULL
);
455 rc
= tape_do_io_free(device
, request
);
457 rc
= tape_mtop(device
, MTBSR
, 1);
466 * MTREW: Rewind the tape.
469 tape_std_mtrew(struct tape_device
*device
, int mt_count
)
471 struct tape_request
*request
;
473 request
= tape_alloc_request(3, 0);
475 return PTR_ERR(request
);
476 request
->op
= TO_REW
;
478 tape_ccw_cc(request
->cpaddr
, MODE_SET_DB
, 1,
479 device
->modeset_byte
);
480 tape_ccw_cc(request
->cpaddr
+ 1, REWIND
, 0, NULL
);
481 tape_ccw_end(request
->cpaddr
+ 2, NOP
, 0, NULL
);
484 return tape_do_io_free(device
, request
);
488 * MTOFFL: Rewind the tape and put the drive off-line.
489 * Implement 'rewind unload'
492 tape_std_mtoffl(struct tape_device
*device
, int mt_count
)
494 struct tape_request
*request
;
496 request
= tape_alloc_request(3, 0);
498 return PTR_ERR(request
);
499 request
->op
= TO_RUN
;
501 tape_ccw_cc(request
->cpaddr
, MODE_SET_DB
, 1, device
->modeset_byte
);
502 tape_ccw_cc(request
->cpaddr
+ 1, REWIND_UNLOAD
, 0, NULL
);
503 tape_ccw_end(request
->cpaddr
+ 2, NOP
, 0, NULL
);
506 return tape_do_io_free(device
, request
);
510 * MTNOP: 'No operation'.
513 tape_std_mtnop(struct tape_device
*device
, int mt_count
)
515 struct tape_request
*request
;
517 request
= tape_alloc_request(2, 0);
519 return PTR_ERR(request
);
520 request
->op
= TO_NOP
;
522 tape_ccw_cc(request
->cpaddr
, MODE_SET_DB
, 1, device
->modeset_byte
);
523 tape_ccw_end(request
->cpaddr
+ 1, NOP
, 0, NULL
);
525 return tape_do_io_free(device
, request
);
529 * MTEOM: positions at the end of the portion of the tape already used
530 * for recordind data. MTEOM positions after the last file mark, ready for
531 * appending another file.
534 tape_std_mteom(struct tape_device
*device
, int mt_count
)
539 * Seek from the beginning of tape (rewind).
541 if ((rc
= tape_mtop(device
, MTREW
, 1)) < 0)
545 * The logical end of volume is given by two sewuential tapemarks.
546 * Look for this by skipping to the next file (over one tapemark)
547 * and then test for another one (fsr returns 1 if a tapemark was
551 if ((rc
= tape_mtop(device
, MTFSF
, 1)) < 0)
553 if ((rc
= tape_mtop(device
, MTFSR
, 1)) < 0)
557 return tape_mtop(device
, MTBSR
, 1);
561 * MTRETEN: Retension the tape, i.e. forward space to end of tape and rewind.
564 tape_std_mtreten(struct tape_device
*device
, int mt_count
)
566 struct tape_request
*request
;
569 request
= tape_alloc_request(4, 0);
571 return PTR_ERR(request
);
572 request
->op
= TO_FSF
;
574 tape_ccw_cc(request
->cpaddr
, MODE_SET_DB
, 1, device
->modeset_byte
);
575 tape_ccw_cc(request
->cpaddr
+ 1,FORSPACEFILE
, 0, NULL
);
576 tape_ccw_cc(request
->cpaddr
+ 2, NOP
, 0, NULL
);
577 tape_ccw_end(request
->cpaddr
+ 3, CCW_CMD_TIC
, 0, request
->cpaddr
);
578 /* execute it, MTRETEN rc gets ignored */
579 rc
= tape_do_io_interruptible(device
, request
);
580 tape_free_request(request
);
581 return tape_mtop(device
, MTREW
, 1);
585 * MTERASE: erases the tape.
588 tape_std_mterase(struct tape_device
*device
, int mt_count
)
590 struct tape_request
*request
;
592 request
= tape_alloc_request(6, 0);
594 return PTR_ERR(request
);
595 request
->op
= TO_DSE
;
597 tape_ccw_cc(request
->cpaddr
, MODE_SET_DB
, 1, device
->modeset_byte
);
598 tape_ccw_cc(request
->cpaddr
+ 1, REWIND
, 0, NULL
);
599 tape_ccw_cc(request
->cpaddr
+ 2, ERASE_GAP
, 0, NULL
);
600 tape_ccw_cc(request
->cpaddr
+ 3, DATA_SEC_ERASE
, 0, NULL
);
601 tape_ccw_cc(request
->cpaddr
+ 4, REWIND
, 0, NULL
);
602 tape_ccw_end(request
->cpaddr
+ 5, NOP
, 0, NULL
);
605 return tape_do_io_free(device
, request
);
609 * MTUNLOAD: Rewind the tape and unload it.
612 tape_std_mtunload(struct tape_device
*device
, int mt_count
)
614 return tape_mtop(device
, MTOFFL
, mt_count
);
618 * MTCOMPRESSION: used to enable compression.
619 * Sets the IDRC on/off.
622 tape_std_mtcompression(struct tape_device
*device
, int mt_count
)
624 struct tape_request
*request
;
626 if (mt_count
< 0 || mt_count
> 1) {
627 DBF_EXCEPTION(6, "xcom parm\n");
630 request
= tape_alloc_request(2, 0);
632 return PTR_ERR(request
);
633 request
->op
= TO_NOP
;
636 *device
->modeset_byte
&= ~0x08;
638 *device
->modeset_byte
|= 0x08;
639 tape_ccw_cc(request
->cpaddr
, MODE_SET_DB
, 1, device
->modeset_byte
);
640 tape_ccw_end(request
->cpaddr
+ 1, NOP
, 0, NULL
);
642 return tape_do_io_free(device
, request
);
648 struct tape_request
*
649 tape_std_read_block(struct tape_device
*device
, size_t count
)
651 struct tape_request
*request
;
654 * We have to alloc 4 ccws in order to be able to transform request
655 * into a read backward request in error case.
657 request
= tape_alloc_request(4, 0);
658 if (IS_ERR(request
)) {
659 DBF_EXCEPTION(6, "xrbl fail");
662 request
->op
= TO_RFO
;
663 tape_ccw_cc(request
->cpaddr
, MODE_SET_DB
, 1, device
->modeset_byte
);
664 tape_ccw_end_idal(request
->cpaddr
+ 1, READ_FORWARD
,
665 device
->char_data
.idal_buf
);
666 DBF_EVENT(6, "xrbl ccwg\n");
671 * Read Block backward transformation function.
674 tape_std_read_backward(struct tape_device
*device
, struct tape_request
*request
)
677 * We have allocated 4 ccws in tape_std_read, so we can now
678 * transform the request to a read backward, followed by a
679 * forward space block.
681 request
->op
= TO_RBA
;
682 tape_ccw_cc(request
->cpaddr
, MODE_SET_DB
, 1, device
->modeset_byte
);
683 tape_ccw_cc_idal(request
->cpaddr
+ 1, READ_BACKWARD
,
684 device
->char_data
.idal_buf
);
685 tape_ccw_cc(request
->cpaddr
+ 2, FORSPACEBLOCK
, 0, NULL
);
686 tape_ccw_end(request
->cpaddr
+ 3, NOP
, 0, NULL
);
687 DBF_EVENT(6, "xrop ccwg");}
692 struct tape_request
*
693 tape_std_write_block(struct tape_device
*device
, size_t count
)
695 struct tape_request
*request
;
697 request
= tape_alloc_request(2, 0);
698 if (IS_ERR(request
)) {
699 DBF_EXCEPTION(6, "xwbl fail\n");
702 request
->op
= TO_WRI
;
703 tape_ccw_cc(request
->cpaddr
, MODE_SET_DB
, 1, device
->modeset_byte
);
704 tape_ccw_end_idal(request
->cpaddr
+ 1, WRITE_CMD
,
705 device
->char_data
.idal_buf
);
706 DBF_EVENT(6, "xwbl ccwg\n");
711 * This routine is called by frontend after an ENOSP on write
714 tape_std_process_eov(struct tape_device
*device
)
717 * End of volume: We have to backspace the last written record, then
718 * we TRY to write a tapemark and then backspace over the written TM
720 if (tape_mtop(device
, MTBSR
, 1) == 0 &&
721 tape_mtop(device
, MTWEOF
, 1) == 0) {
722 tape_mtop(device
, MTBSR
, 1);
726 EXPORT_SYMBOL(tape_std_assign
);
727 EXPORT_SYMBOL(tape_std_unassign
);
728 EXPORT_SYMBOL(tape_std_display
);
729 EXPORT_SYMBOL(tape_std_read_block_id
);
730 EXPORT_SYMBOL(tape_std_mtload
);
731 EXPORT_SYMBOL(tape_std_mtsetblk
);
732 EXPORT_SYMBOL(tape_std_mtreset
);
733 EXPORT_SYMBOL(tape_std_mtfsf
);
734 EXPORT_SYMBOL(tape_std_mtfsr
);
735 EXPORT_SYMBOL(tape_std_mtbsr
);
736 EXPORT_SYMBOL(tape_std_mtweof
);
737 EXPORT_SYMBOL(tape_std_mtbsfm
);
738 EXPORT_SYMBOL(tape_std_mtbsf
);
739 EXPORT_SYMBOL(tape_std_mtfsfm
);
740 EXPORT_SYMBOL(tape_std_mtrew
);
741 EXPORT_SYMBOL(tape_std_mtoffl
);
742 EXPORT_SYMBOL(tape_std_mtnop
);
743 EXPORT_SYMBOL(tape_std_mteom
);
744 EXPORT_SYMBOL(tape_std_mtreten
);
745 EXPORT_SYMBOL(tape_std_mterase
);
746 EXPORT_SYMBOL(tape_std_mtunload
);
747 EXPORT_SYMBOL(tape_std_mtcompression
);
748 EXPORT_SYMBOL(tape_std_read_block
);
749 EXPORT_SYMBOL(tape_std_read_backward
);
750 EXPORT_SYMBOL(tape_std_write_block
);
751 EXPORT_SYMBOL(tape_std_process_eov
);