DistributionPackage.xsd 158 KB

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