ipmivar.h revision 1.4
1 /* $NetBSD: ipmivar.h,v 1.4 2024/12/03 19:55:33 riastradh Exp $ */ 2 3 /* 4 * Copyright (c) 2005 Jordan Hargrave 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR 20 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 * 28 */ 29 30 #include <sys/mutex.h> 31 #include <sys/condvar.h> 32 33 #include <dev/sysmon/sysmonvar.h> 34 35 #ifndef _IPMIVAR_H_ 36 #define _IPMIVAR_H_ 37 38 #define IPMI_IF_KCS 1 39 #define IPMI_IF_SMIC 2 40 #define IPMI_IF_BT 3 41 #define IPMI_IF_SSIF 4 42 43 #define IPMI_IF_KCS_NREGS 2 44 #define IPMI_IF_SMIC_NREGS 3 45 #define IPMI_IF_BT_NREGS 3 46 #define IPMI_IF_SSIF_NREGS 2 47 48 struct ipmi_thread; 49 struct ipmi_softc; 50 51 struct ipmi_attach_args { 52 bus_space_tag_t iaa_iot; 53 bus_space_tag_t iaa_memt; 54 55 int iaa_if_type; 56 int iaa_if_rev; 57 int iaa_if_iotype; 58 bus_addr_t iaa_if_iobase; 59 int iaa_if_iospacing; 60 int iaa_if_irq; 61 int iaa_if_irqlvl; 62 }; 63 64 struct ipmi_if { 65 const char *name; 66 int nregs; 67 void *(*buildmsg)(struct ipmi_softc *, int, int, int, 68 const void *, int *); 69 int (*sendmsg)(struct ipmi_softc *, int, const uint8_t *); 70 int (*recvmsg)(struct ipmi_softc *, int, int *, uint8_t *); 71 int (*reset)(struct ipmi_softc *); 72 int (*probe)(struct ipmi_softc *); 73 }; 74 75 struct ipmi_softc { 76 device_t sc_dev; 77 78 struct ipmi_if *sc_if; /* Interface layer */ 79 int sc_if_iospacing; /* Spacing of I/O ports */ 80 int sc_if_rev; /* IPMI Revision */ 81 struct ipmi_attach_args sc_ia; 82 83 void *sc_ih; /* Interrupt/IO handles */ 84 bus_space_tag_t sc_iot; 85 bus_space_handle_t sc_ioh; 86 87 int sc_btseq; 88 89 struct lwp *sc_kthread; 90 91 int sc_max_retries; 92 93 kmutex_t sc_poll_mtx; 94 kcondvar_t sc_poll_cv; 95 kcondvar_t sc_mode_cv; 96 97 kmutex_t sc_cmd_mtx; 98 kmutex_t sc_sleep_mtx; 99 kcondvar_t sc_cmd_sleep; 100 101 struct ipmi_bmc_args *sc_iowait_args; 102 103 struct ipmi_sensor *current_sensor; 104 bool sc_thread_running; 105 bool sc_thread_ready; 106 bool sc_tickle_due; 107 struct sysmon_wdog sc_wdog; 108 struct sysmon_envsys *sc_envsys; 109 envsys_data_t *sc_sensor; 110 int sc_nsensors; /* total number of sensors */ 111 112 char sc_buf[1024 + 3]; /* IPMI_MAX_RX + 3 */ 113 bool sc_buf_rsvd; 114 115 /* request busy */ 116 int sc_mode; 117 #define IPMI_MODE_IDLE 0 118 #define IPMI_MODE_COMMAND 1 119 #define IPMI_MODE_ENVSYS 2 120 bool sc_sent; 121 122 /* dummy */ 123 int sc_address; 124 int sc_lun; 125 126 /* saved from last SEND_COMMAND */ 127 int sc_msgid; 128 int sc_netfn; 129 int sc_cmd; 130 }; 131 132 struct ipmi_device_id { 133 uint8_t deviceid; 134 uint8_t revision; 135 uint8_t fwrev1; 136 uint8_t fwrev2; 137 uint8_t version; 138 uint8_t additional; 139 uint8_t manufacturer[3]; 140 uint8_t product[2]; 141 uint8_t vendor[4]; 142 } __packed; 143 144 struct ipmi_thread { 145 struct ipmi_softc *sc; 146 volatile int running; 147 }; 148 149 #define IPMI_WDOG_USE_NOLOG __BIT(7) 150 #define IPMI_WDOG_USE_NOSTOP __BIT(6) 151 #define IPMI_WDOG_USE_RSVD1 __BITS(5, 3) 152 #define IPMI_WDOG_USE_USE_MASK __BITS(2, 0) 153 #define IPMI_WDOG_USE_USE_RSVD __SHIFTIN(0, IPMI_WDOG_USE_USE_MASK); 154 #define IPMI_WDOG_USE_USE_FRB2 __SHIFTIN(1, IPMI_WDOG_USE_USE_MASK); 155 #define IPMI_WDOG_USE_USE_POST __SHIFTIN(2, IPMI_WDOG_USE_USE_MASK); 156 #define IPMI_WDOG_USE_USE_OSLOAD __SHIFTIN(3, IPMI_WDOG_USE_USE_MASK); 157 #define IPMI_WDOG_USE_USE_OS __SHIFTIN(4, IPMI_WDOG_USE_USE_MASK); 158 #define IPMI_WDOG_USE_USE_OEM __SHIFTIN(5, IPMI_WDOG_USE_USE_MASK); 159 160 #define IPMI_WDOG_ACT_PRE_RSVD1 __BIT(7) 161 #define IPMI_WDOG_ACT_PRE_MASK __BITS(6, 4) 162 #define IPMI_WDOG_ACT_PRE_DISABLED __SHIFTIN(0, IPMI_WDOG_ACT_MASK) 163 #define IPMI_WDOG_ACT_PRE_SMI __SHIFTIN(1, IPMI_WDOG_ACT_MASK) 164 #define IPMI_WDOG_ACT_PRE_NMI __SHIFTIN(2, IPMI_WDOG_ACT_MASK) 165 #define IPMI_WDOG_ACT_PRE_INTERRUPT __SHIFTIN(3, IPMI_WDOG_ACT_MASK) 166 #define IPMI_WDOG_ACT_PRE_RSVD0 __BIT(3) 167 #define IPMI_WDOG_ACT_MASK __BITS(2, 0) 168 #define IPMI_WDOG_ACT_DISABLED __SHIFTIN(0, IPMI_WDOG_ACT_MASK) 169 #define IPMI_WDOG_ACT_RESET __SHIFTIN(1, IPMI_WDOG_ACT_MASK) 170 #define IPMI_WDOG_ACT_PWROFF __SHIFTIN(2, IPMI_WDOG_ACT_MASK) 171 #define IPMI_WDOG_ACT_PWRCYCLE __SHIFTIN(3, IPMI_WDOG_ACT_MASK) 172 173 #define IPMI_WDOG_FLAGS_RSVD1 __BITS(7, 6) 174 #define IPMI_WDOG_FLAGS_OEM __BIT(5) 175 #define IPMI_WDOG_FLAGS_OS __BIT(4) 176 #define IPMI_WDOG_FLAGS_OSLOAD __BIT(3) 177 #define IPMI_WDOG_FLAGS_POST __BIT(2) 178 #define IPMI_WDOG_FLAGS_FRB2 __BIT(1) 179 #define IPMI_WDOG_FLAGS_RSVD0 __BIT(0) 180 181 struct ipmi_set_watchdog { 182 uint8_t wdog_use; 183 uint8_t wdog_action; 184 uint8_t wdog_pretimeout; 185 uint8_t wdog_flags; 186 uint16_t wdog_timeout; 187 } __packed; 188 189 struct ipmi_get_watchdog { 190 uint8_t wdog_use; 191 uint8_t wdog_action; 192 uint8_t wdog_pretimeout; 193 uint8_t wdog_flags; 194 uint16_t wdog_timeout; 195 uint16_t wdog_countdown; 196 } __packed; 197 198 struct dmd_ipmi { 199 uint8_t dmd_sig[4]; /* Signature 'IPMI' */ 200 uint8_t dmd_i2c_address; /* Address of BMC */ 201 uint8_t dmd_nvram_address; /* Address of NVRAM */ 202 uint8_t dmd_if_type; /* IPMI Interface Type */ 203 uint8_t dmd_if_rev; /* IPMI Interface Revision */ 204 } __packed; 205 206 #define APP_NETFN 0x06 207 #define APP_GET_DEVICE_ID 0x01 208 #define APP_RESET_WATCHDOG 0x22 209 #define APP_SET_WATCHDOG_TIMER 0x24 210 #define APP_GET_WATCHDOG_TIMER 0x25 211 212 #define TRANSPORT_NETFN 0xC 213 #define BRIDGE_NETFN 0x2 214 215 #define STORAGE_NETFN 0x0A 216 #define STORAGE_GET_FRU_INV_AREA 0x10 217 #define STORAGE_READ_FRU_DATA 0x11 218 #define STORAGE_RESERVE_SDR 0x22 219 #define STORAGE_GET_SDR 0x23 220 #define STORAGE_ADD_SDR 0x24 221 #define STORAGE_ADD_PARTIAL_SDR 0x25 222 #define STORAGE_DELETE_SDR 0x26 223 #define STORAGE_RESERVE_SEL 0x42 224 #define STORAGE_GET_SEL 0x43 225 #define STORAGE_ADD_SEL 0x44 226 #define STORAGE_ADD_PARTIAL_SEL 0x45 227 #define STORAGE_DELETE_SEL 0x46 228 229 #define SE_NETFN 0x04 230 #define SE_GET_SDR_INFO 0x20 231 #define SE_GET_SDR 0x21 232 #define SE_RESERVE_SDR 0x22 233 #define SE_GET_SENSOR_FACTOR 0x23 234 #define SE_SET_SENSOR_HYSTERESIS 0x24 235 #define SE_GET_SENSOR_HYSTERESIS 0x25 236 #define SE_SET_SENSOR_THRESHOLD 0x26 237 #define SE_GET_SENSOR_THRESHOLD 0x27 238 #define SE_SET_SENSOR_EVENT_ENABLE 0x28 239 #define SE_GET_SENSOR_EVENT_ENABLE 0x29 240 #define SE_REARM_SENSOR_EVENTS 0x2A 241 #define SE_GET_SENSOR_EVENT_STATUS 0x2B 242 #define SE_GET_SENSOR_READING 0x2D 243 #define SE_SET_SENSOR_TYPE 0x2E 244 #define SE_GET_SENSOR_TYPE 0x2F 245 246 struct sdrhdr { 247 uint16_t record_id; /* SDR Record ID */ 248 uint8_t sdr_version; /* SDR Version */ 249 uint8_t record_type; /* SDR Record Type */ 250 uint8_t record_length; /* SDR Record Length */ 251 } __packed; 252 253 /* SDR: Record Type 1 */ 254 struct sdrtype1 { 255 struct sdrhdr sdrhdr; 256 257 uint8_t owner_id; 258 uint8_t owner_lun; 259 uint8_t sensor_num; 260 261 uint8_t entity_id; 262 uint8_t entity_instance; 263 uint8_t sensor_init; 264 uint8_t sensor_caps; 265 uint8_t sensor_type; 266 uint8_t event_code; 267 uint16_t trigger_mask; 268 uint16_t reading_mask; 269 uint16_t settable_mask; 270 uint8_t units1; 271 uint8_t units2; 272 uint8_t units3; 273 uint8_t linear; 274 uint8_t m; 275 uint8_t m_tolerance; 276 uint8_t b; 277 uint8_t b_accuracy; 278 uint8_t accuracyexp; 279 uint8_t rbexp; 280 uint8_t analogchars; 281 uint8_t nominalreading; 282 uint8_t normalmax; 283 uint8_t normalmin; 284 uint8_t sensormax; 285 uint8_t sensormin; 286 uint8_t uppernr; 287 uint8_t upperc; 288 uint8_t uppernc; 289 uint8_t lowernr; 290 uint8_t lowerc; 291 uint8_t lowernc; 292 uint8_t physt; 293 uint8_t nhyst; 294 uint8_t resvd[2]; 295 uint8_t oem; 296 uint8_t typelen; 297 uint8_t name[1]; 298 } __packed; 299 300 /* SDR: Record Type 2 */ 301 struct sdrtype2 { 302 struct sdrhdr sdrhdr; 303 304 uint8_t owner_id; 305 uint8_t owner_lun; 306 uint8_t sensor_num; 307 308 uint8_t entity_id; 309 uint8_t entity_instance; 310 uint8_t sensor_init; 311 uint8_t sensor_caps; 312 uint8_t sensor_type; 313 uint8_t event_code; 314 uint16_t trigger_mask; 315 uint16_t reading_mask; 316 uint16_t set_mask; 317 uint8_t units1; 318 uint8_t units2; 319 uint8_t units3; 320 uint8_t share1; 321 uint8_t share2; 322 uint8_t physt; 323 uint8_t nhyst; 324 uint8_t resvd[3]; 325 uint8_t oem; 326 uint8_t typelen; 327 uint8_t name[1]; 328 } __packed; 329 330 #endif /* _IPMIVAR_H_ */ 331
Indexes created Mon Sep 29 21:09:56 GMT 2025