MdePkg/Library/BaseS3SmbusLib/S3SmbusLib.c File Reference


Functions

VOID InternalSaveSmBusExecToBootScript (IN EFI_SMBUS_OPERATION SmbusOperation, IN UINTN SmBusAddress, IN UINTN Length, IN OUT VOID *Buffer)
VOID EFIAPI S3SmBusQuickRead (IN UINTN SmBusAddress, OUT RETURN_STATUS *Status)
VOID EFIAPI S3SmBusQuickWrite (IN UINTN SmBusAddress, OUT RETURN_STATUS *Status)
UINT8 EFIAPI S3SmBusReceiveByte (IN UINTN SmBusAddress, OUT RETURN_STATUS *Status)
UINT8 EFIAPI S3SmBusSendByte (IN UINTN SmBusAddress, IN UINT8 Value, OUT RETURN_STATUS *Status)
UINT8 EFIAPI S3SmBusReadDataByte (IN UINTN SmBusAddress, OUT RETURN_STATUS *Status)
UINT8 EFIAPI S3SmBusWriteDataByte (IN UINTN SmBusAddress, IN UINT8 Value, OUT RETURN_STATUS *Status)
UINT16 EFIAPI S3SmBusReadDataWord (IN UINTN SmBusAddress, OUT RETURN_STATUS *Status)
UINT16 EFIAPI S3SmBusWriteDataWord (IN UINTN SmBusAddress, IN UINT16 Value, OUT RETURN_STATUS *Status)
UINT16 EFIAPI S3SmBusProcessCall (IN UINTN SmBusAddress, IN UINT16 Value, OUT RETURN_STATUS *Status)
UINTN EFIAPI S3SmBusReadBlock (IN UINTN SmBusAddress, OUT VOID *Buffer, OUT RETURN_STATUS *Status)
UINTN EFIAPI S3SmBusWriteBlock (IN UINTN SmBusAddress, OUT VOID *Buffer, OUT RETURN_STATUS *Status)
UINTN EFIAPI S3SmBusBlockProcessCall (IN UINTN SmBusAddress, IN VOID *WriteBuffer, OUT VOID *ReadBuffer, OUT RETURN_STATUS *Status)

Detailed Description

Smbus Library Services that do SMBus transactions and also enable the operatation to be replayed during an S3 resume. This library class maps directly on top of the SmbusLib class.

Copyright (c) 2007, Intel Corporation. All rights reserved.

This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.


Function Documentation

VOID InternalSaveSmBusExecToBootScript ( IN EFI_SMBUS_OPERATION  SmbusOperation,
IN UINTN  SmBusAddress,
IN UINTN  Length,
IN OUT VOID *  Buffer 
)

Saves an SMBus operation to S3 script to be replayed on S3 resume.

This function provides a standard way to save SMBus operation to S3 boot Script. The data can either be of the Length byte, word, or a block of data. If it falis to save S3 boot script, then ASSERT ().

Parameters:
SmbusOperation Signifies which particular SMBus hardware protocol instance that it will use to execute the SMBus transactions.
SmBusAddress Address that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC.
Length Signifies the number of bytes that this operation will do. The maximum number of bytes can be revision specific and operation specific.
Buffer Contains the value of data to execute to the SMBus slave device. Not all operations require this argument. The length of this buffer is identified by Length.

References ASSERT, RETURN_SUCCESS, and S3BootScriptSaveSmbusExecute().

Referenced by S3SmBusBlockProcessCall(), S3SmBusProcessCall(), S3SmBusQuickRead(), S3SmBusQuickWrite(), S3SmBusReadBlock(), S3SmBusReadDataByte(), S3SmBusReadDataWord(), S3SmBusReceiveByte(), S3SmBusSendByte(), S3SmBusWriteBlock(), S3SmBusWriteDataByte(), and S3SmBusWriteDataWord().

UINTN EFIAPI S3SmBusBlockProcessCall ( IN UINTN  SmBusAddress,
IN VOID *  WriteBuffer,
OUT VOID *  ReadBuffer,
OUT RETURN_STATUS Status 
)

Executes an SMBUS block process call command and saves the value in the S3 script to be replayed on S3 resume.

Executes an SMBUS block process call command on the SMBUS device specified by SmBusAddress. The SMBUS slave address, SMBUS command, and SMBUS length fields of SmBusAddress are required. Bytes are written to the SMBUS from WriteBuffer. Bytes are then read from the SMBUS into ReadBuffer. If Status is not NULL, then the status of the executed command is returned in Status. It is the caller's responsibility to make sure ReadBuffer is large enough for the total number of bytes read. SMBUS supports a maximum transfer size of 32 bytes, so Buffer does not need to be any larger than 32 bytes. If Length in SmBusAddress is zero or greater than 32, then ASSERT(). If WriteBuffer is NULL, then ASSERT(). If ReadBuffer is NULL, then ASSERT(). If any reserved bits of SmBusAddress are set, then ASSERT().

Parameters:
SmBusAddress Address that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC.
WriteBuffer Pointer to the buffer of bytes to write to the SMBUS.
ReadBuffer Pointer to the buffer of bytes to read from the SMBUS.
Status Return status for the executed command. This is an optional parameter and may be NULL.
Returns:
The number of bytes written.

References EfiSmbusBWBRProcessCall, InternalSaveSmBusExecToBootScript(), SMBUS_LIB_LENGTH, and SmBusBlockProcessCall().

UINT16 EFIAPI S3SmBusProcessCall ( IN UINTN  SmBusAddress,
IN UINT16  Value,
OUT RETURN_STATUS Status 
)

Executes an SMBUS process call command and saves the value in the S3 script to be replayed on S3 resume.

Executes an SMBUS process call command on the SMBUS device specified by SmBusAddress. The 16-bit value specified by Value is written. Only the SMBUS slave address and SMBUS command fields of SmBusAddress are required. The 16-bit value returned by the process call command is returned. If Status is not NULL, then the status of the executed command is returned in Status. If Length in SmBusAddress is not zero, then ASSERT(). If any reserved bits of SmBusAddress are set, then ASSERT().

Parameters:
SmBusAddress Address that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC.
Value The 16-bit value to write.
Status Return status for the executed command. This is an optional parameter and may be NULL.
Returns:
The 16-bit value returned by the process call command.

References EfiSmbusProcessCall, InternalSaveSmBusExecToBootScript(), and SmBusProcessCall().

VOID EFIAPI S3SmBusQuickRead ( IN UINTN  SmBusAddress,
OUT RETURN_STATUS Status 
)

Executes an SMBUS quick read command and saves the value in the S3 script to be replayed on S3 resume.

Executes an SMBUS quick read command on the SMBUS device specified by SmBusAddress. Only the SMBUS slave address field of SmBusAddress is required. If Status is not NULL, then the status of the executed command is returned in Status. If PEC is set in SmBusAddress, then ASSERT(). If Command in SmBusAddress is not zero, then ASSERT(). If Length in SmBusAddress is not zero, then ASSERT(). If any reserved bits of SmBusAddress are set, then ASSERT().

Parameters:
SmBusAddress Address that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC.
Status Return status for the executed command. This is an optional parameter and may be NULL.

References EfiSmbusQuickRead, InternalSaveSmBusExecToBootScript(), NULL, and SmBusQuickRead().

VOID EFIAPI S3SmBusQuickWrite ( IN UINTN  SmBusAddress,
OUT RETURN_STATUS Status 
)

Executes an SMBUS quick write command and saves the value in the S3 script to be replayed on S3 resume.

Executes an SMBUS quick write command on the SMBUS device specified by SmBusAddress. Only the SMBUS slave address field of SmBusAddress is required. If Status is not NULL, then the status of the executed command is returned in Status. If PEC is set in SmBusAddress, then ASSERT(). If Command in SmBusAddress is not zero, then ASSERT(). If Length in SmBusAddress is not zero, then ASSERT(). If any reserved bits of SmBusAddress are set, then ASSERT().

Parameters:
SmBusAddress Address that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC.
Status Return status for the executed command. This is an optional parameter and may be NULL.

References EfiSmbusQuickWrite, InternalSaveSmBusExecToBootScript(), NULL, and SmBusQuickWrite().

UINTN EFIAPI S3SmBusReadBlock ( IN UINTN  SmBusAddress,
OUT VOID *  Buffer,
OUT RETURN_STATUS Status 
)

Executes an SMBUS read block command and saves the value in the S3 script to be replayed on S3 resume.

Executes an SMBUS read block command on the SMBUS device specified by SmBusAddress. Only the SMBUS slave address and SMBUS command fields of SmBusAddress are required. Bytes are read from the SMBUS and stored in Buffer. The number of bytes read is returned, and will never return a value larger than 32-bytes. If Status is not NULL, then the status of the executed command is returned in Status. It is the caller's responsibility to make sure Buffer is large enough for the total number of bytes read. SMBUS supports a maximum transfer size of 32 bytes, so Buffer does not need to be any larger than 32 bytes. If Length in SmBusAddress is not zero, then ASSERT(). If Buffer is NULL, then ASSERT(). If any reserved bits of SmBusAddress are set, then ASSERT().

Parameters:
SmBusAddress Address that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC.
Buffer Pointer to the buffer to store the bytes read from the SMBUS.
Status Return status for the executed command. This is an optional parameter and may be NULL.
Returns:
The number of bytes read.

References EfiSmbusReadBlock, InternalSaveSmBusExecToBootScript(), and SmBusReadBlock().

UINT8 EFIAPI S3SmBusReadDataByte ( IN UINTN  SmBusAddress,
OUT RETURN_STATUS Status 
)

Executes an SMBUS read data byte command and saves the value in the S3 script to be replayed on S3 resume.

Executes an SMBUS read data byte command on the SMBUS device specified by SmBusAddress. Only the SMBUS slave address and SMBUS command fields of SmBusAddress are required. The 8-bit value read from the SMBUS is returned. If Status is not NULL, then the status of the executed command is returned in Status. If Length in SmBusAddress is not zero, then ASSERT(). If any reserved bits of SmBusAddress are set, then ASSERT().

Parameters:
SmBusAddress Address that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC.
Status Return status for the executed command. This is an optional parameter and may be NULL.
Returns:
The byte read from the SMBUS.

References Byte, EfiSmbusReadByte, InternalSaveSmBusExecToBootScript(), and SmBusReadDataByte().

UINT16 EFIAPI S3SmBusReadDataWord ( IN UINTN  SmBusAddress,
OUT RETURN_STATUS Status 
)

Executes an SMBUS read data word command and saves the value in the S3 script to be replayed on S3 resume.

Executes an SMBUS read data word command on the SMBUS device specified by SmBusAddress. Only the SMBUS slave address and SMBUS command fields of SmBusAddress are required. The 16-bit value read from the SMBUS is returned. If Status is not NULL, then the status of the executed command is returned in Status. If Length in SmBusAddress is not zero, then ASSERT(). If any reserved bits of SmBusAddress are set, then ASSERT().

Parameters:
SmBusAddress Address that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC.
Status Return status for the executed command. This is an optional parameter and may be NULL.
Returns:
The byte read from the SMBUS.

References EfiSmbusReadWord, InternalSaveSmBusExecToBootScript(), and SmBusReadDataWord().

UINT8 EFIAPI S3SmBusReceiveByte ( IN UINTN  SmBusAddress,
OUT RETURN_STATUS Status 
)

Executes an SMBUS receive byte command and saves the value in the S3 script to be replayed on S3 resume.

Executes an SMBUS receive byte command on the SMBUS device specified by SmBusAddress. Only the SMBUS slave address field of SmBusAddress is required. The byte received from the SMBUS is returned. If Status is not NULL, then the status of the executed command is returned in Status. If Command in SmBusAddress is not zero, then ASSERT(). If Length in SmBusAddress is not zero, then ASSERT(). If any reserved bits of SmBusAddress are set, then ASSERT().

Parameters:
SmBusAddress Address that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC.
Status Return status for the executed command. This is an optional parameter and may be NULL.
Returns:
The byte received from the SMBUS.

References Byte, EfiSmbusReceiveByte, InternalSaveSmBusExecToBootScript(), and SmBusReceiveByte().

UINT8 EFIAPI S3SmBusSendByte ( IN UINTN  SmBusAddress,
IN UINT8  Value,
OUT RETURN_STATUS Status 
)

Executes an SMBUS send byte command and saves the value in the S3 script to be replayed on S3 resume.

Executes an SMBUS send byte command on the SMBUS device specified by SmBusAddress. The byte specified by Value is sent. Only the SMBUS slave address field of SmBusAddress is required. Value is returned. If Status is not NULL, then the status of the executed command is returned in Status. If Command in SmBusAddress is not zero, then ASSERT(). If Length in SmBusAddress is not zero, then ASSERT(). If any reserved bits of SmBusAddress are set, then ASSERT().

Parameters:
SmBusAddress Address that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC.
Value The 8-bit value to send.
Status Return status for the executed command. This is an optional parameter and may be NULL.
Returns:
The parameter of Value.

References Byte, EfiSmbusSendByte, InternalSaveSmBusExecToBootScript(), and SmBusSendByte().

UINTN EFIAPI S3SmBusWriteBlock ( IN UINTN  SmBusAddress,
OUT VOID *  Buffer,
OUT RETURN_STATUS Status 
)

Executes an SMBUS write block command and saves the value in the S3 script to be replayed on S3 resume.

Executes an SMBUS write block command on the SMBUS device specified by SmBusAddress. The SMBUS slave address, SMBUS command, and SMBUS length fields of SmBusAddress are required. Bytes are written to the SMBUS from Buffer. The number of bytes written is returned, and will never return a value larger than 32-bytes. If Status is not NULL, then the status of the executed command is returned in Status. If Length in SmBusAddress is zero or greater than 32, then ASSERT(). If Buffer is NULL, then ASSERT(). If any reserved bits of SmBusAddress are set, then ASSERT().

Parameters:
SmBusAddress Address that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC.
Buffer Pointer to the buffer to store the bytes read from the SMBUS.
Status Return status for the executed command. This is an optional parameter and may be NULL.
Returns:
The number of bytes written.

References EfiSmbusWriteBlock, InternalSaveSmBusExecToBootScript(), SMBUS_LIB_LENGTH, and SmBusWriteBlock().

UINT8 EFIAPI S3SmBusWriteDataByte ( IN UINTN  SmBusAddress,
IN UINT8  Value,
OUT RETURN_STATUS Status 
)

Executes an SMBUS write data byte command and saves the value in the S3 script to be replayed on S3 resume.

Executes an SMBUS write data byte command on the SMBUS device specified by SmBusAddress. The 8-bit value specified by Value is written. Only the SMBUS slave address and SMBUS command fields of SmBusAddress are required. Value is returned. If Status is not NULL, then the status of the executed command is returned in Status. If Length in SmBusAddress is not zero, then ASSERT(). If any reserved bits of SmBusAddress are set, then ASSERT().

Parameters:
SmBusAddress Address that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC.
Value The 8-bit value to write.
Status Return status for the executed command. This is an optional parameter and may be NULL.
Returns:
The parameter of Value.

References Byte, EfiSmbusWriteByte, InternalSaveSmBusExecToBootScript(), and SmBusWriteDataByte().

UINT16 EFIAPI S3SmBusWriteDataWord ( IN UINTN  SmBusAddress,
IN UINT16  Value,
OUT RETURN_STATUS Status 
)

Executes an SMBUS write data word command and saves the value in the S3 script to be replayed on S3 resume.

Executes an SMBUS write data word command on the SMBUS device specified by SmBusAddress. The 16-bit value specified by Value is written. Only the SMBUS slave address and SMBUS command fields of SmBusAddress are required. Value is returned. If Status is not NULL, then the status of the executed command is returned in Status. If Length in SmBusAddress is not zero, then ASSERT(). If any reserved bits of SmBusAddress are set, then ASSERT().

Parameters:
SmBusAddress Address that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC.
Value The 16-bit value to write.
Status Return status for the executed command. This is an optional parameter and may be NULL.
Returns:
The parameter of Value.

References EfiSmbusWriteWord, InternalSaveSmBusExecToBootScript(), and SmBusWriteDataWord().


Generated on Thu Sep 24 23:14:24 2015 for MdePkg[ALL] by  doxygen 1.5.7.1