Add version check in both PCD database generation and service driver.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@292 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/EdkModulePkg/Universal/PCD/Dxe/Service.h b/EdkModulePkg/Universal/PCD/Dxe/Service.h
index d5918f2693f7b7977ce5b19aa2ff11931ec86316..54ab1b6551667dfc4511c4eba4bd6649872dc4a3 100644 (file)
--- a/EdkModulePkg/Universal/PCD/Dxe/Service.h
+++ b/EdkModulePkg/Universal/PCD/Dxe/Service.h
@@ -18,197 +18,20 @@ Module Name: Service.h
 #ifndef _SERVICE_H\r
 #define _SERVICE_H\r
 \r
 #ifndef _SERVICE_H\r
 #define _SERVICE_H\r
 \r

-#define USE_AUTOGEN\r
-\r
-#ifndef USE_AUTOGEN\r
-//\r
-// The following definition will be generated by build tool \r
-//\r
-\r
-//\r
-// Common definitions\r
-//\r
-#define PCD_TYPE_SHIFT        24\r
-\r
-\r
-#define PCD_TYPE_DATA         (0x00 << PCD_TYPE_SHIFT)\r
-#define PCD_TYPE_HII               (0x80 << PCD_TYPE_SHIFT)\r
-#define PCD_TYPE_VPD               (0x40 << PCD_TYPE_SHIFT)\r
-#define PCD_TYPE_SKU_ENABLED   (0x20 << PCD_TYPE_SHIFT)\r
-\r
-\r
-#define PCD_DATABASE_OFFSET_MASK (~(PCD_TYPE_HII | PCD_TYPE_VPD | PCD_TYPE_SKU_ENABLED))\r
-\r
-typedef struct  {\r
-  UINT32                ExTokenNumber;\r
-  UINT32                LocalTokenNumber;   // PCD Number of this particular platform build\r
-  UINT16                ExGuidIndex;        // Index of GuidTable\r
-} DYNAMICEX_MAPPING;\r
-\r
-\r
-typedef struct {\r
-  UINT32  SkuDataStartOffset; //We have to use offsetof MACRO as we don't know padding done by compiler\r
-  UINT32  SkuIdTableOffset;   //Offset from the PCD_DB\r
-} SKU_HEAD;\r
-\r
-\r
-typedef struct {\r
-  UINT16  GuidTableIndex;   // Offset in Guid Table in units of GUID.\r
-  UINT16  StringIndex;           // Offset in String Table in units of UINT16.\r
-  UINT16  Offset;           // Offset in Variable\r
-} VARIABLE_HEAD  ;\r
-\r
-\r
-typedef  struct {\r
-  UINT32  Offset;\r
-} VPD_HEAD;\r
-\r
-typedef struct {\r
-  UINT32 LocalTokenNumber;\r
-  UINT16 TokenNumber;\r
-  UINT16 Size;\r
-} SIZEINFO;\r
-\r
-#define offsetof(s,m)                 (UINT32)&(((s *)0)->m)\r
-\r
-\r
-\r
-//\r
-// C Structure generate for PEI PCD Database\r
-//\r
-#define PEI_EXMAPPING_TABLE_SIZE  1\r
-#define PEI_GUID_TABLE_SIZE         1\r
-#define PEI_LOCAL_TOKEN_NUMBER            1\r
-#define PEI_EXTOKEN_NUMBER          1\r
-#define PEI_STRING_TABLE_SIZE        2\r
-#define PEI_SKUID_TABLE_SIZE         3\r
-#define PEI_SIZE_TABLE_SIZE          1\r
-\r
-#define PEI_DATABASE_EMPTRY          FALSE\r
-#define PEI_DYNAMICEX_MAPPING_EMPTY  FALSE\r
-#define PEI_GUID_TABLE_EMPTY         FALSE\r
-#define PEI_STRINGTABLE_EMPTY        FALSE\r
-#define PEI_SIZETABLE_EMPTY          FALSE\r
-#define PEI_SKUID_TABLE_EMPTY        FALSE\r
-\r
-\r
-typedef struct {\r
-\r
-  DYNAMICEX_MAPPING ExMapTable[PEI_EXMAPPING_TABLE_SIZE];\r
-  EFI_GUID          GuidTable[PEI_GUID_TABLE_SIZE];\r
-\r
-  UINT32            LocalTokenNumberTable[PEI_LOCAL_TOKEN_NUMBER];\r
-\r
-\r
-  UINT16            StringTable[PEI_STRING_TABLE_SIZE];\r
-  UINT16            SizeTable[PEI_LOCAL_TOKEN_NUMBER];\r
-  \r
-  SKU_ID            SkuIdTable[PEI_SKUID_TABLE_SIZE];\r
-  \r
-  SKU_ID            SystemSkuId;\r
-\r
-} PEI_PCD_DATABASE_INIT;\r
-\r
-typedef struct {\r
-  UINT8 Dummy;\r
-} PEI_PCD_DATABASE_UNINIT;\r
-\r

 //\r
 //\r

-// Following code should be generated for PCD DXE driver\r
+// Please make sure the PCD Serivce PEIM Version is consistent with\r
+// the version of PCD Database generation tool\r

 //\r
 //\r

-\r
-#define DXE_EXMAPPING_TABLE_SIZE  1\r
-#define DXE_GUID_TABLE_SIZE         1\r
-#define DXE_TOKEN_NUMBER            1\r
-#define DXE_EXTOKEN_NUMBER          1\r
-#define DXE_STRING_TABLE_SIZE        2\r
-#define DXE_SKUID_TABLE_SIZE         3\r
-#define DXE_SIZE_TABLE_SIZE          1\r
-\r
-#define DXE_DATABASE_EMPTRY          FALSE\r
-#define DXE_DYNAMICEX_MAPPING_EMPTY  FALSE\r
-#define DXE_GUID_TABLE_EMPTY         FALSE\r
-#define DXE_STRINGTABLE_EMPTY        FALSE\r
-#define DXE_SIZETABLE_EMPTY          FALSE\r
-#define DXE_SKUID_TABLE_EMPTY        FALSE\r
-\r
-typedef struct {\r
-  DYNAMICEX_MAPPING ExMapTable[DXE_EXMAPPING_TABLE_SIZE];\r
-  EFI_GUID          GuidTable[DXE_GUID_TABLE_SIZE];\r
-\r
-  UINT32            LocalTokenNumberTable[DXE_TOKEN_NUMBER];\r
-\r
-\r
-  UINT16            StringTable[DXE_STRING_TABLE_SIZE];\r
-  UINT16            SizeTable[DXE_TOKEN_NUMBER];\r
-  \r
-  SKU_ID            SkuIdTable[DXE_SKUID_TABLE_SIZE];\r
-  \r
-} DXE_PCD_DATABASE_INIT;\r
-\r
-typedef struct {\r
-  UINT8 Dummy;\r
-} DXE_PCD_DATABASE_UNINIT;\r
-\r
-\r
-#define DXE_PCD_DB_INIT_VALUE \\r
-    /* ExMapTable */ \\r
-  { \\r
-    { /* ExTokenNumber */ 0x00000001, /* LocalTokenNumberIndex */ 0, /* ExGuidIndex */ 0} \\r
-  }, \\r
-  \\r
-  /* GuidTable */ \\r
-  { \\r
-    { 0xBB25CF6F, 0xF1D4, 0x11D2, {0x9A, 0x0C, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0xFD }} \\r
-  }, \\r
-  \\r
-  /* LocalTokenNumberTable */ \\r
-  { \\r
-    0 \\r
-  }, \\r
-  \\r
-  /* StringTable */ \\r
-  { \\r
-    L"\0" \\r
-  }, \\r
-  \\r
-  /* SizeTable */ \\r
-  { \\r
-    4 \\r
-  }, \\r
-  \\r
-  /* SkuIdTable */ \\r
-  { \\r
-    /*MaxSku*/ 2, /*SkuId*/ 100, /*SkuId*/200   \\r
-  },\\r
-  \\r
+#define PCD_DXE_SERVICE_DRIVER_VERSION      1\r

 \r
 //\r
 \r
 //\r

-// End of Autogen Code\r
+// PCD_DXE_DATABASE_GENTOOL_VERSION is defined in Autogen.h\r
+// and generated by PCD Database generation tool.\r

 //\r
 //\r

+#if (PCD_DXE_SERVICE_PEIM_VERSION != PCD_DXE_DATABASE_GENTOOL_VERSION)\r
+  #error "Please make sure the version of PCD Service DXE Driver and PCD DXE Database Generation Tool matches"\r

 #endif\r
 \r
 #endif\r
 \r

-/*\r
-typedef struct {\r
-  PEI_PCD_DATABASE_INIT Init;\r
-  PEI_PCD_DATABASE_UNINIT Uninit;\r
-} PEI_PCD_DATABASE;\r
-\r
-\r
-\r
-typedef struct {\r
-  DXE_PCD_DATABASE_INIT Init;\r
-  DXE_PCD_DATABASE_UNINIT Uninit;\r
-} DXE_PCD_DATABASE;\r
-\r
-\r
-typedef struct {\r
-  PEI_PCD_DATABASE PeiDb;\r
-  DXE_PCD_DATABASE DxeDb;\r
-} PCD_DATABASE;\r
-*/\r
-\r
-\r

 //\r
 // Internal Functions\r
 //\r
 //\r
 // Internal Functions\r
 //\r

diff --git a/EdkModulePkg/Universal/PCD/Pei/Service.h b/EdkModulePkg/Universal/PCD/Pei/Service.h
index 0059b2365ebdbb81e016db8f7dde08e9023803ac..5f334e141d0b3da030ac18372b7533fe38b31ff8 100644 (file)
--- a/EdkModulePkg/Universal/PCD/Pei/Service.h
+++ b/EdkModulePkg/Universal/PCD/Pei/Service.h
@@ -18,6 +18,20 @@ Module Name: Service.h
 #ifndef _SERVICE_H\r
 #define _SERVICE_H\r
 \r
 #ifndef _SERVICE_H\r
 #define _SERVICE_H\r
 \r

+//\r
+// Please make sure the PCD Serivce PEIM Version is consistent with\r
+// the version of PCD Database generation tool\r
+//\r
+#define PCD_PEI_SERVICE_DRIVER_VERSION      1\r
+\r
+//\r
+// PCD_PEI_DATABASE_GENTOOL_VERSION is defined in Autogen.h\r
+// and generated by PCD Database generation tool.\r
+//\r
+#if (PCD_PEI_SERVICE_PEIM_VERSION != PCD_PEI_DATABASE_GENTOOL_VERSION)\r
+  #error "Please make sure the version of PCD Service PEIM and PCD PEI Database Generation Tool matches"\r
+#endif\r
+\r

 /* Internal Function definitions */\r
 \r
 PEI_PCD_DATABASE *\r
 /* Internal Function definitions */\r
 \r
 PEI_PCD_DATABASE *\r

diff --git a/Tools/Source/GenBuild/org/tianocore/build/pcd/action/CollectPCDAction.java b/Tools/Source/GenBuild/org/tianocore/build/pcd/action/CollectPCDAction.java
index 6cc73ff22845d9df80078ba595aa4ca8f6aeaddf..9df18008ccf9ae9466951a2b1f6ed24340998e9e 100644 (file)
--- a/Tools/Source/GenBuild/org/tianocore/build/pcd/action/CollectPCDAction.java
+++ b/Tools/Source/GenBuild/org/tianocore/build/pcd/action/CollectPCDAction.java
@@ -217,7 +217,7 @@ class SizeTable {
 \r
         return index;\r
     }\r
 \r
         return index;\r
     }\r

-\r
+    \r

     private int getDatumSize(Token token) {\r
         /*\r
         switch (token.datumType) {\r
     private int getDatumSize(Token token) {\r
         /*\r
         switch (token.datumType) {\r


@@ -674,6 +674,15 @@ class PcdDatabase {
     private ArrayList<Token> alTokens;\r
     private String phase;\r
     private int assignedTokenNumber;\r
     private ArrayList<Token> alTokens;\r
     private String phase;\r
     private int assignedTokenNumber;\r

+    \r
+    //\r
+    // After Major changes done to the PCD\r
+    // database generation class PcdDatabase\r
+    // Please increment the version and please\r
+    // also update the version number in PCD\r
+    // service PEIM and DXE driver accordingly.\r
+    //\r
+    private final int version = 1;\r

 \r
     private String hString;\r
     private String cString;\r
 \r
     private String hString;\r
     private String cString;\r


@@ -754,10 +763,8 @@ class PcdDatabase {
      public void genCode () {\r
 \r
         final String newLine                        = "\r\n";\r
      public void genCode () {\r
 \r
         final String newLine                        = "\r\n";\r

-        final String instNewLine                    = "\\\r\n";\r

         final String declNewLine                    = ";\r\n";\r
         final String tab                            = "\t";\r
         final String declNewLine                    = ";\r\n";\r
         final String tab                            = "\t";\r

-        final String commaInstNewLine                   = "\t,\\\r\n";\r

         final String commaNewLine                   = ", \r\n";\r
 \r
         int i;\r
         final String commaNewLine                   = ", \r\n";\r
 \r
         int i;\r


@@ -790,7 +797,8 @@ class PcdDatabase {
         // Generate Structure Declaration for PcdTokens without Default Value\r
         // PEI_PCD_DATABASE_UNINIT\r
         //\r
         // Generate Structure Declaration for PcdTokens without Default Value\r
         // PEI_PCD_DATABASE_UNINIT\r
         //\r

-        java.util.Collections.sort(uninitTokens, comparator);\r
+        list = uninitTokens;\r
+        java.util.Collections.sort(list, comparator);\r

         uninitCode = processTokens(uninitTokens);\r
 \r
         //\r
         uninitCode = processTokens(uninitTokens);\r
 \r
         //\r


@@ -851,12 +859,6 @@ class PcdDatabase {
         initInstStr += tab + genInstantiationStr(exMapTable.getInstantiation()) + commaNewLine;\r
         initInstStr += tab + genInstantiationStr(guidTable.getInstantiation()) + commaNewLine;\r
         initInstStr += tab + genInstantiationStr(localTokenNumberTable.getInstantiation()) + commaNewLine; \r
         initInstStr += tab + genInstantiationStr(exMapTable.getInstantiation()) + commaNewLine;\r
         initInstStr += tab + genInstantiationStr(guidTable.getInstantiation()) + commaNewLine;\r
         initInstStr += tab + genInstantiationStr(localTokenNumberTable.getInstantiation()) + commaNewLine; \r

-        /*\r
-        inst = stringTable.getInstantiation();\r
-        for (i = 0; i < inst.size(); i++ ) {\r
-            initInstStr += tab + inst.get(i) + commaNewLine; \r
-        }\r
-        */\r

         initInstStr += tab + genInstantiationStr(stringTable.getInstantiation()) + commaNewLine;\r
         initInstStr += tab + genInstantiationStr(sizeTable.getInstantiation()) + commaNewLine;\r
         initInstStr += tab + genInstantiationStr(skuIdTable.getInstantiation()) + commaNewLine;\r
         initInstStr += tab + genInstantiationStr(stringTable.getInstantiation()) + commaNewLine;\r
         initInstStr += tab + genInstantiationStr(sizeTable.getInstantiation()) + commaNewLine;\r
         initInstStr += tab + genInstantiationStr(skuIdTable.getInstantiation()) + commaNewLine;\r


@@ -907,6 +909,8 @@ class PcdDatabase {
               + initDeclStr   + newLine\r
               + uninitDeclStr + newLine\r
               + newLine;\r
               + initDeclStr   + newLine\r
               + uninitDeclStr + newLine\r
               + newLine;\r

+        \r
+        hString += String.format("#define PCD_%s_SERVICE_DRIVER_VERSION                        %d", phase, version);\r

 \r
     }\r
 \r
 \r
     }\r
 \r


@@ -924,7 +928,6 @@ class PcdDatabase {
 \r
     private HashMap<String, ArrayList<String>> processTokens (List<Token> alToken) {\r
 \r
 \r
     private HashMap<String, ArrayList<String>> processTokens (List<Token> alToken) {\r
 \r

-        ArrayList[]  output = new ArrayList[4];\r

         HashMap <String, ArrayList<String>> map = new HashMap<String, ArrayList<String>>();\r
 \r
         ArrayList<String> decl = new ArrayList<String>();\r
         HashMap <String, ArrayList<String>> map = new HashMap<String, ArrayList<String>>();\r
 \r
         ArrayList<String> decl = new ArrayList<String>();\r


@@ -1039,8 +1042,6 @@ class PcdDatabase {
 \r
     private String getDataTypeInstantiation (Token token) {\r
 \r
 \r
     private String getDataTypeInstantiation (Token token) {\r
 \r

-        String typeStr = "";\r
-\r

         if (token.datumType == Token.DATUM_TYPE.POINTER) {\r
             return String.format("%s /* %s */", token.datum.toString(), token.getPrimaryKeyString());\r
         } else {\r
         if (token.datumType == Token.DATUM_TYPE.POINTER) {\r
             return String.format("%s /* %s */", token.datum.toString(), token.getPrimaryKeyString());\r
         } else {\r