hal_display_lcd.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.
 */

#ifndef __HAL_DISPLAY_LCD_H__
#define __HAL_DISPLAY_LCD_H__

#include "hal_platform.h"

#ifdef HAL_DISPLAY_LCD_MODULE_ENABLED

#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    HAL_DISPLAY_LCD_LAYER_ROTATE_0 = 0x0,                           
    HAL_DISPLAY_LCD_LAYER_ROTATE_90 = 0x1,                          
    HAL_DISPLAY_LCD_LAYER_ROTATE_180 = 0x2,                         
    HAL_DISPLAY_LCD_LAYER_ROTATE_270 = 0x3,                         
    HAL_DISPLAY_LCD_LAYER_ROTATE_0_FLIP = 0x4,                      
    HAL_DISPLAY_LCD_LAYER_ROTATE_90_FLIP = 0x5,                     
    HAL_DISPLAY_LCD_LAYER_ROTATE_180_FLIP = 0x6,                    
    HAL_DISPLAY_LCD_LAYER_ROTATE_270_FLIP = 0x7,                    
    HAL_DISPLAY_LCD_LAYER_ROTATE_NUM                                
} hal_display_lcd_layer_rotate_t;

typedef enum {
    HAL_DISPLAY_LCD_STATUS_INITIALIZATION_FAILED = -8,                          
    HAL_DISPLAY_LCD_STATUS_COLOR_INITIALIZATION_FAILED = -7,                    
    HAL_DISPLAY_LCD_STATUS_DSI_INITIALIZATION_FAILED = -6,                      
    HAL_DISPLAY_LCD_STATUS_INVALID_PARAMETER = -5,                           
    HAL_DISPLAY_LCD_STATUS_COLOR_INVALID_PARAMETER = -4,                     
    HAL_DISPLAY_LCD_STATUS_DSI_INVALID_PARAMETER = -3,                       
    HAL_DISPLAY_LCD_STATUS_POWER_FAILED = -2,                               
    HAL_DISPLAY_LCD_STATUS_ERROR = -1,                                  
    HAL_DISPLAY_LCD_STATUS_OK = 0,                                      
} hal_display_lcd_status_t;

typedef enum {
    HAL_DISPLAY_LCD_INTERFACE_WIDTH_8 = 0,                            
    HAL_DISPLAY_LCD_INTERFACE_WIDTH_9,                                
    HAL_DISPLAY_LCD_INTERFACE_WIDTH_16,                               
    HAL_DISPLAY_LCD_INTERFACE_WIDTH_18,                               
    HAL_DISPLAY_LCD_INTERFACE_WIDTH_24,                               
    HAL_DISPLAY_LCD_INTERFACE_WIDTH_32,                               
    HAL_DISPLAY_LCD_INTERFACE_WIDTH_NUM                               
} hal_display_lcd_interface_width_t;

typedef enum {
    HAL_DISPLAY_LCD_INTERFACE_2PIN_WIDTH_16 = 2,                      
    HAL_DISPLAY_LCD_INTERFACE_2PIN_WIDTH_18 = 3,                      
    HAL_DISPLAY_LCD_INTERFACE_2PIN_WIDTH_24 = 4,                      
    HAL_DISPLAY_LCD_INTERFACE_2PIN_WIDTH_12 = 6,                      
    HAL_DISPLAY_LCD_INTERFACE_2PIN_WIDTH_NUM                          
} hal_display_lcd_interface_2pin_width_t;

typedef enum {
    HAL_DISPLAY_LCD_INTERFACE_START_BYTE_WIDTH_8 = 0,               
    HAL_DISPLAY_LCD_INTERFACE_START_BYTE_WIDTH_9,                   
    HAL_DISPLAY_LCD_INTERFACE_START_BYTE_WIDTH_16,                  
    HAL_DISPLAY_LCD_INTERFACE_START_BYTE_WIDTH_18,                  
    HAL_DISPLAY_LCD_INTERFACE_START_BYTE_WIDTH_24,                  
    HAL_DISPLAY_LCD_INTERFACE_START_BYTE_WIDTH_32,                  
    HAL_DISPLAY_LCD_INTERFACE_START_BYTE_WIDTH_NUM                  
} hal_display_lcd_interface_start_byte_width_t;

typedef enum {
    HAL_DISPLAY_LCD_INTERFACE_CLOCK_124MHZ = 0,                        
    HAL_DISPLAY_LCD_INTERFACE_CLOCK_104MHZ = 1,                        
    HAL_DISPLAY_LCD_INTERFACE_CLOCK_91MHZ = 2,                         
    HAL_DISPLAY_LCD_INTERFACE_CLOCK_26MHZ = 3,                         
    HAL_DISPLAY_LCD_INTERFACE_CLOCK_RSVD = 4                           
} hal_display_lcd_interface_clock_t;

typedef enum {
    HAL_DISPLAY_LCD_LAYER_COLOR_8BPP_INDEX = 0,                     
    HAL_DISPLAY_LCD_LAYER_COLOR_RGB565,                             
    HAL_DISPLAY_LCD_LAYER_COLOR_UYVY422,                            
    HAL_DISPLAY_LCD_LAYER_COLOR_RGB888,                             
    HAL_DISPLAY_LCD_LAYER_COLOR_ARGB8888,                           
    HAL_DISPLAY_LCD_LAYER_COLOR_PARGB8888,                          
    HAL_DISPLAY_LCD_LAYER_COLOR_XRGB,                               
    HAL_DISPLAY_LCD_LAYER_COLOR_ARGB6666,                           
    HAL_DISPLAY_LCD_LAYER_COLOR_PARGB6666,                          
    HAL_DISPLAY_LCD_LAYER_COLOR_4BIT_INDEX,                         
    HAL_DISPLAY_LCD_LAYER_COLOR_2BIT_INDEX,                         
    HAL_DISPLAY_LCD_LAYER_COLOR_1BIT_INDEX,                         
    HAL_DISPLAY_LCD_LAYER_COLOR_NUM                                 
} hal_display_lcd_layer_source_color_format_t;

typedef enum {
    HAL_DISPLAY_LCD_ROI_OUTPUT_RGB332 = 0,                          
    HAL_DISPLAY_LCD_ROI_OUTPUT_RGB444,                              
    HAL_DISPLAY_LCD_ROI_OUTPUT_RGB565,                              
    HAL_DISPLAY_LCD_ROI_OUTPUT_RGB666,                              
    HAL_DISPLAY_LCD_ROI_OUTPUT_RGB888,                              
    HAL_DISPLAY_LCD_ROI_OUTPUT_NUM                                  
} hal_display_lcd_output_color_format_t;

typedef enum {
    HAL_DISPLAY_LCD_LAYER0 = 0,                                     
    HAL_DISPLAY_LCD_LAYER1,                                         
    HAL_DISPLAY_LCD_LAYER2,                                         
    HAL_DISPLAY_LCD_LAYER3,                                         
    HAL_DISPLAY_LCD_LAYER_NUM                                       
} hal_display_lcd_layer_t;

typedef enum {
    HAL_DISPLAY_LCD_DRIVING_CURRENT_4MA = 0,                                
    HAL_DISPLAY_LCD_DRIVING_CURRENT_8MA,                                    
    HAL_DISPLAY_LCD_DRIVING_CURRENT_12MA,                                   
    HAL_DISPLAY_LCD_DRIVING_CURRENT_16MA,                                   
    HAL_DISPLAY_LCD_DRIVING_CURRENT_NUM                                     
} hal_display_lcd_driving_current_t;

typedef enum {
    HAL_DISPLAY_LCD_POWER_DOMAIN_1V8 = 0,                           
    HAL_DISPLAY_LCD_POWER_DOMAIN_2V8,                               
    HAL_DISPLAY_LCD_POWER_DOMAIN_NUM                                
} hal_display_lcd_power_domain_t;

typedef enum {
    HAL_DISPLAY_LCD_INTERFACE_SERIAL_0 = 0,                                
    HAL_DISPLAY_LCD_INTERFACE_SERIAL_1,                                    
    HAL_DISPLAY_LCD_INTERFACE_NUM                                          
} hal_display_lcd_interface_port_t;


typedef struct {
    uint8_t                             layer_enable;               
    uint8_t                             alpha;                      
    bool                                alpha_flag;                 
    hal_display_lcd_layer_rotate_t      rotate;                     
    bool                                source_key_flag;            
    bool                                rgb_swap_flag;              
    bool                                byte_swap_flag;             
    bool                                dither_flag;                
    hal_display_lcd_layer_source_color_format_t     color_format;   
    bool                                destination_key_flag;       
    uint32_t                            color_key;                  
    uint16_t                            window_x_offset;            
    uint16_t                            window_y_offset;            
    uint32_t                            buffer_address;             
    uint16_t                            row_size;                   
    uint16_t                            column_size;                
    uint16_t                            pitch;                      
} hal_display_lcd_layer_input_t;

typedef struct {
    uint16_t    target_start_x;             
    uint16_t    target_start_y;             
    uint16_t    target_end_x;               
    uint16_t    target_end_y;               
    uint16_t    roi_offset_x;               
    uint16_t    roi_offset_y;               
    uint32_t    roi_background_color;       
    uint32_t    main_lcd_output;            
} hal_display_lcd_roi_output_t;

typedef struct {
    hal_display_lcd_interface_port_t    port_number;    
    uint32_t                css;                        
    uint32_t                csh;                        
    uint32_t                rd_low;                     
    uint32_t                rd_high;                     
    uint32_t                wr_low;                     
    uint32_t                wr_high;                     
    hal_display_lcd_interface_clock_t   clock_freq;     
} hal_display_lcd_interface_timing_t;

typedef struct {
    hal_display_lcd_interface_port_t    port_number;                     
    bool                                three_wire_mode;                 
    bool                                single_a0_mode;                  
    bool                                cs_stay_low_mode;                
    bool                                read_from_SDI;                   
    hal_display_lcd_interface_width_t   width;                           
    hal_display_lcd_driving_current_t   driving_current;                 
    bool                                hw_cs;                           
    hal_display_lcd_power_domain_t      power_domain;                    
    bool                                start_byte_mode;                 
} hal_display_lcd_interface_mode_t;

typedef struct {
    hal_display_lcd_interface_port_t                port_number;                
    hal_display_lcd_interface_start_byte_width_t    start_byte_width;           
    uint32_t                                        byte_switch;                
    uint32_t                                        wr_start_byte;              
    uint32_t                                        wr_start_byte2;             
    uint32_t                                        rd_start_byte;              
} hal_display_lcd_interface_start_byte_mode_t;

typedef struct {
    hal_display_lcd_interface_port_t            port_number;        
    bool                                        two_data_flag;      
    hal_display_lcd_interface_2pin_width_t      two_data_width;     
} hal_display_lcd_interface_2_data_lane_t;

typedef void (*hal_display_lcd_callback_t)(void *data);

hal_display_lcd_status_t hal_display_lcd_init(uint32_t main_command_address, uint32_t main_data_address, uint32_t main_lcd_output_format);
hal_display_lcd_status_t hal_display_lcd_set_interface_timing(hal_display_lcd_interface_timing_t timing_settings);

hal_display_lcd_status_t hal_display_lcd_set_interface_mode(hal_display_lcd_interface_mode_t mode_settings);

hal_display_lcd_status_t hal_display_lcd_set_interface_2data_lane_mode(hal_display_lcd_interface_port_t port, bool flag, hal_display_lcd_interface_2pin_width_t two_data_width);

hal_display_lcd_status_t hal_display_lcd_config_layer(hal_display_lcd_layer_input_t *layer_data);

hal_display_lcd_status_t hal_display_lcd_config_roi(hal_display_lcd_roi_output_t *roi_settings);

hal_display_lcd_status_t hal_display_lcd_config_start_byte(hal_display_lcd_interface_start_byte_mode_t *start_byte_settings);

hal_display_lcd_status_t hal_display_lcd_set_index_color_table(uint32_t *index_table);

hal_display_lcd_callback_t hal_display_lcd_register_callback(hal_display_lcd_callback_t lcd_callback);

hal_display_lcd_status_t hal_display_lcd_init_te(uint32_t frame_rate, uint32_t back_porch, uint32_t front_porch, uint32_t width, uint32_t height, uint32_t main_lcd_output);

hal_display_lcd_status_t hal_display_lcd_calculate_te(uint32_t width, uint32_t height);

hal_display_lcd_status_t hal_display_lcd_toggle_reset(uint32_t low_time, uint32_t high_time);

hal_display_lcd_status_t hal_display_lcd_start_dma(bool wait_te);

uint32_t hal_display_lcd_get_layer_address(hal_display_lcd_layer_t layer);

void hal_display_lcd_restore_callback(void);

hal_display_lcd_status_t hal_display_lcd_turn_on_mtcmos(void);

hal_display_lcd_status_t hal_display_lcd_turn_off_mtcmos(void);

hal_display_lcd_status_t hal_display_lcd_set_clock(hal_display_lcd_interface_clock_t clock);

hal_display_lcd_status_t hal_display_lcd_apply_setting(void);

hal_display_lcd_status_t hal_display_lcd_set_layer_to_default(void);
#ifdef __cplusplus
}
#endif

#endif /* HAL_DISPLAY_LCD_MODULE_ENABLED */
#endif /* __HAL_DISPLAY_LCD_H__ */