projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 54b330a4 DB |
1 | /** @file\r |
| 2 | Protocol of Ipmi for both SMS and SMM.\r | |
| 3 | \r | |
| 4 | Copyright (c) 2009 - 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_PROTOCOL_H_\r | |
| 16 | #define _IPMI_PROTOCOL_H_\r | |
| 17 | \r | |
| 18 | typedef struct _IPMI_PROTOCOL IPMI_PROTOCOL;\r | |
| 19 | \r | |
| 20 | #define IPMI_PROTOCOL_GUID \\r | |
| 21 | { \\r | |
| 22 | 0xdbc6381f, 0x5554, 0x4d14, 0x8f, 0xfd, 0x76, 0xd7, 0x87, 0xb8, 0xac, 0xbf \\r | |
| 23 | }\r | |
| 24 | \r | |
| 25 | #define SMM_IPMI_PROTOCOL_GUID \\r | |
| 26 | { \\r | |
| 27 | 0x5169af60, 0x8c5a, 0x4243, 0xb3, 0xe9, 0x56, 0xc5, 0x6d, 0x18, 0xee, 0x26 \\r | |
| 28 | }\r | |
| 29 | \r | |
| 30 | \r | |
| 31 | /**\r | |
| 32 | This service enables submitting commands via Ipmi.\r | |
| 33 | \r | |
| 34 | @param[in] This This point for IPMI_PROTOCOL structure.\r | |
| 35 | @param[in] NetFunction Net function of the command.\r | |
| 36 | @param[in] Command IPMI Command.\r | |
| 37 | @param[in] RequestData Command Request Data.\r | |
| 38 | @param[in] RequestDataSize Size of Command Request Data.\r | |
| 39 | @param[out] ResponseData Command Response Data. The completion code is the first byte of response data.\r | |
| 40 | @param[in, out] ResponseDataSize Size of Command Response Data.\r | |
| 41 | \r | |
| 42 | @retval EFI_SUCCESS The command byte stream was successfully submit to the device and a response was successfully received.\r | |
| 43 | @retval EFI_NOT_FOUND The command was not successfully sent to the device or a response was not successfully received from the device.\r | |
| 44 | @retval EFI_NOT_READY Ipmi Device is not ready for Ipmi command access.\r | |
| 45 | @retval EFI_DEVICE_ERROR Ipmi Device hardware error.\r | |
| 46 | @retval EFI_TIMEOUT The command time out.\r | |
| 47 | @retval EFI_UNSUPPORTED The command was not successfully sent to the device.\r | |
| 48 | @retval EFI_OUT_OF_RESOURCES The resource allcation is out of resource or data size error.\r | |
| 49 | **/\r | |
| 50 | typedef\r | |
| 51 | EFI_STATUS\r | |
| 52 | (EFIAPI *IPMI_SUBMIT_COMMAND) (\r | |
| 53 | IN IPMI_PROTOCOL *This,\r | |
| 54 | IN UINT8 NetFunction,\r | |
| 55 | IN UINT8 Command,\r | |
| 56 | IN UINT8 *RequestData,\r | |
| 57 | IN UINT32 RequestDataSize,\r | |
| 58 | OUT UINT8 *ResponseData,\r | |
| 59 | IN OUT UINT32 *ResponseDataSize\r | |
| 60 | );\r | |
| 61 | \r | |
| 62 | //\r | |
| 63 | // IPMI COMMAND PROTOCOL\r | |
| 64 | //\r | |
| 65 | struct _IPMI_PROTOCOL{\r | |
| 66 | IPMI_SUBMIT_COMMAND IpmiSubmitCommand;\r | |
| 67 | };\r | |
| 68 | \r | |
| 69 | extern EFI_GUID gIpmiProtocolGuid;\r | |
| 70 | extern EFI_GUID gSmmIpmiProtocolGuid;\r | |
| 71 | \r | |
| 72 | #endif\r |