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

[mirror_edk2.git] / MdePkg / Library / PeiSmbusLibSmbus2Ppi / InternalSmbusLib.h

/** @file\r
Internal header file for Smbus library.\r
\r
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
\r
**/\r
\r
#ifndef __INTERNAL_SMBUS_LIB_H_\r
#define __INTERNAL_SMBUS_LIB_H_\r
\r
#include <PiPei.h>\r
\r
#include <Ppi/Smbus2.h>\r
\r
#include <Library/SmbusLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/PeiServicesLib.h>\r
#include <Library/BaseMemoryLib.h>\r
\r
//\r
// Declaration for internal functions\r
//\r
\r
/**\r
  Gets Smbus PPIs.\r
\r
  This internal function retrieves Smbus PPI from PPI database.\r
\r
  @param  VOID\r
\r
  @return The pointer to Smbus PPI.\r
\r
**/\r
EFI_PEI_SMBUS2_PPI *\r
InternalGetSmbusPpi (\r
  VOID\r
  );\r
\r
/**\r
  Executes an SMBus operation to an SMBus controller.\r
\r
  This function provides a standard way to execute Smbus script\r
  as defined in the SmBus Specification. The data can either be of\r
  the Length byte, word, or a block of data.\r
\r
  @param  SmbusOperation  Signifies which particular SMBus hardware protocol\r
                          instance that it will use to execute the SMBus transactions.\r
  @param  SmBusAddress    The address that encodes the SMBUS Slave Address,\r
                          SMBUS Command, SMBUS Data Length, and PEC.\r
  @param  Length          Signifies the number of bytes that this operation will\r
                          do. The maximum number of bytes can be revision specific\r
                          and operation specific.\r
  @param  Buffer          Contains the value of data to execute to the SMBus slave\r
                          device. Not all operations require this argument. The\r
                          length of this buffer is identified by Length.\r
  @param  Status          Return status for the executed command.\r
                          This is an optional parameter and may be NULL.\r
\r
  @return The actual number of bytes that are executed for this operation.\r
\r
**/\r
UINTN\r
InternalSmBusExec (\r
  IN     EFI_SMBUS_OPERATION  SmbusOperation,\r
  IN     UINTN                SmBusAddress,\r
  IN     UINTN                Length,\r
  IN OUT VOID                 *Buffer,\r
  OUT RETURN_STATUS           *Status        OPTIONAL\r
  );\r
\r
#endif\r