Added two optional attributes to the Cloned element, FarGuid and Id that can be used...
[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="1" name="OutputDirectory">
70 <xs:complexType>
71 <xs:simpleContent>
72 <xs:extension base="xs:anyURI">
73 <xs:attribute default="UNIFIED" name="IntermediateDirectories" use="optional">
74 <xs:simpleType>
75 <xs:restriction base="UCNameType">
76 <xs:enumeration value="MODULE"/>
77 <xs:enumeration value="UNIFIED"/>
78 </xs:restriction>
79 </xs:simpleType>
80 </xs:attribute>
81 </xs:extension>
82 </xs:simpleContent>
83 </xs:complexType>
84 </xs:element>
85 <xs:element minOccurs="0" maxOccurs="unbounded" name="Ffs">
86 <xs:complexType>
87 <xs:sequence>
88 <xs:element minOccurs="0" maxOccurs="unbounded" name="Attribute">
89 <xs:complexType>
90 <xs:attribute name="Name" type="C_NameType"/>
91 <xs:attribute name="Value" type="C_NameType"/>
92 </xs:complexType>
93 </xs:element>
94 <xs:element minOccurs="0" maxOccurs="1" name="Sections">
95 <xs:complexType>
96 <xs:sequence minOccurs="1">
97 <xs:element name="Section" minOccurs="0" maxOccurs="unbounded">
98 <xs:complexType>
99 <xs:sequence>
100 <xs:element ref=" Filenames " minOccurs="0"/>
101 <xs:element name="Args" type=" ArgsType " minOccurs="0"/>
102 <xs:element name="OutFile" type=" FileNameConvention " minOccurs="0"/>
103 <xs:element name="OutputFileExtension" type=" xs:string " minOccurs="0"/>
104 <xs:element name="ToolName" type=" ToolType " minOccurs="0"/>
105 </xs:sequence>
106 <xs:attributeGroup ref=" SectionsAttributes "/>
107 </xs:complexType>
108 </xs:element>
109 <xs:element name="Sections" minOccurs="0" maxOccurs="unbounded">
110 <xs:complexType>
111 <xs:sequence minOccurs="1" maxOccurs="unbounded">
112 <xs:element name="Section">
113 <xs:complexType>
114 <xs:sequence>
115 <xs:element ref=" Filenames " minOccurs="0"/>
116 <xs:element name="Args" type=" ArgsType " minOccurs="0"/>
117 <xs:element name="OutFile" type=" FileNameConvention " minOccurs="0"/>
118 <xs:element name="OutputFileExtension" type=" xs:string " minOccurs="0"/>
119 <xs:element name="ToolName" type=" ToolType " minOccurs="0"/>
120 </xs:sequence>
121 <xs:attributeGroup ref="SectionsAttributes"/>
122 </xs:complexType>
123 </xs:element>
124 </xs:sequence>
125 <xs:attributeGroup ref=" SectionsAttributes "/>
126 </xs:complexType>
127 </xs:element>
128 </xs:sequence>
129 <xs:attributeGroup ref=" SectionsAttributes "/>
130 </xs:complexType>
131 </xs:element>
132 </xs:sequence>
133 <xs:attribute name="FfsKey" type="KeywordType" use="optional"/>
134 </xs:complexType>
135 </xs:element>
136 <xs:element minOccurs="0" maxOccurs="1" name="Sections">
137 <xs:complexType>
138 <xs:sequence minOccurs="1">
139 <xs:element name="Section" minOccurs="0" maxOccurs="unbounded">
140 <xs:complexType>
141 <xs:sequence>
142 <xs:element ref=" Filenames " minOccurs="0"/>
143 <xs:element name="Args" type=" ArgsType " minOccurs="0"/>
144 <xs:element name="OutFile" type=" FileNameConvention " minOccurs="0"/>
145 <xs:element name="OutputFileExtension" type=" xs:string " minOccurs="0"/>
146 <xs:element name="ToolName" type=" ToolType " minOccurs="0"/>
147 </xs:sequence>
148 <xs:attributeGroup ref=" SectionsAttributes "/>
149 </xs:complexType>
150 </xs:element>
151 <xs:element name="Sections" minOccurs="0" maxOccurs="unbounded">
152 <xs:complexType>
153 <xs:sequence minOccurs="1" maxOccurs="unbounded">
154 <xs:element name="Section">
155 <xs:complexType>
156 <xs:sequence>
157 <xs:element ref=" Filenames " minOccurs="0"/>
158 <xs:element name="Args" type=" ArgsType " minOccurs="0"/>
159 <xs:element name="OutFile" type=" FileNameConvention " minOccurs="0"/>
160 <xs:element name="OutputFileExtension" type=" xs:string " minOccurs="0"/>
161 <xs:element name="ToolName" type=" ToolType " minOccurs="0"/>
162 </xs:sequence>
163 <xs:attributeGroup ref=" SectionsAttributes "/>
164 </xs:complexType>
165 </xs:element>
166 </xs:sequence>
167 <xs:attributeGroup ref=" SectionsAttributes "/>
168 </xs:complexType>
169 </xs:element>
170 </xs:sequence>
171 <xs:attributeGroup ref=" SectionsAttributes "/>
172 </xs:complexType>
173 </xs:element>
174 <!-- Remove to Here -->
175 </xs:sequence>
176 </xs:complexType>
177 </xs:element>
178 <xs:element name="Copyright" type="Paragraph"/>
179 <xs:element name="DataHubs">
180 <xs:annotation>
181 <xs:documentation xml:lang="en">This is a list of DataHubRecord elements.</xs:documentation>
182 </xs:annotation>
183 <xs:complexType>
184 <xs:sequence>
185 <xs:element minOccurs="1" maxOccurs="unbounded" name="DataHubRecord">
186 <xs:complexType>
187 <xs:sequence>
188 <xs:element minOccurs="1" maxOccurs="1" name="DataHubCName" type="C_NameType"/>
189 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
190 </xs:sequence>
191 <xs:attributeGroup ref="DataHubAttributes"/>
192 </xs:complexType>
193 </xs:element>
194 </xs:sequence>
195 </xs:complexType>
196 </xs:element>
197 <xs:element name="DefaultValue">
198 <xs:annotation>
199 <xs:documentation xml:lang="en">The default setting of a PCD entry.</xs:documentation>
200 </xs:annotation>
201 <xs:complexType>
202 <xs:simpleContent>
203 <xs:extension base="xs:normalizedString"/>
204 </xs:simpleContent>
205 </xs:complexType>
206 </xs:element>
207 <xs:element name="Description" type="Paragraph">
208 <xs:annotation>
209 <xs:documentation xml:lang="en">This section is required for new modules and libraries and must contain more information than the Abstract.</xs:documentation>
210 </xs:annotation>
211 </xs:element>
212 <xs:element name="DynamicPcdBuildDefinitions">
213 <xs:annotation>
214 <xs:documentation xml:lang="en">Child of Framework Platform Description (FPD)</xs:documentation>
215 <xs:documentation xml:lang="en">FPD uses this PCD information for Dynamic PCDs Only</xs:documentation>
216 </xs:annotation>
217 <xs:complexType>
218 <xs:sequence>
219 <xs:element minOccurs="1" maxOccurs="unbounded" name="PcdBuildData">
220 <xs:complexType>
221 <xs:sequence>
222 <xs:element minOccurs="1" maxOccurs="1" name="C_Name" type="C_NameType"/>
223 <xs:element minOccurs="1" maxOccurs="1" name="Token" type="TokenDataType"/>
224 <xs:element minOccurs="1" maxOccurs="1" name="TokenSpaceGuidCName" type="C_NameType"/>
225 <xs:element minOccurs="1" maxOccurs="1" name="DatumType" type="PcdDataTypes"/>
226 <xs:element minOccurs="0" maxOccurs="1" name="MaxDatumSize" type="DatumSizeLimitation"/>
227 <xs:element minOccurs="1" maxOccurs="unbounded" name="SkuInfo">
228 <xs:complexType>
229 <xs:sequence>
230 <xs:element minOccurs="1" maxOccurs="1" name="SkuId" type="xs:nonNegativeInteger"/>
231 <xs:choice>
232 <xs:group minOccurs="0" maxOccurs="1" ref="HiiEnable"/>
233 <xs:group minOccurs="0" maxOccurs="1" ref="VpdEnable"/>
234 <xs:group minOccurs="0" maxOccurs="1" ref="DefaultGroup"/>
235 </xs:choice>
236 </xs:sequence>
237 </xs:complexType>
238 </xs:element>
239 </xs:sequence>
240 <xs:attributeGroup ref="DynamicBuildPcdAttributes"/>
241 </xs:complexType>
242 </xs:element>
243 </xs:sequence>
244 </xs:complexType>
245 </xs:element>
246 <xs:element name="Events">
247 <xs:annotation>
248 <xs:documentation xml:lang="en">This is a list of MSA Events</xs:documentation>
249 </xs:annotation>
250 <xs:complexType>
251 <xs:sequence>
252 <xs:element minOccurs="0" maxOccurs="1" name="CreateEvents">
253 <xs:complexType>
254 <xs:sequence>
255 <xs:element minOccurs="1" maxOccurs="unbounded" name="EventTypes">
256 <xs:complexType>
257 <xs:sequence>
258 <xs:element minOccurs="1" maxOccurs="1" name="EventType" type="EventTypes"/>
259 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
260 </xs:sequence>
261 <xs:attributeGroup ref="EventAttributes"/>
262 </xs:complexType>
263 </xs:element>
264 </xs:sequence>
265 </xs:complexType>
266 </xs:element>
267 <xs:element minOccurs="0" maxOccurs="1" name="SignalEvents">
268 <xs:annotation>
269 <xs:documentation xml:lang="en">Module has an event that is waiting to be signaled. Event is named by GUID.</xs:documentation>
270 </xs:annotation>
271 <xs:complexType>
272 <xs:sequence>
273 <xs:element minOccurs="1" maxOccurs="unbounded" name="EventTypes">
274 <xs:complexType>
275 <xs:sequence>
276 <xs:element minOccurs="1" maxOccurs="1" name="EventType" type="EventTypes"/>
277 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
278 </xs:sequence>
279 <xs:attributeGroup ref="EventAttributes"/>
280 </xs:complexType>
281 </xs:element>
282 </xs:sequence>
283 </xs:complexType>
284 </xs:element>
285 </xs:sequence>
286 </xs:complexType>
287 </xs:element>
288 <xs:element name="Externs">
289 <xs:annotation>
290 <xs:documentation xml:lang="en">This is a child of MSA files.</xs:documentation>
291 </xs:annotation>
292 <xs:complexType>
293 <xs:sequence minOccurs="1">
294 <xs:element minOccurs="0" maxOccurs="1" name="PcdIsDriver" type="PcdDriverTypes"/>
295 <xs:element minOccurs="0" maxOccurs="unbounded" name="Specification" type="Sentence"/>
296 <xs:element minOccurs="0" maxOccurs="unbounded" name="Extern">
297 <xs:complexType>
298 <xs:choice minOccurs="1">
299 <xs:sequence>
300 <xs:annotation>
301 <xs:documentation xml:lang="en">Driver Module</xs:documentation>
302 </xs:annotation>
303 <xs:element minOccurs="0" maxOccurs="1" name="ModuleEntryPoint" type="C_NameType"/>
304 <xs:element minOccurs="0" maxOccurs="1" name="ModuleUnloadImage" type="C_NameType"/>
305 </xs:sequence>
306 <xs:sequence>
307 <xs:annotation>
308 <xs:documentation xml:lang="en">Library Module</xs:documentation>
309 </xs:annotation>
310 <xs:element minOccurs="0" maxOccurs="1" name="Constructor" type="C_NameType"/>
311 <xs:element minOccurs="0" maxOccurs="1" name="Destructor" type="C_NameType"/>
312 </xs:sequence>
313 <xs:sequence>
314 <xs:annotation>
315 <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>
316 <xs:documentation xml:lang="en">Permit User Defined Extern Tags</xs:documentation>
317 </xs:annotation>
318 <xs:element minOccurs="0" maxOccurs="1" name="DriverBinding" type="C_NameType"/>
319 <xs:element minOccurs="0" maxOccurs="1" name="ComponentName" type="C_NameType"/>
320 <xs:element minOccurs="0" maxOccurs="1" name="DriverConfig" type="C_NameType"/>
321 <xs:element minOccurs="0" maxOccurs="1" name="DriverDiag" type="C_NameType"/>
322 </xs:sequence>
323 <xs:sequence>
324 <xs:annotation>
325 <xs:documentation xml:lang="en"> Module Call Backs</xs:documentation>
326 </xs:annotation>
327 <xs:element minOccurs="0" maxOccurs="1" name="SetVirtualAddressMapCallBack" type="C_NameType"/>
328 <xs:element minOccurs="0" maxOccurs="1" name="ExitBootServicesCallBack" type="C_NameType"/>
329 </xs:sequence>
330 </xs:choice>
331 <xs:attributeGroup ref="ExternAttributes"/>
332 </xs:complexType>
333 </xs:element>
334 </xs:sequence>
335 </xs:complexType>
336 </xs:element>
337 <xs:element name="Filename">
338 <xs:annotation>
339 <xs:documentation xml:lang="en">Describe the valid content of a filename This should extend PathAndFilename - Variable names not allowed here!</xs:documentation>
340 </xs:annotation>
341 <xs:complexType>
342 <xs:simpleContent>
343 <xs:extension base="PathAndFilename">
344 <xs:attributeGroup ref="FilenameAttributes"/>
345 </xs:extension>
346 </xs:simpleContent>
347 </xs:complexType>
348 </xs:element>
349 <xs:element name="Filenames">
350 <xs:annotation>
351 <xs:documentation xml:lang="en">This is a list of Filenames</xs:documentation>
352 </xs:annotation>
353 <xs:complexType>
354 <xs:sequence minOccurs="1">
355 <xs:element minOccurs="0" maxOccurs="unbounded" ref="Filename"/>
356 </xs:sequence>
357 </xs:complexType>
358 </xs:element>
359 <xs:element name="GuidDeclarations">
360 <xs:annotation>
361 <xs:documentation xml:lang="en">This is a child of PackageSurfaceArea (SPD) </xs:documentation>
362 </xs:annotation>
363 <xs:complexType>
364 <xs:sequence>
365 <xs:element minOccurs="1" maxOccurs="unbounded" name="Entry">
366 <xs:complexType>
367 <xs:sequence>
368 <xs:element minOccurs="1" maxOccurs="1" name="C_Name" type="C_NameType"/>
369 <xs:element minOccurs="1" maxOccurs="1" name="GuidValue" type="GuidType"/>
370 <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
371 </xs:sequence>
372 <xs:attributeGroup ref="GuidDeclarationAttributes"/>
373 </xs:complexType>
374 </xs:element>
375 </xs:sequence>
376 </xs:complexType>
377 </xs:element>
378 <xs:element name="Guids">
379 <xs:complexType>
380 <xs:sequence>
381 <xs:element minOccurs="1" maxOccurs="unbounded" name="GuidCNames">
382 <xs:annotation>
383 <xs:documentation xml:lang="en">Describe the valid content of a GUID element in and MSA file.</xs:documentation>
384 </xs:annotation>
385 <xs:complexType>
386 <xs:sequence>
387 <xs:element minOccurs="1" maxOccurs="1" name="GuidCName" type="C_NameType"/>
388 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
389 </xs:sequence>
390 <xs:attributeGroup ref="GuidAttributes"/>
391 </xs:complexType>
392 </xs:element>
393 </xs:sequence>
394 </xs:complexType>
395 </xs:element>
396 <xs:element name="HiiPackages">
397 <xs:annotation>
398 <xs:documentation xml:lang="en">Describe the list of a HiiPackage elements</xs:documentation>
399 </xs:annotation>
400 <xs:complexType>
401 <xs:sequence>
402 <xs:element minOccurs="1" maxOccurs="unbounded" name="HiiPackage">
403 <xs:complexType>
404 <xs:sequence>
405 <xs:element minOccurs="1" maxOccurs="1" name="HiiCName" type="C_NameType"/>
406 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
407 </xs:sequence>
408 <xs:attributeGroup ref="HiiPackageAttributes"/>
409 </xs:complexType>
410 </xs:element>
411 </xs:sequence>
412 </xs:complexType>
413 </xs:element>
414 <xs:element name="Hobs">
415 <xs:complexType>
416 <xs:sequence>
417 <xs:element minOccurs="1" maxOccurs="unbounded" name="HobTypes">
418 <xs:complexType>
419 <xs:sequence>
420 <xs:element minOccurs="1" maxOccurs="1" name="HobType" type="HobTypes"/>
421 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
422 </xs:sequence>
423 <xs:attributeGroup ref="HobAttributes"/>
424 </xs:complexType>
425 </xs:element>
426 </xs:sequence>
427 </xs:complexType>
428 </xs:element>
429 <xs:element name="IncludeHeader">
430 <xs:complexType>
431 <xs:simpleContent>
432 <xs:extension base="PathAndFilename">
433 <xs:attributeGroup ref="IncludeHeaderAttributes"/>
434 </xs:extension>
435 </xs:simpleContent>
436 </xs:complexType>
437 </xs:element>
438 <xs:element name="IndustryStdIncludes">
439 <xs:complexType>
440 <xs:sequence>
441 <xs:element minOccurs="1" maxOccurs="unbounded" ref="IndustryStdHeader"/>
442 </xs:sequence>
443 </xs:complexType>
444 </xs:element>
445 <xs:element name="IndustryStdHeader">
446 <xs:complexType>
447 <xs:sequence>
448 <xs:element minOccurs="1" maxOccurs="1" name="IncludeHeader" type="PathAndFilename"/>
449 <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
450 </xs:sequence>
451 <xs:attributeGroup ref="IndustryStdHeaderAttributes"/>
452 </xs:complexType>
453 </xs:element>
454 <xs:element name="Libraries">
455 <xs:annotation>
456 <xs:documentation xml:lang="en">Different (Module) Instances of Libraries used ONLY in FPD Files.</xs:documentation>
457 </xs:annotation>
458 <xs:complexType>
459 <xs:sequence>
460 <xs:element minOccurs="1" maxOccurs="unbounded" name="Instance">
461 <xs:complexType>
462 <xs:attributeGroup ref="LibraryAttributes"/>
463 </xs:complexType>
464 </xs:element>
465 </xs:sequence>
466 </xs:complexType>
467 </xs:element>
468 <xs:element name="LibraryClass">
469 <xs:annotation>
470 <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>
471 </xs:annotation>
472 <xs:complexType>
473 <xs:sequence>
474 <xs:element minOccurs="1" maxOccurs="1" name="Keyword" type="KeywordType"/>
475 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
476 </xs:sequence>
477 <xs:attributeGroup ref="LibraryClassAttributes"/>
478 </xs:complexType>
479 </xs:element>
480 <!-- LAH This is SPD LibraryClassDeclarations FINAL version -->
481 <xs:element name="LibraryClassDeclarations">
482 <xs:complexType>
483 <xs:sequence>
484 <xs:element minOccurs="1" maxOccurs="unbounded" name="LibraryClass">
485 <xs:complexType>
486 <xs:sequence>
487 <xs:element minOccurs="1" maxOccurs="1" name="IncludeHeader" type="PathAndFilename"/>
488 <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
489 </xs:sequence>
490 <xs:attributeGroup ref="LibraryClassDeclarationAttributes"/>
491 </xs:complexType>
492 </xs:element>
493 </xs:sequence>
494 </xs:complexType>
495 </xs:element>
496 <xs:element name="LibraryClassDefinitions">
497 <xs:annotation>
498 <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>
499 </xs:annotation>
500 <xs:complexType>
501 <xs:sequence>
502 <xs:element minOccurs="1" maxOccurs="unbounded" ref="LibraryClass"/>
503 </xs:sequence>
504 </xs:complexType>
505 </xs:element>
506 <xs:element name="License">
507 <xs:complexType>
508 <xs:simpleContent>
509 <xs:extension base="Paragraph">
510 <xs:attribute name="URL" type="xs:anyURI" use="optional"/>
511 </xs:extension>
512 </xs:simpleContent>
513 </xs:complexType>
514 </xs:element>
515 <xs:element name="ModuleBuildOptions">
516 <xs:complexType>
517 <xs:sequence>
518 <xs:any minOccurs="0" maxOccurs="unbounded" processContents="lax" namespace="##local"/>
519 </xs:sequence>
520 </xs:complexType>
521 </xs:element>
522 <xs:element name="ModuleSaBuildOptions">
523 <xs:complexType>
524 <xs:sequence>
525 <xs:element minOccurs="0" maxOccurs="1" name="FvBinding" type="KeywordType"/>
526 <!-- The FfsFileNameGuid allows the Platform Integrator to specify a GUID for the FFS File Name GUID -->
527 <xs:element minOccurs="0" maxOccurs="1" name="FfsFileNameGuid" type="GuidType"/>
528 <!-- If binding is specified, you MUST specify the FfsFormatKey -->
529 <xs:element minOccurs="0" maxOccurs="1" name="FfsFormatKey" type="KeywordType"/>
530 <xs:element minOccurs="0" maxOccurs="1" ref="Options"/>
531 </xs:sequence>
532 </xs:complexType>
533 </xs:element>
534 <xs:element name="ModuleDefinitions">
535 <xs:complexType>
536 <xs:sequence>
537 <xs:element minOccurs="1" maxOccurs="1" name="SupportedArchitectures" type="ArchListType"/>
538 <xs:element minOccurs="1" maxOccurs="1" name="BinaryModule" type="xs:boolean" default="false"/>
539 <xs:element minOccurs="1" maxOccurs="1" name="OutputFileBasename" type="FileNameConvention"/>
540 <xs:element minOccurs="0" maxOccurs="1" name="ClonedFrom">
541 <xs:complexType>
542 <xs:sequence>
543 <xs:element minOccurs="1" maxOccurs="unbounded" name="Cloned">
544 <xs:complexType>
545 <xs:sequence>
546 <xs:element minOccurs="1" maxOccurs="1" name="PackageGuid" type="GuidType"/>
547 <xs:element minOccurs="1" maxOccurs="1" name="PackageVersion" type="VersionDataType"/>
548 <xs:element minOccurs="1" maxOccurs="1" name="ModuleGuid" type="GuidType"/>
549 <xs:element minOccurs="1" maxOccurs="1" name="ModuleVersion" type="VersionDataType"/>
550 </xs:sequence>
551 <!-- The Id is a number used to track heritage the first entry will be 0 and increment from then on. -->
552 <xs:attribute name="Id" type="xs:nonNegativeInteger" use="optional"/>
553 <!-- If the original module was installed from a FAR, track the FAR it came from. -->
554 <xs:attribute name="FarGuid" type="GuidType" use="optional"/>
555 </xs:complexType>
556 </xs:element>
557 </xs:sequence>
558 </xs:complexType>
559 </xs:element>
560 </xs:sequence>
561 </xs:complexType>
562 </xs:element>
563 <xs:element name="ModuleType" type="ModuleTypeDef">
564 <xs:annotation>
565 <xs:documentation xml:lang="en">Describe the valid EFI Phase that the Module is designed to execute under.</xs:documentation>
566 </xs:annotation>
567 </xs:element>
568 <!-- Use in Final -->
569 <xs:element name="MsaFiles">
570 <xs:annotation>
571 <xs:documentation xml:lang="en">MsaFiles is a child of Surface Area Package Description (SPD) files</xs:documentation>
572 </xs:annotation>
573 <xs:complexType>
574 <xs:sequence>
575 <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename" type="PathAndFilename"/>
576 </xs:sequence>
577 </xs:complexType>
578 </xs:element>
579 <xs:element name="Options">
580 <xs:complexType>
581 <xs:sequence>
582 <xs:element minOccurs="1" maxOccurs="unbounded" ref="Option"/>
583 </xs:sequence>
584 </xs:complexType>
585 </xs:element>
586 <xs:element name="Option">
587 <!-- This element is used to store flags from the Tools -->
588 <xs:complexType>
589 <xs:simpleContent>
590 <xs:extension base="xs:normalizedString">
591 <xs:attributeGroup ref="OptionAttributes"/>
592 </xs:extension>
593 </xs:simpleContent>
594 </xs:complexType>
595 </xs:element>
596 <xs:element name="PackageDefinitions">
597 <xs:complexType>
598 <xs:sequence>
599 <xs:element minOccurs="1" maxOccurs="1" name="ReadOnly" type="xs:boolean" default="false"/>
600 <xs:element minOccurs="1" maxOccurs="1" name="RePackage" type="xs:boolean" default="false"/>
601 <xs:element minOccurs="0" maxOccurs="1" name="ClonedFrom">
602 <xs:complexType>
603 <xs:sequence>
604 <xs:element minOccurs="1" maxOccurs="unbounded" name="Cloned">
605 <xs:complexType>
606 <xs:sequence>
607 <xs:element minOccurs="1" maxOccurs="1" name="PackageGuid" type="GuidType"/>
608 <xs:element minOccurs="1" maxOccurs="1" name="PackageVersion" type="VersionDataType"/>
609 </xs:sequence>
610 <!-- The Id is a number used to track heritage the first entry will be 0 and increment from then on. -->
611 <xs:attribute name="Id" type="xs:nonNegativeInteger" use="optional"/>
612 <!-- If the original Package was installed from a FAR, track the FAR it came from. -->
613 <xs:attribute name="FarGuid" type="GuidType" use="optional"/>
614 </xs:complexType>
615 </xs:element>
616 </xs:sequence>
617 </xs:complexType>
618 </xs:element>
619 </xs:sequence>
620 </xs:complexType>
621 </xs:element>
622 <xs:element name="PackageDependencies">
623 <xs:annotation>
624 <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>
625 <xs:documentation xml:lang="en">Attributes to PackageName include Required: Usage PackageGuid PackageVesion, Optional: FeatureFlag</xs:documentation>
626 </xs:annotation>
627 <xs:complexType>
628 <xs:sequence>
629 <xs:element minOccurs="1" maxOccurs="unbounded" name="Package">
630 <xs:complexType>
631 <xs:attributeGroup ref="PackageAttributes"/>
632 </xs:complexType>
633 </xs:element>
634 </xs:sequence>
635 </xs:complexType>
636 </xs:element>
637 <xs:element name="PackageHeaders">
638 <xs:annotation>
639 <xs:documentation xml:lang="en">PackageHeaders is a child of PackageSurfaceArea (SPD) </xs:documentation>
640 </xs:annotation>
641 <xs:complexType>
642 <xs:sequence>
643 <xs:element minOccurs="1" maxOccurs="unbounded" name="IncludePkgHeader">
644 <xs:complexType>
645 <xs:simpleContent>
646 <xs:extension base="PathAndFilename">
647 <xs:attributeGroup ref="PackageHeaderAttributes"/>
648 </xs:extension>
649 </xs:simpleContent>
650 </xs:complexType>
651 </xs:element>
652 </xs:sequence>
653 </xs:complexType>
654 </xs:element>
655 <xs:element name="PackageList">
656 <!-- Valid for DB usage only! -->
657 <xs:annotation>
658 <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>
659 </xs:annotation>
660 <xs:complexType>
661 <xs:sequence>
662 <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename" type="DbPathAndFilename"/>
663 </xs:sequence>
664 </xs:complexType>
665 </xs:element>
666 <!-- PcdBuildDefinition is a child of FPD ModuleSA element for FIXED_AT_BUILD, PATCHABLE_IN_MODULE, and FEATURE_FLAG PCDS Only! -->
667 <xs:element name="PcdBuildDefinition">
668 <xs:annotation>
669 <xs:documentation xml:lang="en">Child of FPD ModuleSA element for FIXED_AT_BUILD, PATCHABLE_IN_MODULE, and FEATURE_FLAG PCDS Only!</xs:documentation>
670 </xs:annotation>
671 <xs:complexType>
672 <xs:sequence>
673 <xs:element minOccurs="1" maxOccurs="unbounded" name="PcdData">
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="Token" type="TokenDataType"/>
678 <xs:element minOccurs="1" maxOccurs="1" name="TokenSpaceGuidCName" type="C_NameType"/>
679 <xs:element minOccurs="1" maxOccurs="1" name="DatumType" type="PcdDataTypes"/>
680 <!-- MaxDatumSize is only required if the DatumType is VOID* -->
681 <xs:element minOccurs="0" maxOccurs="1" name="MaxDatumSize" type="DatumSizeLimitation"/>
682 <xs:element minOccurs="0" maxOccurs="1" name="Value" type="DefaultValueType"/>
683 </xs:sequence>
684 <xs:attributeGroup ref="PcdBuildDefinitionAttributes"/>
685 </xs:complexType>
686 </xs:element>
687 </xs:sequence>
688 </xs:complexType>
689 </xs:element>
690 <xs:group name="DefaultGroup">
691 <xs:sequence>
692 <xs:element minOccurs="1" maxOccurs="1" name="Value" type="DefaultValueType"/>
693 </xs:sequence>
694 </xs:group>
695 <xs:group name="HiiEnable">
696 <xs:annotation>
697 <xs:documentation xml:lang="en">If HiiEnable group is specified, then HiiEnable is default true</xs:documentation>
698 </xs:annotation>
699 <xs:sequence>
700 <xs:element minOccurs="1" maxOccurs="1" name="VariableName" type="HexWordArrayType"/>
701 <xs:element minOccurs="1" maxOccurs="1" name="VariableGuid" type="C_NameType"/>
702 <xs:element minOccurs="1" maxOccurs="1" name="VariableOffset" type="Hex64BitDataType"/>
703 <xs:element minOccurs="1" maxOccurs="1" name="HiiDefaultValue" type="DefaultValueType"/>
704 </xs:sequence>
705 </xs:group>
706 <xs:group name="VpdEnable">
707 <xs:annotation>
708 <xs:documentation xml:lang="en">If VpdEnable group is specified, then VpdEnable is default true</xs:documentation>
709 </xs:annotation>
710 <xs:sequence>
711 <xs:element minOccurs="1" maxOccurs="1" name="VpdOffset" type="Hex64BitDataType"/>
712 </xs:sequence>
713 </xs:group>
714 <xs:element name="PcdCoded">
715 <xs:annotation>
716 <xs:documentation xml:lang="en">Child of Module Surface Area Description (MSA)</xs:documentation>
717 </xs:annotation>
718 <xs:complexType>
719 <xs:sequence>
720 <xs:element minOccurs="1" maxOccurs="unbounded" name="PcdEntry">
721 <xs:complexType>
722 <xs:sequence>
723 <xs:element minOccurs="1" maxOccurs="1" name="C_Name" type="C_NameType"/>
724 <xs:element minOccurs="1" maxOccurs="1" name="TokenSpaceGuidCName" type="C_NameType"/>
725 <xs:element minOccurs="0" maxOccurs="1" name="DefaultValue" type="DefaultValueType"/>
726 <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
727 </xs:sequence>
728 <!-- 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. -->
729 <xs:attributeGroup ref="PcdCodedAttributes"/>
730 </xs:complexType>
731 </xs:element>
732 </xs:sequence>
733 </xs:complexType>
734 </xs:element>
735 <!-- LAH This is PcdDeclarations FINAL version -->
736 <xs:element name="PcdDeclarations">
737 <xs:annotation>
738 <xs:documentation xml:lang="en">PcdDeclaratins is a child of Package Surface Area Description (SPD)</xs:documentation>
739 </xs:annotation>
740 <xs:complexType>
741 <xs:sequence minOccurs="1">
742 <xs:element maxOccurs="unbounded" name="PcdEntry">
743 <xs:complexType>
744 <xs:sequence>
745 <xs:element minOccurs="1" maxOccurs="1" name="C_Name" type="C_NameType"/>
746 <xs:element minOccurs="1" maxOccurs="1" name="Token" type="TokenDataType"/>
747 <xs:element minOccurs="1" maxOccurs="1" name="TokenSpaceGuidCName" type="C_NameType"/>
748 <xs:element minOccurs="1" maxOccurs="1" name="DatumType" type="PcdDataTypes"/>
749 <xs:element minOccurs="1" maxOccurs="1" name="ValidUsage" type="PcdListType"/>
750 <xs:element minOccurs="0" maxOccurs="1" name="DefaultValue" type="DefaultValueType"/>
751 <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
752 </xs:sequence>
753 <xs:attributeGroup ref="PcdDeclarationAttributes"/>
754 </xs:complexType>
755 </xs:element>
756 </xs:sequence>
757 </xs:complexType>
758 </xs:element>
759 <xs:element name="FarList">
760 <!-- Valid for DB usage only! -->
761 <xs:annotation>
762 <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>
763 </xs:annotation>
764 <xs:complexType>
765 <xs:sequence>
766 <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename" type="DbPathAndFilename"/>
767 </xs:sequence>
768 </xs:complexType>
769 </xs:element>
770 <xs:element name="FfsFormatDeclarations">
771 <xs:complexType>
772 <xs:sequence>
773 <xs:element minOccurs="1" maxOccurs="unbounded" name="FfsFormatDeclaration">
774 <!-- Required Attributes are the FfsFormatKeyword and SupModuleList -->
775 <xs:complexType>
776 <xs:sequence>
777 <xs:element minOccurs="1" maxOccurs="unbounded" ref="ProcessStep"/>
778 </xs:sequence>
779 <xs:attributeGroup ref="FfsAttributes"/>
780 </xs:complexType>
781 </xs:element>
782 </xs:sequence>
783 </xs:complexType>
784 </xs:element>
785 <xs:element name="PpiDeclarations">
786 <xs:annotation>
787 <xs:documentation xml:lang="en">PpiDeclarations is a child of PackageSurfaceArea (SPD) </xs:documentation>
788 </xs:annotation>
789 <xs:complexType>
790 <xs:sequence>
791 <xs:element minOccurs="1" maxOccurs="unbounded" name="Entry">
792 <xs:complexType>
793 <xs:sequence>
794 <xs:element minOccurs="1" maxOccurs="1" name="C_Name" type="C_NameType"/>
795 <xs:element minOccurs="1" maxOccurs="1" name="GuidValue" type="GuidType"/>
796 <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
797 </xs:sequence>
798 <xs:attributeGroup ref="PpiDeclarationAttributes"/>
799 </xs:complexType>
800 </xs:element>
801 </xs:sequence>
802 </xs:complexType>
803 </xs:element>
804 <xs:element name="PPIs">
805 <xs:annotation>
806 <xs:documentation xml:lang="en">Provide for one or more Ppi or PpiNotify sections. </xs:documentation>
807 </xs:annotation>
808 <xs:complexType>
809 <xs:sequence minOccurs="1">
810 <xs:element minOccurs="0" maxOccurs="unbounded" name="Ppi">
811 <xs:complexType>
812 <xs:sequence>
813 <xs:element minOccurs="1" maxOccurs="1" name="PpiCName" type="C_NameType"/>
814 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
815 </xs:sequence>
816 <xs:attributeGroup ref="PpiAttributes"/>
817 </xs:complexType>
818 </xs:element>
819 <xs:element minOccurs="0" maxOccurs="unbounded" name="PpiNotify">
820 <xs:complexType>
821 <xs:sequence>
822 <xs:element minOccurs="1" maxOccurs="1" name="PpiNotifyCName" type="C_NameType"/>
823 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
824 </xs:sequence>
825 <xs:attributeGroup ref="PpiNotifyAttributes"/>
826 </xs:complexType>
827 </xs:element>
828 </xs:sequence>
829 </xs:complexType>
830 </xs:element>
831 <xs:element name="ProtocolDeclarations">
832 <xs:annotation>
833 <xs:documentation xml:lang="en">ProtocolDeclarations is a child of PackageSurfaceArea (SPD) </xs:documentation>
834 </xs:annotation>
835 <xs:complexType>
836 <xs:sequence>
837 <xs:element minOccurs="1" maxOccurs="unbounded" name="Entry">
838 <xs:complexType>
839 <xs:sequence>
840 <xs:element minOccurs="1" maxOccurs="1" name="C_Name" type="C_NameType"/>
841 <xs:element minOccurs="1" maxOccurs="1" name="GuidValue" type="GuidType"/>
842 <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
843 </xs:sequence>
844 <xs:attributeGroup ref="ProtocolDeclarationAttributes"/>
845 </xs:complexType>
846 </xs:element>
847 </xs:sequence>
848 </xs:complexType>
849 </xs:element>
850 <xs:element name="Protocols">
851 <xs:annotation>
852 <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>
853 </xs:annotation>
854 <xs:complexType>
855 <xs:sequence>
856 <xs:element minOccurs="0" maxOccurs="unbounded" name="Protocol">
857 <xs:complexType>
858 <xs:sequence>
859 <xs:element minOccurs="1" maxOccurs="1" name="ProtocolCName" type="C_NameType"/>
860 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
861 </xs:sequence>
862 <xs:attributeGroup ref="ProtocolAttributes"/>
863 </xs:complexType>
864 </xs:element>
865 <xs:element minOccurs="0" maxOccurs="unbounded" name="ProtocolNotify">
866 <xs:complexType>
867 <xs:sequence>
868 <xs:element minOccurs="1" maxOccurs="1" name="ProtocolNotifyCName" type="C_NameType"/>
869 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
870 </xs:sequence>
871 <xs:attributeGroup ref="ProtocolNotifyAttributes"/>
872 </xs:complexType>
873 </xs:element>
874 </xs:sequence>
875 </xs:complexType>
876 </xs:element>
877 <xs:element name="ProcessStep">
878 <xs:complexType>
879 <xs:sequence>
880 <xs:element minOccurs="1" maxOccurs="1" name="ToolName" type="xs:string"/>
881 <xs:element minOccurs="0" maxOccurs="1" name="ToolArgs" type="xs:string"/>
882 <!-- Input patterns to be processed by the tool above -->
883 <xs:element minOccurs="0" maxOccurs="1" name="InputPattern" type="xs:string"/>
884 <!-- A pattern to match for the output -->
885 <xs:element minOccurs="1" maxOccurs="1" name="OutputPattern" type="xs:string"/>
886 </xs:sequence>
887 <xs:attributeGroup ref="ProcessStepAttributes"/>
888 </xs:complexType>
889 </xs:element>
890 <xs:element name="SourceFiles">
891 <xs:annotation>
892 <xs:documentation xml:lang="en">Multiple Filenames may be specified, and they may also be scoped to a specific Architecture.</xs:documentation>
893 </xs:annotation>
894 <xs:complexType>
895 <xs:sequence>
896 <xs:element minOccurs="1" maxOccurs="unbounded" ref="Filename"/>
897 </xs:sequence>
898 </xs:complexType>
899 </xs:element>
900 <xs:element name="SkuInfo">
901 <xs:complexType>
902 <xs:sequence>
903 <xs:element minOccurs="1" maxOccurs="unbounded" name="UiSkuName">
904 <xs:complexType>
905 <xs:simpleContent>
906 <xs:extension base="UiNameType">
907 <xs:attribute name="SkuID" type="xs:nonNegativeInteger" use="required"/>
908 </xs:extension>
909 </xs:simpleContent>
910 </xs:complexType>
911 </xs:element>
912 </xs:sequence>
913 </xs:complexType>
914 </xs:element>
915 <xs:element name="SystemTables">
916 <xs:annotation>
917 <xs:documentation xml:lang="en">This is list of System Table elements.</xs:documentation>
918 </xs:annotation>
919 <xs:complexType>
920 <xs:sequence>
921 <xs:element minOccurs="1" maxOccurs="unbounded" name="SystemTableCNames">
922 <xs:complexType>
923 <xs:sequence>
924 <xs:element minOccurs="1" maxOccurs="1" name="SystemTableCName" type="C_NameType"/>
925 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
926 </xs:sequence>
927 <xs:attributeGroup ref="SystemTableAttributes"/>
928 </xs:complexType>
929 </xs:element>
930 </xs:sequence>
931 </xs:complexType>
932 </xs:element>
933 <xs:element name="UserDefinedAntTasks">
934 <xs:annotation>
935 <xs:documentation xml:lang="en">This is a sub-element of BuildOptions</xs:documentation>
936 <xs:documentation xml:lang="en">Permit Users to define their own custom ANT tasks.</xs:documentation>
937 </xs:annotation>
938 <xs:complexType>
939 <xs:sequence>
940 <xs:element minOccurs="1" maxOccurs="unbounded" ref="AntTask"/>
941 </xs:sequence>
942 </xs:complexType>
943 </xs:element>
944 <xs:element name="UserExtensions">
945 <xs:complexType>
946 <xs:sequence>
947 <xs:any minOccurs="0" maxOccurs="unbounded" processContents="lax" namespace="##local"/>
948 </xs:sequence>
949 <xs:attribute name="UserID" type="xs:NCName" use="required"/>
950 <xs:attribute name="Identifier" type="xs:nonNegativeInteger" use="required"/>
951 </xs:complexType>
952 </xs:element>
953 <xs:element name="Variables">
954 <xs:annotation>
955 <xs:documentation xml:lang="en">An MSA FILE list of EFI Variables described by string pair.</xs:documentation>
956 </xs:annotation>
957 <xs:complexType>
958 <xs:sequence>
959 <xs:element minOccurs="1" maxOccurs="unbounded" name="Variable">
960 <xs:annotation>
961 <xs:documentation xml:lang="en">This is an EFI Variable Entry</xs:documentation>
962 </xs:annotation>
963 <xs:complexType>
964 <xs:sequence>
965 <xs:element minOccurs="1" maxOccurs="1" name="VariableName" type="HexWordArrayType"/>
966 <xs:element minOccurs="1" maxOccurs="1" name="GuidC_Name" type="C_NameType"/>
967 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
968 </xs:sequence>
969 <xs:attributeGroup ref="VariableAttributes"/>
970 </xs:complexType>
971 </xs:element>
972 </xs:sequence>
973 </xs:complexType>
974 </xs:element>
975 <xs:element name="Version" type="VersionDataType"/>
976 </xs:schema>