4.9.2 I2C with Dual Mode Operation

• struct i2c_client_interface_t

  This structure contains the portable interfaces for I2C client.

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

  Enumeration to determine the direction of data transfer initiated by the host, as determined by the I2Cx_TransferDirGet function.

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

  Enumeration for acknowledgment and non-acknowledgment status.

• 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}

  Enumeration defining the various I2C event types.

• enum i2c_client_error_t { I2C_CLIENT_ERROR_NONE = 0, I2C_CLIENT_ERROR_BUS_ERROR, I2C_CLIENT_ERROR_COLLISION}

  Enumeration that specifies the possible errors in the I2C client driver.

• ISR (TWI0_TWIS_vect)

  Common Interrupt Service Routine (ISR) for all TWI0 interrupts. Initialize TWI0 with TWI0_Initialize() before calling this API.  

  This API calls the TWI0_ErrorEventHandler() if an error flag is set, else calls TWI0_EventHandler() for other TWI transmit and receive events.

• void TWI0_Initialize (void)

  Initializes the TWI0 client module according to the settings specified in the MPLAB® Code Configurator Melody UI.

• void TWI0_Deinitialize (void)

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

• void TWI0_WriteByte (uint8_t data)

  Sends data to a host on the bus. Ensure TWI0 is initialized using TWI0_Initialize() before invoking this function.

• uint8_t TWI0_ReadByte (void)

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

• uint16_t TWI0_ReadAddr (void)

  Retrieves the most recently matched address received from the host. Ensure TWI0 client is initialized using TWI0_Initialize() before invoking this function.

• i2c_client_error_t TWI0_ErrorGet (void)

  Retrieves the type of error that occurred during I2C communication. Ensure TWI0 is initialized using TWI0_Initialize() before invoking this function.

• i2c_client_transfer_dir_t TWI0_TransferDirGet (void)

  Retrieves the data transfer direction. Ensure TWI0 is initialized using TWI0_Initialize() before invoking this function.

• i2c_client_ack_status_t TWI0_LastByteAckStatusGet (void)

  Retrieves the acknowledgement status from host. Ensure TWI0 is initialized using TWI0_Initialize() before invoking this function.

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

  Registers a callback function.

ISR (TWI0_TWIS_vect )

Common Interrupt Service Routine (ISR) for all TWI0 interrupts. Initialize TWI0 with TWI0_Initialize() before calling this API.  

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  

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

Registers a callback function.

void TWI0_Deinitialize (void )

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

i2c_client_error_t TWI0_ErrorGet (void )

Retrieves the type of error that occurred during I2C communication. Ensure TWI0 is initialized using TWI0_Initialize() before invoking this function.

void TWI0_Initialize (void )

Initializes the TWI0 client module according to the settings specified in the MPLAB® Code Configurator Melody UI.

i2c_client_ack_status_t TWI0_LastByteAckStatusGet (void )

Retrieves the acknowledgement status from host. Ensure TWI0 is initialized using TWI0_Initialize() before invoking this function.

uint16_t TWI0_ReadAddr (void )

Retrieves the most recently matched address received from the host. Ensure TWI0 client is initialized using TWI0_Initialize() before invoking this function.

uint8_t TWI0_ReadByte (void )

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

i2c_client_transfer_dir_t TWI0_TransferDirGet (void )

Retrieves the data transfer direction. Ensure TWI0 is initialized using TWI0_Initialize() before invoking this function.

void TWI0_WriteByte (uint8_t data)

Sends data to a host on the bus. Ensure TWI0 is initialized using TWI0_Initialize() before invoking this function.

enum i2c_client_ack_status_t

Enumeration for acknowledgment and non-acknowledgment status.

enum i2c_client_error_t

Enumeration that specifies the possible errors in the I2C client driver.

enum i2c_client_transfer_dir_t

Enumeration to determine the direction of data transfer initiated by the host, as determined by the I2Cx_TransferDirGet function.

enum i2c_client_transfer_event_t

Enumeration defining the various I2C event types.

• struct i2c_host_interface_t

  This structure contains the portable interfaces for I2C host.

• struct i2c_transfer_setup

  Structure defining I2C clock configuration.

• ISR (TWI0_TWIM_vect)

  Common Interrupt Service Routine (ISR) for all TWI0 interrupts. Initialize TWI0 with TWI0_Initialize() before calling this API.  

  This API calls the TWI0_ErrorEventHandler() if an error flag is set, otherwise it calls TWI0_EventHandler() for other TWI transmit and receive events.

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

  Setter function for the TWI error interrupt callback.

• void TWI0_Initialize() (void)

  Initializes the TWI0 host module according to the settings specified in the MPLAB® Code Configurator 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)

  Sends data to a client on the bus. Ensure TWI0 host is initialized using TWI0_Initialize() before invoking this function.

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

  Reads data from an I2C client on the bus. Ensure 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)

  Initiates a data transfer by writing data from the writeData function to the bus and subsequently reads data from the Client, storing the received data in the readData parameter. The function generates a Start condition on the bus and transmits the specified number of bytes (writeLength) from the writeData buffer. Following this, a Repeated Start condition is inserted, and the function proceeds to read the specified number of bytes (readLength) from the client, storing them in the readData buffer. A Stop condition is generated after the final byte is received.

• i2c_host_error_t TWI0_ErrorGet (void)

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

• bool TWI0_IsBusy (void)

  Determines if the I2C bus is currently busy. Ensure TWI0 host is initialized using TWI0_Initialize() before invoking this function.  

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

  Registers a callback function.

• void TWI0_Tasks (void)

  Task to be polled for I2C host events. Ensure TWI0 host is initialized using TWI0_Initialize() before invoking this function.

ISR (TWI0_TWIM_vect )

Common Interrupt Service Routine (ISR) for all TWI0 interrupts. Initialize TWI0 with TWI0_Initialize() before calling this API.  

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  

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

Registers a callback function.

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 TWI0 host is initialized using TWI0_Initialize() before invoking this function.  

void TWI0_Initialize (void )

Initializes the TWI0 host module according to the settings specified in the MPLAB® Code Configurator Melody UI.

bool TWI0_IsBusy (void )

Determines if the I2C bus is currently busy. Ensure TWI0 host is initialized using TWI0_Initialize() before invoking this function.  

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

Reads data from an I2C client on the bus. Ensure 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 )

Task to be polled for I2C host events. Ensure TWI0 host is initialized using TWI0_Initialize() before invoking this function.

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

Sends data to a client on the bus. Ensure TWI0 host is initialized using TWI0_Initialize() before invoking this function.

This function attempts to write a specified number of bytes from the data buffer to a I2C client, identified by the provided address.

The TWI host will generate a Start condition, transmit the data, and then generate a Stop condition. If the client device responds with a NAK or if a bus error occurs, the transfer will be terminated. The application can call the TWI0_ErrorGet() function to determine the cause of the error. This function is non-blocking, meaning it initiates the bus activity and returns immediately. The transfer is then completed within 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. If this function is called while another transfer is ongoing, it will return false.

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

Initiates a data transfer by writing data from the writeData function to the bus and subsequently reads data from the Client, storing the received data in the readData parameter. The function generates a Start condition on the bus and transmits the specified number of bytes (writeLength) from the writeData buffer. Following this, a Repeated Start condition is inserted, and the function proceeds to read the specified number of bytes (readLength) from the client, storing them in the readData buffer. A Stop condition is generated after the final byte is received.

If the Client responds with a NAK 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 initiates the bus activity and returns immediately. The transfer is then completed via 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.

enum enum i2c_event_states_t

Enumeration representing the states of host events.

enum enum i2c_host_error_t

Enumeration for the possible errors in the I2C host driver.

• struct i2c_transfer_setup

  Structure defining I2C clock configuration.

• 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}

  Enumeration representing the states of host events.

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

  Enumeration for the possible errors in the I2C host driver.

• void TWI0_Initialize (void)

  Initializes the TWI0 host module according to the settings specified in the MPLAB® Code Configurator 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)

  Sends data to a client on the bus. Ensure TWI0 host is initialized using TWI0_Initialize() before invoking this function.

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

  Reads data from an I2C client on the bus. Ensure 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)

  Initiates a data transfer by writing data from the writeData function to the bus and subsequently reads data from the Client, storing the received data in the readData parameter. The function generates a Start condition on the bus and transmits the specified number of bytes (writeLength) from the writeData buffer. Following this, a Repeated Start condition is inserted, and the function proceeds to read the specified number of bytes (readLength) from the client, storing them in the readData buffer. A Stop condition is generated after the final byte is received.

• i2c_host_error_t TWI0_ErrorGet (void)

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

• bool TWI0_IsBusy (void)

  Determines if the I2C bus is currently busy. Ensure TWI0 host is initialized using TWI0_Initialize() before invoking this function.  

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

  Registers a callback function.

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

Registers a callback function.

void TWI0_Deinitialize (void )

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

i2c_host_error_t TWI0_ErrorGet (void )

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

void TWI0_Initialize (void )

Initializes the TWI0 host module according to the settings specified in the MPLAB® Code Configurator Melody UI.

bool TWI0_IsBusy (void )

Determines if the I2C bus is currently busy. Ensure TWI0 host is initialized using TWI0_Initialize() before invoking this function.  

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

Reads data from an I2C client on the bus. Ensure 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.

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

Sends data to a client on the bus. Ensure TWI0 host is initialized using TWI0_Initialize() before invoking this function.

This function attempts to write a specified number of bytes from the data buffer to a I2C client, identified by the provided address.

The TWI host will generate a Start condition, transmit the data, and then generate a Stop condition. If the client device responds with a NAK or if a bus error occurs, the transfer will be terminated. The application can call the TWI0_ErrorGet() function to determine the cause of the error. This function is non-blocking, meaning it initiates the bus activity and returns immediately. The transfer is then completed within 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. If this function is called while another transfer is ongoing, it will return false.

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

Initiates a data transfer by writing data from the writeData function to the bus and subsequently reads data from the Client, storing the received data in the readData parameter. The function generates a Start condition on the bus and transmits the specified number of bytes (writeLength) from the writeData buffer. Following this, a Repeated Start condition is inserted, and the function proceeds to read the specified number of bytes (readLength) from the client, storing them in the readData buffer. A Stop condition is generated after the final byte is received.

If the Client responds with a NAK 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 initiates the bus activity and returns immediately. The transfer is then completed via 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(* 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

I2C client address

bool busy

A flag that signifies the host is currently busy

i2c_host_error_t errorState

An instance of i2c_host_error_t

size_t readLength

Number of bytes to be read from the client

uint8_t * readPtr

Pointer to the buffer for received data

i2c_event_states_t state

An instance of i2c_host_event_states_t

bool switchToRead

Boolean flag to indicate switching to read mode

size_t writeLength

The number of bytes to be written or sent to the client

uint8_t * writePtr

Pointer to the buffer used for transmission

• 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.

• uint32_t clkSpeed

uint32_t clkSpeed

enum i2c_client_ack_status_t

enum i2c_client_error_t

enum i2c_client_transfer_dir_t

enum i2c_client_transfer_event_t

static void TWI0_ErrorEventHandler (void )[static]

static void TWI0_EventHandler (void )[static]

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
}

Represents an instance of the portable interface structure designed for TWI0 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.

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

volatile i2c_client_error_t twi0ErrorState[static]

volatile uint16_t twi0matchedAddress[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:,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 must be disabled in the MPLAB-X IDE by navigating to Tools>Options>Embedded>MISRA Check.

inline static void TWI0_CommandUpdate (TWI_MCMD_t cmd)

static void TWI0_ErrorEventHandler (void )[static]

static void TWI0_EventHandler (void )[static]

static void TWI0_ReadStart (void )[static]

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
}

Represents an instance of the portable interface structure designed for TWI0 host.

void(* TWI0_Callback) (void)[static]

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}

static void TWI0_ErrorEventHandler (void )[static]

static void TWI0_EventHandler (void )[static]

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
}

Represents an instance of the portable interface structure designed for TWI0 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.

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

volatile i2c_client_error_t twi0ErrorState[static]

volatile uint16_t twi0matchedAddress[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:,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 must be disabled in the MPLAB-X IDE by navigating to Tools>Options>Embedded>MISRA Check.

inline static void TWI0_CommandUpdate (TWI_MCMD_t cmd)

static void TWI0_ErrorEventHandler (void )[static]

static void TWI0_EventHandler (void )[static]

static void TWI0_ReadStart (void )[static]

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
}

Represents an instance of the portable interface structure designed for TWI0 host.

void(* TWI0_Callback) (void)[static]

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)

Registers a callback function.

void TWI0_Deinitialize (void )

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

i2c_client_error_t TWI0_ErrorGet (void )

Retrieves the type of error that occurred during I2C communication. Ensure TWI0 is initialized using TWI0_Initialize() before invoking this function.

void TWI0_Initialize (void )

Initializes the TWI0 client module according to the settings specified in the MPLAB® Code Configurator Melody UI.

i2c_client_ack_status_t TWI0_LastByteAckStatusGet (void )

Retrieves the acknowledgement status from host. Ensure TWI0 is initialized using TWI0_Initialize() before invoking this function.

uint16_t TWI0_ReadAddr (void )

Retrieves the most recently matched address received from the host. Ensure TWI0 client is initialized using TWI0_Initialize() before invoking this function.

uint8_t TWI0_ReadByte (void )

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

i2c_client_transfer_dir_t TWI0_TransferDirGet (void )

Retrieves the data transfer direction. Ensure TWI0 is initialized using TWI0_Initialize() before invoking this function.

void TWI0_WriteByte (uint8_t data)

Sends data to a host on the bus. Ensure TWI0 is initialized using TWI0_Initialize() before invoking this function.

#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 must 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

Represents an instance of the portable interface structure designed for TWI0 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 - 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 must be disabled in the MPLAB-X IDE by navigating to Tools>Options>Embedded>MISRA Check.

#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) / 1000000))) / 2)

const i2c_host_interface_t I2C2_Host

Represents an instance of the portable interface structure designed for TWI0 host.

void TWI0_Tasks (void )

Task to be polled I2C client events. Ensure TWI0 client is initialized using TWI0_Initialize() before invoking this function.

#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 must 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

Represents an instance of the portable interface structure designed for TWI0 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 - 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 must be disabled in the MPLAB-X IDE by navigating to Tools>Options>Embedded>MISRA Check.

#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)4000000 / (float)(F_SCL))) - 10 - ((float)4000000 * (T_RISE) / 1000000))) / 2)

const i2c_host_interface_t I2C1_Host

Represents an instance of the portable interface structure designed for TWI0 host.

#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 are provided by the Melody-generated drivers for the user’s application. The user has the discretion to implement these declarations in their application.

typedef struct i2c_transfer_setup i2c_host_transfer_setup_t

@misradeviation{Advisory:,2.4,Advisory:,2.3} These declarations are provided by the Melody-generated drivers for the user’s application. The user has the discretion to implement these declarations in their application.

enum i2c_host_error_t