xref: /kvm-unit-tests/lib/s390x/sclp.h (revision bfed1760b7c05d810a4a049dfdc4360621f84847)
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_CMDW_READ_SCP_INFO                 0x00020001
23 #define SCLP_CMDW_READ_SCP_INFO_FORCED          0x00120001
24 #define SCLP_READ_STORAGE_ELEMENT_INFO          0x00040001
25 #define SCLP_ATTACH_STORAGE_ELEMENT             0x00080001
26 #define SCLP_ASSIGN_STORAGE                     0x000D0001
27 #define SCLP_CMD_READ_EVENT_DATA                0x00770005
28 #define SCLP_CMD_WRITE_EVENT_DATA               0x00760005
29 #define SCLP_CMD_READ_EVENT_DATA                0x00770005
30 #define SCLP_CMD_WRITE_EVENT_DATA               0x00760005
31 #define SCLP_CMD_WRITE_EVENT_MASK               0x00780005
32 
33 /* SCLP Memory hotplug codes */
34 #define SCLP_FC_ASSIGN_ATTACH_READ_STOR         0xE00000000000ULL
35 #define SCLP_STARTING_SUBINCREMENT_ID           0x10001
36 #define SCLP_INCREMENT_UNIT                     0x10000
37 #define MAX_AVAIL_SLOTS                         32
38 #define MAX_STORAGE_INCREMENTS                  1020
39 
40 /* CPU hotplug SCLP codes */
41 #define SCLP_HAS_CPU_INFO                       0x0C00000000000000ULL
42 #define SCLP_CMDW_READ_CPU_INFO                 0x00010001
43 #define SCLP_CMDW_CONFIGURE_CPU                 0x00110001
44 #define SCLP_CMDW_DECONFIGURE_CPU               0x00100001
45 
46 /* SCLP PCI codes */
47 #define SCLP_HAS_IOA_RECONFIG                   0x0000000040000000ULL
48 #define SCLP_CMDW_CONFIGURE_IOA                 0x001a0001
49 #define SCLP_CMDW_DECONFIGURE_IOA               0x001b0001
50 #define SCLP_RECONFIG_PCI_ATYPE                 2
51 
52 /* SCLP response codes */
53 #define SCLP_RC_NORMAL_READ_COMPLETION          0x0010
54 #define SCLP_RC_NORMAL_COMPLETION               0x0020
55 #define SCLP_RC_SCCB_BOUNDARY_VIOLATION         0x0100
56 #define SCLP_RC_NO_ACTION_REQUIRED              0x0120
57 #define SCLP_RC_INVALID_SCLP_COMMAND            0x01f0
58 #define SCLP_RC_CONTAINED_EQUIPMENT_CHECK       0x0340
59 #define SCLP_RC_INSUFFICIENT_SCCB_LENGTH        0x0300
60 #define SCLP_RC_STANDBY_READ_COMPLETION         0x0410
61 #define SCLP_RC_ADAPTER_IN_RESERVED_STATE       0x05f0
62 #define SCLP_RC_ADAPTER_TYPE_NOT_RECOGNIZED     0x06f0
63 #define SCLP_RC_ADAPTER_ID_NOT_RECOGNIZED       0x09f0
64 #define SCLP_RC_INVALID_FUNCTION                0x40f0
65 #define SCLP_RC_NO_EVENT_BUFFERS_STORED         0x60f0
66 #define SCLP_RC_INVALID_SELECTION_MASK          0x70f0
67 #define SCLP_RC_INCONSISTENT_LENGTHS            0x72f0
68 #define SCLP_RC_EVENT_BUFFER_SYNTAX_ERROR       0x73f0
69 #define SCLP_RC_INVALID_MASK_LENGTH             0x74f0
70 
71 /* SCLP control mask bits */
72 #define SCLP_CM2_VARIABLE_LENGTH_RESPONSE       0x80
73 
74 /* SCLP function codes */
75 #define SCLP_FC_NORMAL_WRITE                    0
76 #define SCLP_FC_SINGLE_INCREMENT_ASSIGN         0x40
77 #define SCLP_FC_DUMP_INDICATOR                  0x80
78 
79 /* SCLP event buffer flags */
80 #define SCLP_EVENT_BUFFER_ACCEPTED              0x80
81 
82 /* Service Call Control Block (SCCB) and its elements */
83 #define SCCB_SIZE 4096
84 
85 typedef struct SCCBHeader {
86     uint16_t length;
87     uint8_t function_code;
88     uint8_t control_mask[3];
89     uint16_t response_code;
90 } __attribute__((packed)) SCCBHeader;
91 
92 #define SCCB_DATA_LEN (SCCB_SIZE - sizeof(SCCBHeader))
93 #define SCCB_CPU_FEATURE_LEN 6
94 
95 /* CPU information */
96 typedef struct CPUEntry {
97     uint8_t address;
98     uint8_t reserved0;
99     uint8_t features[SCCB_CPU_FEATURE_LEN];
100     uint8_t reserved2[6];
101     uint8_t type;
102     uint8_t reserved1;
103 } __attribute__((packed)) CPUEntry;
104 
105 typedef struct ReadInfo {
106     SCCBHeader h;
107     uint16_t rnmax;
108     uint8_t rnsize;
109     uint8_t  _reserved1[16 - 11];       /* 11-15 */
110     uint16_t entries_cpu;               /* 16-17 */
111     uint16_t offset_cpu;                /* 18-19 */
112     uint8_t  _reserved2[24 - 20];       /* 20-23 */
113     uint8_t  loadparm[8];               /* 24-31 */
114     uint8_t  _reserved3[48 - 32];       /* 32-47 */
115     uint64_t facilities;                /* 48-55 */
116     uint8_t  _reserved0[76 - 56];       /* 56-75 */
117     uint32_t ibc_val;
118     uint8_t  conf_char[99 - 80];        /* 80-98 */
119     uint8_t mha_pow;
120     uint32_t rnsize2;
121     uint64_t rnmax2;
122     uint8_t  _reserved6[116 - 112];     /* 112-115 */
123     uint8_t  conf_char_ext[120 - 116];   /* 116-119 */
124     uint16_t highest_cpu;
125     uint8_t  _reserved5[124 - 122];     /* 122-123 */
126     uint32_t hmfai;
127     struct CPUEntry entries[0];
128 } __attribute__((packed)) ReadInfo;
129 
130 typedef struct ReadCpuInfo {
131     SCCBHeader h;
132     uint16_t nr_configured;         /* 8-9 */
133     uint16_t offset_configured;     /* 10-11 */
134     uint16_t nr_standby;            /* 12-13 */
135     uint16_t offset_standby;        /* 14-15 */
136     uint8_t reserved0[24-16];       /* 16-23 */
137     struct CPUEntry entries[0];
138 } __attribute__((packed)) ReadCpuInfo;
139 
140 typedef struct ReadStorageElementInfo {
141     SCCBHeader h;
142     uint16_t max_id;
143     uint16_t assigned;
144     uint16_t standby;
145     uint8_t _reserved0[16 - 14]; /* 14-15 */
146     uint32_t entries[0];
147 } __attribute__((packed)) ReadStorageElementInfo;
148 
149 typedef struct AttachStorageElement {
150     SCCBHeader h;
151     uint8_t _reserved0[10 - 8];  /* 8-9 */
152     uint16_t assigned;
153     uint8_t _reserved1[16 - 12]; /* 12-15 */
154     uint32_t entries[0];
155 } __attribute__((packed)) AttachStorageElement;
156 
157 typedef struct AssignStorage {
158     SCCBHeader h;
159     uint16_t rn;
160 } __attribute__((packed)) AssignStorage;
161 
162 typedef struct IoaCfgSccb {
163     SCCBHeader header;
164     uint8_t atype;
165     uint8_t reserved1;
166     uint16_t reserved2;
167     uint32_t aid;
168 } __attribute__((packed)) IoaCfgSccb;
169 
170 typedef struct SCCB {
171     SCCBHeader h;
172     char data[SCCB_DATA_LEN];
173  } __attribute__((packed)) SCCB;
174 
175 /* SCLP event types */
176 #define SCLP_EVENT_ASCII_CONSOLE_DATA           0x1a
177 #define SCLP_EVENT_SIGNAL_QUIESCE               0x1d
178 
179 /* SCLP event masks */
180 #define SCLP_EVENT_MASK_SIGNAL_QUIESCE          0x00000008
181 #define SCLP_EVENT_MASK_MSG_ASCII               0x00000040
182 
183 #define SCLP_UNCONDITIONAL_READ                 0x00
184 #define SCLP_SELECTIVE_READ                     0x01
185 
186 typedef struct WriteEventMask {
187     SCCBHeader h;
188     uint16_t _reserved;
189     uint16_t mask_length;
190     uint32_t cp_receive_mask;
191     uint32_t cp_send_mask;
192     uint32_t send_mask;
193     uint32_t receive_mask;
194 } __attribute__((packed)) WriteEventMask;
195 
196 typedef struct EventBufferHeader {
197     uint16_t length;
198     uint8_t  type;
199     uint8_t  flags;
200     uint16_t _reserved;
201 } __attribute__((packed)) EventBufferHeader;
202 
203 typedef struct WriteEventData {
204     SCCBHeader h;
205     EventBufferHeader ebh;
206     char data[0];
207 } __attribute__((packed)) WriteEventData;
208 
209 typedef struct ReadEventData {
210     SCCBHeader h;
211     EventBufferHeader ebh;
212     uint32_t mask;
213 } __attribute__((packed)) ReadEventData;
214 
215 extern char _sccb[];
216 void sclp_console_setup(void);
217 void sclp_print(const char *str);
218 int sclp_service_call(unsigned int command, void *sccb);
219 void sclp_memory_setup(void);
220 
221 #endif /* SCLP_H */
222