I2C.h

Go to the documentation of this file.

/*
 * Copyright (C) 2014-2018 Texas Instruments Incorporated - http://www.ti.com/
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the
 * distribution.
 *
 * Neither the name of Texas Instruments Incorporated nor the names of
 * its contributors may be used to endorse or promote products derived
 * from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

/* @} */

#ifndef I2C_H
#define I2C_H

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>
#define I2C_CMD_RESERVED             32

#define I2C_CMD_PROBE               (0U)

#define I2C_CMD_SET_BUS_FREQUENCY   (1U)

#define I2C_CMD_RECOVER_BUS         (2U)

#define I2C_CMD_SMBUS_TYPE          (3U)

#define I2C_STATUS_RESERVED         (-((int32_t)32))

#define I2C_STATUS_SUCCESS          ((int32_t)(0))

#define I2C_STATUS_ERROR           (-((int32_t)1))

#define I2C_STATUS_UNDEFINEDCMD    (-((int32_t)2))


#define I2C_STS_SUCCESS           ((int16_t)(1))

#define I2C_STS_RESTART           ((int16_t)(2))

#define I2C_STS_ERR               ((int16_t)(0))

#define I2C_STS_ERR_TIMEOUT          (-(int16_t)(1))

#define I2C_STS_ERR_BUS_BUSY         (-(int16_t)(2))

#define I2C_STS_ERR_NO_ACK           (-(int16_t)(3))

#define I2C_STS_ERR_ARBITRATION_LOST (-(int16_t)(4))

#define I2C_STS_ERR_ACCESS_ERROR     (-(int16_t)(5))

#define I2C_STS_ERR_COMMAND_FAILURE  (-(int16_t)(6))

#define I2C_STS_ERR_INVALID_COMMAND  (-(int16_t)(7))

typedef struct I2C_Config_s      *I2C_Handle;

#define I2C_TRANS_VALID_PARAM_MASTER_MODE           (0x00000001U)
#define I2C_TRANS_VALID_PARAM_EXPAND_SA             (0x00000002U)

typedef struct I2C_Transaction_s {
    uint32_t            validParams;        
    void                *writeBuf;          
                                            /*   User input (requested write count) and output (actual write count) fields */
    size_t              writeCount;         
    void                *readBuf;           
                                            /*   User input (requested read count) and output (actual read count) fields */
    size_t              readCount;          
    uint32_t            slaveAddress;       
    void                *arg;               
    void                *nextPtr;           
    uint32_t            timeout;            
    bool                masterMode;         
    bool                expandSA;           
} I2C_Transaction;

typedef enum I2C_TransferMode_e {
    I2C_MODE_BLOCKING,  
    I2C_MODE_CALLBACK   
} I2C_TransferMode;

typedef void (*I2C_CallbackFxn)(I2C_Handle handle, I2C_Transaction * msg, int16_t transferStatus);

typedef enum I2C_BitRate_e {
    I2C_100kHz = 0,
    I2C_400kHz = 1,
    I2C_1P0Mhz = 2,
    I2C_3P4Mhz = 3
} I2C_BitRate;

typedef struct I2C_Params_s {
    I2C_TransferMode    transferMode; 
    /* done to get rid of misra warning MISRA.CAST.FUNC_PTR, it complains later where the function address is assigned */
    void (*transferCallbackFxn)(I2C_Handle i2cHnd, I2C_Transaction * msg, int16_t transferStatus);
    /* I2C_CallbackFxn     transferCallbackFxn; !< Callback function pointer */
    I2C_BitRate         bitRate; 
    void               *custom;  
} I2C_Params;

#define I2C_WAIT_FOREVER   (~((uint32_t)0U))

typedef void        (*I2C_CloseFxn)    (I2C_Handle handle);

typedef int32_t         (*I2C_ControlFxn)  (I2C_Handle handle,
                                        uint32_t cmd,
                                        void *arg);

typedef void        (*I2C_InitFxn)     (I2C_Handle handle);

typedef I2C_Handle  (*I2C_OpenFxn)     (I2C_Handle handle,
                                        const I2C_Params *params);

typedef int16_t        (*I2C_TransferFxn) (I2C_Handle handle,
                                        I2C_Transaction *transaction);

typedef struct I2C_FxnTable_s {
    I2C_CloseFxn        closeFxn;

    I2C_ControlFxn      controlFxn;

    I2C_InitFxn         initFxn;

    I2C_OpenFxn         openFxn;

    I2C_TransferFxn     transferFxn;
} I2C_FxnTable;

typedef struct I2C_Config_s {
    I2C_FxnTable const *fxnTablePtr;

    void               *object;

    void         const *hwAttrs;
} I2C_Config;

#define I2C_MAX_CONFIG_CNT (14U)
typedef I2C_Config I2C_config_list[I2C_MAX_CONFIG_CNT];


extern void I2C_close(I2C_Handle i2cHnd);

extern int32_t I2C_control(I2C_Handle i2cHnd, uint32_t cmd, void *arg);

extern void I2C_init(void);

extern I2C_Handle I2C_open(uint32_t idx, I2C_Params *params);

extern void I2C_Params_init(I2C_Params *params);

extern int16_t I2C_transfer(I2C_Handle i2cHnd, I2C_Transaction *transaction);

extern void I2C_transactionInit(I2C_Transaction *transaction);

#ifdef __cplusplus
}
#endif

#endif /* _I2C_H_ */

/* @} */