]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Include/Ppi/IpmiPpi.h
MdeModulePkg/ResetSystemRuntimeDxe: Add platform filter and handler
[mirror_edk2.git] / MdeModulePkg / Include / Ppi / IpmiPpi.h
CommitLineData
54b330a4
DB
1/** @file\r
2 Ppi for Ipmi of SMS.\r
3\r
4 Copyright (c) 2014 - 2015, Intel Corporation. All rights reserved.<BR>\r
5 This program and the accompanying materials\r
6 are licensed and made available under the terms and conditions of the BSD License\r
7 which accompanies this distribution. The full text of the license may be found at\r
8 http://opensource.org/licenses/bsd-license.php.\r
9\r
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
13**/\r
14\r
15#ifndef _IPMI_PPI_H_\r
16#define _IPMI_PPI_H_\r
17\r
18typedef struct _PEI_IPMI_PPI PEI_IPMI_PPI;\r
19\r
20#define PEI_IPMI_PPI_GUID \\r
21 { \\r
22 0xa9731431, 0xd968, 0x4277, 0xb7, 0x52, 0xa3, 0xa9, 0xa6, 0xae, 0x18, 0x98 \\r
23 }\r
24\r
25/**\r
26 This service enables submitting commands via Ipmi.\r
27\r
28 @param[in] This This point for PEI_IPMI_PPI structure.\r
29 @param[in] NetFunction Net function of the command.\r
30 @param[in] Command IPMI Command.\r
31 @param[in] RequestData Command Request Data.\r
32 @param[in] RequestDataSize Size of Command Request Data.\r
33 @param[out] ResponseData Command Response Data. The completion code is the first byte of response data.\r
34 @param[in, out] ResponseDataSize Size of Command Response Data.\r
35\r
36 @retval EFI_SUCCESS The command byte stream was successfully submit to the device and a response was successfully received.\r
37 @retval EFI_NOT_FOUND The command was not successfully sent to the device or a response was not successfully received from the device.\r
38 @retval EFI_NOT_READY Ipmi Device is not ready for Ipmi command access.\r
39 @retval EFI_DEVICE_ERROR Ipmi Device hardware error.\r
40 @retval EFI_TIMEOUT The command time out.\r
41 @retval EFI_UNSUPPORTED The command was not successfully sent to the device.\r
42 @retval EFI_OUT_OF_RESOURCES The resource allcation is out of resource or data size error.\r
43**/\r
44typedef\r
45EFI_STATUS\r
46(EFIAPI *PEI_IPMI_SUBMIT_COMMAND) (\r
47 IN PEI_IPMI_PPI *This,\r
48 IN UINT8 NetFunction,\r
49 IN UINT8 Command,\r
50 IN UINT8 *RequestData,\r
51 IN UINT32 RequestDataSize,\r
52 OUT UINT8 *ResponseData,\r
53 IN OUT UINT32 *ResponseDataSize\r
54 );\r
55\r
56//\r
57// IPMI PPI\r
58//\r
59struct _PEI_IPMI_PPI {\r
60 PEI_IPMI_SUBMIT_COMMAND IpmiSubmitCommand;\r
61};\r
62\r
63extern EFI_GUID gPeiIpmiPpiGuid;\r
64\r
65#endif\r