Added More Comments and started doing data type checking so that if a ModuleName...
[mirror_edk2.git] / Tools / XMLSchema / FrameworkDataAttributes.xsd
CommitLineData
92e805e9 1<?xml version="1.0" encoding="UTF-8"?>\r
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">\r
3 <!--\r
4 Filename: FrameworkDataAttributes.xsd\r
5 \r
6 Copyright (c) 2006, Intel Corp.\r
7 All rights reserved. This program and the accompanying materials\r
8 are licensed and made available under the terms and conditions of the BSD License\r
9 which may be found at http://opensource.org/licenses/bsd-license.php\r
10 \r
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13 \r
14 -->\r
15 <xs:annotation>\r
16 <xs:documentation xml:lang="en">This schema defines EFI and Framework Attribute. Only attributeGroups are specified in this file. </xs:documentation>\r
17 </xs:annotation>\r
18 <xs:include schemaLocation="NamingConvention.xsd"/>\r
19 <xs:include schemaLocation="FrameworkDataTypes.xsd"/>\r
20 <xs:attributeGroup name="BaseNameAttributes">\r
21 <xs:attribute name="Guid" type="GuidType" use="optional"/>\r
22 <xs:attribute name="Version" type="VersionDataType" use="optional"/>\r
23 </xs:attributeGroup>\r
24 <xs:attributeGroup name="BootModeAttributes">\r
25 <xs:attribute name="Guid" type="GuidType" use="optional"/>\r
26 <xs:attribute name="BootModeName" type="BootModeNames" use="required"/>\r
27 <xs:attribute name="Usage" type="BootModeUsage" use="required"/>\r
0675decb 28 <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>\r
cf0a51a5 29 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>\r
92e805e9 30 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>\r
0675decb 31 <!-- DO NOT USE remove OverrideID from use -->\r
92e805e9 32 </xs:attributeGroup>\r
33 <xs:attributeGroup name="ConvertAttributeString">\r
34 <xs:attribute name="SourceString" type="xs:string" use="optional"/>\r
35 <xs:attribute default="Unicode" name="OutputFiletype" type="xs:string" use="optional"/>\r
36 <xs:attribute name="OutputFilename" type="FileNameConvention" use="optional"/>\r
37 </xs:attributeGroup>\r
38 <xs:attributeGroup name="DataHubAttributes">\r
39 <xs:attribute name="Guid" type="GuidType" use="optional"/>\r
40 <xs:attribute name="Usage" type="DataHubUsage" use="optional"/>\r
0675decb 41 <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>\r
cf0a51a5 42 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>\r
92e805e9 43 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>\r
0675decb 44 <!-- DO NOT USE remove OverrideID from use -->\r
92e805e9 45 </xs:attributeGroup>\r
46 <xs:attributeGroup name="DirectoryAttributes">\r
47 <xs:attribute name="Separator" type="ToothPick"/>\r
48 </xs:attributeGroup>\r
49 <xs:attributeGroup name="EventAttributes">\r
0675decb 50 <xs:attribute name="Guid" type="GuidType" use="optional"/>\r
92e805e9 51 <xs:attribute name="Usage" type="EventUsage" use="optional"/>\r
52 <xs:attribute name="EventGroup" type="EventTypes" use="optional"/>\r
0675decb 53 <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>\r
cf0a51a5 54 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>\r
92e805e9 55 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>\r
0675decb 56 <!-- DO NOT USE remove OverrideID from use -->\r
92e805e9 57 </xs:attributeGroup>\r
58 <xs:attributeGroup name="ExternAttributes">\r
0675decb 59 <xs:attribute name="Guid" type="GuidType" use="optional"/>\r
92e805e9 60 <xs:attribute name="Usage" type="ExternUsage" use="optional"/>\r
0675decb 61 <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>\r
cf0a51a5 62 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>\r
92e805e9 63 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>\r
0675decb 64 <!-- DO NOT USE remove OverrideID from use -->\r
92e805e9 65 </xs:attributeGroup>\r
66 <xs:attributeGroup name="FilenameAttributes">\r
67 <xs:attribute name="Usage" type="FileNameUsage" use="optional"/>\r
68 <xs:attribute name="Guid" type="GuidType" use="optional"/>\r
69 <xs:attribute name="Path" type="DirectoryNamingConvention" use="optional"/>\r
70 <xs:attribute name="FileType" type="xs:string" use="optional"/>\r
71 <xs:attribute name="ToolChain" type="ToolChains" use="optional"/>\r
0675decb 72 <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>\r
cf0a51a5 73 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>\r
92e805e9 74 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>\r
0675decb 75 <!-- DO NOT USE remove OverrideID from use -->\r
92e805e9 76 </xs:attributeGroup>\r
77 <xs:attributeGroup name="FormsetAttributes">\r
92e805e9 78 <xs:attribute name="Guid" type="GuidType" use="optional"/>\r
0675decb 79 <xs:attribute name="Usage" type="FormSetUsage" use="optional"/>\r
80 <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>\r
cf0a51a5 81 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>\r
92e805e9 82 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>\r
0675decb 83 <!-- DO NOT USE remove OverrideID from use -->\r
92e805e9 84 </xs:attributeGroup>\r
85 <xs:attributeGroup name="GuidAttributes">\r
86 <xs:attribute name="Usage" type="GuidUsage" use="optional"/>\r
87 <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>\r
cf0a51a5 88 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>\r
92e805e9 89 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>\r
0675decb 90 <!-- DO NOT USE remove OverrideID from use -->\r
92e805e9 91 </xs:attributeGroup>\r
92 <xs:attributeGroup name="HobAttributes">\r
0675decb 93 <xs:attribute name="Guid" type="GuidType" use="optional"/>\r
92e805e9 94 <xs:attribute name="Usage" type="HobUsage" use="optional"/>\r
95 <xs:attribute name="HobType" type="HobTypes" use="required"/>\r
96 <xs:attribute default="true" name="HobEnabled" type="xs:boolean" use="optional"/>\r
0675decb 97 <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>\r
cf0a51a5 98 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>\r
92e805e9 99 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>\r
0675decb 100 <!-- DO NOT USE remove OverrideID from use -->\r
92e805e9 101 </xs:attributeGroup>\r
102 <xs:attributeGroup name="IncludeAttributes">\r
103 <xs:attribute name="Guid" type="GuidType" use="optional"/>\r
104 <xs:attribute name="Path" type="DirectoryNamingConvention" use="optional"/>\r
0675decb 105 <xs:attribute name="Class" type="BaseNameConvention" use="optional"/>\r
92e805e9 106 <xs:attribute name="Version" type="VersionDataType" use="optional"/>\r
0675decb 107 <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>\r
cf0a51a5 108 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>\r
92e805e9 109 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>\r
0675decb 110 <!-- DO NOT USE remove OverrideID from use -->\r
92e805e9 111 <xs:attribute name="ModuleType" type="ModuleTypeDef" use="optional"/>\r
112 </xs:attributeGroup>\r
113 <xs:attributeGroup name="LibraryAttributes">\r
0675decb 114 <!-- LibraryAttributes is used for Libraries -> Library elements in FPD files -->\r
92e805e9 115 <xs:attribute name="Guid" type="GuidType" use="optional"/>\r
0675decb 116 <!-- DO NOT USE remove Guid from use, Start using LibraryGuid instead -->\r
117 <xs:attribute name="LibraryGuid" type="GuidType" use="optional"/>\r
118 <xs:attribute name="Version" type="VersionDataType" use="optional"/>\r
119 <!-- DO NOT USE remove Version from use, Start using LibraryVersion instead -->\r
120 <xs:attribute name="ModuleVersion" type="VersionDataType" use="optional"/>\r
92e805e9 121 <xs:attribute name="LibraryClass" type="BaseNameConvention" use="optional"/>\r
122 <xs:attribute name="ClassGuid" type="GuidType" use="optional"/>\r
92e805e9 123 <xs:attribute name="Usage" type="LibraryUsage" use="optional"/>\r
124 <xs:attribute name="Package" type="xs:string" use="optional"/>\r
0675decb 125 <!-- DO NOT USE remove Package from use, Start using PackageName instead -->\r
126 <xs:attribute name="PackageName" type="BaseNameConvention" use="optional"/>\r
127 <xs:attribute name="PackageVersion" type="VersionDataType" use="optional"/>\r
128 <xs:attribute name="PackageGuid" type="GuidType" use="optional"/>\r
129 <xs:attribute name="Arch" type="SupportedArchitectures" use="optional"/>\r
130 <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>\r
cf0a51a5 131 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>\r
92e805e9 132 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>\r
0675decb 133 <!-- DO NOT USE remove OverrideID from use -->\r
92e805e9 134 </xs:attributeGroup>\r
135 <xs:attributeGroup name="ModuleNameAttributes">\r
2fdd0c7d 136 <xs:attribute name="Guid" type="GuidType" use="required"/>\r
137 <xs:attribute name="Version" type="VersionDataType" use="optional"/>\r
138 </xs:attributeGroup>\r
139 <xs:attributeGroup name="ModuleNameSaAttributes">\r
0675decb 140 <xs:attribute name="Guid" type="GuidType" use="optional"/>\r
2fdd0c7d 141 <xs:attribute name="ModuleName" type="xs:NCName" use="required"/>\r
92e805e9 142 <xs:attribute name="Version" type="VersionDataType" use="optional"/>\r
143 </xs:attributeGroup>\r
144 <xs:attributeGroup name="MsaAttributes">\r
145 <xs:attribute name="Arch" type="SupportedArchitectures" use="optional"/>\r
146 <xs:attribute name="FvBinding" type="xs:string" use="optional"/>\r
0675decb 147 <xs:attribute name="ModuleName" type="xs:NCName" use="optional"/>\r
92e805e9 148 <xs:attribute name="ModuleGuid" type="GuidType" use="optional"/>\r
0675decb 149 <xs:attribute name="PackageName" type="BaseNameConvention" use="optional"/>\r
92e805e9 150 <xs:attribute name="PackageGuid" type="GuidType" use="optional"/>\r
151 <xs:attribute name="BuildSequence" type="xs:int" use="optional"/>\r
152 </xs:attributeGroup>\r
153 <xs:attributeGroup name="OptionAttributes">\r
154 <xs:attribute name="Platform" type="PlatformNamingConvention" use="optional"/>\r
92e805e9 155 <xs:attribute name="ToolChain" type="ToolChains" use="optional"/>\r
2fdd0c7d 156 <xs:attribute name="BuildTarget" type="BuildTargets" use="optional"/>\r
0675decb 157 <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>\r
cf0a51a5 158 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>\r
159 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>\r
0675decb 160 <!-- DO NOT USE remove OverrideID from use -->\r
92e805e9 161 </xs:attributeGroup>\r
162 <xs:attributeGroup name="PackageAttributes">\r
0675decb 163 <xs:attribute name="PackageGuid" type="GuidType" use="optional"/>\r
164 <xs:attribute name="PackageVersion" type="xs:string" use="optional"/>\r
92e805e9 165 <xs:attribute name="Usage" type="PackageUsage" use="optional"/>\r
166 <xs:attribute name="PackageType" type="PackageType" use="optional"/>\r
167 <xs:attribute name="UpdatedDate" type="DateType" use="optional"/>\r
0675decb 168 <xs:attribute name="Arch" type="SupportedArchitectures" use="optional"/>\r
92e805e9 169 </xs:attributeGroup>\r
0675decb 170 <!-- PackageNameAttributres are only used in the Package Dependencies section of an SPD file. -->\r
92e805e9 171 <xs:attributeGroup name="PackageNameAttributes">\r
172 <xs:attribute name="Guid" type="GuidType" use="optional"/>\r
0675decb 173 <!-- DO NOT USE remove Guid and start using PackageGuid instead -->\r
174 <xs:attribute name="PackageGuid" type="GuidType" use="optional"/>\r
92e805e9 175 <xs:attribute name="Version" type="VersionDataType" use="optional"/>\r
0675decb 176 <!-- DO NOT USE remove Version and start using PackageVersion instead -->\r
177 <xs:attribute name="PackageVersion" type="xs:string" use="optional"/>\r
178 <!-- PackageTypeDepencency is used to identify if a SOURCE or BINARY PackageType is required, in case PackageGuid and/or PackageVersion are not tracked. -->\r
179 <xs:attribute name="PackageTypeDependency" type="PackageType" use="optional"/>\r
2fdd0c7d 180 <xs:attribute name="Arch" type="SupportedArchitectures" use="optional"/>\r
92e805e9 181 </xs:attributeGroup>\r
182 <xs:attributeGroup name="PcdAttributes">\r
183 <xs:annotation>\r
184 <xs:documentation xml:lang="en">These attributes are for the Pcds listed in PcdData, PcdEntry and/or PcdBuildData entries.</xs:documentation>\r
185 <xs:documentation xml:lang="en">PcdUsage is only valid for PcdItemTypes = FEATURE_FLAG</xs:documentation>\r
186 </xs:annotation>\r
187 <xs:attribute name="ItemType" type="PcdItemTypes" use="required"/>\r
188 <xs:attribute name="PcdUsage" type="PcdUsage" use="optional"/>\r
0675decb 189 <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>\r
cf0a51a5 190 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>\r
92e805e9 191 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>\r
0675decb 192 <!-- DO NOT USE remove OverrideID from use -->\r
92e805e9 193 </xs:attributeGroup>\r
194 <xs:attributeGroup name="PlatformAttributes">\r
195 <xs:attribute name="Guid" type="GuidType" use="optional"/>\r
0675decb 196 <!-- DO NOT USE remove Guid from use -->\r
92e805e9 197 <xs:attribute name="Version" type="VersionDataType" use="optional"/>\r
198 <xs:attribute name="AlternateName" type="FileNameConvention" use="optional"/>\r
0675decb 199 <!-- DO NOT USE remove AlternateName from use -->\r
200 <xs:attribute name="PlatformName" type="PlatformNamingConvention" use="optional"/>\r
92e805e9 201 <xs:attribute name="PlatformGuid" type="GuidType" use="optional"/>\r
202 <xs:attribute name="PlatformVersion" type="xs:string" use="optional"/>\r
203 </xs:attributeGroup>\r
204 <xs:attributeGroup name="PpiAttributes">\r
205 <xs:attribute name="Guid" type="GuidType" use="optional"/>\r
206 <xs:attribute name="Usage" type="PpiUsage" use="optional"/>\r
207 <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>\r
cf0a51a5 208 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>\r
92e805e9 209 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>\r
0675decb 210 <!-- DO NOT USE remove OverrideID from use -->\r
92e805e9 211 </xs:attributeGroup>\r
212 <xs:attributeGroup name="PpiNotifyAttributes">\r
213 <xs:attribute name="Guid" type="GuidType" use="optional"/>\r
214 <xs:attribute name="Usage" type="PpiNotifyUsage" use="optional"/>\r
215 <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>\r
cf0a51a5 216 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>\r
92e805e9 217 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>\r
0675decb 218 <!-- DO NOT USE remove OverrideID from use -->\r
92e805e9 219 </xs:attributeGroup>\r
220 <xs:attributeGroup name="ProtocolAttributes">\r
221 <xs:attribute name="Guid" type="GuidType" use="optional"/>\r
222 <xs:attribute name="Usage" type="ProtocolUsage" use="optional"/>\r
223 <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>\r
cf0a51a5 224 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>\r
92e805e9 225 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>\r
0675decb 226 <!-- DO NOT USE remove OverrideID from use -->\r
92e805e9 227 </xs:attributeGroup>\r
228 <xs:attributeGroup name="ProtocolNotifyAttributes">\r
229 <xs:attribute name="Guid" type="GuidType" use="optional"/>\r
230 <xs:attribute name="Usage" type="ProtocolNotifyUsage" use="optional"/>\r
cf0a51a5 231 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>\r
92e805e9 232 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>\r
0675decb 233 <!-- DO NOT USE remove OverrideID from use -->\r
92e805e9 234 </xs:attributeGroup>\r
235 <xs:attributeGroup name="SectionAttributes">\r
236 <xs:annotation>\r
237 <xs:documentation xml:lang="en">Attributes are either compressable and/or sequence order binding</xs:documentation>\r
238 </xs:annotation>\r
239 <xs:attribute name="SectionType" type="EfiSectionType" use="optional"/>\r
240 <xs:attribute default="true" name="Compressible" type="xs:boolean" use="optional"/>\r
241 <xs:attribute name="BindingOrder" type="xs:int" use="optional"/>\r
0675decb 242 <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>\r
cf0a51a5 243 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>\r
92e805e9 244 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>\r
0675decb 245 <!-- DO NOT USE remove OverrideID from use -->\r
92e805e9 246 </xs:attributeGroup>\r
247 <xs:attributeGroup name="SectionsAttributes">\r
248 <xs:annotation>\r
0675decb 249 <xs:documentation xml:lang="en">Attributes for Sections, EncapsulationTag, EncapsulationType and FeatureFlag</xs:documentation>\r
92e805e9 250 </xs:annotation>\r
251 <xs:attribute name="EncapsulationType" type="xs:normalizedString" use="optional"/>\r
252 <xs:attribute name="EncapsulationTag" type="xs:string" use="optional"/>\r
0675decb 253 <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>\r
cf0a51a5 254 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>\r
92e805e9 255 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>\r
0675decb 256 <!-- DO NOT USE remove OverrideID from use -->\r
92e805e9 257 </xs:attributeGroup>\r
258 <xs:attributeGroup name="SystemTableAttributes">\r
0675decb 259 <xs:attribute name="Guid" type="GuidType" use="optional"/>\r
92e805e9 260 <xs:attribute name="Usage" type="SystemTableUsage" use="optional"/>\r
0675decb 261 <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>\r
cf0a51a5 262 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>\r
92e805e9 263 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>\r
0675decb 264 <!-- DO NOT USE remove OverrideID from use -->\r
92e805e9 265 </xs:attributeGroup>\r
cf0a51a5 266 <xs:attributeGroup name="UrlAttribute">\r
267 <xs:attribute name="Url" type="xs:anyURI"/>\r
268 </xs:attributeGroup>\r
92e805e9 269 <xs:attributeGroup name="VariableAttributes">\r
0675decb 270 <xs:attribute name="Guid" type="GuidType" use="optional"/>\r
92e805e9 271 <xs:attribute name="Usage" type="VariableUsage" use="optional"/>\r
0675decb 272 <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>\r
cf0a51a5 273 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>\r
92e805e9 274 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>\r
0675decb 275 <!-- DO NOT USE remove OverrideID from use -->\r
92e805e9 276 </xs:attributeGroup>\r
92e805e9 277</xs:schema>\r