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">
4 Filename: FrameworkDataTypes.xsd
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
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 Types. Only simpleType are specified in this file. </xs:documentation>
18 <xs:include schemaLocation="NamingConvention.xsd"/>
19 <xs:simpleType name="ArchListType">
20 <xs:list itemType="SupportedArchitectures"/>
22 <xs:simpleType name="BlockNameType">
23 <xs:restriction base="UCNameType">
24 <xs:pattern value="BLOCK([A-F0-9]){2}"/>
27 <xs:simpleType name="BootModeNames">
28 <xs:restriction base="NameConvention">
29 <xs:enumeration value="FULL"/>
30 <xs:enumeration value="MINIMAL"/>
31 <xs:enumeration value="NO_CHANGE"/>
32 <xs:enumeration value="DIAGNOSTICS"/>
33 <xs:enumeration value="DEFAULT"/>
34 <xs:enumeration value="S2_RESUME"/>
35 <xs:enumeration value="S3_RESUME"/>
36 <xs:enumeration value="S4_RESUME"/>
37 <xs:enumeration value="S5_RESUME"/>
38 <xs:enumeration value="FLASH_UPDATE"/>
39 <xs:enumeration value="RECOVERY"/>
42 <xs:simpleType name="BootModeUsage">
43 <xs:restriction base="NameConvention">
44 <xs:enumeration value="ALWAYS_CONSUMED"/>
45 <xs:enumeration value="SOMETIMES_CONSUMED"/>
46 <xs:enumeration value="ALWAYS_PRODUCED"/>
47 <xs:enumeration value="SOMETIMES_PRODUCED"/>
50 <xs:simpleType name="BuildTargets">
51 <xs:restriction base="xs:NCName">
52 <xs:enumeration value="DEBUG"/>
53 <xs:enumeration value="RELEASE"/>
54 <xs:enumeration value="BOTH"/>
57 <xs:simpleType name="ComponentExecutionPhase">
58 <xs:restriction base="UCNameType">
59 <xs:enumeration value="MDE"/>
60 <xs:enumeration value="SEC"/>
61 <xs:enumeration value="PEI_CORE"/>
62 <xs:enumeration value="PEIM"/>
63 <xs:enumeration value="DXE_CORE"/>
64 <xs:enumeration value="DXE_DRIVER"/>
65 <xs:enumeration value="DXE_RUNTIME_DRIVER"/>
66 <xs:enumeration value="DXE_SAL_DRIVER"/>
67 <xs:enumeration value="DXE_SMM_DRIVER"/>
68 <xs:enumeration value="UEFI"/>
69 <xs:enumeration value="UEFI_APPLICATION"/>
72 <xs:simpleType name="ConditionalTarget">
73 <xs:list itemType="C_Name"/>
75 <xs:simpleType name="DataHubUsage">
76 <xs:restriction base="NameConvention">
77 <xs:enumeration value="ALWAYS_CONSUMED"/>
78 <xs:enumeration value="SOMETIMES_CONSUMED"/>
79 <xs:enumeration value="ALWAYS_PRODUCED"/>
80 <xs:enumeration value="SOMETIMES_PRODUCED"/>
81 <xs:enumeration value="PRIVATE"/>
84 <xs:simpleType name="DateType">
85 <xs:restriction base="xs:normalizedString">
86 <xs:pattern value="[1-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9] [0-2][0-9]:[0-5][0-9]"/>
89 <xs:simpleType name="DatumSizeLimitation">
90 <xs:restriction base="xs:int">
91 <xs:minInclusive value="1"/>
92 <xs:maxInclusive value="16777215"/>
95 <xs:simpleType name="DefaultValue">
96 <xs:union memberTypes="xs:normalizedString xs:int UnicodeString"/>
98 <xs:simpleType name="EfiSectionType">
99 <xs:restriction base="UCNameType">
100 <xs:enumeration value="EFI_SECTION_FREEFORM_SUBTYPE_GUID"/>
101 <xs:enumeration value="EFI_SECTION_VERSION"/>
102 <xs:enumeration value="EFI_SECTION_USER_INTERFACE"/>
103 <xs:enumeration value="EFI_SECTION_DXE_DEPEX"/>
104 <xs:enumeration value="EFI_SECTION_PEI_DEPEX"/>
105 <xs:enumeration value="EFI_SECTION_PE32"/>
106 <xs:enumeration value="EFI_SECTION_PIC"/>
107 <xs:enumeration value="EFI_SECTION_TE"/>
108 <xs:enumeration value="EFI_SECTION_RAW"/>
109 <xs:enumeration value="EFI_SECTION_COMPRESSION"/>
110 <xs:enumeration value="EFI_SECTION_GUID_DEFINED"/>
111 <xs:enumeration value="EFI_SECTION_COMPATIBILITY16"/>
112 <xs:enumeration value="EFI_SECTION_FIRMWARE_VOLUME_IMAGE"/>
115 <xs:simpleType name="EventTypes">
116 <xs:restriction base="NameConvention">
117 <xs:enumeration value="EVENT_GROUP_EXIT_BOOT_SERVICES"/>
118 <xs:enumeration value="EVENT_GROUP_VIRTUAL_ADDRESS_CHANGE"/>
119 <xs:enumeration value="EVENT_GROUP_MEMORY_MAP_CHANGE"/>
120 <xs:enumeration value="EVENT_GROUP_READY_TO_BOOT"/>
121 <xs:enumeration value="EVENT_GROUP_LEGACY_BOOT"/>
124 <xs:simpleType name="EventUsage">
125 <xs:restriction base="NameConvention">
126 <xs:enumeration value="ALWAYS_CONSUMED"/>
127 <xs:enumeration value="SOMETIMES_CONSUMED"/>
128 <xs:enumeration value="ALWAYS_PRODUCED"/>
129 <xs:enumeration value="SOMETIMES_PRODUCED"/>
130 <xs:enumeration value="PRIVATE"/>
133 <xs:simpleType name="ExecutionType">
134 <xs:restriction base="UCNameType">
135 <xs:enumeration value="REL" id="Relocatable"/>
136 <xs:enumeration value="NREL" id="Non-Relocatable"/>
137 <xs:enumeration value="XIP" id="Execute_In_Place"/>
138 <xs:enumeration value="PIC" id="Position_Independent_Code"/>
141 <xs:simpleType name="ExternType">
142 <xs:restriction base="xs:string">
143 <xs:pattern value="(_*\w*\W*)*"/>
146 <xs:simpleType name="ExternUsage">
147 <xs:restriction base="NameConvention">
148 <xs:enumeration value="ALWAYS_CONSUMED"/>
149 <xs:enumeration value="ALWAYS_PRODUCED"/>
152 <xs:simpleType name="FileNameUsage">
153 <xs:restriction base="NameConvention">
154 <xs:enumeration value="ALWAYS_CONSUMED"/>
155 <xs:enumeration value="SOMETIMES_CONSUMED"/>
156 <xs:enumeration value="ALWAYS_PRODUCED"/>
157 <xs:enumeration value="SOMETIMES_PRODUCED"/>
158 <xs:enumeration value="PRIVATE"/>
161 <xs:simpleType name="FormSetUsage">
162 <xs:restriction base="NameConvention">
163 <xs:enumeration value="ALWAYS_PRODUCED"/>
164 <xs:enumeration value="SOMETIMES_PRODUCED"/>
165 <xs:enumeration value="PRIVATE"/>
168 <xs:simpleType name="FrameworkComponentTypes">
169 <xs:restriction base="UCNameType">
170 <xs:enumeration value="APRIORI"/>
171 <xs:enumeration value="SEC"/>
172 <xs:enumeration value="LIBRARY"/>
173 <xs:enumeration value="FV_IMAGE_FILE"/>
174 <xs:enumeration value="BS_DRIVER"/>
175 <xs:enumeration value="RT_DRIVER"/>
176 <xs:enumeration value="SAL_RT_DRIVER"/>
177 <xs:enumeration value="PE32_PEIM"/>
178 <xs:enumeration value="PIC_PEIM"/>
179 <xs:enumeration value="COMBINED_PEIM_DRIVER"/>
180 <xs:enumeration value="PEI_CORE"/>
181 <xs:enumeration value="DXE_CORE"/>
182 <xs:enumeration value="APPLICATION"/>
183 <xs:enumeration value="BS_DRIVER_EFI"/>
184 <xs:enumeration value="SHELLAPP"/>
185 <xs:enumeration value="UEFI_APPLICATION"/>
186 <xs:enumeration value="BINARY"/>
187 <xs:enumeration value="LOGO"/>
188 <xs:enumeration value="CUSTOM_BUILD"/>
191 <xs:simpleType name="FrameworkModuleTypes">
192 <xs:restriction base="ModuleTypeDef">
193 <xs:enumeration value="BASE"/>
194 <xs:enumeration value="SEC"/>
195 <xs:enumeration value="PEI_CORE"/>
196 <xs:enumeration value="PEIM"/>
197 <xs:enumeration value="DXE_CORE"/>
198 <xs:enumeration value="DXE_DRIVER"/>
199 <xs:enumeration value="DXE_RUNTIME_DRIVER"/>
200 <xs:enumeration value="DXE_SAL_DRIVER"/>
201 <xs:enumeration value="DXE_SMM_DRIVER"/>
202 <xs:enumeration value="UEFI_DRIVER"/>
203 <xs:enumeration value="UEFI_APPLICATION"/>
204 <xs:enumeration value="USER_DEFINED"/>
207 <xs:simpleType name="FvRegionTypes">
208 <xs:restriction base="UCNameType">
209 <xs:enumeration value="FV_MAIN"/>
210 <xs:enumeration value="FV_MAIN_COMPACT"/>
211 <xs:enumeration value="NV_STORAGE"/>
212 <xs:enumeration value="FV_RECOVERY"/>
213 <xs:enumeration value="FV_RECOVERY_FLOPPY"/>
214 <xs:enumeration value="FV_FILE"/>
215 <xs:enumeration value="CAPSULE_CARGO"/>
216 <xs:enumeration value="NULL"/>
217 <xs:enumeration value="USER_DEFINED"/>
220 <xs:simpleType name="GuidTypes">
221 <xs:restriction base="UCNameType">
222 <xs:enumeration value="DATA_HUB_RECORD"/>
223 <xs:enumeration value="EFI_EVENT"/>
224 <xs:enumeration value="EFI_SYSTEM_CONFIGURATION_TABLE"/>
225 <xs:enumeration value="EFI_VARIABLE"/>
226 <xs:enumeration value="HII_PACKAGE_LIST"/>
227 <xs:enumeration value="HOB"/>
230 <xs:simpleType name="GuidListType">
231 <xs:list itemType="GuidTypes"/>
233 <xs:simpleType name="GuidUsage">
234 <xs:restriction base="NameConvention">
235 <xs:enumeration value="ALWAYS_CONSUMED"/>
236 <xs:enumeration value="SOMETIMES_CONSUMED"/>
237 <xs:enumeration value="ALWAYS_PRODUCED"/>
238 <xs:enumeration value="SOMETIMES_PRODUCED"/>
239 <xs:enumeration value="DEFAULT"/>
240 <xs:enumeration value="PRIVATE"/>
243 <xs:simpleType name="HexWordArrayType">
244 <xs:restriction base="xs:normalizedString">
245 <xs:pattern value="((( )?0x[a-fA-F0-9]{4})(,)?)+( )?"/>
248 <xs:simpleType name="HiiPackageUsage">
249 <xs:restriction base="NameConvention">
250 <xs:enumeration value="ALWAYS_PRODUCED"/>
251 <xs:enumeration value="SOMETIMES_PRODUCED"/>
252 <xs:enumeration value="PRIVATE"/>
255 <xs:simpleType name="HobTypes">
256 <xs:restriction base="NameConvention">
257 <xs:enumeration value="PHIT"/>
258 <xs:enumeration value="MEMORY_ALLOCATION"/>
259 <xs:enumeration value="RESOURCE_DESCRIPTOR"/>
260 <xs:enumeration value="GUID_EXTENSION"/>
261 <xs:enumeration value="FIRMWARE_VOLUME"/>
262 <xs:enumeration value="CPU"/>
263 <xs:enumeration value="POOL"/>
264 <xs:enumeration value="CAPSULE_VOLUME"/>
267 <xs:simpleType name="HobUsage">
268 <xs:restriction base="NameConvention">
269 <xs:enumeration value="ALWAYS_CONSUMED"/>
270 <xs:enumeration value="SOMETIMES_CONSUMED"/>
271 <xs:enumeration value="ALWAYS_PRODUCED"/>
272 <xs:enumeration value="SOMETIMES_PRODUCED"/>
273 <xs:enumeration value="PRIVATE"/>
276 <xs:simpleType name="IntList">
277 <xs:list itemType="xs:positiveInteger"/>
279 <xs:simpleType name="LibraryUsage">
280 <xs:restriction base="NameConvention">
281 <xs:enumeration value="ALWAYS_CONSUMED"/>
282 <xs:enumeration value="SOMETIMES_CONSUMED"/>
283 <xs:enumeration value="ALWAYS_PRODUCED"/>
284 <xs:enumeration value="SOMETIMES_PRODUCED"/>
285 <xs:enumeration value="DEFAULT"/>
286 <xs:enumeration value="PRIVATE"/>
289 <xs:simpleType name="ModuleTypeDef">
290 <xs:restriction base="NameConvention">
291 <xs:enumeration value="BASE"/>
292 <xs:enumeration value="SEC"/>
293 <xs:enumeration value="PEI_CORE"/>
294 <xs:enumeration value="PEIM"/>
295 <xs:enumeration value="DXE_CORE"/>
296 <xs:enumeration value="DXE_DRIVER"/>
297 <xs:enumeration value="DXE_RUNTIME_DRIVER"/>
298 <xs:enumeration value="DXE_SAL_DRIVER"/>
299 <xs:enumeration value="DXE_SMM_DRIVER"/>
300 <xs:enumeration value="TOOLS"/>
301 <xs:enumeration value="UEFI_DRIVER"/>
302 <xs:enumeration value="UEFI_APPLICATION"/>
303 <xs:enumeration value="USER_DEFINED"/>
306 <xs:simpleType name="ModuleTypeList">
307 <xs:list itemType="FrameworkModuleTypes"/>
309 <xs:simpleType name="Module_Unified">
310 <xs:restriction base="UCNameType">
311 <xs:enumeration value="MODULE"/>
312 <xs:enumeration value="UNIFIED"/>
315 <xs:simpleType name="PackageType">
316 <xs:restriction base="UCNameType">
317 <xs:enumeration value="SOURCE"/>
318 <xs:enumeration value="BINARY"/>
319 <xs:enumeration value="MIXED"/>
322 <xs:simpleType name="PackageUsage">
323 <xs:restriction base="NameConvention">
324 <xs:enumeration value="ALWAYS_CONSUMED"/>
325 <xs:enumeration value="ALWAYS_PRODUCED"/>
326 <xs:enumeration value="DEFAULT"/>
329 <xs:simpleType name="PcdListType">
330 <xs:list itemType="PcdItemTypes"/>
332 <xs:simpleType name="PcdTypes">
333 <xs:restriction base="NameConvention">
334 <xs:enumeration value="FIXED_AT_BUILD"/>
335 <xs:enumeration value="FEATURE_FLAG"/>
336 <xs:enumeration value="PATCHABLE_IN_MODULE"/>
337 <xs:enumeration value="DYNAMIC"/>
338 <xs:enumeration value="DYNAMIC_EX"/>
341 <xs:simpleType name="PcdDriverTypes">
342 <xs:restriction base="NameConvention">
343 <xs:enumeration value="PEI_PCD_DRIVER"/>
344 <xs:enumeration value="DXE_PCD_DRIVER"/>
347 <xs:simpleType name="PcdDataTypes">
348 <xs:restriction base="xs:normalizedString">
349 <xs:enumeration value="UINT8"/>
350 <xs:enumeration value="UINT16"/>
351 <xs:enumeration value="UINT32"/>
352 <xs:enumeration value="UINT64"/>
353 <xs:enumeration value="VOID*"/>
354 <xs:enumeration value="BOOLEAN"/>
357 <xs:simpleType name="PcdFeatureFlagUsage">
358 <xs:restriction base="UsageTypes">
359 <xs:enumeration value="ALWAYS_PRODUCED"/>
360 <xs:enumeration value="DEFAULT"/>
363 <xs:simpleType name="PcdItemTypes">
364 <xs:restriction base="NameConvention">
365 <xs:enumeration value="FEATURE_FLAG"/>
366 <xs:enumeration value="FIXED_AT_BUILD"/>
367 <xs:enumeration value="PATCHABLE_IN_MODULE"/>
368 <xs:enumeration value="DYNAMIC"/>
369 <xs:enumeration value="DYNAMIC_EX"/>
372 <xs:simpleType name="PcdUsage">
373 <xs:restriction base="NameConvention">
374 <xs:enumeration value="ALWAYS_CONSUMED"/>
375 <xs:enumeration value="SOMETIMES_CONSUMED"/>
376 <xs:enumeration value="ALWAYS_PRODUCED"/>
377 <xs:enumeration value="SOMETIMES_PRODUCED"/>
378 <xs:enumeration value="DEFAULT"/>
381 <xs:simpleType name="PpiNotifyUsage">
382 <xs:restriction base="NameConvention">
383 <xs:enumeration value="SOMETIMES_CONSUMED"/>
386 <xs:simpleType name="PpiUsage">
387 <xs:restriction base="NameConvention">
388 <xs:enumeration value="ALWAYS_CONSUMED"/>
389 <xs:enumeration value="SOMETIMES_CONSUMED"/>
390 <xs:enumeration value="ALWAYS_PRODUCED"/>
391 <xs:enumeration value="SOMETIMES_PRODUCED"/>
392 <xs:enumeration value="PRIVATE"/>
395 <xs:simpleType name="ProtocolNotifyUsage">
396 <xs:restriction base="NameConvention">
397 <xs:enumeration value="SOMETIMES_CONSUMED"/>
400 <xs:simpleType name="ProtocolUsage">
401 <xs:restriction base="NameConvention">
402 <xs:enumeration value="ALWAYS_CONSUMED"/>
403 <xs:enumeration value="SOMETIMES_CONSUMED"/>
404 <xs:enumeration value="ALWAYS_PRODUCED"/>
405 <xs:enumeration value="SOMETIMES_PRODUCED"/>
406 <xs:enumeration value="TO_START"/>
407 <xs:enumeration value="BY_START"/>
408 <xs:enumeration value="PRIVATE"/>
411 <xs:simpleType name="SkuListType">
412 <xs:list itemType="HexByteDataType"/>
414 <xs:simpleType name="SupportedArchitectures">
415 <xs:restriction base="NameConvention">
416 <xs:enumeration value="ALL"/>
417 <xs:enumeration value="EBC"/>
418 <xs:enumeration value="ARM"/>
419 <xs:enumeration value="IA32"/>
420 <xs:enumeration value="X64"/>
421 <xs:enumeration value="IPF"/>
422 <xs:enumeration value="PPC"/>
425 <xs:simpleType name="SystemTableUsage">
426 <xs:restriction base="NameConvention">
427 <xs:enumeration value="ALWAYS_CONSUMED"/>
428 <xs:enumeration value="SOMETIMES_CONSUMED"/>
429 <xs:enumeration value="ALWAYS_PRODUCED"/>
430 <xs:enumeration value="SOMETIMES_PRODUCED"/>
431 <xs:enumeration value="PRIVATE"/>
434 <xs:simpleType name="Token">
435 <xs:union memberTypes="GuidArrayType GuidNamingConvention HexDoubleWordDataType"/>
437 <!-- TokenDataType is xs:nonNegativeInteger in final -->
438 <xs:simpleType name="TokenDataType">
439 <xs:union memberTypes="HexDoubleWordDataType xs:nonNegativeInteger"/>
441 <xs:simpleType name="ToolChains">
442 <xs:restriction base="UCNameType">
443 <xs:enumeration value="MSFT"/>
444 <xs:enumeration value="INTEL"/>
445 <xs:enumeration value="GCC"/>
446 <xs:enumeration value="CYGWIN"/>
449 <xs:simpleType name="ToothPick">
450 <xs:restriction base="xs:normalizedString">
451 <xs:enumeration value="UNIX"/>
452 <xs:enumeration value="WINDOWS"/>
455 <xs:simpleType name="UiNameType">
456 <xs:restriction base="xs:string">
457 <xs:pattern value="(([a-zA-Z][a-zA-Z0-9]*)(_)*(.)*)+"/>
460 <xs:simpleType name="UnicodeString">
461 <xs:restriction base="xs:normalizedString">
462 <xs:pattern value="L(:)?(")(\w+)*((\W*)*(\s*)*(\w*)*)*(")"/>
465 <xs:simpleType name="VariableNameDataType">
466 <xs:list itemType="HexWordArrayType"/>
468 <xs:simpleType name="UsageTypes">
469 <xs:restriction base="NameConvention">
470 <xs:enumeration value="ALWAYS_CONSUMED"/>
471 <xs:enumeration value="SOMETIMES_CONSUMED"/>
472 <xs:enumeration value="ALWAYS_PRODUCED"/>
473 <xs:enumeration value="SOMETIMES_PRODUCED"/>
474 <xs:enumeration value="TO_START"/>
475 <xs:enumeration value="BY_START"/>
476 <xs:enumeration value="PRIVATE"/>
477 <xs:enumeration value="DEFAULT"/>
480 <xs:simpleType name="VariableOffsetValues">
481 <xs:restriction base="xs:string">
482 <xs:pattern value="\d+(:)?\d*"/>
485 <xs:simpleType name="VariableUsage">
486 <xs:restriction base="NameConvention">
487 <xs:enumeration value="ALWAYS_CONSUMED"/>
488 <xs:enumeration value="SOMETIMES_CONSUMED"/>
489 <xs:enumeration value="ALWAYS_PRODUCED"/>
490 <xs:enumeration value="SOMETIMES_PRODUCED"/>
491 <xs:enumeration value="PRIVATE"/>
494 <!-- Complex Data Types -->
495 <xs:complexType name="ArgsType">
496 <xs:sequence minOccurs="0" maxOccurs="unbounded">
497 <xs:element name="Arg" type="xs:string"/>
500 <xs:complexType name="ToolType">
502 <xs:element name="ToolName" type="xs:string"/>
503 <xs:element name="ToolArgs" type="xs:string"/>