MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Include / Library / IpmiLib.h

/** @file\r
  This library abstract how to access IPMI device via IPMI command.\r
\r
Copyright (c) 2011 - 2015, Intel Corporation. All rights reserved. <BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _IPMI_LIB_H_\r
#define _IPMI_LIB_H_\r
\r
#include <Uefi.h>\r
#include <IndustryStandard/Ipmi.h>\r
\r
\r
/**\r
  This service enables submitting commands via Ipmi.\r
\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
EFI_STATUS\r
EFIAPI\r
IpmiSubmitCommand (\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
#endif\r