xref: /qemu/hw/s390x/ipl.h (revision 513823e7521a09ed7ad1e32e6454bac3b2cbf52d)
1 /*
2  * s390 IPL device
3  *
4  * Copyright 2015, 2020 IBM Corp.
5  * Author(s): Zhang Fan <bjfanzh@cn.ibm.com>
6  * Janosch Frank <frankja@linux.ibm.com>
7  *
8  * This work is licensed under the terms of the GNU GPL, version 2 or (at
9  * your option) any later version. See the COPYING file in the top-level
10  * directory.
11  */
12 
13 #ifndef HW_S390_IPL_H
14 #define HW_S390_IPL_H
15 
16 #include "cpu.h"
17 #include "exec/address-spaces.h"
18 #include "hw/qdev-core.h"
19 #include "hw/s390x/ipl/qipl.h"
20 #include "qom/object.h"
21 
22 #define DIAG308_FLAGS_LP_VALID 0x80
23 #define MAX_BOOT_DEVS 8 /* Max number of devices that may have a bootindex */
24 
25 void s390_ipl_convert_loadparm(char *ascii_lp, uint8_t *ebcdic_lp);
26 void s390_ipl_fmt_loadparm(uint8_t *loadparm, char *str, Error **errp);
27 void s390_rebuild_iplb(uint16_t index, IplParameterBlock *iplb);
28 void s390_ipl_update_diag308(IplParameterBlock *iplb);
29 int s390_ipl_prepare_pv_header(Error **errp);
30 int s390_ipl_pv_unpack(void);
31 void s390_ipl_prepare_cpu(S390CPU *cpu);
32 IplParameterBlock *s390_ipl_get_iplb(void);
33 IplParameterBlock *s390_ipl_get_iplb_pv(void);
34 
35 enum s390_reset {
36     /* default is a reset not triggered by a CPU e.g. issued by QMP */
37     S390_RESET_EXTERNAL = 0,
38     S390_RESET_REIPL,
39     S390_RESET_MODIFIED_CLEAR,
40     S390_RESET_LOAD_NORMAL,
41     S390_RESET_PV,
42 };
43 void s390_ipl_reset_request(CPUState *cs, enum s390_reset reset_type);
44 void s390_ipl_get_reset_request(CPUState **cs, enum s390_reset *reset_type);
45 void s390_ipl_clear_reset_request(void);
46 
47 #define QIPL_ADDRESS  0xcc
48 
49 /* Boot Menu flags */
50 #define QIPL_FLAG_BM_OPTS_CMD   0x80
51 #define QIPL_FLAG_BM_OPTS_ZIPL  0x40
52 
53 #define TYPE_S390_IPL "s390-ipl"
54 OBJECT_DECLARE_SIMPLE_TYPE(S390IPLState, S390_IPL)
55 
56 struct S390IPLState {
57     /*< private >*/
58     DeviceState parent_obj;
59     IplParameterBlock iplb;
60     IplParameterBlock iplb_pv;
61     QemuIplParameters qipl;
62     uint64_t start_addr;
63     uint64_t compat_start_addr;
64     uint64_t bios_start_addr;
65     uint64_t compat_bios_start_addr;
66     bool enforce_bios;
67     bool iplb_valid;
68     bool iplb_valid_pv;
69     bool rebuilt_iplb;
70     uint16_t iplb_index;
71     /* reset related properties don't have to be migrated or reset */
72     enum s390_reset reset_type;
73     int reset_cpu_index;
74 
75     /*< public >*/
76     char *kernel;
77     char *initrd;
78     char *cmdline;
79     char *firmware;
80     uint8_t cssid;
81     uint8_t ssid;
82     uint16_t devno;
83 };
84 QEMU_BUILD_BUG_MSG(offsetof(S390IPLState, iplb) & 3, "alignment of iplb wrong");
85 
86 #define DIAG_308_RC_OK              0x0001
87 #define DIAG_308_RC_NO_CONF         0x0102
88 #define DIAG_308_RC_INVALID         0x0402
89 #define DIAG_308_RC_NO_PV_CONF      0x0902
90 #define DIAG_308_RC_INVAL_FOR_PV    0x0a02
91 
92 #define DIAG308_RESET_MOD_CLR       0
93 #define DIAG308_RESET_LOAD_NORM     1
94 #define DIAG308_LOAD_CLEAR          3
95 #define DIAG308_LOAD_NORMAL_DUMP    4
96 #define DIAG308_SET                 5
97 #define DIAG308_STORE               6
98 #define DIAG308_PV_SET              8
99 #define DIAG308_PV_STORE            9
100 #define DIAG308_PV_START            10
101 
102 #define S390_IPL_TYPE_FCP 0x00
103 #define S390_IPL_TYPE_CCW 0x02
104 #define S390_IPL_TYPE_PV 0x05
105 #define S390_IPL_TYPE_QEMU_SCSI 0xff
106 
107 #define S390_IPLB_HEADER_LEN 8
108 #define S390_IPLB_MIN_PV_LEN 148
109 #define S390_IPLB_MIN_CCW_LEN 200
110 #define S390_IPLB_MIN_FCP_LEN 384
111 #define S390_IPLB_MIN_QEMU_SCSI_LEN 200
112 
113 static inline bool iplb_valid_len(IplParameterBlock *iplb)
114 {
115     return be32_to_cpu(iplb->len) <= sizeof(IplParameterBlock);
116 }
117 
118 static inline bool ipl_valid_pv_components(IplParameterBlock *iplb)
119 {
120     IPLBlockPV *ipib_pv = &iplb->pv;
121     int i;
122 
123     if (ipib_pv->num_comp == 0) {
124         return false;
125     }
126 
127     for (i = 0; i < ipib_pv->num_comp; i++) {
128         /* Addr must be 4k aligned */
129         if (ipib_pv->components[i].addr & ~TARGET_PAGE_MASK) {
130             return false;
131         }
132 
133         /* Tweak prefix is monotonically increasing with each component */
134         if (i < ipib_pv->num_comp - 1 &&
135             ipib_pv->components[i].tweak_pref >=
136             ipib_pv->components[i + 1].tweak_pref) {
137             return false;
138         }
139     }
140     return true;
141 }
142 
143 static inline bool ipl_valid_pv_header(IplParameterBlock *iplb)
144 {
145         IPLBlockPV *ipib_pv = &iplb->pv;
146 
147         if (ipib_pv->pv_header_len > 2 * TARGET_PAGE_SIZE) {
148             return false;
149         }
150 
151         if (!address_space_access_valid(&address_space_memory,
152                                         ipib_pv->pv_header_addr,
153                                         ipib_pv->pv_header_len,
154                                         false,
155                                         MEMTXATTRS_UNSPECIFIED)) {
156             return false;
157         }
158 
159         return true;
160 }
161 
162 static inline bool iplb_valid_pv(IplParameterBlock *iplb)
163 {
164     if (iplb->pbt != S390_IPL_TYPE_PV ||
165         be32_to_cpu(iplb->len) < S390_IPLB_MIN_PV_LEN) {
166         return false;
167     }
168     if (!ipl_valid_pv_header(iplb)) {
169         return false;
170     }
171     return ipl_valid_pv_components(iplb);
172 }
173 
174 static inline bool iplb_valid(IplParameterBlock *iplb)
175 {
176     uint32_t len = be32_to_cpu(iplb->len);
177 
178     switch (iplb->pbt) {
179     case S390_IPL_TYPE_FCP:
180         return len >= S390_IPLB_MIN_FCP_LEN;
181     case S390_IPL_TYPE_CCW:
182         return len >= S390_IPLB_MIN_CCW_LEN;
183     case S390_IPL_TYPE_QEMU_SCSI:
184     default:
185         return false;
186     }
187 }
188 
189 #endif
190