PDK API Guide for J721E
dss.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) Texas Instruments Incorporated 2018 - 2022
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *
12  * Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in the
14  * documentation and/or other materials provided with the
15  * distribution.
16  *
17  * Neither the name of Texas Instruments Incorporated nor the names of
18  * its contributors may be used to endorse or promote products derived
19  * from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33 
42 /* @} */
43 
58 #ifndef DSS_H_
59 #define DSS_H_
60 
61 /* ========================================================================== */
62 /* Include Files */
63 /* ========================================================================== */
64 
65 #include <stdint.h>
66 #include <ti/csl/soc.h>
67 #include <ti/csl/csl_dss.h>
68 #include <ti/drv/fvid2/fvid2.h>
70 #include <ti/drv/dss/soc/dss_soc.h>
74 
75 #ifdef __cplusplus
76 extern "C" {
77 #endif
78 
79 /* ========================================================================== */
80 /* Macros & Typedefs */
81 /* ========================================================================== */
82 
84 #define DSS_DISP_DRV_ID (FVID2_DSS_DRV_BASE + 0x00U)
85 
87 #define DSS_DCTRL_DRV_ID (FVID2_DSS_DRV_BASE + 0x01U)
88 
90 #define DSS_M2M_DRV_ID (FVID2_DSS_DRV_BASE + 0x02U)
91 
92 /*
93  * IOCTLs Base address.
94  */
96 #define DSS_DISP_IOCTL_BASE (FVID2_DSS_DRV_IOCTL_BASE + 0x000U)
97 
98 #define DSS_DCTRL_IOCTL_BASE (FVID2_DSS_DRV_IOCTL_BASE + 0x100U)
99 
100 #define DSS_DISP_SOC_IOCTL_BASE (DSS_DISP_IOCTL_BASE + 0x40U)
101 
103 #define DSS_DCTRL_SOC_IOCTL_BASE (DSS_DCTRL_IOCTL_BASE + 0x40U)
104 
105 #define DSS_M2M_IOCTL_BASE (FVID2_DSS_DRV_IOCTL_BASE + 0x200U)
106 
107 /* ========================================================================== */
108 /* Structure Declarations */
109 /* ========================================================================== */
110 
114 typedef struct
115 {
119 
120 /* ========================================================================== */
121 /* Internal/Private Function Declarations */
122 /* ========================================================================== */
123 
124 /* None */
125 
126 /* ========================================================================== */
127 /* Function Declarations */
128 /* ========================================================================== */
129 
137 void Dss_initParamsInit(Dss_InitParams *dssParams);
138 
150 int32_t Dss_init(const Dss_InitParams *initParams);
151 
160 int32_t Dss_deInit(void);
161 
162 /* ========================================================================== */
163 /* Static Function Definitions */
164 /* ========================================================================== */
165 
166 /* None */
167 
168 #ifdef __cplusplus
169 }
170 #endif
171 
172 #endif /* #ifndef DSS_H_ */
173 
174 /* @} */
int32_t Dss_init(const Dss_InitParams *initParams)
DSS initialization function. This function initializes the DSS hardware and drivers....
int32_t Dss_deInit(void)
DSS de-initialization function. This function un-initializes the DSS hardware and drivers....
DSS Driver configuration file.
DSS Controller Driver API/interface file.
Dss_SocParams socParams
Definition: dss.h:116
DSS initialization parameters.
Definition: dss.h:114
DSS Display Write-back Driver interface file.
DSS SOC parameters.
Definition: dss_soc.h:346
DSS Display Driver interface file.
void Dss_initParamsInit(Dss_InitParams *dssParams)
Dss_InitParams structure init function.
This file contains the CSL-FL API's for DSS.