MdeModulePkg/Library/SmmIpmiLibSmmIpmiProtocol/SmmIpmiLibSmmIpmiProtocol.c

   1 /** @file
   2   Implementation of Ipmi Library for 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 #include <PiSmm.h>
  10 #include <Protocol/IpmiProtocol.h>
  11 #include <Library/IpmiLib.h>
  12 #include <Library/SmmServicesTableLib.h>
  13 #include <Library/DebugLib.h>
  14
  15 IPMI_PROTOCOL *mIpmiProtocol = NULL;
  16
  17 /**
  18   This service enables submitting commands via Ipmi.
  19
  20   @param[in]         NetFunction       Net function of the command.
  21   @param[in]         Command           IPMI Command.
  22   @param[in]         RequestData       Command Request Data.
  23   @param[in]         RequestDataSize   Size of Command Request Data.
  24   @param[out]        ResponseData      Command Response Data. The completion code is the first byte of response data.
  25   @param[in, out]    ResponseDataSize  Size of Command Response Data.
  26
  27   @retval EFI_SUCCESS            The command byte stream was successfully submit to the device and a response was successfully received.
  28   @retval EFI_NOT_FOUND          The command was not successfully sent to the device or a response was not successfully received from the device.
  29   @retval EFI_NOT_READY          Ipmi Device is not ready for Ipmi command access.
  30   @retval EFI_DEVICE_ERROR       Ipmi Device hardware error.
  31   @retval EFI_TIMEOUT            The command time out.
  32   @retval EFI_UNSUPPORTED        The command was not successfully sent to the device.
  33   @retval EFI_OUT_OF_RESOURCES   The resource allcation is out of resource or data size error.
  34 **/
  35 EFI_STATUS
  36 EFIAPI
  37 IpmiSubmitCommand (
  38   IN     UINT8     NetFunction,
  39   IN     UINT8     Command,
  40   IN     UINT8     *RequestData,
  41   IN     UINT32    RequestDataSize,
  42      OUT UINT8     *ResponseData,
  43   IN OUT UINT32    *ResponseDataSize
  44   )
  45 {
  46   EFI_STATUS  Status;
  47
  48   if (mIpmiProtocol == NULL) {
  49     Status = gSmst->SmmLocateProtocol (
  50                   &gSmmIpmiProtocolGuid,
  51                   NULL,
  52                   (VOID **) &mIpmiProtocol
  53                   );
  54     if (EFI_ERROR (Status)) {
  55       //
  56       // Smm Ipmi Protocol is not installed. So, IPMI device is not present.
  57       //
  58       DEBUG ((EFI_D_ERROR, "IpmiSubmitCommand for SMM Status - %r\n", Status));
  59       return EFI_NOT_FOUND;
  60     }
  61   }
  62
  63   Status = mIpmiProtocol->IpmiSubmitCommand (
  64                             mIpmiProtocol,
  65                             NetFunction,
  66                             Command,
  67                             RequestData,
  68                             RequestDataSize,
  69                             ResponseData,
  70                             ResponseDataSize
  71                             );
  72   if (EFI_ERROR (Status)) {
  73     return Status;
  74   }
  75   return EFI_SUCCESS;
  76 }