xref: /openbmc/qemu/target/s390x/cpu.h (revision d36f7de8)
1 /*
2  * S/390 virtual CPU header
3  *
4  *  Copyright (c) 2009 Ulrich Hecht
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * Contributions after 2012-10-29 are licensed under the terms of the
17  * GNU GPL, version 2 or (at your option) any later version.
18  *
19  * You should have received a copy of the GNU (Lesser) General Public
20  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
21  */
22 
23 #ifndef S390X_CPU_H
24 #define S390X_CPU_H
25 
26 #include "qemu-common.h"
27 #include "cpu-qom.h"
28 #include "cpu_models.h"
29 
30 #define TARGET_LONG_BITS 64
31 
32 #define ELF_MACHINE_UNAME "S390X"
33 
34 #define CPUArchState struct CPUS390XState
35 
36 #include "exec/cpu-defs.h"
37 #define TARGET_PAGE_BITS 12
38 
39 #define TARGET_PHYS_ADDR_SPACE_BITS 64
40 #define TARGET_VIRT_ADDR_SPACE_BITS 64
41 
42 #include "exec/cpu-all.h"
43 
44 #define NB_MMU_MODES 4
45 #define TARGET_INSN_START_EXTRA_WORDS 1
46 
47 #define MMU_MODE0_SUFFIX _primary
48 #define MMU_MODE1_SUFFIX _secondary
49 #define MMU_MODE2_SUFFIX _home
50 #define MMU_MODE3_SUFFIX _real
51 
52 #define MMU_USER_IDX 0
53 
54 #define S390_MAX_CPUS 248
55 
56 typedef struct PSW {
57     uint64_t mask;
58     uint64_t addr;
59 } PSW;
60 
61 struct CPUS390XState {
62     uint64_t regs[16];     /* GP registers */
63     /*
64      * The floating point registers are part of the vector registers.
65      * vregs[0][0] -> vregs[15][0] are 16 floating point registers
66      */
67     CPU_DoubleU vregs[32][2];  /* vector registers */
68     uint32_t aregs[16];    /* access registers */
69     uint8_t riccb[64];     /* runtime instrumentation control */
70     uint64_t gscb[4];      /* guarded storage control */
71 
72     /* Fields up to this point are not cleared by initial CPU reset */
73     struct {} start_initial_reset_fields;
74 
75     uint32_t fpc;          /* floating-point control register */
76     uint32_t cc_op;
77     bool bpbc;             /* branch prediction blocking */
78 
79     float_status fpu_status; /* passed to softfloat lib */
80 
81     /* The low part of a 128-bit return, or remainder of a divide.  */
82     uint64_t retxl;
83 
84     PSW psw;
85 
86     S390CrashReason crash_reason;
87 
88     uint64_t cc_src;
89     uint64_t cc_dst;
90     uint64_t cc_vr;
91 
92     uint64_t ex_value;
93 
94     uint64_t __excp_addr;
95     uint64_t psa;
96 
97     uint32_t int_pgm_code;
98     uint32_t int_pgm_ilen;
99 
100     uint32_t int_svc_code;
101     uint32_t int_svc_ilen;
102 
103     uint64_t per_address;
104     uint16_t per_perc_atmid;
105 
106     uint64_t cregs[16]; /* control registers */
107 
108     int pending_int;
109     uint16_t external_call_addr;
110     DECLARE_BITMAP(emergency_signals, S390_MAX_CPUS);
111 
112     uint64_t ckc;
113     uint64_t cputm;
114     uint32_t todpr;
115 
116     uint64_t pfault_token;
117     uint64_t pfault_compare;
118     uint64_t pfault_select;
119 
120     uint64_t gbea;
121     uint64_t pp;
122 
123     /* Fields up to this point are cleared by a CPU reset */
124     struct {} end_reset_fields;
125 
126     CPU_COMMON
127 
128 #if !defined(CONFIG_USER_ONLY)
129     uint32_t core_id; /* PoP "CPU address", same as cpu_index */
130     uint64_t cpuid;
131 #endif
132 
133     QEMUTimer *tod_timer;
134 
135     QEMUTimer *cpu_timer;
136 
137     /*
138      * The cpu state represents the logical state of a cpu. In contrast to other
139      * architectures, there is a difference between a halt and a stop on s390.
140      * If all cpus are either stopped (including check stop) or in the disabled
141      * wait state, the vm can be shut down.
142      * The acceptable cpu_state values are defined in the CpuInfoS390State
143      * enum.
144      */
145     uint8_t cpu_state;
146 
147     /* currently processed sigp order */
148     uint8_t sigp_order;
149 
150 };
151 
152 static inline CPU_DoubleU *get_freg(CPUS390XState *cs, int nr)
153 {
154     return &cs->vregs[nr][0];
155 }
156 
157 /**
158  * S390CPU:
159  * @env: #CPUS390XState.
160  *
161  * An S/390 CPU.
162  */
163 struct S390CPU {
164     /*< private >*/
165     CPUState parent_obj;
166     /*< public >*/
167 
168     CPUS390XState env;
169     S390CPUModel *model;
170     /* needed for live migration */
171     void *irqstate;
172     uint32_t irqstate_saved_size;
173 };
174 
175 static inline S390CPU *s390_env_get_cpu(CPUS390XState *env)
176 {
177     return container_of(env, S390CPU, env);
178 }
179 
180 #define ENV_GET_CPU(e) CPU(s390_env_get_cpu(e))
181 
182 #define ENV_OFFSET offsetof(S390CPU, env)
183 
184 #ifndef CONFIG_USER_ONLY
185 extern const struct VMStateDescription vmstate_s390_cpu;
186 #endif
187 
188 /* distinguish between 24 bit and 31 bit addressing */
189 #define HIGH_ORDER_BIT 0x80000000
190 
191 /* Interrupt Codes */
192 /* Program Interrupts */
193 #define PGM_OPERATION                   0x0001
194 #define PGM_PRIVILEGED                  0x0002
195 #define PGM_EXECUTE                     0x0003
196 #define PGM_PROTECTION                  0x0004
197 #define PGM_ADDRESSING                  0x0005
198 #define PGM_SPECIFICATION               0x0006
199 #define PGM_DATA                        0x0007
200 #define PGM_FIXPT_OVERFLOW              0x0008
201 #define PGM_FIXPT_DIVIDE                0x0009
202 #define PGM_DEC_OVERFLOW                0x000a
203 #define PGM_DEC_DIVIDE                  0x000b
204 #define PGM_HFP_EXP_OVERFLOW            0x000c
205 #define PGM_HFP_EXP_UNDERFLOW           0x000d
206 #define PGM_HFP_SIGNIFICANCE            0x000e
207 #define PGM_HFP_DIVIDE                  0x000f
208 #define PGM_SEGMENT_TRANS               0x0010
209 #define PGM_PAGE_TRANS                  0x0011
210 #define PGM_TRANS_SPEC                  0x0012
211 #define PGM_SPECIAL_OP                  0x0013
212 #define PGM_OPERAND                     0x0015
213 #define PGM_TRACE_TABLE                 0x0016
214 #define PGM_SPACE_SWITCH                0x001c
215 #define PGM_HFP_SQRT                    0x001d
216 #define PGM_PC_TRANS_SPEC               0x001f
217 #define PGM_AFX_TRANS                   0x0020
218 #define PGM_ASX_TRANS                   0x0021
219 #define PGM_LX_TRANS                    0x0022
220 #define PGM_EX_TRANS                    0x0023
221 #define PGM_PRIM_AUTH                   0x0024
222 #define PGM_SEC_AUTH                    0x0025
223 #define PGM_ALET_SPEC                   0x0028
224 #define PGM_ALEN_SPEC                   0x0029
225 #define PGM_ALE_SEQ                     0x002a
226 #define PGM_ASTE_VALID                  0x002b
227 #define PGM_ASTE_SEQ                    0x002c
228 #define PGM_EXT_AUTH                    0x002d
229 #define PGM_STACK_FULL                  0x0030
230 #define PGM_STACK_EMPTY                 0x0031
231 #define PGM_STACK_SPEC                  0x0032
232 #define PGM_STACK_TYPE                  0x0033
233 #define PGM_STACK_OP                    0x0034
234 #define PGM_ASCE_TYPE                   0x0038
235 #define PGM_REG_FIRST_TRANS             0x0039
236 #define PGM_REG_SEC_TRANS               0x003a
237 #define PGM_REG_THIRD_TRANS             0x003b
238 #define PGM_MONITOR                     0x0040
239 #define PGM_PER                         0x0080
240 #define PGM_CRYPTO                      0x0119
241 
242 /* External Interrupts */
243 #define EXT_INTERRUPT_KEY               0x0040
244 #define EXT_CLOCK_COMP                  0x1004
245 #define EXT_CPU_TIMER                   0x1005
246 #define EXT_MALFUNCTION                 0x1200
247 #define EXT_EMERGENCY                   0x1201
248 #define EXT_EXTERNAL_CALL               0x1202
249 #define EXT_ETR                         0x1406
250 #define EXT_SERVICE                     0x2401
251 #define EXT_VIRTIO                      0x2603
252 
253 /* PSW defines */
254 #undef PSW_MASK_PER
255 #undef PSW_MASK_DAT
256 #undef PSW_MASK_IO
257 #undef PSW_MASK_EXT
258 #undef PSW_MASK_KEY
259 #undef PSW_SHIFT_KEY
260 #undef PSW_MASK_MCHECK
261 #undef PSW_MASK_WAIT
262 #undef PSW_MASK_PSTATE
263 #undef PSW_MASK_ASC
264 #undef PSW_SHIFT_ASC
265 #undef PSW_MASK_CC
266 #undef PSW_MASK_PM
267 #undef PSW_SHIFT_MASK_PM
268 #undef PSW_MASK_64
269 #undef PSW_MASK_32
270 #undef PSW_MASK_ESA_ADDR
271 
272 #define PSW_MASK_PER            0x4000000000000000ULL
273 #define PSW_MASK_DAT            0x0400000000000000ULL
274 #define PSW_MASK_IO             0x0200000000000000ULL
275 #define PSW_MASK_EXT            0x0100000000000000ULL
276 #define PSW_MASK_KEY            0x00F0000000000000ULL
277 #define PSW_SHIFT_KEY           52
278 #define PSW_MASK_MCHECK         0x0004000000000000ULL
279 #define PSW_MASK_WAIT           0x0002000000000000ULL
280 #define PSW_MASK_PSTATE         0x0001000000000000ULL
281 #define PSW_MASK_ASC            0x0000C00000000000ULL
282 #define PSW_SHIFT_ASC           46
283 #define PSW_MASK_CC             0x0000300000000000ULL
284 #define PSW_MASK_PM             0x00000F0000000000ULL
285 #define PSW_SHIFT_MASK_PM       40
286 #define PSW_MASK_64             0x0000000100000000ULL
287 #define PSW_MASK_32             0x0000000080000000ULL
288 #define PSW_MASK_ESA_ADDR       0x000000007fffffffULL
289 
290 #undef PSW_ASC_PRIMARY
291 #undef PSW_ASC_ACCREG
292 #undef PSW_ASC_SECONDARY
293 #undef PSW_ASC_HOME
294 
295 #define PSW_ASC_PRIMARY         0x0000000000000000ULL
296 #define PSW_ASC_ACCREG          0x0000400000000000ULL
297 #define PSW_ASC_SECONDARY       0x0000800000000000ULL
298 #define PSW_ASC_HOME            0x0000C00000000000ULL
299 
300 /* the address space values shifted */
301 #define AS_PRIMARY              0
302 #define AS_ACCREG               1
303 #define AS_SECONDARY            2
304 #define AS_HOME                 3
305 
306 /* tb flags */
307 
308 #define FLAG_MASK_PSW_SHIFT     31
309 #define FLAG_MASK_PER           (PSW_MASK_PER    >> FLAG_MASK_PSW_SHIFT)
310 #define FLAG_MASK_DAT           (PSW_MASK_DAT    >> FLAG_MASK_PSW_SHIFT)
311 #define FLAG_MASK_PSTATE        (PSW_MASK_PSTATE >> FLAG_MASK_PSW_SHIFT)
312 #define FLAG_MASK_ASC           (PSW_MASK_ASC    >> FLAG_MASK_PSW_SHIFT)
313 #define FLAG_MASK_64            (PSW_MASK_64     >> FLAG_MASK_PSW_SHIFT)
314 #define FLAG_MASK_32            (PSW_MASK_32     >> FLAG_MASK_PSW_SHIFT)
315 #define FLAG_MASK_PSW           (FLAG_MASK_PER | FLAG_MASK_DAT | FLAG_MASK_PSTATE \
316                                 | FLAG_MASK_ASC | FLAG_MASK_64 | FLAG_MASK_32)
317 
318 /* Control register 0 bits */
319 #define CR0_LOWPROT             0x0000000010000000ULL
320 #define CR0_SECONDARY           0x0000000004000000ULL
321 #define CR0_EDAT                0x0000000000800000ULL
322 #define CR0_EMERGENCY_SIGNAL_SC 0x0000000000004000ULL
323 #define CR0_EXTERNAL_CALL_SC    0x0000000000002000ULL
324 #define CR0_CKC_SC              0x0000000000000800ULL
325 #define CR0_CPU_TIMER_SC        0x0000000000000400ULL
326 #define CR0_SERVICE_SC          0x0000000000000200ULL
327 
328 /* Control register 14 bits */
329 #define CR14_CHANNEL_REPORT_SC  0x0000000010000000ULL
330 
331 /* MMU */
332 #define MMU_PRIMARY_IDX         0
333 #define MMU_SECONDARY_IDX       1
334 #define MMU_HOME_IDX            2
335 #define MMU_REAL_IDX            3
336 
337 static inline int cpu_mmu_index(CPUS390XState *env, bool ifetch)
338 {
339     if (!(env->psw.mask & PSW_MASK_DAT)) {
340         return MMU_REAL_IDX;
341     }
342 
343     switch (env->psw.mask & PSW_MASK_ASC) {
344     case PSW_ASC_PRIMARY:
345         return MMU_PRIMARY_IDX;
346     case PSW_ASC_SECONDARY:
347         return MMU_SECONDARY_IDX;
348     case PSW_ASC_HOME:
349         return MMU_HOME_IDX;
350     case PSW_ASC_ACCREG:
351         /* Fallthrough: access register mode is not yet supported */
352     default:
353         abort();
354     }
355 }
356 
357 static inline void cpu_get_tb_cpu_state(CPUS390XState* env, target_ulong *pc,
358                                         target_ulong *cs_base, uint32_t *flags)
359 {
360     *pc = env->psw.addr;
361     *cs_base = env->ex_value;
362     *flags = (env->psw.mask >> FLAG_MASK_PSW_SHIFT) & FLAG_MASK_PSW;
363 }
364 
365 /* PER bits from control register 9 */
366 #define PER_CR9_EVENT_BRANCH           0x80000000
367 #define PER_CR9_EVENT_IFETCH           0x40000000
368 #define PER_CR9_EVENT_STORE            0x20000000
369 #define PER_CR9_EVENT_STORE_REAL       0x08000000
370 #define PER_CR9_EVENT_NULLIFICATION    0x01000000
371 #define PER_CR9_CONTROL_BRANCH_ADDRESS 0x00800000
372 #define PER_CR9_CONTROL_ALTERATION     0x00200000
373 
374 /* PER bits from the PER CODE/ATMID/AI in lowcore */
375 #define PER_CODE_EVENT_BRANCH          0x8000
376 #define PER_CODE_EVENT_IFETCH          0x4000
377 #define PER_CODE_EVENT_STORE           0x2000
378 #define PER_CODE_EVENT_STORE_REAL      0x0800
379 #define PER_CODE_EVENT_NULLIFICATION   0x0100
380 
381 #define EXCP_EXT 1 /* external interrupt */
382 #define EXCP_SVC 2 /* supervisor call (syscall) */
383 #define EXCP_PGM 3 /* program interruption */
384 #define EXCP_RESTART 4 /* restart interrupt */
385 #define EXCP_STOP 5 /* stop interrupt */
386 #define EXCP_IO  7 /* I/O interrupt */
387 #define EXCP_MCHK 8 /* machine check */
388 
389 #define INTERRUPT_EXT_CPU_TIMER          (1 << 3)
390 #define INTERRUPT_EXT_CLOCK_COMPARATOR   (1 << 4)
391 #define INTERRUPT_EXTERNAL_CALL          (1 << 5)
392 #define INTERRUPT_EMERGENCY_SIGNAL       (1 << 6)
393 #define INTERRUPT_RESTART                (1 << 7)
394 #define INTERRUPT_STOP                   (1 << 8)
395 
396 /* Program Status Word.  */
397 #define S390_PSWM_REGNUM 0
398 #define S390_PSWA_REGNUM 1
399 /* General Purpose Registers.  */
400 #define S390_R0_REGNUM 2
401 #define S390_R1_REGNUM 3
402 #define S390_R2_REGNUM 4
403 #define S390_R3_REGNUM 5
404 #define S390_R4_REGNUM 6
405 #define S390_R5_REGNUM 7
406 #define S390_R6_REGNUM 8
407 #define S390_R7_REGNUM 9
408 #define S390_R8_REGNUM 10
409 #define S390_R9_REGNUM 11
410 #define S390_R10_REGNUM 12
411 #define S390_R11_REGNUM 13
412 #define S390_R12_REGNUM 14
413 #define S390_R13_REGNUM 15
414 #define S390_R14_REGNUM 16
415 #define S390_R15_REGNUM 17
416 /* Total Core Registers. */
417 #define S390_NUM_CORE_REGS 18
418 
419 static inline void setcc(S390CPU *cpu, uint64_t cc)
420 {
421     CPUS390XState *env = &cpu->env;
422 
423     env->psw.mask &= ~(3ull << 44);
424     env->psw.mask |= (cc & 3) << 44;
425     env->cc_op = cc;
426 }
427 
428 /* STSI */
429 #define STSI_R0_FC_MASK         0x00000000f0000000ULL
430 #define STSI_R0_FC_CURRENT      0x0000000000000000ULL
431 #define STSI_R0_FC_LEVEL_1      0x0000000010000000ULL
432 #define STSI_R0_FC_LEVEL_2      0x0000000020000000ULL
433 #define STSI_R0_FC_LEVEL_3      0x0000000030000000ULL
434 #define STSI_R0_RESERVED_MASK   0x000000000fffff00ULL
435 #define STSI_R0_SEL1_MASK       0x00000000000000ffULL
436 #define STSI_R1_RESERVED_MASK   0x00000000ffff0000ULL
437 #define STSI_R1_SEL2_MASK       0x000000000000ffffULL
438 
439 /* Basic Machine Configuration */
440 typedef struct SysIB_111 {
441     uint8_t  res1[32];
442     uint8_t  manuf[16];
443     uint8_t  type[4];
444     uint8_t  res2[12];
445     uint8_t  model[16];
446     uint8_t  sequence[16];
447     uint8_t  plant[4];
448     uint8_t  res3[3996];
449 } SysIB_111;
450 QEMU_BUILD_BUG_ON(sizeof(SysIB_111) != 4096);
451 
452 /* Basic Machine CPU */
453 typedef struct SysIB_121 {
454     uint8_t  res1[80];
455     uint8_t  sequence[16];
456     uint8_t  plant[4];
457     uint8_t  res2[2];
458     uint16_t cpu_addr;
459     uint8_t  res3[3992];
460 } SysIB_121;
461 QEMU_BUILD_BUG_ON(sizeof(SysIB_121) != 4096);
462 
463 /* Basic Machine CPUs */
464 typedef struct SysIB_122 {
465     uint8_t res1[32];
466     uint32_t capability;
467     uint16_t total_cpus;
468     uint16_t conf_cpus;
469     uint16_t standby_cpus;
470     uint16_t reserved_cpus;
471     uint16_t adjustments[2026];
472 } SysIB_122;
473 QEMU_BUILD_BUG_ON(sizeof(SysIB_122) != 4096);
474 
475 /* LPAR CPU */
476 typedef struct SysIB_221 {
477     uint8_t  res1[80];
478     uint8_t  sequence[16];
479     uint8_t  plant[4];
480     uint16_t cpu_id;
481     uint16_t cpu_addr;
482     uint8_t  res3[3992];
483 } SysIB_221;
484 QEMU_BUILD_BUG_ON(sizeof(SysIB_221) != 4096);
485 
486 /* LPAR CPUs */
487 typedef struct SysIB_222 {
488     uint8_t  res1[32];
489     uint16_t lpar_num;
490     uint8_t  res2;
491     uint8_t  lcpuc;
492     uint16_t total_cpus;
493     uint16_t conf_cpus;
494     uint16_t standby_cpus;
495     uint16_t reserved_cpus;
496     uint8_t  name[8];
497     uint32_t caf;
498     uint8_t  res3[16];
499     uint16_t dedicated_cpus;
500     uint16_t shared_cpus;
501     uint8_t  res4[4020];
502 } SysIB_222;
503 QEMU_BUILD_BUG_ON(sizeof(SysIB_222) != 4096);
504 
505 /* VM CPUs */
506 typedef struct SysIB_322 {
507     uint8_t  res1[31];
508     uint8_t  count;
509     struct {
510         uint8_t  res2[4];
511         uint16_t total_cpus;
512         uint16_t conf_cpus;
513         uint16_t standby_cpus;
514         uint16_t reserved_cpus;
515         uint8_t  name[8];
516         uint32_t caf;
517         uint8_t  cpi[16];
518         uint8_t res5[3];
519         uint8_t ext_name_encoding;
520         uint32_t res3;
521         uint8_t uuid[16];
522     } vm[8];
523     uint8_t res4[1504];
524     uint8_t ext_names[8][256];
525 } SysIB_322;
526 QEMU_BUILD_BUG_ON(sizeof(SysIB_322) != 4096);
527 
528 typedef union SysIB {
529     SysIB_111 sysib_111;
530     SysIB_121 sysib_121;
531     SysIB_122 sysib_122;
532     SysIB_221 sysib_221;
533     SysIB_222 sysib_222;
534     SysIB_322 sysib_322;
535 } SysIB;
536 QEMU_BUILD_BUG_ON(sizeof(SysIB) != 4096);
537 
538 /* MMU defines */
539 #define ASCE_ORIGIN           (~0xfffULL) /* segment table origin             */
540 #define ASCE_SUBSPACE         0x200       /* subspace group control           */
541 #define ASCE_PRIVATE_SPACE    0x100       /* private space control            */
542 #define ASCE_ALT_EVENT        0x80        /* storage alteration event control */
543 #define ASCE_SPACE_SWITCH     0x40        /* space switch event               */
544 #define ASCE_REAL_SPACE       0x20        /* real space control               */
545 #define ASCE_TYPE_MASK        0x0c        /* asce table type mask             */
546 #define ASCE_TYPE_REGION1     0x0c        /* region first table type          */
547 #define ASCE_TYPE_REGION2     0x08        /* region second table type         */
548 #define ASCE_TYPE_REGION3     0x04        /* region third table type          */
549 #define ASCE_TYPE_SEGMENT     0x00        /* segment table type               */
550 #define ASCE_TABLE_LENGTH     0x03        /* region table length              */
551 
552 #define REGION_ENTRY_ORIGIN   (~0xfffULL) /* region/segment table origin    */
553 #define REGION_ENTRY_RO       0x200       /* region/segment protection bit  */
554 #define REGION_ENTRY_TF       0xc0        /* region/segment table offset    */
555 #define REGION_ENTRY_INV      0x20        /* invalid region table entry     */
556 #define REGION_ENTRY_TYPE_MASK 0x0c       /* region/segment table type mask */
557 #define REGION_ENTRY_TYPE_R1  0x0c        /* region first table type        */
558 #define REGION_ENTRY_TYPE_R2  0x08        /* region second table type       */
559 #define REGION_ENTRY_TYPE_R3  0x04        /* region third table type        */
560 #define REGION_ENTRY_LENGTH   0x03        /* region third length            */
561 
562 #define SEGMENT_ENTRY_ORIGIN  (~0x7ffULL) /* segment table origin        */
563 #define SEGMENT_ENTRY_FC      0x400       /* format control              */
564 #define SEGMENT_ENTRY_RO      0x200       /* page protection bit         */
565 #define SEGMENT_ENTRY_INV     0x20        /* invalid segment table entry */
566 
567 #define VADDR_PX              0xff000     /* page index bits   */
568 
569 #define PAGE_RO               0x200       /* HW read-only bit  */
570 #define PAGE_INVALID          0x400       /* HW invalid bit    */
571 #define PAGE_RES0             0x800       /* bit must be zero  */
572 
573 #define SK_C                    (0x1 << 1)
574 #define SK_R                    (0x1 << 2)
575 #define SK_F                    (0x1 << 3)
576 #define SK_ACC_MASK             (0xf << 4)
577 
578 /* SIGP order codes */
579 #define SIGP_SENSE             0x01
580 #define SIGP_EXTERNAL_CALL     0x02
581 #define SIGP_EMERGENCY         0x03
582 #define SIGP_START             0x04
583 #define SIGP_STOP              0x05
584 #define SIGP_RESTART           0x06
585 #define SIGP_STOP_STORE_STATUS 0x09
586 #define SIGP_INITIAL_CPU_RESET 0x0b
587 #define SIGP_CPU_RESET         0x0c
588 #define SIGP_SET_PREFIX        0x0d
589 #define SIGP_STORE_STATUS_ADDR 0x0e
590 #define SIGP_SET_ARCH          0x12
591 #define SIGP_COND_EMERGENCY    0x13
592 #define SIGP_SENSE_RUNNING     0x15
593 #define SIGP_STORE_ADTL_STATUS 0x17
594 
595 /* SIGP condition codes */
596 #define SIGP_CC_ORDER_CODE_ACCEPTED 0
597 #define SIGP_CC_STATUS_STORED       1
598 #define SIGP_CC_BUSY                2
599 #define SIGP_CC_NOT_OPERATIONAL     3
600 
601 /* SIGP status bits */
602 #define SIGP_STAT_EQUIPMENT_CHECK   0x80000000UL
603 #define SIGP_STAT_NOT_RUNNING       0x00000400UL
604 #define SIGP_STAT_INCORRECT_STATE   0x00000200UL
605 #define SIGP_STAT_INVALID_PARAMETER 0x00000100UL
606 #define SIGP_STAT_EXT_CALL_PENDING  0x00000080UL
607 #define SIGP_STAT_STOPPED           0x00000040UL
608 #define SIGP_STAT_OPERATOR_INTERV   0x00000020UL
609 #define SIGP_STAT_CHECK_STOP        0x00000010UL
610 #define SIGP_STAT_INOPERATIVE       0x00000004UL
611 #define SIGP_STAT_INVALID_ORDER     0x00000002UL
612 #define SIGP_STAT_RECEIVER_CHECK    0x00000001UL
613 
614 /* SIGP SET ARCHITECTURE modes */
615 #define SIGP_MODE_ESA_S390 0
616 #define SIGP_MODE_Z_ARCH_TRANS_ALL_PSW 1
617 #define SIGP_MODE_Z_ARCH_TRANS_CUR_PSW 2
618 
619 /* SIGP order code mask corresponding to bit positions 56-63 */
620 #define SIGP_ORDER_MASK 0x000000ff
621 
622 /* machine check interruption code */
623 
624 /* subclasses */
625 #define MCIC_SC_SD 0x8000000000000000ULL
626 #define MCIC_SC_PD 0x4000000000000000ULL
627 #define MCIC_SC_SR 0x2000000000000000ULL
628 #define MCIC_SC_CD 0x0800000000000000ULL
629 #define MCIC_SC_ED 0x0400000000000000ULL
630 #define MCIC_SC_DG 0x0100000000000000ULL
631 #define MCIC_SC_W  0x0080000000000000ULL
632 #define MCIC_SC_CP 0x0040000000000000ULL
633 #define MCIC_SC_SP 0x0020000000000000ULL
634 #define MCIC_SC_CK 0x0010000000000000ULL
635 
636 /* subclass modifiers */
637 #define MCIC_SCM_B  0x0002000000000000ULL
638 #define MCIC_SCM_DA 0x0000000020000000ULL
639 #define MCIC_SCM_AP 0x0000000000080000ULL
640 
641 /* storage errors */
642 #define MCIC_SE_SE 0x0000800000000000ULL
643 #define MCIC_SE_SC 0x0000400000000000ULL
644 #define MCIC_SE_KE 0x0000200000000000ULL
645 #define MCIC_SE_DS 0x0000100000000000ULL
646 #define MCIC_SE_IE 0x0000000080000000ULL
647 
648 /* validity bits */
649 #define MCIC_VB_WP 0x0000080000000000ULL
650 #define MCIC_VB_MS 0x0000040000000000ULL
651 #define MCIC_VB_PM 0x0000020000000000ULL
652 #define MCIC_VB_IA 0x0000010000000000ULL
653 #define MCIC_VB_FA 0x0000008000000000ULL
654 #define MCIC_VB_VR 0x0000004000000000ULL
655 #define MCIC_VB_EC 0x0000002000000000ULL
656 #define MCIC_VB_FP 0x0000001000000000ULL
657 #define MCIC_VB_GR 0x0000000800000000ULL
658 #define MCIC_VB_CR 0x0000000400000000ULL
659 #define MCIC_VB_ST 0x0000000100000000ULL
660 #define MCIC_VB_AR 0x0000000040000000ULL
661 #define MCIC_VB_GS 0x0000000008000000ULL
662 #define MCIC_VB_PR 0x0000000000200000ULL
663 #define MCIC_VB_FC 0x0000000000100000ULL
664 #define MCIC_VB_CT 0x0000000000020000ULL
665 #define MCIC_VB_CC 0x0000000000010000ULL
666 
667 static inline uint64_t s390_build_validity_mcic(void)
668 {
669     uint64_t mcic;
670 
671     /*
672      * Indicate all validity bits (no damage) only. Other bits have to be
673      * added by the caller. (storage errors, subclasses and subclass modifiers)
674      */
675     mcic = MCIC_VB_WP | MCIC_VB_MS | MCIC_VB_PM | MCIC_VB_IA | MCIC_VB_FP |
676            MCIC_VB_GR | MCIC_VB_CR | MCIC_VB_ST | MCIC_VB_AR | MCIC_VB_PR |
677            MCIC_VB_FC | MCIC_VB_CT | MCIC_VB_CC;
678     if (s390_has_feat(S390_FEAT_VECTOR)) {
679         mcic |= MCIC_VB_VR;
680     }
681     if (s390_has_feat(S390_FEAT_GUARDED_STORAGE)) {
682         mcic |= MCIC_VB_GS;
683     }
684     return mcic;
685 }
686 
687 static inline void s390_do_cpu_full_reset(CPUState *cs, run_on_cpu_data arg)
688 {
689     cpu_reset(cs);
690 }
691 
692 static inline void s390_do_cpu_reset(CPUState *cs, run_on_cpu_data arg)
693 {
694     S390CPUClass *scc = S390_CPU_GET_CLASS(cs);
695 
696     scc->cpu_reset(cs);
697 }
698 
699 static inline void s390_do_cpu_initial_reset(CPUState *cs, run_on_cpu_data arg)
700 {
701     S390CPUClass *scc = S390_CPU_GET_CLASS(cs);
702 
703     scc->initial_cpu_reset(cs);
704 }
705 
706 static inline void s390_do_cpu_load_normal(CPUState *cs, run_on_cpu_data arg)
707 {
708     S390CPUClass *scc = S390_CPU_GET_CLASS(cs);
709 
710     scc->load_normal(cs);
711 }
712 
713 
714 /* cpu.c */
715 void s390_crypto_reset(void);
716 int s390_set_memory_limit(uint64_t new_limit, uint64_t *hw_limit);
717 void s390_cmma_reset(void);
718 void s390_enable_css_support(S390CPU *cpu);
719 int s390_assign_subch_ioeventfd(EventNotifier *notifier, uint32_t sch_id,
720                                 int vq, bool assign);
721 #ifndef CONFIG_USER_ONLY
722 unsigned int s390_cpu_set_state(uint8_t cpu_state, S390CPU *cpu);
723 #else
724 static inline unsigned int s390_cpu_set_state(uint8_t cpu_state, S390CPU *cpu)
725 {
726     return 0;
727 }
728 #endif /* CONFIG_USER_ONLY */
729 static inline uint8_t s390_cpu_get_state(S390CPU *cpu)
730 {
731     return cpu->env.cpu_state;
732 }
733 
734 
735 /* cpu_models.c */
736 void s390_cpu_list(FILE *f, fprintf_function cpu_fprintf);
737 #define cpu_list s390_cpu_list
738 void s390_set_qemu_cpu_model(uint16_t type, uint8_t gen, uint8_t ec_ga,
739                              const S390FeatInit feat_init);
740 
741 
742 /* helper.c */
743 #define S390_CPU_TYPE_SUFFIX "-" TYPE_S390_CPU
744 #define S390_CPU_TYPE_NAME(name) (name S390_CPU_TYPE_SUFFIX)
745 #define CPU_RESOLVING_TYPE TYPE_S390_CPU
746 
747 /* you can call this signal handler from your SIGBUS and SIGSEGV
748    signal handlers to inform the virtual CPU of exceptions. non zero
749    is returned if the signal was handled by the virtual CPU.  */
750 int cpu_s390x_signal_handler(int host_signum, void *pinfo, void *puc);
751 #define cpu_signal_handler cpu_s390x_signal_handler
752 
753 
754 /* interrupt.c */
755 void s390_crw_mchk(void);
756 void s390_io_interrupt(uint16_t subchannel_id, uint16_t subchannel_nr,
757                        uint32_t io_int_parm, uint32_t io_int_word);
758 /* automatically detect the instruction length */
759 #define ILEN_AUTO                   0xff
760 #define RA_IGNORED                  0
761 void s390_program_interrupt(CPUS390XState *env, uint32_t code, int ilen,
762                             uintptr_t ra);
763 /* service interrupts are floating therefore we must not pass an cpustate */
764 void s390_sclp_extint(uint32_t parm);
765 
766 /* mmu_helper.c */
767 int s390_cpu_virt_mem_rw(S390CPU *cpu, vaddr laddr, uint8_t ar, void *hostbuf,
768                          int len, bool is_write);
769 #define s390_cpu_virt_mem_read(cpu, laddr, ar, dest, len)    \
770         s390_cpu_virt_mem_rw(cpu, laddr, ar, dest, len, false)
771 #define s390_cpu_virt_mem_write(cpu, laddr, ar, dest, len)       \
772         s390_cpu_virt_mem_rw(cpu, laddr, ar, dest, len, true)
773 #define s390_cpu_virt_mem_check_read(cpu, laddr, ar, len)   \
774         s390_cpu_virt_mem_rw(cpu, laddr, ar, NULL, len, false)
775 #define s390_cpu_virt_mem_check_write(cpu, laddr, ar, len)   \
776         s390_cpu_virt_mem_rw(cpu, laddr, ar, NULL, len, true)
777 void s390_cpu_virt_mem_handle_exc(S390CPU *cpu, uintptr_t ra);
778 
779 
780 /* sigp.c */
781 int s390_cpu_restart(S390CPU *cpu);
782 void s390_init_sigp(void);
783 
784 
785 /* outside of target/s390x/ */
786 S390CPU *s390_cpu_addr2state(uint16_t cpu_addr);
787 
788 #endif
789