X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdeModulePkg%2FUniversal%2FPCD%2FPei%2FPcdPeim.uni;fp=MdeModulePkg%2FUniversal%2FPCD%2FPei%2FPcdPeim.uni;h=88cfe01f5bf90fbd4a88aa2c6f23261f4af05381;hp=3e7c5566f0727ed2622e52b980828b2ee34cc4fa;hb=d1102dba7210b95e41d06c2338a22ba6af248645;hpb=ca79bab7af4770c5eb578f6d495af01705aedb79 diff --git a/MdeModulePkg/Universal/PCD/Pei/PcdPeim.uni b/MdeModulePkg/Universal/PCD/Pei/PcdPeim.uni index 3e7c5566f0..88cfe01f5b 100644 --- a/MdeModulePkg/Universal/PCD/Pei/PcdPeim.uni +++ b/MdeModulePkg/Universal/PCD/Pei/PcdPeim.uni @@ -10,32 +10,32 @@ // type Pcd. // For dynamicEx type PCD, it is compatible between PCD_PPI and EFI_PEI_PCD_PPI. // PCD PEIM driver will produce above two PPIs at same time. -// +// // PCD database is generated as the separate binary image at build time. The binary image // will be intergrated into Firmware volume together with PCD driver. -// +// // //////////////////////////////////////////////////////////////////////////////// // // // // // Introduction of PCD database // // // // // //////////////////////////////////////////////////////////////////////////////// -// +// // 1, Introduction // PCD database hold all dynamic type PCD information. The structure of PEI PCD // database is generated by build tools according to dynamic PCD usage for // specified platform. -// +// // 2, Dynamic Type PCD // Dynamic type PCD is used for the configuration/setting which value is determined // dynamic. In contrast, the value of static type PCD (FeatureFlag, FixedPcd, // PatchablePcd) is fixed in final generated FD image in build time. -// +// // 2.1 The "dynamic" determination means one of below cases: // a) The PCD setting value is produced by someone driver and consumed by // other driver in execution time. // b) The PCD setting value is set/get by user from FrontPage. // c) The PCD setting value is produced by platform OEM vendor in specified area. -// +// // 2.2 According to module distribution way, dynamic PCD could be classfied as: // a) Dynamic: // If module is released in source code and will be built with platform @@ -49,7 +49,7 @@ // PcdGetxxEx(gEfiMyTokenspaceGuid, PcdSampleDynamicPcd) // Developer need explicity gives {Token Space Guid:Token Number} as parameter // in writting source code. -// +// // 2.3 According to PCD value's storage method, dynamic PCD could be classfied as: // a) Default Storage: // - The PCD value is stored in PCD database maintained by PCD driver in boot @@ -59,7 +59,7 @@ // is turn off. // - [PcdsDynamicDefault] is used as section name for this type PCD in // platform DSC file. [PcdsDynamicExDefault] is used for dynamicEx type PCD. -// +// // b) Variable Storage: // - The PCD value is stored in variable area. // - As default storage type, this type PCD could be used for PEI/DXE driver @@ -69,34 +69,34 @@ // to variable area is readonly. // - [PcdsDynamicHii] is used as section name for this type PCD in platform // DSC file. [PcdsDynamicExHii] is for dynamicEx type PCD. -// +// // c) OEM specificed storage area: // - The PCD value is stored in OEM specified area which base address is // specified by a FixedAtBuild PCD setting - PcdVpdBaseAddress. // - The area is read only for PEI and DXE phase. // - [PcdsDynamicVpd] is used as section name for this type PCD in platform // DSC file. [PcdsDynamicExVpd] is for dynamicex type PCD. -// +// // 2.4 When and how to use dynamic PCD // Module developer do not care the used PCD is dynamic or static when writting // source code/INF. Dynamic PCD and dynamic type is pointed by platform integrator // in platform DSC file. Please ref section 2.3 to get matching between dynamic // PCD type and section name in DSC file. -// +// // 3, PCD database: // Although dynamic PCD could be in different storage type as above description, // but the basic information and default value for all dynamic PCD is hold // by PCD database maintained by PEI/DXE driver. -// +// // As the whole EFI BIOS boot path is divided into PEI/DXE phase, the PCD database // also is divided into Pei/Dxe database maintaied by PcdPeim/PcdDxe driver separatly. // To make PcdPeim's driver image smaller, PEI PCD database only hold all dynamic // PCD information used in PEI phase or use in both PEI/DXE phase. And DXE PCD // database contains all PCDs used in PEI/DXE phase in memory. -// +// // Build tool will generate PCD database into the separate binary file for // PEI/DXE PCD driver according to dynamic PCD section in platform DSC file. -// +// // 3.1 PcdPeim and PcdDxe // PEI PCD database is maintained by PcdPeim driver run from flash. PcdPeim driver // build guid hob in temporary memory and copy the binary data base from flash @@ -104,11 +104,11 @@ // DXE PCD database is maintained by PcdDxe driver.At entry point of PcdDxe driver, // a new PCD database is allocated in boot-time memory which including all // PEI PCD and DXE PCD entry. -// +// // Pcd driver should run as early as possible before any other driver access // dynamic PCD's value. PEI/DXE "Apriori File" mechanism make it possible by // making PcdPeim/PcdDxe as first dispatching driver in PEI/DXE phase. -// +// // 3.2 Token space Guid/Token number, Platform token, Local token number // Dynamic PCD // +-----------+ +---------+ @@ -128,13 +128,13 @@ // | Token | // | Number | // +-----------+ -// -// +// +// // 3.2.1 Pair of Token space guid + Token number // Any type PCD is identified by pair of "TokenSpaceGuid + TokeNumber". But it // is not easy maintained by PCD driver, and hashed token number will make // searching slowly. -// +// // 3.2.2 Platform Token Number // "Platform token number" concept is introduced for mapping to a pair of // "TokenSpaceGuid + TokenNumber". The platform token number is generated by @@ -148,14 +148,14 @@ // mechanism is not suitable for binary module which use DynamicEx type PCD. // To access a dynamicEx type PCD, pair of "token space guid/token number" all need // to be specificed for PcdSet/PcdGet accessing macro. -// +// // Platform Token Number is started from 1, and inceased continuous. From whole // platform scope, there are two zones: PEI Zone and DXE Zone // | Platform Token Number // ----------|---------------------------------------------------------------- // PEI Zone: | 1 ~ PEI_LOCAL_TOKEN_NUMBER // DXE Zone: | (PEI_LOCAL_TOKEN_NUMBER + 1) ~ (PEI_LOCAL_TOKEN_NUMBER + DXE_LOCAL_TOKEN_NUMBER) -// +// // 3.2.3 Local Token Number // To fast searching a PCD entry in PCD database, PCD driver translate // platform token number to local token number via a mapping table. @@ -163,7 +163,7 @@ // "token space guid + token number" to local token number directly. // Local token number is identifier for all internal interface in PCD PEI/DXE // driver. -// +// // A local token number is a 32-bit value in following meaning: // 32 ------------- 28 ---------- 24 -------- 0 // | PCD type mask | Datum Type | Offset | @@ -183,7 +183,7 @@ // Offset : indicate the related offset of PCD value in PCD database array. // Based on local token number, PCD driver could fast determine PCD type, value // type and get PCD entry from PCD database. -// +// // 3.3 PCD Database binary file // PCD Database binary file will be created at build time as the standalone binary image. // To understand the binary image layout, PCD Database C structure is still generated @@ -203,7 +203,7 @@ // Every PCD has a value record in PCD database. For different // datum type PCD has different record structure which will be // introduced in 3.3.1 -// +// // In a PCD database structure, there are two major area: Init and UnInit. // Init area is use stored above PCD internal structure such as ExMapTable, // LocalTokenNumberTable etc and the (default) value of PCD which has default @@ -211,7 +211,7 @@ // Unint area is used stored the value of PCD which has no default value in // platform DSC file, the value of NULL, 0 specified in platform DSC file can // be seemed as "no default value". -// +// // 3.3.1 Simple Sample PCD Database C Structure // A general sample of PCD database structue is as follows: // typedef struct _PCD_DATABASE { @@ -223,7 +223,7 @@ // SIZE_INFO SizeTable[PEI_SIZE_TABLE_SIZE]; // UINT8 SkuIdTable[PEI_SKUID_TABLE_SIZE]; // SKU_ID SystemSkuId; -// +// // //===== Following is value structure for PCD with default value // .... // .... @@ -235,11 +235,11 @@ // .... // } UnInit; // } -// +// // 3.3.2 PCD value structure in PCD database C structure // The value's structure is generated by build tool in PCD database C structure. // The PCDs in different datum type has different value structure. -// +// // 3.3.2.1 UINT8/UINT16/UINT32/UINT64 datum type PCD // The C structure for these datum type PCD is just a UINT8/UINT16/UINT32/UINT64 // data member in PCD database, For example: @@ -247,30 +247,30 @@ // Above structure is generated by build tool, the member name is "PcdCName_Guidvalue" // Member type is UINT16 according to PcdHardwareErrorRecordLevel declaration // in DEC file. -// +// // 3.3.2.2 VOID* datum type PCD // The value of VOID* datum type PCD is a UINT8/UINT16 array in PCD database. -// +// // 3.3.2.2.1 VOID* - string type // If the default value for VOID* datum type PCD like L"xxx", the PCD is // used for unicode string, and C structure of this datum type PCD is // UINT16 string array in PCD database, for example: // UINT16 StringTable[29]; // The number of 29 in above sample is max size of a unicode string. -// +// // If the default value for VOID* datum type PCD like "xxx", the PCD is // used for ascii string, and C structure of this datum type PCD is // UINT8 string array in PCD database, for example: // UINT8 StringTable[20]; // The number of 20 in above sample is max size of a ascii string. -// +// // 3.3.2.2.2 VOID* - byte array // If the default value of VOID* datum type PCD like {'0x29', '0x01', '0xf2'} // the PCD is used for byte array. The generated structrue is same as // above ascii string table, // UINT8 StringTable[13]; // The number of 13 in above sample is max size of byte array. -// +// // 3.3.3 Some utility structures in PCD Database // 3.3.3.1 GuidTable // GuidTable array is used to store all related GUID value in PCD database: