1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 22 /* 23 * Copyright 2015 OmniTI Computer Consulting, Inc. All rights reserved. 24 * Copyright (c) 2018, Joyent, Inc. 25 * Copyright 2022 Oxide Computer Company 26 * Copyright 2010 Sun Microsystems, Inc. All rights reserved. 27 * Use is subject to license terms. 28 */ 29 30 /* 31 * This header file defines the implementation structures for the SMBIOS access 32 * library, libsmbios, and an equivalent kernel module. Clients should use 33 * the <smbios.h> or <sys/smbios.h> header files to access DMTF SMBIOS 34 * information, NOT these underlying implementation structures from the spec. 35 * In short, do not user this header file or these routines for any purpose. 36 */ 37 38 #ifndef _SYS_SMBIOS_IMPL_H 39 #define _SYS_SMBIOS_IMPL_H 40 41 #include <sys/smbios.h> 42 #include <sys/sysmacros.h> 43 44 #ifdef _KERNEL 45 #include <sys/systm.h> 46 #else 47 #include <strings.h> 48 #include <stddef.h> 49 #endif 50 51 #ifdef __cplusplus 52 extern "C" { 53 #endif 54 55 /* 56 * Definitions required to interpret the BIOS type information. 57 */ 58 #define SMB_BIOSXB_EXTROM 6 59 60 #define SMB_BIOS_EXTROM_VALUE_MASK(x) ((x) & 0x3fff) 61 #define SMB_BIOS_EXTROM_SHIFT_MASK(x) (((x) & 0xc000) >> 14) 62 63 #pragma pack(1) 64 65 typedef struct smb_header { 66 uint8_t smbh_type; /* structure type (SMB_TYPE_* value) */ 67 uint8_t smbh_len; /* length in bytes of formatted area */ 68 uint16_t smbh_hdl; /* structure handle */ 69 } smb_header_t; 70 71 /* 72 * SMBIOS implementation structure for SMB_TYPE_BIOS. 73 */ 74 typedef struct smb_bios { 75 smb_header_t smbbi_hdr; /* structure header */ 76 uint8_t smbbi_vendor; /* bios vendor string */ 77 uint8_t smbbi_version; /* bios version string */ 78 uint16_t smbbi_segment; /* segment location of bios address */ 79 uint8_t smbbi_reldate; /* bios release date */ 80 uint8_t smbbi_romsize; /* bios rom size (64k * (n + 1)) */ 81 uint64_t smbbi_cflags; /* bios characteristics */ 82 uint8_t smbbi_xcflags[1]; /* bios characteristics extensions */ 83 } smb_bios_t; 84 85 /* 86 * SMBIOS implementation structure for SMB_TYPE_SYSTEM. 87 */ 88 typedef struct smb_system { 89 smb_header_t smbsi_hdr; /* structure header */ 90 uint8_t smbsi_manufacturer; /* manufacturer */ 91 uint8_t smbsi_product; /* product name */ 92 uint8_t smbsi_version; /* version */ 93 uint8_t smbsi_serial; /* serial number */ 94 uint8_t smbsi_uuid[16]; /* UUID */ 95 uint8_t smbsi_wakeup; /* wake-up type */ 96 uint8_t smbsi_sku; /* SKU number */ 97 uint8_t smbsi_family; /* family */ 98 } smb_system_t; 99 100 /* 101 * SMBIOS implementation structure for SMB_TYPE_BASEBOARD. 102 */ 103 typedef struct smb_bboard { 104 smb_header_t smbbb_hdr; /* structure header */ 105 uint8_t smbbb_manufacturer; /* manufacturer */ 106 uint8_t smbbb_product; /* product name */ 107 uint8_t smbbb_version; /* version */ 108 uint8_t smbbb_serial; /* serial number */ 109 uint8_t smbbb_asset; /* asset tag */ 110 uint8_t smbbb_flags; /* feature flags */ 111 uint8_t smbbb_location; /* location in chassis */ 112 uint16_t smbbb_chassis; /* chassis handle */ 113 uint8_t smbbb_type; /* board type */ 114 uint8_t smbbb_cn; /* number of contained handles */ 115 uint16_t smbbb_cv[1]; /* array of contained handles */ 116 } smb_bboard_t; 117 118 /* 119 * SMBIOS implementation structure for SMB_TYPE_CHASSIS. 120 */ 121 typedef struct smb_chassis { 122 smb_header_t smbch_hdr; /* structure header */ 123 uint8_t smbch_manufacturer; /* manufacturer */ 124 uint8_t smbch_type; /* type */ 125 uint8_t smbch_version; /* version */ 126 uint8_t smbch_serial; /* serial number */ 127 uint8_t smbch_asset; /* asset tag */ 128 uint8_t smbch_bustate; /* boot-up state */ 129 uint8_t smbch_psstate; /* power supply state */ 130 uint8_t smbch_thstate; /* thermal state */ 131 uint8_t smbch_security; /* security state */ 132 uint32_t smbch_oemdata; /* OEM-specific data */ 133 uint8_t smbch_uheight; /* enclosure height */ 134 uint8_t smbch_cords; /* number of power cords */ 135 uint8_t smbch_cn; /* number of contained records */ 136 uint8_t smbch_cm; /* size of contained records */ 137 uint8_t smbch_cv[]; /* array of contained records */ 138 } smb_chassis_t; 139 140 #define SMB_CHT_LOCK 0x80 /* lock bit within smbch_type */ 141 142 typedef struct smb_chassis_entry { 143 uint8_t smbce_type; /* Containing Element and Type */ 144 uint8_t smbce_min; /* minimum number of elt */ 145 uint8_t smbce_max; /* minimum number of elt */ 146 } smb_chassis_entry_t; 147 148 #define SMB_CHE_TYPE_IS_SMB(x) (((x) & 0x80) == 0x80) 149 #define SMB_CHE_TYPE_TYPE(x) (((x) & 0x7f)) 150 151 /* 152 * SMBIOS implementation structure for SMB_TYPE_PROCESSOR. 153 */ 154 typedef struct smb_processor { 155 smb_header_t smbpr_hdr; /* structure header */ 156 uint8_t smbpr_socket; /* socket designation */ 157 uint8_t smbpr_type; /* processor type (see <smbios.h>) */ 158 uint8_t smbpr_family; /* processor family (see <smbios.h>) */ 159 uint8_t smbpr_manufacturer; /* manufacturer */ 160 uint64_t smbpr_cpuid; /* processor cpuid information */ 161 uint8_t smbpr_version; /* version */ 162 uint8_t smbpr_voltage; /* voltage */ 163 uint16_t smbpr_clkspeed; /* external clock speed in MHz */ 164 uint16_t smbpr_maxspeed; /* maximum speed in MHz */ 165 uint16_t smbpr_curspeed; /* current speed in MHz */ 166 uint8_t smbpr_status; /* status (see <smbios.h>) */ 167 uint8_t smbpr_upgrade; /* upgrade */ 168 uint16_t smbpr_l1cache; /* L1 cache handle (if any) */ 169 uint16_t smbpr_l2cache; /* L2 cache handle (if any) */ 170 uint16_t smbpr_l3cache; /* L3 cache handle (if any) */ 171 uint8_t smbpr_serial; /* serial number */ 172 uint8_t smbpr_asset; /* asset tag */ 173 uint8_t smbpr_part; /* part number */ 174 uint8_t smbpr_corecount; /* number of cores per socket */ 175 uint8_t smbpr_coresenabled; /* number of enabled cores per socket */ 176 uint8_t smbpr_threadcount; /* number of threads per socket */ 177 uint16_t smbpr_cflags; /* cpu characteristics (see <smbios.h>) */ 178 uint16_t smbpr_family2; /* processor family2 (see <smbios.h>) */ 179 uint16_t smbpr_corecount2; /* second number of cores per socket */ 180 uint16_t smbpr_coresenabled2; /* second number of enabled cores */ 181 uint16_t smbpr_threadcount2; /* second number of enabled threads */ 182 uint16_t smpbr_threaden; /* enabled thread count */ 183 } smb_processor_t; 184 185 /* 186 * SMBIOS implementation structure for SMB_TYPE_CACHE. 187 */ 188 typedef struct smb_cache { 189 smb_header_t smbca_hdr; /* structure header */ 190 uint8_t smbca_socket; /* socket designation */ 191 uint16_t smbca_config; /* cache configuration */ 192 uint16_t smbca_maxsize; /* maximum installed size */ 193 uint16_t smbca_size; /* installed size */ 194 uint16_t smbca_stype; /* supported SRAM type */ 195 uint16_t smbca_ctype; /* current SRAM type */ 196 uint8_t smbca_speed; /* speed in nanoseconds */ 197 uint8_t smbca_etype; /* error correction type */ 198 uint8_t smbca_ltype; /* logical cache type */ 199 uint8_t smbca_assoc; /* associativity */ 200 uint32_t smbca_maxsize2; /* maximum installed size 2 */ 201 uint32_t smbca_size2; /* installed size 2 */ 202 } smb_cache_t; 203 204 /* 205 * Convert encoded cache size to bytes: DSP0134 Section 7.8 explains the 206 * encoding. The highest bit is 0 for 1k units, 1 for 64k units, and this 207 * macro decodes the value into bytes for exporting to our clients. 208 */ 209 #define SMB_CACHE_SIZE(s) (((s) & 0x8000) ? \ 210 ((uint32_t)((s) & 0x7FFF) * 64 * 1024) : ((uint32_t)(s) * 1024)) 211 212 #define SMB_CACHE_EXT_SIZE(s) (((s) & 0x80000000U) ? \ 213 ((uint64_t)((s) & 0x7FFFFFFFULL) * 64ULL * 1024ULL) : \ 214 ((uint64_t)(s) * 1024ULL)) 215 216 #define SMB_CACHE_CFG_MODE(c) (((c) >> 8) & 3) 217 #define SMB_CACHE_CFG_ENABLED(c) (((c) >> 7) & 1) 218 #define SMB_CACHE_CFG_LOCATION(c) (((c) >> 5) & 3) 219 #define SMB_CACHE_CFG_SOCKETED(c) (((c) >> 3) & 1) 220 #define SMB_CACHE_CFG_LEVEL(c) (((c) & 7) + 1) 221 222 /* 223 * SMBIOS implementation structure for SMB_TYPE_PORT. 224 */ 225 typedef struct smb_port { 226 smb_header_t smbpo_hdr; /* structure header */ 227 uint8_t smbpo_iref; /* internal reference designator */ 228 uint8_t smbpo_itype; /* internal connector type */ 229 uint8_t smbpo_eref; /* external reference designator */ 230 uint8_t smbpo_etype; /* external connector type */ 231 uint8_t smbpo_ptype; /* port type */ 232 } smb_port_t; 233 234 /* 235 * SMBIOS implementation structure for SMB_TYPE_SLOT. 236 */ 237 typedef struct smb_slot_peer { 238 uint16_t smbspb_group_no; /* segment group number */ 239 uint8_t smbspb_bus; /* bus number */ 240 uint8_t smbspb_df; /* device/function number */ 241 uint8_t smbspb_width; /* electrical width */ 242 } smb_slot_peer_t; 243 244 typedef struct smb_slot { 245 smb_header_t smbsl_hdr; /* structure header */ 246 uint8_t smbsl_name; /* reference designation */ 247 uint8_t smbsl_type; /* slot type */ 248 uint8_t smbsl_width; /* slot data bus width */ 249 uint8_t smbsl_usage; /* current usage */ 250 uint8_t smbsl_length; /* slot length */ 251 uint16_t smbsl_id; /* slot ID */ 252 uint8_t smbsl_ch1; /* slot characteristics 1 */ 253 uint8_t smbsl_ch2; /* slot characteristics 2 */ 254 uint16_t smbsl_sg; /* segment group number */ 255 uint8_t smbsl_bus; /* bus number */ 256 uint8_t smbsl_df; /* device/function number */ 257 /* Added in SMBIOS 3.2+ */ 258 uint8_t smbsl_dbw; /* Data bus width */ 259 uint8_t smbsl_npeers; /* Peer bdf groups */ 260 smb_slot_peer_t smbsl_peers[]; /* bifurcation peers */ 261 /* There are later additions in 3.4+, see smbios_slot_cont_t */ 262 } smb_slot_t; 263 264 /* 265 * After the variable number of smbsl_peers, the smbios_slot has continued in 266 * size and has the following members defined as of version 3.4. These occur 267 * starting at byte 14 + 5 * smbsl_npeers. 268 */ 269 typedef struct smb_slot_cont { 270 uint8_t smbsl_info; /* slot info */ 271 uint8_t smbsl_pwidth; /* slot physical width */ 272 uint16_t smbsl_pitch; /* slot pitch */ 273 /* Added in SMBIOS 3.5 */ 274 uint8_t smbsl_height; /* slot height */ 275 } smb_slot_cont_t; 276 277 /* 278 * The first byte that the smb_slot_cont_t is defined to start at. Note, this 279 * was originally indicated to be 0x14 in the SMBIOS 3.4 specification. This has 280 * been noted as an errata. Right now we assume that most things have the 281 * updated behavior in SMBIOS 3.5. However, if we encounter things in the wild 282 * that have the other offset then we will need to condition this on 3.4. 283 */ 284 #define SMB_SLOT_CONT_START 0x13 285 286 /* 287 * SMBIOS implementation structure for SMB_TYPE_OBDEVS. 288 */ 289 typedef struct smb_obdev { 290 uint8_t smbob_type; /* encoded type and enable bit */ 291 uint8_t smbob_name; /* description string */ 292 } smb_obdev_t; 293 294 #define SMB_OBT_ENABLED 0x80 /* enable bit within smbob_type */ 295 296 /* 297 * SMBIOS implementation structure for SMB_TYPE_OEMSTR, SMB_TYPE_SYSCONFSTR, 298 * and SMB_TYPE_LANG. 299 */ 300 typedef struct smb_strtab { 301 smb_header_t smbtb_hdr; /* structure header */ 302 uint8_t smbtb_count; /* number of strings */ 303 } smb_strtab_t; 304 305 /* 306 * SMBIOS implementation structure for SMB_TYPE_LANG. 307 */ 308 typedef struct smb_lang { 309 smb_header_t smblang_hdr; /* structure header */ 310 uint8_t smblang_num; /* number of installed languages */ 311 uint8_t smblang_flags; /* flags */ 312 uint8_t smblang_resv[15]; /* reserved for future use */ 313 uint8_t smblang_cur; /* current language string */ 314 } smb_lang_t; 315 316 /* 317 * SMBIOS implementation structure for SMB_TYPE_EVENTLOG. 318 */ 319 typedef struct smb_sel { 320 smb_header_t smbsel_hdr; /* structure header */ 321 uint16_t smbsel_len; /* log area length */ 322 uint16_t smbsel_hdroff; /* header offset */ 323 uint16_t smbsel_dataoff; /* data offset */ 324 uint8_t smbsel_method; /* access method */ 325 uint8_t smbsel_status; /* status flags */ 326 uint32_t smbsel_token; /* change token */ 327 uint32_t smbsel_addr; /* access method address */ 328 uint8_t smbsel_format; /* header format */ 329 uint8_t smbsel_typec; /* number of type descriptors */ 330 uint8_t smbsel_typesz; /* size of each type descriptor */ 331 uint8_t smbsel_typev[1]; /* array of type descriptors */ 332 } smb_sel_t; 333 334 /* 335 * SMBIOS implementation structure for SMB_TYPE_MEMARRAY. 336 */ 337 typedef struct smb_memarray { 338 smb_header_t smbmarr_hdr; /* structure header */ 339 uint8_t smbmarr_loc; /* location */ 340 uint8_t smbmarr_use; /* use */ 341 uint8_t smbmarr_ecc; /* error detect/correct mechanism */ 342 uint32_t smbmarr_cap; /* maximum capacity */ 343 uint16_t smbmarr_err; /* error handle */ 344 uint16_t smbmarr_ndevs; /* number of slots or sockets */ 345 uint64_t smbmarr_extcap; /* extended maximum capacity */ 346 } smb_memarray_t; 347 348 /* 349 * SMBIOS implementation structure for SMB_TYPE_MEMARRAYMAP. 350 */ 351 typedef struct smb_memarrmap { 352 smb_header_t smbamap_hdr; /* structure header */ 353 uint32_t smbamap_start; /* starting address in kilobytes */ 354 uint32_t smbamap_end; /* ending address in kilobytes */ 355 uint16_t smbamap_array; /* physical memory array handle */ 356 uint8_t smbamap_width; /* partition width */ 357 uint64_t smbamap_extstart; /* extended starting address in bytes */ 358 uint64_t smbamap_extend; /* extended ending address in bytes */ 359 } smb_memarrmap_t; 360 361 /* 362 * SMBIOS implementation structure for SMB_TYPE_MEMDEVICE. 363 */ 364 typedef struct smb_memdevice { 365 smb_header_t smbmdev_hdr; /* structure header */ 366 uint16_t smbmdev_array; /* array handle */ 367 uint16_t smbmdev_error; /* error handle */ 368 uint16_t smbmdev_twidth; /* total width */ 369 uint16_t smbmdev_dwidth; /* data width */ 370 uint16_t smbmdev_size; /* size in either K or MB */ 371 uint8_t smbmdev_form; /* form factor */ 372 uint8_t smbmdev_set; /* device set */ 373 uint8_t smbmdev_dloc; /* device locator */ 374 uint8_t smbmdev_bloc; /* bank locator */ 375 uint8_t smbmdev_type; /* memory type */ 376 uint16_t smbmdev_flags; /* detail flags */ 377 uint16_t smbmdev_speed; /* speed in MT/s */ 378 uint8_t smbmdev_manufacturer; /* manufacturer */ 379 uint8_t smbmdev_serial; /* serial number */ 380 uint8_t smbmdev_asset; /* asset tag */ 381 uint8_t smbmdev_part; /* part number */ 382 uint8_t smbmdev_attrs; /* attributes */ 383 uint32_t smbmdev_extsize; /* extended size */ 384 uint16_t smbmdev_clkspeed; /* configured clock speed */ 385 uint16_t smbmdev_minvolt; /* minimum voltage */ 386 uint16_t smbmdev_maxvolt; /* maximum voltage */ 387 uint16_t smbmdev_confvolt; /* configured voltage */ 388 /* Added in SMBIOS 3.2 */ 389 uint8_t smbmdev_memtech; /* memory technology */ 390 uint16_t smbmdev_opmode; /* memory operating mode capability */ 391 uint8_t smbmdev_fwver; /* firmware version */ 392 uint16_t smbmdev_modulemfgid; /* module manufacturer ID */ 393 uint16_t smbmdev_moduleprodid; /* module product ID */ 394 uint16_t smbmdev_memsysmfgid; /* memory controller manufacturer id */ 395 uint16_t smbmdev_memsysprodid; /* memory controller product id */ 396 uint64_t smbmdev_nvsize; /* non-volatile memory size */ 397 uint64_t smbmdev_volsize; /* volatile memory size */ 398 uint64_t smbmdev_cachesize; /* cache size */ 399 uint64_t smbmdev_logicalsize; /* logical size */ 400 /* Added in SMBIOS 3.3 */ 401 uint32_t smbmdev_extspeed; /* Extended device speed */ 402 uint32_t smbmdev_extclkspeed; /* Extended clock speed */ 403 } smb_memdevice_t; 404 405 #define SMB_MDS_KBYTES 0x8000 /* size in specified in kilobytes */ 406 407 /* 408 * SMBIOS implementation structure for SMB_TYPE_MEMDEVICEMAP. 409 */ 410 typedef struct smb_memdevmap { 411 smb_header_t smbdmap_hdr; /* structure header */ 412 uint32_t smbdmap_start; /* starting address in kilobytes */ 413 uint32_t smbdmap_end; /* ending address in kilobytes */ 414 uint16_t smbdmap_device; /* memory device handle */ 415 uint16_t smbdmap_array; /* memory array mapped address handle */ 416 uint8_t smbdmap_rpos; /* row position */ 417 uint8_t smbdmap_ipos; /* interleave position */ 418 uint8_t smbdmap_idepth; /* interleave depth */ 419 uint64_t smbdmap_extstart; /* extended starting address */ 420 uint64_t smbdmap_extend; /* extended ending address */ 421 } smb_memdevmap_t; 422 423 typedef struct smb_pointdev { 424 smb_header_t smbpdev_hdr; /* structure header */ 425 uint8_t smbpdev_type; /* device type */ 426 uint8_t smbpdev_iface; /* device interface */ 427 uint8_t smbpdev_nbuttons; /* number of buttons */ 428 } smb_pointdev_t; 429 430 /* 431 * SMBIOS implementation structure for SMB_TYPE_BATTERY. 432 */ 433 typedef struct smb_battery { 434 smb_header_t smbbat_hdr; /* structure header */ 435 uint8_t smbbat_loc; /* location */ 436 uint8_t smbbat_manufacturer; /* manufacturer */ 437 uint8_t smbbat_date; /* manufacture date */ 438 uint8_t smbbat_serial; /* serial number */ 439 uint8_t smbbat_devname; /* device name */ 440 uint8_t smbbat_chem; /* device chemistry */ 441 uint16_t smbbat_cap; /* design capacity in mW hours */ 442 uint16_t smbbat_volt; /* design voltage in mV */ 443 uint8_t smbbat_version; /* SBDS version string */ 444 uint8_t smbbat_err; /* error percentage */ 445 uint16_t smbbat_ssn; /* SBDS serial number */ 446 uint16_t smbbat_sdate; /* SBDS manufacture date */ 447 uint8_t smbbat_schem; /* SBDS chemistry string */ 448 uint8_t smbbat_mult; /* design capacity multiplier */ 449 uint32_t smbbat_oemdata; /* OEM-specific data */ 450 } smb_battery_t; 451 452 /* 453 * SMBIOS implementation structure for SMB_TYPE_SECURITY. 454 */ 455 typedef struct smb_hwsec { 456 smb_header_t smbhs_hdr; /* structure header */ 457 uint8_t smbhs_settings; /* settings byte */ 458 } smb_hwsec_t; 459 460 #define SMB_HWS_PWR_PS(x) (((x) & 0xC0) >> 6) 461 #define SMB_HWS_KBD_PS(x) (((x) & 0x30) >> 4) 462 #define SMB_HWS_ADM_PS(x) (((x) & 0x0C) >> 2) 463 #define SMB_HWS_PAN_PS(x) (((x) & 0x03) >> 0) 464 465 /* 466 * SMBIOS implementation structure for SMB_TYPE_VPROBE. 467 */ 468 typedef struct smb_vprobe { 469 smb_header_t smbvpr_hdr; /* structure header */ 470 uint8_t smbvpr_descr; /* description string */ 471 uint8_t smbvpr_locstat; /* location and status */ 472 uint16_t smbvpr_maxval; /* maximum voltage */ 473 uint16_t smbvpr_minval; /* minimum voltage */ 474 uint16_t smbvpr_resolution; /* probe resolution */ 475 uint16_t smbvpr_tolerance; /* probe tolerance */ 476 uint16_t smbvpr_accuracy; /* probe accuracy */ 477 uint32_t smbvpr_oem; /* vendor-specific data */ 478 uint16_t smbvpr_nominal; /* nominal value */ 479 } smb_vprobe_t; 480 481 #define SMB_VPROBE_MINLEN 0x14 482 #define SMB_VPROBE_NOMINAL_MINLEN 0x16 483 484 #define SMB_VPROBE_LOCATION(x) ((x) & 0x1f) 485 #define SMB_VPROBE_STATUS(x) (((x) >> 5) & 0x7) 486 487 /* 488 * SMBIOS implementation structure for SMB_TYPE_COOLDEV. 489 */ 490 typedef struct smb_cooldev { 491 smb_header_t smbcdev_hdr; /* structure header */ 492 uint16_t smbcdev_tprobe; /* temperature probe */ 493 uint8_t smbcdev_typstat; /* type and status */ 494 uint8_t smbcdev_group; /* group identifier */ 495 uint32_t smbcdev_oem; /* vendor-specific data */ 496 uint16_t smbcdev_nominal; /* nominal value */ 497 uint8_t smbcdev_descr; /* description string */ 498 } smb_cooldev_t; 499 500 #define SMB_COOLDEV_MINLEN 0x0c 501 #define SMB_COOLDEV_NOMINAL_MINLEN 0x0e 502 #define SMB_COOLDEV_DESCR_MINLEN 0x0f 503 504 #define SMB_COOLDEV_TYPE(x) ((x) & 0x1f) 505 #define SMB_COOLDEV_STATUS(x) (((x) >> 5) & 0x7) 506 507 /* 508 * SMBIOS implementation structure for SMB_TYPE_TPROBE. 509 */ 510 typedef struct smb_tprobe { 511 smb_header_t smbtpr_hdr; /* structure header */ 512 uint8_t smbtpr_descr; /* description string */ 513 uint8_t smbtpr_locstat; /* location and status */ 514 uint16_t smbtpr_maxval; /* maximum temperature */ 515 uint16_t smbtpr_minval; /* minimum temperature */ 516 uint16_t smbtpr_resolution; /* probe resolution */ 517 uint16_t smbtpr_tolerance; /* probe tolerance */ 518 uint16_t smbtpr_accuracy; /* probe accuracy */ 519 uint32_t smbtpr_oem; /* vendor-specific data */ 520 uint16_t smbtpr_nominal; /* nominal value */ 521 } smb_tprobe_t; 522 523 #define SMB_TPROBE_MINLEN 0x14 524 #define SMB_TPROBE_NOMINAL_MINLEN 0x16 525 526 #define SMB_TPROBE_LOCATION(x) ((x) & 0x1f) 527 #define SMB_TPROBE_STATUS(x) (((x) >> 5) & 0x7) 528 529 /* 530 * SMBIOS implementation structure for SMB_TYPE_IPROBE. 531 */ 532 typedef struct smb_iprobe { 533 smb_header_t smbipr_hdr; /* structure header */ 534 uint8_t smbipr_descr; /* description string */ 535 uint8_t smbipr_locstat; /* location and status */ 536 uint16_t smbipr_maxval; /* maximum current */ 537 uint16_t smbipr_minval; /* minimum current */ 538 uint16_t smbipr_resolution; /* probe resolution */ 539 uint16_t smbipr_tolerance; /* probe tolerance */ 540 uint16_t smbipr_accuracy; /* probe accuracy */ 541 uint32_t smbipr_oem; /* vendor-specific data */ 542 uint16_t smbipr_nominal; /* nominal value */ 543 } smb_iprobe_t; 544 545 #define SMB_IPROBE_MINLEN 0x14 546 #define SMB_IPROBE_NOMINAL_MINLEN 0x16 547 548 #define SMB_IPROBE_LOCATION(x) ((x) & 0x1f) 549 #define SMB_IPROBE_STATUS(x) (((x) >> 5) & 0x7) 550 551 /* 552 * SMBIOS implementation structure for SMB_TYPE_BOOT. 553 */ 554 typedef struct smb_boot { 555 smb_header_t smbbo_hdr; /* structure header */ 556 uint8_t smbbo_pad[6]; /* reserved for future use */ 557 uint8_t smbbo_status[1]; /* variable-length status buffer */ 558 } smb_boot_t; 559 560 /* 561 * SMBIOS implementation structure for SMB_TYPE_IPMIDEV. 562 */ 563 typedef struct smb_ipmi { 564 smb_header_t smbipm_hdr; /* structure header */ 565 uint8_t smbipm_type; /* interface type */ 566 uint8_t smbipm_spec; /* specification revision */ 567 uint8_t smbipm_i2c; /* i2C slave address */ 568 uint8_t smbipm_bus; /* NV storage device bus ID */ 569 uint64_t smbipm_addr; /* base address */ 570 uint8_t smbipm_info; /* base address modifier/intr info */ 571 uint8_t smbipm_intr; /* interrupt number */ 572 } smb_ipmi_t; 573 574 #define SMB_IPM_SPEC_MAJOR(x) (((x) & 0xF0) >> 4) 575 #define SMB_IPM_SPEC_MINOR(x) ((x) & 0x0F) 576 577 #define SMB_IPM_ADDR_IO 1ULL 578 579 #define SMB_IPM_INFO_REGS(x) (((x) & 0xC0) >> 6) 580 #define SMB_IPM_INFO_LSB(x) (((x) & 0x10) >> 4) 581 #define SMB_IPM_INFO_ISPEC(x) (((x) & 0x08) >> 3) 582 #define SMB_IPM_INFO_IPOL(x) (((x) & 0x02) >> 1) 583 #define SMB_IPM_INFO_IMODE(x) (((x) & 0x01) >> 0) 584 585 #define SMB_IPM_REGS_1B 0 586 #define SMB_IPM_REGS_4B 1 587 #define SMB_IPM_REGS_16B 2 588 589 #define SMB_IPM_IPOL_LO 0 590 #define SMB_IPM_IPOL_HI 1 591 592 #define SMB_IPM_IMODE_EDGE 0 593 #define SMB_IPM_IMODE_LEVEL 1 594 595 /* 596 * SMBIOS implementation structure for SMB_TYPE_POWERSUP. 597 */ 598 typedef struct smb_powersup { 599 smb_header_t smbpsup_hdr; /* structure header */ 600 uint8_t smbpsup_group; /* group id */ 601 uint8_t smbpsup_loc; /* location tag */ 602 uint8_t smbpsup_devname; /* device name */ 603 uint8_t smbpsup_manufacturer; /* manufacturer */ 604 uint8_t smbpsup_serial; /* serial number */ 605 uint8_t smbpsup_asset; /* asset tag */ 606 uint8_t smbpsup_part; /* part number */ 607 uint8_t smbpsup_rev; /* revision string */ 608 uint16_t smbpsup_max; /* max output in milliwatts */ 609 uint16_t smbpsup_char; /* characteristics */ 610 uint16_t smbpsup_vprobe; /* voltage probe handle */ 611 uint16_t smbpsup_cooldev; /* cooling device handle */ 612 uint16_t smbpsup_iprobe; /* current probe handle */ 613 } smb_powersup_t; 614 615 #define SMB_PSU_CHARS_ISHOT(x) ((x) & 0x01) 616 #define SMB_PSU_CHARS_ISPRES(x) ((x) & 0x02) 617 #define SMB_PSU_CHARS_ISUNPLUG(x) ((x) & 0x04) 618 #define SMB_PSU_CHARS_IVRS(x) (((x) >> 3) & 0xf) 619 #define SMB_PSU_CHARS_STATUS(x) (((x) >> 7) & 0x7) 620 #define SMB_PSU_CHARS_TYPE(x) (((x) >> 10) & 0xf) 621 622 /* 623 * SMBIOS implementation structure for SMB_TYPE_OBDEVEXT. 624 */ 625 typedef struct smb_obdev_ext { 626 smb_header_t smbobe_hdr; /* structure header */ 627 uint8_t smbobe_name; /* reference designation */ 628 uint8_t smbobe_dtype; /* device type */ 629 uint8_t smbobe_dti; /* device type instance */ 630 uint16_t smbobe_sg; /* segment group number */ 631 uint8_t smbobe_bus; /* bus number */ 632 uint8_t smbobe_df; /* device/function number */ 633 } smb_obdev_ext_t; 634 635 /* 636 * SMBIOS implementation structure for SMB_TYPE_PROCESSOR_INFO 637 */ 638 typedef struct smb_processor_info { 639 smb_header_t smbpai_hdr; /* structure handle */ 640 uint16_t smbpai_proc; /* processor handle */ 641 uint8_t smbpai_len; /* length of processor specific data */ 642 uint8_t smbpai_type; /* processor type */ 643 uint8_t smbpai_data[]; /* processor-specific block */ 644 } smb_processor_info_t; 645 646 typedef struct smb_processor_info_riscv { 647 uint16_t smbpairv_vers; /* structure revision */ 648 uint8_t smbpairv_len; /* length of structure */ 649 uint8_t smbpairv_hartid[16]; /* id of the hart */ 650 uint8_t smbpairv_boot; /* boot hart */ 651 uint8_t smbpairv_vendid[16]; /* machine vendor id */ 652 uint8_t smbpairv_archid[16]; /* arch vendor id */ 653 uint8_t smbpairv_machid[16]; /* machine impl id */ 654 uint32_t smbpairv_isa; /* supported ISA */ 655 uint8_t smbpairv_privlvl; /* supported privilege levels */ 656 uint8_t smbpairv_metdi[16]; /* Machine exception trap delegation */ 657 uint8_t smbpairv_mitdi[16]; /* Machine interrupt trap delegation */ 658 uint8_t smbpairv_xlen; /* Register width */ 659 uint8_t smbpairv_mxlen; /* Machine register width */ 660 uint8_t smbpairv_rsvd; /* Reserved */ 661 uint8_t smbpairv_sxlen; /* Supervisor register width */ 662 uint8_t smbpairv_uxlen; /* User register width */ 663 } smb_processor_info_riscv_t; 664 665 /* 666 * SMBIOS implementation structure for SMBIOS_TYPE_FWINFO. 667 */ 668 typedef struct smb_fwinfo { 669 smb_header_t smbfwii_hdr; /* structure handle */ 670 uint8_t smbfwii_name; /* Firmware component name */ 671 uint8_t smbfwii_vers; /* Firmware version */ 672 uint8_t smbfwii_vers_fmt; /* Version format */ 673 uint8_t smbfwii_id; /* Firmware ID */ 674 uint8_t smbfwii_id_fmt; /* Firmware ID format */ 675 uint8_t smbfwii_reldate; /* Release Date */ 676 uint8_t smbfwii_mfg; /* Manufacturer */ 677 uint8_t smbfwii_lsv; /* Lowest supported version */ 678 uint64_t smbfwii_imgsz; /* Image size */ 679 uint16_t smbfwii_chars; /* Characteristics */ 680 uint8_t smbfwii_state; /* State */ 681 uint8_t smbfwii_ncomps; /* Number of associated components */ 682 uint16_t smbfwii_comps[]; /* Variable handles */ 683 } smb_fwinfo_t; 684 685 /* 686 * SMBIOS implementation structure for SMBIOS_TYPE_STRPROP. 687 */ 688 typedef struct smb_strprop { 689 smb_header_t smbstrp_hdr; /* structure handle */ 690 uint16_t smbstrp_prop_id; /* string property ID */ 691 uint8_t smbstrp_prop_val; /* string property value */ 692 uint16_t smbstrp_phdl; /* parent handle */ 693 } smb_strprop_t; 694 695 /* 696 * SMBIOS implementation structure for SUN_OEM_EXT_PROCESSOR. 697 */ 698 typedef struct smb_processor_ext { 699 smb_header_t smbpre_hdr; /* structure header */ 700 uint16_t smbpre_processor; /* processor handle */ 701 uint8_t smbpre_fru; /* FRU indicator */ 702 uint8_t smbpre_n; /* number of APIC IDs */ 703 uint16_t smbpre_apicid[1]; /* strand initial apic id */ 704 } smb_processor_ext_t; 705 706 /* 707 * SMBIOS implementation structure for SUN_OEM_EXT_PORT. 708 */ 709 typedef struct smb_port_ext { 710 smb_header_t smbpoe_hdr; /* structure header */ 711 uint16_t smbpoe_chassis; /* chassis handle */ 712 uint16_t smbpoe_port; /* port connector handle */ 713 uint8_t smbpoe_dtype; /* device type */ 714 uint16_t smbpoe_devhdl; /* device handle */ 715 uint8_t smbpoe_phy; /* PHY number */ 716 } smb_port_ext_t; 717 718 /* 719 * SMBIOS implementation structure for SUN_OEM_PCIEXRC. 720 */ 721 typedef struct smb_pciexrc { 722 smb_header_t smbpciexrc_hdr; /* structure header */ 723 uint16_t smbpciexrc_bboard; /* base board handle */ 724 uint16_t smbpciexrc_bdf; /* PCI Bus/Dev/Func */ 725 } smb_pciexrc_t; 726 727 /* 728 * SMBIOS implementation structure for SUN_OEM_EXT_MEMARRAY. 729 */ 730 typedef struct smb_memarray_ext { 731 smb_header_t smbmarre_hdr; /* structure header */ 732 uint16_t smbmarre_ma; /* memory array handle */ 733 uint16_t smbmarre_component; /* component parent handle */ 734 uint16_t smbmarre_bdf; /* PCI bus/dev/funct */ 735 } smb_memarray_ext_t; 736 737 /* 738 * SMBIOS implementation structure for SUN_OEM_EXT_MEMDEVICE. 739 */ 740 typedef struct smb_memdevice_ext { 741 smb_header_t smbmdeve_hdr; /* structure header */ 742 uint16_t smbmdeve_mdev; /* memory device handle */ 743 uint8_t smbmdeve_dchan; /* DRAM channel */ 744 uint8_t smbmdeve_ncs; /* number of chip select */ 745 uint8_t smbmdeve_cs[1]; /* chip selects */ 746 } smb_memdevice_ext_t; 747 748 #pragma pack() 749 750 typedef struct smb_struct { 751 const smb_header_t *smbst_hdr; /* address of raw structure data */ 752 const uchar_t *smbst_str; /* address of string data (if any) */ 753 const uchar_t *smbst_end; /* address of 0x0000 ending tag */ 754 struct smb_struct *smbst_next; /* next structure in hash chain */ 755 uint16_t *smbst_strtab; /* string index -> offset table */ 756 uint_t smbst_strtablen; /* length of smbst_strtab */ 757 } smb_struct_t; 758 759 struct smbios_hdl { 760 smbios_entry_point_t sh_ent_type; /* structure table entry point type */ 761 smbios_entry_t sh_ent; /* structure table entry point */ 762 uint_t sh_ent_stnum; /* number of structure table entries */ 763 const void *sh_buf; /* structure table buffer */ 764 size_t sh_buflen; /* size of structure table buffer */ 765 smb_struct_t *sh_structs; /* array of structure descriptors */ 766 uint_t sh_nstructs; /* number of active structures */ 767 smb_struct_t **sh_hash; /* hash bucket array for descriptors */ 768 uint_t sh_hashlen; /* hash bucket array length */ 769 int sh_err; /* error code for smbios_errno() */ 770 int sh_libvers; /* library client abi version */ 771 int sh_smbvers; /* derived underlying format version */ 772 uint_t sh_flags; /* miscellaneous flags (see below) */ 773 }; 774 775 #define SMB_FL_DEBUG 0x1 /* print debug messages for this hdl */ 776 #define SMB_FL_BUFALLOC 0x2 /* sh_buf was allocated by library */ 777 #define SMB_FL_TRUNC 0x4 /* smbios table is truncated */ 778 779 #define SMB_BIOS_DEVICE "/dev/xsvc" /* device w/ BIOS physmem */ 780 #define SMB_SMBIOS_DEVICE "/dev/smbios" /* device w/ SMBIOS image */ 781 782 #define SMB_RANGE_START 0xF0000 /* start of physical address range */ 783 #define SMB_RANGE_LIMIT 0xFFFFF /* limit of physical address range */ 784 #define SMB_SCAN_STEP 16 /* stepping by paragraph */ 785 786 #define SMB_MAJMIN(M, m) ((((M) & 0xFF) << 8) | ((m) & 0xFF)) 787 #define SMB_MAJOR(v) (((v) & 0xFF00) >> 8) 788 #define SMB_MINOR(v) (((v) & 0x00FF)) 789 790 #define ESMB_BASE 1000 /* base value for libsmbios errnos */ 791 792 enum { 793 ESMB_NOTFOUND = ESMB_BASE, /* SMBIOS table not found on system */ 794 ESMB_MAPDEV, /* failed to map SMBIOS table */ 795 ESMB_NOENT, /* failed to locate structure */ 796 ESMB_NOMEM, /* failed to allocate memory */ 797 ESMB_NOHDR, /* failed to read SMBIOS header */ 798 ESMB_NOSTAB, /* failed to read SMBIOS struct table */ 799 ESMB_NOINFO, /* no common info for structure */ 800 ESMB_SHORT, /* buffer length doesn't match header */ 801 ESMB_CORRUPT, /* buffer struct or len is corrupt */ 802 ESMB_VERSION, /* version not supported by library */ 803 ESMB_NOTSUP, /* feature not supported by provider */ 804 ESMB_HEADER, /* SMBIOS header corrupt or invalid */ 805 ESMB_OLD, /* SMBIOS version is too old for us */ 806 ESMB_NEW, /* SMBIOS version is too new for us */ 807 ESMB_CKSUM, /* SMBIOS header checksum mismatch */ 808 ESMB_INVAL, /* invalid function call argument */ 809 ESMB_TYPE, /* structure type mismatch */ 810 ESMB_UNKNOWN /* unknown error (maximum value tag) */ 811 }; 812 813 extern const smb_struct_t *smb_lookup_type(smbios_hdl_t *, uint_t); 814 extern const smb_struct_t *smb_lookup_id(smbios_hdl_t *, uint_t); 815 extern const char *smb_strptr(const smb_struct_t *, uint_t); 816 extern int smb_gteq(smbios_hdl_t *, int); 817 extern int smb_libgteq(smbios_hdl_t *, int); 818 819 extern int smb_set_errno(smbios_hdl_t *, int); 820 extern smbios_hdl_t *smb_open_error(smbios_hdl_t *, int *, int); 821 extern const char *smb_strerror(int); 822 823 extern void *smb_alloc(size_t); 824 extern void *smb_zalloc(size_t); 825 extern void smb_free(void *, size_t); 826 827 extern void smb_dprintf(smbios_hdl_t *, const char *, ...); 828 829 extern int _smb_debug; 830 831 /* 832 * The following series of structures represent the base versions of public 833 * structures that are used inside by the smbios routines. This allows the 834 * common code to properly know how much it should or should not bzero and how 835 * to handle additions to the spec. Types should only be added here if we need 836 * to extend the public structures in sys/smbios.h due to a change in the spec. 837 * 838 * Types here have the name smb_base_%s which corresponds to smbios_%s. 839 */ 840 typedef struct smb_base_chassis { 841 uint32_t smbbc_oemdata; /* OEM-specific data */ 842 uint8_t smbbc_lock; /* lock present? */ 843 uint8_t smbbc_type; /* type */ 844 uint8_t smbbc_bustate; /* boot-up state */ 845 uint8_t smbbc_psstate; /* power supply state */ 846 uint8_t smbbc_thstate; /* thermal state */ 847 uint8_t smbbc_security; /* security status */ 848 uint8_t smbbc_uheight; /* enclosure height in U's */ 849 uint8_t smbbc_cords; /* number of power cords */ 850 uint8_t smbbc_elems; /* number of element records (n) */ 851 uint8_t smbbc_elemlen; /* length of contained element (m) */ 852 } smb_base_chassis_t; 853 854 typedef struct smb_base_processor { 855 uint64_t smbbp_cpuid; /* processor cpuid information */ 856 uint32_t smbbp_family; /* processor family */ 857 uint8_t smbbp_type; /* processor type (SMB_PRT_*) */ 858 uint8_t smbbp_voltage; /* voltage (SMB_PRV_*) */ 859 uint8_t smbbp_status; /* status (SMB_PRS_*) */ 860 uint8_t smbbp_upgrade; /* upgrade (SMB_PRU_*) */ 861 uint32_t smbbp_clkspeed; /* external clock speed in MHz */ 862 uint32_t smbbp_maxspeed; /* maximum speed in MHz */ 863 uint32_t smbbp_curspeed; /* current speed in MHz */ 864 id_t smbbp_l1cache; /* L1 cache handle */ 865 id_t smbbp_l2cache; /* L2 cache handle */ 866 id_t smbbp_l3cache; /* L3 cache handle */ 867 } smb_base_processor_t; 868 869 typedef struct smb_base_memdevice { 870 id_t smbbmd_array; /* handle of physical memory array */ 871 id_t smbbmd_error; /* handle of memory error data */ 872 uint32_t smbbmd_twidth; /* total width in bits including ecc */ 873 uint32_t smbbmd_dwidth; /* data width in bits */ 874 uint64_t smbbmd_size; /* size in bytes (see note above) */ 875 uint8_t smbbmd_form; /* form factor */ 876 uint8_t smbbmd_set; /* set (0x00=none, 0xFF=unknown) */ 877 uint8_t smbbmd_type; /* memory type */ 878 uint8_t smbbmd_pad; /* padding */ 879 uint32_t smbbmd_flags; /* flags (see below) */ 880 uint32_t smbbmd_speed; /* speed in MHz */ 881 const char *smbbmd_dloc; /* physical device locator string */ 882 const char *smbbmd_bloc; /* physical bank locator string */ 883 uint8_t smbbmd_rank; /* rank */ 884 } smb_base_memdevice_t; 885 886 typedef struct smb_base_bios { 887 const char *smbbb_vendor; /* bios vendor string */ 888 const char *smbbb_version; /* bios version string */ 889 const char *smbbb_reldate; /* bios release date */ 890 uint32_t smbbb_segment; /* bios address segment location */ 891 uint32_t smbbb_romsize; /* bios rom size in bytes */ 892 uint32_t smbbb_runsize; /* bios image size in bytes */ 893 uint64_t smbbb_cflags; /* bios characteristics */ 894 const uint8_t *smbbb_xcflags; /* bios characteristics extensions */ 895 size_t smbbb_nxcflags; /* number of smbb_xcflags[] bytes */ 896 smbios_version_t smbbb_biosv; /* bios version */ 897 smbios_version_t smbbb_ecfwv; /* bios embedded ctrl f/w version */ 898 } smb_base_bios_t; 899 900 typedef struct smb_base_cache { 901 uint32_t smbba_maxsize; /* maximum installed size in bytes */ 902 uint32_t smbba_size; /* installed size in bytes */ 903 uint16_t smbba_stype; /* supported SRAM types (SMB_CAT_*) */ 904 uint16_t smbba_ctype; /* current SRAM type (SMB_CAT_*) */ 905 uint8_t smbba_speed; /* speed in nanoseconds */ 906 uint8_t smbba_etype; /* error correction type (SMB_CAE_*) */ 907 uint8_t smbba_ltype; /* logical cache type (SMB_CAG_*) */ 908 uint8_t smbba_assoc; /* associativity (SMB_CAA_*) */ 909 uint8_t smbba_level; /* cache level */ 910 uint8_t smbba_mode; /* cache mode (SMB_CAM_*) */ 911 uint8_t smbba_location; /* cache location (SMB_CAL_*) */ 912 uint8_t smbba_flags; /* cache flags (SMB_CAF_*) */ 913 } smb_base_cache_t; 914 915 typedef struct smb_base_slot { 916 const char *smbbl_name; /* reference designation */ 917 uint8_t smbbl_type; /* slot type */ 918 uint8_t smbbl_width; /* slot data bus width */ 919 uint8_t smbbl_usage; /* current usage */ 920 uint8_t smbbl_length; /* slot length */ 921 uint16_t smbbl_id; /* slot ID */ 922 uint8_t smbbl_ch1; /* slot characteristics 1 */ 923 uint8_t smbbl_ch2; /* slot characteristics 2 */ 924 uint16_t smbbl_sg; /* segment group number */ 925 uint8_t smbbl_bus; /* bus number */ 926 uint8_t smbbl_df; /* device/function number */ 927 } smb_base_slot_t; 928 929 /* 930 * Prior to reivison 3.5 of the library and interface we had embedded a 256 byte 931 * string for the SKU into here rather than pointing to constant data. This, 932 * combined withe bugs in the implementation, generally led to strings with 933 * garbage. As part of fixing this with the 3.5 support, we moved the struct to 934 * ve more inline with everything else. 935 */ 936 typedef struct smb_chassis_pre35 { 937 uint32_t smbc_oemdata; /* OEM-specific data */ 938 uint8_t smbc_lock; /* lock present? */ 939 uint8_t smbc_type; /* type */ 940 uint8_t smbc_bustate; /* boot-up state */ 941 uint8_t smbc_psstate; /* power supply state */ 942 uint8_t smbc_thstate; /* thermal state */ 943 uint8_t smbc_security; /* security status */ 944 uint8_t smbc_uheight; /* enclosure height in U's */ 945 uint8_t smbc_cords; /* number of power cords */ 946 uint8_t smbc_elems; /* number of element records (n) */ 947 uint8_t smbc_elemlen; /* length of contained element (m) */ 948 char smbc_sku[256]; 949 } smb_chassis_pre35_t; 950 951 #ifdef __cplusplus 952 } 953 #endif 954 955 #endif /* _SYS_SMBIOS_IMPL_H */ 956