X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=Tools%2FXMLSchema%2FFrameworkDataElements.xsd;h=665c19ae2256e5ac6d21bcacfe70a7d5932861ec;hp=1d34b49e13d4b1e19c2b4dbf651f9989704e45e1;hb=02b4b59b2bb80e88409bb144463366e0f4e89b5d;hpb=92e805e975d442202de220816f3dbd125cfd6470 diff --git a/Tools/XMLSchema/FrameworkDataElements.xsd b/Tools/XMLSchema/FrameworkDataElements.xsd index 1d34b49e13..665c19ae22 100644 --- a/Tools/XMLSchema/FrameworkDataElements.xsd +++ b/Tools/XMLSchema/FrameworkDataElements.xsd @@ -1,6 +1,6 @@ - - - This schema defines EFI and Framework Data Elements - - - - - - Abstract is valid for all Description Files - This section is required. This is a single sentence to describe the module and will be used in sample files as the abstract data in the header comment section. + This schema defines EFI and Framework Data Elements - - - - - - - - - - - This is a sub-element of AntTask - This is an ant command that will be inserted into a biuld sequence. Since ant commands are valid XML statements, special care must be taken to use the correct tokens for reserved words and escape quote characters. - - - - - - - - - - - - + + + + + + + Abstract is valid for all Description Files + This section is required. This is a single sentence to describe the module and will be used in sample files as the abstract data in the header comment section. + + + + + + + + + + + + This is a sub-element of AntTask + This is an ant command that will be inserted into a biuld sequence. Since ant commands are valid XML statements, special care must be taken to use the correct tokens for reserved words and escape quote characters. + + + + + + + + + + + + @@ -112,6 +113,7 @@ + @@ -148,18 +150,8 @@ Describe the valid Framework Component Type - - - A conditional expression that must be evaluated to determine whether a feature is implemented or not. The expression must be either numeric, string or boolean. - - - - - - - - + A conditional expression that must be evaluated to determine whether a feature is implemented or not. The expression must be either numeric, string or boolean. @@ -190,6 +182,7 @@ + @@ -243,7 +236,7 @@ - This is a list of Events + This is a list of MSA Events @@ -253,12 +246,21 @@ - - + + + + + + + + + + + @@ -266,7 +268,10 @@ - + + + + @@ -287,12 +292,21 @@ - - + + + + + + + + + + + @@ -300,7 +314,6 @@ - @@ -318,12 +331,12 @@ - This is a child of MSA files, both Library and Module. - This is a list of Extern statements, right now, only Driver Binding information is provided. + This is a child of MSA files. - - + + + @@ -362,6 +375,8 @@ + + @@ -431,7 +446,7 @@ - Describe the valid content of a filename + Describe the valid content of a filename This should extend PathAndFilename - Variable names not allowed here! @@ -448,6 +463,7 @@ + @@ -466,9 +482,6 @@ - - Describe the valid content of a Formset - @@ -477,6 +490,7 @@ + @@ -512,16 +526,22 @@ + + This is a child of PackageSurfaceArea (SPD) + - - + + + + + - + @@ -532,20 +552,26 @@ - Describe the valid content of a PCD GUID element + Describe the valid content of a GUID element in and MSA file. + + + + + + @@ -558,6 +584,7 @@ + @@ -573,10 +600,24 @@ - + + - This section is used to describe how a GUID, PPI or PROTOCOL is to be used within the context of PCDs. + Describe the list of a HiiPackage elements + + + + + + + + + + + + + @@ -584,13 +625,23 @@ - + + + + + + - + + + + + + @@ -615,7 +666,8 @@ - + + @@ -628,6 +680,7 @@ + @@ -639,22 +692,40 @@ + + + + + + + + + + + + + + + + + - Different Instances of Libraries + Different (Module) Instances of Libraries used ONLY in FPD Files. - + + @@ -671,47 +742,56 @@ + - Define in the MSA and/or SPD, what class of library is being produced by a library module - for components, it can also specify what class of library is consumed. + Used in MSA files. This defines what class of library is being supported = produced (library module) or consumed by a module. - - + + + This element defines a class of library, along with the path to the Include Header for this library - - + + + + + + + + + + + + - - This section defines what Classes of Libraries that this library belongs to. A Library may belong to multiple different library classes. - - - - + + + - This section defines what Classes of Libraries that this library belongs to. A Library may belong to multiple different library classes. + This section defines what Classes of Library that this library supports. A Library may belong to multiple different library classes. - + @@ -738,7 +818,10 @@ - + + + + @@ -761,7 +844,7 @@ - + @@ -778,7 +861,7 @@ - Describe the valid content of a Surface Area Package Description (SPD) file + Surface Area Package Description (SPD) list of Module Surface Area files @@ -788,6 +871,7 @@ + @@ -810,6 +894,17 @@ + + + + Surface Area Package Description (SPD) list of Module Surface Area files + + + + + + + Define where we want our output to go. The Attribute, IntermediateDirectories, default MODULE, says that intermediate files will be local to the module, versus a unified directory structure. @@ -830,6 +925,7 @@ + Child of Module Surface Area documents, MSA and MBD files, Library Modules and Other Modules One or more PcdData or PcdBuildData Elements Only one type is permitted @@ -846,6 +942,7 @@ + @@ -854,17 +951,7 @@ - - - Max Number of Bytes of the data. - - - - - - - - + @@ -873,7 +960,7 @@ - + @@ -881,7 +968,7 @@ - This tag is used in the Package Surface Area Description File to track package dependencies for a module + This tag is used in the Package Surface Area Description File (SPD) to track package dependencies for a module @@ -892,17 +979,29 @@ - This defines the minimum header file needed to support a given ModuleType. + This is a child of PackageSurfaceArea (SPD) - + + + + + + + + + + + + + - This tag is used in the Framework Package Database File to track all packages installed in a workspace. + This tag is used in the Framework Package Database File to track all packages installed in a workspace. (Database) @@ -913,9 +1012,19 @@ - - - + + + + + + + + + + + + + @@ -926,11 +1035,11 @@ - This tag is used in the Package Surface Area Description File to track package dependencies for a module + This tag is used in the Package Surface Area Description File to track package dependencies for a module (SPD) - + @@ -965,7 +1074,6 @@ - This as a unique identifier defined for either this name space. @@ -979,6 +1087,7 @@ + This specifies the size of the Pcd Datum. It is either 8, 16, 32 or 64 bits for values, 1 bit for BOOLEAN and variable length for elements defined as VOID* @@ -1068,155 +1177,240 @@ - - - This is an enumerated data type that will be used for DYNAMIC_EX, PEIM or DXE only - - - - - - - + + + This is an enumerated data type that will be used for DYNAMIC_EX, PEIM or DXE only + + + + + + + - - - - Child of Framework Platform Description (FPD) - We permit the FPD to use an external XML file for PCD information or else the information must be contained within the XML data element, PcdBuildData. - - - - - - Child of PcdBuildDeclarations - This is date element is used in the platform build description file and contains valid data for a Platform Build - There is ONE required Attribute, ItemType - - - - - - - - This as a unique identifier defined for either this name space. - The Target Attribute may be used to define a Target name space, such as PCI. - - - - - - - - - - - - This specifies the size of the Pcd Datum. It is either 8, 16, 32 or 64 bits for values, 1 bit for BOOLEAN and variable length for elements defined as VOID* - - - - - This Bit means that the Variable data is associated with HII - - - - - This bit enables the Vital Product Data area within flash for maintaining PCD information - - - - - This is only applicable to ItemType DYNAMIC_EX - - - - - - - - This element is a list of two entries per line, the first should be an integer, while the second entry should be a string value - - - - - - - - This section is for a list of SkuData Elements, ID and Value - - - - - - - - - - - - This value comes from a production line database, and has nothing to do with the number of SkuData IDs that have been defined. - - - - - This is the specific Sku ID for this build. - - - - - Max Number of Bytes of the data. - - - - - - - - - - - This is the Variable's GUID if and only if HII is enabled. - - - - - This is the C Name for the Variable, and is valid if and only HII is enabled. - - - - + + + + + Child of Framework Platform Description (FPD) + We permit the FPD to use an external XML file for PCD information or else the information must be contained within the XML data element, PcdBuildData. + + + + + + Child of PcdBuildDeclarations + This is date element is used in the platform build description file and contains valid data for a Platform Build + There is ONE required Attribute, ItemType + + + + + + - If HII is enabled, This is the offset into the variable data entry, If Vpd is enabled, then it's the Offset into the VPD area of the image defined by platform manufacturer, if neither HII nor Vpd are enabled, it's the offset into the PCD Data Area. HII and VPD can never be enabled at the same time (as of the date of this document.) + This as a unique identifier defined for either this name space. + The Target Attribute may be used to define a Target name space, such as PCI. + + + + + + + - + + + + + + + + + + + This element is a list of two entries per line, the first should be an integer, while the second entry should be a string value + + + + + + + + This section is for a list of SkuData Elements, ID and Value + + + + + + + + + + - FIELD IS NOT USED! REMOVE in FINAL! + This value comes from a production line database, and has nothing to do with the number of SkuData IDs that have been defined. + + + + + + + - - - This is an enumerated data type that will be used for DYNAMIC_EX, PEIM or DXE only - - - - - - - + + + This is an enumerated data type that will be used for DYNAMIC_EX, PEIM or DXE only + + + + + + + + + + + + + + + Child of Framework Platform Description (FPD) + FPD uses this PCD information for Dynamic PCDs Only + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Child of FPD ModuleSA element for FIXED_AT_BUILD, PATCHABLE_IN_MODULE, and FEATURE_FLAG PCDS Only! + + + + + + + + + + + + + + + + + + + + + + + + + + + If HiiEnable group is specified, then HiiEnable is default true + + + + + + + + + + If VpdEnable group is specified, then VpdEnable is default true + + + + + + + + Child of Module Surface Area Description (MSA) + + + + + + This is the valid content of the PCD table of a Module. The contents may not be wired at build time, and these only refer to Platform Build values, not modules. + This element is valid for PcdInfo.xml and FPD files. + + + + + + + + + - + + + + + Child of Package Surface Area Description (SPD) + This section is for entering information about a package's PCDs + + + + + + + + + + + + + + + + + + + + + Child of Package Surface Area Description (SPD) @@ -1234,6 +1428,7 @@ + @@ -1283,10 +1478,10 @@ - - + + + + @@ -1296,16 +1491,23 @@ + + This is a child of PackageSurfaceArea (SPD) + - - + + + + + + - + @@ -1335,6 +1537,7 @@ + @@ -1364,16 +1567,22 @@ + + This is a child of PackageSurfaceArea (SPD) + - - + + + + + - + @@ -1403,6 +1612,7 @@ + @@ -1482,6 +1692,7 @@ + @@ -1493,6 +1704,21 @@ + + + + + + + + + + + + + + + This string is used to provide the name and version of the Specification that the component conforms to. @@ -1513,8 +1739,12 @@ - - + + + + + + @@ -1523,6 +1753,7 @@ + @@ -1536,9 +1767,19 @@ + + + + + + + + + + - A list of EFI Variables described by GUID string pair. + An MSA FILE list of EFI Variables described by string pair. @@ -1548,8 +1789,21 @@ - - + + + + + + + + + + + + + + + This entry represents the Hex Byte Offset {0x0, 0xn} to where the data starts. @@ -1581,6 +1835,7 @@ +