4 * Copyright (c) 2015 Corey Minyard, MontaVista Software, LLC
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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
28 #include "exec/memory.h"
29 #include "qemu-common.h"
32 #define MAX_IPMI_MSG_SIZE 300
36 IPMI_POWEROFF_CHASSIS
,
38 IPMI_POWERCYCLE_CHASSIS
,
40 IPMI_SHUTDOWN_VIA_ACPI_OVERTEMP
,
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
58 #define IPMI_NETFN_APP 0x06
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
69 * Used for transferring information to interfaces that add
70 * entries to firmware tables.
72 typedef struct IPMIFwInfo
{
73 const char *interface_name
;
75 uint8_t ipmi_spec_major_revision
;
76 uint8_t ipmi_spec_minor_revision
;
77 uint8_t i2c_slave_address
;
80 uint64_t base_address
;
81 uint64_t register_length
;
82 uint8_t register_spacing
;
98 * Called by each instantiated IPMI interface device to get it's uuid.
100 uint32_t ipmi_next_uuid(void);
102 /* IPMI Interface types (KCS, SMIC, BT) are prefixed with this */
103 #define TYPE_IPMI_INTERFACE_PREFIX "ipmi-interface-"
106 * An IPMI Interface, the interface for talking between the target
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)
117 typedef struct IPMIInterface IPMIInterface
;
119 typedef struct IPMIInterfaceClass
{
120 InterfaceClass parent
;
122 void (*init
)(struct IPMIInterface
*s
, Error
**errp
);
125 * Perform various operations on the hardware. If checkonly is
126 * true, it will return if the operation can be performed, but it
127 * will not do the operation.
129 int (*do_hw_op
)(struct IPMIInterface
*s
, enum ipmi_op op
, int checkonly
);
132 * Enable/disable irqs on the interface when the BMC requests this.
134 void (*set_irq_enable
)(struct IPMIInterface
*s
, int val
);
137 * Handle an event that occurred on the interface, generally the.
138 * target writing to a register.
140 void (*handle_if_event
)(struct IPMIInterface
*s
);
143 * The interfaces use this to perform certain ops
145 void (*set_atn
)(struct IPMIInterface
*s
, int val
, int irq
);
148 * Got an IPMI warm/cold reset.
150 void (*reset
)(struct IPMIInterface
*s
, bool is_cold
);
153 * Handle a response from the bmc.
155 void (*handle_rsp
)(struct IPMIInterface
*s
, uint8_t msg_id
,
156 unsigned char *rsp
, unsigned int rsp_len
);
159 * Set by the owner to hold the backend data for the interface.
161 void *(*get_backend_data
)(struct IPMIInterface
*s
);
164 * Return the firmware info for a device.
166 void (*get_fwinfo
)(struct IPMIInterface
*s
, IPMIFwInfo
*info
);
167 } IPMIInterfaceClass
;
170 * Define a BMC simulator (or perhaps a connection to a real BMC)
172 #define TYPE_IPMI_BMC "ipmi-bmc"
173 #define IPMI_BMC(obj) \
174 OBJECT_CHECK(IPMIBmc, (obj), TYPE_IPMI_BMC)
175 #define IPMI_BMC_CLASS(obj_class) \
176 OBJECT_CLASS_CHECK(IPMIBmcClass, (obj_class), TYPE_IPMI_BMC)
177 #define IPMI_BMC_GET_CLASS(obj) \
178 OBJECT_GET_CLASS(IPMIBmcClass, (obj), TYPE_IPMI_BMC)
180 typedef struct IPMIBmc
{
188 typedef struct IPMIBmcClass
{
191 /* Called when the system resets to report to the bmc. */
192 void (*handle_reset
)(struct IPMIBmc
*s
);
195 * Handle a command to the bmc.
197 void (*handle_command
)(struct IPMIBmc
*s
,
198 uint8_t *cmd
, unsigned int cmd_len
,
199 unsigned int max_cmd_len
,
204 * Add a link property to obj that points to a BMC.
206 void ipmi_bmc_find_and_link(Object
*obj
, Object
**bmc
);
209 #define ipmi_debug(fs, ...) \
210 fprintf(stderr, "IPMI (%s): " fs, __func__, ##__VA_ARGS__)
212 #define ipmi_debug(fs, ...)
215 struct ipmi_sdr_header
{
217 uint8_t sdr_version
; /* 0x51 */
221 #define IPMI_SDR_HEADER_SIZE sizeof(struct ipmi_sdr_header)
223 #define ipmi_sdr_recid(sdr) ((sdr)->rec_id[0] | ((sdr)->rec_id[1] << 8))
224 #define ipmi_sdr_length(sdr) ((sdr)->rec_length + IPMI_SDR_HEADER_SIZE)
227 * 43.2 SDR Type 02h. Compact Sensor Record
229 #define IPMI_SDR_COMPACT_TYPE 2
231 struct ipmi_sdr_compact
{
232 struct ipmi_sdr_header header
;
234 uint8_t sensor_owner_id
;
235 uint8_t sensor_owner_lun
;
236 uint8_t sensor_owner_number
; /* byte 8 */
238 uint8_t entity_instance
;
242 uint8_t reading_type
;
243 uint8_t assert_mask
[2]; /* byte 16 */
244 uint8_t deassert_mask
[2];
245 uint8_t discrete_mask
[2];
246 uint8_t sensor_unit1
;
247 uint8_t sensor_unit2
;
248 uint8_t sensor_unit3
;
249 uint8_t sensor_direction
[2]; /* byte 24 */
250 uint8_t positive_threshold
;
251 uint8_t negative_threshold
;
254 uint8_t id_str_len
; /* byte 32 */
255 uint8_t id_string
[16];
258 typedef uint8_t ipmi_sdr_compact_buffer
[sizeof(struct ipmi_sdr_compact
)];
260 int ipmi_bmc_sdr_find(IPMIBmc
*b
, uint16_t recid
,
261 const struct ipmi_sdr_compact
**sdr
, uint16_t *nextrec
);
262 void ipmi_bmc_gen_event(IPMIBmc
*b
, uint8_t *evt
, bool log
);