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="ModuleListType">
51 <xs:list itemType="FrameworkModuleTypes"/>
53 <xs:simpleType name="IntermediateOutputType">
54 <xs:restriction base="UCNameType">
55 <xs:enumeration value="MODULE"/>
56 <xs:enumeration value="UNIFIED"/>
59 <xs:simpleType name="BuildTargets">
60 <xs:restriction base="xs:NCName">
61 <xs:enumeration value="DEBUG"/>
62 <xs:enumeration value="RELEASE"/>
63 <xs:enumeration value="BOTH"/>
66 <xs:simpleType name="BuildTargetList">
67 <xs:union memberTypes="UCNameType DEBUG RELEASE"/>
69 <xs:simpleType name="DEBUG">
70 <xs:restriction base="UCNameType">
71 <xs:pattern value="DEBUG"/>
74 <xs:simpleType name="RELEASE">
75 <xs:restriction base="UCNameType">
76 <xs:pattern value="RELEASE"/>
79 <xs:simpleType name="ComponentExecutionPhase">
80 <xs:restriction base="UCNameType">
81 <xs:enumeration value="MDE"/>
82 <xs:enumeration value="SEC"/>
83 <xs:enumeration value="PEI_CORE"/>
84 <xs:enumeration value="PEIM"/>
85 <xs:enumeration value="DXE_CORE"/>
86 <xs:enumeration value="DXE_DRIVER"/>
87 <xs:enumeration value="DXE_RUNTIME_DRIVER"/>
88 <xs:enumeration value="DXE_SAL_DRIVER"/>
89 <xs:enumeration value="DXE_SMM_DRIVER"/>
90 <xs:enumeration value="UEFI"/>
91 <xs:enumeration value="UEFI_APPLICATION"/>
94 <xs:simpleType name="ConditionalTarget">
95 <xs:list itemType="C_Name"/>
97 <xs:simpleType name="DataHubUsage">
98 <xs:restriction base="NameConvention">
99 <xs:enumeration value="ALWAYS_CONSUMED"/>
100 <xs:enumeration value="SOMETIMES_CONSUMED"/>
101 <xs:enumeration value="ALWAYS_PRODUCED"/>
102 <xs:enumeration value="SOMETIMES_PRODUCED"/>
103 <xs:enumeration value="PRIVATE"/>
106 <xs:simpleType name="DateType">
107 <xs:restriction base="xs:normalizedString">
108 <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]"/>
111 <xs:simpleType name="DatumSizeLimitation">
112 <xs:restriction base="xs:int">
113 <xs:minInclusive value="1"/>
114 <xs:maxInclusive value="16777215"/>
117 <xs:simpleType name="DefaultValue">
118 <xs:union memberTypes="xs:normalizedString xs:int UnicodeString"/>
120 <xs:simpleType name="EfiSectionType">
121 <xs:restriction base="UCNameType">
122 <xs:enumeration value="EFI_SECTION_FREEFORM_SUBTYPE_GUID"/>
123 <xs:enumeration value="EFI_SECTION_VERSION"/>
124 <xs:enumeration value="EFI_SECTION_USER_INTERFACE"/>
125 <xs:enumeration value="EFI_SECTION_DXE_DEPEX"/>
126 <xs:enumeration value="EFI_SECTION_PEI_DEPEX"/>
127 <xs:enumeration value="EFI_SECTION_PE32"/>
128 <xs:enumeration value="EFI_SECTION_PIC"/>
129 <xs:enumeration value="EFI_SECTION_TE"/>
130 <xs:enumeration value="EFI_SECTION_RAW"/>
131 <xs:enumeration value="EFI_SECTION_COMPRESSION"/>
132 <xs:enumeration value="EFI_SECTION_GUID_DEFINED"/>
133 <xs:enumeration value="EFI_SECTION_COMPATIBILITY16"/>
134 <xs:enumeration value="EFI_SECTION_FIRMWARE_VOLUME_IMAGE"/>
137 <xs:simpleType name="EventTypes">
138 <xs:restriction base="NameConvention">
139 <xs:enumeration value="EVENT_GROUP_EXIT_BOOT_SERVICES"/>
140 <xs:enumeration value="EVENT_GROUP_VIRTUAL_ADDRESS_CHANGE"/>
141 <xs:enumeration value="EVENT_GROUP_MEMORY_MAP_CHANGE"/>
142 <xs:enumeration value="EVENT_GROUP_READY_TO_BOOT"/>
143 <xs:enumeration value="EVENT_GROUP_LEGACY_BOOT"/>
146 <xs:simpleType name="EventUsage">
147 <xs:restriction base="NameConvention">
148 <xs:enumeration value="ALWAYS_CONSUMED"/>
149 <xs:enumeration value="SOMETIMES_CONSUMED"/>
150 <xs:enumeration value="ALWAYS_PRODUCED"/>
151 <xs:enumeration value="SOMETIMES_PRODUCED"/>
152 <xs:enumeration value="PRIVATE"/>
155 <xs:simpleType name="ExecutionType">
156 <xs:restriction base="UCNameType">
157 <xs:enumeration value="REL" id="Relocatable"/>
158 <xs:enumeration value="NREL" id="Non-Relocatable"/>
159 <xs:enumeration value="XIP" id="Execute_In_Place"/>
160 <xs:enumeration value="PIC" id="Position_Independent_Code"/>
163 <xs:simpleType name="ExternType">
164 <xs:restriction base="xs:string">
165 <xs:pattern value="(_*\w*\W*)*"/>
168 <xs:simpleType name="ExternUsage">
169 <xs:restriction base="NameConvention">
170 <xs:enumeration value="ALWAYS_CONSUMED"/>
171 <xs:enumeration value="ALWAYS_PRODUCED"/>
174 <xs:simpleType name="FileNameUsage">
175 <xs:restriction base="NameConvention">
176 <xs:enumeration value="ALWAYS_CONSUMED"/>
177 <xs:enumeration value="SOMETIMES_CONSUMED"/>
178 <xs:enumeration value="ALWAYS_PRODUCED"/>
179 <xs:enumeration value="SOMETIMES_PRODUCED"/>
180 <xs:enumeration value="PRIVATE"/>
183 <xs:simpleType name="FormSetUsage">
184 <xs:restriction base="NameConvention">
185 <xs:enumeration value="ALWAYS_PRODUCED"/>
186 <xs:enumeration value="SOMETIMES_PRODUCED"/>
187 <xs:enumeration value="PRIVATE"/>
190 <xs:simpleType name="FrameworkComponentTypes">
191 <xs:restriction base="UCNameType">
192 <xs:enumeration value="APRIORI"/>
193 <xs:enumeration value="SEC"/>
194 <xs:enumeration value="LIBRARY"/>
195 <xs:enumeration value="FV_IMAGE_FILE"/>
196 <xs:enumeration value="BS_DRIVER"/>
197 <xs:enumeration value="RT_DRIVER"/>
198 <xs:enumeration value="SAL_RT_DRIVER"/>
199 <xs:enumeration value="PE32_PEIM"/>
200 <xs:enumeration value="PIC_PEIM"/>
201 <xs:enumeration value="COMBINED_PEIM_DRIVER"/>
202 <xs:enumeration value="PEI_CORE"/>
203 <xs:enumeration value="DXE_CORE"/>
204 <xs:enumeration value="APPLICATION"/>
205 <xs:enumeration value="BS_DRIVER_EFI"/>
206 <xs:enumeration value="SHELLAPP"/>
207 <xs:enumeration value="UEFI_APPLICATION"/>
208 <xs:enumeration value="BINARY"/>
209 <xs:enumeration value="LOGO"/>
210 <xs:enumeration value="CUSTOM_BUILD"/>
213 <xs:simpleType name="FrameworkModuleTypes">
214 <xs:restriction base="ModuleTypeDef">
215 <xs:enumeration value="BASE"/>
216 <xs:enumeration value="SEC"/>
217 <xs:enumeration value="PEI_CORE"/>
218 <xs:enumeration value="PEIM"/>
219 <xs:enumeration value="DXE_CORE"/>
220 <xs:enumeration value="DXE_DRIVER"/>
221 <xs:enumeration value="DXE_RUNTIME_DRIVER"/>
222 <xs:enumeration value="DXE_SAL_DRIVER"/>
223 <xs:enumeration value="DXE_SMM_DRIVER"/>
224 <xs:enumeration value="UEFI_DRIVER"/>
225 <xs:enumeration value="UEFI_APPLICATION"/>
226 <xs:enumeration value="USER_DEFINED"/>
229 <xs:simpleType name="FvRegionTypes">
230 <xs:restriction base="UCNameType">
231 <xs:enumeration value="FV_MAIN"/>
232 <xs:enumeration value="FV_MAIN_COMPACT"/>
233 <xs:enumeration value="NV_STORAGE"/>
234 <xs:enumeration value="FV_RECOVERY"/>
235 <xs:enumeration value="FV_RECOVERY_FLOPPY"/>
236 <xs:enumeration value="FV_FILE"/>
237 <xs:enumeration value="CAPSULE_CARGO"/>
238 <xs:enumeration value="NULL"/>
239 <xs:enumeration value="USER_DEFINED"/>
242 <xs:simpleType name="GuidTypes">
243 <xs:restriction base="UCNameType">
244 <xs:enumeration value="DATA_HUB_RECORD"/>
245 <xs:enumeration value="EFI_EVENT"/>
246 <xs:enumeration value="EFI_SYSTEM_CONFIGURATION_TABLE"/>
247 <xs:enumeration value="EFI_VARIABLE"/>
248 <xs:enumeration value="HII_PACKAGE_LIST"/>
249 <xs:enumeration value="HOB"/>
252 <xs:simpleType name="GuidListType">
253 <xs:list itemType="GuidTypes"/>
255 <xs:simpleType name="GuidUsage">
256 <xs:restriction base="NameConvention">
257 <xs:enumeration value="ALWAYS_CONSUMED"/>
258 <xs:enumeration value="SOMETIMES_CONSUMED"/>
259 <xs:enumeration value="ALWAYS_PRODUCED"/>
260 <xs:enumeration value="SOMETIMES_PRODUCED"/>
261 <xs:enumeration value="DEFAULT"/>
262 <xs:enumeration value="PRIVATE"/>
265 <xs:simpleType name="HexWordArrayType">
266 <xs:restriction base="xs:normalizedString">
267 <xs:pattern value="((( )?0x[a-fA-F0-9]{4})(,)?)+( )?"/>
270 <xs:simpleType name="HiiPackageUsage">
271 <xs:restriction base="NameConvention">
272 <xs:enumeration value="ALWAYS_PRODUCED"/>
273 <xs:enumeration value="SOMETIMES_PRODUCED"/>
274 <xs:enumeration value="PRIVATE"/>
277 <xs:simpleType name="HobTypes">
278 <xs:restriction base="NameConvention">
279 <xs:enumeration value="PHIT"/>
280 <xs:enumeration value="MEMORY_ALLOCATION"/>
281 <xs:enumeration value="RESOURCE_DESCRIPTOR"/>
282 <xs:enumeration value="GUID_EXTENSION"/>
283 <xs:enumeration value="FIRMWARE_VOLUME"/>
284 <xs:enumeration value="CPU"/>
285 <xs:enumeration value="POOL"/>
286 <xs:enumeration value="CAPSULE_VOLUME"/>
289 <xs:simpleType name="HobUsage">
290 <xs:restriction base="NameConvention">
291 <xs:enumeration value="ALWAYS_CONSUMED"/>
292 <xs:enumeration value="SOMETIMES_CONSUMED"/>
293 <xs:enumeration value="ALWAYS_PRODUCED"/>
294 <xs:enumeration value="SOMETIMES_PRODUCED"/>
295 <xs:enumeration value="PRIVATE"/>
298 <xs:simpleType name="IntList">
299 <xs:list itemType="xs:positiveInteger"/>
301 <xs:simpleType name="LibraryUsage">
302 <xs:restriction base="NameConvention">
303 <xs:enumeration value="ALWAYS_CONSUMED"/>
304 <xs:enumeration value="SOMETIMES_CONSUMED"/>
305 <xs:enumeration value="ALWAYS_PRODUCED"/>
306 <xs:enumeration value="SOMETIMES_PRODUCED"/>
307 <xs:enumeration value="DEFAULT"/>
308 <xs:enumeration value="PRIVATE"/>
311 <xs:simpleType name="ModuleTypeDef">
312 <xs:restriction base="NameConvention">
313 <xs:enumeration value="BASE"/>
314 <xs:enumeration value="SEC"/>
315 <xs:enumeration value="PEI_CORE"/>
316 <xs:enumeration value="PEIM"/>
317 <xs:enumeration value="DXE_CORE"/>
318 <xs:enumeration value="DXE_DRIVER"/>
319 <xs:enumeration value="DXE_RUNTIME_DRIVER"/>
320 <xs:enumeration value="DXE_SAL_DRIVER"/>
321 <xs:enumeration value="DXE_SMM_DRIVER"/>
322 <xs:enumeration value="TOOLS"/>
323 <xs:enumeration value="UEFI_DRIVER"/>
324 <xs:enumeration value="UEFI_APPLICATION"/>
325 <xs:enumeration value="USER_DEFINED"/>
328 <xs:simpleType name="ModuleTypeList">
329 <xs:list itemType="FrameworkModuleTypes"/>
331 <xs:simpleType name="Module_Unified">
332 <xs:restriction base="UCNameType">
333 <xs:enumeration value="MODULE"/>
334 <xs:enumeration value="UNIFIED"/>
337 <xs:simpleType name="PackageType">
338 <xs:restriction base="UCNameType">
339 <xs:enumeration value="SOURCE"/>
340 <xs:enumeration value="BINARY"/>
341 <xs:enumeration value="MIXED"/>
344 <xs:simpleType name="PackageUsage">
345 <xs:restriction base="NameConvention">
346 <xs:enumeration value="ALWAYS_CONSUMED"/>
347 <xs:enumeration value="ALWAYS_PRODUCED"/>
348 <xs:enumeration value="DEFAULT"/>
351 <xs:simpleType name="PcdListType">
352 <xs:list itemType="PcdItemTypes"/>
354 <xs:simpleType name="PcdTypes">
355 <xs:restriction base="NameConvention">
356 <xs:enumeration value="FIXED_AT_BUILD"/>
357 <xs:enumeration value="FEATURE_FLAG"/>
358 <xs:enumeration value="PATCHABLE_IN_MODULE"/>
359 <xs:enumeration value="DYNAMIC"/>
360 <xs:enumeration value="DYNAMIC_EX"/>
363 <xs:simpleType name="PcdDriverTypes">
364 <xs:restriction base="NameConvention">
365 <xs:enumeration value="PEI_PCD_DRIVER"/>
366 <xs:enumeration value="DXE_PCD_DRIVER"/>
369 <xs:simpleType name="PcdDataTypes">
370 <xs:restriction base="xs:normalizedString">
371 <xs:enumeration value="UINT8"/>
372 <xs:enumeration value="UINT16"/>
373 <xs:enumeration value="UINT32"/>
374 <xs:enumeration value="UINT64"/>
375 <xs:enumeration value="VOID*"/>
376 <xs:enumeration value="BOOLEAN"/>
379 <xs:simpleType name="PcdFeatureFlagUsage">
380 <xs:restriction base="UsageTypes">
381 <xs:enumeration value="ALWAYS_PRODUCED"/>
382 <xs:enumeration value="DEFAULT"/>
385 <xs:simpleType name="PcdItemTypes">
386 <xs:restriction base="NameConvention">
387 <xs:enumeration value="FEATURE_FLAG"/>
388 <xs:enumeration value="FIXED_AT_BUILD"/>
389 <xs:enumeration value="PATCHABLE_IN_MODULE"/>
390 <xs:enumeration value="DYNAMIC"/>
391 <xs:enumeration value="DYNAMIC_EX"/>
394 <xs:simpleType name="PcdUsage">
395 <xs:restriction base="NameConvention">
396 <xs:enumeration value="ALWAYS_CONSUMED"/>
397 <xs:enumeration value="SOMETIMES_CONSUMED"/>
398 <xs:enumeration value="ALWAYS_PRODUCED"/>
399 <xs:enumeration value="SOMETIMES_PRODUCED"/>
400 <xs:enumeration value="DEFAULT"/>
403 <xs:simpleType name="PpiNotifyUsage">
404 <xs:restriction base="NameConvention">
405 <xs:enumeration value="SOMETIMES_CONSUMED"/>
408 <xs:simpleType name="PpiUsage">
409 <xs:restriction base="NameConvention">
410 <xs:enumeration value="ALWAYS_CONSUMED"/>
411 <xs:enumeration value="SOMETIMES_CONSUMED"/>
412 <xs:enumeration value="ALWAYS_PRODUCED"/>
413 <xs:enumeration value="SOMETIMES_PRODUCED"/>
414 <xs:enumeration value="PRIVATE"/>
417 <xs:simpleType name="ProtocolNotifyUsage">
418 <xs:restriction base="NameConvention">
419 <xs:enumeration value="SOMETIMES_CONSUMED"/>
422 <xs:simpleType name="ProtocolUsage">
423 <xs:restriction base="NameConvention">
424 <xs:enumeration value="ALWAYS_CONSUMED"/>
425 <xs:enumeration value="SOMETIMES_CONSUMED"/>
426 <xs:enumeration value="ALWAYS_PRODUCED"/>
427 <xs:enumeration value="SOMETIMES_PRODUCED"/>
428 <xs:enumeration value="TO_START"/>
429 <xs:enumeration value="BY_START"/>
430 <xs:enumeration value="PRIVATE"/>
433 <xs:simpleType name="SkuListType">
434 <xs:list itemType="HexByteDataType"/>
436 <xs:simpleType name="SupportedArchitectures">
437 <xs:restriction base="NameConvention">
438 <xs:enumeration value="ALL"/>
439 <xs:enumeration value="EBC"/>
440 <xs:enumeration value="ARM"/>
441 <xs:enumeration value="IA32"/>
442 <xs:enumeration value="X64"/>
443 <xs:enumeration value="IPF"/>
444 <xs:enumeration value="PPC"/>
447 <xs:simpleType name="SystemTableUsage">
448 <xs:restriction base="NameConvention">
449 <xs:enumeration value="ALWAYS_CONSUMED"/>
450 <xs:enumeration value="SOMETIMES_CONSUMED"/>
451 <xs:enumeration value="ALWAYS_PRODUCED"/>
452 <xs:enumeration value="SOMETIMES_PRODUCED"/>
453 <xs:enumeration value="PRIVATE"/>
456 <xs:simpleType name="Token">
457 <xs:union memberTypes="GuidArrayType GuidNamingConvention HexDoubleWordDataType"/>
459 <!-- TokenDataType is xs:nonNegativeInteger in final -->
460 <xs:simpleType name="TokenDataType">
461 <xs:union memberTypes="HexDoubleWordDataType xs:nonNegativeInteger"/>
463 <xs:simpleType name="ToolChains">
464 <xs:restriction base="UCNameType">
465 <xs:enumeration value="MSFT"/>
466 <xs:enumeration value="INTEL"/>
467 <xs:enumeration value="GCC"/>
468 <xs:enumeration value="CYGWIN"/>
471 <xs:simpleType name="ToothPick">
472 <xs:restriction base="xs:normalizedString">
473 <xs:enumeration value="UNIX"/>
474 <xs:enumeration value="WINDOWS"/>
477 <xs:simpleType name="UiNameType">
478 <xs:restriction base="xs:string">
479 <xs:pattern value="(([a-zA-Z][a-zA-Z0-9]*)(_)*(.)*)+"/>
482 <xs:simpleType name="UnicodeString">
483 <xs:restriction base="xs:normalizedString">
484 <xs:pattern value="L(:)?(")(\w+)*((\W*)*(\s*)*(\w*)*)*(")"/>
487 <xs:simpleType name="VariableNameDataType">
488 <xs:list itemType="HexWordArrayType"/>
490 <xs:simpleType name="UsageTypes">
491 <xs:restriction base="NameConvention">
492 <xs:enumeration value="ALWAYS_CONSUMED"/>
493 <xs:enumeration value="SOMETIMES_CONSUMED"/>
494 <xs:enumeration value="ALWAYS_PRODUCED"/>
495 <xs:enumeration value="SOMETIMES_PRODUCED"/>
496 <xs:enumeration value="TO_START"/>
497 <xs:enumeration value="BY_START"/>
498 <xs:enumeration value="PRIVATE"/>
499 <xs:enumeration value="DEFAULT"/>
502 <xs:simpleType name="VariableOffsetValues">
503 <xs:restriction base="xs:string">
504 <xs:pattern value="\d+(:)?\d*"/>
507 <xs:simpleType name="VariableUsage">
508 <xs:restriction base="NameConvention">
509 <xs:enumeration value="ALWAYS_CONSUMED"/>
510 <xs:enumeration value="SOMETIMES_CONSUMED"/>
511 <xs:enumeration value="ALWAYS_PRODUCED"/>
512 <xs:enumeration value="SOMETIMES_PRODUCED"/>
513 <xs:enumeration value="PRIVATE"/>
516 <!-- Complex Data Types -->
517 <xs:complexType name="ArgsType">
518 <xs:sequence minOccurs="0" maxOccurs="unbounded">
519 <xs:element name="Arg" type="xs:string"/>
522 <xs:complexType name="ToolType">
524 <xs:element name="ToolName" type="xs:string"/>
525 <xs:element name="ToolArgs" type="xs:string"/>
528 <xs:simpleType name="FfsNameType">
530 <xs:documentation xml:lang="en"> This defines what an FFS Name can consist of.</xs:documentation>
532 <xs:restriction base="xs:string">
533 <xs:pattern value="[a-zA-Z][_\-a-zA-Z0-9]*(.)?[a-zA-Z0-9]*"/>
536 <xs:simpleType name="FeatureFlagExpressionType">
537 <xs:restriction base="xs:normalizedString">
538 <xs:pattern value="(\w*\W*)*"/>