xref: /linux/drivers/s390/char/vmur.h (revision ead751507de86d90fa250431e9990a8b881f713c)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * Linux driver for System z and s390 unit record devices
4  * (z/VM virtual punch, reader, printer)
5  *
6  * Copyright IBM Corp. 2001, 2007
7  * Authors: Malcolm Beattie <beattiem@uk.ibm.com>
8  *	    Michael Holzheu <holzheu@de.ibm.com>
9  *	    Frank Munzert <munzert@de.ibm.com>
10  */
11 
12 #ifndef _VMUR_H_
13 #define _VMUR_H_
14 
15 #define DEV_CLASS_UR_I 0x20 /* diag210 unit record input device class */
16 #define DEV_CLASS_UR_O 0x10 /* diag210 unit record output device class */
17 /*
18  * we only support z/VM's default unit record devices:
19  * both in SPOOL directory control statement and in CP DEFINE statement
20  *	RDR defaults to 2540 reader
21  *	PUN defaults to 2540 punch
22  *	PRT defaults to 1403 printer
23  */
24 #define READER_PUNCH_DEVTYPE	0x2540
25 #define PRINTER_DEVTYPE		0x1403
26 
27 /* z/VM spool file control block SFBLOK */
28 struct file_control_block {
29 	char reserved_1[8];
30 	char user_owner[8];
31 	char user_orig[8];
32 	__s32 data_recs;
33 	__s16 rec_len;
34 	__s16 file_num;
35 	__u8  file_stat;
36 	__u8  dev_type;
37 	char  reserved_2[6];
38 	char  file_name[12];
39 	char  file_type[12];
40 	char  create_date[8];
41 	char  create_time[8];
42 	char  reserved_3[6];
43 	__u8  file_class;
44 	__u8  sfb_lok;
45 	__u64 distr_code;
46 	__u32 reserved_4;
47 	__u8  current_starting_copy_number;
48 	__u8  sfblock_cntrl_flags;
49 	__u8  reserved_5;
50 	__u8  more_status_flags;
51 	char  rest[200];
52 } __attribute__ ((packed));
53 
54 #define FLG_SYSTEM_HOLD	0x04
55 #define FLG_CP_DUMP	0x10
56 #define FLG_USER_HOLD	0x20
57 #define FLG_IN_USE	0x80
58 
59 /*
60  * A struct urdev is created for each ur device that is made available
61  * via the ccw_device driver model.
62  */
63 struct urdev {
64 	struct ccw_device *cdev;	/* Backpointer to ccw device */
65 	struct mutex io_mutex;		/* Serialises device IO */
66 	struct completion *io_done;	/* do_ur_io waits; irq completes */
67 	struct device *device;
68 	struct cdev *char_device;
69 	struct ccw_dev_id dev_id;	/* device id */
70 	size_t reclen;			/* Record length for *write* CCWs */
71 	int class;			/* VM device class */
72 	int io_request_rc;		/* return code from I/O request */
73 	atomic_t ref_count;		/* reference counter */
74 	wait_queue_head_t wait;		/* wait queue to serialize open */
75 	int open_flag;			/* "urdev is open" flag */
76 	spinlock_t open_lock;		/* serialize critical sections */
77 };
78 
79 /*
80  * A struct urfile is allocated at open() time for each device and
81  * freed on release().
82  */
83 struct urfile {
84 	struct urdev *urd;
85 	unsigned int flags;
86 	size_t dev_reclen;
87 	__u16 file_reclen;
88 };
89 
90 /*
91  * Device major/minor definitions.
92  */
93 
94 #define UR_MAJOR 0	/* get dynamic major */
95 /*
96  * We map minor numbers directly to device numbers (0-FFFF) for simplicity.
97  * This avoids having to allocate (and manage) slot numbers.
98  */
99 #define NUM_MINORS 65536
100 
101 /* Limiting each I/O to 511 records limits chan prog to 4KB (511 r/w + 1 NOP) */
102 #define MAX_RECS_PER_IO		511
103 #define WRITE_CCW_CMD		0x01
104 
105 #define TRACE(x...) debug_sprintf_event(vmur_dbf, 1, x)
106 #define CCWDEV_CU_DI(cutype, di) \
107 		CCW_DEVICE(cutype, 0x00), .driver_info = (di)
108 
109 #define FILE_RECLEN_OFFSET	4064 /* reclen offset in spool data block */
110 
111 #endif /* _VMUR_H_ */
112