]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/PCD/Dxe/Service.h
Correct typo in comments, clean IfrSupportLib.h
[mirror_edk2.git] / MdeModulePkg / Universal / PCD / Dxe / Service.h
index 4b56e4307168852c7c26ad88f39b0bc46f962db2..67114be3bbb61a9aa81c6dfd037b526cb26fe090 100644 (file)
@@ -10,9 +10,6 @@ http://opensource.org/licenses/bsd-license.php
 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
-\r
-Module Name: Service.h\r
-\r
 **/\r
 \r
 #ifndef _PCD_DXE_SERVICE_H_\r
@@ -31,20 +28,6 @@ Module Name: Service.h
 #include <Library/BaseMemoryLib.h>\r
 #include <Library/UefiRuntimeServicesTableLib.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_SERVICE_DXE_DRIVER_VERSION      2\r
-\r
-//\r
-// PCD_DXE_DATABASE_GENTOOL_VERSION is defined in Autogen.h\r
-// and generated by PCD Database generation tool.\r
-//\r
-//#if (PCD_SERVICE_DXE_DRIVER_VERSION != PCD_DXE_SERVICE_DRIVER_AUTOGEN_VERSION)\r
-//  #error "Please make sure the version of PCD Service DXE Driver and PCD DXE Database Generation Tool matches"\r
-//#endif\r
-\r
 //\r
 // Protocol Interface function declaration.\r
 //\r
@@ -68,15 +51,12 @@ Module Name: Service.h
   @param[in]  SkuId The SKU value that will be used when the PCD service will retrieve and \r
               set values associated with a PCD token.\r
 \r
-  @retval VOID\r
-\r
 **/\r
 VOID\r
 EFIAPI\r
 DxePcdSetSku (\r
   IN  UINTN                  SkuId\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Retrieves an 8-bit value for a given PCD token.\r
@@ -93,8 +73,7 @@ UINT8
 EFIAPI\r
 DxePcdGet8 (\r
   IN UINTN             TokenNumber\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Retrieves an 16-bit value for a given PCD token.\r
@@ -111,8 +90,7 @@ UINT16
 EFIAPI\r
 DxePcdGet16 (\r
   IN UINTN             TokenNumber\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Retrieves an 32-bit value for a given PCD token.\r
@@ -129,8 +107,7 @@ UINT32
 EFIAPI\r
 DxePcdGet32 (\r
   IN UINTN             TokenNumber\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Retrieves an 64-bit value for a given PCD token.\r
@@ -147,8 +124,7 @@ UINT64
 EFIAPI\r
 DxePcdGet64 (\r
   IN UINTN             TokenNumber\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Retrieves a pointer to a value for a given PCD token.\r
@@ -160,15 +136,14 @@ DxePcdGet64 (
 \r
   @param[in]  TokenNumber The PCD token number. \r
 \r
-  @return The pointer to the buffer to be retrived.\r
+  @return The pointer to the buffer to be retrieved.\r
   \r
 **/\r
 VOID *\r
 EFIAPI\r
 DxePcdGetPtr (\r
   IN UINTN             TokenNumber\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Retrieves a Boolean value for a given PCD token.\r
@@ -187,8 +162,7 @@ BOOLEAN
 EFIAPI\r
 DxePcdGetBool (\r
   IN UINTN             TokenNumber\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Retrieves the size of the value for a given PCD token.\r
@@ -205,8 +179,7 @@ UINTN
 EFIAPI\r
 DxePcdGetSize (\r
   IN UINTN             TokenNumber\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Retrieves an 8-bit value for a given PCD token.\r
@@ -227,8 +200,7 @@ EFIAPI
 DxePcdGet8Ex (\r
   IN CONST EFI_GUID        *Guid,\r
   IN UINTN             TokenNumber\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Retrieves an 16-bit value for a given PCD token.\r
@@ -249,8 +221,7 @@ EFIAPI
 DxePcdGet16Ex (\r
   IN CONST EFI_GUID        *Guid,\r
   IN UINTN             TokenNumber\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Retrieves an 32-bit value for a given PCD token.\r
@@ -271,8 +242,7 @@ EFIAPI
 DxePcdGet32Ex (\r
   IN CONST EFI_GUID        *Guid,\r
   IN UINTN             TokenNumber\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Retrieves an 64-bit value for a given PCD token.\r
@@ -293,8 +263,7 @@ EFIAPI
 DxePcdGet64Ex (\r
   IN CONST EFI_GUID        *Guid,\r
   IN UINTN             TokenNumber\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Retrieves a pointer to a value for a given PCD token.\r
@@ -307,7 +276,7 @@ DxePcdGet64Ex (
   @param[in]  Guid The token space for the token number.\r
   @param[in]  TokenNumber The PCD token number. \r
 \r
-  @return The pointer to the buffer to be retrived.\r
+  @return The pointer to the buffer to be retrieved.\r
   \r
 **/\r
 VOID *\r
@@ -315,8 +284,7 @@ EFIAPI
 DxePcdGetPtrEx (\r
   IN CONST EFI_GUID        *Guid,\r
   IN UINTN             TokenNumber\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Retrieves an Boolean value for a given PCD token.\r
@@ -337,8 +305,7 @@ EFIAPI
 DxePcdGetBoolEx (\r
   IN CONST EFI_GUID        *Guid,\r
   IN UINTN             TokenNumber\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Retrieves the size of the value for a given PCD token.\r
@@ -357,8 +324,7 @@ EFIAPI
 DxePcdGetSizeEx (\r
   IN CONST EFI_GUID        *Guid,\r
   IN UINTN             TokenNumber\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Sets an 8-bit value for a given PCD token.\r
@@ -382,8 +348,7 @@ EFIAPI
 DxePcdSet8 (\r
   IN UINTN             TokenNumber,\r
   IN UINT8             Value\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Sets an 16-bit value for a given PCD token.\r
@@ -407,8 +372,7 @@ EFIAPI
 DxePcdSet16 (\r
   IN UINTN             TokenNumber,\r
   IN UINT16             Value\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Sets an 32-bit value for a given PCD token.\r
@@ -432,8 +396,7 @@ EFIAPI
 DxePcdSet32 (\r
   IN UINTN             TokenNumber,\r
   IN UINT32             Value\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Sets an 64-bit value for a given PCD token.\r
@@ -457,8 +420,7 @@ EFIAPI
 DxePcdSet64 (\r
   IN UINTN             TokenNumber,\r
   IN UINT64            Value\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
@@ -488,8 +450,7 @@ DxePcdSetPtr (
   IN        UINTN             TokenNumber,\r
   IN OUT    UINTN             *SizeOfBuffer,\r
   IN        VOID              *Buffer\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Sets an Boolean value for a given PCD token.\r
@@ -513,8 +474,7 @@ EFIAPI
 DxePcdSetBool (\r
   IN UINTN             TokenNumber,\r
   IN BOOLEAN           Value\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
@@ -541,8 +501,7 @@ DxePcdSet8Ex (
   IN CONST EFI_GUID        *Guid,\r
   IN UINTN             TokenNumber,\r
   IN UINT8             Value\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Sets an 16-bit value for a given PCD token.\r
@@ -568,8 +527,7 @@ DxePcdSet16Ex (
   IN CONST EFI_GUID        *Guid,\r
   IN UINTN             TokenNumber,\r
   IN UINT16            Value\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Sets an 32-bit value for a given PCD token.\r
@@ -595,8 +553,7 @@ DxePcdSet32Ex (
   IN CONST EFI_GUID        *Guid,\r
   IN UINTN             TokenNumber,\r
   IN UINT32             Value\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Sets an 64-bit value for a given PCD token.\r
@@ -622,8 +579,7 @@ DxePcdSet64Ex (
   IN CONST EFI_GUID        *Guid,\r
   IN UINTN             TokenNumber,\r
   IN UINT64            Value\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Sets a value of a specified size for a given PCD token.\r
@@ -654,8 +610,7 @@ DxePcdSetPtrEx (
   IN        UINTN             TokenNumber,\r
   IN OUT    UINTN             *SizeOfBuffer,\r
   IN        VOID              *Buffer\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Sets an Boolean value for a given PCD token.\r
@@ -681,8 +636,7 @@ DxePcdSetBoolEx (
   IN CONST EFI_GUID    *Guid,\r
   IN UINTN             TokenNumber,\r
   IN BOOLEAN           Value\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Specifies a function to be called anytime the value of a designated token is changed.\r
@@ -702,8 +656,7 @@ DxeRegisterCallBackOnSet (
   IN  CONST EFI_GUID          *Guid, OPTIONAL\r
   IN  UINTN                   TokenNumber,\r
   IN  PCD_PROTOCOL_CALLBACK   CallBackFunction\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Cancels a previously set callback function for a particular PCD token number.\r
@@ -723,8 +676,7 @@ DxeUnRegisterCallBackOnSet (
   IN  CONST EFI_GUID          *Guid, OPTIONAL\r
   IN  UINTN                   TokenNumber,\r
   IN  PCD_PROTOCOL_CALLBACK   CallBackFunction\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Retrieves the next valid PCD token for a given namespace.\r
@@ -749,8 +701,7 @@ EFIAPI
 DxePcdGetNextToken (\r
   IN CONST EFI_GUID               *Guid, OPTIONAL\r
   IN OUT   UINTN                  *TokenNumber\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Get next token space in PCD database according to given token space guid.\r
@@ -771,15 +722,14 @@ EFI_STATUS
 EFIAPI\r
 DxePcdGetNextTokenSpace (\r
   IN OUT CONST EFI_GUID               **Guid\r
-  )\r
-;\r
+  );\r
 \r
 typedef struct {\r
   LIST_ENTRY              Node;\r
   PCD_PROTOCOL_CALLBACK   CallbackFn;\r
 } CALLBACK_FN_ENTRY;\r
 \r
-#define CR_FNENTRY_FROM_LISTNODE(Record, Type, Field) _CR(Record, Type, Field)\r
+#define CR_FNENTRY_FROM_LISTNODE(Record, Type, Field) BASE_CR(Record, Type, Field)\r
 \r
 //\r
 // Internal Functions\r
@@ -800,8 +750,7 @@ SetValueWorker (
   IN UINTN                   TokenNumber,\r
   IN VOID                    *Data,\r
   IN UINTN                   Size\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Set value for an PCD entry\r
@@ -824,8 +773,7 @@ SetWorker (
   IN          VOID                      *Data,\r
   IN OUT      UINTN                     *Size,\r
   IN          BOOLEAN                   PtrType\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Wrapper function for set PCD value for non-Pointer type dynamic-ex PCD.\r
@@ -844,8 +792,7 @@ ExSetValueWorker (
   IN          CONST EFI_GUID       *Guid,\r
   IN          VOID                 *Data,\r
   IN          UINTN                SetSize\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Set value for a dynamic PCD entry.\r
@@ -872,8 +819,7 @@ ExSetWorker (
   IN      VOID                 *Data,\r
   IN OUT  UINTN                *Size,\r
   IN      BOOLEAN              PtrType\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Get the PCD entry pointer in PCD database.\r
@@ -893,14 +839,13 @@ VOID *
 GetWorker (\r
   IN UINTN             TokenNumber,\r
   IN UINTN             GetSize\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Wrapper function for get PCD value for dynamic-ex PCD.\r
 \r
   @param Guid            Token space guid for dynamic-ex PCD.\r
-  @param ExTokenNumber   Token number for dyanmic-ex PCD.\r
+  @param ExTokenNumber   Token number for dynamic-ex PCD.\r
   @param GetSize         The size of dynamic-ex PCD value.\r
 \r
   @return PCD entry in PCD database.\r
@@ -911,8 +856,7 @@ ExGetWorker (
   IN CONST EFI_GUID         *Guid,\r
   IN UINTN                  ExTokenNumber,\r
   IN UINTN                  GetSize\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Find the local token number according to system SKU ID.\r
@@ -930,8 +874,7 @@ GetSkuEnabledTokenNumber (
   UINT32 LocalTokenNumber,\r
   UINTN  Size,\r
   BOOLEAN IsPeiDb\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Get Variable which contains HII type PCD entry.\r
@@ -949,8 +892,7 @@ GetHiiVariable (
   IN  UINT16        *VariableName,\r
   OUT UINT8          **VariableData,\r
   OUT UINTN         *VariableSize\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Set value for HII-type PCD.\r
@@ -974,8 +916,7 @@ SetHiiVariable (
   IN  CONST VOID   *Data,\r
   IN  UINTN        DataSize,\r
   IN  UINTN        Offset\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Register the callback function for a PCD entry.\r
@@ -996,8 +937,7 @@ DxeRegisterCallBackWorker (
   IN  UINTN                   TokenNumber,\r
   IN  CONST EFI_GUID          *Guid, OPTIONAL\r
   IN  PCD_PROTOCOL_CALLBACK   CallBackFunction\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   UnRegister the callback function for a PCD entry.\r
@@ -1018,8 +958,7 @@ DxeUnRegisterCallBackWorker (
   IN  UINTN                   TokenNumber,\r
   IN  CONST EFI_GUID          *Guid, OPTIONAL\r
   IN  PCD_PROTOCOL_CALLBACK   CallBackFunction\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Initialize the PCD database in DXE phase.\r
@@ -1031,8 +970,7 @@ DxeUnRegisterCallBackWorker (
 VOID\r
 BuildPcdDxeDataBase (\r
   VOID\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Get local token number according to dynamic-ex PCD's {token space guid:token number}\r
@@ -1042,7 +980,7 @@ BuildPcdDxeDataBase (
   space guid: token number} to local token number.\r
   \r
   @param Guid            Token space guid for dynamic-ex PCD entry.\r
-  @param ExTokenNumber   EDES_TODO: Add parameter description\r
+  @param ExTokenNumber   Dynamic-ex PCD token number.\r
 \r
   @return local token number for dynamic-ex PCD.\r
 \r
@@ -1051,8 +989,7 @@ UINTN
 GetExPcdTokenNumber (\r
   IN CONST EFI_GUID             *Guid,\r
   IN UINT32                     ExTokenNumber\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Get next token number in given token space.\r
@@ -1087,14 +1024,13 @@ ExGetNextTokeNumber (
   IN      UINTN             SizeOfGuidTable,\r
   IN      DYNAMICEX_MAPPING *ExMapTable,\r
   IN      UINTN             SizeOfExMapTable\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Get size of POINTER type PCD value.\r
 \r
   @param LocalTokenNumberTableIdx Index of local token number in local token number table.\r
-  @param MaxSize                  Maxmium size of POINTER type PCD value.\r
+  @param MaxSize                  Maximum size of POINTER type PCD value.\r
 \r
   @return size of POINTER type PCD value.\r
 \r
@@ -1103,11 +1039,10 @@ UINTN
 GetPtrTypeSize (\r
   IN    UINTN             LocalTokenNumberTableIdx,\r
   OUT   UINTN             *MaxSize\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
-  Set size of POINTER type PCD value. The size should not exceed the maxmium size\r
+  Set size of POINTER type PCD value. The size should not exceed the maximum size\r
   of this PCD value.\r
 \r
   @param LocalTokenNumberTableIdx Index of local token number in local token number table.\r
@@ -1120,8 +1055,7 @@ BOOLEAN
 SetPtrTypeSize (\r
   IN          UINTN             LocalTokenNumberTableIdx,\r
   IN    OUT   UINTN             *CurrentSize\r
-  )\r
-;\r
+  );\r
 \r
 extern EFI_GUID gPcdDataBaseHobGuid;\r
 \r