hal_display_dsi.h

/* Copyright Statement:
 *
 * (C) 2005-2016 MediaTek Inc. All rights reserved.
 *
 * This software/firmware and related documentation ("MediaTek Software") are
 * protected under relevant copyright laws. The information contained herein
 * is confidential and proprietary to MediaTek Inc. ("MediaTek") and/or its licensors.
 * Without the prior written permission of MediaTek and/or its licensors,
 * any reproduction, modification, use or disclosure of MediaTek Software,
 * and information contained herein, in whole or in part, shall be strictly prohibited.
 * You may only use, reproduce, modify, or distribute (as applicable) MediaTek Software
 * if you have agreed to and been bound by the applicable license agreement with
 * MediaTek ("License Agreement") and been granted explicit permission to do so within
 * the License Agreement ("Permitted User"). If you are not a Permitted User,
 * please cease any access or use of MediaTek Software immediately.
 * BY OPENING THIS FILE, RECEIVER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
 * THAT MEDIATEK SOFTWARE RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES
 * ARE PROVIDED TO RECEIVER ON AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL
 * WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
 * NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
 * SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
 * SUPPLIED WITH MEDIATEK SOFTWARE, AND RECEIVER AGREES TO LOOK ONLY TO SUCH
 * THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. RECEIVER EXPRESSLY ACKNOWLEDGES
 * THAT IT IS RECEIVER'S SOLE RESPONSIBILITY TO OBTAIN FROM ANY THIRD PARTY ALL PROPER LICENSES
 * CONTAINED IN MEDIATEK SOFTWARE. MEDIATEK SHALL ALSO NOT BE RESPONSIBLE FOR ANY MEDIATEK
 * SOFTWARE RELEASES MADE TO RECEIVER'S SPECIFICATION OR TO CONFORM TO A PARTICULAR
 * STANDARD OR OPEN FORUM. RECEIVER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND
 * CUMULATIVE LIABILITY WITH RESPECT TO MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
 * AT MEDIATEK'S OPTION, TO REVISE OR REPLACE MEDIATEK SOFTWARE AT ISSUE,
 * OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY RECEIVER TO
 * MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
 */

#include "hal_platform.h"

#ifndef __HAL_DISPLAY_DSI_H__
#define __HAL_DISPLAY_DSI_H__

#ifdef HAL_DISPLAY_DSI_MODULE_ENABLED

#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    HAL_DISPLAY_DSI_STATUS_INITIALIZATION_FAILED = -6,      
    HAL_DISPLAY_DSI_STATUS_POWER_FAILED = -5,               
    HAL_DISPLAY_DSI_STATUS_COMMAND_QUEUE_FAILED = -4,       
    HAL_DISPLAY_DSI_STATUS_INVALID_PARAMETER = -3,          
    HAL_DISPLAY_DSI_STATUS_READ_FAILED = -2,                
    HAL_DISPLAY_DSI_STATUS_ERROR = -1,                      
    HAL_DISPLAY_DSI_STATUS_OK = 0,                          
} hal_display_dsi_status_t;

typedef enum {
    HAL_DISPLAY_DSI_TRANSFER_MODE_LP = 0,               
    HAL_DISPLAY_DSI_TRANSFER_MODE_HS,                   
    HAL_DISPLAY_DSI_TRANSFER_MODE_AUTO,                 
    HAL_DISPLAY_DSI_TRANSFER_MODE_NUM                   
} hal_display_dsi_transfer_mode_t;

typedef struct {
    uint32_t    da_hs_trail;                
    uint32_t    da_hs_zero;                 
    uint32_t    da_hs_prep;                 
    uint32_t    lpx;                        
    uint32_t    da_hs_exit;                 
    uint32_t    ta_get;                     
    uint32_t    ta_sure;                    
    uint32_t    ta_go;                      
    uint32_t    clk_hs_trail;               
    uint32_t    clk_hs_zero;                
    uint32_t    clk_hs_post;                
    uint32_t    clk_hs_prep;                
} hal_display_dsi_dphy_timing_struct_t;

hal_display_dsi_status_t hal_display_dsi_init(bool ssc_enable);
hal_display_dsi_status_t hal_display_dsi_deinit(void);

hal_display_dsi_status_t hal_display_dsi_power_on(void);

hal_display_dsi_status_t hal_display_dsi_power_off(void);

hal_display_dsi_status_t hal_display_dsi_enable_te(void);

hal_display_dsi_status_t hal_display_dsi_set_command_queue(uint32_t *pData, uint8_t size, bool forced_update);

hal_display_dsi_status_t hal_display_dsi_set_command_queue_ex(uint32_t command, uint32_t size, uint32_t *data, bool forced_update);

hal_display_dsi_status_t hal_display_dsi_read_register(uint8_t command, uint8_t *buffer, uint8_t size);

hal_display_dsi_status_t hal_display_dsi_enter_ulps(void);

hal_display_dsi_status_t hal_display_dsi_exit_ulps(void);

hal_display_dsi_status_t hal_display_dsi_set_dphy_timing(hal_display_dsi_dphy_timing_struct_t *timing);

hal_display_dsi_status_t hal_display_dsi_set_clock(uint32_t pll_clock, bool ssc_enable);

hal_display_dsi_status_t hal_display_dsi_set_transfer_mode(hal_display_dsi_transfer_mode_t mode);

void hal_dsiplay_dsi_start_bta_transfer(uint32_t command);

void hal_display_dsi_start_bta_transfer(uint32_t command);


void hal_display_dsi_restore_callback(void);

hal_display_dsi_status_t hal_display_dsi_apply_setting(void);

#ifdef __cplusplus
}
#endif

#endif /* HAL_DISPALY_DSI_MODULE_ENABLED */
#endif /* __HAL_DISPLAY_DSI_H__ */