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