*BaseSmbusLib: (new version)
[mirror_edk2.git] / Tools / XMLSchema / FrameworkPlatformDataElements.xsd
CommitLineData
878ddf1f 1<?xml version="1.0" encoding="UTF-8"?>\r
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">\r
3 <!--\r
4 Filename: FrameworkPlatformDataElements.xsd\r
5 \r
6 Copyright (c) 2006, Intel Corp.\r
7 All rights reserved. This program and the accompanying materials\r
8 are licensed and made available under the terms and conditions of the BSD License\r
9 which may be found at http://opensource.org/licenses/bsd-license.php\r
10 \r
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13 \r
14 -->\r
15 <xs:annotation>\r
16 <xs:documentation xml:lang="en"> This schema defines EFI and Framework Platform Data Elements that are specific to platform creation.</xs:documentation>\r
17 </xs:annotation>\r
18 <xs:include schemaLocation="NamingConvention.xsd"/>\r
19 <xs:include schemaLocation="FrameworkDataTypes.xsd"/>\r
20 <xs:include schemaLocation="FrameworkDataElements.xsd"/>\r
21 <xs:element name="Capsule">\r
22 <xs:complexType>\r
23 <xs:sequence>\r
24 <xs:element minOccurs="1" maxOccurs="1" name="CapsuleId" type="xs:string"/>\r
25 <xs:element minOccurs="0" maxOccurs="1" ref="CapsuleOptions"/>\r
26 <xs:element minOccurs="0" maxOccurs="1" ref="CapsuleAttributes"/>\r
27 </xs:sequence>\r
28 </xs:complexType>\r
29 </xs:element>\r
30 <xs:element name="CapsuleAttributes">\r
31 <xs:annotation>\r
32 <xs:documentation xml:lang="en">This element is used specify different name value pairs.</xs:documentation>\r
33 </xs:annotation>\r
34 <xs:complexType>\r
35 <xs:sequence>\r
36 <xs:element minOccurs="0" maxOccurs="unbounded" ref="NameValue"/>\r
37 <xs:element minOccurs="0" maxOccurs="unbounded" ref="Enable"/>\r
38 <xs:element minOccurs="0" maxOccurs="unbounded" ref="Disable"/>\r
39 </xs:sequence>\r
40 </xs:complexType>\r
41 </xs:element>\r
42 <xs:element name="CapsuleOptions">\r
43 <xs:annotation>\r
44 <xs:documentation xml:lang="en">This element is used specify different name value pairs.</xs:documentation>\r
45 </xs:annotation>\r
46 <xs:complexType>\r
47 <xs:sequence>\r
48 <xs:element minOccurs="0" maxOccurs="unbounded" ref="NameValue"/>\r
49 <xs:element minOccurs="0" maxOccurs="unbounded" ref="Enable"/>\r
50 <xs:element minOccurs="0" maxOccurs="unbounded" ref="Disable"/>\r
51 </xs:sequence>\r
52 </xs:complexType>\r
53 </xs:element>\r
54 <xs:element name="Capsules">\r
55 <xs:annotation>\r
56 <xs:documentation xml:lang="en">Permit multiple Capsule Sections</xs:documentation>\r
57 </xs:annotation>\r
58 <xs:complexType>\r
59 <xs:sequence minOccurs="1" maxOccurs="unbounded">\r
60 <xs:element ref="Capsule"/>\r
61 </xs:sequence>\r
62 </xs:complexType>\r
63 </xs:element>\r
64 <xs:element name="Disable" type="xs:string"/>\r
65 <xs:element name="Enable" type="xs:string"/>\r
66 <xs:element name="Flash">\r
67 <xs:complexType>\r
68 <xs:annotation>\r
69 <xs:documentation xml:lang="en">We allow specifying the Flash layout in this directory, or we allow specifying a flashmap filename</xs:documentation>\r
70 </xs:annotation>\r
71 <xs:sequence>\r
72 <xs:choice>\r
73 <xs:element name="FlashDefinition" type="FlashData"/>\r
74 <xs:element name="FlashDefinitionFile" type="FileNameConvention"/>\r
75 </xs:choice>\r
76 <xs:element minOccurs="0" maxOccurs="unbounded" ref="FvImages"/>\r
77 <xs:element minOccurs="0" maxOccurs="unbounded" ref="Capsules"/>\r
78 </xs:sequence>\r
79 <xs:attribute name="MicrocodeFile" type="FileNameConvention" use="optional"/>\r
80 </xs:complexType>\r
81 </xs:element>\r
82 <xs:element name="FlashDeviceImage">\r
83 <xs:annotation>\r
84 <xs:documentation xml:lang="en">Define contents of the regions in flash. The files and data are placed in the output image in the order they are encountered in this definition. Multiple FlashDeviceImage sections may be defined. Which one the tool should use is specified by Name on the command line.</xs:documentation>\r
85 </xs:annotation>\r
86 <xs:complexType>\r
87 <xs:sequence minOccurs="1" maxOccurs="unbounded">\r
88 <xs:element minOccurs="1" maxOccurs="1" name="Name" type="NameConvention"/>\r
89 <xs:element minOccurs="0" maxOccurs="unbounded" name="File" type="FvImageFileType"/>\r
90 </xs:sequence>\r
91 </xs:complexType>\r
92 </xs:element>\r
93 <xs:element name="FlashDeviceInfo">\r
94 <xs:annotation>\r
95 <xs:documentation xml:lang="en">This is the Flash Devcie definition List</xs:documentation>\r
96 </xs:annotation>\r
97 <xs:complexType>\r
98 <xs:sequence>\r
99 <xs:element minOccurs="1" maxOccurs="1" name="Name" type="UCNameType"/>\r
100 <xs:element default="512KB" minOccurs="1" maxOccurs="1" name="FlashSize" type="FlashSize"/>\r
101 <xs:element minOccurs="1" maxOccurs="1" name="BaseAddress" type="HexAddressType"/>\r
102 <xs:element minOccurs="1" maxOccurs="1" name="OutputDirectory" type="DirectoryNamingConvention"/>\r
103 <xs:element minOccurs="0" maxOccurs="1" name="MicrocodeFile" type="FileNameConvention"/>\r
104 <xs:element minOccurs="1" maxOccurs="255" name="Block" type="BlockNameType"/>\r
105 <xs:element minOccurs="1" maxOccurs="unbounded" name="Region" type="RegionDataType"/>\r
106 </xs:sequence>\r
107 </xs:complexType>\r
108 </xs:element>\r
109 <xs:element name="FlashDeviceOverrideImage">\r
110 <xs:annotation>\r
111 <xs:documentation xml:lang="en">Define OVERRIDE contents of the regions in flash. Only what is different here from what may defined in other areas (or files) is needed </xs:documentation>\r
112 </xs:annotation>\r
113 <xs:complexType>\r
114 <xs:sequence>\r
115 <xs:element minOccurs="0" maxOccurs="1" name="Name" type="NameConvention"/>\r
116 <xs:element minOccurs="0" maxOccurs="unbounded" name="File" type="FvImageOverrideFileType"/>\r
117 </xs:sequence>\r
118 </xs:complexType>\r
119 </xs:element>\r
120 <xs:element name="FlashDeviceOverrideInfo">\r
121 <xs:annotation>\r
122 <xs:documentation xml:lang="en">This is the Flash Devcie Override Definition list. Only what is different from the previously defined stuff needs to be included.</xs:documentation>\r
123 </xs:annotation>\r
124 <xs:complexType>\r
125 <xs:sequence>\r
126 <xs:element minOccurs="0" maxOccurs="1" name="Name" type="UCNameType"/>\r
127 <xs:element default="512KB" minOccurs="0" maxOccurs="1" name="FlashSize" type="FlashSize"/>\r
128 <xs:element minOccurs="0" maxOccurs="1" name="BaseAddress" type="HexAddressType"/>\r
129 <xs:element minOccurs="0" maxOccurs="1" name="OutputDirectory" type="DirectoryNamingConvention"/>\r
130 <xs:element minOccurs="0" maxOccurs="1" name="MicrocodeFile" type="FileNameConvention"/>\r
131 <xs:element minOccurs="0" maxOccurs="255" name="Block" type="BlockNameType"/>\r
132 <xs:element minOccurs="0" maxOccurs="unbounded" name="Region" type="RegionDataType"/>\r
133 </xs:sequence>\r
134 </xs:complexType>\r
135 </xs:element>\r
136 <xs:element name="FvImage">\r
137 <xs:complexType>\r
138 <xs:sequence>\r
139 <xs:element minOccurs="1" maxOccurs="unbounded" ref="FvImageNames"/>\r
140 <xs:element minOccurs="0" maxOccurs="1" ref="FvImageOptions"/>\r
141 </xs:sequence>\r
142 <xs:attribute name="Type" type="xs:string" use="optional"/>\r
143 </xs:complexType>\r
144 </xs:element>\r
145 <xs:element name="FvImageName">\r
146 <xs:complexType>\r
147 <xs:sequence>\r
148 <xs:element ref="FvImageOptions"/>\r
149 </xs:sequence>\r
150 <xs:attribute name="Name" type="FvRegionTypes" use="required"/>\r
151 </xs:complexType>\r
152 </xs:element>\r
153 <xs:element name="FvImageNames" type="xs:string"/>\r
154 <xs:element name="FvImageOptions">\r
155 <xs:annotation>\r
156 <xs:documentation xml:lang="en">This element is used specify different name value pairs.</xs:documentation>\r
157 </xs:annotation>\r
158 <xs:complexType>\r
159 <xs:sequence>\r
160 <xs:element minOccurs="0" maxOccurs="unbounded" ref="NameValue"/>\r
161 <xs:element minOccurs="0" maxOccurs="unbounded" ref="Enable"/>\r
162 <xs:element minOccurs="0" maxOccurs="unbounded" ref="Disable"/>\r
163 </xs:sequence>\r
164 </xs:complexType>\r
165 </xs:element>\r
166 <xs:element name="FvImages">\r
167 <xs:annotation>\r
168 <xs:documentation xml:lang="en">This section allows the user to define specific information regarding the FvImage</xs:documentation>\r
169 </xs:annotation>\r
170 <xs:complexType>\r
171 <xs:sequence>\r
172 <xs:element minOccurs="0" maxOccurs="unbounded" ref="NameValue"/>\r
173 <xs:element minOccurs="0" maxOccurs="unbounded" ref="FvImage"/>\r
174 <xs:element minOccurs="0" maxOccurs="unbounded" ref="FvImageName"/>\r
175 </xs:sequence>\r
176 </xs:complexType>\r
177 </xs:element>\r
178 <xs:element name="ModuleSA">\r
179 <xs:annotation>\r
180 <xs:documentation xml:lang="en">This element is used to specify information in the Platform Description File.</xs:documentation>\r
181 <xs:documentation xml:lang="en">This is a mixed element, allowing the user to specify the name of the MSA file, as well as to optionally specify additional override information.</xs:documentation>\r
182 </xs:annotation>\r
183 <xs:complexType>\r
184 <xs:sequence minOccurs="1">\r
185 <xs:element minOccurs="0" maxOccurs="1" ref="SourceFiles"/>\r
186 <xs:element minOccurs="0" maxOccurs="1" ref="Includes"/>\r
187 <xs:element minOccurs="0" maxOccurs="1" ref="Libraries"/>\r
188 <xs:element minOccurs="0" maxOccurs="1" ref="Protocols"/>\r
189 <xs:element minOccurs="0" maxOccurs="1" ref="Events"/>\r
190 <xs:element minOccurs="0" maxOccurs="1" ref="Hobs"/>\r
191 <xs:element minOccurs="0" maxOccurs="1" ref="PPIs"/>\r
192 <xs:element minOccurs="0" maxOccurs="1" ref="Variables"/>\r
193 <xs:element minOccurs="0" maxOccurs="1" ref="BootModes"/>\r
194 <xs:element minOccurs="0" maxOccurs="1" ref="SystemTables"/>\r
195 <xs:element minOccurs="0" maxOccurs="1" ref="DataHubs"/>\r
196 <xs:element minOccurs="0" maxOccurs="1" ref="Formsets"/>\r
197 <xs:element minOccurs="0" maxOccurs="1" ref="Guids"/>\r
198 <xs:element minOccurs="0" maxOccurs="1" ref="Externs"/>\r
199 </xs:sequence>\r
200 <xs:attributeGroup ref="MsaAttributes"/>\r
201 </xs:complexType>\r
202 </xs:element>\r
203 <xs:element name="NameValue">\r
204 <xs:complexType>\r
205 <xs:simpleContent>\r
206 <xs:extension base="xs:string">\r
207 <xs:attribute name="Name" type="xs:string" use="required"/>\r
208 <xs:attribute name="Value" type="xs:string" use="required"/>\r
209 </xs:extension>\r
210 </xs:simpleContent>\r
211 </xs:complexType>\r
212 </xs:element>\r
213 <xs:element name="Overrides">\r
214 <xs:complexType>\r
215 <xs:sequence>\r
216 <xs:element minOccurs="0" maxOccurs="1" ref="FlashDeviceOverrideInfo"/>\r
217 <xs:element minOccurs="0" maxOccurs="1" ref="FlashDeviceOverrideImage"/>\r
218 </xs:sequence>\r
219 </xs:complexType>\r
220 </xs:element>\r
221 <xs:element name="PlatformDescriptions">\r
222 <xs:complexType>\r
223 <xs:sequence maxOccurs="unbounded">\r
224 <xs:element ref="Platform"/>\r
225 </xs:sequence>\r
226 </xs:complexType>\r
227 </xs:element>\r
228 <xs:element name="TianoImage">\r
229 <xs:annotation>\r
230 <xs:documentation xml:lang="en">This defines the required sections of a valid EFI/Tiano binary image</xs:documentation>\r
231 </xs:annotation>\r
232 <xs:complexType>\r
233 <xs:sequence>\r
4895d0f0 234 <xs:element minOccurs="0" maxOccurs="1" name="SEC" type="Components"/>\r
235 <xs:element minOccurs="0" maxOccurs="1" name="PEI_CORE" type="Components"/>\r
236 <xs:element minOccurs="0" maxOccurs="1" name="PEIM" type="Components"/>\r
237 <xs:element minOccurs="0" maxOccurs="1" name="DXE_CORE" type="Components"/>\r
238 <xs:element minOccurs="0" maxOccurs="1" name="DXE_DRIVERS" type="Components"/>\r
878ddf1f 239 <xs:element minOccurs="0" maxOccurs="1" name="OTHER_COMPONENTS" type="Components"/>\r
240 </xs:sequence>\r
241 </xs:complexType>\r
242 </xs:element>\r
243 <xs:simpleType name="EfiFvAttributeType">\r
244 <xs:annotation>\r
245 <xs:documentation xml:lang="en">The list of EFI_FLASH_AREA Attributes</xs:documentation>\r
246 </xs:annotation>\r
247 <xs:restriction base="UCNameType">\r
248 <xs:enumeration value="EFI_FLASH_AREA_FV"/>\r
249 <xs:enumeration value="EFI_FLASH_AREA_MEMMAPPED_FV"/>\r
250 <xs:enumeration value="EFI_FLASH_AREA_SUBFV"/>\r
251 </xs:restriction>\r
252 </xs:simpleType>\r
253 <xs:simpleType name="EfiFvAreaType">\r
254 <xs:annotation>\r
255 <xs:documentation xml:lang="en">The list of valid EFI Area Types</xs:documentation>\r
256 </xs:annotation>\r
257 <xs:restriction base="UCNameType">\r
258 <xs:enumeration value="EFI_FLASH_AREA_EFI_VARIABLES"/>\r
259 <xs:enumeration value="EFI_FLASH_AREA_UNUSED"/>\r
260 <xs:enumeration value="EFI_FLASH_AREA_MAIN_BIOS"/>\r
261 <xs:enumeration value="EFI_FLASH_AREA_GUID_DEFINED"/>\r
262 <xs:enumeration value="EFI_FLASH_AREA_FTW_STATE"/>\r
263 <xs:enumeration value="EFI_FLASH_AREA_FTW_BACKUP"/>\r
264 <xs:enumeration value="EFI_FLASH_AREA_RECOVERY_BIOS"/>\r
265 </xs:restriction>\r
266 </xs:simpleType>\r
267 <xs:simpleType name="EfiNameGuidType">\r
268 <xs:annotation>\r
269 <xs:documentation xml:lang="en">Right now, only EFI_FLASH_MAP_HOB_GUID is defined</xs:documentation>\r
270 </xs:annotation>\r
271 <xs:restriction base="UCNameType">\r
272 <xs:enumeration value="EFI_FLASH_MAP_HOB_GUID"/>\r
273 </xs:restriction>\r
274 </xs:simpleType>\r
275 <xs:simpleType name="FlashSize">\r
276 <xs:restriction base="xs:string">\r
277 <xs:enumeration value="256KB"/>\r
278 <xs:enumeration value="512KB"/>\r
279 <xs:enumeration value="1MB"/>\r
280 <xs:enumeration value="2MB"/>\r
281 <xs:enumeration value="4MB"/>\r
282 </xs:restriction>\r
283 </xs:simpleType>\r
284 <xs:simpleType name="FvSubRegionTypes">\r
285 <xs:restriction base="UCNameType">\r
286 <xs:enumeration value="NV_VARIABLE_STORE"/>\r
287 <xs:enumeration value="MICROCODE"/>\r
288 <xs:enumeration value="NV_FTW_WORKING"/>\r
289 </xs:restriction>\r
290 </xs:simpleType>\r
291 <xs:complexType name="Components">\r
292 <xs:sequence minOccurs="1" maxOccurs="unbounded">\r
293 <xs:element ref="ModuleSA"/>\r
294 </xs:sequence>\r
295 </xs:complexType>\r
296 <xs:complexType name="FlashData">\r
297 <xs:sequence>\r
298 <xs:element minOccurs="0" maxOccurs="unbounded" name="UserDefinedFvRegion" type="NameConvention"/>\r
299 <xs:choice minOccurs="0" maxOccurs="1">\r
300 <xs:sequence>\r
301 <xs:element minOccurs="1" maxOccurs="1" ref="FlashDeviceInfo"/>\r
302 <xs:element minOccurs="1" maxOccurs="1" ref="FlashDeviceImage"/>\r
303 </xs:sequence>\r
304 </xs:choice>\r
305 <xs:element minOccurs="0" maxOccurs="1" ref="Overrides"/>\r
306 </xs:sequence>\r
307 </xs:complexType>\r
308 <xs:complexType name="FvImageFileType">\r
309 <xs:sequence>\r
310 <xs:element minOccurs="1" maxOccurs="1" name="Name" type="FileNameConvention"/>\r
311 <xs:element minOccurs="1" maxOccurs="1" name="Region" type="FvRegionTypes"/>\r
312 <xs:element minOccurs="1" maxOccurs="unbounded" name="RawData" type="RawDataType"/>\r
313 </xs:sequence>\r
314 </xs:complexType>\r
315 <xs:complexType name="FvImageOverrideFileType">\r
316 <xs:sequence>\r
317 <xs:element minOccurs="0" maxOccurs="1" name="Name" type="FileNameConvention"/>\r
318 <xs:element minOccurs="0" maxOccurs="1" name="Region" type="FvRegionTypes"/>\r
319 <xs:element minOccurs="0" maxOccurs="1" name="UserDefinedFvRegion" type="NameConvention"/>\r
320 <xs:element minOccurs="0" maxOccurs="unbounded" name="RawData" type="RawDataType"/>\r
321 </xs:sequence>\r
322 </xs:complexType>\r
323 <xs:complexType name="RawDataType">\r
324 <xs:sequence>\r
325 <xs:element minOccurs="1" maxOccurs="1" name="Name" type="NameConvention"/>\r
326 <xs:element minOccurs="0" maxOccurs="1" name="Region" type="FvRegionTypes"/>\r
327 <xs:element minOccurs="0" maxOccurs="1" name="UserDefinedFvRegion" type="NameConvention"/>\r
328 <xs:element minOccurs="1" maxOccurs="1" name="SubRegion" type="FvSubRegionTypes"/>\r
329 <xs:element minOccurs="1" maxOccurs="1" name="Data" type="HexDataType"/>\r
330 </xs:sequence>\r
331 </xs:complexType>\r
332 <xs:complexType name="RegionDataType">\r
333 <xs:annotation>\r
334 <xs:documentation xml:lang="en">Define the regions and their uses for the device</xs:documentation>\r
335 </xs:annotation>\r
336 <xs:sequence>\r
337 <xs:element minOccurs="1" maxOccurs="1" name="Name" type="UCNameType"/>\r
338 <xs:element minOccurs="1" maxOccurs="1" name="Size" type="HexAddressType"/>\r
339 <xs:element minOccurs="1" maxOccurs="unbounded" name="Attributes" type="EfiFvAttributeType"/>\r
340 <xs:element minOccurs="1" maxOccurs="1" name="AreaType" type="EfiFvAreaType"/>\r
341 <xs:element minOccurs="0" maxOccurs="unbounded" name="SubRegion" type="SubRegionType"/>\r
342 </xs:sequence>\r
343 </xs:complexType>\r
344 <xs:complexType name="SubRegionType">\r
345 <xs:annotation>\r
346 <xs:documentation xml:lang="en">Define the regions and their uses for the device</xs:documentation>\r
347 </xs:annotation>\r
348 <xs:sequence>\r
349 <xs:element default="true" minOccurs="1" maxOccurs="1" name="CreateHob" type="xs:boolean"/>\r
350 <xs:element minOccurs="1" maxOccurs="1" name="Name" type="UCNameType"/>\r
351 <xs:element minOccurs="1" maxOccurs="1" name="Size" type="HexAddressType"/>\r
352 <xs:element minOccurs="1" maxOccurs="unbounded" name="Attributes" type="EfiFvAttributeType"/>\r
353 <xs:element minOccurs="1" maxOccurs="1" name="AreaType" type="EfiFvAreaType"/>\r
354 <xs:element minOccurs="1" maxOccurs="1" name="NameGuid" type="EfiNameGuidType"/>\r
355 </xs:sequence>\r
356 </xs:complexType>\r
357</xs:schema>\r