Added More Comments and started doing data type checking so that if a ModuleName...
[mirror_edk2.git] / 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="OverrideID" type="xs:int" use="optional"/>
75 <!-- DO NOT USE remove OverrideID from use -->
76 </xs:attributeGroup>
77 <xs:attributeGroup name="FormsetAttributes">
78 <xs:attribute name="Guid" type="GuidType" use="optional"/>
79 <xs:attribute name="Usage" type="FormSetUsage" use="optional"/>
80 <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>
81 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
82 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
83 <!-- DO NOT USE remove OverrideID from use -->
84 </xs:attributeGroup>
85 <xs:attributeGroup name="GuidAttributes">
86 <xs:attribute name="Usage" type="GuidUsage" use="optional"/>
87 <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>
88 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
89 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
90 <!-- DO NOT USE remove OverrideID from use -->
91 </xs:attributeGroup>
92 <xs:attributeGroup name="HobAttributes">
93 <xs:attribute name="Guid" type="GuidType" use="optional"/>
94 <xs:attribute name="Usage" type="HobUsage" use="optional"/>
95 <xs:attribute name="HobType" type="HobTypes" use="required"/>
96 <xs:attribute default="true" name="HobEnabled" type="xs:boolean" use="optional"/>
97 <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>
98 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
99 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
100 <!-- DO NOT USE remove OverrideID from use -->
101 </xs:attributeGroup>
102 <xs:attributeGroup name="IncludeAttributes">
103 <xs:attribute name="Guid" type="GuidType" use="optional"/>
104 <xs:attribute name="Path" type="DirectoryNamingConvention" use="optional"/>
105 <xs:attribute name="Class" type="BaseNameConvention" use="optional"/>
106 <xs:attribute name="Version" type="VersionDataType" use="optional"/>
107 <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>
108 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
109 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
110 <!-- DO NOT USE remove OverrideID from use -->
111 <xs:attribute name="ModuleType" type="ModuleTypeDef" use="optional"/>
112 </xs:attributeGroup>
113 <xs:attributeGroup name="LibraryAttributes">
114 <!-- LibraryAttributes is used for Libraries -> Library elements in FPD files -->
115 <xs:attribute name="Guid" type="GuidType" use="optional"/>
116 <!-- DO NOT USE remove Guid from use, Start using LibraryGuid instead -->
117 <xs:attribute name="LibraryGuid" type="GuidType" use="optional"/>
118 <xs:attribute name="Version" type="VersionDataType" use="optional"/>
119 <!-- DO NOT USE remove Version from use, Start using LibraryVersion instead -->
120 <xs:attribute name="ModuleVersion" type="VersionDataType" use="optional"/>
121 <xs:attribute name="LibraryClass" type="BaseNameConvention" use="optional"/>
122 <xs:attribute name="ClassGuid" type="GuidType" use="optional"/>
123 <xs:attribute name="Usage" type="LibraryUsage" use="optional"/>
124 <xs:attribute name="Package" type="xs:string" use="optional"/>
125 <!-- DO NOT USE remove Package from use, Start using PackageName instead -->
126 <xs:attribute name="PackageName" type="BaseNameConvention" use="optional"/>
127 <xs:attribute name="PackageVersion" type="VersionDataType" use="optional"/>
128 <xs:attribute name="PackageGuid" type="GuidType" use="optional"/>
129 <xs:attribute name="Arch" type="SupportedArchitectures" use="optional"/>
130 <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>
131 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
132 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
133 <!-- DO NOT USE remove OverrideID from use -->
134 </xs:attributeGroup>
135 <xs:attributeGroup name="ModuleNameAttributes">
136 <xs:attribute name="Guid" type="GuidType" use="required"/>
137 <xs:attribute name="Version" type="VersionDataType" use="optional"/>
138 </xs:attributeGroup>
139 <xs:attributeGroup name="ModuleNameSaAttributes">
140 <xs:attribute name="Guid" type="GuidType" use="optional"/>
141 <xs:attribute name="ModuleName" type="xs:NCName" use="required"/>
142 <xs:attribute name="Version" type="VersionDataType" use="optional"/>
143 </xs:attributeGroup>
144 <xs:attributeGroup name="MsaAttributes">
145 <xs:attribute name="Arch" type="SupportedArchitectures" use="optional"/>
146 <xs:attribute name="FvBinding" type="xs:string" use="optional"/>
147 <xs:attribute name="ModuleName" type="xs:NCName" use="optional"/>
148 <xs:attribute name="ModuleGuid" type="GuidType" use="optional"/>
149 <xs:attribute name="PackageName" type="BaseNameConvention" use="optional"/>
150 <xs:attribute name="PackageGuid" type="GuidType" use="optional"/>
151 <xs:attribute name="BuildSequence" type="xs:int" use="optional"/>
152 </xs:attributeGroup>
153 <xs:attributeGroup name="OptionAttributes">
154 <xs:attribute name="Platform" type="PlatformNamingConvention" use="optional"/>
155 <xs:attribute name="ToolChain" type="ToolChains" use="optional"/>
156 <xs:attribute name="BuildTarget" type="BuildTargets" use="optional"/>
157 <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>
158 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
159 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
160 <!-- DO NOT USE remove OverrideID from use -->
161 </xs:attributeGroup>
162 <xs:attributeGroup name="PackageAttributes">
163 <xs:attribute name="PackageGuid" type="GuidType" use="optional"/>
164 <xs:attribute name="PackageVersion" type="xs:string" use="optional"/>
165 <xs:attribute name="Usage" type="PackageUsage" use="optional"/>
166 <xs:attribute name="PackageType" type="PackageType" use="optional"/>
167 <xs:attribute name="UpdatedDate" type="DateType" use="optional"/>
168 <xs:attribute name="Arch" type="SupportedArchitectures" use="optional"/>
169 </xs:attributeGroup>
170 <!-- PackageNameAttributres are only used in the Package Dependencies section of an SPD file. -->
171 <xs:attributeGroup name="PackageNameAttributes">
172 <xs:attribute name="Guid" type="GuidType" use="optional"/>
173 <!-- DO NOT USE remove Guid and start using PackageGuid instead -->
174 <xs:attribute name="PackageGuid" type="GuidType" use="optional"/>
175 <xs:attribute name="Version" type="VersionDataType" use="optional"/>
176 <!-- DO NOT USE remove Version and start using PackageVersion instead -->
177 <xs:attribute name="PackageVersion" type="xs:string" use="optional"/>
178 <!-- PackageTypeDepencency is used to identify if a SOURCE or BINARY PackageType is required, in case PackageGuid and/or PackageVersion are not tracked. -->
179 <xs:attribute name="PackageTypeDependency" type="PackageType" use="optional"/>
180 <xs:attribute name="Arch" type="SupportedArchitectures" use="optional"/>
181 </xs:attributeGroup>
182 <xs:attributeGroup name="PcdAttributes">
183 <xs:annotation>
184 <xs:documentation xml:lang="en">These attributes are for the Pcds listed in PcdData, PcdEntry and/or PcdBuildData entries.</xs:documentation>
185 <xs:documentation xml:lang="en">PcdUsage is only valid for PcdItemTypes = FEATURE_FLAG</xs:documentation>
186 </xs:annotation>
187 <xs:attribute name="ItemType" type="PcdItemTypes" use="required"/>
188 <xs:attribute name="PcdUsage" type="PcdUsage" use="optional"/>
189 <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>
190 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
191 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
192 <!-- DO NOT USE remove OverrideID from use -->
193 </xs:attributeGroup>
194 <xs:attributeGroup name="PlatformAttributes">
195 <xs:attribute name="Guid" type="GuidType" use="optional"/>
196 <!-- DO NOT USE remove Guid from use -->
197 <xs:attribute name="Version" type="VersionDataType" use="optional"/>
198 <xs:attribute name="AlternateName" type="FileNameConvention" use="optional"/>
199 <!-- DO NOT USE remove AlternateName from use -->
200 <xs:attribute name="PlatformName" type="PlatformNamingConvention" use="optional"/>
201 <xs:attribute name="PlatformGuid" type="GuidType" use="optional"/>
202 <xs:attribute name="PlatformVersion" type="xs:string" use="optional"/>
203 </xs:attributeGroup>
204 <xs:attributeGroup name="PpiAttributes">
205 <xs:attribute name="Guid" type="GuidType" use="optional"/>
206 <xs:attribute name="Usage" type="PpiUsage" use="optional"/>
207 <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>
208 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
209 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
210 <!-- DO NOT USE remove OverrideID from use -->
211 </xs:attributeGroup>
212 <xs:attributeGroup name="PpiNotifyAttributes">
213 <xs:attribute name="Guid" type="GuidType" use="optional"/>
214 <xs:attribute name="Usage" type="PpiNotifyUsage" use="optional"/>
215 <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>
216 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
217 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
218 <!-- DO NOT USE remove OverrideID from use -->
219 </xs:attributeGroup>
220 <xs:attributeGroup name="ProtocolAttributes">
221 <xs:attribute name="Guid" type="GuidType" use="optional"/>
222 <xs:attribute name="Usage" type="ProtocolUsage" use="optional"/>
223 <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>
224 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
225 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
226 <!-- DO NOT USE remove OverrideID from use -->
227 </xs:attributeGroup>
228 <xs:attributeGroup name="ProtocolNotifyAttributes">
229 <xs:attribute name="Guid" type="GuidType" use="optional"/>
230 <xs:attribute name="Usage" type="ProtocolNotifyUsage" use="optional"/>
231 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
232 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
233 <!-- DO NOT USE remove OverrideID from use -->
234 </xs:attributeGroup>
235 <xs:attributeGroup name="SectionAttributes">
236 <xs:annotation>
237 <xs:documentation xml:lang="en">Attributes are either compressable and/or sequence order binding</xs:documentation>
238 </xs:annotation>
239 <xs:attribute name="SectionType" type="EfiSectionType" use="optional"/>
240 <xs:attribute default="true" name="Compressible" type="xs:boolean" use="optional"/>
241 <xs:attribute name="BindingOrder" type="xs:int" use="optional"/>
242 <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>
243 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
244 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
245 <!-- DO NOT USE remove OverrideID from use -->
246 </xs:attributeGroup>
247 <xs:attributeGroup name="SectionsAttributes">
248 <xs:annotation>
249 <xs:documentation xml:lang="en">Attributes for Sections, EncapsulationTag, EncapsulationType and FeatureFlag</xs:documentation>
250 </xs:annotation>
251 <xs:attribute name="EncapsulationType" type="xs:normalizedString" use="optional"/>
252 <xs:attribute name="EncapsulationTag" type="xs:string" use="optional"/>
253 <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>
254 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
255 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
256 <!-- DO NOT USE remove OverrideID from use -->
257 </xs:attributeGroup>
258 <xs:attributeGroup name="SystemTableAttributes">
259 <xs:attribute name="Guid" type="GuidType" use="optional"/>
260 <xs:attribute name="Usage" type="SystemTableUsage" use="optional"/>
261 <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>
262 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
263 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
264 <!-- DO NOT USE remove OverrideID from use -->
265 </xs:attributeGroup>
266 <xs:attributeGroup name="UrlAttribute">
267 <xs:attribute name="Url" type="xs:anyURI"/>
268 </xs:attributeGroup>
269 <xs:attributeGroup name="VariableAttributes">
270 <xs:attribute name="Guid" type="GuidType" use="optional"/>
271 <xs:attribute name="Usage" type="VariableUsage" use="optional"/>
272 <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>
273 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
274 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
275 <!-- DO NOT USE remove OverrideID from use -->
276 </xs:attributeGroup>
277 </xs:schema>