Tools/XMLSchema/FrameworkHeaders.xsd

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" targetNamespace="http://www.TianoCore.org/2006/Edk2.0" xmlns="http://www.TianoCore.org/2006/Edk2.0">
   3     <!--
   4     Filename: FrameworkHeaders.xsd
   5
   6     Copyright (c) 2006, Intel Corp.
   7     All rights reserved. This program and the accompanying materials
   8     are licensed and made available under the terms and conditions of the BSD License
   9     which may be found at http://opensource.org/licenses/bsd-license.php
  10
  11     THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12     WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14   -->
  15     <xs:include schemaLocation="FrameworkDataElements.xsd"/>
  16     <xs:element name="FdbHeader">
  17         <xs:annotation>
  18             <xs:documentation xml:lang="en">This is the header for the Framework Package Database file.</xs:documentation>
  19         </xs:annotation>
  20         <xs:complexType>
  21             <xs:sequence>
  22                 <xs:element minOccurs="1" maxOccurs="1" ref="DatabaseName"/>
  23                 <!-- Value fixed during initialization: FrameworkDatabase -->
  24                 <xs:choice minOccurs="1" maxOccurs="1">
  25                     <xs:element minOccurs="0" maxOccurs="1" ref="Guid"/>
  26                     <!-- Guid needs to be removed -->
  27                     <xs:element minOccurs="0" maxOccurs="1" ref="GuidValue"/>
  28                     <!-- GuidValue needs to be required -->
  29                 </xs:choice>
  30                 <xs:element minOccurs="1" maxOccurs="1" ref="Version"/>
  31                 <!-- Version is the version of this file -->
  32                 <xs:element minOccurs="0" maxOccurs="1" ref="Path"/>
  33                 <!-- Path needs to be removed -->
  34                 <xs:choice minOccurs="1" maxOccurs="1">
  35                     <xs:element minOccurs="0" maxOccurs="1" ref="Created"/>
  36                     <!-- Created needs to be removed -->
  37                     <xs:element minOccurs="0" maxOccurs="1" ref="CreatedDate"/>
  38                     <!-- CreatedDate needs to be required -->
  39                 </xs:choice>
  40                 <xs:choice minOccurs="0">
  41                     <xs:element minOccurs="0" maxOccurs="1" ref="Updated"/>
  42                     <!-- Updated needs to be removed -->
  43                     <xs:element minOccurs="0" maxOccurs="1" ref="UpdatedDate"/>
  44                 </xs:choice>
  45                 <xs:element minOccurs="1" maxOccurs="1" ref="Abstract"/>
  46                 <xs:element minOccurs="1" maxOccurs="1" ref="Description"/>
  47                 <xs:element minOccurs="1" maxOccurs="1" ref="Copyright"/>
  48                 <xs:element minOccurs="1" maxOccurs="1" ref="License"/>
  49                 <xs:element minOccurs="0" maxOccurs="1" name="Specification" type="xs:string"/>
  50                 <!-- Specificatoin needs to be required - FRAMEWORK_BUILD_PACKAGING_SPECIFICATION   0x00090000 -->
  51             </xs:sequence>
  52         </xs:complexType>
  53     </xs:element>
  54     <xs:element name="MbdHeader">
  55         <!-- MbdHeader needs to be removed -->
  56         <xs:annotation>
  57             <xs:documentation xml:lang="en">DO NOT USE! This is the header for the Component Module Build Description (MBD) file. NOTE: The GUID may be different from the GUID in the MSA file, as the Guid is updated every time the file is changed, as the Guid may change if the contents of the file are changed.</xs:documentation>
  58         </xs:annotation>
  59         <xs:complexType>
  60             <xs:sequence>
  61                 <xs:element minOccurs="1" maxOccurs="1" ref="BaseName"/>
  62                 <xs:element minOccurs="1" maxOccurs="1" ref="Guid"/>
  63                 <xs:element minOccurs="1" maxOccurs="1" ref="Version"/>
  64                 <xs:element minOccurs="1" maxOccurs="1" ref="Description"/>
  65                 <xs:element minOccurs="1" maxOccurs="1" ref="Copyright"/>
  66                 <xs:element minOccurs="1" maxOccurs="1" ref="License"/>
  67                 <xs:element minOccurs="0" maxOccurs="1" name="Specification" type="xs:string"/>
  68                 <xs:choice minOccurs="1" maxOccurs="1">
  69                     <xs:element minOccurs="0" maxOccurs="1" ref="Created"/>
  70                     <xs:element minOccurs="0" maxOccurs="1" ref="CreatedDate"/>
  71                 </xs:choice>
  72                 <xs:choice minOccurs="1" maxOccurs="1">
  73                     <xs:element minOccurs="0" maxOccurs="1" ref="Modified"/>
  74                     <xs:element minOccurs="0" maxOccurs="1" ref="ModifiedDate"/>
  75                 </xs:choice>
  76             </xs:sequence>
  77         </xs:complexType>
  78     </xs:element>
  79     <xs:element name="MbdLibHeader">
  80         <!-- MbdLibHeader needs to be removed -->
  81         <xs:annotation>
  82             <xs:documentation xml:lang="en">DO NOT USE! This is the header for the Library Module Build Description (MBD) file. NOTE: The Guid may be different from the Guid in the MSA file, as the Guid may change when the contents of the file are changed..</xs:documentation>
  83         </xs:annotation>
  84         <xs:complexType>
  85             <xs:sequence>
  86                 <xs:element minOccurs="1" maxOccurs="1" ref="BaseName"/>
  87                 <xs:element minOccurs="1" maxOccurs="1" ref="Guid"/>
  88                 <xs:element minOccurs="1" maxOccurs="1" ref="Version"/>
  89                 <xs:element minOccurs="1" maxOccurs="1" ref="Description"/>
  90                 <xs:element minOccurs="1" maxOccurs="1" ref="Copyright"/>
  91                 <xs:element minOccurs="1" maxOccurs="1" ref="License"/>
  92                 <xs:element minOccurs="0" maxOccurs="1" name="Specification" type="xs:string"/>
  93                 <xs:choice minOccurs="1" maxOccurs="1">
  94                     <xs:element minOccurs="0" maxOccurs="1" ref="Created"/>
  95                     <xs:element minOccurs="0" maxOccurs="1" ref="CreatedDate"/>
  96                 </xs:choice>
  97                 <xs:choice minOccurs="1" maxOccurs="1">
  98                     <xs:element minOccurs="0" maxOccurs="1" ref="Modified"/>
  99                     <xs:element minOccurs="0" maxOccurs="1" ref="ModifiedDate"/>
 100                 </xs:choice>
 101             </xs:sequence>
 102         </xs:complexType>
 103     </xs:element>
 104     <xs:element name="MsaHeader">
 105         <xs:annotation>
 106             <xs:documentation xml:lang="en">This is the Component Module Surface Area Description Header - a replacement for INF files. The GUID may change when the contents of the file are changed.</xs:documentation>
 107         </xs:annotation>
 108         <xs:complexType>
 109             <xs:sequence>
 110                 <xs:choice>
 111                     <!-- BaseName needs to be removed  -->
 112                     <xs:element minOccurs="0" maxOccurs="1" ref="BaseName"/>
 113                     <!-- ModuleName needs to be required -->
 114                     <xs:element minOccurs="0" maxOccurs="1" name="ModuleName" type="UiNameType"/>
 115                 </xs:choice>
 116                 <xs:element minOccurs="1" maxOccurs="1" ref="ModuleType"/>
 117                 <xs:element minOccurs="0" maxOccurs="1" ref="ComponentType"/>
 118                 <xs:choice>
 119                     <!-- Guid needs to be removed -->
 120                     <xs:element minOccurs="0" maxOccurs="1" ref="Guid"/>
 121                     <!-- GuidValue needs to be required -->
 122                     <xs:element minOccurs="0" maxOccurs="1" ref="GuidValue"/>
 123                 </xs:choice>
 124                 <!-- Version needs to be a decimal in final -->
 125                 <xs:element minOccurs="1" maxOccurs="1" ref="Version"/>
 126                 <xs:element minOccurs="1" maxOccurs="1" ref="Abstract"/>
 127                 <xs:element minOccurs="1" maxOccurs="1" ref="Description"/>
 128                 <xs:element minOccurs="1" maxOccurs="1" ref="Copyright"/>
 129                 <xs:element minOccurs="1" maxOccurs="1" ref="License"/>
 130                 <xs:choice minOccurs="1" maxOccurs="1">
 131                     <!-- Created needs to be removed -->
 132                     <xs:element minOccurs="0" maxOccurs="1" ref="Created"/>
 133                     <!-- CreatedDate needs to be removed -->
 134                     <xs:element minOccurs="0" maxOccurs="1" ref="CreatedDate"/>
 135                 </xs:choice>
 136                 <xs:choice>
 137                     <!-- Updated needs to be removed -->
 138                     <xs:element minOccurs="0" maxOccurs="1" ref="Updated"/>
 139                     <!-- ModifiedDate needs to be removed -->
 140                     <xs:element minOccurs="0" maxOccurs="1" ref="ModifiedDate"/>
 141                 </xs:choice>
 142                 <xs:element default="false" minOccurs="0" name="BinaryModule" type="xs:boolean"/>
 143                 <!-- Specification needs to be required - FRAMEWORK_BUILD_PACKAGING_SPECIFICATION   0x00000052 -->
 144                 <xs:element minOccurs="0" maxOccurs="1" name="Specification" type="xs:string"/>
 145             </xs:sequence>
 146         </xs:complexType>
 147     </xs:element>
 148     <xs:element name="MsaLibHeader">
 149         <!-- MsaLibHeader needs to be removed -->
 150         <xs:annotation>
 151             <xs:documentation xml:lang="en">DO NOT USE! This is the Library Module Surface Area Description Header - a replacement for INF files. The Guid may change when the contents of the file are changed.</xs:documentation>
 152         </xs:annotation>
 153         <xs:complexType>
 154             <xs:sequence>
 155                 <xs:element minOccurs="1" maxOccurs="1" ref="BaseName"/>
 156                 <xs:element minOccurs="1" maxOccurs="1" ref="ModuleType"/>
 157                 <xs:element minOccurs="1" maxOccurs="1" ref="ComponentType"/>
 158                 <xs:element minOccurs="1" maxOccurs="1" ref="Guid"/>
 159                 <xs:element minOccurs="1" maxOccurs="1" ref="Version"/>
 160                 <xs:element minOccurs="1" maxOccurs="1" ref="Abstract"/>
 161                 <xs:element minOccurs="1" maxOccurs="1" ref="Description"/>
 162                 <xs:element minOccurs="1" maxOccurs="1" ref="Copyright"/>
 163                 <xs:element minOccurs="1" maxOccurs="1" ref="License"/>
 164                 <xs:choice minOccurs="1" maxOccurs="1">
 165                     <xs:element minOccurs="0" maxOccurs="1" ref="Created"/>
 166                     <xs:element minOccurs="0" maxOccurs="1" ref="CreatedDate"/>
 167                 </xs:choice>
 168                 <xs:element minOccurs="0" maxOccurs="1" ref="Updated"/>
 169                 <xs:element minOccurs="0" maxOccurs="1" name="Specification" type="xs:string"/>
 170             </xs:sequence>
 171         </xs:complexType>
 172     </xs:element>
 173     <xs:element name="PlatformHeader">
 174         <xs:annotation>
 175             <xs:documentation xml:lang="en">This head is for the Framework Platform Description file (FPD.)</xs:documentation>
 176         </xs:annotation>
 177         <xs:complexType>
 178             <xs:sequence>
 179                 <xs:element minOccurs="1" maxOccurs="1" name="PlatformName" type="PlatformNamingConvention"/>
 180                 <xs:choice>
 181                     <xs:element minOccurs="0" maxOccurs="1" ref="Guid"/>
 182                     <!-- DO NOT USE Guid needs to be removed -->
 183                     <xs:element minOccurs="0" maxOccurs="1" ref="GuidValue"/>
 184                     <!-- GuidValue needs to be required -->
 185                 </xs:choice>
 186                 <!-- Version needs to be xs:decimal in final -->
 187                 <xs:element minOccurs="0" maxOccurs="1" ref="Version"/>
 188                 <xs:element minOccurs="1" maxOccurs="1" ref="Abstract"/>
 189                 <xs:element minOccurs="1" maxOccurs="1" ref="Description"/>
 190                 <xs:element minOccurs="0" maxOccurs="1" ref="Copyright"/>
 191                 <xs:element minOccurs="0" maxOccurs="1" ref="License"/>
 192                 <xs:choice minOccurs="1" maxOccurs="1">
 193                     <!-- DO NOT USE Created needs to be removed -->
 194                     <xs:element minOccurs="0" maxOccurs="1" ref="Created"/>
 195                     <!-- DO NOT USE CreatedDate needs to be removed -->
 196                     <xs:element minOccurs="0" maxOccurs="1" ref="CreatedDate"/>
 197                 </xs:choice>
 198                 <!-- DO NOT USE CreatedBy needs to be removed -->
 199                 <xs:element minOccurs="0" maxOccurs="1" ref="CreatedBy"/>
 200                 <xs:choice>
 201                     <!-- DO NOT USE Updated needs to be removed -->
 202                     <xs:element minOccurs="0" maxOccurs="1" ref="Updated"/>
 203                     <!-- DO NOT USE ModifiedDate needs to be removed -->
 204                     <xs:element minOccurs="0" maxOccurs="1" ref="ModifiedDate"/>
 205                 </xs:choice>
 206                 <!-- DO NOT USE PackageType needs to be removed -->
 207                 <xs:element minOccurs="0" maxOccurs="1" ref="PackageType"/>
 208                 <!-- DO NOT USE BuildTarget needs to be removed -->
 209                 <xs:element minOccurs="0" maxOccurs="1" name="BuildTarget" type="BuildTargets"/>
 210                 <!-- Specification needs to be required - FRAMEWORK_BUILD_PACKAGING_SPECIFICATION   0x00000052 -->
 211                 <xs:element minOccurs="0" maxOccurs="1" name="Specification" type="xs:string"/>
 212             </xs:sequence>
 213         </xs:complexType>
 214     </xs:element>
 215     <xs:element name="SpdHeader">
 216         <xs:annotation>
 217             <xs:documentation xml:lang="en">This head is for the Surface Area Package Description file (SPD)</xs:documentation>
 218             <xs:documentation xml:lang="en">The Guid MUST change when the contents of the file undergo MAJOR FUNCTIONALITY changes.</xs:documentation>
 219             <xs:documentation xml:lang="en">The Version MUST change when the contents of the file undergo MINOR FUNCTIONALITY changes.</xs:documentation>
 220         </xs:annotation>
 221         <xs:complexType>
 222             <xs:sequence>
 223                 <xs:element minOccurs="1" maxOccurs="1" name="PackageName" type="UiNameType"/>
 224                 <xs:choice minOccurs="1" maxOccurs="1">
 225                     <!-- DO NOT USE! Guid needs to be removed -->
 226                     <xs:element minOccurs="0" maxOccurs="1" ref="Guid"/>
 227                     <!-- GuidValue needs to be required -->
 228                     <xs:element minOccurs="0" maxOccurs="1" ref="GuidValue"/>
 229                 </xs:choice>
 230                 <xs:element minOccurs="1" maxOccurs="1" ref="Version"/>
 231                 <xs:element minOccurs="1" maxOccurs="1" ref="Abstract"/>
 232                 <xs:element minOccurs="1" maxOccurs="1" ref="Description"/>
 233                 <xs:element minOccurs="1" maxOccurs="1" ref="Copyright"/>
 234                 <xs:element minOccurs="1" maxOccurs="1" ref="License"/>
 235                 <xs:choice minOccurs="1" maxOccurs="1">
 236                     <!-- Created needs to be removed -->
 237                     <xs:element minOccurs="0" maxOccurs="1" ref="Created"/>
 238                     <!-- CreatedDate needs to be removed -->
 239                     <xs:element minOccurs="0" maxOccurs="1" ref="CreatedDate"/>
 240                 </xs:choice>
 241                 <!-- E_Mail needs to be removed -->
 242                 <xs:element minOccurs="0" maxOccurs="1" ref="E-Mail"/>
 243                 <xs:choice minOccurs="0" maxOccurs="1">
 244                     <!-- Updated needs to be removed -->
 245                     <xs:element minOccurs="0" maxOccurs="1" ref="Updated"/>
 246                     <!-- UpdatedDate needs to be removed -->
 247                     <xs:element minOccurs="0" maxOccurs="1" ref="ModifiedDate"/>
 248                 </xs:choice>
 249                 <!-- URL needs to be removed -->
 250                 <xs:element minOccurs="0" maxOccurs="1" ref="URL"/>
 251                 <!-- PackageType needs to be removed -->
 252                 <xs:element minOccurs="0" maxOccurs="1" ref="PackageType"/>
 253                 <!-- ReadOnly and RePackage remain in final -->
 254                 <xs:element minOccurs="0" maxOccurs="1" ref="ReadOnly"/>
 255                 <xs:element minOccurs="0" maxOccurs="1" ref="RePackage"/>
 256                 <!-- Specification needs to be required - FRAMEWORK_BUILD_PACKAGING_SPECIFICATION   0x00000052 -->
 257                 <xs:element minOccurs="0" maxOccurs="1" name="Specification" type="xs:string"/>
 258                 <!-- OutputDirectory needs to be removed -->
 259                 <xs:element minOccurs="0" maxOccurs="1" ref="OutputDirectory"/>
 260             </xs:sequence>
 261         </xs:complexType>
 262     </xs:element>
 263 </xs:schema>