Tools/XMLSchema/FrameworkDataAttributes.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: FrameworkDataAttributes.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 Attribute. Only attributeGroups are specified in this file. </xs:documentation>
  17     </xs:annotation>
  18     <xs:include schemaLocation="NamingConvention.xsd"/>
  19     <xs:include schemaLocation="FrameworkDataTypes.xsd"/>
  20     <xs:attributeGroup name="BaseNameAttributes">
  21         <xs:attribute name="Guid" type="GuidType" use="optional"/>
  22         <xs:attribute name="Version" type="VersionDataType" use="optional"/>
  23     </xs:attributeGroup>
  24     <xs:attributeGroup name="BootModeAttributes">
  25         <xs:attribute name="Guid" type="GuidType" use="optional"/>
  26         <xs:attribute name="BootModeName" type="BootModeNames" use="required"/>
  27         <xs:attribute name="Usage" type="BootModeUsage" use="required"/>
  28         <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>
  29         <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
  30         <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
  31         <!-- DO NOT USE remove OverrideID from use -->
  32     </xs:attributeGroup>
  33     <xs:attributeGroup name="ConvertAttributeString">
  34         <xs:attribute name="SourceString" type="xs:string" use="optional"/>
  35         <xs:attribute default="Unicode" name="OutputFiletype" type="xs:string" use="optional"/>
  36         <xs:attribute name="OutputFilename" type="FileNameConvention" use="optional"/>
  37     </xs:attributeGroup>
  38     <xs:attributeGroup name="DataHubAttributes">
  39         <xs:attribute name="Guid" type="GuidType" use="optional"/>
  40         <xs:attribute name="Usage" type="DataHubUsage" use="optional"/>
  41         <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>
  42         <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
  43         <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
  44         <!-- DO NOT USE remove OverrideID from use -->
  45     </xs:attributeGroup>
  46     <xs:attributeGroup name="DirectoryAttributes">
  47         <xs:attribute name="Separator" type="ToothPick"/>
  48     </xs:attributeGroup>
  49     <xs:attributeGroup name="EventAttributes">
  50         <xs:attribute name="Guid" type="GuidType" use="optional"/>
  51         <xs:attribute name="Usage" type="EventUsage" use="optional"/>
  52         <xs:attribute name="EventGroup" type="EventTypes" use="optional"/>
  53         <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>
  54         <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
  55         <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
  56         <!-- DO NOT USE remove OverrideID from use -->
  57     </xs:attributeGroup>
  58     <xs:attributeGroup name="ExternAttributes">
  59         <xs:attribute name="Guid" type="GuidType" use="optional"/>
  60         <xs:attribute name="Usage" type="ExternUsage" use="optional"/>
  61         <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>
  62         <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
  63         <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
  64         <!-- DO NOT USE remove OverrideID from use -->
  65     </xs:attributeGroup>
  66     <xs:attributeGroup name="FilenameAttributes">
  67         <xs:attribute name="Usage" type="FileNameUsage" use="optional"/>
  68         <xs:attribute name="Guid" type="GuidType" use="optional"/>
  69         <xs:attribute name="Path" type="DirectoryNamingConvention" use="optional"/>
  70         <xs:attribute name="FileType" type="xs:string" use="optional"/>
  71         <xs:attribute name="ToolChain" type="ToolChains" use="optional"/>
  72         <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>
  73         <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
  74         <xs:attribute name="ArchType" use="optional">
  75             <xs:simpleType>
  76                 <xs:list itemType="SupportedArchitectures"/>
  77             </xs:simpleType>
  78         </xs:attribute>
  79         <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
  80         <!-- DO NOT USE remove OverrideID from use -->
  81     </xs:attributeGroup>
  82     <xs:attributeGroup name="FormsetAttributes">
  83         <xs:attribute name="Guid" type="GuidType" use="optional"/>
  84         <xs:attribute name="Usage" type="FormSetUsage" use="optional"/>
  85         <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>
  86         <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
  87         <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
  88         <!-- DO NOT USE remove OverrideID from use -->
  89     </xs:attributeGroup>
  90     <xs:attributeGroup name="GuidAttributes">
  91         <xs:attribute name="Usage" type="GuidUsage" use="optional"/>
  92         <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>
  93         <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
  94         <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
  95         <!-- DO NOT USE remove OverrideID from use -->
  96     </xs:attributeGroup>
  97     <xs:attributeGroup name="HobAttributes">
  98         <xs:attribute name="Guid" type="GuidType" use="optional"/>
  99         <xs:attribute name="Usage" type="HobUsage" use="optional"/>
 100         <xs:attribute name="HobType" type="HobTypes" use="required"/>
 101         <xs:attribute default="true" name="HobEnabled" type="xs:boolean" use="optional"/>
 102         <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>
 103         <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
 104         <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
 105         <!-- DO NOT USE remove OverrideID from use -->
 106     </xs:attributeGroup>
 107     <xs:attributeGroup name="IncludeAttributes">
 108         <xs:attribute name="Guid" type="GuidType" use="optional"/>
 109         <xs:attribute name="Path" type="DirectoryNamingConvention" use="optional"/>
 110         <xs:attribute name="Class" type="BaseNameConvention" use="optional"/>
 111         <xs:attribute name="Version" type="VersionDataType" use="optional"/>
 112         <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>
 113         <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
 114         <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
 115         <!-- DO NOT USE remove OverrideID from use -->
 116         <xs:attribute name="ModuleType" type="ModuleTypeDef" use="optional"/>
 117     </xs:attributeGroup>
 118     <xs:attributeGroup name="LibraryAttributes">
 119         <!-- LibraryAttributes is used for Libraries -> Library elements in FPD files -->
 120         <xs:attribute name="Guid" type="GuidType" use="optional"/>
 121         <!-- DO NOT USE remove Guid from use, Start using LibraryGuid instead -->
 122         <xs:attribute name="LibraryGuid" type="GuidType" use="optional"/>
 123         <xs:attribute name="Version" type="VersionDataType" use="optional"/>
 124         <!-- DO NOT USE remove Version from use, Start using LibraryVersion instead -->
 125         <xs:attribute name="ModuleVersion" type="VersionDataType" use="optional"/>
 126         <xs:attribute name="LibraryClass" type="BaseNameConvention" use="optional"/>
 127         <xs:attribute name="ClassGuid" type="GuidType" use="optional"/>
 128         <xs:attribute name="Usage" type="LibraryUsage" use="optional"/>
 129         <xs:attribute name="Package" type="xs:string" use="optional"/>
 130         <!-- DO NOT USE remove Package from use, Start using PackageName instead -->
 131         <xs:attribute name="PackageName" type="BaseNameConvention" use="optional"/>
 132         <xs:attribute name="PackageVersion" type="VersionDataType" use="optional"/>
 133         <xs:attribute name="PackageGuid" type="GuidType" use="optional"/>
 134         <xs:attribute name="ArchType" use="optional">
 135             <xs:simpleType>
 136                 <xs:list itemType="SupportedArchitectures"/>
 137             </xs:simpleType>
 138         </xs:attribute>
 139         <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>
 140         <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
 141         <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
 142         <!-- DO NOT USE remove OverrideID from use -->
 143     </xs:attributeGroup>
 144     <xs:attributeGroup name="ModuleNameAttributes">
 145         <xs:attribute name="Guid" type="GuidType" use="required"/>
 146         <xs:attribute name="Version" type="VersionDataType" use="optional"/>
 147     </xs:attributeGroup>
 148     <xs:attributeGroup name="ModuleNameSaAttributes">
 149         <xs:attribute name="Guid" type="GuidType" use="optional"/>
 150         <xs:attribute name="ModuleName" type="xs:NCName" use="required"/>
 151         <xs:attribute name="Version" type="VersionDataType" use="optional"/>
 152     </xs:attributeGroup>
 153     <xs:attributeGroup name="MsaAttributes">
 154         <xs:attribute name="Arch" type="SupportedArchitectures" use="optional"/>
 155         <xs:attribute name="FvBinding" type="xs:string" use="optional"/>
 156         <xs:attribute name="ModuleName" type="xs:NCName" use="optional"/>
 157         <xs:attribute name="ModuleGuid" type="GuidType" use="optional"/>
 158         <xs:attribute name="PackageName" type="BaseNameConvention" use="optional"/>
 159         <xs:attribute name="PackageGuid" type="GuidType" use="optional"/>
 160         <xs:attribute name="BuildSequence" type="xs:int" use="optional"/>
 161         <xs:attribute name="ArchType" use="optional">
 162             <xs:simpleType>
 163                 <xs:list itemType="SupportedArchitectures"/>
 164             </xs:simpleType>
 165         </xs:attribute>
 166     </xs:attributeGroup>
 167     <xs:attributeGroup name="OptionAttributes">
 168         <xs:attribute name="Platform" type="PlatformNamingConvention" use="optional"/>
 169         <xs:attribute name="ToolChain" type="ToolChains" use="optional"/>
 170         <xs:attribute name="BuildTarget" type="BuildTargets" use="optional"/>
 171         <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>
 172         <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
 173         <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
 174         <!-- DO NOT USE remove OverrideID from use -->
 175     </xs:attributeGroup>
 176     <xs:attributeGroup name="PackageAttributes">
 177         <xs:attribute name="PackageGuid" type="GuidType" use="optional"/>
 178         <xs:attribute name="PackageVersion" type="xs:string" use="optional"/>
 179         <xs:attribute name="Usage" type="PackageUsage" use="optional"/>
 180         <xs:attribute name="PackageType" type="PackageType" use="optional"/>
 181         <xs:attribute name="UpdatedDate" type="DateType" use="optional"/>
 182         <xs:attribute name="Arch" type="SupportedArchitectures" use="optional"/>
 183     </xs:attributeGroup>
 184     <!-- PackageNameAttributres are only used in the Package Dependencies section of an SPD file. -->
 185     <xs:attributeGroup name="PackageNameAttributes">
 186         <xs:attribute name="Guid" type="GuidType" use="optional"/>
 187         <!-- DO NOT USE remove Guid and start using PackageGuid instead -->
 188         <xs:attribute name="PackageGuid" type="GuidType" use="optional"/>
 189         <xs:attribute name="Version" type="VersionDataType" use="optional"/>
 190         <!-- DO NOT USE remove Version and start using PackageVersion instead -->
 191         <xs:attribute name="PackageVersion" type="xs:string" use="optional"/>
 192         <!-- PackageTypeDepencency is used to identify if a SOURCE or BINARY PackageType is required, in case PackageGuid and/or PackageVersion are not tracked. -->
 193         <xs:attribute name="PackageTypeDependency" type="PackageType" use="optional"/>
 194         <xs:attribute name="Arch" type="SupportedArchitectures" use="optional"/>
 195     </xs:attributeGroup>
 196     <xs:attributeGroup name="PcdAttributes">
 197         <xs:annotation>
 198             <xs:documentation xml:lang="en">These attributes are for the Pcds listed in PcdData, PcdEntry and/or PcdBuildData entries.</xs:documentation>
 199             <xs:documentation xml:lang="en">PcdUsage is only valid for PcdItemTypes = FEATURE_FLAG</xs:documentation>
 200         </xs:annotation>
 201         <xs:attribute name="ItemType" type="PcdItemTypes" use="required"/>
 202         <xs:attribute name="PcdUsage" type="PcdUsage" use="optional"/>
 203         <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>
 204         <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
 205         <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
 206         <!-- DO NOT USE remove OverrideID from use -->
 207     </xs:attributeGroup>
 208     <xs:attributeGroup name="PlatformAttributes">
 209         <xs:attribute name="Guid" type="GuidType" use="optional"/>
 210         <!-- DO NOT USE remove Guid from use -->
 211         <xs:attribute name="Version" type="VersionDataType" use="optional"/>
 212         <xs:attribute name="AlternateName" type="FileNameConvention" use="optional"/>
 213         <!-- DO NOT USE remove AlternateName from use -->
 214         <xs:attribute name="PlatformName" type="PlatformNamingConvention" use="optional"/>
 215         <xs:attribute name="PlatformGuid" type="GuidType" use="optional"/>
 216         <xs:attribute name="PlatformVersion" type="xs:string" use="optional"/>
 217     </xs:attributeGroup>
 218     <xs:attributeGroup name="PpiAttributes">
 219         <xs:attribute name="Guid" type="GuidType" use="optional"/>
 220         <xs:attribute name="Usage" type="PpiUsage" use="optional"/>
 221         <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>
 222         <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
 223         <xs:attribute name="ArchType" use="optional">
 224             <xs:simpleType>
 225                 <xs:list itemType="SupportedArchitectures"/>
 226             </xs:simpleType>
 227         </xs:attribute>
 228         <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
 229         <!-- DO NOT USE remove OverrideID from use -->
 230     </xs:attributeGroup>
 231     <xs:attributeGroup name="PpiNotifyAttributes">
 232         <xs:attribute name="Guid" type="GuidType" use="optional"/>
 233         <xs:attribute name="Usage" type="PpiNotifyUsage" use="optional"/>
 234         <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>
 235         <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
 236         <xs:attribute name="ArchType" use="optional">
 237             <xs:simpleType>
 238                 <xs:list itemType="SupportedArchitectures"/>
 239             </xs:simpleType>
 240         </xs:attribute>
 241         <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
 242         <!-- DO NOT USE remove OverrideID from use -->
 243     </xs:attributeGroup>
 244     <xs:attributeGroup name="ProtocolAttributes">
 245         <xs:attribute name="Guid" type="GuidType" use="optional"/>
 246         <xs:attribute name="Usage" type="ProtocolUsage" use="optional"/>
 247         <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>
 248         <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
 249         <xs:attribute name="ArchType" use="optional">
 250             <xs:simpleType>
 251                 <xs:list itemType="SupportedArchitectures"/>
 252             </xs:simpleType>
 253         </xs:attribute>
 254         <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
 255         <!-- DO NOT USE remove OverrideID from use -->
 256     </xs:attributeGroup>
 257     <xs:attributeGroup name="ProtocolNotifyAttributes">
 258         <xs:attribute name="Guid" type="GuidType" use="optional"/>
 259         <xs:attribute name="Usage" type="ProtocolNotifyUsage" use="optional"/>
 260         <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
 261         <xs:attribute name="ArchType" use="optional">
 262             <xs:simpleType>
 263                 <xs:list itemType="SupportedArchitectures"/>
 264             </xs:simpleType>
 265         </xs:attribute>
 266         <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
 267         <!-- DO NOT USE remove OverrideID from use -->
 268     </xs:attributeGroup>
 269     <xs:attributeGroup name="SectionAttributes">
 270         <xs:annotation>
 271             <xs:documentation xml:lang="en">Attributes are either compressable and/or sequence order binding</xs:documentation>
 272         </xs:annotation>
 273         <xs:attribute name="SectionType" type="EfiSectionType" use="optional"/>
 274         <xs:attribute default="true" name="Compressible" type="xs:boolean" use="optional"/>
 275         <xs:attribute name="BindingOrder" type="xs:int" use="optional"/>
 276         <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>
 277         <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
 278         <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
 279         <!-- DO NOT USE remove OverrideID from use -->
 280     </xs:attributeGroup>
 281     <xs:attributeGroup name="SectionsAttributes">
 282         <xs:annotation>
 283             <xs:documentation xml:lang="en">Attributes for Sections, EncapsulationTag, EncapsulationType and FeatureFlag</xs:documentation>
 284         </xs:annotation>
 285         <xs:attribute name="EncapsulationType" type="xs:normalizedString" use="optional"/>
 286         <xs:attribute name="EncapsulationTag" type="xs:string" use="optional"/>
 287         <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>
 288         <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
 289         <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
 290         <!-- DO NOT USE remove OverrideID from use -->
 291     </xs:attributeGroup>
 292     <xs:attributeGroup name="SystemTableAttributes">
 293         <xs:attribute name="Guid" type="GuidType" use="optional"/>
 294         <xs:attribute name="Usage" type="SystemTableUsage" use="optional"/>
 295         <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>
 296         <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
 297         <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
 298         <!-- DO NOT USE remove OverrideID from use -->
 299     </xs:attributeGroup>
 300     <xs:attributeGroup name="UrlAttribute">
 301         <xs:attribute name="Url" type="xs:anyURI"/>
 302     </xs:attributeGroup>
 303     <xs:attributeGroup name="VariableAttributes">
 304         <xs:attribute name="Guid" type="GuidType" use="optional"/>
 305         <xs:attribute name="Usage" type="VariableUsage" use="optional"/>
 306         <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>
 307         <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
 308         <xs:attribute name="ArchType" use="optional">
 309             <xs:simpleType>
 310                 <xs:list itemType="SupportedArchitectures"/>
 311             </xs:simpleType>
 312         </xs:attribute>
 313         <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
 314         <!-- DO NOT USE remove OverrideID from use -->
 315     </xs:attributeGroup>
 316 </xs:schema>