From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga07.intel.com (mga07.intel.com [134.134.136.100]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 668B02194235A for ; Tue, 11 Apr 2017 09:46:04 -0700 (PDT) Received: from orsmga002.jf.intel.com ([10.7.209.21]) by orsmga105.jf.intel.com with ESMTP; 11 Apr 2017 09:46:03 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.37,186,1488873600"; d="scan'208";a="72631602" Received: from orsmsx110.amr.corp.intel.com ([10.22.240.8]) by orsmga002.jf.intel.com with ESMTP; 11 Apr 2017 09:46:04 -0700 Received: from orsmsx113.amr.corp.intel.com ([169.254.9.59]) by ORSMSX110.amr.corp.intel.com ([169.254.10.119]) with mapi id 14.03.0319.002; Tue, 11 Apr 2017 09:46:03 -0700 From: "Kinney, Michael D" To: Laszlo Ersek , "Gao, Liming" , "edk2-devel@lists.01.org" , "Kinney, Michael D" Thread-Topic: [edk2] [RFC 0/3] Structure PCD value assignment in DEC/DSC Thread-Index: AQHSstb3GPxOsJ+ddEykj3cx3iwrRqHAvviA//+g5JA= Date: Tue, 11 Apr 2017 16:46:03 +0000 Message-ID: References: <1491923803-12124-1-git-send-email-liming.gao@intel.com> In-Reply-To: Accept-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-ctpclassification: CTP_IC x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiNWEwZGU4NjAtNzg2OC00MWU5LWI1Y2MtZDA5NWRmYmFlMTA1IiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX0lDIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE1LjkuNi42IiwiVHJ1c3RlZExhYmVsSGFzaCI6IlhQK1RsUlhmckFKN25WeTBHbjJ2OEJsZUtXd3E0Z1NpZG0zOE9CRXNxV1k9In0= dlp-product: dlpe-windows dlp-version: 10.0.102.7 dlp-reaction: no-action x-originating-ip: [10.22.254.138] MIME-Version: 1.0 Subject: Re: [RFC 0/3] Structure PCD value assignment in DEC/DSC X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.22 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 11 Apr 2017 16:46:04 -0000 Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Hi Laszlo, I agree that the feature request should go into Bugzilla right away. I would like to the discussion on the RFC conclude before we enter spec and code Bugzilla entries, because based on feedback to the RFC the specific spec and tool changes may need some adjustments. Thanks, Mike > -----Original Message----- > From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of La= szlo > Ersek > Sent: Tuesday, April 11, 2017 8:24 AM > To: Gao, Liming ; edk2-devel@lists.01.org > Subject: Re: [edk2] [RFC 0/3] Structure PCD value assignment in DEC/DSC >=20 > On 04/11/17 17:16, Liming Gao wrote: > > Requirment: Map VOID* PCD to C structure > > 1. When PCD is configured as DynamicHii, it will be map to one EFI vari= able. If > PCD is VOID*, it can map to the > > whole EFI variable. Most EFI variable data are defined as C structure. > > 2. Some PCDs are designed as C style structure, such as > gEfiMdeModulePkgTokenSpaceGuid.PcdPciSerialParameters. > > > > Current limitation: > > 1. VOID* PCD Value must be byte array. Its value is hard to be specifie= d. > > 2. If single PCD is defined to map one field in structure, its offset a= nd width > will be required when this PCD > > is configured as DynamicHii or DynamicVpd. If the structure is big, it = will > require lots of PCDs to map its > > each field. If the structure has the bit field, its bit field can't mat= ch PCD. > > > > Proposal: > > Enhance EDKII Build system to support VOID* PCD be mapped to C structur= e in DEC > or DSC. PCD value can be specified > > by structure field as C language style in DEC and DSC. Then, its value = will be > converted to byte array and assigned > > to VOID* PCD. This is a pure build enhancement, and no change in PCD dr= iver. > > 1. New syntax in DEC and DSC defines PCD with C structure. > > a. PCD Data type will be C structure name. > > b. C structure header file and the dependent packages are required to= be > listed. > > c. Example in DEC [PcdsFixedAtBuild] section: > > gStructuredPcdPkgTokenSpaceGuid.PcdTest|{0xFF}|TEST|0x00010080 { > > > > Guid/Test.h > > > > MdePkg/MdePkg.dec > > MdeModulePkg/MdeModulePkg.dec > > } > > 2. Set the value to the structure fields like normal PCD in DEC/DSC/FDF= . > > a. If the field value is not specified, its default value will be zer= o. > > b. Example in DEC/DSC [PcdsFixedAtBuild] section: > > gStructuredPcdPkgTokenSpaceGuid.PcdTest.Bool|TRUE > > gStructuredPcdPkgTokenSpaceGuid.PcdTest.Array[1].Foo|"ABC" > > gStructuredPcdPkgTokenSpaceGuid.PcdTest.C|0xFEDC > > gStructuredPcdPkgTokenSpaceGuid.PcdTest.D|2222 > > 3. Pre AutoGen phase, Build tool will prepare the value for structure P= CD. > > a. Generate C file (name as pcdc file) and its Makefile to include PC= D value > initialization. > > i. Parse PCD field values in DEC/DSC/FDF to generate pcdc file. > > ii. Developer provides their pcdc files to customize PCD value in o= ne > module INF. > > b. Compile C file to the executable tool like BaseTools C tools. > > c. Run the executable file to output the byte array PCD value. > > d. Build tool gets the byte array PCD value and generate AutoGen code= , > continue to normal edk2 build process. > > 4. Pcdc file will include the different functions to initialize the dif= ferent > PCD value on the different SKU > > a. BaseTools CommonLib adds the generic APIs to parse Args, Get/Set P= CD > value. > > b. Pcdc file is compiled and run by Build tool, user doesn't need awa= re it. > > 5. Report > > a. Error report will point to the specified value in DEC or DSC when = the > value can't be assigned to structure field. > > b. Build Report will print Structure PCD value with byte array and fi= eld > value both. > > 6. C Structure requirement > > a. Structure field data type can't be VOID* or UINTN. its size must b= e same > at the crossing ARCHs. > > b. Structure field can be bits, union, nest structure, structure arra= y, enum, > pack, unpack. > > c. Structure field value can be MACRO, Enum or constant value. >=20 > My only request at this point is to please file two BZs: > - one for the feature itself (apparently the requirement exists already), > - another one for the DEC spec, to document the feature. >=20 > Thank you, > Laszlo >=20 > > > > Patch: > > This patches add TestPkg to show StructurePcd Value Assignment usage in= DEC and > DSC. > > > > Python StructuredPcdValueGenerator.py is added to show structure PCD us= age. Its > logic will be > > integrated into BaseTools later. This script bases on Package dec and P= ackage > dsc > > to convert structure PCD value to byte array. It depends on BaseTools C= source > CommonLib. > > Before run this script, BaseTools are required to be compiled first. Th= is > script will > > generate $(WORKSPACE)\Build\PcdValueInit\PcdValueInit.c with the struct= ure PCD > field value, > > and generate $(WORKSPACE)\Build\PcdValueInit\Makefile to compile it to = the > executable file. > > It also generates $(WORKSPACE)\Build\PcdValueInit\Input.txt to include = the > initial PCD value > > from its declartion in dec file. Last, run the generated executable fil= e with > Input.txt, and > > output the final PCD value in $(WORKSPACE)\Build\PcdValueInit\Output.tx= t. > > > > In Windows: > > 1. enter into edk2 > > 2. type edksetup.bat --nt32 > > 3. nmake -f BaseTools\Makefile > > 4. C:\Python27\python.exe TestPkg\StructuredPcdValueGenerator.py -p > TestPkg\TestPkg.dec -d TestPkg\TestPkg.dsc > > > > In Linux: > > 1. enter into edk2 > > 2. . edksetup.sh BaseTools > > 3. cd BaseTools > > 4. make > > 5. cd edk2 > > 6. python TestPkg/StructuredPcdValueGenerator.py -p TestPkg/TestPkg.dec= -d > TestPkg/TestPkg.dsc > > > > After run StructuredPcdValueGenerator.py, Structure PCD value will outp= ut as > byte array. > > > > Liming Gao (3): > > BaseTools: Update Makefile to work at absolute path > > BaseTools: Add PcdValueCommon logic into CommonLib > > TestPkg: Show Structure PCD value assignment > > > > BaseTools/Source/C/Common/GNUmakefile | 3 +- > > BaseTools/Source/C/Common/Makefile | 3 +- > > BaseTools/Source/C/Common/PcdValueCommon.c | 601 +++++++++++++++++++++= +++ > > BaseTools/Source/C/Common/PcdValueCommon.h | 78 ++++ > > BaseTools/Source/C/Makefiles/app.makefile | 2 +- > > BaseTools/Source/C/Makefiles/lib.makefile | 2 + > > BaseTools/Source/C/Makefiles/ms.app | 4 +- > > TestPkg/Include/Guid/Test.h | 31 ++ > > TestPkg/StructuredPcdValueGenerator.py | 702 +++++++++++++++++++++= ++++++++ > > TestPkg/TestPkg.dec | 44 ++ > > TestPkg/TestPkg.dsc | 69 +++ > > 11 files changed, 1534 insertions(+), 5 deletions(-) > > create mode 100644 BaseTools/Source/C/Common/PcdValueCommon.c > > create mode 100644 BaseTools/Source/C/Common/PcdValueCommon.h > > create mode 100644 TestPkg/Include/Guid/Test.h > > create mode 100644 TestPkg/StructuredPcdValueGenerator.py > > create mode 100644 TestPkg/TestPkg.dec > > create mode 100644 TestPkg/TestPkg.dsc > > >=20 > _______________________________________________ > edk2-devel mailing list > edk2-devel@lists.01.org > https://lists.01.org/mailman/listinfo/edk2-devel