i2c/v0/i2c.h

Go to the documentation of this file.

/*
 *  Copyright (C)2018-2021 Texas Instruments Incorporated
 *
 *  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_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>
#include <kernel/dpl/SemaphoreP.h>
#include <kernel/dpl/HwiP.h>
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
#define I2C_MAX_NUM_OWN_SLAVE_ADDR      (4U)
 
#define I2C_MODE_BLOCKING               ((uint8_t) 0U)
#define I2C_MODE_CALLBACK               ((uint8_t) 1U)
 
#define I2C_100KHZ                      ((uint8_t) 0U)
#define I2C_400KHZ                      ((uint8_t) 1U)
#define I2C_1P0MHZ                      ((uint8_t) 2U)
#define I2C_3P4MHZ                      ((uint8_t) 3U)
 
#define I2C_STS_SUCCESS                 ( 0)
#define I2C_STS_ERR                     (-1)
#define I2C_STS_ERR_TIMEOUT             (-2)
#define I2C_STS_ERR_BUS_BUSY            (-3)
#define I2C_STS_ERR_NO_ACK              (-4)
#define I2C_STS_ERR_ARBITRATION_LOST    (-5)
#define I2C_STS_ERR_ACCESS_ERROR        (-6)
#define I2C_STS_ERR_COMMAND_FAILURE     (-7)
#define I2C_STS_ERR_INVALID_COMMAND     (-8)
#define I2C_STS_RESTART                 (-9)
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
typedef struct I2C_Config_s      *I2C_Handle;
 
typedef struct I2C_HwAttrs_s {
    uint32_t            baseAddr;
    uint32_t            intNum;
    uint32_t            eventId;
    uint32_t            funcClk;
    bool                enableIntr;
    uint32_t            ownSlaveAddr[I2C_MAX_NUM_OWN_SLAVE_ADDR];
} I2C_HwAttrs;
 
typedef struct I2C_Transaction_s {
 
    const void          *writeBuf;
 
    size_t              writeCount;
 
    void                *readBuf;
 
    size_t              readCount;
 
    uint32_t            slaveAddress;
 
    void                *nextPtr;
 
    void                *arg;
 
    uint32_t            timeout;
 
    bool                masterMode;
 
    bool                expandSA;
} I2C_Transaction;
 
typedef struct I2C_Params_s {
    uint8_t     transferMode;
    void        (*transferCallbackFxn)(I2C_Handle i2cHnd, I2C_Transaction * msg, int32_t transferStatus);
    uint8_t     bitRate;
} I2C_Params;
 
typedef struct I2C_Object_s {
 
    SemaphoreP_Object   mutex;
    SemaphoreP_Object   transferComplete;
    HwiP_Object         hwiObj;
    I2C_Params          i2cParams;
    uint8_t             state;
    I2C_Transaction    *currentTransaction;
    uint8_t            *writeBufIdx;
    uint32_t            writeCountIdx;
    uint8_t            *readBufIdx;
    uint32_t            readCountIdx;
 
/* I2C transaction pointers for I2C_MODE_CALLBACK */
/* Head ptr for queued transactions */
    I2C_Transaction    *headPtr;
/* Tail ptr for queued transactions */
    I2C_Transaction    *tailPtr;
/* flag to indicate module is open */
    bool                isOpen;
/* interrupt status error */
    uint32_t            intStatusErr;
 
    uint32_t            baseAddr;
} I2C_Object;
 
 
typedef struct I2C_Config_s {
    I2C_Object         *object;
    I2C_HwAttrs  const *hwAttrs;
} I2C_Config;
 
typedef void (*I2C_CallbackFxn)(I2C_Handle handle, I2C_Transaction * msg, int32_t transferStatus);
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
void        I2C_init(void);
 
void        I2C_deinit(void);
 
void        I2C_Params_init(I2C_Params *params);
 
I2C_Handle  I2C_open(uint32_t idx, const I2C_Params *params);
 
void        I2C_Transaction_init(I2C_Transaction *transaction);
 
int32_t     I2C_transfer(I2C_Handle handle,
                         I2C_Transaction *transaction);
 
int32_t     I2C_probe(I2C_Handle handle, uint32_t slaveAddr);
 
int32_t     I2C_setBusFrequency(I2C_Handle handle, uint32_t busFrequency);
 
int32_t     I2C_recoverBus(I2C_Handle handle, uint32_t i2cDelay);
 
void        I2C_close(I2C_Handle handle);
 
I2C_Handle I2C_getHandle(uint32_t index);
 
#ifdef __cplusplus
}
#endif
 
#endif /* I2C_H_ */