PDK API Guide for J721E
ds90ub925.h
Go to the documentation of this file.
1 /******************************************************************************
2  * Copyright (c) 2019 Texas Instruments Incorporated - http://www.ti.com
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *
11  * Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the
14  * distribution.
15  *
16  * Neither the name of Texas Instruments Incorporated nor the names of
17  * its contributors may be used to endorse or promote products derived
18  * from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  *
32  *****************************************************************************/
33 
53 /* @} */
54 
55 #ifndef _DS90UB925_H_
56 #define _DS90UB925_H_
57 
59 
60 #ifdef __cplusplus
61 extern "C" {
62 #endif
63 
77 #define BOARD_FPD_UB925_I2C_SLV_ADDR (0x1BU)
78 
81 #define BOARD_FPD_UB925_CONFIGURATION1_REG_ADDR (0x04U)
82 
83 #define BOARD_FPD_UB925_GENERAL_STATUS_REG_ADDR (0x0CU)
84 
85 #define BOARD_FPD_UB925_DATA_PATH_CONTROL_REG_ADDR (0x12U)
86 
88 #define BOARD_FPD_UB925_RGB_DE_GATE_SHIFT_CNT (4U)
89 
90 #define BOARD_FPD_UB925_I2S_CHANNEL_B_OVERRIDE_SHIFT_CNT (3U)
91 
92 #define BOARD_FPD_UB925_RGB_18BIT_MODE_SHIFT_CNT (2U)
93 
94 #define BOARD_FPD_UB925_I2S_TRANSPOER_SEL_SHIFT_CNT (1U)
95 
96 #define BOARD_FPD_UB925_I2S_CHANNEL_B_ENABLE_SHIFT_CNT (0U)
97 
98 #define BOARD_FPD_UB925_PCLK_STATUS_SHIFT_CNT (2U)
99 
101 #define BOARD_FPD_UB925_RGB_DE_GATE_BIT_MASK (uint8_t)(0x01 << BOARD_FPD_UB925_RGB_DE_GATE_SHIFT_CNT)
102 
103 #define BOARD_FPD_UB925_I2S_CHANNEL_B_OVERRIDE_BIT_MASK (uint8_t)(0x01 << BOARD_FPD_UB925_I2S_CHANNEL_B_OVERRIDE_SHIFT_CNT)
104 
105 #define BOARD_FPD_UB925_RGB_18BIT_MODE_BIT_MASK (uint8_t)(0x01 << BOARD_FPD_UB925_RGB_18BIT_MODE_SHIFT_CNT)
106 
107 #define BOARD_FPD_UB925_I2S_TRANSPOER_SEL_BIT_MASK (uint8_t)(0x01 << BOARD_FPD_UB925_I2S_TRANSPOER_SEL_SHIFT_CNT)
108 
109 #define BOARD_FPD_UB925_I2S_CHANNEL_B_ENABLE_BIT_MASK (uint8_t)(0x01 << BOARD_FPD_UB925_I2S_CHANNEL_B_ENABLE_SHIFT_CNT)
110 
111 #define BOARD_FPD_UB925_PCLK_STATUS_BIT_MASK (uint8_t)(0x01 << BOARD_FPD_UB925_PCLK_STATUS_SHIFT_CNT)
112 
113 /* @} */
114 
140 Board_STATUS Board_fpdUb925SetRGBGateDEModeCtrl(void *handle,
141  Board_FpdModuleObj *fpdModParams,
142  uint8_t cfgMode);
143 
157 Board_STATUS Board_fpdUb925SetI2SChBModeCtrl(void *handle,
158  Board_FpdModuleObj *fpdModParams,
159  uint8_t cfgMode);
160 
161 
175 Board_STATUS Board_fpdUb925SetI2SChBOverrideModeCtrl(void *handle,
176  Board_FpdModuleObj *fpdModParams,
177  uint8_t cfgMode);
178 
192 Board_STATUS Board_fpdUb925SetI2STransSelModeCtrl(void *handle,
193  Board_FpdModuleObj *fpdModParams,
194  uint8_t cfgMode);
195 
209 Board_STATUS Board_fpdUb925SetRGB18bitModeCtrl(void *handle,
210  Board_FpdModuleObj *fpdModParams,
211  uint8_t cfgMode);
212 
226 Board_STATUS Board_fpdUb925GetPCLKLockStatus(void *handle,
227  Board_FpdModuleObj *fpdModParams,
228  bool *pclkLockStatus);
229 
230 #ifdef __cplusplus
231 }
232 #endif /* __cplusplus */
233 
234 #endif /* _DS90UB925_H_ */
235 
236 /* @} */
Board_STATUS Board_fpdUb925GetPCLKLockStatus(void *handle, Board_FpdModuleObj *fpdModParams, bool *pclkLockStatus)
Get PCLK lock status.
Board_STATUS Board_fpdUb925SetI2STransSelModeCtrl(void *handle, Board_FpdModuleObj *fpdModParams, uint8_t cfgMode)
I2S transport select mode control.
Board_STATUS Board_fpdUb925SetRGB18bitModeCtrl(void *handle, Board_FpdModuleObj *fpdModParams, uint8_t cfgMode)
RGB 18-bit mode control.
FPD module object structure.
Definition: common.h:152
Board_STATUS Board_fpdUb925SetRGBGateDEModeCtrl(void *handle, Board_FpdModuleObj *fpdModParams, uint8_t cfgMode)
RGB gate data enable mode control.
Board_STATUS Board_fpdUb925SetI2SChBModeCtrl(void *handle, Board_FpdModuleObj *fpdModParams, uint8_t cfgMode)
I2S channel-B mode control.
The macro definitions and function prototypes which are common across different board devices.
Board_STATUS Board_fpdUb925SetI2SChBOverrideModeCtrl(void *handle, Board_FpdModuleObj *fpdModParams, uint8_t cfgMode)
I2S channel-B override mode control.