I2CCC32XX.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2019, Texas Instruments Incorporated
 * All rights reserved.
 *
 * 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.
 */
/*!****************************************************************************
 *  @file       I2CCC32XX.h
 *
 *  @brief      I2C driver implementation for a CC32XX I2C controller.
 *
 *  The I2C header file should be included in an application as follows:
 *  @code
 *  #include <ti/drivers/I2C.h>
 *  #include <ti/drivers/i2c/I2CCC32XX.h>
 *  @endcode
 *
 *  Refer to @ref I2C.h for a complete description of APIs and usage.
 *
 *  ## Supported Bit Rates ##
 *    - #I2C_100kHz
 *    - #I2C_400kHz
 *
 ******************************************************************************
 */

#ifndef ti_drivers_i2c_I2CCC32XX__include
#define ti_drivers_i2c_I2CCC32XX__include

#include <stdint.h>
#include <stdbool.h>

#include <ti/drivers/I2C.h>
#include <ti/drivers/dpl/HwiP.h>
#include <ti/drivers/dpl/SemaphoreP.h>
#include <ti/drivers/Power.h>

#ifdef __cplusplus
extern "C" {
#endif

/*
 *  Macros defining possible I2C signal pin mux options
 *
 *  The bits in the pin mode macros are as follows:
 *  The lower 8 bits of the macro refer to the pin, offset by 1, to match
 *  driverlib pin defines.  For example, I2CCC32XX_PIN_01_I2C_SCL & 0xff = 0,
 *  which equals PIN_01 in driverlib pin.h.  By matching the PIN_xx defines in
 *  driverlib pin.h, we can pass the pin directly to the driverlib functions.
 *  The upper 8 bits of the macro correspond to the pin mux confg mode
 *  value for the pin to operate in the I2C mode.  For example, pin 1 is
 *  configured with mode 1 to operate as I2C_SCL.
 */
#define I2CCC32XX_PIN_01_I2C_SCL  0x100 
#define I2CCC32XX_PIN_02_I2C_SDA  0x101 
#define I2CCC32XX_PIN_03_I2C_SCL  0x502 
#define I2CCC32XX_PIN_04_I2C_SDA  0x503 
#define I2CCC32XX_PIN_05_I2C_SCL  0x504 
#define I2CCC32XX_PIN_06_I2C_SDA  0x505 
#define I2CCC32XX_PIN_16_I2C_SCL  0x90F 
#define I2CCC32XX_PIN_17_I2C_SDA  0x910 
/* Add I2CCC32XX_STATUS_* macros here */

/* Add I2CCC32XX_CMD_* macros here */

/* I2C function table pointer */
extern const I2C_FxnTable I2CCC32XX_fxnTable;

typedef enum {
    I2CCC32XX_IDLE_MODE = 0,
    I2CCC32XX_WRITE_MODE,
    I2CCC32XX_READ_MODE,
    I2CCC32XX_TIMEOUT,
    I2CCC32XX_ERROR = 0xFF
} I2CCC32XX_Mode;
typedef struct {
    unsigned int baseAddr;
    unsigned int intNum;
    unsigned int intPriority;
    uint16_t clkPin;
    uint16_t dataPin;
} I2CCC32XX_HWAttrsV1;

typedef struct {
    SemaphoreP_Handle   mutex;            /* Grants exclusive access to I2C */
    SemaphoreP_Handle   transferComplete; /* Signals I2C transfer completion */

    HwiP_Handle         hwiHandle;

    I2C_TransferMode    transferMode;        /* Blocking or Callback mode */
    I2C_CallbackFxn     transferCallbackFxn; /* Callback function pointer */

    volatile I2CCC32XX_Mode mode;            /* Stores the I2C state */

    I2C_Transaction    *currentTransaction; /* Pointer to current transaction */

    uint8_t            *writeBufIdx;         /* Internal inc. writeBuf index */
    size_t              totalWriteCountIdx;  /* Internal dec. writeCounter */
    size_t              burstWriteCountIdx;  /* Internal dec. writeCounter */

    uint8_t            *readBufIdx;          /* Internal inc. readBuf index */
    size_t              totalReadCountIdx;   /* Internal dec. readCounter */
    size_t              burstReadCountIdx;   /* Internal dec. readCounter */

    /* I2C transaction pointers for I2C_MODE_CALLBACK */
    I2C_Transaction    *headPtr;        /* Head ptr for queued transactions */
    I2C_Transaction    *tailPtr;        /* Tail ptr for queued transactions */

    bool                isOpen;         /* Flag to indicate module is open */

    Power_NotifyObj     notifyObj;      /* For notification of wake from LPDS */
    I2C_BitRate         bitRate;        /* I2C bus bit rate */
} I2CCC32XX_Object;
#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_i2c_I2CCC32XX__include */