1 <?xml version="1.0" encoding="UTF-8"?>
3 Filename: DistributionPackage.xsd
5 Copyright (c) 2008 - 2011, Intel Corporation. All rights reserved.
7 This program and the accompanying materials are licensed and made available
8 under the terms and conditions of the BSD License which may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified"
16 targetNamespace="http://www.uefi.org/2011/1.1" xmlns="http://www.uefi.org/2011/1.1">
17 <xs:element name="DistributionPackage">
19 <xs:documentation xml:lang="en-us"> This schema defines the UEFI/PI Distribution Package
20 description (PKG) file. It describes the content of:</xs:documentation>
21 <xs:documentation xml:lang="en-us"> 1) Package descriptions with definitions and
22 headers.</xs:documentation>
23 <xs:documentation xml:lang="en-us"> 2) Modules in either source or binary format. (Note
24 that Binary format is for FFS leaf section file types only, complete FFS files
25 cannot be distributed using this distribution format.) </xs:documentation>
26 <xs:documentation xml:lang="en-us"> 3) The distribution of custom tools used to modify
27 the binary images to create UEFI/PI compliant images. </xs:documentation>
28 <xs:documentation xml:lang="en-us"> 4) Finally, it can be used to distribute other
29 miscellaneous content that is not specific to UEFI/PI images. </xs:documentation>
30 <xs:documentation xml:lang="en-us"> The Package Surface Area describes the content of
31 packages, while the Module Surface Area provides information relevant to source
32 and/or binary distributions. </xs:documentation>
36 <xs:element ref="DistributionHeader" minOccurs="1" maxOccurs="1">
38 <xs:documentation xml:lang="en-us"> This header contains (legal) information
39 usually required for distributing both binary and/or source code.
43 <xs:element ref="PackageSurfaceArea" minOccurs="0" maxOccurs="unbounded">
45 <xs:documentation xml:lang="en-us"> The list of packages in this
46 distribution. </xs:documentation>
47 <xs:documentation xml:lang="en-us"> Packages are groups of files and/or
48 modules that are similar in nature.</xs:documentation>
49 <xs:documentation xml:lang="en-us"> Packages are uniquely identified by a
50 package GUID and a package version. </xs:documentation>
51 <xs:documentation xml:lang="en-us"> A package can declare public mappings of
52 C names to GUID values. </xs:documentation>
53 <xs:documentation xml:lang="en-us"> A package can provide header files for
54 library classes and/or other industry standard definitions. </xs:documentation>
55 <xs:documentation xml:lang="en-us"> A package can also declare public
56 mappings of platform configuration database (PCD) "knobs" to
57 control features and operation of modules within a platform. </xs:documentation>
58 <xs:documentation xml:lang="en-us"> Finally, a package lists the library
59 instances and/or modules that are provided in a distribution package.
63 <xs:element ref="ModuleSurfaceArea" minOccurs="0" maxOccurs="unbounded">
65 <xs:documentation xml:lang="en-us"> The listing of UEFI/PI compliant modules
66 in this distribution that are NOT part of a Package. Every module that
67 is provided as part of a package needs to be described in a
68 PackageSurfaceArea.Modules section. </xs:documentation>
69 <xs:documentation xml:lang="en-us"> The ModuleSurfaceArea section describes
70 how each module in a distribution is coded, or, in the case of a binary
71 module distribution, how it was built. </xs:documentation>
72 <xs:documentation xml:lang="en-us"> UEFI/PI compliant libraries and modules
73 are uniquely identified by the Module's GUID and version number. </xs:documentation>
74 <xs:documentation xml:lang="en-us"> This section will typically be used for
75 modules that don't require any additional files that would be included
76 in a package. For example, the Enhanced FAT driver binary does not need
77 to have a package description, as no additional files are provided.
81 <xs:element ref="Tools" minOccurs="0" maxOccurs="unbounded">
83 <xs:documentation xml:lang="en-us"> This section is for distributing vendor
84 specific executable tools, tool source code and/or configuration files.
85 These tools are primarily for manipulating code and/or binary images. </xs:documentation>
86 <xs:documentation xml:lang="en-us"> Tools in this section
87 can:</xs:documentation>
88 <xs:documentation xml:lang="en-us"> 1) Parse build meta-data files to create
89 source code files and build scripts. </xs:documentation>
90 <xs:documentation xml:lang="en-us"> 2) Modify image files to conform to
91 UEFI/PI specifications. </xs:documentation>
92 <xs:documentation xml:lang="en-us"> 3) Generate binary files from certain
93 types of text/unicode files. </xs:documentation>
94 <xs:documentation xml:lang="en-us"> 4) Generate PCI Option Roms or Firmware
95 Device images. </xs:documentation>
96 <xs:documentation xml:lang="en-us"> 5) Implement external
97 encoding/decoding/signature/GUIDed tools. </xs:documentation>
98 <xs:documentation xml:lang="en-us"> 6) Distribution Package
99 create/install/remove tools. </xs:documentation>
102 <xs:element ref="MiscellaneousFiles" minOccurs="0" maxOccurs="unbounded">
104 <xs:documentation xml:lang="en-us"> The list of miscellaneous files in this
105 distribution. Any files that are not listed in either the Package,
106 Module or Tools sections can be listed here. This section can be used to
107 distribute specifications for packages and modules that are not
108 "industry standards" such as a specification for a chipset or
109 a video device. </xs:documentation>
112 <xs:element ref="UserExtensions" minOccurs="0" maxOccurs="unbounded">
114 <xs:documentation xml:lang="en-us"> The UserExtensions section is used to
115 disseminate processing instructions that may be custom to the content
116 provided by the distribution. This section contains information that is
117 common to all aspects of this disribution. </xs:documentation>
124 <!-- End of the DistributionPackage Description -->
126 <xs:element name="DistributionHeader">
128 <xs:documentation xml:lang="en-us"> This section defines the content of the UEIF/PI
129 compliant Distribution Package Header. This is the only required element of a
130 UEFI/PI compliant distribution package. </xs:documentation>
134 <xs:element minOccurs="1" maxOccurs="1" name="Name">
136 <xs:documentation xml:lang="en-us"> This is the User Interface Name for this
137 Distribution Package. </xs:documentation>
138 <xs:documentation xml:lang="en-us"> Each Distribution Package is uniquely
139 identified by it's GUID and Version number. </xs:documentation>
143 <xs:extension base="xs:normalizedString">
144 <xs:attribute name="BaseName" type="xs:NMTOKEN" use="optional">
146 <xs:documentation xml:lang="en-us"> The reference name of
147 the Distribution Package file. This single word name can
148 be used by tools as a keyword or for directory and/or
149 file creation. </xs:documentation>
150 <xs:documentation xml:lang="en-us"> White space and special
151 characters (dash and underscore characters may be used)
152 are not permitted in this name. </xs:documentation>
159 <xs:element minOccurs="1" maxOccurs="1" name="GUID">
161 <xs:documentation xml:lang="en-us"> This 128-bit GUID and the Version
162 attribute uniquely identify this Distribution Package. </xs:documentation>
163 <xs:documentation xml:lang="en-us"> Backward compatible releases of a
164 distribution package need only change the version number, while
165 non-backward compatible changes require the GUID to change (resetting
166 the version number to 1.0 is optional.) </xs:documentation>
170 <xs:extension base="RegistryFormatGuid">
171 <xs:attribute name="Version" type="xs:decimal" use="required">
173 <xs:documentation xml:lang="en-us"> This value, along with
174 the GUID, is used to uniquely identify this object. The
175 higher the number, the more recent the content.
183 <xs:element minOccurs="1" maxOccurs="1" name="Vendor" type="xs:normalizedString">
185 <xs:documentation xml:lang="en-us"> A string identifying who created this
186 distribution package. </xs:documentation>
189 <xs:element minOccurs="1" maxOccurs="1" name="Date" type="xs:dateTime">
191 <xs:documentation xml:lang="en-us"> The date and time this distribution was
192 created. The format is: YYYY-MM-DDThh:mm:ss, for example:
193 2001-01-31T13:30:00 (note the T character separator between the calendar
194 date and the time. </xs:documentation>
197 <xs:element minOccurs="1" maxOccurs="1" name="Copyright" type="xs:string">
199 <xs:documentation xml:lang="en-us"> The copyright for this file that is
200 generated by the creator of the distribution. If a derivative work is
201 generated from an existing distribution, then the existing copyright
202 must be maintained, and additional copyrights may be appended to the end
203 of this element. It may also be the primary copyright for all code
204 provided in the Distribution Package. </xs:documentation>
207 <xs:element minOccurs="1" maxOccurs="1" name="License" type="xs:string">
209 <xs:documentation xml:lang="en-us"> A license that describes any
210 restrictions on the use of this distribution. If a derivative work is
211 allowed by the original license and a derivative work is generated from
212 an existing distribution, then the existing license must be maintained,
213 and additional licenses may be appended to the end of this element. It
214 may also be the primary license for all code provided in the
215 distribution file. Alternatively, this may point to a filename that
216 contains the License. The file (included in the content zip file) will
217 be stored in the same location as the distribution package's .pkg file.
221 <xs:element minOccurs="1" maxOccurs="1" name="Abstract" type="xs:normalizedString">
223 <xs:documentation xml:lang="en-us"> A one line description of the
224 Distribution Package. </xs:documentation>
227 <xs:element minOccurs="0" maxOccurs="1" name="Description" type="xs:string">
229 <xs:documentation xml:lang="en-us"> A complete description of the
230 Distribution Package. This description may include the release name of
231 the file, the version of the file, and a complete description of the
232 file contents and/or features including a description of the updates
233 since the previous file release. </xs:documentation>
236 <xs:element minOccurs="0" maxOccurs="1" name="Signature" type="Md5Sum">
238 <xs:documentation xml:lang="en-us"> The packaging utilities will use this
239 MD5 sum value of the included ZIP file containing files and/or code. If
240 this element is not present, then installation tools should assume that
241 the content is correct, or that other methods may be needed to verify
242 content. </xs:documentation>
245 <xs:element minOccurs="1" maxOccurs="1" name="XmlSpecification" type="xs:decimal"
248 <xs:documentation xml:lang="en-us"> This version of this XML Schema is 1.1 </xs:documentation>
249 <xs:documentation xml:lang="en-us"> Changes to 1.1 from 1.0 </xs:documentation>
250 <xs:documentation xml:lang="en-us"> #1 Updated to present date and new
251 version which is important to reflect the present state of the
252 matter</xs:documentation>
253 <xs:documentation xml:lang="en-us"> #2 Added definition/enumeration of
254 UNDEFIND type 2 is important since there is a large body of legacy code
255 for which the GUID’s and other code/data objects were not decorated with
256 their usage. This document will allow for importing today’s source
257 artifacts and producing decorations using the ‘Undefined’ versus having
258 an error</xs:documentation>
259 <xs:documentation xml:lang="en-us">#3 Allow for inclusion of ARM and future
260 architecture types</xs:documentation>
264 <xs:attribute name="ReadOnly" type="xs:boolean" default="false" use="optional">
266 <xs:documentation xml:lang="en-us"> If set to true, all content within this
267 Distribution Package should NOT be modified. The default permits
268 modification of all content. </xs:documentation>
271 <xs:attribute name="RePackage" type="xs:boolean" default="false" use="optional">
273 <xs:documentation xml:lang="en-us"> If set to true, then the content can be
274 repackaged into another distribution package. The default prohibits
275 repackaging the Distribution content. </xs:documentation>
280 <!-- End of the DistributionHeader element. -->
282 <xs:element name="PackageSurfaceArea">
284 <xs:documentation xml:lang="en-us"> A package is a collection of related objects -
285 Includes, Libraries and Modules. </xs:documentation>
286 <xs:documentation xml:lang="en-us"> Each package is uniquely identified by it's GUID and
287 Version number. Backward compatible releases of a package need only change the
288 version number, while non-backward compatible changes require the GUID to change
289 (resetting the version number to 1.0 is optional.) </xs:documentation>
294 <xs:element minOccurs="1" maxOccurs="1" name="Header">
297 <xs:element minOccurs="1" maxOccurs="1" name="Name">
299 <xs:documentation xml:lang="en-us"> This is the User Interface
300 Name for this package. </xs:documentation>
304 <xs:extension base="xs:normalizedString">
305 <xs:attribute name="BaseName" type="xs:NMTOKEN"
308 <xs:documentation xml:lang="en-us"> This is a
309 single word BaseName of the package. This BaseName
310 can be used by tools as a keyword and for
311 directory/file creation. </xs:documentation>
318 <xs:element minOccurs="1" maxOccurs="1" name="GUID">
320 <xs:documentation xml:lang="en-us"> This GUID and the Version
321 attribute uniquely identify a given package.
326 <xs:extension base="RegistryFormatGuid">
327 <xs:attribute name="Version" type="xs:decimal"
330 <xs:documentation xml:lang="en-us"> This value,
331 along with the GUID, is used to uniquely identify
332 this object. </xs:documentation>
333 <xs:documentation xml:lang="en-us"> Backward
334 compatible changes must make sure this number is
335 incremented from the most recent version.
336 Non-backward compatible changes require a new
337 GUID, and the version can be reset.
345 <xs:element minOccurs="0" maxOccurs="1" name="Copyright"
348 <xs:documentation xml:lang="en-us"> If the package requires a
349 different copyright than the distribution package, this
350 element can list one or more copyright lines.
354 <xs:element minOccurs="0" maxOccurs="1" name="License" type="xs:string">
356 <xs:documentation xml:lang="en-us"> If the package requires
357 licenses that are different from the distribution package
358 license, this element can contain one or more license text
359 paragraphs (or license filenames.) </xs:documentation>
362 <xs:element minOccurs="0" maxOccurs="1" name="Abstract"
363 type="xs:normalizedString">
365 <xs:documentation xml:lang="en-us"> A one line description of
366 this package. </xs:documentation>
369 <xs:element minOccurs="0" maxOccurs="1" name="Description"
372 <xs:documentation xml:lang="en-us"> A complete description of a
373 package. This description may include the release name of
374 the package, the version of the package, and a complete
375 description of the package contents and/or features
376 including a description of the updates since the previous
377 package’s release. </xs:documentation>
380 <xs:element minOccurs="1" maxOccurs="1" name="PackagePath"
383 <xs:documentation xml:lang="en-us"> This element is the location
384 (in the ZIP file) for the root directory of a package.
391 <!-- End of PackageSurfaceArea Header element. -->
393 <xs:element minOccurs="0" maxOccurs="1" name="ClonedFrom">
395 <xs:documentation xml:lang="en-us"> The term cloned is used here to indicate
396 that this package as been copied and modified to a completely different
397 package. An example might be for a new generation of chipsets that have
398 few or no elements in common with the original. </xs:documentation>
402 <xs:element minOccurs="1" maxOccurs="1" name="GUID">
404 <xs:documentation xml:lang="en-us"> This GUID and the Version
405 attribute uniquely identify the Package that this Package
406 was copied from. </xs:documentation>
410 <xs:extension base="RegistryFormatGuid">
411 <xs:attribute name="Version" type="xs:decimal"
414 <xs:documentation xml:lang="en-us"> This value,
415 along with the GUID, is used to uniquely identify
416 the package that this package was cloned from.
427 <!-- End of PackageSurfaceArea ClonedFrom element. -->
429 <xs:element minOccurs="0" maxOccurs="1" name="LibraryClassDeclarations">
431 <xs:documentation xml:lang="en-us"> Library Classes are public interfaces
432 that can be used by modules. One or more library instances can implement
433 a library class, however only one library instance can be linked to an
434 individual module. This provides the platform integrator with the
435 flexibility of choosing one library instance's implementation over a
436 different library instance. </xs:documentation>
440 <xs:element minOccurs="1" maxOccurs="unbounded" name="LibraryClass">
443 <xs:element minOccurs="1" maxOccurs="1" name="HeaderFile"
446 <xs:documentation xml:lang="en-us"> The header file
447 provides definitions and function prototypes for a
448 library class. Modules can be coded against these
449 functions, using the definitions in this header,
450 without concerning themselves about the libraries'
451 implementation details. This is a PackagePath
452 relative path and filename for the include file.
456 <xs:element minOccurs="0" maxOccurs="1"
457 name="RecommendedInstance">
460 <xs:element minOccurs="1" maxOccurs="1"
463 <xs:documentation xml:lang="en-us"> This GUID and
464 the Version attribute uniquely identify the
465 Recommended Library Instance. </xs:documentation>
469 <xs:extension base="RegistryFormatGuid">
470 <xs:attribute name="Version" type="xs:decimal"
473 <xs:documentation xml:lang="en-us"> This value,
474 along with the GUID, is used to uniquely identify
475 this object. If this value is not specified, then
476 any version of the library instance is
477 recommended. </xs:documentation>
487 <xs:element ref="HelpText" minOccurs="0"
488 maxOccurs="unbounded"/>
490 <xs:attribute name="Keyword" type="xs:NCName" use="required">
492 <xs:documentation xml:lang="en-us"> The single word name
493 of the Library Class that module developers will use
494 to identify a library class dependency.
498 <xs:attributeGroup ref="SupportedArchMod"/>
504 <!-- End of PackageSurfaceArea LibraryClassDeclarations element. -->
506 <xs:element minOccurs="0" maxOccurs="1" name="IndustryStandardIncludes">
508 <xs:documentation xml:lang="en-us"> This section is used to list header
509 files for industry standards not under the auspices of UEFI.org. For
510 example, headers that contain definitions and data structures for the
511 USB specifications. </xs:documentation>
515 <xs:element minOccurs="1" maxOccurs="unbounded"
516 name="IndustryStandardHeader">
519 <xs:element minOccurs="1" maxOccurs="1" name="HeaderFile"
522 <xs:documentation xml:lang="en-us"> The package
523 relative path and filename (in the content zip
524 file) of the industry standard include file.
528 <xs:element ref="HelpText" minOccurs="0"
529 maxOccurs="unbounded"/>
536 <!-- End of PackageSurfaceArea IndustryStdIncludes element. -->
538 <xs:element minOccurs="0" maxOccurs="1" name="PackageIncludes">
540 <xs:documentation xml:lang="en-us"> All top level header files that are
541 included by a package that are not listed above. They cannot
542 be:</xs:documentation>
543 <xs:documentation xml:lang="en-us"> 1) Local to a module (module specific.) </xs:documentation>
544 <xs:documentation xml:lang="en-us"> 2) An industry standard header. </xs:documentation>
545 <xs:documentation xml:lang="en-us"> 3) A library class header.
550 <xs:element minOccurs="1" maxOccurs="unbounded" name="PackageHeader">
553 <xs:element minOccurs="1" maxOccurs="1" name="HeaderFile">
555 <xs:documentation xml:lang="en-us"> This is the
556 Package relative path and filename location within
557 the content ZIP file. </xs:documentation>
561 <xs:extension base="xs:anyURI">
562 <xs:attributeGroup ref="SupportedArchMod"/>
567 <xs:element ref="HelpText" minOccurs="0"
568 maxOccurs="unbounded"/>
575 <!-- End of PackageSurfaceArea PackageIncluces element. -->
577 <xs:element minOccurs="0" maxOccurs="1" name="Modules">
580 <xs:element ref="ModuleSurfaceArea" minOccurs="1" maxOccurs="unbounded">
582 <xs:documentation xml:lang="en-us"> This section lists the
583 Module Surface Area for all modules provided with this
584 package. </xs:documentation>
590 <!-- End of PackageSurfaceArea Modules element. -->
592 <xs:element minOccurs="0" maxOccurs="1" name="GuidDeclarations">
594 <xs:documentation xml:lang="en-us"> This section defines the mapping of GUID
595 C names to GUID values as a Registry Format GUID. </xs:documentation>
596 <xs:documentation xml:lang="en-us"> Modules that use these GUIDs must
597 specify their dependency on this package. </xs:documentation>
601 <xs:element minOccurs="1" maxOccurs="unbounded" name="Entry">
603 <xs:documentation xml:lang="en-us"> Individual GUID Declarations
608 <xs:element minOccurs="1" maxOccurs="1" name="CName"
610 <xs:element minOccurs="1" maxOccurs="1" name="GuidValue"
611 type="RegistryFormatGuid"/>
612 <xs:element ref="HelpText" minOccurs="0"
613 maxOccurs="unbounded"/>
615 <xs:attribute name="UiName" type="xs:normalizedString"
617 <xs:attribute name="GuidTypes" type="GuidListType"
619 <xs:attributeGroup ref="SupportedArchMod"/>
625 <!-- End of PackageSurfaceArea GuidDeclarations element. -->
627 <xs:element minOccurs="0" maxOccurs="1" name="ProtocolDeclarations">
629 <xs:documentation xml:lang="en-us"> This section defines the mapping of
630 Protocol C names to GUID values as a Registry Format GUID. </xs:documentation>
631 <xs:documentation xml:lang="en-us"> Modules that use these Protocols must
632 specify their dependency on this package. </xs:documentation>
636 <xs:element minOccurs="1" maxOccurs="unbounded" name="Entry">
638 <xs:documentation xml:lang="en-us"> Individual Protocol
639 Declarations </xs:documentation>
643 <xs:element minOccurs="1" maxOccurs="1" name="CName"
645 <xs:element minOccurs="1" maxOccurs="1" name="GuidValue"
646 type="RegistryFormatGuid"/>
647 <xs:element ref="HelpText" minOccurs="0"
648 maxOccurs="unbounded"/>
650 <xs:attribute name="UiName" type="xs:normalizedString"
652 <xs:attributeGroup ref="SupportedArchMod"/>
658 <!-- End of PackageSurfaceArea ProtocolDeclarations element. -->
660 <xs:element minOccurs="0" maxOccurs="1" name="PpiDeclarations">
662 <xs:documentation xml:lang="en-us"> This section defines the mapping of Ppi
663 C names to GUID values as a Registry Format GUID. </xs:documentation>
664 <xs:documentation xml:lang="en-us"> Modules that use these Ppis must specify
665 their dependency on this package. </xs:documentation>
669 <xs:element minOccurs="1" maxOccurs="unbounded" name="Entry">
671 <xs:documentation xml:lang="en-us"> Individual PPI Declarations
676 <xs:element minOccurs="1" maxOccurs="1" name="CName"
678 <xs:element minOccurs="1" maxOccurs="1" name="GuidValue"
679 type="RegistryFormatGuid"/>
680 <xs:element ref="HelpText" minOccurs="0"
681 maxOccurs="unbounded"/>
683 <xs:attribute name="UiName" type="xs:normalizedString"
685 <xs:attributeGroup ref="SupportedArchMod"/>
691 <!-- End of PackageSurfaceArea PpiDeclarations element. -->
693 <xs:element minOccurs="0" maxOccurs="1" name="PcdDeclarations">
695 <xs:documentation xml:lang="en-us"> This section is used to declare platform
696 configuration knobs that are defined by this package. </xs:documentation>
697 <xs:documentation xml:lang="en-us"> Modules that use these PCD values must
698 specify their dependency on this package. </xs:documentation>
702 <xs:element minOccurs="1" maxOccurs="unbounded" name="PcdEntry">
705 <xs:element minOccurs="1" maxOccurs="1"
706 name="TokenSpaceGuidCname" type="xs:NCName">
708 <xs:documentation xml:lang="en-us"> Specifies the C
709 name of the Token Space GUID of which this PCD
710 Entry is a member. This C name should also be
711 listed in the GUIDs section, (specified above,)
712 where the C name is assigned to a GUID value.
716 <xs:element minOccurs="1" maxOccurs="1" name="Token">
718 <xs:documentation xml:lang="en-us"> Specifies the
719 32-bit token value for this PCD Entry. The Token
720 number must be unique to the Token Space that
721 declares the PCD. </xs:documentation>
722 <xs:documentation xml:lang="en-us"> The minLength of
723 3 is required to handle the "0x" prefix to the hex
724 number. </xs:documentation>
727 <xs:restriction base="HexNumber">
728 <xs:minLength value="3"/>
729 <xs:maxLength value="10"/>
733 <xs:element minOccurs="1" maxOccurs="1" name="CName"
735 <xs:element minOccurs="1" maxOccurs="1" name="DatumType"
736 type="PcdDatumTypes">
738 <xs:documentation xml:lang="en-us"> A string that
739 contains the data type of this PCD Entry. PCD data
740 types are restricted to the following set:UINT8,
741 UINT16, UINT32, UINT64, VOID*, BOOLEAN.
745 <xs:element minOccurs="1" maxOccurs="1" name="ValidUsage"
746 type="PcdItemListType">
748 <xs:documentation xml:lang="en-us"> A string that
749 contains one or more PCD Item types separated by
750 spaces. The PCD Item types are restricted to
751 FeaturePcd, FixedPcd, PatchPcd, Pcd and/or PcdEx.
755 <xs:element minOccurs="1" maxOccurs="1" name="DefaultValue"
756 type="xs:normalizedString"/>
757 <xs:element minOccurs="0" maxOccurs="1" name="MaxDatumSize">
759 <xs:documentation xml:lang="en-us"> This is a
760 recommended maximum data size for VOID* data
761 types, the actual value should be defined by the
762 Platform Integrator. It is not required for the
763 other data types. </xs:documentation>
764 <xs:documentation xml:lang="en-us"> The minLength of
765 3 is required to handle the "0x" prefix to the hex
766 number. </xs:documentation>
770 <xs:restriction base="HexNumber">
771 <xs:minLength value="3"/>
775 <xs:element ref="HelpText" minOccurs="0"
776 maxOccurs="unbounded"/>
778 <xs:element minOccurs="0" maxOccurs="unbounded"
781 <xs:documentation xml:lang="en-us"> Valid Error
782 messages that may be implemented in a module for
783 the PCD Entry. Only One Error Number per PcdError,
784 (multiple ErrorMessage entries are permitted) and
785 multiple PcdError elements are permitted.
790 <xs:choice minOccurs="1" maxOccurs="1">
792 <xs:documentation xml:lang="en-us"> One of the
793 following types of comparisons, which must be able
794 to evaluate to either true or false.
797 <xs:element minOccurs="0" maxOccurs="1"
798 name="ValidValueList">
800 <xs:documentation xml:lang="en-us"> The PCD Value
801 must be space separated list of values. Values are
802 restricted to the data type of this PCD.
807 <xs:extension base="xs:normalizedString">
808 <xs:attribute name="Lang" type="xs:language"
814 <xs:element minOccurs="0" maxOccurs="1"
815 name="ValidValueRange" type="xs:normalizedString">
817 <xs:documentation xml:lang="en-us"> The PCD must
818 be within a specifed range of numeric values.
819 Restricted to C style Relational, Equality and
820 Logicial Operators and parenthesis are valid. Only
821 the CName for this PCD is permitted in the
822 ValidValueRange expression. All other values must
823 be numeric.</xs:documentation>
824 <xs:documentation xml:lang="en-us"> LValue (op
825 RValue)+ </xs:documentation>
828 <xs:element minOccurs="0" maxOccurs="1"
829 name="Expression" type="xs:normalizedString">
831 <xs:documentation xml:lang="en-us"> A in-fix
832 logical expression using C style logical
833 operators. </xs:documentation>
837 <xs:element minOccurs="1" maxOccurs="1"
840 <xs:documentation xml:lang="en-us"> A hexadecimal
841 value for the error message as defined by
842 specifications. </xs:documentation>
843 <xs:documentation xml:lang="en-us"> The minLength
844 of 3 is required to handle the "0x" prefix to the
845 hex number. </xs:documentation>
849 <xs:restriction base="HexNumber">
850 <xs:minLength value="3"/>
854 <xs:element minOccurs="1" maxOccurs="unbounded"
857 <xs:documentation xml:lang="en-us"> This string
858 should be defined by specifications. There are
859 pre-defined error number ranges in the UEFI/PI
860 specificaiton. </xs:documentation>
864 <xs:extension base="xs:string">
865 <xs:attribute name="Lang" type="xs:language"
866 default="en-us" use="optional"/>
875 <xs:attributeGroup ref="SupportedArchMod"/>
881 <!-- End of PackageSurfaceArea PcdDeclarations element. -->
883 <xs:element minOccurs="0" maxOccurs="1" name="PcdRelationshipChecks">
885 <xs:documentation xml:lang="en-us"> This section is used to describe any PCD
886 interdependencies or relationships. </xs:documentation>
890 <xs:element minOccurs="1" maxOccurs="unbounded" name="PcdCheck"
891 type="xs:normalizedString">
893 <xs:documentation xml:lang="en-us"> This entry must used
894 TokenSpaceGuidCName.PcdCname for every named PCD. Restricted
895 to Relational, Equality and Logical Operators (NOT, AND, OR,
896 GT, GE, EQ, LE, LT and XOR) and parenthesis are valid. Only
897 the TokenSpaceGuidCName.PcdCname us permitted to name PCDs
898 in the expression. All other values must be numeric. </xs:documentation>
899 <xs:documentation xml:lang="en-us"> LValue (op RValue)+
907 <xs:element minOccurs="0" maxOccurs="unbounded" name="MiscellaneousFiles">
909 <xs:documentation xml:lang="en-us"> This section contains files that are not
910 part of the code distributed with this package. </xs:documentation>
914 <xs:element minOccurs="0" maxOccurs="1" name="Copyright"
917 <xs:documentation xml:lang="en-us"> Only required if different
918 from the Package Copyright. </xs:documentation>
921 <xs:element minOccurs="0" maxOccurs="1" name="License" type="xs:string">
923 <xs:documentation xml:lang="en-us"> Only required if different
924 from the Package License. </xs:documentation>
927 <xs:element minOccurs="0" maxOccurs="1" name="Abstract" type="xs:string">
929 <xs:documentation xml:lang="en-us"> A one line description of
930 this section's content. </xs:documentation>
933 <xs:element minOccurs="0" maxOccurs="unbounded" name="Description"
936 <xs:documentation xml:lang="en-us"> A complete description of
937 the files in this section. </xs:documentation>
940 <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename">
942 <xs:documentation xml:lang="en-us"> This is the PackagePath
943 relative path and filename location within the ZIP file.
948 <xs:extension base="xs:anyURI">
949 <xs:attribute name="Executable" type="xs:boolean"
950 default="false" use="optional">
952 <xs:documentation xml:lang="en-us"> If true, used
953 by installation tools to ensure that a file that
954 must be executable has the correct properties to
955 permit execution. </xs:documentation>
966 <!-- End of PackageSurfaceArea Misc element. -->
968 <xs:element minOccurs="0" maxOccurs="unbounded" name="UserExtensions">
970 <xs:documentation xml:lang="en-us"> This section is used for any processing
971 instructions that may be custom to the content provided by this package
972 that are common to this package. </xs:documentation>
974 <xs:complexType mixed="true">
976 <xs:any processContents="lax" minOccurs="0" maxOccurs="1"/>
978 <xs:attribute name="UserId" type="xs:NCName" use="required">
980 <xs:documentation xml:lang="en-us"> This is a single word identifier
981 for grouping similar content that does not fit into previously
982 defined sections or other sections of the Distribution.
986 <xs:attribute name="Identifier" type="xs:string" use="required">
988 <xs:documentation xml:lang="en-us"> This can be used to
989 differentiate multiple sections with a grouping. </xs:documentation>
990 <xs:documentation xml:lang="en-us"> For example, a PRE_PROCESS
991 Identifier might indicate specific steps and tools required
992 before processing module content, while a different
993 UserExtensions section with a POST_PROCESS Identifier might
994 describe steps that need to be executed after operations on the
995 modules in this package. </xs:documentation>
998 <xs:anyAttribute processContents="lax"/>
1001 <!-- End of PackageSurfaceArea UserExtensions element. -->
1006 <!-- End of the PackageSurfaceArea element. -->
1008 <xs:element name="ModuleSurfaceArea">
1010 <xs:documentation xml:lang="en-us"> Each module is uniquely identified by it's GUID and
1011 Version number. Backward compatible releases of a module need only change the
1012 version number, while non-backward compatible changes require the GUID to change
1013 (resetting the version number to 1.0 is optional.) </xs:documentation>
1018 <xs:element minOccurs="1" maxOccurs="1" name="Header">
1021 <xs:element minOccurs="1" maxOccurs="1" name="Name">
1023 <xs:documentation xml:lang="en-us"> This is the User Interface
1024 Name for this Module. </xs:documentation>
1028 <xs:extension base="xs:normalizedString">
1029 <xs:attribute name="BaseName" type="xs:NMTOKEN"
1032 <xs:documentation xml:lang="en-us"> This is a
1033 single word BaseName that will be used to create a
1034 module meta-data file. </xs:documentation>
1035 <xs:documentation xml:lang="en-us"> This name
1036 should also be used to create output file names
1037 and directories. </xs:documentation>
1044 <xs:element minOccurs="1" maxOccurs="1" name="GUID">
1046 <xs:documentation xml:lang="en-us"> This GUID and the Version
1047 attribute uniquely identify a given Module.
1052 <xs:extension base="RegistryFormatGuid">
1053 <xs:attribute name="Version" type="xs:decimal"
1056 <xs:documentation xml:lang="en-us"> This value,
1057 along with the GUID, is used to uniquely identify
1058 this object. </xs:documentation>
1059 <xs:documentation xml:lang="en-us"> Backward
1060 compatible changes must make sure this number is
1061 incremented from the most recent version.
1062 Non-backward compatible changes require a new
1063 GUID, and the version can be reset.
1071 <xs:element minOccurs="0" maxOccurs="1" name="Copyright"
1074 <xs:documentation xml:lang="en-us"> This is only required if the
1075 Copyright is different from either the Package or
1076 Distribution copyright. Multiple copyright lines are
1077 permitted within this section. </xs:documentation>
1080 <xs:element minOccurs="0" maxOccurs="1" name="License" type="xs:string">
1082 <xs:documentation xml:lang="en-us"> This is only required if the
1083 license is different from either the Package or Distribution
1084 license. Multiple licenses are permitted within this
1085 section. </xs:documentation>
1088 <xs:element minOccurs="0" maxOccurs="1" name="Abstract"
1089 type="xs:normalizedString">
1091 <xs:documentation xml:lang="en-us"> A brief text description of
1092 the module. </xs:documentation>
1095 <xs:element minOccurs="0" maxOccurs="1" name="Description"
1098 <xs:documentation xml:lang="en-us"> A complete description of
1099 the module contents and/or features including a description
1100 of the updates since the previous module release.
1107 <!-- End of Module Surface Area Header Section -->
1109 <xs:element minOccurs="0" maxOccurs="1" name="ModuleProperties">
1111 <xs:documentation xml:lang="en-us"> List general information about a module,
1112 including the Supported Architectures, this module's type,
1113 specifications the module is coded against, and other informational
1114 content. </xs:documentation>
1118 <xs:element minOccurs="1" maxOccurs="1" name="ModuleType"
1121 <xs:documentation xml:lang="en-us"> One of the Enumerated module
1122 types that limit the use of a module. </xs:documentation>
1125 <xs:element minOccurs="1" maxOccurs="1" name="Path" type="xs:anyURI">
1127 <xs:documentation xml:lang="en-us"> For stand-alone modules that
1128 are NOT part of any package, this is the path to the root of
1129 the module as listed in the ZIP file. For modules included
1130 in a package, this is the location, relative to the root of
1131 the package (PackagePath) this module belongs to.
1135 <xs:element minOccurs="0" maxOccurs="1" name="PcdIsDriver">
1137 <xs:documentation xml:lang="en-us"> This element is only
1138 required for the PEIM that produces the PCD PPI or the DXE
1139 Driver that produces the PCD Protocol. </xs:documentation>
1142 <xs:restriction base="xs:NCName">
1143 <xs:enumeration value="PEI_PCD_DRIVER"/>
1144 <xs:enumeration value="DXE_PCD_DRIVER"/>
1149 <xs:element minOccurs="0" maxOccurs="1" name="UefiSpecificationVersion"
1152 <xs:element minOccurs="0" maxOccurs="1" name="PiSpecificationVersion"
1155 <xs:element minOccurs="0" maxOccurs="unbounded" name="Specification">
1157 <xs:documentation xml:lang="en-us"> This is a list of other
1158 specifications that this module is written against. These
1159 entries can be used in #define statements (depending on the
1160 build system implementation, they may be autogenerated.)
1165 <xs:extension base="xs:NCName">
1166 <xs:attribute name="Version" type="xs:decimal"
1173 <xs:element minOccurs="0" maxOccurs="unbounded" name="BootMode">
1175 <xs:documentation xml:lang="en-us"> Different firmware execution
1176 paths may be taken based on a given state of the hardware,
1177 firmware, or through feature settings. A BootMode may be
1178 declared (PRODUCES) or discovered (CONSUMES) based on these
1179 states and feature settings. If the usage is UNDEFINE, it
1180 implies that a Boot Mode is used, but the package creator
1181 does not know how it is used. The supported boot modes map
1182 to the PI specification Boot Modes. The boot modes listed
1183 with Recovery are to indicate that the BootMode is valid
1184 during a recovery boot. </xs:documentation>
1187 <xs:sequence minOccurs="0">
1188 <xs:element minOccurs="1" maxOccurs="1"
1189 name="SupportedBootModes">
1193 <xs:restriction base="xs:NCName">
1194 <xs:enumeration value="FULL"/>
1195 <xs:enumeration value="MINIMAL"/>
1196 <xs:enumeration value="NO_CHANGE"/>
1197 <xs:enumeration value="DIAGNOSTICS"/>
1198 <xs:enumeration value="DEFAULT"/>
1199 <xs:enumeration value="S2_RESUME"/>
1200 <xs:enumeration value="S3_RESUME"/>
1201 <xs:enumeration value="S4_RESUME"/>
1202 <xs:enumeration value="S5_RESUME"/>
1203 <xs:enumeration value="FLASH_UPDATE"/>
1204 <xs:enumeration value="RECOVERY_FULL"/>
1205 <xs:enumeration value="RECOVERY_MINIMAL"/>
1206 <xs:enumeration value="RECOVERY_NO_CHANGE"/>
1207 <xs:enumeration value="RECOVERY_DIAGNOSTICS"/>
1208 <xs:enumeration value="RECOVERY_DEFAULT"/>
1209 <xs:enumeration value="RECOVERY_S2_RESUME"/>
1210 <xs:enumeration value="RECOVERY_S3_RESUME"/>
1211 <xs:enumeration value="RECOVERY_S4_RESUME"/>
1212 <xs:enumeration value="RECOVERY_S5_RESUME"/>
1213 <xs:enumeration value="RECOVERY_FLASH_UPDATE"/>
1214 <xs:enumeration value="UNDEFINED"/>
1221 <xs:element ref="HelpText" minOccurs="0"
1222 maxOccurs="unbounded"/>
1224 <xs:attribute name="Usage" use="required">
1226 <xs:restriction base="xs:NCName">
1227 <xs:enumeration value="CONSUMES">
1229 <xs:documentation xml:lang="en-us"> The module
1230 always supports the given boot modes.
1234 <xs:enumeration value="SOMETIMES_CONSUMES">
1236 <xs:documentation xml:lang="en-us"> The module may
1237 support a given mode on some execution paths.
1241 <xs:enumeration value="PRODUCES">
1243 <xs:documentation xml:lang="en-us"> The module
1244 will change the boot mode. </xs:documentation>
1247 <xs:enumeration value="SOMETIME_PRODUCES">
1249 <xs:documentation xml:lang="en-us"> The module
1250 will change the boot mode on some exection paths.
1254 <xs:enumeration value="UNDEFINED">
1256 <xs:documentation xml:lang="en-us"> The package
1257 creator does not know how the boot mode is used.
1264 <xs:attribute name="SupArchList" type="ArchListType"
1266 <xs:attribute name="FeatureFlag" type="xs:normalizedString"
1271 <xs:element minOccurs="0" maxOccurs="unbounded" name="Event"
1274 <xs:documentation xml:lang="en-us"> The functions that make up
1275 the Event, Timer, and Task Priority Services are used during
1276 preboot to create, close, signal, and wait for events; to
1277 set timers; and to raise and restore task priority levels as
1278 defined in the UEFI specification. GUIDed events should be
1279 listed in the Guids section. </xs:documentation>
1283 <xs:element ref="HelpText" minOccurs="0"
1284 maxOccurs="unbounded"/>
1286 <xs:attribute name="Usage" use="required">
1288 <xs:restriction base="xs:NCName">
1289 <xs:enumeration value="CONSUMES">
1291 <xs:documentation xml:lang="en-us"> The module
1292 will register a notification function and calls
1293 the function when it is signaled.
1297 <xs:enumeration value="SOMETIMES_CONSUMES">
1299 <xs:documentation xml:lang="en-us"> The module
1300 will register a notification function and calls
1301 the function when it is signaled on some execution
1302 paths. </xs:documentation>
1305 <xs:enumeration value="PRODUCES">
1307 <xs:documentation xml:lang="en-us"> The module
1308 will signal all events in an event group.
1312 <xs:enumeration value="SOMETIMES_PRODUCES">
1314 <xs:documentation xml:lang="en-us"> The module
1315 will signal all events in an event group under
1316 some execution paths. </xs:documentation>
1319 <xs:enumeration value="UNDEFINED">
1321 <xs:documentation xml:lang="en-us"> The package
1322 creator does not know how an event is used.
1329 <xs:attribute name="EventType" use="required">
1331 <xs:restriction base="xs:NCName">
1332 <xs:enumeration value="EVENT_TYPE_PERIODIC_TIMER"/>
1333 <xs:enumeration value="EVENT_TYPE_RELATIVE_TIMER"/>
1334 <xs:enumeration value="UNDEFINED"/>
1340 <xs:attribute name="SupArchList" type="ArchListType"
1342 <xs:attribute name="FeatureFlag" type="xs:normalizedString"
1347 <xs:element minOccurs="0" maxOccurs="unbounded" name="HOB"
1350 <xs:documentation xml:lang="en-us"> This is a list of non-GUIDed
1351 Hand Off Blocks (HOBs) produced or consumed by this module.
1356 <xs:element ref="HelpText" minOccurs="0"
1357 maxOccurs="unbounded"/>
1359 <xs:attribute name="HobType" use="required">
1361 <xs:restriction base="xs:NCName">
1362 <xs:enumeration value="PHIT"/>
1363 <xs:enumeration value="MEMORY_ALLOCATION"/>
1364 <xs:enumeration value="RESOURCE_DESCRIPTOR"/>
1365 <xs:enumeration value="FIRMWARE_VOLUME"/>
1366 <xs:enumeration value="LOAD_PEIM"/>
1367 <xs:enumeration value="UNDEFINED"/>
1371 <xs:attribute name="Usage" use="required">
1373 <xs:restriction base="xs:NCName">
1374 <xs:enumeration value="CONSUMES">
1376 <xs:documentation xml:lang="en-us"> A HOB must be
1377 present in the system. </xs:documentation>
1380 <xs:enumeration value="SOMETIMES_CONSUMES">
1382 <xs:documentation xml:lang="en-us"> If present,
1383 the HOB will be used. </xs:documentation>
1386 <xs:enumeration value="PRODUCES">
1388 <xs:documentation xml:lang="en-us"> The HOB is
1389 always produced by the module. </xs:documentation>
1392 <xs:enumeration value="SOMETIMES_PRODUCES">
1394 <xs:documentation xml:lang="en-us"> The HOB may be
1395 produced by the module under some execution paths.
1399 <xs:enumeration value="UNDEFINED">
1401 <xs:documentation xml:lang="en-us"> The package
1402 creator knows that a HOB is used, but does not
1403 know how it is used. </xs:documentation>
1409 <xs:attribute name="SupArchList" type="ArchListType"
1411 <xs:attribute name="FeatureFlag" type="xs:normalizedString"
1417 <xs:attributeGroup ref="SupportedArchMod"/>
1420 <!-- End of ModuleProperties Section -->
1422 <xs:element minOccurs="0" maxOccurs="1" name="ClonedFrom">
1424 <xs:documentation xml:lang="en-us"> This section may be included for Modules
1425 that are copied from a different module. </xs:documentation>
1429 <xs:element minOccurs="1" maxOccurs="1" name="GUID">
1431 <xs:documentation xml:lang="en-us"> This GUID and the Version
1432 attribute uniquely identify the Module that this Module was
1433 copied from. </xs:documentation>
1437 <xs:extension base="RegistryFormatGuid">
1438 <xs:attribute name="Version" type="xs:decimal"
1441 <xs:documentation xml:lang="en-us"> This value,
1442 along with the GUID, is used to uniquely identify
1443 this object. </xs:documentation>
1453 <!-- End of ClonedFrom Section. -->
1455 <xs:element minOccurs="0" maxOccurs="1" name="LibraryClassDefinitions">
1457 <xs:documentation xml:lang="en-us"> A list of the different Library Classes
1458 consumed by a driver, core and/or application module, or produced by a
1459 Library module. </xs:documentation>
1463 <xs:element minOccurs="1" maxOccurs="unbounded" name="LibraryClass">
1466 <xs:element minOccurs="1" maxOccurs="1" name="Keyword"
1469 <xs:documentation xml:lang="en-us "> Used by tools
1470 to identify different instances of libraries that
1471 provide the library class. This keyword identifies
1472 the library class this module needs to be linked
1473 against. </xs:documentation>
1476 <xs:element minOccurs="0" maxOccurs="1"
1477 name="RecommendedInstance">
1480 <xs:element minOccurs="1" maxOccurs="1"
1483 <xs:documentation xml:lang="en-us"> This GUID and
1484 the Version attribute uniquely identify the
1485 recommended Library Instance for this module .
1490 <xs:extension base="RegistryFormatGuid">
1491 <xs:attribute name="Version" type="xs:decimal"
1494 <xs:documentation xml:lang="en-us"> This value,
1495 along with the GUID, is used to uniquely identify
1496 this object. </xs:documentation>
1506 <xs:element ref="HelpText" minOccurs="0"
1507 maxOccurs="unbounded"/>
1509 <xs:attribute name="Usage" use="required">
1512 <xs:documentation xml:lang="en-us"> Library
1513 instances can provide code for a library class, or
1514 may require other library instances themselves.
1515 Since different execution paths in a library (or
1516 module) may need different library classes based
1517 on some setting, library classes may not alway be
1518 required. </xs:documentation>
1520 <xs:restriction base="xs:NCName">
1521 <xs:enumeration value="PRODUCES"/>
1522 <xs:enumeration value="CONSUMES"/>
1523 <xs:enumeration value="SOMETIMES_CONSUMES"/>
1524 <xs:enumeration value="UNDEFINED"/>
1529 <xs:attributeGroup ref="SupportedArchMod"/>
1530 <xs:attribute name="FeatureFlag" type="xs:normalizedString"
1533 <xs:documentation xml:lang="en-us"> A FeatureFlag
1534 attribute must evaluate to either true or false - it
1535 may be a fixed value of true or false, a C name or
1536 an in-fix expression. </xs:documentation>
1544 <!-- End of LibraryClassDefinitions Section -->
1546 <xs:element minOccurs="0" maxOccurs="1" name="SourceFiles">
1549 <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename">
1551 <xs:documentation xml:lang="en-us"> This is the module relative
1552 (ModuleProperties.Path) path and filename location within
1553 the ZIP file. </xs:documentation>
1557 <xs:extension base="xs:anyURI">
1558 <xs:attribute name="Family" type="FamilyTypes"
1561 <xs:documentation xml:lang="en-us"> The Family
1562 attribute is used to restrict usage to a given
1563 family of compilers, such as GCC or MSFT. Since
1564 not all code processing tools use the same syntax,
1565 especially for assembly, this field can be used to
1566 identify different syntax. </xs:documentation>
1569 <xs:attribute name="SupArchList" type="ArchListType"
1571 <xs:attribute name="SupModList" type="ModuleListType"
1573 <xs:attribute name="FeatureFlag"
1574 type="xs:normalizedString" use="optional"/>
1579 <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>
1583 <!-- End of SourceFiles Section -->
1585 <xs:element minOccurs="0" maxOccurs="1" name="BinaryFiles">
1588 <xs:element minOccurs="1" maxOccurs="unbounded" name="BinaryFile">
1591 <xs:element minOccurs="1" maxOccurs="unbounded"
1594 <xs:documentation xml:lang="en-us"> This is the
1595 module relative (ModuleProperties.Path) path and
1596 filename location within the ZIP file.
1601 <xs:extension base="xs:anyURI">
1602 <xs:attribute name="FileType" use="optional">
1604 <xs:restriction base="xs:NCName">
1606 <xs:documentation xml:lang="en-us"> Binary file
1607 distribution is limited to UEFI/PI FFS leaf
1608 section file types. </xs:documentation>
1610 <xs:enumeration value="GUID"/>
1611 <xs:enumeration value="FREEFORM"/>
1612 <xs:enumeration value="UEFI_IMAGE"/>
1613 <xs:enumeration value="PE32">
1615 <xs:documentation xml:lang="en-us"> A UEFI/PI FFS
1616 Leaf section file type, not a raw PE32 file.
1620 <xs:enumeration value="PIC"/>
1621 <xs:enumeration value="PEI_DEPEX"/>
1622 <xs:enumeration value="DXE_DEPEX"/>
1623 <xs:enumeration value="SMM_DEPEX"/>
1624 <xs:enumeration value="COMPAT16"/>
1625 <xs:enumeration value="DISPOSABLE"/>
1626 <xs:enumeration value="TE"/>
1627 <xs:enumeration value="VER"/>
1628 <xs:enumeration value="UI"/>
1629 <xs:enumeration value="BIN"/>
1630 <xs:enumeration value="FV"/>
1634 <xs:attribute name="SupArchList"
1635 type="ArchListType" use="optional"/>
1636 <xs:attribute name="SupModList"
1637 type="ModuleListType" use="optional"/>
1638 <xs:attribute name="FeatureFlag"
1639 type="xs:normalizedString" use="optional"/>
1644 <xs:element minOccurs="0" maxOccurs="unbounded"
1647 <xs:documentation xml:lang="en-us"> This section
1648 contains information about how the module was
1649 coded, such as Compiler Tools, Flags, PCDs (only
1650 PatchPcd and/or PcdEx) and Library Class Instances
1651 used to build the binary. </xs:documentation>
1656 <xs:element minOccurs="0" maxOccurs="unbounded"
1657 name="PatchPcdValue">
1659 <xs:documentation xml:lang="en-us"> The element is
1660 the Patchable PCD Value that was used during the
1661 build. </xs:documentation>
1665 <xs:element minOccurs="1" maxOccurs="1"
1666 name="TokenSpaceGuidValue"
1667 type="RegistryFormatGuid"/>
1668 <xs:element minOccurs="1" maxOccurs="1"
1669 name="PcdCName" type="xs:NCName"/>
1670 <xs:element minOccurs="1" maxOccurs="1"
1673 <xs:documentation xml:lang="en-us"> The minLength
1674 of 3 is required to handle the "0x" prefix to the
1675 hex number. </xs:documentation>
1678 <xs:restriction base="HexNumber">
1679 <xs:minLength value="3"/>
1680 <xs:maxLength value="10"/>
1684 <xs:element minOccurs="1" maxOccurs="1"
1685 name="DatumType" type="PcdDatumTypes"/>
1686 <xs:element minOccurs="0" maxOccurs="1"
1687 name="MaxDatumSize">
1689 <xs:documentation xml:lang="en-us"> This field is
1690 required if the Pcd Datum Type is VOID* </xs:documentation>
1691 <xs:documentation xml:lang="en-us"> The minLength
1692 of 3 is required to handle the "0x" prefix to the
1693 hex number. </xs:documentation>
1696 <xs:restriction base="HexNumber">
1697 <xs:minLength value="3"/>
1701 <xs:element minOccurs="1" maxOccurs="1"
1702 name="Value" type="xs:normalizedString"/>
1703 <xs:element minOccurs="1" maxOccurs="1"
1706 <xs:documentation xml:lang="en-us"> The minLength
1707 of 3 is required to handle the "0x" prefix to the
1708 hex number. </xs:documentation>
1711 <xs:restriction base="HexNumber">
1712 <xs:minLength value="3"/>
1716 <xs:element ref="HelpText" minOccurs="0"
1717 maxOccurs="unbounded"/>
1718 <xs:element minOccurs="0" maxOccurs="unbounded"
1721 <xs:documentation xml:lang="en-us"> Error
1722 information implemented by the module.
1727 <xs:element minOccurs="1" maxOccurs="1"
1730 <xs:documentation xml:lang="en-us"> The minLength
1731 of 3 is required to handle the "0x" prefix to the
1732 hex number. </xs:documentation>
1735 <xs:restriction base="HexNumber">
1736 <xs:minLength value="3"/>
1740 <xs:element minOccurs="0" maxOccurs="unbounded"
1741 name="ErrorMessage">
1744 <xs:extension base="xs:string">
1745 <xs:attribute name="Lang" type="xs:language"
1746 default="en-us" use="optional"/>
1758 <xs:element minOccurs="0" maxOccurs="unbounded"
1761 <xs:documentation xml:lang="en-us"> The element is
1762 the DynamicEx PCD Value that was used during the
1763 build. </xs:documentation>
1767 <xs:element minOccurs="1" maxOccurs="1"
1768 name="TokenSpaceGuidValue"
1769 type="RegistryFormatGuid"/>
1770 <xs:element minOccurs="1" maxOccurs="1"
1773 <xs:documentation xml:lang="en-us"> The minLength
1774 of 3 is required to handle the "0x" prefix to the
1775 hex number. </xs:documentation>
1778 <xs:restriction base="HexNumber">
1779 <xs:minLength value="3"/>
1780 <xs:maxLength value="10"/>
1784 <xs:element minOccurs="1" maxOccurs="1"
1785 name="DatumType" type="PcdDatumTypes"/>
1786 <xs:element minOccurs="0" maxOccurs="1"
1787 name="MaxDatumSize">
1789 <xs:documentation xml:lang="en-us"> This field is
1790 required if the Pcd Datum Type is VOID*
1794 <xs:restriction base="HexNumber">
1795 <xs:minLength value="3"/>
1799 <xs:element minOccurs="1" maxOccurs="1"
1800 name="Value" type="xs:normalizedString"/>
1801 <xs:element ref="HelpText" minOccurs="0"
1802 maxOccurs="unbounded"/>
1803 <xs:element minOccurs="0" maxOccurs="unbounded"
1806 <xs:documentation xml:lang="en-us"> Error
1807 information implemented by the module.
1812 <xs:element minOccurs="1" maxOccurs="1"
1815 <xs:documentation xml:lang="en-us"> The minLength
1816 of 3 is required to handle the "0x" prefix to the
1817 hex number. </xs:documentation>
1820 <xs:restriction base="HexNumber">
1821 <xs:minLength value="3"/>
1825 <xs:element minOccurs="0" maxOccurs="unbounded"
1826 name="ErrorMessage">
1829 <xs:extension base="xs:string">
1830 <xs:attribute name="Lang" type="xs:language"
1831 default="en-us" use="optional"/>
1843 <xs:element minOccurs="0" maxOccurs="1"
1844 name="LibraryInstances">
1846 <xs:documentation xml:lang="en-us"> This is the
1847 actual library instance that was used to link
1848 against the module. </xs:documentation>
1852 <xs:element minOccurs="1" maxOccurs="unbounded"
1855 <xs:documentation xml:lang="en-us"> This GUID and
1856 the Version attribute uniquely identify the actual
1857 Library Instance linked in this module.
1862 <xs:extension base="RegistryFormatGuid">
1863 <xs:attribute name="Version" type="xs:decimal"
1866 <xs:documentation xml:lang="en-us"> This value,
1867 along with the GUID, is used to uniquely identify
1868 this object. </xs:documentation>
1879 <xs:element minOccurs="0" maxOccurs="unbounded"
1881 <xs:complexType mixed="true">
1884 <xs:documentation xml:lang="en-us"> Any
1885 description of OS, Tool, and flags for the
1886 individual tool can go in this section.
1889 <xs:extension base="xs:string">
1890 <xs:anyAttribute processContents="lax"/>
1898 <!-- End of AsBuilt -->
1899 <xs:element ref="HelpText" minOccurs="0"
1900 maxOccurs="unbounded"/>
1908 <!-- End of BinaryFiles Section -->
1910 <xs:element minOccurs="0" maxOccurs="1" name="PackageDependencies">
1913 <xs:element minOccurs="1" maxOccurs="unbounded" name="Package">
1916 <xs:element minOccurs="0" maxOccurs="unbounded"
1920 <xs:extension base="xs:string">
1921 <xs:attribute name="Lang" type="xs:language"
1922 default="en-us" use="optional"/>
1927 <xs:element minOccurs="1" maxOccurs="1" name="GUID">
1929 <xs:documentation xml:lang="en-us"> This GUID and
1930 the Version attribute uniquely identify Package
1931 that this Module depends on. </xs:documentation>
1935 <xs:extension base="RegistryFormatGuid">
1936 <xs:attribute name="Version" type="xs:decimal"
1939 <xs:documentation xml:lang="en-us"> This value,
1940 along with the GUID, is used to uniquely identify
1941 this object. If the version attribute is not
1942 specified, the most recent version of the package
1943 can be used. </xs:documentation>
1951 <xs:attribute name="SupArchList" type="ArchListType"
1953 <xs:attribute name="SupModList" type="ModuleListType"
1955 <xs:attribute name="FeatureFlag" type="xs:normalizedString"
1962 <!-- End of PackageDependencies -->
1964 <xs:element minOccurs="0" maxOccurs="1" name="Guids">
1967 <xs:element minOccurs="1" maxOccurs="unbounded" name="GuidCName">
1970 <xs:element minOccurs="1" maxOccurs="1" name="CName"
1972 <xs:element minOccurs="0" maxOccurs="1" name="VariableName"
1973 type="xs:normalizedString">
1975 <xs:documentation xml:lang="en-us"> Only valid for
1976 Variable GUID types. </xs:documentation>
1977 <xs:documentation> This can be either a Hex Array or
1978 C string in unicode format: L"string" Data.
1982 <xs:element ref="HelpText" minOccurs="0"
1983 maxOccurs="unbounded"/>
1985 <xs:attribute name="Usage" use="required">
1987 <xs:restriction base="xs:NCName">
1988 <xs:enumeration value="CONSUMES">
1990 <xs:documentation xml:lang="en-us">The module does
1991 not install the GUID, and the GUID must be present
1992 for the module to execute. </xs:documentation>
1995 <xs:enumeration value="SOMETIMES_CONSUMES">
1997 <xs:documentation xml:lang="en-us"> The module
1998 does not install the GUID, however, the GUID will
1999 be used if it is present. </xs:documentation>
2002 <xs:enumeration value="PRODUCES">
2004 <xs:documentation xml:lang="en-us"> The module
2005 always installs the GUID. </xs:documentation>
2008 <xs:enumeration value="SOMETIMES_PRODUCES">
2010 <xs:documentation xml:lang="en-us"> The Module
2011 will install the GUID under certain execution
2012 paths. </xs:documentation>
2015 <xs:enumeration value="UNDEFINED">
2017 <xs:documentation xml:lang="en-us"> The package
2018 creator knows that a GUID is used, but does not
2019 know how it is used. </xs:documentation>
2025 <xs:attribute name="GuidType" type="GuidListType" use="required"/>
2026 <xs:attribute name="SupArchList" type="ArchListType"
2028 <xs:attribute name="SupModList" type="ModuleListType"
2030 <xs:attribute name="FeatureFlag" type="xs:normalizedString"
2037 <!-- End of Guids Section -->
2039 <xs:element minOccurs="0" maxOccurs="1" name="Protocols">
2041 <xs:documentation xml:lang="en-us"> A listing of protocols required or
2042 produced by this module. </xs:documentation>
2046 <xs:element minOccurs="1" maxOccurs="unbounded" name="Protocol"
2050 <xs:element minOccurs="1" maxOccurs="1" name="CName"
2052 <xs:element ref="HelpText" minOccurs="0"
2053 maxOccurs="unbounded"/>
2055 <xs:attribute name="Usage" use="required">
2057 <xs:restriction base="xs:NCName">
2058 <xs:enumeration value="PRODUCES"/>
2059 <xs:enumeration value="SOMETIMES_PRODUCES"/>
2060 <xs:enumeration value="CONSUMES"/>
2061 <xs:enumeration value="SOMETIMES_CONSUMES"/>
2062 <xs:enumeration value="TO_START"/>
2063 <xs:enumeration value="BY_START"/>
2064 <xs:enumeration value="UNDEFINED"/>
2068 <xs:attribute name="Notify" type="xs:boolean" use="optional"/>
2069 <xs:attribute name="SupArchList" type="ArchListType"
2071 <xs:attribute name="SupModList" type="ModuleListType"
2073 <xs:attribute name="FeatureFlag" type="xs:normalizedString"
2080 <!-- End of Protocols Section -->
2082 <xs:element minOccurs="0" maxOccurs="1" name="PPIs">
2084 <xs:documentation xml:lang="en-us"> A listing of PPIs required or produced
2085 by this module. </xs:documentation>
2089 <xs:element minOccurs="1" maxOccurs="unbounded" name="Ppi"
2093 <xs:element minOccurs="1" maxOccurs="1" name="CName"
2095 <xs:element ref="HelpText" minOccurs="0"
2096 maxOccurs="unbounded"/>
2098 <xs:attribute name="Usage" use="required">
2100 <xs:restriction base="xs:NCName">
2101 <xs:enumeration value="PRODUCES"/>
2102 <xs:enumeration value="SOMETIMES_PRODUCES"/>
2103 <xs:enumeration value="CONSUMES"/>
2104 <xs:enumeration value="SOMETIMES_CONSUMES"/>
2105 <xs:enumeration value="UNDEFINED"/>
2109 <xs:attribute name="Notify" type="xs:boolean" use="optional"/>
2110 <xs:attribute name="SupArchList" type="ArchListType"
2112 <xs:attribute name="SupModList" type="ModuleListType"
2114 <xs:attribute name="FeatureFlag" type="xs:normalizedString"
2121 <!-- End of PPIs Section -->
2123 <xs:element minOccurs="0" maxOccurs="1" name="Externs">
2125 <xs:documentation xml:lang="en-us"> These elements specify additional
2126 information about the module. This area may be used by tools to generate
2127 code. </xs:documentation>
2131 <xs:element minOccurs="1" maxOccurs="unbounded" name="Extern">
2134 <xs:choice minOccurs="1">
2136 <xs:element minOccurs="0" maxOccurs="1"
2137 name="EntryPoint" type="xs:NCName"/>
2138 <xs:element minOccurs="0" maxOccurs="1"
2139 name="UnloadImage" type="xs:NCName"/>
2142 <xs:element minOccurs="0" maxOccurs="1"
2143 name="Constructor" type="xs:NCName"/>
2144 <xs:element minOccurs="0" maxOccurs="1"
2145 name="Destructor" type="xs:NCName"/>
2148 <xs:element ref="HelpText" minOccurs="0" maxOccurs="1"/>
2150 <xs:attribute name="SupArchList" type="ArchListType"
2152 <xs:attribute name="SupModList" type="ModuleListType"
2154 <xs:attribute name="FeatureFlag" type="xs:normalizedString"
2161 <!-- End of Externs Section -->
2163 <xs:element minOccurs="0" maxOccurs="1" name="PcdCoded">
2165 <xs:documentation xml:lang="en-us"> This section describes how a platform is
2166 coded with respect to the platform configuration knobs.
2171 <xs:element minOccurs="1" maxOccurs="unbounded" name="PcdEntry">
2174 <xs:element minOccurs="1" maxOccurs="1" name="CName"
2176 <xs:element minOccurs="1" maxOccurs="1"
2177 name="TokenSpaceGuidCName" type="xs:NCName"/>
2178 <xs:element minOccurs="0" maxOccurs="1" name="DefaultValue"
2179 type="xs:normalizedString"/>
2180 <xs:element ref="HelpText" minOccurs="0"
2181 maxOccurs="unbounded"/>
2183 <xs:attribute name="PcdItemType" type="PcdItemTypes"
2185 <xs:attribute name="PcdUsage" use="required">
2187 <xs:restriction base="xs:NCName">
2188 <xs:enumeration value="PRODUCES"/>
2189 <xs:enumeration value="SOMETIMES_PRODUCES"/>
2190 <xs:enumeration value="CONSUMES"/>
2191 <xs:enumeration value="SOMETIMES_CONSUMES"/>
2192 <xs:enumeration value="UNDEFINED"/>
2198 <xs:attribute name="SupArchList" type="ArchListType"
2200 <xs:attribute name="SupModList" type="ModuleListType"
2202 <xs:attribute name="FeatureFlag" type="xs:normalizedString"
2209 <!-- End of PcdCoded Section -->
2211 <xs:element minOccurs="0" maxOccurs="unbounded" name="PeiDepex">
2213 <xs:documentation xml:lang="en-us"> This is the PEI dependency expression
2214 for a Dependency Section. </xs:documentation>
2218 <xs:element name="Expression" type="xs:string" minOccurs="1"
2221 <xs:documentation xml:lang="en-us"> An in-fix expression, of C
2222 identifiers and TRUE, FALSE, AND, OR, NOT, BEFORE, and AFTER
2223 as well as parenthesis () in the in-fix notation. The
2224 operators are restricted to grammar defined in the PI
2225 specification. </xs:documentation>
2228 <xs:element ref="HelpText" minOccurs="0" maxOccurs="1"/>
2230 <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>
2231 <xs:attribute name="SupModList" type="ModuleListType" use="optional"/>
2232 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
2235 <!-- End of PeiDepex Section -->
2237 <xs:element minOccurs="0" maxOccurs="unbounded" name="DxeDepex">
2239 <xs:documentation xml:lang="en-us"> This is the DXE dependency expression
2240 for a Dependency Section. </xs:documentation>
2244 <xs:element name="Expression" type=" xs:string " minOccurs="1"
2247 <xs:documentation xml:lang="en-us"> An in-fix expression, of C
2248 identifiers and TRUE, FALSE, AND, OR, NOT, BEFORE, and AFTER
2249 as well as parenthesis () in the in-fix notation. The
2250 operators are restricted to grammar defined in the PI
2251 specification. </xs:documentation>
2254 <xs:element ref="HelpText" minOccurs="0" maxOccurs="1"/>
2256 <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>
2257 <xs:attribute name="SupModList" type="ModuleListType" use="optional"/>
2258 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
2261 <!-- End of DxeDepex Section -->
2263 <xs:element minOccurs="0" maxOccurs="unbounded" name="SmmDepex">
2265 <xs:documentation xml:lang="en-us"> This is the SMM dependency expression
2266 for a Dependency Section. </xs:documentation>
2270 <xs:element name="Expression" type=" xs:string " minOccurs="1"
2273 <xs:documentation xml:lang="en-us"> An in-fix expression, of C
2274 identifiers and TRUE, FALSE, AND, OR, NOT, BEFORE, and AFTER
2275 as well as parenthesis () in the in-fix notation. The
2276 operators are restricted to grammar defined in the PI
2277 specification. </xs:documentation>
2280 <xs:element ref="HelpText" minOccurs="0" maxOccurs="1"/>
2282 <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>
2283 <xs:attribute name="SupModList" type="ModuleListType" use="optional"/>
2284 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
2287 <!-- End of SmmDepex Section -->
2290 <xs:element minOccurs="0" maxOccurs="1" name="MiscellaneousFiles">
2292 <xs:documentation xml:lang="en-us"> This section is used to provide comments
2293 and/or list auxiliary files, such as pdb or map files.
2298 <xs:element minOccurs="0" maxOccurs="unbounded" name="Description">
2301 <xs:extension base="xs:string">
2302 <xs:attribute name="Lang" type="xs:language"
2303 default="en-us" use="optional"/>
2308 <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename">
2310 <xs:documentation xml:lang="en-us"> This is the path and
2311 filename location within the ZIP file. </xs:documentation>
2315 <xs:extension base="xs:anyURI">
2316 <xs:attribute name="Executable" type="xs:boolean"
2317 default="false" use="optional">
2319 <xs:documentation xml:lang="en-us"> If true, used
2320 by installation tools to ensure that a file that
2321 must be executable has the correct properties to
2322 permit execution. </xs:documentation>
2332 <!-- End of Module Surface Area Misc Section -->
2334 <xs:element minOccurs="0" maxOccurs="unbounded" name="UserExtensions">
2336 <xs:documentation xml:lang="en-us"> This section is used for any processing
2337 instructions that may be custom to the content provided by the
2338 distribution that are common to module. </xs:documentation>
2339 <xs:documentation xml:lang="en-us"> The content is vendor specific. </xs:documentation>
2340 <xs:documentation xml:lang="en-us"> The content can be plain text as well as
2341 any user-defined, properly formatted XML structure. </xs:documentation>
2343 <xs:complexType mixed="true">
2344 <xs:attribute name="UserId" type="xs:NCName" use="required">
2346 <xs:documentation xml:lang="en-us"> This is a single word identifier
2347 for grouping similar content. For example, ReferenceBuild might
2348 be used to identify non-PI compliant build steps, with two
2349 different UserExtensions sections, one with an Identifier of
2350 Prebuild, and another of PostBuild. Both UserExtensions sections
2351 would use the same UserId. </xs:documentation>
2354 <xs:attribute name="Identifier" type="xs:string" use="required">
2356 <xs:documentation xml:lang="en-us"> This can be any string used to
2357 differentiate or identify this section from other UserExtensions
2358 sections. </xs:documentation>
2359 <xs:documentation xml:lang="en-us"> For example, a PRE_PROCESS
2360 Identifier might indicate specific steps and tools required
2361 before processing module content, while a different
2362 UserExtensions section with a POST_PROCESS Identifier might
2363 describe steps that need to be executed after operations on this
2364 module. </xs:documentation>
2367 <xs:anyAttribute processContents="lax"/>
2370 <!-- End of Module Surface Area UserExtensions Section -->
2373 <xs:attribute name="BinaryModule" type="xs:boolean" default="false" use="optional">
2375 <xs:documentation xml:lang="en-us"> This attribute is used when the binaries are
2376 distributed for this module and no code generation from source files is
2377 required. If set, then the BinaryFiles section should be used, and any files
2378 listed in the SourceFiles section do not have to be built. Additionally, the
2379 AsBuilt section for each binary file must be included. </xs:documentation>
2385 <!-- End of the ModuleSurfaceArea element. -->
2387 <xs:element name="Tools">
2390 <xs:element minOccurs="0" maxOccurs="1" name="Header">
2393 <xs:element minOccurs="1" maxOccurs="1" name="Name"
2394 type="xs:normalizedString">
2396 <xs:documentation xml:lang="en-us">This is the User Interface
2397 Name for this Tools Distribution.</xs:documentation>
2400 <xs:element minOccurs="0" maxOccurs="1" name="Copyright"
2403 <xs:documentation xml:lang="en-us"> This is only required if the
2404 Copyright is different from the Distribution Package
2405 copyright. </xs:documentation>
2408 <xs:element minOccurs="0" maxOccurs="1" name="License" type="xs:string">
2410 <xs:documentation xml:lang="en-us"> This is only required if the
2411 License is different from the Distribution Package license.
2415 <xs:element minOccurs="0" maxOccurs="1" name="Abstract"
2416 type="xs:normalizedString">
2418 <xs:documentation xml:lang="en-us"> This is only required if the
2419 Abstract is different from the Distribution Package
2420 Abstract. </xs:documentation>
2423 <xs:element minOccurs="0" maxOccurs="1" name="Description"
2426 <xs:documentation xml:lang="en-us"> This is only required if the
2427 Description is different from the Distribution Package
2428 Description. </xs:documentation>
2434 <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename">
2436 <xs:documentation xml:lang="en-us"> This is the path and filename location
2437 within the ZIP file. </xs:documentation>
2441 <xs:extension base="xs:anyURI">
2442 <xs:attribute name="OS" type="SupportedOs" use="optional">
2444 <xs:documentation xml:lang="en-us"> This is required for
2445 tools that execute; it should not be used for
2446 configuration files. </xs:documentation>
2449 <xs:attribute name="Executable" type="xs:boolean" default="false"
2452 <xs:documentation xml:lang="en-us"> If true, used by
2453 installation tools to ensure that a file that must be
2454 executable has the correct properties to permit
2455 execution. </xs:documentation>
2465 <!-- End of the Tools element. -->
2467 <xs:element name="MiscellaneousFiles">
2469 <xs:documentation xml:lang="en-us"> This section contains a list of files that are not
2470 part of the code distributed with modules, packages or tools. </xs:documentation>
2474 <xs:element minOccurs="0" maxOccurs="1" name="Header">
2477 <xs:element minOccurs="0" maxOccurs="1" name="Name"
2478 type="xs:normalizedString">
2480 <xs:documentation xml:lang="en-us"> The User interface name for
2481 this content. </xs:documentation>
2484 <xs:element minOccurs="0" maxOccurs="1" name="Copyright"
2487 <xs:documentation xml:lang="en-us"> This is only required if the
2488 Copyright is different from the Distribution Package
2489 Copyright. </xs:documentation>
2492 <xs:element minOccurs="0" maxOccurs="1" name="License" type="xs:string">
2494 <xs:documentation xml:lang="en-us"> This is only required if the
2495 License is different from the Distribution Package License.
2499 <xs:element minOccurs="0" maxOccurs="1" name="Abstract"
2500 type="xs:normalizedString"/>
2501 <xs:element minOccurs="0" maxOccurs="unbounded" name="Description">
2504 <xs:extension base="xs:string">
2505 <xs:attribute name="Lang" type="xs:language"
2506 default="en-us" use="optional"/>
2514 <xs:element minOccurs="0" maxOccurs="unbounded" name="Filename">
2516 <xs:documentation xml:lang="en-us"> This is the path and filename location
2517 within the ZIP file. </xs:documentation>
2521 <xs:extension base="xs:anyURI">
2522 <xs:attribute name="Executable" type="xs:boolean" default="false"
2525 <xs:documentation xml:lang="en-us"> If true, used by
2526 installation tools to ensure that a file that must be
2527 executable has the correct properties to permit
2528 execution. </xs:documentation>
2538 <!-- End of the Misc element. -->
2540 <xs:element name="UserExtensions">
2541 <xs:complexType mixed="true">
2543 <xs:any processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
2545 <xs:attribute name="UserId" type="xs:NCName" use="required">
2547 <xs:documentation xml:lang="en-us"> This is a single word identifier for
2548 grouping similar content. For example, ReferenceBuild might be used to
2549 identify non-PI compliant build steps, with two different UserExtensions
2550 sections, one with an Identifier of Prebuild, and another of PostBuild. Both
2551 UserExtensions sections would use the same UserId. </xs:documentation>
2554 <xs:attribute name="Identifier" type="xs:string" use="optional">
2556 <xs:documentation xml:lang="en-us"> This can be any string used to differentiate
2557 or identify this section from other UserExtensions sections. </xs:documentation>
2558 <xs:documentation xml:lang="en-us"> For example, a PRE_PROCESS Identifier might
2559 indicate specific steps and tools required before processing distribution
2560 package content, while a different UserExtensions section with a
2561 POST_PROCESS Identifier might describe steps that need to be executed after
2562 operations on this content. </xs:documentation>
2565 <xs:anyAttribute processContents="lax"/>
2568 <!-- The following elsements are common definitions used with the ref attribute for elements. -->
2570 <xs:element name="HelpText">
2573 <xs:extension base="xs:string">
2574 <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"/>
2580 <!-- The following attribute groups are used in various elements above. -->
2582 <xs:attributeGroup name="SupportedArchMod">
2583 <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>
2584 <xs:attribute name="SupModList" type="ModuleListType" use="optional"/>
2585 </xs:attributeGroup>
2587 <!-- The following data types are used to restrict content. -->
2589 <xs:simpleType name="ArchListType">
2590 <xs:list itemType="ArchTypes"/>
2593 <xs:simpleType name="ArchTypes">
2594 <xs:restriction base="xs:NCName">
2595 <xs:enumeration value="IA32"/>
2596 <xs:enumeration value="X64"/>
2597 <xs:enumeration value="IPF"/>
2598 <xs:enumeration value="EBC"/>
2599 <xs:pattern value="([A-Z])([a-zA-Z0-9])*">
2601 <xs:documentation xml:lang="en-us"> Any processor architecture not listed above.
2602 The Architecture must be a target architecture of one or more compiler tool
2603 chains. </xs:documentation>
2610 <xs:simpleType name="FamilyTypes">
2611 <xs:restriction base="xs:NCName">
2612 <xs:enumeration value="MSFT"/>
2613 <xs:enumeration value="GCC"/>
2614 <xs:pattern value="[A-Z][a-zA-Z0-9]*">
2616 <xs:documentation xml:lang="en-us"> Any other family of build utilities for
2617 which compiler tools exist. </xs:documentation>
2623 <xs:simpleType name="GuidListType">
2624 <xs:list itemType="GuidTypes"/>
2627 <xs:simpleType name="GuidTypes">
2628 <xs:restriction base="xs:NCName">
2629 <xs:enumeration value="Event"/>
2630 <xs:enumeration value="File"/>
2631 <xs:enumeration value="FV"/>
2632 <xs:enumeration value="GUID"/>
2633 <xs:enumeration value="Hii"/>
2634 <xs:enumeration value="HOB"/>
2635 <xs:enumeration value="SystemTable"/>
2636 <xs:enumeration value="TokenSpaceGuid"/>
2637 <xs:enumeration value="Variable"/>
2638 <xs:enumeration value="UNDEFINED"/>
2642 <xs:simpleType name="HexNumber">
2643 <xs:restriction base="xs:hexBinary">
2644 <xs:pattern value="0x([a-fA-F0-9])+"/>
2648 <xs:simpleType name="Md5Sum">
2649 <xs:restriction base="xs:normalizedString">
2650 <xs:pattern value="[a-zA-Z0-9]{32}"/>
2654 <xs:simpleType name="ModuleListType">
2655 <xs:list itemType="ModuleTypes"/>
2658 <xs:simpleType name="ModuleTypes">
2660 <xs:documentation xml:lang="en-us"> The following module types are defined by
2661 specifications. </xs:documentation>
2662 <xs:documentation xml:lang="en-us"> Module types for components and libraries defined
2663 for this distribution mechanism. </xs:documentation>
2665 <xs:restriction base="xs:NCName">
2666 <xs:enumeration value="BASE ">
2668 <xs:documentation xml:lang="en-us"> Use of this module is not restricted.
2672 <xs:enumeration value="DXE_CORE">
2674 <xs:documentation xml:lang="en-us"> This module is only applicable to the DXE
2675 core. </xs:documentation>
2678 <xs:enumeration value="DXE_DRIVER">
2680 <xs:documentation xml:lang="en-us"> This module is only applicable to a DXE
2681 driver. </xs:documentation>
2684 <xs:enumeration value="DXE_RUNTIME_DRIVER">
2686 <xs:documentation xml:lang="en-us"> This module is only applicable to a DXE
2687 runtime driver. </xs:documentation>
2690 <xs:enumeration value="DXE_SAL_DRIVER">
2692 <xs:documentation xml:lang="en-us"> This module is only applicable to an IPF DXE
2693 runtime driver. </xs:documentation>
2696 <xs:enumeration value="DXE_SMM_DRIVER">
2698 <xs:documentation xml:lang="en-us"> This module is only applicable to a DXE SMM
2699 driver. </xs:documentation>
2702 <xs:enumeration value="PEI_CORE">
2704 <xs:documentation xml:lang="en-us"> This module is only applicable to the PEI
2705 core. </xs:documentation>
2708 <xs:enumeration value="PEIM">
2710 <xs:documentation xml:lang="en-us"> This module is only valid for PEI modules.
2714 <xs:enumeration value="SEC">
2716 <xs:documentation xml:lang="en-us"> This module is only applicable to Security
2717 phase. </xs:documentation>
2720 <xs:enumeration value="UEFI_DRIVER">
2722 <xs:documentation xml:lang="en-us"> This module is only valid for UEFI drivers.
2726 <xs:enumeration value="UEFI_RUNTIME_DRIVER">
2728 <xs:documentation xml:lang="en-us"> This module is only valid for UEFI runtime
2729 drivers.</xs:documentation>
2732 <xs:enumeration value="UEFI_APPLICATION">
2734 <xs:documentation xml:lang="en-us"> This module is only valid for UEFI
2735 applications. </xs:documentation>
2738 <xs:enumeration value="SMM_CORE">
2740 <xs:documentation xml:lang="en-us"> This module is only applicable to the SMM
2741 core.</xs:documentation>
2744 <xs:enumeration value="USER_DEFINED">
2746 <xs:documentation xml:lang="en-us"> This content is restricted to a specific
2747 implementation. </xs:documentation>
2750 <xs:enumeration value="UNDEFINED">
2752 <xs:documentation xml:lang="en-us"> This enumeration is for use in a list that
2753 where the package creator does not know the what module types are supported
2754 by a module. </xs:documentation>
2757 <xs:pattern value="([A-Z])([a-zA-Z0-9])*">
2759 <xs:documentation xml:lang="en-us"> This pattern has been added for use in a
2760 module lists - for future expansion. </xs:documentation>
2766 <xs:simpleType name="PcdDatumTypes">
2768 <xs:documentation xml:lang="en-us"> The following data types are defined by the PCD
2769 specification (or PCD section of the UEFI/PI specifications.) </xs:documentation>
2771 <xs:restriction base="xs:normalizedString">
2772 <xs:enumeration value="UINT8"/>
2773 <xs:enumeration value="UINT16"/>
2774 <xs:enumeration value="UINT32"/>
2775 <xs:enumeration value="UINT64"/>
2776 <xs:enumeration value="BOOLEAN"/>
2777 <xs:enumeration value="VOID*"/>
2781 <xs:simpleType name="PcdItemListType">
2782 <xs:list itemType="PcdItemTypes"/>
2785 <xs:simpleType name="PcdItemTypes">
2786 <xs:restriction base="xs:NCName">
2787 <xs:enumeration value="FeaturePcd">
2789 <xs:documentation xml:lang="en-us"> The Feature PCD is a binary, evaluating to
2790 either true or false. This is used during build to include/exclude content.
2791 It can also be used during execution to force execution paths within
2792 drivers, or to enable/disable features within a driver for a given platform.
2796 <xs:enumeration value="FixedPcd">
2798 <xs:documentation xml:lang="en-us"> The Fixed PCD is a #define value that is set
2799 at build time. </xs:documentation>
2802 <xs:enumeration value="PatchPcd">
2804 <xs:documentation xml:lang="en-us"> The Patch PCD is a #define that is set at
2805 build time, and that can be modified within a binary file. Additional
2806 information, such as the offset location of the value, along with it's
2807 length may need to be provided.</xs:documentation>
2810 <xs:enumeration value="Pcd">
2812 <xs:documentation xml:lang="en-us"> This PCD type has an overloaded definition.
2813 Prior to build, the platform integrator may choose to implement a PCD as
2814 Fixed, Patchable or a Dynamic PCD. If the platform integrator choose to use
2815 the PCD as dynamic, then a PCD driver is required in the platform
2816 (PEI/DXE/both) to track the PCD in some sort of 'database' of these items.
2817 For Dynamic PCDs, the PcdGet* must pass in the token space guid and the
2818 token number to retrieve data (PcdSet* also needs these values.)
2822 <xs:enumeration value="PcdEx">
2824 <xs:documentation xml:lang="en-us"> The PCD can only be used as Dynamic, and the
2825 platform firmware must contain a driver to maintain a 'database' of these
2826 items. For Dynamic PCDs, the PcdGet* must pass in the token space guid and
2827 the token number to retrieve data (PcdSet* also needs these values.)
2836 <xs:simpleType name="RegistryFormatGuid">
2838 <xs:documentation xml:lang="en-us"> A GUID must contain five different Hexadecimal
2839 character sets that are separated by a dash (-) character. </xs:documentation>
2841 <xs:restriction base="xs:string">
2843 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*"
2848 <xs:simpleType name="SupportedOs">
2850 <xs:documentation xml:lang="en-us"> The EDK II build system supports workstations
2851 running one of the following supported operating systems. This is the OS for the
2852 developer's workstation, not the target platform. </xs:documentation>
2854 <xs:restriction base="xs:string">
2855 <xs:enumeration value="Win32">
2857 <xs:documentation xml:lang="en-us"> For Windows 2003, Windows XP and Windows
2858 Vista. </xs:documentation>
2861 <xs:enumeration value="Win64">
2863 <xs:documentation xml:lang="en-us"> For Windows 2003, Windows XP and Windows
2864 Vista. </xs:documentation>
2867 <xs:enumeration value="Linux32"/>
2868 <xs:enumeration value="Linux64"/>
2869 <xs:enumeration value="OS/X32"/>
2870 <xs:enumeration value="OS/X64"/>
2871 <xs:enumeration value="GenericWin">
2873 <xs:documentation xml:lang="en-us"> Typically, this is used for Windows Batch
2874 files. </xs:documentation>
2877 <xs:enumeration value="GenericNix">
2879 <xs:documentation xml:lang="en-us"> Typically use for shell scripts - valid for
2880 any Linux and Mac OS/X. </xs:documentation>
2883 <xs:pattern value="[a-zA-Z]([a-zA-Z0-9])*"/>
projects / mirror_edk2.git / blob