UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm

[mirror_edk2.git] / MdeModulePkg / Include / Protocol / IpmiProtocol.h

/** @file\r
  Protocol of Ipmi for both SMS and SMM.\r
\r
  Copyright (c) 2009 - 2015, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _IPMI_PROTOCOL_H_\r
#define _IPMI_PROTOCOL_H_\r
\r
typedef struct _IPMI_PROTOCOL IPMI_PROTOCOL;\r
\r
#define IPMI_PROTOCOL_GUID \\r
  { \\r
    0xdbc6381f, 0x5554, 0x4d14, 0x8f, 0xfd, 0x76, 0xd7, 0x87, 0xb8, 0xac, 0xbf \\r
  }\r
\r
#define SMM_IPMI_PROTOCOL_GUID \\r
  { \\r
    0x5169af60, 0x8c5a, 0x4243, 0xb3, 0xe9, 0x56, 0xc5, 0x6d, 0x18, 0xee, 0x26 \\r
  }\r
\r
/**\r
  This service enables submitting commands via Ipmi.\r
\r
  @param[in]         This              This point for IPMI_PROTOCOL 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 *IPMI_SUBMIT_COMMAND)(\r
  IN     IPMI_PROTOCOL                 *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 COMMAND PROTOCOL\r
//\r
struct _IPMI_PROTOCOL {\r
  IPMI_SUBMIT_COMMAND    IpmiSubmitCommand;\r
};\r
\r
extern EFI_GUID  gIpmiProtocolGuid;\r
extern EFI_GUID  gSmmIpmiProtocolGuid;\r
\r
#endif\r