]> git.proxmox.com Git - mirror_edk2.git/blob - Tools/XMLSchema/FrameworkDataAttributes.xsd
Added more comments to show indicate what will go, and what will stay, also wrapped...
[mirror_edk2.git] / Tools / XMLSchema / FrameworkDataAttributes.xsd
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/2006/Edk2.0" targetNamespace="http://www.TianoCore.org/2006/Edk2.0">
3 <!--
4 Filename: FrameworkDataAttributes.xsd
5
6 Copyright (c) 2006, 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
10
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.
13
14 -->
15 <xs:annotation>
16 <xs:documentation xml:lang="en">This schema defines EFI and Framework Attribute. Only attributeGroups are specified in this file. </xs:documentation>
17 </xs:annotation>
18 <xs:include schemaLocation="NamingConvention.xsd"/>
19 <xs:include schemaLocation="FrameworkDataTypes.xsd"/>
20 <xs:attributeGroup name="BaseNameAttributes">
21 <xs:attribute name="Guid" type="GuidType" use="optional"/>
22 <xs:attribute name="Version" type="VersionDataType" use="optional"/>
23 </xs:attributeGroup>
24 <xs:attributeGroup name="BootModeAttributes">
25 <xs:attribute name="Guid" type="GuidType" use="optional"/>
26 <xs:attribute name="BootModeName" type="BootModeNames" use="required"/>
27 <xs:attribute name="Usage" type="BootModeUsage" use="required"/>
28 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
29 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
30 </xs:attributeGroup>
31 <xs:attributeGroup name="ConvertAttributeString">
32 <xs:attribute name="SourceString" type="xs:string" use="optional"/>
33 <xs:attribute default="Unicode" name="OutputFiletype" type="xs:string" use="optional"/>
34 <xs:attribute name="OutputFilename" type="FileNameConvention" use="optional"/>
35 </xs:attributeGroup>
36 <xs:attributeGroup name="DataHubAttributes">
37 <xs:attribute name="Guid" type="GuidType" use="optional"/>
38 <xs:attribute name="Usage" type="DataHubUsage" use="optional"/>
39 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
40 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
41 </xs:attributeGroup>
42 <xs:attributeGroup name="DirectoryAttributes">
43 <xs:attribute name="Separator" type="ToothPick"/>
44 </xs:attributeGroup>
45 <xs:attributeGroup name="EventAttributes">
46 <xs:attribute name="Usage" type="EventUsage" use="optional"/>
47 <xs:attribute name="EventGroup" type="EventTypes" use="optional"/>
48 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
49 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
50 </xs:attributeGroup>
51 <xs:attributeGroup name="ExternAttributes">
52 <xs:attribute name="Usage" type="ExternUsage" use="optional"/>
53 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
54 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
55 </xs:attributeGroup>
56 <xs:attributeGroup name="FilenameAttributes">
57 <xs:attribute name="Usage" type="FileNameUsage" use="optional"/>
58 <xs:attribute name="Guid" type="GuidType" use="optional"/>
59 <xs:attribute name="GuidValue" type="GuidType" use="optional"/>
60 <xs:attribute name="Path" type="DirectoryNamingConvention" use="optional"/>
61 <xs:attribute name="FileType" type="xs:string" use="optional"/>
62 <xs:attribute name="ToolChain" type="ToolChains" use="optional"/>
63 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
64 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
65 </xs:attributeGroup>
66 <xs:attributeGroup name="FormsetAttributes">
67 <xs:attribute name="Usage" type="FormSetUsage" use="optional"/>
68 <xs:attribute name="Guid" type="GuidType" use="optional"/>
69 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
70 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
71 </xs:attributeGroup>
72 <xs:attributeGroup name="GuidAttributes">
73 <xs:attribute name="Usage" type="GuidUsage" use="optional"/>
74 <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>
75 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
76 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
77 </xs:attributeGroup>
78 <xs:attributeGroup name="HobAttributes">
79 <xs:attribute name="Usage" type="HobUsage" use="optional"/>
80 <xs:attribute name="HobType" type="HobTypes" use="required"/>
81 <xs:attribute default="true" name="HobEnabled" type="xs:boolean" use="optional"/>
82 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
83 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
84 </xs:attributeGroup>
85 <xs:attributeGroup name="IncludeAttributes">
86 <xs:attribute name="Guid" type="GuidType" use="optional"/>
87 <xs:attribute name="Path" type="DirectoryNamingConvention" use="optional"/>
88 <xs:attribute name="Class" type="xs:normalizedString" use="optional"/>
89 <xs:attribute name="Version" type="VersionDataType" use="optional"/>
90 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
91 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
92 <xs:attribute name="ModuleType" type="ModuleTypeDef" use="optional"/>
93 </xs:attributeGroup>
94 <xs:attributeGroup name="LibraryAttributes">
95 <xs:attribute name="Guid" type="GuidType" use="optional"/>
96 <xs:attribute name="LibraryClass" type="BaseNameConvention" use="optional"/>
97 <xs:attribute name="ClassGuid" type="GuidType" use="optional"/>
98 <xs:attribute name="Version" type="VersionDataType" use="optional"/>
99 <xs:attribute name="Usage" type="LibraryUsage" use="optional"/>
100 <xs:attribute name="Package" type="xs:string" use="optional"/>
101 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
102 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
103 </xs:attributeGroup>
104 <xs:attributeGroup name="ModuleNameAttributes">
105 <xs:attribute name="Guid" type="GuidType" use="required"/>
106 <xs:attribute name="Version" type="VersionDataType" use="optional"/>
107 </xs:attributeGroup>
108 <xs:attributeGroup name="ModuleNameSaAttributes">
109 <xs:attribute name="ModuleName" type="xs:NCName" use="required"/>
110 <xs:attribute name="Guid" type="GuidType" use="required"/>
111 <xs:attribute name="Version" type="VersionDataType" use="optional"/>
112 </xs:attributeGroup>
113 <xs:attributeGroup name="MsaAttributes">
114 <xs:attribute name="Arch" type="SupportedArchitectures" use="optional"/>
115 <xs:attribute name="FvBinding" type="xs:string" use="optional"/>
116 <xs:attribute name="ModuleName" type="C_Name" use="optional"/>
117 <xs:attribute name="ModuleGuid" type="GuidType" use="optional"/>
118 <xs:attribute name="PackageName" type="C_Name" use="optional"/>
119 <xs:attribute name="PackageGuid" type="GuidType" use="optional"/>
120 <xs:attribute name="BuildSequence" type="xs:int" use="optional"/>
121 </xs:attributeGroup>
122 <xs:attributeGroup name="OptionAttributes">
123 <xs:attribute name="Platform" type="PlatformNamingConvention" use="optional"/>
124 <xs:attribute name="ToolChain" type="ToolChains" use="optional"/>
125 <xs:attribute name="BuildTarget" type="BuildTargets" use="optional"/>
126 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
127 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
128 </xs:attributeGroup>
129 <xs:attributeGroup name="PackageAttributes">
130 <xs:attribute name="Usage" type="PackageUsage" use="optional"/>
131 <xs:attribute name="PackageType" type="PackageType" use="optional"/>
132 <xs:attribute name="UpdatedDate" type="DateType" use="optional"/>
133 </xs:attributeGroup>
134 <xs:attributeGroup name="PackageNameAttributes">
135 <xs:attribute name="Guid" type="GuidType" use="optional"/>
136 <xs:attribute name="Version" type="VersionDataType" use="optional"/>
137 <xs:attribute name="Arch" type="SupportedArchitectures" use="optional"/>
138 </xs:attributeGroup>
139 <xs:attributeGroup name="PcdAttributes">
140 <xs:annotation>
141 <xs:documentation xml:lang="en">These attributes are for the Pcds listed in PcdData, PcdEntry and/or PcdBuildData entries.</xs:documentation>
142 <xs:documentation xml:lang="en">PcdUsage is only valid for PcdItemTypes = FEATURE_FLAG</xs:documentation>
143 </xs:annotation>
144 <xs:attribute name="ItemType" type="PcdItemTypes" use="required"/>
145 <xs:attribute name="PcdUsage" type="PcdUsage" use="optional"/>
146 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
147 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
148 </xs:attributeGroup>
149 <xs:attributeGroup name="PlatformAttributes">
150 <xs:attribute name="Guid" type="GuidType" use="optional"/>
151 <xs:attribute name="Version" type="VersionDataType" use="optional"/>
152 <xs:attribute name="AlternateName" type="FileNameConvention" use="optional"/>
153 <xs:attribute name="PlatformName" type="BaseNameConvention" use="optional"/>
154 <xs:attribute name="PlatformGuid" type="GuidType" use="optional"/>
155 <xs:attribute name="PlatformVersion" type="xs:string" use="optional"/>
156 </xs:attributeGroup>
157 <xs:attributeGroup name="PpiAttributes">
158 <xs:attribute name="Guid" type="GuidType" use="optional"/>
159 <xs:attribute name="Usage" type="PpiUsage" use="optional"/>
160 <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>
161 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
162 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
163 </xs:attributeGroup>
164 <xs:attributeGroup name="PpiNotifyAttributes">
165 <xs:attribute name="Guid" type="GuidType" use="optional"/>
166 <xs:attribute name="Usage" type="PpiNotifyUsage" use="optional"/>
167 <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>
168 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
169 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
170 </xs:attributeGroup>
171 <xs:attributeGroup name="ProtocolAttributes">
172 <xs:attribute name="Guid" type="GuidType" use="optional"/>
173 <xs:attribute name="Usage" type="ProtocolUsage" use="optional"/>
174 <xs:attribute default="true" name="EnableFeature" type="xs:boolean" use="optional"/>
175 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
176 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
177 </xs:attributeGroup>
178 <xs:attributeGroup name="ProtocolNotifyAttributes">
179 <xs:attribute name="Guid" type="GuidType" use="optional"/>
180 <xs:attribute name="Usage" type="ProtocolNotifyUsage" use="optional"/>
181 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
182 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
183 </xs:attributeGroup>
184 <xs:attributeGroup name="SectionAttributes">
185 <xs:annotation>
186 <xs:documentation xml:lang="en">Attributes are either compressable and/or sequence order binding</xs:documentation>
187 </xs:annotation>
188 <xs:attribute name="SectionType" type="EfiSectionType" use="optional"/>
189 <xs:attribute default="true" name="Compressible" type="xs:boolean" use="optional"/>
190 <xs:attribute name="BindingOrder" type="xs:int" use="optional"/>
191 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
192 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
193 </xs:attributeGroup>
194 <xs:attributeGroup name="SectionsAttributes">
195 <xs:annotation>
196 <xs:documentation xml:lang="en">Attributes for Sections, EncapsulationTag, EncapsulationType and OverrideID</xs:documentation>
197 </xs:annotation>
198 <xs:attribute name="EncapsulationType" type="xs:normalizedString" use="optional"/>
199 <xs:attribute name="EncapsulationTag" type="xs:string" use="optional"/>
200 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
201 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
202 </xs:attributeGroup>
203 <xs:attributeGroup name="SystemTableAttributes">
204 <xs:attribute name="Usage" type="SystemTableUsage" use="optional"/>
205 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
206 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
207 </xs:attributeGroup>
208 <xs:attributeGroup name="UrlAttribute">
209 <xs:attribute name="Url" type="xs:anyURI"/>
210 </xs:attributeGroup>
211 <xs:attributeGroup name="VariableAttributes">
212 <xs:attribute name="Usage" type="VariableUsage" use="optional"/>
213 <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>
214 <xs:attribute name="OverrideID" type="xs:int" use="optional"/>
215 </xs:attributeGroup>
216 </xs:schema>