xref: /illumos-gate/usr/src/uts/common/sys/smbios_impl.h (revision 941b7e9c849240e1a04a25b32722d30dae557dc3)
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) 2017, 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 {
230 	smb_header_t smbsl_hdr;		/* structure header */
231 	uint8_t smbsl_name;		/* reference designation */
232 	uint8_t smbsl_type;		/* slot type */
233 	uint8_t smbsl_width;		/* slot data bus width */
234 	uint8_t smbsl_usage;		/* current usage */
235 	uint8_t smbsl_length;		/* slot length */
236 	uint16_t smbsl_id;		/* slot ID */
237 	uint8_t smbsl_ch1;		/* slot characteristics 1 */
238 	uint8_t smbsl_ch2;		/* slot characteristics 2 */
239 	uint16_t smbsl_sg;		/* segment group number */
240 	uint8_t smbsl_bus;		/* bus number */
241 	uint8_t smbsl_df;		/* device/function number */
242 } smb_slot_t;
243 
244 /*
245  * SMBIOS implementation structure for SMB_TYPE_OBDEVS.
246  */
247 typedef struct smb_obdev {
248 	uint8_t smbob_type;		/* encoded type and enable bit */
249 	uint8_t smbob_name;		/* description string */
250 } smb_obdev_t;
251 
252 #define	SMB_OBT_ENABLED		0x80	/* enable bit within smbob_type */
253 
254 /*
255  * SMBIOS implementation structure for SMB_TYPE_OEMSTR, SMB_TYPE_SYSCONFSTR,
256  * and SMB_TYPE_LANG.
257  */
258 typedef struct smb_strtab {
259 	smb_header_t smbtb_hdr;		/* structure header */
260 	uint8_t smbtb_count;		/* number of strings */
261 } smb_strtab_t;
262 
263 /*
264  * SMBIOS implementation structure for SMB_TYPE_LANG.
265  */
266 typedef struct smb_lang {
267 	smb_header_t smblang_hdr;	/* structure header */
268 	uint8_t smblang_num;		/* number of installed languages */
269 	uint8_t smblang_flags;		/* flags */
270 	uint8_t smblang_resv[15];	/* reserved for future use */
271 	uint8_t smblang_cur;		/* current language string */
272 } smb_lang_t;
273 
274 /*
275  * SMBIOS implementation structure for SMB_TYPE_EVENTLOG.
276  */
277 typedef struct smb_sel {
278 	smb_header_t smbsel_hdr;	/* structure header */
279 	uint16_t smbsel_len;		/* log area length */
280 	uint16_t smbsel_hdroff;		/* header offset */
281 	uint16_t smbsel_dataoff;	/* data offset */
282 	uint8_t smbsel_method;		/* access method */
283 	uint8_t smbsel_status;		/* status flags */
284 	uint32_t smbsel_token;		/* change token */
285 	uint32_t smbsel_addr;		/* access method address */
286 	uint8_t smbsel_format;		/* header format */
287 	uint8_t smbsel_typec;		/* number of type descriptors */
288 	uint8_t smbsel_typesz;		/* size of each type descriptor */
289 	uint8_t smbsel_typev[1];	/* array of type descriptors */
290 } smb_sel_t;
291 
292 /*
293  * SMBIOS implementation structure for SMB_TYPE_MEMARRAY.
294  */
295 typedef struct smb_memarray {
296 	smb_header_t smbmarr_hdr;	/* structure header */
297 	uint8_t smbmarr_loc;		/* location */
298 	uint8_t smbmarr_use;		/* use */
299 	uint8_t smbmarr_ecc;		/* error detect/correct mechanism */
300 	uint32_t smbmarr_cap;		/* maximum capacity */
301 	uint16_t smbmarr_err;		/* error handle */
302 	uint16_t smbmarr_ndevs;		/* number of slots or sockets */
303 	uint64_t smbmarr_extcap;	/* extended maximum capacity */
304 } smb_memarray_t;
305 
306 /*
307  * SMBIOS implementation structure for SMB_TYPE_MEMARRAYMAP.
308  */
309 typedef struct smb_memarrmap {
310 	smb_header_t smbamap_hdr;	/* structure header */
311 	uint32_t smbamap_start;		/* starting address in kilobytes */
312 	uint32_t smbamap_end;		/* ending address in kilobytes */
313 	uint16_t smbamap_array;		/* physical memory array handle */
314 	uint8_t smbamap_width;		/* partition width */
315 	uint64_t smbamap_extstart;	/* extended starting address in bytes */
316 	uint64_t smbamap_extend;	/* extended ending address in bytes */
317 } smb_memarrmap_t;
318 
319 /*
320  * SMBIOS implementation structure for SMB_TYPE_MEMDEVICE.
321  */
322 typedef struct smb_memdevice {
323 	smb_header_t smbmdev_hdr;	/* structure header */
324 	uint16_t smbmdev_array;		/* array handle */
325 	uint16_t smbmdev_error;		/* error handle */
326 	uint16_t smbmdev_twidth;	/* total width */
327 	uint16_t smbmdev_dwidth;	/* data width */
328 	uint16_t smbmdev_size;		/* size in either K or MB */
329 	uint8_t smbmdev_form;		/* form factor */
330 	uint8_t smbmdev_set;		/* device set */
331 	uint8_t smbmdev_dloc;		/* device locator */
332 	uint8_t smbmdev_bloc;		/* bank locator */
333 	uint8_t smbmdev_type;		/* memory type */
334 	uint16_t smbmdev_flags;		/* detail flags */
335 	uint16_t smbmdev_speed;		/* speed in MT/s */
336 	uint8_t smbmdev_manufacturer;	/* manufacturer */
337 	uint8_t smbmdev_serial;		/* serial number */
338 	uint8_t smbmdev_asset;		/* asset tag */
339 	uint8_t smbmdev_part;		/* part number */
340 	uint8_t smbmdev_attrs;		/* attributes */
341 	uint32_t smbmdev_extsize;	/* extended size */
342 	uint16_t smbmdev_clkspeed;	/* configured clock speed */
343 	uint16_t smbmdev_minvolt;	/* minimum voltage */
344 	uint16_t smbmdev_maxvolt;	/* maximum voltage */
345 	uint16_t smbmdev_confvolt;	/* configured voltage */
346 } smb_memdevice_t;
347 
348 #define	SMB_MDS_KBYTES		0x8000	/* size in specified in kilobytes */
349 
350 /*
351  * SMBIOS implementation structure for SMB_TYPE_MEMDEVICEMAP.
352  */
353 typedef struct smb_memdevmap {
354 	smb_header_t smbdmap_hdr;	/* structure header */
355 	uint32_t smbdmap_start;		/* starting address in kilobytes */
356 	uint32_t smbdmap_end;		/* ending address in kilobytes */
357 	uint16_t smbdmap_device;	/* memory device handle */
358 	uint16_t smbdmap_array;		/* memory array mapped address handle */
359 	uint8_t smbdmap_rpos;		/* row position */
360 	uint8_t smbdmap_ipos;		/* interleave position */
361 	uint8_t smbdmap_idepth;		/* interleave depth */
362 	uint64_t smbdmap_extstart;	/* extended starting address */
363 	uint64_t smbdmap_extend;	/* extended ending address */
364 } smb_memdevmap_t;
365 
366 /*
367  * SMBIOS implementation structure for SMB_TYPE_BATTERY.
368  */
369 typedef struct smb_battery {
370 	smb_header_t smbbat_hdr;	/* structure header */
371 	uint8_t smbbat_loc;		/* location */
372 	uint8_t smbbat_manufacturer;	/* manufacturer */
373 	uint8_t smbbat_date;		/* manufacture date */
374 	uint8_t smbbat_serial;		/* serial number */
375 	uint8_t smbbat_devname;		/* device name */
376 	uint8_t smbbat_chem;		/* device chemistry */
377 	uint16_t smbbat_cap;		/* design capacity in mW hours */
378 	uint16_t smbbat_volt;		/* design voltage in mV */
379 	uint8_t smbbat_version;		/* SBDS version string */
380 	uint8_t smbbat_err;		/* error percentage */
381 	uint16_t smbbat_ssn;		/* SBDS serial number */
382 	uint16_t smbbat_sdate;		/* SBDS manufacture date */
383 	uint8_t smbbat_schem;		/* SBDS chemistry string */
384 	uint8_t smbbat_mult;		/* design capacity multiplier */
385 	uint32_t smbbat_oemdata;	/* OEM-specific data */
386 } smb_battery_t;
387 
388 /*
389  * SMBIOS implementation structure for SMB_TYPE_SECURITY.
390  */
391 typedef struct smb_hwsec {
392 	smb_header_t smbhs_hdr;		/* structure header */
393 	uint8_t smbhs_settings;		/* settings byte */
394 } smb_hwsec_t;
395 
396 #define	SMB_HWS_PWR_PS(x)	(((x) & 0xC0) >> 6)
397 #define	SMB_HWS_KBD_PS(x)	(((x) & 0x30) >> 4)
398 #define	SMB_HWS_ADM_PS(x)	(((x) & 0x0C) >> 2)
399 #define	SMB_HWS_PAN_PS(x)	(((x) & 0x03) >> 0)
400 
401 /*
402  * SMBIOS implementation structure for SMB_TYPE_VPROBE.
403  */
404 typedef struct smb_vprobe {
405 	smb_header_t smbvpr_hdr;	/* structure header */
406 	uint8_t smbvpr_descr;		/* description string */
407 	uint8_t smbvpr_locstat;		/* location and status */
408 	uint16_t smbvpr_maxval;		/* maximum voltage */
409 	uint16_t smbvpr_minval;		/* minimum voltage */
410 	uint16_t smbvpr_resolution;	/* probe resolution */
411 	uint16_t smbvpr_tolerance;	/* probe tolerance */
412 	uint16_t smbvpr_accuracy;	/* probe accuracy */
413 	uint32_t smbvpr_oem;		/* vendor-specific data */
414 	uint16_t smbvpr_nominal;	/* nominal value */
415 } smb_vprobe_t;
416 
417 #define	SMB_VPROBE_MINLEN		0x14
418 #define	SMB_VPROBE_NOMINAL_MINLEN	0x16
419 
420 #define	SMB_VPROBE_LOCATION(x)	((x) & 0x1f)
421 #define	SMB_VPROBE_STATUS(x)	(((x) >> 5) & 0x7)
422 
423 /*
424  * SMBIOS implementation structure for SMB_TYPE_COOLDEV.
425  */
426 typedef struct smb_cooldev {
427 	smb_header_t smbcdev_hdr;	/* structure header */
428 	uint16_t smbcdev_tprobe;	/* temperature probe */
429 	uint8_t smbcdev_typstat;	/* type and status */
430 	uint8_t smbcdev_group;		/* group identifier */
431 	uint32_t smbcdev_oem;		/* vendor-specific data */
432 	uint16_t smbcdev_nominal;	/* nominal value */
433 	uint8_t smbcdev_descr;		/* description string */
434 } smb_cooldev_t;
435 
436 #define	SMB_COOLDEV_MINLEN		0x0c
437 #define	SMB_COOLDEV_NOMINAL_MINLEN	0x0e
438 #define	SMB_COOLDEV_DESCR_MINLEN	0x0f
439 
440 #define	SMB_COOLDEV_TYPE(x)	((x) & 0x1f)
441 #define	SMB_COOLDEV_STATUS(x)	(((x) >> 5) & 0x7)
442 
443 /*
444  * SMBIOS implementation structure for SMB_TYPE_TPROBE.
445  */
446 typedef struct smb_tprobe {
447 	smb_header_t smbtpr_hdr;	/* structure header */
448 	uint8_t smbtpr_descr;		/* description string */
449 	uint8_t smbtpr_locstat;		/* location and status */
450 	uint16_t smbtpr_maxval;		/* maximum temperature */
451 	uint16_t smbtpr_minval;		/* minimum temperature */
452 	uint16_t smbtpr_resolution;	/* probe resolution */
453 	uint16_t smbtpr_tolerance;	/* probe tolerance */
454 	uint16_t smbtpr_accuracy;	/* probe accuracy */
455 	uint32_t smbtpr_oem;		/* vendor-specific data */
456 	uint16_t smbtpr_nominal;	/* nominal value */
457 } smb_tprobe_t;
458 
459 #define	SMB_TPROBE_MINLEN		0x14
460 #define	SMB_TPROBE_NOMINAL_MINLEN	0x16
461 
462 #define	SMB_TPROBE_LOCATION(x)	((x) & 0x1f)
463 #define	SMB_TPROBE_STATUS(x)	(((x) >> 5) & 0x7)
464 
465 /*
466  * SMBIOS implementation structure for SMB_TYPE_IPROBE.
467  */
468 typedef struct smb_iprobe {
469 	smb_header_t smbipr_hdr;	/* structure header */
470 	uint8_t smbipr_descr;		/* description string */
471 	uint8_t smbipr_locstat;		/* location and status */
472 	uint16_t smbipr_maxval;		/* maximum current */
473 	uint16_t smbipr_minval;		/* minimum current */
474 	uint16_t smbipr_resolution;	/* probe resolution */
475 	uint16_t smbipr_tolerance;	/* probe tolerance */
476 	uint16_t smbipr_accuracy;	/* probe accuracy */
477 	uint32_t smbipr_oem;		/* vendor-specific data */
478 	uint16_t smbipr_nominal;	/* nominal value */
479 } smb_iprobe_t;
480 
481 #define	SMB_IPROBE_MINLEN		0x14
482 #define	SMB_IPROBE_NOMINAL_MINLEN	0x16
483 
484 #define	SMB_IPROBE_LOCATION(x)	((x) & 0x1f)
485 #define	SMB_IPROBE_STATUS(x)	(((x) >> 5) & 0x7)
486 
487 /*
488  * SMBIOS implementation structure for SMB_TYPE_BOOT.
489  */
490 typedef struct smb_boot {
491 	smb_header_t smbbo_hdr;		/* structure header */
492 	uint8_t smbbo_pad[6];		/* reserved for future use */
493 	uint8_t smbbo_status[1];	/* variable-length status buffer */
494 } smb_boot_t;
495 
496 /*
497  * SMBIOS implementation structure for SMB_TYPE_IPMIDEV.
498  */
499 typedef struct smb_ipmi {
500 	smb_header_t smbipm_hdr;	/* structure header */
501 	uint8_t smbipm_type;		/* interface type */
502 	uint8_t smbipm_spec;		/* specification revision */
503 	uint8_t smbipm_i2c;		/* i2C slave address */
504 	uint8_t smbipm_bus;		/* NV storage device bus ID */
505 	uint64_t smbipm_addr;		/* base address */
506 	uint8_t smbipm_info;		/* base address modifier/intr info */
507 	uint8_t smbipm_intr;		/* interrupt number */
508 } smb_ipmi_t;
509 
510 #define	SMB_IPM_SPEC_MAJOR(x)	(((x) & 0xF0) >> 4)
511 #define	SMB_IPM_SPEC_MINOR(x)	((x) & 0x0F)
512 
513 #define	SMB_IPM_ADDR_IO		1ULL
514 
515 #define	SMB_IPM_INFO_REGS(x)	(((x) & 0xC0) >> 6)
516 #define	SMB_IPM_INFO_LSB(x)	(((x) & 0x10) >> 4)
517 #define	SMB_IPM_INFO_ISPEC(x)	(((x) & 0x08) >> 3)
518 #define	SMB_IPM_INFO_IPOL(x)	(((x) & 0x02) >> 1)
519 #define	SMB_IPM_INFO_IMODE(x)	(((x) & 0x01) >> 0)
520 
521 #define	SMB_IPM_REGS_1B		0
522 #define	SMB_IPM_REGS_4B		1
523 #define	SMB_IPM_REGS_16B	2
524 
525 #define	SMB_IPM_IPOL_LO		0
526 #define	SMB_IPM_IPOL_HI		1
527 
528 #define	SMB_IPM_IMODE_EDGE	0
529 #define	SMB_IPM_IMODE_LEVEL	1
530 
531 /*
532  * SMBIOS implementation structure for SMB_TYPE_POWERSUP.
533  */
534 typedef struct smb_powersup {
535 	smb_header_t smbpsup_hdr;	/* structure header */
536 	uint8_t smbpsup_group;		/* group id */
537 	uint8_t smbpsup_loc;		/* location tag */
538 	uint8_t smbpsup_devname;	/* device name */
539 	uint8_t smbpsup_manufacturer;	/* manufacturer */
540 	uint8_t smbpsup_serial;		/* serial number */
541 	uint8_t smbpsup_asset;		/* asset tag */
542 	uint8_t smbpsup_part;		/* part number */
543 	uint8_t smbpsup_rev;		/* revision string */
544 	uint16_t smbpsup_max;		/* max output in milliwatts */
545 	uint16_t smbpsup_char;		/* characteristics */
546 	uint16_t smbpsup_vprobe;	/* voltage probe handle */
547 	uint16_t smbpsup_cooldev;	/* cooling device handle */
548 	uint16_t smbpsup_iprobe;	/* current probe handle */
549 } smb_powersup_t;
550 
551 #define	SMB_PSU_CHARS_ISHOT(x)		((x) & 0x01)
552 #define	SMB_PSU_CHARS_ISPRES(x)		((x) & 0x02)
553 #define	SMB_PSU_CHARS_ISUNPLUG(x)	((x) & 0x04)
554 #define	SMB_PSU_CHARS_IVRS(x)		(((x) >> 3) & 0xf)
555 #define	SMB_PSU_CHARS_STATUS(x)		(((x) >> 7) & 0x7)
556 #define	SMB_PSU_CHARS_TYPE(x)		(((x) >> 10) & 0xf)
557 
558 /*
559  * SMBIOS implementation structure for SMB_TYPE_OBDEVEXT.
560  */
561 typedef struct smb_obdev_ext {
562 	smb_header_t smbobe_hdr;	/* structure header */
563 	uint8_t smbobe_name;		/* reference designation */
564 	uint8_t smbobe_dtype;		/* device type */
565 	uint8_t smbobe_dti;		/* device type instance */
566 	uint16_t smbobe_sg;		/* segment group number */
567 	uint8_t smbobe_bus;		/* bus number */
568 	uint8_t smbobe_df;		/* device/function number */
569 } smb_obdev_ext_t;
570 
571 /*
572  * SMBIOS implementation structure for SUN_OEM_EXT_PROCESSOR.
573  */
574 typedef struct smb_processor_ext {
575 	smb_header_t smbpre_hdr;	/* structure header */
576 	uint16_t smbpre_processor;	/* processor handle */
577 	uint8_t smbpre_fru;		/* FRU indicator */
578 	uint8_t smbpre_n;		/* number of APIC IDs */
579 	uint16_t smbpre_apicid[1];	/* strand initial apic id */
580 } smb_processor_ext_t;
581 
582 /*
583  * SMBIOS implementation structure for SUN_OEM_EXT_PORT.
584  */
585 typedef struct smb_port_ext {
586 	smb_header_t smbpoe_hdr;	/* structure header */
587 	uint16_t smbpoe_chassis;	/* chassis handle */
588 	uint16_t smbpoe_port;		/* port connector handle */
589 	uint8_t smbpoe_dtype;		/* device type */
590 	uint16_t smbpoe_devhdl;		/* device handle */
591 	uint8_t smbpoe_phy;		/* PHY number */
592 } smb_port_ext_t;
593 
594 /*
595  * SMBIOS implementation structure for SUN_OEM_PCIEXRC.
596  */
597 typedef struct smb_pciexrc {
598 	smb_header_t smbpciexrc_hdr;	/* structure header */
599 	uint16_t smbpciexrc_bboard;	/* base board handle */
600 	uint16_t smbpciexrc_bdf;	/* PCI Bus/Dev/Func */
601 } smb_pciexrc_t;
602 
603 /*
604  * SMBIOS implementation structure for SUN_OEM_EXT_MEMARRAY.
605  */
606 typedef struct smb_memarray_ext {
607 	smb_header_t smbmarre_hdr;	/* structure header */
608 	uint16_t smbmarre_ma;		/* memory array handle */
609 	uint16_t smbmarre_component;	/* component parent handle */
610 	uint16_t smbmarre_bdf;		/* PCI bus/dev/funct */
611 } smb_memarray_ext_t;
612 
613 /*
614  * SMBIOS implementation structure for SUN_OEM_EXT_MEMDEVICE.
615  */
616 typedef struct smb_memdevice_ext {
617 	smb_header_t smbmdeve_hdr;	/* structure header */
618 	uint16_t smbmdeve_mdev;		/* memory device handle */
619 	uint8_t smbmdeve_dchan;		/* DRAM channel */
620 	uint8_t smbmdeve_ncs;		/* number of chip select */
621 	uint8_t smbmdeve_cs[1];		/* chip selects */
622 } smb_memdevice_ext_t;
623 
624 #pragma pack()
625 
626 typedef struct smb_struct {
627 	const smb_header_t *smbst_hdr;	/* address of raw structure data */
628 	const uchar_t *smbst_str;	/* address of string data (if any) */
629 	const uchar_t *smbst_end;	/* address of 0x0000 ending tag */
630 	struct smb_struct *smbst_next; 	/* next structure in hash chain */
631 	uint16_t *smbst_strtab;		/* string index -> offset table */
632 	uint_t smbst_strtablen;		/* length of smbst_strtab */
633 } smb_struct_t;
634 
635 struct smbios_hdl {
636 	smbios_entry_point_t sh_ent_type; /* structure table entry point type */
637 	smbios_entry_t sh_ent;		/* structure table entry point */
638 	uint_t sh_ent_stnum;		/* number of structure table entries */
639 	const void *sh_buf;		/* structure table buffer */
640 	size_t sh_buflen;		/* size of structure table buffer */
641 	smb_struct_t *sh_structs;	/* array of structure descriptors */
642 	uint_t sh_nstructs;		/* number of active structures */
643 	smb_struct_t **sh_hash;		/* hash bucket array for descriptors */
644 	uint_t sh_hashlen;		/* hash bucket array length */
645 	int sh_err;			/* error code for smbios_errno() */
646 	int sh_libvers;			/* library client abi version */
647 	int sh_smbvers;			/* derived underlying format version */
648 	uint_t sh_flags;		/* miscellaneous flags (see below) */
649 };
650 
651 #define	SMB_FL_DEBUG	0x1		/* print debug messages for this hdl */
652 #define	SMB_FL_BUFALLOC	0x2		/* sh_buf was allocated by library */
653 #define	SMB_FL_TRUNC	0x4		/* smbios table is truncated */
654 
655 #define	SMB_BIOS_DEVICE		"/dev/xsvc"	/* device w/ BIOS physmem */
656 #define	SMB_SMBIOS_DEVICE	"/dev/smbios"	/* device w/ SMBIOS image */
657 
658 #define	SMB_RANGE_START	0xF0000		/* start of physical address range */
659 #define	SMB_RANGE_LIMIT	0xFFFFF		/* limit of physical address range */
660 #define	SMB_SCAN_STEP	16		/* stepping by paragraph */
661 
662 #define	SMB_MAJMIN(M, m)	((((M) & 0xFF) << 8) | ((m) & 0xFF))
663 #define	SMB_MAJOR(v)		(((v) & 0xFF00) >> 8)
664 #define	SMB_MINOR(v)		(((v) & 0x00FF))
665 
666 #define	ESMB_BASE	1000		/* base value for libsmbios errnos */
667 
668 enum {
669 	ESMB_NOTFOUND = ESMB_BASE,	/* SMBIOS table not found on system */
670 	ESMB_MAPDEV,			/* failed to map SMBIOS table */
671 	ESMB_NOENT,			/* failed to locate structure */
672 	ESMB_NOMEM,			/* failed to allocate memory */
673 	ESMB_NOHDR,			/* failed to read SMBIOS header */
674 	ESMB_NOSTAB,			/* failed to read SMBIOS struct table */
675 	ESMB_NOINFO,			/* no common info for structure */
676 	ESMB_SHORT,			/* buffer length doesn't match header */
677 	ESMB_CORRUPT,			/* buffer struct or len is corrupt */
678 	ESMB_VERSION,			/* version not supported by library */
679 	ESMB_NOTSUP,			/* feature not supported by provider */
680 	ESMB_HEADER,			/* SMBIOS header corrupt or invalid */
681 	ESMB_OLD,			/* SMBIOS version is too old for us */
682 	ESMB_NEW,			/* SMBIOS version is too new for us */
683 	ESMB_CKSUM,			/* SMBIOS header checksum mismatch */
684 	ESMB_INVAL,			/* invalid function call argument */
685 	ESMB_TYPE,			/* structure type mismatch */
686 	ESMB_UNKNOWN			/* unknown error (maximum value tag) */
687 };
688 
689 extern const smb_struct_t *smb_lookup_type(smbios_hdl_t *, uint_t);
690 extern const smb_struct_t *smb_lookup_id(smbios_hdl_t *, uint_t);
691 extern const char *smb_strptr(const smb_struct_t *, uint_t);
692 extern int smb_gteq(smbios_hdl_t *, int);
693 extern int smb_libgteq(smbios_hdl_t *, int);
694 
695 extern int smb_set_errno(smbios_hdl_t *, int);
696 extern smbios_hdl_t *smb_open_error(smbios_hdl_t *, int *, int);
697 extern const char *smb_strerror(int);
698 
699 extern void *smb_alloc(size_t);
700 extern void *smb_zalloc(size_t);
701 extern void smb_free(void *, size_t);
702 
703 extern void smb_dprintf(smbios_hdl_t *, const char *, ...);
704 
705 extern int _smb_debug;
706 
707 /*
708  * The following series of structures represent the base versions of public
709  * structures that are used inside by the smbios routines. This allows the
710  * common code to properly know how much it should or should not bzero and how
711  * to handle additions to the spec. Types should only be added here if we need
712  * to extend the public structures in sys/smbios.h due to a change in the spec.
713  *
714  * Types here have the name smb_base_%s which corresponds to smbios_%s.
715  */
716 typedef struct smb_base_chassis {
717 	uint32_t smbbc_oemdata;		/* OEM-specific data */
718 	uint8_t smbbc_lock;		/* lock present? */
719 	uint8_t smbbc_type;		/* type */
720 	uint8_t smbbc_bustate;		/* boot-up state */
721 	uint8_t smbbc_psstate;		/* power supply state */
722 	uint8_t smbbc_thstate;		/* thermal state */
723 	uint8_t smbbc_security;		/* security status */
724 	uint8_t smbbc_uheight;		/* enclosure height in U's */
725 	uint8_t smbbc_cords;		/* number of power cords */
726 	uint8_t smbbc_elems;		/* number of element records (n) */
727 	uint8_t smbbc_elemlen;		/* length of contained element (m) */
728 } smb_base_chassis_t;
729 
730 typedef struct smb_base_processor {
731 	uint64_t smbbp_cpuid;		/* processor cpuid information */
732 	uint32_t smbbp_family;		/* processor family */
733 	uint8_t smbbp_type;		/* processor type (SMB_PRT_*) */
734 	uint8_t smbbp_voltage;		/* voltage (SMB_PRV_*) */
735 	uint8_t smbbp_status;		/* status (SMB_PRS_*) */
736 	uint8_t smbbp_upgrade;		/* upgrade (SMB_PRU_*) */
737 	uint32_t smbbp_clkspeed;	/* external clock speed in MHz */
738 	uint32_t smbbp_maxspeed;	/* maximum speed in MHz */
739 	uint32_t smbbp_curspeed;	/* current speed in MHz */
740 	id_t smbbp_l1cache;		/* L1 cache handle */
741 	id_t smbbp_l2cache;		/* L2 cache handle */
742 	id_t smbbp_l3cache;		/* L3 cache handle */
743 } smb_base_processor_t;
744 
745 typedef struct smb_base_memdevice {
746 	id_t smbbmd_array;		/* handle of physical memory array */
747 	id_t smbbmd_error;		/* handle of memory error data */
748 	uint32_t smbbmd_twidth;		/* total width in bits including ecc */
749 	uint32_t smbbmd_dwidth;		/* data width in bits */
750 	uint64_t smbbmd_size;		/* size in bytes (see note above) */
751 	uint8_t smbbmd_form;		/* form factor */
752 	uint8_t smbbmd_set;		/* set (0x00=none, 0xFF=unknown) */
753 	uint8_t smbbmd_type;		/* memory type */
754 	uint8_t smbbmd_pad;		/* padding */
755 	uint32_t smbbmd_flags;		/* flags (see below) */
756 	uint32_t smbbmd_speed;		/* speed in MHz */
757 	const char *smbbmd_dloc;	/* physical device locator string */
758 	const char *smbbmd_bloc;	/* physical bank locator string */
759 	uint8_t smbbmd_rank;		/* rank */
760 } smb_base_memdevice_t;
761 
762 typedef struct smb_base_bios {
763 	const char *smbbb_vendor;	/* bios vendor string */
764 	const char *smbbb_version;	/* bios version string */
765 	const char *smbbb_reldate;	/* bios release date */
766 	uint32_t smbbb_segment;		/* bios address segment location */
767 	uint32_t smbbb_romsize;		/* bios rom size in bytes */
768 	uint32_t smbbb_runsize;		/* bios image size in bytes */
769 	uint64_t smbbb_cflags;		/* bios characteristics */
770 	const uint8_t *smbbb_xcflags;	/* bios characteristics extensions */
771 	size_t smbbb_nxcflags;		/* number of smbb_xcflags[] bytes */
772 	smbios_version_t smbbb_biosv;	/* bios version */
773 	smbios_version_t smbbb_ecfwv;	/* bios embedded ctrl f/w version */
774 } smb_base_bios_t;
775 
776 typedef struct smb_base_cache {
777 	uint32_t smbba_maxsize;		/* maximum installed size in bytes */
778 	uint32_t smbba_size;		/* installed size in bytes */
779 	uint16_t smbba_stype;		/* supported SRAM types (SMB_CAT_*) */
780 	uint16_t smbba_ctype;		/* current SRAM type (SMB_CAT_*) */
781 	uint8_t smbba_speed;		/* speed in nanoseconds */
782 	uint8_t smbba_etype;		/* error correction type (SMB_CAE_*) */
783 	uint8_t smbba_ltype;		/* logical cache type (SMB_CAG_*) */
784 	uint8_t smbba_assoc;		/* associativity (SMB_CAA_*) */
785 	uint8_t smbba_level;		/* cache level */
786 	uint8_t smbba_mode;		/* cache mode (SMB_CAM_*) */
787 	uint8_t smbba_location;		/* cache location (SMB_CAL_*) */
788 	uint8_t smbba_flags;		/* cache flags (SMB_CAF_*) */
789 } smb_base_cache_t;
790 
791 #ifdef	__cplusplus
792 }
793 #endif
794 
795 #endif	/* _SYS_SMBIOS_IMPL_H */
796