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="Description" type="Paragraph">
76 <xs:documentation xml:lang="en">This section is required for new modules and libraries and must contain more information than the Abstract.</xs:documentation>
79 <xs:element name="BinaryFiles">
81 <xs:documentation xml:lang="en">Multiple Filenames may be specified, and they may also be scoped to a specific Architecture.</xs:documentation>
85 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
86 <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename">
89 <xs:extension base="PathAndFilename">
90 <xs:attributeGroup ref="BinaryFileAttributes"/>
98 <xs:element name="Events">
100 <xs:documentation xml:lang="en">This is a list of MSA Events</xs:documentation>
104 <xs:element minOccurs="0" maxOccurs="1" name="CreateEvents">
107 <xs:element minOccurs="1" maxOccurs="unbounded" name="EventTypes">
110 <xs:element minOccurs="1" maxOccurs="1" name="EventType" type="EventTypes"/>
111 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
113 <xs:attributeGroup ref="EventAttributes"/>
119 <xs:element minOccurs="0" maxOccurs="1" name="SignalEvents">
121 <xs:documentation xml:lang="en">Module has an event that is waiting to be signaled. Event is named by GUID.</xs:documentation>
125 <xs:element minOccurs="1" maxOccurs="unbounded" name="EventTypes">
128 <xs:element minOccurs="1" maxOccurs="1" name="EventType" type="EventTypes"/>
129 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
131 <xs:attributeGroup ref="EventAttributes"/>
140 <xs:element name="Externs">
142 <xs:documentation xml:lang="en">This is a child of MSA files.</xs:documentation>
145 <xs:sequence minOccurs="1">
146 <xs:element minOccurs="0" maxOccurs="1" name="PcdIsDriver" type="PcdDriverTypes"/>
147 <xs:element minOccurs="0" maxOccurs="1" name="TianoR8FlashMap_h" type="xs:boolean" default="false"/>
148 <xs:element minOccurs="0" maxOccurs="unbounded" name="Specification" type="Sentence"/>
149 <xs:element minOccurs="0" maxOccurs="unbounded" name="Extern">
151 <xs:choice minOccurs="1" maxOccurs="1">
152 <xs:sequence minOccurs="0" maxOccurs="1">
154 <xs:documentation xml:lang="en">Driver Module</xs:documentation>
156 <xs:element minOccurs="0" maxOccurs="1" name="ModuleEntryPoint" type="C_NameType"/>
157 <xs:element minOccurs="0" maxOccurs="1" name="ModuleUnloadImage" type="C_NameType"/>
159 <xs:sequence minOccurs="0" maxOccurs="1">
161 <xs:documentation xml:lang="en">Library Module</xs:documentation>
163 <xs:element minOccurs="0" maxOccurs="1" name="Constructor" type="C_NameType"/>
164 <xs:element minOccurs="0" maxOccurs="1" name="Destructor" type="C_NameType"/>
166 <xs:sequence minOccurs="0" maxOccurs="1">
168 <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>
169 <xs:documentation xml:lang="en">Permit User Defined Extern Tags</xs:documentation>
171 <xs:element minOccurs="1" maxOccurs="1" name="DriverBinding" type="C_NameType"/>
172 <xs:element minOccurs="0" maxOccurs="1" name="ComponentName" type="C_NameType"/>
173 <xs:element minOccurs="0" maxOccurs="1" name="DriverConfig" type="C_NameType"/>
174 <xs:element minOccurs="0" maxOccurs="1" name="DriverDiag" type="C_NameType"/>
176 <xs:sequence minOccurs="0" maxOccurs="1">
178 <xs:documentation xml:lang="en"> Module Call Backs</xs:documentation>
180 <xs:element minOccurs="0" maxOccurs="1" name="SetVirtualAddressMapCallBack" type="C_NameType"/>
181 <xs:element minOccurs="0" maxOccurs="1" name="ExitBootServicesCallBack" type="C_NameType"/>
184 <xs:attributeGroup ref="ExternAttributes"/>
190 <xs:element name="Filename">
192 <xs:documentation xml:lang="en">Describe the valid content of a filename This should extend PathAndFilename - Variable names not allowed here!</xs:documentation>
196 <xs:extension base="PathAndFilename">
197 <xs:attributeGroup ref="FilenameAttributes"/>
202 <xs:element name="Filenames">
204 <xs:documentation xml:lang="en">This is a list of Filenames</xs:documentation>
207 <xs:sequence minOccurs="1">
208 <xs:element minOccurs="0" maxOccurs="unbounded" ref="Filename"/>
212 <xs:element name="GuidDeclarations">
214 <xs:documentation xml:lang="en">This is a child of PackageSurfaceArea (SPD) </xs:documentation>
218 <xs:element minOccurs="1" maxOccurs="unbounded" name="Entry">
221 <xs:element minOccurs="1" maxOccurs="1" name="C_Name" type="C_NameType"/>
222 <xs:element minOccurs="1" maxOccurs="1" name="GuidValue" type="GuidType"/>
223 <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
225 <xs:attributeGroup ref="GuidDeclarationAttributes"/>
231 <xs:element name="Guids">
234 <xs:element minOccurs="1" maxOccurs="unbounded" name="GuidCNames">
236 <xs:documentation xml:lang="en">Describe the valid content of a GUID element in and MSA file.</xs:documentation>
240 <xs:element minOccurs="1" maxOccurs="1" name="GuidCName" type="C_NameType"/>
241 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
243 <xs:attributeGroup ref="GuidAttributes"/>
249 <xs:element name="HiiPackages">
251 <xs:documentation xml:lang="en">Describe the list of a HiiPackage elements</xs:documentation>
255 <xs:element minOccurs="1" maxOccurs="unbounded" name="HiiPackage">
258 <xs:element minOccurs="1" maxOccurs="1" name="HiiCName" type="C_NameType"/>
259 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
261 <xs:attributeGroup ref="HiiPackageAttributes"/>
267 <xs:element name="Hobs">
270 <xs:element minOccurs="1" maxOccurs="unbounded" name="HobTypes">
273 <xs:element minOccurs="1" maxOccurs="1" name="HobType" type="HobTypes"/>
274 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
276 <xs:attributeGroup ref="HobAttributes"/>
282 <xs:element name="IncludeHeader">
285 <xs:extension base="PathAndFilename">
286 <xs:attributeGroup ref="IncludeHeaderAttributes"/>
291 <xs:element name="IndustryStdIncludes">
294 <xs:element minOccurs="1" maxOccurs="unbounded" ref="IndustryStdHeader"/>
298 <xs:element name="IndustryStdHeader">
301 <xs:element minOccurs="1" maxOccurs="1" name="IncludeHeader" type="PathAndFilename"/>
302 <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
304 <xs:attributeGroup ref="IndustryStdHeaderAttributes"/>
307 <xs:element name="LibraryClass">
309 <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>
313 <xs:element minOccurs="1" maxOccurs="1" name="Keyword" type="KeywordType"/>
314 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
316 <xs:attributeGroup ref="LibraryClassAttributes"/>
319 <!-- LAH This is SPD LibraryClassDeclarations FINAL version -->
320 <xs:element name="LibraryClassDeclarations">
323 <xs:element minOccurs="1" maxOccurs="unbounded" name="LibraryClass">
326 <xs:element minOccurs="1" maxOccurs="1" name="IncludeHeader" type="PathAndFilename"/>
327 <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
329 <xs:attributeGroup ref="LibraryClassDeclarationAttributes"/>
335 <xs:element name="LibraryClassDefinitions">
337 <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>
341 <xs:element minOccurs="1" maxOccurs="unbounded" ref="LibraryClass"/>
345 <xs:element name="License">
348 <xs:extension base="Paragraph">
349 <xs:attribute name="URL" type="xs:anyURI" use="optional"/>
354 <xs:element name="ModuleBuildOptions">
357 <xs:element minOccurs="0" maxOccurs="1" ref="Options"/>
358 <xs:element minOccurs="0" maxOccurs="unbounded" ref="UserExtensions"/>
362 <xs:element name="ModuleDefinitions">
365 <xs:element minOccurs="1" maxOccurs="1" name="SupportedArchitectures" type="ArchListType"/>
366 <xs:element minOccurs="1" maxOccurs="1" name="BinaryModule" type="xs:boolean" default="false"/>
367 <xs:element minOccurs="1" maxOccurs="1" name="OutputFileBasename" type="FileNameConvention"/>
368 <xs:element minOccurs="0" maxOccurs="1" name="ClonedFrom">
371 <xs:element minOccurs="1" maxOccurs="unbounded" name="Cloned">
374 <xs:element minOccurs="1" maxOccurs="1" name="PackageGuid" type="GuidType"/>
375 <xs:element minOccurs="1" maxOccurs="1" name="PackageVersion" type="VersionDataType"/>
376 <xs:element minOccurs="1" maxOccurs="1" name="ModuleGuid" type="GuidType"/>
377 <xs:element minOccurs="1" maxOccurs="1" name="ModuleVersion" type="VersionDataType"/>
379 <!-- The Id is a number used to track heritage the first entry will be 0 and increment from then on. -->
380 <xs:attribute name="Id" type="xs:nonNegativeInteger" use="required"/>
381 <!-- If the original module was installed from a FAR, track the FAR it came from. -->
382 <xs:attribute name="FarGuid" type="GuidType" use="optional"/>
391 <xs:element name="ModuleType" type="ModuleTypeDef">
393 <xs:documentation xml:lang="en">Describe the valid EFI Phase that the Module is designed to execute under.</xs:documentation>
396 <!-- Use in Final -->
397 <xs:element name="MsaFiles">
399 <xs:documentation xml:lang="en">MsaFiles is a child of Surface Area Package Description (SPD) files</xs:documentation>
403 <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename" type="PathAndFilename"/>
407 <xs:element name="Options">
410 <xs:element minOccurs="1" maxOccurs="unbounded" ref="Option"/>
414 <xs:element name="NonProcessedFiles">
416 <xs:sequence minOccurs="1" maxOccurs="unbounded">
417 <xs:element name="Filename" type="PathAndFilename"/>
421 <xs:element name="Option">
422 <!-- This element is used to store flags from the Tools -->
425 <xs:extension base="xs:normalizedString">
426 <xs:attributeGroup ref="OptionAttributes"/>
431 <xs:element name="PackageDefinitions">
434 <xs:element minOccurs="1" maxOccurs="1" name="ReadOnly" type="xs:boolean" default="false"/>
435 <xs:element minOccurs="1" maxOccurs="1" name="RePackage" type="xs:boolean" default="false"/>
436 <xs:element minOccurs="0" maxOccurs="1" name="ClonedFrom">
439 <xs:element minOccurs="1" maxOccurs="unbounded" name="Cloned">
442 <xs:element minOccurs="1" maxOccurs="1" name="PackageGuid" type="GuidType"/>
443 <xs:element minOccurs="1" maxOccurs="1" name="PackageVersion" type="VersionDataType"/>
445 <!-- The Id is a number used to track heritage the first entry will be 0 and increment from then on. -->
446 <xs:attribute name="Id" type="xs:nonNegativeInteger" use="required"/>
447 <!-- If the original Package was installed from a FAR, track the FAR it came from. -->
448 <xs:attribute name="FarGuid" type="GuidType" use="optional"/>
457 <xs:element name="PackageDependencies">
459 <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>
460 <xs:documentation xml:lang="en">Attributes to PackageName include Required: Usage PackageGuid PackageVesion, Optional: FeatureFlag</xs:documentation>
464 <xs:element minOccurs="1" maxOccurs="unbounded" name="Package">
466 <xs:attributeGroup ref="PackageAttributes"/>
472 <xs:element name="PackageHeaders">
474 <xs:documentation xml:lang="en">PackageHeaders is a child of PackageSurfaceArea (SPD) </xs:documentation>
478 <xs:element minOccurs="1" maxOccurs="unbounded" name="IncludePkgHeader">
481 <xs:extension base="PathAndFilename">
482 <xs:attributeGroup ref="PackageHeaderAttributes"/>
490 <xs:element name="PackageList">
491 <!-- Valid for DB usage only! -->
493 <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>
497 <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename">
500 <xs:extension base="PathAndFilename">
501 <xs:attributeGroup ref="PackageNameAttributes"/>
509 <xs:element name="PcdCoded">
511 <xs:documentation xml:lang="en">Child of Module Surface Area Description (MSA)</xs:documentation>
515 <xs:element minOccurs="1" maxOccurs="unbounded" name="PcdEntry">
518 <xs:element minOccurs="1" maxOccurs="1" name="C_Name" type="C_NameType"/>
519 <xs:element minOccurs="1" maxOccurs="1" name="TokenSpaceGuidCName" type="C_NameType"/>
520 <xs:element minOccurs="0" maxOccurs="1" name="DefaultValue" type="DefaultValueType"/>
521 <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
523 <!-- 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. -->
524 <xs:attributeGroup ref="PcdCodedAttributes"/>
530 <!-- LAH This is PcdDeclarations FINAL version -->
531 <xs:element name="PcdDeclarations">
533 <xs:documentation xml:lang="en">PcdDeclaratins is a child of Package Surface Area Description (SPD)</xs:documentation>
536 <xs:sequence minOccurs="1">
537 <xs:element maxOccurs="unbounded" name="PcdEntry">
540 <xs:element minOccurs="1" maxOccurs="1" name="C_Name" type="C_NameType"/>
541 <xs:element minOccurs="1" maxOccurs="1" name="Token" type="TokenDataType"/>
542 <xs:element minOccurs="1" maxOccurs="1" name="TokenSpaceGuidCName" type="C_NameType"/>
543 <xs:element minOccurs="1" maxOccurs="1" name="DatumType" type="PcdDataTypes"/>
544 <xs:element minOccurs="1" maxOccurs="1" name="ValidUsage" type="PcdListType"/>
545 <xs:element minOccurs="0" maxOccurs="1" name="DefaultValue" type="DefaultValueType"/>
546 <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
548 <xs:attributeGroup ref="PcdDeclarationAttributes"/>
554 <xs:element name="FarList">
555 <!-- Valid for DB usage only! -->
557 <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>
561 <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename" type="DbPathAndFilename"/>
565 <xs:element name="PpiDeclarations">
567 <xs:documentation xml:lang="en">PpiDeclarations is a child of PackageSurfaceArea (SPD) </xs:documentation>
571 <xs:element minOccurs="1" maxOccurs="unbounded" name="Entry">
574 <xs:element minOccurs="1" maxOccurs="1" name="C_Name" type="C_NameType"/>
575 <xs:element minOccurs="1" maxOccurs="1" name="GuidValue" type="GuidType"/>
576 <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
578 <xs:attributeGroup ref="PpiDeclarationAttributes"/>
584 <xs:element name="PPIs">
586 <xs:documentation xml:lang="en">Provide for one or more Ppi or PpiNotify sections. </xs:documentation>
589 <xs:sequence minOccurs="1">
590 <xs:element minOccurs="0" maxOccurs="unbounded" name="Ppi">
593 <xs:element minOccurs="1" maxOccurs="1" name="PpiCName" type="C_NameType"/>
594 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
596 <xs:attributeGroup ref="PpiAttributes"/>
599 <xs:element minOccurs="0" maxOccurs="unbounded" name="PpiNotify">
602 <xs:element minOccurs="1" maxOccurs="1" name="PpiNotifyCName" type="C_NameType"/>
603 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
605 <xs:attributeGroup ref="PpiNotifyAttributes"/>
611 <xs:element name="ProtocolDeclarations">
613 <xs:documentation xml:lang="en">ProtocolDeclarations is a child of PackageSurfaceArea (SPD) </xs:documentation>
617 <xs:element minOccurs="1" maxOccurs="unbounded" name="Entry">
620 <xs:element minOccurs="1" maxOccurs="1" name="C_Name" type="C_NameType"/>
621 <xs:element minOccurs="1" maxOccurs="1" name="GuidValue" type="GuidType"/>
622 <xs:element minOccurs="1" maxOccurs="1" name="HelpText" type="Paragraph"/>
624 <xs:attributeGroup ref="ProtocolDeclarationAttributes"/>
630 <xs:element name="Protocols">
632 <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>
636 <xs:element minOccurs="0" maxOccurs="unbounded" name="Protocol">
639 <xs:element minOccurs="1" maxOccurs="1" name="ProtocolCName" type="C_NameType"/>
640 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
642 <xs:attributeGroup ref="ProtocolAttributes"/>
645 <xs:element minOccurs="0" maxOccurs="unbounded" name="ProtocolNotify">
648 <xs:element minOccurs="1" maxOccurs="1" name="ProtocolNotifyCName" type="C_NameType"/>
649 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
651 <xs:attributeGroup ref="ProtocolNotifyAttributes"/>
657 <xs:element name="SourceFiles">
659 <xs:documentation xml:lang="en">Multiple Filenames may be specified, and they may also be scoped to a specific Architecture.</xs:documentation>
663 <xs:element minOccurs="1" maxOccurs="unbounded" ref="Filename"/>
667 <xs:element name="SystemTables">
669 <xs:documentation xml:lang="en">This is list of System Table elements.</xs:documentation>
673 <xs:element minOccurs="1" maxOccurs="unbounded" name="SystemTableCNames">
676 <xs:element minOccurs="1" maxOccurs="1" name="SystemTableCName" type="C_NameType"/>
677 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
679 <xs:attributeGroup ref="SystemTableAttributes"/>
685 <xs:element name="UserExtensions">
688 <xs:any minOccurs="0" maxOccurs="unbounded" processContents="lax"/>
690 <xs:attribute name="UserID" type="xs:NCName" use="required"/>
691 <xs:attribute name="Identifier" type="xs:string" use="required"/>
694 <xs:element name="Variables">
696 <xs:documentation xml:lang="en">An MSA FILE list of EFI Variables described by string pair.</xs:documentation>
700 <xs:element minOccurs="1" maxOccurs="unbounded" name="Variable">
702 <xs:documentation xml:lang="en">This is an EFI Variable Entry</xs:documentation>
706 <xs:element minOccurs="1" maxOccurs="1" name="VariableName" type="HexWordArrayType"/>
707 <xs:element minOccurs="1" maxOccurs="1" name="GuidC_Name" type="C_NameType"/>
708 <xs:element minOccurs="0" maxOccurs="1" name="HelpText" type="Paragraph"/>
710 <xs:attributeGroup ref="VariableAttributes"/>
716 <xs:element name="Version" type="VersionDataType"/>