MdeModulePkg/Include/Ppi/IpmiPpi.h

   1 /** @file
   2   Ppi for Ipmi of SMS.
   3
   4   Copyright (c) 2014 - 2015, Intel Corporation. All rights reserved.<BR>
   5   SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7 **/
   8
   9 #ifndef _IPMI_PPI_H_
  10 #define _IPMI_PPI_H_
  11
  12 typedef struct _PEI_IPMI_PPI PEI_IPMI_PPI;
  13
  14 #define PEI_IPMI_PPI_GUID \
  15   { \
  16     0xa9731431, 0xd968, 0x4277, 0xb7, 0x52, 0xa3, 0xa9, 0xa6, 0xae, 0x18, 0x98 \
  17   }
  18
  19 /**
  20   This service enables submitting commands via Ipmi.
  21
  22   @param[in]         This              This point for PEI_IPMI_PPI structure.
  23   @param[in]         NetFunction       Net function of the command.
  24   @param[in]         Command           IPMI Command.
  25   @param[in]         RequestData       Command Request Data.
  26   @param[in]         RequestDataSize   Size of Command Request Data.
  27   @param[out]        ResponseData      Command Response Data. The completion code is the first byte of response data.
  28   @param[in, out]    ResponseDataSize  Size of Command Response Data.
  29
  30   @retval EFI_SUCCESS            The command byte stream was successfully submit to the device and a response was successfully received.
  31   @retval EFI_NOT_FOUND          The command was not successfully sent to the device or a response was not successfully received from the device.
  32   @retval EFI_NOT_READY          Ipmi Device is not ready for Ipmi command access.
  33   @retval EFI_DEVICE_ERROR       Ipmi Device hardware error.
  34   @retval EFI_TIMEOUT            The command time out.
  35   @retval EFI_UNSUPPORTED        The command was not successfully sent to the device.
  36   @retval EFI_OUT_OF_RESOURCES   The resource allcation is out of resource or data size error.
  37 **/
  38 typedef
  39 EFI_STATUS
  40 (EFIAPI *PEI_IPMI_SUBMIT_COMMAND) (
  41   IN     PEI_IPMI_PPI                      *This,
  42   IN     UINT8                             NetFunction,
  43   IN     UINT8                             Command,
  44   IN     UINT8                             *RequestData,
  45   IN     UINT32                            RequestDataSize,
  46      OUT UINT8                             *ResponseData,
  47   IN OUT UINT32                            *ResponseDataSize
  48   );
  49
  50 //
  51 // IPMI PPI
  52 //
  53 struct _PEI_IPMI_PPI {
  54   PEI_IPMI_SUBMIT_COMMAND       IpmiSubmitCommand;
  55 };
  56
  57 extern EFI_GUID gPeiIpmiPpiGuid;
  58
  59 #endif