1 <?xml version="1.0" encoding="UTF-8"?>
3 Filename: DistributionPackage.xsd
5 Copyright (c) 2008 - 2012, 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/2012/1.0" xmlns="http://www.uefi.org/2012/1.0">
17 <xs:element name="DistributionPackage">
19 <xs:documentation xml:lang="en-us"> This schema defines the UEFI/PI Distribution Package description (PKG)
20 file. It describes the content of:</xs:documentation>
21 <xs:documentation xml:lang="en-us"> 1) Package descriptions with definitions and headers.</xs:documentation>
22 <xs:documentation xml:lang="en-us"> 2) Modules in either source or binary format. (Note that Binary format
23 is for FFS leaf section file types only, complete FFS files cannot be distributed using this
24 distribution format.) </xs:documentation>
25 <xs:documentation xml:lang="en-us"> 3) The distribution of custom tools used to modify the binary images to
26 create UEFI/PI compliant images. </xs:documentation>
27 <xs:documentation xml:lang="en-us"> 4) Finally, it can be used to distribute other miscellaneous content
28 that is not specific to UEFI/PI images. </xs:documentation>
29 <xs:documentation xml:lang="en-us"> The Package Surface Area describes the content of packages, while the
30 Module Surface Area provides information relevant to source and/or binary distributions.
35 <xs:element ref="DistributionHeader" minOccurs="1" maxOccurs="1">
37 <xs:documentation xml:lang="en-us"> This header contains (legal) information usually required
38 for distributing both binary and/or source code. </xs:documentation>
41 <xs:element ref="PackageSurfaceArea" minOccurs="0" maxOccurs="unbounded">
43 <xs:documentation xml:lang="en-us"> The list of packages in this distribution. </xs:documentation>
44 <xs:documentation xml:lang="en-us"> Packages are groups of files and/or modules that are similar
45 in nature.</xs:documentation>
46 <xs:documentation xml:lang="en-us"> Packages are uniquely identified by a package GUID and a
47 package version. </xs:documentation>
48 <xs:documentation xml:lang="en-us"> A package can declare public mappings of C names to GUID
49 values. </xs:documentation>
50 <xs:documentation xml:lang="en-us"> A package can provide header files for library classes
51 and/or other industry standard definitions. </xs:documentation>
52 <xs:documentation xml:lang="en-us"> A package can also declare public mappings of platform
53 configuration database (PCD) "knobs" to control features and operation of modules
54 within a platform. </xs:documentation>
55 <xs:documentation xml:lang="en-us"> Finally, a package lists the library instances and/or
56 modules that are provided in a distribution package. </xs:documentation>
59 <xs:element ref="ModuleSurfaceArea" minOccurs="0" maxOccurs="unbounded">
61 <xs:documentation xml:lang="en-us"> The listing of UEFI/PI compliant modules in this
62 distribution that are NOT part of a Package. Every module that is provided as part of a
63 package needs to be described in a PackageSurfaceArea.Modules section. </xs:documentation>
64 <xs:documentation xml:lang="en-us"> The ModuleSurfaceArea section describes how each module in a
65 distribution is coded, or, in the case of a binary module distribution, how it was built. </xs:documentation>
66 <xs:documentation xml:lang="en-us"> UEFI/PI compliant libraries and modules are uniquely
67 identified by the Module's GUID and version number. </xs:documentation>
68 <xs:documentation xml:lang="en-us"> This section will typically be used for modules that don't
69 require any additional files that would be included in a package. For example, the Enhanced
70 FAT driver binary does not need to have a package description, as no additional files are
71 provided. </xs:documentation>
74 <xs:element ref="Tools" minOccurs="0" maxOccurs="unbounded">
76 <xs:documentation xml:lang="en-us"> This section is for distributing vendor specific executable
77 tools, tool source code and/or configuration files. These tools are primarily for
78 manipulating code and/or binary images. </xs:documentation>
79 <xs:documentation xml:lang="en-us"> Tools in this section can:</xs:documentation>
80 <xs:documentation xml:lang="en-us"> 1) Parse build meta-data files to create source code files
81 and build scripts. </xs:documentation>
82 <xs:documentation xml:lang="en-us"> 2) Modify image files to conform to UEFI/PI specifications. </xs:documentation>
83 <xs:documentation xml:lang="en-us"> 3) Generate binary files from certain types of text/unicode
84 files. </xs:documentation>
85 <xs:documentation xml:lang="en-us"> 4) Generate PCI Option Roms or Firmware Device images. </xs:documentation>
86 <xs:documentation xml:lang="en-us"> 5) Implement external encoding/decoding/signature/GUIDed
87 tools. </xs:documentation>
88 <xs:documentation xml:lang="en-us"> 6) Distribution Package create/install/remove tools.
92 <xs:element ref="MiscellaneousFiles" minOccurs="0" maxOccurs="unbounded">
94 <xs:documentation xml:lang="en-us"> The list of miscellaneous files in this distribution. Any
95 files that are not listed in either the Package, Module or Tools sections can be listed
96 here. This section can be used to distribute specifications for packages and modules that
97 are not "industry standards" such as a specification for a chipset or a video
98 device. </xs:documentation>
101 <xs:element ref="UserExtensions" minOccurs="0" maxOccurs="unbounded">
103 <xs:documentation xml:lang="en-us"> The UserExtensions section is used to disseminate processing
104 instructions that may be custom to the content provided by the distribution. This section
105 contains information that is common to all aspects of this disribution. </xs:documentation>
112 <!-- End of the DistributionPackage Description -->
114 <xs:element name="DistributionHeader">
116 <xs:documentation xml:lang="en-us"> This section defines the content of the UEIF/PI compliant Distribution
117 Package Header. This is the only required element of a UEFI/PI compliant distribution package.
122 <xs:element minOccurs="1" maxOccurs="1" name="Name">
124 <xs:documentation xml:lang="en-us"> This is the User Interface Name for this Distribution
125 Package. </xs:documentation>
126 <xs:documentation xml:lang="en-us"> Each Distribution Package is uniquely identified by it's
127 GUID and Version number. </xs:documentation>
131 <xs:extension base="xs:normalizedString">
132 <xs:attribute name="BaseName" type="xs:NMTOKEN" use="optional">
134 <xs:documentation xml:lang="en-us"> The reference name of the Distribution
135 Package file. This single word name can be used by tools as a keyword or for
136 directory and/or file creation. </xs:documentation>
137 <xs:documentation xml:lang="en-us"> White space and special characters (dash and
138 underscore characters may be used) are not permitted in this name.
146 <xs:element minOccurs="1" maxOccurs="1" name="GUID">
148 <xs:documentation xml:lang="en-us"> This 128-bit GUID and the Version attribute uniquely
149 identify this Distribution Package. </xs:documentation>
150 <xs:documentation xml:lang="en-us"> Backward compatible releases of a distribution package need
151 only change the version number, while non-backward compatible changes require the GUID to
152 change (resetting the version number to 1.0 is optional.) </xs:documentation>
156 <xs:extension base="RegistryFormatGuid">
157 <xs:attribute name="Version" type="xs:decimal" use="required">
159 <xs:documentation xml:lang="en-us"> This value, along with the GUID, is used to
160 uniquely identify this object. The higher the number, the more recent the
161 content. </xs:documentation>
168 <xs:element minOccurs="1" maxOccurs="1" name="Vendor" type="xs:normalizedString">
170 <xs:documentation xml:lang="en-us"> A string identifying who created this distribution package.
174 <xs:element minOccurs="1" maxOccurs="1" name="Date" type="xs:dateTime">
176 <xs:documentation xml:lang="en-us"> The date and time this distribution was created. The format
177 is: YYYY-MM-DDThh:mm:ss, for example: 2001-01-31T13:30:00 (note the T character separator
178 between the calendar date and the time. </xs:documentation>
181 <xs:element minOccurs="1" maxOccurs="unbounded" name="Copyright">
183 <xs:documentation xml:lang="en-us"> The copyright for this file that is generated by the creator
184 of the distribution. If a derivative work is generated from an existing distribution, then
185 the existing copyright must be maintained, and additional copyrights may be appended to the
186 end of this element. It may also be the primary copyright for all code provided in the
187 Distribution Package. </xs:documentation>
191 <xs:extension base="xs:string">
192 <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"/>
198 <xs:element minOccurs="1" maxOccurs="unbounded" name="License">
200 <xs:documentation xml:lang="en-us"> A license that describes any restrictions on the use of this
201 distribution. If a derivative work is allowed by the original license and a derivative work
202 is generated from an existing distribution, then the existing license must be maintained,
203 and additional licenses may be appended to the end of this element. It may also be the
204 primary license for all code provided in the distribution file. Alternatively, this may
205 point to a filename that contains the License. The file (included in the content zip file)
206 will be stored in the same location as the distribution package's .pkg file.
211 <xs:extension base="xs:string">
212 <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"/>
217 <xs:element minOccurs="1" maxOccurs="unbounded" name="Abstract">
219 <xs:documentation xml:lang="en-us"> A one line description of the Distribution Package.
224 <xs:extension base="xs:normalizedString">
225 <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"/>
230 <xs:element minOccurs="0" maxOccurs="unbounded" name="Description">
232 <xs:documentation xml:lang="en-us"> A complete description of the Distribution Package. This
233 description may include the release name of the file, the version of the file, and a
234 complete description of the file contents and/or features including a description of the
235 updates since the previous file release. </xs:documentation>
239 <xs:extension base="xs:string">
240 <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"/>
245 <xs:element minOccurs="0" maxOccurs="1" name="Signature" type="Md5Sum">
247 <xs:documentation xml:lang="en-us"> The packaging utilities will use this MD5 sum value of the
248 included ZIP file containing files and/or code. If this element is not present, then
249 installation tools should assume that the content is correct, or that other methods may be
250 needed to verify content. </xs:documentation>
253 <xs:element minOccurs="1" maxOccurs="1" name="XmlSpecification" type="xs:decimal" default="1.1">
255 <xs:documentation xml:lang="en-us"> This version of this XML Schema is 1.1 </xs:documentation>
256 <xs:documentation xml:lang="en-us"> Changes to 1.1 from 1.0 </xs:documentation>
257 <xs:documentation xml:lang="en-us"> #1 Updated to present date and new version which is
258 important to reflect the present state of the matter</xs:documentation>
259 <xs:documentation xml:lang="en-us"> #2 Added definition/enumeration of UNDEFIND type 2 is
260 important since there is a large body of legacy code for which the GUID’s and other
261 code/data objects were not decorated with their usage. This document will allow for
262 importing today’s source artifacts and producing decorations using the ‘Undefined’ versus
263 having an error</xs:documentation>
264 <xs:documentation xml:lang="en-us">#3 Allow for inclusion of ARM and future architecture
265 types</xs:documentation>
269 <xs:attribute name="ReadOnly" type="xs:boolean" default="false" use="optional">
271 <xs:documentation xml:lang="en-us"> If set to true, all content within this Distribution Package
272 should NOT be modified. The default permits modification of all content. </xs:documentation>
275 <xs:attribute name="RePackage" type="xs:boolean" default="false" use="optional">
277 <xs:documentation xml:lang="en-us"> If set to true, then the content can be repackaged into another
278 distribution package. The default prohibits repackaging the Distribution content.
284 <!-- End of the DistributionHeader element. -->
286 <xs:element name="PackageSurfaceArea">
288 <xs:documentation xml:lang="en-us"> A package is a collection of related objects - Includes, Libraries and
289 Modules. </xs:documentation>
290 <xs:documentation xml:lang="en-us"> Each package is uniquely identified by it's GUID and Version number.
291 Backward compatible releases of a package need only change the version number, while non-backward
292 compatible changes require the GUID to change (resetting the version number to 1.0 is optional.)
298 <xs:element minOccurs="1" maxOccurs="1" name="Header">
301 <xs:element minOccurs="1" maxOccurs="1" name="Name">
303 <xs:documentation xml:lang="en-us"> This is the User Interface Name for this
304 package. </xs:documentation>
308 <xs:extension base="xs:normalizedString">
309 <xs:attribute name="BaseName" type="xs:NMTOKEN" use="required">
311 <xs:documentation xml:lang="en-us"> This is a single word BaseName
312 of the package. This BaseName can be used by tools as a keyword
313 and for directory/file creation. </xs:documentation>
320 <xs:element minOccurs="1" maxOccurs="1" name="GUID">
322 <xs:documentation xml:lang="en-us"> This GUID and the Version attribute uniquely
323 identify a given package. </xs:documentation>
327 <xs:extension base="RegistryFormatGuid">
328 <xs:attribute name="Version" type="xs:decimal" use="required">
330 <xs:documentation xml:lang="en-us"> This value, along with the GUID,
331 is used to uniquely identify this object. </xs:documentation>
332 <xs:documentation xml:lang="en-us"> Backward compatible changes must
333 make sure this number is incremented from the most recent
334 version. Non-backward compatible changes require a new GUID, and
335 the version can be reset. </xs:documentation>
342 <xs:element minOccurs="0" maxOccurs="unbounded" name="Copyright">
344 <xs:documentation xml:lang="en-us"> If the package requires a different copyright
345 than the distribution package, this element can list one or more copyright
346 lines. </xs:documentation>
350 <xs:extension base="xs:string">
351 <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"
358 <xs:element minOccurs="0" maxOccurs="unbounded" name="License">
360 <xs:documentation xml:lang="en-us"> If the package requires licenses that are
361 different from the distribution package license, this element can contain one or
362 more license text paragraphs (or license filenames.) </xs:documentation>
366 <xs:extension base="xs:string">
367 <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"
374 <xs:element minOccurs="0" maxOccurs="unbounded" name="Abstract">
376 <xs:documentation xml:lang="en-us"> A one line description of this package.
381 <xs:extension base="xs:normalizedString">
382 <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"
388 <xs:element minOccurs="0" maxOccurs="unbounded" name="Description">
390 <xs:documentation xml:lang="en-us"> A complete description of a package. This
391 description may include the release name of the package, the version of the
392 package, and a complete description of the package contents and/or features
393 including a description of the updates since the previous package’s release.
398 <xs:extension base="xs:string">
399 <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"
405 <xs:element minOccurs="1" maxOccurs="1" name="PackagePath" type="xs:anyURI">
407 <xs:documentation xml:lang="en-us"> This element is the location (in the ZIP file)
408 for the root directory of a package. </xs:documentation>
414 <!-- End of PackageSurfaceArea Header element. -->
416 <xs:element minOccurs="0" maxOccurs="1" name="ClonedFrom">
418 <xs:documentation xml:lang="en-us"> The term cloned is used here to indicate that this package
419 as been copied and modified to a completely different package. An example might be for a new
420 generation of chipsets that have few or no elements in common with the original.
425 <xs:element minOccurs="1" maxOccurs="1" name="GUID">
427 <xs:documentation xml:lang="en-us"> This GUID and the Version attribute uniquely
428 identify the Package that this Package was copied from. </xs:documentation>
432 <xs:extension base="RegistryFormatGuid">
433 <xs:attribute name="Version" type="xs:decimal" use="required">
435 <xs:documentation xml:lang="en-us"> This value, along with the GUID,
436 is used to uniquely identify the package that this package was
437 cloned from. </xs:documentation>
447 <!-- End of PackageSurfaceArea ClonedFrom element. -->
449 <xs:element minOccurs="0" maxOccurs="1" name="LibraryClassDeclarations">
451 <xs:documentation xml:lang="en-us"> Library Classes are public interfaces that can be used by
452 modules. One or more library instances can implement a library class, however only one
453 library instance can be linked to an individual module. This provides the platform
454 integrator with the flexibility of choosing one library instance's implementation over a
455 different library instance. </xs:documentation>
459 <xs:element minOccurs="1" maxOccurs="unbounded" name="LibraryClass">
462 <xs:element minOccurs="1" maxOccurs="1" name="HeaderFile" type="xs:anyURI">
464 <xs:documentation xml:lang="en-us"> The header file provides definitions
465 and function prototypes for a library class. Modules can be coded
466 against these functions, using the definitions in this header,
467 without concerning themselves about the libraries' implementation
468 details. This is a PackagePath relative path and filename for the
469 include file. </xs:documentation>
472 <xs:element minOccurs="0" maxOccurs="1" name="RecommendedInstance">
475 <xs:element minOccurs="1" maxOccurs="1" name="GUID">
477 <xs:documentation xml:lang="en-us"> This GUID and the
478 Version attribute uniquely identify the Recommended Library
479 Instance. </xs:documentation>
483 <xs:extension base="RegistryFormatGuid">
484 <xs:attribute name="Version" type="xs:decimal"
487 <xs:documentation xml:lang="en-us"> This value, along with
488 the GUID, is used to uniquely identify this object. If this
489 value is not specified, then any version of the library
490 instance is recommended. </xs:documentation>
500 <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>
502 <xs:attribute name="Keyword" type="xs:NCName" use="required">
504 <xs:documentation xml:lang="en-us"> The single word name of the Library
505 Class that module developers will use to identify a library class
506 dependency. </xs:documentation>
509 <xs:attributeGroup ref="SupportedArchMod"/>
515 <!-- End of PackageSurfaceArea LibraryClassDeclarations element. -->
517 <xs:element minOccurs="0" maxOccurs="1" name="IndustryStandardIncludes">
519 <xs:documentation xml:lang="en-us"> This section is used to list header files for industry
520 standards not under the auspices of UEFI.org. For example, headers that contain definitions
521 and data structures for the USB specifications. </xs:documentation>
525 <xs:element minOccurs="1" maxOccurs="unbounded" name="IndustryStandardHeader">
528 <xs:element minOccurs="1" maxOccurs="1" name="HeaderFile" type="xs:anyURI">
530 <xs:documentation xml:lang="en-us"> The package relative path and
531 filename (in the content zip file) of the industry standard include
532 file. </xs:documentation>
535 <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>
542 <!-- End of PackageSurfaceArea IndustryStdIncludes element. -->
544 <xs:element minOccurs="0" maxOccurs="1" name="PackageIncludes">
546 <xs:documentation xml:lang="en-us"> All top level header files that are included by a package
547 that are not listed above. They cannot be:</xs:documentation>
548 <xs:documentation xml:lang="en-us"> 1) Local to a module (module specific.) </xs:documentation>
549 <xs:documentation xml:lang="en-us"> 2) An industry standard header. </xs:documentation>
550 <xs:documentation xml:lang="en-us"> 3) A library class header. </xs:documentation>
554 <xs:element minOccurs="1" maxOccurs="unbounded" name="PackageHeader">
557 <xs:element minOccurs="1" maxOccurs="1" name="HeaderFile">
559 <xs:documentation xml:lang="en-us"> This is the Package relative path
560 and filename location within the content ZIP file.
565 <xs:extension base="xs:anyURI">
566 <xs:attributeGroup ref="SupportedArchMod"/>
571 <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>
578 <!-- End of PackageSurfaceArea PackageIncluces element. -->
580 <xs:element minOccurs="0" maxOccurs="1" name="Modules">
583 <xs:element ref="ModuleSurfaceArea" minOccurs="1" maxOccurs="unbounded">
585 <xs:documentation xml:lang="en-us"> This section lists the Module Surface Area for
586 all modules provided with this package. </xs:documentation>
592 <!-- End of PackageSurfaceArea Modules element. -->
594 <xs:element minOccurs="0" maxOccurs="1" name="GuidDeclarations">
596 <xs:documentation xml:lang="en-us"> This section defines the mapping of GUID C names to GUID
597 values as a Registry Format GUID. </xs:documentation>
598 <xs:documentation xml:lang="en-us"> Modules that use these GUIDs must specify their dependency
599 on this package. </xs:documentation>
603 <xs:element minOccurs="1" maxOccurs="unbounded" name="Entry">
605 <xs:documentation xml:lang="en-us"> Individual GUID Declarations </xs:documentation>
609 <xs:element minOccurs="1" maxOccurs="1" name="CName" type="xs:NCName"/>
610 <xs:element minOccurs="1" maxOccurs="1" name="GuidValue"
611 type="RegistryFormatGuid"/>
612 <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>
614 <xs:attribute name="UiName" type="xs:normalizedString" use="optional"/>
615 <xs:attribute name="GuidTypes" type="GuidListType" use="optional"/>
616 <xs:attributeGroup ref="SupportedArchMod"/>
622 <!-- End of PackageSurfaceArea GuidDeclarations element. -->
624 <xs:element minOccurs="0" maxOccurs="1" name="ProtocolDeclarations">
626 <xs:documentation xml:lang="en-us"> This section defines the mapping of Protocol C names to GUID
627 values as a Registry Format GUID. </xs:documentation>
628 <xs:documentation xml:lang="en-us"> Modules that use these Protocols must specify their
629 dependency on this package. </xs:documentation>
633 <xs:element minOccurs="1" maxOccurs="unbounded" name="Entry">
635 <xs:documentation xml:lang="en-us"> Individual Protocol Declarations
640 <xs:element minOccurs="1" maxOccurs="1" name="CName" type="xs:NCName"/>
641 <xs:element minOccurs="1" maxOccurs="1" name="GuidValue"
642 type="RegistryFormatGuid"/>
643 <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>
645 <xs:attribute name="UiName" type="xs:normalizedString" use="optional"/>
646 <xs:attributeGroup ref="SupportedArchMod"/>
652 <!-- End of PackageSurfaceArea ProtocolDeclarations element. -->
654 <xs:element minOccurs="0" maxOccurs="1" name="PpiDeclarations">
656 <xs:documentation xml:lang="en-us"> This section defines the mapping of Ppi C names to GUID
657 values as a Registry Format GUID. </xs:documentation>
658 <xs:documentation xml:lang="en-us"> Modules that use these Ppis must specify their dependency on
659 this package. </xs:documentation>
663 <xs:element minOccurs="1" maxOccurs="unbounded" name="Entry">
665 <xs:documentation xml:lang="en-us"> Individual PPI Declarations </xs:documentation>
669 <xs:element minOccurs="1" maxOccurs="1" name="CName" type="xs:NCName"/>
670 <xs:element minOccurs="1" maxOccurs="1" name="GuidValue"
671 type="RegistryFormatGuid"/>
672 <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>
674 <xs:attribute name="UiName" type="xs:normalizedString" use="optional"/>
675 <xs:attributeGroup ref="SupportedArchMod"/>
681 <!-- End of PackageSurfaceArea PpiDeclarations element. -->
683 <xs:element minOccurs="0" maxOccurs="1" name="PcdDeclarations">
685 <xs:documentation xml:lang="en-us"> This section is used to declare platform configuration knobs
686 that are defined by this package. </xs:documentation>
687 <xs:documentation xml:lang="en-us"> Modules that use these PCD values must specify their
688 dependency on this package. </xs:documentation>
692 <xs:element minOccurs="1" maxOccurs="unbounded" name="PcdEntry">
695 <xs:element minOccurs="1" maxOccurs="1" name="TokenSpaceGuidCname"
698 <xs:documentation xml:lang="en-us"> Specifies the C name of the Token
699 Space GUID of which this PCD Entry is a member. This C name should
700 also be listed in the GUIDs section, (specified above,) where the C
701 name is assigned to a GUID value. </xs:documentation>
704 <xs:element minOccurs="1" maxOccurs="1" name="Token">
706 <xs:documentation xml:lang="en-us"> Specifies the 32-bit token value for
707 this PCD Entry. The Token number must be unique to the Token Space
708 that declares the PCD. </xs:documentation>
709 <xs:documentation xml:lang="en-us"> The minLength of 3 is required to
710 handle the "0x" prefix to the hex number. </xs:documentation>
713 <xs:restriction base="HexNumber">
714 <xs:minLength value="3"/>
715 <xs:maxLength value="10"/>
719 <xs:element minOccurs="1" maxOccurs="1" name="CName" type="xs:NCName"/>
720 <xs:element minOccurs="1" maxOccurs="1" name="DatumType" type="PcdDatumTypes">
722 <xs:documentation xml:lang="en-us"> A string that contains the data type
723 of this PCD Entry. PCD data types are restricted to the following
724 set:UINT8, UINT16, UINT32, UINT64, VOID*, BOOLEAN.
728 <xs:element minOccurs="1" maxOccurs="1" name="ValidUsage" type="PcdItemListType">
730 <xs:documentation xml:lang="en-us"> A string that contains one or more
731 PCD Item types separated by spaces. The PCD Item types are
732 restricted to FeaturePcd, FixedPcd, PatchPcd, Pcd and/or PcdEx.
736 <xs:element minOccurs="1" maxOccurs="1" name="DefaultValue"
737 type="xs:normalizedString"/>
738 <xs:element minOccurs="0" maxOccurs="1" name="MaxDatumSize">
740 <xs:documentation xml:lang="en-us"> This is a recommended maximum data
741 size for VOID* data types, the actual value should be defined by the
742 Platform Integrator. It is not required for the other data types. </xs:documentation>
743 <xs:documentation xml:lang="en-us"> The minLength of 3 is required to
744 handle the "0x" prefix to the hex number. </xs:documentation>
748 <xs:restriction base="HexNumber">
749 <xs:minLength value="3"/>
753 <xs:element minOccurs="0" maxOccurs="unbounded" name="Prompt">
755 <xs:documentation xml:lang="en-US"> This entry contains prompt
756 information, that may used by tools to assist platform integrators
757 with choosing the correct values </xs:documentation>
761 <xs:extension base="xs:string">
762 <xs:attribute name="Lang" type="xs:language" default="en-us"
768 <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>
770 <xs:element minOccurs="0" maxOccurs="unbounded" name="PcdError">
772 <xs:documentation xml:lang="en-us"> Valid Error messages that may be
773 implemented in a module for the PCD Entry. Only One Error Number per
774 PcdError, (multiple ErrorMessage entries are permitted) and multiple
775 PcdError elements are permitted. </xs:documentation>
779 <xs:choice minOccurs="1" maxOccurs="1">
781 <xs:documentation xml:lang="en-us"> One of the following
782 types of comparisons, which must be able to evaluate to
783 either true or false. </xs:documentation>
785 <xs:element minOccurs="0" maxOccurs="1" name="ValidValueList">
787 <xs:documentation xml:lang="en-us"> The PCD Value must be
788 space separated list of values. Values are restricted to the
789 data type of this PCD. </xs:documentation>
793 <xs:extension base="xs:normalizedString">
794 <xs:attribute name="Lang" type="xs:language" use="optional"
800 <xs:element minOccurs="0" maxOccurs="1" name="ValidValueRange"
801 type="xs:normalizedString">
803 <xs:documentation xml:lang="en-us"> The PCD must be within a
804 specifed range of numeric values. Restricted to C style
805 Relational, Equality and Logicial Operators and parenthesis
806 are valid. Only the CName for this PCD is permitted in the
807 ValidValueRange expression. All other values must be
808 numeric.</xs:documentation>
809 <xs:documentation xml:lang="en-us"> LValue (op RValue)+
813 <xs:element minOccurs="0" maxOccurs="1" name="Expression"
814 type="xs:normalizedString">
816 <xs:documentation xml:lang="en-us"> A in-fix logical
817 expression using C style logical operators.
822 <xs:element minOccurs="1" maxOccurs="1" name="ErrorNumber">
824 <xs:documentation xml:lang="en-us"> A hexadecimal value for
825 the error message as defined by specifications. </xs:documentation>
826 <xs:documentation xml:lang="en-us"> The minLength of 3 is
827 required to handle the "0x" prefix to the hex number. </xs:documentation>
831 <xs:restriction base="HexNumber">
832 <xs:minLength value="3"/>
836 <xs:element minOccurs="1" maxOccurs="unbounded" name="ErrorMessage">
838 <xs:documentation xml:lang="en-us"> This string should be
839 defined by specifications. There are pre-defined error
840 number ranges in the UEFI/PI specificaiton.
845 <xs:extension base="xs:string">
846 <xs:attribute name="Lang" type="xs:language" default="en-us"
856 <xs:attributeGroup ref="SupportedArchMod"/>
862 <!-- End of PackageSurfaceArea PcdDeclarations element. -->
864 <xs:element minOccurs="0" maxOccurs="1" name="PcdRelationshipChecks">
866 <xs:documentation xml:lang="en-us"> This section is used to describe any PCD interdependencies
867 or relationships. </xs:documentation>
871 <xs:element minOccurs="1" maxOccurs="unbounded" name="PcdCheck" type="xs:normalizedString">
873 <xs:documentation xml:lang="en-us"> This entry must used
874 TokenSpaceGuidCName.PcdCname for every named PCD. Restricted to Relational,
875 Equality and Logical Operators (NOT, AND, OR, GT, GE, EQ, LE, LT and XOR) and
876 parenthesis are valid. Only the TokenSpaceGuidCName.PcdCname us permitted to
877 name PCDs in the expression. All other values must be numeric. </xs:documentation>
878 <xs:documentation xml:lang="en-us"> LValue (op RValue)+ </xs:documentation>
885 <xs:element minOccurs="0" maxOccurs="unbounded" name="MiscellaneousFiles">
887 <xs:documentation xml:lang="en-us"> This section contains files that are not part of the code
888 distributed with this package. </xs:documentation>
892 <xs:element minOccurs="0" maxOccurs="1" name="Copyright" type="xs:string">
894 <xs:documentation xml:lang="en-us"> Only required if different from the Package
895 Copyright. </xs:documentation>
898 <xs:element minOccurs="0" maxOccurs="1" name="License" type="xs:string">
900 <xs:documentation xml:lang="en-us"> Only required if different from the Package
901 License. </xs:documentation>
904 <xs:element minOccurs="0" maxOccurs="1" name="Abstract" type="xs:string">
906 <xs:documentation xml:lang="en-us"> A one line description of this section's
907 content. </xs:documentation>
910 <xs:element minOccurs="0" maxOccurs="unbounded" name="Description" type="xs:string">
912 <xs:documentation xml:lang="en-us"> A complete description of the files in this
913 section. </xs:documentation>
916 <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename">
918 <xs:documentation xml:lang="en-us"> This is the PackagePath relative path and
919 filename location within the ZIP file. </xs:documentation>
923 <xs:extension base="xs:anyURI">
924 <xs:attribute name="Executable" type="xs:boolean" default="false"
927 <xs:documentation xml:lang="en-us"> If true, used by installation
928 tools to ensure that a file that must be executable has the
929 correct properties to permit execution. </xs:documentation>
940 <!-- End of PackageSurfaceArea Misc element. -->
942 <xs:element minOccurs="0" maxOccurs="unbounded" name="UserExtensions">
944 <xs:documentation xml:lang="en-us"> This section is used for any processing instructions that
945 may be custom to the content provided by this package that are common to this package.
948 <xs:complexType mixed="true">
950 <xs:any processContents="lax" minOccurs="0" maxOccurs="1"/>
952 <xs:attribute name="UserId" type="xs:NCName" use="required">
954 <xs:documentation xml:lang="en-us"> This is a single word identifier for grouping
955 similar content that does not fit into previously defined sections or other sections
956 of the Distribution. </xs:documentation>
959 <xs:attribute name="Identifier" type="xs:string" use="required">
961 <xs:documentation xml:lang="en-us"> This can be used to differentiate multiple sections
962 with a grouping. </xs:documentation>
963 <xs:documentation xml:lang="en-us"> For example, a PRE_PROCESS Identifier might indicate
964 specific steps and tools required before processing module content, while a
965 different UserExtensions section with a POST_PROCESS Identifier might describe steps
966 that need to be executed after operations on the modules in this package.
970 <xs:anyAttribute processContents="lax"/>
973 <!-- End of PackageSurfaceArea UserExtensions element. -->
978 <!-- End of the PackageSurfaceArea element. -->
980 <xs:element name="ModuleSurfaceArea">
982 <xs:documentation xml:lang="en-us"> Each module is uniquely identified by it's GUID and Version number.
983 Backward compatible releases of a module need only change the version number, while non-backward
984 compatible changes require the GUID to change (resetting the version number to 1.0 is optional.)
990 <xs:element minOccurs="1" maxOccurs="1" name="Header">
993 <xs:element minOccurs="1" maxOccurs="1" name="Name">
995 <xs:documentation xml:lang="en-us"> This is the User Interface Name for this Module.
1000 <xs:extension base="xs:normalizedString">
1001 <xs:attribute name="BaseName" type="xs:NMTOKEN" use="required">
1003 <xs:documentation xml:lang="en-us"> This is a single word BaseName
1004 that will be used to create a module meta-data file. </xs:documentation>
1005 <xs:documentation xml:lang="en-us"> This name should also be used to
1006 create output file names and directories. </xs:documentation>
1013 <xs:element minOccurs="1" maxOccurs="1" name="GUID">
1015 <xs:documentation xml:lang="en-us"> This GUID and the Version attribute uniquely
1016 identify a given Module. </xs:documentation>
1020 <xs:extension base="RegistryFormatGuid">
1021 <xs:attribute name="Version" type="xs:decimal" use="required">
1023 <xs:documentation xml:lang="en-us"> This value, along with the GUID,
1024 is used to uniquely identify this object. </xs:documentation>
1025 <xs:documentation xml:lang="en-us"> Backward compatible changes must
1026 make sure this number is incremented from the most recent
1027 version. Non-backward compatible changes require a new GUID, and
1028 the version can be reset. </xs:documentation>
1035 <xs:element minOccurs="0" maxOccurs="unbounded" name="Copyright">
1037 <xs:documentation xml:lang="en-us"> This is only required if the Copyright is
1038 different from either the Package or Distribution copyright. Multiple copyright
1039 lines are permitted within this section. </xs:documentation>
1043 <xs:extension base="xs:string">
1044 <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"
1050 <xs:element minOccurs="0" maxOccurs="unbounded" name="License">
1052 <xs:documentation xml:lang="en-us"> This is only required if the license is
1053 different from either the Package or Distribution license. Multiple licenses are
1054 permitted within this section. </xs:documentation>
1058 <xs:extension base="xs:string">
1059 <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"
1065 <xs:element minOccurs="0" maxOccurs="unbounded" name="Abstract">
1067 <xs:documentation xml:lang="en-us"> A brief text description of the module.
1072 <xs:extension base="xs:normalizedString">
1073 <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"
1079 <xs:element minOccurs="0" maxOccurs="unbounded" name="Description">
1081 <xs:documentation xml:lang="en-us"> A complete description of the module contents
1082 and/or features including a description of the updates since the previous module
1083 release. </xs:documentation>
1087 <xs:extension base="xs:string">
1088 <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"
1097 <!-- End of Module Surface Area Header Section -->
1099 <xs:element minOccurs="0" maxOccurs="1" name="ModuleProperties">
1101 <xs:documentation xml:lang="en-us"> List general information about a module, including the
1102 Supported Architectures, this module's type, specifications the module is coded against, and
1103 other informational content. </xs:documentation>
1107 <xs:element minOccurs="1" maxOccurs="1" name="ModuleType" type="ModuleTypes">
1109 <xs:documentation xml:lang="en-us"> One of the Enumerated module types that limit
1110 the use of a module. </xs:documentation>
1113 <xs:element minOccurs="1" maxOccurs="1" name="Path" type="xs:anyURI">
1115 <xs:documentation xml:lang="en-us"> For stand-alone modules that are NOT part of any
1116 package, this is the path to the root of the module as listed in the ZIP file.
1117 For modules included in a package, this is the location, relative to the root of
1118 the package (PackagePath) this module belongs to. </xs:documentation>
1121 <xs:element minOccurs="0" maxOccurs="1" name="PcdIsDriver">
1123 <xs:documentation xml:lang="en-us"> This element is only required for the PEIM that
1124 produces the PCD PPI or the DXE Driver that produces the PCD Protocol.
1128 <xs:restriction base="xs:NCName">
1129 <xs:enumeration value="PEI_PCD_DRIVER"/>
1130 <xs:enumeration value="DXE_PCD_DRIVER"/>
1135 <xs:element minOccurs="0" maxOccurs="1" name="UefiSpecificationVersion" type="xs:decimal"/>
1137 <xs:element minOccurs="0" maxOccurs="1" name="PiSpecificationVersion" type="xs:decimal"/>
1139 <xs:element minOccurs="0" maxOccurs="unbounded" name="Specification">
1141 <xs:documentation xml:lang="en-us"> This is a list of other specifications that this
1142 module is written against. These entries can be used in #define statements
1143 (depending on the build system implementation, they may be autogenerated.)
1148 <xs:extension base="xs:NCName">
1149 <xs:attribute name="Version" type="xs:decimal" use="required"/>
1155 <xs:element minOccurs="0" maxOccurs="unbounded" name="BootMode">
1157 <xs:documentation xml:lang="en-us"> Different firmware execution paths may be taken
1158 based on a given state of the hardware, firmware, or through feature settings. A
1159 BootMode may be declared (PRODUCES) or discovered (CONSUMES) based on these
1160 states and feature settings. If the usage is UNDEFINE, it implies that a Boot
1161 Mode is used, but the package creator does not know how it is used. The
1162 supported boot modes map to the PI specification Boot Modes. The boot modes
1163 listed with Recovery are to indicate that the BootMode is valid during a
1164 recovery boot. </xs:documentation>
1167 <xs:sequence minOccurs="0">
1168 <xs:element minOccurs="1" maxOccurs="1" name="SupportedBootModes">
1172 <xs:restriction base="xs:NCName">
1173 <xs:enumeration value="FULL"/>
1174 <xs:enumeration value="MINIMAL"/>
1175 <xs:enumeration value="NO_CHANGE"/>
1176 <xs:enumeration value="DIAGNOSTICS"/>
1177 <xs:enumeration value="DEFAULT"/>
1178 <xs:enumeration value="S2_RESUME"/>
1179 <xs:enumeration value="S3_RESUME"/>
1180 <xs:enumeration value="S4_RESUME"/>
1181 <xs:enumeration value="S5_RESUME"/>
1182 <xs:enumeration value="FLASH_UPDATE"/>
1183 <xs:enumeration value="RECOVERY_FULL"/>
1184 <xs:enumeration value="RECOVERY_MINIMAL"/>
1185 <xs:enumeration value="RECOVERY_NO_CHANGE"/>
1186 <xs:enumeration value="RECOVERY_DIAGNOSTICS"/>
1187 <xs:enumeration value="RECOVERY_DEFAULT"/>
1188 <xs:enumeration value="RECOVERY_S2_RESUME"/>
1189 <xs:enumeration value="RECOVERY_S3_RESUME"/>
1190 <xs:enumeration value="RECOVERY_S4_RESUME"/>
1191 <xs:enumeration value="RECOVERY_S5_RESUME"/>
1192 <xs:enumeration value="RECOVERY_FLASH_UPDATE"/>
1193 <xs:enumeration value="UNDEFINED"/>
1200 <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>
1202 <xs:attribute name="Usage" use="required">
1204 <xs:restriction base="xs:NCName">
1205 <xs:enumeration value="CONSUMES">
1207 <xs:documentation xml:lang="en-us"> The module always supports
1208 the given boot modes. </xs:documentation>
1211 <xs:enumeration value="SOMETIMES_CONSUMES">
1213 <xs:documentation xml:lang="en-us"> The module may support a
1214 given mode on some execution paths. </xs:documentation>
1217 <xs:enumeration value="PRODUCES">
1219 <xs:documentation xml:lang="en-us"> The module will change the
1220 boot mode. </xs:documentation>
1223 <xs:enumeration value="SOMETIME_PRODUCES">
1225 <xs:documentation xml:lang="en-us"> The module will change the
1226 boot mode on some exection paths. </xs:documentation>
1229 <xs:enumeration value="UNDEFINED">
1231 <xs:documentation xml:lang="en-us"> The package creator does not
1232 know how the boot mode is used. </xs:documentation>
1238 <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>
1239 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
1243 <xs:element minOccurs="0" maxOccurs="unbounded" name="Event" nillable="true">
1245 <xs:documentation xml:lang="en-us"> The functions that make up the Event, Timer, and
1246 Task Priority Services are used during preboot to create, close, signal, and
1247 wait for events; to set timers; and to raise and restore task priority levels as
1248 defined in the UEFI specification. GUIDed events should be listed in the Guids
1249 section. </xs:documentation>
1253 <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>
1255 <xs:attribute name="Usage" use="required">
1257 <xs:restriction base="xs:NCName">
1258 <xs:enumeration value="CONSUMES">
1260 <xs:documentation xml:lang="en-us"> The module will register a
1261 notification function and calls the function when it is
1262 signaled. </xs:documentation>
1265 <xs:enumeration value="SOMETIMES_CONSUMES">
1267 <xs:documentation xml:lang="en-us"> The module will register a
1268 notification function and calls the function when it is
1269 signaled on some execution paths. </xs:documentation>
1272 <xs:enumeration value="PRODUCES">
1274 <xs:documentation xml:lang="en-us"> The module will signal all
1275 events in an event group. </xs:documentation>
1278 <xs:enumeration value="SOMETIMES_PRODUCES">
1280 <xs:documentation xml:lang="en-us"> The module will signal all
1281 events in an event group under some execution paths.
1285 <xs:enumeration value="UNDEFINED">
1287 <xs:documentation xml:lang="en-us"> The package creator does not
1288 know how an event is used. </xs:documentation>
1294 <xs:attribute name="EventType" use="required">
1296 <xs:restriction base="xs:NCName">
1297 <xs:enumeration value="EVENT_TYPE_PERIODIC_TIMER"/>
1298 <xs:enumeration value="EVENT_TYPE_RELATIVE_TIMER"/>
1299 <xs:enumeration value="UNDEFINED"/>
1305 <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>
1306 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
1310 <xs:element minOccurs="0" maxOccurs="unbounded" name="HOB" nillable="false">
1312 <xs:documentation xml:lang="en-us"> This is a list of non-GUIDed Hand Off Blocks
1313 (HOBs) produced or consumed by this module. </xs:documentation>
1317 <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>
1319 <xs:attribute name="HobType" use="required">
1321 <xs:restriction base="xs:NCName">
1322 <xs:enumeration value="PHIT"/>
1323 <xs:enumeration value="MEMORY_ALLOCATION"/>
1324 <xs:enumeration value="RESOURCE_DESCRIPTOR"/>
1325 <xs:enumeration value="FIRMWARE_VOLUME"/>
1326 <xs:enumeration value="LOAD_PEIM"/>
1327 <xs:enumeration value="UNDEFINED"/>
1331 <xs:attribute name="Usage" use="required">
1333 <xs:restriction base="xs:NCName">
1334 <xs:enumeration value="CONSUMES">
1336 <xs:documentation xml:lang="en-us"> A HOB must be present in the
1337 system. </xs:documentation>
1340 <xs:enumeration value="SOMETIMES_CONSUMES">
1342 <xs:documentation xml:lang="en-us"> If present, the HOB will be
1343 used. </xs:documentation>
1346 <xs:enumeration value="PRODUCES">
1348 <xs:documentation xml:lang="en-us"> The HOB is always produced
1349 by the module. </xs:documentation>
1352 <xs:enumeration value="SOMETIMES_PRODUCES">
1354 <xs:documentation xml:lang="en-us"> The HOB may be produced by
1355 the module under some execution paths. </xs:documentation>
1358 <xs:enumeration value="UNDEFINED">
1360 <xs:documentation xml:lang="en-us"> The package creator knows
1361 that a HOB is used, but does not know how it is used.
1368 <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>
1369 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
1374 <xs:attributeGroup ref="SupportedArchMod"/>
1377 <!-- End of ModuleProperties Section -->
1379 <xs:element minOccurs="0" maxOccurs="1" name="ClonedFrom">
1381 <xs:documentation xml:lang="en-us"> This section may be included for Modules that are copied
1382 from a different module. </xs:documentation>
1386 <xs:element minOccurs="1" maxOccurs="1" name="GUID">
1388 <xs:documentation xml:lang="en-us"> This GUID and the Version attribute uniquely
1389 identify the Module that this Module was copied from. </xs:documentation>
1393 <xs:extension base="RegistryFormatGuid">
1394 <xs:attribute name="Version" type="xs:decimal" use="required">
1396 <xs:documentation xml:lang="en-us"> This value, along with the GUID,
1397 is used to uniquely identify this object. </xs:documentation>
1407 <!-- End of ClonedFrom Section. -->
1409 <xs:element minOccurs="0" maxOccurs="1" name="LibraryClassDefinitions">
1411 <xs:documentation xml:lang="en-us"> A list of the different Library Classes consumed by a
1412 driver, core and/or application module, or produced by a Library module. </xs:documentation>
1416 <xs:element minOccurs="1" maxOccurs="unbounded" name="LibraryClass">
1419 <xs:element minOccurs="1" maxOccurs="1" name="Keyword" type="xs:NCName">
1421 <xs:documentation xml:lang="en-us "> Used by tools to identify different
1422 instances of libraries that provide the library class. This keyword
1423 identifies the library class this module needs to be linked against.
1427 <xs:element minOccurs="0" maxOccurs="1" name="RecommendedInstance">
1430 <xs:element minOccurs="1" maxOccurs="1" name="GUID">
1432 <xs:documentation xml:lang="en-us"> This GUID and the
1433 Version attribute uniquely identify the recommended Library
1434 Instance for this module . </xs:documentation>
1438 <xs:extension base="RegistryFormatGuid">
1439 <xs:attribute name="Version" type="xs:decimal"
1442 <xs:documentation xml:lang="en-us"> This value, along with
1443 the GUID, is used to uniquely identify this object.
1454 <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>
1456 <xs:attribute name="Usage" use="required">
1459 <xs:documentation xml:lang="en-us"> Library instances can provide code
1460 for a library class, or may require other library instances
1461 themselves. Since different execution paths in a library (or module)
1462 may need different library classes based on some setting, library
1463 classes may not alway be required. </xs:documentation>
1465 <xs:restriction base="xs:NCName">
1466 <xs:enumeration value="PRODUCES"/>
1467 <xs:enumeration value="CONSUMES"/>
1468 <xs:enumeration value="SOMETIMES_CONSUMES"/>
1469 <xs:enumeration value="UNDEFINED"/>
1474 <xs:attributeGroup ref="SupportedArchMod"/>
1475 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional">
1477 <xs:documentation xml:lang="en-us"> A FeatureFlag attribute must evaluate to
1478 either true or false - it may be a fixed value of true or false, a C
1479 name or an in-fix expression. </xs:documentation>
1487 <!-- End of LibraryClassDefinitions Section -->
1489 <xs:element minOccurs="0" maxOccurs="1" name="SourceFiles">
1492 <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename">
1494 <xs:documentation xml:lang="en-us"> This is the module relative
1495 (ModuleProperties.Path) path and filename location within the ZIP file.
1500 <xs:extension base="xs:anyURI">
1501 <xs:attribute name="Family" type="FamilyTypes" use="optional">
1503 <xs:documentation xml:lang="en-us"> The Family attribute is used to
1504 restrict usage to a given family of compilers, such as GCC or
1505 MSFT. Since not all code processing tools use the same syntax,
1506 especially for assembly, this field can be used to identify
1507 different syntax. </xs:documentation>
1510 <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>
1511 <xs:attribute name="SupModList" type="ModuleListType" use="optional"/>
1512 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
1517 <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>
1521 <!-- End of SourceFiles Section -->
1523 <xs:element minOccurs="0" maxOccurs="1" name="BinaryFiles">
1526 <xs:element minOccurs="1" maxOccurs="unbounded" name="BinaryFile">
1529 <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename">
1531 <xs:documentation xml:lang="en-us"> This is the module relative
1532 (ModuleProperties.Path) path and filename location within the ZIP
1533 file. </xs:documentation>
1537 <xs:extension base="xs:anyURI">
1538 <xs:attribute name="FileType" use="optional">
1540 <xs:restriction base="xs:NCName">
1542 <xs:documentation xml:lang="en-us"> Binary file distribution
1543 is limited to UEFI/PI FFS leaf section file types.
1546 <xs:enumeration value="GUID"/>
1547 <xs:enumeration value="FREEFORM"/>
1548 <xs:enumeration value="UEFI_IMAGE"/>
1549 <xs:enumeration value="PE32">
1551 <xs:documentation xml:lang="en-us"> A UEFI/PI FFS Leaf
1552 section file type, not a raw PE32 file. </xs:documentation>
1555 <xs:enumeration value="PIC"/>
1556 <xs:enumeration value="PEI_DEPEX"/>
1557 <xs:enumeration value="DXE_DEPEX"/>
1558 <xs:enumeration value="SMM_DEPEX"/>
1559 <xs:enumeration value="COMPAT16"/>
1560 <xs:enumeration value="DISPOSABLE"/>
1561 <xs:enumeration value="TE"/>
1562 <xs:enumeration value="VER"/>
1563 <xs:enumeration value="UI"/>
1564 <xs:enumeration value="BIN"/>
1565 <xs:enumeration value="FV"/>
1569 <xs:attribute name="GUID" use="optional"
1570 type="RegistryFormatGuid"/>
1571 <xs:attribute name="SupArchList" type="ArchListType"
1573 <xs:attribute name="SupModList" type="ModuleListType"
1575 <xs:attribute name="FeatureFlag" type="xs:normalizedString"
1581 <xs:element minOccurs="0" maxOccurs="unbounded" name="AsBuilt">
1583 <xs:documentation xml:lang="en-us"> This section contains information
1584 about how the module was coded, such as Compiler Tools, Flags, PCDs
1585 (only PatchPcd and/or PcdEx) and Library Class Instances used to
1586 build the binary. </xs:documentation>
1591 <xs:element minOccurs="0" maxOccurs="unbounded" name="PatchPcdValue">
1593 <xs:documentation xml:lang="en-us"> The element is the
1594 Patchable PCD Value that was used during the build.
1599 <xs:element minOccurs="1" maxOccurs="1"
1600 name="TokenSpaceGuidValue" type="RegistryFormatGuid"/>
1601 <xs:element minOccurs="1" maxOccurs="1" name="PcdCName"
1603 <xs:element minOccurs="1" maxOccurs="1" name="Token">
1605 <xs:documentation xml:lang="en-us"> The minLength of 3 is
1606 required to handle the "0x" prefix to the hex number.
1610 <xs:restriction base="HexNumber">
1611 <xs:minLength value="3"/>
1612 <xs:maxLength value="10"/>
1616 <xs:element minOccurs="1" maxOccurs="1" name="DatumType"
1617 type="PcdDatumTypes"/>
1618 <xs:element minOccurs="0" maxOccurs="1" name="MaxDatumSize">
1620 <xs:documentation xml:lang="en-us"> This field is required
1621 if the Pcd Datum Type is VOID* </xs:documentation>
1622 <xs:documentation xml:lang="en-us"> The minLength of 3 is
1623 required to handle the "0x" prefix to the hex number.
1627 <xs:restriction base="HexNumber">
1628 <xs:minLength value="3"/>
1632 <xs:element minOccurs="1" maxOccurs="1" name="Value"
1633 type="xs:normalizedString"/>
1634 <xs:element minOccurs="1" maxOccurs="1" name="Offset">
1636 <xs:documentation xml:lang="en-us"> The minLength of 3 is
1637 required to handle the "0x" prefix to the hex number.
1641 <xs:restriction base="HexNumber">
1642 <xs:minLength value="3"/>
1646 <xs:element ref="HelpText" minOccurs="0"
1647 maxOccurs="unbounded"/>
1648 <xs:element minOccurs="0" maxOccurs="unbounded"
1651 <xs:documentation xml:lang="en-us"> Error information
1652 implemented by the module. </xs:documentation>
1657 <xs:element minOccurs="0" maxOccurs="1" name="ValidValueList">
1660 <xs:extension base="xs:normalizedString">
1661 <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"/>
1666 <xs:element minOccurs="0" maxOccurs="1" name="ValidValueRange" type="xs:normalizedString"/>
1667 <xs:element minOccurs="0" maxOccurs="1" name="Expression" type="xs:normalizedString"/>
1669 <xs:element minOccurs="1" maxOccurs="1" name="ErrorNumber">
1671 <xs:documentation xml:lang="en-us"> The minLength of 3 is
1672 required to handle the "0x" prefix to the hex number.
1676 <xs:restriction base="HexNumber">
1677 <xs:minLength value="3"/>
1681 <xs:element minOccurs="0" maxOccurs="unbounded"
1682 name="ErrorMessage">
1685 <xs:extension base="xs:string">
1686 <xs:attribute name="Lang" type="xs:language" default="en-us"
1699 <xs:element minOccurs="0" maxOccurs="unbounded" name="PcdExValue">
1701 <xs:documentation xml:lang="en-us"> The element is the
1702 DynamicEx PCD Value that was used during the build.
1707 <xs:element minOccurs="1" maxOccurs="1"
1708 name="TokenSpaceGuidValue" type="RegistryFormatGuid"/>
1709 <xs:element minOccurs="1" maxOccurs="1" name="Token">
1711 <xs:documentation xml:lang="en-us"> The minLength of 3 is
1712 required to handle the "0x" prefix to the hex number.
1716 <xs:restriction base="HexNumber">
1717 <xs:minLength value="3"/>
1718 <xs:maxLength value="10"/>
1722 <xs:element minOccurs="1" maxOccurs="1" name="DatumType"
1723 type="PcdDatumTypes"/>
1724 <xs:element minOccurs="0" maxOccurs="1" name="MaxDatumSize">
1726 <xs:documentation xml:lang="en-us"> This field is required
1727 if the Pcd Datum Type is VOID* </xs:documentation>
1730 <xs:restriction base="HexNumber">
1731 <xs:minLength value="3"/>
1735 <xs:element minOccurs="1" maxOccurs="1" name="Value"
1736 type="xs:normalizedString"/>
1737 <xs:element ref="HelpText" minOccurs="0"
1738 maxOccurs="unbounded"/>
1739 <xs:element minOccurs="0" maxOccurs="unbounded"
1742 <xs:documentation xml:lang="en-us"> Error information
1743 implemented by the module. </xs:documentation>
1748 <xs:element minOccurs="0" maxOccurs="1" name="ValidValueList">
1751 <xs:extension base="xs:normalizedString">
1752 <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"/>
1757 <xs:element minOccurs="0" maxOccurs="1" name="ValidValueRange" type="xs:normalizedString"/>
1758 <xs:element minOccurs="0" maxOccurs="1" name="Expression" type="xs:normalizedString"/>
1760 <xs:element minOccurs="1" maxOccurs="1" name="ErrorNumber">
1762 <xs:documentation xml:lang="en-us"> The minLength of 3 is
1763 required to handle the "0x" prefix to the hex number.
1767 <xs:restriction base="HexNumber">
1768 <xs:minLength value="3"/>
1772 <xs:element minOccurs="0" maxOccurs="unbounded"
1773 name="ErrorMessage">
1776 <xs:extension base="xs:string">
1777 <xs:attribute name="Lang" type="xs:language" default="en-us"
1790 <xs:element minOccurs="0" maxOccurs="1" name="LibraryInstances">
1792 <xs:documentation xml:lang="en-us"> This is the actual
1793 library instance that was used to link against the module.
1798 <xs:element minOccurs="1" maxOccurs="unbounded" name="GUID">
1800 <xs:documentation xml:lang="en-us"> This GUID and the
1801 Version attribute uniquely identify the actual Library
1802 Instance linked in this module. </xs:documentation>
1806 <xs:extension base="RegistryFormatGuid">
1807 <xs:attribute name="Version" type="xs:decimal"
1810 <xs:documentation xml:lang="en-us"> This value, along with
1811 the GUID, is used to uniquely identify this object.
1823 <xs:element minOccurs="0" maxOccurs="unbounded" name="BuildFlags">
1824 <xs:complexType mixed="true">
1827 <xs:documentation xml:lang="en-us"> Any description of OS,
1828 Tool, and flags for the individual tool can go in this
1829 section. </xs:documentation>
1831 <xs:extension base="xs:string">
1832 <xs:anyAttribute processContents="lax"/>
1840 <!-- End of AsBuilt -->
1841 <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>
1849 <!-- End of BinaryFiles Section -->
1851 <xs:element minOccurs="0" maxOccurs="1" name="PackageDependencies">
1854 <xs:element minOccurs="1" maxOccurs="unbounded" name="Package">
1857 <xs:element minOccurs="0" maxOccurs="unbounded" name="Description">
1860 <xs:extension base="xs:string">
1861 <xs:attribute name="Lang" type="xs:language" default="en-us"
1867 <xs:element minOccurs="1" maxOccurs="1" name="GUID">
1869 <xs:documentation xml:lang="en-us"> This GUID and the Version attribute
1870 uniquely identify Package that this Module depends on.
1875 <xs:extension base="RegistryFormatGuid">
1876 <xs:attribute name="Version" type="xs:decimal" use="optional">
1878 <xs:documentation xml:lang="en-us"> This value, along with
1879 the GUID, is used to uniquely identify this object. If the
1880 version attribute is not specified, the most recent version
1881 of the package can be used. </xs:documentation>
1889 <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>
1890 <xs:attribute name="SupModList" type="ModuleListType" use="optional"/>
1891 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
1897 <!-- End of PackageDependencies -->
1899 <xs:element minOccurs="0" maxOccurs="1" name="Guids">
1902 <xs:element minOccurs="1" maxOccurs="unbounded" name="GuidCName">
1905 <xs:element minOccurs="1" maxOccurs="1" name="CName" type="xs:NCName"/>
1906 <xs:element minOccurs="0" maxOccurs="1" name="GUID" type="RegistryFormatGuid"/>
1907 <xs:element minOccurs="0" maxOccurs="1" name="VariableName"
1908 type="xs:normalizedString">
1910 <xs:documentation xml:lang="en-us"> Only valid for Variable GUID types. </xs:documentation>
1911 <xs:documentation> This can be either a Hex Array or C string in unicode
1912 format: L"string" Data. </xs:documentation>
1915 <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>
1917 <xs:attribute name="Usage" use="required">
1919 <xs:restriction base="xs:NCName">
1920 <xs:enumeration value="CONSUMES">
1922 <xs:documentation xml:lang="en-us">The module does not install
1923 the GUID, and the GUID must be present for the module to
1924 execute. </xs:documentation>
1927 <xs:enumeration value="SOMETIMES_CONSUMES">
1929 <xs:documentation xml:lang="en-us"> The module does not install
1930 the GUID, however, the GUID will be used if it is present.
1934 <xs:enumeration value="PRODUCES">
1936 <xs:documentation xml:lang="en-us"> The module always installs
1937 the GUID. </xs:documentation>
1940 <xs:enumeration value="SOMETIMES_PRODUCES">
1942 <xs:documentation xml:lang="en-us"> The Module will install the
1943 GUID under certain execution paths. </xs:documentation>
1946 <xs:enumeration value="UNDEFINED">
1948 <xs:documentation xml:lang="en-us"> The package creator knows
1949 that a GUID is used, but does not know how it is used.
1956 <xs:attribute name="GuidType" type="GuidListType" use="required"/>
1957 <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>
1958 <xs:attribute name="SupModList" type="ModuleListType" use="optional"/>
1959 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
1965 <!-- End of Guids Section -->
1967 <xs:element minOccurs="0" maxOccurs="1" name="Protocols">
1969 <xs:documentation xml:lang="en-us"> A listing of protocols required or produced by this module.
1974 <xs:element minOccurs="1" maxOccurs="unbounded" name="Protocol" nillable="true">
1977 <xs:element minOccurs="1" maxOccurs="1" name="CName" type="xs:NCName"/>
1978 <xs:element minOccurs="0" maxOccurs="1" name="GUID" type="RegistryFormatGuid"/>
1979 <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>
1981 <xs:attribute name="Usage" use="required">
1983 <xs:restriction base="xs:NCName">
1984 <xs:enumeration value="PRODUCES"/>
1985 <xs:enumeration value="SOMETIMES_PRODUCES"/>
1986 <xs:enumeration value="CONSUMES"/>
1987 <xs:enumeration value="SOMETIMES_CONSUMES"/>
1988 <xs:enumeration value="TO_START"/>
1989 <xs:enumeration value="BY_START"/>
1990 <xs:enumeration value="UNDEFINED"/>
1994 <xs:attribute name="Notify" type="xs:boolean" use="optional"/>
1995 <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>
1996 <xs:attribute name="SupModList" type="ModuleListType" use="optional"/>
1997 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
2003 <!-- End of Protocols Section -->
2005 <xs:element minOccurs="0" maxOccurs="1" name="PPIs">
2007 <xs:documentation xml:lang="en-us"> A listing of PPIs required or produced by this module.
2012 <xs:element minOccurs="1" maxOccurs="unbounded" name="Ppi" nillable="true">
2015 <xs:element minOccurs="1" maxOccurs="1" name="CName" type="xs:NCName"/>
2016 <xs:element minOccurs="0" maxOccurs="1" name="GUID" type="RegistryFormatGuid"/>
2017 <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>
2019 <xs:attribute name="Usage" use="required">
2021 <xs:restriction base="xs:NCName">
2022 <xs:enumeration value="PRODUCES"/>
2023 <xs:enumeration value="SOMETIMES_PRODUCES"/>
2024 <xs:enumeration value="CONSUMES"/>
2025 <xs:enumeration value="SOMETIMES_CONSUMES"/>
2026 <xs:enumeration value="UNDEFINED"/>
2030 <xs:attribute name="Notify" type="xs:boolean" use="optional"/>
2031 <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>
2032 <xs:attribute name="SupModList" type="ModuleListType" use="optional"/>
2033 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
2039 <!-- End of PPIs Section -->
2041 <xs:element minOccurs="0" maxOccurs="1" name="Externs">
2043 <xs:documentation xml:lang="en-us"> These elements specify additional information about the
2044 module. This area may be used by tools to generate code. </xs:documentation>
2048 <xs:element minOccurs="1" maxOccurs="unbounded" name="Extern">
2051 <xs:choice minOccurs="1">
2053 <xs:element minOccurs="0" maxOccurs="1" name="EntryPoint"
2055 <xs:element minOccurs="0" maxOccurs="1" name="UnloadImage"
2059 <xs:element minOccurs="0" maxOccurs="1" name="Constructor"
2061 <xs:element minOccurs="0" maxOccurs="1" name="Destructor"
2065 <xs:element ref="HelpText" minOccurs="0" maxOccurs="1"/>
2067 <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>
2068 <xs:attribute name="SupModList" type="ModuleListType" use="optional"/>
2069 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
2075 <!-- End of Externs Section -->
2077 <xs:element minOccurs="0" maxOccurs="1" name="PcdCoded">
2079 <xs:documentation xml:lang="en-us"> This section describes how a platform is coded with respect
2080 to the platform configuration knobs. </xs:documentation>
2084 <xs:element minOccurs="1" maxOccurs="unbounded" name="PcdEntry">
2087 <xs:element minOccurs="1" maxOccurs="1" name="CName" type="xs:NCName"/>
2088 <xs:element minOccurs="1" maxOccurs="1" name="TokenSpaceGuidCName"
2090 <xs:element minOccurs="0" maxOccurs="1" name="DefaultValue"
2091 type="xs:normalizedString"/>
2092 <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>
2094 <xs:attribute name="PcdItemType" type="PcdItemTypes" use="required"/>
2095 <xs:attribute name="PcdUsage" use="required">
2097 <xs:restriction base="xs:NCName">
2098 <xs:enumeration value="PRODUCES"/>
2099 <xs:enumeration value="SOMETIMES_PRODUCES"/>
2100 <xs:enumeration value="CONSUMES"/>
2101 <xs:enumeration value="SOMETIMES_CONSUMES"/>
2102 <xs:enumeration value="UNDEFINED"/>
2108 <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>
2109 <xs:attribute name="SupModList" type="ModuleListType" use="optional"/>
2110 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
2116 <!-- End of PcdCoded Section -->
2118 <xs:element minOccurs="0" maxOccurs="unbounded" name="PeiDepex">
2120 <xs:documentation xml:lang="en-us"> This is the PEI dependency expression for a Dependency
2121 Section. </xs:documentation>
2125 <xs:element name="Expression" type="xs:string" minOccurs="1" maxOccurs="1">
2127 <xs:documentation xml:lang="en-us"> An in-fix expression, of C identifiers and TRUE,
2128 FALSE, AND, OR, NOT, BEFORE, and AFTER as well as parenthesis () in the in-fix
2129 notation. The operators are restricted to grammar defined in the PI
2130 specification. </xs:documentation>
2133 <xs:element ref="HelpText" minOccurs="0" maxOccurs="1"/>
2135 <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>
2136 <xs:attribute name="SupModList" type="ModuleListType" use="optional"/>
2137 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
2140 <!-- End of PeiDepex Section -->
2142 <xs:element minOccurs="0" maxOccurs="unbounded" name="DxeDepex">
2144 <xs:documentation xml:lang="en-us"> This is the DXE dependency expression for a Dependency
2145 Section. </xs:documentation>
2149 <xs:element name="Expression" type=" xs:string " minOccurs="1" maxOccurs="1">
2151 <xs:documentation xml:lang="en-us"> An in-fix expression, of C identifiers and TRUE,
2152 FALSE, AND, OR, NOT, BEFORE, and AFTER as well as parenthesis () in the in-fix
2153 notation. The operators are restricted to grammar defined in the PI
2154 specification. </xs:documentation>
2157 <xs:element ref="HelpText" minOccurs="0" maxOccurs="1"/>
2159 <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>
2160 <xs:attribute name="SupModList" type="ModuleListType" use="optional"/>
2161 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
2164 <!-- End of DxeDepex Section -->
2166 <xs:element minOccurs="0" maxOccurs="unbounded" name="SmmDepex">
2168 <xs:documentation xml:lang="en-us"> This is the SMM dependency expression for a Dependency
2169 Section. </xs:documentation>
2173 <xs:element name="Expression" type=" xs:string " minOccurs="1" maxOccurs="1">
2175 <xs:documentation xml:lang="en-us"> An in-fix expression, of C identifiers and TRUE,
2176 FALSE, AND, OR, NOT, BEFORE, and AFTER as well as parenthesis () in the in-fix
2177 notation. The operators are restricted to grammar defined in the PI
2178 specification. </xs:documentation>
2181 <xs:element ref="HelpText" minOccurs="0" maxOccurs="1"/>
2183 <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>
2184 <xs:attribute name="SupModList" type="ModuleListType" use="optional"/>
2185 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
2188 <!-- End of SmmDepex Section -->
2191 <xs:element minOccurs="0" maxOccurs="1" name="MiscellaneousFiles">
2193 <xs:documentation xml:lang="en-us"> This section is used to provide comments and/or list
2194 auxiliary files, such as pdb or map files. </xs:documentation>
2198 <xs:element minOccurs="0" maxOccurs="unbounded" name="Description">
2201 <xs:extension base="xs:string">
2202 <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"
2208 <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename">
2210 <xs:documentation xml:lang="en-us"> This is the path and filename location within
2211 the ZIP file. </xs:documentation>
2215 <xs:extension base="xs:anyURI">
2216 <xs:attribute name="Executable" type="xs:boolean" default="false"
2219 <xs:documentation xml:lang="en-us"> If true, used by installation
2220 tools to ensure that a file that must be executable has the
2221 correct properties to permit execution. </xs:documentation>
2231 <!-- End of Module Surface Area Misc Section -->
2233 <xs:element minOccurs="0" maxOccurs="unbounded" name="UserExtensions">
2235 <xs:documentation xml:lang="en-us"> This section is used for any processing instructions that
2236 may be custom to the content provided by the distribution that are common to module. </xs:documentation>
2237 <xs:documentation xml:lang="en-us"> The content is vendor specific. </xs:documentation>
2238 <xs:documentation xml:lang="en-us"> The content can be plain text as well as any user-defined,
2239 properly formatted XML structure. </xs:documentation>
2241 <xs:complexType mixed="true">
2242 <xs:attribute name="UserId" type="xs:NCName" use="required">
2244 <xs:documentation xml:lang="en-us"> This is a single word identifier for grouping
2245 similar content. For example, ReferenceBuild might be used to identify non-PI
2246 compliant build steps, with two different UserExtensions sections, one with an
2247 Identifier of Prebuild, and another of PostBuild. Both UserExtensions sections would
2248 use the same UserId. </xs:documentation>
2251 <xs:attribute name="Identifier" type="xs:string" use="required">
2253 <xs:documentation xml:lang="en-us"> This can be any string used to differentiate or
2254 identify this section from other UserExtensions sections. </xs:documentation>
2255 <xs:documentation xml:lang="en-us"> For example, a PRE_PROCESS Identifier might indicate
2256 specific steps and tools required before processing module content, while a
2257 different UserExtensions section with a POST_PROCESS Identifier might describe steps
2258 that need to be executed after operations on this module. </xs:documentation>
2261 <xs:anyAttribute processContents="lax"/>
2264 <!-- End of Module Surface Area UserExtensions Section -->
2267 <xs:attribute name="BinaryModule" type="xs:boolean" default="false" use="optional">
2269 <xs:documentation xml:lang="en-us"> This attribute is used when the binaries are distributed for
2270 this module and no code generation from source files is required. If set, then the BinaryFiles
2271 section should be used, and any files listed in the SourceFiles section do not have to be built.
2272 Additionally, the AsBuilt section for each binary file must be included. </xs:documentation>
2278 <!-- End of the ModuleSurfaceArea element. -->
2280 <xs:element name="Tools">
2283 <xs:element minOccurs="0" maxOccurs="1" name="Header">
2286 <xs:element minOccurs="1" maxOccurs="1" name="Name" type="xs:normalizedString">
2288 <xs:documentation xml:lang="en-us">This is the User Interface Name for this Tools
2289 Distribution.</xs:documentation>
2292 <xs:element minOccurs="0" maxOccurs="1" name="Copyright" type="xs:string">
2294 <xs:documentation xml:lang="en-us"> This is only required if the Copyright is
2295 different from the Distribution Package copyright. </xs:documentation>
2298 <xs:element minOccurs="0" maxOccurs="1" name="License" type="xs:string">
2300 <xs:documentation xml:lang="en-us"> This is only required if the License is
2301 different from the Distribution Package license. </xs:documentation>
2304 <xs:element minOccurs="0" maxOccurs="1" name="Abstract">
2306 <xs:documentation xml:lang="en-us"> This is only required if the Abstract is
2307 different from the Distribution Package Abstract. </xs:documentation>
2311 <xs:extension base="xs:normalizedString">
2312 <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"/>
2317 <xs:element minOccurs="0" maxOccurs="1" name="Description">
2319 <xs:documentation xml:lang="en-us"> This is only required if the Description is
2320 different from the Distribution Package Description. </xs:documentation>
2324 <xs:extension base="xs:string">
2325 <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"/>
2334 <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename">
2336 <xs:documentation xml:lang="en-us"> This is the path and filename location within the ZIP file.
2341 <xs:extension base="xs:anyURI">
2342 <xs:attribute name="OS" type="SupportedOs" use="optional">
2344 <xs:documentation xml:lang="en-us"> This is required for tools that execute; it
2345 should not be used for configuration files. </xs:documentation>
2348 <xs:attribute name="Executable" type="xs:boolean" default="false" use="optional">
2350 <xs:documentation xml:lang="en-us"> If true, used by installation tools to
2351 ensure that a file that must be executable has the correct properties to
2352 permit execution. </xs:documentation>
2362 <!-- End of the Tools element. -->
2364 <xs:element name="MiscellaneousFiles">
2366 <xs:documentation xml:lang="en-us"> This section contains a list of files that are not part of the code
2367 distributed with modules, packages or tools. </xs:documentation>
2371 <xs:element minOccurs="0" maxOccurs="1" name="Header">
2374 <xs:element minOccurs="0" maxOccurs="1" name="Name" type="xs:normalizedString">
2376 <xs:documentation xml:lang="en-us"> The User interface name for this content.
2380 <xs:element minOccurs="0" maxOccurs="1" name="Copyright" type="xs:string">
2382 <xs:documentation xml:lang="en-us"> This is only required if the Copyright is
2383 different from the Distribution Package Copyright. </xs:documentation>
2386 <xs:element minOccurs="0" maxOccurs="1" name="License" type="xs:string">
2388 <xs:documentation xml:lang="en-us"> This is only required if the License is
2389 different from the Distribution Package License. </xs:documentation>
2392 <xs:element minOccurs="0" maxOccurs="1" name="Abstract" type="xs:normalizedString"/>
2393 <xs:element minOccurs="0" maxOccurs="unbounded" name="Description">
2396 <xs:extension base="xs:string">
2397 <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"
2406 <xs:element minOccurs="0" maxOccurs="unbounded" name="Filename">
2408 <xs:documentation xml:lang="en-us"> This is the path and filename location within the ZIP file.
2413 <xs:extension base="xs:anyURI">
2414 <xs:attribute name="Executable" type="xs:boolean" default="false" use="optional">
2416 <xs:documentation xml:lang="en-us"> If true, used by installation tools to
2417 ensure that a file that must be executable has the correct properties to
2418 permit execution. </xs:documentation>
2428 <!-- End of the Misc element. -->
2430 <xs:element name="UserExtensions">
2431 <xs:complexType mixed="true">
2433 <xs:any processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
2435 <xs:attribute name="UserId" type="xs:NCName" use="required">
2437 <xs:documentation xml:lang="en-us"> This is a single word identifier for grouping similar content.
2438 For example, ReferenceBuild might be used to identify non-PI compliant build steps, with two
2439 different UserExtensions sections, one with an Identifier of Prebuild, and another of PostBuild.
2440 Both UserExtensions sections would use the same UserId. </xs:documentation>
2443 <xs:attribute name="Identifier" type="xs:string" use="optional">
2445 <xs:documentation xml:lang="en-us"> This can be any string used to differentiate or identify this
2446 section from other UserExtensions sections. </xs:documentation>
2447 <xs:documentation xml:lang="en-us"> For example, a PRE_PROCESS Identifier might indicate specific
2448 steps and tools required before processing distribution package content, while a different
2449 UserExtensions section with a POST_PROCESS Identifier might describe steps that need to be
2450 executed after operations on this content. </xs:documentation>
2453 <xs:anyAttribute processContents="lax"/>
2456 <!-- The following elsements are common definitions used with the ref attribute for elements. -->
2458 <xs:element name="HelpText">
2461 <xs:extension base="xs:string">
2462 <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"/>
2468 <!-- The following attribute groups are used in various elements above. -->
2470 <xs:attributeGroup name="SupportedArchMod">
2471 <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>
2472 <xs:attribute name="SupModList" type="ModuleListType" use="optional"/>
2473 </xs:attributeGroup>
2475 <!-- The following data types are used to restrict content. -->
2477 <xs:simpleType name="ArchListType">
2478 <xs:list itemType="ArchTypes"/>
2481 <xs:simpleType name="ArchTypes">
2482 <xs:restriction base="xs:NCName">
2483 <xs:enumeration value="IA32"/>
2484 <xs:enumeration value="X64"/>
2485 <xs:enumeration value="IPF"/>
2486 <xs:enumeration value="EBC"/>
2487 <xs:enumeration value="ARM"/>
2488 <xs:pattern value="([A-Z])([a-zA-Z0-9])*">
2490 <xs:documentation xml:lang="en-us"> Any processor architecture not listed above. The Architecture
2491 must be a target architecture of one or more compiler tool chains. </xs:documentation>
2498 <xs:simpleType name="FamilyTypes">
2499 <xs:restriction base="xs:NCName">
2500 <xs:enumeration value="MSFT"/>
2501 <xs:enumeration value="GCC"/>
2502 <xs:pattern value="[A-Z][a-zA-Z0-9]*">
2504 <xs:documentation xml:lang="en-us"> Any other family of build utilities for which compiler tools
2505 exist. </xs:documentation>
2511 <xs:simpleType name="GuidListType">
2512 <xs:list itemType="GuidTypes"/>
2515 <xs:simpleType name="GuidTypes">
2516 <xs:restriction base="xs:NCName">
2517 <xs:enumeration value="Event"/>
2518 <xs:enumeration value="File"/>
2519 <xs:enumeration value="FV"/>
2520 <xs:enumeration value="GUID"/>
2521 <xs:enumeration value="HII"/>
2522 <xs:enumeration value="Hii"/>
2523 <xs:enumeration value="HOB"/>
2524 <xs:enumeration value="SystemTable"/>
2525 <xs:enumeration value="TokenSpaceGuid"/>
2526 <xs:enumeration value="Variable"/>
2527 <xs:enumeration value="UNDEFINED"/>
2531 <xs:simpleType name="HexNumber">
2532 <xs:restriction base="xs:hexBinary">
2533 <xs:pattern value="0x([a-fA-F0-9])+"/>
2537 <xs:simpleType name="Md5Sum">
2538 <xs:restriction base="xs:normalizedString">
2539 <xs:pattern value="[a-zA-Z0-9]{32}"/>
2543 <xs:simpleType name="ModuleListType">
2544 <xs:list itemType="ModuleTypes"/>
2547 <xs:simpleType name="ModuleTypes">
2549 <xs:documentation xml:lang="en-us"> The following module types are defined by specifications. </xs:documentation>
2550 <xs:documentation xml:lang="en-us"> Module types for components and libraries defined for this distribution
2551 mechanism. </xs:documentation>
2553 <xs:restriction base="xs:NCName">
2554 <xs:enumeration value="BASE ">
2556 <xs:documentation xml:lang="en-us"> Use of this module is not restricted. </xs:documentation>
2559 <xs:enumeration value="DXE_CORE">
2561 <xs:documentation xml:lang="en-us"> This module is only applicable to the DXE core.
2565 <xs:enumeration value="DXE_DRIVER">
2567 <xs:documentation xml:lang="en-us"> This module is only applicable to a DXE driver.
2571 <xs:enumeration value="DXE_RUNTIME_DRIVER">
2573 <xs:documentation xml:lang="en-us"> This module is only applicable to a DXE runtime driver.
2577 <xs:enumeration value="DXE_SAL_DRIVER">
2579 <xs:documentation xml:lang="en-us"> This module is only applicable to an IPF DXE runtime driver.
2583 <xs:enumeration value="DXE_SMM_DRIVER">
2585 <xs:documentation xml:lang="en-us"> This module is only applicable to a DXE SMM driver.
2589 <xs:enumeration value="PEI_CORE">
2591 <xs:documentation xml:lang="en-us"> This module is only applicable to the PEI core.
2595 <xs:enumeration value="PEIM">
2597 <xs:documentation xml:lang="en-us"> This module is only valid for PEI modules. </xs:documentation>
2600 <xs:enumeration value="SEC">
2602 <xs:documentation xml:lang="en-us"> This module is only applicable to Security phase.
2606 <xs:enumeration value="UEFI_DRIVER">
2608 <xs:documentation xml:lang="en-us"> This module is only valid for UEFI drivers. </xs:documentation>
2611 <xs:enumeration value="UEFI_RUNTIME_DRIVER">
2613 <xs:documentation xml:lang="en-us"> This module is only valid for UEFI runtime
2614 drivers.</xs:documentation>
2617 <xs:enumeration value="UEFI_APPLICATION">
2619 <xs:documentation xml:lang="en-us"> This module is only valid for UEFI applications.
2623 <xs:enumeration value="SMM_CORE">
2625 <xs:documentation xml:lang="en-us"> This module is only applicable to the SMM
2626 core.</xs:documentation>
2629 <xs:enumeration value="USER_DEFINED">
2631 <xs:documentation xml:lang="en-us"> This content is restricted to a specific implementation.
2635 <xs:enumeration value="UNDEFINED">
2637 <xs:documentation xml:lang="en-us"> This enumeration is for use in a list that where the package
2638 creator does not know the what module types are supported by a module. </xs:documentation>
2641 <xs:pattern value="([A-Z])([a-zA-Z0-9])*">
2643 <xs:documentation xml:lang="en-us"> This pattern has been added for use in a module lists - for
2644 future expansion. </xs:documentation>
2650 <xs:simpleType name="PcdDatumTypes">
2652 <xs:documentation xml:lang="en-us"> The following data types are defined by the PCD specification (or PCD
2653 section of the UEFI/PI specifications.) </xs:documentation>
2655 <xs:restriction base="xs:normalizedString">
2656 <xs:enumeration value="UINT8"/>
2657 <xs:enumeration value="UINT16"/>
2658 <xs:enumeration value="UINT32"/>
2659 <xs:enumeration value="UINT64"/>
2660 <xs:enumeration value="BOOLEAN"/>
2661 <xs:enumeration value="VOID*"/>
2665 <xs:simpleType name="PcdItemListType">
2666 <xs:list itemType="PcdItemTypes"/>
2669 <xs:simpleType name="PcdItemTypes">
2670 <xs:restriction base="xs:NCName">
2671 <xs:enumeration value="FeaturePcd">
2673 <xs:documentation xml:lang="en-us"> The Feature PCD is a binary, evaluating to either true or false.
2674 This is used during build to include/exclude content. It can also be used during execution to
2675 force execution paths within drivers, or to enable/disable features within a driver for a given
2676 platform. </xs:documentation>
2679 <xs:enumeration value="FixedPcd">
2681 <xs:documentation xml:lang="en-us"> The Fixed PCD is a #define value that is set at build time.
2685 <xs:enumeration value="PatchPcd">
2687 <xs:documentation xml:lang="en-us"> The Patch PCD is a #define that is set at build time, and that
2688 can be modified within a binary file. Additional information, such as the offset location of the
2689 value, along with it's length may need to be provided.</xs:documentation>
2692 <xs:enumeration value="Pcd">
2694 <xs:documentation xml:lang="en-us"> This PCD type has an overloaded definition. Prior to build, the
2695 platform integrator may choose to implement a PCD as Fixed, Patchable or a Dynamic PCD. If the
2696 platform integrator choose to use the PCD as dynamic, then a PCD driver is required in the
2697 platform (PEI/DXE/both) to track the PCD in some sort of 'database' of these items. For Dynamic
2698 PCDs, the PcdGet* must pass in the token space guid and the token number to retrieve data
2699 (PcdSet* also needs these values.) </xs:documentation>
2702 <xs:enumeration value="PcdEx">
2704 <xs:documentation xml:lang="en-us"> The PCD can only be used as Dynamic, and the platform firmware
2705 must contain a driver to maintain a 'database' of these items. For Dynamic PCDs, the PcdGet*
2706 must pass in the token space guid and the token number to retrieve data (PcdSet* also needs
2707 these values.) </xs:documentation>
2713 <xs:simpleType name="RegistryFormatGuid">
2715 <xs:documentation xml:lang="en-us"> A GUID must contain five different Hexadecimal character sets that are
2716 separated by a dash (-) character. </xs:documentation>
2718 <xs:restriction base="xs:string">
2719 <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*"/>
2723 <xs:simpleType name="SupportedOs">
2725 <xs:documentation xml:lang="en-us"> The EDK II build system supports workstations running one of the
2726 following supported operating systems. This is the OS for the developer's workstation, not the target
2727 platform. </xs:documentation>
2729 <xs:restriction base="xs:string">
2730 <xs:enumeration value="Win32">
2732 <xs:documentation xml:lang="en-us"> For Windows 2003, Windows XP and Windows Vista.
2736 <xs:enumeration value="Win64">
2738 <xs:documentation xml:lang="en-us"> For Windows 2003, Windows XP and Windows Vista.
2742 <xs:enumeration value="RedHat32"/>
2743 <xs:enumeration value="RedHat64"/>
2744 <xs:enumeration value="SuSE32"/>
2745 <xs:enumeration value="SuSE64"/>
2746 <xs:enumeration value="Linux32"/>
2747 <xs:enumeration value="Linux64"/>
2748 <xs:enumeration value="OS/X32"/>
2749 <xs:enumeration value="OS/X64"/>
2750 <xs:enumeration value="Generic"/>
2751 <xs:enumeration value="GenericWin">
2753 <xs:documentation xml:lang="en-us"> Typically, this is used for Windows Batch files.
2757 <xs:enumeration value="GenericNix">
2759 <xs:documentation xml:lang="en-us"> Typically use for shell scripts - valid for any Linux and Mac
2760 OS/X. </xs:documentation>
2763 <xs:pattern value="[a-zA-Z]([a-zA-Z0-9])*"/>
projects / mirror_edk2.git / blob