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