MdeModulePkg/Include/Library/IpmiLib.h

   1 /** @file
   2   This library abstract how to access IPMI device via IPMI command.
   3
   4 Copyright (c) 2011 - 2015, Intel Corporation. All rights reserved. <BR>
   5 SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7 **/
   8
   9 #ifndef _IPMI_LIB_H_
  10 #define _IPMI_LIB_H_
  11
  12 #include <Uefi.h>
  13 #include <IndustryStandard/Ipmi.h>
  14
  15
  16 /**
  17   This service enables submitting commands via Ipmi.
  18
  19   @param[in]         NetFunction       Net function of the command.
  20   @param[in]         Command           IPMI Command.
  21   @param[in]         RequestData       Command Request Data.
  22   @param[in]         RequestDataSize   Size of Command Request Data.
  23   @param[out]        ResponseData      Command Response Data. The completion code is the first byte of response data.
  24   @param[in, out]    ResponseDataSize  Size of Command Response Data.
  25
  26   @retval EFI_SUCCESS            The command byte stream was successfully submit to the device and a response was successfully received.
  27   @retval EFI_NOT_FOUND          The command was not successfully sent to the device or a response was not successfully received from the device.
  28   @retval EFI_NOT_READY          Ipmi Device is not ready for Ipmi command access.
  29   @retval EFI_DEVICE_ERROR       Ipmi Device hardware error.
  30   @retval EFI_TIMEOUT            The command time out.
  31   @retval EFI_UNSUPPORTED        The command was not successfully sent to the device.
  32   @retval EFI_OUT_OF_RESOURCES   The resource allcation is out of resource or data size error.
  33 **/
  34 EFI_STATUS
  35 EFIAPI
  36 IpmiSubmitCommand (
  37   IN     UINT8     NetFunction,
  38   IN     UINT8     Command,
  39   IN     UINT8     *RequestData,
  40   IN     UINT32    RequestDataSize,
  41      OUT UINT8     *ResponseData,
  42   IN OUT UINT32    *ResponseDataSize
  43   );
  44
  45 #endif