MdeModulePkg: Add IpmiLib and Ppi/Protocol header file.

[mirror_edk2.git] / MdeModulePkg / Include / Ppi / IpmiPpi.h

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