| iic Vitis Drivers API Documentation

- Overview
- Data Structures
- APIs
- File List
- Examples

iic Documentation

XIic is the driver for an IIC master or slave device.In order to reduce the memory requirements of the driver the driver is partitioned such that there are optional parts of the driver. Slave, master, and multimaster features are optional such that all these files are not required at the same time. In order to use the slave and multimaster features of the driver, the user must call functions (XIic_SlaveInclude and XIic_MultiMasterInclude) to dynamically include the code. These functions may be called at any time.

Two sets of higher level API's are available in the XIic driver that can be used for Transmission/Reception in Master mode :

- XIic_MasterSend()/ XIic_MasterRecv() which is used in normal mode.
- XIic_DynMasterSend()/ XIic_DynMasterRecv() which is used in Dynamic mode.

Similarly two sets of lower level API's are available in XIic driver that can be used for Transmission/Reception in Master mode:

- XIic_Send()/ XIic_Recv() which is used in normal mode
- XIic_DynSend()/ XIic_DynRecv() which is used in Dynamic mode.

The user should use a single set of APIs as per his requirement and should not intermix them.

All the driver APIs can be used for read, write and combined mode of operations on the IIC bus.

In the normal mode IIC support both 7-bit and 10-bit addressing, and in the dynamic mode support only 7-bit addressing.

Initialization & Configuration

The XIic_Config structure is used by the driver to configure itself. This configuration structure is typically created by the tool-chain based on HW build properties.

To support multiple runtime loading and initialization strategies employed by various operating systems, the driver instance can be initialized in one of the following ways:

- XIic_Initialize() - The driver looks up its own configuration structure created by the tool-chain based on an ID provided by the tool-chain.
- XIic_CfgInitialize() - The driver uses a configuration structure provided by the caller. If running in a system with address translation, the provided virtual memory base address replaces the physical address present in the configuration structure.

General Purpose Output The IIC hardware provides a General Purpose Output Register that allows the user to connect general purpose outputs to devices, such as a write protect, for an EEPROM. This register is parameterizable in the hardware such that there could be zero bits in this register and in this case it will cause a bus error if read or written.

Bus Throttling

The IIC hardware provides bus throttling which allows either the device, as either a master or a slave, to stop the clock on the IIC bus. This feature allows the software to perform the appropriate processing for each interrupt without an unreasonable response restriction. With this design, it is important for the user to understand the implications of bus throttling.

Repeated Start

An application can send multiple messages, as a master, to a slave device and re-acquire the IIC bus each time a message is sent. The repeated start option allows the application to send multiple messages without re-acquiring the IIC bus for each message. The transactions involving repeated start are also called combined transfers if there is Read and Write in the same transaction.

The repeated start feature works with all the API's in XIic driver.

The Repeated Start feature also could cause the application to lock up, or monopolize the IIC bus, should repeated start option be enabled and sequences of messages never end(periodic data collection). Also when repeated start is not disable before the last master message is sent or received, will leave the bus captive to the master, but unused.

Addressing

The IIC hardware is parameterized such that it can be built for 7 or 10 bit addresses. The driver provides the ability to control which address size is sent in messages as a master to a slave device. The address size which the hardware responds to as a slave is parameterized as 7 or 10 bits but fixed by the hardware build.

Addresses are represented as hex values with no adjustment for the data direction bit as the software manages address bit placement. This is especially important as the bit placement is not handled the same depending on which options are used such as repeated start and 7 vs 10 bit addressing.

Data Rates

The IIC hardware is parameterized such that it can be built to support data rates from DC to 400KBit. The frequency of the interrupts which occur is proportional to the data rate.

Polled Mode Operation

This driver does not provide a polled mode of operation primarily because polled mode which is non-blocking is difficult with the amount of interaction with the hardware that is necessary.

Interrupts

The device has many interrupts which allow IIC data transactions as well as bus status processing to occur.

The interrupts are divided into two types, data and status. Data interrupts indicate data has been received or transmitted while the status interrupts indicate the status of the IIC bus. Some of the interrupts, such as Not Addressed As Slave and Bus Not Busy, are only used when these specific events must be recognized as opposed to being enabled at all times.

Many of the interrupts are not a single event in that they are continuously present such that they must be disabled after recognition or when undesired. Some of these interrupts, which are data related, may be acknowledged by the software by reading or writing data to the appropriate register, or must be disabled. The following interrupts can be continuous rather than single events.

- Data Transmit Register Empty/Transmit FIFO Empty
- Data Receive Register Full/Receive FIFO
- Transmit FIFO Half Empty
- Bus Not Busy
- Addressed As Slave
- Not Addressed As Slave

The following interrupts are not passed directly to the application through the status callback. These are only used internally for the driver processing and may result in the receive and send handlers being called to indicate completion of an operation. The following interrupts are data related rather than status.

- Data Transmit Register Empty/Transmit FIFO Empty
- Data Receive Register Full/Receive FIFO
- Transmit FIFO Half Empty
- Slave Transmit Complete

Interrupt To Event Mapping

The following table provides a mapping of the interrupts to the events which are passed to the status handler and the intended role (master or slave) for the event. Some interrupts can cause multiple events which are combined together into a single status event such as XII_MASTER_WRITE_EVENT and XII_GENERAL_CALL_EVENT

    Interrupt                         Event(s)                      Role

    Arbitration Lost Interrupt        XII_ARB_LOST_EVENT            Master
    Transmit Error                    XII_SLAVE_NO_ACK_EVENT        Master
    IIC Bus Not Busy                  XII_BUS_NOT_BUSY_EVENT        Master
    Addressed As Slave                XII_MASTER_READ_EVENT,        Slave
                                      XII_MASTER_WRITE_EVENT,       Slave
                                      XII_GENERAL_CALL_EVENT        Slave

Not Addressed As Slave Interrupt

The Not Addressed As Slave interrupt is not passed directly to the application through the status callback. It is used to determine the end of a message being received by a slave when there was no stop condition (repeated start). It will cause the receive handler to be called to indicate completion of the operation.

RTOS Independence

This driver is intended to be RTOS and processor independent. It works with physical addresses only. Any needs for dynamic memory management, threads or thread mutual exclusion, virtual memory, or cache control must be satisfied by the layer above this driver.

    MODIFICATION HISTORY:

    Ver   Who  Date     Changes

    1.01a rfp  10/19/01 release
    1.01c ecm  12/05/02 new rev
    1.01d jhl  10/08/03 Added general purpose output feature
    1.01d sv   05/09/05 Changed the data being written to the Address/Control
                        Register and removed the code for testing the
                        Receive Data Register in XIic_SelfTest function of
                        xiic_selftest.c source file
    1.02a jvb  12/14/05 I separated dependency on the static config table and
                        xparameters.h from the driver initialization by moving
                        _Initialize and _LookupConfig to _sinit.c. I also added
                        the new _CfgInitialize routine.
    1.02a mta  03/09/06 Added a new function XIic_IsIicBusy() which returns
                    whether IIC Bus is Busy or Free.
    1.02a mta  03/09/06 Implemented Repeated Start in the Low Level Driver.
    1.03a mta  07/17/06 Added files to support Dynamic IIC controller in High
                  level driver. Added xiic_dyn_master.c. Added support
                          for IIC Dynamic controller in Low level driver in xiic_l.c
    1.13a wgr  03/22/07 Converted to new coding style.
    1.13b ecm  11/29/07 added BB polling loops to the DynSend and DynRecv
                  routines to handle the race condition with BNB in IISR.
    1.14a sdm  08/22/08 Removed support for static interrupt handlers from the MDD
                  file
    1.14a ecm  11/13/08 changed BB polling loops in DynRecv to handle race
                  condition, CR491889. DynSend was correct from v1.13.b
    1.15a ktn  02/17/09 Fixed XIic_GetAddress() to return correct device address.
    1.16a ktn  07/17/09 Updated the XIic_SelfTest() to test only Interrupt
                  Registers.
    2.00a ktn  10/22/09 Converted all register accesses to 32 bit access.,
                  Removed the macro XIIC_RESET, XIic_Reset API should be
                  used in its place.
                  Removed the XIIC_CLEAR_STATS macro, XIic_ClearStats API
                  should be used in its place.
                  Removed the macro XIic_mEnterCriticalRegion,
                  XIic_IntrGlobalDisable should be used in its place.
                  Removed the macro XIic_mExitCriticalRegion,
                  XIic_IntrGlobalEnable should be used in its place.
                  Some of the macros have been renamed to remove _m from
                  the name see the xiic_i.h and xiic_l.h file for further
                  information (Example XIic_mClearIntr is now
                  XIic_ClearIntr).
                  Some of the macros have been renamed to be consistent,
                  see the xiic_l.h file for further information
                  (Example XIIC_WRITE_IIER is renamed as XIic_WriteIier).
                  The driver has been updated to use the HAL APIs/macros
                  (Example XASSERT_NONVOID is now Xil_AssertNonvoid)
    2.01a ktn  04/09/10 Updated TxErrorhandler in xiic_intr.c to be called for
                  Master Transmitter case based on Addressed As Slave (AAS)
                  bit rather than MSMS bit(CR 540199).
    2.02a sdm  10/08/10 Updated to disable the device at the end of the transfer,
                  using Addressed As Slave (AAS) bit when addressed as
                  slave in XIic_Send for CR565373.
    2.03a rkv  01/25/11 Updated in NAAS interrupt handler to support data
                  received less than FIFO size prior to NAAS interrupt.
                  Fixed for CR590212.
    2.04a sdm  07/22/11 Added IsSlaveSetAckOff flag to the instance structure.
                  This flag is set when the Slave has set the Ack Off in the
                  RecvSlaveData function (xiic_slave.c) and
                  is cleared in the NotAddrAsSlaveHandler (xiic_slave.c)
                  when the master has released the bus. This flag is
                  to be used by slave applications for recovering when it
                  has gone out of sync with the master for CR 615004.
                  Removed a compiler warning in XIic_Send (xiic_l.c)
    2.05a bss  02/05/12 Assigned RecvBufferPtr in XIic_MasterSend API and
                  SendBufferPtr in XIic_MasterRecv to NULL in xiic_master.c
    2.06a bss  02/14/13 Modified TxErrorHandler in xiic_intr.c to fix CR #686483
                  Modified xiic_eeprom_example.c to fix CR# 683509.
                  Modified bitwise OR to logical OR in
                  XIic_InterruptHandler API in xiic_intr.c.
    2.07a adk  18/04/13 Updated the code to avoid unused variable warnings
                        when compiling with the -Wextra -Wall flags.
                        Changes done in files xiic.c and xiic_i.h. CR:705001
    2.08a adk  29/07/13 In Low level driver In repeated start condition the
                  Direction of Tx bit must be disabled in recv condition
                  It Fixes the CR:685759 Changes are done in the file
                  xiic_l.c in the function XIic_Recv.
    3.0   adk  19/12/13 Updated as per the New Tcl API's
    3.1   adk  01/08/15 When configured as a slave return the actual number of
                        bytes have been received/sent by the Master
                        to the user callback (CR: 828504). Changes are made in the
                  file xiic_slave.c.
    3.2   sk   11/10/15 Used UINTPTR instead of u32 for Baseaddress CR# 867425.
                        Changed the prototype of XIic_CfgInitialize API.
    3.2     sd   18/02/16 In Low level driver in repeated start condition
                        NACK for last byte is added. Changes are done in
                        XIic_Recv for CR# 862303
    3.3   sk   06/17/16 Added bus busy checks for slave send/recv and master
                        send/recv.
    3.3   als  06/27/16 XIic_IsIicBusy now a wrapper for XIic_CheckIsBusBusy.
    3.4   ms   01/23/17 Added xil_printf statement in main function for all
                        examples to ensure that "Successfully ran" and "Failed"
                        strings are available in all examples. This is a fix
                        for CR-965028.
          ms   03/17/17 Added readme.txt file in examples folder for doxygen
                        generation.
          ms   04/05/17 Modified Comment lines in functions of iic
                        examples to recognize it as documentation block
                        for doxygen generation.
    3.10  gm   07/09/23 Added SDT support.