EDK2 doxygen online documents - Firmware Encoding Index 1
EDK2 doxygen online documents - Firmware Encoding Index
Functions

EdkCompatibilityPkg/Foundation/Library/EdkIIGlueLib/Library/DxeSmbusLib/SmbusLib.c File Reference

#include "DxeSmbusLibInternal.h"

Go to the source code of this file.

Functions

VOID EFIAPI SmBusQuickRead (IN UINTN SmBusAddress, OUT RETURN_STATUS *Status OPTIONAL)
VOID EFIAPI SmBusQuickWrite (IN UINTN SmBusAddress, OUT RETURN_STATUS *Status OPTIONAL)
UINT8 EFIAPI SmBusReceiveByte (IN UINTN SmBusAddress, OUT RETURN_STATUS *Status OPTIONAL)
UINT8 EFIAPI SmBusSendByte (IN UINTN SmBusAddress, IN UINT8 Value, OUT RETURN_STATUS *Status OPTIONAL)
UINT8 EFIAPI SmBusReadDataByte (IN UINTN SmBusAddress, OUT RETURN_STATUS *Status OPTIONAL)
UINT8 EFIAPI SmBusWriteDataByte (IN UINTN SmBusAddress, IN UINT8 Value, OUT RETURN_STATUS *Status OPTIONAL)
UINT16 EFIAPI SmBusReadDataWord (IN UINTN SmBusAddress, OUT RETURN_STATUS *Status OPTIONAL)
UINT16 EFIAPI SmBusWriteDataWord (IN UINTN SmBusAddress, IN UINT16 Value, OUT RETURN_STATUS *Status OPTIONAL)
UINT16 EFIAPI SmBusProcessCall (IN UINTN SmBusAddress, IN UINT16 Value, OUT RETURN_STATUS *Status OPTIONAL)
UINTN EFIAPI SmBusReadBlock (IN UINTN SmBusAddress, OUT VOID *Buffer, OUT RETURN_STATUS *Status OPTIONAL)
UINTN EFIAPI SmBusWriteBlock (IN UINTN SmBusAddress, OUT VOID *Buffer, OUT RETURN_STATUS *Status OPTIONAL)
UINTN EFIAPI SmBusBlockProcessCall (IN UINTN SmBusAddress, IN VOID *WriteBuffer, OUT VOID *ReadBuffer, OUT RETURN_STATUS *Status OPTIONAL)

Function Documentation

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

Executes an SMBUS block process call command.

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:
SmBusAddressAddress that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC.
WriteBufferPointer to the buffer of bytes to write to the SMBUS.
ReadBufferPointer to the buffer of bytes to read from the SMBUS.
StatusReturn status for the executed command. This is an optional parameter and may be NULL.
Returns:
The number of bytes written.

Definition at line 454 of file SmbusLib.c.

UINT16 EFIAPI SmBusProcessCall ( IN UINTN  SmBusAddress,
IN UINT16  Value,
OUT RETURN_STATUS *Status  OPTIONAL 
)

Executes an SMBUS process call command.

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:
SmBusAddressAddress that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC.
ValueThe 16-bit value to write.
StatusReturn 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.

Definition at line 336 of file SmbusLib.c.

VOID EFIAPI SmBusQuickRead ( IN UINTN  SmBusAddress,
OUT RETURN_STATUS *Status  OPTIONAL 
)

Executes an SMBUS quick read command.

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:
SmBusAddressAddress that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC.
StatusReturn status for the executed command. This is an optional parameter and may be NULL.

Definition at line 44 of file SmbusLib.c.

VOID EFIAPI SmBusQuickWrite ( IN UINTN  SmBusAddress,
OUT RETURN_STATUS *Status  OPTIONAL 
)

Executes an SMBUS quick write command.

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:
SmBusAddressAddress that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC.
StatusReturn status for the executed command. This is an optional parameter and may be NULL.

Definition at line 76 of file SmbusLib.c.

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

Executes an SMBUS read block command.

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:
SmBusAddressAddress that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC.
BufferPointer to the buffer to store the bytes read from the SMBUS.
StatusReturn status for the executed command. This is an optional parameter and may be NULL.
Returns:
The number of bytes read.

Definition at line 375 of file SmbusLib.c.

UINT8 EFIAPI SmBusReadDataByte ( IN UINTN  SmBusAddress,
OUT RETURN_STATUS *Status  OPTIONAL 
)

Executes an SMBUS read data byte command.

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:
SmBusAddressAddress that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC.
StatusReturn status for the executed command. This is an optional parameter and may be NULL.
Returns:
The byte read from the SMBUS.

Definition at line 186 of file SmbusLib.c.

UINT16 EFIAPI SmBusReadDataWord ( IN UINTN  SmBusAddress,
OUT RETURN_STATUS *Status  OPTIONAL 
)

Executes an SMBUS read data word command.

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:
SmBusAddressAddress that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC.
StatusReturn status for the executed command. This is an optional parameter and may be NULL.
Returns:
The byte read from the SMBUS.

Definition at line 260 of file SmbusLib.c.

UINT8 EFIAPI SmBusReceiveByte ( IN UINTN  SmBusAddress,
OUT RETURN_STATUS *Status  OPTIONAL 
)

Executes an SMBUS receive byte command.

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:
SmBusAddressAddress that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC.
StatusReturn status for the executed command. This is an optional parameter and may be NULL.
Returns:
The byte received from the SMBUS.

Definition at line 110 of file SmbusLib.c.

UINT8 EFIAPI SmBusSendByte ( IN UINTN  SmBusAddress,
IN UINT8  Value,
OUT RETURN_STATUS *Status  OPTIONAL 
)

Executes an SMBUS send byte command.

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:
SmBusAddressAddress that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC.
ValueThe 8-bit value to send.
StatusReturn status for the executed command. This is an optional parameter and may be NULL.
Returns:
The parameter of Value.

Definition at line 148 of file SmbusLib.c.

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

Executes an SMBUS write block command.

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:
SmBusAddressAddress that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC.
BufferPointer to the buffer to store the bytes read from the SMBUS.
StatusReturn status for the executed command. This is an optional parameter and may be NULL.
Returns:
The number of bytes written.

Definition at line 411 of file SmbusLib.c.

UINT8 EFIAPI SmBusWriteDataByte ( IN UINTN  SmBusAddress,
IN UINT8  Value,
OUT RETURN_STATUS *Status  OPTIONAL 
)

Executes an SMBUS write data byte command.

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:
SmBusAddressAddress that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC.
ValueThe 8-bit value to write.
StatusReturn status for the executed command. This is an optional parameter and may be NULL.
Returns:
The parameter of Value.

Definition at line 223 of file SmbusLib.c.

UINT16 EFIAPI SmBusWriteDataWord ( IN UINTN  SmBusAddress,
IN UINT16  Value,
OUT RETURN_STATUS *Status  OPTIONAL 
)

Executes an SMBUS write data word command.

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:
SmBusAddressAddress that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC.
ValueThe 16-bit value to write.
StatusReturn status for the executed command. This is an optional parameter and may be NULL.
Returns:
The parameter of Value.

Definition at line 297 of file SmbusLib.c.

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Defines