1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25#ifndef HW_IPMI_H
26#define HW_IPMI_H
27
28#include "exec/memory.h"
29#include "qemu-common.h"
30#include "hw/qdev.h"
31
32#define MAX_IPMI_MSG_SIZE 300
33
34enum ipmi_op {
35 IPMI_RESET_CHASSIS,
36 IPMI_POWEROFF_CHASSIS,
37 IPMI_POWERON_CHASSIS,
38 IPMI_POWERCYCLE_CHASSIS,
39 IPMI_PULSE_DIAG_IRQ,
40 IPMI_SHUTDOWN_VIA_ACPI_OVERTEMP,
41 IPMI_SEND_NMI
42};
43
44#define IPMI_CC_INVALID_CMD 0xc1
45#define IPMI_CC_COMMAND_INVALID_FOR_LUN 0xc2
46#define IPMI_CC_TIMEOUT 0xc3
47#define IPMI_CC_OUT_OF_SPACE 0xc4
48#define IPMI_CC_INVALID_RESERVATION 0xc5
49#define IPMI_CC_REQUEST_DATA_TRUNCATED 0xc6
50#define IPMI_CC_REQUEST_DATA_LENGTH_INVALID 0xc7
51#define IPMI_CC_PARM_OUT_OF_RANGE 0xc9
52#define IPMI_CC_CANNOT_RETURN_REQ_NUM_BYTES 0xca
53#define IPMI_CC_REQ_ENTRY_NOT_PRESENT 0xcb
54#define IPMI_CC_INVALID_DATA_FIELD 0xcc
55#define IPMI_CC_BMC_INIT_IN_PROGRESS 0xd2
56#define IPMI_CC_COMMAND_NOT_SUPPORTED 0xd5
57
58#define IPMI_NETFN_APP 0x06
59
60#define IPMI_DEBUG 1
61
62
63#define IPMI_SMBIOS_KCS 0x01
64#define IPMI_SMBIOS_SMIC 0x02
65#define IPMI_SMBIOS_BT 0x03
66#define IPMI_SMBIOS_SSIF 0x04
67
68
69
70
71
72typedef struct IPMIFwInfo {
73 const char *interface_name;
74 int interface_type;
75 uint8_t ipmi_spec_major_revision;
76 uint8_t ipmi_spec_minor_revision;
77 uint8_t i2c_slave_address;
78 uint32_t uuid;
79
80 uint64_t base_address;
81 uint64_t register_length;
82 uint8_t register_spacing;
83 enum {
84 IPMI_MEMSPACE_IO,
85 IPMI_MEMSPACE_MEM32,
86 IPMI_MEMSPACE_MEM64,
87 IPMI_MEMSPACE_SMBUS
88 } memspace;
89
90 int interrupt_number;
91 enum {
92 IPMI_LEVEL_IRQ,
93 IPMI_EDGE_IRQ
94 } irq_type;
95} IPMIFwInfo;
96
97
98
99
100uint32_t ipmi_next_uuid(void);
101
102
103#define TYPE_IPMI_INTERFACE_PREFIX "ipmi-interface-"
104
105
106
107
108
109#define TYPE_IPMI_INTERFACE "ipmi-interface"
110#define IPMI_INTERFACE(obj) \
111 INTERFACE_CHECK(IPMIInterface, (obj), TYPE_IPMI_INTERFACE)
112#define IPMI_INTERFACE_CLASS(class) \
113 OBJECT_CLASS_CHECK(IPMIInterfaceClass, (class), TYPE_IPMI_INTERFACE)
114#define IPMI_INTERFACE_GET_CLASS(class) \
115 OBJECT_GET_CLASS(IPMIInterfaceClass, (class), TYPE_IPMI_INTERFACE)
116
117typedef struct IPMIInterface {
118 Object parent;
119} IPMIInterface;
120
121typedef struct IPMIInterfaceClass {
122 InterfaceClass parent;
123
124 void (*init)(struct IPMIInterface *s, Error **errp);
125
126
127
128
129
130
131 int (*do_hw_op)(struct IPMIInterface *s, enum ipmi_op op, int checkonly);
132
133
134
135
136 void (*set_irq_enable)(struct IPMIInterface *s, int val);
137
138
139
140
141
142 void (*handle_if_event)(struct IPMIInterface *s);
143
144
145
146
147 void (*set_atn)(struct IPMIInterface *s, int val, int irq);
148
149
150
151
152 void (*reset)(struct IPMIInterface *s, bool is_cold);
153
154
155
156
157 void (*handle_rsp)(struct IPMIInterface *s, uint8_t msg_id,
158 unsigned char *rsp, unsigned int rsp_len);
159
160
161
162
163 void *(*get_backend_data)(struct IPMIInterface *s);
164
165
166
167
168 void (*get_fwinfo)(struct IPMIInterface *s, IPMIFwInfo *info);
169} IPMIInterfaceClass;
170
171
172
173
174#define TYPE_IPMI_BMC "ipmi-bmc"
175#define IPMI_BMC(obj) \
176 OBJECT_CHECK(IPMIBmc, (obj), TYPE_IPMI_BMC)
177#define IPMI_BMC_CLASS(obj_class) \
178 OBJECT_CLASS_CHECK(IPMIBmcClass, (obj_class), TYPE_IPMI_BMC)
179#define IPMI_BMC_GET_CLASS(obj) \
180 OBJECT_GET_CLASS(IPMIBmcClass, (obj), TYPE_IPMI_BMC)
181
182typedef struct IPMIBmc {
183 DeviceState parent;
184
185 uint8_t slave_addr;
186
187 IPMIInterface *intf;
188} IPMIBmc;
189
190typedef struct IPMIBmcClass {
191 DeviceClass parent;
192
193
194 void (*handle_reset)(struct IPMIBmc *s);
195
196
197
198
199 void (*handle_command)(struct IPMIBmc *s,
200 uint8_t *cmd, unsigned int cmd_len,
201 unsigned int max_cmd_len,
202 uint8_t msg_id);
203} IPMIBmcClass;
204
205
206
207
208void ipmi_bmc_find_and_link(Object *obj, Object **bmc);
209
210#ifdef IPMI_DEBUG
211#define ipmi_debug(fs, ...) \
212 fprintf(stderr, "IPMI (%s): " fs, __func__, ##__VA_ARGS__)
213#else
214#define ipmi_debug(fs, ...)
215#endif
216
217struct ipmi_sdr_header {
218 uint8_t rec_id[2];
219 uint8_t sdr_version;
220 uint8_t rec_type;
221 uint8_t rec_length;
222};
223#define IPMI_SDR_HEADER_SIZE sizeof(struct ipmi_sdr_header)
224
225#define ipmi_sdr_recid(sdr) ((sdr)->rec_id[0] | ((sdr)->rec_id[1] << 8))
226#define ipmi_sdr_length(sdr) ((sdr)->rec_length + IPMI_SDR_HEADER_SIZE)
227
228
229
230
231#define IPMI_SDR_COMPACT_TYPE 2
232
233struct ipmi_sdr_compact {
234 struct ipmi_sdr_header header;
235
236 uint8_t sensor_owner_id;
237 uint8_t sensor_owner_lun;
238 uint8_t sensor_owner_number;
239 uint8_t entity_id;
240 uint8_t entity_instance;
241 uint8_t sensor_init;
242 uint8_t sensor_caps;
243 uint8_t sensor_type;
244 uint8_t reading_type;
245 uint8_t assert_mask[2];
246 uint8_t deassert_mask[2];
247 uint8_t discrete_mask[2];
248 uint8_t sensor_unit1;
249 uint8_t sensor_unit2;
250 uint8_t sensor_unit3;
251 uint8_t sensor_direction[2];
252 uint8_t positive_threshold;
253 uint8_t negative_threshold;
254 uint8_t reserved[3];
255 uint8_t oem;
256 uint8_t id_str_len;
257 uint8_t id_string[16];
258};
259
260typedef uint8_t ipmi_sdr_compact_buffer[sizeof(struct ipmi_sdr_compact)];
261
262int ipmi_bmc_sdr_find(IPMIBmc *b, uint16_t recid,
263 const struct ipmi_sdr_compact **sdr, uint16_t *nextrec);
264void ipmi_bmc_gen_event(IPMIBmc *b, uint8_t *evt, bool log);
265
266#endif
267