Vision Apps User Guide
app_dss_defaults.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 
69 #ifndef APP_DSS_DEFAULTS_H_
70 #define APP_DSS_DEFAULTS_H_
71 
72 /* ========================================================================== */
73 /* Include Files */
74 /* ========================================================================== */
75 
76 #include <stdint.h>
78 
79 #ifdef __cplusplus
80 extern "C" {
81 #endif
82 
83 /* ========================================================================== */
84 /* Macros & Typedefs */
85 /* ========================================================================== */
86 
88 #define APP_DSS_DEFAULT_DISPLAY_TYPE_EDP (0u)
89 
91 #define APP_DSS_DEFAULT_DISPLAY_TYPE_DPI_HDMI (1u)
92 
94 #define APP_DSS_DEFAULT_DISPLAY_TYPE_DSI (2u)
95 
96 /* ========================================================================== */
97 /* Structure Declarations */
98 /* ========================================================================== */
99 
103 typedef struct {
104 
105  uint32_t width;
106  uint32_t height;
107  uint32_t hFrontPorch;
108  uint32_t hBackPorch;
109  uint32_t hSyncLen;
110  uint32_t vFrontPorch;
111  uint32_t vBackPorch;
112  uint32_t vSyncLen;
113  uint64_t pixelClock;
116 
120 typedef struct {
121 
122  uint32_t display_type;
125  uint32_t enableM2m;
127 
128 
132 typedef struct {
133 
136  uint32_t vid_pipe_to_display_map[APP_DSS_VID_PIPE_ID_MAX];
138  uint32_t enableM2m;
140 
141 /* ========================================================================== */
142 /* Function Declarations */
143 /* ========================================================================== */
144 
149 
154 
158 int32_t appDssDefaultDeInit(void);
159 
164 
169 
173 int32_t appDssDualDisplayDefaultDeInit(void);
174 
175 
176 /* @} */
177 
178 #ifdef __cplusplus
179 }
180 #endif
181 
182 #endif /* #ifndef APP_DSS_DEFAULTS_H_ */
uint32_t enableM2m
Definition: app_dss_defaults.h:125
app_dss_default_timings_prm_t timings
Definition: app_dss_defaults.h:123
int32_t appDssDualDisplayDefaultDeInit(void)
DSS de-initialization wrapper function for dual display mode.
uint32_t hSyncLen
Definition: app_dss_defaults.h:109
uint32_t hBackPorch
Definition: app_dss_defaults.h:108
uint32_t enableM2m
Definition: app_dss_defaults.h:138
uint32_t display_type
Definition: app_dss_defaults.h:122
uint32_t width
Definition: app_dss_defaults.h:105
int32_t appDssDefaultInit(app_dss_default_prm_t *prm)
DSS initialization wrapper function.
uint64_t pixelClock
Definition: app_dss_defaults.h:113
void appDssDefaultSetDefaultPrm(app_dss_default_prm_t *prm)
Set default parameters to use for appDssDefaultInit()
Parameters to use to init display in dual display mode.
Definition: app_dss_defaults.h:132
uint32_t height
Definition: app_dss_defaults.h:106
int32_t appDssDefaultDeInit(void)
DSS de-initialization wrapper function.
#define APP_DSS_VID_PIPE_ID_MAX
Video Pipeline Max Id.
Definition: app_dss.h:128
Parameters to use to init display.
Definition: app_dss_defaults.h:120
uint32_t hFrontPorch
Definition: app_dss_defaults.h:107
uint32_t vBackPorch
Definition: app_dss_defaults.h:111
void appDssDualDisplayDefaultSetDefaultPrm(app_dss_dual_display_default_prm_t *prm)
Set default parameters to use for appDssDualDisplayDefaultInit()
Timing Parameters for display.
Definition: app_dss_defaults.h:103
uint32_t vSyncLen
Definition: app_dss_defaults.h:112
int32_t appDssDualDisplayDefaultInit(app_dss_dual_display_default_prm_t *prm)
DSS initialization wrapper function for dual display mode.
uint32_t vFrontPorch
Definition: app_dss_defaults.h:110