MdeModulePkg: Add IpmiLib and Ppi/Protocol header file.

Add IpmiLib and Ppi/Protocol header file. Update dec file
for new IpmiLib and Ppi/Protocol header file.

In V5,change for coding style.

(Sync patch r19485 from main trunk.)

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Daocheng Bu <daocheng.bu@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/branches/UDK2015@19494 6f19259b-4bc3-4df7-8a09-765794883524

4 files changed, 199 insertions, 0 deletions

diff --git a/MdeModulePkg/Include/Library/IpmiLib.h b/MdeModulePkg/Include/Library/IpmiLib.h
new file mode 100644
index 0000000000..71b0c1a5a3
--- /dev/null
+++ b/MdeModulePkg/Include/Library/IpmiLib.h
@@ -0,0 +1,51 @@
+/** @file

+  This library abstract how to access IPMI device via IPMI command.

+

+Copyright (c) 2011 - 2015, Intel Corporation. All rights reserved. <BR>

+This program and the accompanying materials

+are licensed and made available under the terms and conditions of the BSD License

+which accompanies this distribution.  The full text of the license may be found at

+http://opensource.org/licenses/bsd-license.php

+

+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+

+**/

+

+#ifndef _IPMI_LIB_H_

+#define _IPMI_LIB_H_

+

+#include <Uefi.h>

+#include <IndustryStandard/Ipmi.h>

+

+

+/**

+  This service enables submitting commands via Ipmi.

+

+  @param[in]         NetFunction       Net function of the command.

+  @param[in]         Command           IPMI Command.

+  @param[in]         RequestData       Command Request Data.

+  @param[in]         RequestDataSize   Size of Command Request Data.

+  @param[out]        ResponseData      Command Response Data. The completion code is the first byte of response data.

+  @param[in, out]    ResponseDataSize  Size of Command Response Data.

+

+  @retval EFI_SUCCESS            The command byte stream was successfully submit to the device and a response was successfully received.

+  @retval EFI_NOT_FOUND          The command was not successfully sent to the device or a response was not successfully received from the device.

+  @retval EFI_NOT_READY          Ipmi Device is not ready for Ipmi command access.

+  @retval EFI_DEVICE_ERROR       Ipmi Device hardware error.

+  @retval EFI_TIMEOUT            The command time out.

+  @retval EFI_UNSUPPORTED        The command was not successfully sent to the device.

+  @retval EFI_OUT_OF_RESOURCES   The resource allcation is out of resource or data size error.

+**/

+EFI_STATUS

+EFIAPI

+IpmiSubmitCommand (

+  IN     UINT8     NetFunction,

+  IN     UINT8     Command,

+  IN     UINT8     *RequestData,

+  IN     UINT32    RequestDataSize,

+     OUT UINT8     *ResponseData,

+  IN OUT UINT32    *ResponseDataSize

+  );

+

+#endif

diff --git a/MdeModulePkg/Include/Ppi/IpmiPpi.h b/MdeModulePkg/Include/Ppi/IpmiPpi.h
new file mode 100644
index 0000000000..b8f7063424
--- /dev/null
+++ b/MdeModulePkg/Include/Ppi/IpmiPpi.h
@@ -0,0 +1,65 @@
+/** @file

+  Ppi for Ipmi of SMS.

+

+  Copyright (c) 2014 - 2015, Intel Corporation. All rights reserved.<BR>

+  This program and the accompanying materials

+  are licensed and made available under the terms and conditions of the BSD License

+  which accompanies this distribution.  The full text of the license may be found at

+  http://opensource.org/licenses/bsd-license.php.

+

+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+

+**/

+

+#ifndef _IPMI_PPI_H_

+#define _IPMI_PPI_H_

+

+typedef struct _PEI_IPMI_PPI PEI_IPMI_PPI;

+

+#define PEI_IPMI_PPI_GUID \

+  { \

+    0xa9731431, 0xd968, 0x4277, 0xb7, 0x52, 0xa3, 0xa9, 0xa6, 0xae, 0x18, 0x98 \

+  }

+

+/**

+  This service enables submitting commands via Ipmi.

+

+  @param[in]         This              This point for PEI_IPMI_PPI structure.

+  @param[in]         NetFunction       Net function of the command.

+  @param[in]         Command           IPMI Command.

+  @param[in]         RequestData       Command Request Data.

+  @param[in]         RequestDataSize   Size of Command Request Data.

+  @param[out]        ResponseData      Command Response Data. The completion code is the first byte of response data.

+  @param[in, out]    ResponseDataSize  Size of Command Response Data.

+

+  @retval EFI_SUCCESS            The command byte stream was successfully submit to the device and a response was successfully received.

+  @retval EFI_NOT_FOUND          The command was not successfully sent to the device or a response was not successfully received from the device.

+  @retval EFI_NOT_READY          Ipmi Device is not ready for Ipmi command access.

+  @retval EFI_DEVICE_ERROR       Ipmi Device hardware error.

+  @retval EFI_TIMEOUT            The command time out.

+  @retval EFI_UNSUPPORTED        The command was not successfully sent to the device.

+  @retval EFI_OUT_OF_RESOURCES   The resource allcation is out of resource or data size error.

+**/

+typedef

+EFI_STATUS

+(EFIAPI *PEI_IPMI_SUBMIT_COMMAND) (

+  IN     PEI_IPMI_PPI                      *This,

+  IN     UINT8                             NetFunction,

+  IN     UINT8                             Command,

+  IN     UINT8                             *RequestData,

+  IN     UINT32                            RequestDataSize,

+     OUT UINT8                             *ResponseData,

+  IN OUT UINT32                            *ResponseDataSize

+  );

+

+//

+// IPMI PPI

+//

+struct _PEI_IPMI_PPI {

+  PEI_IPMI_SUBMIT_COMMAND       IpmiSubmitCommand;

+};

+

+extern EFI_GUID gPeiIpmiPpiGuid;

+

+#endif

diff --git a/MdeModulePkg/Include/Protocol/IpmiProtocol.h b/MdeModulePkg/Include/Protocol/IpmiProtocol.h
new file mode 100644
index 0000000000..a02ca6cb73
--- /dev/null
+++ b/MdeModulePkg/Include/Protocol/IpmiProtocol.h
@@ -0,0 +1,72 @@
+/** @file

+  Protocol of Ipmi for both SMS and SMM.

+

+  Copyright (c) 2009 - 2015, Intel Corporation. All rights reserved.<BR>

+  This program and the accompanying materials

+  are licensed and made available under the terms and conditions of the BSD License

+  which accompanies this distribution.  The full text of the license may be found at

+  http://opensource.org/licenses/bsd-license.php.

+

+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+

+**/

+

+#ifndef _IPMI_PROTOCOL_H_

+#define _IPMI_PROTOCOL_H_

+

+typedef struct _IPMI_PROTOCOL IPMI_PROTOCOL;

+

+#define IPMI_PROTOCOL_GUID \

+  { \

+    0xdbc6381f, 0x5554, 0x4d14, 0x8f, 0xfd, 0x76, 0xd7, 0x87, 0xb8, 0xac, 0xbf \

+  }

+

+#define SMM_IPMI_PROTOCOL_GUID \

+  { \

+    0x5169af60, 0x8c5a, 0x4243, 0xb3, 0xe9, 0x56, 0xc5, 0x6d, 0x18, 0xee, 0x26 \

+  }

+

+

+/**

+  This service enables submitting commands via Ipmi.

+

+  @param[in]         This              This point for IPMI_PROTOCOL structure.

+  @param[in]         NetFunction       Net function of the command.

+  @param[in]         Command           IPMI Command.

+  @param[in]         RequestData       Command Request Data.

+  @param[in]         RequestDataSize   Size of Command Request Data.

+  @param[out]        ResponseData      Command Response Data. The completion code is the first byte of response data.

+  @param[in, out]    ResponseDataSize  Size of Command Response Data.

+

+  @retval EFI_SUCCESS            The command byte stream was successfully submit to the device and a response was successfully received.

+  @retval EFI_NOT_FOUND          The command was not successfully sent to the device or a response was not successfully received from the device.

+  @retval EFI_NOT_READY          Ipmi Device is not ready for Ipmi command access.

+  @retval EFI_DEVICE_ERROR       Ipmi Device hardware error.

+  @retval EFI_TIMEOUT            The command time out.

+  @retval EFI_UNSUPPORTED        The command was not successfully sent to the device.

+  @retval EFI_OUT_OF_RESOURCES   The resource allcation is out of resource or data size error.

+**/

+typedef

+EFI_STATUS

+(EFIAPI *IPMI_SUBMIT_COMMAND) (

+  IN     IPMI_PROTOCOL                 *This,

+  IN     UINT8                         NetFunction,

+  IN     UINT8                         Command,

+  IN     UINT8                         *RequestData,

+  IN     UINT32                        RequestDataSize,

+     OUT UINT8                         *ResponseData,

+  IN OUT UINT32                        *ResponseDataSize

+  );

+

+//

+// IPMI COMMAND PROTOCOL

+//

+struct _IPMI_PROTOCOL{

+  IPMI_SUBMIT_COMMAND       IpmiSubmitCommand;

+};

+

+extern EFI_GUID gIpmiProtocolGuid;

+extern EFI_GUID gSmmIpmiProtocolGuid;

+

+#endif

diff --git a/MdeModulePkg/MdeModulePkg.dec b/MdeModulePkg/MdeModulePkg.dec
index ea70c7e3da..16d60e72d2 100644
--- a/MdeModulePkg/MdeModulePkg.dec
+++ b/MdeModulePkg/MdeModulePkg.dec
@@ -131,6 +131,10 @@
   #

   PlatformVarCleanupLib|Include/Library/PlatformVarCleanupLib.h

 

+  ## @libraryclass  Provides interfaces about Ipmi submit generic commond.

+  #

+  IpmiLib|Include/Library/IpmiLib.h

+

 [Guids]

   ## MdeModule package token space guid

   # Include/Guid/MdeModulePkgTokenSpace.h

@@ -357,6 +361,9 @@
   ## Include/Ppi/UfsHostController.h

   gEdkiiPeiUfsHostControllerPpiGuid  =  { 0xdc54b283, 0x1a77, 0x4cd6, { 0x83, 0xbb, 0xfd, 0xda, 0x46, 0x9a, 0x2e, 0xc6 }}

 

+  ## Include/Ppi/IpmiPpi.h

+  gPeiIpmiPpiGuid               =  { 0xa9731431, 0xd968, 0x4277, { 0xb7, 0x52, 0xa3, 0xa9, 0xa6, 0xae, 0x18, 0x98 }}

+

 [Protocols]

   ## Load File protocol provides capability to load and unload EFI image into memory and execute it.

   #  Include/Protocol/LoadPe32Image.h

@@ -449,6 +456,10 @@
   ## Include/Protocol/SmmReadyToBoot.h

   gEdkiiSmmReadyToBootProtocolGuid = { 0x6e057ecf, 0xfa99, 0x4f39, { 0x95, 0xbc, 0x59, 0xf9, 0x92, 0x1d, 0x17, 0xe4 } }

 

+  ## Include/Protocol/IpmiProtocol.h

+  gIpmiProtocolGuid    = { 0xdbc6381f, 0x5554, 0x4d14, { 0x8f, 0xfd, 0x76, 0xd7, 0x87, 0xb8, 0xac, 0xbf } }

+  gSmmIpmiProtocolGuid = { 0x5169af60, 0x8c5a, 0x4243, { 0xb3, 0xe9, 0x56, 0xc5, 0x6d, 0x18, 0xee, 0x26 } }

+

 #

 # [Error.gEfiMdeModulePkgTokenSpaceGuid]

 #   0x80000001 | Invalid value provided.