xref: /kvm-unit-tests/lib/s390x/sclp.h (revision e36a9c28fc8f8f59e0e30db244af0b17c6d04be9)
1 /*
2  * SCLP definitions
3  *
4  * Based on the file pc-bios/s390-ccw/sclp.h from QEMU
5  * Copyright (c) 2013 Alexander Graf <agraf@suse.de>
6  *
7  * and based on the file include/hw/s390x/sclp.h from QEMU
8  * Copyright IBM, Corp. 2012
9  * Author: Christian Borntraeger <borntraeger@de.ibm.com>
10  *
11  * This work is licensed under the terms of the GNU GPL, version 2 or (at
12  * your option) any later version. See the COPYING file in the top-level
13  * directory.
14  */
15 
16 #ifndef SCLP_H
17 #define SCLP_H
18 
19 #define SCLP_CMD_CODE_MASK                      0xffff00ff
20 
21 /* SCLP command codes */
22 #define SCLP_READ_CPU_INFO			0x00010001
23 #define SCLP_CMDW_READ_SCP_INFO                 0x00020001
24 #define SCLP_CMDW_READ_SCP_INFO_FORCED          0x00120001
25 #define SCLP_READ_STORAGE_ELEMENT_INFO          0x00040001
26 #define SCLP_ATTACH_STORAGE_ELEMENT             0x00080001
27 #define SCLP_ASSIGN_STORAGE                     0x000D0001
28 #define SCLP_CMD_READ_EVENT_DATA                0x00770005
29 #define SCLP_CMD_WRITE_EVENT_DATA               0x00760005
30 #define SCLP_CMD_READ_EVENT_DATA                0x00770005
31 #define SCLP_CMD_WRITE_EVENT_DATA               0x00760005
32 #define SCLP_CMD_WRITE_EVENT_MASK               0x00780005
33 
34 /* SCLP Memory hotplug codes */
35 #define SCLP_FC_ASSIGN_ATTACH_READ_STOR         0xE00000000000ULL
36 #define SCLP_STARTING_SUBINCREMENT_ID           0x10001
37 #define SCLP_INCREMENT_UNIT                     0x10000
38 #define MAX_AVAIL_SLOTS                         32
39 #define MAX_STORAGE_INCREMENTS                  1020
40 
41 /* CPU hotplug SCLP codes */
42 #define SCLP_HAS_CPU_INFO                       0x0C00000000000000ULL
43 #define SCLP_CMDW_READ_CPU_INFO                 0x00010001
44 #define SCLP_CMDW_CONFIGURE_CPU                 0x00110001
45 #define SCLP_CMDW_DECONFIGURE_CPU               0x00100001
46 
47 /* SCLP PCI codes */
48 #define SCLP_HAS_IOA_RECONFIG                   0x0000000040000000ULL
49 #define SCLP_CMDW_CONFIGURE_IOA                 0x001a0001
50 #define SCLP_CMDW_DECONFIGURE_IOA               0x001b0001
51 #define SCLP_RECONFIG_PCI_ATYPE                 2
52 
53 /* SCLP response codes */
54 #define SCLP_RC_NORMAL_READ_COMPLETION          0x0010
55 #define SCLP_RC_NORMAL_COMPLETION               0x0020
56 #define SCLP_RC_SCCB_BOUNDARY_VIOLATION         0x0100
57 #define SCLP_RC_NO_ACTION_REQUIRED              0x0120
58 #define SCLP_RC_INVALID_SCLP_COMMAND            0x01f0
59 #define SCLP_RC_CONTAINED_EQUIPMENT_CHECK       0x0340
60 #define SCLP_RC_INSUFFICIENT_SCCB_LENGTH        0x0300
61 #define SCLP_RC_STANDBY_READ_COMPLETION         0x0410
62 #define SCLP_RC_ADAPTER_IN_RESERVED_STATE       0x05f0
63 #define SCLP_RC_ADAPTER_TYPE_NOT_RECOGNIZED     0x06f0
64 #define SCLP_RC_ADAPTER_ID_NOT_RECOGNIZED       0x09f0
65 #define SCLP_RC_INVALID_FUNCTION                0x40f0
66 #define SCLP_RC_NO_EVENT_BUFFERS_STORED         0x60f0
67 #define SCLP_RC_INVALID_SELECTION_MASK          0x70f0
68 #define SCLP_RC_INCONSISTENT_LENGTHS            0x72f0
69 #define SCLP_RC_EVENT_BUFFER_SYNTAX_ERROR       0x73f0
70 #define SCLP_RC_INVALID_MASK_LENGTH             0x74f0
71 
72 /* SCLP control mask bits */
73 #define SCLP_CM2_VARIABLE_LENGTH_RESPONSE       0x80
74 
75 /* SCLP function codes */
76 #define SCLP_FC_NORMAL_WRITE                    0
77 #define SCLP_FC_SINGLE_INCREMENT_ASSIGN         0x40
78 #define SCLP_FC_DUMP_INDICATOR                  0x80
79 
80 /* SCLP event buffer flags */
81 #define SCLP_EVENT_BUFFER_ACCEPTED              0x80
82 
83 /* Service Call Control Block (SCCB) and its elements */
84 #define SCCB_SIZE 4096
85 
86 typedef struct SCCBHeader {
87     uint16_t length;
88     uint8_t function_code;
89     uint8_t control_mask[3];
90     uint16_t response_code;
91 } __attribute__((packed)) SCCBHeader;
92 
93 #define SCCB_DATA_LEN (SCCB_SIZE - sizeof(SCCBHeader))
94 #define SCCB_CPU_FEATURE_LEN 6
95 
96 /* CPU information */
97 typedef struct CPUEntry {
98     uint8_t address;
99     uint8_t reserved0;
100     uint8_t features[SCCB_CPU_FEATURE_LEN];
101     uint8_t reserved2[6];
102     uint8_t type;
103     uint8_t reserved1;
104 } __attribute__((packed)) CPUEntry;
105 
106 typedef struct ReadInfo {
107     SCCBHeader h;
108     uint16_t rnmax;
109     uint8_t rnsize;
110     uint8_t  _reserved1[16 - 11];       /* 11-15 */
111     uint16_t entries_cpu;               /* 16-17 */
112     uint16_t offset_cpu;                /* 18-19 */
113     uint8_t  _reserved2[24 - 20];       /* 20-23 */
114     uint8_t  loadparm[8];               /* 24-31 */
115     uint8_t  _reserved3[48 - 32];       /* 32-47 */
116     uint64_t facilities;                /* 48-55 */
117     uint8_t  _reserved0[76 - 56];       /* 56-75 */
118     uint32_t ibc_val;
119     uint8_t  conf_char[99 - 80];        /* 80-98 */
120     uint8_t mha_pow;
121     uint32_t rnsize2;
122     uint64_t rnmax2;
123     uint8_t  _reserved6[116 - 112];     /* 112-115 */
124     uint8_t  conf_char_ext[120 - 116];   /* 116-119 */
125     uint16_t highest_cpu;
126     uint8_t  _reserved5[124 - 122];     /* 122-123 */
127     uint32_t hmfai;
128     struct CPUEntry entries[0];
129 } __attribute__((packed)) ReadInfo;
130 
131 typedef struct ReadCpuInfo {
132     SCCBHeader h;
133     uint16_t nr_configured;         /* 8-9 */
134     uint16_t offset_configured;     /* 10-11 */
135     uint16_t nr_standby;            /* 12-13 */
136     uint16_t offset_standby;        /* 14-15 */
137     uint8_t reserved0[24-16];       /* 16-23 */
138     struct CPUEntry entries[0];
139 } __attribute__((packed)) ReadCpuInfo;
140 
141 typedef struct ReadStorageElementInfo {
142     SCCBHeader h;
143     uint16_t max_id;
144     uint16_t assigned;
145     uint16_t standby;
146     uint8_t _reserved0[16 - 14]; /* 14-15 */
147     uint32_t entries[0];
148 } __attribute__((packed)) ReadStorageElementInfo;
149 
150 typedef struct AttachStorageElement {
151     SCCBHeader h;
152     uint8_t _reserved0[10 - 8];  /* 8-9 */
153     uint16_t assigned;
154     uint8_t _reserved1[16 - 12]; /* 12-15 */
155     uint32_t entries[0];
156 } __attribute__((packed)) AttachStorageElement;
157 
158 typedef struct AssignStorage {
159     SCCBHeader h;
160     uint16_t rn;
161 } __attribute__((packed)) AssignStorage;
162 
163 typedef struct IoaCfgSccb {
164     SCCBHeader header;
165     uint8_t atype;
166     uint8_t reserved1;
167     uint16_t reserved2;
168     uint32_t aid;
169 } __attribute__((packed)) IoaCfgSccb;
170 
171 typedef struct SCCB {
172     SCCBHeader h;
173     char data[SCCB_DATA_LEN];
174  } __attribute__((packed)) SCCB;
175 
176 /* SCLP event types */
177 #define SCLP_EVENT_ASCII_CONSOLE_DATA           0x1a
178 #define SCLP_EVENT_SIGNAL_QUIESCE               0x1d
179 
180 /* SCLP event masks */
181 #define SCLP_EVENT_MASK_SIGNAL_QUIESCE          0x00000008
182 #define SCLP_EVENT_MASK_MSG_ASCII               0x00000040
183 #define SCLP_EVENT_MASK_MSG          		0x40000000
184 
185 #define SCLP_UNCONDITIONAL_READ                 0x00
186 #define SCLP_SELECTIVE_READ                     0x01
187 
188 typedef struct WriteEventMask {
189     SCCBHeader h;
190     uint16_t _reserved;
191     uint16_t mask_length;
192     uint32_t cp_receive_mask;
193     uint32_t cp_send_mask;
194     uint32_t send_mask;
195     uint32_t receive_mask;
196 } __attribute__((packed)) WriteEventMask;
197 
198 #define MDBTYP_GO               0x0001
199 #define MDBTYP_MTO              0x0004
200 #define EVTYP_MSG               0x02
201 #define LNTPFLGS_CNTLTEXT       0x8000
202 #define LNTPFLGS_LABELTEXT      0x4000
203 #define LNTPFLGS_DATATEXT       0x2000
204 #define LNTPFLGS_ENDTEXT        0x1000
205 #define LNTPFLGS_PROMPTTEXT     0x0800
206 
207 typedef uint32_t sccb_mask_t;
208 
209 /* SCLP line mode console related structures. */
210 
211 struct mto {
212 	u16 length;
213 	u16 type;
214 	u16 line_type_flags;
215 	u8  alarm_control;
216 	u8  _reserved[3];
217 } __attribute__((packed));
218 
219 struct go {
220 	u16 length;
221 	u16 type;
222 	u32 domid;
223 	u8  hhmmss_time[8];
224 	u8  th_time[3];
225 	u8  reserved_0;
226 	u8  dddyyyy_date[7];
227 	u8  _reserved_1;
228 	u16 general_msg_flags;
229 	u8  _reserved_2[10];
230 	u8  originating_system_name[8];
231 	u8  job_guest_name[8];
232 } __attribute__((packed));
233 
234 struct mdb_header {
235 	u16 length;
236 	u16 type;
237 	u32 tag;
238 	u32 revision_code;
239 } __attribute__((packed));
240 
241 struct mdb {
242 	struct mdb_header header;
243 	struct go go;
244 	struct mto mto;
245 } __attribute__((packed));
246 
247 typedef struct EventBufferHeader {
248     uint16_t length;
249     uint8_t  type;
250     uint8_t  flags;
251     uint16_t _reserved;
252 } __attribute__((packed)) EventBufferHeader;
253 
254 typedef struct WriteEventData {
255     SCCBHeader h;
256     EventBufferHeader ebh;
257     union {
258 	char data[0];
259 	struct mdb mdb;
260     } msg;
261 } __attribute__((packed)) WriteEventData;
262 
263 typedef struct ReadEventData {
264     SCCBHeader h;
265     EventBufferHeader ebh;
266     uint32_t mask;
267 } __attribute__((packed)) ReadEventData;
268 
269 extern char _sccb[];
270 void sclp_handle_ext(void);
271 void sclp_wait_busy(void);
272 void sclp_mark_busy(void);
273 void sclp_console_setup(void);
274 void sclp_print(const char *str);
275 int sclp_service_call(unsigned int command, void *sccb);
276 void sclp_memory_setup(void);
277 
278 #endif /* SCLP_H */
279