3.15.1 I2C

• static void I2C1_EventHandler ()

• static void I2C1_ErrorEventHandler ()

• static bool I2C1_DefaultCallback (i2c_client_transfer_event_t event)

• void I2C1_Initialize (void)

  This routine initializes the I2C1 module. This routine must be called before any other I2C1 routine is called. This routine should only be called once during system initialization.

• void I2C1_Deinitialize (void)

  This routine Deinitializes the I2C1 module. This function disables the module.

• void I2C1_WriteByte (uint8_t data)

  This function writes data to a host on the bus. I2C1_Initialize() must have been called for the associated.

• uint8_t I2C1_ReadByte (void)

  This function read data from a host on the bus. I2C1_Initialize() must have been called for the associated.

• uint16_t I2C1_ReadAddr (void)

  This function read requested address from a host on the bus. I2C1_Initialize() must have been called for the associated.

• i2c_client_error_t I2C1_ErrorGet (void)

  This function the error occurred during I2C Transmit and Receive. I2C1_Initialize() must have been called for the associated.

• i2c_client_transfer_dir_t I2C1_TransferDirGet (void)

  This function get the I2C Transfer direction. I2C1_Initialize() must have been called for the associated.

• i2c_client_ack_status_t I2C1_LastByteAckStatusGet (void)

  This function get the I2C Host ACK status. I2C1_Initialize() must have been called for the associated.

• void I2C1_CallbackRegister (bool(*callback)(i2c_client_transfer_event_t clientEvent))

  This function sets the pointer to be called "back" when the given I2C transfer events, Bus collision and Write collision occur.

• void I2C1_ISR (void)

  This function is common ISR function for all I2C1 interrupts. I2C1_Initialize() must have been called for the associated.

• void I2C1_ERROR_ISR (void)

  This function is common ISR function for all I2C1 Error interrupts. I2C1_Initialize() must have been called for the associated.

• const struct I2C_CLIENT_INTERFACEI2C_Client

  External object for I2C_Client.

• static volatile uint16_t i2c1Addr

• static volatile i2c_client_error_ti2c1ErrorState

• static bool(* I2C1_InterruptHandler )(i2c_client_transfer_event_t clientEvent) = NULL

This file contains the driver code for I2C1 module.

I2C1 Generated Driver File

• void I2C1_Initialize (void)

  This routine initializes the I2C1 module. This routine must be called before any other I2C1 routine is called. This routine should only be called once during system initialization.

• void I2C1_Deinitialize (void)

  This routine Deinitializes the I2C1 module. This function disables the module.

• void I2C1_WriteByte (uint8_t wrByte)

  This function writes data to a host on the bus. I2C1_Initialize() must have been called for the associated.

• uint8_t I2C1_ReadByte (void)

  This function read data from a host on the bus. I2C1_Initialize() must have been called for the associated.

• uint16_t I2C1_ReadAddr (void)

  This function read requested address from a host on the bus. I2C1_Initialize() must have been called for the associated.

• i2c_client_error_t I2C1_ErrorGet (void)

  This function the error occurred during I2C Transmit and Receive. I2C1_Initialize() must have been called for the associated.

• i2c_client_transfer_dir_t I2C1_TransferDirGet (void)

  This function get the I2C Transfer direction. I2C1_Initialize() must have been called for the associated.

• i2c_client_ack_status_t I2C1_LastByteAckStatusGet (void)

  This function get the I2C Host ACK status. I2C1_Initialize() must have been called for the associated.

• void I2C1_CallbackRegister (bool(*callback)(i2c_client_transfer_event_t clientEvent))

  This function sets the pointer to be called "back" when the given I2C transfer events, Bus collision and Write collision occur.

• void I2C1_ISR (void)

  This function is common ISR function for all I2C1 interrupts. I2C1_Initialize() must have been called for the associated.

• void I2C1_ERROR_ISR (void)

  This function is common ISR function for all I2C1 Error interrupts. I2C1_Initialize() must have been called for the associated.

• #define i2c_client_client_interfaceI2C_Client

• #define I2C_Client_InitializeI2C1_Initialize

• #define I2C_Client_DeinitializeI2C1_Deinitialize

• #define I2C_Client_WriteByteI2C1_WriteByte

• #define I2C_Client_ReadByteI2C1_ReadByte

• #define I2C_Client_ReadAddrI2C1_ReadAddr

• #define I2C_Client_ErrorGetI2C1_ErrorGet

• #define I2C_Client_TransferDirGetI2C1_TransferDirGet

• #define I2C_Client_LastByteAckStatusGetI2C1_LastByteAckStatusGet

• #define I2C_Client_CallbackRegisterI2C1_CallbackRegister

• #define I2C_Client_TasksI2C1_Tasks

• const struct I2C_CLIENT_INTERFACE I2C_Client

  External object for I2C_Client.

I2C1 Generated Driver API Header File

• static void I2C1_EventHandler ()

• static void I2C1_ErrorEventHandler ()

• static bool I2C1_DefaultCallback (i2c_client_transfer_event_t event)

• void I2C1_Initialize (void)

  This routine initializes the I2C1 module. This routine must be called before any other I2C1 routine is called. This routine should only be called once during system initialization.

• void I2C1_Deinitialize (void)

  This routine Deinitializes the I2C1 module. This function disables the module.

• void I2C1_WriteByte (uint8_t data)

  This function writes data to a host on the bus. I2C1_Initialize() must have been called for the associated.

• uint8_t I2C1_ReadByte (void)

  This function read data from a host on the bus. I2C1_Initialize() must have been called for the associated.

• uint16_t I2C1_ReadAddr (void)

  This function read requested address from a host on the bus. I2C1_Initialize() must have been called for the associated.

• i2c_client_error_t I2C1_ErrorGet (void)

  This function the error occurred during I2C Transmit and Receive. I2C1_Initialize() must have been called for the associated.

• i2c_client_transfer_dir_t I2C1_TransferDirGet (void)

  This function get the I2C Transfer direction. I2C1_Initialize() must have been called for the associated.

• i2c_client_ack_status_t I2C1_LastByteAckStatusGet (void)

  This function get the I2C Host ACK status. I2C1_Initialize() must have been called for the associated.

• void I2C1_CallbackRegister (bool(*callback)(i2c_client_transfer_event_t clientEvent))

  This function sets the pointer to be called "back" when the given I2C transfer events, Bus collision and Write collision occur.

• void I2C1_Tasks (void)

  his function is common Polling function for all I2C1 client. I2C1_Initialize() must have been called for the associated.

• const struct I2C_CLIENT_INTERFACEI2C_Client

  External object for I2C_Client.

• static volatile uint16_t i2c1Addr

• static volatile i2c_client_error_ti2c1ErrorState

• static bool(* I2C1_InterruptHandler )(i2c_client_transfer_event_t clientEvent) = NULL

This file contains the driver code for I2C1 module.

I2C1 Generated Driver File

• void I2C1_Initialize (void)

  This routine initializes the I2C1 module. This routine must be called before any other I2C1 routine is called. This routine should only be called once during system initialization.

• void I2C1_Deinitialize (void)

  This routine Deinitializes the I2C1 module. This function disables the module.

• void I2C1_WriteByte (uint8_t wrByte)

  This function writes data to a host on the bus. I2C1_Initialize() must have been called for the associated.

• uint8_t I2C1_ReadByte (void)

  This function read data from a host on the bus. I2C1_Initialize() must have been called for the associated.

• uint16_t I2C1_ReadAddr (void)

  This function read requested address from a host on the bus. I2C1_Initialize() must have been called for the associated.

• i2c_client_error_t I2C1_ErrorGet (void)

  This function the error occurred during I2C Transmit and Receive. I2C1_Initialize() must have been called for the associated.

• i2c_client_transfer_dir_t I2C1_TransferDirGet (void)

  This function get the I2C Transfer direction. I2C1_Initialize() must have been called for the associated.

• i2c_client_ack_status_t I2C1_LastByteAckStatusGet (void)

  This function get the I2C Host ACK status. I2C1_Initialize() must have been called for the associated.

• void I2C1_CallbackRegister (bool(*callback)(i2c_client_transfer_event_t clientEvent))

  This function sets the pointer to be called "back" when the given I2C transfer events, Bus collision and Write collision occur.

• void I2C1_Tasks (void)

  his function is common Polling function for all I2C1 client. I2C1_Initialize() must have been called for the associated.

• #define i2c_client_client_interfaceI2C_Client

• #define I2C_Client_InitializeI2C1_Initialize

• #define I2C_Client_DeinitializeI2C1_Deinitialize

• #define I2C_Client_WriteByteI2C1_WriteByte

• #define I2C_Client_ReadByteI2C1_ReadByte

• #define I2C_Client_ReadAddrI2C1_ReadAddr

• #define I2C_Client_ErrorGetI2C1_ErrorGet

• #define I2C_Client_TransferDirGetI2C1_TransferDirGet

• #define I2C_Client_LastByteAckStatusGetI2C1_LastByteAckStatusGet

• #define I2C_Client_CallbackRegisterI2C1_CallbackRegister

• #define I2C_Client_TasksI2C1_Tasks

• const struct I2C_CLIENT_INTERFACEI2C_Client

  External object for I2C_Client.

I2C1 Generated Driver API Header File

• enum i2c_client_transfer_dir_t { I2C_CLIENT_TRANSFER_DIR_WRITE = 0, I2C_CLIENT_TRANSFER_DIR_READ = 1 }

  I2C_CLIENT_TRANSFER_DIR Enumeration.

• enum i2c_client_ack_status_t { I2C_CLIENT_ACK_STATUS_RECEIVED_ACK = 0, I2C_CLIENT_ACK_STATUS_RECEIVED_NACK = 1 }

  I2C Ack/Nack status enumeration.

• enum i2c_client_transfer_event_t { I2C_CLIENT_TRANSFER_EVENT_NONE = 0, I2C_CLIENT_TRANSFER_EVENT_ADDR_MATCH, I2C_CLIENT_TRANSFER_EVENT_RX_READY, I2C_CLIENT_TRANSFER_EVENT_TX_READY, I2C_CLIENT_TRANSFER_EVENT_STOP_BIT_RECEIVED, I2C_CLIENT_TRANSFER_EVENT_ERROR }

  I2C notification event type.

• enum i2c_client_error_t { I2C_CLIENT_ERROR_NONE = 0, I2C_CLIENT_ERROR_BUS_COLLISION, I2C_CLIENT_ERROR_WRITE_COLLISION, I2C_CLIENT_ERROR_RECEIVE_OVERFLOW, I2C_CLIENT_ERROR_TRANSMIT_UNDERFLOW, I2C_CLIENT_ERROR_READ_UNDERFLOW }

  I2C client error type indicator.

I2C Generated Driver Types Header File

• static void I2C1_ReadStart (void)

• static void I2C1_WriteStart (void)

• static void I2C1_Close (void)

• static void I2C1_DefaultCallback (void)

• static void I2C1_StartSend (void)

• static void I2C1_AddrTransmit (uint8_t addr)

• static void I2C1_DataTransmit (uint8_t data)

• static uint8_t I2C1_DataReceive (void)

• static void I2C1_CounterSet (uint8_t counter)

• static uint8_t I2C1_CounterGet (void)

• static void I2C1_BusReset (void)

• static void I2C1_RestartEnable (void)

• static void I2C1_RestartDisable (void)

• static void I2C1_StopSend (void)

• static bool I2C1_IsNack (void)

• static bool I2C1_IsBusCol (void)

• static bool I2C1_IsBusTimeOut (void)

• static bool I2C1_IsData (void)

• static bool I2C1_IsAddr (void)

• static void I2C1_InterruptsEnable (void)

• static void I2C1_InterruptsDisable (void)

• static void I2C1_InterruptsClear (void)

• static void I2C1_ErrorFlagsClear (void)

• static void I2C1_BufferClear (void)

• void I2C1_Initialize (void)

  This routine initializes the I2C1 module. This routine must be called before any other I2C1 routine is called. This routine should only be called once during system initialization.

• void I2C1_Deinitialize (void)

  This routine Deinitializes the I2C1 module. This function disables the module.

• bool I2C1_Write (uint16_t address, uint8_t *data, size_t dataLength)

  This function writes data to a Client on the bus. The function will attempt to write length number of bytes from data buffer to a Client whose address is specified by address. The I2C Host will generate a Start condition,write the data and then generate a Stop Condition. If the Client NACK the request or a bus error was encountered on the bus, the transfer is terminated. The application can call the I2C1_ErrorGet() function to know that cause of the error.

• bool I2C1_Read (uint16_t address, uint8_t *data, size_t dataLength)

  This function reads the data from a Client on the bus. The function will attempt to read length number of bytes into data buffer from a Client whose address is specified as address. The I2C Host generate a Start condition, read the data and then generate a Stop Condition. If the Client NAKs the request or a bus error is encountered on the bus, the transfer is terminated. The application can call I2C1_ErrorGet() function to know that cause of the error.

• bool I2C1_WriteRead (uint16_t address, uint8_t *writeData, size_t writeLength, uint8_t *readData, size_t readLength)

  This function writes data from the writeData to the bus and then reads data from the Client and stores the received in the readData. The function generates a Start condition on the bus and will then send writeLength number of bytes contained in writeData. The function will then insert a Repeated start condition and proceed to read readLength number of bytes from the client. The received bytes are stored in readData buffer. A Stop condition is generated after the last byte has been received.

• i2c_host_error_t I2C1_ErrorGet (void)

  This function the error occurred during I2C Transmit and Receive. I2C1_Initialize() must have been called for the associated.

• bool I2C1_IsBusy (void)

  This API checks if I2C is busy. I2C must be initialized with I2C1_Initialize() before calling this API.

• void I2C1_CallbackRegister (void(*callbackHandler)(void))

  Setter function for I2C interrupt callback, This will be called when any error is generated.

• void I2C1_ISR ()

  This function is common ISR function for all I2C1 interrupts. I2C1_Initialize() must have been called for the associated.

• void I2C1_ERROR_ISR ()

  This function is common ISR function for all I2C1 Error interrupts. I2C1_Initialize() must have been called for the associated.

• void I2C1_RX_ISR ()

  This function is ISR function for I2C1 Receive interrupts.

• void I2C1_TX_ISR ()

  This function is ISR function for I2C1 Transmit interrupts.

• const i2c_host_interface_tI2C_Host

  External object for I2C_Host.

• static void(* I2C1_Callback )(void) = NULL

• volatile i2c_host_event_status_t i2c1Status = {0}

This file contains the driver code for I2C1 module.

I2C1 Generated Driver File

• void I2C1_Initialize (void)

  This API initializes the I2C1 driver. This routine initializes the I2C1 module. This routine must be called before any other I2C1 routine is called. This routine should only be called once during system initialization.

• void I2C1_Deinitialize (void)

  This API Deinitializes the I2C1 driver. This routine disables the I2C1 module.

• bool I2C1_Write (uint16_t address, uint8_t *data, size_t dataLength)

  This function writes data to a Client on the bus. The function will attempt to write length number of bytes from data buffer to a Client whose address is specified by address. The I2C Host will generate a Start condition,write the data and then generate a Stop Condition. If the Client NACK the request or a bus error was encountered on the bus, the transfer is terminated. The application can call the I2C1_ErrorGet() function to know that cause of the error.

• bool I2C1_Read (uint16_t address, uint8_t *data, size_t dataLength)

  This function reads the data from a Client on the bus. The function will attempt to read length number of bytes into data buffer from a Client whose address is specified as address. The I2C Host generate a Start condition, read the data and then generate a Stop Condition. If the Client NAKs the request or a bus error is encountered on the bus, the transfer is terminated. The application can call I2C1_ErrorGet() function to know that cause of the error.

• bool I2C1_WriteRead (uint16_t address, uint8_t *writeData, size_t writeLength, uint8_t *readData, size_t readLength)

  This function writes data from the writeData to the bus and then reads data from the Client and stores the received in the readData. The function generates a Start condition on the bus and will then send writeLength number of bytes contained in writeData. The function will then insert a Repeated start condition and proceed to read readLength number of bytes from the client. The received bytes are stored in readData buffer. A Stop condition is generated after the last byte has been received.

• i2c_host_error_t I2C1_ErrorGet (void)

  This function get the error occurred during I2C Transmit and Receive.

• bool I2C1_IsBusy (void)

  This API checks if I2C is busy. I2C must be initialized with I2C1_Initialize() before calling this API.

• void I2C1_CallbackRegister (void(*callbackHandler)(void))

  Setter function for I2C interrupt callback, This will be called when any error is generated.

• void I2C1_ISR (void)

  This function is ISR function for I2C1 Common interrupts.

• void I2C1_ERROR_ISR (void)

  This function is ISR function for I2C1 Error interrupts.

• void I2C1_RX_ISR (void)

  This function is ISR function for I2C1 Receive interrupts.

• void I2C1_TX_ISR (void)

  This function is ISR function for I2C1 Transmit interrupts.

• #define i2c_host_host_interfaceI2C_Host

• #define I2C_Host_InitializeI2C1_Initialize

• #define I2C_Host_DeinitializeI2C1_Deinitialize

• #define I2C_Host_WriteI2C1_Write

• #define I2C_Host_ReadI2C1_Read

• #define I2C_Host_WriteReadI2C1_WriteRead

• #define I2C_Host_ErrorGetI2C1_ErrorGet

• #define I2C_Host_CallbackRegisterI2C1_CallbackRegister

• #define I2C_Host_IsBusyI2C1_IsBusy

• const i2c_host_interface_tI2C_Host

  External object for I2C_Host.

I2C1 Generated Driver API Header File

• static void I2C1_ReadStart (void)

• static void I2C1_WriteStart (void)

• static void I2C1_Close (void)

• static void I2C1_DefaultCallback (void)

• static void I2C1_StartSend (void)

• static void I2C1_AddrTransmit (uint8_t addr)

• static void I2C1_DataTransmit (uint8_t data)

• static uint8_t I2C1_DataReceive (void)

• static void I2C1_CounterSet (uint8_t counter)

• static uint8_t I2C1_CounterGet (void)

• static void I2C1_BusReset (void)

• static void I2C1_RestartEnable (void)

• static void I2C1_RestartDisable (void)

• static void I2C1_StopSend (void)

• static bool I2C1_IsNack (void)

• static bool I2C1_IsBusCol (void)

• static bool I2C1_IsBusTimeOut (void)

• static bool I2C1_IsData (void)

• static bool I2C1_IsAddr (void)

• static void I2C1_InterruptsClear (void)

• static void I2C1_ErrorFlagsClear (void)

• static void I2C1_BufferClear (void)

• void I2C1_Initialize (void)

  This routine initializes the I2C1 module. This routine must be called before any other I2C1 routine is called. This routine should only be called once during system initialization.

• void I2C1_Deinitialize (void)

  This routine Deinitializes the I2C1 module. This function disables the module.

• bool I2C1_Write (uint16_t address, uint8_t *data, size_t dataLength)

  This function writes data to a Client on the bus. The function will attempt to write length number of bytes from data buffer to a Client whose address is specified by address. The I2C Host will generate a Start condition,write the data and then generate a Stop Condition. If the Client NACK the request or a bus error was encountered on the bus, the transfer is terminated. The application can call the I2C1_ErrorGet() function to know that cause of the error.

• bool I2C1_Read (uint16_t address, uint8_t *data, size_t dataLength)

  This function reads the data from a Client on the bus. The function will attempt to read length number of bytes into data buffer from a Client whose address is specified as address. The I2C Host generate a Start condition, read the data and then generate a Stop Condition. If the Client NAKs the request or a bus error is encountered on the bus, the transfer is terminated. The application can call I2C1_ErrorGet() function to know that cause of the error.

• bool I2C1_WriteRead (uint16_t address, uint8_t *writeData, size_t writeLength, uint8_t *readData, size_t readLength)

  This function writes data from the writeData to the bus and then reads data from the Client and stores the received in the readData. The function generates a Start condition on the bus and will then send writeLength number of bytes contained in writeData. The function will then insert a Repeated start condition and proceed to read readLength number of bytes from the client. The received bytes are stored in readData buffer. A Stop condition is generated after the last byte has been received.

• i2c_host_error_t I2C1_ErrorGet (void)

  This function the error occurred during I2C Transmit and Receive. I2C1_Initialize() must have been called for the associated.

• bool I2C1_IsBusy (void)

  This API checks if I2C is busy. I2C must be initialized with I2C1_Initialize() before calling this API.

• void I2C1_CallbackRegister (void(*callbackHandler)(void))

  Setter function for I2C interrupt callback, This will be called when any error is generated.

• void I2C1_Tasks (void)

  his function is common Polling function for all I2C1 client. I2C1_Initialize() must have been called for the associated.

• const i2c_host_interface_tI2C_Host

  External object for I2C_Host.

• static void(* I2C1_Callback )(void) = NULL

• volatile i2c_host_event_status_t i2c1Status = {0}

This file contains the driver code for I2C1 module.

I2C1 Generated Driver File

• void I2C1_Initialize (void)

  This API initializes the I2C1 driver. This routine initializes the I2C1 module. This routine must be called before any other I2C1 routine is called. This routine should only be called once during system initialization.

• void I2C1_Deinitialize (void)

  This API Deinitializes the I2C1 driver. This routine disables the I2C1 module.

• bool I2C1_Write (uint16_t address, uint8_t *data, size_t dataLength)

  This function writes data to a Client on the bus. The function will attempt to write length number of bytes from data buffer to a Client whose address is specified by address. The I2C Host will generate a Start condition,write the data and then generate a Stop Condition. If the Client NACK the request or a bus error was encountered on the bus, the transfer is terminated. The application can call the I2C1_ErrorGet() function to know that cause of the error.

• bool I2C1_Read (uint16_t address, uint8_t *data, size_t dataLength)

  This function reads the data from a Client on the bus. The function will attempt to read length number of bytes into data buffer from a Client whose address is specified as address. The I2C Host generate a Start condition, read the data and then generate a Stop Condition. If the Client NAKs the request or a bus error is encountered on the bus, the transfer is terminated. The application can call I2C1_ErrorGet() function to know that cause of the error.

• bool I2C1_WriteRead (uint16_t address, uint8_t *writeData, size_t writeLength, uint8_t *readData, size_t readLength)

  This function writes data from the writeData to the bus and then reads data from the Client and stores the received in the readData. The function generates a Start condition on the bus and will then send writeLength number of bytes contained in writeData. The function will then insert a Repeated start condition and proceed to read readLength number of bytes from the client. The received bytes are stored in readData buffer. A Stop condition is generated after the last byte has been received.

• i2c_host_error_t I2C1_ErrorGet (void)

  This function get the error occurred during I2C Transmit and Receive.

• bool I2C1_IsBusy (void)

  This API checks if I2C is busy. I2C must be initialized with I2C1_Initialize() before calling this API.

• void I2C1_CallbackRegister (void(*callbackHandler)(void))

  Setter function for I2C interrupt callback, This will be called when any error is generated.

• void I2C1_Tasks (void)

  This is polling function for non interrupt mode.

• #define i2c_host_host_interfaceI2C_Host

• #define I2C_Host_InitializeI2C1_Initialize

• #define I2C_Host_DeinitializeI2C1_Deinitialize

• #define I2C_Host_WriteI2C1_Write

• #define I2C_Host_ReadI2C1_Read

• #define I2C_Host_WriteReadI2C1_WriteRead

• #define I2C_Host_ErrorGetI2C1_ErrorGet

• #define I2C_Host_CallbackRegisterI2C1_CallbackRegister

• #define I2C_Host_IsBusyI2C1_IsBusy

• #define I2C_Host_TasksI2C1_Tasks

• const i2c_host_interface_tI2C_Host

  External object for I2C_Host.

I2C1 Generated Driver API Header File