]> git.proxmox.com Git - mirror_edk2.git/blobdiff - Tools/XMLSchema/SurfaceArea.xsd
Added the OPTIONAL NonProcessedFiles element to MSA section. Sub-element is Filename...
[mirror_edk2.git] / Tools / XMLSchema / SurfaceArea.xsd
index 8cca1211c90d2fc9fdaa5d5f220bd7501a6ff535..d79e574ee0279b1befeec97d499cf5cb567f3c49 100644 (file)
     THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
     WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
     \r
+    APPROVED: 14-Jun-2006\r
   -->\r
   <xs:include schemaLocation="FrameworkHeaders.xsd"/>\r
   <xs:include schemaLocation="FrameworkDataElements.xsd"/>\r
   <xs:include schemaLocation="FrameworkPlatformDataElements.xsd"/>\r
+  <xs:annotation>\r
+    <xs:documentation xml:lang="en">This describes the valid content of a FrameworkDatabase (DB) File.</xs:documentation>\r
+  </xs:annotation>\r
   <xs:element name="FrameworkDatabase">\r
-    <xs:annotation>\r
-      <xs:documentation xml:lang="en">This is the valid format for the Package Database File. Note: MsaList is used for Modules that have not yet been included in a package.</xs:documentation>\r
-    </xs:annotation>\r
     <xs:complexType>\r
       <xs:sequence>\r
         <xs:element minOccurs="1" maxOccurs="1" ref="FdbHeader"/>\r
         <xs:element minOccurs="1" maxOccurs="1" ref="PackageList"/>\r
         <xs:element minOccurs="0" maxOccurs="1" ref="PlatformList"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="PlatformDescriptions">\r
-          <xs:annotation>\r
-            <xs:documentation xml:lang="en">DO NOT USE! - Use PlatformList instead.</xs:documentation>\r
-          </xs:annotation>\r
-        </xs:element>    \r
+        <xs:element minOccurs="0" maxOccurs="1" ref="FarList"/>\r
+        <xs:element minOccurs="0" maxOccurs="unbounded" ref="UserExtensions"/>\r
       </xs:sequence>\r
     </xs:complexType>\r
   </xs:element>\r
-  <xs:element name="FrameworkPlatformDescription">\r
-    <xs:annotation>\r
-      <xs:documentation xml:lang="en">This is the valid format for the Framework Platform Description (FPD) File.</xs:documentation>\r
-    </xs:annotation>\r
+  <xs:annotation>\r
+    <xs:documentation xml:lang="en">This describes the valid content of a Framework Platform Description (FPD) File.</xs:documentation>\r
+  </xs:annotation>\r
+  <xs:element name="PlatformSurfaceArea">\r
     <xs:complexType>\r
       <xs:sequence>\r
         <xs:element minOccurs="1" maxOccurs="1" ref="PlatformHeader"/>\r
+        <!-- This section will be for new definitions of how we put together the Framework Binary Images -->\r
+        <xs:element minOccurs="0" maxOccurs="1" ref="PlatformDefinitions"/>\r
+        <!-- The Flash section is the legacy implementation of Flash -->\r
         <xs:element minOccurs="0" maxOccurs="1" ref="Flash"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="TianoImage">\r
-          <xs:annotation>\r
-            <xs:documentation xml:lang="en">DO NOT USE! - Use FrameworkModules instead.</xs:documentation>\r
-          </xs:annotation>\r
-        </xs:element>    \r
         <xs:element minOccurs="0" maxOccurs="1" ref="FrameworkModules"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="PcdBuildDeclarations">\r
-          <xs:annotation>\r
-            <xs:documentation xml:lang="en">DO NOT USE! - Use PcdBuildDeclaratiion in ModuleSA instead.</xs:documentation>\r
-          </xs:annotation>\r
-        </xs:element>    \r
-        <xs:element minOccurs="0" maxOccurs="1" ref="PcdDynamicBuildDeclarations"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="BuildOptions"/>\r
-      </xs:sequence>\r
-    </xs:complexType>\r
-  </xs:element>\r
-  <xs:element name="LibraryModuleBuildDescription">\r
-    <xs:annotation>\r
-      <xs:documentation xml:lang="en">DO NOT USE - PUT IN PLATFORM DESCRIPTION FILE, FPD</xs:documentation>\r
-    </xs:annotation>\r
-    <xs:complexType>\r
-      <xs:sequence>\r
-        <xs:element minOccurs="1" maxOccurs="1" ref="MbdLibHeader"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="SourceFiles"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="Includes"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="Libraries"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="Protocols"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="Events"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="Hobs"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="PPIs"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="Variables"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="BootModes"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="SystemTables"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="DataHubs"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="Formsets"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="Guids"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="Externs"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="PCDs"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="BuildOptions"/>\r
-      </xs:sequence>\r
-    </xs:complexType>\r
-  </xs:element>\r
-  <xs:element name="LibraryModuleSurfaceArea">\r
-    <xs:annotation>\r
-      <xs:documentation xml:lang="en">DO NOT USE - USE MODULE DESCRIPTION FILE, MSA</xs:documentation>\r
-    </xs:annotation>\r
-    <xs:complexType>\r
-      <xs:sequence>\r
-        <xs:element minOccurs="1" maxOccurs="1" ref="MsaLibHeader"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="LibraryClassDefinitions"/>\r
-        <xs:element minOccurs="1" maxOccurs="1" ref="SourceFiles"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="Includes"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="Protocols"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="Events"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="Hobs"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="PPIs"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="Variables"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="BootModes"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="SystemTables"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="DataHubs"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="Formsets"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="Guids"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="Externs"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="PCDs"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="BuildOptions"/>\r
-      </xs:sequence>\r
-    </xs:complexType>\r
-  </xs:element>\r
-  <xs:element name="ModuleBuildDescription">\r
-    <xs:annotation>\r
-      <xs:documentation xml:lang="en">DO NOT USE - PUT IN PLATFORM DESCRIPTION FILE, FPD</xs:documentation>\r
-    </xs:annotation>\r
-    <xs:complexType>\r
-      <xs:sequence>\r
-        <xs:element minOccurs="1" maxOccurs="1" ref="MbdHeader"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="SourceFiles"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="Includes"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="Libraries"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="Protocols"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="Events"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="Hobs"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="PPIs"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="Variables"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="BootModes"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="SystemTables"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="DataHubs"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="Formsets"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="Guids"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="Externs"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="PCDs"/>\r
+        <xs:element minOccurs="0" maxOccurs="1" ref="DynamicPcdBuildDefinitions"/>\r
         <xs:element minOccurs="0" maxOccurs="1" ref="BuildOptions"/>\r
+        <xs:element minOccurs="0" maxOccurs="unbounded" ref="UserExtensions"/>\r
       </xs:sequence>\r
     </xs:complexType>\r
   </xs:element>\r
+  <xs:annotation>\r
+    <xs:documentation xml:lang="en">This describes the valid content for a Module Surface Area Description (MSA) file.</xs:documentation>\r
+  </xs:annotation>\r
   <xs:element name="ModuleSurfaceArea">\r
-    <xs:annotation>\r
-      <xs:documentation xml:lang="en">This is the Module Surface Area Description that contains the list of the module's source files, library classes that can or must be used by the module, the Include Paths, Protocols and Ppi's that are either produced or consued.</xs:documentation>\r
-    </xs:annotation>\r
     <xs:complexType>\r
       <xs:sequence>\r
         <xs:element minOccurs="1" maxOccurs="1" ref="MsaHeader"/>\r
+        <xs:element minOccurs="1" maxOccurs="1" ref="ModuleDefinitions"/>\r
         <xs:element minOccurs="0" maxOccurs="1" ref="LibraryClassDefinitions"/>\r
-        <xs:element minOccurs="1" maxOccurs="1" ref="SourceFiles"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="Includes"/>\r
+        <xs:element minOccurs="0" maxOccurs="1" ref="SourceFiles"/>\r
+        <xs:element minOccurs="0" maxOccurs="1" ref="NonProcessedFiles"/>\r
+        <xs:element minOccurs="0" maxOccurs="1" ref="PackageDependencies"/>\r
         <xs:element minOccurs="0" maxOccurs="1" ref="Protocols"/>\r
         <xs:element minOccurs="0" maxOccurs="1" ref="Events"/>\r
         <xs:element minOccurs="0" maxOccurs="1" ref="Hobs"/>\r
         <xs:element minOccurs="0" maxOccurs="1" ref="BootModes"/>\r
         <xs:element minOccurs="0" maxOccurs="1" ref="SystemTables"/>\r
         <xs:element minOccurs="0" maxOccurs="1" ref="DataHubs"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="Formsets"/>\r
+        <xs:element minOccurs="0" maxOccurs="1" ref="HiiPackages"/>\r
         <xs:element minOccurs="0" maxOccurs="1" ref="Guids"/>\r
         <xs:element minOccurs="0" maxOccurs="1" ref="Externs"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="PCDs"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="BuildOptions"/>\r
+        <xs:element minOccurs="0" maxOccurs="1" ref="PcdCoded"/>\r
+        <xs:element minOccurs="0" maxOccurs="1" ref="ModuleBuildOptions"/>\r
+        <xs:element minOccurs="0" maxOccurs="unbounded" ref="UserExtensions"/>\r
       </xs:sequence>\r
     </xs:complexType>\r
   </xs:element>\r
+  <xs:annotation>\r
+    <xs:documentation xml:lang="en">This describes the valid content for a Package Surface Area Description (SPD) file.</xs:documentation>\r
+  </xs:annotation>\r
   <xs:element name="PackageSurfaceArea">\r
-    <xs:annotation>\r
-      <xs:documentation xml:lang="en">This is valid content for a Package Surface Area Description (SPD) file.</xs:documentation>\r
-    </xs:annotation>\r
     <xs:complexType>\r
       <xs:sequence>\r
         <xs:element minOccurs="1" maxOccurs="1" ref="SpdHeader"/>\r
+        <xs:element minOccurs="1" maxOccurs="1" ref="PackageDefinitions"/>\r
         <xs:element minOccurs="0" maxOccurs="1" ref="LibraryClassDeclarations"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="PackageDependencies"/>\r
-        <xs:element minOccurs="1" maxOccurs="1" ref="MsaFiles"/>\r
+        <xs:element minOccurs="0" maxOccurs="1" ref="IndustryStdIncludes"/>\r
+        <xs:element minOccurs="0" maxOccurs="1" ref="MsaFiles"/>\r
         <xs:element minOccurs="0" maxOccurs="1" ref="PackageHeaders"/>\r
         <xs:element minOccurs="0" maxOccurs="1" ref="GuidDeclarations"/>\r
         <xs:element minOccurs="0" maxOccurs="1" ref="ProtocolDeclarations"/>\r
         <xs:element minOccurs="0" maxOccurs="1" ref="PpiDeclarations"/>\r
-        <xs:element minOccurs="0" maxOccurs="1" ref="PcdDefinitions"/>\r
+        <xs:element minOccurs="0" maxOccurs="1" ref="PcdDeclarations"/>\r
+        <xs:element minOccurs="0" maxOccurs="unbounded" ref="UserExtensions"/>\r
+      </xs:sequence>\r
+    </xs:complexType>\r
+  </xs:element>\r
+  <!-- This element is listed here, only because we are using elements from both the FrameworkDataElements and FrameworkPlatformDataElements files. -->\r
+  <xs:element name="PlatformDefinitions">\r
+    <xs:complexType>\r
+      <xs:sequence>\r
+        <!-- This is the list of ALL architectures that are supported by this Platform -->\r
+        <xs:element minOccurs="1" maxOccurs="1" name="SupportedArchitectures" type="ArchListType"/>\r
+        <xs:element minOccurs="1" maxOccurs="1" name="BuildTargets" type="BuildTargetList"/>\r
+        <xs:element default="UNIFIED" name="IntermediateDirectories" type="IntermediateOutputType"/>\r
+        <xs:element minOccurs="0" maxOccurs="1" name="OutputDirectory" type="xs:anyURI"/>\r
+        <xs:element minOccurs="0" maxOccurs="1" name="ForceDebugTarget" type="KeywordType"/>\r
+        <!-- SkuInfo is only defined if Sku enabled -->\r
+        <xs:element minOccurs="0" maxOccurs="1" ref="SkuInfo"/>\r
+        <xs:element minOccurs="0" maxOccurs="1" ref="FlashDeviceDefinitions"/>\r
+        <xs:element minOccurs="0" maxOccurs="1" ref="FfsFormatDeclarations"/>\r
+        <xs:element minOccurs="0" maxOccurs="1" name="ClonedFrom">\r
+          <xs:complexType>\r
+            <xs:sequence>\r
+              <xs:element minOccurs="1" maxOccurs="unbounded" name="Cloned">\r
+                <xs:complexType>\r
+                  <xs:sequence>\r
+                    <xs:element minOccurs="1" maxOccurs="1" name="PlatformGuid" type="GuidType"/>\r
+                    <xs:element minOccurs="1" maxOccurs="1" name="PlatformVersion" type="VersionDataType"/>\r
+                  </xs:sequence>\r
+                  <!-- The Id is a number used to track heritage  the first entry will be 0 and increment from then on. -->\r
+                  <xs:attribute name="Id" type="xs:nonNegativeInteger" use="required"/>\r
+                  <!-- If the original module was installed from a FAR, track the FAR it came from. -->\r
+                  <xs:attribute name="FarGuid" type="GuidType" use="optional"/>\r
+                </xs:complexType>\r
+              </xs:element>\r
+            </xs:sequence>\r
+          </xs:complexType>\r
+        </xs:element>\r
       </xs:sequence>\r
     </xs:complexType>\r
   </xs:element>\r