xref: /OK3568_Linux_fs/kernel/drivers/s390/char/tape_std.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  *    standard tape device functions for ibm tapes.
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  *    Copyright IBM Corp. 2001, 2006
6*4882a593Smuzhiyun  *    Author(s): Carsten Otte <cotte@de.ibm.com>
7*4882a593Smuzhiyun  *		 Tuan Ngo-Anh <ngoanh@de.ibm.com>
8*4882a593Smuzhiyun  *		 Martin Schwidefsky <schwidefsky@de.ibm.com>
9*4882a593Smuzhiyun  */
10*4882a593Smuzhiyun 
11*4882a593Smuzhiyun #ifndef _TAPE_STD_H
12*4882a593Smuzhiyun #define _TAPE_STD_H
13*4882a593Smuzhiyun 
14*4882a593Smuzhiyun #include <asm/tape390.h>
15*4882a593Smuzhiyun 
16*4882a593Smuzhiyun /*
17*4882a593Smuzhiyun  * Biggest block size to handle. Currently 64K because we only build
18*4882a593Smuzhiyun  * channel programs without data chaining.
19*4882a593Smuzhiyun  */
20*4882a593Smuzhiyun #define MAX_BLOCKSIZE   65535
21*4882a593Smuzhiyun 
22*4882a593Smuzhiyun /*
23*4882a593Smuzhiyun  * The CCW commands for the Tape type of command.
24*4882a593Smuzhiyun  */
25*4882a593Smuzhiyun #define INVALID_00		0x00	/* Invalid cmd */
26*4882a593Smuzhiyun #define BACKSPACEBLOCK		0x27	/* Back Space block */
27*4882a593Smuzhiyun #define BACKSPACEFILE		0x2f	/* Back Space file */
28*4882a593Smuzhiyun #define DATA_SEC_ERASE		0x97	/* Data security erase */
29*4882a593Smuzhiyun #define ERASE_GAP		0x17	/* Erase Gap */
30*4882a593Smuzhiyun #define FORSPACEBLOCK		0x37	/* Forward space block */
31*4882a593Smuzhiyun #define FORSPACEFILE		0x3F	/* Forward Space file */
32*4882a593Smuzhiyun #define FORCE_STREAM_CNT	0xEB	/* Forced streaming count # */
33*4882a593Smuzhiyun #define NOP			0x03	/* No operation	*/
34*4882a593Smuzhiyun #define READ_FORWARD		0x02	/* Read forward */
35*4882a593Smuzhiyun #define REWIND			0x07	/* Rewind */
36*4882a593Smuzhiyun #define REWIND_UNLOAD		0x0F	/* Rewind and Unload */
37*4882a593Smuzhiyun #define SENSE			0x04	/* Sense */
38*4882a593Smuzhiyun #define NEW_MODE_SET		0xEB	/* Guess it is Mode set */
39*4882a593Smuzhiyun #define WRITE_CMD		0x01	/* Write */
40*4882a593Smuzhiyun #define WRITETAPEMARK		0x1F	/* Write Tape Mark */
41*4882a593Smuzhiyun 
42*4882a593Smuzhiyun #define ASSIGN			0xB7	/* 3420 REJECT,3480 OK	*/
43*4882a593Smuzhiyun #define CONTROL_ACCESS		0xE3	/* Set high speed */
44*4882a593Smuzhiyun #define DIAG_MODE_SET		0x0B	/* 3420 NOP, 3480 REJECT */
45*4882a593Smuzhiyun #define LOAD_DISPLAY		0x9F	/* 3420 REJECT,3480 OK */
46*4882a593Smuzhiyun #define LOCATE			0x4F	/* 3420 REJ, 3480 NOP */
47*4882a593Smuzhiyun #define LOOP_WRITE_TO_READ	0x8B	/* 3480 REJECT */
48*4882a593Smuzhiyun #define MODE_SET_DB		0xDB	/* 3420 REJECT,3480 OK */
49*4882a593Smuzhiyun #define MODE_SET_C3		0xC3	/* for 3420 */
50*4882a593Smuzhiyun #define MODE_SET_CB		0xCB	/* for 3420 */
51*4882a593Smuzhiyun #define MODE_SET_D3		0xD3	/* for 3420 */
52*4882a593Smuzhiyun #define READ_BACKWARD		0x0C	/* */
53*4882a593Smuzhiyun #define READ_BLOCK_ID		0x22	/* 3420 REJECT,3480 OK */
54*4882a593Smuzhiyun #define READ_BUFFER		0x12	/* 3420 REJECT,3480 OK */
55*4882a593Smuzhiyun #define READ_BUFF_LOG		0x24	/* 3420 REJECT,3480 OK */
56*4882a593Smuzhiyun #define RELEASE			0xD4	/* 3420 NOP, 3480 REJECT */
57*4882a593Smuzhiyun #define REQ_TRK_IN_ERROR	0x1B	/* 3420 NOP, 3480 REJECT */
58*4882a593Smuzhiyun #define RESERVE			0xF4	/* 3420 NOP, 3480 REJECT */
59*4882a593Smuzhiyun #define SENSE_GROUP_ID		0x34	/* 3420 REJECT,3480 OK */
60*4882a593Smuzhiyun #define SENSE_ID		0xE4	/* 3420 REJECT,3480 OK */
61*4882a593Smuzhiyun #define READ_DEV_CHAR		0x64	/* Read device characteristics */
62*4882a593Smuzhiyun #define SET_DIAGNOSE		0x4B	/* 3420 NOP, 3480 REJECT */
63*4882a593Smuzhiyun #define SET_GROUP_ID		0xAF	/* 3420 REJECT,3480 OK */
64*4882a593Smuzhiyun #define SET_TAPE_WRITE_IMMED	0xC3	/* for 3480 */
65*4882a593Smuzhiyun #define SUSPEND			0x5B	/* 3420 REJ, 3480 NOP */
66*4882a593Smuzhiyun #define SYNC			0x43	/* Synchronize (flush buffer) */
67*4882a593Smuzhiyun #define UNASSIGN		0xC7	/* 3420 REJECT,3480 OK */
68*4882a593Smuzhiyun #define PERF_SUBSYS_FUNC	0x77	/* 3490 CMD */
69*4882a593Smuzhiyun #define READ_CONFIG_DATA	0xFA	/* 3490 CMD */
70*4882a593Smuzhiyun #define READ_MESSAGE_ID		0x4E	/* 3490 CMD */
71*4882a593Smuzhiyun #define READ_SUBSYS_DATA	0x3E	/* 3490 CMD */
72*4882a593Smuzhiyun #define SET_INTERFACE_ID	0x73	/* 3490 CMD */
73*4882a593Smuzhiyun 
74*4882a593Smuzhiyun #define SENSE_COMMAND_REJECT		0x80
75*4882a593Smuzhiyun #define SENSE_INTERVENTION_REQUIRED	0x40
76*4882a593Smuzhiyun #define SENSE_BUS_OUT_CHECK		0x20
77*4882a593Smuzhiyun #define SENSE_EQUIPMENT_CHECK		0x10
78*4882a593Smuzhiyun #define SENSE_DATA_CHECK		0x08
79*4882a593Smuzhiyun #define SENSE_OVERRUN			0x04
80*4882a593Smuzhiyun #define SENSE_DEFERRED_UNIT_CHECK	0x02
81*4882a593Smuzhiyun #define SENSE_ASSIGNED_ELSEWHERE	0x01
82*4882a593Smuzhiyun 
83*4882a593Smuzhiyun #define SENSE_LOCATE_FAILURE		0x80
84*4882a593Smuzhiyun #define SENSE_DRIVE_ONLINE		0x40
85*4882a593Smuzhiyun #define SENSE_RESERVED			0x20
86*4882a593Smuzhiyun #define SENSE_RECORD_SEQUENCE_ERR	0x10
87*4882a593Smuzhiyun #define SENSE_BEGINNING_OF_TAPE		0x08
88*4882a593Smuzhiyun #define SENSE_WRITE_MODE		0x04
89*4882a593Smuzhiyun #define SENSE_WRITE_PROTECT		0x02
90*4882a593Smuzhiyun #define SENSE_NOT_CAPABLE		0x01
91*4882a593Smuzhiyun 
92*4882a593Smuzhiyun #define SENSE_CHANNEL_ADAPTER_CODE	0xE0
93*4882a593Smuzhiyun #define SENSE_CHANNEL_ADAPTER_LOC	0x10
94*4882a593Smuzhiyun #define SENSE_REPORTING_CU		0x08
95*4882a593Smuzhiyun #define SENSE_AUTOMATIC_LOADER		0x04
96*4882a593Smuzhiyun #define SENSE_TAPE_SYNC_MODE		0x02
97*4882a593Smuzhiyun #define SENSE_TAPE_POSITIONING		0x01
98*4882a593Smuzhiyun 
99*4882a593Smuzhiyun /* discipline functions */
100*4882a593Smuzhiyun struct tape_request *tape_std_read_block(struct tape_device *, size_t);
101*4882a593Smuzhiyun void tape_std_read_backward(struct tape_device *device,
102*4882a593Smuzhiyun 			    struct tape_request *request);
103*4882a593Smuzhiyun struct tape_request *tape_std_write_block(struct tape_device *, size_t);
104*4882a593Smuzhiyun 
105*4882a593Smuzhiyun /* Some non-mtop commands. */
106*4882a593Smuzhiyun int tape_std_assign(struct tape_device *);
107*4882a593Smuzhiyun int tape_std_unassign(struct tape_device *);
108*4882a593Smuzhiyun int tape_std_read_block_id(struct tape_device *device, __u64 *id);
109*4882a593Smuzhiyun int tape_std_display(struct tape_device *, struct display_struct *disp);
110*4882a593Smuzhiyun int tape_std_terminate_write(struct tape_device *);
111*4882a593Smuzhiyun 
112*4882a593Smuzhiyun /* Standard magnetic tape commands. */
113*4882a593Smuzhiyun int tape_std_mtbsf(struct tape_device *, int);
114*4882a593Smuzhiyun int tape_std_mtbsfm(struct tape_device *, int);
115*4882a593Smuzhiyun int tape_std_mtbsr(struct tape_device *, int);
116*4882a593Smuzhiyun int tape_std_mtcompression(struct tape_device *, int);
117*4882a593Smuzhiyun int tape_std_mteom(struct tape_device *, int);
118*4882a593Smuzhiyun int tape_std_mterase(struct tape_device *, int);
119*4882a593Smuzhiyun int tape_std_mtfsf(struct tape_device *, int);
120*4882a593Smuzhiyun int tape_std_mtfsfm(struct tape_device *, int);
121*4882a593Smuzhiyun int tape_std_mtfsr(struct tape_device *, int);
122*4882a593Smuzhiyun int tape_std_mtload(struct tape_device *, int);
123*4882a593Smuzhiyun int tape_std_mtnop(struct tape_device *, int);
124*4882a593Smuzhiyun int tape_std_mtoffl(struct tape_device *, int);
125*4882a593Smuzhiyun int tape_std_mtreset(struct tape_device *, int);
126*4882a593Smuzhiyun int tape_std_mtreten(struct tape_device *, int);
127*4882a593Smuzhiyun int tape_std_mtrew(struct tape_device *, int);
128*4882a593Smuzhiyun int tape_std_mtsetblk(struct tape_device *, int);
129*4882a593Smuzhiyun int tape_std_mtunload(struct tape_device *, int);
130*4882a593Smuzhiyun int tape_std_mtweof(struct tape_device *, int);
131*4882a593Smuzhiyun 
132*4882a593Smuzhiyun /* Event handlers */
133*4882a593Smuzhiyun void tape_std_process_eov(struct tape_device *);
134*4882a593Smuzhiyun 
135*4882a593Smuzhiyun /* S390 tape types */
136*4882a593Smuzhiyun enum s390_tape_type {
137*4882a593Smuzhiyun         tape_3480,
138*4882a593Smuzhiyun         tape_3490,
139*4882a593Smuzhiyun         tape_3590,
140*4882a593Smuzhiyun         tape_3592,
141*4882a593Smuzhiyun };
142*4882a593Smuzhiyun 
143*4882a593Smuzhiyun #endif // _TAPE_STD_H
144