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