Enabling use PcdSetXX macro to set value for PATCHABLE_IN_MODULE, DYNAMIC, DYNAMIC_EX type PCD

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

2 files changed, 109 insertions, 58 deletions

diff --git a/MdePkg/Include/Library/PcdLib.h b/MdePkg/Include/Library/PcdLib.h
index 90e19ba2a9..2f797640a0 100644
--- a/MdePkg/Include/Library/PcdLib.h
+++ b/MdePkg/Include/Library/PcdLib.h
@@ -20,91 +20,92 @@ Module Name: PcdLib.h
 

 #define PCD_INVALID_TOKEN_NUMBER ((UINTN) 0)

 

-#define PcdToken(TokenName)  _PCD_TOKEN_##TokenName

+#define PcdToken(TokenName)                 _PCD_TOKEN_##TokenName

 

 

 //

 // Feature Flag is in the form of a global constant

 //

-#define FeaturePcdGet(TokenName)     _PCD_VALUE_##TokenName

+#define FeaturePcdGet(TokenName)            _PCD_VALUE_##TokenName

 

 

 //

 // Fixed is fixed at build time

 //

-#define FixedPcdGet8(TokenName)     _PCD_VALUE_##TokenName

-#define FixedPcdGet16(TokenName)    _PCD_VALUE_##TokenName

-#define FixedPcdGet32(TokenName)    _PCD_VALUE_##TokenName

-#define FixedPcdGet64(TokenName)    _PCD_VALUE_##TokenName

-#define FixedPcdGetBool(TokenName)  _PCD_VALUE_##TokenName

+#define FixedPcdGet8(TokenName)             _PCD_VALUE_##TokenName

+#define FixedPcdGet16(TokenName)            _PCD_VALUE_##TokenName

+#define FixedPcdGet32(TokenName)            _PCD_VALUE_##TokenName

+#define FixedPcdGet64(TokenName)            _PCD_VALUE_##TokenName

+#define FixedPcdGetBool(TokenName)          _PCD_VALUE_##TokenName

 

 

 //

 // BugBug: This works for strings, but not constants.

 //

-#define FixedPcdGetPtr(TokenName)    ((VOID *)_PCD_VALUE_##TokenName)

+#define FixedPcdGetPtr(TokenName)           ((VOID *)_PCD_VALUE_##TokenName)

 

 

 //

 // (Binary) Patch is in the form of a global variable

 //

-#define PatchPcdGet8(TokenName)     _gPcd_BinaryPatch_##TokenName

-#define PatchPcdGet16(TokenName)    _gPcd_BinaryPatch_##TokenName

-#define PatchPcdGet32(TokenName)    _gPcd_BinaryPatch_##TokenName

-#define PatchPcdGet64(TokenName)    _gPcd_BinaryPatch_##TokenName

-#define PatchPcdGetBool(TokenName)  _gPcd_BinaryPatch_##TokenName

-#define PatchPcdGetPtr(TokenName)   ((VOID *)_gPcd_BinaryPatch_##TokenName)

-

-#define PatchPcdSet8(TokenName, Value)     (_gPcd_BinaryPatch_##TokenName = Value)

-#define PatchPcdSet16(TokenName, Value)    (_gPcd_BinaryPatch_##TokenName = Value)

-#define PatchPcdSet32(TokenName, Value)    (_gPcd_BinaryPatch_##TokenName = Value)

-#define PatchPcdSet64(TokenName, Value)    (_gPcd_BinaryPatch_##TokenName = Value)

-#define PatchPcdSetBool(TokenName, Value)  (_gPcd_BinaryPatch_##TokenName = Value)

-#define PatchPcdSetPtr(TokenName, Size, Buffer)   CopyMem (_gPcd_BinaryPatch_##TokenName, Buffer, Size)

+#define PatchPcdGet8(TokenName)             _gPcd_BinaryPatch_##TokenName

+#define PatchPcdGet16(TokenName)            _gPcd_BinaryPatch_##TokenName

+#define PatchPcdGet32(TokenName)            _gPcd_BinaryPatch_##TokenName

+#define PatchPcdGet64(TokenName)            _gPcd_BinaryPatch_##TokenName

+#define PatchPcdGetBool(TokenName)          _gPcd_BinaryPatch_##TokenName

+#define PatchPcdGetPtr(TokenName)           ((VOID *)_gPcd_BinaryPatch_##TokenName)

+

+#define PatchPcdSet8(TokenName, Value)      (_gPcd_BinaryPatch_##TokenName = (Value))

+#define PatchPcdSet16(TokenName, Value)     (_gPcd_BinaryPatch_##TokenName = (Value))

+#define PatchPcdSet32(TokenName, Value)     (_gPcd_BinaryPatch_##TokenName = (Value))

+#define PatchPcdSet64(TokenName, Value)     (_gPcd_BinaryPatch_##TokenName = (Value))

+#define PatchPcdSetBool(TokenName, Value)   (_gPcd_BinaryPatch_##TokenName = (Value))

+#define PatchPcdSetPtr(TokenName, Size, Buffer) \

+                                            CopyMem (_gPcd_BinaryPatch_##TokenName, (Buffer), (Size))

 

 //

 // Dynamic is via the protocol with only the TokenNumber as argument

 //  It can also be Patch or Fixed type based on a build option

 //

-#define PcdGet8(TokenName)          _PCD_MODE_8_##TokenName

-#define PcdGet16(TokenName)         _PCD_MODE_16_##TokenName

-#define PcdGet32(TokenName)         _PCD_MODE_32_##TokenName

-#define PcdGet64(TokenName)         _PCD_MODE_64_##TokenName

-#define PcdGetPtr(TokenName)        _PCD_MODE_PTR_##TokenName

-#define PcdGetBool(TokenName)       _PCD_MODE_BOOL_##TokenName

-

+#define PcdGet8(TokenName)                  _PCD_GET_MODE_8_##TokenName

+#define PcdGet16(TokenName)                 _PCD_GET_MODE_16_##TokenName

+#define PcdGet32(TokenName)                 _PCD_GET_MODE_32_##TokenName

+#define PcdGet64(TokenName)                 _PCD_GET_MODE_64_##TokenName

+#define PcdGetPtr(TokenName)                _PCD_GET_MODE_PTR_##TokenName

+#define PcdGetBool(TokenName)               _PCD_GET_MODE_BOOL_##TokenName

 

 //

-// Dynamic Ex is to support binary distribution

+// Dynamic Set

 //

-#define PcdGetEx8(Guid, TokenName)     LibPcdGetEx8 (Guid, _PCD_TOKEN_##TokenName)

-#define PcdGetEx16(Guid, TokenName)    LibPcdGetEx16 (Guid, _PCD_TOKEN_##TokenName)

-#define PcdGetEx32(Guid, TokenName)    LibPcdGetEx32 (Guid, _PCD_TOKEN_##TokenName)

-#define PcdGetEx64(Guid, TokenName)    LibPcdGetEx64 (Guid, _PCD_TOKEN_##TokenName)

-#define PcdGetExPtr(Guid, TokenName)   LibPcdGetExPtr (Guid, _PCD_TOKEN_##TokenName)

-#define PcdGetExBool(Guid, TokenName)  LibPcdGetExBool (Guid, _PCD_TOKEN_##TokenName)

-

+#define PcdSet8(TokenName, Value)           _PCD_SET_MODE_8_##TokenName     ((Value))

+#define PcdSet16(TokenName, Value)          _PCD_SET_MODE_16_##TokenName    ((Value))

+#define PcdSet32(TokenName, Value)          _PCD_SET_MODE_32_##TokenName    ((Value))

+#define PcdSet64(TokenName, Value)          _PCD_SET_MODE_64_##TokenName    ((Value))

+#define PcdSetPtr(TokenName, SizeOfBuffer, Buffer) \

+                                            _PCD_SET_MODE_PTR_##TokenName   ((SizeOfBuffer), (Buffer))

+#define PcdSetBool(TokenName, Value)        _PCD_SET_MODE_BOOL_##TokenName  ((Value))

 

 //

-// Dynamic Set

+// Dynamic Ex is to support binary distribution

 //

-#define PcdSet8(TokenName, Value)       LibPcdSet8   (_PCD_TOKEN_##TokenName, Value)

-#define PcdSet16(TokenName, Value)      LibPcdSet16  (_PCD_TOKEN_##TokenName, Value)

-#define PcdSet32(TokenName, Value)      LibPcdSet32  (_PCD_TOKEN_##TokenName, Value)

-#define PcdSet64(TokenName, Value)      LibPcdSet64  (_PCD_TOKEN_##TokenName, Value)

-#define PcdSetPtr(TokenName, SizeOfBuffer, Buffer)     LibPcdSetPtr (_PCD_TOKEN_##TokenName, SizeOfBuffer, Buffer)

-#define PcdSetBool(TokenName, Value)    LibPcdSetBool(_PCD_TOKEN_##TokenName, Value)

-

+#define PcdGetEx8(Guid, TokenName)          LibPcdGetEx8    ((Guid), _PCD_TOKEN_##TokenName)

+#define PcdGetEx16(Guid, TokenName)         LibPcdGetEx16   ((Guid), _PCD_TOKEN_##TokenName)

+#define PcdGetEx32(Guid, TokenName)         LibPcdGetEx32   ((Guid), _PCD_TOKEN_##TokenName)

+#define PcdGetEx64(Guid, TokenName)         LibPcdGetEx64   ((Guid), _PCD_TOKEN_##TokenName)

+#define PcdGetExPtr(Guid, TokenName)        LibPcdGetExPtr  ((Guid), _PCD_TOKEN_##TokenName)

+#define PcdGetExBool(Guid, TokenName)       LibPcdGetExBool ((Guid), _PCD_TOKEN_##TokenName)

 

 //

 // Dynamic Set Ex

 //

-#define PcdSetEx8(Guid, TokenName, Value)      LibPcdSetEx8   (Guid, _PCD_TOKEN_##TokenName, Value)

-#define PcdSetEx16(Guid, TokenName, Value)     LibPcdSetEx16  (Guid, _PCD_TOKEN_##TokenName, Value)

-#define PcdSetEx32(Guid, TokenName, Value)     LibPcdSetEx32  (Guid, _PCD_TOKEN_##TokenName, Value)

-#define PcdSetEx64(Guid, TokenName, Value)     LibPcdSetEx64  (Guid, _PCD_TOKEN_##TokenName, Value)

-#define PcdSetExPtr(Guid, TokenName, SizeOfBuffer, Buffer)    LibPcdSetExPtr (Guid, _PCD_TOKEN_##TokenName, SizeOfBuffer, Buffer)

-#define PcdSetExBool(Guid, TokenName, Value)   LibPcdSetExBool(Guid, _PCD_TOKEN_##TokenName, Value)

+#define PcdSetEx8(Guid, TokenName, Value)   LibPcdSetEx8   ((Guid), _PCD_TOKEN_##TokenName, (Value))

+#define PcdSetEx16(Guid, TokenName, Value)  LibPcdSetEx16  ((Guid), _PCD_TOKEN_##TokenName, (Value))

+#define PcdSetEx32(Guid, TokenName, Value)  LibPcdSetEx32  ((Guid), _PCD_TOKEN_##TokenName, (Value))

+#define PcdSetEx64(Guid, TokenName, Value)  LibPcdSetEx64  ((Guid), _PCD_TOKEN_##TokenName, (Value))

+#define PcdSetExPtr(Guid, TokenName, SizeOfBuffer, Buffer) \

+                                            LibPcdSetExPtr ((Guid), _PCD_TOKEN_##TokenName, (SizeOfBuffer), (Buffer))

+#define PcdSetExBool(Guid, TokenName, Value) \

+                                            LibPcdSetExBool((Guid), _PCD_TOKEN_##TokenName, (Value))

 

 

 /**

diff --git a/Tools/Source/GenBuild/org/tianocore/build/pcd/entity/UsageInstance.java b/Tools/Source/GenBuild/org/tianocore/build/pcd/entity/UsageInstance.java
index 85806b4289..baf87572f0 100644
--- a/Tools/Source/GenBuild/org/tianocore/build/pcd/entity/UsageInstance.java
+++ b/Tools/Source/GenBuild/org/tianocore/build/pcd/entity/UsageInstance.java
@@ -242,10 +242,13 @@ public class UsageInstance {
         case FEATURE_FLAG:

             hAutogenStr += String.format("extern const BOOLEAN _gPcd_FixedAtBuild_%s;\r\n", 

                                          parentToken.cName);

-            hAutogenStr += String.format("#define _PCD_MODE_%s_%s  _gPcd_FixedAtBuild_%s\r\n",

+            hAutogenStr += String.format("#define _PCD_GET_MODE_%s_%s  _gPcd_FixedAtBuild_%s\r\n",

                                          parentToken.GetAutogenDefinedatumTypeString(parentToken.datumType),

                                          parentToken.cName,

                                          parentToken.cName);

+            hAutogenStr += String.format("//#define _PCD_SET_MODE_%s_%s ASSERT(FALSE) If is not allowed to set value for a FEATURE_FLAG PCD\r\n",

+                                         parentToken.GetAutogenDefinedatumTypeString(parentToken.datumType),

+                                         parentToken.cName);

 

             if (!isBuildUsedLibrary) {

                 hAutogenStr += String.format("#define _PCD_VALUE_%s   %s\r\n", 

@@ -260,7 +263,7 @@ public class UsageInstance {
             if (isByteArray) {

                 hAutogenStr += String.format("extern const UINT8 _gPcd_FixedAtBuild_%s[];\r\n",

                                              parentToken.cName);

-                hAutogenStr += String.format("#define _PCD_MODE_%s_%s  &_gPcd_FixedAtBuild_%s\r\n", 

+                hAutogenStr += String.format("#define _PCD_GET_MODE_%s_%s  (VOID*)_gPcd_FixedAtBuild_%s\r\n", 

                                              Token.GetAutogenDefinedatumTypeString(parentToken.datumType),

                                              parentToken.cName,

                                              parentToken.cName);

@@ -268,12 +271,15 @@ public class UsageInstance {
                 hAutogenStr += String.format("extern const %s _gPcd_FixedAtBuild_%s;\r\n",

                                              Token.getAutogendatumTypeString(parentToken.datumType),

                                              parentToken.cName);

-                hAutogenStr += String.format("#define _PCD_MODE_%s_%s  _gPcd_FixedAtBuild_%s\r\n", 

+                hAutogenStr += String.format("#define _PCD_GET_MODE_%s_%s  _gPcd_FixedAtBuild_%s\r\n", 

                                              Token.GetAutogenDefinedatumTypeString(parentToken.datumType),

                                              parentToken.cName,

                                              parentToken.cName);

             }

 

+            hAutogenStr += String.format("//#define _PCD_SET_MODE_%s_%s ASSERT(FALSE) // It is not allowed to set value for a FIXED_AT_BUILD PCD\r\n",

+                                         parentToken.GetAutogenDefinedatumTypeString(parentToken.datumType),

+                                         parentToken.cName);

             if (!isBuildUsedLibrary) {

                 hAutogenStr += String.format("#define _PCD_VALUE_%s   %s\r\n", 

                                              parentToken.cName, 

@@ -294,7 +300,7 @@ public class UsageInstance {
             if (isByteArray) {

                 hAutogenStr += String.format("extern UINT8 _gPcd_BinaryPatch_%s[];\r\n",

                                              parentToken.cName);

-                hAutogenStr += String.format("#define _PCD_MODE_%s_%s  &_gPcd_BinaryPatch_%s\r\n",

+                hAutogenStr += String.format("#define _PCD_GET_MODE_%s_%s  (VOID*)_gPcd_BinaryPatch_%s\r\n",

                                              Token.GetAutogenDefinedatumTypeString(parentToken.datumType),

                                              parentToken.cName,

                                              parentToken.cName);  

@@ -302,12 +308,27 @@ public class UsageInstance {
                 hAutogenStr += String.format("extern %s _gPcd_BinaryPatch_%s;\r\n",

                                              Token.getAutogendatumTypeString(parentToken.datumType),

                                              parentToken.cName);

-                hAutogenStr += String.format("#define _PCD_MODE_%s_%s  _gPcd_BinaryPatch_%s\r\n",

+                hAutogenStr += String.format("#define _PCD_GET_MODE_%s_%s  _gPcd_BinaryPatch_%s\r\n",

                                              Token.GetAutogenDefinedatumTypeString(parentToken.datumType),

                                              parentToken.cName,

                                              parentToken.cName);                

             }

 

+            //

+            // Generate _PCD_SET_MODE_xx macro for using set BinaryPatch value via PcdSet macro

+            // 

+            if (parentToken.datumType == Token.DATUM_TYPE.POINTER) {

+                hAutogenStr += String.format("#define _PCD_SET_MODE_%s_%s(SizeOfBuffer, Buffer) CopyMem (_gPcd_BinaryPatch_%s, (Buffer), (SizeOfBuffer))\r\n",

+                                             Token.GetAutogenDefinedatumTypeString(parentToken.datumType),

+                                             parentToken.cName,

+                                             parentToken.cName);

+            } else {

+                hAutogenStr += String.format("#define _PCD_SET_MODE_%s_%s(Value) (_gPcd_BinaryPatch_%s = (Value))\r\n",

+                                             Token.GetAutogenDefinedatumTypeString(parentToken.datumType),

+                                             parentToken.cName,

+                                             parentToken.cName);

+            }

+            

             if (!isBuildUsedLibrary) {

                 hAutogenStr += String.format("#define _PCD_VALUE_%s   %s\r\n", 

                                              parentToken.cName, 

@@ -326,23 +347,52 @@ public class UsageInstance {
 

             break;

         case DYNAMIC:

-            hAutogenStr += String.format("#define _PCD_MODE_%s_%s  LibPcdGet%s(_PCD_TOKEN_%s)\r\n",

+            hAutogenStr += String.format("#define _PCD_GET_MODE_%s_%s  LibPcdGet%s(_PCD_TOKEN_%s)\r\n",

                                          Token.GetAutogenDefinedatumTypeString(parentToken.datumType),

                                          parentToken.cName,

                                          Token.getAutogenLibrarydatumTypeString(parentToken.datumType),

                                          parentToken.cName);

+            if (parentToken.datumType == Token.DATUM_TYPE.POINTER) {

+                hAutogenStr += String.format("#define _PCD_SET_MODE_%s_%s(SizeOfBuffer, Buffer)  LibPcdSet%s(_PCD_TOKEN_%s, (SizeOfBuffer), (Buffer))\r\n",

+                                             Token.GetAutogenDefinedatumTypeString(parentToken.datumType),

+                                             parentToken.cName,

+                                             Token.getAutogenLibrarydatumTypeString(parentToken.datumType),

+                                             parentToken.cName);

+            } else {

+                hAutogenStr += String.format("#define _PCD_SET_MODE_%s_%s(Value)  LibPcdSet%s(_PCD_TOKEN_%s, (Value))\r\n",

+                                             Token.GetAutogenDefinedatumTypeString(parentToken.datumType),

+                                             parentToken.cName,

+                                             Token.getAutogenLibrarydatumTypeString(parentToken.datumType),

+                                             parentToken.cName);

+            }

             break;

         case DYNAMIC_EX:

             guidStringCName = "_gPcd_TokenSpaceGuid_" +

                               parentToken.tokenSpaceName.toString().replaceAll("-", "_");

-                                            

-            hAutogenStr += String.format("#define _PCD_MODE_%s_%s LibPcdGetEx%s(&%s, _PCD_TOKEN_%s)\r\n",

+

+            hAutogenStr += String.format("#define _PCD_GET_MODE_%s_%s LibPcdGetEx%s(&%s, _PCD_TOKEN_%s)\r\n",

                                          Token.GetAutogenDefinedatumTypeString(parentToken.datumType),

                                          parentToken.cName,

                                          Token.getAutogenLibrarydatumTypeString(parentToken.datumType),

                                          guidStringCName,

                                          parentToken.cName);

 

+            if (parentToken.datumType == Token.DATUM_TYPE.POINTER) {

+                hAutogenStr += String.format("#define _PCD_SET_MODE_%s_%s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, _PCD_TOKEN_%s, (SizeOfBuffer), (Buffer))\r\n",

+                                             Token.GetAutogenDefinedatumTypeString(parentToken.datumType),

+                                             parentToken.cName,

+                                             Token.getAutogenLibrarydatumTypeString(parentToken.datumType),

+                                             guidStringCName,

+                                             parentToken.cName);

+            } else {

+                hAutogenStr += String.format("#define _PCD_SET_MODE_%s_%s(Value) LibPcdSetEx%s(&%s, _PCD_TOKEN_%s, (Value))\r\n",

+                                             Token.GetAutogenDefinedatumTypeString(parentToken.datumType),

+                                             parentToken.cName,

+                                             Token.getAutogenLibrarydatumTypeString(parentToken.datumType),

+                                             guidStringCName,

+                                             parentToken.cName);

+

+            }

             break;

         }

     }