hal_gdc.h File Reference

Header file containing functions prototypes of Graphics library. More...

#include "hal_gfx_sys_defs.h"
#include "hal_gdc_hal.h"
+ Include dependency graph for hal_gdc.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  __hal_gdc_display_t
 Display parameters definition. More...
 
struct  __hal_gdc_layer_t
 Layer parameters definition. More...
 

Macros

#define HAL_GDC_CFG_LAYER_EXISTS(i)   (1U << (8 + (i)*4))
 Configure layer-existence for specifical DC layer
More...
 
#define HAL_GDC_CFG_LAYER_BLENDER(i)   (1U << (8 + (i)*4 + 1))
 Configure blender for specifical DC layer. More...
 
#define HAL_GDC_CFG_LAYER_SCALER(i)   (1U << (8 + (i)*4 + 2))
 Configure scaler for specifical DC layer
More...
 
#define HAL_GDC_CFG_LAYER_GAMMA(i)   (1U << (8 + (i)*4 + 3))
 Configure gamma for specifical DC layer
More...
 
#define HAL_GDC_LAYER_ENABLE   (1U << 31)
 Enable Layer. More...
 
#define HAL_GDC_ENABLE   (1U << 31)
 Enable DC. More...
 
#define HAL_GDC_CFG_L3_YUVMEM   (1U << 31)
 Cfg L3 YUV. More...
 
#define HAL_GDC_EN_L3PIX   (1U << 31)
 Ignore. More...
 
#define DC_STATUS_rsrvd_0   (1U << 31)
 Resrved. More...
 
#define hal_gdc_clkctrl_cg_l3_bus_clk   (1U << 31)
 Ignore. More...
 

Typedefs

typedef struct __hal_gdc_display_t hal_gdc_display_t
 Display parameters definition. More...
 
typedef struct __hal_gdc_layer_t hal_gdc_layer_t
 Layer parameters definition. More...
 

Enumerations

enum  hal_gdc_layer_ctrl_t {
  HAL_GDC_LAYER_DISABLE = 0, HAL_GDC_FORCE_A = 1U << 30, HAL_GDC_SCALE_NN = 1U << 29, HAL_GDC_MODULATE_A = 1U << 28,
  HAL_GDC_LAYER_AHBLOCK = 1U << 27, HAL_GDC_LAYER_GAMMALUT_EN = 1U << 26
}
 Layer control definition. More...
 
enum  hal_gdc_blend_factors_t {
  HAL_GDC_BF_ZERO = 0x0, HAL_GDC_BF_ONE = 0x1, HAL_GDC_BF_SRCALPHA = 0x2, HAL_GDC_BF_GLBALPHA = 0x3,
  HAL_GDC_BF_SRCGBLALPHA = 0x4, HAL_GDC_BF_INVSRCALPHA = 0x5, HAL_GDC_BF_INVGBLALPHA = 0x6, HAL_GDC_BF_INVSRCGBLALPHA = 0x7,
  HAL_GDC_BF_DSTALPHA = 0xa, HAL_GDC_BF_INVDSTALPHA = 0xb
}
 Layer blending factor definition. More...
 
enum  hal_gdc_blend_mode_t {
  HAL_GDC_BL_SIMPLE = (HAL_GDC_BF_SRCALPHA | (HAL_GDC_BF_INVSRCALPHA <<4)), HAL_GDC_BL_CLEAR = (HAL_GDC_BF_ZERO | (HAL_GDC_BF_ZERO <<4)), HAL_GDC_BL_SRC = (HAL_GDC_BF_ONE | (HAL_GDC_BF_ZERO <<4)), HAL_GDC_BL_SRC_OVER = (HAL_GDC_BF_ONE | (HAL_GDC_BF_INVSRCALPHA <<4)),
  HAL_GDC_BL_DST_OVER = (HAL_GDC_BF_INVDSTALPHA | (HAL_GDC_BF_ONE <<4)), HAL_GDC_BL_SRC_IN = (HAL_GDC_BF_DSTALPHA | (HAL_GDC_BF_ZERO <<4)), HAL_GDC_BL_DST_IN = (HAL_GDC_BF_ZERO | (HAL_GDC_BF_SRCALPHA <<4)), HAL_GDC_BL_SRC_OUT = (HAL_GDC_BF_INVDSTALPHA | (HAL_GDC_BF_ZERO <<4)),
  HAL_GDC_BL_DST_OUT = (HAL_GDC_BF_ZERO | (HAL_GDC_BF_INVSRCALPHA <<4)), HAL_GDC_BL_SRC_ATOP = (HAL_GDC_BF_DSTALPHA | (HAL_GDC_BF_INVSRCALPHA <<4)), HAL_GDC_BL_DST_ATOP = (HAL_GDC_BF_INVDSTALPHA | (HAL_GDC_BF_SRCALPHA <<4)), HAL_GDC_BL_ADD = (HAL_GDC_BF_ONE | (HAL_GDC_BF_ONE <<4)),
  HAL_GDC_BL_XOR = (HAL_GDC_BF_INVDSTALPHA | (HAL_GDC_BF_INVSRCALPHA <<4))
}
 Layer blending mode definition. More...
 
enum  hal_gdc_format_t {
  HAL_GDC_RGBA5551 = 0x01, HAL_GDC_ABGR8888 = 0x02, HAL_GDC_RGB332 = 0x04, HAL_GDC_RGB565 = 0x05,
  HAL_GDC_BGRA8888 = 0x06, HAL_GDC_L8 = 0x07, HAL_GDC_L1 = 0x08, HAL_GDC_L4 = 0x09,
  HAL_GDC_YUYV = 0x0a, HAL_GDC_RGB24 = 0x0b, HAL_GDC_YUY2 = 0x0c, HAL_GDC_RGBA8888 = 0x0d,
  HAL_GDC_ARGB8888 = 0x0e, HAL_GDC_V_YUV420 = 0x10, HAL_GDC_TLYUV420 = 0x11, HAL_GDC_TSC4 = 0x12,
  HAL_GDC_TSC6 = 0x13, HAL_GDC_TSC6A = 0x14, HAL_GDC_RGBA4444 = 0x15, HAL_GDC_ARGB4444 = 0x18
}
 Layer color mode definition. More...
 
enum  hal_gdc_videomode_t {
  HAL_GDC_DISABLE = 0, HAL_GDC_CURSOR = 1U << 30, HAL_GDC_NEG_V = 1U << 28, HAL_GDC_NEG_H = 1U << 27,
  HAL_GDC_NEG_DE = 1U << 26, HAL_GDC_DITHER = 1U << 24, HAL_GDC_DITHER16 = 2U << 24, HAL_GDC_DITHER15 = 3U << 24,
  HAL_GDC_SINGLEV = 1U << 23, HAL_GDC_INVPIXCLK = 1U << 22, HAL_GDC_PALETTE = 1U << 20, HAL_GDC_GAMMA = 1U << 20,
  HAL_GDC_BLANK = 1U << 19, HAL_GDC_INTERLACE = 1U << 18, HAL_GDC_ONE_FRAME = 1U << 17, HAL_GDC_P_RGB3_18B = 1U << 12,
  HAL_GDC_P_RGB3_18B1 = 2U << 12, HAL_GDC_P_RGB3_16B = 3U << 12, HAL_GDC_P_RGB3_16B1 = 4U << 12, HAL_GDC_P_RGB3_16B2 = 5U << 12,
  HAL_GDC_CLKOUTDIV = 1U << 11, HAL_GDC_LVDSPADS = 1U << 10, HAL_GDC_YUVOUT = 1U << 9, HAL_GDC_MIPI_OFF = 1U << 4,
  HAL_GDC_OUTP_OFF = 1U << 3, HAL_GDC_LVDS_OFF = 1U << 2, HAL_GDC_SCANDOUBLE = 1U << 1, HAL_GDC_TESTMODE = 1U << 0,
  HAL_GDC_P_RGB3 = 0U << 5, HAL_GDC_S_RGBX4 = 1U << 5, HAL_GDC_S_RGB3 = 2U << 5, HAL_GDC_S_12BIT = 3U << 5,
  HAL_GDC_LVDS_ISP68 = 4U << 5, HAL_GDC_LVDS_ISP8 = 5U << 5, HAL_GDC_T_16BIT = 6U << 5, HAL_GDC_BT656 = 7U << 5,
  HAL_GDC_JDIMIP = 8U << 5, HAL_GDC_LUT8 = 1U << 20
}
 Layer video mode definition. More...
 
enum  hal_gdc_config_t {
  HAL_GDC_CFG_PALETTE = 1U << 0, HAL_GDC_CFG_FIXED_CURSOR = 1U << 1, HAL_GDC_CFG_PROGR_CURSOR = 1U << 2, HAL_GDC_CFG_DITHERING = 1U << 3,
  HAL_GDC_CFG_FORMAT = 1U << 4, HAL_GDC_CFG_HiQ_YUV = 1U << 5, HAL_GDC_CFG_DBIB = 1U << 6, HAL_GDC_CFG_YUVOUT = 1U << 7,
  HAL_GDC_CFG_L0_ENABLED = 1U << 8, HAL_GDC_CFG_L0_BLENDER = 1U << 9, HAL_GDC_CFG_L0_SCALER = 1U << 10, HAL_GDC_CFG_L0_GAMMA = 1U << 11,
  HAL_GDC_CFG_L1_ENABLED = 1U << 12, HAL_GDC_CFG_L1_BLENDER = 1U << 13, HAL_GDC_CFG_L1_SCALER = 1U << 14, HAL_GDC_CFG_L1_GAMMA = 1U << 15,
  HAL_GDC_CFG_L2_ENABLED = 1U << 16, HAL_GDC_CFG_L2_BLENDER = 1U << 17, HAL_GDC_CFG_L2_SCALER = 1U << 18, HAL_GDC_CFG_L2_GAMMA = 1U << 19,
  HAL_GDC_CFG_L3_ENABLED = 1U << 20, HAL_GDC_CFG_L3_BLENDER = 1U << 21, HAL_GDC_CFG_L3_SCALER = 1U << 22, HAL_GDC_CFG_L3_GAMMA = 1U << 23,
  HAL_GDC_CFG_SPI = 1U << 24, HAL_GDC_CFG_L0_YUVMEM = 1U << 28, HAL_GDC_CFG_L1_YUVMEM = 1U << 29, HAL_GDC_CFG_L2_YUVMEM = 1U << 30
}
 Layer configuration definition. More...
 
enum  hal_gdc_status_t {
  DC_STATUS_rsrvd_1 = (1U<<30), DC_STATUS_rsrvd_2 = (1U<<29), DC_STATUS_rsrvd_3 = (1U<<28), DC_STATUS_rsrvd_4 = (1U<<27),
  DC_STATUS_rsrvd_5 = (1U<<26), DC_STATUS_rsrvd_6 = (1U<<25), DC_STATUS_rsrvd_7 = (1U<<24), DC_STATUS_rsrvd_8 = (1U<<23),
  DC_STATUS_rsrvd_9 = (1U<<22), DC_STATUS_rsrvd_10 = (1U<<21), DC_STATUS_rsrvd_11 = (1U<<20), DC_STATUS_rsrvd_12 = (1U<<19),
  DC_STATUS_rsrvd_13 = (1U<<18), DC_STATUS_rsrvd_14 = (1U<<17), DC_STATUS_rsrvd_15 = (1U<<16), DC_STATUS_dbi_cmd_ready = (1U<<15),
  DC_STATUS_dbi_cs = (1U<<14), DC_STATUS_frame_end = (1U<<13), DC_STATUS_dbi_pending_trans = (1U<<12), DC_STATUS_dbi_pending_cmd = (1U<<11),
  DC_STATUS_dbi_pending_data = (1U<<10), DC_STATUS_dbi_busy =((1U<<16)|(1U<<14)|(1U<<13)|(1U<<12)|(1U<<11)|(1U<<10)), DC_STATUS_mmu_error = (1U<< 9), DC_STATUS_te = (1U<< 8),
  DC_STATUS_sticky = (1U<< 7), DC_STATUS_underflow = (1U<< 6), DC_STATUS_LASTROW = (1U<< 5), DC_STATUS_DPI_Csync = (1U<< 4),
  DC_STATUS_vsync_te = (1U<< 3), DC_STATUS_hsync = (1U<< 2), DC_STATUS_framegen_busy = (1U<< 1), DC_STATUS_ACTIVE = (1U<< 0)
}
 DC status definition. More...
 
enum  hal_gdc_clkctrl_t {
  HAL_GDC_EN_PIXCLK = (1U<<22), HAL_GDC_EN_CFCLK = (1U<<23), HAL_GDC_EN_L0BUS = (1U<<24), HAL_GDC_EN_L0PIX = (1U<<25),
  HAL_GDC_EN_L1BUS = (1U<<26), HAL_GDC_EN_L1PIX = (1U<<27), HAL_GDC_EN_L2BUS = (1U<<28), HAL_GDC_EN_L2PIX = (1U<<29),
  HAL_GDC_EN_L3BUS = (1U<<30)
}
 DC clock control definition. More...
 
enum  hal_gdc_clkctrl_cg_t {
  hal_gdc_clkctrl_cg_l3_pix_clk = (1U<<30), hal_gdc_clkctrl_cg_l2_bus_clk = (1U<<29), hal_gdc_clkctrl_cg_l2_pix_clk = (1U<<28), hal_gdc_clkctrl_cg_l1_bus_clk = (1U<<27),
  hal_gdc_clkctrl_cg_l1_pix_clk = (1U<<26), hal_gdc_clkctrl_cg_l0_bus_clk = (1U<<25), hal_gdc_clkctrl_cg_l0_pix_clk = (1U<<24), hal_gdc_clkctrl_cg_regfil_clk = (1U<<23),
  hal_gdc_clkctrl_cg_bypass_clk = (1U<<22), hal_gdc_clkctrl_cg_rsrvd_21 = (1U<<21), hal_gdc_clkctrl_cg_rsrvd_20 = (1U<<20), hal_gdc_clkctrl_cg_rsrvd_19 = (1U<<19),
  hal_gdc_clkctrl_cg_rsrvd_18 = (1U<<18), hal_gdc_clkctrl_cg_rsrvd_17 = (1U<<17), hal_gdc_clkctrl_cg_rsrvd_16 = (1U<<16), hal_gdc_clkctrl_cg_rsrvd_15 = (1U<<15),
  hal_gdc_clkctrl_cg_rsrvd_14 = (1U<<14), hal_gdc_clkctrl_cg_rsrvd_13 = (1U<<13), hal_gdc_clkctrl_cg_rsrvd_12 = (1U<<12), hal_gdc_clkctrl_cg_rsrvd_11 = (1U<<11),
  hal_gdc_clkctrl_cg_rsrvd_10 = (1U<<10), hal_gdc_clkctrl_cg_rsrvd_9 = (1U<< 9), hal_gdc_clkctrl_cg_rsrvd_8 = (1U<< 8), hal_gdc_clkctrl_cg_rsrvd_7 = (1U<< 7),
  hal_gdc_clkctrl_cg_rsrvd_6 = (1U<< 6), hal_gdc_clkctrl_cg_rsrvd_5 = (1U<< 5), hal_gdc_clkctrl_cg_rsrvd_4 = (1U<< 4), hal_gdc_clkctrl_cg_rsrvd_3 = (1U<< 3),
  hal_gdc_clkctrl_cg_clk_swap = (1U<< 2), hal_gdc_clkctrl_cg_clk_inv = (1U<< 1), hal_gdc_clkctrl_cg_clk_en = (1U<< 0)
}
 DC clock cg control definition. More...
 

Functions

int hal_gdc_init (void)
 Initialize hal_gdc library. More...
 
uint32_t hal_gdc_get_config (void)
 Read Configuration Register. More...
 
uint32_t hal_gdc_get_crc (void)
 Read CRC Checksum Register. More...
 
void hal_gdc_set_bgcolor (uint32_t rgba)
 Set hal_gdc Background Color. More...
 
void hal_gdc_timing (int resx, int fpx, int blx, int bpx, int resy, int fpy, int bly, int bpy)
 Set Display timing parameters. More...
 
int hal_gdc_stride_size (hal_gdc_format_t format, int width)
 Get stride size in bytes. More...
 
void hal_gdc_clkdiv (int div, int div2, int dma_prefetch, int phase)
 Set the built-in Clock Dividers and DMA Line Prefetch. More...
 
void hal_gdc_clkctrl (hal_gdc_clkctrl_t ctrl)
 Control the clock gaters. More...
 
void hal_gdc_set_mode (int mode)
 Set operation mode. More...
 
uint32_t hal_gdc_get_status (void)
 Get status from Status Register. More...
 
void hal_gdc_request_vsync_non_blocking (void)
 Request a VSync Interrupt without blocking. More...
 
void hal_gdc_set_layer (int layer_no, hal_gdc_layer_t *layer)
 Set the Layer Mode. More...
 
void hal_gdc_set_layer_addr (int layer_no, uintptr_t addr)
 Set the physical address of a layer. More...
 
void hal_gdc_set_layer_gamma_lut (int layer, int index, int colour)
 Set the physical address of a layer. More...
 
int hal_gdc_get_layer_gamma_lut (int layer, int index)
 Get an entry in the lut8 Palette Gamma table for a layer. More...
 
void hal_gdc_set_palette (uint32_t index, uint32_t colour)
 Sets an entry in the lut8 Palatte Gamma table. More...
 
int hal_gdc_get_palette (uint32_t index)
 Reads an entry from the lut8 Palatte Gamma table. More...
 
void hal_gdc_layer_disable (int layer_no)
 Disable layer. More...
 
void hal_gdc_layer_enable (int layer_no)
 Enable layer. More...
 
void hal_gdc_cursor_enable (int enable)
 Enable or Disable fixed cursor. More...
 
void hal_gdc_cursor_xy (int x, int y)
 Set the location of the cursor. More...
 
void hal_gdc_set_cursor_img (unsigned char *img)
 Set programmable cursor image (32x32 pixels) More...
 
void hal_gdc_set_cursor_lut (uint32_t index, uint32_t color)
 Set a color for the Cursor LUT. More...
 
unsigned char hal_gdc_check_config (hal_gdc_config_t flag)
 Check whether hal_gdc supports a specific characteristic. More...
 
uint32_t hal_gdc_get_col_mode (void)
 Read Color Mode Register. More...
 
int hal_gdc_get_layer_count (void)
 Get the number of layers available. More...
 

Detailed Description

Header file containing functions prototypes of Graphics library.

Author
BLE Driver Team
Attention
Copyright (c) 2019 GOODIX

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of GOODIX nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file hal_gdc.h.