1 <?xml version="1.0" encoding="UTF-8"?>
2 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" xmlns="http://www.TianoCore.org/2007/Edk2.1" targetNamespace="http://www.TianoCore.org/2007/Edk2.1">
4 Filename: FrameworkDataElements.xsd
6 Copyright (c) 2007, Intel Corp.
7 All rights reserved. This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which may be found at http://opensource.org/licenses/bsd-license.php
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.
16 <xs:documentation xml:lang="en"> This schema defines EFI and Framework Data Elements </xs:documentation>
18 <xs:include schemaLocation="NamingConvention.xsd"/>
19 <xs:include schemaLocation="FrameworkDataTypes.xsd"/>
20 <xs:include schemaLocation="FrameworkDataAttributes.xsd"/>
21 <xs:element name="Abstract" type="Sentence">
23 <xs:documentation xml:lang="en">Abstract is valid for all Description Files</xs:documentation>
24 <xs:documentation xml:lang="en">This section is required. This is a single sentence to describe the module and will be used in sample files as the abstract data in the header comment section.</xs:documentation>
27 <xs:element name="BootModes">
29 <xs:documentation xml:lang="en">BootModes is valid for all Description Files</xs:documentation>
30 <xs:documentation xml:lang="en">This is a list of BootModes Supported by the Module</xs:documentation>
34 <xs:element minOccurs="1" maxOccurs="unbounded" name="BootMode">
36 <xs:sequence minOccurs="0">
37 <xs:element name="HelpText" type="Paragraph"/>
39 <xs:attributeGroup ref="BootModeAttributes"/>
45 <xs:element name="Copyright" type="Paragraph"/>
46 <xs:element name="DataHubs">
48 <xs:documentation xml:lang="en">This is a list of DataHubRecord elements.</xs:documentation>
52 <xs:element minOccurs="1" maxOccurs="unbounded" name="DataHubRecord">
55 <xs:element minOccurs="1" maxOccurs="1" name="DataHubCName" type="C_NameType"/>
56 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
58 <xs:attributeGroup ref="DataHubAttributes"/>
64 <xs:element name="DefaultValue">
66 <xs:documentation xml:lang="en">The default setting of a PCD entry.</xs:documentation>
70 <xs:extension base="xs:normalizedString"/>
74 <xs:element name="Depex">
76 <xs:documentation xml:lang="en">This section is used to describe the DXE or PEI Dependency code</xs:documentation>
80 <xs:element minOccurs="0" maxOccurs="unbounded" name="Define" type="xs:normalizedString"/>
81 <xs:element minOccurs="0" maxOccurs="unbounded" name="Expression" type="xs:string"/>
85 <xs:element name="Description" type="Paragraph">
87 <xs:documentation xml:lang="en">This section is required for new modules and libraries and must contain more information than the Abstract.</xs:documentation>
90 <xs:element name="BinaryFiles">
92 <xs:documentation xml:lang="en">Multiple Filenames may be specified, and they may also be scoped to a specific Architecture.</xs:documentation>
96 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
97 <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename">
100 <xs:extension base="PathAndFilename">
101 <xs:attributeGroup ref="BinaryFileAttributes"/>
109 <xs:element name="Events">
111 <xs:documentation xml:lang="en">This is a list of MSA Events</xs:documentation>
115 <xs:element minOccurs="0" maxOccurs="1" name="CreateEvents">
118 <xs:element minOccurs="1" maxOccurs="unbounded" name="EventTypes">
121 <xs:element minOccurs="1" maxOccurs="1" name="EventType" type="EventTypes"/>
122 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
124 <xs:attributeGroup ref="EventAttributes"/>
130 <xs:element minOccurs="0" maxOccurs="1" name="SignalEvents">
132 <xs:documentation xml:lang="en">Module has an event that is waiting to be signaled. Event is named by GUID.</xs:documentation>
136 <xs:element minOccurs="1" maxOccurs="unbounded" name="EventTypes">
139 <xs:element minOccurs="1" maxOccurs="1" name="EventType" type="EventTypes"/>
140 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
142 <xs:attributeGroup ref="EventAttributes"/>
151 <xs:element name="Externs">
153 <xs:documentation xml:lang="en">This is a child of MSA files.</xs:documentation>
156 <xs:sequence minOccurs="1">
157 <xs:element minOccurs="0" maxOccurs="1" name="PcdIsDriver" type="PcdDriverTypes"/>
158 <xs:element minOccurs="0" maxOccurs="1" name="TianoR8FlashMap_h" type="xs:boolean" default="false"/>
159 <xs:element minOccurs="0" maxOccurs="unbounded" name="Specification" type="Sentence"/>
160 <xs:element minOccurs="0" maxOccurs="unbounded" name="Extern">
162 <xs:choice minOccurs="1" maxOccurs="1">
163 <xs:sequence minOccurs="0" maxOccurs="1">
165 <xs:documentation xml:lang="en">Driver Module</xs:documentation>
167 <xs:element minOccurs="0" maxOccurs="1" name="ModuleEntryPoint" type="C_NameType"/>
168 <xs:element minOccurs="0" maxOccurs="1" name="ModuleUnloadImage" type="C_NameType"/>
170 <xs:sequence minOccurs="0" maxOccurs="1">
172 <xs:documentation xml:lang="en">Library Module</xs:documentation>
174 <xs:element minOccurs="0" maxOccurs="1" name="Constructor" type="C_NameType"/>
175 <xs:element minOccurs="0" maxOccurs="1" name="Destructor" type="C_NameType"/>
177 <xs:sequence minOccurs="0" maxOccurs="1">
179 <xs:documentation xml:lang="en">Allow multiple entries for DriverBinding, ComponentName, DriverConfig and DriverDiag elements. For ComponentName, DriverConfig and/or DriverDiag - you must have a 1:1 mapping to DriverBinding if the element is defined.</xs:documentation>
180 <xs:documentation xml:lang="en">Permit User Defined Extern Tags</xs:documentation>
182 <xs:element minOccurs="1" maxOccurs="1" name="DriverBinding" type="C_NameType"/>
183 <xs:element minOccurs="0" maxOccurs="1" name="ComponentName" type="C_NameType"/>
184 <xs:element minOccurs="0" maxOccurs="1" name="DriverConfig" type="C_NameType"/>
185 <xs:element minOccurs="0" maxOccurs="1" name="DriverDiag" type="C_NameType"/>
187 <xs:sequence minOccurs="0" maxOccurs="1">
189 <xs:documentation xml:lang="en"> Module Call Backs</xs:documentation>
191 <xs:element minOccurs="0" maxOccurs="1" name="SetVirtualAddressMapCallBack" type="C_NameType"/>
192 <xs:element minOccurs="0" maxOccurs="1" name="ExitBootServicesCallBack" type="C_NameType"/>
195 <xs:attributeGroup ref="ExternAttributes"/>
201 <xs:element name="Filename">
203 <xs:documentation xml:lang="en">Describe the valid content of a filename This should extend PathAndFilename - Variable names not allowed here!</xs:documentation>
207 <xs:extension base="PathAndFilename">
208 <xs:attributeGroup ref="FilenameAttributes"/>
213 <xs:element name="Filenames">
215 <xs:documentation xml:lang="en">This is a list of Filenames</xs:documentation>
218 <xs:sequence minOccurs="1">
219 <xs:element minOccurs="0" maxOccurs="unbounded" ref="Filename"/>
223 <xs:element name="GuidDeclarations">
225 <xs:documentation xml:lang="en">This is a child of PackageSurfaceArea (SPD) </xs:documentation>
229 <xs:element minOccurs="1" maxOccurs="unbounded" name="Entry">
232 <xs:element minOccurs="1" maxOccurs="1" name="C_Name" type="C_NameType"/>
233 <xs:element minOccurs="1" maxOccurs="1" name="GuidValue" type="GuidType"/>
234 <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
236 <xs:attributeGroup ref="GuidDeclarationAttributes"/>
242 <xs:element name="Guids">
245 <xs:element minOccurs="1" maxOccurs="unbounded" name="GuidCNames">
247 <xs:documentation xml:lang="en">Describe the valid content of a GUID element in and MSA file.</xs:documentation>
251 <xs:element minOccurs="1" maxOccurs="1" name="GuidCName" type="C_NameType"/>
252 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
254 <xs:attributeGroup ref="GuidAttributes"/>
260 <xs:element name="HiiPackages">
262 <xs:documentation xml:lang="en">Describe the list of a HiiPackage elements</xs:documentation>
266 <xs:element minOccurs="1" maxOccurs="unbounded" name="HiiPackage">
269 <xs:element minOccurs="1" maxOccurs="1" name="HiiCName" type="C_NameType"/>
270 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
272 <xs:attributeGroup ref="HiiPackageAttributes"/>
278 <xs:element name="Hobs">
281 <xs:element minOccurs="1" maxOccurs="unbounded" name="HobTypes">
284 <xs:element minOccurs="1" maxOccurs="1" name="HobType" type="HobTypes"/>
285 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
287 <xs:attributeGroup ref="HobAttributes"/>
293 <xs:element name="IncludeHeader">
296 <xs:extension base="PathAndFilename">
297 <xs:attributeGroup ref="IncludeHeaderAttributes"/>
302 <xs:element name="IndustryStdIncludes">
305 <xs:element minOccurs="1" maxOccurs="unbounded" ref="IndustryStdHeader"/>
309 <xs:element name="IndustryStdHeader">
312 <xs:element minOccurs="1" maxOccurs="1" name="IncludeHeader" type="PathAndFilename"/>
313 <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
315 <xs:attributeGroup ref="IndustryStdHeaderAttributes"/>
318 <xs:element name="LibraryClass">
320 <xs:documentation xml:lang="en">Used in MSA files. This defines what class of library is being supported = produced (library module) or consumed by a module.</xs:documentation>
324 <xs:element minOccurs="1" maxOccurs="1" name="Keyword" type="KeywordType"/>
325 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
327 <xs:attributeGroup ref="LibraryClassAttributes"/>
330 <!-- LAH This is SPD LibraryClassDeclarations FINAL version -->
331 <xs:element name="LibraryClassDeclarations">
334 <xs:element minOccurs="1" maxOccurs="unbounded" name="LibraryClass">
337 <xs:element minOccurs="1" maxOccurs="1" name="IncludeHeader" type="PathAndFilename"/>
338 <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
340 <xs:attributeGroup ref="LibraryClassDeclarationAttributes"/>
346 <xs:element name="LibraryClassDefinitions">
348 <xs:documentation xml:lang="en">This section defines what Classes of Library that this library supports. A Library may belong to multiple different library classes.</xs:documentation>
352 <xs:element minOccurs="1" maxOccurs="unbounded" ref="LibraryClass"/>
356 <xs:element name="License">
359 <xs:extension base="Paragraph">
360 <xs:attribute name="URL" type="xs:anyURI" use="optional"/>
365 <xs:element name="ModuleBuildOptions">
368 <xs:element minOccurs="0" maxOccurs="1" ref="Options"/>
369 <xs:element minOccurs="0" maxOccurs="unbounded" ref="UserExtensions"/>
373 <xs:element name="ModuleDefinitions">
376 <xs:element minOccurs="1" maxOccurs="1" name="SupportedArchitectures" type="ArchListType"/>
377 <xs:element minOccurs="1" maxOccurs="1" name="BinaryModule" type="xs:boolean" default="false"/>
378 <xs:element minOccurs="1" maxOccurs="1" name="OutputFileBasename" type="FileNameConvention"/>
379 <xs:element minOccurs="0" maxOccurs="1" name="ClonedFrom">
382 <xs:element minOccurs="1" maxOccurs="unbounded" name="Cloned">
385 <xs:element minOccurs="1" maxOccurs="1" name="PackageGuid" type="GuidType"/>
386 <xs:element minOccurs="1" maxOccurs="1" name="PackageVersion" type="VersionDataType"/>
387 <xs:element minOccurs="1" maxOccurs="1" name="ModuleGuid" type="GuidType"/>
388 <xs:element minOccurs="1" maxOccurs="1" name="ModuleVersion" type="VersionDataType"/>
390 <!-- The Id is a number used to track heritage the first entry will be 0 and increment from then on. -->
391 <xs:attribute name="Id" type="xs:nonNegativeInteger" use="required"/>
392 <!-- If the original module was installed from a FAR, track the FAR it came from. -->
393 <xs:attribute name="FarGuid" type="GuidType" use="optional"/>
402 <xs:element name="ModuleType" type="ModuleTypeDef">
404 <xs:documentation xml:lang="en">Describe the valid EFI Phase that the Module is designed to execute under.</xs:documentation>
407 <!-- Use in Final -->
408 <xs:element name="MsaFiles">
410 <xs:documentation xml:lang="en">MsaFiles is a child of Surface Area Package Description (SPD) files</xs:documentation>
414 <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename" type="PathAndFilename"/>
418 <xs:element name="Options">
421 <xs:element minOccurs="1" maxOccurs="unbounded" ref="Option"/>
425 <xs:element name="NonProcessedFiles">
427 <xs:sequence minOccurs="1" maxOccurs="unbounded">
428 <xs:element name="Filename" type="PathAndFilename"/>
432 <xs:element name="Option">
433 <!-- This element is used to store flags from the Tools -->
436 <xs:extension base="xs:normalizedString">
437 <xs:attributeGroup ref="OptionAttributes"/>
442 <xs:element name="PackageDefinitions">
445 <xs:element minOccurs="1" maxOccurs="1" name="ReadOnly" type="xs:boolean" default="false"/>
446 <xs:element minOccurs="1" maxOccurs="1" name="RePackage" type="xs:boolean" default="false"/>
447 <xs:element minOccurs="0" maxOccurs="1" name="ClonedFrom">
450 <xs:element minOccurs="1" maxOccurs="unbounded" name="Cloned">
453 <xs:element minOccurs="1" maxOccurs="1" name="PackageGuid" type="GuidType"/>
454 <xs:element minOccurs="1" maxOccurs="1" name="PackageVersion" type="VersionDataType"/>
456 <!-- The Id is a number used to track heritage the first entry will be 0 and increment from then on. -->
457 <xs:attribute name="Id" type="xs:nonNegativeInteger" use="required"/>
458 <!-- If the original Package was installed from a FAR, track the FAR it came from. -->
459 <xs:attribute name="FarGuid" type="GuidType" use="optional"/>
468 <xs:element name="PackageDependencies">
470 <xs:documentation xml:lang="en">This tag is used in the Module Surface Area Description File (MSA) to track package dependencies for a module.</xs:documentation>
471 <xs:documentation xml:lang="en">Attributes to PackageName include Required: Usage PackageGuid PackageVesion, Optional: FeatureFlag</xs:documentation>
475 <xs:element minOccurs="1" maxOccurs="unbounded" name="Package">
477 <xs:attributeGroup ref="PackageAttributes"/>
483 <xs:element name="PackageHeaders">
485 <xs:documentation xml:lang="en">PackageHeaders is a child of PackageSurfaceArea (SPD) </xs:documentation>
489 <xs:element minOccurs="1" maxOccurs="unbounded" name="IncludePkgHeader">
492 <xs:extension base="PathAndFilename">
493 <xs:attributeGroup ref="PackageHeaderAttributes"/>
501 <xs:element name="PackageList">
502 <!-- Valid for DB usage only! -->
504 <xs:documentation xml:lang="en">This tag is used in the Framework Package Database File to track all packages (SPD files) installed in a workspace. (Database)</xs:documentation>
508 <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename">
511 <xs:extension base="PathAndFilename">
512 <xs:attributeGroup ref="PackageNameAttributes"/>
520 <xs:element name="PcdCoded">
522 <xs:documentation xml:lang="en">Child of Module Surface Area Description (MSA)</xs:documentation>
526 <xs:element minOccurs="1" maxOccurs="unbounded" name="PcdEntry">
529 <xs:element minOccurs="1" maxOccurs="1" name="C_Name" type="C_NameType"/>
530 <xs:element minOccurs="1" maxOccurs="1" name="TokenSpaceGuidCName" type="C_NameType"/>
531 <xs:element minOccurs="0" maxOccurs="1" name="DefaultValue" type="DefaultValueType"/>
532 <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
534 <!-- MSA file declares a single usage, and must match one of the entries in what the SPD file declares as the set of possible Item Types. -->
535 <xs:attributeGroup ref="PcdCodedAttributes"/>
541 <!-- LAH This is PcdDeclarations FINAL version -->
542 <xs:element name="PcdDeclarations">
544 <xs:documentation xml:lang="en">PcdDeclaratins is a child of Package Surface Area Description (SPD)</xs:documentation>
547 <xs:sequence minOccurs="1">
548 <xs:element maxOccurs="unbounded" name="PcdEntry">
551 <xs:element minOccurs="1" maxOccurs="1" name="C_Name" type="C_NameType"/>
552 <xs:element minOccurs="1" maxOccurs="1" name="Token" type="TokenDataType"/>
553 <xs:element minOccurs="1" maxOccurs="1" name="TokenSpaceGuidCName" type="C_NameType"/>
554 <xs:element minOccurs="1" maxOccurs="1" name="DatumType" type="PcdDataTypes"/>
555 <xs:element minOccurs="1" maxOccurs="1" name="ValidUsage" type="PcdListType"/>
556 <xs:element minOccurs="0" maxOccurs="1" name="DefaultValue" type="DefaultValueType"/>
557 <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
559 <xs:attributeGroup ref="PcdDeclarationAttributes"/>
565 <xs:element name="FarList">
566 <!-- Valid for DB usage only! -->
568 <xs:documentation xml:lang="en">This tag is used in the Framework Package Database File to track all DISTRIBUTION packages (FAR files) installed in a workspace. (Database)</xs:documentation>
572 <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename" type="DbPathAndFilename"/>
576 <xs:element name="PpiDeclarations">
578 <xs:documentation xml:lang="en">PpiDeclarations is a child of PackageSurfaceArea (SPD) </xs:documentation>
582 <xs:element minOccurs="1" maxOccurs="unbounded" name="Entry">
585 <xs:element minOccurs="1" maxOccurs="1" name="C_Name" type="C_NameType"/>
586 <xs:element minOccurs="1" maxOccurs="1" name="GuidValue" type="GuidType"/>
587 <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
589 <xs:attributeGroup ref="PpiDeclarationAttributes"/>
595 <xs:element name="PPIs">
597 <xs:documentation xml:lang="en">Provide for one or more Ppi or PpiNotify sections. </xs:documentation>
600 <xs:sequence minOccurs="1">
601 <xs:element minOccurs="0" maxOccurs="unbounded" name="Ppi">
604 <xs:element minOccurs="1" maxOccurs="1" name="PpiCName" type="C_NameType"/>
605 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
607 <xs:attributeGroup ref="PpiAttributes"/>
610 <xs:element minOccurs="0" maxOccurs="unbounded" name="PpiNotify">
613 <xs:element minOccurs="1" maxOccurs="1" name="PpiNotifyCName" type="C_NameType"/>
614 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
616 <xs:attributeGroup ref="PpiNotifyAttributes"/>
622 <xs:element name="ProtocolDeclarations">
624 <xs:documentation xml:lang="en">ProtocolDeclarations is a child of PackageSurfaceArea (SPD) </xs:documentation>
628 <xs:element minOccurs="1" maxOccurs="unbounded" name="Entry">
631 <xs:element minOccurs="1" maxOccurs="1" name="C_Name" type="C_NameType"/>
632 <xs:element minOccurs="1" maxOccurs="1" name="GuidValue" type="GuidType"/>
633 <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
635 <xs:attributeGroup ref="ProtocolDeclarationAttributes"/>
641 <xs:element name="Protocols">
643 <xs:documentation xml:lang="en">If either Protocol or ProtocolNotify sections are needed, one or more of them should be specified within this section</xs:documentation>
647 <xs:element minOccurs="0" maxOccurs="unbounded" name="Protocol">
650 <xs:element minOccurs="1" maxOccurs="1" name="ProtocolCName" type="C_NameType"/>
651 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
653 <xs:attributeGroup ref="ProtocolAttributes"/>
656 <xs:element minOccurs="0" maxOccurs="unbounded" name="ProtocolNotify">
659 <xs:element minOccurs="1" maxOccurs="1" name="ProtocolNotifyCName" type="C_NameType"/>
660 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
662 <xs:attributeGroup ref="ProtocolNotifyAttributes"/>
668 <xs:element name="SourceFiles">
670 <xs:documentation xml:lang="en">Multiple Filenames may be specified, and they may also be scoped to a specific Architecture.</xs:documentation>
674 <xs:element minOccurs="1" maxOccurs="unbounded" ref="Filename"/>
678 <xs:element name="SystemTables">
680 <xs:documentation xml:lang="en">This is list of System Table elements.</xs:documentation>
684 <xs:element minOccurs="1" maxOccurs="unbounded" name="SystemTableCNames">
687 <xs:element minOccurs="1" maxOccurs="1" name="SystemTableCName" type="C_NameType"/>
688 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
690 <xs:attributeGroup ref="SystemTableAttributes"/>
696 <xs:element name="UserExtensions">
699 <xs:any minOccurs="0" maxOccurs="unbounded" processContents="lax"/>
701 <xs:attribute name="UserID" type="xs:NCName" use="required"/>
702 <xs:attribute name="Identifier" type="xs:string" use="required"/>
705 <xs:element name="Variables">
707 <xs:documentation xml:lang="en">An MSA FILE list of EFI Variables described by string pair.</xs:documentation>
711 <xs:element minOccurs="1" maxOccurs="unbounded" name="Variable">
713 <xs:documentation xml:lang="en">This is an EFI Variable Entry</xs:documentation>
717 <xs:element minOccurs="1" maxOccurs="1" name="VariableName" type="HexWordArrayType"/>
718 <xs:element minOccurs="1" maxOccurs="1" name="GuidC_Name" type="C_NameType"/>
719 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
721 <xs:attributeGroup ref="VariableAttributes"/>
727 <xs:element name="Version" type="VersionDataType"/>