Description

Functions to control the I²C clock speed.

Functions
double	I2CGetSpeedMax (TpDeviceHandle_t hDevice)
	Get the maximum clock speed on the I²C bus controlled by a specified I²C host. More...

double	I2CGetSpeed (TpDeviceHandle_t hDevice)
	Get the current clock speed on the I²C bus controlled by a specified I²C host. More...

double	I2CSetSpeed (TpDeviceHandle_t hDevice, double dSpeed)
	Set the clock speed on the I²C bus controlled by a specified I²C host. More...

Function Documentation

double I2CGetSpeedMax ( TpDeviceHandle_t hDevice )

Get the maximum clock speed on the I²C bus controlled by a specified I²C host.

Parameters

[in] hDevice A device handle identifying the I²C host.

Status values

INVALID_HANDLE	The handle is not a valid I²C host handle.
DEVICE_GONE	The device indicated by the device handle is no longer available.
LIBRARY_NOT_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

double I2CGetSpeed ( TpDeviceHandle_t hDevice )

Get the current clock speed on the I²C bus controlled by a specified I²C host.

Parameters

[in] hDevice A device handle identifying the I²C host.

Status values

UNSUCCESSFUL	An error occurred during execution of the last called function.
INVALID_HANDLE	The handle is not a valid I²C host handle.
DEVICE_GONE	The device indicated by the device handle is no longer available.
LIBRARY_NOT_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

Set the clock speed on the I²C bus controlled by a specified I²C host.

Parameters

[in]	hDevice	A device handle identifying the I²C host.
[in]	dSpeed	The requested I²C clock speed in Hz.

Status values

VALUE_CLIPPED	The requested I²C clock speed is outside the valid range and clipped to that range.
VALUE_MODIFIED	The requested I²C clock speed is inside the valid range but not available. The closest valid value is set.
INVALID_HANDLE	The handle is not a valid I²C host handle.
DEVICE_GONE	The device indicated by the device handle is no longer available.
LIBRARY_NOT_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.