Change IpmiBaseLibNull to BASE library type (#160)

## Description The IpmiBaseLibNull implementation currently restricts its library types and consumes libraries that it does not use. This change cleans up and generalizes the NULL imlementation. - [x] Impacts functionality? - [ ] Impacts security? - [ ] Breaking change? - [ ] Includes tests? - [ ] Includes documentation? ## How This Was Tested Local build ## Integration Instructions N/A
microsoft · Sep 20, 2023 · 0f3834b · 0f3834b
1 parent d1f7ecb
commit 0f3834b
Show file tree

Hide file tree

Showing 7 changed files with 16 additions and 7 deletions.
diff --git a/IpmiFeaturePkg/Include/Library/IpmiBaseLib.h b/IpmiFeaturePkg/Include/Library/IpmiBaseLib.h
@@ -30,6 +30,7 @@
   @retval   EFI_NOT_FOUND           Ipmi interface is not installed yet.
 **/
 EFI_STATUS
+EFIAPI
 IpmiSubmitCommand (
   IN UINT8       NetFunction,
   IN UINT8       Command,
@@ -49,6 +50,7 @@ IpmiSubmitCommand (
   @retval   EFI_NOT_AVAILABLE_YET   Ipmi interface is not installed yet.
 **/
 EFI_STATUS
+EFIAPI
 GetBmcStatus (
   OUT BMC_STATUS      *BmcStatus,
   OUT SM_COM_ADDRESS  *ComAddress

diff --git a/IpmiFeaturePkg/Library/IpmiBaseLibDxe/IpmiBaseLibDxe.c b/IpmiFeaturePkg/Library/IpmiBaseLibDxe/IpmiBaseLibDxe.c
@@ -28,6 +28,7 @@ STATIC IPMI_TRANSPORT  *mIpmiTransport = NULL;
   @retval   EFI_NOT_FOUND           Ipmi interface is not installed yet.
 **/
 EFI_STATUS
+EFIAPI
 IpmiSubmitCommand (
   IN UINT8       NetFunction,
   IN UINT8       Command,
@@ -70,6 +71,7 @@ IpmiSubmitCommand (
   @retval   EFI_NOT_AVAILABLE_YET   Ipmi interface is not installed yet.
 **/
 EFI_STATUS
+EFIAPI
 GetBmcStatus (
   OUT BMC_STATUS      *BmcStatus,
   OUT SM_COM_ADDRESS  *ComAddress

diff --git a/IpmiFeaturePkg/Library/IpmiBaseLibNull/IpmiBaseLibNull.c b/IpmiFeaturePkg/Library/IpmiBaseLibNull/IpmiBaseLibNull.c
@@ -6,12 +6,10 @@
   SPDX-License-Identifier: BSD-2-Clause-Patent
 **/
 
+#include <Uefi.h>
 #include <Library/BaseLib.h>
-#include <Library/UefiBootServicesTableLib.h>
-#include <Library/DxeServicesLib.h>
 #include <Library/DebugLib.h>
 #include <Library/IpmiBaseLib.h>
-#include <Ppi/IpmiTransportPpi.h>
 
 /**
   Sends a IPMI command to the BMC and returns the response.
@@ -28,6 +26,7 @@
   @retval   EFI_NOT_FOUND           Ipmi interface is not installed yet.
 **/
 EFI_STATUS
+EFIAPI
 IpmiSubmitCommand (
   IN UINT8       NetFunction,
   IN UINT8       Command,
@@ -50,6 +49,7 @@ IpmiSubmitCommand (
   @retval   EFI_NOT_AVAILABLE_YET   Ipmi interface is not installed yet.
 **/
 EFI_STATUS
+EFIAPI
 GetBmcStatus (
   OUT BMC_STATUS      *BmcStatus,
   OUT SM_COM_ADDRESS  *ComAddress

diff --git a/IpmiFeaturePkg/Library/IpmiBaseLibNull/IpmiBaseLibNull.inf b/IpmiFeaturePkg/Library/IpmiBaseLibNull/IpmiBaseLibNull.inf
@@ -2,16 +2,17 @@
 #
 # @copyright
 # Copyright 2011 - 2021 Intel Corporation. <BR>
+# Copyright (c) Microsoft Corporation
 # SPDX-License-Identifier: BSD-2-Clause-Patent
 ##
 
 [Defines]
   INF_VERSION                   = 0x00010005
   BASE_NAME                     = IpmiBaseLibNull
   FILE_GUID                     = 3444CF4F-8B88-4579-9A95-2E7678C0E945
-  MODULE_TYPE                   = DXE_SMM_DRIVER
+  MODULE_TYPE                   = BASE
   VERSION_STRING                = 1.0
-  LIBRARY_CLASS                 = IpmiBaseLib|DXE_CORE DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SMM_DRIVER UEFI_APPLICATION UEFI_DRIVER SMM_CORE
+  LIBRARY_CLASS                 = IpmiBaseLib
 
 #
 # The following information is for reference only and not required by the build tools.
@@ -28,8 +29,6 @@
 
 [LibraryClasses]
   BaseLib
-  UefiBootServicesTableLib
-  DxeServicesLib
   DebugLib
 
 [Guids]

diff --git a/IpmiFeaturePkg/Library/IpmiBaseLibPei/IpmiBaseLibPei.c b/IpmiFeaturePkg/Library/IpmiBaseLibPei/IpmiBaseLibPei.c
@@ -27,6 +27,7 @@
   @retval   EFI_NOT_FOUND           Ipmi interface is not installed yet.
 **/
 EFI_STATUS
+EFIAPI
 IpmiSubmitCommand (
   IN UINT8       NetFunction,
   IN UINT8       Command,
@@ -68,6 +69,7 @@ IpmiSubmitCommand (
   @retval   EFI_NOT_AVAILABLE_YET   Ipmi interface is not installed yet.
 **/
 EFI_STATUS
+EFIAPI
 GetBmcStatus (
   OUT BMC_STATUS      *BmcStatus,
   OUT SM_COM_ADDRESS  *ComAddress

diff --git a/IpmiFeaturePkg/Library/IpmiBaseLibSmm/IpmiBaseLibSmm.c b/IpmiFeaturePkg/Library/IpmiBaseLibSmm/IpmiBaseLibSmm.c
@@ -30,6 +30,7 @@ STATIC IPMI_TRANSPORT  *mIpmiTransport = NULL;
   @retval   EFI_NOT_AVAILABLE_YET   Ipmi interface is not installed yet.
 **/
 EFI_STATUS
+EFIAPI
 IpmiSubmitCommand (
   IN UINT8       NetFunction,
   IN UINT8       Command,
@@ -72,6 +73,7 @@ IpmiSubmitCommand (
   @retval   EFI_NOT_FOUND           Ipmi interface is not installed yet.
 **/
 EFI_STATUS
+EFIAPI
 GetBmcStatus (
   OUT BMC_STATUS      *BmcStatus,
   OUT SM_COM_ADDRESS  *ComAddress

diff --git a/IpmiFeaturePkg/Library/MockIpmi/IpmiBaseLibMock.c b/IpmiFeaturePkg/Library/MockIpmi/IpmiBaseLibMock.c
@@ -29,6 +29,7 @@ STATIC UINT8  ResponseBuffer[MOCK_BASE_IPMI_BUFFER_SIZE];
   @retval   EFI_NOT_FOUND           Ipmi interface is not installed yet.
 **/
 EFI_STATUS
+EFIAPI
 IpmiSubmitCommand (
   IN UINT8       NetFunction,
   IN UINT8       Command,
@@ -82,6 +83,7 @@ IpmiSubmitCommand (
   @retval   EFI_NOT_AVAILABLE_YET   Ipmi interface is not installed yet.
 **/
 EFI_STATUS
+EFIAPI
 GetBmcStatus (
   OUT BMC_STATUS      *BmcStatus,
   OUT SM_COM_ADDRESS  *ComAddress