Before plugging in U2C-12 adapter, the necessary software (I2C Bridge) should be installed. Before the installation, it is recommended to check Windows OS settings:

To install U2C-12 adapter software:

Connect U2C-12 adapter to PC with USB cable. After connection of U2C-12 adapter the “Found New Hardware Wizard” is started:

%windir% contains the address line to Windows system folder where your operating system is installed.

In case you want to perform this actions manually, you may mention that there is no inf folder inside Windows system folder. By default the inf folder is hidden. To make it visible, open Windows Explorer, select "Tools" main menu item and choose "Folder Options". In "Folder Options" window select "View" tab. In "Advanced settings" section find "Hidden files and folders" and choose "Show hidden files and folders" radio button. Then click "OK" button. Now you can see all hidden files and folders in your operating system.

%windir% contains the address line to Windows system folder where your operating system is installed.

In case you want to perform this actions manually, you may mention that there is no inf folder inside Windows system folder. By default the inf folder is hidden. To make it visible, open Windows Explorer, select "Tools" main menu item and choose "Folder Options". In "Folder Options" window select "View" tab. In "Advanced settings" section find "Hidden files and folders" and choose "Show hidden files and folders" radio button. Then click "OK" button. Now you can see all hidden files and folders in your operating system.

In the “I2C Configuration” dialog window (Figure 2.2, ““I2C Configuration” dialog window”) you can change the settings of the I2C bus. To open this dialog window select "Options/I2C Configuration".

Figure 2.2. “I2C Configuration” dialog window

In the "I2C bus" drop list you can choose the frequency of the I2C bus. It can have one of the following values:

Select the “Clock Synchronization” check-box to turn on the clock synchronization (Clock Stretching). This option is only available for the frequencies below or equal to "Standard-mode" (<=100 kHz). In "Fast-mode" this option is unavailable.

The “Clock Synchronization Timeout” field allows to change the clock stretching timeout value (integer number from 1 to 65535). Clock synchronization (clock stretching) timeout value specified as multiple of 100 microseconds.

The "I2C Bridge Devices" Bar (Figure 2.4, “"I2C Bridge Devices" Bar”) includes the following buttons:

Figure 2.4. "I2C Bridge Devices" Bar

I2C Read” Bar (Figure 2.10, ““I2C Read” Bar”) is used to read data from I2C slave device.

Figure 2.10. “I2C Read” Bar

Each I2C slave device has its own 7-bit address. Enter it in the “Slave address” field. The I2C slave device address is an integer hexadecimal number in the range from 0 to 7F. Click the “Scan I2C Slave” button (Figure 2.9, “The I2C slave device addresses”) to get the list of addresses currently occupied by I2C slave devices.

Some I2C slave devices (e.g. I2C EEPROMs) have their own internal addressing. If your I2C slave device supports internal addressing, you can enter the internal address in the "Memory address" field and the address length (in bytes) in the “Memory address length” field. If your I2C slave device doesn’t support the internal addressing, enter “0” in the “Memory address length” field. Memory address length depends on the I2C slave device type. If the memory address length value is incorrect, you will get the wrong data.

Possible memory address values for the particular memory address length are listed in table.

Enter the number of bytes to be read from the I2C slave device into the “Length” field (integer decimal value from 1 to 256).

After you have entered the correct values, press the “I2c Read” button to read the data from the I2C slave device. You can see the result in the log field (Figure 2.11, “The result of the data reading from the I2C slave device”).

Figure 2.11. The result of the data reading from the I2C slave device

Figure 2.12. The "I2C Write" Bar

Each I2C slave device has its own 7-bit address. Enter it in the “Slave address” field. The I2C slave device address is an integer hexadecimal number in the range from 0 to 7F. Click the “Scan I2C Slave” button (Figure 2.9, “The I2C slave device addresses”) to get the list of addresses currently occupied by the I2C slave devices.

Some I2C slave devices (e.g. I2C EEPROMs) have their own internal addressing. If your I2C slave device supports internal addressing, you can enter the internal address in the "Memory address" field and the address length (in bytes) in the “Memory address length” field. If your I2C slave device doesn’t support the internal addressing, enter “0” in the “Memory address length” field. Memory address length depends on the I2C slave device type. If the memory address length value is incorrect, you will get the wrong data.

The possible memory address values for the particular memory address length are listed in table.

In the “Data” field you can enter the data to be sent to the I2C slave device. You can type hexadecimal values (from 0 to FF) to the field. To enter more then one value separate them by space.

After you have entered the correct values press the “I2с Write” button to send the data to the I2C slave device. You can see the result in the log field Figure 2.13, “The result of data writing into the I2C slave device”.

Figure 2.13. The result of data writing into the I2C slave device

The "I2C Bus Level" Bar (Figure 2.19, “"I2C Bus Level" Bar”) allows to work with the I2C slave devices on the bus level (SDA and SCL lines). The bar buttons make it possible to read and write the data by controlling the bus lines.

Figure 2.19. "I2C Bus Level" Bar

The "Release SCL" button releases the SCL line of the I2C bus. If the SCL line is not pulled down by I2C slave device, it will get high.

The "Drop SCL" pulls down the I2C bus SCL line.

The "Read SCL" button checks the current state of the I2C bus SCL line.

The "Release SDA" button releases the SDA line of the I2C bus. If the line is not pulled down by I2C slave device, it will get high.

The "Drop SDA" button pulls down the I2C bus SDA line.

The "Read SDA" button checks the current state of the I2C bus SDA line.

For instance, by consiquent pressing the "Read SCL" and "Read SDA" buttons (on condition that the I2C bus is released) the messages informing that the both lines are released will be displayed in the log field (Figure 2.20, “Reading the SDA/SCL lines”).

Figure 2.20. Reading the SDA/SCL lines

The “I2C Low Level” bar (Figure 2.14, “"I2C Low Level" Bar”) allows to work with the I2C slave devices on the low level.

Figure 2.14. "I2C Low Level" Bar

The “Start” button generates the START condition on the I2C bus, i.e. a HIGH to LOW transition of the SDA line while the SCL line is HIGH. The START condition (Figure 2.15, “The START condition”) indicates the beginning of the data exchange operation.

Figure 2.15. The START condition

The “ReStart” button generates the repeated START condition (Figure 2.16, “The repeated START condition”). It is used to allow combined write/read operations without releasing the bus and interrupting the operation.

Figure 2.16. The repeated START condition

The “Stop” button generates the STOP condition (Figure 2.17, “The STOP condition”) on the I2C bus, i.e. a HIGH to LOW transition of the SDA line while the SCL line is HIGH. The bus is considered to be free after the STOP condition.

Figure 2.17. The STOP condition

The “Write” button transmits the data byte from I2C master to I2C slave device. Enter the transmitted value into the “Write” field (integer hexadecimal value from 0 to FF).

If the "Ack" (Write) check-box is selected, acknowledge will be requested from the I2C slave device after the data byte transmission.

If the "Ack" (Write) check-box is not selected, acknowledge will not be requested. It may lead to the data loss. You can still press the "Get Ack" button to request acknowledge.

The “Read” button transmits the data byte from I2C slave to I2C master device. The information about the byte data requested is desplayed in the log field (Figure 2.18, “The information about the byte data reading with the "Ack" signal”).

Figure 2.18. The information about the byte data reading with the "Ack" signal

If the "Ack" (read) check-box is selected, acknowledge ("Ack" or "No Ack" depends on the value of “Put Ack” drop list) will be generated.

If "Ack" (read) check-box is not selected, acknowledge will not be generated. You can still press the “Put Ack” button to generate acknowledge. Without acknowledge the further data reading can be incorrect.

The “Get Ack” button requests acknowledge from the I2C slave device.

The “Put Ack” button generates acknowledge on the I2C bus ("Ack” or “No Ack” depends on the value of “Put Ack” drop list).

The "SPI Bus Level" Bar (Figure 2.21, “The "SPI Bus" bar”) allows to read and write the data over the SPI bus.

Figure 2.21. The "SPI Bus" bar

The "Spi ReadWrite" button shifts out (writes) and in (reads) a stream of up to 256 bytes to/from the SPI slave device. The shift operation is occurred in a full duplex data transmission mode.

The "Spi Write" button shifts out (writes) a stream of up to 256 bytes to the SPI slave device.

The "Spi Read" button shifts in (reads) a stream of up to 256 bytes from the SPI slave device.

The "Length" field allows you to enter the number of bytes to be shifted. Maximum value is 256.

The "Data" field allows you to enter the data to be shifted. You can type hexadecimal values (from 0 to FF) to the field. To enter more then one value separate them by space.

U2C_RESULT U2C_CloseDevice(
      HANDLE hDevice
);

The U2C_CloseDevice() function closes the open device handle.

Return values:

U2C_SUCCESS

The device referenced by hDevice handle was successfully closed.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

U2C_RESULT U2C_DropScl(
      HANDLE hDevice
);

The U2C_DropScl() function pulls down the I2C bus SCL line.

Return values:

U2C_SUCCESS

The SCL line was successfully dropped.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

U2C_RESULT U2C_DropSda(
      HANDLE hDevice
);

The U2C_DropSda() function pulls down the I2C bus SDA line.

Return values:

U2C_SUCCESS

The SDA line was successfully dropped.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

U2C_RESULT U2C_GetAck(
      HANDLE hDevice,
);

The U2C_GetAck() function checks for acknowledge from I2C slave device. This function does not finish the I2C bus transaction after transmission, so at the end of I2C transaction U2C_Stop() function has to be called.

Return values:

U2C_SUCCESS

I2C slave device provided acknowledge.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

U2C_NO_ACK

I2C slave device did not provide acknowledge.

U2C_RESULT U2C_GetByte(
      HANDLE hDevice,
      BYTE* pData
);

The U2C_GetByte() function shifts in (reads) a single byte from I2C bus. It assumes that the bus is available, Start Condition has been previously generated and the slave device has been properly addressed. This function doesn't generate acknowledge, so you must call the U2C_PutAck() function or use U2C_GetByteWithAck() instead ofU2C_GetByte() function. This function can be called several times to implement custom I2C-like protocol. The function does not finish I2C bus transaction after transmission, so at the end of I2C transaction U2C_Stop() function has to be called.

Return values:

U2C_SUCCESS

Byte was successfully read from I2C bus.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

U2C_RESULT U2C_GetByteWithAck(
      HANDLE hDevice,
      BYTE* pData,
      BOOL bAck
);

The U2C_GetByteWithAck() function shifts in (reads) a single byte from the I2C bus and then generates acknowledge or not-acknowledge condition according to the value passed in bAck parameter. It assumes that the bus is available, Start Condition has been previously generated and the slave device has been properly addressed. This function can be called several times to implement custom I2C-like protocol. The function does not finish the I2C bus transaction after transmission, so at the end of I2C transaction U2C_Stop() function has to be called.

Return values:

U2C_SUCCESS

Byte was successfully read from I2C bus.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

U2C_RESULT U2C_SetClockSynch(
      HANDLE hDevice,
      BOOL* pEnable
);

The U2C_GetClockSynch() function retrieves I2C bus clock synchronization settings.

Clock synchronization (clock stretching) is used in situations where an I2C slave is not able to co-operate with the clock speed provided by the U2C-12 I2C master and needs to slow down the I2C bus. I2C slave holds down the SCL line low and in this way signals the I2C master about a wait state. If I2C bus clock synchronization is enabled, U2C-12 device will wait until I2C slave device releases the SCL line.

	Warning
	I 2 C bus clock synchronization (clock stretching) is implemented for I 2 C bus frequencies up to 100kHz. See U2C_SetI2cFreq() to learn how to change I 2 C bus frequency.

Return values:

U2C_SUCCESS

The I2C bus clock synchronization value was successfully retrieved.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

U2C_RESULT U2C_GetClockSynchTimeout(
      HANDLE hDevice,
      WORD* pTimeout
);

The U2C_GetClockSynchTimeout() function retrieves timeout value for I2C bus clock synchronization.

Clock synchronization (clock stretching) is used in situations where I2C slave device is not able to cooperate on the clock speed provided by the U2C-12 I2C master and needs to slow down the I2C bus. I2C slave holds down the SCL line low and in that way signals the I2C master about a wait state. To avoid waiting deadlock (if some problem occurs with I2C slave device) timeout value was introduced into U2C-12 I2C interface. If I2C slave device doesn't release the clock within the given timeout interval, U2C-12 adapter returns the U2C_I2C_CLOCK_SYNCH_TIMEOUT error value.

	Warning
	I 2 C bus clock synchronization (clock stretching) is implemented for I 2 C bus frequencies up to 100kHz. See U2C_SetI2cFreq() to learn how to change I 2 C bus frequency.

Return values:

U2C_SUCCESS

The I2C bus clock synchronization timeout value was successfully retrieved.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

BYTE U2C_GetDeviceCount();

The U2C_GetDeviceCount() function checks how many U2C-12 devices are currently attached.

U2C_VERSION_INFO U2C_GetDllVersion();

The U2C_GetDllVersion() function retrieves the version of the I2CBrdg.dll dynamic link library or shared library for Linux.

U2C_RESULT U2C_GetDriverVersion(
      HANDLE hDevice,
      PU2C_VESION_INFO pVersion
);

U2C_RESULT U2C_GetFirmwareVersion(
      HANDLE hDevice,
      PU2C_VESION_INFO pVersion
);

The U2C_GetFirmwareVersion() function retrieves the version of the firmware currently loaded into the U2C-12 device referenced by hDevice handle.

Return values:

U2C_SUCCESS

The firmware version was successfully retrieved.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

U2C_RESULT U2C_GetI2cFreq(
      HANDLE hDevice,
      BYTE* pFrequency
);

U2C_RESULT U2C_GetIoDirection(
      HANDLE hDevice,
      ULONG* pValue
);

The U2C_GetIoDirection() function obtains current input/output direction of the GPIO port pins.

Return values:

U2C_SUCCESS

The GPIO pins direction was successfully read.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

U2C_RESULT U2C_GetSerialNum(
      HANDLE hDevice,
      long* pSerialNum
);

The U2C_GetSerialNum() function retrieves the Serial Number of the current device. This is unique Serial Number. It can be used to identify device when you are using a number of U2C-12 devices simultaneously.

Return values:

U2C_SUCCESS

Serial Number was successfully obtained.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

U2C_RESULT U2C_GetSingleIoDirection(
      HANDLE hDevice,
      ULONG IoNumber,
      BOOL* pbOutput
);

The U2C_GetSingleIoDirection() function obtains input/output direction of the specified GPIO pin.

Return values:

U2C_SUCCESS

The GPIO pin direction was successfully read.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

U2C_BAD_PARAMETER

IoNumber is out of range.

U2C_RESULT U2C_IoRead(
      HANDLE hDevice,
      ULONG* pValue
);

The U2C_IoRead() function obtains the value of the GPIO port pins.

Return values:

U2C_SUCCESS

The GPIO pins state was successfully read.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

U2C_RESULT U2C_IoWrite(
      HANDLE hDevice,
      ULONG Value,
      ULONG Mask
);

The U2C_IoWrite() sets the output value of the GPIO port pins. Pins have to be configured as output using the U2C_SetIoDirection() function first.

Return values:

U2C_SUCCESS

The GPIO pins output value was successfully modified.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

U2C_RESULT U2C_IsHandleValid(
      HANDLE hDevice
);

The U2C_IsHandleValid() function checks whether the device referenced by hDevice handle is currently attached to the USB and can be used by SW.

Return values:

U2C_SUCCESS

The device referenced by hDevice handle is present.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

HANDLE U2C_OpenDevice(
      BYTE nDevice
);

HANDLE U2C_OpenDeviceBySerialNum(
      long nSerialNum
);

The U2C_OpenDeviceBySerialNum() function opens the U2C-12 device with specified Serial Number. This is unique Serial Number. It can be used to identify device when you are using a number of U2C-12 devices simultaneously.

U2C_RESULT U2C_PutAck(
      HANDLE hDevice,
      BOOL bAck
);

The U2C_PutAck() function generates acknowledge or not-acknowledge condition according to the value passed in bAck parameter. This function does not finish the I2C bus transaction after transmission, so at the end of I2C transaction U2C_Stop() function has to be called.

Return values:

U2C_SUCCESS

Acknowledge / non-acknowledge condition was successfully generated.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

U2C_RESULT U2C_PutByte(
      HANDLE hDevice,
      BYTE Data
);

The U2C_PutByte() function shifts out (transmits) a single byte to I2C bus. It assumes that the bus is available and Start Condition has been generated first. This function doesn't check acknowledge from I2C slave device, so you must call the U2C_GetAck() function to check acknowledge or to use U2C_PutByteWithAck() instead ofU2C_PutByte() function. This function can be called several times to implement custom I2C-like protocol. The function does not finish I2C bus transaction after transmission, so at the end of I2C transaction U2C_Stop() function has to be called.

Return values:

U2C_SUCCESS

Byte was successfully transmitted to the I2C bus.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

U2C_RESULT U2C_PutByteWithAck(
      HANDLE hDevice,
      BYTE Data
);

The U2C_PutByteWithAck() function shifts out (transmits) a single byte to I2C bus and checks for acknowledge from I2C slave device. It assumes that the bus is available and Start Condition has been generated first. This function can be called several times to implement custom I2C-like protocol. The function does not finish the I2C bus transaction after transmission, so at the end of I2C transaction U2C_Stop() function has to be called.

Return values:

U2C_SUCCESS

Byte was successfully transmitted to the I2C bus and I2C slave device provided acknowledge.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

U2C_NO_ACK

I2C slave device did not acknowledge the transmitted byte.

U2C_RESULT U2C_RW_Pack(
      HANDLE hDevice,
      PU2C_TRANSACTION_PACK pTransaction,
      int count
);

	Warning
	This function is implemented only for Linux and Mac versions of the library.

The U2C_RW_Pack() function executes a list (pack) of I2C read/write transactions. All transactions are sent to U2C-12 device in a single USB transfer block.U2C_RW_Pack() waits until all I2C transactions are completed and returns each transaction result code in pTransaction[i].rc element. I2C transactions are performed sequentially in the same order as they are in the pack. Take care to pack correct sequence of the transactions. For instance attempt to read/write after write to I2C EEPROM may timeout because of the internal EEPROM write cycle.

Parameters:

hDevice

Handle to the U2C-12 device.

pTransaction

List of I2C transactions.

count

Number of I2C transactions in the pTransaction list.

Return values:

U2C_SUCCESS

Operation was successfully completed and pList is filled with valid data.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

U2C_BAD_PARAMETER

I2C transactions list is too big.

U2C_RESULT U2C_Read(
      HANDLE hDevice,
      PU2C_TRANSACTION pTransaction
);

U2C_RESULT U2C_ReadScl(
      HANDLE hDevice,
      U2C_LINE_STATE* pState
);

The U2C_ReadScl() function checks the current state of the I2C bus SCL line.

Return values:

U2C_SUCCESS

The SCL line state was successfully read.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

U2C_RESULT U2C_ReadSda(
      HANDLE hDevice,
      U2C_LINE_STATE* pState
);

The U2C_ReadSda() function checks the current state of the I2C bus SDA line.

Return values:

U2C_SUCCESS

The SDA line state was successfully read.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

U2C_RESULT U2C_ReleaseScl(
      HANDLE hDevice
);

U2C_RESULT U2C_ReleaseSda(
      HANDLE hDevice
);

The U2C_ReleaseSda() function releases the SDA line of the I2C bus. If the line is not pulled down by I2C slave device, it will get high.

Return values:

U2C_SUCCESS

The SDA line was successfully released.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

U2C_RESULT U2C_RepeatedStart(
      HANDLE hDevice
);

The U2C_RepeatedStart() function generates repeated start condition on the I2C bus.

Return values:

U2C_SUCCESS

Repeated start condition was successfully generated.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

U2C_RESULT U2C_ScanDevices(
      HANDLE hDevice,
      PU2C_SLAVE_ADDR_LIST pList
);

The U2C_ScanDevices() function scans slave device addresses currently occupied by I2C slave devices connected to the I2C bus.

Return values:

U2C_SUCCESS

Operation was successfully completed and pList is filled with valid data.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

U2C_RESULT U2C_SetClockSynch(
      HANDLE hDevice,
      BOOL Enable
);

The U2C_SetClockSynch() function enables I2C bus clock synchronization.

Clock synchronization (clock stretching) is used in situations where an I2C slave is not able to co-operate with the clock speed provided by the U2C-12 I2C master and needs to slow down the I2C bus. I2C slave holds down the SCL line low and in this way signals the I2C master about a wait state. If I2C bus clock synchronization is enabled, U2C-12 device will wait until I2C slave device releases the SCL line.

	Warning
	I 2 C bus clock synchronization (clock stretching) is implemented for I 2 C bus frequencies up to 100kHz. See U2C_SetI2cFreq() to learn how to change I 2 C bus frequency.

Return values:

U2C_SUCCESS

The I2C bus clock synchronization value was successfully set.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

U2C_RESULT U2C_SetClockSynchTimeout(
      HANDLE hDevice,
      WORD Timeout
);

The U2C_SetClockSynchTimeout() function configures timeout value for I2C bus clock synchronization.

Clock synchronization (clock stretching) is used in situations where I2C slave device is not able to cooperate on the clock speed provided by the U2C-12 I2C master and needs to slow down the I2C bus. I2C slave holds down the SCL line low and in that way signals the I2C master about a wait state. To avoid waiting deadlock (if some problem occurs with I2C slave device) timeout value was introduced into U2C-12 I2C interface. If I2C slave device doesn't release the clock within the given timeout interval, U2C-12 adapter returns the U2C_I2C_CLOCK_SYNCH_TIMEOUT error value.

The U2C_SetClockSynchTimeout() function doesn't enables or disables clock stretching functionality. It only changes the clock stretching timeout value. Clock stretching should be enabled with U2C_SetClockSynch() function.

	Warning
	I 2 C bus clock synchronization (clock stretching) is implemented for I 2 C bus frequencies up to 100kHz. See U2C_SetI2cFreq() to learn how to change I 2 C bus frequency.

Parameters:

hDevice

Handle to the U2C-12 device.

Timeout

Clock synchronization (clock stretching) timeout value specified as multiple of 100 microseconds.

Return values:

U2C_SUCCESS

The I2C bus clock synchronization timeout value was successfully set.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

U2C_RESULT U2C_SetI2cFreq(
      HANDLE hDevice,
      BYTE Frequency
);

U2C_RESULT U2C_SetIoDirection(
      HANDLE hDevice,
      ULONG Value,
      ULONG Mask
);

The U2C_SetIoDirection() function configures input/output direction of the GPIO port pins.

Return values:

U2C_SUCCESS

The GPIO pins direction was successfully modified.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

U2C_RESULT U2C_SetSingleIoDirection(
      HANDLE hDevice,
      ULONG IoNumber,
      BOOL bOutput
);

The U2C_SetSingleIoDirection() function configures input/output direction of the specified GPIO pin.

Return values:

U2C_SUCCESS

The GPIO pin direction was successfully modified.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

U2C_BAD_PARAMETER

IoNumber is out of range.

U2C_RESULT U2C_SingleIoRead(
      HANDLE hDevice,
      ULONG IoNumber,
      BOOL* pValue
);

The U2C_SingleIoRead() function obtains the value of the specified GPIO pin.

Return values:

U2C_SUCCESS

The GPIO pin state was successfully read.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

U2C_BAD_PARAMETER

IoNumber is out of range.

U2C_RESULT U2C_SingleIoWrite(
      HANDLE hDevice,
      ULONG IoNumber,
      BOOL Value
);

The U2C_SingleIoWrite() function sets the output value of the specified GPIO pin. Pin must be configured as output using U2C_SetIoDirection() orU2C_SetSingleIoDirection() functions first.

Return values:

U2C_SUCCESS

The GPIO pin output value was successfully modified.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

U2C_BAD_PARAMETER

IoNumber is out of range.

U2C_RESULT U2C_SpiConfigSS(
      HANDLE hDevice,
      ULONG IoNumber,
      BOOL ActiveHigh
);

The U2C_SpiConfigSS() function configures GPIO pin specified by IoNumber as SPI Bus Slave Select (Master Select) signal.

To benefit from Slave Select signal during SPI communication you should use Slave Select aware functions set:

Slave Select pin remains unchanged if you call U2C_SpiReadWrite(), U2C_SpiWrite() or U2C_SpiRead() function. This can be useful if you want to send or receive several buffers through SPI Bus changing Slave Select pin only once. You can use GPIO routines to work with Slave Select signal in such a case.

You can configure any number of pins for Slave Select signal and specify different pins for each SPI transaction.

Return values:

U2C_SUCCESS

The Slave Select pin was successfully configured.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

U2C_BAD_PARAMETER

IoNumber is out of range.

U2C_RESULT U2C_SpiGetConfig(
      HANDLE hDevice,
      BYTE* pCPOL,
      BYTE* pCPHA
);

The U2C_SpiGetConfig() function obtains SPI bus configuration (clock polarity and phase).

Return values:

U2C_SUCCESS

The SPI bus configuration was successfully obtained.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

U2C_RESULT U2C_SpiGetConfigEx(
      HANDLE hDevice,
      DWORD* pConfig
);

The U2C_SpiGetConfigEx() function obtains SPI configuration.

Return values:

U2C_SUCCESS

The SPI bus configuration was successfully obtained.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

U2C_RESULT U2C_SpiGetFreq(
      HANDLE hDevice,
      BYTE* pFrequency
);

The U2C_SpiGetFreq() function obtains SPI bus frequency.

Return values:

U2C_SUCCESS

The SPI bus frequency value was successfully retrieved.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

U2C_RESULT U2C_SpiRead(
      HANDLE hDevice,
      BYTE* pInBuffer,
      unsigned short Length
);

The U2C_SpiRead() function shifts in (reads) a stream of up to 256 bytes from the SPI slave device.

Return values:

U2C_SUCCESS

The data was successfully read.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

U2C_BAD_PARAMETER

Length parameter is out of range.

U2C_RESULT U2C_SpiReadSS(
      HANDLE hDevice,
      BYTE* pInBuffer,
      WORD Length
      ULONG IoNumber
      BOOL ActiveHigh
);

The U2C_SpiReadSS() function shifts in (reads) a stream of up to 256 bytes from the SPI slave device.

In contrast to U2C_SpiRead() function, U2C_SpiReadSS() also selects the SPI slave device to communicate with. Slave Select pin should be preconfigured withU2C_SpiConfigSS() function. You can configure any number of pins for Slave Select signal and specify different pins for each SPI transaction.

Use U2C_SpiRead() function if you don't want to involve slave device selection into SPI transaction. This can be useful if you want to receive several buffers through SPI Bus changing Slave Select pin only once. You can use GPIO routines to work with Slave Select pin in such a case.

Return values:

U2C_SUCCESS

The data was successfully read.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

U2C_BAD_PARAMETER

Length or IoNumber parameter is out of range.

U2C_RESULT U2C_SpiReadWrite(
      HANDLE hDevice,
      BYTE* pOutBuffer,
      BYTE* pInBuffer,
      unsigned short Length
);

The U2C_SpiReadWrite() function shifts out (writes) and in (reads) a stream of up to 256 bytes to/from the SPI slave device.

Return values:

U2C_SUCCESS

The data was successfully transmitted via SPI bus.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

U2C_BAD_PARAMETER

Length parameter is out of range.

U2C_RESULT U2C_SpiReadWriteSS(
      HANDLE hDevice,
      BYTE* pOutBuffer,
      BYTE* pInBuffer,
      WORD Length
      ULONG IoNumber
      BOOL ActiveHigh
);

U2C_RESULT U2C_SpiSetConfig(
      HANDLE hDevice,
      BYTE CPOL,
      BYTE CPHA
);

The U2C_SpiSetConfig() function configures SPI bus clock polarity and phase.

Return values:

U2C_SUCCESS

The SPI bus was successfully configured.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

U2C_RESULT U2C_SpiSetConfigEx(
      HANDLE hDevice,
      DWORD Config
);

The U2C_SpiSetConfigEx() function enables/disables and configures SPI interface.

Return values:

U2C_SUCCESS

SPI bus was successfully configured.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

U2C_RESULT U2C_SpiSetFreq(
      HANDLE hDevice,
      BYTE Frequency
);

The U2C_SpiSetFreq() function configures SPI bus frequency.

Return values:

U2C_SUCCESS

The SPI bus frequency value was successfully set.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

U2C_RESULT U2C_SpiWrite(
      HANDLE hDevice,
      BYTE* pOutBuffer,
      unsigned short Length
);

U2C_RESULT U2C_SpiWriteSS(
      HANDLE hDevice,
      BYTE* pOutBuffer,
      WORD Length
      ULONG IoNumber
      BOOL ActiveHigh
);

U2C_RESULT U2C_Start(
      HANDLE hDevice
);

U2C_RESULT U2C_Stop(
      HANDLE hDevice
);

U2C_RESULT U2C_Write(
      HANDLE hDevice,
      PU2C_TRANSACTION pTransaction
);

The U2C_Write() function writes up to 256 bytes into the I2C slave device.

Return values:

U2C_SUCCESS

The data was successfully written into the I2C slave device.

U2C_HARDWARE_NOT_FOUND

U2C-12 device referenced by hDevice handle was not found.

U2C_SLAVE_OPENNING_FOR_WRITE_FAILED

I2C slave device did not acknowledge write slave address.

U2C_SENDING_MEMORY_ADDRESS_FAILED

I2C slave device did not acknowledge internal address.

U2C_SENDING_DATA_FAILED

I2C slave did not acknowledge data output.