4.9.1 I2C

• struct i2c_client_interface_t

  This structure contains the portable interfaces for I2C client.

• enum i2c_event_states_t { I2C_STATE_IDLE = 0, I2C_STATE_SEND_RD_ADDR, I2C_STATE_SEND_WR_ADDR, I2C_STATE_TX, I2C_STATE_RX, I2C_STATE_NACK, I2C_STATE_ERROR, I2C_STATE_STOP, I2C_STATE_RESET, I2C_STATE_IDLE = 0, I2C_STATE_SEND_RD_ADDR, I2C_STATE_SEND_WR_ADDR, I2C_STATE_TX, I2C_STATE_RX, I2C_STATE_NACK, I2C_STATE_ERROR, I2C_STATE_STOP, I2C_STATE_RESET }

  Enumeration for I2C states.

enum enum i2c_event_states_t

Enumeration for I2C states.

• struct i2c_host_interface_t

  This structure contains the portable interfaces for I2C host.

• void TWI0_Initialize (void)

  Initializes the TWI0 module based on the configurable options in the MPLAB® Code Configurator (MCC) Melody UI.

• void TWI0_Deinitialize (void)

  Resets the registers to their default Power-on Reset (POR) values.

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

  Writes data to a client on the bus. The function will attempt to write the length number of bytes from the data buffer to a client whose address is specified by the address argument.

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

  Reads data from an I2C client on the bus. Ensure the TWI0 host is initialized using TWI0_Initialize() before invoking this function.

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

  Writes data from the writeData to the bus and then reads the data from the client. After that, it stores the received data in the readData.

• i2c_host_error_t TWI0_ErrorGet (void)

  Retrieves the error that occurred during I2C transmission and reception. Ensure the TWI0 host is initialized using TWI0_Initialize() before invoking this function.  

• bool TWI0_IsBusy (void)

  This API checks if I2C is busy.

• void TWI0_CallbackRegister (void(*callbackHandler)(void))

  Setter function for the TWI interrupt callback. This will be called when any error is generated.

• void TWI0_ErrorCallbackRegister (void(*handler)(void))

  Setter function for the TWI error interrupt callback.

• void TWI0_Tasks (void)

  Handles TWI tasks when peripheral interrupts are disabled.  

  This function must be called in application.

void TWI0_CallbackRegister (void(*)(void) callbackHandler)

Setter function for the TWI interrupt callback. This will be called when any error is generated.

void TWI0_Deinitialize (void )

Resets the registers to their default Power-on Reset (POR) values.

void TWI0_ErrorCallbackRegister (void(*)(void) handler)

Setter function for the TWI error interrupt callback.

i2c_host_error_t TWI0_ErrorGet (void )

Retrieves the error that occurred during I2C transmission and reception. Ensure the TWI0 host is initialized using TWI0_Initialize() before invoking this function.  

This function the error occurred during I2C Transmit and Receive.

void TWI0_Initialize (void )

Initializes the TWI0 module based on the configurable options in the MPLAB® Code Configurator (MCC) Melody UI.

bool TWI0_IsBusy (void )

This API checks if I2C is busy.

bool TWI0_Read (uint16_t address, uint8_t * data, size_t dataLength)

Reads data from an I2C client on the bus. Ensure the TWI0 host is initialized using TWI0_Initialize() before invoking this function.

This function attempts to read a specified number of bytes received from the I2C client with the given address into the data buffer. The I2C Host initiates a Start condition, reads the data, and then generates a Stop condition. If the client NAKs the request or a bus error occurs, the transfer is terminated. The application can call the TWI0_ErrorGet() function to determine the cause of the error.

This function is non-blocking; it starts the bus activity and returns immediately. The transfer is completed in the peripheral interrupt. In Polling mode, the user must call TWI0_Tasks within the while loop. A new transfer request cannot be initiated while another transfer is in progress. Calling this function during an ongoing transfer will result in the function returning false.

void TWI0_Tasks (void )

Handles TWI tasks when peripheral interrupts are disabled.  

bool TWI0_Write (uint16_t address, uint8_t * data, size_t dataLength)

Writes data to a client on the bus. The function will attempt to write the length number of bytes from the data buffer to a client whose address is specified by the address argument.

The TWI host will generate a Start condition, write the data and then generate a Stop condition. If the client NAKs the request or a bus error was encountered on the bus, the transfer is terminated. The application can call the TWI0_ErrorGet() function to check the cause of the error. The function is non-blocking, initiating the bus activity and returning immediately. The transfer is then completed in the peripheral interrupt. For the Polling mode, the user has to call TWI0_Tasks in the while loop. A transfer request cannot be placed when another transfer is in progress. Calling this function when another function is already in progress will cause the function to return false.

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

Writes data from the writeData to the bus and then reads the data from the client. After that, it stores the received data in the readData.

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

If the client NAKs the request or a bus error was encountered on the bus, the transfer is terminated. The application will call the TWI0_ErrorGet() function to know the cause of the error.

The function is non-blocking, initiating the bus activity and returning immediately. The transfer is then completed in the peripheral interrupt. For the Polling mode, the user has to call TWI0_Tasks in the while loop. A transfer request cannot be placed when another transfer is in progress. Calling this function when another function is already in progress will cause the function to return false.

• struct I2C_TRANSFER_SETUP

  Structure for clock configurations.

• enum i2c_host_error_t { I2C_ERROR_NONE, I2C_ERROR_ADDR_NACK, I2C_ERROR_DATA_NACK, I2C_ERROR_BUS_COLLISION, I2C_ERROR_NONE, I2C_ERROR_ADDR_NACK, I2C_ERROR_DATA_NACK, I2C_ERROR_BUS_COLLISION }

  Enumeration for the potential error types in the I2C host driver.

enum enum i2c_host_error_t

Enumeration for the potential error types in the I2C host driver.

• void(* Initialize )(void)

  Pointer to the function that initializes the I2C client.

• void(* Deinitialize )(void)

  Pointer to the function that deinitializes the I2C client.

• void(* WriteByte )(uint8_t data)

  Pointer to the function that sends data to a host on bus.

• uint8_t(* ReadByte )(void)

  Pointer to the function that reads data from a host on bus.

• i2c_client_error_t(* ErrorGet )(void)

  Pointer to the function that returns the last error that occurred on the I2C bus.

• i2c_client_transfer_dir_t(* TransferDirGet )(void)

  Pointer to the function that returns the direction of data transfer between client and a host on bus.

• i2c_client_ack_status_t(* LastByteAckStatusGet )(void)

  Pointer to the function that retrieves the acknowledgment status of the last byte transferred.

• void(* CallbackRegister )(bool(*handler)(i2c_client_transfer_event_t clientEvent))

  Pointer to the function that registers a callback handler for I2C client.

• void(* Tasks )(void)

  Pointer to the function that is polled for I2C client events.

void(* CallbackRegister

Pointer to the function that registers a callback handler for I2C client.

void(* Deinitialize

Pointer to the function that deinitializes the I2C client.

i2c_client_error_t(* ErrorGet

Pointer to the function that returns the last error that occurred on the I2C bus.

void(* Initialize

Pointer to the function that initializes the I2C client.

i2c_client_ack_status_t(* LastByteAckStatusGet

Pointer to the function that retrieves the acknowledgment status of the last byte transferred.

uint8_t(* ReadByte

Pointer to the function that reads data from a host on bus.

void(* Tasks

Pointer to the function that is polled for I2C client events.

i2c_client_transfer_dir_t(* TransferDirGet

Pointer to the function that returns the direction of data transfer between client and a host on bus.

void(* WriteByte

Pointer to the function that sends data to a host on bus.

uint16_t address

bool busy

i2c_host_error_t errorState

size_t readLength

uint8_t * readPtr

i2c_event_states_t state

bool switchToRead

size_t writeLength

uint8_t * writePtr

• void(* Initialize )(void)

  Pointer to the function that initializes the I2C host, setting up any necessary hardware or software resources.

• void(* Deinitialize )(void)

  Pointer to the function that deinitializes the I2C host, by resetting the I2C registers to Power On Default (POR) values.

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

  Pointer to the write function of the I2C host.

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

  Pointer to the read function of the I2C host.

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

  Pointer to the write and read function of the I2C host.

• bool(* TransferSetup )(struct i2c_transfer_setup *setup, uint32_t srcClkFreq)

  Pointer to the function that sets up the transfer parameters of the I2C host.

• i2c_host_error_t(* ErrorGet )(void)

  Pointer to the function that returns the last error that occurred on the I2C bus.

• bool(* IsBusy )(void)

  Pointer to the function that checks if the I2C bus is busy.

• void(* CallbackRegister )(void(*callback)(void))

  Pointer to the function that Registers a callback function for I2C events.

• void(* Tasks )(void)

  Pointer to the function that is polled for I2C host events.

void(* CallbackRegister

Pointer to the function that Registers a callback function for I2C events.

void(* Deinitialize

Pointer to the function that deinitializes the I2C host, by resetting the I2C registers to Power On Default (POR) values.

i2c_host_error_t(* ErrorGet

Pointer to the function that returns the last error that occurred on the I2C bus.

void(* Initialize

Pointer to the function that initializes the I2C host, setting up any necessary hardware or software resources.

bool(* IsBusy

Pointer to the function that checks if the I2C bus is busy.

bool(* Read

Pointer to the read function of the I2C host.

void(* Tasks

Pointer to the function that is polled for I2C host events.

bool(* TransferSetup

Pointer to the function that sets up the transfer parameters of the I2C host.

bool(* Write

Pointer to the write function of the I2C host.

bool(* WriteRead

Pointer to the write and read function of the I2C host.

enum i2c_client_ack_status_t

Enumeration for the I2C client driver ACK/NACK status.

enum i2c_client_error_t

Enumeration defining the potential error types in the I2C client driver.

enum i2c_client_transfer_dir_t

Enumeration for the data direction of the I2C client driver.

enum i2c_client_transfer_event_t

Enumeration for the types of I2C events.

enum i2c_client_ack_status_t

enum i2c_client_error_t

enum i2c_client_transfer_dir_t

enum i2c_client_transfer_event_t

ISR (TWI0_TWIS_vect )

MISRA C:2012 Deviation Advisory: misra-c2012-2.7  

@misradeviation{Required:,8.2,Required:,8.4} False positive - ISR is a pre-processor macro defined in interrupt.h. The CPP Checker wrongly treats ISR as a function and expects a declaration to be available.

void TWI0_CallbackRegister (bool(*)(i2c_client_transfer_event_t clientEvent) callback)

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

static void TWI0_ErrorEventHandler (void )[static]

static void TWI0_EventHandler (void )[static]

i2c_client_ack_status_t TWI0_LastByteAckStatusGet (void )

Returns the I2C Host ACK status. TWI0 must be intitialized with TWI0_Initialize() before calling this API.

uint16_t TWI0_ReadAddr (void )

Reads the requested address from a host on the bus. TWI0 must be intitialized with TWI0_Initialize() before calling this API.

uint8_t TWI0_ReadByte (void )

Reads data from a host on the bus. TWI0 must be intitialized with TWI0_Initialize() before calling this API.

i2c_client_transfer_dir_t TWI0_TransferDirGet (void )

Returns the I2C Transfer direction. TWI0 must be intitialized with TWI0_Initialize() before calling this API.

void TWI0_WriteByte (uint8_t wrByte)

Writes data to a host on the bus. TWI0 must be intitialized with TWI0_Initialize() before calling this API.

const i2c_client_interface_t I2C2_Client

Initial value:

= 
{
    .Initialize = TWI0_Initialize,
    .Deinitialize = TWI0_Deinitialize,
    .WriteByte = TWI0_WriteByte,
    .ReadByte = TWI0_ReadByte,
    .TransferDirGet = TWI0_TransferDirGet,
    .LastByteAckStatusGet = TWI0_LastByteAckStatusGet,
    .ErrorGet = TWI0_ErrorGet,
    .CallbackRegister = TWI0_CallbackRegister,
    .Tasks = NULL
}

@misradeviation {Advisory:,8.7} False postive - A few MCC generated driver APIs are made available to users through external linkage. This rule ID has been disabled at the project level due to numerous instances across various files. Consequently, in the application project, this rule ID should be disabled in the MPLAB-X IDE by navigating to Tools -> Options -> Embedded -> MISRA Check.

bool(* TWI0_InterruptHandler) (i2c_client_transfer_event_t clientEvent)[static]

volatile i2c_client_error_t twi0ErrorState[static]

static i2c_event_states_t I2C_EVENT_ERROR (void )[static]

static i2c_event_states_t I2C_EVENT_IDLE (void )[static]

static i2c_event_states_t I2C_EVENT_NACK (void )[static]

static i2c_event_states_t I2C_EVENT_RESET (void )[static]

static i2c_event_states_t I2C_EVENT_RX (void )[static]

static i2c_event_states_t I2C_EVENT_SEND_RD_ADDR (void )[static]

static i2c_event_states_t I2C_EVENT_SEND_WR_ADDR (void )[static]

static i2c_event_states_t I2C_EVENT_STOP (void )[static]

static i2c_event_states_t I2C_EVENT_TX (void )[static]

ISR (TWI0_TWIM_vect )

MISRA C:2012 Deviation Advisory: misra-c2012-2.7  

@misradeviation{Required:,8.2,Required:,8.4} False positive - ISR is a pre-processor macro defined in interrupt.h. The CPP Checker wrongly treats ISR as a function and expects a declaration to be available.

MISRA C:2012 Deviation Required: misra-c2012-5.5  

static void TWI0_Close (void )[static]

@misradeviation {Advisory:,8.7} Some Melody-generated driver APIs are made available to users through external linkage. Users have the option to add these APIs in the application.This rule ID is disabled at project level due to its multiple occurrences in several files.Therefore, in the application project, this rule ID must be disabled in the MPLAB-X IDE from Tools -> Options -> Embedded -> MISRA Check.

static void TWI0_ErrorEventHandler (void )[static]

static void TWI0_EventHandler (void )[static]

static void TWI0_ReadStart (void )[static]

Section: Private Interfaces

static void TWI0_WriteStart (void )[static]

const i2c_host_interface_t I2C2_Host

Initial value:

= 
{
  .Initialize = TWI0_Initialize,
  .Deinitialize = TWI0_Deinitialize,
  .Write = TWI0_Write,
  .Read = TWI0_Read,
  .WriteRead = TWI0_WriteRead,
  .TransferSetup = NULL,
  .ErrorGet = TWI0_ErrorGet,
  .IsBusy = TWI0_IsBusy,
  .CallbackRegister = TWI0_CallbackRegister,
  .Tasks = NULL
}

Section: Driver Interface

void(* TWI0_Callback) (void)[static]

Section: Private Variable Definitions

const twi0eventHandler twi0_eventTable[]

Initial value:

= 
{
    I2C_EVENT_IDLE,
    I2C_EVENT_SEND_RD_ADDR,
    I2C_EVENT_SEND_WR_ADDR,
    I2C_EVENT_TX,
    I2C_EVENT_RX,
    I2C_EVENT_NACK,
    I2C_EVENT_ERROR,
    I2C_EVENT_STOP,
    I2C_EVENT_RESET
}

volatile i2c_event_status_t twi0_Status = {0}

void TWI0_CallbackRegister (bool(*)(i2c_client_transfer_event_t clientEvent) callback)

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

static void TWI0_ErrorEventHandler (void )[static]

static void TWI0_EventHandler (void )[static]

i2c_client_ack_status_t TWI0_LastByteAckStatusGet (void )

Returns the I2C Host ACK status. TWI0 must be intitialized with TWI0_Initialize() before calling this API.

uint16_t TWI0_ReadAddr (void )

Reads the requested address from a host on the bus. TWI0 must be intitialized with TWI0_Initialize() before calling this API.

uint8_t TWI0_ReadByte (void )

Reads data from a host on the bus. TWI0 must be intitialized with TWI0_Initialize() before calling this API.

i2c_client_transfer_dir_t TWI0_TransferDirGet (void )

Returns the I2C Transfer direction. TWI0 must be intitialized with TWI0_Initialize() before calling this API.

void TWI0_WriteByte (uint8_t wrByte)

Writes data to a host on the bus. TWI0 must be intitialized with TWI0_Initialize() before calling this API.

const i2c_client_interface_t I2C1_Client

Initial value:

= 
{
    .Initialize = TWI0_Initialize,
    .Deinitialize = TWI0_Deinitialize,
    .WriteByte = TWI0_WriteByte,
    .ReadByte = TWI0_ReadByte,
    .TransferDirGet = TWI0_TransferDirGet,
    .LastByteAckStatusGet = TWI0_LastByteAckStatusGet,
    .ErrorGet = TWI0_ErrorGet,
    .CallbackRegister = TWI0_CallbackRegister,
    .Tasks = TWI0_Tasks
}

@misradeviation {Advisory:,8.7} False postive - A few MCC generated driver APIs are made available to users through external linkage. This rule ID has been disabled at the project level due to numerous instances across various files. Consequently, in the application project, this rule ID should be disabled in the MPLAB-X IDE by navigating to Tools -> Options -> Embedded -> MISRA Check.

bool(* TWI0_InterruptHandler) (i2c_client_transfer_event_t clientEvent)[static]

volatile i2c_client_error_t twi0ErrorState[static]

static i2c_event_states_t I2C_EVENT_ERROR (void )[static]

static i2c_event_states_t I2C_EVENT_IDLE (void )[static]

static i2c_event_states_t I2C_EVENT_NACK (void )[static]

static i2c_event_states_t I2C_EVENT_RESET (void )[static]

static i2c_event_states_t I2C_EVENT_RX (void )[static]

static i2c_event_states_t I2C_EVENT_SEND_RD_ADDR (void )[static]

static i2c_event_states_t I2C_EVENT_SEND_WR_ADDR (void )[static]

static i2c_event_states_t I2C_EVENT_STOP (void )[static]

static i2c_event_states_t I2C_EVENT_TX (void )[static]

static void TWI0_Close (void )[static]

@misradeviation {Advisory:,8.7} Some Melody-generated driver APIs are made available to users through external linkage. Users have the option to add these APIs in the application.This rule ID is disabled at project level due to its multiple occurrences in several files.Therefore, in the application project, this rule ID must be disabled in the MPLAB-X IDE from Tools -> Options -> Embedded -> MISRA Check.

static void TWI0_ErrorEventHandler (void )[static]

static void TWI0_EventHandler (void )[static]

static void TWI0_ReadStart (void )[static]

Section: Private Interfaces

static void TWI0_WriteStart (void )[static]

const i2c_host_interface_t I2C1_Host

Initial value:

= 
{
  .Initialize = TWI0_Initialize,
  .Deinitialize = TWI0_Deinitialize,
  .Write = TWI0_Write,
  .Read = TWI0_Read,
  .WriteRead = TWI0_WriteRead,
  .TransferSetup = NULL,
  .ErrorGet = TWI0_ErrorGet,
  .IsBusy = TWI0_IsBusy,
  .CallbackRegister = TWI0_CallbackRegister,
  .Tasks = TWI0_Tasks
}

Section: Driver Interface

void(* TWI0_Callback) (void)[static]

Section: Private Variable Definitions

const twi0eventHandler twi0_eventTable[]

Initial value:

= 
{
    I2C_EVENT_IDLE,
    I2C_EVENT_SEND_RD_ADDR,
    I2C_EVENT_SEND_WR_ADDR,
    I2C_EVENT_TX,
    I2C_EVENT_RX,
    I2C_EVENT_NACK,
    I2C_EVENT_ERROR,
    I2C_EVENT_STOP,
    I2C_EVENT_RESET
}

volatile i2c_event_status_t twi0_Status = {0}

void TWI0_CallbackRegister (bool(*)(i2c_client_transfer_event_t clientEvent) callback)

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

void TWI0_Deinitialize (void )

Sets the registers to Power-on Reset (POR) values.

i2c_client_error_t TWI0_ErrorGet (void )

This function the error occurred during I2C Transmit and Receive.

This function the error occurred during I2C Transmit and Receive.

void TWI0_Initialize (void )

Initializes the TWI0 module based on the configurable options in the MPLAB® Code Configurator (MCC) Melody UI.

i2c_client_ack_status_t TWI0_LastByteAckStatusGet (void )

Returns the I2C Host ACK status. TWI0 must be intitialized with TWI0_Initialize() before calling this API.

uint16_t TWI0_ReadAddr (void )

Reads the requested address from a host on the bus. TWI0 must be intitialized with TWI0_Initialize() before calling this API.

uint8_t TWI0_ReadByte (void )

Reads data from a host on the bus. TWI0 must be intitialized with TWI0_Initialize() before calling this API.

i2c_client_transfer_dir_t TWI0_TransferDirGet (void )

Returns the I2C Transfer direction. TWI0 must be intitialized with TWI0_Initialize() before calling this API.

void TWI0_WriteByte (uint8_t wrByte)

Writes data to a host on the bus. TWI0 must be intitialized with TWI0_Initialize() before calling this API.

#define I2C2_Client_CallbackRegister TWI0_CallbackRegister

#define i2c2_client_client_interface I2C2_Client

@misradeviation {Advisory:,2.5} False positive - A few macros in this file are used as arguments but are not getting recognized by the tool. This rule ID has been disabled at the project level due to numerous instances across various files. Consequently, in the application project, this rule ID should be disabled in the MPLAB-X IDE by navigating to Tools -> Options -> Embedded -> MISRA Check.

#define I2C2_Client_Deinitialize TWI0_Deinitialize

#define I2C2_Client_ErrorGet TWI0_ErrorGet

#define I2C2_Client_Initialize TWI0_Initialize

#define I2C2_Client_LastByteAckStatusGet TWI0_LastByteAckStatusGet

#define I2C2_Client_ReadAddr TWI0_ReadAddr

#define I2C2_Client_ReadByte TWI0_ReadByte

#define I2C2_Client_TransferDirGet TWI0_TransferDirGet

#define I2C2_Client_WriteByte TWI0_WriteByte

const i2c_client_interface_t I2C2_Client

@misradeviation {Advisory:,8.7} False postive - A few MCC generated driver APIs are made available to users through external linkage. This rule ID has been disabled at the project level due to numerous instances across various files. Consequently, in the application project, this rule ID should be disabled in the MPLAB-X IDE by navigating to Tools -> Options -> Embedded -> MISRA Check.

#define I2C2_Host_CallbackRegister TWI0_CallbackRegister

#define I2C2_Host_Deinitialize TWI0_Deinitialize

#define I2C2_Host_ErrorGet TWI0_ErrorGet

#define i2c2_host_host_interface I2C2_Host

@misradeviation {Advisory:,2.5} False positive - This rule ID has been disabled at the project level due to numerous instances across various files, particularly for false positives where macros used as arguments are not recognized by the tool. Consequently, in the application project, this rule ID should be disabled in the MPLAB-X IDE by navigating to Tools -> Options -> Embedded -> MISRA Check. Section: Data Type Definitions

#define I2C2_Host_Initialize TWI0_Initialize

#define I2C2_Host_IsBusy TWI0_IsBusy

#define I2C2_Host_Read TWI0_Read

#define I2C2_Host_Write TWI0_Write

#define I2C2_Host_WriteRead TWI0_WriteRead

#define TWI0_BAUD( F_SCL, T_RISE) ((((((float)3333333 / (float)(F_SCL))) - 10 - ((float)3333333 * (T_RISE) / 1000000U))) / 2)

const i2c_host_interface_t I2C2_Host

Section: Data Type Definitions

Section: Driver Interface

void TWI0_CallbackRegister (bool(*)(i2c_client_transfer_event_t clientEvent) callback)

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

i2c_client_ack_status_t TWI0_LastByteAckStatusGet (void )

Returns the I2C Host ACK status. TWI0 must be intitialized with TWI0_Initialize() before calling this API.

uint16_t TWI0_ReadAddr (void )

Reads the requested address from a host on the bus. TWI0 must be intitialized with TWI0_Initialize() before calling this API.

uint8_t TWI0_ReadByte (void )

Reads data from a host on the bus. TWI0 must be intitialized with TWI0_Initialize() before calling this API.

void TWI0_Tasks (void )

Polling function for all TWI0 clients. TWI0 must be intitialized with TWI0_Initialize() before calling this API.

i2c_client_transfer_dir_t TWI0_TransferDirGet (void )

Returns the I2C Transfer direction. TWI0 must be intitialized with TWI0_Initialize() before calling this API.

void TWI0_WriteByte (uint8_t wrByte)

Writes data to a host on the bus. TWI0 must be intitialized with TWI0_Initialize() before calling this API.

#define I2C1_Client_CallbackRegister TWI0_CallbackRegister

#define i2c1_client_client_interface I2C1_Client

@misradeviation {Advisory:,2.5} False positive - A few macros in this file are used as arguments but are not getting recognized by the tool. This rule ID has been disabled at the project level due to numerous instances across various files. Consequently, in the application project, this rule ID should be disabled in the MPLAB-X IDE by navigating to Tools -> Options -> Embedded -> MISRA Check.

#define I2C1_Client_Deinitialize TWI0_Deinitialize

#define I2C1_Client_ErrorGet TWI0_ErrorGet

#define I2C1_Client_Initialize TWI0_Initialize

#define I2C1_Client_LastByteAckStatusGet TWI0_LastByteAckStatusGet

#define I2C1_Client_ReadAddr TWI0_ReadAddr

#define I2C1_Client_ReadByte TWI0_ReadByte

#define I2C1_Client_Tasks TWI0_Tasks

#define I2C1_Client_TransferDirGet TWI0_TransferDirGet

#define I2C1_Client_WriteByte TWI0_WriteByte

const i2c_client_interface_t I2C1_Client

@misradeviation {Advisory:,8.7} False postive - A few MCC generated driver APIs are made available to users through external linkage. This rule ID has been disabled at the project level due to numerous instances across various files. Consequently, in the application project, this rule ID should be disabled in the MPLAB-X IDE by navigating to Tools -> Options -> Embedded -> MISRA Check.

#define I2C1_Host_CallbackRegister TWI0_CallbackRegister

#define I2C1_Host_Deinitialize TWI0_Deinitialize

#define I2C1_Host_ErrorGet TWI0_ErrorGet

#define i2c1_host_host_interface I2C1_Host

@misradeviation {Advisory:,2.5} False positive - This rule ID has been disabled at the project level due to numerous instances across various files, particularly for false positives where macros used as arguments are not recognized by the tool. Consequently, in the application project, this rule ID should be disabled in the MPLAB-X IDE by navigating to Tools -> Options -> Embedded -> MISRA Check. Section: Data Type Definitions

#define I2C1_Host_Initialize TWI0_Initialize

#define I2C1_Host_IsBusy TWI0_IsBusy

#define I2C1_Host_Read TWI0_Read

#define I2C1_Host_Tasks TWI0_Tasks

#define I2C1_Host_Write TWI0_Write

#define I2C1_Host_WriteRead TWI0_WriteRead

#define TWI0_BAUD( F_SCL, T_RISE) ((((((float)3333333 / (float)(F_SCL))) - 10 - ((float)3333333 * (T_RISE) / 1000000U))) / 2)

const i2c_host_interface_t I2C1_Host

Section: Data Type Definitions

Section: Driver Interface

#define I2C_EVENTS (9)

typedef i2c_event_states_t(* twi0eventHandler) (void)

const twi0eventHandler twi0_eventTable[I2C_EVENTS]

volatile i2c_event_status_t twi0_Status

#define I2C_EVENTS (9)

typedef i2c_event_states_t(* twi0eventHandler) (void)

enum i2c_event_states_t

const twi0eventHandler twi0_eventTable[I2C_EVENTS]

volatile i2c_event_status_t twi0_Status

typedef struct i2c_transfer_setup i2c_host_transfer_setup_t

@misradeviation{Advisory:,2.4,Advisory:,2.3}These declarations provided by the Melody-generated drivers for the user's application. It is up to the user if these declarations will be implemented in their application.

typedef struct i2c_transfer_setup i2c_host_transfer_setup_t

@misradeviation{Advisory:,2.4,Advisory:,2.3}These declarations provided by the Melody-generated drivers for the user's application. It is up to the user if these declarations will be implemented in their application.

enum i2c_host_error_t