Vision Apps User Guide
app_dss.h
Go to the documentation of this file.
1 /*
2  *
3  * Copyright (c) 2018 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 APP_DSS_H_
64 #define APP_DSS_H_
65 
66 /* ========================================================================== */
67 /* Include Files */
68 /* ========================================================================== */
69 
70 #include <stdint.h>
71 #include <stdlib.h>
72 #include <stdbool.h>
73 #include <string.h>
74 
75 #ifdef __cplusplus
76 extern "C" {
77 #endif
78 
79 /* ========================================================================== */
80 /* Macros & Typedefs */
81 /* ========================================================================== */
82 
101 #define APP_DSS_COMM_REG_ID_0 ((uint32_t) 0x0U)
102 
103 #define APP_DSS_COMM_REG_ID_1 ((uint32_t) 0x1U)
104 
105 #define APP_DSS_COMM_REG_ID_2 ((uint32_t) 0x2U)
106 
107 #define APP_DSS_COMM_REG_ID_3 ((uint32_t) 0x3U)
108 
109 #define APP_DSS_COMM_REG_ID_MAX ((uint32_t) 0x4U)
110 /* @} */
111 
120 #define APP_DSS_VID_PIPE_ID_VID1 ((uint32_t) 0x0U)
121 
122 #define APP_DSS_VID_PIPE_ID_VIDL1 ((uint32_t) 0x1U)
123 
124 #define APP_DSS_VID_PIPE_ID_VID2 ((uint32_t) 0x2U)
125 
126 #define APP_DSS_VID_PIPE_ID_VIDL2 ((uint32_t) 0x3U)
127 
128 #define APP_DSS_VID_PIPE_ID_MAX ((uint32_t) 0x4U)
129 /* @} */
130 
139 #define APP_DSS_OVERLAY_ID_1 ((uint32_t) 0x0U)
140 
141 #define APP_DSS_OVERLAY_ID_2 ((uint32_t) 0x1U)
142 
143 #define APP_DSS_OVERLAY_ID_3 ((uint32_t) 0x2U)
144 
145 #define APP_DSS_OVERLAY_ID_4 ((uint32_t) 0x3U)
146 
147 #define APP_DSS_OVERLAY_ID_MAX ((uint32_t) 0x4U)
148 /* @} */
149 
158 #define APP_DSS_VP_ID_1 ((uint32_t) 0x0U)
159 
160 #define APP_DSS_VP_ID_2 ((uint32_t) 0x1U)
161 
162 #define APP_DSS_VP_ID_3 ((uint32_t) 0x2U)
163 
164 #define APP_DSS_VP_ID_4 ((uint32_t) 0x3U)
165 
166 #define APP_DSS_VP_ID_MAX ((uint32_t) 0x4U)
167 /* @} */
168 
177 #define APP_DSS_CSC_RANGE_LIMITED ((uint32_t) 0x0U)
178 
179 #define APP_DSS_CSC_RANGE_FULL ((uint32_t) 0x1U)
180 /* @} */
181 
182 /* ========================================================================== */
183 /* Structure Declarations */
184 /* ========================================================================== */
185 
190 typedef struct
191 {
192  uint32_t isPipeAvailable[APP_DSS_VID_PIPE_ID_MAX];
194  uint32_t isOverlayAvailable[APP_DSS_OVERLAY_ID_MAX];
196  uint32_t isPortAvailable[APP_DSS_VP_ID_MAX];
198  uint32_t isDpAvailable;
200  uint32_t isDsiAvailable;
204 
205 /* ========================================================================== */
206 /* Internal/Private Function Declarations */
207 /* ========================================================================== */
208 
216 static inline void appDssInitParamsInit(app_dss_init_params_t *initParams);
217 
218 /* ========================================================================== */
219 /* Function Declarations */
220 /* ========================================================================== */
221 
229 int32_t appDssInit(app_dss_init_params_t *dssParams);
230 
234 int32_t appDssDeInit(void);
235 
236 
237 /* ========================================================================== */
238 /* Static Function Definitions */
239 /* ========================================================================== */
240 
241 static inline void appDssInitParamsInit(app_dss_init_params_t *initParams)
242 {
243  uint32_t i;
244  if(NULL != initParams)
245  {
246  for(i=0U; i<APP_DSS_VID_PIPE_ID_MAX ; i++)
247  {
248  initParams->isPipeAvailable[i] = false;
249  }
250  for(i=0U; i<APP_DSS_OVERLAY_ID_MAX ; i++)
251  {
252  initParams->isOverlayAvailable[i] = false;
253  }
254  for(i=0U; i<APP_DSS_VP_ID_MAX ; i++)
255  {
256  initParams->isPortAvailable[i] = false;
257  }
258  initParams->isDpAvailable = false;
259  initParams->isDsiAvailable = false;
260  }
261 }
262 
263 /* @} */
264 
265 #ifdef __cplusplus
266 }
267 #endif
268 
269 #endif /* #ifndef APP_DSS_H_ */
int32_t appDssInit(app_dss_init_params_t *dssParams)
DSS initialization function.
uint32_t isOverlayAvailable[APP_DSS_OVERLAY_ID_MAX]
Definition: app_dss.h:194
uint32_t isDpAvailable
Definition: app_dss.h:198
#define APP_DSS_OVERLAY_ID_MAX
Overlay Max Id.
Definition: app_dss.h:147
#define APP_DSS_VP_ID_MAX
Video Port Max Id.
Definition: app_dss.h:166
#define APP_DSS_VID_PIPE_ID_MAX
Video Pipeline Max Id.
Definition: app_dss.h:128
static void appDssInitParamsInit(app_dss_init_params_t *initParams)
app_dss_init_params_t structure init function.
Definition: app_dss.h:241
uint32_t isPipeAvailable[APP_DSS_VID_PIPE_ID_MAX]
Definition: app_dss.h:192
uint32_t isDsiAvailable
Definition: app_dss.h:200
Structure containing DSS resources information. This enables display sharing between two different so...
Definition: app_dss.h:190
uint32_t isPortAvailable[APP_DSS_VP_ID_MAX]
Definition: app_dss.h:196
int32_t appDssDeInit(void)
DSS de-initialization function.