MT7687 API Reference  LinkIt SDK v4
hal_display_dsi.h
1 /* Copyright Statement:
2  *
3  * (C) 2005-2016 MediaTek Inc. All rights reserved.
4  *
5  * This software/firmware and related documentation ("MediaTek Software") are
6  * protected under relevant copyright laws. The information contained herein
7  * is confidential and proprietary to MediaTek Inc. ("MediaTek") and/or its licensors.
8  * Without the prior written permission of MediaTek and/or its licensors,
9  * any reproduction, modification, use or disclosure of MediaTek Software,
10  * and information contained herein, in whole or in part, shall be strictly prohibited.
11  * You may only use, reproduce, modify, or distribute (as applicable) MediaTek Software
12  * if you have agreed to and been bound by the applicable license agreement with
13  * MediaTek ("License Agreement") and been granted explicit permission to do so within
14  * the License Agreement ("Permitted User"). If you are not a Permitted User,
15  * please cease any access or use of MediaTek Software immediately.
16  * BY OPENING THIS FILE, RECEIVER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
17  * THAT MEDIATEK SOFTWARE RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES
18  * ARE PROVIDED TO RECEIVER ON AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL
19  * WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
21  * NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
22  * SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
23  * SUPPLIED WITH MEDIATEK SOFTWARE, AND RECEIVER AGREES TO LOOK ONLY TO SUCH
24  * THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. RECEIVER EXPRESSLY ACKNOWLEDGES
25  * THAT IT IS RECEIVER'S SOLE RESPONSIBILITY TO OBTAIN FROM ANY THIRD PARTY ALL PROPER LICENSES
26  * CONTAINED IN MEDIATEK SOFTWARE. MEDIATEK SHALL ALSO NOT BE RESPONSIBLE FOR ANY MEDIATEK
27  * SOFTWARE RELEASES MADE TO RECEIVER'S SPECIFICATION OR TO CONFORM TO A PARTICULAR
28  * STANDARD OR OPEN FORUM. RECEIVER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND
29  * CUMULATIVE LIABILITY WITH RESPECT TO MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
30  * AT MEDIATEK'S OPTION, TO REVISE OR REPLACE MEDIATEK SOFTWARE AT ISSUE,
31  * OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY RECEIVER TO
32  * MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
33  */
34 
35 #include "hal_platform.h"
36 
37 #ifndef __HAL_DISPLAY_DSI_H__
38 #define __HAL_DISPLAY_DSI_H__
39 
40 #ifdef HAL_DISPLAY_DSI_MODULE_ENABLED
41 
125 #ifdef __cplusplus
126 extern "C" {
127 #endif
128 
133 typedef enum {
134  HAL_DISPLAY_DSI_STATUS_INITIALIZATION_FAILED = -6,
135  HAL_DISPLAY_DSI_STATUS_POWER_FAILED = -5,
136  HAL_DISPLAY_DSI_STATUS_COMMAND_QUEUE_FAILED = -4,
137  HAL_DISPLAY_DSI_STATUS_INVALID_PARAMETER = -3,
138  HAL_DISPLAY_DSI_STATUS_READ_FAILED = -2,
139  HAL_DISPLAY_DSI_STATUS_ERROR = -1,
140  HAL_DISPLAY_DSI_STATUS_OK = 0,
141 } hal_display_dsi_status_t;
142 
144 typedef enum {
145  HAL_DISPLAY_DSI_TRANSFER_MODE_LP = 0,
146  HAL_DISPLAY_DSI_TRANSFER_MODE_HS,
147  HAL_DISPLAY_DSI_TRANSFER_MODE_AUTO,
148  HAL_DISPLAY_DSI_TRANSFER_MODE_NUM
149 } hal_display_dsi_transfer_mode_t;
150 
163 typedef struct {
164  uint32_t da_hs_trail;
165  uint32_t da_hs_zero;
166  uint32_t da_hs_prep;
167  uint32_t lpx;
168  uint32_t da_hs_exit;
169  uint32_t ta_get;
170  uint32_t ta_sure;
171  uint32_t ta_go;
172  uint32_t clk_hs_trail;
173  uint32_t clk_hs_zero;
174  uint32_t clk_hs_post;
175  uint32_t clk_hs_prep;
176 } hal_display_dsi_dphy_timing_struct_t;
177 
191 hal_display_dsi_status_t hal_display_dsi_init(bool ssc_enable);
192 hal_display_dsi_status_t hal_display_dsi_deinit(void);
200 
208 hal_display_dsi_status_t hal_display_dsi_power_on(void);
209 
217 hal_display_dsi_status_t hal_display_dsi_power_off(void);
218 
226 hal_display_dsi_status_t hal_display_dsi_enable_te(void);
227 
239 hal_display_dsi_status_t hal_display_dsi_set_command_queue(uint32_t *pData, uint8_t size, bool forced_update);
240 
253 hal_display_dsi_status_t hal_display_dsi_set_command_queue_ex(uint32_t command, uint32_t size, uint32_t *data, bool forced_update);
254 
266 hal_display_dsi_status_t hal_display_dsi_read_register(uint8_t command, uint8_t *buffer, uint8_t size);
267 
275 hal_display_dsi_status_t hal_display_dsi_enter_ulps(void);
276 
284 hal_display_dsi_status_t hal_display_dsi_exit_ulps(void);
285 
295 hal_display_dsi_status_t hal_display_dsi_set_dphy_timing(hal_display_dsi_dphy_timing_struct_t *timing);
296 
307 hal_display_dsi_status_t hal_display_dsi_set_clock(uint32_t pll_clock, bool ssc_enable);
308 
318 hal_display_dsi_status_t hal_display_dsi_set_transfer_mode(hal_display_dsi_transfer_mode_t mode);
319 
329 void hal_dsiplay_dsi_start_bta_transfer(uint32_t command);
330 
338 void hal_display_dsi_start_bta_transfer(uint32_t command);
339 
340 
346 void hal_display_dsi_restore_callback(void);
347 
356 hal_display_dsi_status_t hal_display_dsi_apply_setting(void);
357 
358 #ifdef __cplusplus
359 }
360 #endif
361 
367 #endif /* HAL_DISPALY_DSI_MODULE_ENABLED */
368 #endif /* __HAL_DISPLAY_DSI_H__ */
369