D4D LOW LEVEL DRIVER API Types Specification

Collaboration diagram for D4D LOW LEVEL DRIVER API Types Specification:

Data Structures
struct	D4D_TOUCHSCREEN_LIMITS_S
	D4D low level touch screen limitation structure. More...
struct	D4DLCD_FRAMEBUFF_DESC_S
	D4D low level frame buffer description structure. More...
struct	D4DMOUSE_DESC
	D4D low level mouse pointer structure. More...
struct	D4DLCD_FUNCTIONS_S
	D4D low level standard LCD interface API structure. More...
struct	D4DLCDHW_FUNCTIONS_S
	D4D low level standard LCD Hardware interface API structure. More...
struct	D4DLCDHWFB_FUNCTIONS_S
	D4D low level frame buffer LCD interface API structure. More...
struct	D4DTCH_FUNCTIONS_S
	D4D low level touch screen interface API structure. More...
struct	D4DTCHHW_FUNCTIONS_S
	D4D low level touch screen hardware interface API structure. More...
struct	D4DMOUSE_FUNCTIONS_S
	D4D low level mouse pointer interface API structure. More...

Typedefs
typedef struct D4D_TOUCHSCREEN_LIMITS_S	D4D_TOUCHSCREEN_LIMITS
	D4D low level touch screen limitation structure. More...
typedef struct D4DLCD_FRAMEBUFF_DESC_S	D4DLCD_FRAMEBUFF_DESC
	D4D low level frame buffer description structure. More...
typedef struct D4DLCD_FUNCTIONS_S	D4DLCD_FUNCTIONS
	D4D low level standard LCD interface API structure. More...
typedef struct D4DLCDHW_FUNCTIONS_S	D4DLCDHW_FUNCTIONS
	D4D low level standard LCD Hardware interface API structure. More...
typedef struct D4DLCDHWFB_FUNCTIONS_S	D4DLCDHWFB_FUNCTIONS
	D4D low level frame buffer LCD interface API structure. More...
typedef struct D4DTCH_FUNCTIONS_S	D4DTCH_FUNCTIONS
	D4D low level touch screen interface API structure. More...
typedef struct D4DTCHHW_FUNCTIONS_S	D4DTCHHW_FUNCTIONS
	D4D low level touch screen hardware interface API structure. More...
typedef struct D4DMOUSE_FUNCTIONS_S	D4DMOUSE_FUNCTIONS
	D4D low level mouse pointer interface API structure. More...

Enumerations
enum	D4DLCD_ORIENTATION { Portrait, Portrait180, Landscape, Landscape180 }
	D4D low level screen orientation enumeration type. More...
enum	D4DHW_PIN_STATE { D4DHW_PIN_PULL_UP_ON, D4DHW_PIN_PULL_UP_OFF, D4DHW_PIN_OUT, D4DHW_PIN_IN, D4DHW_PIN_SET_0, D4DHW_PIN_SET_1, D4DHW_PIN_GET, D4DHW_PIN_ADC_ON, D4DHW_PIN_ADC_OFF }
	D4D low level MCU pin state enumeration type. More...
enum	D4DTCHHW_PINS { D4DTCH_X_PLUS_PIN, D4DTCH_X_MINUS_PIN, D4DTCH_Y_PLUS_PIN, D4DTCH_Y_MINUS_PIN }
	D4D low level MCU types definition for analog resistive touch screen signals. More...
enum	D4DLCDHW_PINS { D4DLCD_RESET_PIN, D4DLCD_BACKLIGHT_PIN, D4DLCD_CS_PIN }
	D4D low level MCU types definition for general LCD screen control signals. More...
enum	D4DLCD_FLUSH_MODE { D4DLCD_FLSH_ELEMENT, D4DLCD_FLSH_SCR_START, D4DLCD_FLSH_SCR_END, D4DLCD_FLSH_FORCE }
	D4D low level eGUI flush screen types enumeration. More...

Detailed Description

This section specifies the exact type for each typedef definition of low level drivers support.

---

Data Structure Documentation

struct D4D_TOUCHSCREEN_LIMITS_S

Collaboration diagram for D4D_TOUCHSCREEN_LIMITS_S:

Data Fields
unsigned short	rawDataScale
	The scale mask of ADC convertor. More...
unsigned short	touchMinX
	Minimal valid raw value of axis X. More...
unsigned short	touchMinY
	Minimal valid raw value of axis Y. More...
unsigned short	touchOffMaxX
	Maximal valid raw value of axis X. More...
unsigned short	touchOffMaxY
	Maximal valid raw value of axis Y. More...

Field Documentation

unsigned short rawDataScale

The scale mask of ADC convertor.

Definition at line 107 of file d4d_lldapi.h.

unsigned short touchMinX

Minimal valid raw value of axis X.

Definition at line 108 of file d4d_lldapi.h.

unsigned short touchMinY

Minimal valid raw value of axis Y.

Definition at line 109 of file d4d_lldapi.h.

unsigned short touchOffMaxX

Maximal valid raw value of axis X.

Definition at line 110 of file d4d_lldapi.h.

unsigned short touchOffMaxY

Maximal valid raw value of axis Y.

Definition at line 111 of file d4d_lldapi.h.

struct D4DLCD_FRAMEBUFF_DESC_S

Collaboration diagram for D4DLCD_FRAMEBUFF_DESC_S:

Data Fields
unsigned long	fb_start_addr
	The address of frame buffer. More...
unsigned short	lcd_x_max
	The resolution of LCD in axis X. More...
unsigned short	lcd_y_max
	The resolution of LCD in axis Y. More...
unsigned char	bpp_byte
	The bytes per pixel. More...

Field Documentation

unsigned char bpp_byte

The bytes per pixel.

Definition at line 122 of file d4d_lldapi.h.

unsigned long fb_start_addr

The address of frame buffer.

Definition at line 119 of file d4d_lldapi.h.

unsigned short lcd_x_max

The resolution of LCD in axis X.

Definition at line 120 of file d4d_lldapi.h.

unsigned short lcd_y_max

The resolution of LCD in axis Y.

Definition at line 121 of file d4d_lldapi.h.

struct D4DMOUSE_DESC

Collaboration diagram for D4DMOUSE_DESC:

Data Fields
D4D_COOR	size_x
	The size of omuse pointer in axis X. More...
D4D_COOR	size_y
	The size of omuse pointer in axis Y. More...
LWord	bmpFormat
	The bitmap format of mouse pointer (corresponded to main eGUI internal bitmap types) More...

Field Documentation

LWord bmpFormat

The bitmap format of mouse pointer (corresponded to main eGUI internal bitmap types)

Definition at line 132 of file d4d_lldapi.h.

D4D_COOR size_x

The size of omuse pointer in axis X.

Definition at line 130 of file d4d_lldapi.h.

D4D_COOR size_y

The size of omuse pointer in axis Y.

Definition at line 131 of file d4d_lldapi.h.

struct D4DLCD_FUNCTIONS_S

Collaboration diagram for D4DLCD_FUNCTIONS_S:

Data Fields
unsigned char(*	D4DLCD_Init )(void)
	The LCD driver initialization function. More...
unsigned char(*	D4DLCD_SetWindow )(unsigned short x1, unsigned short y1, unsigned short x2, unsigned short y2)
	The LCD driver Set logic window function. Into this logic window will be draw pixels. More...
unsigned char(*	D4DLCD_SetOrientation )(D4DLCD_ORIENTATION new_orientation)
	The LCD driver set orientation function. More...
void(*	D4DLCD_Send_PixelColor )(D4D_COLOR value)
	The LCD driver send pixel function. The pixels will be draw on position (automaticaly incremented) sets by D4DLCD_SetWindow function. More...
D4D_COLOR(*	D4DLCD_Read_PixelColor )(void)
	The LCD driver read pixel function. The pixels will be read on position (automaticaly incremented) sets by D4DLCD_SetWindow function. More...
void(*	D4DLCD_FlushBuffer )(D4DLCD_FLUSH_MODE mode)
	The LCD driver flush function. More...
void(*	D4DLCD_Delay_ms )(unsigned short period)
	The LCD driver delay function. More...
unsigned char(*	D4DLCD_DeInit )(void)
	The LCD driver deinicialization function. More...

Field Documentation

unsigned char(* D4DLCD_DeInit)(void)

The LCD driver deinicialization function.

Definition at line 156 of file d4d_lldapi.h.

void(* D4DLCD_Delay_ms)(unsigned short period)

The LCD driver delay function.

Definition at line 155 of file d4d_lldapi.h.

void(* D4DLCD_FlushBuffer)(D4DLCD_FLUSH_MODE mode)

The LCD driver flush function.

Definition at line 154 of file d4d_lldapi.h.

unsigned char(* D4DLCD_Init)(void)

The LCD driver initialization function.

Definition at line 149 of file d4d_lldapi.h.

D4D_COLOR(* D4DLCD_Read_PixelColor)(void)

The LCD driver read pixel function. The pixels will be read on position (automaticaly incremented) sets by D4DLCD_SetWindow function.

Definition at line 153 of file d4d_lldapi.h.

void(* D4DLCD_Send_PixelColor)(D4D_COLOR value)

The LCD driver send pixel function. The pixels will be draw on position (automaticaly incremented) sets by D4DLCD_SetWindow function.

Definition at line 152 of file d4d_lldapi.h.

unsigned char(* D4DLCD_SetOrientation)(D4DLCD_ORIENTATION new_orientation)

The LCD driver set orientation function.

Definition at line 151 of file d4d_lldapi.h.

unsigned char(* D4DLCD_SetWindow)(unsigned short x1, unsigned short y1, unsigned short x2, unsigned short y2)

The LCD driver Set logic window function. Into this logic window will be draw pixels.

Definition at line 150 of file d4d_lldapi.h.

struct D4DLCDHW_FUNCTIONS_S

Collaboration diagram for D4DLCDHW_FUNCTIONS_S:

Data Fields
unsigned char(*	D4DLCDHW_Init )(void)
	The LCD HW interface driver initialization function. More...
void(*	D4DLCDHW_SendDataWord )(Word value)
	The LCD HW interface driver send data word function. More...
void(*	D4DLCDHW_SendCmdWord )(Word cmd)
	The LCD HW interface driver send command word function. More...
Word(*	D4DLCDHW_ReadDataWord )(void)
	The LCD HW interface driver read data word function. More...
Word(*	D4DLCDHW_ReadCmdWord )(void)
	The LCD HW interface driver read command word function. More...
unsigned char(*	D4DLCDHW_PinCtl )(D4DLCDHW_PINS pinId, D4DHW_PIN_STATE setState)
	The LCD HW interface driver control HW pins function. More...
void(*	D4DLCDHW_FlushBuffer )(D4DLCD_FLUSH_MODE mode)
	The LCD HW interface driver flush data function. More...
unsigned char(*	D4DLCDHW_DeInit )(void)
	The LCD HW interface driver deinicialization function. More...

Field Documentation

unsigned char(* D4DLCDHW_DeInit)(void)

The LCD HW interface driver deinicialization function.

Definition at line 172 of file d4d_lldapi.h.

void(* D4DLCDHW_FlushBuffer)(D4DLCD_FLUSH_MODE mode)

The LCD HW interface driver flush data function.

Definition at line 171 of file d4d_lldapi.h.

unsigned char(* D4DLCDHW_Init)(void)

The LCD HW interface driver initialization function.

Definition at line 165 of file d4d_lldapi.h.

unsigned char(* D4DLCDHW_PinCtl)(D4DLCDHW_PINS pinId, D4DHW_PIN_STATE setState)

The LCD HW interface driver control HW pins function.

Definition at line 170 of file d4d_lldapi.h.

Word(* D4DLCDHW_ReadCmdWord)(void)

The LCD HW interface driver read command word function.

Definition at line 169 of file d4d_lldapi.h.

Word(* D4DLCDHW_ReadDataWord)(void)

The LCD HW interface driver read data word function.

Definition at line 168 of file d4d_lldapi.h.

void(* D4DLCDHW_SendCmdWord)(Word cmd)

The LCD HW interface driver send command word function.

Definition at line 167 of file d4d_lldapi.h.

void(* D4DLCDHW_SendDataWord)(Word value)

The LCD HW interface driver send data word function.

Definition at line 166 of file d4d_lldapi.h.

struct D4DLCDHWFB_FUNCTIONS_S

Collaboration diagram for D4DLCDHWFB_FUNCTIONS_S:

Data Fields
unsigned char(*	D4DLCDHW_Init )(void)
	The frame buffer LCD driver initialization function. More...
void(*	D4DLCDHW_WriteData )(unsigned long addr, D4D_COLOR value)
	The frame buffer LCD driver write data to buffer function. More...
D4D_COLOR(*	D4DLCDHW_ReadData )(unsigned long addr)
	The frame buffer LCD driver read data from buffer function. More...
D4DLCD_FRAMEBUFF_DESC *(*	D4DLCDHW_GetFbDescriptor )(void)
	The frame buffer LCD driver get frame buffer descriptor function. More...
unsigned char(*	D4DLCDHW_PinCtl )(D4DLCDHW_PINS pinId, D4DHW_PIN_STATE setState)
	The frame buffer LCD driver control HW pins function. More...
void(*	D4DLCDHW_FlushBuffer )(D4DLCD_FLUSH_MODE mode)
	The frame buffer LCD driver flush data function. More...
unsigned char(*	D4DLCDHW_DeInit )(void)
	The frame buffer LCD driver deinitialization function. More...

Field Documentation

unsigned char(* D4DLCDHW_DeInit)(void)

The frame buffer LCD driver deinitialization function.

Definition at line 187 of file d4d_lldapi.h.

void(* D4DLCDHW_FlushBuffer)(D4DLCD_FLUSH_MODE mode)

The frame buffer LCD driver flush data function.

Definition at line 186 of file d4d_lldapi.h.

D4DLCD_FRAMEBUFF_DESC*(* D4DLCDHW_GetFbDescriptor)(void)

The frame buffer LCD driver get frame buffer descriptor function.

Definition at line 184 of file d4d_lldapi.h.

unsigned char(* D4DLCDHW_Init)(void)

The frame buffer LCD driver initialization function.

Definition at line 181 of file d4d_lldapi.h.

unsigned char(* D4DLCDHW_PinCtl)(D4DLCDHW_PINS pinId, D4DHW_PIN_STATE setState)

The frame buffer LCD driver control HW pins function.

Definition at line 185 of file d4d_lldapi.h.

D4D_COLOR(* D4DLCDHW_ReadData)(unsigned long addr)

The frame buffer LCD driver read data from buffer function.

Definition at line 183 of file d4d_lldapi.h.

void(* D4DLCDHW_WriteData)(unsigned long addr, D4D_COLOR value)

The frame buffer LCD driver write data to buffer function.

Definition at line 182 of file d4d_lldapi.h.

struct D4DTCH_FUNCTIONS_S

Collaboration diagram for D4DTCH_FUNCTIONS_S:

Data Fields
unsigned char(*	D4DTCH_Init )(void)
	The touch screen driver initialization function. More...
unsigned char(*	D4DTCH_GetPositionRaw )(unsigned short *TouchPositionX, unsigned short *TouchPositionY)
	The touch screen driver get raw data function. More...
D4D_TOUCHSCREEN_LIMITS *(*	D4DTCH_GetRawLimits )(void)
	The touch screen driver get touch screen hardware limit structure function. More...
unsigned char(*	D4DTCH_DeInit )(void)
	The touch screen driver deinitialization function. More...

Field Documentation

unsigned char(* D4DTCH_DeInit)(void)

The touch screen driver deinitialization function.

Definition at line 200 of file d4d_lldapi.h.

unsigned char(* D4DTCH_GetPositionRaw)(unsigned short *TouchPositionX, unsigned short *TouchPositionY)

The touch screen driver get raw data function.

Definition at line 198 of file d4d_lldapi.h.

D4D_TOUCHSCREEN_LIMITS*(* D4DTCH_GetRawLimits)(void)

The touch screen driver get touch screen hardware limit structure function.

Definition at line 199 of file d4d_lldapi.h.

unsigned char(* D4DTCH_Init)(void)

The touch screen driver initialization function.

Definition at line 197 of file d4d_lldapi.h.

struct D4DTCHHW_FUNCTIONS_S

Collaboration diagram for D4DTCHHW_FUNCTIONS_S:

Data Fields
unsigned char(*	D4DTCHHW_Init )(void)
	The touch screen hardware interface driver initialization function. More...
unsigned short(*	D4DTCHHW_ReadTouchAxis )(D4DTCHHW_PINS pinId)
	The touch screen hardware interface driver read one axis function. More...
D4D_TOUCHSCREEN_LIMITS *(*	D4DTCHHW_GetRawLimits )(void)
	The touch screen hardware interface driver get hardware limits function. More...
unsigned char(*	D4DTCHHW_PinCtl )(D4DTCHHW_PINS pinId, D4DHW_PIN_STATE setState)
	The touch screen hardware interface driver control HW pins function. More...
unsigned char(*	D4DTCHHW_DeInit )(void)
	The touch screen hardware interface driver deinitialization function. More...

Field Documentation

unsigned char(* D4DTCHHW_DeInit)(void)

The touch screen hardware interface driver deinitialization function.

Definition at line 213 of file d4d_lldapi.h.

D4D_TOUCHSCREEN_LIMITS*(* D4DTCHHW_GetRawLimits)(void)

The touch screen hardware interface driver get hardware limits function.

Definition at line 211 of file d4d_lldapi.h.

unsigned char(* D4DTCHHW_Init)(void)

The touch screen hardware interface driver initialization function.

Definition at line 209 of file d4d_lldapi.h.

unsigned char(* D4DTCHHW_PinCtl)(D4DTCHHW_PINS pinId, D4DHW_PIN_STATE setState)

The touch screen hardware interface driver control HW pins function.

Definition at line 212 of file d4d_lldapi.h.

unsigned short(* D4DTCHHW_ReadTouchAxis)(D4DTCHHW_PINS pinId)

The touch screen hardware interface driver read one axis function.

Definition at line 210 of file d4d_lldapi.h.

struct D4DMOUSE_FUNCTIONS_S

Collaboration diagram for D4DMOUSE_FUNCTIONS_S:

Data Fields
unsigned char(*	D4DMOUSE_Init )(void)
	The mouse pointer interface driver initialization function. More...
void(*	D4DMOUSE_SetCoor )(unsigned short x, unsigned short y)
	The mouse pointer interface driver set current coordination function. More...
void(*	D4DMOUSE_SetPointerBmp )(void **pPntrData, D4D_INDEX cnt, D4D_COLOR keyColor)
	The mouse pointer interface driver set pointer to mouse cursors bitmaps function. More...
void(*	D4DMOUSE_SetPointer )(D4D_INDEX cnt, D4D_BOOL show)
	The mouse pointer interface driver set cursor index and also visibility function. More...
D4DMOUSE_DESC *(*	D4DMOUSE_GetDescriptor )(void)
	The mouse pointer interface driver get gescriptor function. More...
unsigned char(*	D4DMOUSE_DeInit )(void)
	The mouse pointer interface driver deinitialization function. More...

Field Documentation

unsigned char(* D4DMOUSE_DeInit)(void)

The mouse pointer interface driver deinitialization function.

Definition at line 226 of file d4d_lldapi.h.

D4DMOUSE_DESC*(* D4DMOUSE_GetDescriptor)(void)

The mouse pointer interface driver get gescriptor function.

Definition at line 225 of file d4d_lldapi.h.

unsigned char(* D4DMOUSE_Init)(void)

The mouse pointer interface driver initialization function.

Definition at line 221 of file d4d_lldapi.h.

void(* D4DMOUSE_SetCoor)(unsigned short x, unsigned short y)

The mouse pointer interface driver set current coordination function.

Definition at line 222 of file d4d_lldapi.h.

void(* D4DMOUSE_SetPointer)(D4D_INDEX cnt, D4D_BOOL show)

The mouse pointer interface driver set cursor index and also visibility function.

Definition at line 224 of file d4d_lldapi.h.

void(* D4DMOUSE_SetPointerBmp)(void **pPntrData, D4D_INDEX cnt, D4D_COLOR keyColor)

The mouse pointer interface driver set pointer to mouse cursors bitmaps function.

Definition at line 223 of file d4d_lldapi.h.

Typedef Documentation

typedef struct D4D_TOUCHSCREEN_LIMITS_S D4D_TOUCHSCREEN_LIMITS

D4D low level touch screen limitation structure.

Note

This structure contains the limitation data for touch screen driver.

typedef struct D4DLCD_FRAMEBUFF_DESC_S D4DLCD_FRAMEBUFF_DESC

D4D low level frame buffer description structure.

Note

This structure is used only with frame buffer type of low level driver. The size of frame buffer could be computed by (lcd_x_max * lcd_y_max * bpp_byte).

typedef struct D4DLCD_FUNCTIONS_S D4DLCD_FUNCTIONS

D4D low level standard LCD interface API structure.

Note

This structure contains all needed API function pointers to currently used driver. All the function MUST be defined in low level driver

typedef struct D4DLCDHW_FUNCTIONS_S D4DLCDHW_FUNCTIONS

D4D low level standard LCD Hardware interface API structure.

Note

This structure contains all needed API function pointers to currently used hardware interface driver. All the function MUST be defined in hardware interface low level driver

typedef struct D4DLCDHWFB_FUNCTIONS_S D4DLCDHWFB_FUNCTIONS

D4D low level frame buffer LCD interface API structure.

Note

This structure contains all needed API function pointers to currently used frame buffer driver. All the function MUST be defined in low level driver

typedef struct D4DMOUSE_FUNCTIONS_S D4DMOUSE_FUNCTIONS

D4D low level mouse pointer interface API structure.

Note

This structure contains all needed API function pointers to currently used mouse pointer interface driver. All the function MUST be defined in low level driver

typedef struct D4DTCH_FUNCTIONS_S D4DTCH_FUNCTIONS

D4D low level touch screen interface API structure.

Note

This structure contains all needed API function pointers to currently used touch screen driver. All the function MUST be defined in low level driver

typedef struct D4DTCHHW_FUNCTIONS_S D4DTCHHW_FUNCTIONS

D4D low level touch screen hardware interface API structure.

Note

This structure contains all needed API function pointers to currently used touch screen hardware interface driver. All the function MUST be defined in low level driver

Enumeration Type Documentation

enum D4DHW_PIN_STATE

D4D low level MCU pin state enumeration type.

Enumerator
D4DHW_PIN_PULL_UP_ON	Switch on Pull Up resistor on pin.
D4DHW_PIN_PULL_UP_OFF	Switch off Pull Up resistor on pin.
D4DHW_PIN_OUT	Switch pin to output mode.
D4DHW_PIN_IN	Switch pin to input mode (equivalent to high-Z)
D4DHW_PIN_SET_0	Set pin output register to logic 0.
D4DHW_PIN_SET_1	Set pin output register to logic 1.
D4DHW_PIN_GET	Get the pin input value.
D4DHW_PIN_ADC_ON	Switch on the pin for read by ADC.
D4DHW_PIN_ADC_OFF	Switch off the pin for read by ADC.

Definition at line 73 of file d4d_lldapi.h.

enum D4DLCD_FLUSH_MODE

D4D low level eGUI flush screen types enumeration.

Enumerator
D4DLCD_FLSH_ELEMENT	The flush after one basic element is draw.
D4DLCD_FLSH_SCR_START	The notification that the start of screen is done.
D4DLCD_FLSH_SCR_END	The notification that the end of screen is draw.
D4DLCD_FLSH_FORCE	The notification of forcing flush by user code.

Definition at line 136 of file d4d_lldapi.h.

enum D4DLCD_ORIENTATION

D4D low level screen orientation enumeration type.

Enumerator
Portrait	Orientation Portrait.
Portrait180	Orientation Portrait up side down.
Landscape	Orientation LandScape.
Landscape180	Orientation LandScape up side down.

Definition at line 64 of file d4d_lldapi.h.

enum D4DLCDHW_PINS

D4D low level MCU types definition for general LCD screen control signals.

Enumerator
D4DLCD_RESET_PIN	LCD device reset signal.
D4DLCD_BACKLIGHT_PIN	LCD device backlight enable signal.
D4DLCD_CS_PIN	LCD device chip select signal.

Definition at line 96 of file d4d_lldapi.h.

enum D4DTCHHW_PINS

D4D low level MCU types definition for analog resistive touch screen signals.

Enumerator
D4DTCH_X_PLUS_PIN	Analog touch screen X+ signal.
D4DTCH_X_MINUS_PIN	Analog touch screen X- signal.
D4DTCH_Y_PLUS_PIN	Analog touch screen Y+ signal.
D4DTCH_Y_MINUS_PIN	Analog touch screen Y- signal.

Definition at line 87 of file d4d_lldapi.h.