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="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">
 243           <xs:complexType>
 244             <xs:choice minOccurs="1">
 245               <xs:sequence>
 246                 <xs:annotation>
 247                   <xs:documentation xml:lang="en">Driver Module</xs:documentation>
 248                 </xs:annotation>
 249                 <xs:element minOccurs="0" maxOccurs="1" name="ModuleEntryPoint" type="C_NameType"/>
 250                 <xs:element minOccurs="0" maxOccurs="1" name="ModuleUnloadImage" type="C_NameType"/>
 251               </xs:sequence>
 252               <xs:sequence>
 253                 <xs:annotation>
 254                   <xs:documentation xml:lang="en">Library Module</xs:documentation>
 255                 </xs:annotation>
 256                 <xs:element minOccurs="0" maxOccurs="1" name="Constructor" type="C_NameType"/>
 257                 <xs:element minOccurs="0" maxOccurs="1" name="Destructor" type="C_NameType"/>
 258               </xs:sequence>
 259               <xs:sequence>
 260                 <xs:annotation>
 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>
 263                 </xs:annotation>
 264                 <xs:element minOccurs="0" 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"/>
 268               </xs:sequence>
 269               <xs:sequence>
 270                 <xs:annotation>
 271                   <xs:documentation xml:lang="en"> Module Call Backs</xs:documentation>
 272                 </xs:annotation>
 273                 <xs:element minOccurs="0" maxOccurs="1" name="SetVirtualAddressMapCallBack" type="C_NameType"/>
 274                 <xs:element minOccurs="0" maxOccurs="1" name="ExitBootServicesCallBack" type="C_NameType"/>
 275               </xs:sequence>
 276             </xs:choice>
 277             <xs:attributeGroup ref="ExternAttributes"/>
 278           </xs:complexType>
 279         </xs:element>
 280       </xs:sequence>
 281     </xs:complexType>
 282   </xs:element>
 283   <xs:element name="Filename">
 284     <xs:annotation>
 285       <xs:documentation xml:lang="en">Describe the valid content of a filename This should extend PathAndFilename - Variable names not allowed here!</xs:documentation>
 286     </xs:annotation>
 287     <xs:complexType>
 288       <xs:simpleContent>
 289         <xs:extension base="PathAndFilename">
 290           <xs:attributeGroup ref="FilenameAttributes"/>
 291         </xs:extension>
 292       </xs:simpleContent>
 293     </xs:complexType>
 294   </xs:element>
 295   <xs:element name="Filenames">
 296     <xs:annotation>
 297       <xs:documentation xml:lang="en">This is a list of Filenames</xs:documentation>
 298     </xs:annotation>
 299     <xs:complexType>
 300       <xs:sequence minOccurs="1">
 301         <xs:element minOccurs="0" maxOccurs="unbounded" ref="Filename"/>
 302       </xs:sequence>
 303     </xs:complexType>
 304   </xs:element>
 305   <xs:element name="GuidDeclarations">
 306     <xs:annotation>
 307       <xs:documentation xml:lang="en">This is a child of PackageSurfaceArea (SPD) </xs:documentation>
 308     </xs:annotation>
 309     <xs:complexType>
 310       <xs:sequence>
 311         <xs:element minOccurs="1" maxOccurs="unbounded" name="Entry">
 312           <xs:complexType>
 313             <xs:sequence>
 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"/>
 317             </xs:sequence>
 318             <xs:attributeGroup ref="GuidDeclarationAttributes"/>
 319           </xs:complexType>
 320         </xs:element>
 321       </xs:sequence>
 322     </xs:complexType>
 323   </xs:element>
 324   <xs:element name="Guids">
 325     <xs:complexType>
 326       <xs:sequence>
 327         <xs:element minOccurs="1" maxOccurs="unbounded" name="GuidCNames">
 328           <xs:annotation>
 329             <xs:documentation xml:lang="en">Describe the valid content of a GUID element in and MSA file.</xs:documentation>
 330           </xs:annotation>
 331           <xs:complexType>
 332             <xs:sequence>
 333               <xs:element minOccurs="1" maxOccurs="1" name="GuidCName" type="C_NameType"/>
 334               <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
 335             </xs:sequence>
 336             <xs:attributeGroup ref="GuidAttributes"/>
 337           </xs:complexType>
 338         </xs:element>
 339       </xs:sequence>
 340     </xs:complexType>
 341   </xs:element>
 342   <xs:element name="HiiPackages">
 343     <xs:annotation>
 344       <xs:documentation xml:lang="en">Describe the list of a HiiPackage elements</xs:documentation>
 345     </xs:annotation>
 346     <xs:complexType>
 347       <xs:sequence>
 348         <xs:element minOccurs="1" maxOccurs="unbounded" name="HiiPackage">
 349           <xs:complexType>
 350             <xs:sequence>
 351               <xs:element minOccurs="1" maxOccurs="1" name="HiiCName" type="C_NameType"/>
 352               <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
 353             </xs:sequence>
 354             <xs:attributeGroup ref="HiiPackageAttributes"/>
 355           </xs:complexType>
 356         </xs:element>
 357       </xs:sequence>
 358     </xs:complexType>
 359   </xs:element>
 360   <xs:element name="Hobs">
 361     <xs:complexType>
 362       <xs:sequence>
 363         <xs:element minOccurs="1" maxOccurs="unbounded" name="HobTypes">
 364           <xs:complexType>
 365             <xs:sequence>
 366               <xs:element minOccurs="1" maxOccurs="1" name="HobType" type="HobTypes"/>
 367               <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
 368             </xs:sequence>
 369             <xs:attributeGroup ref="HobAttributes"/>
 370           </xs:complexType>
 371         </xs:element>
 372       </xs:sequence>
 373     </xs:complexType>
 374   </xs:element>
 375   <xs:element name="IncludeHeader">
 376     <xs:complexType>
 377       <xs:simpleContent>
 378         <xs:extension base="PathAndFilename">
 379           <xs:attributeGroup ref="IncludeHeaderAttributes"/>
 380         </xs:extension>
 381       </xs:simpleContent>
 382     </xs:complexType>
 383   </xs:element>
 384   <xs:element name="IndustryStdIncludes">
 385     <xs:complexType>
 386       <xs:sequence>
 387         <xs:element minOccurs="1" maxOccurs="unbounded" ref="IndustryStdHeader"/>
 388       </xs:sequence>
 389     </xs:complexType>
 390   </xs:element>
 391   <xs:element name="IndustryStdHeader">
 392     <xs:complexType>
 393       <xs:sequence>
 394         <xs:element minOccurs="1" maxOccurs="1" name="IncludeHeader" type="PathAndFilename"/>
 395         <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
 396       </xs:sequence>
 397       <xs:attributeGroup ref="IndustryStdHeaderAttributes"/>
 398     </xs:complexType>
 399   </xs:element>
 400   <xs:element name="Libraries">
 401     <xs:annotation>
 402       <xs:documentation xml:lang="en">Different (Module) Instances of Libraries used ONLY in FPD Files.</xs:documentation>
 403     </xs:annotation>
 404     <xs:complexType>
 405       <xs:sequence>
 406         <xs:element minOccurs="1" maxOccurs="unbounded" name="Instance">
 407           <xs:complexType>
 408             <xs:attributeGroup ref="LibraryAttributes"/>
 409           </xs:complexType>
 410         </xs:element>
 411       </xs:sequence>
 412     </xs:complexType>
 413   </xs:element>
 414   <xs:element name="LibraryClass">
 415     <xs:annotation>
 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>
 417     </xs:annotation>
 418     <xs:complexType>
 419       <xs:sequence>
 420         <xs:element minOccurs="1" maxOccurs="1" name="Keyword" type="KeywordType"/>
 421         <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
 422       </xs:sequence>
 423       <xs:attributeGroup ref="LibraryClassAttributes"/>
 424     </xs:complexType>
 425   </xs:element>
 426   <!-- LAH This is SPD LibraryClassDeclarations FINAL version -->
 427   <xs:element name="LibraryClassDeclarations">
 428     <xs:complexType>
 429       <xs:sequence>
 430         <xs:element minOccurs="1" maxOccurs="unbounded" name="LibraryClass">
 431           <xs:complexType>
 432             <xs:sequence>
 433               <xs:element minOccurs="1" maxOccurs="1" name="IncludeHeader" type="PathAndFilename"/>
 434               <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
 435             </xs:sequence>
 436             <xs:attributeGroup ref="LibraryClassDeclarationAttributes"/>
 437           </xs:complexType>
 438         </xs:element>
 439       </xs:sequence>
 440     </xs:complexType>
 441   </xs:element>
 442   <xs:element name="LibraryClassDefinitions">
 443     <xs:annotation>
 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>
 445     </xs:annotation>
 446     <xs:complexType>
 447       <xs:sequence>
 448         <xs:element minOccurs="1" maxOccurs="unbounded" ref="LibraryClass"/>
 449       </xs:sequence>
 450     </xs:complexType>
 451   </xs:element>
 452   <xs:element name="License">
 453     <xs:complexType>
 454       <xs:simpleContent>
 455         <xs:extension base="Paragraph">
 456           <xs:attribute name="URL" type="xs:anyURI" use="optional"/>
 457         </xs:extension>
 458       </xs:simpleContent>
 459     </xs:complexType>
 460   </xs:element>
 461   <xs:element name="ModuleBuildOptions">
 462     <xs:complexType>
 463       <xs:sequence>
 464         <xs:any minOccurs="0" maxOccurs="unbounded" processContents="lax"/>
 465       </xs:sequence>
 466     </xs:complexType>
 467   </xs:element>
 468   <xs:element name="ModuleSaBuildOptions">
 469     <xs:complexType>
 470       <xs:sequence>
 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"/>
 477       </xs:sequence>
 478     </xs:complexType>
 479   </xs:element>
 480   <xs:element name="ModuleDefinitions">
 481     <xs:complexType>
 482       <xs:sequence>
 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">
 487           <xs:complexType>
 488             <xs:sequence>
 489               <xs:element minOccurs="1" maxOccurs="unbounded" name="Cloned">
 490                 <xs:complexType>
 491                   <xs:sequence>
 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"/>
 496                   </xs:sequence>
 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"/>
 501                 </xs:complexType>
 502               </xs:element>
 503             </xs:sequence>
 504           </xs:complexType>
 505         </xs:element>
 506       </xs:sequence>
 507     </xs:complexType>
 508   </xs:element>
 509   <xs:element name="ModuleType" type="ModuleTypeDef">
 510     <xs:annotation>
 511       <xs:documentation xml:lang="en">Describe the valid EFI Phase that the Module is designed to execute under.</xs:documentation>
 512     </xs:annotation>
 513   </xs:element>
 514   <!-- Use in Final -->
 515   <xs:element name="MsaFiles">
 516     <xs:annotation>
 517       <xs:documentation xml:lang="en">MsaFiles is a child of Surface Area Package Description (SPD) files</xs:documentation>
 518     </xs:annotation>
 519     <xs:complexType>
 520       <xs:sequence>
 521         <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename" type="PathAndFilename"/>
 522       </xs:sequence>
 523     </xs:complexType>
 524   </xs:element>
 525   <xs:element name="Options">
 526     <xs:complexType>
 527       <xs:sequence>
 528         <xs:element minOccurs="1" maxOccurs="unbounded" ref="Option"/>
 529       </xs:sequence>
 530     </xs:complexType>
 531   </xs:element>
 532   <xs:element name="Option">
 533     <!-- This element is used to store flags from the Tools -->
 534     <xs:complexType>
 535       <xs:simpleContent>
 536         <xs:extension base="xs:normalizedString">
 537           <xs:attributeGroup ref="OptionAttributes"/>
 538         </xs:extension>
 539       </xs:simpleContent>
 540     </xs:complexType>
 541   </xs:element>
 542   <xs:element name="PackageDefinitions">
 543     <xs:complexType>
 544       <xs:sequence>
 545         <xs:element minOccurs="1" maxOccurs="1" name="ReadOnly" type="xs:boolean" default="false"/>
 546         <xs:element minOccurs="1" maxOccurs="1" name="RePackage" type="xs:boolean" default="false"/>
 547         <xs:element minOccurs="0" maxOccurs="1" name="ClonedFrom">
 548           <xs:complexType>
 549             <xs:sequence>
 550               <xs:element minOccurs="1" maxOccurs="unbounded" name="Cloned">
 551                 <xs:complexType>
 552                   <xs:sequence>
 553                     <xs:element minOccurs="1" maxOccurs="1" name="PackageGuid" type="GuidType"/>
 554                     <xs:element minOccurs="1" maxOccurs="1" name="PackageVersion" type="VersionDataType"/>
 555                   </xs:sequence>
 556                   <!-- The Id is a number used to track heritage  the first entry will be 0 and increment from then on. -->
 557                   <xs:attribute name="Id" type="xs:nonNegativeInteger" use="required"/>
 558                   <!-- If the original Package was installed from a FAR, track the FAR it came from. -->
 559                   <xs:attribute name="FarGuid" type="GuidType" use="optional"/>
 560                 </xs:complexType>
 561               </xs:element>
 562             </xs:sequence>
 563           </xs:complexType>
 564         </xs:element>
 565       </xs:sequence>
 566     </xs:complexType>
 567   </xs:element>
 568   <xs:element name="PackageDependencies">
 569     <xs:annotation>
 570       <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>
 571       <xs:documentation xml:lang="en">Attributes to PackageName include Required: Usage PackageGuid PackageVesion, Optional: FeatureFlag</xs:documentation>
 572     </xs:annotation>
 573     <xs:complexType>
 574       <xs:sequence>
 575         <xs:element minOccurs="1" maxOccurs="unbounded" name="Package">
 576           <xs:complexType>
 577             <xs:attributeGroup ref="PackageAttributes"/>
 578           </xs:complexType>
 579         </xs:element>
 580       </xs:sequence>
 581     </xs:complexType>
 582   </xs:element>
 583   <xs:element name="PackageHeaders">
 584     <xs:annotation>
 585       <xs:documentation xml:lang="en">PackageHeaders is a child of PackageSurfaceArea (SPD) </xs:documentation>
 586     </xs:annotation>
 587     <xs:complexType>
 588       <xs:sequence>
 589         <xs:element minOccurs="1" maxOccurs="unbounded" name="IncludePkgHeader">
 590           <xs:complexType>
 591             <xs:simpleContent>
 592               <xs:extension base="PathAndFilename">
 593                 <xs:attributeGroup ref="PackageHeaderAttributes"/>
 594               </xs:extension>
 595             </xs:simpleContent>
 596           </xs:complexType>
 597         </xs:element>
 598       </xs:sequence>
 599     </xs:complexType>
 600   </xs:element>
 601   <xs:element name="PackageList">
 602     <!-- Valid for DB usage only! -->
 603     <xs:annotation>
 604       <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>
 605     </xs:annotation>
 606     <xs:complexType>
 607       <xs:sequence>
 608         <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename" type="DbPathAndFilename"/>
 609       </xs:sequence>
 610     </xs:complexType>
 611   </xs:element>
 612   <!-- PcdBuildDefinition is a child of FPD ModuleSA element for FIXED_AT_BUILD, PATCHABLE_IN_MODULE, and FEATURE_FLAG PCDS Only! -->
 613   <xs:element name="PcdBuildDefinition">
 614     <xs:annotation>
 615       <xs:documentation xml:lang="en">Child of FPD ModuleSA element for FIXED_AT_BUILD, PATCHABLE_IN_MODULE, and FEATURE_FLAG PCDS Only!</xs:documentation>
 616     </xs:annotation>
 617     <xs:complexType>
 618       <xs:sequence>
 619         <xs:element minOccurs="1" maxOccurs="unbounded" name="PcdData">
 620           <xs:complexType>
 621             <xs:sequence>
 622               <xs:element minOccurs="1" maxOccurs="1" name="C_Name" type="C_NameType"/>
 623               <xs:element minOccurs="1" maxOccurs="1" name="Token" type="TokenDataType"/>
 624               <xs:element minOccurs="1" maxOccurs="1" name="TokenSpaceGuidCName" type="C_NameType"/>
 625               <xs:element minOccurs="1" maxOccurs="1" name="DatumType" type="PcdDataTypes"/>
 626               <!-- MaxDatumSize is only required if the DatumType is VOID* -->
 627               <xs:element minOccurs="0" maxOccurs="1" name="MaxDatumSize" type="DatumSizeLimitation"/>
 628               <xs:element minOccurs="0" maxOccurs="1" name="Value" type="DefaultValueType"/>
 629             </xs:sequence>
 630             <xs:attributeGroup ref="PcdBuildDefinitionAttributes"/>
 631           </xs:complexType>
 632         </xs:element>
 633       </xs:sequence>
 634     </xs:complexType>
 635   </xs:element>
 636   <xs:group name="DefaultGroup">
 637     <xs:sequence>
 638       <xs:element minOccurs="1" maxOccurs="1" name="Value" type="DefaultValueType"/>
 639     </xs:sequence>
 640   </xs:group>
 641   <xs:group name="HiiEnable">
 642     <xs:annotation>
 643       <xs:documentation xml:lang="en">If HiiEnable group is specified, then HiiEnable is default true</xs:documentation>
 644     </xs:annotation>
 645     <xs:sequence>
 646       <xs:element minOccurs="1" maxOccurs="1" name="VariableName" type="HexWordArrayType"/>
 647       <xs:element minOccurs="1" maxOccurs="1" name="VariableGuid" type="C_NameType"/>
 648       <xs:element minOccurs="1" maxOccurs="1" name="VariableOffset" type="Hex64BitDataType"/>
 649       <xs:element minOccurs="1" maxOccurs="1" name="HiiDefaultValue" type="DefaultValueType"/>
 650     </xs:sequence>
 651   </xs:group>
 652   <xs:group name="VpdEnable">
 653     <xs:annotation>
 654       <xs:documentation xml:lang="en">If VpdEnable group is specified, then VpdEnable is default true</xs:documentation>
 655     </xs:annotation>
 656     <xs:sequence>
 657       <xs:element minOccurs="1" maxOccurs="1" name="VpdOffset" type="Hex64BitDataType"/>
 658     </xs:sequence>
 659   </xs:group>
 660   <xs:element name="PcdCoded">
 661     <xs:annotation>
 662       <xs:documentation xml:lang="en">Child of Module Surface Area Description (MSA)</xs:documentation>
 663     </xs:annotation>
 664     <xs:complexType>
 665       <xs:sequence>
 666         <xs:element minOccurs="1" maxOccurs="unbounded" name="PcdEntry">
 667           <xs:complexType>
 668             <xs:sequence>
 669               <xs:element minOccurs="1" maxOccurs="1" name="C_Name" type="C_NameType"/>
 670               <xs:element minOccurs="1" maxOccurs="1" name="TokenSpaceGuidCName" type="C_NameType"/>
 671               <xs:element minOccurs="0" maxOccurs="1" name="DefaultValue" type="DefaultValueType"/>
 672               <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
 673             </xs:sequence>
 674             <!-- 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. -->
 675             <xs:attributeGroup ref="PcdCodedAttributes"/>
 676           </xs:complexType>
 677         </xs:element>
 678       </xs:sequence>
 679     </xs:complexType>
 680   </xs:element>
 681   <!-- LAH This is PcdDeclarations FINAL version -->
 682   <xs:element name="PcdDeclarations">
 683     <xs:annotation>
 684       <xs:documentation xml:lang="en">PcdDeclaratins is a child of Package Surface Area Description (SPD)</xs:documentation>
 685     </xs:annotation>
 686     <xs:complexType>
 687       <xs:sequence minOccurs="1">
 688         <xs:element maxOccurs="unbounded" name="PcdEntry">
 689           <xs:complexType>
 690             <xs:sequence>
 691               <xs:element minOccurs="1" maxOccurs="1" name="C_Name" type="C_NameType"/>
 692               <xs:element minOccurs="1" maxOccurs="1" name="Token" type="TokenDataType"/>
 693               <xs:element minOccurs="1" maxOccurs="1" name="TokenSpaceGuidCName" type="C_NameType"/>
 694               <xs:element minOccurs="1" maxOccurs="1" name="DatumType" type="PcdDataTypes"/>
 695               <xs:element minOccurs="1" maxOccurs="1" name="ValidUsage" type="PcdListType"/>
 696               <xs:element minOccurs="0" maxOccurs="1" name="DefaultValue" type="DefaultValueType"/>
 697               <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
 698             </xs:sequence>
 699             <xs:attributeGroup ref="PcdDeclarationAttributes"/>
 700           </xs:complexType>
 701         </xs:element>
 702       </xs:sequence>
 703     </xs:complexType>
 704   </xs:element>
 705   <xs:element name="FarList">
 706     <!-- Valid for DB usage only! -->
 707     <xs:annotation>
 708       <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>
 709     </xs:annotation>
 710     <xs:complexType>
 711       <xs:sequence>
 712         <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename" type="DbPathAndFilename"/>
 713       </xs:sequence>
 714     </xs:complexType>
 715   </xs:element>
 716   <xs:element name="FfsFormatDeclarations">
 717     <xs:complexType>
 718       <xs:sequence>
 719         <xs:element minOccurs="1" maxOccurs="unbounded" name="FfsFormatDeclaration">
 720           <!-- Required Attributes are the FfsFormatKeyword and SupModuleList -->
 721           <xs:complexType>
 722             <xs:sequence>
 723               <xs:element minOccurs="1" maxOccurs="unbounded" ref="ProcessStep"/>
 724             </xs:sequence>
 725             <xs:attributeGroup ref="FfsAttributes"/>
 726           </xs:complexType>
 727         </xs:element>
 728       </xs:sequence>
 729     </xs:complexType>
 730   </xs:element>
 731   <xs:element name="PpiDeclarations">
 732     <xs:annotation>
 733       <xs:documentation xml:lang="en">PpiDeclarations is a child of PackageSurfaceArea (SPD) </xs:documentation>
 734     </xs:annotation>
 735     <xs:complexType>
 736       <xs:sequence>
 737         <xs:element minOccurs="1" maxOccurs="unbounded" name="Entry">
 738           <xs:complexType>
 739             <xs:sequence>
 740               <xs:element minOccurs="1" maxOccurs="1" name="C_Name" type="C_NameType"/>
 741               <xs:element minOccurs="1" maxOccurs="1" name="GuidValue" type="GuidType"/>
 742               <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
 743             </xs:sequence>
 744             <xs:attributeGroup ref="PpiDeclarationAttributes"/>
 745           </xs:complexType>
 746         </xs:element>
 747       </xs:sequence>
 748     </xs:complexType>
 749   </xs:element>
 750   <xs:element name="PPIs">
 751     <xs:annotation>
 752       <xs:documentation xml:lang="en">Provide for one or more Ppi or PpiNotify sections. </xs:documentation>
 753     </xs:annotation>
 754     <xs:complexType>
 755       <xs:sequence minOccurs="1">
 756         <xs:element minOccurs="0" maxOccurs="unbounded" name="Ppi">
 757           <xs:complexType>
 758             <xs:sequence>
 759               <xs:element minOccurs="1" maxOccurs="1" name="PpiCName" type="C_NameType"/>
 760               <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
 761             </xs:sequence>
 762             <xs:attributeGroup ref="PpiAttributes"/>
 763           </xs:complexType>
 764         </xs:element>
 765         <xs:element minOccurs="0" maxOccurs="unbounded" name="PpiNotify">
 766           <xs:complexType>
 767             <xs:sequence>
 768               <xs:element minOccurs="1" maxOccurs="1" name="PpiNotifyCName" type="C_NameType"/>
 769               <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
 770             </xs:sequence>
 771             <xs:attributeGroup ref="PpiNotifyAttributes"/>
 772           </xs:complexType>
 773         </xs:element>
 774       </xs:sequence>
 775     </xs:complexType>
 776   </xs:element>
 777   <xs:element name="ProtocolDeclarations">
 778     <xs:annotation>
 779       <xs:documentation xml:lang="en">ProtocolDeclarations is a child of PackageSurfaceArea (SPD) </xs:documentation>
 780     </xs:annotation>
 781     <xs:complexType>
 782       <xs:sequence>
 783         <xs:element minOccurs="1" maxOccurs="unbounded" name="Entry">
 784           <xs:complexType>
 785             <xs:sequence>
 786               <xs:element minOccurs="1" maxOccurs="1" name="C_Name" type="C_NameType"/>
 787               <xs:element minOccurs="1" maxOccurs="1" name="GuidValue" type="GuidType"/>
 788               <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
 789             </xs:sequence>
 790             <xs:attributeGroup ref="ProtocolDeclarationAttributes"/>
 791           </xs:complexType>
 792         </xs:element>
 793       </xs:sequence>
 794     </xs:complexType>
 795   </xs:element>
 796   <xs:element name="Protocols">
 797     <xs:annotation>
 798       <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>
 799     </xs:annotation>
 800     <xs:complexType>
 801       <xs:sequence>
 802         <xs:element minOccurs="0" maxOccurs="unbounded" name="Protocol">
 803           <xs:complexType>
 804             <xs:sequence>
 805               <xs:element minOccurs="1" maxOccurs="1" name="ProtocolCName" type="C_NameType"/>
 806               <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
 807             </xs:sequence>
 808             <xs:attributeGroup ref="ProtocolAttributes"/>
 809           </xs:complexType>
 810         </xs:element>
 811         <xs:element minOccurs="0" maxOccurs="unbounded" name="ProtocolNotify">
 812           <xs:complexType>
 813             <xs:sequence>
 814               <xs:element minOccurs="1" maxOccurs="1" name="ProtocolNotifyCName" type="C_NameType"/>
 815               <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
 816             </xs:sequence>
 817             <xs:attributeGroup ref="ProtocolNotifyAttributes"/>
 818           </xs:complexType>
 819         </xs:element>
 820       </xs:sequence>
 821     </xs:complexType>
 822   </xs:element>
 823   <xs:element name="ProcessStep">
 824     <xs:complexType>
 825       <xs:sequence>
 826         <!-- The following is a macro for Apache ANT -->
 827         <xs:element minOccurs="0" maxOccurs="1" name="MacroDefFile">
 828           <xs:complexType>
 829             <xs:simpleContent>
 830               <xs:extension base="PathAndFilename">
 831                 <xs:attribute name="MacroName" type="KeywordType" use="required"/>
 832               </xs:extension>
 833             </xs:simpleContent>
 834           </xs:complexType>
 835         </xs:element>
 836         <!-- The following is for System Executables -->
 837         <xs:element minOccurs="0" maxOccurs="1" name="ToolName" type="xs:NCName"/>
 838         <xs:element minOccurs="0" maxOccurs="unbounded" name="ToolArgs" type="xs:normalizedString"/>
 839         <xs:element minOccurs="0" maxOccurs="unbounded" name="InputPattern" type="xs:normalizedString"/>
 840         <xs:element minOccurs="0" maxOccurs="1" name="OutputPattern" type="xs:normalizedString"/>
 841       </xs:sequence>
 842       <xs:attributeGroup ref="ProcessStepAttributes"/>
 843     </xs:complexType>
 844   </xs:element>
 845   <xs:element name="SourceFiles">
 846     <xs:annotation>
 847       <xs:documentation xml:lang="en">Multiple Filenames may be specified, and they may also be scoped to a specific Architecture.</xs:documentation>
 848     </xs:annotation>
 849     <xs:complexType>
 850       <xs:sequence>
 851         <xs:element minOccurs="1" maxOccurs="unbounded" ref="Filename"/>
 852       </xs:sequence>
 853     </xs:complexType>
 854   </xs:element>
 855   <xs:element name="SkuInfo">
 856     <xs:complexType>
 857       <xs:sequence>
 858         <xs:element minOccurs="1" maxOccurs="unbounded" name="UiSkuName">
 859           <xs:complexType>
 860             <xs:simpleContent>
 861               <xs:extension base="UiNameType">
 862                 <xs:attribute name="SkuID" type="xs:nonNegativeInteger" use="required"/>
 863               </xs:extension>
 864             </xs:simpleContent>
 865           </xs:complexType>
 866         </xs:element>
 867       </xs:sequence>
 868     </xs:complexType>
 869   </xs:element>
 870   <xs:element name="SystemTables">
 871     <xs:annotation>
 872       <xs:documentation xml:lang="en">This is list of System Table elements.</xs:documentation>
 873     </xs:annotation>
 874     <xs:complexType>
 875       <xs:sequence>
 876         <xs:element minOccurs="1" maxOccurs="unbounded" name="SystemTableCNames">
 877           <xs:complexType>
 878             <xs:sequence>
 879               <xs:element minOccurs="1" maxOccurs="1" name="SystemTableCName" type="C_NameType"/>
 880               <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
 881             </xs:sequence>
 882             <xs:attributeGroup ref="SystemTableAttributes"/>
 883           </xs:complexType>
 884         </xs:element>
 885       </xs:sequence>
 886     </xs:complexType>
 887   </xs:element>
 888   <xs:element name="UserDefinedAntTasks">
 889     <xs:annotation>
 890       <xs:documentation xml:lang="en">This is a sub-element of BuildOptions</xs:documentation>
 891       <xs:documentation xml:lang="en">Permit Users to define their own custom ANT tasks.</xs:documentation>
 892     </xs:annotation>
 893     <xs:complexType>
 894       <xs:sequence>
 895         <xs:element minOccurs="1" maxOccurs="unbounded" ref="AntTask"/>
 896       </xs:sequence>
 897     </xs:complexType>
 898   </xs:element>
 899   <xs:element name="UserExtensions">
 900     <xs:complexType>
 901       <xs:sequence>
 902         <xs:any minOccurs="0" maxOccurs="unbounded" processContents="lax"/>
 903       </xs:sequence>
 904       <xs:attribute name="UserID" type="xs:NCName" use="required"/>
 905       <xs:attribute name="Identifier" type="xs:nonNegativeInteger" use="required"/>
 906     </xs:complexType>
 907   </xs:element>
 908   <xs:element name="Variables">
 909     <xs:annotation>
 910       <xs:documentation xml:lang="en">An MSA FILE list of EFI Variables described by string pair.</xs:documentation>
 911     </xs:annotation>
 912     <xs:complexType>
 913       <xs:sequence>
 914         <xs:element minOccurs="1" maxOccurs="unbounded" name="Variable">
 915           <xs:annotation>
 916             <xs:documentation xml:lang="en">This is an EFI Variable Entry</xs:documentation>
 917           </xs:annotation>
 918           <xs:complexType>
 919             <xs:sequence>
 920               <xs:element minOccurs="1" maxOccurs="1" name="VariableName" type="HexWordArrayType"/>
 921               <xs:element minOccurs="1" maxOccurs="1" name="GuidC_Name" type="C_NameType"/>
 922               <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
 923             </xs:sequence>
 924             <xs:attributeGroup ref="VariableAttributes"/>
 925           </xs:complexType>
 926         </xs:element>
 927       </xs:sequence>
 928     </xs:complexType>
 929   </xs:element>
 930   <xs:element name="Version" type="VersionDataType"/>
 931 </xs:schema>