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