1 <?xml version="1.0" encoding="UTF-8"?>
2 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" xmlns="http://www.TianoCore.org/2006/Edk2.0" targetNamespace="http://www.TianoCore.org/2006/Edk2.0">
4 Filename: FrameworkDataElements.xsd
6 Copyright (c) 2006, Intel Corp.
7 All rights reserved. This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which may be found at http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 <xs:documentation xml:lang="en"> This schema defines EFI and Framework Data Elements </xs:documentation>
18 <xs:include schemaLocation="NamingConvention.xsd"/>
19 <xs:include schemaLocation="FrameworkDataTypes.xsd"/>
20 <xs:include schemaLocation="FrameworkPlatformDataTypes.xsd"/>
21 <xs:include schemaLocation="FrameworkDataAttributes.xsd"/>
22 <xs:element name="Abstract" type="Sentence">
24 <xs:documentation xml:lang="en">Abstract is valid for all Description Files</xs:documentation>
25 <xs:documentation xml:lang="en">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.</xs:documentation>
28 <xs:element name="AntTask">
30 <xs:documentation xml:lang="en">This is a sub-element of UserDefinedAntTasks</xs:documentation>
31 <xs:documentation xml:lang="en">Define a file that contains one or more ant tasks that are to be added into or replacing of sequences of build steps. These files will be called using the ant-call task on a file name. These files must be valid apache-ant formatted task files.</xs:documentation>
35 <xs:element minOccurs="0" maxOccurs="1" name="AntCmdOptions" type="xs:normalizedString"/>
36 <xs:element minOccurs="0" maxOccurs="1" name="Filename" type="PathAndFilename"/>
38 <xs:attribute name="Id" type="xs:int" use="required"/>
41 <xs:element name="BootModes">
43 <xs:documentation xml:lang="en">BootModes is valid for all Description Files</xs:documentation>
44 <xs:documentation xml:lang="en">This is a list of BootModes Supported by the Module</xs:documentation>
48 <xs:element minOccurs="1" maxOccurs="unbounded" name="BootMode">
50 <xs:sequence minOccurs="0">
51 <xs:element name="HelpText" type="Paragraph"/>
53 <xs:attributeGroup ref="BootModeAttributes"/>
59 <xs:element name="BuildOptions">
61 <xs:documentation xml:lang="en">BuildOptions is valid for FPD files.</xs:documentation>
65 <xs:element minOccurs="0" maxOccurs="1" ref="UserDefinedAntTasks"/>
66 <xs:element minOccurs="0" maxOccurs="1" ref="Options"/>
67 <xs:element minOccurs="0" maxOccurs="unbounded" ref="UserExtensions"/>
68 <!-- The following sections are legacy and will be removed -->
69 <xs:element minOccurs="0" maxOccurs="unbounded" name="Ffs">
72 <xs:element minOccurs="0" maxOccurs="unbounded" name="Attribute">
74 <xs:attribute name="Name" type="C_NameType"/>
75 <xs:attribute name="Value" type="xs:string"/>
78 <xs:element minOccurs="0" maxOccurs="1" name="Sections">
80 <xs:sequence minOccurs="1">
81 <xs:element name="Section" minOccurs="0" maxOccurs="unbounded">
84 <xs:element ref=" Filenames " minOccurs="0"/>
85 <xs:element name="Args" type=" ArgsType " minOccurs="0"/>
86 <xs:element name="OutFile" type=" FileNameConvention " minOccurs="0"/>
87 <xs:element name="OutputFileExtension" type=" xs:string " minOccurs="0"/>
88 <xs:element name="ToolName" type=" ToolType " minOccurs="0"/>
90 <xs:attributeGroup ref=" SectionsAttributes "/>
93 <xs:element name="Sections" minOccurs="0" maxOccurs="unbounded">
95 <xs:sequence minOccurs="1" maxOccurs="unbounded">
96 <xs:element name="Section">
99 <xs:element ref=" Filenames " minOccurs="0"/>
100 <xs:element name="Args" type=" ArgsType " minOccurs="0"/>
101 <xs:element name="OutFile" type=" FileNameConvention " minOccurs="0"/>
102 <xs:element name="OutputFileExtension" type=" xs:string " minOccurs="0"/>
103 <xs:element name="ToolName" type=" ToolType " minOccurs="0"/>
105 <xs:attributeGroup ref="SectionsAttributes"/>
109 <xs:attributeGroup ref=" SectionsAttributes "/>
113 <xs:attributeGroup ref=" SectionsAttributes "/>
117 <xs:attribute name="FfsKey" type="KeywordType" use="optional"/>
123 <xs:element name="Copyright" type="Paragraph"/>
124 <xs:element name="DataHubs">
126 <xs:documentation xml:lang="en">This is a list of DataHubRecord elements.</xs:documentation>
130 <xs:element minOccurs="1" maxOccurs="unbounded" name="DataHubRecord">
133 <xs:element minOccurs="1" maxOccurs="1" name="DataHubCName" type="C_NameType"/>
134 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
136 <xs:attributeGroup ref="DataHubAttributes"/>
142 <xs:element name="DefaultValue">
144 <xs:documentation xml:lang="en">The default setting of a PCD entry.</xs:documentation>
148 <xs:extension base="xs:normalizedString"/>
152 <xs:element name="Description" type="Paragraph">
154 <xs:documentation xml:lang="en">This section is required for new modules and libraries and must contain more information than the Abstract.</xs:documentation>
157 <xs:element name="DynamicPcdBuildDefinitions">
159 <xs:documentation xml:lang="en">Child of Framework Platform Description (FPD)</xs:documentation>
160 <xs:documentation xml:lang="en">FPD uses this PCD information for Dynamic PCDs Only</xs:documentation>
164 <xs:element minOccurs="1" maxOccurs="unbounded" name="PcdBuildData">
167 <xs:element minOccurs="1" maxOccurs="1" name="C_Name" type="C_NameType"/>
168 <xs:element minOccurs="1" maxOccurs="1" name="Token" type="TokenDataType"/>
169 <xs:element minOccurs="1" maxOccurs="1" name="TokenSpaceGuidCName" type="C_NameType"/>
170 <xs:element minOccurs="1" maxOccurs="1" name="DatumType" type="PcdDataTypes"/>
171 <xs:element minOccurs="0" maxOccurs="1" name="MaxDatumSize" type="DatumSizeLimitation"/>
172 <xs:element minOccurs="1" maxOccurs="unbounded" name="SkuInfo">
175 <xs:element minOccurs="1" maxOccurs="1" name="SkuId" type="xs:nonNegativeInteger"/>
177 <xs:group minOccurs="0" maxOccurs="1" ref="HiiEnable"/>
178 <xs:group minOccurs="0" maxOccurs="1" ref="VpdEnable"/>
179 <xs:group minOccurs="0" maxOccurs="1" ref="DefaultGroup"/>
185 <xs:attributeGroup ref="DynamicBuildPcdAttributes"/>
191 <xs:element name="Events">
193 <xs:documentation xml:lang="en">This is a list of MSA Events</xs:documentation>
197 <xs:element minOccurs="0" maxOccurs="1" name="CreateEvents">
200 <xs:element minOccurs="1" maxOccurs="unbounded" name="EventTypes">
203 <xs:element minOccurs="1" maxOccurs="1" name="EventType" type="EventTypes"/>
204 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
206 <xs:attributeGroup ref="EventAttributes"/>
212 <xs:element minOccurs="0" maxOccurs="1" name="SignalEvents">
214 <xs:documentation xml:lang="en">Module has an event that is waiting to be signaled. Event is named by GUID.</xs:documentation>
218 <xs:element minOccurs="1" maxOccurs="unbounded" name="EventTypes">
221 <xs:element minOccurs="1" maxOccurs="1" name="EventType" type="EventTypes"/>
222 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
224 <xs:attributeGroup ref="EventAttributes"/>
233 <xs:element name="Externs">
235 <xs:documentation xml:lang="en">This is a child of MSA files.</xs:documentation>
238 <xs:sequence minOccurs="1">
239 <xs:element minOccurs="0" maxOccurs="1" name="PcdIsDriver" type="PcdDriverTypes"/>
240 <xs:element minOccurs="0" maxOccurs="1" name="TianoR8FlashMap_h" type="xs:boolean" default="false"/>
241 <xs:element minOccurs="0" maxOccurs="unbounded" name="Specification" type="Sentence"/>
242 <xs:element minOccurs="0" maxOccurs="unbounded" name="Extern">
244 <xs:choice minOccurs="1" maxOccurs="1">
245 <xs:sequence minOccurs="0" maxOccurs="1">
247 <xs:documentation xml:lang="en">Driver Module</xs:documentation>
249 <xs:element minOccurs="0" maxOccurs="1" name="ModuleEntryPoint" type="C_NameType"/>
250 <xs:element minOccurs="0" maxOccurs="1" name="ModuleUnloadImage" type="C_NameType"/>
252 <xs:sequence minOccurs="0" maxOccurs="1">
254 <xs:documentation xml:lang="en">Library Module</xs:documentation>
256 <xs:element minOccurs="0" maxOccurs="1" name="Constructor" type="C_NameType"/>
257 <xs:element minOccurs="0" maxOccurs="1" name="Destructor" type="C_NameType"/>
259 <xs:sequence minOccurs="0" maxOccurs="1">
261 <xs:documentation xml:lang="en">Allow multiple entries for DriverBinding, ComponentName, DriverConfig and DriverDiag elements. For ComponentName, DriverConfig and/or DriverDiag - you must have a 1:1 mapping to DriverBinding if the element is defined.</xs:documentation>
262 <xs:documentation xml:lang="en">Permit User Defined Extern Tags</xs:documentation>
264 <xs:element minOccurs="1" maxOccurs="1" name="DriverBinding" type="C_NameType"/>
265 <xs:element minOccurs="0" maxOccurs="1" name="ComponentName" type="C_NameType"/>
266 <xs:element minOccurs="0" maxOccurs="1" name="DriverConfig" type="C_NameType"/>
267 <xs:element minOccurs="0" maxOccurs="1" name="DriverDiag" type="C_NameType"/>
269 <xs:sequence minOccurs="0" maxOccurs="1">
271 <xs:documentation xml:lang="en"> Module Call Backs</xs:documentation>
273 <xs:element minOccurs="0" maxOccurs="1" name="SetVirtualAddressMapCallBack" type="C_NameType"/>
274 <xs:element minOccurs="0" maxOccurs="1" name="ExitBootServicesCallBack" type="C_NameType"/>
277 <xs:attributeGroup ref="ExternAttributes"/>
283 <xs:element name="Filename">
285 <xs:documentation xml:lang="en">Describe the valid content of a filename This should extend PathAndFilename - Variable names not allowed here!</xs:documentation>
289 <xs:extension base="PathAndFilename">
290 <xs:attributeGroup ref="FilenameAttributes"/>
295 <xs:element name="Filenames">
297 <xs:documentation xml:lang="en">This is a list of Filenames</xs:documentation>
300 <xs:sequence minOccurs="1">
301 <xs:element minOccurs="0" maxOccurs="unbounded" ref="Filename"/>
305 <xs:element name="GuidDeclarations">
307 <xs:documentation xml:lang="en">This is a child of PackageSurfaceArea (SPD) </xs:documentation>
311 <xs:element minOccurs="1" maxOccurs="unbounded" name="Entry">
314 <xs:element minOccurs="1" maxOccurs="1" name="C_Name" type="C_NameType"/>
315 <xs:element minOccurs="1" maxOccurs="1" name="GuidValue" type="GuidType"/>
316 <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
318 <xs:attributeGroup ref="GuidDeclarationAttributes"/>
324 <xs:element name="Guids">
327 <xs:element minOccurs="1" maxOccurs="unbounded" name="GuidCNames">
329 <xs:documentation xml:lang="en">Describe the valid content of a GUID element in and MSA file.</xs:documentation>
333 <xs:element minOccurs="1" maxOccurs="1" name="GuidCName" type="C_NameType"/>
334 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
336 <xs:attributeGroup ref="GuidAttributes"/>
342 <xs:element name="HiiPackages">
344 <xs:documentation xml:lang="en">Describe the list of a HiiPackage elements</xs:documentation>
348 <xs:element minOccurs="1" maxOccurs="unbounded" name="HiiPackage">
351 <xs:element minOccurs="1" maxOccurs="1" name="HiiCName" type="C_NameType"/>
352 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
354 <xs:attributeGroup ref="HiiPackageAttributes"/>
360 <xs:element name="Hobs">
363 <xs:element minOccurs="1" maxOccurs="unbounded" name="HobTypes">
366 <xs:element minOccurs="1" maxOccurs="1" name="HobType" type="HobTypes"/>
367 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
369 <xs:attributeGroup ref="HobAttributes"/>
375 <xs:element name="IncludeHeader">
378 <xs:extension base="PathAndFilename">
379 <xs:attributeGroup ref="IncludeHeaderAttributes"/>
384 <xs:element name="IndustryStdIncludes">
387 <xs:element minOccurs="1" maxOccurs="unbounded" ref="IndustryStdHeader"/>
391 <xs:element name="IndustryStdHeader">
394 <xs:element minOccurs="1" maxOccurs="1" name="IncludeHeader" type="PathAndFilename"/>
395 <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
397 <xs:attributeGroup ref="IndustryStdHeaderAttributes"/>
400 <xs:element name="Libraries">
402 <xs:documentation xml:lang="en">Different (Module) Instances of Libraries used ONLY in FPD Files.</xs:documentation>
406 <xs:element minOccurs="1" maxOccurs="unbounded" name="Instance">
408 <xs:attributeGroup ref="LibraryAttributes"/>
414 <xs:element name="LibraryClass">
416 <xs:documentation xml:lang="en">Used in MSA files. This defines what class of library is being supported = produced (library module) or consumed by a module.</xs:documentation>
420 <xs:element minOccurs="1" maxOccurs="1" name="Keyword" type="KeywordType"/>
421 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
423 <xs:attributeGroup ref="LibraryClassAttributes"/>
426 <!-- LAH This is SPD LibraryClassDeclarations FINAL version -->
427 <xs:element name="LibraryClassDeclarations">
430 <xs:element minOccurs="1" maxOccurs="unbounded" name="LibraryClass">
433 <xs:element minOccurs="1" maxOccurs="1" name="IncludeHeader" type="PathAndFilename"/>
434 <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
436 <xs:attributeGroup ref="LibraryClassDeclarationAttributes"/>
442 <xs:element name="LibraryClassDefinitions">
444 <xs:documentation xml:lang="en">This section defines what Classes of Library that this library supports. A Library may belong to multiple different library classes.</xs:documentation>
448 <xs:element minOccurs="1" maxOccurs="unbounded" ref="LibraryClass"/>
452 <xs:element name="License">
455 <xs:extension base="Paragraph">
456 <xs:attribute name="URL" type="xs:anyURI" use="optional"/>
461 <xs:element name="ModuleBuildOptions">
464 <xs:any minOccurs="0" maxOccurs="unbounded" processContents="lax"/>
468 <xs:element name="ModuleSaBuildOptions">
471 <xs:element minOccurs="0" maxOccurs="1" name="FvBinding" type="KeywordList"/>
472 <!-- The FfsFileNameGuid allows the Platform Integrator to specify a GUID for the FFS File Name GUID -->
473 <xs:element minOccurs="0" maxOccurs="1" name="FfsFileNameGuid" type="GuidType"/>
474 <!-- If binding is specified, you MUST specify the FfsFormatKey -->
475 <xs:element minOccurs="0" maxOccurs="1" name="FfsFormatKey" type="KeywordType"/>
476 <xs:element minOccurs="0" maxOccurs="1" ref="Options"/>
480 <xs:element name="ModuleDefinitions">
483 <xs:element minOccurs="1" maxOccurs="1" name="SupportedArchitectures" type="ArchListType"/>
484 <xs:element minOccurs="1" maxOccurs="1" name="BinaryModule" type="xs:boolean" default="false"/>
485 <xs:element minOccurs="1" maxOccurs="1" name="OutputFileBasename" type="FileNameConvention"/>
486 <xs:element minOccurs="0" maxOccurs="1" name="ClonedFrom">
489 <xs:element minOccurs="1" maxOccurs="unbounded" name="Cloned">
492 <xs:element minOccurs="1" maxOccurs="1" name="PackageGuid" type="GuidType"/>
493 <xs:element minOccurs="1" maxOccurs="1" name="PackageVersion" type="VersionDataType"/>
494 <xs:element minOccurs="1" maxOccurs="1" name="ModuleGuid" type="GuidType"/>
495 <xs:element minOccurs="1" maxOccurs="1" name="ModuleVersion" type="VersionDataType"/>
497 <!-- The Id is a number used to track heritage the first entry will be 0 and increment from then on. -->
498 <xs:attribute name="Id" type="xs:nonNegativeInteger" use="required"/>
499 <!-- If the original module was installed from a FAR, track the FAR it came from. -->
500 <xs:attribute name="FarGuid" type="GuidType" use="optional"/>
509 <xs:element name="ModuleType" type="ModuleTypeDef">
511 <xs:documentation xml:lang="en">Describe the valid EFI Phase that the Module is designed to execute under.</xs:documentation>
514 <!-- Use in Final -->
515 <xs:element name="MsaFiles">
517 <xs:documentation xml:lang="en">MsaFiles is a child of Surface Area Package Description (SPD) files</xs:documentation>
521 <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename" type="PathAndFilename"/>
525 <xs:element name="Options">
528 <xs:element minOccurs="1" maxOccurs="unbounded" ref="Option"/>
532 <xs:element name="NonProcessedFiles">
534 <xs:sequence minOccurs="1" maxOccurs="unbounded">
535 <xs:element name="Filename" type="PathAndFilename"/>
539 <xs:element name="Option">
540 <!-- This element is used to store flags from the Tools -->
543 <xs:extension base="xs:normalizedString">
544 <xs:attributeGroup ref="OptionAttributes"/>
549 <xs:element name="PackageDefinitions">
552 <xs:element minOccurs="1" maxOccurs="1" name="ReadOnly" type="xs:boolean" default="false"/>
553 <xs:element minOccurs="1" maxOccurs="1" name="RePackage" type="xs:boolean" default="false"/>
554 <xs:element minOccurs="0" maxOccurs="1" name="ClonedFrom">
557 <xs:element minOccurs="1" maxOccurs="unbounded" name="Cloned">
560 <xs:element minOccurs="1" maxOccurs="1" name="PackageGuid" type="GuidType"/>
561 <xs:element minOccurs="1" maxOccurs="1" name="PackageVersion" type="VersionDataType"/>
563 <!-- The Id is a number used to track heritage the first entry will be 0 and increment from then on. -->
564 <xs:attribute name="Id" type="xs:nonNegativeInteger" use="required"/>
565 <!-- If the original Package was installed from a FAR, track the FAR it came from. -->
566 <xs:attribute name="FarGuid" type="GuidType" use="optional"/>
575 <xs:element name="PackageDependencies">
577 <xs:documentation xml:lang="en">This tag is used in the Module Surface Area Description File (MSA) to track package dependencies for a module.</xs:documentation>
578 <xs:documentation xml:lang="en">Attributes to PackageName include Required: Usage PackageGuid PackageVesion, Optional: FeatureFlag</xs:documentation>
582 <xs:element minOccurs="1" maxOccurs="unbounded" name="Package">
584 <xs:attributeGroup ref="PackageAttributes"/>
590 <xs:element name="PackageHeaders">
592 <xs:documentation xml:lang="en">PackageHeaders is a child of PackageSurfaceArea (SPD) </xs:documentation>
596 <xs:element minOccurs="1" maxOccurs="unbounded" name="IncludePkgHeader">
599 <xs:extension base="PathAndFilename">
600 <xs:attributeGroup ref="PackageHeaderAttributes"/>
608 <xs:element name="PackageList">
609 <!-- Valid for DB usage only! -->
611 <xs:documentation xml:lang="en">This tag is used in the Framework Package Database File to track all packages (SPD files) installed in a workspace. (Database)</xs:documentation>
615 <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename" type="DbPathAndFilename"/>
619 <!-- PcdBuildDefinition is a child of FPD ModuleSA element for FIXED_AT_BUILD, PATCHABLE_IN_MODULE, and FEATURE_FLAG PCDS Only! -->
620 <xs:element name="PcdBuildDefinition">
622 <xs:documentation xml:lang="en">Child of FPD ModuleSA element for FIXED_AT_BUILD, PATCHABLE_IN_MODULE, and FEATURE_FLAG PCDS Only!</xs:documentation>
626 <xs:element minOccurs="1" maxOccurs="unbounded" name="PcdData">
629 <xs:element minOccurs="1" maxOccurs="1" name="C_Name" type="C_NameType"/>
630 <xs:element minOccurs="1" maxOccurs="1" name="Token" type="TokenDataType"/>
631 <xs:element minOccurs="1" maxOccurs="1" name="TokenSpaceGuidCName" type="C_NameType"/>
632 <xs:element minOccurs="1" maxOccurs="1" name="DatumType" type="PcdDataTypes"/>
633 <!-- MaxDatumSize is only required if the DatumType is VOID* -->
634 <xs:element minOccurs="0" maxOccurs="1" name="MaxDatumSize" type="DatumSizeLimitation"/>
635 <xs:element minOccurs="0" maxOccurs="1" name="Value" type="DefaultValueType"/>
637 <xs:attributeGroup ref="PcdBuildDefinitionAttributes"/>
643 <xs:group name="DefaultGroup">
645 <xs:element minOccurs="1" maxOccurs="1" name="Value" type="DefaultValueType"/>
648 <xs:group name="HiiEnable">
650 <xs:documentation xml:lang="en">If HiiEnable group is specified, then HiiEnable is default true</xs:documentation>
653 <xs:element minOccurs="1" maxOccurs="1" name="VariableName" type="HexWordArrayType"/>
654 <xs:element minOccurs="1" maxOccurs="1" name="VariableGuid" type="C_NameType"/>
655 <xs:element minOccurs="1" maxOccurs="1" name="VariableOffset" type="Hex64BitDataType"/>
656 <xs:element minOccurs="1" maxOccurs="1" name="HiiDefaultValue" type="DefaultValueType"/>
659 <xs:group name="VpdEnable">
661 <xs:documentation xml:lang="en">If VpdEnable group is specified, then VpdEnable is default true</xs:documentation>
664 <xs:element minOccurs="1" maxOccurs="1" name="VpdOffset" type="Hex64BitDataType"/>
667 <xs:element name="PcdCoded">
669 <xs:documentation xml:lang="en">Child of Module Surface Area Description (MSA)</xs:documentation>
673 <xs:element minOccurs="1" maxOccurs="unbounded" name="PcdEntry">
676 <xs:element minOccurs="1" maxOccurs="1" name="C_Name" type="C_NameType"/>
677 <xs:element minOccurs="1" maxOccurs="1" name="TokenSpaceGuidCName" type="C_NameType"/>
678 <xs:element minOccurs="0" maxOccurs="1" name="DefaultValue" type="DefaultValueType"/>
679 <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
681 <!-- MSA file declares a single usage, and must match one of the entries in what the SPD file declares as the set of possible Item Types. -->
682 <xs:attributeGroup ref="PcdCodedAttributes"/>
688 <!-- LAH This is PcdDeclarations FINAL version -->
689 <xs:element name="PcdDeclarations">
691 <xs:documentation xml:lang="en">PcdDeclaratins is a child of Package Surface Area Description (SPD)</xs:documentation>
694 <xs:sequence minOccurs="1">
695 <xs:element maxOccurs="unbounded" name="PcdEntry">
698 <xs:element minOccurs="1" maxOccurs="1" name="C_Name" type="C_NameType"/>
699 <xs:element minOccurs="1" maxOccurs="1" name="Token" type="TokenDataType"/>
700 <xs:element minOccurs="1" maxOccurs="1" name="TokenSpaceGuidCName" type="C_NameType"/>
701 <xs:element minOccurs="1" maxOccurs="1" name="DatumType" type="PcdDataTypes"/>
702 <xs:element minOccurs="1" maxOccurs="1" name="ValidUsage" type="PcdListType"/>
703 <xs:element minOccurs="0" maxOccurs="1" name="DefaultValue" type="DefaultValueType"/>
704 <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
706 <xs:attributeGroup ref="PcdDeclarationAttributes"/>
712 <xs:element name="FarList">
713 <!-- Valid for DB usage only! -->
715 <xs:documentation xml:lang="en">This tag is used in the Framework Package Database File to track all DISTRIBUTION packages (FAR files) installed in a workspace. (Database)</xs:documentation>
719 <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename" type="DbPathAndFilename"/>
723 <xs:element name="FfsFormatDeclarations">
726 <xs:element minOccurs="1" maxOccurs="unbounded" name="FfsFormatDeclaration">
727 <!-- Required Attributes are the FfsFormatKeyword and SupModuleList -->
730 <xs:element minOccurs="1" maxOccurs="unbounded" ref="ProcessStep"/>
732 <xs:attributeGroup ref="FfsAttributes"/>
738 <xs:element name="PpiDeclarations">
740 <xs:documentation xml:lang="en">PpiDeclarations is a child of PackageSurfaceArea (SPD) </xs:documentation>
744 <xs:element minOccurs="1" maxOccurs="unbounded" name="Entry">
747 <xs:element minOccurs="1" maxOccurs="1" name="C_Name" type="C_NameType"/>
748 <xs:element minOccurs="1" maxOccurs="1" name="GuidValue" type="GuidType"/>
749 <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
751 <xs:attributeGroup ref="PpiDeclarationAttributes"/>
757 <xs:element name="PPIs">
759 <xs:documentation xml:lang="en">Provide for one or more Ppi or PpiNotify sections. </xs:documentation>
762 <xs:sequence minOccurs="1">
763 <xs:element minOccurs="0" maxOccurs="unbounded" name="Ppi">
766 <xs:element minOccurs="1" maxOccurs="1" name="PpiCName" type="C_NameType"/>
767 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
769 <xs:attributeGroup ref="PpiAttributes"/>
772 <xs:element minOccurs="0" maxOccurs="unbounded" name="PpiNotify">
775 <xs:element minOccurs="1" maxOccurs="1" name="PpiNotifyCName" type="C_NameType"/>
776 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
778 <xs:attributeGroup ref="PpiNotifyAttributes"/>
784 <xs:element name="ProtocolDeclarations">
786 <xs:documentation xml:lang="en">ProtocolDeclarations is a child of PackageSurfaceArea (SPD) </xs:documentation>
790 <xs:element minOccurs="1" maxOccurs="unbounded" name="Entry">
793 <xs:element minOccurs="1" maxOccurs="1" name="C_Name" type="C_NameType"/>
794 <xs:element minOccurs="1" maxOccurs="1" name="GuidValue" type="GuidType"/>
795 <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
797 <xs:attributeGroup ref="ProtocolDeclarationAttributes"/>
803 <xs:element name="Protocols">
805 <xs:documentation xml:lang="en">If either Protocol or ProtocolNotify sections are needed, one or more of them should be specified within this section</xs:documentation>
809 <xs:element minOccurs="0" maxOccurs="unbounded" name="Protocol">
812 <xs:element minOccurs="1" maxOccurs="1" name="ProtocolCName" type="C_NameType"/>
813 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
815 <xs:attributeGroup ref="ProtocolAttributes"/>
818 <xs:element minOccurs="0" maxOccurs="unbounded" name="ProtocolNotify">
821 <xs:element minOccurs="1" maxOccurs="1" name="ProtocolNotifyCName" type="C_NameType"/>
822 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
824 <xs:attributeGroup ref="ProtocolNotifyAttributes"/>
830 <xs:element name="ProcessStep">
833 <!-- The following is a macro for Apache ANT -->
834 <xs:element minOccurs="0" maxOccurs="1" name="MacroDefFile">
837 <xs:extension base="PathAndFilename">
838 <xs:attribute name="MacroName" type="KeywordType" use="required"/>
843 <!-- The following is for System Executables -->
844 <xs:element minOccurs="0" maxOccurs="1" name="ToolName" type="xs:NCName"/>
845 <xs:element minOccurs="0" maxOccurs="unbounded" name="ToolArgs" type="xs:normalizedString"/>
846 <xs:element minOccurs="0" maxOccurs="unbounded" name="InputPattern" type="xs:normalizedString"/>
847 <xs:element minOccurs="0" maxOccurs="1" name="OutputPattern" type="xs:normalizedString"/>
849 <xs:attributeGroup ref="ProcessStepAttributes"/>
852 <xs:element name="SourceFiles">
854 <xs:documentation xml:lang="en">Multiple Filenames may be specified, and they may also be scoped to a specific Architecture.</xs:documentation>
858 <xs:element minOccurs="1" maxOccurs="unbounded" ref="Filename"/>
862 <xs:element name="SkuInfo">
865 <xs:element minOccurs="1" maxOccurs="unbounded" name="UiSkuName">
868 <xs:extension base="UiNameType">
869 <xs:attribute name="SkuID" type="xs:nonNegativeInteger" use="required"/>
877 <xs:element name="SystemTables">
879 <xs:documentation xml:lang="en">This is list of System Table elements.</xs:documentation>
883 <xs:element minOccurs="1" maxOccurs="unbounded" name="SystemTableCNames">
886 <xs:element minOccurs="1" maxOccurs="1" name="SystemTableCName" type="C_NameType"/>
887 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
889 <xs:attributeGroup ref="SystemTableAttributes"/>
895 <xs:element name="UserDefinedAntTasks">
897 <xs:documentation xml:lang="en">This is a sub-element of BuildOptions</xs:documentation>
898 <xs:documentation xml:lang="en">Permit Users to define their own custom ANT tasks.</xs:documentation>
902 <xs:element minOccurs="1" maxOccurs="unbounded" ref="AntTask"/>
906 <xs:element name="UserExtensions">
909 <xs:any minOccurs="0" maxOccurs="unbounded" processContents="lax"/>
911 <xs:attribute name="UserID" type="xs:NCName" use="required"/>
912 <xs:attribute name="Identifier" type="xs:nonNegativeInteger" use="required"/>
915 <xs:element name="Variables">
917 <xs:documentation xml:lang="en">An MSA FILE list of EFI Variables described by string pair.</xs:documentation>
921 <xs:element minOccurs="1" maxOccurs="unbounded" name="Variable">
923 <xs:documentation xml:lang="en">This is an EFI Variable Entry</xs:documentation>
927 <xs:element minOccurs="1" maxOccurs="1" name="VariableName" type="HexWordArrayType"/>
928 <xs:element minOccurs="1" maxOccurs="1" name="GuidC_Name" type="C_NameType"/>
929 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
931 <xs:attributeGroup ref="VariableAttributes"/>
937 <xs:element name="Version" type="VersionDataType"/>