xref: /illumos-gate/usr/src/common/smbios/mktables.sh (revision 9a686fbc186e8e2a64e9a5094d44c7d6fa0ea167)
1#!/bin/sh
2#
3# CDDL HEADER START
4#
5# The contents of this file are subject to the terms of the
6# Common Development and Distribution License, Version 1.0 only
7# (the "License").  You may not use this file except in compliance
8# with the License.
9#
10# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
11# or http://www.opensolaris.org/os/licensing.
12# See the License for the specific language governing permissions
13# and limitations under the License.
14#
15# When distributing Covered Code, include this CDDL HEADER in each
16# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
17# If applicable, add the following below this CDDL HEADER, with the
18# fields enclosed by brackets "[]" replaced with your own identifying
19# information: Portions Copyright [yyyy] [name of copyright owner]
20#
21# CDDL HEADER END
22#
23#
24# Copyright 2015 OmniTI Computer Consulting, Inc.  All rights reserved.
25# Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
26# Use is subject to license terms.
27#
28
29#
30# The SMBIOS interfaces defined in <sys/smbios.h> include a set of integer-to-
31# string conversion routines for the various constants defined in the SMBIOS
32# spec.  These functions are used by smbios(1M) and prtdiag(1M) and can be
33# leveraged by other clients as well.  To simplify maintenance of the source
34# base, this shell script automatically generates the source code for all of
35# these functions from the <sys/smbios.h> header file and its comments.  Each
36# set of constants should be given a unique #define prefix, listed in the
37# tables below.  The smbios_*_name() functions return the identifier of the
38# cpp define, and the smbios_*_desc() functions return the text of the comment.
39#
40
41name_funcs='
42SMB_BBFL_	smbios_bboard_flag_name		uint_t
43SMB_BIOSFL_	smbios_bios_flag_name		uint64_t
44SMB_BIOSXB1_	smbios_bios_xb1_name		uint_t
45SMB_BIOSXB2_	smbios_bios_xb2_name		uint_t
46SMB_CAT_	smbios_cache_ctype_name		uint_t
47SMB_CAF_	smbios_cache_flag_name		uint_t
48SMB_EVFL_	smbios_evlog_flag_name		uint_t
49SMB_IPMI_F_	smbios_ipmi_flag_name		uint_t
50SMB_MDF_	smbios_memdevice_flag_name	uint_t
51SMB_PRC_	smbios_processor_core_flag_name	uint_t
52SMB_TYPE_ 	smbios_type_name		uint_t
53SMB_SLCH1_	smbios_slot_ch1_name		uint_t
54SMB_SLCH2_	smbios_slot_ch2_name		uint_t
55'
56
57desc_funcs='
58SMB_BBFL_	smbios_bboard_flag_desc		uint_t
59SMB_BBT_	smbios_bboard_type_desc		uint_t
60SMB_BIOSFL_	smbios_bios_flag_desc		uint64_t
61SMB_BIOSXB1_	smbios_bios_xb1_desc		uint_t
62SMB_BIOSXB2_	smbios_bios_xb2_desc		uint_t
63SMB_BOOT_	smbios_boot_desc		uint_t
64SMB_CAA_	smbios_cache_assoc_desc		uint_t
65SMB_CAT_	smbios_cache_ctype_desc		uint_t
66SMB_CAE_	smbios_cache_ecc_desc		uint_t
67SMB_CAF_	smbios_cache_flag_desc		uint_t
68SMB_CAL_	smbios_cache_loc_desc		uint_t
69SMB_CAG_	smbios_cache_logical_desc	uint_t
70SMB_CAM_	smbios_cache_mode_desc		uint_t
71SMB_CHST_	smbios_chassis_state_desc	uint_t
72SMB_CHT_	smbios_chassis_type_desc	uint_t
73SMB_EVFL_	smbios_evlog_flag_desc		uint_t
74SMB_EVHF_	smbios_evlog_format_desc	uint_t
75SMB_EVM_	smbios_evlog_method_desc	uint_t
76SMB_HWSEC_PS_	smbios_hwsec_desc		uint_t
77SMB_IPMI_F_	smbios_ipmi_flag_desc		uint_t
78SMB_IPMI_T_	smbios_ipmi_type_desc		uint_t
79SMB_MAL_	smbios_memarray_loc_desc	uint_t
80SMB_MAU_	smbios_memarray_use_desc	uint_t
81SMB_MAE_	smbios_memarray_ecc_desc	uint_t
82SMB_MDF_	smbios_memdevice_flag_desc	uint_t
83SMB_MDFF_	smbios_memdevice_form_desc	uint_t
84SMB_MDT_	smbios_memdevice_type_desc	uint_t
85SMB_MDR_	smbios_memdevice_rank_desc	uint_t
86SMB_OBT_	smbios_onboard_type_desc	uint_t
87SMB_POC_	smbios_port_conn_desc		uint_t
88SMB_POT_	smbios_port_type_desc		uint_t
89SMB_PRC_	smbios_processor_core_flag_desc	uint_t
90SMB_PRF_	smbios_processor_family_desc	uint_t
91SMB_PRS_	smbios_processor_status_desc	uint_t
92SMB_PRT_	smbios_processor_type_desc	uint_t
93SMB_PRU_	smbios_processor_upgrade_desc	uint_t
94SMB_SLCH1_	smbios_slot_ch1_desc		uint_t
95SMB_SLCH2_	smbios_slot_ch2_desc		uint_t
96SMB_SLL_	smbios_slot_length_desc		uint_t
97SMB_SLT_	smbios_slot_type_desc		uint_t
98SMB_SLU_	smbios_slot_usage_desc		uint_t
99SMB_SLW_	smbios_slot_width_desc		uint_t
100SMB_TYPE_ 	smbios_type_desc		uint_t
101SMB_WAKEUP_	smbios_system_wakeup_desc	uint_t
102'
103
104if [ $# -ne 1 ]; then
105	echo "Usage: $0 file.h > file.c" >&2
106	exit 2
107fi
108
109echo "\
110/*\n\
111 * Copyright 2015 OmniTI Computer Consulting, Inc.  All rights reserved.\n\
112 * Copyright 2005 Sun Microsystems, Inc.  All rights reserved.\n\
113 * Use is subject to license terms.\n\
114 */\n\
115\n\
116#include <smbios.h>"
117
118echo "$name_funcs" | while read p name type; do
119	[ -z "$p" ] && continue
120	pattern="^#define[	 ]\($p[A-Za-z0-9_]*\)[	 ]*[A-Z0-9]*.*$"
121	replace='	case \1: return ("\1");'
122
123	echo "\nconst char *\n$name($type x)\n{\n\tswitch (x) {"
124	sed -n "s@$pattern@$replace@p" < $1 || exit 1
125	echo "\t}\n\treturn (NULL);\n}"
126done
127
128#
129# Generate the description functions based on the comment next to a #define.
130# The transformations for descriptive comments are slightly more complicated
131# than those used for the identifier->name functions above:
132#
133# (1) strip any [RO] suffix from the comment (a header file convention)
134# (2) replace any " with \" so it is escaped for the final output string
135# (3) replace return (...); with return ("..."); to finish the code
136#
137echo "$desc_funcs" | while read p name type; do
138	[ -z "$p" ] && continue
139	pattern="^#define[	 ]\($p[A-Za-z0-9_]*\)[	 ]*.*/\\* \(.*\) \\*/$"
140	replace='	case \1: return (\2);'
141
142	echo "\nconst char *\n$name($type x)\n{\n\tswitch (x) {"
143	sed -n "s@$pattern@$replace@p" < $1 | sed 's/ ([RO]))/)/' | \
144	    sed 's/"/\\"/g' | sed 's/(/("/;s/);$/");/' || exit 1
145	echo "\t}\n\treturn (NULL);\n}"
146done
147
148exit 0
149