DistributionPackage.xsd 158 KB

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