Tools/XMLSchema/FrameworkDataElements.xsd

   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">
   3   <!--
   4     Filename: FrameworkDataElements.xsd
   5
   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
  10
  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.
  13
  14   -->
  15   <xs:annotation>
  16     <xs:documentation xml:lang="en"> This schema defines EFI and Framework Data Elements </xs:documentation>
  17   </xs:annotation>
  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">
  23     <xs:annotation>
  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>
  26     </xs:annotation>
  27   </xs:element>
  28   <xs:element name="AntTask">
  29     <xs:annotation>
  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>
  32     </xs:annotation>
  33     <xs:complexType>
  34       <xs:sequence>
  35         <xs:element minOccurs="0" maxOccurs="1" name="AntCmdOptions" type="xs:normalizedString"/>
  36         <xs:element minOccurs="0" maxOccurs="1" name="Filename" type="PathAndFilename"/>
  37       </xs:sequence>
  38       <xs:attribute name="Id" type="xs:int" use="required"/>
  39     </xs:complexType>
  40   </xs:element>
  41   <xs:element name="BootModes">
  42     <xs:annotation>
  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>
  45     </xs:annotation>
  46     <xs:complexType>
  47       <xs:sequence>
  48         <xs:element minOccurs="1" maxOccurs="unbounded" name="BootMode">
  49           <xs:complexType>
  50             <xs:sequence minOccurs="0">
  51               <xs:element name="HelpText" type="Paragraph"/>
  52             </xs:sequence>
  53             <xs:attributeGroup ref="BootModeAttributes"/>
  54           </xs:complexType>
  55         </xs:element>
  56       </xs:sequence>
  57     </xs:complexType>
  58   </xs:element>
  59   <xs:element name="BuildOptions">
  60     <xs:annotation>
  61       <xs:documentation xml:lang="en">BuildOptions is valid for FPD files.</xs:documentation>
  62     </xs:annotation>
  63     <xs:complexType>
  64       <xs:sequence>
  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">
  70           <xs:complexType>
  71             <xs:sequence>
  72               <xs:element minOccurs="0" maxOccurs="unbounded" name="Attribute">
  73                 <xs:complexType>
  74                   <xs:attribute name="Name" type="C_NameType"/>
  75                   <xs:attribute name="Value" type="C_NameType"/>
  76                 </xs:complexType>
  77               </xs:element>
  78               <xs:element minOccurs="0" maxOccurs="1" name="Sections">
  79                 <xs:complexType>
  80                   <xs:sequence minOccurs="1">
  81                     <xs:element name="Section" minOccurs="0" maxOccurs="unbounded">
  82                       <xs:complexType>
  83                         <xs:sequence>
  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"/>
  89                         </xs:sequence>
  90                         <xs:attributeGroup ref=" SectionsAttributes "/>
  91                       </xs:complexType>
  92                     </xs:element>
  93                     <xs:element name="Sections" minOccurs="0" maxOccurs="unbounded">
  94                       <xs:complexType>
  95                         <xs:sequence minOccurs="1" maxOccurs="unbounded">
  96                           <xs:element name="Section">
  97                             <xs:complexType>
  98                               <xs:sequence>
  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"/>
 104                               </xs:sequence>
 105                               <xs:attributeGroup ref="SectionsAttributes"/>
 106                             </xs:complexType>
 107                           </xs:element>
 108                         </xs:sequence>
 109                         <xs:attributeGroup ref=" SectionsAttributes "/>
 110                       </xs:complexType>
 111                     </xs:element>
 112                   </xs:sequence>
 113                   <xs:attributeGroup ref=" SectionsAttributes "/>
 114                 </xs:complexType>
 115               </xs:element>
 116             </xs:sequence>
 117             <xs:attribute name="FfsKey" type="KeywordType" use="optional"/>
 118           </xs:complexType>
 119         </xs:element>
 120       </xs:sequence>
 121     </xs:complexType>
 122   </xs:element>
 123   <xs:element name="Copyright" type="Paragraph"/>
 124   <xs:element name="DataHubs">
 125     <xs:annotation>
 126       <xs:documentation xml:lang="en">This is a list of DataHubRecord elements.</xs:documentation>
 127     </xs:annotation>
 128     <xs:complexType>
 129       <xs:sequence>
 130         <xs:element minOccurs="1" maxOccurs="unbounded" name="DataHubRecord">
 131           <xs:complexType>
 132             <xs:sequence>
 133               <xs:element minOccurs="1" maxOccurs="1" name="DataHubCName" type="C_NameType"/>
 134               <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
 135             </xs:sequence>
 136             <xs:attributeGroup ref="DataHubAttributes"/>
 137           </xs:complexType>
 138         </xs:element>
 139       </xs:sequence>
 140     </xs:complexType>
 141   </xs:element>
 142   <xs:element name="DefaultValue">
 143     <xs:annotation>
 144       <xs:documentation xml:lang="en">The default setting of a PCD entry.</xs:documentation>
 145     </xs:annotation>
 146     <xs:complexType>
 147       <xs:simpleContent>
 148         <xs:extension base="xs:normalizedString"/>
 149       </xs:simpleContent>
 150     </xs:complexType>
 151   </xs:element>
 152   <xs:element name="Description" type="Paragraph">
 153     <xs:annotation>
 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>
 155     </xs:annotation>
 156   </xs:element>
 157   <xs:element name="DynamicPcdBuildDefinitions">
 158     <xs:annotation>
 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>
 161     </xs:annotation>
 162     <xs:complexType>
 163       <xs:sequence>
 164         <xs:element minOccurs="1" maxOccurs="unbounded" name="PcdBuildData">
 165           <xs:complexType>
 166             <xs:sequence>
 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">
 173                 <xs:complexType>
 174                   <xs:sequence>
 175                     <xs:element minOccurs="1" maxOccurs="1" name="SkuId" type="xs:nonNegativeInteger"/>
 176                     <xs:choice>
 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"/>
 180                     </xs:choice>
 181                   </xs:sequence>
 182                 </xs:complexType>
 183               </xs:element>
 184             </xs:sequence>
 185             <xs:attributeGroup ref="DynamicBuildPcdAttributes"/>
 186           </xs:complexType>
 187         </xs:element>
 188       </xs:sequence>
 189     </xs:complexType>
 190   </xs:element>
 191   <xs:element name="Events">
 192     <xs:annotation>
 193       <xs:documentation xml:lang="en">This is a list of MSA Events</xs:documentation>
 194     </xs:annotation>
 195     <xs:complexType>
 196       <xs:sequence>
 197         <xs:element minOccurs="0" maxOccurs="1" name="CreateEvents">
 198           <xs:complexType>
 199             <xs:sequence>
 200               <xs:element minOccurs="1" maxOccurs="unbounded" name="EventTypes">
 201                 <xs:complexType>
 202                   <xs:sequence>
 203                     <xs:element minOccurs="1" maxOccurs="1" name="EventType" type="EventTypes"/>
 204                     <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
 205                   </xs:sequence>
 206                   <xs:attributeGroup ref="EventAttributes"/>
 207                 </xs:complexType>
 208               </xs:element>
 209             </xs:sequence>
 210           </xs:complexType>
 211         </xs:element>
 212         <xs:element minOccurs="0" maxOccurs="1" name="SignalEvents">
 213           <xs:annotation>
 214             <xs:documentation xml:lang="en">Module has an event that is waiting to be signaled. Event is named by GUID.</xs:documentation>
 215           </xs:annotation>
 216           <xs:complexType>
 217             <xs:sequence>
 218               <xs:element minOccurs="1" maxOccurs="unbounded" name="EventTypes">
 219                 <xs:complexType>
 220                   <xs:sequence>
 221                     <xs:element minOccurs="1" maxOccurs="1" name="EventType" type="EventTypes"/>
 222                     <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
 223                   </xs:sequence>
 224                   <xs:attributeGroup ref="EventAttributes"/>
 225                 </xs:complexType>
 226               </xs:element>
 227             </xs:sequence>
 228           </xs:complexType>
 229         </xs:element>
 230       </xs:sequence>
 231     </xs:complexType>
 232   </xs:element>
 233   <xs:element name="Externs">
 234     <xs:annotation>
 235       <xs:documentation xml:lang="en">This is a child of MSA files.</xs:documentation>
 236     </xs:annotation>
 237     <xs:complexType>
 238       <xs:sequence minOccurs="1">
 239         <xs:element minOccurs="0" maxOccurs="1" name="PcdIsDriver" type="PcdDriverTypes"/>
 240         <xs:element minOccurs="0" maxOccurs="unbounded" name="Specification" type="Sentence"/>
 241         <xs:element minOccurs="0" maxOccurs="unbounded" name="Extern">
 242           <xs:complexType>
 243             <xs:choice minOccurs="1">
 244               <xs:sequence>
 245                 <xs:annotation>
 246                   <xs:documentation xml:lang="en">Driver Module</xs:documentation>
 247                 </xs:annotation>
 248                 <xs:element minOccurs="0" maxOccurs="1" name="ModuleEntryPoint" type="C_NameType"/>
 249                 <xs:element minOccurs="0" maxOccurs="1" name="ModuleUnloadImage" type="C_NameType"/>
 250               </xs:sequence>
 251               <xs:sequence>
 252                 <xs:annotation>
 253                   <xs:documentation xml:lang="en">Library Module</xs:documentation>
 254                 </xs:annotation>
 255                 <xs:element minOccurs="0" maxOccurs="1" name="Constructor" type="C_NameType"/>
 256                 <xs:element minOccurs="0" maxOccurs="1" name="Destructor" type="C_NameType"/>
 257               </xs:sequence>
 258               <xs:sequence>
 259                 <xs:annotation>
 260                   <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>
 261                   <xs:documentation xml:lang="en">Permit User Defined Extern Tags</xs:documentation>
 262                 </xs:annotation>
 263                 <xs:element minOccurs="0" maxOccurs="1" name="DriverBinding" type="C_NameType"/>
 264                 <xs:element minOccurs="0" maxOccurs="1" name="ComponentName" type="C_NameType"/>
 265                 <xs:element minOccurs="0" maxOccurs="1" name="DriverConfig" type="C_NameType"/>
 266                 <xs:element minOccurs="0" maxOccurs="1" name="DriverDiag" type="C_NameType"/>
 267               </xs:sequence>
 268               <xs:sequence>
 269                 <xs:annotation>
 270                   <xs:documentation xml:lang="en"> Module Call Backs</xs:documentation>
 271                 </xs:annotation>
 272                 <xs:element minOccurs="0" maxOccurs="1" name="SetVirtualAddressMapCallBack" type="C_NameType"/>
 273                 <xs:element minOccurs="0" maxOccurs="1" name="ExitBootServicesCallBack" type="C_NameType"/>
 274               </xs:sequence>
 275             </xs:choice>
 276             <xs:attributeGroup ref="ExternAttributes"/>
 277           </xs:complexType>
 278         </xs:element>
 279       </xs:sequence>
 280     </xs:complexType>
 281   </xs:element>
 282   <xs:element name="Filename">
 283     <xs:annotation>
 284       <xs:documentation xml:lang="en">Describe the valid content of a filename This should extend PathAndFilename - Variable names not allowed here!</xs:documentation>
 285     </xs:annotation>
 286     <xs:complexType>
 287       <xs:simpleContent>
 288         <xs:extension base="PathAndFilename">
 289           <xs:attributeGroup ref="FilenameAttributes"/>
 290         </xs:extension>
 291       </xs:simpleContent>
 292     </xs:complexType>
 293   </xs:element>
 294   <xs:element name="Filenames">
 295     <xs:annotation>
 296       <xs:documentation xml:lang="en">This is a list of Filenames</xs:documentation>
 297     </xs:annotation>
 298     <xs:complexType>
 299       <xs:sequence minOccurs="1">
 300         <xs:element minOccurs="0" maxOccurs="unbounded" ref="Filename"/>
 301       </xs:sequence>
 302     </xs:complexType>
 303   </xs:element>
 304   <xs:element name="GuidDeclarations">
 305     <xs:annotation>
 306       <xs:documentation xml:lang="en">This is a child of PackageSurfaceArea (SPD) </xs:documentation>
 307     </xs:annotation>
 308     <xs:complexType>
 309       <xs:sequence>
 310         <xs:element minOccurs="1" maxOccurs="unbounded" name="Entry">
 311           <xs:complexType>
 312             <xs:sequence>
 313               <xs:element minOccurs="1" maxOccurs="1" name="C_Name" type="C_NameType"/>
 314               <xs:element minOccurs="1" maxOccurs="1" name="GuidValue" type="GuidType"/>
 315               <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
 316             </xs:sequence>
 317             <xs:attributeGroup ref="GuidDeclarationAttributes"/>
 318           </xs:complexType>
 319         </xs:element>
 320       </xs:sequence>
 321     </xs:complexType>
 322   </xs:element>
 323   <xs:element name="Guids">
 324     <xs:complexType>
 325       <xs:sequence>
 326         <xs:element minOccurs="1" maxOccurs="unbounded" name="GuidCNames">
 327           <xs:annotation>
 328             <xs:documentation xml:lang="en">Describe the valid content of a GUID element in and MSA file.</xs:documentation>
 329           </xs:annotation>
 330           <xs:complexType>
 331             <xs:sequence>
 332               <xs:element minOccurs="1" maxOccurs="1" name="GuidCName" type="C_NameType"/>
 333               <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
 334             </xs:sequence>
 335             <xs:attributeGroup ref="GuidAttributes"/>
 336           </xs:complexType>
 337         </xs:element>
 338       </xs:sequence>
 339     </xs:complexType>
 340   </xs:element>
 341   <xs:element name="HiiPackages">
 342     <xs:annotation>
 343       <xs:documentation xml:lang="en">Describe the list of a HiiPackage elements</xs:documentation>
 344     </xs:annotation>
 345     <xs:complexType>
 346       <xs:sequence>
 347         <xs:element minOccurs="1" maxOccurs="unbounded" name="HiiPackage">
 348           <xs:complexType>
 349             <xs:sequence>
 350               <xs:element minOccurs="1" maxOccurs="1" name="HiiCName" type="C_NameType"/>
 351               <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
 352             </xs:sequence>
 353             <xs:attributeGroup ref="HiiPackageAttributes"/>
 354           </xs:complexType>
 355         </xs:element>
 356       </xs:sequence>
 357     </xs:complexType>
 358   </xs:element>
 359   <xs:element name="Hobs">
 360     <xs:complexType>
 361       <xs:sequence>
 362         <xs:element minOccurs="1" maxOccurs="unbounded" name="HobTypes">
 363           <xs:complexType>
 364             <xs:sequence>
 365               <xs:element minOccurs="1" maxOccurs="1" name="HobType" type="HobTypes"/>
 366               <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
 367             </xs:sequence>
 368             <xs:attributeGroup ref="HobAttributes"/>
 369           </xs:complexType>
 370         </xs:element>
 371       </xs:sequence>
 372     </xs:complexType>
 373   </xs:element>
 374   <xs:element name="IncludeHeader">
 375     <xs:complexType>
 376       <xs:simpleContent>
 377         <xs:extension base="PathAndFilename">
 378           <xs:attributeGroup ref="IncludeHeaderAttributes"/>
 379         </xs:extension>
 380       </xs:simpleContent>
 381     </xs:complexType>
 382   </xs:element>
 383   <xs:element name="IndustryStdIncludes">
 384     <xs:complexType>
 385       <xs:sequence>
 386         <xs:element minOccurs="1" maxOccurs="unbounded" ref="IndustryStdHeader"/>
 387       </xs:sequence>
 388     </xs:complexType>
 389   </xs:element>
 390   <xs:element name="IndustryStdHeader">
 391     <xs:complexType>
 392       <xs:sequence>
 393         <xs:element minOccurs="1" maxOccurs="1" name="IncludeHeader" type="PathAndFilename"/>
 394         <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
 395       </xs:sequence>
 396       <xs:attributeGroup ref="IndustryStdHeaderAttributes"/>
 397     </xs:complexType>
 398   </xs:element>
 399   <xs:element name="Libraries">
 400     <xs:annotation>
 401       <xs:documentation xml:lang="en">Different (Module) Instances of Libraries used ONLY in FPD Files.</xs:documentation>
 402     </xs:annotation>
 403     <xs:complexType>
 404       <xs:sequence>
 405         <xs:element minOccurs="1" maxOccurs="unbounded" name="Instance">
 406           <xs:complexType>
 407             <xs:attributeGroup ref="LibraryAttributes"/>
 408           </xs:complexType>
 409         </xs:element>
 410       </xs:sequence>
 411     </xs:complexType>
 412   </xs:element>
 413   <xs:element name="LibraryClass">
 414     <xs:annotation>
 415       <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>
 416     </xs:annotation>
 417     <xs:complexType>
 418       <xs:sequence>
 419         <xs:element minOccurs="1" maxOccurs="1" name="Keyword" type="KeywordType"/>
 420         <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
 421       </xs:sequence>
 422       <xs:attributeGroup ref="LibraryClassAttributes"/>
 423     </xs:complexType>
 424   </xs:element>
 425   <!-- LAH This is SPD LibraryClassDeclarations FINAL version -->
 426   <xs:element name="LibraryClassDeclarations">
 427     <xs:complexType>
 428       <xs:sequence>
 429         <xs:element minOccurs="1" maxOccurs="unbounded" name="LibraryClass">
 430           <xs:complexType>
 431             <xs:sequence>
 432               <xs:element minOccurs="1" maxOccurs="1" name="IncludeHeader" type="PathAndFilename"/>
 433               <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
 434             </xs:sequence>
 435             <xs:attributeGroup ref="LibraryClassDeclarationAttributes"/>
 436           </xs:complexType>
 437         </xs:element>
 438       </xs:sequence>
 439     </xs:complexType>
 440   </xs:element>
 441   <xs:element name="LibraryClassDefinitions">
 442     <xs:annotation>
 443       <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>
 444     </xs:annotation>
 445     <xs:complexType>
 446       <xs:sequence>
 447         <xs:element minOccurs="1" maxOccurs="unbounded" ref="LibraryClass"/>
 448       </xs:sequence>
 449     </xs:complexType>
 450   </xs:element>
 451   <xs:element name="License">
 452     <xs:complexType>
 453       <xs:simpleContent>
 454         <xs:extension base="Paragraph">
 455           <xs:attribute name="URL" type="xs:anyURI" use="optional"/>
 456         </xs:extension>
 457       </xs:simpleContent>
 458     </xs:complexType>
 459   </xs:element>
 460   <xs:element name="ModuleBuildOptions">
 461     <xs:complexType>
 462       <xs:sequence>
 463         <xs:any minOccurs="0" maxOccurs="unbounded" processContents="lax"/>
 464       </xs:sequence>
 465     </xs:complexType>
 466   </xs:element>
 467   <xs:element name="ModuleSaBuildOptions">
 468     <xs:complexType>
 469       <xs:sequence>
 470         <xs:element minOccurs="0" maxOccurs="1" name="FvBinding" type="KeywordList"/>
 471         <!-- The FfsFileNameGuid allows the Platform Integrator to specify a GUID for the FFS File Name GUID -->
 472         <xs:element minOccurs="0" maxOccurs="1" name="FfsFileNameGuid" type="GuidType"/>
 473         <!-- If binding is specified, you MUST specify the FfsFormatKey -->
 474         <xs:element minOccurs="0" maxOccurs="1" name="FfsFormatKey" type="KeywordType"/>
 475         <xs:element minOccurs="0" maxOccurs="1" ref="Options"/>
 476       </xs:sequence>
 477     </xs:complexType>
 478   </xs:element>
 479   <xs:element name="ModuleDefinitions">
 480     <xs:complexType>
 481       <xs:sequence>
 482         <xs:element minOccurs="1" maxOccurs="1" name="SupportedArchitectures" type="ArchListType"/>
 483         <xs:element minOccurs="1" maxOccurs="1" name="BinaryModule" type="xs:boolean" default="false"/>
 484         <xs:element minOccurs="1" maxOccurs="1" name="OutputFileBasename" type="FileNameConvention"/>
 485         <xs:element minOccurs="0" maxOccurs="1" name="ClonedFrom">
 486           <xs:complexType>
 487             <xs:sequence>
 488               <xs:element minOccurs="1" maxOccurs="unbounded" name="Cloned">
 489                 <xs:complexType>
 490                   <xs:sequence>
 491                     <xs:element minOccurs="1" maxOccurs="1" name="PackageGuid" type="GuidType"/>
 492                     <xs:element minOccurs="1" maxOccurs="1" name="PackageVersion" type="VersionDataType"/>
 493                     <xs:element minOccurs="1" maxOccurs="1" name="ModuleGuid" type="GuidType"/>
 494                     <xs:element minOccurs="1" maxOccurs="1" name="ModuleVersion" type="VersionDataType"/>
 495                   </xs:sequence>
 496                   <!-- The Id is a number used to track heritage  the first entry will be 0 and increment from then on. -->
 497                   <xs:attribute name="Id" type="xs:nonNegativeInteger" use="required"/>
 498                   <!-- If the original module was installed from a FAR, track the FAR it came from. -->
 499                   <xs:attribute name="FarGuid" type="GuidType" use="optional"/>
 500                 </xs:complexType>
 501               </xs:element>
 502             </xs:sequence>
 503           </xs:complexType>
 504         </xs:element>
 505       </xs:sequence>
 506     </xs:complexType>
 507   </xs:element>
 508   <xs:element name="ModuleType" type="ModuleTypeDef">
 509     <xs:annotation>
 510       <xs:documentation xml:lang="en">Describe the valid EFI Phase that the Module is designed to execute under.</xs:documentation>
 511     </xs:annotation>
 512   </xs:element>
 513   <!-- Use in Final -->
 514   <xs:element name="MsaFiles">
 515     <xs:annotation>
 516       <xs:documentation xml:lang="en">MsaFiles is a child of Surface Area Package Description (SPD) files</xs:documentation>
 517     </xs:annotation>
 518     <xs:complexType>
 519       <xs:sequence>
 520         <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename" type="PathAndFilename"/>
 521       </xs:sequence>
 522     </xs:complexType>
 523   </xs:element>
 524   <xs:element name="Options">
 525     <xs:complexType>
 526       <xs:sequence>
 527         <xs:element minOccurs="1" maxOccurs="unbounded" ref="Option"/>
 528       </xs:sequence>
 529     </xs:complexType>
 530   </xs:element>
 531   <xs:element name="Option">
 532     <!-- This element is used to store flags from the Tools -->
 533     <xs:complexType>
 534       <xs:simpleContent>
 535         <xs:extension base="xs:normalizedString">
 536           <xs:attributeGroup ref="OptionAttributes"/>
 537         </xs:extension>
 538       </xs:simpleContent>
 539     </xs:complexType>
 540   </xs:element>
 541   <xs:element name="PackageDefinitions">
 542     <xs:complexType>
 543       <xs:sequence>
 544         <xs:element minOccurs="1" maxOccurs="1" name="ReadOnly" type="xs:boolean" default="false"/>
 545         <xs:element minOccurs="1" maxOccurs="1" name="RePackage" type="xs:boolean" default="false"/>
 546         <xs:element minOccurs="0" maxOccurs="1" name="ClonedFrom">
 547           <xs:complexType>
 548             <xs:sequence>
 549               <xs:element minOccurs="1" maxOccurs="unbounded" name="Cloned">
 550                 <xs:complexType>
 551                   <xs:sequence>
 552                     <xs:element minOccurs="1" maxOccurs="1" name="PackageGuid" type="GuidType"/>
 553                     <xs:element minOccurs="1" maxOccurs="1" name="PackageVersion" type="VersionDataType"/>
 554                   </xs:sequence>
 555                   <!-- The Id is a number used to track heritage  the first entry will be 0 and increment from then on. -->
 556                   <xs:attribute name="Id" type="xs:nonNegativeInteger" use="required"/>
 557                   <!-- If the original Package was installed from a FAR, track the FAR it came from. -->
 558                   <xs:attribute name="FarGuid" type="GuidType" use="optional"/>
 559                 </xs:complexType>
 560               </xs:element>
 561             </xs:sequence>
 562           </xs:complexType>
 563         </xs:element>
 564       </xs:sequence>
 565     </xs:complexType>
 566   </xs:element>
 567   <xs:element name="PackageDependencies">
 568     <xs:annotation>
 569       <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>
 570       <xs:documentation xml:lang="en">Attributes to PackageName include Required: Usage PackageGuid PackageVesion, Optional: FeatureFlag</xs:documentation>
 571     </xs:annotation>
 572     <xs:complexType>
 573       <xs:sequence>
 574         <xs:element minOccurs="1" maxOccurs="unbounded" name="Package">
 575           <xs:complexType>
 576             <xs:attributeGroup ref="PackageAttributes"/>
 577           </xs:complexType>
 578         </xs:element>
 579       </xs:sequence>
 580     </xs:complexType>
 581   </xs:element>
 582   <xs:element name="PackageHeaders">
 583     <xs:annotation>
 584       <xs:documentation xml:lang="en">PackageHeaders is a child of PackageSurfaceArea (SPD) </xs:documentation>
 585     </xs:annotation>
 586     <xs:complexType>
 587       <xs:sequence>
 588         <xs:element minOccurs="1" maxOccurs="unbounded" name="IncludePkgHeader">
 589           <xs:complexType>
 590             <xs:simpleContent>
 591               <xs:extension base="PathAndFilename">
 592                 <xs:attributeGroup ref="PackageHeaderAttributes"/>
 593               </xs:extension>
 594             </xs:simpleContent>
 595           </xs:complexType>
 596         </xs:element>
 597       </xs:sequence>
 598     </xs:complexType>
 599   </xs:element>
 600   <xs:element name="PackageList">
 601     <!-- Valid for DB usage only! -->
 602     <xs:annotation>
 603       <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>
 604     </xs:annotation>
 605     <xs:complexType>
 606       <xs:sequence>
 607         <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename" type="DbPathAndFilename"/>
 608       </xs:sequence>
 609     </xs:complexType>
 610   </xs:element>
 611   <!-- PcdBuildDefinition is a child of FPD ModuleSA element for FIXED_AT_BUILD, PATCHABLE_IN_MODULE, and FEATURE_FLAG PCDS Only! -->
 612   <xs:element name="PcdBuildDefinition">
 613     <xs:annotation>
 614       <xs:documentation xml:lang="en">Child of FPD ModuleSA element for FIXED_AT_BUILD, PATCHABLE_IN_MODULE, and FEATURE_FLAG PCDS Only!</xs:documentation>
 615     </xs:annotation>
 616     <xs:complexType>
 617       <xs:sequence>
 618         <xs:element minOccurs="1" maxOccurs="unbounded" name="PcdData">
 619           <xs:complexType>
 620             <xs:sequence>
 621               <xs:element minOccurs="1" maxOccurs="1" name="C_Name" type="C_NameType"/>
 622               <xs:element minOccurs="1" maxOccurs="1" name="Token" type="TokenDataType"/>
 623               <xs:element minOccurs="1" maxOccurs="1" name="TokenSpaceGuidCName" type="C_NameType"/>
 624               <xs:element minOccurs="1" maxOccurs="1" name="DatumType" type="PcdDataTypes"/>
 625               <!-- MaxDatumSize is only required if the DatumType is VOID* -->
 626               <xs:element minOccurs="0" maxOccurs="1" name="MaxDatumSize" type="DatumSizeLimitation"/>
 627               <xs:element minOccurs="0" maxOccurs="1" name="Value" type="DefaultValueType"/>
 628             </xs:sequence>
 629             <xs:attributeGroup ref="PcdBuildDefinitionAttributes"/>
 630           </xs:complexType>
 631         </xs:element>
 632       </xs:sequence>
 633     </xs:complexType>
 634   </xs:element>
 635   <xs:group name="DefaultGroup">
 636     <xs:sequence>
 637       <xs:element minOccurs="1" maxOccurs="1" name="Value" type="DefaultValueType"/>
 638     </xs:sequence>
 639   </xs:group>
 640   <xs:group name="HiiEnable">
 641     <xs:annotation>
 642       <xs:documentation xml:lang="en">If HiiEnable group is specified, then HiiEnable is default true</xs:documentation>
 643     </xs:annotation>
 644     <xs:sequence>
 645       <xs:element minOccurs="1" maxOccurs="1" name="VariableName" type="HexWordArrayType"/>
 646       <xs:element minOccurs="1" maxOccurs="1" name="VariableGuid" type="C_NameType"/>
 647       <xs:element minOccurs="1" maxOccurs="1" name="VariableOffset" type="Hex64BitDataType"/>
 648       <xs:element minOccurs="1" maxOccurs="1" name="HiiDefaultValue" type="DefaultValueType"/>
 649     </xs:sequence>
 650   </xs:group>
 651   <xs:group name="VpdEnable">
 652     <xs:annotation>
 653       <xs:documentation xml:lang="en">If VpdEnable group is specified, then VpdEnable is default true</xs:documentation>
 654     </xs:annotation>
 655     <xs:sequence>
 656       <xs:element minOccurs="1" maxOccurs="1" name="VpdOffset" type="Hex64BitDataType"/>
 657     </xs:sequence>
 658   </xs:group>
 659   <xs:element name="PcdCoded">
 660     <xs:annotation>
 661       <xs:documentation xml:lang="en">Child of Module Surface Area Description (MSA)</xs:documentation>
 662     </xs:annotation>
 663     <xs:complexType>
 664       <xs:sequence>
 665         <xs:element minOccurs="1" maxOccurs="unbounded" name="PcdEntry">
 666           <xs:complexType>
 667             <xs:sequence>
 668               <xs:element minOccurs="1" maxOccurs="1" name="C_Name" type="C_NameType"/>
 669               <xs:element minOccurs="1" maxOccurs="1" name="TokenSpaceGuidCName" type="C_NameType"/>
 670               <xs:element minOccurs="0" maxOccurs="1" name="DefaultValue" type="DefaultValueType"/>
 671               <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
 672             </xs:sequence>
 673             <!-- 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. -->
 674             <xs:attributeGroup ref="PcdCodedAttributes"/>
 675           </xs:complexType>
 676         </xs:element>
 677       </xs:sequence>
 678     </xs:complexType>
 679   </xs:element>
 680   <!-- LAH This is PcdDeclarations FINAL version -->
 681   <xs:element name="PcdDeclarations">
 682     <xs:annotation>
 683       <xs:documentation xml:lang="en">PcdDeclaratins is a child of Package Surface Area Description (SPD)</xs:documentation>
 684     </xs:annotation>
 685     <xs:complexType>
 686       <xs:sequence minOccurs="1">
 687         <xs:element maxOccurs="unbounded" name="PcdEntry">
 688           <xs:complexType>
 689             <xs:sequence>
 690               <xs:element minOccurs="1" maxOccurs="1" name="C_Name" type="C_NameType"/>
 691               <xs:element minOccurs="1" maxOccurs="1" name="Token" type="TokenDataType"/>
 692               <xs:element minOccurs="1" maxOccurs="1" name="TokenSpaceGuidCName" type="C_NameType"/>
 693               <xs:element minOccurs="1" maxOccurs="1" name="DatumType" type="PcdDataTypes"/>
 694               <xs:element minOccurs="1" maxOccurs="1" name="ValidUsage" type="PcdListType"/>
 695               <xs:element minOccurs="0" maxOccurs="1" name="DefaultValue" type="DefaultValueType"/>
 696               <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
 697             </xs:sequence>
 698             <xs:attributeGroup ref="PcdDeclarationAttributes"/>
 699           </xs:complexType>
 700         </xs:element>
 701       </xs:sequence>
 702     </xs:complexType>
 703   </xs:element>
 704   <xs:element name="FarList">
 705     <!-- Valid for DB usage only! -->
 706     <xs:annotation>
 707       <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>
 708     </xs:annotation>
 709     <xs:complexType>
 710       <xs:sequence>
 711         <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename" type="DbPathAndFilename"/>
 712       </xs:sequence>
 713     </xs:complexType>
 714   </xs:element>
 715   <xs:element name="FfsFormatDeclarations">
 716     <xs:complexType>
 717       <xs:sequence>
 718         <xs:element minOccurs="1" maxOccurs="unbounded" name="FfsFormatDeclaration">
 719           <!-- Required Attributes are the FfsFormatKeyword and SupModuleList -->
 720           <xs:complexType>
 721             <xs:sequence>
 722               <xs:element minOccurs="1" maxOccurs="unbounded" ref="ProcessStep"/>
 723             </xs:sequence>
 724             <xs:attributeGroup ref="FfsAttributes"/>
 725           </xs:complexType>
 726         </xs:element>
 727       </xs:sequence>
 728     </xs:complexType>
 729   </xs:element>
 730   <xs:element name="PpiDeclarations">
 731     <xs:annotation>
 732       <xs:documentation xml:lang="en">PpiDeclarations is a child of PackageSurfaceArea (SPD) </xs:documentation>
 733     </xs:annotation>
 734     <xs:complexType>
 735       <xs:sequence>
 736         <xs:element minOccurs="1" maxOccurs="unbounded" name="Entry">
 737           <xs:complexType>
 738             <xs:sequence>
 739               <xs:element minOccurs="1" maxOccurs="1" name="C_Name" type="C_NameType"/>
 740               <xs:element minOccurs="1" maxOccurs="1" name="GuidValue" type="GuidType"/>
 741               <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
 742             </xs:sequence>
 743             <xs:attributeGroup ref="PpiDeclarationAttributes"/>
 744           </xs:complexType>
 745         </xs:element>
 746       </xs:sequence>
 747     </xs:complexType>
 748   </xs:element>
 749   <xs:element name="PPIs">
 750     <xs:annotation>
 751       <xs:documentation xml:lang="en">Provide for one or more Ppi or PpiNotify sections. </xs:documentation>
 752     </xs:annotation>
 753     <xs:complexType>
 754       <xs:sequence minOccurs="1">
 755         <xs:element minOccurs="0" maxOccurs="unbounded" name="Ppi">
 756           <xs:complexType>
 757             <xs:sequence>
 758               <xs:element minOccurs="1" maxOccurs="1" name="PpiCName" type="C_NameType"/>
 759               <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
 760             </xs:sequence>
 761             <xs:attributeGroup ref="PpiAttributes"/>
 762           </xs:complexType>
 763         </xs:element>
 764         <xs:element minOccurs="0" maxOccurs="unbounded" name="PpiNotify">
 765           <xs:complexType>
 766             <xs:sequence>
 767               <xs:element minOccurs="1" maxOccurs="1" name="PpiNotifyCName" type="C_NameType"/>
 768               <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
 769             </xs:sequence>
 770             <xs:attributeGroup ref="PpiNotifyAttributes"/>
 771           </xs:complexType>
 772         </xs:element>
 773       </xs:sequence>
 774     </xs:complexType>
 775   </xs:element>
 776   <xs:element name="ProtocolDeclarations">
 777     <xs:annotation>
 778       <xs:documentation xml:lang="en">ProtocolDeclarations is a child of PackageSurfaceArea (SPD) </xs:documentation>
 779     </xs:annotation>
 780     <xs:complexType>
 781       <xs:sequence>
 782         <xs:element minOccurs="1" maxOccurs="unbounded" name="Entry">
 783           <xs:complexType>
 784             <xs:sequence>
 785               <xs:element minOccurs="1" maxOccurs="1" name="C_Name" type="C_NameType"/>
 786               <xs:element minOccurs="1" maxOccurs="1" name="GuidValue" type="GuidType"/>
 787               <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
 788             </xs:sequence>
 789             <xs:attributeGroup ref="ProtocolDeclarationAttributes"/>
 790           </xs:complexType>
 791         </xs:element>
 792       </xs:sequence>
 793     </xs:complexType>
 794   </xs:element>
 795   <xs:element name="Protocols">
 796     <xs:annotation>
 797       <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>
 798     </xs:annotation>
 799     <xs:complexType>
 800       <xs:sequence>
 801         <xs:element minOccurs="0" maxOccurs="unbounded" name="Protocol">
 802           <xs:complexType>
 803             <xs:sequence>
 804               <xs:element minOccurs="1" maxOccurs="1" name="ProtocolCName" type="C_NameType"/>
 805               <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
 806             </xs:sequence>
 807             <xs:attributeGroup ref="ProtocolAttributes"/>
 808           </xs:complexType>
 809         </xs:element>
 810         <xs:element minOccurs="0" maxOccurs="unbounded" name="ProtocolNotify">
 811           <xs:complexType>
 812             <xs:sequence>
 813               <xs:element minOccurs="1" maxOccurs="1" name="ProtocolNotifyCName" type="C_NameType"/>
 814               <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
 815             </xs:sequence>
 816             <xs:attributeGroup ref="ProtocolNotifyAttributes"/>
 817           </xs:complexType>
 818         </xs:element>
 819       </xs:sequence>
 820     </xs:complexType>
 821   </xs:element>
 822   <xs:element name="ProcessStep">
 823     <xs:complexType>
 824       <xs:sequence>
 825         <!-- The following is a macro for Apache ANT -->
 826         <xs:element minOccurs="0" maxOccurs="1" name="MacroDefFile">
 827           <xs:complexType>
 828             <xs:simpleContent>
 829               <xs:extension base="PathAndFilename">
 830                 <xs:attribute name="MacroName" type="KeywordType" use="required"/>
 831               </xs:extension>
 832             </xs:simpleContent>
 833           </xs:complexType>
 834         </xs:element>
 835         <!-- The following is for System Executables -->
 836         <xs:element minOccurs="0" maxOccurs="1" name="ToolName" type="xs:NCName"/>
 837         <xs:element minOccurs="0" maxOccurs="unbounded" name="ToolArgs" type="xs:normalizedString"/>
 838         <xs:element minOccurs="0" maxOccurs="unbounded" name="InputPattern" type="xs:normalizedString"/>
 839         <xs:element minOccurs="0" maxOccurs="1" name="OutputPattern" type="xs:normalizedString"/>
 840       </xs:sequence>
 841       <xs:attributeGroup ref="ProcessStepAttributes"/>
 842     </xs:complexType>
 843   </xs:element>
 844   <xs:element name="SourceFiles">
 845     <xs:annotation>
 846       <xs:documentation xml:lang="en">Multiple Filenames may be specified, and they may also be scoped to a specific Architecture.</xs:documentation>
 847     </xs:annotation>
 848     <xs:complexType>
 849       <xs:sequence>
 850         <xs:element minOccurs="1" maxOccurs="unbounded" ref="Filename"/>
 851       </xs:sequence>
 852     </xs:complexType>
 853   </xs:element>
 854   <xs:element name="SkuInfo">
 855     <xs:complexType>
 856       <xs:sequence>
 857         <xs:element minOccurs="1" maxOccurs="unbounded" name="UiSkuName">
 858           <xs:complexType>
 859             <xs:simpleContent>
 860               <xs:extension base="UiNameType">
 861                 <xs:attribute name="SkuID" type="xs:nonNegativeInteger" use="required"/>
 862               </xs:extension>
 863             </xs:simpleContent>
 864           </xs:complexType>
 865         </xs:element>
 866       </xs:sequence>
 867     </xs:complexType>
 868   </xs:element>
 869   <xs:element name="SystemTables">
 870     <xs:annotation>
 871       <xs:documentation xml:lang="en">This is list of System Table elements.</xs:documentation>
 872     </xs:annotation>
 873     <xs:complexType>
 874       <xs:sequence>
 875         <xs:element minOccurs="1" maxOccurs="unbounded" name="SystemTableCNames">
 876           <xs:complexType>
 877             <xs:sequence>
 878               <xs:element minOccurs="1" maxOccurs="1" name="SystemTableCName" type="C_NameType"/>
 879               <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
 880             </xs:sequence>
 881             <xs:attributeGroup ref="SystemTableAttributes"/>
 882           </xs:complexType>
 883         </xs:element>
 884       </xs:sequence>
 885     </xs:complexType>
 886   </xs:element>
 887   <xs:element name="UserDefinedAntTasks">
 888     <xs:annotation>
 889       <xs:documentation xml:lang="en">This is a sub-element of BuildOptions</xs:documentation>
 890       <xs:documentation xml:lang="en">Permit Users to define their own custom ANT tasks.</xs:documentation>
 891     </xs:annotation>
 892     <xs:complexType>
 893       <xs:sequence>
 894         <xs:element minOccurs="1" maxOccurs="unbounded" ref="AntTask"/>
 895       </xs:sequence>
 896     </xs:complexType>
 897   </xs:element>
 898   <xs:element name="UserExtensions">
 899     <xs:complexType>
 900       <xs:sequence>
 901         <xs:any minOccurs="0" maxOccurs="unbounded" processContents="lax"/>
 902       </xs:sequence>
 903       <xs:attribute name="UserID" type="xs:NCName" use="required"/>
 904       <xs:attribute name="Identifier" type="xs:nonNegativeInteger" use="required"/>
 905     </xs:complexType>
 906   </xs:element>
 907   <xs:element name="Variables">
 908     <xs:annotation>
 909       <xs:documentation xml:lang="en">An MSA FILE list of EFI Variables described by string pair.</xs:documentation>
 910     </xs:annotation>
 911     <xs:complexType>
 912       <xs:sequence>
 913         <xs:element minOccurs="1" maxOccurs="unbounded" name="Variable">
 914           <xs:annotation>
 915             <xs:documentation xml:lang="en">This is an EFI Variable Entry</xs:documentation>
 916           </xs:annotation>
 917           <xs:complexType>
 918             <xs:sequence>
 919               <xs:element minOccurs="1" maxOccurs="1" name="VariableName" type="HexWordArrayType"/>
 920               <xs:element minOccurs="1" maxOccurs="1" name="GuidC_Name" type="C_NameType"/>
 921               <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
 922             </xs:sequence>
 923             <xs:attributeGroup ref="VariableAttributes"/>
 924           </xs:complexType>
 925         </xs:element>
 926       </xs:sequence>
 927     </xs:complexType>
 928   </xs:element>
 929   <xs:element name="Version" type="VersionDataType"/>
 930 </xs:schema>