MdePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdePkg / Library / BaseS3SmbusLib / S3SmbusLib.c

/** @file\r
  Smbus Library Services that do SMBus transactions and also enable the operatation\r
  to be replayed during an S3 resume. This library class maps directly on top\r
  of the SmbusLib class.\r
\r
  Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
\r
#include <Base.h>\r
\r
#include <Library/DebugLib.h>\r
#include <Library/S3BootScriptLib.h>\r
#include <Library/SmbusLib.h>\r
#include <Library/S3SmbusLib.h>\r
\r
/**\r
  Saves an SMBus operation to S3 script to be replayed on S3 resume.\r
\r
  This function provides a standard way to save SMBus operation to S3 boot Script.\r
  The data can either be of the Length byte, word, or a block of data.\r
  If it falis to save S3 boot script, then ASSERT ().\r
\r
  @param  SmbusOperation  Signifies which particular SMBus hardware protocol instance that it will use to\r
                          execute the SMBus transactions.\r
  @param  SmBusAddress    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 do. The maximum number of\r
                          bytes can be revision specific and operation specific.\r
  @param  Buffer          Contains the value of data to execute to the SMBus slave device. Not all operations\r
                          require this argument. The length of this buffer is identified by Length.\r
\r
**/\r
VOID\r
InternalSaveSmBusExecToBootScript (\r
  IN     EFI_SMBUS_OPERATION        SmbusOperation,\r
  IN     UINTN                      SmBusAddress,\r
  IN     UINTN                      Length,\r
  IN OUT VOID                       *Buffer\r
  )\r
{\r
  RETURN_STATUS                Status;\r
\r
  Status = S3BootScriptSaveSmbusExecute (\r
             SmBusAddress,\r
             SmbusOperation,\r
            &Length,\r
             Buffer\r
             );\r
  ASSERT (Status == RETURN_SUCCESS);\r
}\r
\r
/**\r
  Executes an SMBUS quick read command and saves the value in the S3 script to be replayed\r
  on S3 resume.\r
\r
  Executes an SMBUS quick read command on the SMBUS device specified by SmBusAddress.\r
  Only the SMBUS slave address field of SmBusAddress is required.\r
  If Status is not NULL, then the status of the executed command is returned in Status.\r
  If PEC is set in SmBusAddress, then ASSERT().\r
  If Command in SmBusAddress is not zero, then ASSERT().\r
  If Length in SmBusAddress is not zero, then ASSERT().\r
  If any reserved bits of SmBusAddress are set, then ASSERT().\r
\r
  @param  SmBusAddress    Address that encodes the SMBUS Slave Address,\r
                          SMBUS Command, SMBUS Data Length, and PEC.\r
  @param  Status          Return status for the executed command.\r
                          This is an optional parameter and may be NULL.\r
\r
**/\r
VOID\r
EFIAPI\r
S3SmBusQuickRead (\r
  IN  UINTN                     SmBusAddress,\r
  OUT RETURN_STATUS             *Status       OPTIONAL\r
  )\r
{\r
  SmBusQuickRead (SmBusAddress, Status);\r
\r
  InternalSaveSmBusExecToBootScript (EfiSmbusQuickRead, SmBusAddress, 0, NULL);\r
}\r
\r
/**\r
  Executes an SMBUS quick write command and saves the value in the S3 script to be replayed\r
  on S3 resume.\r
\r
  Executes an SMBUS quick write command on the SMBUS device specified by SmBusAddress.\r
  Only the SMBUS slave address field of SmBusAddress is required.\r
  If Status is not NULL, then the status of the executed command is returned in Status.\r
  If PEC is set in SmBusAddress, then ASSERT().\r
  If Command in SmBusAddress is not zero, then ASSERT().\r
  If Length in SmBusAddress is not zero, then ASSERT().\r
  If any reserved bits of SmBusAddress are set, then ASSERT().\r
\r
  @param  SmBusAddress    Address that encodes the SMBUS Slave Address,\r
                          SMBUS Command, SMBUS Data Length, and PEC.\r
  @param  Status          Return status for the executed command.\r
                          This is an optional parameter and may be NULL.\r
\r
**/\r
VOID\r
EFIAPI\r
S3SmBusQuickWrite (\r
  IN  UINTN                     SmBusAddress,\r
  OUT RETURN_STATUS             *Status       OPTIONAL\r
  )\r
{\r
  SmBusQuickWrite (SmBusAddress, Status);\r
\r
  InternalSaveSmBusExecToBootScript (EfiSmbusQuickWrite, SmBusAddress, 0, NULL);\r
}\r
\r
/**\r
  Executes an SMBUS receive byte command and saves the value in the S3 script to be replayed\r
  on S3 resume.\r
\r
  Executes an SMBUS receive byte command on the SMBUS device specified by SmBusAddress.\r
  Only the SMBUS slave address field of SmBusAddress is required.\r
  The byte received from the SMBUS is returned.\r
  If Status is not NULL, then the status of the executed command is returned in Status.\r
  If Command in SmBusAddress is not zero, then ASSERT().\r
  If Length in SmBusAddress is not zero, then ASSERT().\r
  If any reserved bits of SmBusAddress are set, then ASSERT().\r
\r
  @param  SmBusAddress    Address that encodes the SMBUS Slave Address,\r
                          SMBUS Command, SMBUS Data Length, and PEC.\r
  @param  Status          Return status for the executed command.\r
                          This is an optional parameter and may be NULL.\r
\r
  @return The byte received from the SMBUS.\r
\r
**/\r
UINT8\r
EFIAPI\r
S3SmBusReceiveByte (\r
  IN  UINTN          SmBusAddress,\r
  OUT RETURN_STATUS  *Status        OPTIONAL\r
  )\r
{\r
  UINT8   Byte;\r
\r
  Byte = SmBusReceiveByte (SmBusAddress, Status);\r
\r
  InternalSaveSmBusExecToBootScript (EfiSmbusReceiveByte, SmBusAddress, 1, &Byte);\r
\r
  return Byte;\r
}\r
\r
/**\r
  Executes an SMBUS send byte command and saves the value in the S3 script to be replayed\r
  on S3 resume.\r
\r
  Executes an SMBUS send byte command on the SMBUS device specified by SmBusAddress.\r
  The byte specified by Value is sent.\r
  Only the SMBUS slave address field of SmBusAddress is required.  Value is returned.\r
  If Status is not NULL, then the status of the executed command is returned in Status.\r
  If Command in SmBusAddress is not zero, then ASSERT().\r
  If Length in SmBusAddress is not zero, then ASSERT().\r
  If any reserved bits of SmBusAddress are set, then ASSERT().\r
\r
  @param  SmBusAddress    Address that encodes the SMBUS Slave Address,\r
                          SMBUS Command, SMBUS Data Length, and PEC.\r
  @param  Value           The 8-bit value to send.\r
  @param  Status          Return status for the executed command.\r
                          This is an optional parameter and may be NULL.\r
\r
  @return The parameter of Value.\r
\r
**/\r
UINT8\r
EFIAPI\r
S3SmBusSendByte (\r
  IN  UINTN          SmBusAddress,\r
  IN  UINT8          Value,\r
  OUT RETURN_STATUS  *Status        OPTIONAL\r
  )\r
{\r
  UINT8   Byte;\r
\r
  Byte = SmBusSendByte (SmBusAddress, Value, Status);\r
\r
  InternalSaveSmBusExecToBootScript (EfiSmbusSendByte, SmBusAddress, 1, &Byte);\r
\r
  return Byte;\r
}\r
\r
/**\r
  Executes an SMBUS read data byte command and saves the value in the S3 script to be replayed\r
  on S3 resume.\r
\r
  Executes an SMBUS read data byte command on the SMBUS device specified by SmBusAddress.\r
  Only the SMBUS slave address and SMBUS command fields of SmBusAddress are required.\r
  The 8-bit value read from the SMBUS is returned.\r
  If Status is not NULL, then the status of the executed command is returned in Status.\r
  If Length in SmBusAddress is not zero, then ASSERT().\r
  If any reserved bits of SmBusAddress are set, then ASSERT().\r
\r
  @param  SmBusAddress    Address that encodes the SMBUS Slave Address,\r
                          SMBUS Command, SMBUS Data Length, and PEC.\r
  @param  Status          Return status for the executed command.\r
                          This is an optional parameter and may be NULL.\r
\r
  @return The byte read from the SMBUS.\r
\r
**/\r
UINT8\r
EFIAPI\r
S3SmBusReadDataByte (\r
  IN  UINTN          SmBusAddress,\r
  OUT RETURN_STATUS  *Status        OPTIONAL\r
  )\r
{\r
  UINT8   Byte;\r
\r
  Byte = SmBusReadDataByte (SmBusAddress, Status);\r
\r
  InternalSaveSmBusExecToBootScript (EfiSmbusReadByte, SmBusAddress, 1, &Byte);\r
\r
  return Byte;\r
}\r
\r
/**\r
  Executes an SMBUS write data byte command and saves the value in the S3 script to be replayed\r
  on S3 resume.\r
\r
  Executes an SMBUS write data byte command on the SMBUS device specified by SmBusAddress.\r
  The 8-bit value specified by Value is written.\r
  Only the SMBUS slave address and SMBUS command fields of SmBusAddress are required.\r
  Value is returned.\r
  If Status is not NULL, then the status of the executed command is returned in Status.\r
  If Length in SmBusAddress is not zero, then ASSERT().\r
  If any reserved bits of SmBusAddress are set, then ASSERT().\r
\r
  @param  SmBusAddress    Address that encodes the SMBUS Slave Address,\r
                          SMBUS Command, SMBUS Data Length, and PEC.\r
  @param  Value           The 8-bit value to write.\r
  @param  Status          Return status for the executed command.\r
                          This is an optional parameter and may be NULL.\r
\r
  @return The parameter of Value.\r
\r
**/\r
UINT8\r
EFIAPI\r
S3SmBusWriteDataByte (\r
  IN  UINTN          SmBusAddress,\r
  IN  UINT8          Value,\r
  OUT RETURN_STATUS  *Status        OPTIONAL\r
  )\r
{\r
  UINT8   Byte;\r
\r
  Byte = SmBusWriteDataByte (SmBusAddress, Value, Status);\r
\r
  InternalSaveSmBusExecToBootScript (EfiSmbusWriteByte, SmBusAddress, 1, &Byte);\r
\r
  return Byte;\r
}\r
\r
/**\r
  Executes an SMBUS read data word command and saves the value in the S3 script to be replayed\r
  on S3 resume.\r
\r
  Executes an SMBUS read data word command on the SMBUS device specified by SmBusAddress.\r
  Only the SMBUS slave address and SMBUS command fields of SmBusAddress are required.\r
  The 16-bit value read from the SMBUS is returned.\r
  If Status is not NULL, then the status of the executed command is returned in Status.\r
  If Length in SmBusAddress is not zero, then ASSERT().\r
  If any reserved bits of SmBusAddress are set, then ASSERT().\r
\r
  @param  SmBusAddress    Address that encodes the SMBUS Slave Address,\r
                          SMBUS Command, SMBUS Data Length, and PEC.\r
  @param  Status          Return status for the executed command.\r
                          This is an optional parameter and may be NULL.\r
\r
  @return The byte read from the SMBUS.\r
\r
**/\r
UINT16\r
EFIAPI\r
S3SmBusReadDataWord (\r
  IN  UINTN          SmBusAddress,\r
  OUT RETURN_STATUS  *Status        OPTIONAL\r
  )\r
{\r
  UINT16  Word;\r
\r
  Word = SmBusReadDataWord (SmBusAddress, Status);\r
\r
  InternalSaveSmBusExecToBootScript (EfiSmbusReadWord, SmBusAddress, 2, &Word);\r
\r
  return Word;\r
}\r
\r
/**\r
  Executes an SMBUS write data word command and saves the value in the S3 script to be replayed\r
  on S3 resume.\r
\r
  Executes an SMBUS write data word command on the SMBUS device specified by SmBusAddress.\r
  The 16-bit value specified by Value is written.\r
  Only the SMBUS slave address and SMBUS command fields of SmBusAddress are required.\r
  Value is returned.\r
  If Status is not NULL, then the status of the executed command is returned in Status.\r
  If Length in SmBusAddress is not zero, then ASSERT().\r
  If any reserved bits of SmBusAddress are set, then ASSERT().\r
\r
  @param  SmBusAddress    Address that encodes the SMBUS Slave Address,\r
                          SMBUS Command, SMBUS Data Length, and PEC.\r
  @param  Value           The 16-bit value to write.\r
  @param  Status          Return status for the executed command.\r
                          This is an optional parameter and may be NULL.\r
\r
  @return The parameter of Value.\r
\r
**/\r
UINT16\r
EFIAPI\r
S3SmBusWriteDataWord (\r
  IN  UINTN          SmBusAddress,\r
  IN  UINT16         Value,\r
  OUT RETURN_STATUS  *Status        OPTIONAL\r
  )\r
{\r
  UINT16  Word;\r
\r
  Word = SmBusWriteDataWord (SmBusAddress, Value, Status);\r
\r
  InternalSaveSmBusExecToBootScript (EfiSmbusWriteWord, SmBusAddress, 2, &Word);\r
\r
  return Word;\r
}\r
\r
/**\r
  Executes an SMBUS process call command and saves the value in the S3 script to be replayed\r
  on S3 resume.\r
\r
  Executes an SMBUS process call command on the SMBUS device specified by SmBusAddress.\r
  The 16-bit value specified by Value is written.\r
  Only the SMBUS slave address and SMBUS command fields of SmBusAddress are required.\r
  The 16-bit value returned by the process call command is returned.\r
  If Status is not NULL, then the status of the executed command is returned in Status.\r
  If Length in SmBusAddress is not zero, then ASSERT().\r
  If any reserved bits of SmBusAddress are set, then ASSERT().\r
\r
  @param  SmBusAddress    Address that encodes the SMBUS Slave Address,\r
                          SMBUS Command, SMBUS Data Length, and PEC.\r
  @param  Value           The 16-bit value to write.\r
  @param  Status          Return status for the executed command.\r
                          This is an optional parameter and may be NULL.\r
\r
  @return The 16-bit value returned by the process call command.\r
\r
**/\r
UINT16\r
EFIAPI\r
S3SmBusProcessCall (\r
  IN  UINTN          SmBusAddress,\r
  IN  UINT16         Value,\r
  OUT RETURN_STATUS  *Status        OPTIONAL\r
  )\r
{\r
  UINT16  Word;\r
\r
  Word = SmBusProcessCall (SmBusAddress, Value, Status);\r
\r
  InternalSaveSmBusExecToBootScript (EfiSmbusProcessCall, SmBusAddress, 2, &Value);\r
\r
  return Word;\r
}\r
\r
/**\r
  Executes an SMBUS read block command and saves the value in the S3 script to be replayed\r
  on S3 resume.\r
\r
  Executes an SMBUS read block command on the SMBUS device specified by SmBusAddress.\r
  Only the SMBUS slave address and SMBUS command fields of SmBusAddress are required.\r
  Bytes are read from the SMBUS and stored in Buffer.\r
  The number of bytes read is returned, and will never return a value larger than 32-bytes.\r
  If Status is not NULL, then the status of the executed command is returned in Status.\r
  It is the caller's responsibility to make sure Buffer is large enough for the total number of bytes read.\r
  SMBUS supports a maximum transfer size of 32 bytes, so Buffer does not need to be any larger than 32 bytes.\r
  If Length in SmBusAddress is not zero, then ASSERT().\r
  If Buffer is NULL, then ASSERT().\r
  If any reserved bits of SmBusAddress are set, then ASSERT().\r
\r
  @param  SmBusAddress    Address that encodes the SMBUS Slave Address,\r
                          SMBUS Command, SMBUS Data Length, and PEC.\r
  @param  Buffer          Pointer to the buffer to store the bytes read from the SMBUS.\r
  @param  Status          Return status for the executed command.\r
                          This is an optional parameter and may be NULL.\r
\r
  @return The number of bytes read.\r
\r
**/\r
UINTN\r
EFIAPI\r
S3SmBusReadBlock (\r
  IN  UINTN          SmBusAddress,\r
  OUT VOID           *Buffer,\r
  OUT RETURN_STATUS  *Status        OPTIONAL\r
  )\r
{\r
  UINTN   Length;\r
\r
  Length = SmBusReadBlock (SmBusAddress, Buffer, Status);\r
\r
  InternalSaveSmBusExecToBootScript (EfiSmbusReadBlock, SmBusAddress, Length, Buffer);\r
\r
  return Length;\r
}\r
\r
/**\r
  Executes an SMBUS write block command and saves the value in the S3 script to be replayed\r
  on S3 resume.\r
\r
  Executes an SMBUS write block command on the SMBUS device specified by SmBusAddress.\r
  The SMBUS slave address, SMBUS command, and SMBUS length fields of SmBusAddress are required.\r
  Bytes are written to the SMBUS from Buffer.\r
  The number of bytes written is returned, and will never return a value larger than 32-bytes.\r
  If Status is not NULL, then the status of the executed command is returned in Status.\r
  If Length in SmBusAddress is zero or greater than 32, then ASSERT().\r
  If Buffer is NULL, then ASSERT().\r
  If any reserved bits of SmBusAddress are set, then ASSERT().\r
\r
  @param  SmBusAddress    Address that encodes the SMBUS Slave Address,\r
                          SMBUS Command, SMBUS Data Length, and PEC.\r
  @param  Buffer          Pointer to the buffer to store the bytes read from the SMBUS.\r
  @param  Status          Return status for the executed command.\r
                          This is an optional parameter and may be NULL.\r
\r
  @return The number of bytes written.\r
\r
**/\r
UINTN\r
EFIAPI\r
S3SmBusWriteBlock (\r
  IN  UINTN          SmBusAddress,\r
  OUT VOID           *Buffer,\r
  OUT RETURN_STATUS  *Status        OPTIONAL\r
  )\r
{\r
  UINTN  Length;\r
\r
  Length = SmBusWriteBlock (SmBusAddress, Buffer, Status);\r
\r
  InternalSaveSmBusExecToBootScript (EfiSmbusWriteBlock, SmBusAddress, SMBUS_LIB_LENGTH (SmBusAddress), Buffer);\r
\r
  return Length;\r
}\r
\r
/**\r
  Executes an SMBUS block process call command and saves the value in the S3 script to be replayed\r
  on S3 resume.\r
\r
  Executes an SMBUS block process call command on the SMBUS device specified by SmBusAddress.\r
  The SMBUS slave address, SMBUS command, and SMBUS length fields of SmBusAddress are required.\r
  Bytes are written to the SMBUS from WriteBuffer.  Bytes are then read from the SMBUS into ReadBuffer.\r
  If Status is not NULL, then the status of the executed command is returned in Status.\r
  It is the caller's responsibility to make sure ReadBuffer is large enough for the total number of bytes read.\r
  SMBUS supports a maximum transfer size of 32 bytes, so Buffer does not need to be any larger than 32 bytes.\r
  If Length in SmBusAddress is zero or greater than 32, then ASSERT().\r
  If WriteBuffer is NULL, then ASSERT().\r
  If ReadBuffer is NULL, then ASSERT().\r
  If any reserved bits of SmBusAddress are set, then ASSERT().\r
\r
  @param  SmBusAddress    Address that encodes the SMBUS Slave Address,\r
                          SMBUS Command, SMBUS Data Length, and PEC.\r
  @param  WriteBuffer     Pointer to the buffer of bytes to write to the SMBUS.\r
  @param  ReadBuffer      Pointer to the buffer of bytes to read from the SMBUS.\r
  @param  Status          Return status for the executed command.\r
                          This is an optional parameter and may be NULL.\r
\r
  @return The number of bytes written.\r
\r
**/\r
UINTN\r
EFIAPI\r
S3SmBusBlockProcessCall (\r
  IN  UINTN          SmBusAddress,\r
  IN  VOID           *WriteBuffer,\r
  OUT VOID           *ReadBuffer,\r
  OUT RETURN_STATUS  *Status        OPTIONAL\r
  )\r
{\r
  UINTN   Length;\r
\r
  Length = SmBusBlockProcessCall (SmBusAddress, WriteBuffer, ReadBuffer, Status);\r
\r
  InternalSaveSmBusExecToBootScript (EfiSmbusBWBRProcessCall, SmBusAddress, SMBUS_LIB_LENGTH (SmBusAddress), ReadBuffer);\r
\r
  return Length;\r
}\r