i2c2.h

 
/*
    (c) 2022 Microchip Technology Inc. and its subsidiaries. You may use this
    software and any derivatives exclusively with Microchip products.
 
    THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS". NO WARRANTIES, WHETHER
    EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE, INCLUDING ANY IMPLIED
    WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A
    PARTICULAR PURPOSE, OR ITS INTERACTION WITH MICROCHIP PRODUCTS, COMBINATION
    WITH ANY OTHER PRODUCTS, OR USE IN ANY APPLICATION.
 
    IN NO EVENT WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE,
    INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND
    WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP HAS
    BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE FORESEEABLE. TO THE
    FULLEST EXTENT ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON ALL CLAIMS IN
    ANY WAY RELATED TO THIS SOFTWARE WILL NOT EXCEED THE AMOUNT OF FEES, IF ANY,
    THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR THIS SOFTWARE.
 
    MICROCHIP PROVIDES THIS SOFTWARE CONDITIONALLY UPON YOUR ACCEPTANCE OF THESE
    TERMS.
*/
 
#ifndef _I2C2_H
#define _I2C2_H
 
#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>
#include <xc.h>
 
#ifdef __cplusplus  // Provide C++ Compatibility
 
    extern "C" {
 
#endif
 
 
typedef enum
{
    /* This state indicates that the slave driver has detected a transmit request from the master.
       The next transaction will be a read transaction. Application should prime the transmit
       buffer with the valid data to be sent to the master using the: I2C2_ReadPointerSet()
       
     */
    I2C2_SLAVE_TRANSMIT_REQUEST_DETECTED,
            
    /* This state indicates that the slave driver has detected a reception request from the master.
       The next transaction will be a write transaction. Application should set up the receive 
       buffer by setting the location of the receive buffer using the: I2C2_WritePointerSet()
     */
    I2C2_SLAVE_RECEIVE_REQUEST_DETECTED,
 
    /* This state indicates that the slave driver has received data from the master.
       Application can use this status to process the received data set up the receive
       buffer in anticipation of next reception in case the master sends more data. 
       See I2C2_SLAVE_RECEIVE_REQUEST_DETECTED.
     */
    I2C2_SLAVE_RECEIVED_DATA_DETECTED,
            
    /* This state indicates that the slave driver has detected the most significant
       byte of the 10-bit slave address. Another transaction with the least 
       significant byte of the 10-bit address with a read/write request will
       be detected next. This second detection is automatically done by the 
       driver which may return one of the following:
           a. I2C2_SLAVE_RECEIVE_REQUEST_DETECTED
           b. I2C2_SLAVE_TRANSMIT_REQUEST_DETECTED
           c. I2C2_SLAVE_10BIT_RECEIVE_REQUEST_DETECTED
       a or b is detected depending on the read/write bit of the received 
       control data. If c is detected next, the master decided to resend
       the most significant address.  
     */
    I2C2_SLAVE_10BIT_RECEIVE_REQUEST_DETECTED,
                  
     /* 
     * This state indicates that an stop bit was detected, so execute
     * CRC check
     * This was added by Cormac on 19-Jan-2021
     */
    I2C2_SLAVE_STOP_BIT_DETECTED, 
            
 
} I2C2_SLAVE_DRIVER_STATUS;
 
#define I2C2_SLAVE_DEFAULT_ADDRESS          99
 
void I2C2_Initialize(void);
 
 
void I2C2_SlaveAddressMaskSet(
                                uint16_t mask);
 
void I2C2_SlaveAddressSet(
                                uint16_t address);
 
 
void I2C2_ReadPointerSet(uint8_t *p);
 
void I2C2_WritePointerSet(uint8_t *p);
 
uint8_t *I2C2_ReadPointerGet(void);
 
uint8_t *I2C2_WritePointerGet(void);
 
void I2C2_SlaveTasks ( void );
 
//#pragma message "I2C2_StatusCallback() is an Application implemented function. If this function is already implemented, you can turn off this message by deleting or commenting out this message."
bool I2C2_StatusCallback(I2C2_SLAVE_DRIVER_STATUS status);
 
#ifdef __cplusplus  // Provide C++ Compatibility
 
    }
 
#endif
 
#endif  // _I2C2_H