VirtualBox

source: vbox/trunk/src/VBox/Devices/EFI/Firmware/BaseTools/Conf/XMLSchema/DistributionPackage.xsd

最後變更 在這個檔案是 80721,由 vboxsync 提交於 5 年 前

Devices/EFI/FirmwareNew: Start upgrade process to edk2-stable201908 (compiles on Windows and works to some extent), bugref:4643

  • 屬性 svn:eol-style 設為 native
檔案大小: 155.0 KB
 
1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3Filename: DistributionPackage.xsd
4
5Copyright (c) 2008 - 2012, Intel Corporation. All rights reserved.
6
7SPDX-License-Identifier: BSD-2-Clause-Patent
8
9-->
10<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified"
11 targetNamespace="http://www.uefi.org/2012/1.0" xmlns="http://www.uefi.org/2012/1.0">
12 <xs:element name="DistributionPackage">
13 <xs:annotation>
14 <xs:documentation xml:lang="en-us">
15 This schema defines the UEFI/PI Distribution Package description (PKG)
16 file. It describes the content of:
17 </xs:documentation>
18 <xs:documentation xml:lang="en-us"> 1) Package descriptions with definitions and headers.</xs:documentation>
19 <xs:documentation xml:lang="en-us">
20 2) Modules in either source or binary format. (Note that Binary format
21 is for FFS leaf section file types only, complete FFS files cannot be distributed using this
22 distribution format.)
23 </xs:documentation>
24 <xs:documentation xml:lang="en-us">
25 3) The distribution of custom tools used to modify the binary images to
26 create UEFI/PI compliant images.
27 </xs:documentation>
28 <xs:documentation xml:lang="en-us">
29 4) Finally, it can be used to distribute other miscellaneous content
30 that is not specific to UEFI/PI images.
31 </xs:documentation>
32 <xs:documentation xml:lang="en-us">
33 The Package Surface Area describes the content of packages, while the
34 Module Surface Area provides information relevant to source and/or binary distributions.
35 </xs:documentation>
36 </xs:annotation>
37 <xs:complexType>
38 <xs:sequence>
39 <xs:element ref="DistributionHeader" minOccurs="1" maxOccurs="1">
40 <xs:annotation>
41 <xs:documentation xml:lang="en-us">
42 This header contains (legal) information usually required
43 for distributing both binary and/or source code.
44 </xs:documentation>
45 </xs:annotation>
46 </xs:element>
47 <xs:element ref="PackageSurfaceArea" minOccurs="0" maxOccurs="unbounded">
48 <xs:annotation>
49 <xs:documentation xml:lang="en-us"> The list of packages in this distribution. </xs:documentation>
50 <xs:documentation xml:lang="en-us">
51 Packages are groups of files and/or modules that are similar
52 in nature.
53 </xs:documentation>
54 <xs:documentation xml:lang="en-us">
55 Packages are uniquely identified by a package GUID and a
56 package version.
57 </xs:documentation>
58 <xs:documentation xml:lang="en-us">
59 A package can declare public mappings of C names to GUID
60 values.
61 </xs:documentation>
62 <xs:documentation xml:lang="en-us">
63 A package can provide header files for library classes
64 and/or other industry standard definitions.
65 </xs:documentation>
66 <xs:documentation xml:lang="en-us">
67 A package can also declare public mappings of platform
68 configuration database (PCD) &quot;knobs&quot; to control features and operation of modules
69 within a platform.
70 </xs:documentation>
71 <xs:documentation xml:lang="en-us">
72 Finally, a package lists the library instances and/or
73 modules that are provided in a distribution package.
74 </xs:documentation>
75 </xs:annotation>
76 </xs:element>
77 <xs:element ref="ModuleSurfaceArea" minOccurs="0" maxOccurs="unbounded">
78 <xs:annotation>
79 <xs:documentation xml:lang="en-us">
80 The listing of UEFI/PI compliant modules in this
81 distribution that are NOT part of a Package. Every module that is provided as part of a
82 package needs to be described in a PackageSurfaceArea.Modules section.
83 </xs:documentation>
84 <xs:documentation xml:lang="en-us">
85 The ModuleSurfaceArea section describes how each module in a
86 distribution is coded, or, in the case of a binary module distribution, how it was built.
87 </xs:documentation>
88 <xs:documentation xml:lang="en-us">
89 UEFI/PI compliant libraries and modules are uniquely
90 identified by the Module's GUID and version number.
91 </xs:documentation>
92 <xs:documentation xml:lang="en-us">
93 This section will typically be used for modules that don't
94 require any additional files that would be included in a package. For example, the Enhanced
95 FAT driver binary does not need to have a package description, as no additional files are
96 provided.
97 </xs:documentation>
98 </xs:annotation>
99 </xs:element>
100 <xs:element ref="Tools" minOccurs="0" maxOccurs="unbounded">
101 <xs:annotation>
102 <xs:documentation xml:lang="en-us">
103 This section is for distributing vendor specific executable
104 tools, tool source code and/or configuration files. These tools are primarily for
105 manipulating code and/or binary images.
106 </xs:documentation>
107 <xs:documentation xml:lang="en-us"> Tools in this section can:</xs:documentation>
108 <xs:documentation xml:lang="en-us">
109 1) Parse build meta-data files to create source code files
110 and build scripts.
111 </xs:documentation>
112 <xs:documentation xml:lang="en-us"> 2) Modify image files to conform to UEFI/PI specifications. </xs:documentation>
113 <xs:documentation xml:lang="en-us">
114 3) Generate binary files from certain types of text/unicode
115 files.
116 </xs:documentation>
117 <xs:documentation xml:lang="en-us"> 4) Generate PCI Option Roms or Firmware Device images. </xs:documentation>
118 <xs:documentation xml:lang="en-us">
119 5) Implement external encoding/decoding/signature/GUIDed
120 tools.
121 </xs:documentation>
122 <xs:documentation xml:lang="en-us">
123 6) Distribution Package create/install/remove tools.
124 </xs:documentation>
125 </xs:annotation>
126 </xs:element>
127 <xs:element ref="MiscellaneousFiles" minOccurs="0" maxOccurs="unbounded">
128 <xs:annotation>
129 <xs:documentation xml:lang="en-us">
130 The list of miscellaneous files in this distribution. Any
131 files that are not listed in either the Package, Module or Tools sections can be listed
132 here. This section can be used to distribute specifications for packages and modules that
133 are not &quot;industry standards&quot; such as a specification for a chipset or a video
134 device.
135 </xs:documentation>
136 </xs:annotation>
137 </xs:element>
138 <xs:element ref="UserExtensions" minOccurs="0" maxOccurs="unbounded">
139 <xs:annotation>
140 <xs:documentation xml:lang="en-us">
141 The UserExtensions section is used to disseminate processing
142 instructions that may be custom to the content provided by the distribution. This section
143 contains information that is common to all aspects of this distribution.
144 </xs:documentation>
145 </xs:annotation>
146 </xs:element>
147 </xs:sequence>
148
149 </xs:complexType>
150 </xs:element>
151 <!-- End of the DistributionPackage Description -->
152
153 <xs:element name="DistributionHeader">
154 <xs:annotation>
155 <xs:documentation xml:lang="en-us">
156 This section defines the content of the UEIF/PI compliant Distribution
157 Package Header. This is the only required element of a UEFI/PI compliant distribution package.
158 </xs:documentation>
159 </xs:annotation>
160 <xs:complexType>
161 <xs:sequence>
162 <xs:element minOccurs="1" maxOccurs="1" name="Name">
163 <xs:annotation>
164 <xs:documentation xml:lang="en-us">
165 This is the User Interface Name for this Distribution
166 Package.
167 </xs:documentation>
168 <xs:documentation xml:lang="en-us">
169 Each Distribution Package is uniquely identified by its
170 GUID and Version number.
171 </xs:documentation>
172 </xs:annotation>
173 <xs:complexType>
174 <xs:simpleContent>
175 <xs:extension base="xs:normalizedString">
176 <xs:attribute name="BaseName" type="xs:NMTOKEN" use="optional">
177 <xs:annotation>
178 <xs:documentation xml:lang="en-us">
179 The reference name of the Distribution
180 Package file. This single word name can be used by tools as a keyword or for
181 directory and/or file creation.
182 </xs:documentation>
183 <xs:documentation xml:lang="en-us">
184 White space and special characters (dash and
185 underscore characters may be used) are not permitted in this name.
186 </xs:documentation>
187 </xs:annotation>
188 </xs:attribute>
189 </xs:extension>
190 </xs:simpleContent>
191 </xs:complexType>
192 </xs:element>
193 <xs:element minOccurs="1" maxOccurs="1" name="GUID">
194 <xs:annotation>
195 <xs:documentation xml:lang="en-us">
196 This 128-bit GUID and the Version attribute uniquely
197 identify this Distribution Package.
198 </xs:documentation>
199 <xs:documentation xml:lang="en-us">
200 Backward compatible releases of a distribution package need
201 only change the version number, while non-backward compatible changes require the GUID to
202 change (resetting the version number to 1.0 is optional.)
203 </xs:documentation>
204 </xs:annotation>
205 <xs:complexType>
206 <xs:simpleContent>
207 <xs:extension base="RegistryFormatGuid">
208 <xs:attribute name="Version" type="xs:decimal" use="required">
209 <xs:annotation>
210 <xs:documentation xml:lang="en-us">
211 This value, along with the GUID, is used to
212 uniquely identify this object. The higher the number, the more recent the
213 content.
214 </xs:documentation>
215 </xs:annotation>
216 </xs:attribute>
217 </xs:extension>
218 </xs:simpleContent>
219 </xs:complexType>
220 </xs:element>
221 <xs:element minOccurs="1" maxOccurs="1" name="Vendor" type="xs:normalizedString">
222 <xs:annotation>
223 <xs:documentation xml:lang="en-us">
224 A string identifying who created this distribution package.
225 </xs:documentation>
226 </xs:annotation>
227 </xs:element>
228 <xs:element minOccurs="1" maxOccurs="1" name="Date" type="xs:dateTime">
229 <xs:annotation>
230 <xs:documentation xml:lang="en-us">
231 The date and time this distribution was created. The format
232 is: YYYY-MM-DDThh:mm:ss, for example: 2001-01-31T13:30:00 (note the T character separator
233 between the calendar date and the time.
234 </xs:documentation>
235 </xs:annotation>
236 </xs:element>
237 <xs:element minOccurs="1" maxOccurs="unbounded" name="Copyright">
238 <xs:annotation>
239 <xs:documentation xml:lang="en-us">
240 The copyright for this file that is generated by the creator
241 of the distribution. If a derivative work is generated from an existing distribution, then
242 the existing copyright must be maintained, and additional copyrights may be appended to the
243 end of this element. It may also be the primary copyright for all code provided in the
244 Distribution Package.
245 </xs:documentation>
246 </xs:annotation>
247 <xs:complexType>
248 <xs:simpleContent>
249 <xs:extension base="xs:string">
250 <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"/>
251 </xs:extension>
252 </xs:simpleContent>
253 </xs:complexType>
254
255 </xs:element>
256 <xs:element minOccurs="1" maxOccurs="unbounded" name="License">
257 <xs:annotation>
258 <xs:documentation xml:lang="en-us">
259 A license that describes any restrictions on the use of this
260 distribution. If a derivative work is allowed by the original license and a derivative work
261 is generated from an existing distribution, then the existing license must be maintained,
262 and additional licenses may be appended to the end of this element. It may also be the
263 primary license for all code provided in the distribution file. Alternatively, this may
264 point to a filename that contains the License. The file (included in the content zip file)
265 will be stored in the same location as the distribution package's .pkg file.
266 </xs:documentation>
267 </xs:annotation>
268 <xs:complexType>
269 <xs:simpleContent>
270 <xs:extension base="xs:string">
271 <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"/>
272 </xs:extension>
273 </xs:simpleContent>
274 </xs:complexType>
275 </xs:element>
276 <xs:element minOccurs="1" maxOccurs="unbounded" name="Abstract">
277 <xs:annotation>
278 <xs:documentation xml:lang="en-us">
279 A one line description of the Distribution Package.
280 </xs:documentation>
281 </xs:annotation>
282 <xs:complexType>
283 <xs:simpleContent>
284 <xs:extension base="xs:normalizedString">
285 <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"/>
286 </xs:extension>
287 </xs:simpleContent>
288 </xs:complexType>
289 </xs:element>
290 <xs:element minOccurs="0" maxOccurs="unbounded" name="Description">
291 <xs:annotation>
292 <xs:documentation xml:lang="en-us">
293 A complete description of the Distribution Package. This
294 description may include the release name of the file, the version of the file, and a
295 complete description of the file contents and/or features including a description of the
296 updates since the previous file release.
297 </xs:documentation>
298 </xs:annotation>
299 <xs:complexType>
300 <xs:simpleContent>
301 <xs:extension base="xs:string">
302 <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"/>
303 </xs:extension>
304 </xs:simpleContent>
305 </xs:complexType>
306 </xs:element>
307 <xs:element minOccurs="0" maxOccurs="1" name="Signature" type="Md5Sum">
308 <xs:annotation>
309 <xs:documentation xml:lang="en-us">
310 The packaging utilities will use this MD5 sum value of the
311 included ZIP file containing files and/or code. If this element is not present, then
312 installation tools should assume that the content is correct, or that other methods may be
313 needed to verify content.
314 </xs:documentation>
315 </xs:annotation>
316 </xs:element>
317 <xs:element minOccurs="1" maxOccurs="1" name="XmlSpecification" type="xs:decimal" default="1.1">
318 <xs:annotation>
319 <xs:documentation xml:lang="en-us"> This version of this XML Schema is 1.1 </xs:documentation>
320 <xs:documentation xml:lang="en-us"> Changes to 1.1 from 1.0 </xs:documentation>
321 <xs:documentation xml:lang="en-us">
322 #1 Updated to present date and new version which is
323 important to reflect the present state of the matter
324 </xs:documentation>
325 <xs:documentation xml:lang="en-us">
326 #2 Added definition/enumeration of UNDEFINED type 2 is
327 important since there is a large body of legacy code for which the GUID’s and other
328 code/data objects were not decorated with their usage. This document will allow for
329 importing today’s source artifacts and producing decorations using the ‘Undefined’ versus
330 having an error
331 </xs:documentation>
332 <xs:documentation xml:lang="en-us">
333 #3 Allow for inclusion of ARM and future architecture
334 types
335 </xs:documentation>
336 </xs:annotation>
337 </xs:element>
338 </xs:sequence>
339 <xs:attribute name="ReadOnly" type="xs:boolean" default="false" use="optional">
340 <xs:annotation>
341 <xs:documentation xml:lang="en-us">
342 If set to true, all content within this Distribution Package
343 should NOT be modified. The default permits modification of all content.
344 </xs:documentation>
345 </xs:annotation>
346 </xs:attribute>
347 <xs:attribute name="RePackage" type="xs:boolean" default="false" use="optional">
348 <xs:annotation>
349 <xs:documentation xml:lang="en-us">
350 If set to true, then the content can be repackaged into another
351 distribution package. The default prohibits repackaging the Distribution content.
352 </xs:documentation>
353 </xs:annotation>
354 </xs:attribute>
355 </xs:complexType>
356 </xs:element>
357 <!-- End of the DistributionHeader element. -->
358
359 <xs:element name="PackageSurfaceArea">
360 <xs:annotation>
361 <xs:documentation xml:lang="en-us">
362 A package is a collection of related objects - Includes, Libraries and
363 Modules.
364 </xs:documentation>
365 <xs:documentation xml:lang="en-us">
366 Each package is uniquely identified by its GUID and Version number.
367 Backward compatible releases of a package need only change the version number, while non-backward
368 compatible changes require the GUID to change (resetting the version number to 1.0 is optional.)
369 </xs:documentation>
370 </xs:annotation>
371 <xs:complexType>
372 <xs:sequence>
373
374 <xs:element minOccurs="1" maxOccurs="1" name="Header">
375 <xs:complexType>
376 <xs:sequence>
377 <xs:element minOccurs="1" maxOccurs="1" name="Name">
378 <xs:annotation>
379 <xs:documentation xml:lang="en-us">
380 This is the User Interface Name for this
381 package.
382 </xs:documentation>
383 </xs:annotation>
384 <xs:complexType>
385 <xs:simpleContent>
386 <xs:extension base="xs:normalizedString">
387 <xs:attribute name="BaseName" type="xs:NMTOKEN" use="required">
388 <xs:annotation>
389 <xs:documentation xml:lang="en-us">
390 This is a single word BaseName
391 of the package. This BaseName can be used by tools as a keyword
392 and for directory/file creation.
393 </xs:documentation>
394 </xs:annotation>
395 </xs:attribute>
396 </xs:extension>
397 </xs:simpleContent>
398 </xs:complexType>
399 </xs:element>
400 <xs:element minOccurs="1" maxOccurs="1" name="GUID">
401 <xs:annotation>
402 <xs:documentation xml:lang="en-us">
403 This GUID and the Version attribute uniquely
404 identify a given package.
405 </xs:documentation>
406 </xs:annotation>
407 <xs:complexType>
408 <xs:simpleContent>
409 <xs:extension base="RegistryFormatGuid">
410 <xs:attribute name="Version" type="xs:decimal" use="required">
411 <xs:annotation>
412 <xs:documentation xml:lang="en-us">
413 This value, along with the GUID,
414 is used to uniquely identify this object.
415 </xs:documentation>
416 <xs:documentation xml:lang="en-us">
417 Backward compatible changes must
418 make sure this number is incremented from the most recent
419 version. Non-backward compatible changes require a new GUID, and
420 the version can be reset.
421 </xs:documentation>
422 </xs:annotation>
423 </xs:attribute>
424 </xs:extension>
425 </xs:simpleContent>
426 </xs:complexType>
427 </xs:element>
428 <xs:element minOccurs="0" maxOccurs="unbounded" name="Copyright">
429 <xs:annotation>
430 <xs:documentation xml:lang="en-us">
431 If the package requires a different copyright
432 than the distribution package, this element can list one or more copyright
433 lines.
434 </xs:documentation>
435 </xs:annotation>
436 <xs:complexType>
437 <xs:simpleContent>
438 <xs:extension base="xs:string">
439 <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"
440 />
441 </xs:extension>
442 </xs:simpleContent>
443 </xs:complexType>
444
445 </xs:element>
446 <xs:element minOccurs="0" maxOccurs="unbounded" name="License">
447 <xs:annotation>
448 <xs:documentation xml:lang="en-us">
449 If the package requires licenses that are
450 different from the distribution package license, this element can contain one or
451 more license text paragraphs (or license filenames.)
452 </xs:documentation>
453 </xs:annotation>
454 <xs:complexType>
455 <xs:simpleContent>
456 <xs:extension base="xs:string">
457 <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"
458 />
459 </xs:extension>
460 </xs:simpleContent>
461 </xs:complexType>
462
463 </xs:element>
464 <xs:element minOccurs="0" maxOccurs="unbounded" name="Abstract">
465 <xs:annotation>
466 <xs:documentation xml:lang="en-us">
467 A one line description of this package.
468 </xs:documentation>
469 </xs:annotation>
470 <xs:complexType>
471 <xs:simpleContent>
472 <xs:extension base="xs:normalizedString">
473 <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"
474 />
475 </xs:extension>
476 </xs:simpleContent>
477 </xs:complexType>
478 </xs:element>
479 <xs:element minOccurs="0" maxOccurs="unbounded" name="Description">
480 <xs:annotation>
481 <xs:documentation xml:lang="en-us">
482 A complete description of a package. This
483 description may include the release name of the package, the version of the
484 package, and a complete description of the package contents and/or features
485 including a description of the updates since the previous package’s release.
486 </xs:documentation>
487 </xs:annotation>
488 <xs:complexType>
489 <xs:simpleContent>
490 <xs:extension base="xs:string">
491 <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"
492 />
493 </xs:extension>
494 </xs:simpleContent>
495 </xs:complexType>
496 </xs:element>
497 <xs:element minOccurs="1" maxOccurs="1" name="PackagePath" type="xs:anyURI">
498 <xs:annotation>
499 <xs:documentation xml:lang="en-us">
500 This element is the location (in the ZIP file)
501 for the root directory of a package.
502 </xs:documentation>
503 </xs:annotation>
504 </xs:element>
505 </xs:sequence>
506 </xs:complexType>
507 </xs:element>
508 <!-- End of PackageSurfaceArea Header element. -->
509
510 <xs:element minOccurs="0" maxOccurs="1" name="ClonedFrom">
511 <xs:annotation>
512 <xs:documentation xml:lang="en-us">
513 The term cloned is used here to indicate that this package
514 as been copied and modified to a completely different package. An example might be for a new
515 generation of chipsets that have few or no elements in common with the original.
516 </xs:documentation>
517 </xs:annotation>
518 <xs:complexType>
519 <xs:sequence>
520 <xs:element minOccurs="1" maxOccurs="1" name="GUID">
521 <xs:annotation>
522 <xs:documentation xml:lang="en-us">
523 This GUID and the Version attribute uniquely
524 identify the Package that this Package was copied from.
525 </xs:documentation>
526 </xs:annotation>
527 <xs:complexType>
528 <xs:simpleContent>
529 <xs:extension base="RegistryFormatGuid">
530 <xs:attribute name="Version" type="xs:decimal" use="required">
531 <xs:annotation>
532 <xs:documentation xml:lang="en-us">
533 This value, along with the GUID,
534 is used to uniquely identify the package that this package was
535 cloned from.
536 </xs:documentation>
537 </xs:annotation>
538 </xs:attribute>
539 </xs:extension>
540 </xs:simpleContent>
541 </xs:complexType>
542 </xs:element>
543 </xs:sequence>
544 </xs:complexType>
545 </xs:element>
546 <!-- End of PackageSurfaceArea ClonedFrom element. -->
547
548 <xs:element minOccurs="0" maxOccurs="1" name="LibraryClassDeclarations">
549 <xs:annotation>
550 <xs:documentation xml:lang="en-us">
551 Library Classes are public interfaces that can be used by
552 modules. One or more library instances can implement a library class, however only one
553 library instance can be linked to an individual module. This provides the platform
554 integrator with the flexibility of choosing one library instance's implementation over a
555 different library instance.
556 </xs:documentation>
557 </xs:annotation>
558 <xs:complexType>
559 <xs:sequence>
560 <xs:element minOccurs="1" maxOccurs="unbounded" name="LibraryClass">
561 <xs:complexType>
562 <xs:sequence>
563 <xs:element minOccurs="1" maxOccurs="1" name="HeaderFile" type="xs:anyURI">
564 <xs:annotation>
565 <xs:documentation xml:lang="en-us">
566 The header file provides definitions
567 and function prototypes for a library class. Modules can be coded
568 against these functions, using the definitions in this header,
569 without concerning themselves about the libraries' implementation
570 details. This is a PackagePath relative path and filename for the
571 include file.
572 </xs:documentation>
573 </xs:annotation>
574 </xs:element>
575 <xs:element minOccurs="0" maxOccurs="1" name="RecommendedInstance">
576 <xs:complexType>
577 <xs:sequence>
578 <xs:element minOccurs="1" maxOccurs="1" name="GUID">
579 <xs:annotation>
580 <xs:documentation xml:lang="en-us">
581 This GUID and the
582 Version attribute uniquely identify the Recommended Library
583 Instance.
584 </xs:documentation>
585 </xs:annotation>
586 <xs:complexType>
587 <xs:simpleContent>
588 <xs:extension base="RegistryFormatGuid">
589 <xs:attribute name="Version" type="xs:decimal"
590 use="optional">
591 <xs:annotation>
592 <xs:documentation xml:lang="en-us">
593 This value, along with
594 the GUID, is used to uniquely identify this object. If this
595 value is not specified, then any version of the library
596 instance is recommended.
597 </xs:documentation>
598 </xs:annotation>
599 </xs:attribute>
600 </xs:extension>
601 </xs:simpleContent>
602 </xs:complexType>
603 </xs:element>
604 </xs:sequence>
605 </xs:complexType>
606 </xs:element>
607 <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>
608 </xs:sequence>
609 <xs:attribute name="Keyword" type="xs:NCName" use="required">
610 <xs:annotation>
611 <xs:documentation xml:lang="en-us">
612 The single word name of the Library
613 Class that module developers will use to identify a library class
614 dependency.
615 </xs:documentation>
616 </xs:annotation>
617 </xs:attribute>
618 <xs:attributeGroup ref="SupportedArchMod"/>
619 </xs:complexType>
620 </xs:element>
621 </xs:sequence>
622 </xs:complexType>
623 </xs:element>
624 <!-- End of PackageSurfaceArea LibraryClassDeclarations element. -->
625
626 <xs:element minOccurs="0" maxOccurs="1" name="IndustryStandardIncludes">
627 <xs:annotation>
628 <xs:documentation xml:lang="en-us">
629 This section is used to list header files for industry
630 standards not under the auspices of UEFI.org. For example, headers that contain definitions
631 and data structures for the USB specifications.
632 </xs:documentation>
633 </xs:annotation>
634 <xs:complexType>
635 <xs:sequence>
636 <xs:element minOccurs="1" maxOccurs="unbounded" name="IndustryStandardHeader">
637 <xs:complexType>
638 <xs:sequence>
639 <xs:element minOccurs="1" maxOccurs="1" name="HeaderFile" type="xs:anyURI">
640 <xs:annotation>
641 <xs:documentation xml:lang="en-us">
642 The package relative path and
643 filename (in the content zip file) of the industry standard include
644 file.
645 </xs:documentation>
646 </xs:annotation>
647 </xs:element>
648 <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>
649 </xs:sequence>
650 </xs:complexType>
651 </xs:element>
652 </xs:sequence>
653 </xs:complexType>
654 </xs:element>
655 <!-- End of PackageSurfaceArea IndustryStdIncludes element. -->
656
657 <xs:element minOccurs="0" maxOccurs="1" name="PackageIncludes">
658 <xs:annotation>
659 <xs:documentation xml:lang="en-us">
660 All top level header files that are included by a package
661 that are not listed above. They cannot be:
662 </xs:documentation>
663 <xs:documentation xml:lang="en-us"> 1) Local to a module (module specific.) </xs:documentation>
664 <xs:documentation xml:lang="en-us"> 2) An industry standard header. </xs:documentation>
665 <xs:documentation xml:lang="en-us"> 3) A library class header. </xs:documentation>
666 </xs:annotation>
667 <xs:complexType>
668 <xs:sequence>
669 <xs:element minOccurs="1" maxOccurs="unbounded" name="PackageHeader">
670 <xs:complexType>
671 <xs:sequence>
672 <xs:element minOccurs="1" maxOccurs="1" name="HeaderFile">
673 <xs:annotation>
674 <xs:documentation xml:lang="en-us">
675 This is the Package relative path
676 and filename location within the content ZIP file.
677 </xs:documentation>
678 </xs:annotation>
679 <xs:complexType>
680 <xs:simpleContent>
681 <xs:extension base="xs:anyURI">
682 <xs:attributeGroup ref="SupportedArchMod"/>
683 </xs:extension>
684 </xs:simpleContent>
685 </xs:complexType>
686 </xs:element>
687 <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>
688 </xs:sequence>
689 </xs:complexType>
690 </xs:element>
691 </xs:sequence>
692 </xs:complexType>
693 </xs:element>
694 <!-- End of PackageSurfaceArea PackageIncludes element. -->
695
696 <xs:element minOccurs="0" maxOccurs="1" name="Modules">
697 <xs:complexType>
698 <xs:sequence>
699 <xs:element ref="ModuleSurfaceArea" minOccurs="1" maxOccurs="unbounded">
700 <xs:annotation>
701 <xs:documentation xml:lang="en-us">
702 This section lists the Module Surface Area for
703 all modules provided with this package.
704 </xs:documentation>
705 </xs:annotation>
706 </xs:element>
707 </xs:sequence>
708 </xs:complexType>
709 </xs:element>
710 <!-- End of PackageSurfaceArea Modules element. -->
711
712 <xs:element minOccurs="0" maxOccurs="1" name="GuidDeclarations">
713 <xs:annotation>
714 <xs:documentation xml:lang="en-us">
715 This section defines the mapping of GUID C names to GUID
716 values as a Registry Format GUID.
717 </xs:documentation>
718 <xs:documentation xml:lang="en-us">
719 Modules that use these GUIDs must specify their dependency
720 on this package.
721 </xs:documentation>
722 </xs:annotation>
723 <xs:complexType>
724 <xs:sequence>
725 <xs:element minOccurs="1" maxOccurs="unbounded" name="Entry">
726 <xs:annotation>
727 <xs:documentation xml:lang="en-us"> Individual GUID Declarations </xs:documentation>
728 </xs:annotation>
729 <xs:complexType>
730 <xs:sequence>
731 <xs:element minOccurs="1" maxOccurs="1" name="CName" type="xs:NCName"/>
732 <xs:element minOccurs="1" maxOccurs="1" name="GuidValue"
733 type="RegistryFormatGuid"/>
734 <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>
735 </xs:sequence>
736 <xs:attribute name="UiName" type="xs:normalizedString" use="optional"/>
737 <xs:attribute name="GuidTypes" type="GuidListType" use="optional"/>
738 <xs:attributeGroup ref="SupportedArchMod"/>
739 </xs:complexType>
740 </xs:element>
741 </xs:sequence>
742 </xs:complexType>
743 </xs:element>
744 <!-- End of PackageSurfaceArea GuidDeclarations element. -->
745
746 <xs:element minOccurs="0" maxOccurs="1" name="ProtocolDeclarations">
747 <xs:annotation>
748 <xs:documentation xml:lang="en-us">
749 This section defines the mapping of Protocol C names to GUID
750 values as a Registry Format GUID.
751 </xs:documentation>
752 <xs:documentation xml:lang="en-us">
753 Modules that use these Protocols must specify their
754 dependency on this package.
755 </xs:documentation>
756 </xs:annotation>
757 <xs:complexType>
758 <xs:sequence>
759 <xs:element minOccurs="1" maxOccurs="unbounded" name="Entry">
760 <xs:annotation>
761 <xs:documentation xml:lang="en-us">
762 Individual Protocol Declarations
763 </xs:documentation>
764 </xs:annotation>
765 <xs:complexType>
766 <xs:sequence>
767 <xs:element minOccurs="1" maxOccurs="1" name="CName" type="xs:NCName"/>
768 <xs:element minOccurs="1" maxOccurs="1" name="GuidValue"
769 type="RegistryFormatGuid"/>
770 <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>
771 </xs:sequence>
772 <xs:attribute name="UiName" type="xs:normalizedString" use="optional"/>
773 <xs:attributeGroup ref="SupportedArchMod"/>
774 </xs:complexType>
775 </xs:element>
776 </xs:sequence>
777 </xs:complexType>
778 </xs:element>
779 <!-- End of PackageSurfaceArea ProtocolDeclarations element. -->
780
781 <xs:element minOccurs="0" maxOccurs="1" name="PpiDeclarations">
782 <xs:annotation>
783 <xs:documentation xml:lang="en-us">
784 This section defines the mapping of Ppi C names to GUID
785 values as a Registry Format GUID.
786 </xs:documentation>
787 <xs:documentation xml:lang="en-us">
788 Modules that use these Ppis must specify their dependency on
789 this package.
790 </xs:documentation>
791 </xs:annotation>
792 <xs:complexType>
793 <xs:sequence>
794 <xs:element minOccurs="1" maxOccurs="unbounded" name="Entry">
795 <xs:annotation>
796 <xs:documentation xml:lang="en-us"> Individual PPI Declarations </xs:documentation>
797 </xs:annotation>
798 <xs:complexType>
799 <xs:sequence>
800 <xs:element minOccurs="1" maxOccurs="1" name="CName" type="xs:NCName"/>
801 <xs:element minOccurs="1" maxOccurs="1" name="GuidValue"
802 type="RegistryFormatGuid"/>
803 <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>
804 </xs:sequence>
805 <xs:attribute name="UiName" type="xs:normalizedString" use="optional"/>
806 <xs:attributeGroup ref="SupportedArchMod"/>
807 </xs:complexType>
808 </xs:element>
809 </xs:sequence>
810 </xs:complexType>
811 </xs:element>
812 <!-- End of PackageSurfaceArea PpiDeclarations element. -->
813
814 <xs:element minOccurs="0" maxOccurs="1" name="PcdDeclarations">
815 <xs:annotation>
816 <xs:documentation xml:lang="en-us">
817 This section is used to declare platform configuration knobs
818 that are defined by this package.
819 </xs:documentation>
820 <xs:documentation xml:lang="en-us">
821 Modules that use these PCD values must specify their
822 dependency on this package.
823 </xs:documentation>
824 </xs:annotation>
825 <xs:complexType>
826 <xs:sequence>
827 <xs:element minOccurs="1" maxOccurs="unbounded" name="PcdEntry">
828 <xs:complexType>
829 <xs:sequence>
830 <xs:element minOccurs="1" maxOccurs="1" name="TokenSpaceGuidCname"
831 type="xs:NCName">
832 <xs:annotation>
833 <xs:documentation xml:lang="en-us">
834 Specifies the C name of the Token
835 Space GUID of which this PCD Entry is a member. This C name should
836 also be listed in the GUIDs section, (specified above,) where the C
837 name is assigned to a GUID value.
838 </xs:documentation>
839 </xs:annotation>
840 </xs:element>
841 <xs:element minOccurs="1" maxOccurs="1" name="Token">
842 <xs:annotation>
843 <xs:documentation xml:lang="en-us">
844 Specifies the 32-bit token value for
845 this PCD Entry. The Token number must be unique to the Token Space
846 that declares the PCD.
847 </xs:documentation>
848 <xs:documentation xml:lang="en-us">
849 The minLength of 3 is required to
850 handle the "0x" prefix to the hex number.
851 </xs:documentation>
852 </xs:annotation>
853 <xs:simpleType>
854 <xs:restriction base="HexNumber">
855 <xs:minLength value="3"/>
856 <xs:maxLength value="10"/>
857 </xs:restriction>
858 </xs:simpleType>
859 </xs:element>
860 <xs:element minOccurs="1" maxOccurs="1" name="CName" type="xs:NCName"/>
861 <xs:element minOccurs="1" maxOccurs="1" name="DatumType" type="PcdDatumTypes">
862 <xs:annotation>
863 <xs:documentation xml:lang="en-us">
864 A string that contains the data type
865 of this PCD Entry. PCD data types are restricted to the following
866 set:UINT8, UINT16, UINT32, UINT64, VOID*, BOOLEAN.
867 </xs:documentation>
868 </xs:annotation>
869 </xs:element>
870 <xs:element minOccurs="1" maxOccurs="1" name="ValidUsage" type="PcdItemListType">
871 <xs:annotation>
872 <xs:documentation xml:lang="en-us">
873 A string that contains one or more
874 PCD Item types separated by spaces. The PCD Item types are
875 restricted to FeaturePcd, FixedPcd, PatchPcd, Pcd and/or PcdEx.
876 </xs:documentation>
877 </xs:annotation>
878 </xs:element>
879 <xs:element minOccurs="1" maxOccurs="1" name="DefaultValue"
880 type="xs:normalizedString"/>
881 <xs:element minOccurs="0" maxOccurs="1" name="MaxDatumSize">
882 <xs:annotation>
883 <xs:documentation xml:lang="en-us">
884 This is a recommended maximum data
885 size for VOID* data types, the actual value should be defined by the
886 Platform Integrator. It is not required for the other data types.
887 </xs:documentation>
888 <xs:documentation xml:lang="en-us">
889 The minLength of 3 is required to
890 handle the "0x" prefix to the hex number.
891 </xs:documentation>
892
893 </xs:annotation>
894 <xs:simpleType>
895 <xs:restriction base="HexNumber">
896 <xs:minLength value="3"/>
897 </xs:restriction>
898 </xs:simpleType>
899 </xs:element>
900 <xs:element minOccurs="0" maxOccurs="unbounded" name="Prompt">
901 <xs:annotation>
902 <xs:documentation xml:lang="en-US">
903 This entry contains prompt
904 information, that may used by tools to assist platform integrators
905 with choosing the correct values
906 </xs:documentation>
907 </xs:annotation>
908 <xs:complexType>
909 <xs:simpleContent>
910 <xs:extension base="xs:string">
911 <xs:attribute name="Lang" type="xs:language" default="en-us"
912 use="optional"/>
913 </xs:extension>
914 </xs:simpleContent>
915 </xs:complexType>
916 </xs:element>
917 <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>
918
919 <xs:element minOccurs="0" maxOccurs="unbounded" name="PcdError">
920 <xs:annotation>
921 <xs:documentation xml:lang="en-us">
922 Valid Error messages that may be
923 implemented in a module for the PCD Entry. Only One Error Number per
924 PcdError, (multiple ErrorMessage entries are permitted) and multiple
925 PcdError elements are permitted.
926 </xs:documentation>
927 </xs:annotation>
928 <xs:complexType>
929 <xs:sequence>
930 <xs:choice minOccurs="1" maxOccurs="1">
931 <xs:annotation>
932 <xs:documentation xml:lang="en-us">
933 One of the following
934 types of comparisons, which must be able to evaluate to
935 either true or false.
936 </xs:documentation>
937 </xs:annotation>
938 <xs:element minOccurs="0" maxOccurs="1" name="ValidValueList">
939 <xs:annotation>
940 <xs:documentation xml:lang="en-us">
941 The PCD Value must be
942 space separated list of values. Values are restricted to the
943 data type of this PCD.
944 </xs:documentation>
945 </xs:annotation>
946 <xs:complexType>
947 <xs:simpleContent>
948 <xs:extension base="xs:normalizedString">
949 <xs:attribute name="Lang" type="xs:language" use="optional"
950 />
951 </xs:extension>
952 </xs:simpleContent>
953 </xs:complexType>
954 </xs:element>
955 <xs:element minOccurs="0" maxOccurs="1" name="ValidValueRange"
956 type="xs:normalizedString">
957 <xs:annotation>
958 <xs:documentation xml:lang="en-us">
959 The PCD must be within a
960 specified range of numeric values. Restricted to C style
961 Relational, Equality and Logical Operators and parenthesis
962 are valid. Only the CName for this PCD is permitted in the
963 ValidValueRange expression. All other values must be
964 numeric.
965 </xs:documentation>
966 <xs:documentation xml:lang="en-us">
967 LValue (op RValue)+
968 </xs:documentation>
969 </xs:annotation>
970 </xs:element>
971 <xs:element minOccurs="0" maxOccurs="1" name="Expression"
972 type="xs:normalizedString">
973 <xs:annotation>
974 <xs:documentation xml:lang="en-us">
975 A in-fix logical
976 expression using C style logical operators.
977 </xs:documentation>
978 </xs:annotation>
979 </xs:element>
980 </xs:choice>
981 <xs:element minOccurs="1" maxOccurs="1" name="ErrorNumber">
982 <xs:annotation>
983 <xs:documentation xml:lang="en-us">
984 A hexadecimal value for
985 the error message as defined by specifications.
986 </xs:documentation>
987 <xs:documentation xml:lang="en-us">
988 The minLength of 3 is
989 required to handle the "0x" prefix to the hex number.
990 </xs:documentation>
991
992 </xs:annotation>
993 <xs:simpleType>
994 <xs:restriction base="HexNumber">
995 <xs:minLength value="3"/>
996 </xs:restriction>
997 </xs:simpleType>
998 </xs:element>
999 <xs:element minOccurs="1" maxOccurs="unbounded" name="ErrorMessage">
1000 <xs:annotation>
1001 <xs:documentation xml:lang="en-us">
1002 This string should be
1003 defined by specifications. There are pre-defined error
1004 number ranges in the UEFI/PI specification.
1005 </xs:documentation>
1006 </xs:annotation>
1007 <xs:complexType>
1008 <xs:simpleContent>
1009 <xs:extension base="xs:string">
1010 <xs:attribute name="Lang" type="xs:language" default="en-us"
1011 use="optional"/>
1012 </xs:extension>
1013 </xs:simpleContent>
1014 </xs:complexType>
1015 </xs:element>
1016 </xs:sequence>
1017 </xs:complexType>
1018 </xs:element>
1019 </xs:sequence>
1020 <xs:attributeGroup ref="SupportedArchMod"/>
1021 </xs:complexType>
1022 </xs:element>
1023 </xs:sequence>
1024 </xs:complexType>
1025 </xs:element>
1026 <!-- End of PackageSurfaceArea PcdDeclarations element. -->
1027
1028 <xs:element minOccurs="0" maxOccurs="1" name="PcdRelationshipChecks">
1029 <xs:annotation>
1030 <xs:documentation xml:lang="en-us">
1031 This section is used to describe any PCD interdependencies
1032 or relationships.
1033 </xs:documentation>
1034 </xs:annotation>
1035 <xs:complexType>
1036 <xs:sequence>
1037 <xs:element minOccurs="1" maxOccurs="unbounded" name="PcdCheck" type="xs:normalizedString">
1038 <xs:annotation>
1039 <xs:documentation xml:lang="en-us">
1040 This entry must used
1041 TokenSpaceGuidCName.PcdCname for every named PCD. Restricted to Relational,
1042 Equality and Logical Operators (NOT, AND, OR, GT, GE, EQ, LE, LT and XOR) and
1043 parenthesis are valid. Only the TokenSpaceGuidCName.PcdCname us permitted to
1044 name PCDs in the expression. All other values must be numeric.
1045 </xs:documentation>
1046 <xs:documentation xml:lang="en-us"> LValue (op RValue)+ </xs:documentation>
1047 </xs:annotation>
1048 </xs:element>
1049 </xs:sequence>
1050 </xs:complexType>
1051 </xs:element>
1052
1053 <xs:element minOccurs="0" maxOccurs="unbounded" name="MiscellaneousFiles">
1054 <xs:annotation>
1055 <xs:documentation xml:lang="en-us">
1056 This section contains files that are not part of the code
1057 distributed with this package.
1058 </xs:documentation>
1059 </xs:annotation>
1060 <xs:complexType>
1061 <xs:sequence>
1062 <xs:element minOccurs="0" maxOccurs="1" name="Copyright" type="xs:string">
1063 <xs:annotation>
1064 <xs:documentation xml:lang="en-us">
1065 Only required if different from the Package
1066 Copyright.
1067 </xs:documentation>
1068 </xs:annotation>
1069 </xs:element>
1070 <xs:element minOccurs="0" maxOccurs="1" name="License" type="xs:string">
1071 <xs:annotation>
1072 <xs:documentation xml:lang="en-us">
1073 Only required if different from the Package
1074 License.
1075 </xs:documentation>
1076 </xs:annotation>
1077 </xs:element>
1078 <xs:element minOccurs="0" maxOccurs="1" name="Abstract" type="xs:string">
1079 <xs:annotation>
1080 <xs:documentation xml:lang="en-us">
1081 A one line description of this section's
1082 content.
1083 </xs:documentation>
1084 </xs:annotation>
1085 </xs:element>
1086 <xs:element minOccurs="0" maxOccurs="unbounded" name="Description" type="xs:string">
1087 <xs:annotation>
1088 <xs:documentation xml:lang="en-us">
1089 A complete description of the files in this
1090 section.
1091 </xs:documentation>
1092 </xs:annotation>
1093 </xs:element>
1094 <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename">
1095 <xs:annotation>
1096 <xs:documentation xml:lang="en-us">
1097 This is the PackagePath relative path and
1098 filename location within the ZIP file.
1099 </xs:documentation>
1100 </xs:annotation>
1101 <xs:complexType>
1102 <xs:simpleContent>
1103 <xs:extension base="xs:anyURI">
1104 <xs:attribute name="Executable" type="xs:boolean" default="false"
1105 use="optional">
1106 <xs:annotation>
1107 <xs:documentation xml:lang="en-us">
1108 If true, used by installation
1109 tools to ensure that a file that must be executable has the
1110 correct properties to permit execution.
1111 </xs:documentation>
1112 </xs:annotation>
1113 </xs:attribute>
1114 </xs:extension>
1115 </xs:simpleContent>
1116 </xs:complexType>
1117 </xs:element>
1118
1119 </xs:sequence>
1120 </xs:complexType>
1121 </xs:element>
1122 <!-- End of PackageSurfaceArea Misc element. -->
1123
1124 <xs:element minOccurs="0" maxOccurs="unbounded" name="UserExtensions">
1125 <xs:annotation>
1126 <xs:documentation xml:lang="en-us">
1127 This section is used for any processing instructions that
1128 may be custom to the content provided by this package that are common to this package.
1129 </xs:documentation>
1130 </xs:annotation>
1131 <xs:complexType mixed="true">
1132 <xs:sequence>
1133 <xs:any processContents="lax" minOccurs="0" maxOccurs="1"/>
1134 </xs:sequence>
1135 <xs:attribute name="UserId" type="xs:NCName" use="required">
1136 <xs:annotation>
1137 <xs:documentation xml:lang="en-us">
1138 This is a single word identifier for grouping
1139 similar content that does not fit into previously defined sections or other sections
1140 of the Distribution.
1141 </xs:documentation>
1142 </xs:annotation>
1143 </xs:attribute>
1144 <xs:attribute name="Identifier" type="xs:string" use="required">
1145 <xs:annotation>
1146 <xs:documentation xml:lang="en-us">
1147 This can be used to differentiate multiple sections
1148 with a grouping.
1149 </xs:documentation>
1150 <xs:documentation xml:lang="en-us">
1151 For example, a PRE_PROCESS Identifier might indicate
1152 specific steps and tools required before processing module content, while a
1153 different UserExtensions section with a POST_PROCESS Identifier might describe steps
1154 that need to be executed after operations on the modules in this package.
1155 </xs:documentation>
1156 </xs:annotation>
1157 </xs:attribute>
1158 <xs:anyAttribute processContents="lax"/>
1159 </xs:complexType>
1160 </xs:element>
1161 <!-- End of PackageSurfaceArea UserExtensions element. -->
1162
1163 </xs:sequence>
1164 </xs:complexType>
1165 </xs:element>
1166 <!-- End of the PackageSurfaceArea element. -->
1167
1168 <xs:element name="ModuleSurfaceArea">
1169 <xs:annotation>
1170 <xs:documentation xml:lang="en-us">
1171 Each module is uniquely identified by its GUID and Version number.
1172 Backward compatible releases of a module need only change the version number, while non-backward
1173 compatible changes require the GUID to change (resetting the version number to 1.0 is optional.)
1174 </xs:documentation>
1175 </xs:annotation>
1176 <xs:complexType>
1177 <xs:sequence>
1178
1179 <xs:element minOccurs="1" maxOccurs="1" name="Header">
1180 <xs:complexType>
1181 <xs:sequence>
1182 <xs:element minOccurs="1" maxOccurs="1" name="Name">
1183 <xs:annotation>
1184 <xs:documentation xml:lang="en-us">
1185 This is the User Interface Name for this Module.
1186 </xs:documentation>
1187 </xs:annotation>
1188 <xs:complexType>
1189 <xs:simpleContent>
1190 <xs:extension base="xs:normalizedString">
1191 <xs:attribute name="BaseName" type="xs:NMTOKEN" use="required">
1192 <xs:annotation>
1193 <xs:documentation xml:lang="en-us">
1194 This is a single word BaseName
1195 that will be used to create a module meta-data file.
1196 </xs:documentation>
1197 <xs:documentation xml:lang="en-us">
1198 This name should also be used to
1199 create output file names and directories.
1200 </xs:documentation>
1201 </xs:annotation>
1202 </xs:attribute>
1203 </xs:extension>
1204 </xs:simpleContent>
1205 </xs:complexType>
1206 </xs:element>
1207 <xs:element minOccurs="1" maxOccurs="1" name="GUID">
1208 <xs:annotation>
1209 <xs:documentation xml:lang="en-us">
1210 This GUID and the Version attribute uniquely
1211 identify a given Module.
1212 </xs:documentation>
1213 </xs:annotation>
1214 <xs:complexType>
1215 <xs:simpleContent>
1216 <xs:extension base="RegistryFormatGuid">
1217 <xs:attribute name="Version" type="xs:decimal" use="required">
1218 <xs:annotation>
1219 <xs:documentation xml:lang="en-us">
1220 This value, along with the GUID,
1221 is used to uniquely identify this object.
1222 </xs:documentation>
1223 <xs:documentation xml:lang="en-us">
1224 Backward compatible changes must
1225 make sure this number is incremented from the most recent
1226 version. Non-backward compatible changes require a new GUID, and
1227 the version can be reset.
1228 </xs:documentation>
1229 </xs:annotation>
1230 </xs:attribute>
1231 </xs:extension>
1232 </xs:simpleContent>
1233 </xs:complexType>
1234 </xs:element>
1235 <xs:element minOccurs="0" maxOccurs="unbounded" name="Copyright">
1236 <xs:annotation>
1237 <xs:documentation xml:lang="en-us">
1238 This is only required if the Copyright is
1239 different from either the Package or Distribution copyright. Multiple copyright
1240 lines are permitted within this section.
1241 </xs:documentation>
1242 </xs:annotation>
1243 <xs:complexType>
1244 <xs:simpleContent>
1245 <xs:extension base="xs:string">
1246 <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"
1247 />
1248 </xs:extension>
1249 </xs:simpleContent>
1250 </xs:complexType>
1251 </xs:element>
1252 <xs:element minOccurs="0" maxOccurs="unbounded" name="License">
1253 <xs:annotation>
1254 <xs:documentation xml:lang="en-us">
1255 This is only required if the license is
1256 different from either the Package or Distribution license. Multiple licenses are
1257 permitted within this section.
1258 </xs:documentation>
1259 </xs:annotation>
1260 <xs:complexType>
1261 <xs:simpleContent>
1262 <xs:extension base="xs:string">
1263 <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"
1264 />
1265 </xs:extension>
1266 </xs:simpleContent>
1267 </xs:complexType>
1268 </xs:element>
1269 <xs:element minOccurs="0" maxOccurs="unbounded" name="Abstract">
1270 <xs:annotation>
1271 <xs:documentation xml:lang="en-us">
1272 A brief text description of the module.
1273 </xs:documentation>
1274 </xs:annotation>
1275 <xs:complexType>
1276 <xs:simpleContent>
1277 <xs:extension base="xs:normalizedString">
1278 <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"
1279 />
1280 </xs:extension>
1281 </xs:simpleContent>
1282 </xs:complexType>
1283 </xs:element>
1284 <xs:element minOccurs="0" maxOccurs="unbounded" name="Description">
1285 <xs:annotation>
1286 <xs:documentation xml:lang="en-us">
1287 A complete description of the module contents
1288 and/or features including a description of the updates since the previous module
1289 release.
1290 </xs:documentation>
1291 </xs:annotation>
1292 <xs:complexType>
1293 <xs:simpleContent>
1294 <xs:extension base="xs:string">
1295 <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"
1296 />
1297 </xs:extension>
1298 </xs:simpleContent>
1299 </xs:complexType>
1300 </xs:element>
1301 </xs:sequence>
1302 </xs:complexType>
1303 </xs:element>
1304 <!-- End of Module Surface Area Header Section -->
1305
1306 <xs:element minOccurs="0" maxOccurs="1" name="ModuleProperties">
1307 <xs:annotation>
1308 <xs:documentation xml:lang="en-us">
1309 List general information about a module, including the
1310 Supported Architectures, this module's type, specifications the module is coded against, and
1311 other informational content.
1312 </xs:documentation>
1313 </xs:annotation>
1314 <xs:complexType>
1315 <xs:sequence>
1316 <xs:element minOccurs="1" maxOccurs="1" name="ModuleType" type="ModuleTypes">
1317 <xs:annotation>
1318 <xs:documentation xml:lang="en-us">
1319 One of the Enumerated module types that limit
1320 the use of a module.
1321 </xs:documentation>
1322 </xs:annotation>
1323 </xs:element>
1324 <xs:element minOccurs="1" maxOccurs="1" name="Path" type="xs:anyURI">
1325 <xs:annotation>
1326 <xs:documentation xml:lang="en-us">
1327 For stand-alone modules that are NOT part of any
1328 package, this is the path to the root of the module as listed in the ZIP file.
1329 For modules included in a package, this is the location, relative to the root of
1330 the package (PackagePath) this module belongs to.
1331 </xs:documentation>
1332 </xs:annotation>
1333 </xs:element>
1334 <xs:element minOccurs="0" maxOccurs="1" name="PcdIsDriver">
1335 <xs:annotation>
1336 <xs:documentation xml:lang="en-us">
1337 This element is only required for the PEIM that
1338 produces the PCD PPI or the DXE Driver that produces the PCD Protocol.
1339 </xs:documentation>
1340 </xs:annotation>
1341 <xs:simpleType>
1342 <xs:restriction base="xs:NCName">
1343 <xs:enumeration value="PEI_PCD_DRIVER"/>
1344 <xs:enumeration value="DXE_PCD_DRIVER"/>
1345 </xs:restriction>
1346 </xs:simpleType>
1347 </xs:element>
1348
1349 <xs:element minOccurs="0" maxOccurs="1" name="UefiSpecificationVersion" type="xs:decimal"/>
1350
1351 <xs:element minOccurs="0" maxOccurs="1" name="PiSpecificationVersion" type="xs:decimal"/>
1352
1353 <xs:element minOccurs="0" maxOccurs="unbounded" name="Specification">
1354 <xs:annotation>
1355 <xs:documentation xml:lang="en-us">
1356 This is a list of other specifications that this
1357 module is written against. These entries can be used in #define statements
1358 (depending on the build system implementation, they may be autogenerated.)
1359 </xs:documentation>
1360 </xs:annotation>
1361 <xs:complexType>
1362 <xs:simpleContent>
1363 <xs:extension base="xs:NCName">
1364 <xs:attribute name="Version" type="xs:decimal" use="required"/>
1365 </xs:extension>
1366 </xs:simpleContent>
1367 </xs:complexType>
1368 </xs:element>
1369
1370 <xs:element minOccurs="0" maxOccurs="unbounded" name="BootMode">
1371 <xs:annotation>
1372 <xs:documentation xml:lang="en-us">
1373 Different firmware execution paths may be taken
1374 based on a given state of the hardware, firmware, or through feature settings. A
1375 BootMode may be declared (PRODUCES) or discovered (CONSUMES) based on these
1376 states and feature settings. If the usage is UNDEFINE, it implies that a Boot
1377 Mode is used, but the package creator does not know how it is used. The
1378 supported boot modes map to the PI specification Boot Modes. The boot modes
1379 listed with Recovery are to indicate that the BootMode is valid during a
1380 recovery boot.
1381 </xs:documentation>
1382 </xs:annotation>
1383 <xs:complexType>
1384 <xs:sequence minOccurs="0">
1385 <xs:element minOccurs="1" maxOccurs="1" name="SupportedBootModes">
1386 <xs:simpleType>
1387 <xs:list>
1388 <xs:simpleType>
1389 <xs:restriction base="xs:NCName">
1390 <xs:enumeration value="FULL"/>
1391 <xs:enumeration value="MINIMAL"/>
1392 <xs:enumeration value="NO_CHANGE"/>
1393 <xs:enumeration value="DIAGNOSTICS"/>
1394 <xs:enumeration value="DEFAULT"/>
1395 <xs:enumeration value="S2_RESUME"/>
1396 <xs:enumeration value="S3_RESUME"/>
1397 <xs:enumeration value="S4_RESUME"/>
1398 <xs:enumeration value="S5_RESUME"/>
1399 <xs:enumeration value="FLASH_UPDATE"/>
1400 <xs:enumeration value="RECOVERY_FULL"/>
1401 <xs:enumeration value="RECOVERY_MINIMAL"/>
1402 <xs:enumeration value="RECOVERY_NO_CHANGE"/>
1403 <xs:enumeration value="RECOVERY_DIAGNOSTICS"/>
1404 <xs:enumeration value="RECOVERY_DEFAULT"/>
1405 <xs:enumeration value="RECOVERY_S2_RESUME"/>
1406 <xs:enumeration value="RECOVERY_S3_RESUME"/>
1407 <xs:enumeration value="RECOVERY_S4_RESUME"/>
1408 <xs:enumeration value="RECOVERY_S5_RESUME"/>
1409 <xs:enumeration value="RECOVERY_FLASH_UPDATE"/>
1410 <xs:enumeration value="UNDEFINED"/>
1411 </xs:restriction>
1412 </xs:simpleType>
1413 </xs:list>
1414 </xs:simpleType>
1415 </xs:element>
1416
1417 <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>
1418 </xs:sequence>
1419 <xs:attribute name="Usage" use="required">
1420 <xs:simpleType>
1421 <xs:restriction base="xs:NCName">
1422 <xs:enumeration value="CONSUMES">
1423 <xs:annotation>
1424 <xs:documentation xml:lang="en-us">
1425 The module always supports
1426 the given boot modes.
1427 </xs:documentation>
1428 </xs:annotation>
1429 </xs:enumeration>
1430 <xs:enumeration value="SOMETIMES_CONSUMES">
1431 <xs:annotation>
1432 <xs:documentation xml:lang="en-us">
1433 The module may support a
1434 given mode on some execution paths.
1435 </xs:documentation>
1436 </xs:annotation>
1437 </xs:enumeration>
1438 <xs:enumeration value="PRODUCES">
1439 <xs:annotation>
1440 <xs:documentation xml:lang="en-us">
1441 The module will change the
1442 boot mode.
1443 </xs:documentation>
1444 </xs:annotation>
1445 </xs:enumeration>
1446 <xs:enumeration value="SOMETIME_PRODUCES">
1447 <xs:annotation>
1448 <xs:documentation xml:lang="en-us">
1449 The module will change the
1450 boot mode on some execution paths.
1451 </xs:documentation>
1452 </xs:annotation>
1453 </xs:enumeration>
1454 <xs:enumeration value="UNDEFINED">
1455 <xs:annotation>
1456 <xs:documentation xml:lang="en-us">
1457 The package creator does not
1458 know how the boot mode is used.
1459 </xs:documentation>
1460 </xs:annotation>
1461 </xs:enumeration>
1462 </xs:restriction>
1463 </xs:simpleType>
1464 </xs:attribute>
1465 <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>
1466 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
1467 </xs:complexType>
1468 </xs:element>
1469
1470 <xs:element minOccurs="0" maxOccurs="unbounded" name="Event" nillable="true">
1471 <xs:annotation>
1472 <xs:documentation xml:lang="en-us">
1473 The functions that make up the Event, Timer, and
1474 Task Priority Services are used during preboot to create, close, signal, and
1475 wait for events; to set timers; and to raise and restore task priority levels as
1476 defined in the UEFI specification. GUIDed events should be listed in the Guids
1477 section.
1478 </xs:documentation>
1479 </xs:annotation>
1480 <xs:complexType>
1481 <xs:sequence>
1482 <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>
1483 </xs:sequence>
1484 <xs:attribute name="Usage" use="required">
1485 <xs:simpleType>
1486 <xs:restriction base="xs:NCName">
1487 <xs:enumeration value="CONSUMES">
1488 <xs:annotation>
1489 <xs:documentation xml:lang="en-us">
1490 The module will register a
1491 notification function and calls the function when it is
1492 signaled.
1493 </xs:documentation>
1494 </xs:annotation>
1495 </xs:enumeration>
1496 <xs:enumeration value="SOMETIMES_CONSUMES">
1497 <xs:annotation>
1498 <xs:documentation xml:lang="en-us">
1499 The module will register a
1500 notification function and calls the function when it is
1501 signaled on some execution paths.
1502 </xs:documentation>
1503 </xs:annotation>
1504 </xs:enumeration>
1505 <xs:enumeration value="PRODUCES">
1506 <xs:annotation>
1507 <xs:documentation xml:lang="en-us">
1508 The module will signal all
1509 events in an event group.
1510 </xs:documentation>
1511 </xs:annotation>
1512 </xs:enumeration>
1513 <xs:enumeration value="SOMETIMES_PRODUCES">
1514 <xs:annotation>
1515 <xs:documentation xml:lang="en-us">
1516 The module will signal all
1517 events in an event group under some execution paths.
1518 </xs:documentation>
1519 </xs:annotation>
1520 </xs:enumeration>
1521 <xs:enumeration value="UNDEFINED">
1522 <xs:annotation>
1523 <xs:documentation xml:lang="en-us">
1524 The package creator does not
1525 know how an event is used.
1526 </xs:documentation>
1527 </xs:annotation>
1528 </xs:enumeration>
1529 </xs:restriction>
1530 </xs:simpleType>
1531 </xs:attribute>
1532 <xs:attribute name="EventType" use="required">
1533 <xs:simpleType>
1534 <xs:restriction base="xs:NCName">
1535 <xs:enumeration value="EVENT_TYPE_PERIODIC_TIMER"/>
1536 <xs:enumeration value="EVENT_TYPE_RELATIVE_TIMER"/>
1537 <xs:enumeration value="UNDEFINED"/>
1538 </xs:restriction>
1539 </xs:simpleType>
1540
1541
1542 </xs:attribute>
1543 <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>
1544 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
1545 </xs:complexType>
1546 </xs:element>
1547
1548 <xs:element minOccurs="0" maxOccurs="unbounded" name="HOB" nillable="false">
1549 <xs:annotation>
1550 <xs:documentation xml:lang="en-us">
1551 This is a list of non-GUIDed Hand Off Blocks
1552 (HOBs) produced or consumed by this module.
1553 </xs:documentation>
1554 </xs:annotation>
1555 <xs:complexType>
1556 <xs:sequence>
1557 <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>
1558 </xs:sequence>
1559 <xs:attribute name="HobType" use="required">
1560 <xs:simpleType>
1561 <xs:restriction base="xs:NCName">
1562 <xs:enumeration value="PHIT"/>
1563 <xs:enumeration value="MEMORY_ALLOCATION"/>
1564 <xs:enumeration value="RESOURCE_DESCRIPTOR"/>
1565 <xs:enumeration value="FIRMWARE_VOLUME"/>
1566 <xs:enumeration value="LOAD_PEIM"/>
1567 <xs:enumeration value="UNDEFINED"/>
1568 </xs:restriction>
1569 </xs:simpleType>
1570 </xs:attribute>
1571 <xs:attribute name="Usage" use="required">
1572 <xs:simpleType>
1573 <xs:restriction base="xs:NCName">
1574 <xs:enumeration value="CONSUMES">
1575 <xs:annotation>
1576 <xs:documentation xml:lang="en-us">
1577 A HOB must be present in the
1578 system.
1579 </xs:documentation>
1580 </xs:annotation>
1581 </xs:enumeration>
1582 <xs:enumeration value="SOMETIMES_CONSUMES">
1583 <xs:annotation>
1584 <xs:documentation xml:lang="en-us">
1585 If present, the HOB will be
1586 used.
1587 </xs:documentation>
1588 </xs:annotation>
1589 </xs:enumeration>
1590 <xs:enumeration value="PRODUCES">
1591 <xs:annotation>
1592 <xs:documentation xml:lang="en-us">
1593 The HOB is always produced
1594 by the module.
1595 </xs:documentation>
1596 </xs:annotation>
1597 </xs:enumeration>
1598 <xs:enumeration value="SOMETIMES_PRODUCES">
1599 <xs:annotation>
1600 <xs:documentation xml:lang="en-us">
1601 The HOB may be produced by
1602 the module under some execution paths.
1603 </xs:documentation>
1604 </xs:annotation>
1605 </xs:enumeration>
1606 <xs:enumeration value="UNDEFINED">
1607 <xs:annotation>
1608 <xs:documentation xml:lang="en-us">
1609 The package creator knows
1610 that a HOB is used, but does not know how it is used.
1611 </xs:documentation>
1612 </xs:annotation>
1613 </xs:enumeration>
1614 </xs:restriction>
1615 </xs:simpleType>
1616 </xs:attribute>
1617 <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>
1618 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
1619 </xs:complexType>
1620 </xs:element>
1621
1622 </xs:sequence>
1623 <xs:attributeGroup ref="SupportedArchMod"/>
1624 </xs:complexType>
1625 </xs:element>
1626 <!-- End of ModuleProperties Section -->
1627
1628 <xs:element minOccurs="0" maxOccurs="1" name="ClonedFrom">
1629 <xs:annotation>
1630 <xs:documentation xml:lang="en-us">
1631 This section may be included for Modules that are copied
1632 from a different module.
1633 </xs:documentation>
1634 </xs:annotation>
1635 <xs:complexType>
1636 <xs:sequence>
1637 <xs:element minOccurs="1" maxOccurs="1" name="GUID">
1638 <xs:annotation>
1639 <xs:documentation xml:lang="en-us">
1640 This GUID and the Version attribute uniquely
1641 identify the Module that this Module was copied from.
1642 </xs:documentation>
1643 </xs:annotation>
1644 <xs:complexType>
1645 <xs:simpleContent>
1646 <xs:extension base="RegistryFormatGuid">
1647 <xs:attribute name="Version" type="xs:decimal" use="required">
1648 <xs:annotation>
1649 <xs:documentation xml:lang="en-us">
1650 This value, along with the GUID,
1651 is used to uniquely identify this object.
1652 </xs:documentation>
1653 </xs:annotation>
1654 </xs:attribute>
1655 </xs:extension>
1656 </xs:simpleContent>
1657 </xs:complexType>
1658 </xs:element>
1659 </xs:sequence>
1660 </xs:complexType>
1661 </xs:element>
1662 <!-- End of ClonedFrom Section. -->
1663
1664 <xs:element minOccurs="0" maxOccurs="1" name="LibraryClassDefinitions">
1665 <xs:annotation>
1666 <xs:documentation xml:lang="en-us">
1667 A list of the different Library Classes consumed by a
1668 driver, core and/or application module, or produced by a Library module.
1669 </xs:documentation>
1670 </xs:annotation>
1671 <xs:complexType>
1672 <xs:sequence>
1673 <xs:element minOccurs="1" maxOccurs="unbounded" name="LibraryClass">
1674 <xs:complexType>
1675 <xs:sequence>
1676 <xs:element minOccurs="1" maxOccurs="1" name="Keyword" type="xs:NCName">
1677 <xs:annotation>
1678 <xs:documentation xml:lang="en-us ">
1679 Used by tools to identify different
1680 instances of libraries that provide the library class. This keyword
1681 identifies the library class this module needs to be linked against.
1682 </xs:documentation>
1683 </xs:annotation>
1684 </xs:element>
1685 <xs:element minOccurs="0" maxOccurs="1" name="RecommendedInstance">
1686 <xs:complexType>
1687 <xs:all>
1688 <xs:element minOccurs="1" maxOccurs="1" name="GUID">
1689 <xs:annotation>
1690 <xs:documentation xml:lang="en-us">
1691 This GUID and the
1692 Version attribute uniquely identify the recommended Library
1693 Instance for this module .
1694 </xs:documentation>
1695 </xs:annotation>
1696 <xs:complexType>
1697 <xs:simpleContent>
1698 <xs:extension base="RegistryFormatGuid">
1699 <xs:attribute name="Version" type="xs:decimal"
1700 use="optional">
1701 <xs:annotation>
1702 <xs:documentation xml:lang="en-us">
1703 This value, along with
1704 the GUID, is used to uniquely identify this object.
1705 </xs:documentation>
1706 </xs:annotation>
1707 </xs:attribute>
1708 </xs:extension>
1709 </xs:simpleContent>
1710 </xs:complexType>
1711 </xs:element>
1712 </xs:all>
1713 </xs:complexType>
1714 </xs:element>
1715 <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>
1716 </xs:sequence>
1717 <xs:attribute name="Usage" use="required">
1718 <xs:simpleType>
1719 <xs:annotation>
1720 <xs:documentation xml:lang="en-us">
1721 Library instances can provide code
1722 for a library class, or may require other library instances
1723 themselves. Since different execution paths in a library (or module)
1724 may need different library classes based on some setting, library
1725 classes may not alway be required.
1726 </xs:documentation>
1727 </xs:annotation>
1728 <xs:restriction base="xs:NCName">
1729 <xs:enumeration value="PRODUCES"/>
1730 <xs:enumeration value="CONSUMES"/>
1731 <xs:enumeration value="SOMETIMES_CONSUMES"/>
1732 <xs:enumeration value="UNDEFINED"/>
1733 </xs:restriction>
1734 </xs:simpleType>
1735 </xs:attribute>
1736
1737 <xs:attributeGroup ref="SupportedArchMod"/>
1738 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional">
1739 <xs:annotation>
1740 <xs:documentation xml:lang="en-us">
1741 A FeatureFlag attribute must evaluate to
1742 either true or false - it may be a fixed value of true or false, a C
1743 name or an in-fix expression.
1744 </xs:documentation>
1745 </xs:annotation>
1746 </xs:attribute>
1747 </xs:complexType>
1748 </xs:element>
1749 </xs:sequence>
1750 </xs:complexType>
1751 </xs:element>
1752 <!-- End of LibraryClassDefinitions Section -->
1753
1754 <xs:element minOccurs="0" maxOccurs="1" name="SourceFiles">
1755 <xs:complexType>
1756 <xs:sequence>
1757 <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename">
1758 <xs:annotation>
1759 <xs:documentation xml:lang="en-us">
1760 This is the module relative
1761 (ModuleProperties.Path) path and filename location within the ZIP file.
1762 </xs:documentation>
1763 </xs:annotation>
1764 <xs:complexType>
1765 <xs:simpleContent>
1766 <xs:extension base="xs:anyURI">
1767 <xs:attribute name="Family" type="FamilyTypes" use="optional">
1768 <xs:annotation>
1769 <xs:documentation xml:lang="en-us">
1770 The Family attribute is used to
1771 restrict usage to a given family of compilers, such as GCC or
1772 MSFT. Since not all code processing tools use the same syntax,
1773 especially for assembly, this field can be used to identify
1774 different syntax.
1775 </xs:documentation>
1776 </xs:annotation>
1777 </xs:attribute>
1778 <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>
1779 <xs:attribute name="SupModList" type="ModuleListType" use="optional"/>
1780 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
1781 </xs:extension>
1782 </xs:simpleContent>
1783 </xs:complexType>
1784 </xs:element>
1785 <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>
1786 </xs:sequence>
1787 </xs:complexType>
1788 </xs:element>
1789 <!-- End of SourceFiles Section -->
1790
1791 <xs:element minOccurs="0" maxOccurs="1" name="BinaryFiles">
1792 <xs:complexType>
1793 <xs:sequence>
1794 <xs:element minOccurs="1" maxOccurs="unbounded" name="BinaryFile">
1795 <xs:complexType>
1796 <xs:sequence>
1797 <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename">
1798 <xs:annotation>
1799 <xs:documentation xml:lang="en-us">
1800 This is the module relative
1801 (ModuleProperties.Path) path and filename location within the ZIP
1802 file.
1803 </xs:documentation>
1804 </xs:annotation>
1805 <xs:complexType>
1806 <xs:simpleContent>
1807 <xs:extension base="xs:anyURI">
1808 <xs:attribute name="FileType" use="optional">
1809 <xs:simpleType>
1810 <xs:restriction base="xs:NCName">
1811 <xs:annotation>
1812 <xs:documentation xml:lang="en-us">
1813 Binary file distribution
1814 is limited to UEFI/PI FFS leaf section file types.
1815 </xs:documentation>
1816 </xs:annotation>
1817 <xs:enumeration value="GUID"/>
1818 <xs:enumeration value="FREEFORM"/>
1819 <xs:enumeration value="UEFI_IMAGE"/>
1820 <xs:enumeration value="PE32">
1821 <xs:annotation>
1822 <xs:documentation xml:lang="en-us">
1823 A UEFI/PI FFS Leaf
1824 section file type, not a raw PE32 file.
1825 </xs:documentation>
1826 </xs:annotation>
1827 </xs:enumeration>
1828 <xs:enumeration value="PIC"/>
1829 <xs:enumeration value="PEI_DEPEX"/>
1830 <xs:enumeration value="DXE_DEPEX"/>
1831 <xs:enumeration value="SMM_DEPEX"/>
1832 <xs:enumeration value="COMPAT16"/>
1833 <xs:enumeration value="DISPOSABLE"/>
1834 <xs:enumeration value="TE"/>
1835 <xs:enumeration value="VER"/>
1836 <xs:enumeration value="UI"/>
1837 <xs:enumeration value="BIN"/>
1838 <xs:enumeration value="FV"/>
1839 </xs:restriction>
1840 </xs:simpleType>
1841 </xs:attribute>
1842 <xs:attribute name="GUID" use="optional"
1843 type="RegistryFormatGuid"/>
1844 <xs:attribute name="SupArchList" type="ArchListType"
1845 use="optional"/>
1846 <xs:attribute name="SupModList" type="ModuleListType"
1847 use="optional"/>
1848 <xs:attribute name="FeatureFlag" type="xs:normalizedString"
1849 use="optional"/>
1850 </xs:extension>
1851 </xs:simpleContent>
1852 </xs:complexType>
1853 </xs:element>
1854 <xs:element minOccurs="0" maxOccurs="unbounded" name="AsBuilt">
1855 <xs:annotation>
1856 <xs:documentation xml:lang="en-us">
1857 This section contains information
1858 about how the module was coded, such as Compiler Tools, Flags, PCDs
1859 (only PatchPcd and/or PcdEx) and Library Class Instances used to
1860 build the binary.
1861 </xs:documentation>
1862 </xs:annotation>
1863 <xs:complexType>
1864 <xs:sequence>
1865
1866 <xs:element minOccurs="0" maxOccurs="unbounded" name="PatchPcdValue">
1867 <xs:annotation>
1868 <xs:documentation xml:lang="en-us">
1869 The element is the
1870 Patchable PCD Value that was used during the build.
1871 </xs:documentation>
1872 </xs:annotation>
1873 <xs:complexType>
1874 <xs:sequence>
1875 <xs:element minOccurs="1" maxOccurs="1"
1876 name="TokenSpaceGuidValue" type="RegistryFormatGuid"/>
1877 <xs:element minOccurs="1" maxOccurs="1" name="PcdCName"
1878 type="xs:NCName"/>
1879 <xs:element minOccurs="1" maxOccurs="1" name="Token">
1880 <xs:annotation>
1881 <xs:documentation xml:lang="en-us">
1882 The minLength of 3 is
1883 required to handle the "0x" prefix to the hex number.
1884 </xs:documentation>
1885 </xs:annotation>
1886 <xs:simpleType>
1887 <xs:restriction base="HexNumber">
1888 <xs:minLength value="3"/>
1889 <xs:maxLength value="10"/>
1890 </xs:restriction>
1891 </xs:simpleType>
1892 </xs:element>
1893 <xs:element minOccurs="1" maxOccurs="1" name="DatumType"
1894 type="PcdDatumTypes"/>
1895 <xs:element minOccurs="0" maxOccurs="1" name="MaxDatumSize">
1896 <xs:annotation>
1897 <xs:documentation xml:lang="en-us">
1898 This field is required
1899 if the Pcd Datum Type is VOID*
1900 </xs:documentation>
1901 <xs:documentation xml:lang="en-us">
1902 The minLength of 3 is
1903 required to handle the "0x" prefix to the hex number.
1904 </xs:documentation>
1905 </xs:annotation>
1906 <xs:simpleType>
1907 <xs:restriction base="HexNumber">
1908 <xs:minLength value="3"/>
1909 </xs:restriction>
1910 </xs:simpleType>
1911 </xs:element>
1912 <xs:element minOccurs="1" maxOccurs="1" name="Value"
1913 type="xs:normalizedString"/>
1914 <xs:element minOccurs="1" maxOccurs="1" name="Offset">
1915 <xs:annotation>
1916 <xs:documentation xml:lang="en-us">
1917 The minLength of 3 is
1918 required to handle the "0x" prefix to the hex number.
1919 </xs:documentation>
1920 </xs:annotation>
1921 <xs:simpleType>
1922 <xs:restriction base="HexNumber">
1923 <xs:minLength value="3"/>
1924 </xs:restriction>
1925 </xs:simpleType>
1926 </xs:element>
1927 <xs:element ref="HelpText" minOccurs="0"
1928 maxOccurs="unbounded"/>
1929 <xs:element minOccurs="0" maxOccurs="unbounded"
1930 name="PcdError">
1931 <xs:annotation>
1932 <xs:documentation xml:lang="en-us">
1933 Error information
1934 implemented by the module.
1935 </xs:documentation>
1936 </xs:annotation>
1937 <xs:complexType>
1938 <xs:sequence>
1939 <xs:choice>
1940 <xs:element minOccurs="0" maxOccurs="1" name="ValidValueList">
1941 <xs:complexType>
1942 <xs:simpleContent>
1943 <xs:extension base="xs:normalizedString">
1944 <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"/>
1945 </xs:extension>
1946 </xs:simpleContent>
1947 </xs:complexType>
1948 </xs:element>
1949 <xs:element minOccurs="0" maxOccurs="1" name="ValidValueRange" type="xs:normalizedString"/>
1950 <xs:element minOccurs="0" maxOccurs="1" name="Expression" type="xs:normalizedString"/>
1951 </xs:choice>
1952 <xs:element minOccurs="1" maxOccurs="1" name="ErrorNumber">
1953 <xs:annotation>
1954 <xs:documentation xml:lang="en-us">
1955 The minLength of 3 is
1956 required to handle the "0x" prefix to the hex number.
1957 </xs:documentation>
1958 </xs:annotation>
1959 <xs:simpleType>
1960 <xs:restriction base="HexNumber">
1961 <xs:minLength value="3"/>
1962 </xs:restriction>
1963 </xs:simpleType>
1964 </xs:element>
1965 <xs:element minOccurs="0" maxOccurs="unbounded"
1966 name="ErrorMessage">
1967 <xs:complexType>
1968 <xs:simpleContent>
1969 <xs:extension base="xs:string">
1970 <xs:attribute name="Lang" type="xs:language" default="en-us"
1971 use="optional"/>
1972 </xs:extension>
1973 </xs:simpleContent>
1974 </xs:complexType>
1975 </xs:element>
1976 </xs:sequence>
1977 </xs:complexType>
1978 </xs:element>
1979 </xs:sequence>
1980 </xs:complexType>
1981 </xs:element>
1982
1983 <xs:element minOccurs="0" maxOccurs="unbounded" name="PcdExValue">
1984 <xs:annotation>
1985 <xs:documentation xml:lang="en-us">
1986 The element is the
1987 DynamicEx PCD Value that was used during the build.
1988 </xs:documentation>
1989 </xs:annotation>
1990 <xs:complexType>
1991 <xs:sequence>
1992 <xs:element minOccurs="1" maxOccurs="1"
1993 name="TokenSpaceGuidValue" type="RegistryFormatGuid"/>
1994 <xs:element minOccurs="1" maxOccurs="1" name="Token">
1995 <xs:annotation>
1996 <xs:documentation xml:lang="en-us">
1997 The minLength of 3 is
1998 required to handle the "0x" prefix to the hex number.
1999 </xs:documentation>
2000 </xs:annotation>
2001 <xs:simpleType>
2002 <xs:restriction base="HexNumber">
2003 <xs:minLength value="3"/>
2004 <xs:maxLength value="10"/>
2005 </xs:restriction>
2006 </xs:simpleType>
2007 </xs:element>
2008 <xs:element minOccurs="1" maxOccurs="1" name="DatumType"
2009 type="PcdDatumTypes"/>
2010 <xs:element minOccurs="0" maxOccurs="1" name="MaxDatumSize">
2011 <xs:annotation>
2012 <xs:documentation xml:lang="en-us">
2013 This field is required
2014 if the Pcd Datum Type is VOID*
2015 </xs:documentation>
2016 </xs:annotation>
2017 <xs:simpleType>
2018 <xs:restriction base="HexNumber">
2019 <xs:minLength value="3"/>
2020 </xs:restriction>
2021 </xs:simpleType>
2022 </xs:element>
2023 <xs:element minOccurs="1" maxOccurs="1" name="Value"
2024 type="xs:normalizedString"/>
2025 <xs:element ref="HelpText" minOccurs="0"
2026 maxOccurs="unbounded"/>
2027 <xs:element minOccurs="0" maxOccurs="unbounded"
2028 name="PcdError">
2029 <xs:annotation>
2030 <xs:documentation xml:lang="en-us">
2031 Error information
2032 implemented by the module.
2033 </xs:documentation>
2034 </xs:annotation>
2035 <xs:complexType>
2036 <xs:sequence>
2037 <xs:choice>
2038 <xs:element minOccurs="0" maxOccurs="1" name="ValidValueList">
2039 <xs:complexType>
2040 <xs:simpleContent>
2041 <xs:extension base="xs:normalizedString">
2042 <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"/>
2043 </xs:extension>
2044 </xs:simpleContent>
2045 </xs:complexType>
2046 </xs:element>
2047 <xs:element minOccurs="0" maxOccurs="1" name="ValidValueRange" type="xs:normalizedString"/>
2048 <xs:element minOccurs="0" maxOccurs="1" name="Expression" type="xs:normalizedString"/>
2049 </xs:choice>
2050 <xs:element minOccurs="1" maxOccurs="1" name="ErrorNumber">
2051 <xs:annotation>
2052 <xs:documentation xml:lang="en-us">
2053 The minLength of 3 is
2054 required to handle the "0x" prefix to the hex number.
2055 </xs:documentation>
2056 </xs:annotation>
2057 <xs:simpleType>
2058 <xs:restriction base="HexNumber">
2059 <xs:minLength value="3"/>
2060 </xs:restriction>
2061 </xs:simpleType>
2062 </xs:element>
2063 <xs:element minOccurs="0" maxOccurs="unbounded"
2064 name="ErrorMessage">
2065 <xs:complexType>
2066 <xs:simpleContent>
2067 <xs:extension base="xs:string">
2068 <xs:attribute name="Lang" type="xs:language" default="en-us"
2069 use="optional"/>
2070 </xs:extension>
2071 </xs:simpleContent>
2072 </xs:complexType>
2073 </xs:element>
2074 </xs:sequence>
2075 </xs:complexType>
2076 </xs:element>
2077 </xs:sequence>
2078 </xs:complexType>
2079 </xs:element>
2080
2081 <xs:element minOccurs="0" maxOccurs="1" name="LibraryInstances">
2082 <xs:annotation>
2083 <xs:documentation xml:lang="en-us">
2084 This is the actual
2085 library instance that was used to link against the module.
2086 </xs:documentation>
2087 </xs:annotation>
2088 <xs:complexType>
2089 <xs:sequence>
2090 <xs:element minOccurs="1" maxOccurs="unbounded" name="GUID">
2091 <xs:annotation>
2092 <xs:documentation xml:lang="en-us">
2093 This GUID and the
2094 Version attribute uniquely identify the actual Library
2095 Instance linked in this module.
2096 </xs:documentation>
2097 </xs:annotation>
2098 <xs:complexType>
2099 <xs:simpleContent>
2100 <xs:extension base="RegistryFormatGuid">
2101 <xs:attribute name="Version" type="xs:decimal"
2102 use="required">
2103 <xs:annotation>
2104 <xs:documentation xml:lang="en-us">
2105 This value, along with
2106 the GUID, is used to uniquely identify this object.
2107 </xs:documentation>
2108 </xs:annotation>
2109 </xs:attribute>
2110 </xs:extension>
2111 </xs:simpleContent>
2112 </xs:complexType>
2113 </xs:element>
2114 </xs:sequence>
2115 </xs:complexType>
2116 </xs:element>
2117
2118 <xs:element minOccurs="0" maxOccurs="unbounded" name="BuildFlags">
2119 <xs:complexType mixed="true">
2120 <xs:simpleContent>
2121 <xs:annotation>
2122 <xs:documentation xml:lang="en-us">
2123 Any description of OS,
2124 Tool, and flags for the individual tool can go in this
2125 section.
2126 </xs:documentation>
2127 </xs:annotation>
2128 <xs:extension base="xs:string">
2129 <xs:anyAttribute processContents="lax"/>
2130 </xs:extension>
2131 </xs:simpleContent>
2132 </xs:complexType>
2133 </xs:element>
2134 </xs:sequence>
2135 </xs:complexType>
2136 </xs:element>
2137 <!-- End of AsBuilt -->
2138 <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>
2139 </xs:sequence>
2140 </xs:complexType>
2141 </xs:element>
2142
2143 </xs:sequence>
2144 </xs:complexType>
2145 </xs:element>
2146 <!-- End of BinaryFiles Section -->
2147
2148 <xs:element minOccurs="0" maxOccurs="1" name="PackageDependencies">
2149 <xs:complexType>
2150 <xs:sequence>
2151 <xs:element minOccurs="1" maxOccurs="unbounded" name="Package">
2152 <xs:complexType>
2153 <xs:sequence>
2154 <xs:element minOccurs="0" maxOccurs="unbounded" name="Description">
2155 <xs:complexType>
2156 <xs:simpleContent>
2157 <xs:extension base="xs:string">
2158 <xs:attribute name="Lang" type="xs:language" default="en-us"
2159 use="optional"/>
2160 </xs:extension>
2161 </xs:simpleContent>
2162 </xs:complexType>
2163 </xs:element>
2164 <xs:element minOccurs="1" maxOccurs="1" name="GUID">
2165 <xs:annotation>
2166 <xs:documentation xml:lang="en-us">
2167 This GUID and the Version attribute
2168 uniquely identify Package that this Module depends on.
2169 </xs:documentation>
2170 </xs:annotation>
2171 <xs:complexType>
2172 <xs:simpleContent>
2173 <xs:extension base="RegistryFormatGuid">
2174 <xs:attribute name="Version" type="xs:decimal" use="optional">
2175 <xs:annotation>
2176 <xs:documentation xml:lang="en-us">
2177 This value, along with
2178 the GUID, is used to uniquely identify this object. If the
2179 version attribute is not specified, the most recent version
2180 of the package can be used.
2181 </xs:documentation>
2182 </xs:annotation>
2183 </xs:attribute>
2184 </xs:extension>
2185 </xs:simpleContent>
2186 </xs:complexType>
2187 </xs:element>
2188 </xs:sequence>
2189 <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>
2190 <xs:attribute name="SupModList" type="ModuleListType" use="optional"/>
2191 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
2192 </xs:complexType>
2193 </xs:element>
2194 </xs:sequence>
2195 </xs:complexType>
2196 </xs:element>
2197 <!-- End of PackageDependencies -->
2198
2199 <xs:element minOccurs="0" maxOccurs="1" name="Guids">
2200 <xs:complexType>
2201 <xs:sequence>
2202 <xs:element minOccurs="1" maxOccurs="unbounded" name="GuidCName">
2203 <xs:complexType>
2204 <xs:sequence>
2205 <xs:element minOccurs="1" maxOccurs="1" name="CName" type="xs:NCName"/>
2206 <xs:element minOccurs="0" maxOccurs="1" name="GUID" type="RegistryFormatGuid"/>
2207 <xs:element minOccurs="0" maxOccurs="1" name="VariableName"
2208 type="xs:normalizedString">
2209 <xs:annotation>
2210 <xs:documentation xml:lang="en-us"> Only valid for Variable GUID types. </xs:documentation>
2211 <xs:documentation>
2212 This can be either a Hex Array or C string in unicode
2213 format: L"string" Data.
2214 </xs:documentation>
2215 </xs:annotation>
2216 </xs:element>
2217 <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>
2218 </xs:sequence>
2219 <xs:attribute name="Usage" use="required">
2220 <xs:simpleType>
2221 <xs:restriction base="xs:NCName">
2222 <xs:enumeration value="CONSUMES">
2223 <xs:annotation>
2224 <xs:documentation xml:lang="en-us">
2225 The module does not install
2226 the GUID, and the GUID must be present for the module to
2227 execute.
2228 </xs:documentation>
2229 </xs:annotation>
2230 </xs:enumeration>
2231 <xs:enumeration value="SOMETIMES_CONSUMES">
2232 <xs:annotation>
2233 <xs:documentation xml:lang="en-us">
2234 The module does not install
2235 the GUID, however, the GUID will be used if it is present.
2236 </xs:documentation>
2237 </xs:annotation>
2238 </xs:enumeration>
2239 <xs:enumeration value="PRODUCES">
2240 <xs:annotation>
2241 <xs:documentation xml:lang="en-us">
2242 The module always installs
2243 the GUID.
2244 </xs:documentation>
2245 </xs:annotation>
2246 </xs:enumeration>
2247 <xs:enumeration value="SOMETIMES_PRODUCES">
2248 <xs:annotation>
2249 <xs:documentation xml:lang="en-us">
2250 The Module will install the
2251 GUID under certain execution paths.
2252 </xs:documentation>
2253 </xs:annotation>
2254 </xs:enumeration>
2255 <xs:enumeration value="UNDEFINED">
2256 <xs:annotation>
2257 <xs:documentation xml:lang="en-us">
2258 The package creator knows
2259 that a GUID is used, but does not know how it is used.
2260 </xs:documentation>
2261 </xs:annotation>
2262 </xs:enumeration>
2263 </xs:restriction>
2264 </xs:simpleType>
2265 </xs:attribute>
2266 <xs:attribute name="GuidType" type="GuidListType" use="required"/>
2267 <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>
2268 <xs:attribute name="SupModList" type="ModuleListType" use="optional"/>
2269 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
2270 </xs:complexType>
2271 </xs:element>
2272 </xs:sequence>
2273 </xs:complexType>
2274 </xs:element>
2275 <!-- End of Guids Section -->
2276
2277 <xs:element minOccurs="0" maxOccurs="1" name="Protocols">
2278 <xs:annotation>
2279 <xs:documentation xml:lang="en-us">
2280 A listing of protocols required or produced by this module.
2281 </xs:documentation>
2282 </xs:annotation>
2283 <xs:complexType>
2284 <xs:sequence>
2285 <xs:element minOccurs="1" maxOccurs="unbounded" name="Protocol" nillable="true">
2286 <xs:complexType>
2287 <xs:sequence>
2288 <xs:element minOccurs="1" maxOccurs="1" name="CName" type="xs:NCName"/>
2289 <xs:element minOccurs="0" maxOccurs="1" name="GUID" type="RegistryFormatGuid"/>
2290 <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>
2291 </xs:sequence>
2292 <xs:attribute name="Usage" use="required">
2293 <xs:simpleType>
2294 <xs:restriction base="xs:NCName">
2295 <xs:enumeration value="PRODUCES"/>
2296 <xs:enumeration value="SOMETIMES_PRODUCES"/>
2297 <xs:enumeration value="CONSUMES"/>
2298 <xs:enumeration value="SOMETIMES_CONSUMES"/>
2299 <xs:enumeration value="TO_START"/>
2300 <xs:enumeration value="BY_START"/>
2301 <xs:enumeration value="UNDEFINED"/>
2302 </xs:restriction>
2303 </xs:simpleType>
2304 </xs:attribute>
2305 <xs:attribute name="Notify" type="xs:boolean" use="optional"/>
2306 <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>
2307 <xs:attribute name="SupModList" type="ModuleListType" use="optional"/>
2308 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
2309 </xs:complexType>
2310 </xs:element>
2311 </xs:sequence>
2312 </xs:complexType>
2313 </xs:element>
2314 <!-- End of Protocols Section -->
2315
2316 <xs:element minOccurs="0" maxOccurs="1" name="PPIs">
2317 <xs:annotation>
2318 <xs:documentation xml:lang="en-us">
2319 A listing of PPIs required or produced by this module.
2320 </xs:documentation>
2321 </xs:annotation>
2322 <xs:complexType>
2323 <xs:sequence>
2324 <xs:element minOccurs="1" maxOccurs="unbounded" name="Ppi" nillable="true">
2325 <xs:complexType>
2326 <xs:sequence>
2327 <xs:element minOccurs="1" maxOccurs="1" name="CName" type="xs:NCName"/>
2328 <xs:element minOccurs="0" maxOccurs="1" name="GUID" type="RegistryFormatGuid"/>
2329 <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>
2330 </xs:sequence>
2331 <xs:attribute name="Usage" use="required">
2332 <xs:simpleType>
2333 <xs:restriction base="xs:NCName">
2334 <xs:enumeration value="PRODUCES"/>
2335 <xs:enumeration value="SOMETIMES_PRODUCES"/>
2336 <xs:enumeration value="CONSUMES"/>
2337 <xs:enumeration value="SOMETIMES_CONSUMES"/>
2338 <xs:enumeration value="UNDEFINED"/>
2339 </xs:restriction>
2340 </xs:simpleType>
2341 </xs:attribute>
2342 <xs:attribute name="Notify" type="xs:boolean" use="optional"/>
2343 <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>
2344 <xs:attribute name="SupModList" type="ModuleListType" use="optional"/>
2345 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
2346 </xs:complexType>
2347 </xs:element>
2348 </xs:sequence>
2349 </xs:complexType>
2350 </xs:element>
2351 <!-- End of PPIs Section -->
2352
2353 <xs:element minOccurs="0" maxOccurs="1" name="Externs">
2354 <xs:annotation>
2355 <xs:documentation xml:lang="en-us">
2356 These elements specify additional information about the
2357 module. This area may be used by tools to generate code.
2358 </xs:documentation>
2359 </xs:annotation>
2360 <xs:complexType>
2361 <xs:sequence>
2362 <xs:element minOccurs="1" maxOccurs="unbounded" name="Extern">
2363 <xs:complexType>
2364 <xs:sequence>
2365 <xs:choice minOccurs="1">
2366 <xs:sequence>
2367 <xs:element minOccurs="0" maxOccurs="1" name="EntryPoint"
2368 type="xs:NCName"/>
2369 <xs:element minOccurs="0" maxOccurs="1" name="UnloadImage"
2370 type="xs:NCName"/>
2371 </xs:sequence>
2372 <xs:sequence>
2373 <xs:element minOccurs="0" maxOccurs="1" name="Constructor"
2374 type="xs:NCName"/>
2375 <xs:element minOccurs="0" maxOccurs="1" name="Destructor"
2376 type="xs:NCName"/>
2377 </xs:sequence>
2378 </xs:choice>
2379 <xs:element ref="HelpText" minOccurs="0" maxOccurs="1"/>
2380 </xs:sequence>
2381 <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>
2382 <xs:attribute name="SupModList" type="ModuleListType" use="optional"/>
2383 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
2384 </xs:complexType>
2385 </xs:element>
2386 </xs:sequence>
2387 </xs:complexType>
2388 </xs:element>
2389 <!-- End of Externs Section -->
2390
2391 <xs:element minOccurs="0" maxOccurs="1" name="PcdCoded">
2392 <xs:annotation>
2393 <xs:documentation xml:lang="en-us">
2394 This section describes how a platform is coded with respect
2395 to the platform configuration knobs.
2396 </xs:documentation>
2397 </xs:annotation>
2398 <xs:complexType>
2399 <xs:sequence>
2400 <xs:element minOccurs="1" maxOccurs="unbounded" name="PcdEntry">
2401 <xs:complexType>
2402 <xs:sequence>
2403 <xs:element minOccurs="1" maxOccurs="1" name="CName" type="xs:NCName"/>
2404 <xs:element minOccurs="1" maxOccurs="1" name="TokenSpaceGuidCName"
2405 type="xs:NCName"/>
2406 <xs:element minOccurs="0" maxOccurs="1" name="DefaultValue"
2407 type="xs:normalizedString"/>
2408 <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>
2409 </xs:sequence>
2410 <xs:attribute name="PcdItemType" type="PcdItemTypes" use="required"/>
2411 <xs:attribute name="PcdUsage" use="required">
2412 <xs:simpleType>
2413 <xs:restriction base="xs:NCName">
2414 <xs:enumeration value="PRODUCES"/>
2415 <xs:enumeration value="SOMETIMES_PRODUCES"/>
2416 <xs:enumeration value="CONSUMES"/>
2417 <xs:enumeration value="SOMETIMES_CONSUMES"/>
2418 <xs:enumeration value="UNDEFINED"/>
2419 </xs:restriction>
2420 </xs:simpleType>
2421
2422
2423 </xs:attribute>
2424 <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>
2425 <xs:attribute name="SupModList" type="ModuleListType" use="optional"/>
2426 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
2427 </xs:complexType>
2428 </xs:element>
2429 </xs:sequence>
2430 </xs:complexType>
2431 </xs:element>
2432 <!-- End of PcdCoded Section -->
2433
2434 <xs:element minOccurs="0" maxOccurs="unbounded" name="PeiDepex">
2435 <xs:annotation>
2436 <xs:documentation xml:lang="en-us">
2437 This is the PEI dependency expression for a Dependency
2438 Section.
2439 </xs:documentation>
2440 </xs:annotation>
2441 <xs:complexType>
2442 <xs:sequence>
2443 <xs:element name="Expression" type="xs:string" minOccurs="1" maxOccurs="1">
2444 <xs:annotation>
2445 <xs:documentation xml:lang="en-us">
2446 An in-fix expression, of C identifiers and TRUE,
2447 FALSE, AND, OR, NOT, BEFORE, and AFTER as well as parenthesis () in the in-fix
2448 notation. The operators are restricted to grammar defined in the PI
2449 specification.
2450 </xs:documentation>
2451 </xs:annotation>
2452 </xs:element>
2453 <xs:element ref="HelpText" minOccurs="0" maxOccurs="1"/>
2454 </xs:sequence>
2455 <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>
2456 <xs:attribute name="SupModList" type="ModuleListType" use="optional"/>
2457 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
2458 </xs:complexType>
2459 </xs:element>
2460 <!-- End of PeiDepex Section -->
2461
2462 <xs:element minOccurs="0" maxOccurs="unbounded" name="DxeDepex">
2463 <xs:annotation>
2464 <xs:documentation xml:lang="en-us">
2465 This is the DXE dependency expression for a Dependency
2466 Section.
2467 </xs:documentation>
2468 </xs:annotation>
2469 <xs:complexType>
2470 <xs:sequence>
2471 <xs:element name="Expression" type=" xs:string " minOccurs="1" maxOccurs="1">
2472 <xs:annotation>
2473 <xs:documentation xml:lang="en-us">
2474 An in-fix expression, of C identifiers and TRUE,
2475 FALSE, AND, OR, NOT, BEFORE, and AFTER as well as parenthesis () in the in-fix
2476 notation. The operators are restricted to grammar defined in the PI
2477 specification.
2478 </xs:documentation>
2479 </xs:annotation>
2480 </xs:element>
2481 <xs:element ref="HelpText" minOccurs="0" maxOccurs="1"/>
2482 </xs:sequence>
2483 <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>
2484 <xs:attribute name="SupModList" type="ModuleListType" use="optional"/>
2485 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
2486 </xs:complexType>
2487 </xs:element>
2488 <!-- End of DxeDepex Section -->
2489
2490 <xs:element minOccurs="0" maxOccurs="unbounded" name="SmmDepex">
2491 <xs:annotation>
2492 <xs:documentation xml:lang="en-us">
2493 This is the SMM dependency expression for a Dependency
2494 Section.
2495 </xs:documentation>
2496 </xs:annotation>
2497 <xs:complexType>
2498 <xs:sequence>
2499 <xs:element name="Expression" type=" xs:string " minOccurs="1" maxOccurs="1">
2500 <xs:annotation>
2501 <xs:documentation xml:lang="en-us">
2502 An in-fix expression, of C identifiers and TRUE,
2503 FALSE, AND, OR, NOT, BEFORE, and AFTER as well as parenthesis () in the in-fix
2504 notation. The operators are restricted to grammar defined in the PI
2505 specification.
2506 </xs:documentation>
2507 </xs:annotation>
2508 </xs:element>
2509 <xs:element ref="HelpText" minOccurs="0" maxOccurs="1"/>
2510 </xs:sequence>
2511 <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>
2512 <xs:attribute name="SupModList" type="ModuleListType" use="optional"/>
2513 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
2514 </xs:complexType>
2515 </xs:element>
2516 <!-- End of SmmDepex Section -->
2517
2518
2519 <xs:element minOccurs="0" maxOccurs="1" name="MiscellaneousFiles">
2520 <xs:annotation>
2521 <xs:documentation xml:lang="en-us">
2522 This section is used to provide comments and/or list
2523 auxiliary files, such as pdb or map files.
2524 </xs:documentation>
2525 </xs:annotation>
2526 <xs:complexType>
2527 <xs:sequence>
2528 <xs:element minOccurs="0" maxOccurs="unbounded" name="Description">
2529 <xs:complexType>
2530 <xs:simpleContent>
2531 <xs:extension base="xs:string">
2532 <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"
2533 />
2534 </xs:extension>
2535 </xs:simpleContent>
2536 </xs:complexType>
2537 </xs:element>
2538 <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename">
2539 <xs:annotation>
2540 <xs:documentation xml:lang="en-us">
2541 This is the path and filename location within
2542 the ZIP file.
2543 </xs:documentation>
2544 </xs:annotation>
2545 <xs:complexType>
2546 <xs:simpleContent>
2547 <xs:extension base="xs:anyURI">
2548 <xs:attribute name="Executable" type="xs:boolean" default="false"
2549 use="optional">
2550 <xs:annotation>
2551 <xs:documentation xml:lang="en-us">
2552 If true, used by installation
2553 tools to ensure that a file that must be executable has the
2554 correct properties to permit execution.
2555 </xs:documentation>
2556 </xs:annotation>
2557 </xs:attribute>
2558 </xs:extension>
2559 </xs:simpleContent>
2560 </xs:complexType>
2561 </xs:element>
2562 </xs:sequence>
2563 </xs:complexType>
2564 </xs:element>
2565 <!-- End of Module Surface Area Misc Section -->
2566
2567 <xs:element minOccurs="0" maxOccurs="unbounded" name="UserExtensions">
2568 <xs:annotation>
2569 <xs:documentation xml:lang="en-us">
2570 This section is used for any processing instructions that
2571 may be custom to the content provided by the distribution that are common to module.
2572 </xs:documentation>
2573 <xs:documentation xml:lang="en-us"> The content is vendor specific. </xs:documentation>
2574 <xs:documentation xml:lang="en-us">
2575 The content can be plain text as well as any user-defined,
2576 properly formatted XML structure.
2577 </xs:documentation>
2578 </xs:annotation>
2579 <xs:complexType mixed="true">
2580 <xs:attribute name="UserId" type="xs:NCName" use="required">
2581 <xs:annotation>
2582 <xs:documentation xml:lang="en-us">
2583 This is a single word identifier for grouping
2584 similar content. For example, ReferenceBuild might be used to identify non-PI
2585 compliant build steps, with two different UserExtensions sections, one with an
2586 Identifier of Prebuild, and another of PostBuild. Both UserExtensions sections would
2587 use the same UserId.
2588 </xs:documentation>
2589 </xs:annotation>
2590 </xs:attribute>
2591 <xs:attribute name="Identifier" type="xs:string" use="required">
2592 <xs:annotation>
2593 <xs:documentation xml:lang="en-us">
2594 This can be any string used to differentiate or
2595 identify this section from other UserExtensions sections.
2596 </xs:documentation>
2597 <xs:documentation xml:lang="en-us">
2598 For example, a PRE_PROCESS Identifier might indicate
2599 specific steps and tools required before processing module content, while a
2600 different UserExtensions section with a POST_PROCESS Identifier might describe steps
2601 that need to be executed after operations on this module.
2602 </xs:documentation>
2603 </xs:annotation>
2604 </xs:attribute>
2605 <xs:anyAttribute processContents="lax"/>
2606 </xs:complexType>
2607 </xs:element>
2608 <!-- End of Module Surface Area UserExtensions Section -->
2609
2610 </xs:sequence>
2611 <xs:attribute name="BinaryModule" type="xs:boolean" default="false" use="optional">
2612 <xs:annotation>
2613 <xs:documentation xml:lang="en-us">
2614 This attribute is used when the binaries are distributed for
2615 this module and no code generation from source files is required. If set, then the BinaryFiles
2616 section should be used, and any files listed in the SourceFiles section do not have to be built.
2617 Additionally, the AsBuilt section for each binary file must be included.
2618 </xs:documentation>
2619 </xs:annotation>
2620 </xs:attribute>
2621 </xs:complexType>
2622
2623 </xs:element>
2624 <!-- End of the ModuleSurfaceArea element. -->
2625
2626 <xs:element name="Tools">
2627 <xs:complexType>
2628 <xs:sequence>
2629 <xs:element minOccurs="0" maxOccurs="1" name="Header">
2630 <xs:complexType>
2631 <xs:sequence>
2632 <xs:element minOccurs="1" maxOccurs="1" name="Name" type="xs:normalizedString">
2633 <xs:annotation>
2634 <xs:documentation xml:lang="en-us">
2635 This is the User Interface Name for this Tools
2636 Distribution.
2637 </xs:documentation>
2638 </xs:annotation>
2639 </xs:element>
2640 <xs:element minOccurs="0" maxOccurs="1" name="Copyright" type="xs:string">
2641 <xs:annotation>
2642 <xs:documentation xml:lang="en-us">
2643 This is only required if the Copyright is
2644 different from the Distribution Package copyright.
2645 </xs:documentation>
2646 </xs:annotation>
2647 </xs:element>
2648 <xs:element minOccurs="0" maxOccurs="1" name="License" type="xs:string">
2649 <xs:annotation>
2650 <xs:documentation xml:lang="en-us">
2651 This is only required if the License is
2652 different from the Distribution Package license.
2653 </xs:documentation>
2654 </xs:annotation>
2655 </xs:element>
2656 <xs:element minOccurs="0" maxOccurs="1" name="Abstract">
2657 <xs:annotation>
2658 <xs:documentation xml:lang="en-us">
2659 This is only required if the Abstract is
2660 different from the Distribution Package Abstract.
2661 </xs:documentation>
2662 </xs:annotation>
2663 <xs:complexType>
2664 <xs:simpleContent>
2665 <xs:extension base="xs:normalizedString">
2666 <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"/>
2667 </xs:extension>
2668 </xs:simpleContent>
2669 </xs:complexType>
2670 </xs:element>
2671 <xs:element minOccurs="0" maxOccurs="1" name="Description">
2672 <xs:annotation>
2673 <xs:documentation xml:lang="en-us">
2674 This is only required if the Description is
2675 different from the Distribution Package Description.
2676 </xs:documentation>
2677 </xs:annotation>
2678 <xs:complexType>
2679 <xs:simpleContent>
2680 <xs:extension base="xs:string">
2681 <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"/>
2682 </xs:extension>
2683 </xs:simpleContent>
2684 </xs:complexType>
2685
2686 </xs:element>
2687 </xs:sequence>
2688 </xs:complexType>
2689 </xs:element>
2690 <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename">
2691 <xs:annotation>
2692 <xs:documentation xml:lang="en-us">
2693 This is the path and filename location within the ZIP file.
2694 </xs:documentation>
2695 </xs:annotation>
2696 <xs:complexType>
2697 <xs:simpleContent>
2698 <xs:extension base="xs:anyURI">
2699 <xs:attribute name="OS" type="SupportedOs" use="optional">
2700 <xs:annotation>
2701 <xs:documentation xml:lang="en-us">
2702 This is required for tools that execute; it
2703 should not be used for configuration files.
2704 </xs:documentation>
2705 </xs:annotation>
2706 </xs:attribute>
2707 <xs:attribute name="Executable" type="xs:boolean" default="false" use="optional">
2708 <xs:annotation>
2709 <xs:documentation xml:lang="en-us">
2710 If true, used by installation tools to
2711 ensure that a file that must be executable has the correct properties to
2712 permit execution.
2713 </xs:documentation>
2714 </xs:annotation>
2715 </xs:attribute>
2716 </xs:extension>
2717 </xs:simpleContent>
2718 </xs:complexType>
2719 </xs:element>
2720 </xs:sequence>
2721 </xs:complexType>
2722 </xs:element>
2723 <!-- End of the Tools element. -->
2724
2725 <xs:element name="MiscellaneousFiles">
2726 <xs:annotation>
2727 <xs:documentation xml:lang="en-us">
2728 This section contains a list of files that are not part of the code
2729 distributed with modules, packages or tools.
2730 </xs:documentation>
2731 </xs:annotation>
2732 <xs:complexType>
2733 <xs:sequence>
2734 <xs:element minOccurs="0" maxOccurs="1" name="Header">
2735 <xs:complexType>
2736 <xs:sequence>
2737 <xs:element minOccurs="0" maxOccurs="1" name="Name" type="xs:normalizedString">
2738 <xs:annotation>
2739 <xs:documentation xml:lang="en-us">
2740 The User interface name for this content.
2741 </xs:documentation>
2742 </xs:annotation>
2743 </xs:element>
2744 <xs:element minOccurs="0" maxOccurs="1" name="Copyright" type="xs:string">
2745 <xs:annotation>
2746 <xs:documentation xml:lang="en-us">
2747 This is only required if the Copyright is
2748 different from the Distribution Package Copyright.
2749 </xs:documentation>
2750 </xs:annotation>
2751 </xs:element>
2752 <xs:element minOccurs="0" maxOccurs="1" name="License" type="xs:string">
2753 <xs:annotation>
2754 <xs:documentation xml:lang="en-us">
2755 This is only required if the License is
2756 different from the Distribution Package License.
2757 </xs:documentation>
2758 </xs:annotation>
2759 </xs:element>
2760 <xs:element minOccurs="0" maxOccurs="1" name="Abstract" type="xs:normalizedString"/>
2761 <xs:element minOccurs="0" maxOccurs="unbounded" name="Description">
2762 <xs:complexType>
2763 <xs:simpleContent>
2764 <xs:extension base="xs:string">
2765 <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"
2766 />
2767 </xs:extension>
2768 </xs:simpleContent>
2769 </xs:complexType>
2770 </xs:element>
2771 </xs:sequence>
2772 </xs:complexType>
2773 </xs:element>
2774 <xs:element minOccurs="0" maxOccurs="unbounded" name="Filename">
2775 <xs:annotation>
2776 <xs:documentation xml:lang="en-us">
2777 This is the path and filename location within the ZIP file.
2778 </xs:documentation>
2779 </xs:annotation>
2780 <xs:complexType>
2781 <xs:simpleContent>
2782 <xs:extension base="xs:anyURI">
2783 <xs:attribute name="Executable" type="xs:boolean" default="false" use="optional">
2784 <xs:annotation>
2785 <xs:documentation xml:lang="en-us">
2786 If true, used by installation tools to
2787 ensure that a file that must be executable has the correct properties to
2788 permit execution.
2789 </xs:documentation>
2790 </xs:annotation>
2791 </xs:attribute>
2792 </xs:extension>
2793 </xs:simpleContent>
2794 </xs:complexType>
2795 </xs:element>
2796 </xs:sequence>
2797 </xs:complexType>
2798 </xs:element>
2799 <!-- End of the Misc element. -->
2800
2801 <xs:element name="UserExtensions">
2802 <xs:complexType mixed="true">
2803 <xs:sequence>
2804 <xs:any processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
2805 </xs:sequence>
2806 <xs:attribute name="UserId" type="xs:NCName" use="required">
2807 <xs:annotation>
2808 <xs:documentation xml:lang="en-us">
2809 This is a single word identifier for grouping similar content.
2810 For example, ReferenceBuild might be used to identify non-PI compliant build steps, with two
2811 different UserExtensions sections, one with an Identifier of Prebuild, and another of PostBuild.
2812 Both UserExtensions sections would use the same UserId.
2813 </xs:documentation>
2814 </xs:annotation>
2815 </xs:attribute>
2816 <xs:attribute name="Identifier" type="xs:string" use="optional">
2817 <xs:annotation>
2818 <xs:documentation xml:lang="en-us">
2819 This can be any string used to differentiate or identify this
2820 section from other UserExtensions sections.
2821 </xs:documentation>
2822 <xs:documentation xml:lang="en-us">
2823 For example, a PRE_PROCESS Identifier might indicate specific
2824 steps and tools required before processing distribution package content, while a different
2825 UserExtensions section with a POST_PROCESS Identifier might describe steps that need to be
2826 executed after operations on this content.
2827 </xs:documentation>
2828 </xs:annotation>
2829 </xs:attribute>
2830 <xs:anyAttribute processContents="lax"/>
2831 </xs:complexType>
2832 </xs:element>
2833 <!-- The following elements are common definitions used with the ref attribute for elements. -->
2834
2835 <xs:element name="HelpText">
2836 <xs:complexType>
2837 <xs:simpleContent>
2838 <xs:extension base="xs:string">
2839 <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"/>
2840 </xs:extension>
2841 </xs:simpleContent>
2842 </xs:complexType>
2843 </xs:element>
2844
2845 <!-- The following attribute groups are used in various elements above. -->
2846
2847 <xs:attributeGroup name="SupportedArchMod">
2848 <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>
2849 <xs:attribute name="SupModList" type="ModuleListType" use="optional"/>
2850 </xs:attributeGroup>
2851
2852 <!-- The following data types are used to restrict content. -->
2853
2854 <xs:simpleType name="ArchListType">
2855 <xs:list itemType="ArchTypes"/>
2856 </xs:simpleType>
2857
2858 <xs:simpleType name="ArchTypes">
2859 <xs:restriction base="xs:NCName">
2860 <xs:enumeration value="IA32"/>
2861 <xs:enumeration value="X64"/>
2862 <xs:enumeration value="IPF"/>
2863 <xs:enumeration value="EBC"/>
2864 <xs:enumeration value="ARM"/>
2865 <xs:pattern value="([A-Z])([a-zA-Z0-9])*">
2866 <xs:annotation>
2867 <xs:documentation xml:lang="en-us">
2868 Any processor architecture not listed above. The Architecture
2869 must be a target architecture of one or more compiler tool chains.
2870 </xs:documentation>
2871 </xs:annotation>
2872 </xs:pattern>
2873 </xs:restriction>
2874 </xs:simpleType>
2875
2876
2877 <xs:simpleType name="FamilyTypes">
2878 <xs:restriction base="xs:NCName">
2879 <xs:enumeration value="MSFT"/>
2880 <xs:enumeration value="GCC"/>
2881 <xs:pattern value="[A-Z][a-zA-Z0-9]*">
2882 <xs:annotation>
2883 <xs:documentation xml:lang="en-us">
2884 Any other family of build utilities for which compiler tools
2885 exist.
2886 </xs:documentation>
2887 </xs:annotation>
2888 </xs:pattern>
2889 </xs:restriction>
2890 </xs:simpleType>
2891
2892 <xs:simpleType name="GuidListType">
2893 <xs:list itemType="GuidTypes"/>
2894 </xs:simpleType>
2895
2896 <xs:simpleType name="GuidTypes">
2897 <xs:restriction base="xs:NCName">
2898 <xs:enumeration value="Event"/>
2899 <xs:enumeration value="File"/>
2900 <xs:enumeration value="FV"/>
2901 <xs:enumeration value="GUID"/>
2902 <xs:enumeration value="HII"/>
2903 <xs:enumeration value="Hii"/>
2904 <xs:enumeration value="HOB"/>
2905 <xs:enumeration value="SystemTable"/>
2906 <xs:enumeration value="TokenSpaceGuid"/>
2907 <xs:enumeration value="Variable"/>
2908 <xs:enumeration value="UNDEFINED"/>
2909 </xs:restriction>
2910 </xs:simpleType>
2911
2912 <xs:simpleType name="HexNumber">
2913 <xs:restriction base="xs:hexBinary">
2914 <xs:pattern value="0x([a-fA-F0-9])+"/>
2915 </xs:restriction>
2916 </xs:simpleType>
2917
2918 <xs:simpleType name="Md5Sum">
2919 <xs:restriction base="xs:normalizedString">
2920 <xs:pattern value="[a-zA-Z0-9]{32}"/>
2921 </xs:restriction>
2922 </xs:simpleType>
2923
2924 <xs:simpleType name="ModuleListType">
2925 <xs:list itemType="ModuleTypes"/>
2926 </xs:simpleType>
2927
2928 <xs:simpleType name="ModuleTypes">
2929 <xs:annotation>
2930 <xs:documentation xml:lang="en-us"> The following module types are defined by specifications. </xs:documentation>
2931 <xs:documentation xml:lang="en-us">
2932 Module types for components and libraries defined for this distribution
2933 mechanism.
2934 </xs:documentation>
2935 </xs:annotation>
2936 <xs:restriction base="xs:NCName">
2937 <xs:enumeration value="BASE ">
2938 <xs:annotation>
2939 <xs:documentation xml:lang="en-us"> Use of this module is not restricted. </xs:documentation>
2940 </xs:annotation>
2941 </xs:enumeration>
2942 <xs:enumeration value="DXE_CORE">
2943 <xs:annotation>
2944 <xs:documentation xml:lang="en-us">
2945 This module is only applicable to the DXE core.
2946 </xs:documentation>
2947 </xs:annotation>
2948 </xs:enumeration>
2949 <xs:enumeration value="DXE_DRIVER">
2950 <xs:annotation>
2951 <xs:documentation xml:lang="en-us">
2952 This module is only applicable to a DXE driver.
2953 </xs:documentation>
2954 </xs:annotation>
2955 </xs:enumeration>
2956 <xs:enumeration value="DXE_RUNTIME_DRIVER">
2957 <xs:annotation>
2958 <xs:documentation xml:lang="en-us">
2959 This module is only applicable to a DXE runtime driver.
2960 </xs:documentation>
2961 </xs:annotation>
2962 </xs:enumeration>
2963 <xs:enumeration value="DXE_SAL_DRIVER">
2964 <xs:annotation>
2965 <xs:documentation xml:lang="en-us">
2966 This module is only applicable to an IPF DXE runtime driver.
2967 </xs:documentation>
2968 </xs:annotation>
2969 </xs:enumeration>
2970 <xs:enumeration value="DXE_SMM_DRIVER">
2971 <xs:annotation>
2972 <xs:documentation xml:lang="en-us">
2973 This module is only applicable to a DXE SMM driver.
2974 </xs:documentation>
2975 </xs:annotation>
2976 </xs:enumeration>
2977 <xs:enumeration value="PEI_CORE">
2978 <xs:annotation>
2979 <xs:documentation xml:lang="en-us">
2980 This module is only applicable to the PEI core.
2981 </xs:documentation>
2982 </xs:annotation>
2983 </xs:enumeration>
2984 <xs:enumeration value="PEIM">
2985 <xs:annotation>
2986 <xs:documentation xml:lang="en-us"> This module is only valid for PEI modules. </xs:documentation>
2987 </xs:annotation>
2988 </xs:enumeration>
2989 <xs:enumeration value="SEC">
2990 <xs:annotation>
2991 <xs:documentation xml:lang="en-us">
2992 This module is only applicable to Security phase.
2993 </xs:documentation>
2994 </xs:annotation>
2995 </xs:enumeration>
2996 <xs:enumeration value="UEFI_DRIVER">
2997 <xs:annotation>
2998 <xs:documentation xml:lang="en-us"> This module is only valid for UEFI drivers. </xs:documentation>
2999 </xs:annotation>
3000 </xs:enumeration>
3001 <xs:enumeration value="UEFI_RUNTIME_DRIVER">
3002 <xs:annotation>
3003 <xs:documentation xml:lang="en-us">
3004 This module is only valid for UEFI runtime
3005 drivers.
3006 </xs:documentation>
3007 </xs:annotation>
3008 </xs:enumeration>
3009 <xs:enumeration value="UEFI_APPLICATION">
3010 <xs:annotation>
3011 <xs:documentation xml:lang="en-us">
3012 This module is only valid for UEFI applications.
3013 </xs:documentation>
3014 </xs:annotation>
3015 </xs:enumeration>
3016 <xs:enumeration value="SMM_CORE">
3017 <xs:annotation>
3018 <xs:documentation xml:lang="en-us">
3019 This module is only applicable to the SMM
3020 core.
3021 </xs:documentation>
3022 </xs:annotation>
3023 </xs:enumeration>
3024 <xs:enumeration value="USER_DEFINED">
3025 <xs:annotation>
3026 <xs:documentation xml:lang="en-us">
3027 This content is restricted to a specific implementation.
3028 </xs:documentation>
3029 </xs:annotation>
3030 </xs:enumeration>
3031 <xs:enumeration value="UNDEFINED">
3032 <xs:annotation>
3033 <xs:documentation xml:lang="en-us">
3034 This enumeration is for use in a list that where the package
3035 creator does not know the what module types are supported by a module.
3036 </xs:documentation>
3037 </xs:annotation>
3038 </xs:enumeration>
3039 <xs:pattern value="([A-Z])([a-zA-Z0-9])*">
3040 <xs:annotation>
3041 <xs:documentation xml:lang="en-us">
3042 This pattern has been added for use in a module lists - for
3043 future expansion.
3044 </xs:documentation>
3045 </xs:annotation>
3046 </xs:pattern>
3047 </xs:restriction>
3048 </xs:simpleType>
3049
3050 <xs:simpleType name="PcdDatumTypes">
3051 <xs:annotation>
3052 <xs:documentation xml:lang="en-us">
3053 The following data types are defined by the PCD specification (or PCD
3054 section of the UEFI/PI specifications.)
3055 </xs:documentation>
3056 </xs:annotation>
3057 <xs:restriction base="xs:normalizedString">
3058 <xs:enumeration value="UINT8"/>
3059 <xs:enumeration value="UINT16"/>
3060 <xs:enumeration value="UINT32"/>
3061 <xs:enumeration value="UINT64"/>
3062 <xs:enumeration value="BOOLEAN"/>
3063 <xs:enumeration value="VOID*"/>
3064 </xs:restriction>
3065 </xs:simpleType>
3066
3067 <xs:simpleType name="PcdItemListType">
3068 <xs:list itemType="PcdItemTypes"/>
3069 </xs:simpleType>
3070
3071 <xs:simpleType name="PcdItemTypes">
3072 <xs:restriction base="xs:NCName">
3073 <xs:enumeration value="FeaturePcd">
3074 <xs:annotation>
3075 <xs:documentation xml:lang="en-us">
3076 The Feature PCD is a binary, evaluating to either true or false.
3077 This is used during build to include/exclude content. It can also be used during execution to
3078 force execution paths within drivers, or to enable/disable features within a driver for a given
3079 platform.
3080 </xs:documentation>
3081 </xs:annotation>
3082 </xs:enumeration>
3083 <xs:enumeration value="FixedPcd">
3084 <xs:annotation>
3085 <xs:documentation xml:lang="en-us">
3086 The Fixed PCD is a #define value that is set at build time.
3087 </xs:documentation>
3088 </xs:annotation>
3089 </xs:enumeration>
3090 <xs:enumeration value="PatchPcd">
3091 <xs:annotation>
3092 <xs:documentation xml:lang="en-us">
3093 The Patch PCD is a #define that is set at build time, and that
3094 can be modified within a binary file. Additional information, such as the offset location of the
3095 value, along with its length may need to be provided.
3096 </xs:documentation>
3097 </xs:annotation>
3098 </xs:enumeration>
3099 <xs:enumeration value="Pcd">
3100 <xs:annotation>
3101 <xs:documentation xml:lang="en-us">
3102 This PCD type has an overloaded definition. Prior to build, the
3103 platform integrator may choose to implement a PCD as Fixed, Patchable or a Dynamic PCD. If the
3104 platform integrator choose to use the PCD as dynamic, then a PCD driver is required in the
3105 platform (PEI/DXE/both) to track the PCD in some sort of 'database' of these items. For Dynamic
3106 PCDs, the PcdGet* must pass in the token space guid and the token number to retrieve data
3107 (PcdSet* also needs these values.)
3108 </xs:documentation>
3109 </xs:annotation>
3110 </xs:enumeration>
3111 <xs:enumeration value="PcdEx">
3112 <xs:annotation>
3113 <xs:documentation xml:lang="en-us">
3114 The PCD can only be used as Dynamic, and the platform firmware
3115 must contain a driver to maintain a 'database' of these items. For Dynamic PCDs, the PcdGet*
3116 must pass in the token space guid and the token number to retrieve data (PcdSet* also needs
3117 these values.)
3118 </xs:documentation>
3119 </xs:annotation>
3120 </xs:enumeration>
3121 </xs:restriction>
3122 </xs:simpleType>
3123
3124 <xs:simpleType name="RegistryFormatGuid">
3125 <xs:annotation>
3126 <xs:documentation xml:lang="en-us">
3127 A GUID must contain five different Hexadecimal character sets that are
3128 separated by a dash (-) character.
3129 </xs:documentation>
3130 </xs:annotation>
3131 <xs:restriction base="xs:string">
3132 <xs:pattern value="\s*[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\s*"/>
3133 </xs:restriction>
3134 </xs:simpleType>
3135
3136 <xs:simpleType name="SupportedOs">
3137 <xs:annotation>
3138 <xs:documentation xml:lang="en-us">
3139 The EDK II build system supports workstations running one of the
3140 following supported operating systems. This is the OS for the developer's workstation, not the target
3141 platform.
3142 </xs:documentation>
3143 </xs:annotation>
3144 <xs:restriction base="xs:string">
3145 <xs:enumeration value="Win32">
3146 <xs:annotation>
3147 <xs:documentation xml:lang="en-us">
3148 For Windows 2003, Windows XP and Windows Vista.
3149 </xs:documentation>
3150 </xs:annotation>
3151 </xs:enumeration>
3152 <xs:enumeration value="Win64">
3153 <xs:annotation>
3154 <xs:documentation xml:lang="en-us">
3155 For Windows 2003, Windows XP and Windows Vista.
3156 </xs:documentation>
3157 </xs:annotation>
3158 </xs:enumeration>
3159 <xs:enumeration value="RedHat32"/>
3160 <xs:enumeration value="RedHat64"/>
3161 <xs:enumeration value="SuSE32"/>
3162 <xs:enumeration value="SuSE64"/>
3163 <xs:enumeration value="Linux32"/>
3164 <xs:enumeration value="Linux64"/>
3165 <xs:enumeration value="OS/X32"/>
3166 <xs:enumeration value="OS/X64"/>
3167 <xs:enumeration value="Generic"/>
3168 <xs:enumeration value="GenericWin">
3169 <xs:annotation>
3170 <xs:documentation xml:lang="en-us">
3171 Typically, this is used for Windows Batch files.
3172 </xs:documentation>
3173 </xs:annotation>
3174 </xs:enumeration>
3175 <xs:enumeration value="GenericNix">
3176 <xs:annotation>
3177 <xs:documentation xml:lang="en-us">
3178 Typically use for shell scripts - valid for any Linux and Mac
3179 OS/X.
3180 </xs:documentation>
3181 </xs:annotation>
3182 </xs:enumeration>
3183 <xs:pattern value="[a-zA-Z]([a-zA-Z0-9])*"/>
3184 </xs:restriction>
3185 </xs:simpleType>
3186
3187</xs:schema>
注意: 瀏覽 TracBrowser 來幫助您使用儲存庫瀏覽器

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette