xref: /openbmc/qemu/include/hw/s390x/sclp.h (revision 228aa992)
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 
20 #define SCLP_CMD_CODE_MASK                      0xffff00ff
21 
22 /* SCLP command codes */
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_UNASSIGN_STORAGE                   0x000C0001
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 response codes */
47 #define SCLP_RC_NORMAL_READ_COMPLETION          0x0010
48 #define SCLP_RC_NORMAL_COMPLETION               0x0020
49 #define SCLP_RC_SCCB_BOUNDARY_VIOLATION         0x0100
50 #define SCLP_RC_INVALID_SCLP_COMMAND            0x01f0
51 #define SCLP_RC_CONTAINED_EQUIPMENT_CHECK       0x0340
52 #define SCLP_RC_INSUFFICIENT_SCCB_LENGTH        0x0300
53 #define SCLP_RC_STANDBY_READ_COMPLETION         0x0410
54 #define SCLP_RC_INVALID_FUNCTION                0x40f0
55 #define SCLP_RC_NO_EVENT_BUFFERS_STORED         0x60f0
56 #define SCLP_RC_INVALID_SELECTION_MASK          0x70f0
57 #define SCLP_RC_INCONSISTENT_LENGTHS            0x72f0
58 #define SCLP_RC_EVENT_BUFFER_SYNTAX_ERROR       0x73f0
59 #define SCLP_RC_INVALID_MASK_LENGTH             0x74f0
60 
61 
62 /* Service Call Control Block (SCCB) and its elements */
63 
64 #define SCCB_SIZE 4096
65 
66 #define SCLP_VARIABLE_LENGTH_RESPONSE           0x80
67 #define SCLP_EVENT_BUFFER_ACCEPTED              0x80
68 
69 #define SCLP_FC_NORMAL_WRITE                    0
70 
71 /*
72  * Normally packed structures are not the right thing to do, since all code
73  * must take care of endianness. We cannot use ldl_phys and friends for two
74  * reasons, though:
75  * - some of the embedded structures below the SCCB can appear multiple times
76  *   at different locations, so there is no fixed offset
77  * - we work on a private copy of the SCCB, since there are several length
78  *   fields, that would cause a security nightmare if we allow the guest to
79  *   alter the structure while we parse it. We cannot use ldl_p and friends
80  *   either without doing pointer arithmetics
81  * So we have to double check that all users of sclp data structures use the
82  * right endianness wrappers.
83  */
84 typedef struct SCCBHeader {
85     uint16_t length;
86     uint8_t function_code;
87     uint8_t control_mask[3];
88     uint16_t response_code;
89 } QEMU_PACKED SCCBHeader;
90 
91 #define SCCB_DATA_LEN (SCCB_SIZE - sizeof(SCCBHeader))
92 
93 /* CPU information */
94 typedef struct CPUEntry {
95     uint8_t address;
96     uint8_t reserved0[13];
97     uint8_t type;
98     uint8_t reserved1;
99 } QEMU_PACKED CPUEntry;
100 
101 typedef struct ReadInfo {
102     SCCBHeader h;
103     uint16_t rnmax;
104     uint8_t rnsize;
105     uint8_t  _reserved1[16 - 11];       /* 11-15 */
106     uint16_t entries_cpu;               /* 16-17 */
107     uint16_t offset_cpu;                /* 18-19 */
108     uint8_t  _reserved2[24 - 20];       /* 20-23 */
109     uint8_t  loadparm[8];               /* 24-31 */
110     uint8_t  _reserved3[48 - 32];       /* 32-47 */
111     uint64_t facilities;                /* 48-55 */
112     uint8_t  _reserved0[100 - 56];
113     uint32_t rnsize2;
114     uint64_t rnmax2;
115     uint8_t  _reserved4[120-112];       /* 112-119 */
116     uint16_t highest_cpu;
117     uint8_t  _reserved5[128 - 122];     /* 122-127 */
118     struct CPUEntry entries[0];
119 } QEMU_PACKED ReadInfo;
120 
121 typedef struct ReadCpuInfo {
122     SCCBHeader h;
123     uint16_t nr_configured;         /* 8-9 */
124     uint16_t offset_configured;     /* 10-11 */
125     uint16_t nr_standby;            /* 12-13 */
126     uint16_t offset_standby;        /* 14-15 */
127     uint8_t reserved0[24-16];       /* 16-23 */
128     struct CPUEntry entries[0];
129 } QEMU_PACKED ReadCpuInfo;
130 
131 typedef struct ReadStorageElementInfo {
132     SCCBHeader h;
133     uint16_t max_id;
134     uint16_t assigned;
135     uint16_t standby;
136     uint8_t _reserved0[16 - 14]; /* 14-15 */
137     uint32_t entries[0];
138 } QEMU_PACKED ReadStorageElementInfo;
139 
140 typedef struct AttachStorageElement {
141     SCCBHeader h;
142     uint8_t _reserved0[10 - 8];  /* 8-9 */
143     uint16_t assigned;
144     uint8_t _reserved1[16 - 12]; /* 12-15 */
145     uint32_t entries[0];
146 } QEMU_PACKED AttachStorageElement;
147 
148 typedef struct AssignStorage {
149     SCCBHeader h;
150     uint16_t rn;
151 } QEMU_PACKED AssignStorage;
152 
153 typedef struct SCCB {
154     SCCBHeader h;
155     char data[SCCB_DATA_LEN];
156  } QEMU_PACKED SCCB;
157 
158 typedef struct sclpMemoryHotplugDev sclpMemoryHotplugDev;
159 
160 #define TYPE_SCLP_MEMORY_HOTPLUG_DEV "sclp-memory-hotplug-dev"
161 #define SCLP_MEMORY_HOTPLUG_DEV(obj) \
162   OBJECT_CHECK(sclpMemoryHotplugDev, (obj), TYPE_SCLP_MEMORY_HOTPLUG_DEV)
163 
164 struct sclpMemoryHotplugDev {
165     SysBusDevice parent;
166     ram_addr_t standby_mem_size;
167     ram_addr_t padded_ram_size;
168     ram_addr_t pad_size;
169     ram_addr_t standby_subregion_size;
170     ram_addr_t rzm;
171     int increment_size;
172     char *standby_state_map;
173 };
174 
175 static inline int sccb_data_len(SCCB *sccb)
176 {
177     return be16_to_cpu(sccb->h.length) - sizeof(sccb->h);
178 }
179 
180 
181 void s390_sclp_init(void);
182 sclpMemoryHotplugDev *init_sclp_memory_hotplug_dev(void);
183 sclpMemoryHotplugDev *get_sclp_memory_hotplug_dev(void);
184 void sclp_service_interrupt(uint32_t sccb);
185 void raise_irq_cpu_hotplug(void);
186 
187 #endif
188