d4d_lldapi.h

Go to the documentation of this file.

/**************************************************************************
*
* Copyright 2014 by Petr Gargulak. eGUI Community.
* Copyright 2009-2013 by Petr Gargulak. Freescale Semiconductor, Inc.
*
***************************************************************************
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License Version 3
* or later (the "LGPL").
*
* As a special exception, the copyright holders of the eGUI project give you
* permission to link the eGUI sources with independent modules to produce an
* executable, regardless of the license terms of these independent modules,
* and to copy and distribute the resulting executable under terms of your
* choice, provided that you also meet, for each linked independent module,
* the terms and conditions of the license of that module.
* An independent module is a module which is not derived from or based
* on this library.
* If you modify the eGUI sources, you may extend this exception
* to your version of the eGUI sources, but you are not obligated
* to do so. If you do not wish to do so, delete this
* exception statement from your version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*
* You should have received a copy of the GNU General Public License
* and the GNU Lesser General Public License along with this program.
* If not, see <http://www.gnu.org/licenses/>.
*
***************************************************************************/
#ifndef __D4D_LLD_API_H
#define __D4D_LLD_API_H


/******************************************************************************
* Includes
******************************************************************************/
#include "d4d_user_cfg.h"
#include "common_files/d4d_types.h"

/******************************************************************************
* D4D LLD API types
*
*/
typedef enum
{
  Portrait      = D4D_ORIENT_PORTRAIT,          
  Portrait180   = D4D_ORIENT_PORTRAIT180,       
  Landscape     = D4D_ORIENT_LANDSCAPE,         
  Landscape180  = D4D_ORIENT_LANDSCAPE180       
} D4DLCD_ORIENTATION;

typedef enum
{
  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     
}D4DHW_PIN_STATE;

typedef enum
{
  D4DTCH_X_PLUS_PIN,    
  D4DTCH_X_MINUS_PIN,   
  D4DTCH_Y_PLUS_PIN,    
  D4DTCH_Y_MINUS_PIN    
}D4DTCHHW_PINS;

typedef enum
{
  D4DLCD_RESET_PIN,     
  D4DLCD_BACKLIGHT_PIN, 
  D4DLCD_CS_PIN         
}D4DLCDHW_PINS;

typedef struct D4D_TOUCHSCREEN_LIMITS_S
{
  unsigned short rawDataScale;  
  unsigned short touchMinX;     
  unsigned short touchMinY;     
  unsigned short touchOffMaxX;  
  unsigned short touchOffMaxY;  
}D4D_TOUCHSCREEN_LIMITS;

typedef struct D4DLCD_FRAMEBUFF_DESC_S
{
  unsigned long fb_start_addr;  
  unsigned short lcd_x_max;     
  unsigned short lcd_y_max;     
  unsigned char bpp_byte;     
}D4DLCD_FRAMEBUFF_DESC;

typedef struct
{
  D4D_COOR size_x;      
  D4D_COOR size_y;      
  LWord  bmpFormat;     
}D4DMOUSE_DESC;

typedef enum
{
  D4DLCD_FLSH_ELEMENT,          
  D4DLCD_FLSH_SCR_START,        
  D4DLCD_FLSH_SCR_END,          
  D4DLCD_FLSH_FORCE             
} D4DLCD_FLUSH_MODE;

typedef struct D4DLCD_FUNCTIONS_S
{
  unsigned char (*D4DLCD_Init)(void);                   
  unsigned char (*D4DLCD_SetWindow)(unsigned short x1, unsigned short y1, unsigned short x2, unsigned short y2);        
  unsigned char (*D4DLCD_SetOrientation)(D4DLCD_ORIENTATION new_orientation);   
  void (*D4DLCD_Send_PixelColor)(D4D_COLOR value);      
  D4D_COLOR (*D4DLCD_Read_PixelColor)(void);            
  void (*D4DLCD_FlushBuffer)(D4DLCD_FLUSH_MODE mode);   
  void (*D4DLCD_Delay_ms)(unsigned short period);       
  unsigned char (*D4DLCD_DeInit)(void);                 
}D4DLCD_FUNCTIONS;


typedef struct D4DLCDHW_FUNCTIONS_S
{
  unsigned char (*D4DLCDHW_Init)(void);         
  void (*D4DLCDHW_SendDataWord)(Word value);    
  void (*D4DLCDHW_SendCmdWord)(Word cmd);       
  Word (*D4DLCDHW_ReadDataWord)(void);          
  Word (*D4DLCDHW_ReadCmdWord)(void);           
  unsigned char (*D4DLCDHW_PinCtl)(D4DLCDHW_PINS pinId, D4DHW_PIN_STATE setState);      
  void (*D4DLCDHW_FlushBuffer)(D4DLCD_FLUSH_MODE mode);         
  unsigned char (*D4DLCDHW_DeInit)(void);       
}D4DLCDHW_FUNCTIONS;


typedef struct D4DLCDHWFB_FUNCTIONS_S
{
  unsigned char (*D4DLCDHW_Init)(void);         
  void (*D4DLCDHW_WriteData)(unsigned long addr, D4D_COLOR value);      
  D4D_COLOR (*D4DLCDHW_ReadData)(unsigned long addr);                   
  D4DLCD_FRAMEBUFF_DESC* (*D4DLCDHW_GetFbDescriptor)(void);             
  unsigned char (*D4DLCDHW_PinCtl)(D4DLCDHW_PINS pinId, D4DHW_PIN_STATE setState);      
  void (*D4DLCDHW_FlushBuffer)(D4DLCD_FLUSH_MODE mode);                 
  unsigned char (*D4DLCDHW_DeInit)(void);                               
}D4DLCDHWFB_FUNCTIONS;



typedef struct D4DTCH_FUNCTIONS_S
{
  unsigned char (*D4DTCH_Init)(void);                           
  unsigned char (*D4DTCH_GetPositionRaw)(unsigned short *TouchPositionX, unsigned short *TouchPositionY);  
  D4D_TOUCHSCREEN_LIMITS* (*D4DTCH_GetRawLimits)(void);         
  unsigned char (*D4DTCH_DeInit)(void);                         
}D4DTCH_FUNCTIONS;


typedef struct D4DTCHHW_FUNCTIONS_S
{
  unsigned char (*D4DTCHHW_Init)(void);                         
  unsigned short (*D4DTCHHW_ReadTouchAxis)(D4DTCHHW_PINS pinId);
  D4D_TOUCHSCREEN_LIMITS* (*D4DTCHHW_GetRawLimits)(void);       
  unsigned char (*D4DTCHHW_PinCtl)(D4DTCHHW_PINS pinId, D4DHW_PIN_STATE setState);      
  unsigned char (*D4DTCHHW_DeInit)(void);                       
}D4DTCHHW_FUNCTIONS;

typedef struct D4DMOUSE_FUNCTIONS_S
{
  unsigned char (*D4DMOUSE_Init)(void);                         
  void (*D4DMOUSE_SetCoor)(unsigned short x, unsigned short y); 
  void (*D4DMOUSE_SetPointerBmp)(void** pPntrData, D4D_INDEX cnt, D4D_COLOR keyColor);  
  void (*D4DMOUSE_SetPointer)(D4D_INDEX cnt, D4D_BOOL show);    
  D4DMOUSE_DESC* (*D4DMOUSE_GetDescriptor)(void);               
  unsigned char (*D4DMOUSE_DeInit)(void);                       
}D4DMOUSE_FUNCTIONS;

// Include the right low level driver for LCD/TFT

#ifndef D4D_LLD_LCD
  #error "You must #define symbol D4D_LLD_LCD in d4d_user_cfg.h header file"
#endif

extern const D4DLCD_FUNCTIONS D4D_LLD_LCD;

#ifdef D4D_LLD_TCH
  extern const D4DTCH_FUNCTIONS D4D_LLD_TCH;
#endif

#ifdef D4D_LLD_TCH_HW
  extern const D4DTCHHW_FUNCTIONS D4D_LLD_TCH_HW;
#endif

#ifdef D4D_LLD_MOUSE
  extern const D4DMOUSE_FUNCTIONS D4D_LLD_MOUSE;
#endif


#endif /* __D4D_LLD_API_H */