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 #define IPMI_NETFN_OEM 0x3a 59 60 #define IPMI_DEBUG 1 61 62 /* Specified in the SMBIOS spec. */ 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 * Used for transferring information to interfaces that add 70 * entries to firmware tables. 71 */ 72 typedef 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 * Called by each instantiated IPMI interface device to get it's uuid. 99 */ 100 uint32_t ipmi_next_uuid(void); 101 102 /* IPMI Interface types (KCS, SMIC, BT) are prefixed with this */ 103 #define TYPE_IPMI_INTERFACE_PREFIX "ipmi-interface-" 104 105 /* 106 * An IPMI Interface, the interface for talking between the target 107 * and the BMC. 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 117 typedef struct IPMIInterface IPMIInterface; 118 119 typedef struct IPMIInterfaceClass { 120 InterfaceClass parent; 121 122 /* 123 * min_size is the requested I/O size and must be a power of 2. 124 * This is so PCI (or other busses) can request a bigger range. 125 * Use 0 for the default. 126 */ 127 void (*init)(struct IPMIInterface *s, unsigned int min_size, Error **errp); 128 129 /* 130 * Perform various operations on the hardware. If checkonly is 131 * true, it will return if the operation can be performed, but it 132 * will not do the operation. 133 */ 134 int (*do_hw_op)(struct IPMIInterface *s, enum ipmi_op op, int checkonly); 135 136 /* 137 * Enable/disable irqs on the interface when the BMC requests this. 138 */ 139 void (*set_irq_enable)(struct IPMIInterface *s, int val); 140 141 /* 142 * Handle an event that occurred on the interface, generally the. 143 * target writing to a register. 144 */ 145 void (*handle_if_event)(struct IPMIInterface *s); 146 147 /* 148 * The interfaces use this to perform certain ops 149 */ 150 void (*set_atn)(struct IPMIInterface *s, int val, int irq); 151 152 /* 153 * Got an IPMI warm/cold reset. 154 */ 155 void (*reset)(struct IPMIInterface *s, bool is_cold); 156 157 /* 158 * Handle a response from the bmc. 159 */ 160 void (*handle_rsp)(struct IPMIInterface *s, uint8_t msg_id, 161 unsigned char *rsp, unsigned int rsp_len); 162 163 /* 164 * Set by the owner to hold the backend data for the interface. 165 */ 166 void *(*get_backend_data)(struct IPMIInterface *s); 167 168 /* 169 * Return the firmware info for a device. 170 */ 171 void (*get_fwinfo)(struct IPMIInterface *s, IPMIFwInfo *info); 172 } IPMIInterfaceClass; 173 174 /* 175 * Define a BMC simulator (or perhaps a connection to a real BMC) 176 */ 177 #define TYPE_IPMI_BMC "ipmi-bmc" 178 #define IPMI_BMC(obj) \ 179 OBJECT_CHECK(IPMIBmc, (obj), TYPE_IPMI_BMC) 180 #define IPMI_BMC_CLASS(obj_class) \ 181 OBJECT_CLASS_CHECK(IPMIBmcClass, (obj_class), TYPE_IPMI_BMC) 182 #define IPMI_BMC_GET_CLASS(obj) \ 183 OBJECT_GET_CLASS(IPMIBmcClass, (obj), TYPE_IPMI_BMC) 184 185 typedef struct IPMIBmc { 186 DeviceState parent; 187 188 uint8_t slave_addr; 189 190 IPMIInterface *intf; 191 } IPMIBmc; 192 193 typedef struct IPMIBmcClass { 194 DeviceClass parent; 195 196 /* Called when the system resets to report to the bmc. */ 197 void (*handle_reset)(struct IPMIBmc *s); 198 199 /* 200 * Handle a command to the bmc. 201 */ 202 void (*handle_command)(struct IPMIBmc *s, 203 uint8_t *cmd, unsigned int cmd_len, 204 unsigned int max_cmd_len, 205 uint8_t msg_id); 206 } IPMIBmcClass; 207 208 /* 209 * Add a link property to obj that points to a BMC. 210 */ 211 void ipmi_bmc_find_and_link(Object *obj, Object **bmc); 212 213 #ifdef IPMI_DEBUG 214 #define ipmi_debug(fs, ...) \ 215 fprintf(stderr, "IPMI (%s): " fs, __func__, ##__VA_ARGS__) 216 #else 217 #define ipmi_debug(fs, ...) 218 #endif 219 220 struct ipmi_sdr_header { 221 uint8_t rec_id[2]; 222 uint8_t sdr_version; /* 0x51 */ 223 uint8_t rec_type; 224 uint8_t rec_length; 225 }; 226 #define IPMI_SDR_HEADER_SIZE sizeof(struct ipmi_sdr_header) 227 228 #define ipmi_sdr_recid(sdr) ((sdr)->rec_id[0] | ((sdr)->rec_id[1] << 8)) 229 #define ipmi_sdr_length(sdr) ((sdr)->rec_length + IPMI_SDR_HEADER_SIZE) 230 231 /* 232 * 43.2 SDR Type 02h. Compact Sensor Record 233 */ 234 #define IPMI_SDR_COMPACT_TYPE 2 235 236 struct ipmi_sdr_compact { 237 struct ipmi_sdr_header header; 238 239 uint8_t sensor_owner_id; 240 uint8_t sensor_owner_lun; 241 uint8_t sensor_owner_number; /* byte 8 */ 242 uint8_t entity_id; 243 uint8_t entity_instance; 244 uint8_t sensor_init; 245 uint8_t sensor_caps; 246 uint8_t sensor_type; 247 uint8_t reading_type; 248 uint8_t assert_mask[2]; /* byte 16 */ 249 uint8_t deassert_mask[2]; 250 uint8_t discrete_mask[2]; 251 uint8_t sensor_unit1; 252 uint8_t sensor_unit2; 253 uint8_t sensor_unit3; 254 uint8_t sensor_direction[2]; /* byte 24 */ 255 uint8_t positive_threshold; 256 uint8_t negative_threshold; 257 uint8_t reserved[3]; 258 uint8_t oem; 259 uint8_t id_str_len; /* byte 32 */ 260 uint8_t id_string[16]; 261 }; 262 263 typedef uint8_t ipmi_sdr_compact_buffer[sizeof(struct ipmi_sdr_compact)]; 264 265 int ipmi_bmc_sdr_find(IPMIBmc *b, uint16_t recid, 266 const struct ipmi_sdr_compact **sdr, uint16_t *nextrec); 267 void ipmi_bmc_gen_event(IPMIBmc *b, uint8_t *evt, bool log); 268 269 #define TYPE_IPMI_BMC_SIMULATOR "ipmi-bmc-sim" 270 #define IPMI_BMC_SIMULATOR(obj) OBJECT_CHECK(IPMIBmcSim, (obj), \ 271 TYPE_IPMI_BMC_SIMULATOR) 272 273 typedef struct IPMIBmcSim IPMIBmcSim; 274 275 typedef struct RspBuffer { 276 uint8_t buffer[MAX_IPMI_MSG_SIZE]; 277 unsigned int len; 278 } RspBuffer; 279 280 static inline void rsp_buffer_set_error(RspBuffer *rsp, uint8_t byte) 281 { 282 rsp->buffer[2] = byte; 283 } 284 285 /* Add a byte to the response. */ 286 static inline void rsp_buffer_push(RspBuffer *rsp, uint8_t byte) 287 { 288 if (rsp->len >= sizeof(rsp->buffer)) { 289 rsp_buffer_set_error(rsp, IPMI_CC_REQUEST_DATA_TRUNCATED); 290 return; 291 } 292 rsp->buffer[rsp->len++] = byte; 293 } 294 295 typedef struct IPMICmdHandler { 296 void (*cmd_handler)(IPMIBmcSim *s, 297 uint8_t *cmd, unsigned int cmd_len, 298 RspBuffer *rsp); 299 unsigned int cmd_len_min; 300 } IPMICmdHandler; 301 302 typedef struct IPMINetfn { 303 unsigned int cmd_nums; 304 const IPMICmdHandler *cmd_handlers; 305 } IPMINetfn; 306 307 int ipmi_sim_register_netfn(IPMIBmcSim *s, unsigned int netfn, 308 const IPMINetfn *netfnd); 309 310 #endif 311