]>
Commit | Line | Data |
---|---|---|
f51461c8 LG |
1 | <?xml version="1.0" encoding="UTF-8"?>\r |
2 | <!--\r | |
3 | Filename: DistributionPackage.xsd\r | |
4 | \r | |
5 | Copyright (c) 2008 - 2012, Intel Corporation. All rights reserved.\r | |
6 | \r | |
7 | This program and the accompanying materials are licensed and made available \r | |
8 | under the terms and conditions of the BSD License which may be found at \r | |
9 | 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:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified"\r | |
16 | targetNamespace="http://www.uefi.org/2012/1.0" xmlns="http://www.uefi.org/2012/1.0">\r | |
17 | <xs:element name="DistributionPackage">\r | |
18 | <xs:annotation>\r | |
19 | <xs:documentation xml:lang="en-us"> This schema defines the UEFI/PI Distribution Package description (PKG)\r | |
20 | file. It describes the content of:</xs:documentation>\r | |
21 | <xs:documentation xml:lang="en-us"> 1) Package descriptions with definitions and headers.</xs:documentation>\r | |
22 | <xs:documentation xml:lang="en-us"> 2) Modules in either source or binary format. (Note that Binary format\r | |
23 | is for FFS leaf section file types only, complete FFS files cannot be distributed using this\r | |
24 | distribution format.) </xs:documentation>\r | |
25 | <xs:documentation xml:lang="en-us"> 3) The distribution of custom tools used to modify the binary images to\r | |
26 | create UEFI/PI compliant images. </xs:documentation>\r | |
27 | <xs:documentation xml:lang="en-us"> 4) Finally, it can be used to distribute other miscellaneous content\r | |
28 | that is not specific to UEFI/PI images. </xs:documentation>\r | |
29 | <xs:documentation xml:lang="en-us"> The Package Surface Area describes the content of packages, while the\r | |
30 | Module Surface Area provides information relevant to source and/or binary distributions.\r | |
31 | </xs:documentation>\r | |
32 | </xs:annotation>\r | |
33 | <xs:complexType>\r | |
34 | <xs:sequence>\r | |
35 | <xs:element ref="DistributionHeader" minOccurs="1" maxOccurs="1">\r | |
36 | <xs:annotation>\r | |
37 | <xs:documentation xml:lang="en-us"> This header contains (legal) information usually required\r | |
38 | for distributing both binary and/or source code. </xs:documentation>\r | |
39 | </xs:annotation>\r | |
40 | </xs:element>\r | |
41 | <xs:element ref="PackageSurfaceArea" minOccurs="0" maxOccurs="unbounded">\r | |
42 | <xs:annotation>\r | |
43 | <xs:documentation xml:lang="en-us"> The list of packages in this distribution. </xs:documentation>\r | |
44 | <xs:documentation xml:lang="en-us"> Packages are groups of files and/or modules that are similar\r | |
45 | in nature.</xs:documentation>\r | |
46 | <xs:documentation xml:lang="en-us"> Packages are uniquely identified by a package GUID and a\r | |
47 | package version. </xs:documentation>\r | |
48 | <xs:documentation xml:lang="en-us"> A package can declare public mappings of C names to GUID\r | |
49 | values. </xs:documentation>\r | |
50 | <xs:documentation xml:lang="en-us"> A package can provide header files for library classes\r | |
51 | and/or other industry standard definitions. </xs:documentation>\r | |
52 | <xs:documentation xml:lang="en-us"> A package can also declare public mappings of platform\r | |
53 | configuration database (PCD) "knobs" to control features and operation of modules\r | |
54 | within a platform. </xs:documentation>\r | |
55 | <xs:documentation xml:lang="en-us"> Finally, a package lists the library instances and/or\r | |
56 | modules that are provided in a distribution package. </xs:documentation>\r | |
57 | </xs:annotation>\r | |
58 | </xs:element>\r | |
59 | <xs:element ref="ModuleSurfaceArea" minOccurs="0" maxOccurs="unbounded">\r | |
60 | <xs:annotation>\r | |
61 | <xs:documentation xml:lang="en-us"> The listing of UEFI/PI compliant modules in this\r | |
62 | distribution that are NOT part of a Package. Every module that is provided as part of a\r | |
63 | package needs to be described in a PackageSurfaceArea.Modules section. </xs:documentation>\r | |
64 | <xs:documentation xml:lang="en-us"> The ModuleSurfaceArea section describes how each module in a\r | |
65 | distribution is coded, or, in the case of a binary module distribution, how it was built. </xs:documentation>\r | |
66 | <xs:documentation xml:lang="en-us"> UEFI/PI compliant libraries and modules are uniquely\r | |
67 | identified by the Module's GUID and version number. </xs:documentation>\r | |
68 | <xs:documentation xml:lang="en-us"> This section will typically be used for modules that don't\r | |
69 | require any additional files that would be included in a package. For example, the Enhanced\r | |
70 | FAT driver binary does not need to have a package description, as no additional files are\r | |
71 | provided. </xs:documentation>\r | |
72 | </xs:annotation>\r | |
73 | </xs:element>\r | |
74 | <xs:element ref="Tools" minOccurs="0" maxOccurs="unbounded">\r | |
75 | <xs:annotation>\r | |
76 | <xs:documentation xml:lang="en-us"> This section is for distributing vendor specific executable\r | |
77 | tools, tool source code and/or configuration files. These tools are primarily for\r | |
78 | manipulating code and/or binary images. </xs:documentation>\r | |
79 | <xs:documentation xml:lang="en-us"> Tools in this section can:</xs:documentation>\r | |
80 | <xs:documentation xml:lang="en-us"> 1) Parse build meta-data files to create source code files\r | |
81 | and build scripts. </xs:documentation>\r | |
82 | <xs:documentation xml:lang="en-us"> 2) Modify image files to conform to UEFI/PI specifications. </xs:documentation>\r | |
83 | <xs:documentation xml:lang="en-us"> 3) Generate binary files from certain types of text/unicode\r | |
84 | files. </xs:documentation>\r | |
85 | <xs:documentation xml:lang="en-us"> 4) Generate PCI Option Roms or Firmware Device images. </xs:documentation>\r | |
86 | <xs:documentation xml:lang="en-us"> 5) Implement external encoding/decoding/signature/GUIDed\r | |
87 | tools. </xs:documentation>\r | |
88 | <xs:documentation xml:lang="en-us"> 6) Distribution Package create/install/remove tools.\r | |
89 | </xs:documentation>\r | |
90 | </xs:annotation>\r | |
91 | </xs:element>\r | |
92 | <xs:element ref="MiscellaneousFiles" minOccurs="0" maxOccurs="unbounded">\r | |
93 | <xs:annotation>\r | |
94 | <xs:documentation xml:lang="en-us"> The list of miscellaneous files in this distribution. Any\r | |
95 | files that are not listed in either the Package, Module or Tools sections can be listed\r | |
96 | here. This section can be used to distribute specifications for packages and modules that\r | |
97 | are not "industry standards" such as a specification for a chipset or a video\r | |
98 | device. </xs:documentation>\r | |
99 | </xs:annotation>\r | |
100 | </xs:element>\r | |
101 | <xs:element ref="UserExtensions" minOccurs="0" maxOccurs="unbounded">\r | |
102 | <xs:annotation>\r | |
103 | <xs:documentation xml:lang="en-us"> The UserExtensions section is used to disseminate processing\r | |
104 | instructions that may be custom to the content provided by the distribution. This section\r | |
105 | contains information that is common to all aspects of this disribution. </xs:documentation>\r | |
106 | </xs:annotation>\r | |
107 | </xs:element>\r | |
108 | </xs:sequence>\r | |
109 | \r | |
110 | </xs:complexType>\r | |
111 | </xs:element>\r | |
112 | <!-- End of the DistributionPackage Description -->\r | |
113 | \r | |
114 | <xs:element name="DistributionHeader">\r | |
115 | <xs:annotation>\r | |
116 | <xs:documentation xml:lang="en-us"> This section defines the content of the UEIF/PI compliant Distribution\r | |
117 | Package Header. This is the only required element of a UEFI/PI compliant distribution package.\r | |
118 | </xs:documentation>\r | |
119 | </xs:annotation>\r | |
120 | <xs:complexType>\r | |
121 | <xs:sequence>\r | |
122 | <xs:element minOccurs="1" maxOccurs="1" name="Name">\r | |
123 | <xs:annotation>\r | |
124 | <xs:documentation xml:lang="en-us"> This is the User Interface Name for this Distribution\r | |
125 | Package. </xs:documentation>\r | |
126 | <xs:documentation xml:lang="en-us"> Each Distribution Package is uniquely identified by it's\r | |
127 | GUID and Version number. </xs:documentation>\r | |
128 | </xs:annotation>\r | |
129 | <xs:complexType>\r | |
130 | <xs:simpleContent>\r | |
131 | <xs:extension base="xs:normalizedString">\r | |
132 | <xs:attribute name="BaseName" type="xs:NMTOKEN" use="optional">\r | |
133 | <xs:annotation>\r | |
134 | <xs:documentation xml:lang="en-us"> The reference name of the Distribution\r | |
135 | Package file. This single word name can be used by tools as a keyword or for\r | |
136 | directory and/or file creation. </xs:documentation>\r | |
137 | <xs:documentation xml:lang="en-us"> White space and special characters (dash and\r | |
138 | underscore characters may be used) are not permitted in this name.\r | |
139 | </xs:documentation>\r | |
140 | </xs:annotation>\r | |
141 | </xs:attribute>\r | |
142 | </xs:extension>\r | |
143 | </xs:simpleContent>\r | |
144 | </xs:complexType>\r | |
145 | </xs:element>\r | |
146 | <xs:element minOccurs="1" maxOccurs="1" name="GUID">\r | |
147 | <xs:annotation>\r | |
148 | <xs:documentation xml:lang="en-us"> This 128-bit GUID and the Version attribute uniquely\r | |
149 | identify this Distribution Package. </xs:documentation>\r | |
150 | <xs:documentation xml:lang="en-us"> Backward compatible releases of a distribution package need\r | |
151 | only change the version number, while non-backward compatible changes require the GUID to\r | |
152 | change (resetting the version number to 1.0 is optional.) </xs:documentation>\r | |
153 | </xs:annotation>\r | |
154 | <xs:complexType>\r | |
155 | <xs:simpleContent>\r | |
156 | <xs:extension base="RegistryFormatGuid">\r | |
157 | <xs:attribute name="Version" type="xs:decimal" use="required">\r | |
158 | <xs:annotation>\r | |
159 | <xs:documentation xml:lang="en-us"> This value, along with the GUID, is used to\r | |
160 | uniquely identify this object. The higher the number, the more recent the\r | |
161 | content. </xs:documentation>\r | |
162 | </xs:annotation>\r | |
163 | </xs:attribute>\r | |
164 | </xs:extension>\r | |
165 | </xs:simpleContent>\r | |
166 | </xs:complexType>\r | |
167 | </xs:element>\r | |
168 | <xs:element minOccurs="1" maxOccurs="1" name="Vendor" type="xs:normalizedString">\r | |
169 | <xs:annotation>\r | |
170 | <xs:documentation xml:lang="en-us"> A string identifying who created this distribution package.\r | |
171 | </xs:documentation>\r | |
172 | </xs:annotation>\r | |
173 | </xs:element>\r | |
174 | <xs:element minOccurs="1" maxOccurs="1" name="Date" type="xs:dateTime">\r | |
175 | <xs:annotation>\r | |
176 | <xs:documentation xml:lang="en-us"> The date and time this distribution was created. The format\r | |
177 | is: YYYY-MM-DDThh:mm:ss, for example: 2001-01-31T13:30:00 (note the T character separator\r | |
178 | between the calendar date and the time. </xs:documentation>\r | |
179 | </xs:annotation>\r | |
180 | </xs:element>\r | |
181 | <xs:element minOccurs="1" maxOccurs="unbounded" name="Copyright">\r | |
182 | <xs:annotation>\r | |
183 | <xs:documentation xml:lang="en-us"> The copyright for this file that is generated by the creator\r | |
184 | of the distribution. If a derivative work is generated from an existing distribution, then\r | |
185 | the existing copyright must be maintained, and additional copyrights may be appended to the\r | |
186 | end of this element. It may also be the primary copyright for all code provided in the\r | |
187 | Distribution Package. </xs:documentation>\r | |
188 | </xs:annotation>\r | |
189 | <xs:complexType>\r | |
190 | <xs:simpleContent>\r | |
191 | <xs:extension base="xs:string">\r | |
192 | <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"/>\r | |
193 | </xs:extension>\r | |
194 | </xs:simpleContent>\r | |
195 | </xs:complexType>\r | |
196 | \r | |
197 | </xs:element>\r | |
198 | <xs:element minOccurs="1" maxOccurs="unbounded" name="License">\r | |
199 | <xs:annotation>\r | |
200 | <xs:documentation xml:lang="en-us"> A license that describes any restrictions on the use of this\r | |
201 | distribution. If a derivative work is allowed by the original license and a derivative work\r | |
202 | is generated from an existing distribution, then the existing license must be maintained,\r | |
203 | and additional licenses may be appended to the end of this element. It may also be the\r | |
204 | primary license for all code provided in the distribution file. Alternatively, this may\r | |
205 | point to a filename that contains the License. The file (included in the content zip file)\r | |
206 | will be stored in the same location as the distribution package's .pkg file.\r | |
207 | </xs:documentation>\r | |
208 | </xs:annotation>\r | |
209 | <xs:complexType>\r | |
210 | <xs:simpleContent>\r | |
211 | <xs:extension base="xs:string">\r | |
212 | <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"/>\r | |
213 | </xs:extension>\r | |
214 | </xs:simpleContent>\r | |
215 | </xs:complexType>\r | |
216 | </xs:element>\r | |
217 | <xs:element minOccurs="1" maxOccurs="unbounded" name="Abstract">\r | |
218 | <xs:annotation>\r | |
219 | <xs:documentation xml:lang="en-us"> A one line description of the Distribution Package.\r | |
220 | </xs:documentation>\r | |
221 | </xs:annotation>\r | |
222 | <xs:complexType>\r | |
223 | <xs:simpleContent>\r | |
224 | <xs:extension base="xs:normalizedString">\r | |
225 | <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"/>\r | |
226 | </xs:extension>\r | |
227 | </xs:simpleContent>\r | |
228 | </xs:complexType>\r | |
229 | </xs:element>\r | |
230 | <xs:element minOccurs="0" maxOccurs="unbounded" name="Description">\r | |
231 | <xs:annotation>\r | |
232 | <xs:documentation xml:lang="en-us"> A complete description of the Distribution Package. This\r | |
233 | description may include the release name of the file, the version of the file, and a\r | |
234 | complete description of the file contents and/or features including a description of the\r | |
235 | updates since the previous file release. </xs:documentation>\r | |
236 | </xs:annotation>\r | |
237 | <xs:complexType>\r | |
238 | <xs:simpleContent>\r | |
239 | <xs:extension base="xs:string">\r | |
240 | <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"/>\r | |
241 | </xs:extension>\r | |
242 | </xs:simpleContent>\r | |
243 | </xs:complexType>\r | |
244 | </xs:element>\r | |
245 | <xs:element minOccurs="0" maxOccurs="1" name="Signature" type="Md5Sum">\r | |
246 | <xs:annotation>\r | |
247 | <xs:documentation xml:lang="en-us"> The packaging utilities will use this MD5 sum value of the\r | |
248 | included ZIP file containing files and/or code. If this element is not present, then\r | |
249 | installation tools should assume that the content is correct, or that other methods may be\r | |
250 | needed to verify content. </xs:documentation>\r | |
251 | </xs:annotation>\r | |
252 | </xs:element>\r | |
253 | <xs:element minOccurs="1" maxOccurs="1" name="XmlSpecification" type="xs:decimal" default="1.1">\r | |
254 | <xs:annotation>\r | |
255 | <xs:documentation xml:lang="en-us"> This version of this XML Schema is 1.1 </xs:documentation>\r | |
256 | <xs:documentation xml:lang="en-us"> Changes to 1.1 from 1.0 </xs:documentation>\r | |
257 | <xs:documentation xml:lang="en-us"> #1 Updated to present date and new version which is\r | |
258 | important to reflect the present state of the matter</xs:documentation>\r | |
259 | <xs:documentation xml:lang="en-us"> #2 Added definition/enumeration of UNDEFIND type 2 is\r | |
260 | important since there is a large body of legacy code for which the GUID’s and other\r | |
261 | code/data objects were not decorated with their usage. This document will allow for\r | |
262 | importing today’s source artifacts and producing decorations using the ‘Undefined’ versus\r | |
263 | having an error</xs:documentation>\r | |
264 | <xs:documentation xml:lang="en-us">#3 Allow for inclusion of ARM and future architecture\r | |
265 | types</xs:documentation>\r | |
266 | </xs:annotation>\r | |
267 | </xs:element>\r | |
268 | </xs:sequence>\r | |
269 | <xs:attribute name="ReadOnly" type="xs:boolean" default="false" use="optional">\r | |
270 | <xs:annotation>\r | |
271 | <xs:documentation xml:lang="en-us"> If set to true, all content within this Distribution Package\r | |
272 | should NOT be modified. The default permits modification of all content. </xs:documentation>\r | |
273 | </xs:annotation>\r | |
274 | </xs:attribute>\r | |
275 | <xs:attribute name="RePackage" type="xs:boolean" default="false" use="optional">\r | |
276 | <xs:annotation>\r | |
277 | <xs:documentation xml:lang="en-us"> If set to true, then the content can be repackaged into another\r | |
278 | distribution package. The default prohibits repackaging the Distribution content.\r | |
279 | </xs:documentation>\r | |
280 | </xs:annotation>\r | |
281 | </xs:attribute>\r | |
282 | </xs:complexType>\r | |
283 | </xs:element>\r | |
284 | <!-- End of the DistributionHeader element. -->\r | |
285 | \r | |
286 | <xs:element name="PackageSurfaceArea">\r | |
287 | <xs:annotation>\r | |
288 | <xs:documentation xml:lang="en-us"> A package is a collection of related objects - Includes, Libraries and\r | |
289 | Modules. </xs:documentation>\r | |
290 | <xs:documentation xml:lang="en-us"> Each package is uniquely identified by it's GUID and Version number.\r | |
291 | Backward compatible releases of a package need only change the version number, while non-backward\r | |
292 | compatible changes require the GUID to change (resetting the version number to 1.0 is optional.)\r | |
293 | </xs:documentation>\r | |
294 | </xs:annotation>\r | |
295 | <xs:complexType>\r | |
296 | <xs:sequence>\r | |
297 | \r | |
298 | <xs:element minOccurs="1" maxOccurs="1" name="Header">\r | |
299 | <xs:complexType>\r | |
300 | <xs:sequence>\r | |
301 | <xs:element minOccurs="1" maxOccurs="1" name="Name">\r | |
302 | <xs:annotation>\r | |
303 | <xs:documentation xml:lang="en-us"> This is the User Interface Name for this\r | |
304 | package. </xs:documentation>\r | |
305 | </xs:annotation>\r | |
306 | <xs:complexType>\r | |
307 | <xs:simpleContent>\r | |
308 | <xs:extension base="xs:normalizedString">\r | |
309 | <xs:attribute name="BaseName" type="xs:NMTOKEN" use="required">\r | |
310 | <xs:annotation>\r | |
311 | <xs:documentation xml:lang="en-us"> This is a single word BaseName\r | |
312 | of the package. This BaseName can be used by tools as a keyword\r | |
313 | and for directory/file creation. </xs:documentation>\r | |
314 | </xs:annotation>\r | |
315 | </xs:attribute>\r | |
316 | </xs:extension>\r | |
317 | </xs:simpleContent>\r | |
318 | </xs:complexType>\r | |
319 | </xs:element>\r | |
320 | <xs:element minOccurs="1" maxOccurs="1" name="GUID">\r | |
321 | <xs:annotation>\r | |
322 | <xs:documentation xml:lang="en-us"> This GUID and the Version attribute uniquely\r | |
323 | identify a given package. </xs:documentation>\r | |
324 | </xs:annotation>\r | |
325 | <xs:complexType>\r | |
326 | <xs:simpleContent>\r | |
327 | <xs:extension base="RegistryFormatGuid">\r | |
328 | <xs:attribute name="Version" type="xs:decimal" use="required">\r | |
329 | <xs:annotation>\r | |
330 | <xs:documentation xml:lang="en-us"> This value, along with the GUID,\r | |
331 | is used to uniquely identify this object. </xs:documentation>\r | |
332 | <xs:documentation xml:lang="en-us"> Backward compatible changes must\r | |
333 | make sure this number is incremented from the most recent\r | |
334 | version. Non-backward compatible changes require a new GUID, and\r | |
335 | the version can be reset. </xs:documentation>\r | |
336 | </xs:annotation>\r | |
337 | </xs:attribute>\r | |
338 | </xs:extension>\r | |
339 | </xs:simpleContent>\r | |
340 | </xs:complexType>\r | |
341 | </xs:element>\r | |
342 | <xs:element minOccurs="0" maxOccurs="unbounded" name="Copyright">\r | |
343 | <xs:annotation>\r | |
344 | <xs:documentation xml:lang="en-us"> If the package requires a different copyright\r | |
345 | than the distribution package, this element can list one or more copyright\r | |
346 | lines. </xs:documentation>\r | |
347 | </xs:annotation>\r | |
348 | <xs:complexType>\r | |
349 | <xs:simpleContent>\r | |
350 | <xs:extension base="xs:string">\r | |
351 | <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"\r | |
352 | />\r | |
353 | </xs:extension>\r | |
354 | </xs:simpleContent>\r | |
355 | </xs:complexType>\r | |
356 | \r | |
357 | </xs:element>\r | |
358 | <xs:element minOccurs="0" maxOccurs="unbounded" name="License">\r | |
359 | <xs:annotation>\r | |
360 | <xs:documentation xml:lang="en-us"> If the package requires licenses that are\r | |
361 | different from the distribution package license, this element can contain one or\r | |
362 | more license text paragraphs (or license filenames.) </xs:documentation>\r | |
363 | </xs:annotation>\r | |
364 | <xs:complexType>\r | |
365 | <xs:simpleContent>\r | |
366 | <xs:extension base="xs:string">\r | |
367 | <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"\r | |
368 | />\r | |
369 | </xs:extension>\r | |
370 | </xs:simpleContent>\r | |
371 | </xs:complexType>\r | |
372 | \r | |
373 | </xs:element>\r | |
374 | <xs:element minOccurs="0" maxOccurs="unbounded" name="Abstract">\r | |
375 | <xs:annotation>\r | |
376 | <xs:documentation xml:lang="en-us"> A one line description of this package.\r | |
377 | </xs:documentation>\r | |
378 | </xs:annotation>\r | |
379 | <xs:complexType>\r | |
380 | <xs:simpleContent>\r | |
381 | <xs:extension base="xs:normalizedString">\r | |
382 | <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"\r | |
383 | />\r | |
384 | </xs:extension>\r | |
385 | </xs:simpleContent>\r | |
386 | </xs:complexType>\r | |
387 | </xs:element>\r | |
388 | <xs:element minOccurs="0" maxOccurs="unbounded" name="Description">\r | |
389 | <xs:annotation>\r | |
390 | <xs:documentation xml:lang="en-us"> A complete description of a package. This\r | |
391 | description may include the release name of the package, the version of the\r | |
392 | package, and a complete description of the package contents and/or features\r | |
393 | including a description of the updates since the previous package’s release.\r | |
394 | </xs:documentation>\r | |
395 | </xs:annotation>\r | |
396 | <xs:complexType>\r | |
397 | <xs:simpleContent>\r | |
398 | <xs:extension base="xs:string">\r | |
399 | <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"\r | |
400 | />\r | |
401 | </xs:extension>\r | |
402 | </xs:simpleContent>\r | |
403 | </xs:complexType>\r | |
404 | </xs:element>\r | |
405 | <xs:element minOccurs="1" maxOccurs="1" name="PackagePath" type="xs:anyURI">\r | |
406 | <xs:annotation>\r | |
407 | <xs:documentation xml:lang="en-us"> This element is the location (in the ZIP file)\r | |
408 | for the root directory of a package. </xs:documentation>\r | |
409 | </xs:annotation>\r | |
410 | </xs:element>\r | |
411 | </xs:sequence>\r | |
412 | </xs:complexType>\r | |
413 | </xs:element>\r | |
414 | <!-- End of PackageSurfaceArea Header element. -->\r | |
415 | \r | |
416 | <xs:element minOccurs="0" maxOccurs="1" name="ClonedFrom">\r | |
417 | <xs:annotation>\r | |
418 | <xs:documentation xml:lang="en-us"> The term cloned is used here to indicate that this package\r | |
419 | as been copied and modified to a completely different package. An example might be for a new\r | |
420 | generation of chipsets that have few or no elements in common with the original.\r | |
421 | </xs:documentation>\r | |
422 | </xs:annotation>\r | |
423 | <xs:complexType>\r | |
424 | <xs:sequence>\r | |
425 | <xs:element minOccurs="1" maxOccurs="1" name="GUID">\r | |
426 | <xs:annotation>\r | |
427 | <xs:documentation xml:lang="en-us"> This GUID and the Version attribute uniquely\r | |
428 | identify the Package that this Package was copied from. </xs:documentation>\r | |
429 | </xs:annotation>\r | |
430 | <xs:complexType>\r | |
431 | <xs:simpleContent>\r | |
432 | <xs:extension base="RegistryFormatGuid">\r | |
433 | <xs:attribute name="Version" type="xs:decimal" use="required">\r | |
434 | <xs:annotation>\r | |
435 | <xs:documentation xml:lang="en-us"> This value, along with the GUID,\r | |
436 | is used to uniquely identify the package that this package was\r | |
437 | cloned from. </xs:documentation>\r | |
438 | </xs:annotation>\r | |
439 | </xs:attribute>\r | |
440 | </xs:extension>\r | |
441 | </xs:simpleContent>\r | |
442 | </xs:complexType>\r | |
443 | </xs:element>\r | |
444 | </xs:sequence>\r | |
445 | </xs:complexType>\r | |
446 | </xs:element>\r | |
447 | <!-- End of PackageSurfaceArea ClonedFrom element. -->\r | |
448 | \r | |
449 | <xs:element minOccurs="0" maxOccurs="1" name="LibraryClassDeclarations">\r | |
450 | <xs:annotation>\r | |
451 | <xs:documentation xml:lang="en-us"> Library Classes are public interfaces that can be used by\r | |
452 | modules. One or more library instances can implement a library class, however only one\r | |
453 | library instance can be linked to an individual module. This provides the platform\r | |
454 | integrator with the flexibility of choosing one library instance's implementation over a\r | |
455 | different library instance. </xs:documentation>\r | |
456 | </xs:annotation>\r | |
457 | <xs:complexType>\r | |
458 | <xs:sequence>\r | |
459 | <xs:element minOccurs="1" maxOccurs="unbounded" name="LibraryClass">\r | |
460 | <xs:complexType>\r | |
461 | <xs:sequence>\r | |
462 | <xs:element minOccurs="1" maxOccurs="1" name="HeaderFile" type="xs:anyURI">\r | |
463 | <xs:annotation>\r | |
464 | <xs:documentation xml:lang="en-us"> The header file provides definitions\r | |
465 | and function prototypes for a library class. Modules can be coded\r | |
466 | against these functions, using the definitions in this header,\r | |
467 | without concerning themselves about the libraries' implementation\r | |
468 | details. This is a PackagePath relative path and filename for the\r | |
469 | include file. </xs:documentation>\r | |
470 | </xs:annotation>\r | |
471 | </xs:element>\r | |
472 | <xs:element minOccurs="0" maxOccurs="1" name="RecommendedInstance">\r | |
473 | <xs:complexType>\r | |
474 | <xs:sequence>\r | |
475 | <xs:element minOccurs="1" maxOccurs="1" name="GUID">\r | |
476 | <xs:annotation>\r | |
477 | <xs:documentation xml:lang="en-us"> This GUID and the\r | |
478 | Version attribute uniquely identify the Recommended Library\r | |
479 | Instance. </xs:documentation>\r | |
480 | </xs:annotation>\r | |
481 | <xs:complexType>\r | |
482 | <xs:simpleContent>\r | |
483 | <xs:extension base="RegistryFormatGuid">\r | |
484 | <xs:attribute name="Version" type="xs:decimal"\r | |
485 | use="optional">\r | |
486 | <xs:annotation>\r | |
487 | <xs:documentation xml:lang="en-us"> This value, along with\r | |
488 | the GUID, is used to uniquely identify this object. If this\r | |
489 | value is not specified, then any version of the library\r | |
490 | instance is recommended. </xs:documentation>\r | |
491 | </xs:annotation>\r | |
492 | </xs:attribute>\r | |
493 | </xs:extension>\r | |
494 | </xs:simpleContent>\r | |
495 | </xs:complexType>\r | |
496 | </xs:element>\r | |
497 | </xs:sequence>\r | |
498 | </xs:complexType>\r | |
499 | </xs:element>\r | |
500 | <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>\r | |
501 | </xs:sequence>\r | |
502 | <xs:attribute name="Keyword" type="xs:NCName" use="required">\r | |
503 | <xs:annotation>\r | |
504 | <xs:documentation xml:lang="en-us"> The single word name of the Library\r | |
505 | Class that module developers will use to identify a library class\r | |
506 | dependency. </xs:documentation>\r | |
507 | </xs:annotation>\r | |
508 | </xs:attribute>\r | |
509 | <xs:attributeGroup ref="SupportedArchMod"/>\r | |
510 | </xs:complexType>\r | |
511 | </xs:element>\r | |
512 | </xs:sequence>\r | |
513 | </xs:complexType>\r | |
514 | </xs:element>\r | |
515 | <!-- End of PackageSurfaceArea LibraryClassDeclarations element. -->\r | |
516 | \r | |
517 | <xs:element minOccurs="0" maxOccurs="1" name="IndustryStandardIncludes">\r | |
518 | <xs:annotation>\r | |
519 | <xs:documentation xml:lang="en-us"> This section is used to list header files for industry\r | |
520 | standards not under the auspices of UEFI.org. For example, headers that contain definitions\r | |
521 | and data structures for the USB specifications. </xs:documentation>\r | |
522 | </xs:annotation>\r | |
523 | <xs:complexType>\r | |
524 | <xs:sequence>\r | |
525 | <xs:element minOccurs="1" maxOccurs="unbounded" name="IndustryStandardHeader">\r | |
526 | <xs:complexType>\r | |
527 | <xs:sequence>\r | |
528 | <xs:element minOccurs="1" maxOccurs="1" name="HeaderFile" type="xs:anyURI">\r | |
529 | <xs:annotation>\r | |
530 | <xs:documentation xml:lang="en-us"> The package relative path and\r | |
531 | filename (in the content zip file) of the industry standard include\r | |
532 | file. </xs:documentation>\r | |
533 | </xs:annotation>\r | |
534 | </xs:element>\r | |
535 | <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>\r | |
536 | </xs:sequence>\r | |
537 | </xs:complexType>\r | |
538 | </xs:element>\r | |
539 | </xs:sequence>\r | |
540 | </xs:complexType>\r | |
541 | </xs:element>\r | |
542 | <!-- End of PackageSurfaceArea IndustryStdIncludes element. -->\r | |
543 | \r | |
544 | <xs:element minOccurs="0" maxOccurs="1" name="PackageIncludes">\r | |
545 | <xs:annotation>\r | |
546 | <xs:documentation xml:lang="en-us"> All top level header files that are included by a package\r | |
547 | that are not listed above. They cannot be:</xs:documentation>\r | |
548 | <xs:documentation xml:lang="en-us"> 1) Local to a module (module specific.) </xs:documentation>\r | |
549 | <xs:documentation xml:lang="en-us"> 2) An industry standard header. </xs:documentation>\r | |
550 | <xs:documentation xml:lang="en-us"> 3) A library class header. </xs:documentation>\r | |
551 | </xs:annotation>\r | |
552 | <xs:complexType>\r | |
553 | <xs:sequence>\r | |
554 | <xs:element minOccurs="1" maxOccurs="unbounded" name="PackageHeader">\r | |
555 | <xs:complexType>\r | |
556 | <xs:sequence>\r | |
557 | <xs:element minOccurs="1" maxOccurs="1" name="HeaderFile">\r | |
558 | <xs:annotation>\r | |
559 | <xs:documentation xml:lang="en-us"> This is the Package relative path\r | |
560 | and filename location within the content ZIP file.\r | |
561 | </xs:documentation>\r | |
562 | </xs:annotation>\r | |
563 | <xs:complexType>\r | |
564 | <xs:simpleContent>\r | |
565 | <xs:extension base="xs:anyURI">\r | |
566 | <xs:attributeGroup ref="SupportedArchMod"/>\r | |
567 | </xs:extension>\r | |
568 | </xs:simpleContent>\r | |
569 | </xs:complexType>\r | |
570 | </xs:element>\r | |
571 | <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>\r | |
572 | </xs:sequence>\r | |
573 | </xs:complexType>\r | |
574 | </xs:element>\r | |
575 | </xs:sequence>\r | |
576 | </xs:complexType>\r | |
577 | </xs:element>\r | |
578 | <!-- End of PackageSurfaceArea PackageIncluces element. -->\r | |
579 | \r | |
580 | <xs:element minOccurs="0" maxOccurs="1" name="Modules">\r | |
581 | <xs:complexType>\r | |
582 | <xs:sequence>\r | |
583 | <xs:element ref="ModuleSurfaceArea" minOccurs="1" maxOccurs="unbounded">\r | |
584 | <xs:annotation>\r | |
585 | <xs:documentation xml:lang="en-us"> This section lists the Module Surface Area for\r | |
586 | all modules provided with this package. </xs:documentation>\r | |
587 | </xs:annotation>\r | |
588 | </xs:element>\r | |
589 | </xs:sequence>\r | |
590 | </xs:complexType>\r | |
591 | </xs:element>\r | |
592 | <!-- End of PackageSurfaceArea Modules element. -->\r | |
593 | \r | |
594 | <xs:element minOccurs="0" maxOccurs="1" name="GuidDeclarations">\r | |
595 | <xs:annotation>\r | |
596 | <xs:documentation xml:lang="en-us"> This section defines the mapping of GUID C names to GUID\r | |
597 | values as a Registry Format GUID. </xs:documentation>\r | |
598 | <xs:documentation xml:lang="en-us"> Modules that use these GUIDs must specify their dependency\r | |
599 | on this package. </xs:documentation>\r | |
600 | </xs:annotation>\r | |
601 | <xs:complexType>\r | |
602 | <xs:sequence>\r | |
603 | <xs:element minOccurs="1" maxOccurs="unbounded" name="Entry">\r | |
604 | <xs:annotation>\r | |
605 | <xs:documentation xml:lang="en-us"> Individual GUID Declarations </xs:documentation>\r | |
606 | </xs:annotation>\r | |
607 | <xs:complexType>\r | |
608 | <xs:sequence>\r | |
609 | <xs:element minOccurs="1" maxOccurs="1" name="CName" type="xs:NCName"/>\r | |
610 | <xs:element minOccurs="1" maxOccurs="1" name="GuidValue"\r | |
611 | type="RegistryFormatGuid"/>\r | |
612 | <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>\r | |
613 | </xs:sequence>\r | |
614 | <xs:attribute name="UiName" type="xs:normalizedString" use="optional"/>\r | |
615 | <xs:attribute name="GuidTypes" type="GuidListType" use="optional"/>\r | |
616 | <xs:attributeGroup ref="SupportedArchMod"/>\r | |
617 | </xs:complexType>\r | |
618 | </xs:element>\r | |
619 | </xs:sequence>\r | |
620 | </xs:complexType>\r | |
621 | </xs:element>\r | |
622 | <!-- End of PackageSurfaceArea GuidDeclarations element. -->\r | |
623 | \r | |
624 | <xs:element minOccurs="0" maxOccurs="1" name="ProtocolDeclarations">\r | |
625 | <xs:annotation>\r | |
626 | <xs:documentation xml:lang="en-us"> This section defines the mapping of Protocol C names to GUID\r | |
627 | values as a Registry Format GUID. </xs:documentation>\r | |
628 | <xs:documentation xml:lang="en-us"> Modules that use these Protocols must specify their\r | |
629 | dependency on this package. </xs:documentation>\r | |
630 | </xs:annotation>\r | |
631 | <xs:complexType>\r | |
632 | <xs:sequence>\r | |
633 | <xs:element minOccurs="1" maxOccurs="unbounded" name="Entry">\r | |
634 | <xs:annotation>\r | |
635 | <xs:documentation xml:lang="en-us"> Individual Protocol Declarations\r | |
636 | </xs:documentation>\r | |
637 | </xs:annotation>\r | |
638 | <xs:complexType>\r | |
639 | <xs:sequence>\r | |
640 | <xs:element minOccurs="1" maxOccurs="1" name="CName" type="xs:NCName"/>\r | |
641 | <xs:element minOccurs="1" maxOccurs="1" name="GuidValue"\r | |
642 | type="RegistryFormatGuid"/>\r | |
643 | <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>\r | |
644 | </xs:sequence>\r | |
645 | <xs:attribute name="UiName" type="xs:normalizedString" use="optional"/>\r | |
646 | <xs:attributeGroup ref="SupportedArchMod"/>\r | |
647 | </xs:complexType>\r | |
648 | </xs:element>\r | |
649 | </xs:sequence>\r | |
650 | </xs:complexType>\r | |
651 | </xs:element>\r | |
652 | <!-- End of PackageSurfaceArea ProtocolDeclarations element. -->\r | |
653 | \r | |
654 | <xs:element minOccurs="0" maxOccurs="1" name="PpiDeclarations">\r | |
655 | <xs:annotation>\r | |
656 | <xs:documentation xml:lang="en-us"> This section defines the mapping of Ppi C names to GUID\r | |
657 | values as a Registry Format GUID. </xs:documentation>\r | |
658 | <xs:documentation xml:lang="en-us"> Modules that use these Ppis must specify their dependency on\r | |
659 | this package. </xs:documentation>\r | |
660 | </xs:annotation>\r | |
661 | <xs:complexType>\r | |
662 | <xs:sequence>\r | |
663 | <xs:element minOccurs="1" maxOccurs="unbounded" name="Entry">\r | |
664 | <xs:annotation>\r | |
665 | <xs:documentation xml:lang="en-us"> Individual PPI Declarations </xs:documentation>\r | |
666 | </xs:annotation>\r | |
667 | <xs:complexType>\r | |
668 | <xs:sequence>\r | |
669 | <xs:element minOccurs="1" maxOccurs="1" name="CName" type="xs:NCName"/>\r | |
670 | <xs:element minOccurs="1" maxOccurs="1" name="GuidValue"\r | |
671 | type="RegistryFormatGuid"/>\r | |
672 | <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>\r | |
673 | </xs:sequence>\r | |
674 | <xs:attribute name="UiName" type="xs:normalizedString" use="optional"/>\r | |
675 | <xs:attributeGroup ref="SupportedArchMod"/>\r | |
676 | </xs:complexType>\r | |
677 | </xs:element>\r | |
678 | </xs:sequence>\r | |
679 | </xs:complexType>\r | |
680 | </xs:element>\r | |
681 | <!-- End of PackageSurfaceArea PpiDeclarations element. -->\r | |
682 | \r | |
683 | <xs:element minOccurs="0" maxOccurs="1" name="PcdDeclarations">\r | |
684 | <xs:annotation>\r | |
685 | <xs:documentation xml:lang="en-us"> This section is used to declare platform configuration knobs\r | |
686 | that are defined by this package. </xs:documentation>\r | |
687 | <xs:documentation xml:lang="en-us"> Modules that use these PCD values must specify their\r | |
688 | dependency on this package. </xs:documentation>\r | |
689 | </xs:annotation>\r | |
690 | <xs:complexType>\r | |
691 | <xs:sequence>\r | |
692 | <xs:element minOccurs="1" maxOccurs="unbounded" name="PcdEntry">\r | |
693 | <xs:complexType>\r | |
694 | <xs:sequence>\r | |
695 | <xs:element minOccurs="1" maxOccurs="1" name="TokenSpaceGuidCname"\r | |
696 | type="xs:NCName">\r | |
697 | <xs:annotation>\r | |
698 | <xs:documentation xml:lang="en-us"> Specifies the C name of the Token\r | |
699 | Space GUID of which this PCD Entry is a member. This C name should\r | |
700 | also be listed in the GUIDs section, (specified above,) where the C\r | |
701 | name is assigned to a GUID value. </xs:documentation>\r | |
702 | </xs:annotation>\r | |
703 | </xs:element>\r | |
704 | <xs:element minOccurs="1" maxOccurs="1" name="Token">\r | |
705 | <xs:annotation>\r | |
706 | <xs:documentation xml:lang="en-us"> Specifies the 32-bit token value for\r | |
707 | this PCD Entry. The Token number must be unique to the Token Space\r | |
708 | that declares the PCD. </xs:documentation>\r | |
709 | <xs:documentation xml:lang="en-us"> The minLength of 3 is required to\r | |
710 | handle the "0x" prefix to the hex number. </xs:documentation>\r | |
711 | </xs:annotation>\r | |
712 | <xs:simpleType>\r | |
713 | <xs:restriction base="HexNumber">\r | |
714 | <xs:minLength value="3"/>\r | |
715 | <xs:maxLength value="10"/>\r | |
716 | </xs:restriction>\r | |
717 | </xs:simpleType>\r | |
718 | </xs:element>\r | |
719 | <xs:element minOccurs="1" maxOccurs="1" name="CName" type="xs:NCName"/>\r | |
720 | <xs:element minOccurs="1" maxOccurs="1" name="DatumType" type="PcdDatumTypes">\r | |
721 | <xs:annotation>\r | |
722 | <xs:documentation xml:lang="en-us"> A string that contains the data type\r | |
723 | of this PCD Entry. PCD data types are restricted to the following\r | |
724 | set:UINT8, UINT16, UINT32, UINT64, VOID*, BOOLEAN.\r | |
725 | </xs:documentation>\r | |
726 | </xs:annotation>\r | |
727 | </xs:element>\r | |
728 | <xs:element minOccurs="1" maxOccurs="1" name="ValidUsage" type="PcdItemListType">\r | |
729 | <xs:annotation>\r | |
730 | <xs:documentation xml:lang="en-us"> A string that contains one or more\r | |
731 | PCD Item types separated by spaces. The PCD Item types are\r | |
732 | restricted to FeaturePcd, FixedPcd, PatchPcd, Pcd and/or PcdEx.\r | |
733 | </xs:documentation>\r | |
734 | </xs:annotation>\r | |
735 | </xs:element>\r | |
736 | <xs:element minOccurs="1" maxOccurs="1" name="DefaultValue"\r | |
737 | type="xs:normalizedString"/>\r | |
738 | <xs:element minOccurs="0" maxOccurs="1" name="MaxDatumSize">\r | |
739 | <xs:annotation>\r | |
740 | <xs:documentation xml:lang="en-us"> This is a recommended maximum data\r | |
741 | size for VOID* data types, the actual value should be defined by the\r | |
742 | Platform Integrator. It is not required for the other data types. </xs:documentation>\r | |
743 | <xs:documentation xml:lang="en-us"> The minLength of 3 is required to\r | |
744 | handle the "0x" prefix to the hex number. </xs:documentation>\r | |
745 | \r | |
746 | </xs:annotation>\r | |
747 | <xs:simpleType>\r | |
748 | <xs:restriction base="HexNumber">\r | |
749 | <xs:minLength value="3"/>\r | |
750 | </xs:restriction>\r | |
751 | </xs:simpleType>\r | |
752 | </xs:element>\r | |
753 | <xs:element minOccurs="0" maxOccurs="unbounded" name="Prompt">\r | |
754 | <xs:annotation>\r | |
755 | <xs:documentation xml:lang="en-US"> This entry contains prompt\r | |
756 | information, that may used by tools to assist platform integrators\r | |
757 | with choosing the correct values </xs:documentation>\r | |
758 | </xs:annotation>\r | |
759 | <xs:complexType>\r | |
760 | <xs:simpleContent>\r | |
761 | <xs:extension base="xs:string">\r | |
762 | <xs:attribute name="Lang" type="xs:language" default="en-us"\r | |
763 | use="optional"/>\r | |
764 | </xs:extension>\r | |
765 | </xs:simpleContent>\r | |
766 | </xs:complexType>\r | |
767 | </xs:element>\r | |
768 | <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>\r | |
769 | \r | |
770 | <xs:element minOccurs="0" maxOccurs="unbounded" name="PcdError">\r | |
771 | <xs:annotation>\r | |
772 | <xs:documentation xml:lang="en-us"> Valid Error messages that may be\r | |
773 | implemented in a module for the PCD Entry. Only One Error Number per\r | |
774 | PcdError, (multiple ErrorMessage entries are permitted) and multiple\r | |
775 | PcdError elements are permitted. </xs:documentation>\r | |
776 | </xs:annotation>\r | |
777 | <xs:complexType>\r | |
778 | <xs:sequence>\r | |
779 | <xs:choice minOccurs="1" maxOccurs="1">\r | |
780 | <xs:annotation>\r | |
781 | <xs:documentation xml:lang="en-us"> One of the following\r | |
782 | types of comparisons, which must be able to evaluate to\r | |
783 | either true or false. </xs:documentation>\r | |
784 | </xs:annotation>\r | |
785 | <xs:element minOccurs="0" maxOccurs="1" name="ValidValueList">\r | |
786 | <xs:annotation>\r | |
787 | <xs:documentation xml:lang="en-us"> The PCD Value must be\r | |
788 | space separated list of values. Values are restricted to the\r | |
789 | data type of this PCD. </xs:documentation>\r | |
790 | </xs:annotation>\r | |
791 | <xs:complexType>\r | |
792 | <xs:simpleContent>\r | |
793 | <xs:extension base="xs:normalizedString">\r | |
794 | <xs:attribute name="Lang" type="xs:language" use="optional"\r | |
795 | />\r | |
796 | </xs:extension>\r | |
797 | </xs:simpleContent>\r | |
798 | </xs:complexType>\r | |
799 | </xs:element>\r | |
800 | <xs:element minOccurs="0" maxOccurs="1" name="ValidValueRange"\r | |
801 | type="xs:normalizedString">\r | |
802 | <xs:annotation>\r | |
803 | <xs:documentation xml:lang="en-us"> The PCD must be within a\r | |
804 | specifed range of numeric values. Restricted to C style\r | |
805 | Relational, Equality and Logicial Operators and parenthesis\r | |
806 | are valid. Only the CName for this PCD is permitted in the\r | |
807 | ValidValueRange expression. All other values must be\r | |
808 | numeric.</xs:documentation>\r | |
809 | <xs:documentation xml:lang="en-us"> LValue (op RValue)+\r | |
810 | </xs:documentation>\r | |
811 | </xs:annotation>\r | |
812 | </xs:element>\r | |
813 | <xs:element minOccurs="0" maxOccurs="1" name="Expression"\r | |
814 | type="xs:normalizedString">\r | |
815 | <xs:annotation>\r | |
816 | <xs:documentation xml:lang="en-us"> A in-fix logical\r | |
817 | expression using C style logical operators.\r | |
818 | </xs:documentation>\r | |
819 | </xs:annotation>\r | |
820 | </xs:element>\r | |
821 | </xs:choice>\r | |
822 | <xs:element minOccurs="1" maxOccurs="1" name="ErrorNumber">\r | |
823 | <xs:annotation>\r | |
824 | <xs:documentation xml:lang="en-us"> A hexadecimal value for\r | |
825 | the error message as defined by specifications. </xs:documentation>\r | |
826 | <xs:documentation xml:lang="en-us"> The minLength of 3 is\r | |
827 | required to handle the "0x" prefix to the hex number. </xs:documentation>\r | |
828 | \r | |
829 | </xs:annotation>\r | |
830 | <xs:simpleType>\r | |
831 | <xs:restriction base="HexNumber">\r | |
832 | <xs:minLength value="3"/>\r | |
833 | </xs:restriction>\r | |
834 | </xs:simpleType>\r | |
835 | </xs:element>\r | |
836 | <xs:element minOccurs="1" maxOccurs="unbounded" name="ErrorMessage">\r | |
837 | <xs:annotation>\r | |
838 | <xs:documentation xml:lang="en-us"> This string should be\r | |
839 | defined by specifications. There are pre-defined error\r | |
840 | number ranges in the UEFI/PI specificaiton.\r | |
841 | </xs:documentation>\r | |
842 | </xs:annotation>\r | |
843 | <xs:complexType>\r | |
844 | <xs:simpleContent>\r | |
845 | <xs:extension base="xs:string">\r | |
846 | <xs:attribute name="Lang" type="xs:language" default="en-us"\r | |
847 | use="optional"/>\r | |
848 | </xs:extension>\r | |
849 | </xs:simpleContent>\r | |
850 | </xs:complexType>\r | |
851 | </xs:element>\r | |
852 | </xs:sequence>\r | |
853 | </xs:complexType>\r | |
854 | </xs:element>\r | |
855 | </xs:sequence>\r | |
856 | <xs:attributeGroup ref="SupportedArchMod"/>\r | |
857 | </xs:complexType>\r | |
858 | </xs:element>\r | |
859 | </xs:sequence>\r | |
860 | </xs:complexType>\r | |
861 | </xs:element>\r | |
862 | <!-- End of PackageSurfaceArea PcdDeclarations element. -->\r | |
863 | \r | |
864 | <xs:element minOccurs="0" maxOccurs="1" name="PcdRelationshipChecks">\r | |
865 | <xs:annotation>\r | |
866 | <xs:documentation xml:lang="en-us"> This section is used to describe any PCD interdependencies\r | |
867 | or relationships. </xs:documentation>\r | |
868 | </xs:annotation>\r | |
869 | <xs:complexType>\r | |
870 | <xs:sequence>\r | |
871 | <xs:element minOccurs="1" maxOccurs="unbounded" name="PcdCheck" type="xs:normalizedString">\r | |
872 | <xs:annotation>\r | |
873 | <xs:documentation xml:lang="en-us"> This entry must used\r | |
874 | TokenSpaceGuidCName.PcdCname for every named PCD. Restricted to Relational,\r | |
875 | Equality and Logical Operators (NOT, AND, OR, GT, GE, EQ, LE, LT and XOR) and\r | |
876 | parenthesis are valid. Only the TokenSpaceGuidCName.PcdCname us permitted to\r | |
877 | name PCDs in the expression. All other values must be numeric. </xs:documentation>\r | |
878 | <xs:documentation xml:lang="en-us"> LValue (op RValue)+ </xs:documentation>\r | |
879 | </xs:annotation>\r | |
880 | </xs:element>\r | |
881 | </xs:sequence>\r | |
882 | </xs:complexType>\r | |
883 | </xs:element>\r | |
884 | \r | |
885 | <xs:element minOccurs="0" maxOccurs="unbounded" name="MiscellaneousFiles">\r | |
886 | <xs:annotation>\r | |
887 | <xs:documentation xml:lang="en-us"> This section contains files that are not part of the code\r | |
888 | distributed with this package. </xs:documentation>\r | |
889 | </xs:annotation>\r | |
890 | <xs:complexType>\r | |
891 | <xs:sequence>\r | |
892 | <xs:element minOccurs="0" maxOccurs="1" name="Copyright" type="xs:string">\r | |
893 | <xs:annotation>\r | |
894 | <xs:documentation xml:lang="en-us"> Only required if different from the Package\r | |
895 | Copyright. </xs:documentation>\r | |
896 | </xs:annotation>\r | |
897 | </xs:element>\r | |
898 | <xs:element minOccurs="0" maxOccurs="1" name="License" type="xs:string">\r | |
899 | <xs:annotation>\r | |
900 | <xs:documentation xml:lang="en-us"> Only required if different from the Package\r | |
901 | License. </xs:documentation>\r | |
902 | </xs:annotation>\r | |
903 | </xs:element>\r | |
904 | <xs:element minOccurs="0" maxOccurs="1" name="Abstract" type="xs:string">\r | |
905 | <xs:annotation>\r | |
906 | <xs:documentation xml:lang="en-us"> A one line description of this section's\r | |
907 | content. </xs:documentation>\r | |
908 | </xs:annotation>\r | |
909 | </xs:element>\r | |
910 | <xs:element minOccurs="0" maxOccurs="unbounded" name="Description" type="xs:string">\r | |
911 | <xs:annotation>\r | |
912 | <xs:documentation xml:lang="en-us"> A complete description of the files in this\r | |
913 | section. </xs:documentation>\r | |
914 | </xs:annotation>\r | |
915 | </xs:element>\r | |
916 | <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename">\r | |
917 | <xs:annotation>\r | |
918 | <xs:documentation xml:lang="en-us"> This is the PackagePath relative path and\r | |
919 | filename location within the ZIP file. </xs:documentation>\r | |
920 | </xs:annotation>\r | |
921 | <xs:complexType>\r | |
922 | <xs:simpleContent>\r | |
923 | <xs:extension base="xs:anyURI">\r | |
924 | <xs:attribute name="Executable" type="xs:boolean" default="false"\r | |
925 | use="optional">\r | |
926 | <xs:annotation>\r | |
927 | <xs:documentation xml:lang="en-us"> If true, used by installation\r | |
928 | tools to ensure that a file that must be executable has the\r | |
929 | correct properties to permit execution. </xs:documentation>\r | |
930 | </xs:annotation>\r | |
931 | </xs:attribute>\r | |
932 | </xs:extension>\r | |
933 | </xs:simpleContent>\r | |
934 | </xs:complexType>\r | |
935 | </xs:element>\r | |
936 | \r | |
937 | </xs:sequence>\r | |
938 | </xs:complexType>\r | |
939 | </xs:element>\r | |
940 | <!-- End of PackageSurfaceArea Misc element. -->\r | |
941 | \r | |
942 | <xs:element minOccurs="0" maxOccurs="unbounded" name="UserExtensions">\r | |
943 | <xs:annotation>\r | |
944 | <xs:documentation xml:lang="en-us"> This section is used for any processing instructions that\r | |
945 | may be custom to the content provided by this package that are common to this package.\r | |
946 | </xs:documentation>\r | |
947 | </xs:annotation>\r | |
948 | <xs:complexType mixed="true">\r | |
949 | <xs:sequence>\r | |
950 | <xs:any processContents="lax" minOccurs="0" maxOccurs="1"/>\r | |
951 | </xs:sequence>\r | |
952 | <xs:attribute name="UserId" type="xs:NCName" use="required">\r | |
953 | <xs:annotation>\r | |
954 | <xs:documentation xml:lang="en-us"> This is a single word identifier for grouping\r | |
955 | similar content that does not fit into previously defined sections or other sections\r | |
956 | of the Distribution. </xs:documentation>\r | |
957 | </xs:annotation>\r | |
958 | </xs:attribute>\r | |
959 | <xs:attribute name="Identifier" type="xs:string" use="required">\r | |
960 | <xs:annotation>\r | |
961 | <xs:documentation xml:lang="en-us"> This can be used to differentiate multiple sections\r | |
962 | with a grouping. </xs:documentation>\r | |
963 | <xs:documentation xml:lang="en-us"> For example, a PRE_PROCESS Identifier might indicate\r | |
964 | specific steps and tools required before processing module content, while a\r | |
965 | different UserExtensions section with a POST_PROCESS Identifier might describe steps\r | |
966 | that need to be executed after operations on the modules in this package.\r | |
967 | </xs:documentation>\r | |
968 | </xs:annotation>\r | |
969 | </xs:attribute>\r | |
970 | <xs:anyAttribute processContents="lax"/>\r | |
971 | </xs:complexType>\r | |
972 | </xs:element>\r | |
973 | <!-- End of PackageSurfaceArea UserExtensions element. -->\r | |
974 | \r | |
975 | </xs:sequence>\r | |
976 | </xs:complexType>\r | |
977 | </xs:element>\r | |
978 | <!-- End of the PackageSurfaceArea element. -->\r | |
979 | \r | |
980 | <xs:element name="ModuleSurfaceArea">\r | |
981 | <xs:annotation>\r | |
982 | <xs:documentation xml:lang="en-us"> Each module is uniquely identified by it's GUID and Version number.\r | |
983 | Backward compatible releases of a module need only change the version number, while non-backward\r | |
984 | compatible changes require the GUID to change (resetting the version number to 1.0 is optional.)\r | |
985 | </xs:documentation>\r | |
986 | </xs:annotation>\r | |
987 | <xs:complexType>\r | |
988 | <xs:sequence>\r | |
989 | \r | |
990 | <xs:element minOccurs="1" maxOccurs="1" name="Header">\r | |
991 | <xs:complexType>\r | |
992 | <xs:sequence>\r | |
993 | <xs:element minOccurs="1" maxOccurs="1" name="Name">\r | |
994 | <xs:annotation>\r | |
995 | <xs:documentation xml:lang="en-us"> This is the User Interface Name for this Module.\r | |
996 | </xs:documentation>\r | |
997 | </xs:annotation>\r | |
998 | <xs:complexType>\r | |
999 | <xs:simpleContent>\r | |
1000 | <xs:extension base="xs:normalizedString">\r | |
1001 | <xs:attribute name="BaseName" type="xs:NMTOKEN" use="required">\r | |
1002 | <xs:annotation>\r | |
1003 | <xs:documentation xml:lang="en-us"> This is a single word BaseName\r | |
1004 | that will be used to create a module meta-data file. </xs:documentation>\r | |
1005 | <xs:documentation xml:lang="en-us"> This name should also be used to\r | |
1006 | create output file names and directories. </xs:documentation>\r | |
1007 | </xs:annotation>\r | |
1008 | </xs:attribute>\r | |
1009 | </xs:extension>\r | |
1010 | </xs:simpleContent>\r | |
1011 | </xs:complexType>\r | |
1012 | </xs:element>\r | |
1013 | <xs:element minOccurs="1" maxOccurs="1" name="GUID">\r | |
1014 | <xs:annotation>\r | |
1015 | <xs:documentation xml:lang="en-us"> This GUID and the Version attribute uniquely\r | |
1016 | identify a given Module. </xs:documentation>\r | |
1017 | </xs:annotation>\r | |
1018 | <xs:complexType>\r | |
1019 | <xs:simpleContent>\r | |
1020 | <xs:extension base="RegistryFormatGuid">\r | |
1021 | <xs:attribute name="Version" type="xs:decimal" use="required">\r | |
1022 | <xs:annotation>\r | |
1023 | <xs:documentation xml:lang="en-us"> This value, along with the GUID,\r | |
1024 | is used to uniquely identify this object. </xs:documentation>\r | |
1025 | <xs:documentation xml:lang="en-us"> Backward compatible changes must\r | |
1026 | make sure this number is incremented from the most recent\r | |
1027 | version. Non-backward compatible changes require a new GUID, and\r | |
1028 | the version can be reset. </xs:documentation>\r | |
1029 | </xs:annotation>\r | |
1030 | </xs:attribute>\r | |
1031 | </xs:extension>\r | |
1032 | </xs:simpleContent>\r | |
1033 | </xs:complexType>\r | |
1034 | </xs:element>\r | |
1035 | <xs:element minOccurs="0" maxOccurs="unbounded" name="Copyright">\r | |
1036 | <xs:annotation>\r | |
1037 | <xs:documentation xml:lang="en-us"> This is only required if the Copyright is\r | |
1038 | different from either the Package or Distribution copyright. Multiple copyright\r | |
1039 | lines are permitted within this section. </xs:documentation>\r | |
1040 | </xs:annotation>\r | |
1041 | <xs:complexType>\r | |
1042 | <xs:simpleContent>\r | |
1043 | <xs:extension base="xs:string">\r | |
1044 | <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"\r | |
1045 | />\r | |
1046 | </xs:extension>\r | |
1047 | </xs:simpleContent>\r | |
1048 | </xs:complexType>\r | |
1049 | </xs:element>\r | |
1050 | <xs:element minOccurs="0" maxOccurs="unbounded" name="License">\r | |
1051 | <xs:annotation>\r | |
1052 | <xs:documentation xml:lang="en-us"> This is only required if the license is\r | |
1053 | different from either the Package or Distribution license. Multiple licenses are\r | |
1054 | permitted within this section. </xs:documentation>\r | |
1055 | </xs:annotation>\r | |
1056 | <xs:complexType>\r | |
1057 | <xs:simpleContent>\r | |
1058 | <xs:extension base="xs:string">\r | |
1059 | <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"\r | |
1060 | />\r | |
1061 | </xs:extension>\r | |
1062 | </xs:simpleContent>\r | |
1063 | </xs:complexType>\r | |
1064 | </xs:element>\r | |
1065 | <xs:element minOccurs="0" maxOccurs="unbounded" name="Abstract">\r | |
1066 | <xs:annotation>\r | |
1067 | <xs:documentation xml:lang="en-us"> A brief text description of the module.\r | |
1068 | </xs:documentation>\r | |
1069 | </xs:annotation>\r | |
1070 | <xs:complexType>\r | |
1071 | <xs:simpleContent>\r | |
1072 | <xs:extension base="xs:normalizedString">\r | |
1073 | <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"\r | |
1074 | />\r | |
1075 | </xs:extension>\r | |
1076 | </xs:simpleContent>\r | |
1077 | </xs:complexType>\r | |
1078 | </xs:element>\r | |
1079 | <xs:element minOccurs="0" maxOccurs="unbounded" name="Description">\r | |
1080 | <xs:annotation>\r | |
1081 | <xs:documentation xml:lang="en-us"> A complete description of the module contents\r | |
1082 | and/or features including a description of the updates since the previous module\r | |
1083 | release. </xs:documentation>\r | |
1084 | </xs:annotation>\r | |
1085 | <xs:complexType>\r | |
1086 | <xs:simpleContent>\r | |
1087 | <xs:extension base="xs:string">\r | |
1088 | <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"\r | |
1089 | />\r | |
1090 | </xs:extension>\r | |
1091 | </xs:simpleContent>\r | |
1092 | </xs:complexType>\r | |
1093 | </xs:element>\r | |
1094 | </xs:sequence>\r | |
1095 | </xs:complexType>\r | |
1096 | </xs:element>\r | |
1097 | <!-- End of Module Surface Area Header Section -->\r | |
1098 | \r | |
1099 | <xs:element minOccurs="0" maxOccurs="1" name="ModuleProperties">\r | |
1100 | <xs:annotation>\r | |
1101 | <xs:documentation xml:lang="en-us"> List general information about a module, including the\r | |
1102 | Supported Architectures, this module's type, specifications the module is coded against, and\r | |
1103 | other informational content. </xs:documentation>\r | |
1104 | </xs:annotation>\r | |
1105 | <xs:complexType>\r | |
1106 | <xs:sequence>\r | |
1107 | <xs:element minOccurs="1" maxOccurs="1" name="ModuleType" type="ModuleTypes">\r | |
1108 | <xs:annotation>\r | |
1109 | <xs:documentation xml:lang="en-us"> One of the Enumerated module types that limit\r | |
1110 | the use of a module. </xs:documentation>\r | |
1111 | </xs:annotation>\r | |
1112 | </xs:element>\r | |
1113 | <xs:element minOccurs="1" maxOccurs="1" name="Path" type="xs:anyURI">\r | |
1114 | <xs:annotation>\r | |
1115 | <xs:documentation xml:lang="en-us"> For stand-alone modules that are NOT part of any\r | |
1116 | package, this is the path to the root of the module as listed in the ZIP file.\r | |
1117 | For modules included in a package, this is the location, relative to the root of\r | |
1118 | the package (PackagePath) this module belongs to. </xs:documentation>\r | |
1119 | </xs:annotation>\r | |
1120 | </xs:element>\r | |
1121 | <xs:element minOccurs="0" maxOccurs="1" name="PcdIsDriver">\r | |
1122 | <xs:annotation>\r | |
1123 | <xs:documentation xml:lang="en-us"> This element is only required for the PEIM that\r | |
1124 | produces the PCD PPI or the DXE Driver that produces the PCD Protocol.\r | |
1125 | </xs:documentation>\r | |
1126 | </xs:annotation>\r | |
1127 | <xs:simpleType>\r | |
1128 | <xs:restriction base="xs:NCName">\r | |
1129 | <xs:enumeration value="PEI_PCD_DRIVER"/>\r | |
1130 | <xs:enumeration value="DXE_PCD_DRIVER"/>\r | |
1131 | </xs:restriction>\r | |
1132 | </xs:simpleType>\r | |
1133 | </xs:element>\r | |
1134 | \r | |
1135 | <xs:element minOccurs="0" maxOccurs="1" name="UefiSpecificationVersion" type="xs:decimal"/>\r | |
1136 | \r | |
1137 | <xs:element minOccurs="0" maxOccurs="1" name="PiSpecificationVersion" type="xs:decimal"/>\r | |
1138 | \r | |
1139 | <xs:element minOccurs="0" maxOccurs="unbounded" name="Specification">\r | |
1140 | <xs:annotation>\r | |
1141 | <xs:documentation xml:lang="en-us"> This is a list of other specifications that this\r | |
1142 | module is written against. These entries can be used in #define statements\r | |
1143 | (depending on the build system implementation, they may be autogenerated.)\r | |
1144 | </xs:documentation>\r | |
1145 | </xs:annotation>\r | |
1146 | <xs:complexType>\r | |
1147 | <xs:simpleContent>\r | |
1148 | <xs:extension base="xs:NCName">\r | |
1149 | <xs:attribute name="Version" type="xs:decimal" use="required"/>\r | |
1150 | </xs:extension>\r | |
1151 | </xs:simpleContent>\r | |
1152 | </xs:complexType>\r | |
1153 | </xs:element>\r | |
1154 | \r | |
1155 | <xs:element minOccurs="0" maxOccurs="unbounded" name="BootMode">\r | |
1156 | <xs:annotation>\r | |
1157 | <xs:documentation xml:lang="en-us"> Different firmware execution paths may be taken\r | |
1158 | based on a given state of the hardware, firmware, or through feature settings. A\r | |
1159 | BootMode may be declared (PRODUCES) or discovered (CONSUMES) based on these\r | |
1160 | states and feature settings. If the usage is UNDEFINE, it implies that a Boot\r | |
1161 | Mode is used, but the package creator does not know how it is used. The\r | |
1162 | supported boot modes map to the PI specification Boot Modes. The boot modes\r | |
1163 | listed with Recovery are to indicate that the BootMode is valid during a\r | |
1164 | recovery boot. </xs:documentation>\r | |
1165 | </xs:annotation>\r | |
1166 | <xs:complexType>\r | |
1167 | <xs:sequence minOccurs="0">\r | |
1168 | <xs:element minOccurs="1" maxOccurs="1" name="SupportedBootModes">\r | |
1169 | <xs:simpleType>\r | |
1170 | <xs:list>\r | |
1171 | <xs:simpleType>\r | |
1172 | <xs:restriction base="xs:NCName">\r | |
1173 | <xs:enumeration value="FULL"/>\r | |
1174 | <xs:enumeration value="MINIMAL"/>\r | |
1175 | <xs:enumeration value="NO_CHANGE"/>\r | |
1176 | <xs:enumeration value="DIAGNOSTICS"/>\r | |
1177 | <xs:enumeration value="DEFAULT"/>\r | |
1178 | <xs:enumeration value="S2_RESUME"/>\r | |
1179 | <xs:enumeration value="S3_RESUME"/>\r | |
1180 | <xs:enumeration value="S4_RESUME"/>\r | |
1181 | <xs:enumeration value="S5_RESUME"/>\r | |
1182 | <xs:enumeration value="FLASH_UPDATE"/>\r | |
1183 | <xs:enumeration value="RECOVERY_FULL"/>\r | |
1184 | <xs:enumeration value="RECOVERY_MINIMAL"/>\r | |
1185 | <xs:enumeration value="RECOVERY_NO_CHANGE"/>\r | |
1186 | <xs:enumeration value="RECOVERY_DIAGNOSTICS"/>\r | |
1187 | <xs:enumeration value="RECOVERY_DEFAULT"/>\r | |
1188 | <xs:enumeration value="RECOVERY_S2_RESUME"/>\r | |
1189 | <xs:enumeration value="RECOVERY_S3_RESUME"/>\r | |
1190 | <xs:enumeration value="RECOVERY_S4_RESUME"/>\r | |
1191 | <xs:enumeration value="RECOVERY_S5_RESUME"/>\r | |
1192 | <xs:enumeration value="RECOVERY_FLASH_UPDATE"/>\r | |
1193 | <xs:enumeration value="UNDEFINED"/>\r | |
1194 | </xs:restriction>\r | |
1195 | </xs:simpleType>\r | |
1196 | </xs:list>\r | |
1197 | </xs:simpleType>\r | |
1198 | </xs:element>\r | |
1199 | \r | |
1200 | <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>\r | |
1201 | </xs:sequence>\r | |
1202 | <xs:attribute name="Usage" use="required">\r | |
1203 | <xs:simpleType>\r | |
1204 | <xs:restriction base="xs:NCName">\r | |
1205 | <xs:enumeration value="CONSUMES">\r | |
1206 | <xs:annotation>\r | |
1207 | <xs:documentation xml:lang="en-us"> The module always supports\r | |
1208 | the given boot modes. </xs:documentation>\r | |
1209 | </xs:annotation>\r | |
1210 | </xs:enumeration>\r | |
1211 | <xs:enumeration value="SOMETIMES_CONSUMES">\r | |
1212 | <xs:annotation>\r | |
1213 | <xs:documentation xml:lang="en-us"> The module may support a\r | |
1214 | given mode on some execution paths. </xs:documentation>\r | |
1215 | </xs:annotation>\r | |
1216 | </xs:enumeration>\r | |
1217 | <xs:enumeration value="PRODUCES">\r | |
1218 | <xs:annotation>\r | |
1219 | <xs:documentation xml:lang="en-us"> The module will change the\r | |
1220 | boot mode. </xs:documentation>\r | |
1221 | </xs:annotation>\r | |
1222 | </xs:enumeration>\r | |
1223 | <xs:enumeration value="SOMETIME_PRODUCES">\r | |
1224 | <xs:annotation>\r | |
1225 | <xs:documentation xml:lang="en-us"> The module will change the\r | |
1226 | boot mode on some exection paths. </xs:documentation>\r | |
1227 | </xs:annotation>\r | |
1228 | </xs:enumeration>\r | |
1229 | <xs:enumeration value="UNDEFINED">\r | |
1230 | <xs:annotation>\r | |
1231 | <xs:documentation xml:lang="en-us"> The package creator does not\r | |
1232 | know how the boot mode is used. </xs:documentation>\r | |
1233 | </xs:annotation>\r | |
1234 | </xs:enumeration>\r | |
1235 | </xs:restriction>\r | |
1236 | </xs:simpleType>\r | |
1237 | </xs:attribute>\r | |
1238 | <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>\r | |
1239 | <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>\r | |
1240 | </xs:complexType>\r | |
1241 | </xs:element>\r | |
1242 | \r | |
1243 | <xs:element minOccurs="0" maxOccurs="unbounded" name="Event" nillable="true">\r | |
1244 | <xs:annotation>\r | |
1245 | <xs:documentation xml:lang="en-us"> The functions that make up the Event, Timer, and\r | |
1246 | Task Priority Services are used during preboot to create, close, signal, and\r | |
1247 | wait for events; to set timers; and to raise and restore task priority levels as\r | |
1248 | defined in the UEFI specification. GUIDed events should be listed in the Guids\r | |
1249 | section. </xs:documentation>\r | |
1250 | </xs:annotation>\r | |
1251 | <xs:complexType>\r | |
1252 | <xs:sequence>\r | |
1253 | <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>\r | |
1254 | </xs:sequence>\r | |
1255 | <xs:attribute name="Usage" use="required">\r | |
1256 | <xs:simpleType>\r | |
1257 | <xs:restriction base="xs:NCName">\r | |
1258 | <xs:enumeration value="CONSUMES">\r | |
1259 | <xs:annotation>\r | |
1260 | <xs:documentation xml:lang="en-us"> The module will register a\r | |
1261 | notification function and calls the function when it is\r | |
1262 | signaled. </xs:documentation>\r | |
1263 | </xs:annotation>\r | |
1264 | </xs:enumeration>\r | |
1265 | <xs:enumeration value="SOMETIMES_CONSUMES">\r | |
1266 | <xs:annotation>\r | |
1267 | <xs:documentation xml:lang="en-us"> The module will register a\r | |
1268 | notification function and calls the function when it is\r | |
1269 | signaled on some execution paths. </xs:documentation>\r | |
1270 | </xs:annotation>\r | |
1271 | </xs:enumeration>\r | |
1272 | <xs:enumeration value="PRODUCES">\r | |
1273 | <xs:annotation>\r | |
1274 | <xs:documentation xml:lang="en-us"> The module will signal all\r | |
1275 | events in an event group. </xs:documentation>\r | |
1276 | </xs:annotation>\r | |
1277 | </xs:enumeration>\r | |
1278 | <xs:enumeration value="SOMETIMES_PRODUCES">\r | |
1279 | <xs:annotation>\r | |
1280 | <xs:documentation xml:lang="en-us"> The module will signal all\r | |
1281 | events in an event group under some execution paths.\r | |
1282 | </xs:documentation>\r | |
1283 | </xs:annotation>\r | |
1284 | </xs:enumeration>\r | |
1285 | <xs:enumeration value="UNDEFINED">\r | |
1286 | <xs:annotation>\r | |
1287 | <xs:documentation xml:lang="en-us"> The package creator does not\r | |
1288 | know how an event is used. </xs:documentation>\r | |
1289 | </xs:annotation>\r | |
1290 | </xs:enumeration>\r | |
1291 | </xs:restriction>\r | |
1292 | </xs:simpleType>\r | |
1293 | </xs:attribute>\r | |
1294 | <xs:attribute name="EventType" use="required">\r | |
1295 | <xs:simpleType>\r | |
1296 | <xs:restriction base="xs:NCName">\r | |
1297 | <xs:enumeration value="EVENT_TYPE_PERIODIC_TIMER"/>\r | |
1298 | <xs:enumeration value="EVENT_TYPE_RELATIVE_TIMER"/>\r | |
1299 | <xs:enumeration value="UNDEFINED"/>\r | |
1300 | </xs:restriction>\r | |
1301 | </xs:simpleType>\r | |
1302 | \r | |
1303 | \r | |
1304 | </xs:attribute>\r | |
1305 | <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>\r | |
1306 | <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>\r | |
1307 | </xs:complexType>\r | |
1308 | </xs:element>\r | |
1309 | \r | |
1310 | <xs:element minOccurs="0" maxOccurs="unbounded" name="HOB" nillable="false">\r | |
1311 | <xs:annotation>\r | |
1312 | <xs:documentation xml:lang="en-us"> This is a list of non-GUIDed Hand Off Blocks\r | |
1313 | (HOBs) produced or consumed by this module. </xs:documentation>\r | |
1314 | </xs:annotation>\r | |
1315 | <xs:complexType>\r | |
1316 | <xs:sequence>\r | |
1317 | <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>\r | |
1318 | </xs:sequence>\r | |
1319 | <xs:attribute name="HobType" use="required">\r | |
1320 | <xs:simpleType>\r | |
1321 | <xs:restriction base="xs:NCName">\r | |
1322 | <xs:enumeration value="PHIT"/>\r | |
1323 | <xs:enumeration value="MEMORY_ALLOCATION"/>\r | |
1324 | <xs:enumeration value="RESOURCE_DESCRIPTOR"/>\r | |
1325 | <xs:enumeration value="FIRMWARE_VOLUME"/>\r | |
1326 | <xs:enumeration value="LOAD_PEIM"/>\r | |
1327 | <xs:enumeration value="UNDEFINED"/>\r | |
1328 | </xs:restriction>\r | |
1329 | </xs:simpleType>\r | |
1330 | </xs:attribute>\r | |
1331 | <xs:attribute name="Usage" use="required">\r | |
1332 | <xs:simpleType>\r | |
1333 | <xs:restriction base="xs:NCName">\r | |
1334 | <xs:enumeration value="CONSUMES">\r | |
1335 | <xs:annotation>\r | |
1336 | <xs:documentation xml:lang="en-us"> A HOB must be present in the\r | |
1337 | system. </xs:documentation>\r | |
1338 | </xs:annotation>\r | |
1339 | </xs:enumeration>\r | |
1340 | <xs:enumeration value="SOMETIMES_CONSUMES">\r | |
1341 | <xs:annotation>\r | |
1342 | <xs:documentation xml:lang="en-us"> If present, the HOB will be\r | |
1343 | used. </xs:documentation>\r | |
1344 | </xs:annotation>\r | |
1345 | </xs:enumeration>\r | |
1346 | <xs:enumeration value="PRODUCES">\r | |
1347 | <xs:annotation>\r | |
1348 | <xs:documentation xml:lang="en-us"> The HOB is always produced\r | |
1349 | by the module. </xs:documentation>\r | |
1350 | </xs:annotation>\r | |
1351 | </xs:enumeration>\r | |
1352 | <xs:enumeration value="SOMETIMES_PRODUCES">\r | |
1353 | <xs:annotation>\r | |
1354 | <xs:documentation xml:lang="en-us"> The HOB may be produced by\r | |
1355 | the module under some execution paths. </xs:documentation>\r | |
1356 | </xs:annotation>\r | |
1357 | </xs:enumeration>\r | |
1358 | <xs:enumeration value="UNDEFINED">\r | |
1359 | <xs:annotation>\r | |
1360 | <xs:documentation xml:lang="en-us"> The package creator knows\r | |
1361 | that a HOB is used, but does not know how it is used.\r | |
1362 | </xs:documentation>\r | |
1363 | </xs:annotation>\r | |
1364 | </xs:enumeration>\r | |
1365 | </xs:restriction>\r | |
1366 | </xs:simpleType>\r | |
1367 | </xs:attribute>\r | |
1368 | <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>\r | |
1369 | <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>\r | |
1370 | </xs:complexType>\r | |
1371 | </xs:element>\r | |
1372 | \r | |
1373 | </xs:sequence>\r | |
1374 | <xs:attributeGroup ref="SupportedArchMod"/>\r | |
1375 | </xs:complexType>\r | |
1376 | </xs:element>\r | |
1377 | <!-- End of ModuleProperties Section -->\r | |
1378 | \r | |
1379 | <xs:element minOccurs="0" maxOccurs="1" name="ClonedFrom">\r | |
1380 | <xs:annotation>\r | |
1381 | <xs:documentation xml:lang="en-us"> This section may be included for Modules that are copied\r | |
1382 | from a different module. </xs:documentation>\r | |
1383 | </xs:annotation>\r | |
1384 | <xs:complexType>\r | |
1385 | <xs:sequence>\r | |
1386 | <xs:element minOccurs="1" maxOccurs="1" name="GUID">\r | |
1387 | <xs:annotation>\r | |
1388 | <xs:documentation xml:lang="en-us"> This GUID and the Version attribute uniquely\r | |
1389 | identify the Module that this Module was copied from. </xs:documentation>\r | |
1390 | </xs:annotation>\r | |
1391 | <xs:complexType>\r | |
1392 | <xs:simpleContent>\r | |
1393 | <xs:extension base="RegistryFormatGuid">\r | |
1394 | <xs:attribute name="Version" type="xs:decimal" use="required">\r | |
1395 | <xs:annotation>\r | |
1396 | <xs:documentation xml:lang="en-us"> This value, along with the GUID,\r | |
1397 | is used to uniquely identify this object. </xs:documentation>\r | |
1398 | </xs:annotation>\r | |
1399 | </xs:attribute>\r | |
1400 | </xs:extension>\r | |
1401 | </xs:simpleContent>\r | |
1402 | </xs:complexType>\r | |
1403 | </xs:element>\r | |
1404 | </xs:sequence>\r | |
1405 | </xs:complexType>\r | |
1406 | </xs:element>\r | |
1407 | <!-- End of ClonedFrom Section. -->\r | |
1408 | \r | |
1409 | <xs:element minOccurs="0" maxOccurs="1" name="LibraryClassDefinitions">\r | |
1410 | <xs:annotation>\r | |
1411 | <xs:documentation xml:lang="en-us"> A list of the different Library Classes consumed by a\r | |
1412 | driver, core and/or application module, or produced by a Library module. </xs:documentation>\r | |
1413 | </xs:annotation>\r | |
1414 | <xs:complexType>\r | |
1415 | <xs:sequence>\r | |
1416 | <xs:element minOccurs="1" maxOccurs="unbounded" name="LibraryClass">\r | |
1417 | <xs:complexType>\r | |
1418 | <xs:sequence>\r | |
1419 | <xs:element minOccurs="1" maxOccurs="1" name="Keyword" type="xs:NCName">\r | |
1420 | <xs:annotation>\r | |
1421 | <xs:documentation xml:lang="en-us "> Used by tools to identify different\r | |
1422 | instances of libraries that provide the library class. This keyword\r | |
1423 | identifies the library class this module needs to be linked against.\r | |
1424 | </xs:documentation>\r | |
1425 | </xs:annotation>\r | |
1426 | </xs:element>\r | |
1427 | <xs:element minOccurs="0" maxOccurs="1" name="RecommendedInstance">\r | |
1428 | <xs:complexType>\r | |
1429 | <xs:all>\r | |
1430 | <xs:element minOccurs="1" maxOccurs="1" name="GUID">\r | |
1431 | <xs:annotation>\r | |
1432 | <xs:documentation xml:lang="en-us"> This GUID and the\r | |
1433 | Version attribute uniquely identify the recommended Library\r | |
1434 | Instance for this module . </xs:documentation>\r | |
1435 | </xs:annotation>\r | |
1436 | <xs:complexType>\r | |
1437 | <xs:simpleContent>\r | |
1438 | <xs:extension base="RegistryFormatGuid">\r | |
1439 | <xs:attribute name="Version" type="xs:decimal"\r | |
1440 | use="optional">\r | |
1441 | <xs:annotation>\r | |
1442 | <xs:documentation xml:lang="en-us"> This value, along with\r | |
1443 | the GUID, is used to uniquely identify this object.\r | |
1444 | </xs:documentation>\r | |
1445 | </xs:annotation>\r | |
1446 | </xs:attribute>\r | |
1447 | </xs:extension>\r | |
1448 | </xs:simpleContent>\r | |
1449 | </xs:complexType>\r | |
1450 | </xs:element>\r | |
1451 | </xs:all>\r | |
1452 | </xs:complexType>\r | |
1453 | </xs:element>\r | |
1454 | <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>\r | |
1455 | </xs:sequence>\r | |
1456 | <xs:attribute name="Usage" use="required">\r | |
1457 | <xs:simpleType>\r | |
1458 | <xs:annotation>\r | |
1459 | <xs:documentation xml:lang="en-us"> Library instances can provide code\r | |
1460 | for a library class, or may require other library instances\r | |
1461 | themselves. Since different execution paths in a library (or module)\r | |
1462 | may need different library classes based on some setting, library\r | |
1463 | classes may not alway be required. </xs:documentation>\r | |
1464 | </xs:annotation>\r | |
1465 | <xs:restriction base="xs:NCName">\r | |
1466 | <xs:enumeration value="PRODUCES"/>\r | |
1467 | <xs:enumeration value="CONSUMES"/>\r | |
1468 | <xs:enumeration value="SOMETIMES_CONSUMES"/>\r | |
1469 | <xs:enumeration value="UNDEFINED"/>\r | |
1470 | </xs:restriction>\r | |
1471 | </xs:simpleType>\r | |
1472 | </xs:attribute>\r | |
1473 | \r | |
1474 | <xs:attributeGroup ref="SupportedArchMod"/>\r | |
1475 | <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional">\r | |
1476 | <xs:annotation>\r | |
1477 | <xs:documentation xml:lang="en-us"> A FeatureFlag attribute must evaluate to\r | |
1478 | either true or false - it may be a fixed value of true or false, a C\r | |
1479 | name or an in-fix expression. </xs:documentation>\r | |
1480 | </xs:annotation>\r | |
1481 | </xs:attribute>\r | |
1482 | </xs:complexType>\r | |
1483 | </xs:element>\r | |
1484 | </xs:sequence>\r | |
1485 | </xs:complexType>\r | |
1486 | </xs:element>\r | |
1487 | <!-- End of LibraryClassDefinitions Section -->\r | |
1488 | \r | |
1489 | <xs:element minOccurs="0" maxOccurs="1" name="SourceFiles">\r | |
1490 | <xs:complexType>\r | |
1491 | <xs:sequence>\r | |
1492 | <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename">\r | |
1493 | <xs:annotation>\r | |
1494 | <xs:documentation xml:lang="en-us"> This is the module relative\r | |
1495 | (ModuleProperties.Path) path and filename location within the ZIP file.\r | |
1496 | </xs:documentation>\r | |
1497 | </xs:annotation>\r | |
1498 | <xs:complexType>\r | |
1499 | <xs:simpleContent>\r | |
1500 | <xs:extension base="xs:anyURI">\r | |
1501 | <xs:attribute name="Family" type="FamilyTypes" use="optional">\r | |
1502 | <xs:annotation>\r | |
1503 | <xs:documentation xml:lang="en-us"> The Family attribute is used to\r | |
1504 | restrict usage to a given family of compilers, such as GCC or\r | |
1505 | MSFT. Since not all code processing tools use the same syntax,\r | |
1506 | especially for assembly, this field can be used to identify\r | |
1507 | different syntax. </xs:documentation>\r | |
1508 | </xs:annotation>\r | |
1509 | </xs:attribute>\r | |
1510 | <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>\r | |
1511 | <xs:attribute name="SupModList" type="ModuleListType" use="optional"/>\r | |
1512 | <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>\r | |
1513 | </xs:extension>\r | |
1514 | </xs:simpleContent>\r | |
1515 | </xs:complexType>\r | |
1516 | </xs:element>\r | |
1517 | <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>\r | |
1518 | </xs:sequence>\r | |
1519 | </xs:complexType>\r | |
1520 | </xs:element>\r | |
1521 | <!-- End of SourceFiles Section -->\r | |
1522 | \r | |
1523 | <xs:element minOccurs="0" maxOccurs="1" name="BinaryFiles">\r | |
1524 | <xs:complexType>\r | |
1525 | <xs:sequence>\r | |
1526 | <xs:element minOccurs="1" maxOccurs="unbounded" name="BinaryFile">\r | |
1527 | <xs:complexType>\r | |
1528 | <xs:sequence>\r | |
1529 | <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename">\r | |
1530 | <xs:annotation>\r | |
1531 | <xs:documentation xml:lang="en-us"> This is the module relative\r | |
1532 | (ModuleProperties.Path) path and filename location within the ZIP\r | |
1533 | file. </xs:documentation>\r | |
1534 | </xs:annotation>\r | |
1535 | <xs:complexType>\r | |
1536 | <xs:simpleContent>\r | |
1537 | <xs:extension base="xs:anyURI">\r | |
1538 | <xs:attribute name="FileType" use="optional">\r | |
1539 | <xs:simpleType>\r | |
1540 | <xs:restriction base="xs:NCName">\r | |
1541 | <xs:annotation>\r | |
1542 | <xs:documentation xml:lang="en-us"> Binary file distribution\r | |
1543 | is limited to UEFI/PI FFS leaf section file types.\r | |
1544 | </xs:documentation>\r | |
1545 | </xs:annotation>\r | |
1546 | <xs:enumeration value="GUID"/>\r | |
1547 | <xs:enumeration value="FREEFORM"/>\r | |
1548 | <xs:enumeration value="UEFI_IMAGE"/>\r | |
1549 | <xs:enumeration value="PE32">\r | |
1550 | <xs:annotation>\r | |
1551 | <xs:documentation xml:lang="en-us"> A UEFI/PI FFS Leaf\r | |
1552 | section file type, not a raw PE32 file. </xs:documentation>\r | |
1553 | </xs:annotation>\r | |
1554 | </xs:enumeration>\r | |
1555 | <xs:enumeration value="PIC"/>\r | |
1556 | <xs:enumeration value="PEI_DEPEX"/>\r | |
1557 | <xs:enumeration value="DXE_DEPEX"/>\r | |
1558 | <xs:enumeration value="SMM_DEPEX"/>\r | |
1559 | <xs:enumeration value="COMPAT16"/>\r | |
1560 | <xs:enumeration value="DISPOSABLE"/>\r | |
1561 | <xs:enumeration value="TE"/>\r | |
1562 | <xs:enumeration value="VER"/>\r | |
1563 | <xs:enumeration value="UI"/>\r | |
1564 | <xs:enumeration value="BIN"/>\r | |
1565 | <xs:enumeration value="FV"/>\r | |
1566 | </xs:restriction>\r | |
1567 | </xs:simpleType>\r | |
1568 | </xs:attribute>\r | |
1569 | <xs:attribute name="GUID" use="optional"\r | |
1570 | type="RegistryFormatGuid"/>\r | |
1571 | <xs:attribute name="SupArchList" type="ArchListType"\r | |
1572 | use="optional"/>\r | |
1573 | <xs:attribute name="SupModList" type="ModuleListType"\r | |
1574 | use="optional"/>\r | |
1575 | <xs:attribute name="FeatureFlag" type="xs:normalizedString"\r | |
1576 | use="optional"/>\r | |
1577 | </xs:extension>\r | |
1578 | </xs:simpleContent>\r | |
1579 | </xs:complexType>\r | |
1580 | </xs:element>\r | |
1581 | <xs:element minOccurs="0" maxOccurs="unbounded" name="AsBuilt">\r | |
1582 | <xs:annotation>\r | |
1583 | <xs:documentation xml:lang="en-us"> This section contains information\r | |
1584 | about how the module was coded, such as Compiler Tools, Flags, PCDs\r | |
1585 | (only PatchPcd and/or PcdEx) and Library Class Instances used to\r | |
1586 | build the binary. </xs:documentation>\r | |
1587 | </xs:annotation>\r | |
1588 | <xs:complexType>\r | |
1589 | <xs:sequence>\r | |
1590 | \r | |
1591 | <xs:element minOccurs="0" maxOccurs="unbounded" name="PatchPcdValue">\r | |
1592 | <xs:annotation>\r | |
1593 | <xs:documentation xml:lang="en-us"> The element is the\r | |
1594 | Patchable PCD Value that was used during the build.\r | |
1595 | </xs:documentation>\r | |
1596 | </xs:annotation>\r | |
1597 | <xs:complexType>\r | |
1598 | <xs:sequence>\r | |
1599 | <xs:element minOccurs="1" maxOccurs="1"\r | |
1600 | name="TokenSpaceGuidValue" type="RegistryFormatGuid"/>\r | |
1601 | <xs:element minOccurs="1" maxOccurs="1" name="PcdCName"\r | |
1602 | type="xs:NCName"/>\r | |
1603 | <xs:element minOccurs="1" maxOccurs="1" name="Token">\r | |
1604 | <xs:annotation>\r | |
1605 | <xs:documentation xml:lang="en-us"> The minLength of 3 is\r | |
1606 | required to handle the "0x" prefix to the hex number.\r | |
1607 | </xs:documentation>\r | |
1608 | </xs:annotation>\r | |
1609 | <xs:simpleType>\r | |
1610 | <xs:restriction base="HexNumber">\r | |
1611 | <xs:minLength value="3"/>\r | |
1612 | <xs:maxLength value="10"/>\r | |
1613 | </xs:restriction>\r | |
1614 | </xs:simpleType>\r | |
1615 | </xs:element>\r | |
1616 | <xs:element minOccurs="1" maxOccurs="1" name="DatumType" \r | |
1617 | type="PcdDatumTypes"/>\r | |
1618 | <xs:element minOccurs="0" maxOccurs="1" name="MaxDatumSize">\r | |
1619 | <xs:annotation>\r | |
1620 | <xs:documentation xml:lang="en-us"> This field is required\r | |
1621 | if the Pcd Datum Type is VOID* </xs:documentation>\r | |
1622 | <xs:documentation xml:lang="en-us"> The minLength of 3 is\r | |
1623 | required to handle the "0x" prefix to the hex number.\r | |
1624 | </xs:documentation>\r | |
1625 | </xs:annotation>\r | |
1626 | <xs:simpleType>\r | |
1627 | <xs:restriction base="HexNumber">\r | |
1628 | <xs:minLength value="3"/>\r | |
1629 | </xs:restriction>\r | |
1630 | </xs:simpleType>\r | |
1631 | </xs:element>\r | |
1632 | <xs:element minOccurs="1" maxOccurs="1" name="Value"\r | |
1633 | type="xs:normalizedString"/>\r | |
1634 | <xs:element minOccurs="1" maxOccurs="1" name="Offset">\r | |
1635 | <xs:annotation>\r | |
1636 | <xs:documentation xml:lang="en-us"> The minLength of 3 is\r | |
1637 | required to handle the "0x" prefix to the hex number.\r | |
1638 | </xs:documentation>\r | |
1639 | </xs:annotation>\r | |
1640 | <xs:simpleType>\r | |
1641 | <xs:restriction base="HexNumber">\r | |
1642 | <xs:minLength value="3"/>\r | |
1643 | </xs:restriction>\r | |
1644 | </xs:simpleType>\r | |
1645 | </xs:element>\r | |
1646 | <xs:element ref="HelpText" minOccurs="0"\r | |
1647 | maxOccurs="unbounded"/>\r | |
1648 | <xs:element minOccurs="0" maxOccurs="unbounded"\r | |
1649 | name="PcdError">\r | |
1650 | <xs:annotation>\r | |
1651 | <xs:documentation xml:lang="en-us"> Error information\r | |
1652 | implemented by the module. </xs:documentation>\r | |
1653 | </xs:annotation>\r | |
1654 | <xs:complexType>\r | |
1655 | <xs:sequence>\r | |
1656 | <xs:choice>\r | |
1657 | <xs:element minOccurs="0" maxOccurs="1" name="ValidValueList">\r | |
1658 | <xs:complexType>\r | |
1659 | <xs:simpleContent>\r | |
1660 | <xs:extension base="xs:normalizedString">\r | |
1661 | <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"/>\r | |
1662 | </xs:extension>\r | |
1663 | </xs:simpleContent>\r | |
1664 | </xs:complexType>\r | |
1665 | </xs:element>\r | |
1666 | <xs:element minOccurs="0" maxOccurs="1" name="ValidValueRange" type="xs:normalizedString"/>\r | |
1667 | <xs:element minOccurs="0" maxOccurs="1" name="Expression" type="xs:normalizedString"/>\r | |
1668 | </xs:choice>\r | |
1669 | <xs:element minOccurs="1" maxOccurs="1" name="ErrorNumber">\r | |
1670 | <xs:annotation>\r | |
1671 | <xs:documentation xml:lang="en-us"> The minLength of 3 is\r | |
1672 | required to handle the "0x" prefix to the hex number.\r | |
1673 | </xs:documentation>\r | |
1674 | </xs:annotation>\r | |
1675 | <xs:simpleType>\r | |
1676 | <xs:restriction base="HexNumber">\r | |
1677 | <xs:minLength value="3"/>\r | |
1678 | </xs:restriction>\r | |
1679 | </xs:simpleType>\r | |
1680 | </xs:element>\r | |
1681 | <xs:element minOccurs="0" maxOccurs="unbounded"\r | |
1682 | name="ErrorMessage">\r | |
1683 | <xs:complexType>\r | |
1684 | <xs:simpleContent>\r | |
1685 | <xs:extension base="xs:string">\r | |
1686 | <xs:attribute name="Lang" type="xs:language" default="en-us"\r | |
1687 | use="optional"/>\r | |
1688 | </xs:extension>\r | |
1689 | </xs:simpleContent>\r | |
1690 | </xs:complexType>\r | |
1691 | </xs:element>\r | |
1692 | </xs:sequence>\r | |
1693 | </xs:complexType>\r | |
1694 | </xs:element>\r | |
1695 | </xs:sequence>\r | |
1696 | </xs:complexType>\r | |
1697 | </xs:element>\r | |
1698 | \r | |
1699 | <xs:element minOccurs="0" maxOccurs="unbounded" name="PcdExValue">\r | |
1700 | <xs:annotation>\r | |
1701 | <xs:documentation xml:lang="en-us"> The element is the\r | |
1702 | DynamicEx PCD Value that was used during the build.\r | |
1703 | </xs:documentation>\r | |
1704 | </xs:annotation>\r | |
1705 | <xs:complexType>\r | |
1706 | <xs:sequence>\r | |
1707 | <xs:element minOccurs="1" maxOccurs="1"\r | |
1708 | name="TokenSpaceGuidValue" type="RegistryFormatGuid"/>\r | |
1709 | <xs:element minOccurs="1" maxOccurs="1" name="Token">\r | |
1710 | <xs:annotation>\r | |
1711 | <xs:documentation xml:lang="en-us"> The minLength of 3 is\r | |
1712 | required to handle the "0x" prefix to the hex number.\r | |
1713 | </xs:documentation>\r | |
1714 | </xs:annotation>\r | |
1715 | <xs:simpleType>\r | |
1716 | <xs:restriction base="HexNumber">\r | |
1717 | <xs:minLength value="3"/>\r | |
1718 | <xs:maxLength value="10"/>\r | |
1719 | </xs:restriction>\r | |
1720 | </xs:simpleType>\r | |
1721 | </xs:element>\r | |
1722 | <xs:element minOccurs="1" maxOccurs="1" name="DatumType"\r | |
1723 | type="PcdDatumTypes"/>\r | |
1724 | <xs:element minOccurs="0" maxOccurs="1" name="MaxDatumSize">\r | |
1725 | <xs:annotation>\r | |
1726 | <xs:documentation xml:lang="en-us"> This field is required\r | |
1727 | if the Pcd Datum Type is VOID* </xs:documentation>\r | |
1728 | </xs:annotation>\r | |
1729 | <xs:simpleType>\r | |
1730 | <xs:restriction base="HexNumber">\r | |
1731 | <xs:minLength value="3"/>\r | |
1732 | </xs:restriction>\r | |
1733 | </xs:simpleType>\r | |
1734 | </xs:element>\r | |
1735 | <xs:element minOccurs="1" maxOccurs="1" name="Value"\r | |
1736 | type="xs:normalizedString"/>\r | |
1737 | <xs:element ref="HelpText" minOccurs="0"\r | |
1738 | maxOccurs="unbounded"/>\r | |
1739 | <xs:element minOccurs="0" maxOccurs="unbounded"\r | |
1740 | name="PcdError">\r | |
1741 | <xs:annotation>\r | |
1742 | <xs:documentation xml:lang="en-us"> Error information\r | |
1743 | implemented by the module. </xs:documentation>\r | |
1744 | </xs:annotation>\r | |
1745 | <xs:complexType>\r | |
1746 | <xs:sequence>\r | |
1747 | <xs:choice>\r | |
1748 | <xs:element minOccurs="0" maxOccurs="1" name="ValidValueList">\r | |
1749 | <xs:complexType>\r | |
1750 | <xs:simpleContent>\r | |
1751 | <xs:extension base="xs:normalizedString">\r | |
1752 | <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"/>\r | |
1753 | </xs:extension>\r | |
1754 | </xs:simpleContent>\r | |
1755 | </xs:complexType>\r | |
1756 | </xs:element>\r | |
1757 | <xs:element minOccurs="0" maxOccurs="1" name="ValidValueRange" type="xs:normalizedString"/>\r | |
1758 | <xs:element minOccurs="0" maxOccurs="1" name="Expression" type="xs:normalizedString"/>\r | |
1759 | </xs:choice>\r | |
1760 | <xs:element minOccurs="1" maxOccurs="1" name="ErrorNumber">\r | |
1761 | <xs:annotation>\r | |
1762 | <xs:documentation xml:lang="en-us"> The minLength of 3 is\r | |
1763 | required to handle the "0x" prefix to the hex number.\r | |
1764 | </xs:documentation>\r | |
1765 | </xs:annotation>\r | |
1766 | <xs:simpleType>\r | |
1767 | <xs:restriction base="HexNumber">\r | |
1768 | <xs:minLength value="3"/>\r | |
1769 | </xs:restriction>\r | |
1770 | </xs:simpleType>\r | |
1771 | </xs:element>\r | |
1772 | <xs:element minOccurs="0" maxOccurs="unbounded"\r | |
1773 | name="ErrorMessage">\r | |
1774 | <xs:complexType>\r | |
1775 | <xs:simpleContent>\r | |
1776 | <xs:extension base="xs:string">\r | |
1777 | <xs:attribute name="Lang" type="xs:language" default="en-us"\r | |
1778 | use="optional"/>\r | |
1779 | </xs:extension>\r | |
1780 | </xs:simpleContent>\r | |
1781 | </xs:complexType>\r | |
1782 | </xs:element>\r | |
1783 | </xs:sequence>\r | |
1784 | </xs:complexType>\r | |
1785 | </xs:element>\r | |
1786 | </xs:sequence>\r | |
1787 | </xs:complexType>\r | |
1788 | </xs:element>\r | |
1789 | \r | |
1790 | <xs:element minOccurs="0" maxOccurs="1" name="LibraryInstances">\r | |
1791 | <xs:annotation>\r | |
1792 | <xs:documentation xml:lang="en-us"> This is the actual\r | |
1793 | library instance that was used to link against the module.\r | |
1794 | </xs:documentation>\r | |
1795 | </xs:annotation>\r | |
1796 | <xs:complexType>\r | |
1797 | <xs:sequence>\r | |
1798 | <xs:element minOccurs="1" maxOccurs="unbounded" name="GUID">\r | |
1799 | <xs:annotation>\r | |
1800 | <xs:documentation xml:lang="en-us"> This GUID and the\r | |
1801 | Version attribute uniquely identify the actual Library\r | |
1802 | Instance linked in this module. </xs:documentation>\r | |
1803 | </xs:annotation>\r | |
1804 | <xs:complexType>\r | |
1805 | <xs:simpleContent>\r | |
1806 | <xs:extension base="RegistryFormatGuid">\r | |
1807 | <xs:attribute name="Version" type="xs:decimal"\r | |
1808 | use="required">\r | |
1809 | <xs:annotation>\r | |
1810 | <xs:documentation xml:lang="en-us"> This value, along with\r | |
1811 | the GUID, is used to uniquely identify this object.\r | |
1812 | </xs:documentation>\r | |
1813 | </xs:annotation>\r | |
1814 | </xs:attribute>\r | |
1815 | </xs:extension>\r | |
1816 | </xs:simpleContent>\r | |
1817 | </xs:complexType>\r | |
1818 | </xs:element>\r | |
1819 | </xs:sequence>\r | |
1820 | </xs:complexType>\r | |
1821 | </xs:element>\r | |
1822 | \r | |
1823 | <xs:element minOccurs="0" maxOccurs="unbounded" name="BuildFlags">\r | |
1824 | <xs:complexType mixed="true">\r | |
1825 | <xs:simpleContent>\r | |
1826 | <xs:annotation>\r | |
1827 | <xs:documentation xml:lang="en-us"> Any description of OS,\r | |
1828 | Tool, and flags for the individual tool can go in this\r | |
1829 | section. </xs:documentation>\r | |
1830 | </xs:annotation>\r | |
1831 | <xs:extension base="xs:string">\r | |
1832 | <xs:anyAttribute processContents="lax"/>\r | |
1833 | </xs:extension>\r | |
1834 | </xs:simpleContent>\r | |
1835 | </xs:complexType>\r | |
1836 | </xs:element>\r | |
1837 | </xs:sequence>\r | |
1838 | </xs:complexType>\r | |
1839 | </xs:element>\r | |
1840 | <!-- End of AsBuilt -->\r | |
1841 | <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>\r | |
1842 | </xs:sequence>\r | |
1843 | </xs:complexType>\r | |
1844 | </xs:element>\r | |
1845 | \r | |
1846 | </xs:sequence>\r | |
1847 | </xs:complexType>\r | |
1848 | </xs:element>\r | |
1849 | <!-- End of BinaryFiles Section -->\r | |
1850 | \r | |
1851 | <xs:element minOccurs="0" maxOccurs="1" name="PackageDependencies">\r | |
1852 | <xs:complexType>\r | |
1853 | <xs:sequence>\r | |
1854 | <xs:element minOccurs="1" maxOccurs="unbounded" name="Package">\r | |
1855 | <xs:complexType>\r | |
1856 | <xs:sequence>\r | |
1857 | <xs:element minOccurs="0" maxOccurs="unbounded" name="Description">\r | |
1858 | <xs:complexType>\r | |
1859 | <xs:simpleContent>\r | |
1860 | <xs:extension base="xs:string">\r | |
1861 | <xs:attribute name="Lang" type="xs:language" default="en-us"\r | |
1862 | use="optional"/>\r | |
1863 | </xs:extension>\r | |
1864 | </xs:simpleContent>\r | |
1865 | </xs:complexType>\r | |
1866 | </xs:element>\r | |
1867 | <xs:element minOccurs="1" maxOccurs="1" name="GUID">\r | |
1868 | <xs:annotation>\r | |
1869 | <xs:documentation xml:lang="en-us"> This GUID and the Version attribute\r | |
1870 | uniquely identify Package that this Module depends on.\r | |
1871 | </xs:documentation>\r | |
1872 | </xs:annotation>\r | |
1873 | <xs:complexType>\r | |
1874 | <xs:simpleContent>\r | |
1875 | <xs:extension base="RegistryFormatGuid">\r | |
1876 | <xs:attribute name="Version" type="xs:decimal" use="optional">\r | |
1877 | <xs:annotation>\r | |
1878 | <xs:documentation xml:lang="en-us"> This value, along with\r | |
1879 | the GUID, is used to uniquely identify this object. If the\r | |
1880 | version attribute is not specified, the most recent version\r | |
1881 | of the package can be used. </xs:documentation>\r | |
1882 | </xs:annotation>\r | |
1883 | </xs:attribute>\r | |
1884 | </xs:extension>\r | |
1885 | </xs:simpleContent>\r | |
1886 | </xs:complexType>\r | |
1887 | </xs:element>\r | |
1888 | </xs:sequence>\r | |
1889 | <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>\r | |
1890 | <xs:attribute name="SupModList" type="ModuleListType" use="optional"/>\r | |
1891 | <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>\r | |
1892 | </xs:complexType>\r | |
1893 | </xs:element>\r | |
1894 | </xs:sequence>\r | |
1895 | </xs:complexType>\r | |
1896 | </xs:element>\r | |
1897 | <!-- End of PackageDependencies -->\r | |
1898 | \r | |
1899 | <xs:element minOccurs="0" maxOccurs="1" name="Guids">\r | |
1900 | <xs:complexType>\r | |
1901 | <xs:sequence>\r | |
1902 | <xs:element minOccurs="1" maxOccurs="unbounded" name="GuidCName">\r | |
1903 | <xs:complexType>\r | |
1904 | <xs:sequence>\r | |
1905 | <xs:element minOccurs="1" maxOccurs="1" name="CName" type="xs:NCName"/>\r | |
1906 | <xs:element minOccurs="0" maxOccurs="1" name="GUID" type="RegistryFormatGuid"/>\r | |
1907 | <xs:element minOccurs="0" maxOccurs="1" name="VariableName"\r | |
1908 | type="xs:normalizedString">\r | |
1909 | <xs:annotation>\r | |
1910 | <xs:documentation xml:lang="en-us"> Only valid for Variable GUID types. </xs:documentation>\r | |
1911 | <xs:documentation> This can be either a Hex Array or C string in unicode\r | |
1912 | format: L"string" Data. </xs:documentation>\r | |
1913 | </xs:annotation>\r | |
1914 | </xs:element>\r | |
1915 | <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>\r | |
1916 | </xs:sequence>\r | |
1917 | <xs:attribute name="Usage" use="required">\r | |
1918 | <xs:simpleType>\r | |
1919 | <xs:restriction base="xs:NCName">\r | |
1920 | <xs:enumeration value="CONSUMES">\r | |
1921 | <xs:annotation>\r | |
1922 | <xs:documentation xml:lang="en-us">The module does not install\r | |
1923 | the GUID, and the GUID must be present for the module to\r | |
1924 | execute. </xs:documentation>\r | |
1925 | </xs:annotation>\r | |
1926 | </xs:enumeration>\r | |
1927 | <xs:enumeration value="SOMETIMES_CONSUMES">\r | |
1928 | <xs:annotation>\r | |
1929 | <xs:documentation xml:lang="en-us"> The module does not install\r | |
1930 | the GUID, however, the GUID will be used if it is present.\r | |
1931 | </xs:documentation>\r | |
1932 | </xs:annotation>\r | |
1933 | </xs:enumeration>\r | |
1934 | <xs:enumeration value="PRODUCES">\r | |
1935 | <xs:annotation>\r | |
1936 | <xs:documentation xml:lang="en-us"> The module always installs\r | |
1937 | the GUID. </xs:documentation>\r | |
1938 | </xs:annotation>\r | |
1939 | </xs:enumeration>\r | |
1940 | <xs:enumeration value="SOMETIMES_PRODUCES">\r | |
1941 | <xs:annotation>\r | |
1942 | <xs:documentation xml:lang="en-us"> The Module will install the\r | |
1943 | GUID under certain execution paths. </xs:documentation>\r | |
1944 | </xs:annotation>\r | |
1945 | </xs:enumeration>\r | |
1946 | <xs:enumeration value="UNDEFINED">\r | |
1947 | <xs:annotation>\r | |
1948 | <xs:documentation xml:lang="en-us"> The package creator knows\r | |
1949 | that a GUID is used, but does not know how it is used.\r | |
1950 | </xs:documentation>\r | |
1951 | </xs:annotation>\r | |
1952 | </xs:enumeration>\r | |
1953 | </xs:restriction>\r | |
1954 | </xs:simpleType>\r | |
1955 | </xs:attribute>\r | |
1956 | <xs:attribute name="GuidType" type="GuidListType" use="required"/>\r | |
1957 | <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>\r | |
1958 | <xs:attribute name="SupModList" type="ModuleListType" use="optional"/>\r | |
1959 | <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>\r | |
1960 | </xs:complexType>\r | |
1961 | </xs:element>\r | |
1962 | </xs:sequence>\r | |
1963 | </xs:complexType>\r | |
1964 | </xs:element>\r | |
1965 | <!-- End of Guids Section -->\r | |
1966 | \r | |
1967 | <xs:element minOccurs="0" maxOccurs="1" name="Protocols">\r | |
1968 | <xs:annotation>\r | |
1969 | <xs:documentation xml:lang="en-us"> A listing of protocols required or produced by this module.\r | |
1970 | </xs:documentation>\r | |
1971 | </xs:annotation>\r | |
1972 | <xs:complexType>\r | |
1973 | <xs:sequence>\r | |
1974 | <xs:element minOccurs="1" maxOccurs="unbounded" name="Protocol" nillable="true">\r | |
1975 | <xs:complexType>\r | |
1976 | <xs:sequence>\r | |
1977 | <xs:element minOccurs="1" maxOccurs="1" name="CName" type="xs:NCName"/>\r | |
1978 | <xs:element minOccurs="0" maxOccurs="1" name="GUID" type="RegistryFormatGuid"/> \r | |
1979 | <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>\r | |
1980 | </xs:sequence>\r | |
1981 | <xs:attribute name="Usage" use="required">\r | |
1982 | <xs:simpleType>\r | |
1983 | <xs:restriction base="xs:NCName">\r | |
1984 | <xs:enumeration value="PRODUCES"/>\r | |
1985 | <xs:enumeration value="SOMETIMES_PRODUCES"/>\r | |
1986 | <xs:enumeration value="CONSUMES"/>\r | |
1987 | <xs:enumeration value="SOMETIMES_CONSUMES"/>\r | |
1988 | <xs:enumeration value="TO_START"/>\r | |
1989 | <xs:enumeration value="BY_START"/>\r | |
1990 | <xs:enumeration value="UNDEFINED"/>\r | |
1991 | </xs:restriction>\r | |
1992 | </xs:simpleType>\r | |
1993 | </xs:attribute>\r | |
1994 | <xs:attribute name="Notify" type="xs:boolean" use="optional"/>\r | |
1995 | <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>\r | |
1996 | <xs:attribute name="SupModList" type="ModuleListType" use="optional"/>\r | |
1997 | <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>\r | |
1998 | </xs:complexType>\r | |
1999 | </xs:element>\r | |
2000 | </xs:sequence>\r | |
2001 | </xs:complexType>\r | |
2002 | </xs:element>\r | |
2003 | <!-- End of Protocols Section -->\r | |
2004 | \r | |
2005 | <xs:element minOccurs="0" maxOccurs="1" name="PPIs">\r | |
2006 | <xs:annotation>\r | |
2007 | <xs:documentation xml:lang="en-us"> A listing of PPIs required or produced by this module.\r | |
2008 | </xs:documentation>\r | |
2009 | </xs:annotation>\r | |
2010 | <xs:complexType>\r | |
2011 | <xs:sequence>\r | |
2012 | <xs:element minOccurs="1" maxOccurs="unbounded" name="Ppi" nillable="true">\r | |
2013 | <xs:complexType>\r | |
2014 | <xs:sequence>\r | |
2015 | <xs:element minOccurs="1" maxOccurs="1" name="CName" type="xs:NCName"/>\r | |
2016 | <xs:element minOccurs="0" maxOccurs="1" name="GUID" type="RegistryFormatGuid"/> \r | |
2017 | <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>\r | |
2018 | </xs:sequence>\r | |
2019 | <xs:attribute name="Usage" use="required">\r | |
2020 | <xs:simpleType>\r | |
2021 | <xs:restriction base="xs:NCName">\r | |
2022 | <xs:enumeration value="PRODUCES"/>\r | |
2023 | <xs:enumeration value="SOMETIMES_PRODUCES"/>\r | |
2024 | <xs:enumeration value="CONSUMES"/>\r | |
2025 | <xs:enumeration value="SOMETIMES_CONSUMES"/>\r | |
2026 | <xs:enumeration value="UNDEFINED"/>\r | |
2027 | </xs:restriction>\r | |
2028 | </xs:simpleType>\r | |
2029 | </xs:attribute>\r | |
2030 | <xs:attribute name="Notify" type="xs:boolean" use="optional"/>\r | |
2031 | <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>\r | |
2032 | <xs:attribute name="SupModList" type="ModuleListType" use="optional"/>\r | |
2033 | <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>\r | |
2034 | </xs:complexType>\r | |
2035 | </xs:element>\r | |
2036 | </xs:sequence>\r | |
2037 | </xs:complexType>\r | |
2038 | </xs:element>\r | |
2039 | <!-- End of PPIs Section -->\r | |
2040 | \r | |
2041 | <xs:element minOccurs="0" maxOccurs="1" name="Externs">\r | |
2042 | <xs:annotation>\r | |
2043 | <xs:documentation xml:lang="en-us"> These elements specify additional information about the\r | |
2044 | module. This area may be used by tools to generate code. </xs:documentation>\r | |
2045 | </xs:annotation>\r | |
2046 | <xs:complexType>\r | |
2047 | <xs:sequence>\r | |
2048 | <xs:element minOccurs="1" maxOccurs="unbounded" name="Extern">\r | |
2049 | <xs:complexType>\r | |
2050 | <xs:sequence>\r | |
2051 | <xs:choice minOccurs="1">\r | |
2052 | <xs:sequence>\r | |
2053 | <xs:element minOccurs="0" maxOccurs="1" name="EntryPoint"\r | |
2054 | type="xs:NCName"/>\r | |
2055 | <xs:element minOccurs="0" maxOccurs="1" name="UnloadImage"\r | |
2056 | type="xs:NCName"/>\r | |
2057 | </xs:sequence>\r | |
2058 | <xs:sequence>\r | |
2059 | <xs:element minOccurs="0" maxOccurs="1" name="Constructor"\r | |
2060 | type="xs:NCName"/>\r | |
2061 | <xs:element minOccurs="0" maxOccurs="1" name="Destructor"\r | |
2062 | type="xs:NCName"/>\r | |
2063 | </xs:sequence>\r | |
2064 | </xs:choice>\r | |
2065 | <xs:element ref="HelpText" minOccurs="0" maxOccurs="1"/>\r | |
2066 | </xs:sequence>\r | |
2067 | <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>\r | |
2068 | <xs:attribute name="SupModList" type="ModuleListType" use="optional"/>\r | |
2069 | <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>\r | |
2070 | </xs:complexType>\r | |
2071 | </xs:element>\r | |
2072 | </xs:sequence>\r | |
2073 | </xs:complexType>\r | |
2074 | </xs:element>\r | |
2075 | <!-- End of Externs Section -->\r | |
2076 | \r | |
2077 | <xs:element minOccurs="0" maxOccurs="1" name="PcdCoded">\r | |
2078 | <xs:annotation>\r | |
2079 | <xs:documentation xml:lang="en-us"> This section describes how a platform is coded with respect\r | |
2080 | to the platform configuration knobs. </xs:documentation>\r | |
2081 | </xs:annotation>\r | |
2082 | <xs:complexType>\r | |
2083 | <xs:sequence>\r | |
2084 | <xs:element minOccurs="1" maxOccurs="unbounded" name="PcdEntry">\r | |
2085 | <xs:complexType>\r | |
2086 | <xs:sequence>\r | |
2087 | <xs:element minOccurs="1" maxOccurs="1" name="CName" type="xs:NCName"/>\r | |
2088 | <xs:element minOccurs="1" maxOccurs="1" name="TokenSpaceGuidCName"\r | |
2089 | type="xs:NCName"/>\r | |
2090 | <xs:element minOccurs="0" maxOccurs="1" name="DefaultValue"\r | |
2091 | type="xs:normalizedString"/>\r | |
2092 | <xs:element ref="HelpText" minOccurs="0" maxOccurs="unbounded"/>\r | |
2093 | </xs:sequence>\r | |
2094 | <xs:attribute name="PcdItemType" type="PcdItemTypes" use="required"/>\r | |
2095 | <xs:attribute name="PcdUsage" use="required">\r | |
2096 | <xs:simpleType>\r | |
2097 | <xs:restriction base="xs:NCName">\r | |
2098 | <xs:enumeration value="PRODUCES"/>\r | |
2099 | <xs:enumeration value="SOMETIMES_PRODUCES"/>\r | |
2100 | <xs:enumeration value="CONSUMES"/>\r | |
2101 | <xs:enumeration value="SOMETIMES_CONSUMES"/>\r | |
2102 | <xs:enumeration value="UNDEFINED"/>\r | |
2103 | </xs:restriction>\r | |
2104 | </xs:simpleType>\r | |
2105 | \r | |
2106 | \r | |
2107 | </xs:attribute>\r | |
2108 | <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>\r | |
2109 | <xs:attribute name="SupModList" type="ModuleListType" use="optional"/>\r | |
2110 | <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>\r | |
2111 | </xs:complexType>\r | |
2112 | </xs:element>\r | |
2113 | </xs:sequence>\r | |
2114 | </xs:complexType>\r | |
2115 | </xs:element>\r | |
2116 | <!-- End of PcdCoded Section -->\r | |
2117 | \r | |
2118 | <xs:element minOccurs="0" maxOccurs="unbounded" name="PeiDepex">\r | |
2119 | <xs:annotation>\r | |
2120 | <xs:documentation xml:lang="en-us"> This is the PEI dependency expression for a Dependency\r | |
2121 | Section. </xs:documentation>\r | |
2122 | </xs:annotation>\r | |
2123 | <xs:complexType>\r | |
2124 | <xs:sequence>\r | |
2125 | <xs:element name="Expression" type="xs:string" minOccurs="1" maxOccurs="1">\r | |
2126 | <xs:annotation>\r | |
2127 | <xs:documentation xml:lang="en-us"> An in-fix expression, of C identifiers and TRUE,\r | |
2128 | FALSE, AND, OR, NOT, BEFORE, and AFTER as well as parenthesis () in the in-fix\r | |
2129 | notation. The operators are restricted to grammar defined in the PI\r | |
2130 | specification. </xs:documentation>\r | |
2131 | </xs:annotation>\r | |
2132 | </xs:element>\r | |
2133 | <xs:element ref="HelpText" minOccurs="0" maxOccurs="1"/>\r | |
2134 | </xs:sequence>\r | |
2135 | <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>\r | |
2136 | <xs:attribute name="SupModList" type="ModuleListType" use="optional"/>\r | |
2137 | <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>\r | |
2138 | </xs:complexType>\r | |
2139 | </xs:element>\r | |
2140 | <!-- End of PeiDepex Section -->\r | |
2141 | \r | |
2142 | <xs:element minOccurs="0" maxOccurs="unbounded" name="DxeDepex">\r | |
2143 | <xs:annotation>\r | |
2144 | <xs:documentation xml:lang="en-us"> This is the DXE dependency expression for a Dependency\r | |
2145 | Section. </xs:documentation>\r | |
2146 | </xs:annotation>\r | |
2147 | <xs:complexType>\r | |
2148 | <xs:sequence>\r | |
2149 | <xs:element name="Expression" type=" xs:string " minOccurs="1" maxOccurs="1">\r | |
2150 | <xs:annotation>\r | |
2151 | <xs:documentation xml:lang="en-us"> An in-fix expression, of C identifiers and TRUE,\r | |
2152 | FALSE, AND, OR, NOT, BEFORE, and AFTER as well as parenthesis () in the in-fix\r | |
2153 | notation. The operators are restricted to grammar defined in the PI\r | |
2154 | specification. </xs:documentation>\r | |
2155 | </xs:annotation>\r | |
2156 | </xs:element>\r | |
2157 | <xs:element ref="HelpText" minOccurs="0" maxOccurs="1"/>\r | |
2158 | </xs:sequence>\r | |
2159 | <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>\r | |
2160 | <xs:attribute name="SupModList" type="ModuleListType" use="optional"/>\r | |
2161 | <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>\r | |
2162 | </xs:complexType>\r | |
2163 | </xs:element>\r | |
2164 | <!-- End of DxeDepex Section -->\r | |
2165 | \r | |
2166 | <xs:element minOccurs="0" maxOccurs="unbounded" name="SmmDepex">\r | |
2167 | <xs:annotation>\r | |
2168 | <xs:documentation xml:lang="en-us"> This is the SMM dependency expression for a Dependency\r | |
2169 | Section. </xs:documentation>\r | |
2170 | </xs:annotation>\r | |
2171 | <xs:complexType>\r | |
2172 | <xs:sequence>\r | |
2173 | <xs:element name="Expression" type=" xs:string " minOccurs="1" maxOccurs="1">\r | |
2174 | <xs:annotation>\r | |
2175 | <xs:documentation xml:lang="en-us"> An in-fix expression, of C identifiers and TRUE,\r | |
2176 | FALSE, AND, OR, NOT, BEFORE, and AFTER as well as parenthesis () in the in-fix\r | |
2177 | notation. The operators are restricted to grammar defined in the PI\r | |
2178 | specification. </xs:documentation>\r | |
2179 | </xs:annotation>\r | |
2180 | </xs:element>\r | |
2181 | <xs:element ref="HelpText" minOccurs="0" maxOccurs="1"/>\r | |
2182 | </xs:sequence>\r | |
2183 | <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>\r | |
2184 | <xs:attribute name="SupModList" type="ModuleListType" use="optional"/>\r | |
2185 | <xs:attribute name="FeatureFlag" type="xs:normalizedString" use="optional"/>\r | |
2186 | </xs:complexType>\r | |
2187 | </xs:element>\r | |
2188 | <!-- End of SmmDepex Section -->\r | |
2189 | \r | |
2190 | \r | |
2191 | <xs:element minOccurs="0" maxOccurs="1" name="MiscellaneousFiles">\r | |
2192 | <xs:annotation>\r | |
2193 | <xs:documentation xml:lang="en-us"> This section is used to provide comments and/or list\r | |
2194 | auxiliary files, such as pdb or map files. </xs:documentation>\r | |
2195 | </xs:annotation>\r | |
2196 | <xs:complexType>\r | |
2197 | <xs:sequence>\r | |
2198 | <xs:element minOccurs="0" maxOccurs="unbounded" name="Description">\r | |
2199 | <xs:complexType>\r | |
2200 | <xs:simpleContent>\r | |
2201 | <xs:extension base="xs:string">\r | |
2202 | <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"\r | |
2203 | />\r | |
2204 | </xs:extension>\r | |
2205 | </xs:simpleContent>\r | |
2206 | </xs:complexType>\r | |
2207 | </xs:element>\r | |
2208 | <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename">\r | |
2209 | <xs:annotation>\r | |
2210 | <xs:documentation xml:lang="en-us"> This is the path and filename location within\r | |
2211 | the ZIP file. </xs:documentation>\r | |
2212 | </xs:annotation>\r | |
2213 | <xs:complexType>\r | |
2214 | <xs:simpleContent>\r | |
2215 | <xs:extension base="xs:anyURI">\r | |
2216 | <xs:attribute name="Executable" type="xs:boolean" default="false"\r | |
2217 | use="optional">\r | |
2218 | <xs:annotation>\r | |
2219 | <xs:documentation xml:lang="en-us"> If true, used by installation\r | |
2220 | tools to ensure that a file that must be executable has the\r | |
2221 | correct properties to permit execution. </xs:documentation>\r | |
2222 | </xs:annotation>\r | |
2223 | </xs:attribute>\r | |
2224 | </xs:extension>\r | |
2225 | </xs:simpleContent>\r | |
2226 | </xs:complexType>\r | |
2227 | </xs:element>\r | |
2228 | </xs:sequence>\r | |
2229 | </xs:complexType>\r | |
2230 | </xs:element>\r | |
2231 | <!-- End of Module Surface Area Misc Section -->\r | |
2232 | \r | |
2233 | <xs:element minOccurs="0" maxOccurs="unbounded" name="UserExtensions">\r | |
2234 | <xs:annotation>\r | |
2235 | <xs:documentation xml:lang="en-us"> This section is used for any processing instructions that\r | |
2236 | may be custom to the content provided by the distribution that are common to module. </xs:documentation>\r | |
2237 | <xs:documentation xml:lang="en-us"> The content is vendor specific. </xs:documentation>\r | |
2238 | <xs:documentation xml:lang="en-us"> The content can be plain text as well as any user-defined,\r | |
2239 | properly formatted XML structure. </xs:documentation>\r | |
2240 | </xs:annotation>\r | |
2241 | <xs:complexType mixed="true">\r | |
2242 | <xs:attribute name="UserId" type="xs:NCName" use="required">\r | |
2243 | <xs:annotation>\r | |
2244 | <xs:documentation xml:lang="en-us"> This is a single word identifier for grouping\r | |
2245 | similar content. For example, ReferenceBuild might be used to identify non-PI\r | |
2246 | compliant build steps, with two different UserExtensions sections, one with an\r | |
2247 | Identifier of Prebuild, and another of PostBuild. Both UserExtensions sections would\r | |
2248 | use the same UserId. </xs:documentation>\r | |
2249 | </xs:annotation>\r | |
2250 | </xs:attribute>\r | |
2251 | <xs:attribute name="Identifier" type="xs:string" use="required">\r | |
2252 | <xs:annotation>\r | |
2253 | <xs:documentation xml:lang="en-us"> This can be any string used to differentiate or\r | |
2254 | identify this section from other UserExtensions sections. </xs:documentation>\r | |
2255 | <xs:documentation xml:lang="en-us"> For example, a PRE_PROCESS Identifier might indicate\r | |
2256 | specific steps and tools required before processing module content, while a\r | |
2257 | different UserExtensions section with a POST_PROCESS Identifier might describe steps\r | |
2258 | that need to be executed after operations on this module. </xs:documentation>\r | |
2259 | </xs:annotation>\r | |
2260 | </xs:attribute>\r | |
2261 | <xs:anyAttribute processContents="lax"/>\r | |
2262 | </xs:complexType>\r | |
2263 | </xs:element>\r | |
2264 | <!-- End of Module Surface Area UserExtensions Section -->\r | |
2265 | \r | |
2266 | </xs:sequence>\r | |
2267 | <xs:attribute name="BinaryModule" type="xs:boolean" default="false" use="optional">\r | |
2268 | <xs:annotation>\r | |
2269 | <xs:documentation xml:lang="en-us"> This attribute is used when the binaries are distributed for\r | |
2270 | this module and no code generation from source files is required. If set, then the BinaryFiles\r | |
2271 | section should be used, and any files listed in the SourceFiles section do not have to be built.\r | |
2272 | Additionally, the AsBuilt section for each binary file must be included. </xs:documentation>\r | |
2273 | </xs:annotation>\r | |
2274 | </xs:attribute>\r | |
2275 | </xs:complexType>\r | |
2276 | \r | |
2277 | </xs:element>\r | |
2278 | <!-- End of the ModuleSurfaceArea element. -->\r | |
2279 | \r | |
2280 | <xs:element name="Tools">\r | |
2281 | <xs:complexType>\r | |
2282 | <xs:sequence>\r | |
2283 | <xs:element minOccurs="0" maxOccurs="1" name="Header">\r | |
2284 | <xs:complexType>\r | |
2285 | <xs:sequence>\r | |
2286 | <xs:element minOccurs="1" maxOccurs="1" name="Name" type="xs:normalizedString">\r | |
2287 | <xs:annotation>\r | |
2288 | <xs:documentation xml:lang="en-us">This is the User Interface Name for this Tools\r | |
2289 | Distribution.</xs:documentation>\r | |
2290 | </xs:annotation>\r | |
2291 | </xs:element>\r | |
2292 | <xs:element minOccurs="0" maxOccurs="1" name="Copyright" type="xs:string">\r | |
2293 | <xs:annotation>\r | |
2294 | <xs:documentation xml:lang="en-us"> This is only required if the Copyright is\r | |
2295 | different from the Distribution Package copyright. </xs:documentation>\r | |
2296 | </xs:annotation>\r | |
2297 | </xs:element>\r | |
2298 | <xs:element minOccurs="0" maxOccurs="1" name="License" type="xs:string">\r | |
2299 | <xs:annotation>\r | |
2300 | <xs:documentation xml:lang="en-us"> This is only required if the License is\r | |
2301 | different from the Distribution Package license. </xs:documentation>\r | |
2302 | </xs:annotation>\r | |
2303 | </xs:element>\r | |
2304 | <xs:element minOccurs="0" maxOccurs="1" name="Abstract">\r | |
2305 | <xs:annotation>\r | |
2306 | <xs:documentation xml:lang="en-us"> This is only required if the Abstract is\r | |
2307 | different from the Distribution Package Abstract. </xs:documentation>\r | |
2308 | </xs:annotation>\r | |
2309 | <xs:complexType>\r | |
2310 | <xs:simpleContent>\r | |
2311 | <xs:extension base="xs:normalizedString">\r | |
2312 | <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"/>\r | |
2313 | </xs:extension> \r | |
2314 | </xs:simpleContent>\r | |
2315 | </xs:complexType>\r | |
2316 | </xs:element>\r | |
2317 | <xs:element minOccurs="0" maxOccurs="1" name="Description">\r | |
2318 | <xs:annotation>\r | |
2319 | <xs:documentation xml:lang="en-us"> This is only required if the Description is\r | |
2320 | different from the Distribution Package Description. </xs:documentation>\r | |
2321 | </xs:annotation>\r | |
2322 | <xs:complexType>\r | |
2323 | <xs:simpleContent>\r | |
2324 | <xs:extension base="xs:string">\r | |
2325 | <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"/>\r | |
2326 | </xs:extension> \r | |
2327 | </xs:simpleContent>\r | |
2328 | </xs:complexType>\r | |
2329 | \r | |
2330 | </xs:element>\r | |
2331 | </xs:sequence>\r | |
2332 | </xs:complexType>\r | |
2333 | </xs:element>\r | |
2334 | <xs:element minOccurs="1" maxOccurs="unbounded" name="Filename">\r | |
2335 | <xs:annotation>\r | |
2336 | <xs:documentation xml:lang="en-us"> This is the path and filename location within the ZIP file.\r | |
2337 | </xs:documentation>\r | |
2338 | </xs:annotation>\r | |
2339 | <xs:complexType>\r | |
2340 | <xs:simpleContent>\r | |
2341 | <xs:extension base="xs:anyURI">\r | |
2342 | <xs:attribute name="OS" type="SupportedOs" use="optional">\r | |
2343 | <xs:annotation>\r | |
2344 | <xs:documentation xml:lang="en-us"> This is required for tools that execute; it\r | |
2345 | should not be used for configuration files. </xs:documentation>\r | |
2346 | </xs:annotation>\r | |
2347 | </xs:attribute>\r | |
2348 | <xs:attribute name="Executable" type="xs:boolean" default="false" use="optional">\r | |
2349 | <xs:annotation>\r | |
2350 | <xs:documentation xml:lang="en-us"> If true, used by installation tools to\r | |
2351 | ensure that a file that must be executable has the correct properties to\r | |
2352 | permit execution. </xs:documentation>\r | |
2353 | </xs:annotation>\r | |
2354 | </xs:attribute>\r | |
2355 | </xs:extension>\r | |
2356 | </xs:simpleContent>\r | |
2357 | </xs:complexType>\r | |
2358 | </xs:element>\r | |
2359 | </xs:sequence>\r | |
2360 | </xs:complexType>\r | |
2361 | </xs:element>\r | |
2362 | <!-- End of the Tools element. -->\r | |
2363 | \r | |
2364 | <xs:element name="MiscellaneousFiles">\r | |
2365 | <xs:annotation>\r | |
2366 | <xs:documentation xml:lang="en-us"> This section contains a list of files that are not part of the code\r | |
2367 | distributed with modules, packages or tools. </xs:documentation>\r | |
2368 | </xs:annotation>\r | |
2369 | <xs:complexType>\r | |
2370 | <xs:sequence>\r | |
2371 | <xs:element minOccurs="0" maxOccurs="1" name="Header">\r | |
2372 | <xs:complexType>\r | |
2373 | <xs:sequence>\r | |
2374 | <xs:element minOccurs="0" maxOccurs="1" name="Name" type="xs:normalizedString">\r | |
2375 | <xs:annotation>\r | |
2376 | <xs:documentation xml:lang="en-us"> The User interface name for this content.\r | |
2377 | </xs:documentation>\r | |
2378 | </xs:annotation>\r | |
2379 | </xs:element>\r | |
2380 | <xs:element minOccurs="0" maxOccurs="1" name="Copyright" type="xs:string">\r | |
2381 | <xs:annotation>\r | |
2382 | <xs:documentation xml:lang="en-us"> This is only required if the Copyright is\r | |
2383 | different from the Distribution Package Copyright. </xs:documentation>\r | |
2384 | </xs:annotation>\r | |
2385 | </xs:element>\r | |
2386 | <xs:element minOccurs="0" maxOccurs="1" name="License" type="xs:string">\r | |
2387 | <xs:annotation>\r | |
2388 | <xs:documentation xml:lang="en-us"> This is only required if the License is\r | |
2389 | different from the Distribution Package License. </xs:documentation>\r | |
2390 | </xs:annotation>\r | |
2391 | </xs:element>\r | |
2392 | <xs:element minOccurs="0" maxOccurs="1" name="Abstract" type="xs:normalizedString"/>\r | |
2393 | <xs:element minOccurs="0" maxOccurs="unbounded" name="Description">\r | |
2394 | <xs:complexType>\r | |
2395 | <xs:simpleContent>\r | |
2396 | <xs:extension base="xs:string">\r | |
2397 | <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"\r | |
2398 | />\r | |
2399 | </xs:extension>\r | |
2400 | </xs:simpleContent>\r | |
2401 | </xs:complexType>\r | |
2402 | </xs:element>\r | |
2403 | </xs:sequence>\r | |
2404 | </xs:complexType>\r | |
2405 | </xs:element>\r | |
2406 | <xs:element minOccurs="0" maxOccurs="unbounded" name="Filename">\r | |
2407 | <xs:annotation>\r | |
2408 | <xs:documentation xml:lang="en-us"> This is the path and filename location within the ZIP file.\r | |
2409 | </xs:documentation>\r | |
2410 | </xs:annotation>\r | |
2411 | <xs:complexType>\r | |
2412 | <xs:simpleContent>\r | |
2413 | <xs:extension base="xs:anyURI">\r | |
2414 | <xs:attribute name="Executable" type="xs:boolean" default="false" use="optional">\r | |
2415 | <xs:annotation>\r | |
2416 | <xs:documentation xml:lang="en-us"> If true, used by installation tools to\r | |
2417 | ensure that a file that must be executable has the correct properties to\r | |
2418 | permit execution. </xs:documentation>\r | |
2419 | </xs:annotation>\r | |
2420 | </xs:attribute>\r | |
2421 | </xs:extension>\r | |
2422 | </xs:simpleContent>\r | |
2423 | </xs:complexType>\r | |
2424 | </xs:element>\r | |
2425 | </xs:sequence>\r | |
2426 | </xs:complexType>\r | |
2427 | </xs:element>\r | |
2428 | <!-- End of the Misc element. -->\r | |
2429 | \r | |
2430 | <xs:element name="UserExtensions">\r | |
2431 | <xs:complexType mixed="true">\r | |
2432 | <xs:sequence>\r | |
2433 | <xs:any processContents="lax" minOccurs="0" maxOccurs="unbounded"/>\r | |
2434 | </xs:sequence>\r | |
2435 | <xs:attribute name="UserId" type="xs:NCName" use="required">\r | |
2436 | <xs:annotation>\r | |
2437 | <xs:documentation xml:lang="en-us"> This is a single word identifier for grouping similar content.\r | |
2438 | For example, ReferenceBuild might be used to identify non-PI compliant build steps, with two\r | |
2439 | different UserExtensions sections, one with an Identifier of Prebuild, and another of PostBuild.\r | |
2440 | Both UserExtensions sections would use the same UserId. </xs:documentation>\r | |
2441 | </xs:annotation>\r | |
2442 | </xs:attribute>\r | |
2443 | <xs:attribute name="Identifier" type="xs:string" use="optional">\r | |
2444 | <xs:annotation>\r | |
2445 | <xs:documentation xml:lang="en-us"> This can be any string used to differentiate or identify this\r | |
2446 | section from other UserExtensions sections. </xs:documentation>\r | |
2447 | <xs:documentation xml:lang="en-us"> For example, a PRE_PROCESS Identifier might indicate specific\r | |
2448 | steps and tools required before processing distribution package content, while a different\r | |
2449 | UserExtensions section with a POST_PROCESS Identifier might describe steps that need to be\r | |
2450 | executed after operations on this content. </xs:documentation>\r | |
2451 | </xs:annotation>\r | |
2452 | </xs:attribute>\r | |
2453 | <xs:anyAttribute processContents="lax"/>\r | |
2454 | </xs:complexType>\r | |
2455 | </xs:element>\r | |
2456 | <!-- The following elsements are common definitions used with the ref attribute for elements. -->\r | |
2457 | \r | |
2458 | <xs:element name="HelpText">\r | |
2459 | <xs:complexType>\r | |
2460 | <xs:simpleContent>\r | |
2461 | <xs:extension base="xs:string">\r | |
2462 | <xs:attribute name="Lang" type="xs:language" default="en-us" use="optional"/>\r | |
2463 | </xs:extension>\r | |
2464 | </xs:simpleContent>\r | |
2465 | </xs:complexType>\r | |
2466 | </xs:element>\r | |
2467 | \r | |
2468 | <!-- The following attribute groups are used in various elements above. -->\r | |
2469 | \r | |
2470 | <xs:attributeGroup name="SupportedArchMod">\r | |
2471 | <xs:attribute name="SupArchList" type="ArchListType" use="optional"/>\r | |
2472 | <xs:attribute name="SupModList" type="ModuleListType" use="optional"/>\r | |
2473 | </xs:attributeGroup>\r | |
2474 | \r | |
2475 | <!-- The following data types are used to restrict content. -->\r | |
2476 | \r | |
2477 | <xs:simpleType name="ArchListType">\r | |
2478 | <xs:list itemType="ArchTypes"/>\r | |
2479 | </xs:simpleType>\r | |
2480 | \r | |
2481 | <xs:simpleType name="ArchTypes">\r | |
2482 | <xs:restriction base="xs:NCName">\r | |
2483 | <xs:enumeration value="IA32"/>\r | |
2484 | <xs:enumeration value="X64"/>\r | |
2485 | <xs:enumeration value="IPF"/>\r | |
2486 | <xs:enumeration value="EBC"/>\r | |
2487 | <xs:enumeration value="ARM"/>\r | |
2488 | <xs:pattern value="([A-Z])([a-zA-Z0-9])*">\r | |
2489 | <xs:annotation>\r | |
2490 | <xs:documentation xml:lang="en-us"> Any processor architecture not listed above. The Architecture\r | |
2491 | must be a target architecture of one or more compiler tool chains. </xs:documentation>\r | |
2492 | </xs:annotation>\r | |
2493 | </xs:pattern>\r | |
2494 | </xs:restriction>\r | |
2495 | </xs:simpleType>\r | |
2496 | \r | |
2497 | \r | |
2498 | <xs:simpleType name="FamilyTypes">\r | |
2499 | <xs:restriction base="xs:NCName">\r | |
2500 | <xs:enumeration value="MSFT"/>\r | |
2501 | <xs:enumeration value="GCC"/>\r | |
2502 | <xs:pattern value="[A-Z][a-zA-Z0-9]*">\r | |
2503 | <xs:annotation>\r | |
2504 | <xs:documentation xml:lang="en-us"> Any other family of build utilities for which compiler tools\r | |
2505 | exist. </xs:documentation>\r | |
2506 | </xs:annotation>\r | |
2507 | </xs:pattern>\r | |
2508 | </xs:restriction>\r | |
2509 | </xs:simpleType>\r | |
2510 | \r | |
2511 | <xs:simpleType name="GuidListType">\r | |
2512 | <xs:list itemType="GuidTypes"/>\r | |
2513 | </xs:simpleType>\r | |
2514 | \r | |
2515 | <xs:simpleType name="GuidTypes">\r | |
2516 | <xs:restriction base="xs:NCName">\r | |
2517 | <xs:enumeration value="Event"/>\r | |
2518 | <xs:enumeration value="File"/>\r | |
2519 | <xs:enumeration value="FV"/>\r | |
2520 | <xs:enumeration value="GUID"/>\r | |
2521 | <xs:enumeration value="HII"/>\r | |
2522 | <xs:enumeration value="Hii"/>\r | |
2523 | <xs:enumeration value="HOB"/>\r | |
2524 | <xs:enumeration value="SystemTable"/>\r | |
2525 | <xs:enumeration value="TokenSpaceGuid"/>\r | |
2526 | <xs:enumeration value="Variable"/>\r | |
2527 | <xs:enumeration value="UNDEFINED"/>\r | |
2528 | </xs:restriction>\r | |
2529 | </xs:simpleType>\r | |
2530 | \r | |
2531 | <xs:simpleType name="HexNumber">\r | |
2532 | <xs:restriction base="xs:hexBinary">\r | |
2533 | <xs:pattern value="0x([a-fA-F0-9])+"/>\r | |
2534 | </xs:restriction>\r | |
2535 | </xs:simpleType>\r | |
2536 | \r | |
2537 | <xs:simpleType name="Md5Sum">\r | |
2538 | <xs:restriction base="xs:normalizedString">\r | |
2539 | <xs:pattern value="[a-zA-Z0-9]{32}"/>\r | |
2540 | </xs:restriction>\r | |
2541 | </xs:simpleType>\r | |
2542 | \r | |
2543 | <xs:simpleType name="ModuleListType">\r | |
2544 | <xs:list itemType="ModuleTypes"/>\r | |
2545 | </xs:simpleType>\r | |
2546 | \r | |
2547 | <xs:simpleType name="ModuleTypes">\r | |
2548 | <xs:annotation>\r | |
2549 | <xs:documentation xml:lang="en-us"> The following module types are defined by specifications. </xs:documentation>\r | |
2550 | <xs:documentation xml:lang="en-us"> Module types for components and libraries defined for this distribution\r | |
2551 | mechanism. </xs:documentation>\r | |
2552 | </xs:annotation>\r | |
2553 | <xs:restriction base="xs:NCName">\r | |
2554 | <xs:enumeration value="BASE ">\r | |
2555 | <xs:annotation>\r | |
2556 | <xs:documentation xml:lang="en-us"> Use of this module is not restricted. </xs:documentation>\r | |
2557 | </xs:annotation>\r | |
2558 | </xs:enumeration>\r | |
2559 | <xs:enumeration value="DXE_CORE">\r | |
2560 | <xs:annotation>\r | |
2561 | <xs:documentation xml:lang="en-us"> This module is only applicable to the DXE core.\r | |
2562 | </xs:documentation>\r | |
2563 | </xs:annotation>\r | |
2564 | </xs:enumeration>\r | |
2565 | <xs:enumeration value="DXE_DRIVER">\r | |
2566 | <xs:annotation>\r | |
2567 | <xs:documentation xml:lang="en-us"> This module is only applicable to a DXE driver.\r | |
2568 | </xs:documentation>\r | |
2569 | </xs:annotation>\r | |
2570 | </xs:enumeration>\r | |
2571 | <xs:enumeration value="DXE_RUNTIME_DRIVER">\r | |
2572 | <xs:annotation>\r | |
2573 | <xs:documentation xml:lang="en-us"> This module is only applicable to a DXE runtime driver.\r | |
2574 | </xs:documentation>\r | |
2575 | </xs:annotation>\r | |
2576 | </xs:enumeration>\r | |
2577 | <xs:enumeration value="DXE_SAL_DRIVER">\r | |
2578 | <xs:annotation>\r | |
2579 | <xs:documentation xml:lang="en-us"> This module is only applicable to an IPF DXE runtime driver.\r | |
2580 | </xs:documentation>\r | |
2581 | </xs:annotation>\r | |
2582 | </xs:enumeration>\r | |
2583 | <xs:enumeration value="DXE_SMM_DRIVER">\r | |
2584 | <xs:annotation>\r | |
2585 | <xs:documentation xml:lang="en-us"> This module is only applicable to a DXE SMM driver.\r | |
2586 | </xs:documentation>\r | |
2587 | </xs:annotation>\r | |
2588 | </xs:enumeration>\r | |
2589 | <xs:enumeration value="PEI_CORE">\r | |
2590 | <xs:annotation>\r | |
2591 | <xs:documentation xml:lang="en-us"> This module is only applicable to the PEI core.\r | |
2592 | </xs:documentation>\r | |
2593 | </xs:annotation>\r | |
2594 | </xs:enumeration>\r | |
2595 | <xs:enumeration value="PEIM">\r | |
2596 | <xs:annotation>\r | |
2597 | <xs:documentation xml:lang="en-us"> This module is only valid for PEI modules. </xs:documentation>\r | |
2598 | </xs:annotation>\r | |
2599 | </xs:enumeration>\r | |
2600 | <xs:enumeration value="SEC">\r | |
2601 | <xs:annotation>\r | |
2602 | <xs:documentation xml:lang="en-us"> This module is only applicable to Security phase.\r | |
2603 | </xs:documentation>\r | |
2604 | </xs:annotation>\r | |
2605 | </xs:enumeration>\r | |
2606 | <xs:enumeration value="UEFI_DRIVER">\r | |
2607 | <xs:annotation>\r | |
2608 | <xs:documentation xml:lang="en-us"> This module is only valid for UEFI drivers. </xs:documentation>\r | |
2609 | </xs:annotation>\r | |
2610 | </xs:enumeration>\r | |
2611 | <xs:enumeration value="UEFI_RUNTIME_DRIVER">\r | |
2612 | <xs:annotation>\r | |
2613 | <xs:documentation xml:lang="en-us"> This module is only valid for UEFI runtime\r | |
2614 | drivers.</xs:documentation>\r | |
2615 | </xs:annotation>\r | |
2616 | </xs:enumeration>\r | |
2617 | <xs:enumeration value="UEFI_APPLICATION">\r | |
2618 | <xs:annotation>\r | |
2619 | <xs:documentation xml:lang="en-us"> This module is only valid for UEFI applications.\r | |
2620 | </xs:documentation>\r | |
2621 | </xs:annotation>\r | |
2622 | </xs:enumeration>\r | |
2623 | <xs:enumeration value="SMM_CORE">\r | |
2624 | <xs:annotation>\r | |
2625 | <xs:documentation xml:lang="en-us"> This module is only applicable to the SMM\r | |
2626 | core.</xs:documentation>\r | |
2627 | </xs:annotation>\r | |
2628 | </xs:enumeration>\r | |
2629 | <xs:enumeration value="USER_DEFINED">\r | |
2630 | <xs:annotation>\r | |
2631 | <xs:documentation xml:lang="en-us"> This content is restricted to a specific implementation.\r | |
2632 | </xs:documentation>\r | |
2633 | </xs:annotation>\r | |
2634 | </xs:enumeration>\r | |
2635 | <xs:enumeration value="UNDEFINED">\r | |
2636 | <xs:annotation>\r | |
2637 | <xs:documentation xml:lang="en-us"> This enumeration is for use in a list that where the package\r | |
2638 | creator does not know the what module types are supported by a module. </xs:documentation>\r | |
2639 | </xs:annotation>\r | |
2640 | </xs:enumeration>\r | |
2641 | <xs:pattern value="([A-Z])([a-zA-Z0-9])*">\r | |
2642 | <xs:annotation>\r | |
2643 | <xs:documentation xml:lang="en-us"> This pattern has been added for use in a module lists - for\r | |
2644 | future expansion. </xs:documentation>\r | |
2645 | </xs:annotation>\r | |
2646 | </xs:pattern>\r | |
2647 | </xs:restriction>\r | |
2648 | </xs:simpleType>\r | |
2649 | \r | |
2650 | <xs:simpleType name="PcdDatumTypes">\r | |
2651 | <xs:annotation>\r | |
2652 | <xs:documentation xml:lang="en-us"> The following data types are defined by the PCD specification (or PCD\r | |
2653 | section of the UEFI/PI specifications.) </xs:documentation>\r | |
2654 | </xs:annotation>\r | |
2655 | <xs:restriction base="xs:normalizedString">\r | |
2656 | <xs:enumeration value="UINT8"/>\r | |
2657 | <xs:enumeration value="UINT16"/>\r | |
2658 | <xs:enumeration value="UINT32"/>\r | |
2659 | <xs:enumeration value="UINT64"/>\r | |
2660 | <xs:enumeration value="BOOLEAN"/>\r | |
2661 | <xs:enumeration value="VOID*"/>\r | |
2662 | </xs:restriction>\r | |
2663 | </xs:simpleType>\r | |
2664 | \r | |
2665 | <xs:simpleType name="PcdItemListType">\r | |
2666 | <xs:list itemType="PcdItemTypes"/>\r | |
2667 | </xs:simpleType>\r | |
2668 | \r | |
2669 | <xs:simpleType name="PcdItemTypes">\r | |
2670 | <xs:restriction base="xs:NCName">\r | |
2671 | <xs:enumeration value="FeaturePcd">\r | |
2672 | <xs:annotation>\r | |
2673 | <xs:documentation xml:lang="en-us"> The Feature PCD is a binary, evaluating to either true or false.\r | |
2674 | This is used during build to include/exclude content. It can also be used during execution to\r | |
2675 | force execution paths within drivers, or to enable/disable features within a driver for a given\r | |
2676 | platform. </xs:documentation>\r | |
2677 | </xs:annotation>\r | |
2678 | </xs:enumeration>\r | |
2679 | <xs:enumeration value="FixedPcd">\r | |
2680 | <xs:annotation>\r | |
2681 | <xs:documentation xml:lang="en-us"> The Fixed PCD is a #define value that is set at build time.\r | |
2682 | </xs:documentation>\r | |
2683 | </xs:annotation>\r | |
2684 | </xs:enumeration>\r | |
2685 | <xs:enumeration value="PatchPcd">\r | |
2686 | <xs:annotation>\r | |
2687 | <xs:documentation xml:lang="en-us"> The Patch PCD is a #define that is set at build time, and that\r | |
2688 | can be modified within a binary file. Additional information, such as the offset location of the\r | |
2689 | value, along with it's length may need to be provided.</xs:documentation>\r | |
2690 | </xs:annotation>\r | |
2691 | </xs:enumeration>\r | |
2692 | <xs:enumeration value="Pcd">\r | |
2693 | <xs:annotation>\r | |
2694 | <xs:documentation xml:lang="en-us"> This PCD type has an overloaded definition. Prior to build, the\r | |
2695 | platform integrator may choose to implement a PCD as Fixed, Patchable or a Dynamic PCD. If the\r | |
2696 | platform integrator choose to use the PCD as dynamic, then a PCD driver is required in the\r | |
2697 | platform (PEI/DXE/both) to track the PCD in some sort of 'database' of these items. For Dynamic\r | |
2698 | PCDs, the PcdGet* must pass in the token space guid and the token number to retrieve data\r | |
2699 | (PcdSet* also needs these values.) </xs:documentation>\r | |
2700 | </xs:annotation>\r | |
2701 | </xs:enumeration>\r | |
2702 | <xs:enumeration value="PcdEx">\r | |
2703 | <xs:annotation>\r | |
2704 | <xs:documentation xml:lang="en-us"> The PCD can only be used as Dynamic, and the platform firmware\r | |
2705 | must contain a driver to maintain a 'database' of these items. For Dynamic PCDs, the PcdGet*\r | |
2706 | must pass in the token space guid and the token number to retrieve data (PcdSet* also needs\r | |
2707 | these values.) </xs:documentation>\r | |
2708 | </xs:annotation>\r | |
2709 | </xs:enumeration>\r | |
2710 | </xs:restriction>\r | |
2711 | </xs:simpleType>\r | |
2712 | \r | |
2713 | <xs:simpleType name="RegistryFormatGuid">\r | |
2714 | <xs:annotation>\r | |
2715 | <xs:documentation xml:lang="en-us"> A GUID must contain five different Hexadecimal character sets that are\r | |
2716 | separated by a dash (-) character. </xs:documentation>\r | |
2717 | </xs:annotation>\r | |
2718 | <xs:restriction base="xs:string">\r | |
2719 | <xs:pattern value="\s*[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\s*"/>\r | |
2720 | </xs:restriction>\r | |
2721 | </xs:simpleType>\r | |
2722 | \r | |
2723 | <xs:simpleType name="SupportedOs">\r | |
2724 | <xs:annotation>\r | |
2725 | <xs:documentation xml:lang="en-us"> The EDK II build system supports workstations running one of the\r | |
2726 | following supported operating systems. This is the OS for the developer's workstation, not the target\r | |
2727 | platform. </xs:documentation>\r | |
2728 | </xs:annotation>\r | |
2729 | <xs:restriction base="xs:string">\r | |
2730 | <xs:enumeration value="Win32">\r | |
2731 | <xs:annotation>\r | |
2732 | <xs:documentation xml:lang="en-us"> For Windows 2003, Windows XP and Windows Vista.\r | |
2733 | </xs:documentation>\r | |
2734 | </xs:annotation>\r | |
2735 | </xs:enumeration>\r | |
2736 | <xs:enumeration value="Win64">\r | |
2737 | <xs:annotation>\r | |
2738 | <xs:documentation xml:lang="en-us"> For Windows 2003, Windows XP and Windows Vista.\r | |
2739 | </xs:documentation>\r | |
2740 | </xs:annotation>\r | |
2741 | </xs:enumeration>\r | |
2742 | <xs:enumeration value="RedHat32"/>\r | |
2743 | <xs:enumeration value="RedHat64"/>\r | |
2744 | <xs:enumeration value="SuSE32"/>\r | |
2745 | <xs:enumeration value="SuSE64"/>\r | |
2746 | <xs:enumeration value="Linux32"/>\r | |
2747 | <xs:enumeration value="Linux64"/>\r | |
2748 | <xs:enumeration value="OS/X32"/>\r | |
2749 | <xs:enumeration value="OS/X64"/>\r | |
2750 | <xs:enumeration value="Generic"/>\r | |
2751 | <xs:enumeration value="GenericWin">\r | |
2752 | <xs:annotation>\r | |
2753 | <xs:documentation xml:lang="en-us"> Typically, this is used for Windows Batch files.\r | |
2754 | </xs:documentation>\r | |
2755 | </xs:annotation>\r | |
2756 | </xs:enumeration>\r | |
2757 | <xs:enumeration value="GenericNix">\r | |
2758 | <xs:annotation>\r | |
2759 | <xs:documentation xml:lang="en-us"> Typically use for shell scripts - valid for any Linux and Mac\r | |
2760 | OS/X. </xs:documentation>\r | |
2761 | </xs:annotation>\r | |
2762 | </xs:enumeration>\r | |
2763 | <xs:pattern value="[a-zA-Z]([a-zA-Z0-9])*"/>\r | |
2764 | </xs:restriction>\r | |
2765 | </xs:simpleType>\r | |
2766 | \r | |
2767 | </xs:schema>\r |