1 /** @file 2 Protocol of Ipmi for both SMS and SMM. 3 4 Copyright (c) 2009 - 2015, Intel Corporation. All rights reserved.<BR> 5 This program and the accompanying materials 6 are licensed and made available under the terms and conditions of the BSD License 7 which accompanies this distribution. The full text of the license may be found at 8 http://opensource.org/licenses/bsd-license.php. 9 10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, 11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. 12 13 **/ 14 15 #ifndef _IPMI_PROTOCOL_H_ 16 #define _IPMI_PROTOCOL_H_ 17 18 typedef struct _IPMI_PROTOCOL IPMI_PROTOCOL; 19 20 #define IPMI_PROTOCOL_GUID \ 21 { \ 22 0xdbc6381f, 0x5554, 0x4d14, 0x8f, 0xfd, 0x76, 0xd7, 0x87, 0xb8, 0xac, 0xbf \ 23 } 24 25 #define SMM_IPMI_PROTOCOL_GUID \ 26 { \ 27 0x5169af60, 0x8c5a, 0x4243, 0xb3, 0xe9, 0x56, 0xc5, 0x6d, 0x18, 0xee, 0x26 \ 28 } 29 30 31 /** 32 This service enables submitting commands via Ipmi. 33 34 @param[in] This This point for IPMI_PROTOCOL structure. 35 @param[in] NetFunction Net function of the command. 36 @param[in] Command IPMI Command. 37 @param[in] RequestData Command Request Data. 38 @param[in] RequestDataSize Size of Command Request Data. 39 @param[out] ResponseData Command Response Data. The completion code is the first byte of response data. 40 @param[in, out] ResponseDataSize Size of Command Response Data. 41 42 @retval EFI_SUCCESS The command byte stream was successfully submit to the device and a response was successfully received. 43 @retval EFI_NOT_FOUND The command was not successfully sent to the device or a response was not successfully received from the device. 44 @retval EFI_NOT_READY Ipmi Device is not ready for Ipmi command access. 45 @retval EFI_DEVICE_ERROR Ipmi Device hardware error. 46 @retval EFI_TIMEOUT The command time out. 47 @retval EFI_UNSUPPORTED The command was not successfully sent to the device. 48 @retval EFI_OUT_OF_RESOURCES The resource allcation is out of resource or data size error. 49 **/ 50 typedef 51 EFI_STATUS 52 (EFIAPI *IPMI_SUBMIT_COMMAND) ( 53 IN IPMI_PROTOCOL *This, 54 IN UINT8 NetFunction, 55 IN UINT8 Command, 56 IN UINT8 *RequestData, 57 IN UINT32 RequestDataSize, 58 OUT UINT8 *ResponseData, 59 IN OUT UINT32 *ResponseDataSize 60 ); 61 62 // 63 // IPMI COMMAND PROTOCOL 64 // 65 struct _IPMI_PROTOCOL{ 66 IPMI_SUBMIT_COMMAND IpmiSubmitCommand; 67 }; 68 69 extern EFI_GUID gIpmiProtocolGuid; 70 extern EFI_GUID gSmmIpmiProtocolGuid; 71 72 #endif 73
