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