| /* |
| * Copyright (c) 2015-2016, 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. |
| * |
| * ============================================================================ |
| */ |
| |
| #ifndef ti_drivers_i2c_I2CCC32XX__include |
| #define ti_drivers_i2c_I2CCC32XX__include |
| |
| #ifdef __cplusplus |
| extern "C" { |
| #endif |
| |
| #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> |
| |
| /* macros defining possible I2C signal pin mux options */ |
| #define I2CCC32XX_PIN_01_I2C_SCL 0x100 /*!< PIN 1 is used for I2C_SCL */ |
| #define I2CCC32XX_PIN_02_I2C_SDA 0x101 /*!< PIN 2 is used for I2C_SDA */ |
| #define I2CCC32XX_PIN_03_I2C_SCL 0x502 /*!< PIN 3 is used for I2C_SCL */ |
| #define I2CCC32XX_PIN_04_I2C_SDA 0x503 /*!< PIN 4 is used for I2C_SDA */ |
| #define I2CCC32XX_PIN_05_I2C_SCL 0x504 /*!< PIN 5 is used for I2C_SCL */ |
| #define I2CCC32XX_PIN_06_I2C_SDA 0x505 /*!< PIN 6 is used for I2C_SDA */ |
| #define I2CCC32XX_PIN_16_I2C_SCL 0x90F /*!< PIN 16 is used for I2C_SCL */ |
| #define I2CCC32XX_PIN_17_I2C_SDA 0x910 /*!< PIN 17 is used for I2C_SDA */ |
| |
| /** |
| * @addtogroup I2C_STATUS |
| * I2CCC32XX_STATUS_* macros are command codes only defined in the |
| * I2CCC32XX.h driver implementation and need to: |
| * @code |
| * #include <ti/drivers/i2c/I2CCC32XX.h> |
| * @endcode |
| * @{ |
| */ |
| |
| /* Add I2CCC32XX_STATUS_* macros here */ |
| |
| /** @}*/ |
| |
| /** |
| * @addtogroup I2C_CMD |
| * I2CCC32XX_CMD_* macros are command codes only defined in the |
| * I2CCC32XX.h driver implementation and need to: |
| * @code |
| * #include <ti/drivers/i2c/I2CCC32XX.h> |
| * @endcode |
| * @{ |
| */ |
| |
| /* Add I2CCC32XX_CMD_* macros here */ |
| |
| /** @}*/ |
| |
| /* I2C function table pointer */ |
| extern const I2C_FxnTable I2CCC32XX_fxnTable; |
| |
| /*! |
| * @cond NODOC |
| * I2CCC32XX mode |
| * |
| * This enum defines the state of the I2C driver's state machine. |
| */ |
| typedef enum I2CCC32XX_Mode { |
| /*! I2C is idle, and not performing a transaction */ |
| I2CCC32XX_IDLE_MODE = 0, |
| /*! I2C is currently performing a write operation */ |
| I2CCC32XX_WRITE_MODE, |
| /*! I2C is currently performing a read operation */ |
| I2CCC32XX_READ_MODE, |
| /*! I2C error has occurred */ |
| I2CCC32XX_ERROR = 0xFF |
| } I2CCC32XX_Mode; |
| /*! @endcond */ |
| |
| /*! |
| * @brief I2CCC32XX Hardware attributes |
| * |
| * The baseAddr and intNum fields define the base address and interrupt number |
| * of the I2C peripheral. These values are used by driverlib APIs and |
| * therefore must be populated by driverlib macro definitions. These |
| * definitions are found in the header files: |
| * - inc/hw_memmap.h |
| * - inc/hw_ints.h |
| * |
| * intPriority is the I2C peripheral's interrupt priority. |
| * This driver uses the ti.dpl interface instead of making OS calls directly, |
| * and the corresponding HwiP port handles the interrupt priority in an |
| * OS-specific way. For example, in the case of the TI-RTOS kernel port, |
| * the intPriority is passed unmodified to Hwi_create() provided by the |
| * ti.sysbios.family.arm.m3.Hwi module; so the documentation for the |
| * ti.sysbios.family.arm.m3.Hwi module should be referenced for a description |
| * of usage of priority. |
| * |
| * clkPin and dataPin define the pin multiplexing to be used for the SCL and |
| * SDA pins, respectively. Macro values defined in this header file should |
| * be used for these fields. |
| * |
| * A sample structure is shown below: |
| * @code |
| * const I2CCC32XX_HWAttrsV1 i2cCC32XXHWAttrs[] = { |
| * { |
| * .baseAddr = I2CA0_BASE, |
| * .intNum = INT_I2CA0, |
| * .intPriority = (~0), |
| * .clkPin = I2CCC32XX_PIN_01_I2C_SCL, |
| * .dataPin = I2CCC32XX_PIN_02_I2C_SDA, |
| * } |
| * }; |
| * @endcode |
| */ |
| typedef struct I2CCC32XX_HWAttrsV1 { |
| /*! I2C Peripheral's base address */ |
| unsigned int baseAddr; |
| /*! I2C Peripheral's interrupt vector */ |
| unsigned int intNum; |
| /*! I2C Peripheral's interrupt priority */ |
| unsigned int intPriority; |
| /*! I2C clock pin configuration */ |
| uint16_t clkPin; |
| /*! I2C data pin configuration */ |
| uint16_t dataPin; |
| } I2CCC32XX_HWAttrsV1; |
| |
| /*! |
| * @cond NODOC |
| * I2CCC32XX Object. Applications must not access any member variables of |
| * this structure! |
| */ |
| typedef struct I2CCC32XX_Object { |
| 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 writeCountIdx; /* Internal dec. writeCounter */ |
| |
| uint8_t *readBufIdx; /* Internal inc. readBuf index */ |
| size_t readCountIdx; /* 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; |
| /*! @endcond */ |
| |
| #ifdef __cplusplus |
| } |
| #endif |
| |
| #endif /* ti_drivers_i2c_I2CCC32XX__include */ |
