xref: /openbmc/qemu/include/hw/s390x/sclp.h (revision 3110cdbd)
1 /*
2  * SCLP Support
3  *
4  * Copyright IBM, Corp. 2012
5  *
6  * Authors:
7  *  Christian Borntraeger <borntraeger@de.ibm.com>
8  *
9  * This work is licensed under the terms of the GNU GPL, version 2 or (at your
10  * option) any later version.  See the COPYING file in the top-level directory.
11  *
12  */
13 
14 #ifndef HW_S390_SCLP_H
15 #define HW_S390_SCLP_H
16 
17 #include "hw/sysbus.h"
18 #include "hw/qdev.h"
19 #include "target/s390x/cpu-qom.h"
20 
21 #define SCLP_CMD_CODE_MASK                      0xffff00ff
22 
23 /* SCLP command codes */
24 #define SCLP_CMDW_READ_SCP_INFO                 0x00020001
25 #define SCLP_CMDW_READ_SCP_INFO_FORCED          0x00120001
26 #define SCLP_READ_STORAGE_ELEMENT_INFO          0x00040001
27 #define SCLP_ATTACH_STORAGE_ELEMENT             0x00080001
28 #define SCLP_ASSIGN_STORAGE                     0x000D0001
29 #define SCLP_UNASSIGN_STORAGE                   0x000C0001
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 
73 /* Service Call Control Block (SCCB) and its elements */
74 
75 #define SCCB_SIZE 4096
76 
77 #define SCLP_VARIABLE_LENGTH_RESPONSE           0x80
78 #define SCLP_EVENT_BUFFER_ACCEPTED              0x80
79 
80 #define SCLP_FC_NORMAL_WRITE                    0
81 
82 /*
83  * Normally packed structures are not the right thing to do, since all code
84  * must take care of endianness. We cannot use ldl_phys and friends for two
85  * reasons, though:
86  * - some of the embedded structures below the SCCB can appear multiple times
87  *   at different locations, so there is no fixed offset
88  * - we work on a private copy of the SCCB, since there are several length
89  *   fields, that would cause a security nightmare if we allow the guest to
90  *   alter the structure while we parse it. We cannot use ldl_p and friends
91  *   either without doing pointer arithmetics
92  * So we have to double check that all users of sclp data structures use the
93  * right endianness wrappers.
94  */
95 typedef struct SCCBHeader {
96     uint16_t length;
97     uint8_t function_code;
98     uint8_t control_mask[3];
99     uint16_t response_code;
100 } QEMU_PACKED SCCBHeader;
101 
102 #define SCCB_DATA_LEN (SCCB_SIZE - sizeof(SCCBHeader))
103 #define SCCB_CPU_FEATURE_LEN 6
104 
105 /* CPU information */
106 typedef struct CPUEntry {
107     uint8_t address;
108     uint8_t reserved0;
109     uint8_t features[SCCB_CPU_FEATURE_LEN];
110     uint8_t reserved2[6];
111     uint8_t type;
112     uint8_t reserved1;
113 } QEMU_PACKED CPUEntry;
114 
115 typedef struct ReadInfo {
116     SCCBHeader h;
117     uint16_t rnmax;
118     uint8_t rnsize;
119     uint8_t  _reserved1[16 - 11];       /* 11-15 */
120     uint16_t entries_cpu;               /* 16-17 */
121     uint16_t offset_cpu;                /* 18-19 */
122     uint8_t  _reserved2[24 - 20];       /* 20-23 */
123     uint8_t  loadparm[8];               /* 24-31 */
124     uint8_t  _reserved3[48 - 32];       /* 32-47 */
125     uint64_t facilities;                /* 48-55 */
126     uint8_t  _reserved0[76 - 56];       /* 56-75 */
127     uint32_t ibc_val;
128     uint8_t  conf_char[99 - 80];        /* 80-98 */
129     uint8_t mha_pow;
130     uint32_t rnsize2;
131     uint64_t rnmax2;
132     uint8_t  _reserved6[116 - 112];     /* 112-115 */
133     uint8_t  conf_char_ext[120 - 116];   /* 116-119 */
134     uint16_t highest_cpu;
135     uint8_t  _reserved5[124 - 122];     /* 122-123 */
136     uint32_t hmfai;
137     struct CPUEntry entries[0];
138 } QEMU_PACKED ReadInfo;
139 
140 typedef struct ReadCpuInfo {
141     SCCBHeader h;
142     uint16_t nr_configured;         /* 8-9 */
143     uint16_t offset_configured;     /* 10-11 */
144     uint16_t nr_standby;            /* 12-13 */
145     uint16_t offset_standby;        /* 14-15 */
146     uint8_t reserved0[24-16];       /* 16-23 */
147     struct CPUEntry entries[0];
148 } QEMU_PACKED ReadCpuInfo;
149 
150 typedef struct ReadStorageElementInfo {
151     SCCBHeader h;
152     uint16_t max_id;
153     uint16_t assigned;
154     uint16_t standby;
155     uint8_t _reserved0[16 - 14]; /* 14-15 */
156     uint32_t entries[0];
157 } QEMU_PACKED ReadStorageElementInfo;
158 
159 typedef struct AttachStorageElement {
160     SCCBHeader h;
161     uint8_t _reserved0[10 - 8];  /* 8-9 */
162     uint16_t assigned;
163     uint8_t _reserved1[16 - 12]; /* 12-15 */
164     uint32_t entries[0];
165 } QEMU_PACKED AttachStorageElement;
166 
167 typedef struct AssignStorage {
168     SCCBHeader h;
169     uint16_t rn;
170 } QEMU_PACKED AssignStorage;
171 
172 typedef struct IoaCfgSccb {
173     SCCBHeader header;
174     uint8_t atype;
175     uint8_t reserved1;
176     uint16_t reserved2;
177     uint32_t aid;
178 } QEMU_PACKED IoaCfgSccb;
179 
180 typedef struct SCCB {
181     SCCBHeader h;
182     char data[SCCB_DATA_LEN];
183  } QEMU_PACKED SCCB;
184 
185 #define TYPE_SCLP "sclp"
186 #define SCLP(obj) OBJECT_CHECK(SCLPDevice, (obj), TYPE_SCLP)
187 #define SCLP_CLASS(oc) OBJECT_CLASS_CHECK(SCLPDeviceClass, (oc), TYPE_SCLP)
188 #define SCLP_GET_CLASS(obj) OBJECT_GET_CLASS(SCLPDeviceClass, (obj), TYPE_SCLP)
189 
190 typedef struct SCLPEventFacility SCLPEventFacility;
191 
192 typedef struct SCLPDevice {
193     /* private */
194     DeviceState parent_obj;
195     SCLPEventFacility *event_facility;
196     int increment_size;
197 
198     /* public */
199 } SCLPDevice;
200 
201 typedef struct SCLPDeviceClass {
202     /* private */
203     DeviceClass parent_class;
204     void (*read_SCP_info)(SCLPDevice *sclp, SCCB *sccb);
205     void (*read_storage_element0_info)(SCLPDevice *sclp, SCCB *sccb);
206     void (*read_storage_element1_info)(SCLPDevice *sclp, SCCB *sccb);
207     void (*attach_storage_element)(SCLPDevice *sclp, SCCB *sccb,
208                                    uint16_t element);
209     void (*assign_storage)(SCLPDevice *sclp, SCCB *sccb);
210     void (*unassign_storage)(SCLPDevice *sclp, SCCB *sccb);
211     void (*read_cpu_info)(SCLPDevice *sclp, SCCB *sccb);
212 
213     /* public */
214     void (*execute)(SCLPDevice *sclp, SCCB *sccb, uint32_t code);
215     void (*service_interrupt)(SCLPDevice *sclp, uint32_t sccb);
216 } SCLPDeviceClass;
217 
218 typedef struct sclpMemoryHotplugDev sclpMemoryHotplugDev;
219 
220 #define TYPE_SCLP_MEMORY_HOTPLUG_DEV "sclp-memory-hotplug-dev"
221 #define SCLP_MEMORY_HOTPLUG_DEV(obj) \
222   OBJECT_CHECK(sclpMemoryHotplugDev, (obj), TYPE_SCLP_MEMORY_HOTPLUG_DEV)
223 
224 struct sclpMemoryHotplugDev {
225     SysBusDevice parent;
226     ram_addr_t standby_mem_size;
227     ram_addr_t padded_ram_size;
228     ram_addr_t pad_size;
229     ram_addr_t standby_subregion_size;
230     ram_addr_t rzm;
231     int increment_size;
232     char *standby_state_map;
233 };
234 
235 static inline int sccb_data_len(SCCB *sccb)
236 {
237     return be16_to_cpu(sccb->h.length) - sizeof(sccb->h);
238 }
239 
240 
241 void s390_sclp_init(void);
242 sclpMemoryHotplugDev *init_sclp_memory_hotplug_dev(void);
243 sclpMemoryHotplugDev *get_sclp_memory_hotplug_dev(void);
244 void sclp_service_interrupt(uint32_t sccb);
245 void raise_irq_cpu_hotplug(void);
246 int sclp_service_call(CPUS390XState *env, uint64_t sccb, uint32_t code);
247 
248 #endif
249