usr/src/common/smbios/mktables.sh

   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 (c) 2017, Joyent, Inc.
  26 # Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
  27 # Use is subject to license terms.
  28 #
  29
  30 #
  31 # The SMBIOS interfaces defined in <sys/smbios.h> include a set of integer-to-
  32 # string conversion routines for the various constants defined in the SMBIOS
  33 # spec.  These functions are used by smbios(1M) and prtdiag(1M) and can be
  34 # leveraged by other clients as well.  To simplify maintenance of the source
  35 # base, this shell script automatically generates the source code for all of
  36 # these functions from the <sys/smbios.h> header file and its comments.  Each
  37 # set of constants should be given a unique #define prefix, listed in the
  38 # tables below.  The smbios_*_name() functions return the identifier of the
  39 # cpp define, and the smbios_*_desc() functions return the text of the comment.
  40 #
  41
  42 name_funcs='
  43 SMB_BBFL_       smbios_bboard_flag_name         uint_t
  44 SMB_BIOSFL_     smbios_bios_flag_name           uint64_t
  45 SMB_BIOSXB1_    smbios_bios_xb1_name            uint_t
  46 SMB_BIOSXB2_    smbios_bios_xb2_name            uint_t
  47 SMB_CAT_        smbios_cache_ctype_name         uint_t
  48 SMB_CAF_        smbios_cache_flag_name          uint_t
  49 SMB_EVFL_       smbios_evlog_flag_name          uint_t
  50 SMB_IPMI_F_     smbios_ipmi_flag_name           uint_t
  51 SMB_POWERSUP_F_ smbios_powersup_flag_name       uint_t
  52 SMB_MDF_        smbios_memdevice_flag_name      uint_t
  53 SMB_PRC_        smbios_processor_core_flag_name uint_t
  54 SMB_TYPE_       smbios_type_name                uint_t
  55 SMB_SLCH1_      smbios_slot_ch1_name            uint_t
  56 SMB_SLCH2_      smbios_slot_ch2_name            uint_t
  57 '
  58
  59 desc_funcs='
  60 SMB_BBFL_       smbios_bboard_flag_desc         uint_t
  61 SMB_BBT_        smbios_bboard_type_desc         uint_t
  62 SMB_BIOSFL_     smbios_bios_flag_desc           uint64_t
  63 SMB_BIOSXB1_    smbios_bios_xb1_desc            uint_t
  64 SMB_BIOSXB2_    smbios_bios_xb2_desc            uint_t
  65 SMB_BOOT_       smbios_boot_desc                uint_t
  66 SMB_CAA_        smbios_cache_assoc_desc         uint_t
  67 SMB_CAT_        smbios_cache_ctype_desc         uint_t
  68 SMB_CAE_        smbios_cache_ecc_desc           uint_t
  69 SMB_CAF_        smbios_cache_flag_desc          uint_t
  70 SMB_CAL_        smbios_cache_loc_desc           uint_t
  71 SMB_CAG_        smbios_cache_logical_desc       uint_t
  72 SMB_CAM_        smbios_cache_mode_desc          uint_t
  73 SMB_CHST_       smbios_chassis_state_desc       uint_t
  74 SMB_CHT_        smbios_chassis_type_desc        uint_t
  75 SMB_COOLDEV_S_  smbios_cooldev_status_desc      uint_t
  76 SMB_COOLDEV_T_  smbios_cooldev_type_desc        uint_t
  77 SMB_EVFL_       smbios_evlog_flag_desc          uint_t
  78 SMB_EVHF_       smbios_evlog_format_desc        uint_t
  79 SMB_EVM_        smbios_evlog_method_desc        uint_t
  80 SMB_HWSEC_PS_   smbios_hwsec_desc               uint_t
  81 SMB_IPMI_F_     smbios_ipmi_flag_desc           uint_t
  82 SMB_IPMI_T_     smbios_ipmi_type_desc           uint_t
  83 SMB_IPROBE_L_   smbios_iprobe_loc_desc          uint_t
  84 SMB_IPROBE_S_   smbios_iprobe_status_desc       uint_t
  85 SMB_POWERSUP_F_ smbios_powersup_flag_desc       uint_t
  86 SMB_POWERSUP_I_ smbios_powersup_input_desc      uint_t
  87 SMB_POWERSUP_S_ smbios_powersup_status_desc     uint_t
  88 SMB_POWERSUP_T_ smbios_powersup_type_desc       uint_t
  89 SMB_MAL_        smbios_memarray_loc_desc        uint_t
  90 SMB_MAU_        smbios_memarray_use_desc        uint_t
  91 SMB_MAE_        smbios_memarray_ecc_desc        uint_t
  92 SMB_MDF_        smbios_memdevice_flag_desc      uint_t
  93 SMB_MDFF_       smbios_memdevice_form_desc      uint_t
  94 SMB_MDT_        smbios_memdevice_type_desc      uint_t
  95 SMB_MDR_        smbios_memdevice_rank_desc      uint_t
  96 SMB_OBT_        smbios_onboard_type_desc        uint_t
  97 SMB_POC_        smbios_port_conn_desc           uint_t
  98 SMB_POT_        smbios_port_type_desc           uint_t
  99 SMB_PRC_        smbios_processor_core_flag_desc uint_t
 100 SMB_PRF_        smbios_processor_family_desc    uint_t
 101 SMB_PRS_        smbios_processor_status_desc    uint_t
 102 SMB_PRT_        smbios_processor_type_desc      uint_t
 103 SMB_PRU_        smbios_processor_upgrade_desc   uint_t
 104 SMB_SLCH1_      smbios_slot_ch1_desc            uint_t
 105 SMB_SLCH2_      smbios_slot_ch2_desc            uint_t
 106 SMB_SLL_        smbios_slot_length_desc         uint_t
 107 SMB_SLT_        smbios_slot_type_desc           uint_t
 108 SMB_SLU_        smbios_slot_usage_desc          uint_t
 109 SMB_SLW_        smbios_slot_width_desc          uint_t
 110 SMB_TPROBE_L_   smbios_tprobe_loc_desc          uint_t
 111 SMB_TPROBE_S_   smbios_tprobe_status_desc       uint_t
 112 SMB_TYPE_       smbios_type_desc                uint_t
 113 SMB_VPROBE_L_   smbios_vprobe_loc_desc          uint_t
 114 SMB_VPROBE_S_   smbios_vprobe_status_desc       uint_t
 115 SMB_WAKEUP_     smbios_system_wakeup_desc       uint_t
 116 '
 117
 118 if [ $# -ne 1 ]; then
 119         echo "Usage: $0 file.h > file.c" >&2
 120         exit 2
 121 fi
 122
 123 echo "\
 124 /*\n\
 125  * Copyright 2015 OmniTI Computer Consulting, Inc.  All rights reserved.\n\
 126  * Copyright 2005 Sun Microsystems, Inc.  All rights reserved.\n\
 127  * Use is subject to license terms.\n\
 128  */\n\
 129 \n\
 130 #include <smbios.h>"
 131
 132 echo "$name_funcs" | while read p name type; do
 133         [ -z "$p" ] && continue
 134         pattern="^#define[       ]\($p[A-Za-z0-9_]*\)[   ]*[A-Z0-9]*.*$"
 135         replace='       case \1: return ("\1");'
 136
 137         echo "\nconst char *\n$name($type x)\n{\n\tswitch (x) {"
 138         sed -n "s@$pattern@$replace@p" < $1 || exit 1
 139         echo "\t}\n\treturn (NULL);\n}"
 140 done
 141
 142 #
 143 # Generate the description functions based on the comment next to a #define.
 144 # The transformations for descriptive comments are slightly more complicated
 145 # than those used for the identifier->name functions above:
 146 #
 147 # (1) strip any [RO] suffix from the comment (a header file convention)
 148 # (2) replace any " with \" so it is escaped for the final output string
 149 # (3) replace return (...); with return ("..."); to finish the code
 150 #
 151 echo "$desc_funcs" | while read p name type; do
 152         [ -z "$p" ] && continue
 153         pattern="^#define[       ]\($p[A-Za-z0-9_]*\)[   ]*.*/\\* \(.*\) \\*/$"
 154         replace='       case \1: return (\2);'
 155
 156         echo "\nconst char *\n$name($type x)\n{\n\tswitch (x) {"
 157         sed -n "s@$pattern@$replace@p" < $1 | sed 's/ ([RO]))/)/' | \
 158             sed 's/"/\\"/g' | sed 's/(/("/;s/);$/");/' || exit 1
 159         echo "\t}\n\treturn (NULL);\n}"
 160 done
 161
 162 exit 0