ds90ub926.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 _DS90UB926_H_
#define _DS90UB926_H_

#include <ti/board/src/devices/common/common.h>

#ifdef __cplusplus
extern "C" {
#endif

#define BOARD_FPD_UB926_I2C_INSTANCE                                  (0x03U)

#define BOARD_FPD_UB926_I2C_SLV_ADDR                                  (0x2CU)


#define BOARD_FPD_UB926_I2C_DEVICE_ID_REG_ADDR                        (0x00U)

#define BOARD_FPD_UB926_RESET_REG_ADDR                                (0x01U)

#define BOARD_FPD_UB926_CONFIGURATION1_REG_ADDR                       (0x03U)

#define BOARD_FPD_UB926_DES_FREEZE_DEVID_REG_ADDR                     (0x01)

#define BOARD_FPD_UB926_I2C_CONTROL1_REG_ADDR                         (0x05U)

#define BOARD_FPD_UB926_REMOTE_DEVICE_ID_REG_ADDR                     (0x07U)

#define BOARD_FPD_UB926_SLAVE_ID0_REG_ADDR                            (0x08U)

#define BOARD_FPD_UB926_SLAVE_ALIAS0_REG_ADDR                         (0x10U)

#define BOARD_FPD_UB926_GENERAL_STATUS_REG_ADDR                       (0x1CU)

#define BOARD_FPD_UB926_DATA_PATH_CONTROL_REG_ADDR                    (0X22U)

#define BOARD_FPD_UB926_SCL_HIGH_TIME_REG_ADDR                        (0x26U)

#define BOARD_FPD_UB926_SCL_LOW_TIME_REG_ADDR                         (0x27U)

#define BOARD_FPD_UB926_RMT_SER_SLAVE_DEVICE_ID_REG_ADDR              (0x18U)

#define BOARD_FPD_UB926_RMT_SER_ALIAS_SLAVE_DEVICE_ID_REG_ADDR        (0x2AU)

#define BOARD_FPD_UB926_DIGITAL_RESET1_SHIFT_CNT                     (1U)

#define BOARD_FPD_UB926_BC_ENABLE_SHIFT_CNT                          (2U)

#define BOARD_FPD_UB926_REMOTE_AUTO_PWR_DWN_SHIFT_CNT                (7U)

#define BOARD_FPD_UB926_ID_SETTING_SHIFT_CNT                         (0U)

#define BOARD_FPD_UB926_DEVICE_ID_SHIFT_CNT                          (1U)

#define BOARD_FPD_UB926_I2C_PASS_THROUGH_SHIFT_CNT                   (3U)

#define BOARD_FPD_UB926_I2C_PASS_THROUGH_ALL_SHIFT_CNT               (7U)

#define BOARD_FPD_UB926_OVERRIDE_FC_CONFIG_SHIFT_CNT                 (7U)

#define BOARD_FPD_UB926_PASS_RGB_SHIFT_CNT                           (6U)

#define BOARD_FPD_UB926_RGB_18BIT_MODE_SHIFT_CNT                     (2U)

#define BOARD_FPD_UB926_I2S_CHANNEL_B_OVERRIDE_SHIFT_CNT             (3U)

#define BOARD_FPD_UB926_I2S_GEN_SHIFT_CNT                            (4U)

#define BOARD_FPD_UB926_I2S_TRANSPOER_SEL_SHIFT_CNT                  (1U)

#define BOARD_FPD_UB926_I2S_CHANNEL_B_ENABLE_SHIFT_CNT               (0U)

#define BOARD_FPD_UB926_I2S_PLL_LOCK_STATUS_SHIFT_CNT                (3U)

/* Bit mask's used for different deserializer register configurations */
#define BOARD_FPD_UB926_DIGITAL_RESET1_BIT_MASK                      (uint8_t)(0x01 << BOARD_FPD_UB926_DIGITAL_RESET1_SHIFT_CNT)

#define BOARD_FPD_UB926_REMOTE_AUTO_PWR_DWN_BIT_MASK                 (uint8_t)(0x01 << BOARD_FPD_UB926_REMOTE_AUTO_PWR_DWN_SHIFT_CNT)

#define BOARD_FPD_UB926_BC_ENABLE_BIT_MASK                           (uint8_t)(0x01 << BOARD_FPD_UB926_BC_ENABLE_SHIFT_CNT)

#define BOARD_FPD_UB926_ID_SETTING_BIT_MASK                          (uint8_t)(0x01  << BOARD_FPD_UB926_ID_SETTING_SHIFT_CNT)

#define BOARD_FPD_UB926_DEVICE_ID_BIT_MASK                           (uint8_t)(0x07F << BOARD_FPD_UB926_DEVICE_ID_SHIFT_CNT)

#define BOARD_FPD_UB926_I2C_PASS_THROUGH_BIT_MASK                    (uint8_t)(0x01  << BOARD_FPD_UB926_I2C_PASS_THROUGH_SHIFT_CNT)

#define BOARD_FPD_UB926_I2C_PASS_THROUGH_ALL_BIT_MASK                (uint8_t)(0x01  << BOARD_FPD_UB926_I2C_PASS_THROUGH_ALL_SHIFT_CNT)

#define BOARD_FPD_UB926_OVERRIDE_FC_CONFIG_BIT_MASK                  (uint8_t)(0x01 << BOARD_FPD_UB926_OVERRIDE_FC_CONFIG_SHIFT_CNT)

#define BOARD_FPD_UB926_PASS_RGB_BIT_MASK                            (uint8_t)(0x01 << BOARD_FPD_UB926_PASS_RGB_SHIFT_CNT)

#define BOARD_FPD_UB926_I2S_GEN_BIT_MASK                             (uint8_t)(0x01 << BOARD_FPD_UB926_I2S_GEN_SHIFT_CNT)

#define BOARD_FPD_UB926_RGB_18BIT_MODE_BIT_MASK                      (uint8_t)(0x01 << BOARD_FPD_UB926_RGB_18BIT_MODE_SHIFT_CNT)

#define BOARD_FPD_UB926_I2S_TRANSPOER_SEL_BIT_MASK                   (uint8_t)(0x01 << BOARD_FPD_UB926_I2S_TRANSPOER_SEL_SHIFT_CNT)

#define BOARD_FPD_UB926_I2S_CHANNEL_B_ENABLE_BIT_MASK                (uint8_t)(0x01 << BOARD_FPD_UB926_I2S_CHANNEL_B_ENABLE_SHIFT_CNT)

#define BOARD_FPD_UB926_I2S_CHANNEL_B_OVERRIDE_BIT_MASK              (uint8_t)(0x01 << BOARD_FPD_UB926_I2S_CHANNEL_B_OVERRIDE_SHIFT_CNT)

#define BOARD_FPD_UB926_I2S_PLL_LOCK_STATUS_BIT_MASK                 (uint8_t)(0x01 << BOARD_FPD_UB926_I2S_PLL_LOCK_STATUS_SHIFT_CNT)

/* @} */

Board_STATUS Board_fpdUb926SetI2SChBEnableModeCtrl(void *handle,
                                                   Board_FpdModuleObj *fpdModParams,
                                                   uint8_t cfgMode);

Board_STATUS Board_fpdUb926SetI2SChBOverrideModeCtrl(void *handle,
                                                     Board_FpdModuleObj *fpdModParams,
                                                     uint8_t cfgMode);

Board_STATUS Board_fpdUb926SetI2STransportSelModeCtrl(void *handle,
                                                      Board_FpdModuleObj *fpdModParams,
                                                      uint8_t cfgMode);

Board_STATUS Board_fpdUb926SetI2SGenModeCtrl(void *handle,
                                             Board_FpdModuleObj *fpdModParams,
                                             uint8_t cfgMode);

Board_STATUS Board_fpdUb926SetPassRGBModeCtrl(void *handle,
                                              Board_FpdModuleObj *fpdModParams,
                                              uint8_t cfgMode);

Board_STATUS Board_fpdUb926SetOverrideFCConfigModeCtrl(void *handle,
                                                       Board_FpdModuleObj *fpdModParams,
                                                       uint8_t cfgMode);

Board_STATUS Board_fpdUb926SetRGB18bitModeCtrl(void *handle,
                                               Board_FpdModuleObj *fpdModParams,
                                               uint8_t cfgMode);

Board_STATUS Board_fpdUb926GetPLLLockStatus(void *handle,
                                            Board_FpdModuleObj *fpdModParams,
                                            bool *pllLockStatus);


Board_STATUS Board_fpdUb926RmtSerSlvDevAliasIdCfg(void *handle,
                                                  Board_FpdModuleObj *fpdModParams,
                                                  Board_FpdRmtDevObj *fpdRmtParams);

Board_STATUS Board_fpdUb926SetI2CPassThrAllModeCtrl(void *handle,
                                                    Board_FpdModuleObj *fpdModParams,
                                                    uint8_t cfgMode);

Board_STATUS Board_fpdUb926SetI2CPassThrModeCtrl(void *handle,
                                                 Board_FpdModuleObj *fpdModParams,
                                                 uint8_t cfgMode);

Board_STATUS Board_fpdUb926SetI2CBusFreq(void *handle,
                                         Board_FpdModuleObj *fpdModParams,
                                         uint8_t cfgBitRate);

Board_STATUS Board_fpdUb926SetBackChModeCtrl(void *handle,
                                             Board_FpdModuleObj *fpdModParams,
                                             uint8_t cfgMode);

Board_STATUS Board_fpdUb926SetDigitalRst1ModeCtrl(void *handle,
                                                  Board_FpdModuleObj *fpdModParams,
                                                  uint8_t cfgMode);

Board_STATUS Board_fpdUb926SetRmtAutoPwrDwnModeCtrl(void *handle,
                                                    Board_FpdModuleObj *fpdModParams,
                                                    uint8_t cfgMode);

void Board_fpdUb926GetI2CAddr(uint8_t *domain,
                              uint8_t *chNum,
                              uint8_t *i2cAddr);


#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* _DS90UB926_H_ */

/* @} */