]> git.proxmox.com Git - mirror_edk2.git/blobdiff - Tools/XMLSchema/FrameworkDataElements.xsd
Had to put the Attribute, URL back into the Abstract so that Module Editor would...
[mirror_edk2.git] / Tools / XMLSchema / FrameworkDataElements.xsd
index bbc75d9729d7d441d7492ca1c576cd3232e4908e..284e7080bf03fdbb8a640379aa71b5076a35cc44 100644 (file)
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>\r
 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" xmlns="http://www.TianoCore.org/2006/Edk2.0" targetNamespace="http://www.TianoCore.org/2006/Edk2.0">\r
-    <!--\r
+  <!--\r
     Filename: FrameworkDataElements.xsd\r
     \r
     Copyright (c) 2006, Intel Corp.\r
     WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
     \r
   -->\r
+  <xs:annotation>\r
+    <xs:documentation xml:lang="en"> This schema defines EFI and Framework Data Elements </xs:documentation>\r
+  </xs:annotation>\r
+  <xs:include schemaLocation="NamingConvention.xsd"/>\r
+  <xs:include schemaLocation="FrameworkDataTypes.xsd"/>\r
+  <xs:element name="Abstract">\r
     <xs:annotation>\r
-        <xs:documentation xml:lang="en"> This schema defines EFI and Framework Data Elements </xs:documentation>\r
+      <xs:documentation xml:lang="en">Abstract is valid for all Description Files</xs:documentation>\r
+      <xs:documentation xml:lang="en">This section is required. This is a single sentence to describe the module and will be used in sample files as the abstract data in the header comment section.</xs:documentation>\r
     </xs:annotation>\r
-    <xs:include schemaLocation="NamingConvention.xsd"/>\r
-    <xs:include schemaLocation="FrameworkDataTypes.xsd"/>\r
-    <xs:element name="Abstract">\r
-        <xs:annotation>\r
-            <xs:documentation xml:lang="en">Abstract is valid for all Description Files</xs:documentation>\r
-            <xs:documentation xml:lang="en">This section is required. This is a single sentence to describe the module and will be used in sample files as the abstract data in the header comment section.</xs:documentation>\r
-        </xs:annotation>\r
-        <xs:complexType>\r
-            <xs:simpleContent>\r
-                <xs:extension base="Sentence">\r
-                    <xs:attribute name="URL" type="xs:anyURI"/>\r
-                </xs:extension>\r
-            </xs:simpleContent>\r
-        </xs:complexType>\r
-    </xs:element>\r
-    <xs:element name="AntCmd">\r
-        <xs:annotation>\r
-            <xs:documentation xml:lang="en">This is a sub-element of AntTask</xs:documentation>\r
-            <xs:documentation xml:lang="en">This is an ant command that will be inserted into a biuld sequence. Since ant commands are valid XML statements, special care must be taken to use the correct tokens for reserved words and escape quote characters.</xs:documentation>\r
-        </xs:annotation>\r
-        <xs:complexType>\r
-            <xs:sequence>\r
-                <xs:element minOccurs="0" name="Id" type="xs:int"/>\r
-                <xs:element name="ExecutionOrder">\r
-                    <xs:simpleType>\r
-                        <xs:list itemType="xs:normalizedString"/>\r
-                    </xs:simpleType>\r
-                </xs:element>\r
-            </xs:sequence>\r
-            <xs:attributeGroup ref="SectionAttributes"/>\r
-        </xs:complexType>\r
+      <xs:complexType>\r
+        <xs:simpleContent>\r
+          <xs:extension base="Sentence">\r
+            <xs:attribute name="URL" type="xs:anyURI" use="optional"/>\r
+          </xs:extension>\r
+        </xs:simpleContent>\r
+      </xs:complexType>\r
+  </xs:element>\r
+  <xs:element name="AntCmd">\r
+    <xs:annotation>\r
+      <xs:documentation xml:lang="en">This is a sub-element of AntTask</xs:documentation>\r
+      <xs:documentation xml:lang="en">This is an ant command that will be inserted into a biuld sequence. Since ant commands are valid XML statements, special care must be taken to use the correct tokens for reserved words and escape quote characters.</xs:documentation>\r
+    </xs:annotation>\r
+    <xs:complexType>\r
+      <xs:sequence>\r
+        <xs:element minOccurs="0" name="Id" type="xs:int"/>\r
+          <xs:element name="ExecutionOrder">\r
+            <xs:simpleType>\r
+              <xs:list itemType="xs:normalizedString"/>\r
+            </xs:simpleType>\r
+          </xs:element>\r
+        </xs:sequence>\r
+        <xs:attributeGroup ref="SectionAttributes"/>\r
+      </xs:complexType>\r
     </xs:element>\r
     <xs:element name="AntTask">\r
         <xs:annotation>\r
     <xs:element name="Constructor" type="C_Name"/>\r
     <xs:element name="Copyright" type="Sentence"/>\r
     <xs:element name="Created" type="DateType"/>\r
+    <xs:element name="CreatedDate" type="DateType"/>\r
     <xs:element name="CreatedBy" type="UserName"/>\r
     <xs:element name="DataHubs">\r
         <xs:annotation>\r
         <xs:complexType>\r
             <xs:simpleContent>\r
                 <xs:extension base="Paragraph">\r
-                    <xs:attribute name="URL" type="xs:anyURI"/>\r
+                    <xs:attribute name="URL" type="xs:anyURI" use="optional"/>\r
                 </xs:extension>\r
             </xs:simpleContent>\r
         </xs:complexType>\r
     </xs:element>\r
     <xs:element name="Modified" type="DateType"/>\r
+    <xs:element name="ModifiedDate" type="DateType"/>\r
     <xs:element name="Module">\r
         <xs:annotation>\r
             <xs:documentation xml:lang="en">This is record format for a Module entry in the Framework Database file.</xs:documentation>\r
     </xs:element>\r
     <xs:element name="PcdBuildDeclarations">\r
         <xs:annotation>\r
-            <xs:documentation xml:lang="en">Child of Framework Platform Description (FPD)</xs:documentation>\r
-            <xs:documentation xml:lang="en">We permit the FPD to use an external XML file for PCD information or else the information must be contained within the XML data element, PcdBuildData.</xs:documentation>\r
+            <xs:documentation xml:lang="en">NEW: Will become a child of ModuleSA in the FPD</xs:documentation>\r
         </xs:annotation>\r
         <xs:complexType>\r
             <xs:choice minOccurs="1">\r
                     <xs:complexType>\r
                         <xs:sequence>\r
                             <xs:element minOccurs="1" maxOccurs="1" ref="C_Name"/>\r
+                            <xs:element minOccurs="0" maxOccurs="1" name="TokenSpaceGuid" type="GuidType"/>\r
                             <xs:element minOccurs="1" maxOccurs="1" name="Token">\r
                                 <xs:annotation>\r
                                     <xs:documentation xml:lang="en">This as a unique identifier defined for either this name space.</xs:documentation>\r
                                     <xs:documentation xml:lang="en">This is the C Name for the Variable, and is valid if and only HII is enabled.</xs:documentation>\r
                                 </xs:annotation>\r
                             </xs:element>\r
+                            <xs:element minOccurs="0" maxOccurs="1" name="VariableValueDefault" type="xs:normalizedString"/>\r
                             <xs:element minOccurs="1" maxOccurs="1" name="DataOffset" type="Hex64BitDataType">\r
                                 <xs:annotation>\r
                                     <xs:documentation xml:lang="en">If HII is enabled, This is the offset into the variable data entry, If Vpd is enabled, then it's the Offset into the VPD area of the image defined by platform manufacturer, if neither HII nor Vpd are enabled, it's the offset into the PCD Data Area. HII and VPD can never be enabled at the same time (as of the date of this document.)</xs:documentation>\r
                                 </xs:annotation>\r
                             </xs:element>\r
-                            <xs:element minOccurs="1" maxOccurs="1" name="GuidOffset" type="Hex64BitDataType">\r
+                            <xs:element minOccurs="0" maxOccurs="1" name="GuidOffset" type="Hex64BitDataType">\r
                                 <xs:annotation>\r
-                                    <xs:documentation xml:lang="en">This field is only valid if AlternateNameSpaceEnable is true.</xs:documentation>\r
+                                    <xs:documentation xml:lang="en">FIELD IS NOT USED! REMOVE in FINAL!</xs:documentation>\r
                                 </xs:annotation>\r
                             </xs:element>\r
                             <xs:element minOccurs="1" maxOccurs="1" name="DefaultValue" type="xs:normalizedString"/>\r
                         </xs:sequence>\r
                         <xs:attributeGroup ref="PcdAttributes"/>\r
+                        <xs:attribute name="PcdIsDriver" use="optional">\r
+                           <xs:simpleType>\r
+                             <xs:annotation>\r
+                               <xs:documentation xml:lang="en">This is an enumerated data type that will be used for DYNAMIC_EX, PEIM or DXE only</xs:documentation>\r
+                             </xs:annotation>\r
+                             <xs:restriction base="UCNameType">\r
+                               <xs:enumeration value="PEI_PCD_DRIVER"/>\r
+                               <xs:enumeration value="DXE_PCD_DRIVER"/>\r
+                             </xs:restriction>\r
+                           </xs:simpleType>\r
+                         </xs:attribute>\r
                     </xs:complexType>\r
                 </xs:element>\r
             </xs:choice>\r
         </xs:complexType>\r
-    </xs:element>\r
+    </xs:element> <!-- PcdBuildDeclarations -->\r
+  <xs:element name="PcdDynamicBuildDeclarations">\r
+    <xs:annotation>\r
+      <xs:documentation xml:lang="en">Child of Framework Platform Description (FPD)</xs:documentation>\r
+        <xs:documentation xml:lang="en">We permit the FPD to use an external XML file for PCD information or else the information must be contained within the XML data element, PcdBuildData.</xs:documentation>\r
+      </xs:annotation>\r
+      <xs:complexType>\r
+        <xs:sequence>\r
+          <xs:element minOccurs="0" maxOccurs="unbounded" name="PcdBuildData">\r
+            <xs:annotation>\r
+              <xs:documentation xml:lang="en">Child of PcdBuildDeclarations</xs:documentation>\r
+              <xs:documentation xml:lang="en">This is date element is used in the platform build description file and contains valid data for a Platform Build</xs:documentation>\r
+              <xs:documentation xml:lang="en">There is ONE required Attribute, ItemType</xs:documentation>\r
+            </xs:annotation>\r
+            <xs:complexType>\r
+              <xs:sequence>\r
+                <xs:element minOccurs="1" maxOccurs="1" ref="C_Name"/>\r
+                <xs:element minOccurs="0" maxOccurs="1" name="TokenSpaceGuid" type="GuidType"/>\r
+                <xs:element minOccurs="1" maxOccurs="1" name="Token">\r
+                  <xs:annotation>\r
+                    <xs:documentation xml:lang="en">This as a unique identifier defined for either this name space.</xs:documentation>\r
+                    <xs:documentation xml:lang="en">The Target Attribute may be used to define a Target name space, such as PCI.</xs:documentation>\r
+                  </xs:annotation>\r
+                  <xs:complexType>\r
+                    <xs:simpleContent>\r
+                      <xs:extension base="HexDoubleWordDataType">\r
+                        <xs:attribute name="Target" type="C_Name" use="optional"/>\r
+                      </xs:extension>\r
+                    </xs:simpleContent>\r
+                  </xs:complexType>\r
+                </xs:element>\r
+                <xs:element minOccurs="1" maxOccurs="1" name="DatumType" type="PcdDataTypes">\r
+                  <xs:annotation>\r
+                    <xs:documentation xml:lang="en">This specifies the size of the Pcd Datum. It is either 8, 16, 32 or 64 bits for values, 1 bit for BOOLEAN and variable length for elements defined as VOID*</xs:documentation>\r
+                  </xs:annotation>\r
+                </xs:element>\r
+                <xs:element default="false" minOccurs="1" maxOccurs="1" name="HiiEnable" type="xs:boolean">\r
+                  <xs:annotation>\r
+                    <xs:documentation xml:lang="en">This Bit means that the Variable data is associated with HII</xs:documentation>\r
+                  </xs:annotation>\r
+                </xs:element>\r
+                <xs:element default="false" minOccurs="1" maxOccurs="1" name="VpdEnable" type="xs:boolean">\r
+                  <xs:annotation>\r
+                    <xs:documentation xml:lang="en">This bit enables the Vital Product Data area within flash for maintaining PCD information</xs:documentation>\r
+                  </xs:annotation>\r
+                </xs:element>\r
+                <xs:element default="false" minOccurs="1" maxOccurs="1" name="AlternateNameSpaceEnable" type="xs:boolean">\r
+                  <xs:annotation>\r
+                    <xs:documentation>This is only applicable to ItemType DYNAMIC_EX</xs:documentation>\r
+                  </xs:annotation>\r
+                </xs:element>\r
+                <xs:element default="false" minOccurs="1" maxOccurs="1" name="SkuEnable" type="xs:boolean"/>\r
+                  <xs:element default="false" minOccurs="1" maxOccurs="1" name="SkuDataArrayEnable" type="xs:boolean"/>\r
+                    <xs:choice minOccurs="0">\r
+                      <xs:element minOccurs="0" maxOccurs="1" name="SkuDataArray">\r
+                        <xs:annotation>\r
+                          <xs:documentation xml:lang="en">This element is a list of two entries per line, the first should be an integer, while the second entry should be a string value</xs:documentation>\r
+                        </xs:annotation>\r
+                        <xs:simpleType>\r
+                          <xs:list itemType="xs:normalizedString"/>\r
+                        </xs:simpleType>\r
+                     </xs:element>\r
+                     <xs:element minOccurs="0" maxOccurs="unbounded" name="SkuData">\r
+                       <xs:annotation>\r
+                         <xs:documentation xml:lang="en">This section is for a list of SkuData Elements, ID and Value</xs:documentation>\r
+                       </xs:annotation>\r
+                       <xs:complexType>\r
+                         <xs:sequence minOccurs="1">\r
+                           <xs:element name="Id" type="xs:int"/>\r
+                           <xs:element name="Value" type="xs:normalizedString"/>\r
+                         </xs:sequence>\r
+                       </xs:complexType>\r
+                     </xs:element>\r
+                   </xs:choice>\r
+                   <xs:element default="0x00" minOccurs="1" maxOccurs="1" name="MaxSku" type="HexByteDataType">\r
+                     <xs:annotation>\r
+                       <xs:documentation xml:lang="en">This value comes from a production line database, and has nothing to do with the number of SkuData IDs that have been defined.</xs:documentation>\r
+                     </xs:annotation>\r
+                   </xs:element>\r
+                   <xs:element default="0x00" minOccurs="1" maxOccurs="1" name="SkuId" type="HexByteDataType">\r
+                     <xs:annotation>\r
+                       <xs:documentation xml:lang="en">This is the specific Sku ID for this build.</xs:documentation>\r
+                     </xs:annotation>\r
+                   </xs:element>\r
+                   <xs:element minOccurs="1" maxOccurs="1" name="DatumSize">\r
+                     <xs:annotation>\r
+                       <xs:documentation xml:lang="en">Max Number of Bytes of the data.</xs:documentation>\r
+                     </xs:annotation>\r
+                     <xs:simpleType>\r
+                       <xs:restriction base="xs:int">\r
+                         <xs:minInclusive value="1"/>\r
+                         <xs:maxInclusive value="16777215"/>\r
+                       </xs:restriction>\r
+                     </xs:simpleType>\r
+                   </xs:element>\r
+                   <xs:element minOccurs="1" maxOccurs="1" name="VariableGuid" type="VariableGuidType">\r
+                     <xs:annotation>\r
+                       <xs:documentation xml:lang="en">This is the Variable's GUID if and only if HII is enabled.</xs:documentation>\r
+                     </xs:annotation>\r
+                   </xs:element>\r
+                   <xs:element minOccurs="1" maxOccurs="1" name="VariableName" type="xs:normalizedString">\r
+                     <xs:annotation>\r
+                       <xs:documentation xml:lang="en">This is the C Name for the Variable, and is valid if and only HII is enabled.</xs:documentation>\r
+                     </xs:annotation>\r
+                   </xs:element>\r
+                   <xs:element minOccurs="0" maxOccurs="1" name="VariableValueDefault" type="xs:normalizedString"/>\r
+                   <xs:element minOccurs="1" maxOccurs="1" name="DataOffset" type="Hex64BitDataType">\r
+                                <xs:annotation>\r
+                                    <xs:documentation xml:lang="en">If HII is enabled, This is the offset into the variable data entry, If Vpd is enabled, then it's the Offset into the VPD area of the image defined by platform manufacturer, if neither HII nor Vpd are enabled, it's the offset into the PCD Data Area. HII and VPD can never be enabled at the same time (as of the date of this document.)</xs:documentation>\r
+                                </xs:annotation>\r
+                            </xs:element>\r
+                            <xs:element minOccurs="0" maxOccurs="1" name="GuidOffset" type="Hex64BitDataType">\r
+                                <xs:annotation>\r
+                                    <xs:documentation xml:lang="en">FIELD IS NOT USED! REMOVE in FINAL!</xs:documentation>\r
+                                </xs:annotation>\r
+                            </xs:element>\r
+                            <xs:element minOccurs="1" maxOccurs="1" name="DefaultValue" type="xs:normalizedString"/>\r
+                        </xs:sequence>\r
+                        <xs:attributeGroup ref="PcdAttributes"/>\r
+                        <xs:attribute name="PcdIsDriver" use="optional">\r
+                           <xs:simpleType>\r
+                             <xs:annotation>\r
+                               <xs:documentation xml:lang="en">This is an enumerated data type that will be used for DYNAMIC_EX, PEIM or DXE only</xs:documentation>\r
+                             </xs:annotation>\r
+                             <xs:restriction base="UCNameType">\r
+                               <xs:enumeration value="PEI_PCD_DRIVER"/>\r
+                               <xs:enumeration value="DXE_PCD_DRIVER"/>\r
+                             </xs:restriction>\r
+                           </xs:simpleType>\r
+                         </xs:attribute>\r
+                    </xs:complexType>\r
+                </xs:element>\r
+            </xs:sequence>\r
+        </xs:complexType>\r
+    </xs:element> <!-- PcdDynamicBuildDeclarations -->\r
     <xs:element name="PcdDefinitions">\r
         <xs:annotation>\r
             <xs:documentation xml:lang="en">Child of Package Surface Area Description (SPD)</xs:documentation>\r
         </xs:annotation>\r
         <xs:complexType>\r
             <xs:sequence>\r
-                <xs:element name="PlatformName">\r
+                <xs:element minOccurs="0" maxOccurs="1" name="PlatformName">\r
                     <xs:annotation>\r
                         <xs:documentation xml:lang="en">Define the Name of a Platform</xs:documentation>\r
                     </xs:annotation>\r
                         </xs:simpleContent>\r
                     </xs:complexType>\r
                 </xs:element>\r
-                <xs:element ref="Path"/>\r
+                <xs:element minOccurs="0" maxOccurs="1" ref="Path"/>\r
+                <xs:element minOccurs="0" maxOccurs="1" ref="File"/>\r
+                <xs:element minOccurs="0" maxOccurs="1" ref="InstalledDate"/>\r
+                <xs:element minOccurs="0" maxOccurs="1" ref="ModifiedDate"/>\r
                 <xs:element minOccurs="0" maxOccurs="1" name="AlternatePcdFile" type="FileNameConvention"/>\r
                 <xs:element minOccurs="0" maxOccurs="1" name="AlternateFdfFile" type="FileNameConvention"/>\r
             </xs:sequence>\r