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.

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/trunk/edk2@19485 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdeModulePkg/Include/Library/IpmiLib.h b/MdeModulePkg/Include/Library/IpmiLib.h
new file mode 100644 (file)
index 0000000..71b0c1a
--- /dev/null
+++ b/MdeModulePkg/Include/Library/IpmiLib.h
@@ -0,0 +1,51 @@
+/** @file\r
+  This library abstract how to access IPMI device via IPMI command.\r
+\r
+Copyright (c) 2011 - 2015, Intel Corporation. All rights reserved. <BR>\r
+This program and the accompanying materials\r
+are licensed and made available under the terms and conditions of the BSD License\r
+which accompanies this distribution.  The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php\r
+\r
+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
+\r
+#ifndef _IPMI_LIB_H_\r
+#define _IPMI_LIB_H_\r
+\r
+#include <Uefi.h>\r
+#include <IndustryStandard/Ipmi.h>\r
+\r
+\r
+/**\r
+  This service enables submitting commands via Ipmi.\r
+\r
+  @param[in]         NetFunction       Net function of the command.\r
+  @param[in]         Command           IPMI Command.\r
+  @param[in]         RequestData       Command Request Data.\r
+  @param[in]         RequestDataSize   Size of Command Request Data.\r
+  @param[out]        ResponseData      Command Response Data. The completion code is the first byte of response data.\r
+  @param[in, out]    ResponseDataSize  Size of Command Response Data.\r
+\r
+  @retval EFI_SUCCESS            The command byte stream was successfully submit to the device and a response was successfully received.\r
+  @retval EFI_NOT_FOUND          The command was not successfully sent to the device or a response was not successfully received from the device.\r
+  @retval EFI_NOT_READY          Ipmi Device is not ready for Ipmi command access.\r
+  @retval EFI_DEVICE_ERROR       Ipmi Device hardware error.\r
+  @retval EFI_TIMEOUT            The command time out.\r
+  @retval EFI_UNSUPPORTED        The command was not successfully sent to the device.\r
+  @retval EFI_OUT_OF_RESOURCES   The resource allcation is out of resource or data size error.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+IpmiSubmitCommand (\r
+  IN     UINT8     NetFunction,\r
+  IN     UINT8     Command,\r
+  IN     UINT8     *RequestData,\r
+  IN     UINT32    RequestDataSize,\r
+     OUT UINT8     *ResponseData,\r
+  IN OUT UINT32    *ResponseDataSize\r
+  );\r
+\r
+#endif\r

diff --git a/MdeModulePkg/Include/Ppi/IpmiPpi.h b/MdeModulePkg/Include/Ppi/IpmiPpi.h
new file mode 100644 (file)
index 0000000..b8f7063
--- /dev/null
+++ b/MdeModulePkg/Include/Ppi/IpmiPpi.h
@@ -0,0 +1,65 @@
+/** @file\r
+  Ppi for Ipmi of SMS.\r
+\r
+  Copyright (c) 2014 - 2015, Intel Corporation. All rights reserved.<BR>\r
+  This program and the accompanying materials\r
+  are licensed and made available under the terms and conditions of the BSD License\r
+  which accompanies this distribution.  The full text of the license may be found at\r
+  http://opensource.org/licenses/bsd-license.php.\r
+\r
+  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
+\r
+#ifndef _IPMI_PPI_H_\r
+#define _IPMI_PPI_H_\r
+\r
+typedef struct _PEI_IPMI_PPI PEI_IPMI_PPI;\r
+\r
+#define PEI_IPMI_PPI_GUID \\r
+  { \\r
+    0xa9731431, 0xd968, 0x4277, 0xb7, 0x52, 0xa3, 0xa9, 0xa6, 0xae, 0x18, 0x98 \\r
+  }\r
+\r
+/**\r
+  This service enables submitting commands via Ipmi.\r
+\r
+  @param[in]         This              This point for PEI_IPMI_PPI structure.\r
+  @param[in]         NetFunction       Net function of the command.\r
+  @param[in]         Command           IPMI Command.\r
+  @param[in]         RequestData       Command Request Data.\r
+  @param[in]         RequestDataSize   Size of Command Request Data.\r
+  @param[out]        ResponseData      Command Response Data. The completion code is the first byte of response data.\r
+  @param[in, out]    ResponseDataSize  Size of Command Response Data.\r
+\r
+  @retval EFI_SUCCESS            The command byte stream was successfully submit to the device and a response was successfully received.\r
+  @retval EFI_NOT_FOUND          The command was not successfully sent to the device or a response was not successfully received from the device.\r
+  @retval EFI_NOT_READY          Ipmi Device is not ready for Ipmi command access.\r
+  @retval EFI_DEVICE_ERROR       Ipmi Device hardware error.\r
+  @retval EFI_TIMEOUT            The command time out.\r
+  @retval EFI_UNSUPPORTED        The command was not successfully sent to the device.\r
+  @retval EFI_OUT_OF_RESOURCES   The resource allcation is out of resource or data size error.\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *PEI_IPMI_SUBMIT_COMMAND) (\r
+  IN     PEI_IPMI_PPI                      *This,\r
+  IN     UINT8                             NetFunction,\r
+  IN     UINT8                             Command,\r
+  IN     UINT8                             *RequestData,\r
+  IN     UINT32                            RequestDataSize,\r
+     OUT UINT8                             *ResponseData,\r
+  IN OUT UINT32                            *ResponseDataSize\r
+  );\r
+\r
+//\r
+// IPMI PPI\r
+//\r
+struct _PEI_IPMI_PPI {\r
+  PEI_IPMI_SUBMIT_COMMAND       IpmiSubmitCommand;\r
+};\r
+\r
+extern EFI_GUID gPeiIpmiPpiGuid;\r
+\r
+#endif\r

diff --git a/MdeModulePkg/Include/Protocol/IpmiProtocol.h b/MdeModulePkg/Include/Protocol/IpmiProtocol.h
new file mode 100644 (file)
index 0000000..a02ca6c
--- /dev/null
+++ b/MdeModulePkg/Include/Protocol/IpmiProtocol.h
@@ -0,0 +1,72 @@
+/** @file\r
+  Protocol of Ipmi for both SMS and SMM.\r
+\r
+  Copyright (c) 2009 - 2015, Intel Corporation. All rights reserved.<BR>\r
+  This program and the accompanying materials\r
+  are licensed and made available under the terms and conditions of the BSD License\r
+  which accompanies this distribution.  The full text of the license may be found at\r
+  http://opensource.org/licenses/bsd-license.php.\r
+\r
+  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
+\r
+#ifndef _IPMI_PROTOCOL_H_\r
+#define _IPMI_PROTOCOL_H_\r
+\r
+typedef struct _IPMI_PROTOCOL IPMI_PROTOCOL;\r
+\r
+#define IPMI_PROTOCOL_GUID \\r
+  { \\r
+    0xdbc6381f, 0x5554, 0x4d14, 0x8f, 0xfd, 0x76, 0xd7, 0x87, 0xb8, 0xac, 0xbf \\r
+  }\r
+\r
+#define SMM_IPMI_PROTOCOL_GUID \\r
+  { \\r
+    0x5169af60, 0x8c5a, 0x4243, 0xb3, 0xe9, 0x56, 0xc5, 0x6d, 0x18, 0xee, 0x26 \\r
+  }\r
+\r
+\r
+/**\r
+  This service enables submitting commands via Ipmi.\r
+\r
+  @param[in]         This              This point for IPMI_PROTOCOL structure.\r
+  @param[in]         NetFunction       Net function of the command.\r
+  @param[in]         Command           IPMI Command.\r
+  @param[in]         RequestData       Command Request Data.\r
+  @param[in]         RequestDataSize   Size of Command Request Data.\r
+  @param[out]        ResponseData      Command Response Data. The completion code is the first byte of response data.\r
+  @param[in, out]    ResponseDataSize  Size of Command Response Data.\r
+\r
+  @retval EFI_SUCCESS            The command byte stream was successfully submit to the device and a response was successfully received.\r
+  @retval EFI_NOT_FOUND          The command was not successfully sent to the device or a response was not successfully received from the device.\r
+  @retval EFI_NOT_READY          Ipmi Device is not ready for Ipmi command access.\r
+  @retval EFI_DEVICE_ERROR       Ipmi Device hardware error.\r
+  @retval EFI_TIMEOUT            The command time out.\r
+  @retval EFI_UNSUPPORTED        The command was not successfully sent to the device.\r
+  @retval EFI_OUT_OF_RESOURCES   The resource allcation is out of resource or data size error.\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *IPMI_SUBMIT_COMMAND) (\r
+  IN     IPMI_PROTOCOL                 *This,\r
+  IN     UINT8                         NetFunction,\r
+  IN     UINT8                         Command,\r
+  IN     UINT8                         *RequestData,\r
+  IN     UINT32                        RequestDataSize,\r
+     OUT UINT8                         *ResponseData,\r
+  IN OUT UINT32                        *ResponseDataSize\r
+  );\r
+\r
+//\r
+// IPMI COMMAND PROTOCOL\r
+//\r
+struct _IPMI_PROTOCOL{\r
+  IPMI_SUBMIT_COMMAND       IpmiSubmitCommand;\r
+};\r
+\r
+extern EFI_GUID gIpmiProtocolGuid;\r
+extern EFI_GUID gSmmIpmiProtocolGuid;\r
+\r
+#endif\r

diff --git a/MdeModulePkg/MdeModulePkg.dec b/MdeModulePkg/MdeModulePkg.dec
index a96229676d06f38eee524610c025bba448eef96a..cb7d25420e92dba9cf73fb24d7c4ae6b09d8205b 100644 (file)
--- a/MdeModulePkg/MdeModulePkg.dec
+++ b/MdeModulePkg/MdeModulePkg.dec
@@ -143,6 +143,10 @@
   #\r
   BootLogoLib|Include/Library/BootLogoLib.h\r
 \r
+  ## @libraryclass  Provides interfaces about Ipmi submit generic commond.\r
+  #\r
+  IpmiLib|Include/Library/IpmiLib.h\r
+\r
 [Guids]\r
   ## MdeModule package token space guid\r
   # Include/Guid/MdeModulePkgTokenSpace.h\r
@@ -372,6 +376,9 @@
   ## Include/Ppi/UfsHostController.h\r
   gEdkiiPeiUfsHostControllerPpiGuid  =  { 0xdc54b283, 0x1a77, 0x4cd6, { 0x83, 0xbb, 0xfd, 0xda, 0x46, 0x9a, 0x2e, 0xc6 }}\r
 \r
+  ## Include/Ppi/IpmiPpi.h\r
+  gPeiIpmiPpiGuid               =  { 0xa9731431, 0xd968, 0x4277, { 0xb7, 0x52, 0xa3, 0xa9, 0xa6, 0xae, 0x18, 0x98 }}\r
+\r
 [Protocols]\r
   ## Load File protocol provides capability to load and unload EFI image into memory and execute it.\r
   #  Include/Protocol/LoadPe32Image.h\r
@@ -470,6 +477,10 @@
   ## Include/Protocol/FileExplorer.h\r
   gEfiFileExplorerProtocolGuid = { 0x2C03C536, 0x4594, 0x4515, { 0x9E, 0x7A, 0xD3, 0xD2, 0x04, 0xFE, 0x13, 0x63 } }\r
 \r
+  ## Include/Protocol/IpmiProtocol.h\r
+  gIpmiProtocolGuid    = { 0xdbc6381f, 0x5554, 0x4d14, { 0x8f, 0xfd, 0x76, 0xd7, 0x87, 0xb8, 0xac, 0xbf } }\r
+  gSmmIpmiProtocolGuid = { 0x5169af60, 0x8c5a, 0x4243, { 0xb3, 0xe9, 0x56, 0xc5, 0x6d, 0x18, 0xee, 0x26 } }\r
+\r
 #\r
 # [Error.gEfiMdeModulePkgTokenSpaceGuid]\r
 #   0x80000001 | Invalid value provided.\r