From mboxrd@z Thu Jan 1 00:00:00 1970 Authentication-Results: mx.groups.io; dkim=missing; spf=pass (domain: intel.com, ip: 134.134.136.31, mailfrom: michael.d.kinney@intel.com) Received: from mga06.intel.com (mga06.intel.com [134.134.136.31]) by groups.io with SMTP; Fri, 14 Jun 2019 08:06:40 -0700 X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga003.fm.intel.com ([10.253.24.29]) by orsmga104.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 14 Jun 2019 08:06:39 -0700 X-ExtLoop1: 1 Received: from orsmsx103.amr.corp.intel.com ([10.22.225.130]) by FMSMGA003.fm.intel.com with ESMTP; 14 Jun 2019 08:06:38 -0700 Received: from orsmsx113.amr.corp.intel.com ([169.254.9.248]) by ORSMSX103.amr.corp.intel.com ([169.254.5.232]) with mapi id 14.03.0415.000; Fri, 14 Jun 2019 08:06:38 -0700 From: "Michael D Kinney" To: "devel@edk2.groups.io" , "Zhang, Shenglei" , "Kinney, Michael D" CC: "Fan, ZhijuX" , "Feng, Bob C" , "Gao, Liming" Subject: Re: [edk2-devel] [PATCH] BaseTools/GenBiosId: Add a new tool GenBiosId Thread-Topic: [edk2-devel] [PATCH] BaseTools/GenBiosId: Add a new tool GenBiosId Thread-Index: AQHVIoRGO4FUMXHcH0uB+9sNKmdrpqabP4bg Date: Fri, 14 Jun 2019 15:06:37 +0000 Message-ID: References: <20190614073855.14788-1-shenglei.zhang@intel.com> In-Reply-To: <20190614073855.14788-1-shenglei.zhang@intel.com> Accept-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: dlp-product: dlpe-windows dlp-version: 11.0.600.7 dlp-reaction: no-action x-originating-ip: [10.22.254.140] MIME-Version: 1.0 Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Thank you for converting to Python. Please use python argparse module to parse arguments and make sure the tool supports the standard EDK II tool command line arguments. BinToPcd is a good example: https://github.com/tianocore/edk2/blob/master/BaseTools/Scripts/BinToPcd.p= y Mike > -----Original Message----- > From: devel@edk2.groups.io [mailto:devel@edk2.groups.io] > On Behalf Of Zhang, Shenglei > Sent: Friday, June 14, 2019 12:39 AM > To: devel@edk2.groups.io > Cc: Fan, ZhijuX ; Feng, Bob C > ; Gao, Liming > > Subject: [edk2-devel] [PATCH] BaseTools/GenBiosId: Add a > new tool GenBiosId >=20 > From: "Fan, Zhiju" >=20 > GenBiosId is a tool to generate the BIOS ID binary file > which uses the data from the configuration file. > https://bugzilla.tianocore.org/show_bug.cgi?id=3D1846 >=20 > v2:v1 is a tool of C type and v2 is python type. >=20 > Cc: Bob Feng > Cc: Liming Gao > Signed-off-by: Shenglei Zhang > --- > BaseTools/BinWrappers/PosixLike/GenBiosId | 14 +++ > .../BinWrappers/WindowsLike/GenBiosId.bat | 3 + > BaseTools/Source/Python/GenBiosId/BiosId.env | 27 > +++++ > .../Source/Python/GenBiosId/GenBiosId.py | 108 > ++++++++++++++++++ > 4 files changed, 152 insertions(+) > create mode 100644 > BaseTools/BinWrappers/PosixLike/GenBiosId > create mode 100644 > BaseTools/BinWrappers/WindowsLike/GenBiosId.bat > create mode 100644 > BaseTools/Source/Python/GenBiosId/BiosId.env > create mode 100644 > BaseTools/Source/Python/GenBiosId/GenBiosId.py >=20 > diff --git a/BaseTools/BinWrappers/PosixLike/GenBiosId > b/BaseTools/BinWrappers/PosixLike/GenBiosId > new file mode 100644 > index 000000000000..9fb68299e4c6 > --- /dev/null > +++ b/BaseTools/BinWrappers/PosixLike/GenBiosId > @@ -0,0 +1,14 @@ > +#!/usr/bin/env bash > +#python `dirname $0`/RunToolFromSource.py `basename $0` > $* > + > +# If a ${PYTHON_COMMAND} command is available, use it in > preference to > +python if command -v ${PYTHON_COMMAND} >/dev/null 2>&1; > then > + python_exe=3D${PYTHON_COMMAND} > +fi > + > +full_cmd=3D${BASH_SOURCE:-$0} # see > +http://mywiki.wooledge.org/BashFAQ/028 for a discussion > of why $0 is > +not a good choice here dir=3D$(dirname "$full_cmd") > exe=3D$(basename > +"$full_cmd") > + > +export > PYTHONPATH=3D"$dir/../../Source/Python${PYTHONPATH:+:"$PYTH > ONPATH"}" > +exec "${python_exe:-python}" > "$dir/../../Source/Python/$exe/$exe.py" "$@" > diff --git > a/BaseTools/BinWrappers/WindowsLike/GenBiosId.bat > b/BaseTools/BinWrappers/WindowsLike/GenBiosId.bat > new file mode 100644 > index 000000000000..9616cd893bec > --- /dev/null > +++ b/BaseTools/BinWrappers/WindowsLike/GenBiosId.bat > @@ -0,0 +1,3 @@ > +@setlocal > +@set ToolName=3D%~n0% > +@%PYTHON_COMMAND% > +%BASE_TOOLS_PATH%\Source\Python\%ToolName%\%ToolName%.py > %* > diff --git a/BaseTools/Source/Python/GenBiosId/BiosId.env > b/BaseTools/Source/Python/GenBiosId/BiosId.env > new file mode 100644 > index 000000000000..92805e3cb78c > --- /dev/null > +++ b/BaseTools/Source/Python/GenBiosId/BiosId.env > @@ -0,0 +1,27 @@ > +## @file > +# This file is used to define the BIOS ID parameters of > the build. > +# This file is processed by GenBiosId. > +# Here, it is just a template and can be customized by > user. > +# > +# BIOS ID string format: > +# > $(BOARD_ID)$(BOARD_REV).$(BOARD_EXT).$(VERSION_MAJOR).$(B > UILD_TYPE)$(VERSION_MINOR).YYMMDDHHMM > +# All fields must have a fixed length. YYMMDDHHMM is > UTC time. > +# Example: "EMLATOR1.000.0001.D01.1906141517" > +# > +# If DATE is specified for YYMMDD and TIME is specified > for HHMM like > +below, # GenBiosId will use the value of DATE and TIME > to fill > +YYMMDDHHMM, # otherwise GenBiosId will fill YYMMDDHHMM > with current UTC time of the build machine. > +# DATE =3D 190614 > +# TIME =3D 1517 > +# > +# Copyright (c) 2019, Intel Corporation. All rights > reserved.
# > +SPDX-License-Identifier: BSD-2-Clause-Patent # ## > [config] > +BOARD_ID =3D EMLATOR > +BOARD_REV =3D 1 > +BOARD_EXT =3D 000 > +BUILD_TYPE =3D D > +VERSION_MAJOR =3D 0001 > +VERSION_MINOR =3D 01 > diff --git > a/BaseTools/Source/Python/GenBiosId/GenBiosId.py > b/BaseTools/Source/Python/GenBiosId/GenBiosId.py > new file mode 100644 > index 000000000000..1be99f4a5931 > --- /dev/null > +++ b/BaseTools/Source/Python/GenBiosId/GenBiosId.py > @@ -0,0 +1,108 @@ > +## @file > +# Trim files preprocessed by compiler > +# > +# Copyright (c) 2019, Intel Corporation. All rights > reserved.
# > +SPDX-License-Identifier: BSD-2-Clause-Patent # > + > +## > +# Import Modules > +# > +import Common.LongFilePathOs as os > +import sys > +import struct > +import time > +import datetime > +try: > + from configparser import ConfigParser > +except: > + from ConfigParser import ConfigParser from > Common.BuildToolError > +import * from Common.Misc import * from Common.DataType > import * from > +Common.BuildVersion import gBUILD_VERSION import > Common.EdkLogger as > +EdkLogger from Common.LongFilePathSupport import > OpenLongFilePath as > +open > + > +_BIOS_Signature =3D "$IBIOSI$" > +_SectionKeyName =3D '__name__' > +_SectionName =3D 'config' > + > +_ConfigItem =3D { > + "BOARD_ID" : {'Value' : '', 'Length' : 7}, > + "BOARD_REV" : {'Value' : '', 'Length' : 1}, > + "BOARD_EXT" : { 'Value' : '', 'Length' : 3}, > + "BUILD_TYPE" : {'Value' : '', 'Length' :1}, > + "VERSION_MAJOR" : {'Value' : '0000', 'Length' : 4}, > + "VERSION_MINOR" : {'Value' : '00', 'Length' : 2}, > + > +} > + > + > +_Usage =3D "Usage: GenBiosId -i Configfile -o OutputFile > [-ob OutputBatchFile]" > +_ConfigSectionNotDefine =3D "Not support the config file > format, need config section" > +_ConfigLenInvalid =3D "Config item %s length is invalid" > +_ConfigItemInvalid =3D "Item %s is invalid" > + > +def Main(): > + try: > + EdkLogger.Initialize() > + if len(sys.argv) !=3D5 and len(sys.argv) !=3D 7: > + EdkLogger.error("GenBiosId", OPTION_MISSING, > ExtraData=3D_Usage) > + except FatalError as X: > + return 1 > + InputFile =3D '' > + OutputFile =3D '' > + OutputBatchFile =3D '' > + for Index, Item in enumerate(sys.argv): > + if '-i' =3D=3D Item: > + InputFile =3D sys.argv[Index + 1] > + if '-o' =3D=3D Item: > + OutputFile =3D sys.argv[Index + 1] > + if '-ob' =3D=3D Item: > + OutputBatchFile =3D sys.argv[Index + 1] > + if not os.path.exists(InputFile): > + EdkLogger.error("GenBiosId", FILE_NOT_FOUND, > ExtraData=3D"Input file not found") > + cf =3D ConfigParser() > + cf.optionxform =3D str > + cf.read(InputFile) > + if _SectionName not in cf._sections: > + EdkLogger.error("GenBiosId", > FORMAT_NOT_SUPPORTED, ExtraData=3D_ConfigSectionNotDefine) > + for Item in cf._sections[_SectionName]: > + if Item =3D=3D _SectionKeyName: > + continue > + if Item not in _ConfigItem: > + EdkLogger.error("GenBiosId", FORMAT_INVALID, > ExtraData=3D_ConfigItemInvalid % Item) > + _ConfigItem[Item]['Value'] =3D > cf._sections[_SectionName][Item] > + if len(_ConfigItem[Item]['Value']) !=3D > _ConfigItem[Item]['Length']: > + EdkLogger.error("GenBiosId", FORMAT_INVALID, > ExtraData=3D_ConfigLenInvalid % Item) > + for Item in _ConfigItem: > + if not _ConfigItem[Item]['Value']: > + EdkLogger.error("GenBiosId", > FORMAT_UNKNOWN_ERROR, ExtraData=3D"Item %s is missing" % > Item) > + utcnow =3D datetime.datetime.utcnow() > + TimeStamp =3D time.strftime("%y%m%d%H%M", > utcnow.timetuple()) > + > + Id_Str =3D _ConfigItem['BOARD_ID']['Value'] + > _ConfigItem['BOARD_REV']['Value'] + '.' + > _ConfigItem['BOARD_EXT']['Value'] + '.' + > _ConfigItem['VERSION_MAJOR']['Value'] + \ > + '.' + _ConfigItem["BUILD_TYPE"]['Value'] + > _ConfigItem['VERSION_MINOR']['Value'] + '.' + TimeStamp > + with open(OutputFile, 'wb') as FdOut: > + for i in _BIOS_Signature: > + FdOut.write(struct.pack('B', ord(i))) > + > + for i in Id_Str: > + FdOut.write(struct.pack('H', ord(i))) > + > + FdOut.write(struct.pack('H', 0x00)) > + if OutputBatchFile: > + with open(OutputBatchFile, 'w') as FdOut: > + if sys.platform.startswith('win'): > + Id_Str =3D 'SET BIOS_ID=3D' + Id_Str > + else: > + Id_Str =3D 'export BIOS_ID=3D' + Id_Str > + FdOut.write(Id_Str) > + return 0 > + > +if __name__ =3D=3D '__main__': > + r =3D Main() > + ## 0-127 is a safe return range, and 1 is a standard > default error > + if r < 0 or r > 127: r =3D 1 > + sys.exit(r) > -- > 2.18.0.windows.1 >=20 >=20 >=20