1 | /* |
2 | * IPMI base class |
3 | * |
4 | * Copyright (c) 2015 Corey Minyard, MontaVista Software, LLC |
5 | * |
6 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
7 | * of this software and associated documentation files (the "Software"), to deal |
8 | * in the Software without restriction, including without limitation the rights |
9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
10 | * copies of the Software, and to permit persons to whom the Software is |
11 | * furnished to do so, subject to the following conditions: |
12 | * |
13 | * The above copyright notice and this permission notice shall be included in |
14 | * all copies or substantial portions of the Software. |
15 | * |
16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
19 | * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
22 | * THE SOFTWARE. |
23 | */ |
24 | |
25 | #ifndef HW_IPMI_H |
26 | #define HW_IPMI_H |
27 | |
28 | #include "exec/memory.h" |
29 | #include "hw/qdev-core.h" |
30 | |
31 | #define MAX_IPMI_MSG_SIZE 300 |
32 | |
33 | enum ipmi_op { |
34 | IPMI_RESET_CHASSIS, |
35 | IPMI_POWEROFF_CHASSIS, |
36 | IPMI_POWERON_CHASSIS, |
37 | IPMI_POWERCYCLE_CHASSIS, |
38 | IPMI_PULSE_DIAG_IRQ, |
39 | IPMI_SHUTDOWN_VIA_ACPI_OVERTEMP, |
40 | IPMI_SEND_NMI |
41 | }; |
42 | |
43 | #define IPMI_CC_INVALID_CMD 0xc1 |
44 | #define IPMI_CC_COMMAND_INVALID_FOR_LUN 0xc2 |
45 | #define IPMI_CC_TIMEOUT 0xc3 |
46 | #define IPMI_CC_OUT_OF_SPACE 0xc4 |
47 | #define IPMI_CC_INVALID_RESERVATION 0xc5 |
48 | #define IPMI_CC_REQUEST_DATA_TRUNCATED 0xc6 |
49 | #define IPMI_CC_REQUEST_DATA_LENGTH_INVALID 0xc7 |
50 | #define IPMI_CC_PARM_OUT_OF_RANGE 0xc9 |
51 | #define IPMI_CC_CANNOT_RETURN_REQ_NUM_BYTES 0xca |
52 | #define IPMI_CC_REQ_ENTRY_NOT_PRESENT 0xcb |
53 | #define IPMI_CC_INVALID_DATA_FIELD 0xcc |
54 | #define IPMI_CC_BMC_INIT_IN_PROGRESS 0xd2 |
55 | #define IPMI_CC_COMMAND_NOT_SUPPORTED 0xd5 |
56 | |
57 | #define IPMI_NETFN_APP 0x06 |
58 | |
59 | #define IPMI_DEBUG 1 |
60 | |
61 | /* Specified in the SMBIOS spec. */ |
62 | #define IPMI_SMBIOS_KCS 0x01 |
63 | #define IPMI_SMBIOS_SMIC 0x02 |
64 | #define IPMI_SMBIOS_BT 0x03 |
65 | #define IPMI_SMBIOS_SSIF 0x04 |
66 | |
67 | /* |
68 | * Used for transferring information to interfaces that add |
69 | * entries to firmware tables. |
70 | */ |
71 | typedef struct IPMIFwInfo { |
72 | const char *interface_name; |
73 | int interface_type; |
74 | uint8_t ipmi_spec_major_revision; |
75 | uint8_t ipmi_spec_minor_revision; |
76 | uint8_t i2c_slave_address; |
77 | uint32_t uuid; |
78 | |
79 | uint64_t base_address; |
80 | uint64_t register_length; |
81 | uint8_t register_spacing; |
82 | enum { |
83 | IPMI_MEMSPACE_IO, |
84 | IPMI_MEMSPACE_MEM32, |
85 | IPMI_MEMSPACE_MEM64, |
86 | IPMI_MEMSPACE_SMBUS |
87 | } memspace; |
88 | |
89 | int interrupt_number; |
90 | enum { |
91 | IPMI_LEVEL_IRQ, |
92 | IPMI_EDGE_IRQ |
93 | } irq_type; |
94 | } IPMIFwInfo; |
95 | |
96 | /* |
97 | * Called by each instantiated IPMI interface device to get it's uuid. |
98 | */ |
99 | uint32_t ipmi_next_uuid(void); |
100 | |
101 | /* IPMI Interface types (KCS, SMIC, BT) are prefixed with this */ |
102 | #define TYPE_IPMI_INTERFACE_PREFIX "ipmi-interface-" |
103 | |
104 | /* |
105 | * An IPMI Interface, the interface for talking between the target |
106 | * and the BMC. |
107 | */ |
108 | #define TYPE_IPMI_INTERFACE "ipmi-interface" |
109 | #define IPMI_INTERFACE(obj) \ |
110 | INTERFACE_CHECK(IPMIInterface, (obj), TYPE_IPMI_INTERFACE) |
111 | #define IPMI_INTERFACE_CLASS(class) \ |
112 | OBJECT_CLASS_CHECK(IPMIInterfaceClass, (class), TYPE_IPMI_INTERFACE) |
113 | #define IPMI_INTERFACE_GET_CLASS(class) \ |
114 | OBJECT_GET_CLASS(IPMIInterfaceClass, (class), TYPE_IPMI_INTERFACE) |
115 | |
116 | typedef struct IPMIInterface IPMIInterface; |
117 | |
118 | typedef struct IPMIInterfaceClass { |
119 | InterfaceClass parent; |
120 | |
121 | void (*init)(struct IPMIInterface *s, Error **errp); |
122 | |
123 | /* |
124 | * Perform various operations on the hardware. If checkonly is |
125 | * true, it will return if the operation can be performed, but it |
126 | * will not do the operation. |
127 | */ |
128 | int (*do_hw_op)(struct IPMIInterface *s, enum ipmi_op op, int checkonly); |
129 | |
130 | /* |
131 | * Enable/disable irqs on the interface when the BMC requests this. |
132 | */ |
133 | void (*set_irq_enable)(struct IPMIInterface *s, int val); |
134 | |
135 | /* |
136 | * Handle an event that occurred on the interface, generally the. |
137 | * target writing to a register. |
138 | */ |
139 | void (*handle_if_event)(struct IPMIInterface *s); |
140 | |
141 | /* |
142 | * The interfaces use this to perform certain ops |
143 | */ |
144 | void (*set_atn)(struct IPMIInterface *s, int val, int irq); |
145 | |
146 | /* |
147 | * Got an IPMI warm/cold reset. |
148 | */ |
149 | void (*reset)(struct IPMIInterface *s, bool is_cold); |
150 | |
151 | /* |
152 | * Handle a response from the bmc. |
153 | */ |
154 | void (*handle_rsp)(struct IPMIInterface *s, uint8_t msg_id, |
155 | unsigned char *rsp, unsigned int rsp_len); |
156 | |
157 | /* |
158 | * Set by the owner to hold the backend data for the interface. |
159 | */ |
160 | void *(*get_backend_data)(struct IPMIInterface *s); |
161 | |
162 | /* |
163 | * Return the firmware info for a device. |
164 | */ |
165 | void (*get_fwinfo)(struct IPMIInterface *s, IPMIFwInfo *info); |
166 | } IPMIInterfaceClass; |
167 | |
168 | /* |
169 | * Define a BMC simulator (or perhaps a connection to a real BMC) |
170 | */ |
171 | #define TYPE_IPMI_BMC "ipmi-bmc" |
172 | #define IPMI_BMC(obj) \ |
173 | OBJECT_CHECK(IPMIBmc, (obj), TYPE_IPMI_BMC) |
174 | #define IPMI_BMC_CLASS(obj_class) \ |
175 | OBJECT_CLASS_CHECK(IPMIBmcClass, (obj_class), TYPE_IPMI_BMC) |
176 | #define IPMI_BMC_GET_CLASS(obj) \ |
177 | OBJECT_GET_CLASS(IPMIBmcClass, (obj), TYPE_IPMI_BMC) |
178 | |
179 | typedef struct IPMIBmc { |
180 | DeviceState parent; |
181 | |
182 | uint8_t slave_addr; |
183 | |
184 | IPMIInterface *intf; |
185 | } IPMIBmc; |
186 | |
187 | typedef struct IPMIBmcClass { |
188 | DeviceClass parent; |
189 | |
190 | /* Called when the system resets to report to the bmc. */ |
191 | void (*handle_reset)(struct IPMIBmc *s); |
192 | |
193 | /* |
194 | * Handle a command to the bmc. |
195 | */ |
196 | void (*handle_command)(struct IPMIBmc *s, |
197 | uint8_t *cmd, unsigned int cmd_len, |
198 | unsigned int max_cmd_len, |
199 | uint8_t msg_id); |
200 | } IPMIBmcClass; |
201 | |
202 | /* |
203 | * Add a link property to obj that points to a BMC. |
204 | */ |
205 | void ipmi_bmc_find_and_link(Object *obj, Object **bmc); |
206 | |
207 | #ifdef IPMI_DEBUG |
208 | #define ipmi_debug(fs, ...) \ |
209 | fprintf(stderr, "IPMI (%s): " fs, __func__, ##__VA_ARGS__) |
210 | #else |
211 | #define ipmi_debug(fs, ...) |
212 | #endif |
213 | |
214 | struct { |
215 | uint8_t [2]; |
216 | uint8_t ; /* 0x51 */ |
217 | uint8_t ; |
218 | uint8_t ; |
219 | }; |
220 | #define sizeof(struct ipmi_sdr_header) |
221 | |
222 | #define ipmi_sdr_recid(sdr) ((sdr)->rec_id[0] | ((sdr)->rec_id[1] << 8)) |
223 | #define ipmi_sdr_length(sdr) ((sdr)->rec_length + IPMI_SDR_HEADER_SIZE) |
224 | |
225 | /* |
226 | * 43.2 SDR Type 02h. Compact Sensor Record |
227 | */ |
228 | #define IPMI_SDR_COMPACT_TYPE 2 |
229 | |
230 | struct ipmi_sdr_compact { |
231 | struct ipmi_sdr_header ; |
232 | |
233 | uint8_t sensor_owner_id; |
234 | uint8_t sensor_owner_lun; |
235 | uint8_t sensor_owner_number; /* byte 8 */ |
236 | uint8_t entity_id; |
237 | uint8_t entity_instance; |
238 | uint8_t sensor_init; |
239 | uint8_t sensor_caps; |
240 | uint8_t sensor_type; |
241 | uint8_t reading_type; |
242 | uint8_t assert_mask[2]; /* byte 16 */ |
243 | uint8_t deassert_mask[2]; |
244 | uint8_t discrete_mask[2]; |
245 | uint8_t sensor_unit1; |
246 | uint8_t sensor_unit2; |
247 | uint8_t sensor_unit3; |
248 | uint8_t sensor_direction[2]; /* byte 24 */ |
249 | uint8_t positive_threshold; |
250 | uint8_t negative_threshold; |
251 | uint8_t reserved[3]; |
252 | uint8_t oem; |
253 | uint8_t id_str_len; /* byte 32 */ |
254 | uint8_t id_string[16]; |
255 | }; |
256 | |
257 | typedef uint8_t ipmi_sdr_compact_buffer[sizeof(struct ipmi_sdr_compact)]; |
258 | |
259 | int ipmi_bmc_sdr_find(IPMIBmc *b, uint16_t recid, |
260 | const struct ipmi_sdr_compact **sdr, uint16_t *nextrec); |
261 | void ipmi_bmc_gen_event(IPMIBmc *b, uint8_t *evt, bool log); |
262 | |
263 | #endif |
264 | |