Re: [edk2] [Patch] BaseTools/Scripts: Add BinToPcd utility
Liming,
Thanks for catching this case. I will send a V2 patch
Mike
From: Gao, Liming
Sent: Sunday, November 13, 2016 6:58 PM
To: Gao, Liming <liming@intel.com>; Kinney, Michael D
<michael.d.kin...@intel.com>; edk2-devel@lists.01.org
Subject: RE: [edk2] [Patch] BaseTools/Scripts: Add BinToPcd utility
Mike:
Per DSC spec, MaxSize supports all type PCDs. Here is one example in NT32Pkg
DSC file. Could you help update BinToPcd utility to remove MaxSize limitation
for VPD only?
[PcdsDynamicDefault.common.DEFAULT]
gEfiNt32PkgTokenSpaceGuid.PcdWinNtSerialPort|L"COM1!COM2"|VOID*|20
gEfiNt32PkgTokenSpaceGuid.PcdWinNtGop|L"UGA Window 1!UGA Window 2"|VOID*|52
Thanks
Liming
From: edk2-devel [mailto:edk2-devel-boun...@lists.01.org] On Behalf Of Gao,
Liming
Sent: Friday, November 11, 2016 8:14 AM
To: Kinney, Michael D
<michael.d.kin...@intel.com<mailto:michael.d.kin...@intel.com>>;
edk2-devel@lists.01.org<mailto:edk2-devel@lists.01.org>
Subject: Re: [edk2] [Patch] BaseTools/Scripts: Add BinToPcd utility
Mike:
Thanks for your clarification. This way works for me.
Thanks
Liming
From: Kinney, Michael D
Sent: Friday, November 11, 2016 12:46 AM
To: Gao, Liming ; edk2-devel@lists.01.org<mailto:edk2-devel@lists.01.org>;
Kinney, Michael D
Subject: RE: [edk2] [Patch] BaseTools/Scripts: Add BinToPcd utility
Liming,
There are several ways that BinPcd can produce output files.
* Use -o, --output flag (e.g. -o test.pcd)
* Use output redirection > (e.g. > test.pcd)
* Use output redirection with append >> (e.g. >> test.pcd)
Here is an example using append with current patch:
BinToPcd.py -i test1.bin -p MyTokenSpaceGuid.MyToken1 > test.pcd
BinToPcd.py -i test2.bin -p MyTokenSpaceGuid.MyToken2 >> test.pcd
Here is sample output:
MyTokenSpaceGuid.MyToken1|{0x68, 0x65, 0x6c, 0x6c, 0x6f, 0x20, 0x0d, 0x0a}
MyTokenSpaceGuid.MyToken2|{0x57, 0x6f, 0x72, 0x6c, 0x64, 0x20, 0x0d, 0x0a}
Same with -t VPD flag added
MyTokenSpaceGuid.MyToken1|*|8|{0x68, 0x65, 0x6c, 0x6c, 0x6f, 0x20, 0x0d, 0x0a}
MyTokenSpaceGuid.MyToken2|*|8|{0x57, 0x6f, 0x72, 0x6c, 0x64, 0x20, 0x0d, 0x0a}
Best regards,
Mike
From: Gao, Liming
Sent: Thursday, November 10, 2016 8:23 AM
To: Kinney, Michael D ; edk2-devel@lists.01.org<mailto:edk2-devel@lists.01.org>
Subject: RE: [edk2] [Patch] BaseTools/Scripts: Add BinToPcd utility
Yes. Wiki is good enough.
For second one, I understand its complexity. Append is optional option. Users
will decide to use it or not. I don't expect to add every file for every PCD.
From: Kinney, Michael D
Sent: Friday, November 11, 2016 12:11 AM
To: Gao, Liming ; edk2-devel@lists.01.org<mailto:edk2-devel@lists.01.org>;
Kinney, Michael D
Subject: RE: [edk2] [Patch] BaseTools/Scripts: Add BinToPcd utility
Liming,
This utility would not used as part of a build.
I put it in BaseTools/Scripts because it is intended to be a helper
tool for developers. I have been writing the Wiki on the Capsule
Based System Firmware Update and there are development steps in that
Wiki that will be simpler if this utility was available, so I plan on
demonstrating real use of this utility in that Wiki. Will that address
your feedback?
The append concept is very complex because this utility can generate
PCD statements for all the supported DSC PCD section types. So we
can not append 2 PCDs with different types. I prefer to do one PCD
at a time and developer can choose to combine or not into one file.
Thanks,
Mike
> -Original Message-
> From: Gao, Liming
> Sent: Thursday, November 10, 2016 6:37 AM
> To: Kinney, Michael D ;
> edk2-devel@lists.01.org<mailto:edk2-devel@lists.01.org>
> Subject: RE: [edk2] [Patch] BaseTools/Scripts: Add BinToPcd utility
>
> Mike:
> I have two comments.
> 1) Could you also provide the patch to use this utility in edk2 platform,
> such as
> quark platform?
> 2) Suggest to support append mode as one option. If so, we can use this
> utility
> to dump more one PCD values into one file.
>
> Thanks
> Liming
> -Original Message-
> From: edk2-devel [mailto:edk2-devel-boun...@lists.01.org] On Behalf Of Michael
> Kinney
> Sent: Wednesday, November 9, 2016 7:45 AM
> To: edk2-devel@lists.01.org<mailto:edk2-devel@lists.01.org>
> Cc: Gao, Liming
> Subject: [edk2] [Patch] BaseTools/Scripts: Add BinToPcd utility
>
> Add a utility that converts a binary file into a VOID* PCD value
> or a full DSC file VOID* PCD statement with support for all the
> DSC supported PCD sections.
>
> usage: BinToPcd [-h] [--version] -i INPUTFILE [-o OUTPUTFILE] [-p PCDNAME]
> [-t {VPD,HII}] [-m MAXSIZE] [-f OFFSET] [-n VARIABLENAME]
> [-g VARIABLEGUID] [-v] [-q] [--debug [0-9]]
>
> Convert a binary file to a VOID* PCD value or DSC file VOID* PCD statement.
> Copyright (c) 2016, Intel Corporation. All rights reserved.
Re: [edk2] [Patch] BaseTools/Scripts: Add BinToPcd utility
Mike:
Per DSC spec, MaxSize supports all type PCDs. Here is one example in NT32Pkg
DSC file. Could you help update BinToPcd utility to remove MaxSize limitation
for VPD only?
[PcdsDynamicDefault.common.DEFAULT]
gEfiNt32PkgTokenSpaceGuid.PcdWinNtSerialPort|L"COM1!COM2"|VOID*|20
gEfiNt32PkgTokenSpaceGuid.PcdWinNtGop|L"UGA Window 1!UGA Window 2"|VOID*|52
Thanks
Liming
From: edk2-devel [mailto:edk2-devel-boun...@lists.01.org] On Behalf Of Gao,
Liming
Sent: Friday, November 11, 2016 8:14 AM
To: Kinney, Michael D <michael.d.kin...@intel.com>; edk2-devel@lists.01.org
Subject: Re: [edk2] [Patch] BaseTools/Scripts: Add BinToPcd utility
Mike:
Thanks for your clarification. This way works for me.
Thanks
Liming
From: Kinney, Michael D
Sent: Friday, November 11, 2016 12:46 AM
To: Gao, Liming ; edk2-devel@lists.01.org<mailto:edk2-devel@lists.01.org>;
Kinney, Michael D
Subject: RE: [edk2] [Patch] BaseTools/Scripts: Add BinToPcd utility
Liming,
There are several ways that BinPcd can produce output files.
* Use -o, --output flag (e.g. -o test.pcd)
* Use output redirection > (e.g. > test.pcd)
* Use output redirection with append >> (e.g. >> test.pcd)
Here is an example using append with current patch:
BinToPcd.py -i test1.bin -p MyTokenSpaceGuid.MyToken1 > test.pcd
BinToPcd.py -i test2.bin -p MyTokenSpaceGuid.MyToken2 >> test.pcd
Here is sample output:
MyTokenSpaceGuid.MyToken1|{0x68, 0x65, 0x6c, 0x6c, 0x6f, 0x20, 0x0d, 0x0a}
MyTokenSpaceGuid.MyToken2|{0x57, 0x6f, 0x72, 0x6c, 0x64, 0x20, 0x0d, 0x0a}
Same with -t VPD flag added
MyTokenSpaceGuid.MyToken1|*|8|{0x68, 0x65, 0x6c, 0x6c, 0x6f, 0x20, 0x0d, 0x0a}
MyTokenSpaceGuid.MyToken2|*|8|{0x57, 0x6f, 0x72, 0x6c, 0x64, 0x20, 0x0d, 0x0a}
Best regards,
Mike
From: Gao, Liming
Sent: Thursday, November 10, 2016 8:23 AM
To: Kinney, Michael D ; edk2-devel@lists.01.org<mailto:edk2-devel@lists.01.org>
Subject: RE: [edk2] [Patch] BaseTools/Scripts: Add BinToPcd utility
Yes. Wiki is good enough.
For second one, I understand its complexity. Append is optional option. Users
will decide to use it or not. I don't expect to add every file for every PCD.
From: Kinney, Michael D
Sent: Friday, November 11, 2016 12:11 AM
To: Gao, Liming ; edk2-devel@lists.01.org<mailto:edk2-devel@lists.01.org>;
Kinney, Michael D
Subject: RE: [edk2] [Patch] BaseTools/Scripts: Add BinToPcd utility
Liming,
This utility would not used as part of a build.
I put it in BaseTools/Scripts because it is intended to be a helper
tool for developers. I have been writing the Wiki on the Capsule
Based System Firmware Update and there are development steps in that
Wiki that will be simpler if this utility was available, so I plan on
demonstrating real use of this utility in that Wiki. Will that address
your feedback?
The append concept is very complex because this utility can generate
PCD statements for all the supported DSC PCD section types. So we
can not append 2 PCDs with different types. I prefer to do one PCD
at a time and developer can choose to combine or not into one file.
Thanks,
Mike
> -Original Message-
> From: Gao, Liming
> Sent: Thursday, November 10, 2016 6:37 AM
> To: Kinney, Michael D ;
> edk2-devel@lists.01.org<mailto:edk2-devel@lists.01.org>
> Subject: RE: [edk2] [Patch] BaseTools/Scripts: Add BinToPcd utility
>
> Mike:
> I have two comments.
> 1) Could you also provide the patch to use this utility in edk2 platform,
> such as
> quark platform?
> 2) Suggest to support append mode as one option. If so, we can use this
> utility
> to dump more one PCD values into one file.
>
> Thanks
> Liming
> -Original Message-
> From: edk2-devel [mailto:edk2-devel-boun...@lists.01.org] On Behalf Of Michael
> Kinney
> Sent: Wednesday, November 9, 2016 7:45 AM
> To: edk2-devel@lists.01.org<mailto:edk2-devel@lists.01.org>
> Cc: Gao, Liming
> Subject: [edk2] [Patch] BaseTools/Scripts: Add BinToPcd utility
>
> Add a utility that converts a binary file into a VOID* PCD value
> or a full DSC file VOID* PCD statement with support for all the
> DSC supported PCD sections.
>
> usage: BinToPcd [-h] [--version] -i INPUTFILE [-o OUTPUTFILE] [-p PCDNAME]
> [-t {VPD,HII}] [-m MAXSIZE] [-f OFFSET] [-n VARIABLENAME]
> [-g VARIABLEGUID] [-v] [-q] [--debug [0-9]]
>
> Convert a binary file to a VOID* PCD value or DSC file VOID* PCD statement.
> Copyright (c) 2016, Intel Corporation. All rights reserved.
>
> optional arguments:
> -h, --help show this help message and exit
> --version show program's version number and exit
> -i INPUTFILE, --input INPUTFILE
> Input binary filename
> -o OUTPUTFILE, --output OUTPUTFILE
> Output filename for PCD value or PCD statement
> -p PCDNAME, --pcd PCDNAME
> Name of the PCD in the form
> .
> -t {VPD,HII}, --type {VPD,HII}
> PCD
Re: [edk2] [Patch] BaseTools/Scripts: Add BinToPcd utility
Liming,
There are several ways that BinPcd can produce output files.
* Use -o, --output flag (e.g. -o test.pcd)
* Use output redirection > (e.g. > test.pcd)
* Use output redirection with append >> (e.g. >> test.pcd)
Here is an example using append with current patch:
BinToPcd.py -i test1.bin -p MyTokenSpaceGuid.MyToken1 > test.pcd
BinToPcd.py -i test2.bin -p MyTokenSpaceGuid.MyToken2 >> test.pcd
Here is sample output:
MyTokenSpaceGuid.MyToken1|{0x68, 0x65, 0x6c, 0x6c, 0x6f, 0x20, 0x0d, 0x0a}
MyTokenSpaceGuid.MyToken2|{0x57, 0x6f, 0x72, 0x6c, 0x64, 0x20, 0x0d, 0x0a}
Same with -t VPD flag added
MyTokenSpaceGuid.MyToken1|*|8|{0x68, 0x65, 0x6c, 0x6c, 0x6f, 0x20, 0x0d, 0x0a}
MyTokenSpaceGuid.MyToken2|*|8|{0x57, 0x6f, 0x72, 0x6c, 0x64, 0x20, 0x0d, 0x0a}
Best regards,
Mike
From: Gao, Liming
Sent: Thursday, November 10, 2016 8:23 AM
To: Kinney, Michael D <michael.d.kin...@intel.com>; edk2-devel@lists.01.org
Subject: RE: [edk2] [Patch] BaseTools/Scripts: Add BinToPcd utility
Yes. Wiki is good enough.
For second one, I understand its complexity. Append is optional option. Users
will decide to use it or not. I don't expect to add every file for every PCD.
From: Kinney, Michael D
Sent: Friday, November 11, 2016 12:11 AM
To: Gao, Liming <liming@intel.com>; edk2-devel@lists.01.org; Kinney,
Michael D <michael.d.kin...@intel.com>
Subject: RE: [edk2] [Patch] BaseTools/Scripts: Add BinToPcd utility
Liming,
This utility would not used as part of a build.
I put it in BaseTools/Scripts because it is intended to be a helper
tool for developers. I have been writing the Wiki on the Capsule
Based System Firmware Update and there are development steps in that
Wiki that will be simpler if this utility was available, so I plan on
demonstrating real use of this utility in that Wiki. Will that address
your feedback?
The append concept is very complex because this utility can generate
PCD statements for all the supported DSC PCD section types. So we
can not append 2 PCDs with different types. I prefer to do one PCD
at a time and developer can choose to combine or not into one file.
Thanks,
Mike
> -Original Message-
> From: Gao, Liming
> Sent: Thursday, November 10, 2016 6:37 AM
> To: Kinney, Michael D ; edk2-devel@lists.01.org
> Subject: RE: [edk2] [Patch] BaseTools/Scripts: Add BinToPcd utility
>
> Mike:
> I have two comments.
> 1) Could you also provide the patch to use this utility in edk2 platform,
> such as
> quark platform?
> 2) Suggest to support append mode as one option. If so, we can use this
> utility
> to dump more one PCD values into one file.
>
> Thanks
> Liming
> -Original Message-
> From: edk2-devel [mailto:edk2-devel-boun...@lists.01.org] On Behalf Of Michael
> Kinney
> Sent: Wednesday, November 9, 2016 7:45 AM
> To: edk2-devel@lists.01.org
> Cc: Gao, Liming
> Subject: [edk2] [Patch] BaseTools/Scripts: Add BinToPcd utility
>
> Add a utility that converts a binary file into a VOID* PCD value
> or a full DSC file VOID* PCD statement with support for all the
> DSC supported PCD sections.
>
> usage: BinToPcd [-h] [--version] -i INPUTFILE [-o OUTPUTFILE] [-p PCDNAME]
> [-t {VPD,HII}] [-m MAXSIZE] [-f OFFSET] [-n VARIABLENAME]
> [-g VARIABLEGUID] [-v] [-q] [--debug [0-9]]
>
> Convert a binary file to a VOID* PCD value or DSC file VOID* PCD statement.
> Copyright (c) 2016, Intel Corporation. All rights reserved.
>
> optional arguments:
> -h, --help show this help message and exit
> --version show program's version number and exit
> -i INPUTFILE, --input INPUTFILE
> Input binary filename
> -o OUTPUTFILE, --output OUTPUTFILE
> Output filename for PCD value or PCD statement
> -p PCDNAME, --pcd PCDNAME
> Name of the PCD in the form
> .
> -t {VPD,HII}, --type {VPD,HII}
> PCD statement type (HII or VPD). Default is standard.
> -m MAXSIZE, --max-size MAXSIZE
> Maximum size of the PCD. Only used with --type VPD.
> -f OFFSET, --offset OFFSET
> VPD offset if --type is VPD. UEFI Variable offset if
> --type is HII.
> -n VARIABLENAME, --variable-name VARIABLENAME
> UEFI variable name. Only used with --type HII.
> -g VARIABLEGUID, --variable-guid VARIABLEGUID
> UEFI variable GUID C name. Only used with --type HII.
> -v, --verbose Increase output messages
> -q, --quiet Reduce output messages
> --debug [0-9] Set debug level
>
> This utility can be used in PCD value mode to convert a binary
> file into a string that can then be copied into the PCD value field
> of a VOID* PCD. The following is an example of PCD value mode on
> an 8 byte test.bin file.
>
> BinToPcd.py -i test.bin
>
> {0x48, 0x65, 0x6c, 0x6c, 0x6f, 0x20, 0x0d, 0x0a}
>
> The DSC file VOID* PCD statement mode can be used to generate a
> comple
Re: [edk2] [Patch] BaseTools/Scripts: Add BinToPcd utility
Yes. Wiki is good enough.
For second one, I understand its complexity. Append is optional option. Users
will decide to use it or not. I don't expect to add every file for every PCD.
From: Kinney, Michael D
Sent: Friday, November 11, 2016 12:11 AM
To: Gao, Liming <liming@intel.com>; edk2-devel@lists.01.org; Kinney,
Michael D <michael.d.kin...@intel.com>
Subject: RE: [edk2] [Patch] BaseTools/Scripts: Add BinToPcd utility
Liming,
This utility would not used as part of a build.
I put it in BaseTools/Scripts because it is intended to be a helper
tool for developers. I have been writing the Wiki on the Capsule
Based System Firmware Update and there are development steps in that
Wiki that will be simpler if this utility was available, so I plan on
demonstrating real use of this utility in that Wiki. Will that address
your feedback?
The append concept is very complex because this utility can generate
PCD statements for all the supported DSC PCD section types. So we
can not append 2 PCDs with different types. I prefer to do one PCD
at a time and developer can choose to combine or not into one file.
Thanks,
Mike
> -Original Message-
> From: Gao, Liming
> Sent: Thursday, November 10, 2016 6:37 AM
> To: Kinney, Michael D ;
> edk2-devel@lists.01.org<mailto:edk2-devel@lists.01.org>
> Subject: RE: [edk2] [Patch] BaseTools/Scripts: Add BinToPcd utility
>
> Mike:
> I have two comments.
> 1) Could you also provide the patch to use this utility in edk2 platform,
> such as
> quark platform?
> 2) Suggest to support append mode as one option. If so, we can use this
> utility
> to dump more one PCD values into one file.
>
> Thanks
> Liming
> -Original Message-
> From: edk2-devel [mailto:edk2-devel-boun...@lists.01.org] On Behalf Of Michael
> Kinney
> Sent: Wednesday, November 9, 2016 7:45 AM
> To: edk2-devel@lists.01.org<mailto:edk2-devel@lists.01.org>
> Cc: Gao, Liming
> Subject: [edk2] [Patch] BaseTools/Scripts: Add BinToPcd utility
>
> Add a utility that converts a binary file into a VOID* PCD value
> or a full DSC file VOID* PCD statement with support for all the
> DSC supported PCD sections.
>
> usage: BinToPcd [-h] [--version] -i INPUTFILE [-o OUTPUTFILE] [-p PCDNAME]
> [-t {VPD,HII}] [-m MAXSIZE] [-f OFFSET] [-n VARIABLENAME]
> [-g VARIABLEGUID] [-v] [-q] [--debug [0-9]]
>
> Convert a binary file to a VOID* PCD value or DSC file VOID* PCD statement.
> Copyright (c) 2016, Intel Corporation. All rights reserved.
>
> optional arguments:
> -h, --help show this help message and exit
> --version show program's version number and exit
> -i INPUTFILE, --input INPUTFILE
> Input binary filename
> -o OUTPUTFILE, --output OUTPUTFILE
> Output filename for PCD value or PCD statement
> -p PCDNAME, --pcd PCDNAME
> Name of the PCD in the form
> .
> -t {VPD,HII}, --type {VPD,HII}
> PCD statement type (HII or VPD). Default is standard.
> -m MAXSIZE, --max-size MAXSIZE
> Maximum size of the PCD. Only used with --type VPD.
> -f OFFSET, --offset OFFSET
> VPD offset if --type is VPD. UEFI Variable offset if
> --type is HII.
> -n VARIABLENAME, --variable-name VARIABLENAME
> UEFI variable name. Only used with --type HII.
> -g VARIABLEGUID, --variable-guid VARIABLEGUID
> UEFI variable GUID C name. Only used with --type HII.
> -v, --verbose Increase output messages
> -q, --quiet Reduce output messages
> --debug [0-9] Set debug level
>
> This utility can be used in PCD value mode to convert a binary
> file into a string that can then be copied into the PCD value field
> of a VOID* PCD. The following is an example of PCD value mode on
> an 8 byte test.bin file.
>
> BinToPcd.py -i test.bin
>
> {0x48, 0x65, 0x6c, 0x6c, 0x6f, 0x20, 0x0d, 0x0a}
>
> The DSC file VOID* PCD statement mode can be used to generate a
> complete PCD statement for the PCD section types that a DSC file
> supports:
>
> [PcdsFixedAtBuild]
> [PcdsPatchableInModule]
> [PcdsDynamicDefault]
> [PcdsDynamicExDefault]
> [PcdsDynamicVpd]
> [PcdsDynamicExVpd]
> [PcdsDynamicHii]
> [PcdsDynamicExHii]
>
> The PCD statement mode is useful when combined with a !include
> statement in a DSC file. BinToPcd.py can be used to convert a
> binary file to a PCD statement in an output file, and that output
> file can be included into a DSC file in the matching PCD section
> to set the value of the PCD to the value from the binary file
> without having to copy the value into the DSC file. Updates can be
> made to the included file without editing the DSC file. Some
> example use cases are the setting the public key PCDs such as:
>
> gEfiSecurityPkgTokenSpaceGuid.PcdRsa2048Sha256PublicKeyBuffer
> gEfiSecurityPkgTokenSpaceGu
Re: [edk2] [Patch] BaseTools/Scripts: Add BinToPcd utility
Liming,
This utility would not used as part of a build.
I put it in BaseTools/Scripts because it is intended to be a helper
tool for developers. I have been writing the Wiki on the Capsule
Based System Firmware Update and there are development steps in that
Wiki that will be simpler if this utility was available, so I plan on
demonstrating real use of this utility in that Wiki. Will that address
your feedback?
The append concept is very complex because this utility can generate
PCD statements for all the supported DSC PCD section types. So we
can not append 2 PCDs with different types. I prefer to do one PCD
at a time and developer can choose to combine or not into one file.
Thanks,
Mike
> -Original Message-
> From: Gao, Liming
> Sent: Thursday, November 10, 2016 6:37 AM
> To: Kinney, Michael D <michael.d.kin...@intel.com>; edk2-devel@lists.01.org
> Subject: RE: [edk2] [Patch] BaseTools/Scripts: Add BinToPcd utility
>
> Mike:
> I have two comments.
> 1) Could you also provide the patch to use this utility in edk2 platform,
> such as
> quark platform?
> 2) Suggest to support append mode as one option. If so, we can use this
> utility
> to dump more one PCD values into one file.
>
> Thanks
> Liming
> -Original Message-
> From: edk2-devel [mailto:edk2-devel-boun...@lists.01.org] On Behalf Of Michael
> Kinney
> Sent: Wednesday, November 9, 2016 7:45 AM
> To: edk2-devel@lists.01.org
> Cc: Gao, Liming <liming....@intel.com>
> Subject: [edk2] [Patch] BaseTools/Scripts: Add BinToPcd utility
>
> Add a utility that converts a binary file into a VOID* PCD value
> or a full DSC file VOID* PCD statement with support for all the
> DSC supported PCD sections.
>
> usage: BinToPcd [-h] [--version] -i INPUTFILE [-o OUTPUTFILE] [-p PCDNAME]
> [-t {VPD,HII}] [-m MAXSIZE] [-f OFFSET] [-n VARIABLENAME]
> [-g VARIABLEGUID] [-v] [-q] [--debug [0-9]]
>
> Convert a binary file to a VOID* PCD value or DSC file VOID* PCD statement.
> Copyright (c) 2016, Intel Corporation. All rights reserved.
>
> optional arguments:
> -h, --helpshow this help message and exit
> --version show program's version number and exit
> -i INPUTFILE, --input INPUTFILE
> Input binary filename
> -o OUTPUTFILE, --output OUTPUTFILE
> Output filename for PCD value or PCD statement
> -p PCDNAME, --pcd PCDNAME
> Name of the PCD in the form
> .
> -t {VPD,HII}, --type {VPD,HII}
> PCD statement type (HII or VPD). Default is standard.
> -m MAXSIZE, --max-size MAXSIZE
> Maximum size of the PCD. Only used with --type VPD.
> -f OFFSET, --offset OFFSET
> VPD offset if --type is VPD. UEFI Variable offset if
> --type is HII.
> -n VARIABLENAME, --variable-name VARIABLENAME
> UEFI variable name. Only used with --type HII.
> -g VARIABLEGUID, --variable-guid VARIABLEGUID
> UEFI variable GUID C name. Only used with --type HII.
> -v, --verbose Increase output messages
> -q, --quiet Reduce output messages
> --debug [0-9] Set debug level
>
> This utility can be used in PCD value mode to convert a binary
> file into a string that can then be copied into the PCD value field
> of a VOID* PCD. The following is an example of PCD value mode on
> an 8 byte test.bin file.
>
> BinToPcd.py -i test.bin
>
> {0x48, 0x65, 0x6c, 0x6c, 0x6f, 0x20, 0x0d, 0x0a}
>
> The DSC file VOID* PCD statement mode can be used to generate a
> complete PCD statement for the PCD section types that a DSC file
> supports:
>
> [PcdsFixedAtBuild]
> [PcdsPatchableInModule]
> [PcdsDynamicDefault]
> [PcdsDynamicExDefault]
> [PcdsDynamicVpd]
> [PcdsDynamicExVpd]
> [PcdsDynamicHii]
> [PcdsDynamicExHii]
>
> The PCD statement mode is useful when combined with a !include
> statement in a DSC file. BinToPcd.py can be used to convert a
> binary file to a PCD statement in an output file, and that output
> file can be included into a DSC file in the matching PCD section
> to set the value of the PCD to the value from the binary file
> without having to copy the value into the DSC file. Updates can be
> made to the included file without editing the DSC file. Some
> example use cases are the setting the public key PCDs such as:
>
> gEfiSecurityPkgTokenSpaceGuid.PcdRsa2048Sha256PublicKeyBuffer
> gEfiSecurityPkgTokenSpaceGuid.PcdPkcs7CertBuffer
>
> The following example converts a public key binary file to a
> [PcdsFixedAtBuild] compatible PCD statement:
>
> B
Re: [edk2] [Patch] BaseTools/Scripts: Add BinToPcd utility
Mike:
I have two comments.
1) Could you also provide the patch to use this utility in edk2 platform, such
as quark platform?
2) Suggest to support append mode as one option. If so, we can use this utility
to dump more one PCD values into one file.
Thanks
Liming
-Original Message-
From: edk2-devel [mailto:edk2-devel-boun...@lists.01.org] On Behalf Of Michael
Kinney
Sent: Wednesday, November 9, 2016 7:45 AM
To: edk2-devel@lists.01.org
Cc: Gao, Liming <liming@intel.com>
Subject: [edk2] [Patch] BaseTools/Scripts: Add BinToPcd utility
Add a utility that converts a binary file into a VOID* PCD value
or a full DSC file VOID* PCD statement with support for all the
DSC supported PCD sections.
usage: BinToPcd [-h] [--version] -i INPUTFILE [-o OUTPUTFILE] [-p PCDNAME]
[-t {VPD,HII}] [-m MAXSIZE] [-f OFFSET] [-n VARIABLENAME]
[-g VARIABLEGUID] [-v] [-q] [--debug [0-9]]
Convert a binary file to a VOID* PCD value or DSC file VOID* PCD statement.
Copyright (c) 2016, Intel Corporation. All rights reserved.
optional arguments:
-h, --helpshow this help message and exit
--version show program's version number and exit
-i INPUTFILE, --input INPUTFILE
Input binary filename
-o OUTPUTFILE, --output OUTPUTFILE
Output filename for PCD value or PCD statement
-p PCDNAME, --pcd PCDNAME
Name of the PCD in the form
.
-t {VPD,HII}, --type {VPD,HII}
PCD statement type (HII or VPD). Default is standard.
-m MAXSIZE, --max-size MAXSIZE
Maximum size of the PCD. Only used with --type VPD.
-f OFFSET, --offset OFFSET
VPD offset if --type is VPD. UEFI Variable offset if
--type is HII.
-n VARIABLENAME, --variable-name VARIABLENAME
UEFI variable name. Only used with --type HII.
-g VARIABLEGUID, --variable-guid VARIABLEGUID
UEFI variable GUID C name. Only used with --type HII.
-v, --verbose Increase output messages
-q, --quiet Reduce output messages
--debug [0-9] Set debug level
This utility can be used in PCD value mode to convert a binary
file into a string that can then be copied into the PCD value field
of a VOID* PCD. The following is an example of PCD value mode on
an 8 byte test.bin file.
BinToPcd.py -i test.bin
{0x48, 0x65, 0x6c, 0x6c, 0x6f, 0x20, 0x0d, 0x0a}
The DSC file VOID* PCD statement mode can be used to generate a
complete PCD statement for the PCD section types that a DSC file
supports:
[PcdsFixedAtBuild]
[PcdsPatchableInModule]
[PcdsDynamicDefault]
[PcdsDynamicExDefault]
[PcdsDynamicVpd]
[PcdsDynamicExVpd]
[PcdsDynamicHii]
[PcdsDynamicExHii]
The PCD statement mode is useful when combined with a !include
statement in a DSC file. BinToPcd.py can be used to convert a
binary file to a PCD statement in an output file, and that output
file can be included into a DSC file in the matching PCD section
to set the value of the PCD to the value from the binary file
without having to copy the value into the DSC file. Updates can be
made to the included file without editing the DSC file. Some
example use cases are the setting the public key PCDs such as:
gEfiSecurityPkgTokenSpaceGuid.PcdRsa2048Sha256PublicKeyBuffer
gEfiSecurityPkgTokenSpaceGuid.PcdPkcs7CertBuffer
The following example converts a public key binary file to a
[PcdsFixedAtBuild] compatible PCD statement:
BinToPcd.py -i PublicKey.bin -o PublicKey.pcd
--pcd gEfiSecurityPkgTokenSpaceGuid.PcdPkcs7CertBufferkenSpaceGuid
The PublicKey.pcd output file contains a single line:
gEfiSecurityPkgTokenSpaceGuid.PcdPkcs7CertBuffer|{0x48, ...}
A DSC file can be updated to include the PublicKey.pcd file:
[PcdsFixedAtBuild]
!include PublicKey.pcd
VPD examples:
=
BinToPcd.py -i test.bin -p Guid.Token -t VPD
Guid.Name|*|8|{0x48, 0x65, 0x6c, 0x6c, 0x6f, 0x20, 0x0d, 0x0a}
BinToPcd.py -i test.bin -p Guid.Token -t VPD -f 20
Guid.Name|20|8|{0x48, 0x65, 0x6c, 0x6c, 0x6f, 0x20, 0x0d, 0x0a}
BinToPcd.py -i test.bin -p Guid.Token -t VPD -m 10
Guid.Name|*|10|{0x48, 0x65, 0x6c, 0x6c, 0x6f, 0x20, 0x0d, 0x0a}
BinToPcd.py -i test.bin -p Guid.Token -t VPD -f 20 -m 10
Guid.Name|20|10|{0x48, 0x65, 0x6c, 0x6c, 0x6f, 0x20, 0x0d, 0x0a}
HII examples:
=
BinToPcd.py -i test.bin -p Guid.Token -t HII -g VarGuid -n VarName
Guid.Name|L"VarName"|VarGuid|0|{0x48, 0x65, 0x6c, 0x6c}
BinToPcd.py -i test.bin -p Guid.Token -t HII -g VarGuid -n VarName -f 8
Guid.Name|L"VarName"|VarGuid|8|{0x48, 0x65, 0x6c, 0x6c}
Cc: Yonghong Zhu <yonghong@intel.com>
Cc: Liming Gao <liming@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Michael Kinney <michael.d.kin...@intel.com>
---
BaseTools/Scripts/BinToPcd.py | 179 +++
[edk2] [Patch] BaseTools/Scripts: Add BinToPcd utility
Add a utility that converts a binary file into a VOID* PCD value
or a full DSC file VOID* PCD statement with support for all the
DSC supported PCD sections.
usage: BinToPcd [-h] [--version] -i INPUTFILE [-o OUTPUTFILE] [-p PCDNAME]
[-t {VPD,HII}] [-m MAXSIZE] [-f OFFSET] [-n VARIABLENAME]
[-g VARIABLEGUID] [-v] [-q] [--debug [0-9]]
Convert a binary file to a VOID* PCD value or DSC file VOID* PCD statement.
Copyright (c) 2016, Intel Corporation. All rights reserved.
optional arguments:
-h, --helpshow this help message and exit
--version show program's version number and exit
-i INPUTFILE, --input INPUTFILE
Input binary filename
-o OUTPUTFILE, --output OUTPUTFILE
Output filename for PCD value or PCD statement
-p PCDNAME, --pcd PCDNAME
Name of the PCD in the form
.
-t {VPD,HII}, --type {VPD,HII}
PCD statement type (HII or VPD). Default is standard.
-m MAXSIZE, --max-size MAXSIZE
Maximum size of the PCD. Only used with --type VPD.
-f OFFSET, --offset OFFSET
VPD offset if --type is VPD. UEFI Variable offset if
--type is HII.
-n VARIABLENAME, --variable-name VARIABLENAME
UEFI variable name. Only used with --type HII.
-g VARIABLEGUID, --variable-guid VARIABLEGUID
UEFI variable GUID C name. Only used with --type HII.
-v, --verbose Increase output messages
-q, --quiet Reduce output messages
--debug [0-9] Set debug level
This utility can be used in PCD value mode to convert a binary
file into a string that can then be copied into the PCD value field
of a VOID* PCD. The following is an example of PCD value mode on
an 8 byte test.bin file.
BinToPcd.py -i test.bin
{0x48, 0x65, 0x6c, 0x6c, 0x6f, 0x20, 0x0d, 0x0a}
The DSC file VOID* PCD statement mode can be used to generate a
complete PCD statement for the PCD section types that a DSC file
supports:
[PcdsFixedAtBuild]
[PcdsPatchableInModule]
[PcdsDynamicDefault]
[PcdsDynamicExDefault]
[PcdsDynamicVpd]
[PcdsDynamicExVpd]
[PcdsDynamicHii]
[PcdsDynamicExHii]
The PCD statement mode is useful when combined with a !include
statement in a DSC file. BinToPcd.py can be used to convert a
binary file to a PCD statement in an output file, and that output
file can be included into a DSC file in the matching PCD section
to set the value of the PCD to the value from the binary file
without having to copy the value into the DSC file. Updates can be
made to the included file without editing the DSC file. Some
example use cases are the setting the public key PCDs such as:
gEfiSecurityPkgTokenSpaceGuid.PcdRsa2048Sha256PublicKeyBuffer
gEfiSecurityPkgTokenSpaceGuid.PcdPkcs7CertBuffer
The following example converts a public key binary file to a
[PcdsFixedAtBuild] compatible PCD statement:
BinToPcd.py -i PublicKey.bin -o PublicKey.pcd
--pcd gEfiSecurityPkgTokenSpaceGuid.PcdPkcs7CertBufferkenSpaceGuid
The PublicKey.pcd output file contains a single line:
gEfiSecurityPkgTokenSpaceGuid.PcdPkcs7CertBuffer|{0x48, ...}
A DSC file can be updated to include the PublicKey.pcd file:
[PcdsFixedAtBuild]
!include PublicKey.pcd
VPD examples:
=
BinToPcd.py -i test.bin -p Guid.Token -t VPD
Guid.Name|*|8|{0x48, 0x65, 0x6c, 0x6c, 0x6f, 0x20, 0x0d, 0x0a}
BinToPcd.py -i test.bin -p Guid.Token -t VPD -f 20
Guid.Name|20|8|{0x48, 0x65, 0x6c, 0x6c, 0x6f, 0x20, 0x0d, 0x0a}
BinToPcd.py -i test.bin -p Guid.Token -t VPD -m 10
Guid.Name|*|10|{0x48, 0x65, 0x6c, 0x6c, 0x6f, 0x20, 0x0d, 0x0a}
BinToPcd.py -i test.bin -p Guid.Token -t VPD -f 20 -m 10
Guid.Name|20|10|{0x48, 0x65, 0x6c, 0x6c, 0x6f, 0x20, 0x0d, 0x0a}
HII examples:
=
BinToPcd.py -i test.bin -p Guid.Token -t HII -g VarGuid -n VarName
Guid.Name|L"VarName"|VarGuid|0|{0x48, 0x65, 0x6c, 0x6c}
BinToPcd.py -i test.bin -p Guid.Token -t HII -g VarGuid -n VarName -f 8
Guid.Name|L"VarName"|VarGuid|8|{0x48, 0x65, 0x6c, 0x6c}
Cc: Yonghong Zhu
Cc: Liming Gao
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Michael Kinney
---
BaseTools/Scripts/BinToPcd.py | 179 ++
1 file changed, 179 insertions(+)
create mode 100644 BaseTools/Scripts/BinToPcd.py
diff --git a/BaseTools/Scripts/BinToPcd.py b/BaseTools/Scripts/BinToPcd.py
new file mode 100644
index 000..3cb8000
--- /dev/null
+++ b/BaseTools/Scripts/BinToPcd.py
@@ -0,0 +1,179 @@
+## @file
+# Convert a binary file to a VOID* PCD value or DSC file VOID* PCD statement.
+#
+# Copyright (c) 2016, Intel Corporation. All rights reserved.
+# This program and the accompanying materials
+# are licensed and made available under the terms and conditions of the BSD
License
+# which accompanies
