Fix a typo in lib name.
[mirror_edk2.git] / 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="xs:string"/>
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" maxOccurs="1">
245 <xs:sequence minOccurs="0" maxOccurs="1">
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 minOccurs="0" maxOccurs="1">
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 minOccurs="0" maxOccurs="1">
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="1" 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 minOccurs="0" maxOccurs="1">
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="NonProcessedFiles">
533 <xs:complexType>
534 <xs:sequence minOccurs="1" maxOccurs="unbounded">
535 <xs:element name="Filename" type="PathAndFilename"/>
536 </xs:sequence>
537 </xs:complexType>
538 </xs:element>
539 <xs:element name="Option">
540 <!-- This element is used to store flags from the Tools -->
541 <xs:complexType>
542 <xs:simpleContent>
543 <xs:extension base="xs:normalizedString">
544 <xs:attributeGroup ref="OptionAttributes"/>
545 </xs:extension>
546 </xs:simpleContent>
547 </xs:complexType>
548 </xs:element>
549 <xs:element name="PackageDefinitions">
550 <xs:complexType>
551 <xs:sequence>
552 <xs:element minOccurs="1" maxOccurs="1" name="ReadOnly" type="xs:boolean" default="false"/>
553 <xs:element minOccurs="1" maxOccurs="1" name="RePackage" type="xs:boolean" default="false"/>
554 <xs:element minOccurs="0" maxOccurs="1" name="ClonedFrom">
555 <xs:complexType>
556 <xs:sequence>
557 <xs:element minOccurs="1" maxOccurs="unbounded" name="Cloned">
558 <xs:complexType>
559 <xs:sequence>
560 <xs:element minOccurs="1" maxOccurs="1" name="PackageGuid" type="GuidType"/>
561 <xs:element minOccurs="1" maxOccurs="1" name="PackageVersion" type="VersionDataType"/>
562 </xs:sequence>
563 <!-- The Id is a number used to track heritage the first entry will be 0 and increment from then on. -->
564 <xs:attribute name="Id" type="xs:nonNegativeInteger" use="required"/>
565 <!-- If the original Package was installed from a FAR, track the FAR it came from. -->
566 <xs:attribute name="FarGuid" type="GuidType" use="optional"/>
567 </xs:complexType>
568 </xs:element>
569 </xs:sequence>
570 </xs:complexType>
571 </xs:element>
572 </xs:sequence>
573 </xs:complexType>
574 </xs:element>
575 <xs:element name="PackageDependencies">
576 <xs:annotation>
577 <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>
578 <xs:documentation xml:lang="en">Attributes to PackageName include Required: Usage PackageGuid PackageVesion, Optional: FeatureFlag</xs:documentation>
579 </xs:annotation>
580 <xs:complexType>
581 <xs:sequence>
582 <xs:element minOccurs="1" maxOccurs="unbounded" name="Package">
583 <xs:complexType>
584 <xs:attributeGroup ref="PackageAttributes"/>
585 </xs:complexType>
586 </xs:element>
587 </xs:sequence>
588 </xs:complexType>
589 </xs:element>
590 <xs:element name="PackageHeaders">
591 <xs:annotation>
592 <xs:documentation xml:lang="en">PackageHeaders is a child of PackageSurfaceArea (SPD) </xs:documentation>
593 </xs:annotation>
594 <xs:complexType>
595 <xs:sequence>
596 <xs:element minOccurs="1" maxOccurs="unbounded" name="IncludePkgHeader">
597 <xs:complexType>
598 <xs:simpleContent>
599 <xs:extension base="PathAndFilename">
600 <xs:attributeGroup ref="PackageHeaderAttributes"/>
601 </xs:extension>
602 </xs:simpleContent>
603 </xs:complexType>
604 </xs:element>
605 </xs:sequence>
606 </xs:complexType>
607 </xs:element>
608 <xs:element name="PackageList">
609 <!-- Valid for DB usage only! -->
610 <xs:annotation>
611 <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>
612 </xs:annotation>
613 <xs:complexType>
614 <xs:sequence>
615 <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename" type="DbPathAndFilename"/>
616 </xs:sequence>
617 </xs:complexType>
618 </xs:element>
619 <!-- PcdBuildDefinition is a child of FPD ModuleSA element for FIXED_AT_BUILD, PATCHABLE_IN_MODULE, and FEATURE_FLAG PCDS Only! -->
620 <xs:element name="PcdBuildDefinition">
621 <xs:annotation>
622 <xs:documentation xml:lang="en">Child of FPD ModuleSA element for FIXED_AT_BUILD, PATCHABLE_IN_MODULE, and FEATURE_FLAG PCDS Only!</xs:documentation>
623 </xs:annotation>
624 <xs:complexType>
625 <xs:sequence>
626 <xs:element minOccurs="1" maxOccurs="unbounded" name="PcdData">
627 <xs:complexType>
628 <xs:sequence>
629 <xs:element minOccurs="1" maxOccurs="1" name="C_Name" type="C_NameType"/>
630 <xs:element minOccurs="1" maxOccurs="1" name="Token" type="TokenDataType"/>
631 <xs:element minOccurs="1" maxOccurs="1" name="TokenSpaceGuidCName" type="C_NameType"/>
632 <xs:element minOccurs="1" maxOccurs="1" name="DatumType" type="PcdDataTypes"/>
633 <!-- MaxDatumSize is only required if the DatumType is VOID* -->
634 <xs:element minOccurs="0" maxOccurs="1" name="MaxDatumSize" type="DatumSizeLimitation"/>
635 <xs:element minOccurs="0" maxOccurs="1" name="Value" type="DefaultValueType"/>
636 </xs:sequence>
637 <xs:attributeGroup ref="PcdBuildDefinitionAttributes"/>
638 </xs:complexType>
639 </xs:element>
640 </xs:sequence>
641 </xs:complexType>
642 </xs:element>
643 <xs:group name="DefaultGroup">
644 <xs:sequence>
645 <xs:element minOccurs="1" maxOccurs="1" name="Value" type="DefaultValueType"/>
646 </xs:sequence>
647 </xs:group>
648 <xs:group name="HiiEnable">
649 <xs:annotation>
650 <xs:documentation xml:lang="en">If HiiEnable group is specified, then HiiEnable is default true</xs:documentation>
651 </xs:annotation>
652 <xs:sequence>
653 <xs:element minOccurs="1" maxOccurs="1" name="VariableName" type="HexWordArrayType"/>
654 <xs:element minOccurs="1" maxOccurs="1" name="VariableGuid" type="C_NameType"/>
655 <xs:element minOccurs="1" maxOccurs="1" name="VariableOffset" type="Hex64BitDataType"/>
656 <xs:element minOccurs="1" maxOccurs="1" name="HiiDefaultValue" type="DefaultValueType"/>
657 </xs:sequence>
658 </xs:group>
659 <xs:group name="VpdEnable">
660 <xs:annotation>
661 <xs:documentation xml:lang="en">If VpdEnable group is specified, then VpdEnable is default true</xs:documentation>
662 </xs:annotation>
663 <xs:sequence>
664 <xs:element minOccurs="1" maxOccurs="1" name="VpdOffset" type="Hex64BitDataType"/>
665 </xs:sequence>
666 </xs:group>
667 <xs:element name="PcdCoded">
668 <xs:annotation>
669 <xs:documentation xml:lang="en">Child of Module Surface Area Description (MSA)</xs:documentation>
670 </xs:annotation>
671 <xs:complexType>
672 <xs:sequence>
673 <xs:element minOccurs="1" maxOccurs="unbounded" name="PcdEntry">
674 <xs:complexType>
675 <xs:sequence>
676 <xs:element minOccurs="1" maxOccurs="1" name="C_Name" type="C_NameType"/>
677 <xs:element minOccurs="1" maxOccurs="1" name="TokenSpaceGuidCName" type="C_NameType"/>
678 <xs:element minOccurs="0" maxOccurs="1" name="DefaultValue" type="DefaultValueType"/>
679 <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
680 </xs:sequence>
681 <!-- 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. -->
682 <xs:attributeGroup ref="PcdCodedAttributes"/>
683 </xs:complexType>
684 </xs:element>
685 </xs:sequence>
686 </xs:complexType>
687 </xs:element>
688 <!-- LAH This is PcdDeclarations FINAL version -->
689 <xs:element name="PcdDeclarations">
690 <xs:annotation>
691 <xs:documentation xml:lang="en">PcdDeclaratins is a child of Package Surface Area Description (SPD)</xs:documentation>
692 </xs:annotation>
693 <xs:complexType>
694 <xs:sequence minOccurs="1">
695 <xs:element maxOccurs="unbounded" name="PcdEntry">
696 <xs:complexType>
697 <xs:sequence>
698 <xs:element minOccurs="1" maxOccurs="1" name="C_Name" type="C_NameType"/>
699 <xs:element minOccurs="1" maxOccurs="1" name="Token" type="TokenDataType"/>
700 <xs:element minOccurs="1" maxOccurs="1" name="TokenSpaceGuidCName" type="C_NameType"/>
701 <xs:element minOccurs="1" maxOccurs="1" name="DatumType" type="PcdDataTypes"/>
702 <xs:element minOccurs="1" maxOccurs="1" name="ValidUsage" type="PcdListType"/>
703 <xs:element minOccurs="0" maxOccurs="1" name="DefaultValue" type="DefaultValueType"/>
704 <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
705 </xs:sequence>
706 <xs:attributeGroup ref="PcdDeclarationAttributes"/>
707 </xs:complexType>
708 </xs:element>
709 </xs:sequence>
710 </xs:complexType>
711 </xs:element>
712 <xs:element name="FarList">
713 <!-- Valid for DB usage only! -->
714 <xs:annotation>
715 <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>
716 </xs:annotation>
717 <xs:complexType>
718 <xs:sequence>
719 <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename" type="DbPathAndFilename"/>
720 </xs:sequence>
721 </xs:complexType>
722 </xs:element>
723 <xs:element name="FfsFormatDeclarations">
724 <xs:complexType>
725 <xs:sequence>
726 <xs:element minOccurs="1" maxOccurs="unbounded" name="FfsFormatDeclaration">
727 <!-- Required Attributes are the FfsFormatKeyword and SupModuleList -->
728 <xs:complexType>
729 <xs:sequence>
730 <xs:element minOccurs="1" maxOccurs="unbounded" ref="ProcessStep"/>
731 </xs:sequence>
732 <xs:attributeGroup ref="FfsAttributes"/>
733 </xs:complexType>
734 </xs:element>
735 </xs:sequence>
736 </xs:complexType>
737 </xs:element>
738 <xs:element name="PpiDeclarations">
739 <xs:annotation>
740 <xs:documentation xml:lang="en">PpiDeclarations is a child of PackageSurfaceArea (SPD) </xs:documentation>
741 </xs:annotation>
742 <xs:complexType>
743 <xs:sequence>
744 <xs:element minOccurs="1" maxOccurs="unbounded" name="Entry">
745 <xs:complexType>
746 <xs:sequence>
747 <xs:element minOccurs="1" maxOccurs="1" name="C_Name" type="C_NameType"/>
748 <xs:element minOccurs="1" maxOccurs="1" name="GuidValue" type="GuidType"/>
749 <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
750 </xs:sequence>
751 <xs:attributeGroup ref="PpiDeclarationAttributes"/>
752 </xs:complexType>
753 </xs:element>
754 </xs:sequence>
755 </xs:complexType>
756 </xs:element>
757 <xs:element name="PPIs">
758 <xs:annotation>
759 <xs:documentation xml:lang="en">Provide for one or more Ppi or PpiNotify sections. </xs:documentation>
760 </xs:annotation>
761 <xs:complexType>
762 <xs:sequence minOccurs="1">
763 <xs:element minOccurs="0" maxOccurs="unbounded" name="Ppi">
764 <xs:complexType>
765 <xs:sequence>
766 <xs:element minOccurs="1" maxOccurs="1" name="PpiCName" type="C_NameType"/>
767 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
768 </xs:sequence>
769 <xs:attributeGroup ref="PpiAttributes"/>
770 </xs:complexType>
771 </xs:element>
772 <xs:element minOccurs="0" maxOccurs="unbounded" name="PpiNotify">
773 <xs:complexType>
774 <xs:sequence>
775 <xs:element minOccurs="1" maxOccurs="1" name="PpiNotifyCName" type="C_NameType"/>
776 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
777 </xs:sequence>
778 <xs:attributeGroup ref="PpiNotifyAttributes"/>
779 </xs:complexType>
780 </xs:element>
781 </xs:sequence>
782 </xs:complexType>
783 </xs:element>
784 <xs:element name="ProtocolDeclarations">
785 <xs:annotation>
786 <xs:documentation xml:lang="en">ProtocolDeclarations is a child of PackageSurfaceArea (SPD) </xs:documentation>
787 </xs:annotation>
788 <xs:complexType>
789 <xs:sequence>
790 <xs:element minOccurs="1" maxOccurs="unbounded" name="Entry">
791 <xs:complexType>
792 <xs:sequence>
793 <xs:element minOccurs="1" maxOccurs="1" name="C_Name" type="C_NameType"/>
794 <xs:element minOccurs="1" maxOccurs="1" name="GuidValue" type="GuidType"/>
795 <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
796 </xs:sequence>
797 <xs:attributeGroup ref="ProtocolDeclarationAttributes"/>
798 </xs:complexType>
799 </xs:element>
800 </xs:sequence>
801 </xs:complexType>
802 </xs:element>
803 <xs:element name="Protocols">
804 <xs:annotation>
805 <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>
806 </xs:annotation>
807 <xs:complexType>
808 <xs:sequence>
809 <xs:element minOccurs="0" maxOccurs="unbounded" name="Protocol">
810 <xs:complexType>
811 <xs:sequence>
812 <xs:element minOccurs="1" maxOccurs="1" name="ProtocolCName" type="C_NameType"/>
813 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
814 </xs:sequence>
815 <xs:attributeGroup ref="ProtocolAttributes"/>
816 </xs:complexType>
817 </xs:element>
818 <xs:element minOccurs="0" maxOccurs="unbounded" name="ProtocolNotify">
819 <xs:complexType>
820 <xs:sequence>
821 <xs:element minOccurs="1" maxOccurs="1" name="ProtocolNotifyCName" type="C_NameType"/>
822 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
823 </xs:sequence>
824 <xs:attributeGroup ref="ProtocolNotifyAttributes"/>
825 </xs:complexType>
826 </xs:element>
827 </xs:sequence>
828 </xs:complexType>
829 </xs:element>
830 <xs:element name="ProcessStep">
831 <xs:complexType>
832 <xs:sequence>
833 <!-- The following is a macro for Apache ANT -->
834 <xs:element minOccurs="0" maxOccurs="1" name="MacroDefFile">
835 <xs:complexType>
836 <xs:simpleContent>
837 <xs:extension base="PathAndFilename">
838 <xs:attribute name="MacroName" type="KeywordType" use="required"/>
839 </xs:extension>
840 </xs:simpleContent>
841 </xs:complexType>
842 </xs:element>
843 <!-- The following is for System Executables -->
844 <xs:element minOccurs="0" maxOccurs="1" name="ToolName" type="xs:NCName"/>
845 <xs:element minOccurs="0" maxOccurs="unbounded" name="ToolArgs" type="xs:normalizedString"/>
846 <xs:element minOccurs="0" maxOccurs="unbounded" name="InputPattern" type="xs:normalizedString"/>
847 <xs:element minOccurs="0" maxOccurs="1" name="OutputPattern" type="xs:normalizedString"/>
848 </xs:sequence>
849 <xs:attributeGroup ref="ProcessStepAttributes"/>
850 </xs:complexType>
851 </xs:element>
852 <xs:element name="SourceFiles">
853 <xs:annotation>
854 <xs:documentation xml:lang="en">Multiple Filenames may be specified, and they may also be scoped to a specific Architecture.</xs:documentation>
855 </xs:annotation>
856 <xs:complexType>
857 <xs:sequence>
858 <xs:element minOccurs="1" maxOccurs="unbounded" ref="Filename"/>
859 </xs:sequence>
860 </xs:complexType>
861 </xs:element>
862 <xs:element name="SkuInfo">
863 <xs:complexType>
864 <xs:sequence>
865 <xs:element minOccurs="1" maxOccurs="unbounded" name="UiSkuName">
866 <xs:complexType>
867 <xs:simpleContent>
868 <xs:extension base="UiNameType">
869 <xs:attribute name="SkuID" type="xs:nonNegativeInteger" use="required"/>
870 </xs:extension>
871 </xs:simpleContent>
872 </xs:complexType>
873 </xs:element>
874 </xs:sequence>
875 </xs:complexType>
876 </xs:element>
877 <xs:element name="SystemTables">
878 <xs:annotation>
879 <xs:documentation xml:lang="en">This is list of System Table elements.</xs:documentation>
880 </xs:annotation>
881 <xs:complexType>
882 <xs:sequence>
883 <xs:element minOccurs="1" maxOccurs="unbounded" name="SystemTableCNames">
884 <xs:complexType>
885 <xs:sequence>
886 <xs:element minOccurs="1" maxOccurs="1" name="SystemTableCName" type="C_NameType"/>
887 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
888 </xs:sequence>
889 <xs:attributeGroup ref="SystemTableAttributes"/>
890 </xs:complexType>
891 </xs:element>
892 </xs:sequence>
893 </xs:complexType>
894 </xs:element>
895 <xs:element name="UserDefinedAntTasks">
896 <xs:annotation>
897 <xs:documentation xml:lang="en">This is a sub-element of BuildOptions</xs:documentation>
898 <xs:documentation xml:lang="en">Permit Users to define their own custom ANT tasks.</xs:documentation>
899 </xs:annotation>
900 <xs:complexType>
901 <xs:sequence>
902 <xs:element minOccurs="1" maxOccurs="unbounded" ref="AntTask"/>
903 </xs:sequence>
904 </xs:complexType>
905 </xs:element>
906 <xs:element name="UserExtensions">
907 <xs:complexType>
908 <xs:sequence>
909 <xs:any minOccurs="0" maxOccurs="unbounded" processContents="lax"/>
910 </xs:sequence>
911 <xs:attribute name="UserID" type="xs:NCName" use="required"/>
912 <xs:attribute name="Identifier" type="xs:nonNegativeInteger" use="required"/>
913 </xs:complexType>
914 </xs:element>
915 <xs:element name="Variables">
916 <xs:annotation>
917 <xs:documentation xml:lang="en">An MSA FILE list of EFI Variables described by string pair.</xs:documentation>
918 </xs:annotation>
919 <xs:complexType>
920 <xs:sequence>
921 <xs:element minOccurs="1" maxOccurs="unbounded" name="Variable">
922 <xs:annotation>
923 <xs:documentation xml:lang="en">This is an EFI Variable Entry</xs:documentation>
924 </xs:annotation>
925 <xs:complexType>
926 <xs:sequence>
927 <xs:element minOccurs="1" maxOccurs="1" name="VariableName" type="HexWordArrayType"/>
928 <xs:element minOccurs="1" maxOccurs="1" name="GuidC_Name" type="C_NameType"/>
929 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
930 </xs:sequence>
931 <xs:attributeGroup ref="VariableAttributes"/>
932 </xs:complexType>
933 </xs:element>
934 </xs:sequence>
935 </xs:complexType>
936 </xs:element>
937 <xs:element name="Version" type="VersionDataType"/>
938 </xs:schema>