/** @file\r
-Implementation of SmBusLib class library for PEI phase.\r
+Implementation of SmBusLib class library for DXE phase.\r
\r
-Copyright (c) 2006, Intel Corporation<BR>\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
+http://opensource.org/licenses/bsd-license.php.\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
\r
-Module Name: SmbusLib.c\r
-\r
**/\r
\r
#include "InternalSmbusLib.h"\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
+ @param SmBusAddress The 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
+ RETURN_SUCCESS: The SMBUS command was executed.\r
+ RETURN_TIMEOUT: A timeout occurred while executing the \r
+ SMBUS command. \r
+ RETURN_DEVICE_ERROR: The request was not \r
+ completed because a failure reflected in the Host Status \r
+ Register bit. Device errors are a result of a transaction \r
+ collision, illegal command field, unclaimed cycle (host \r
+ initiated), or bus errors (collisions). \r
+ RETURN_UNSUPPORTED: The SMBus operation is not supported.\r
\r
**/\r
VOID\r
ASSERT (!SMBUS_LIB_PEC (SmBusAddress));\r
ASSERT (SMBUS_LIB_COMMAND (SmBusAddress) == 0);\r
ASSERT (SMBUS_LIB_LENGTH (SmBusAddress) == 0);\r
- ASSERT (SMBUS_LIB_RESEARVED (SmBusAddress) == 0);\r
+ ASSERT (SMBUS_LIB_RESERVED (SmBusAddress) == 0);\r
\r
InternalSmBusExec (EfiSmbusQuickRead, SmBusAddress, 0, NULL, Status);\r
}\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
+ @param SmBusAddress The 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
+ RETURN_SUCCESS: The SMBUS command was executed.\r
+ RETURN_TIMEOUT: A timeout occurred while executing the \r
+ SMBUS command.\r
+ RETURN_DEVICE_ERROR: The request was not completed because \r
+ a failure reflected in the Host Status Register bit. \r
+ Device errors are a result of a transaction collision, \r
+ illegal command field, unclaimed cycle (host initiated), \r
+ or bus errors (collisions).\r
+ RETURN_UNSUPPORTED: The SMBus operation is not supported.\r
\r
**/\r
VOID\r
ASSERT (!SMBUS_LIB_PEC (SmBusAddress));\r
ASSERT (SMBUS_LIB_COMMAND (SmBusAddress) == 0);\r
ASSERT (SMBUS_LIB_LENGTH (SmBusAddress) == 0);\r
- ASSERT (SMBUS_LIB_RESEARVED (SmBusAddress) == 0);\r
+ ASSERT (SMBUS_LIB_RESERVED (SmBusAddress) == 0);\r
\r
InternalSmBusExec (EfiSmbusQuickWrite, SmBusAddress, 0, NULL, Status);\r
}\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
+ @param SmBusAddress The 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
+ RETURN_SUCCESS: The SMBUS command was executed.\r
+ RETURN_TIMEOUT: A timeout occurred while executing the \r
+ SMBUS command.\r
+ RETURN_DEVICE_ERROR: The request was not completed because \r
+ a failure reflected in the Host Status Register bit. Device\r
+ errors are a result of a transaction collision, illegal \r
+ command field, unclaimed cycle(host initiated), or bus \r
+ errors (collisions).\r
+ RETURN_CRC_ERROR: The checksum is not correct. (PEC is incorrect.)\r
+ RETURN_UNSUPPORTED: The SMBus operation is not supported.\r
\r
@return The byte received from the SMBUS.\r
\r
\r
ASSERT (SMBUS_LIB_COMMAND (SmBusAddress) == 0);\r
ASSERT (SMBUS_LIB_LENGTH (SmBusAddress) == 0);\r
- ASSERT (SMBUS_LIB_RESEARVED (SmBusAddress) == 0);\r
+ ASSERT (SMBUS_LIB_RESERVED (SmBusAddress) == 0);\r
\r
InternalSmBusExec (EfiSmbusReceiveByte, SmBusAddress, 1, &Byte, Status);\r
\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
+ @param SmBusAddress The 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
+ RETURN_SUCCESS: The SMBUS command was executed.\r
+ RETURN_TIMEOUT: A timeout occurred while executing the \r
+ SMBUS command.\r
+ RETURN_DEVICE_ERROR: The request was not completed because\r
+ a failure reflected in the Host Status Register bit. Device \r
+ errors are a result of a transaction collision, illegal \r
+ command field, unclaimed cycle(host initiated), or bus \r
+ errors (collisions).\r
+ RETURN_CRC_ERROR: The checksum is not correct (PEC is incorrect)\r
+ RETURN_UNSUPPORTED: The SMBus operation is not supported.\r
\r
@return The parameter of Value.\r
\r
\r
ASSERT (SMBUS_LIB_COMMAND (SmBusAddress) == 0);\r
ASSERT (SMBUS_LIB_LENGTH (SmBusAddress) == 0);\r
- ASSERT (SMBUS_LIB_RESEARVED (SmBusAddress) == 0);\r
+ ASSERT (SMBUS_LIB_RESERVED (SmBusAddress) == 0);\r
\r
Byte = Value;\r
InternalSmBusExec (EfiSmbusSendByte, SmBusAddress, 1, &Byte, 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
+ @param SmBusAddress The 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
+ RETURN_SUCCESS: The SMBUS command was executed.\r
+ RETURN_TIMEOUT: A timeout occurred while executing the \r
+ SMBUS command.\r
+ RETURN_DEVICE_ERROR: The request was not completed because \r
+ a failurereflected in the Host Status Register bit. Device \r
+ errors are a result of a transaction collision, illegal \r
+ command field, unclaimed cycle (host initiated), or bus \r
+ errors (collisions).\r
+ RETURN_CRC_ERROR: The checksum is not correct (PEC is incorrect)\r
+ RETURN_UNSUPPORTED: The SMBus operation is not supported.\r
\r
@return The byte read from the SMBUS.\r
\r
UINT8 Byte;\r
\r
ASSERT (SMBUS_LIB_LENGTH (SmBusAddress) == 0);\r
- ASSERT (SMBUS_LIB_RESEARVED (SmBusAddress) == 0);\r
+ ASSERT (SMBUS_LIB_RESERVED (SmBusAddress) == 0);\r
\r
InternalSmBusExec (EfiSmbusReadByte, SmBusAddress, 1, &Byte, Status);\r
\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
+ @param SmBusAddress The 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
+ RETURN_SUCCESS: The SMBUS command was executed.\r
+ RETURN_TIMEOUT: A timeout occurred while executing the \r
+ SMBUS command.\r
+ RETURN_DEVICE_ERROR: The request was not completed because \r
+ a failure reflected in the Host Status Register bit. Device \r
+ errors are a result of a transaction collision, illegal \r
+ command field, unclaimed cycle host initiated), or bus \r
+ errors (collisions).\r
+ RETURN_CRC_ERROR: The checksum is not correct. (PEC is incorrect.)\r
+ RETURN_UNSUPPORTED: The SMBus operation is not supported.\r
\r
@return The parameter of Value.\r
\r
UINT8 Byte;\r
\r
ASSERT (SMBUS_LIB_LENGTH (SmBusAddress) == 0);\r
- ASSERT (SMBUS_LIB_RESEARVED (SmBusAddress) == 0);\r
+ ASSERT (SMBUS_LIB_RESERVED (SmBusAddress) == 0);\r
\r
Byte = Value;\r
InternalSmBusExec (EfiSmbusWriteByte, SmBusAddress, 1, &Byte, Status);\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
+ @param SmBusAddress The 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
+ RETURN_SUCCESS: The SMBUS command was executed.\r
+ RETURN_TIMEOUT: A timeout occurred while executing the \r
+ SMBUS command.\r
+ RETURN_DEVICE_ERROR: The request was not completed because \r
+ a failure reflected in the Host Status Register bit. \r
+ Device errors are a result of a transaction collision, \r
+ illegal command field, unclaimed cycle (host initiated), \r
+ or bus errors (collisions).\r
+ RETURN_CRC_ERROR: The checksum is not correct. (PEC is \r
+ incorrect.)\r
+ RETURN_UNSUPPORTED: The SMBus operation is not supported.\r
\r
@return The byte read from the SMBUS.\r
\r
UINT16 Word;\r
\r
ASSERT (SMBUS_LIB_LENGTH (SmBusAddress) == 0);\r
- ASSERT (SMBUS_LIB_RESEARVED (SmBusAddress) == 0);\r
+ ASSERT (SMBUS_LIB_RESERVED (SmBusAddress) == 0);\r
\r
InternalSmBusExec (EfiSmbusReadWord, SmBusAddress, 2, &Word, Status);\r
\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
+ @param SmBusAddress The 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
+ RETURN_SUCCESS: The SMBUS command was executed.\r
+ RETURN_TIMEOUT: A timeout occurred while executing the SMBUS \r
+ command.\r
+ RETURN_DEVICE_ERROR: The request was not completed because \r
+ a failure reflected in the Host Status Register bit. \r
+ Device errors are a result of a transaction collision, \r
+ illegal command field, unclaimed cycle (host initiated), \r
+ or bus errors (collisions).\r
+ RETURN_CRC_ERROR: The checksum is not correct. \r
+ (PEC is incorrect.)\r
+ RETURN_UNSUPPORTED: The SMBus operation is not supported.\r
\r
@return The parameter of Value.\r
\r
UINT16 Word;\r
\r
ASSERT (SMBUS_LIB_LENGTH (SmBusAddress) == 0);\r
- ASSERT (SMBUS_LIB_RESEARVED (SmBusAddress) == 0);\r
+ ASSERT (SMBUS_LIB_RESERVED (SmBusAddress) == 0);\r
\r
Word = Value;\r
InternalSmBusExec (EfiSmbusWriteWord, SmBusAddress, 2, &Word, 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
+ @param SmBusAddress The 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
+ RETURN_SUCCESS: The SMBUS command was executed.\r
+ RETURN_TIMEOUT: A timeout occurred while executing the \r
+ SMBUS command.\r
+ RETURN_DEVICE_ERROR: The request was not completed because \r
+ a failure reflected in the Host Status Register bit. \r
+ Device errors are a result of a transaction collision, \r
+ illegal command field, unclaimed cycle (host initiated), \r
+ or bus errors (collisions).\r
+ RETURN_CRC_ERROR: The checksum is not correct. (PEC is \r
+ incorrect.)\r
+ RETURN_UNSUPPORTED: The SMBus operation is not supported.\r
\r
@return The 16-bit value returned by the process call command.\r
\r
)\r
{\r
ASSERT (SMBUS_LIB_LENGTH (SmBusAddress) == 0);\r
- ASSERT (SMBUS_LIB_RESEARVED (SmBusAddress) == 0);\r
+ ASSERT (SMBUS_LIB_RESERVED (SmBusAddress) == 0);\r
\r
InternalSmBusExec (EfiSmbusProcessCall, SmBusAddress, 2, &Value, Status);\r
\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
+ @param SmBusAddress The address that encodes the SMBUS Slave Address,\r
+ SMBUS Command, SMBUS Data Length, and PEC.\r
+ @param Buffer The pointer to the buffer to store the bytes read from \r
+ the SMBUS.\r
+ @param Status Return status for the executed command.\r
+ This is an optional parameter and may be NULL.\r
+ RETURN_SUCCESS: The SMBUS command was executed.\r
+ RETURN_TIMEOUT: A timeout occurred while executing the SMBUS \r
+ command.\r
+ RETURN_DEVICE_ERROR: The request was not completed because \r
+ a failure reflected in the Host Status Register bit. Device \r
+ errors are a result of a transaction collision, illegal \r
+ command field, unclaimed cycle (host initiated), or bus \r
+ errors (collisions).\r
+ RETURN_CRC_ERROR: The checksum is not correct. (PEC is \r
+ incorrect.)\r
+ RETURN_UNSUPPORTED: The SMBus operation is not supported.\r
\r
@return The number of bytes read.\r
\r
{\r
ASSERT (Buffer != NULL);\r
ASSERT (SMBUS_LIB_LENGTH (SmBusAddress) == 0);\r
- ASSERT (SMBUS_LIB_RESEARVED (SmBusAddress) == 0);\r
+ ASSERT (SMBUS_LIB_RESERVED (SmBusAddress) == 0);\r
\r
return InternalSmBusExec (EfiSmbusReadBlock, SmBusAddress, 0x20, Buffer, Status);\r
}\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 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
+ @param SmBusAddress The address that encodes the SMBUS Slave Address,\r
+ MBUS Command, SMBUS Data Length, and PEC.\r
+ @param Buffer The pointer to the buffer to store the bytes read from \r
+ the SMBUS.\r
+ @param Status Return status for the executed command.\r
+ This is an optional parameter and may be NULL.\r
+ RETURN_TIMEOUT: A timeout occurred while executing the \r
+ SMBUS command.\r
+ RETURN_DEVICE_ERROR: The request was not completed because \r
+ a failure reflected in the Host Status Register bit. Device \r
+ errors are a result of a transaction collision, illegal \r
+ command field, unclaimed cycle (host initiated), or bus \r
+ errors (collisions).\r
+ RETURN_CRC_ERROR: The checksum is not correct. (PEC is \r
+ incorrect.)\r
+ RETURN_UNSUPPORTED: The SMBus operation is not supported.\r
\r
@return The number of bytes written.\r
\r
ASSERT (Buffer != NULL);\r
ASSERT (SMBUS_LIB_LENGTH (SmBusAddress) >= 1);\r
ASSERT (SMBUS_LIB_LENGTH (SmBusAddress) <= 32);\r
- ASSERT (SMBUS_LIB_RESEARVED (SmBusAddress) == 0);\r
+ ASSERT (SMBUS_LIB_RESERVED (SmBusAddress) == 0);\r
\r
Length = SMBUS_LIB_LENGTH (SmBusAddress);\r
return InternalSmBusExec (EfiSmbusWriteBlock, SmBusAddress, Length, Buffer, Status);\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
+ @param SmBusAddress The address that encodes the SMBUS Slave Address,\r
+ SMBUS Command, SMBUS Data Length, and PEC.\r
+ @param WriteBuffer The pointer to the buffer of bytes to write to the SMBUS.\r
+ @param ReadBuffer The 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
+ RETURN_TIMEOUT: A timeout occurred while executing the \r
+ SMBUS command.\r
+ RETURN_DEVICE_ERROR: The request was not completed because \r
+ a failure reflected in the Host Status Register bit. Device \r
+ errors are a result of a transaction collision, illegal \r
+ command field, unclaimed cycle (host initiated), or bus \r
+ errors (collisions).\r
+ RETURN_CRC_ERROR: The checksum is not correct. (PEC is \r
+ incorrect.)\r
+ RETURN_UNSUPPORTED: The SMBus operation is not supported.\r
\r
@return The number of bytes written.\r
\r
ASSERT (ReadBuffer != NULL);\r
ASSERT (SMBUS_LIB_LENGTH (SmBusAddress) >= 1);\r
ASSERT (SMBUS_LIB_LENGTH (SmBusAddress) <= 32);\r
- ASSERT (SMBUS_LIB_RESEARVED (SmBusAddress) == 0);\r
+ ASSERT (SMBUS_LIB_RESERVED (SmBusAddress) == 0);\r
\r
Length = SMBUS_LIB_LENGTH (SmBusAddress);\r
//\r
projects / mirror_edk2.git / blobdiff