TI J721E Imaging User Guide
hwa_vpac_viss.h
Go to the documentation of this file.
1 /*
2  *
3  * Copyright (c) 2019-2021 Texas Instruments Incorporated
4  *
5  * All rights reserved not granted herein.
6  *
7  * Limited License.
8  *
9  * Texas Instruments Incorporated grants a world-wide, royalty-free, non-exclusive
10  * license under copyrights and patents it now or hereafter owns or controls to make,
11  * have made, use, import, offer to sell and sell ("Utilize") this software subject to the
12  * terms herein. With respect to the foregoing patent license, such license is granted
13  * solely to the extent that any such patent is necessary to Utilize the software alone.
14  * The patent license shall not apply to any combinations which include this software,
15  * other than combinations with devices manufactured by or for TI ("TI Devices").
16  * No hardware patent is licensed hereunder.
17  *
18  * Redistributions must preserve existing copyright notices and reproduce this license
19  * (including the above copyright notice and the disclaimer and (if applicable) source
20  * code license limitations below) in the documentation and/or other materials provided
21  * with the distribution
22  *
23  * Redistribution and use in binary form, without modification, are permitted provided
24  * that the following conditions are met:
25  *
26  * * No reverse engineering, decompilation, or disassembly of this software is
27  * permitted with respect to any software provided in binary form.
28  *
29  * * any redistribution and use are licensed by TI for use only with TI Devices.
30  *
31  * * Nothing shall obligate TI to provide you with source code for the software
32  * licensed and provided to you in object code.
33  *
34  * If software source code is provided to you, modification and redistribution of the
35  * source code are permitted provided that the following conditions are met:
36  *
37  * * any redistribution and use of the source code, including any resulting derivative
38  * works, are licensed by TI for use only with TI Devices.
39  *
40  * * any redistribution and use of any object code compiled from the source code
41  * and any resulting derivative works, are licensed by TI for use only with TI Devices.
42  *
43  * Neither the name of Texas Instruments Incorporated nor the names of its suppliers
44  *
45  * may be used to endorse or promote products derived from this software without
46  * specific prior written permission.
47  *
48  * DISCLAIMER.
49  *
50  * THIS SOFTWARE IS PROVIDED BY TI AND TI'S LICENSORS "AS IS" AND ANY EXPRESS
51  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
52  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
53  * IN NO EVENT SHALL TI AND TI'S LICENSORS BE LIABLE FOR ANY DIRECT, INDIRECT,
54  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
55  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
56  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
57  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
58  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
59  * OF THE POSSIBILITY OF SUCH DAMAGE.
60  *
61  */
62 
63 #ifndef HWA_VPAC_VISS_H_
64 #define HWA_VPAC_VISS_H_
65 
66 #include <VX/vx.h>
67 #include <VX/vx_kernels.h>
68 
69 #include <TI/hwa_vpac_viss_fcp.h>
70 
71 #ifdef VPAC3
72 #include <TI/hwa_vpac_viss3.h>
73 #elif defined (VPAC3L)
74 #include <TI/hwa_vpac_viss3l.h>
75 #else
76 #include <TI/hwa_vpac_viss1.h>
77 #endif
78 
79 #ifdef __cplusplus
80 extern "C" {
81 #endif
82 
91 #define TIVX_KERNEL_VPAC_VISS_NAME "com.ti.hwa.vpac_viss"
92 
93 /*********************************
94  * VPAC_VISS Control Commands
95  *********************************/
96 
115 #define TIVX_VPAC_VISS_CMD_SET_DCC_PARAMS (0x30000000u)
116 
130 #define TIVX_VPAC_VISS_CMD_GET_ERR_STATUS (0x30000001u)
131 
135 #define TIVX_VPAC_VISS_CMD_GET_PSA_STATUS (0x30000002u)
136 
137 /*********************************
138  * VPAC_VISS Defines
139  *********************************/
140 
147 #define TIVX_VPAC_VISS_MAX_H3A_STAT_NUMBYTES (24576U)
148 
158 #define TIVX_VPAC_VISS_H3A_OUT_BUFF_ALIGN (64U)
159 
167 #define TIVX_VPAC_VISS_H3A_IN_RAW0 (0U)
168 
169 #define TIVX_VPAC_VISS_H3A_IN_RAW1 (1U)
170 
171 #define TIVX_VPAC_VISS_H3A_IN_RAW2 (2U)
172 
173 #define TIVX_VPAC_VISS_H3A_IN_LSC (3U)
174 #ifdef VPAC3L
175 
176 #define TIVX_VPAC_VISS_H3A_IN_PCID (4U)
177 #endif
178 
179 #define TIVX_VPAC_VISS_H3A_MODE_AEWB (0U)
180 
181 #define TIVX_VPAC_VISS_H3A_MODE_AF (1U)
182 
193 #define TIVX_VPAC_VISS_RAWFE_CFG_ERR_INTR (0x1U)
194 
195 #define TIVX_VPAC_VISS_RAWFE_AEW_PULSE_INTR (0x2U)
196 
197 #define TIVX_VPAC_VISS_RAWFE_AF_PULSE_INTR (0x4U)
198 
199 #define TIVX_VPAC_VISS_RAWFE_H3A_PULSE_INTR (0x8U)
200 
201 #define TIVX_VPAC_VISS_RAWFE_H3A_BUF_OVRFLOW_PULSE_INTR (0x10U)
202 
203 #define TIVX_VPAC_VISS_NSF4V_LINEMEM_CFG_ERR_INTR (0x20U)
204 
205 #define TIVX_VPAC_VISS_NSF4V_HBLANK_ERR_INTR (0x40U)
206 
207 #define TIVX_VPAC_VISS_NSF4V_VBLANK_ERR_INTR (0x80U)
208 
209 #define TIVX_VPAC_VISS_GLBCE_CFG_ERR_INTR (0x100U)
210 
211 #define TIVX_VPAC_VISS_GLBCE_FILT_START_INTR (0x200U)
212 
213 #define TIVX_VPAC_VISS_GLBCE_FILT_DONE_INTR (0x400U)
214 
215 #define TIVX_VPAC_VISS_GLBCE_HSYNC_ERR_INTR (0x800U)
216 
217 #define TIVX_VPAC_VISS_GLBCE_VSYNC_ERR_INTR (0x1000U)
218 
219 #define TIVX_VPAC_VISS_GLBCE_VP_ERR_INTR (0x2000U)
220 
221 #define TIVX_VPAC_VISS_FCFA_CFG_ERR_INTR (0x4000U)
222 
226 #define TIVX_VPAC_VISS_FCC_CFG_ERR_INTR (0x8000U)
227 
229 #define TIVX_VPAC_VISS_FCC_OUTIF_OVF_ERR_INTR (0x10000U)
230 
233 #define TIVX_VPAC_VISS_FCC_HIST_READ_ERR_INTR (0x20000U)
234 
235 #define TIVX_VPAC_VISS_EE_CFG_ERR (0x40000U)
236 
237 #define TIVX_VPAC_VISS_EE_SYNCOVF_ERR (0x80000U)
238 
239 #define TIVX_VPAC_VISS_LSE_FR_DONE_EVT_INTR (0x100000U)
240 
241 #define TIVX_VPAC_VISS_LSE_SL2_RD_ERR_INTR (0x200000U)
242 
243 #define TIVX_VPAC_VISS_LSE_SL2_WR_ERR_INTR (0x400000U)
244 
245 #define TIVX_VPAC_VISS_LSE_CAL_VP_ERR_INTR (0x800000U)
246 
247 #define TIVX_VPAC_VISS_LSE_OUT_FR_START_EVT_INTR (0x1000000U)
248 #if defined(VPAC3) || defined(VPAC3L)
249 
250 #define TIVX_VPAC_VISS_RAWFE_X_Y_POINTER (0x2000000U)
251 
253 #define TIVX_VPAC_VISS_CR_CFG_ERR (0x4000000U)
254 
256 #endif
257 #if defined(VPAC3L)
258 #define TIVX_VPAC_VISS_RAWFE_DPC_STATS_READ_ERR (0x8000000U)
259 #endif
260 
261 #define TIVX_VPAC_VISS_WDTIMER_ERR (0x40000000U)
262 
266 /*********************************
267  * VPAC_VISS STRUCTURES
268  *********************************/
269 
279 typedef struct {
290  uint32_t h3a_source_data;
292  uint32_t exposure_time;
294  uint32_t analog_gain;
296  uint32_t ae_valid;
298  uint32_t ae_converged;
300  uint32_t digital_gain;
302  uint32_t wb_gains[4];
304  int32_t wb_offsets[4];
308  uint32_t awb_valid;
310  uint32_t awb_converged;
312 
323 typedef struct
324 {
326  uint16_t aewwin1_WINH;
328  uint16_t aewwin1_WINW;
330  uint16_t aewwin1_WINVC;
332  uint16_t aewwin1_WINHC;
338 
348 typedef struct {
355  uint32_t aew_af_mode;
366  uint32_t h3a_source_data;
372  uint32_t cpu_id;
376  uint32_t channel_id;
378  uint32_t size;
380  uint32_t resv[(TIVX_VPAC_VISS_H3A_OUT_BUFF_ALIGN-(sizeof(tivx_h3a_aew_config)+20U))/4U ];
384 
385 /*********************************
386  * Function Prototypes
387  *********************************/
388 
394 
400 
409 
418 
428 
437 
438 
439 #ifdef __cplusplus
440 }
441 #endif
442 
443 #endif /* HWA_VPAC_VISS_H_ */
444 
void tivx_ae_awb_params_init(tivx_ae_awb_params_t *prms)
Function to initialize AEWB Output Parameters These parameters come from the AEWB algorithm...
uint32_t awb_valid
Definition: hwa_vpac_viss.h:308
Data corresponding to results of 2A algorithm.
Definition: hwa_vpac_viss.h:279
uint32_t exposure_time
Definition: hwa_vpac_viss.h:292
The VISS kernels in this kernel extension.
The VISS kernels in this kernel extension.
uint32_t ae_converged
Definition: hwa_vpac_viss.h:298
void tivx_h3a_aew_config_init(tivx_h3a_aew_config *prms)
Function to initialize H3A aew Config.
void tivxRegisterHwaTargetVpacVissKernels(void)
Function to register HWA Kernels on the vpac_viss Target.
uint32_t h3a_source_data
Definition: hwa_vpac_viss.h:366
The h3a_output data structure used by the TIVX_KERNEL_VISS kernel.
Definition: hwa_vpac_viss.h:348
uint32_t ae_valid
Definition: hwa_vpac_viss.h:296
uint32_t cpu_id
Definition: hwa_vpac_viss.h:372
uint32_t channel_id
Definition: hwa_vpac_viss.h:376
uint32_t size
Definition: hwa_vpac_viss.h:378
void tivxUnRegisterHwaTargetVpacVissKernels(void)
Function to un-register HWA Kernels on the vpac_viss Target.
uint16_t aewwin1_WINW
Definition: hwa_vpac_viss.h:328
uint16_t aewwin1_WINVC
Definition: hwa_vpac_viss.h:330
#define TIVX_VPAC_VISS_H3A_OUT_BUFF_ALIGN
The H3A output memory address alignment.
Definition: hwa_vpac_viss.h:158
The VISS kernels in this kernel extension.
uint16_t aewsubwin_AEWINCH
Definition: hwa_vpac_viss.h:336
uint16_t aewwin1_WINHC
Definition: hwa_vpac_viss.h:332
uint32_t digital_gain
Definition: hwa_vpac_viss.h:300
uint32_t analog_gain
Definition: hwa_vpac_viss.h:294
uint32_t h3a_source_data
Definition: hwa_vpac_viss.h:290
void tivx_h3a_data_init(tivx_h3a_data_t *prms)
Function to initialize H3A data Parameters.
uint32_t awb_converged
Definition: hwa_vpac_viss.h:310
uint32_t color_temperature
Definition: hwa_vpac_viss.h:306
uint16_t aewwin1_WINH
Definition: hwa_vpac_viss.h:326
The configuration data structure used by the TIVX_KERNEL_VISS kernel.
Definition: hwa_vpac_viss1.h:93
tivx_h3a_aew_config aew_config
Definition: hwa_vpac_viss.h:368
H3A AEW configuration data structure used by the TIVX_KERNEL_VISS kernel.
Definition: hwa_vpac_viss.h:323
uint32_t aew_af_mode
Definition: hwa_vpac_viss.h:355
void tivx_vpac_viss_params_init(tivx_vpac_viss_params_t *prms)
Function to initialize VISS Parameters.
#define TIVX_VPAC_VISS_MAX_H3A_STAT_NUMBYTES
Maximum H3A number of bytes in statistics data array.
Definition: hwa_vpac_viss.h:147
The VISS FCP structures in this kernel extension.
uint16_t aewsubwin_AEWINCV
Definition: hwa_vpac_viss.h:334