4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Provides library functions to access SMBUS devices. Libraries of this class
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync must be ported to a specific SMBUS controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncare licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncwhich accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Macro that converts SMBUS slave address, SMBUS command, SMBUS data length,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and PEC to a value that can be passed to the SMBUS Library functions.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Computes an address that is compatible with the SMBUS Library functions.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The unused upper bits of SlaveAddress, Command, and Length are stripped
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync prior to the generation of the address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SlaveAddress SMBUS Slave Address. Range 0..127.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Command SMBUS Command. Range 0..255.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Length SMBUS Data Length. Range 0..32.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Pec TRUE if Packet Error Checking is enabled. Otherwise FALSE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define SMBUS_LIB_ADDRESS(SlaveAddress,Command,Length,Pec) \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Macro that returns the SMBUS Slave Address value from an SmBusAddress Parameter value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SmBusAddress Address that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define SMBUS_LIB_SLAVE_ADDRESS(SmBusAddress) (((SmBusAddress) >> 1) & 0x7f)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Macro that returns the SMBUS Command value from an SmBusAddress Parameter value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SmBusAddress Address that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define SMBUS_LIB_COMMAND(SmBusAddress) (((SmBusAddress) >> 8) & 0xff)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Macro that returns the SMBUS Data Length value from an SmBusAddress Parameter value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SmBusAddress Address that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define SMBUS_LIB_LENGTH(SmBusAddress) (((SmBusAddress) >> 16) & 0x3f)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Macro that returns the SMBUS PEC value from an SmBusAddress Parameter value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SmBusAddress Address that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define SMBUS_LIB_PEC(SmBusAddress) ((BOOLEAN) (((SmBusAddress) & BIT22) != 0))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Macro that returns the set of reserved bits from an SmBusAddress Parameter value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SmBusAddress Address that encodes the SMBUS Slave Address, SMBUS Command, SMBUS Data Length, and PEC
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define SMBUS_LIB_RESERVED(SmBusAddress) ((SmBusAddress) & ~(BIT23 - 2))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Executes an SMBUS quick read command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Executes an SMBUS quick read command on the SMBUS device specified by SmBusAddress.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Only the SMBUS slave address field of SmBusAddress is required.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Status is not NULL, then the status of the executed command is returned in Status.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If PEC is set in SmBusAddress, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Command in SmBusAddress is not zero, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Length in SmBusAddress is not zero, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If any reserved bits of SmBusAddress are set, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SmBusAddress Address that encodes the SMBUS Slave Address,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SMBUS Command, SMBUS Data Length, and PEC.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Status Return status for the executed command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is an optional parameter and may be NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_SUCCESS The SMBUS command was executed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_DEVICE_ERROR The request was not completed because a failure
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync reflected in the Host Status Register bit. Device errors are a result
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of a transaction collision, illegal command field, unclaimed cycle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (host initiated), or bus errors (collisions).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_UNSUPPORTED The SMBus operation is not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Executes an SMBUS quick write command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Executes an SMBUS quick write command on the SMBUS device specified by SmBusAddress.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Only the SMBUS slave address field of SmBusAddress is required.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Status is not NULL, then the status of the executed command is returned in Status.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If PEC is set in SmBusAddress, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Command in SmBusAddress is not zero, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Length in SmBusAddress is not zero, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If any reserved bits of SmBusAddress are set, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SmBusAddress Address that encodes the SMBUS Slave Address,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SMBUS Command, SMBUS Data Length, and PEC.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Status Return status for the executed command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is an optional parameter and may be NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_SUCCESS The SMBUS command was executed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_DEVICE_ERROR The request was not completed because a failure
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync reflected in the Host Status Register bit. Device errors are a result
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of a transaction collision, illegal command field, unclaimed cycle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (host initiated), or bus errors (collisions).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_UNSUPPORTED The SMBus operation is not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Executes an SMBUS receive byte command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Executes an SMBUS receive byte command on the SMBUS device specified by SmBusAddress.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Only the SMBUS slave address field of SmBusAddress is required.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The byte received from the SMBUS is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Status is not NULL, then the status of the executed command is returned in Status.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Command in SmBusAddress is not zero, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Length in SmBusAddress is not zero, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If any reserved bits of SmBusAddress are set, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SmBusAddress Address that encodes the SMBUS Slave Address,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SMBUS Command, SMBUS Data Length, and PEC.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Status Return status for the executed command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is an optional parameter and may be NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_SUCCESS The SMBUS command was executed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_DEVICE_ERROR The request was not completed because a failure
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync reflected in the Host Status Register bit. Device errors are a result
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of a transaction collision, illegal command field, unclaimed cycle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (host initiated), or bus errors (collisions).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_CRC_ERROR The checksum is not correct (PEC is incorrect)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_UNSUPPORTED The SMBus operation is not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The byte received from the SMBUS.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Executes an SMBUS send byte command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Executes an SMBUS send byte command on the SMBUS device specified by SmBusAddress.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The byte specified by Value is sent.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Only the SMBUS slave address field of SmBusAddress is required. Value is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Status is not NULL, then the status of the executed command is returned in Status.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Command in SmBusAddress is not zero, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Length in SmBusAddress is not zero, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If any reserved bits of SmBusAddress are set, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SmBusAddress Address that encodes the SMBUS Slave Address,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SMBUS Command, SMBUS Data Length, and PEC.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Value The 8-bit value to send.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Status Return status for the executed command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is an optional parameter and may be NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_SUCCESS The SMBUS command was executed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_DEVICE_ERROR The request was not completed because a failure
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync reflected in the Host Status Register bit. Device errors are a result
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of a transaction collision, illegal command field, unclaimed cycle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (host initiated), or bus errors (collisions).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_CRC_ERROR The checksum is not correct (PEC is incorrect)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_UNSUPPORTED The SMBus operation is not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The parameter of Value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Executes an SMBUS read data byte command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Executes an SMBUS read data byte command on the SMBUS device specified by SmBusAddress.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Only the SMBUS slave address and SMBUS command fields of SmBusAddress are required.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The 8-bit value read from the SMBUS is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Status is not NULL, then the status of the executed command is returned in Status.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Length in SmBusAddress is not zero, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If any reserved bits of SmBusAddress are set, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SmBusAddress Address that encodes the SMBUS Slave Address,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SMBUS Command, SMBUS Data Length, and PEC.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Status Return status for the executed command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is an optional parameter and may be NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_SUCCESS The SMBUS command was executed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_DEVICE_ERROR The request was not completed because a failure
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync reflected in the Host Status Register bit. Device errors are a result
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of a transaction collision, illegal command field, unclaimed cycle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (host initiated), or bus errors (collisions).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_CRC_ERROR The checksum is not correct (PEC is incorrect)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_UNSUPPORTED The SMBus operation is not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The byte read from the SMBUS.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Executes an SMBUS write data byte command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Executes an SMBUS write data byte command on the SMBUS device specified by SmBusAddress.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The 8-bit value specified by Value is written.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Only the SMBUS slave address and SMBUS command fields of SmBusAddress are required.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Value is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Status is not NULL, then the status of the executed command is returned in Status.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Length in SmBusAddress is not zero, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If any reserved bits of SmBusAddress are set, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SmBusAddress Address that encodes the SMBUS Slave Address,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SMBUS Command, SMBUS Data Length, and PEC.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Value The 8-bit value to write.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Status Return status for the executed command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is an optional parameter and may be NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_SUCCESS The SMBUS command was executed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_DEVICE_ERROR The request was not completed because a failure
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync reflected in the Host Status Register bit. Device errors are a result
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of a transaction collision, illegal command field, unclaimed cycle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (host initiated), or bus errors (collisions).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_CRC_ERROR The checksum is not correct (PEC is incorrect)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_UNSUPPORTED The SMBus operation is not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The parameter of Value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Executes an SMBUS read data word command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Executes an SMBUS read data word command on the SMBUS device specified by SmBusAddress.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Only the SMBUS slave address and SMBUS command fields of SmBusAddress are required.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The 16-bit value read from the SMBUS is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Status is not NULL, then the status of the executed command is returned in Status.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Length in SmBusAddress is not zero, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If any reserved bits of SmBusAddress are set, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SmBusAddress Address that encodes the SMBUS Slave Address,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SMBUS Command, SMBUS Data Length, and PEC.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Status Return status for the executed command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is an optional parameter and may be NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_SUCCESS The SMBUS command was executed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_DEVICE_ERROR The request was not completed because a failure
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync reflected in the Host Status Register bit. Device errors are a result
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of a transaction collision, illegal command field, unclaimed cycle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (host initiated), or bus errors (collisions).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_CRC_ERROR The checksum is not correct (PEC is incorrect)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_UNSUPPORTED The SMBus operation is not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The byte read from the SMBUS.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Executes an SMBUS write data word command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Executes an SMBUS write data word command on the SMBUS device specified by SmBusAddress.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The 16-bit value specified by Value is written.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Only the SMBUS slave address and SMBUS command fields of SmBusAddress are required.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Value is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Status is not NULL, then the status of the executed command is returned in Status.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Length in SmBusAddress is not zero, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If any reserved bits of SmBusAddress are set, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SmBusAddress Address that encodes the SMBUS Slave Address,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SMBUS Command, SMBUS Data Length, and PEC.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Value The 16-bit value to write.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Status Return status for the executed command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is an optional parameter and may be NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_SUCCESS The SMBUS command was executed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_DEVICE_ERROR The request was not completed because a failure
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync reflected in the Host Status Register bit. Device errors are a result
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of a transaction collision, illegal command field, unclaimed cycle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (host initiated), or bus errors (collisions).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_CRC_ERROR The checksum is not correct (PEC is incorrect)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_UNSUPPORTED The SMBus operation is not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The parameter of Value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Executes an SMBUS process call command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Executes an SMBUS process call command on the SMBUS device specified by SmBusAddress.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The 16-bit value specified by Value is written.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Only the SMBUS slave address and SMBUS command fields of SmBusAddress are required.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The 16-bit value returned by the process call command is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Status is not NULL, then the status of the executed command is returned in Status.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Length in SmBusAddress is not zero, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If any reserved bits of SmBusAddress are set, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SmBusAddress Address that encodes the SMBUS Slave Address,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SMBUS Command, SMBUS Data Length, and PEC.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Value The 16-bit value to write.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Status Return status for the executed command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is an optional parameter and may be NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_SUCCESS The SMBUS command was executed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_DEVICE_ERROR The request was not completed because a failure
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync reflected in the Host Status Register bit. Device errors are a result
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of a transaction collision, illegal command field, unclaimed cycle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (host initiated), or bus errors (collisions).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_CRC_ERROR The checksum is not correct (PEC is incorrect)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_UNSUPPORTED The SMBus operation is not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The 16-bit value returned by the process call command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Executes an SMBUS read block command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Executes an SMBUS read block command on the SMBUS device specified by SmBusAddress.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Only the SMBUS slave address and SMBUS command fields of SmBusAddress are required.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Bytes are read from the SMBUS and stored in Buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The number of bytes read is returned, and will never return a value larger than 32-bytes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Status is not NULL, then the status of the executed command is returned in Status.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync It is the caller's responsibility to make sure Buffer is large enough for the total number of bytes read.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SMBUS supports a maximum transfer size of 32 bytes, so Buffer does not need to be any larger than 32 bytes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Length in SmBusAddress is not zero, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Buffer is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If any reserved bits of SmBusAddress are set, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SmBusAddress Address that encodes the SMBUS Slave Address,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SMBUS Command, SMBUS Data Length, and PEC.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer Pointer to the buffer to store the bytes read from the SMBUS.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Status Return status for the executed command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is an optional parameter and may be NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_SUCCESS The SMBUS command was executed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_DEVICE_ERROR The request was not completed because a failure
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync reflected in the Host Status Register bit. Device errors are a result
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of a transaction collision, illegal command field, unclaimed cycle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (host initiated), or bus errors (collisions).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_CRC_ERROR The checksum is not correct (PEC is incorrect)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_UNSUPPORTED The SMBus operation is not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The number of bytes read.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Executes an SMBUS write block command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Executes an SMBUS write block command on the SMBUS device specified by SmBusAddress.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The SMBUS slave address, SMBUS command, and SMBUS length fields of SmBusAddress are required.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Bytes are written to the SMBUS from Buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The number of bytes written is returned, and will never return a value larger than 32-bytes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Status is not NULL, then the status of the executed command is returned in Status.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Length in SmBusAddress is zero or greater than 32, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Buffer is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If any reserved bits of SmBusAddress are set, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SmBusAddress Address that encodes the SMBUS Slave Address,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SMBUS Command, SMBUS Data Length, and PEC.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer Pointer to the buffer to store the bytes read from the SMBUS.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Status Return status for the executed command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is an optional parameter and may be NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_DEVICE_ERROR The request was not completed because a failure
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync reflected in the Host Status Register bit. Device errors are a result
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of a transaction collision, illegal command field, unclaimed cycle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (host initiated), or bus errors (collisions).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_CRC_ERROR The checksum is not correct (PEC is incorrect)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RETURN_UNSUPPORTED The SMBus operation is not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The number of bytes written.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Executes an SMBUS block process call command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Executes an SMBUS block process call command on the SMBUS device specified by SmBusAddress.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The SMBUS slave address, SMBUS command, and SMBUS length fields of SmBusAddress are required.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Bytes are written to the SMBUS from WriteBuffer. Bytes are then read from the SMBUS into ReadBuffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Status is not NULL, then the status of the executed command is returned in Status.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync It is the caller's responsibility to make sure ReadBuffer is large enough for the total number of bytes read.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SMBUS supports a maximum transfer size of 32 bytes, so Buffer does not need to be any larger than 32 bytes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Length in SmBusAddress is zero or greater than 32, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If WriteBuffer is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If ReadBuffer is NULL, then ASSERT().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If any reserved bits of SmBusAddress are set, then ASSERT().