Updated schema, added some new elements that will be used in the final. Added a Datum...

[mirror_edk2.git] / Tools / XMLSchema / SurfaceArea.xsd

diff --git a/Tools/XMLSchema/SurfaceArea.xsd b/Tools/XMLSchema/SurfaceArea.xsd
index 7b309570ae66e8cd9ec084c5bfaa5ec3aab960fd..e5e0276c38058f2b0bab03ecd5e8411468a600e1 100644 (file)
--- a/Tools/XMLSchema/SurfaceArea.xsd
+++ b/Tools/XMLSchema/SurfaceArea.xsd
@@ -15,37 +15,48 @@
     <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">The following defines the valid format for the Framework Database (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="ModuleList"/>\r
-                <xs:element minOccurs="0" maxOccurs="1" ref="PlatformDescriptions"/>\r
+                <xs:choice>\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="PlatformList"/>\r
+                    <!-- DO NOT USE! removing PlatformDescriptions, use PlatformList instead. -->\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="PlatformDescriptions"/>\r
+                </xs:choice>\r
             </xs:sequence>\r
         </xs:complexType>\r
     </xs:element>\r
+    <xs:annotation>\r
+        <xs:documentation xml:lang="en">The following describes the valid format for the Framework Platform Description (FPD) File.</xs:documentation>\r
+    </xs:annotation>\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:complexType>\r
             <xs:sequence>\r
                 <xs:element minOccurs="1" maxOccurs="1" ref="PlatformHeader"/>\r
                 <xs:element minOccurs="0" maxOccurs="1" ref="Flash"/>\r
+                <!-- DO NOT USE! removing TianoImage, use FrameworkModules instead. -->\r
                 <xs:element minOccurs="0" maxOccurs="1" ref="TianoImage"/>\r
+                <xs:element minOccurs="0" maxOccurs="1" ref="FrameworkModules"/>\r
+                <!-- DO NOT USE! removing PcdBuildDeclarations here, use PcdBuildDeclaratiion in ModuleSA instead. -->\r
                 <xs:element minOccurs="0" maxOccurs="1" ref="PcdBuildDeclarations"/>\r
+                <xs:choice minOccurs="0">\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="PcdDynamicBuildDeclarations"/>\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="DynamicPcdBuildDefinitions"/>\r
+                </xs:choice>\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">DO NOT USE removing all Library Module files - PUT IN PLATFORM DESCRIPTION FILE, FPD</xs:documentation>\r
+    </xs:annotation>\r
     <xs:element name="LibraryModuleBuildDescription">\r
-        <xs:annotation>\r
-            <xs:documentation xml:lang="en">This is the Module Build Description that contains the list of overrides, library instances that can or must be used by the library.</xs:documentation>\r
-        </xs:annotation>\r
         <xs:complexType>\r
             <xs:sequence>\r
                 <xs:element minOccurs="1" maxOccurs="1" ref="MbdLibHeader"/>\r
@@ -68,10 +79,10 @@
             </xs:sequence>\r
         </xs:complexType>\r
     </xs:element>\r
+    <xs:annotation>\r
+        <xs:documentation xml:lang="en">DO NOT USE Removing all Library Module files - USE MODULE DESCRIPTION FILE, MSA</xs:documentation>\r
+    </xs:annotation>\r
     <xs:element name="LibraryModuleSurfaceArea">\r
-        <xs:annotation>\r
-            <xs:documentation xml:lang="en">This is the Module Library 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 Class(es) of the Library that will be supported by the library, 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="MsaLibHeader"/>\r
@@ -94,10 +105,10 @@
             </xs:sequence>\r
         </xs:complexType>\r
     </xs:element>\r
+    <xs:annotation>\r
+        <xs:documentation xml:lang="en">DO NOT USE Removing Build Description files - PUT IN PLATFORM DESCRIPTION FILE, FPD or RecommendedInstance Attribute in MSA LibraryClass</xs:documentation>\r
+    </xs:annotation>\r
     <xs:element name="ModuleBuildDescription">\r
-        <xs:annotation>\r
-            <xs:documentation xml:lang="en">This is the Module Build Description that contains the list of overrides, library instances that can or must be used by the module.</xs:documentation>\r
-        </xs:annotation>\r
         <xs:complexType>\r
             <xs:sequence>\r
                 <xs:element minOccurs="1" maxOccurs="1" ref="MbdHeader"/>\r
@@ -120,16 +131,19 @@
             </xs:sequence>\r
         </xs:complexType>\r
     </xs:element>\r
+    <xs:annotation>\r
+        <xs:documentation xml:lang="en">This is the Module Surface Area Description (MSA) 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: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="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:choice minOccurs="0">\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="Includes"/>\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="PackageDependencies"/>\r
+                </xs:choice>\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
@@ -141,26 +155,37 @@
                 <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:choice minOccurs="0">\r
+                    <!-- DO NOT USE! removing PCDs, use MsaPcdDeclarations instead -->\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="PCDs"/>\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="PcdCoded"/>\r
+                </xs:choice>\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 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="0" maxOccurs="1" ref="LibraryClassDeclarations"/>\r
+                <xs:element minOccurs="0" maxOccurs="1" ref="IndustryStdHeaders"/>\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="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:choice minOccurs="0">\r
+                    <!-- DO NOT USE! removing PcdDefinitions, use PcdDeclarations instead. -->\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="PcdDefinitions"/>\r
+                    <xs:element minOccurs="0" maxOccurs="1" ref="PcdDeclarations"/>\r
+                </xs:choice>\r
+                <xs:element minOccurs="0" maxOccurs="unbounded" ref="UserExtensions"/>\r
             </xs:sequence>\r
         </xs:complexType>\r
     </xs:element>\r