common.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright (c) 2019 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 _COMMON_H_
#define _COMMON_H_

/* @} */

#include <ti/drv/uart/UART.h>
#include <ti/drv/uart/UART_stdio.h>

#include <ti/drv/i2c/I2C.h>
#include <ti/drv/i2c/soc/I2C_soc.h>

#include <ti/board/board.h>

#include <ti/osal/osal.h>
#include <stdio.h>
#include <stdint.h>
#include <stdlib.h>
#include <string.h>

#ifdef __cplusplus
extern "C" {
#endif

#define BOARD_DEVICES_CONFIG_END           (-1)

/* Define below macros to enable the debug logs from board device library */
/* Enables status logs */
#undef BOARD_DEVICES_ENABLE_STATUS_LOGS
/* Enables error logs which are displayed during function execution failure */
#undef BOARD_DEVICES_ENABLE_ERROR_LOGS

#if defined(BOARD_DEVICES_ENABLE_STATUS_LOGS)
#define BOARD_DEVICES_STS_LOG     UART_printf
#else
#define BOARD_DEVICES_STS_LOG(x, ...)
#endif  /* #if defined(BOARD_DEVICES_ENABLE_STATUS_LOGS) */

#if defined(BOARD_DEVICES_ENABLE_ERROR_LOGS)
#define BOARD_DEVICES_ERR_LOG     UART_printf
#else
#define BOARD_DEVICES_ERR_LOG(x, ...)
#endif  /* #if defined(BOARD_DEVICES_ENABLE_ERROR_LOGS) */

#define BOARD_FPD_MAX_REMOTE_SENSOR_DEVICES                 (8U)

#define BOARD_FPD_MODE_DISABLE                              (0U)

#define BOARD_FPD_MODE_ENABLE                               (1U)

#define BOARD_FPD_MODE_NORMAL                               (0U)

#define BOARD_FPD_MODE_RESET                                (1U)

#define BOARD_FPD_KBPS_100                                  (0x64U)

#define BOARD_FPD_KBPS_400                                  (0x32U)

#define BOARD_I2C_REG_ADDR_MSB_FIRST                        (0x0U)

#define BOARD_I2C_REG_ADDR_LSB_FIRST                        (0x1U)

#define ONE_MILLI_SEC                                       (1U)

#define BOARD_FPD_I2C_CFG_DELAY                             (5 * ONE_MILLI_SEC)

#define BOARD_I2C_TRANSACTION_TIMEOUT                       (2000U)

typedef struct Board_FpdRmtDevObj_s
{
    uint32_t i2cDevAddr;
    uint32_t i2cDevAliasAddr;
} Board_FpdRmtDevObj;

typedef struct Board_FpdModuleObj_s
{
    uint32_t desSlvAddr;
    uint32_t serSlvAddr;
    uint32_t serDesAliasAddr;
} Board_FpdModuleObj;

typedef struct Board_I2cRegProgObj_s
{
    int32_t regAddr;
    uint32_t regData;
    uint32_t i2cDelay;
} Board_I2cRegProgObj;

/* @} */

void Board_delay(uint32_t delayCycles);

Board_STATUS Board_i2c16BitRegRd(void   *handle,
                                 uint32_t slaveAddr,
                                 uint16_t regAddr,
                                 uint8_t *regData,
                                 uint8_t numOfBytes,
                                 uint8_t byteOrdSel,
                                 uint32_t i2cTimeout);

Board_STATUS Board_i2c16BitRegWr(void *handle,
                                 uint32_t slaveAddr,
                                 uint16_t regAddr,
                                 uint8_t *regData,
                                 uint8_t numOfBytes,
                                 uint8_t byteOrdSel,
                                 uint32_t i2cTimeout);

Board_STATUS Board_i2c8BitRegRd(void   *handle,
                                uint32_t slaveAddr,
                                uint8_t regAddr,
                                uint8_t *regData,
                                uint8_t numOfBytes,
                                uint32_t i2cTimeout);

Board_STATUS Board_i2c8BitRegWr(void *handle,
                                uint32_t slaveAddr,
                                uint8_t regAddr,
                                uint8_t *regData,
                                uint8_t numOfBytes,
                                uint32_t i2cTimeout);

Board_STATUS Board_i2c10bit16bitRegRd(void *handle,
                                      uint32_t slaveAddr,
                                      uint16_t regAddr,
                                      uint16_t *regData,
                                      uint32_t i2cTimeout);

Board_STATUS Board_i2c10bit16bitRegWr(void *handle,
                                      uint32_t slaveAddr,
                                      uint16_t regAddr,
                                      uint16_t regData,
                                      uint32_t i2cTimeout);
#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* _COMMON_H_ */

/* @} */