lcd_001.h

Go to the documentation of this file.

/*
 * @brief LCD controller Registers and control functions
 *
 * @note
 * Copyright(C) NXP Semiconductors, 2012
 * All rights reserved.
 *
 * @par
 * Software that is described herein is for illustrative purposes only
 * which provides customers with programming information regarding the
 * LPC products.  This software is supplied "AS IS" without any warranties of
 * any kind, and NXP Semiconductors and its licensor disclaim any and
 * all warranties, express or implied, including all implied warranties of
 * merchantability, fitness for a particular purpose and non-infringement of
 * intellectual property rights.  NXP Semiconductors assumes no responsibility
 * or liability for the use of the software, conveys no license or rights under any
 * patent, copyright, mask work right, or any other intellectual property rights in
 * or to any products. NXP Semiconductors reserves the right to make changes
 * in the software without notification. NXP Semiconductors also makes no
 * representation or warranty that such application will be suitable for the
 * specified use without further testing or modification.
 *
 * @par
 * Permission to use, copy, modify, and distribute this software and its
 * documentation is hereby granted, under NXP Semiconductors' and its
 * licensor's relevant copyrights in the software, without fee, provided that it
 * is used in conjunction with NXP Semiconductors microcontrollers.  This
 * copyright, permission, and disclaimer notice must appear in all copies of
 * this code.
 */

#ifndef __LCD_001_H_
#define __LCD_001_H_

#include "sys_config.h"
#include "cmsis.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef struct {    
 __IO uint32_t  TIMH;  
 __IO uint32_t  TIMV;  
 __IO uint32_t  POL;   
 __IO uint32_t  LE;   
 __IO uint32_t  UPBASE;  
 __IO uint32_t  LPBASE;  
 __IO uint32_t  CTRL;  
 __IO uint32_t  INTMSK;  
 __I  uint32_t  INTRAW;  
 __I  uint32_t  INTSTAT;  
 __O  uint32_t  INTCLR;  
 __I  uint32_t  UPCURR;  
 __I  uint32_t  LPCURR;  
 __I  uint32_t  RESERVED0[115];
 __IO uint16_t PAL[256];  
 __I  uint32_t  RESERVED1[256];
 __IO uint32_t CRSR_IMG[256];
 __IO uint32_t  CRSR_CTRL; 
 __IO uint32_t  CRSR_CFG; 
 __IO uint32_t  CRSR_PAL0; 
 __IO uint32_t  CRSR_PAL1; 
 __IO uint32_t  CRSR_XY;  
 __IO uint32_t  CRSR_CLIP; 
 __I  uint32_t  RESERVED2[2];
 __IO uint32_t  CRSR_INTMSK; 
 __O  uint32_t  CRSR_INTCLR; 
 __I  uint32_t  CRSR_INTRAW; 
 __I  uint32_t  CRSR_INTSTAT;
} IP_LCD_001_T;

typedef struct {
 uint32_t Rl : 5;
 uint32_t Gl : 5;
 uint32_t Bl : 5;
 uint32_t Il : 1;
 uint32_t Ru : 5;
 uint32_t Gu : 5;
 uint32_t Bu : 5;
 uint32_t Iu : 1;
} LCD_PALETTE_ENTRY_T;

typedef enum IP_LCD_PANEL_OPT {
 LCD_TFT = 0x02,  
 LCD_MONO_4 = 0x01, 
 LCD_MONO_8 = 0x05, 
 LCD_CSTN = 0x00  
} IP_LCD_PANEL_OPT_T;

typedef enum IP_LCD_COLOR_FORMAT_OPT {
 LCD_COLOR_FORMAT_RGB = 0,
 LCD_COLOR_FORMAT_BGR
} IP_LCD_COLOR_FORMAT_OPT_T;

#define LCD_INTMSK_FUFIM   0x2 
#define LCD_INTMSK_LNBUIM  0x4 
#define LCD_INTMSK_VCOMPIM 0x8 
#define LCD_INTMSK_BERIM   0x10 
#define CLCDC_LCDCTRL_ENABLE    _BIT(0)  
#define CLCDC_LCDCTRL_PWR       _BIT(11) 
typedef struct {
 uint8_t  HBP; 
 uint8_t  HFP; 
 uint8_t  HSW; 
 uint16_t PPL; 
 uint8_t  VBP; 
 uint8_t  VFP; 
 uint8_t  VSW; 
 uint16_t LPP; 
 uint8_t  IOE; 
 uint8_t  IPC; 
 uint8_t  IHS; 
 uint8_t  IVS; 
 uint8_t  ACB; 
 uint8_t  BPP; 
 IP_LCD_PANEL_OPT_T  LCD; 
 IP_LCD_COLOR_FORMAT_OPT_T  color_format; 
 uint8_t  Dual; 
} LCD_Config_T;

typedef enum IP_LCD_CURSOR_SIZE_OPT {
 LCD_CURSOR_32x32 = 0,
 LCD_CURSOR_64x64
} IP_LCD_CURSOR_SIZE_OPT_T;

STATIC INLINE void IP_LCD_EnableInts(IP_LCD_001_T *pLCD, uint32_t ints)
{
 pLCD->INTMSK = ints;
}

STATIC INLINE void IP_LCD_DisableInts(IP_LCD_001_T *pLCD, uint32_t ints)
{
 pLCD->INTMSK = pLCD->INTMSK & ~(ints);
}

STATIC INLINE void IP_LCD_ClearInts(IP_LCD_001_T *pLCD, uint32_t ints)
{
 pLCD->INTCLR = pLCD->INTMSK & (ints);
}

STATIC INLINE void IP_LCD_PowerOn(IP_LCD_001_T *pLCD) {
 volatile int i;
 pLCD->CTRL |= CLCDC_LCDCTRL_PWR;
 for (i = 0; i < 1000000; i++) {}
 pLCD->CTRL |= CLCDC_LCDCTRL_ENABLE;
}

STATIC INLINE void IP_LCD_PowerOff(IP_LCD_001_T *pLCD) {
 volatile int i;
 pLCD->CTRL &= ~CLCDC_LCDCTRL_PWR;
 for (i = 0; i < 1000000; i++) {}
 pLCD->CTRL &= ~CLCDC_LCDCTRL_ENABLE;
}

STATIC INLINE void IP_LCD_Enable(IP_LCD_001_T *pLCD) {
 pLCD->CTRL |= CLCDC_LCDCTRL_ENABLE;
}

STATIC INLINE void IP_LCD_Disable(IP_LCD_001_T *pLCD) {
 pLCD->CTRL &= ~CLCDC_LCDCTRL_ENABLE;
}

STATIC INLINE void IP_LCD_SetUPFrameBuffer(IP_LCD_001_T *pLCD, void *buffer)
{
 pLCD->UPBASE = (uint32_t) buffer;
}

STATIC INLINE void IP_LCD_SetLPFrameBuffer(IP_LCD_001_T *pLCD, void *buffer)
{
 pLCD->LPBASE = (uint32_t) buffer;
}

STATIC INLINE void IP_LCD_Cursor_Config(IP_LCD_001_T *pLCD, IP_LCD_CURSOR_SIZE_OPT_T cursor_size, bool sync)
{
 pLCD->CRSR_CFG = ((sync ? 1 : 0) << 1) | cursor_size;
}

STATIC INLINE void *IP_LCD_Cursor_GetImageBufferAddress(IP_LCD_001_T *pLCD, uint8_t cursor_num)
{
 return (void *) &(pLCD->CRSR_IMG[cursor_num * 64]);
}

STATIC INLINE void IP_LCD_Cursor_Enable(IP_LCD_001_T *pLCD, uint8_t cursor_num) {
 pLCD->CRSR_CTRL = (cursor_num << 4) | 1;
}

STATIC INLINE void IP_LCD_Cursor_Disable(IP_LCD_001_T *pLCD, uint8_t cursor_num) {
 pLCD->CRSR_CTRL = (cursor_num << 4);
}

STATIC INLINE void IP_LCD_Cursor_LoadPalette0(IP_LCD_001_T *pLCD, uint32_t palette_color)
{
 /* 7:0 - Red
    15:8 - Green
    23:16 - Blue
    31:24 - Not used*/
 pLCD->CRSR_PAL0 = (uint32_t) palette_color;
}

STATIC INLINE void IP_LCD_Cursor_LoadPalette1(IP_LCD_001_T *pLCD, uint32_t palette_color)
{
 /* 7:0 - Red
        15:8 - Green
        23:16 - Blue
        31:24 - Not used*/
 pLCD->CRSR_PAL1 = (uint32_t) palette_color;

}

STATIC INLINE void IP_LCD_Cursor_SetPos(IP_LCD_001_T *pLCD, uint16_t x, uint16_t y)
{
 pLCD->CRSR_XY = (x & 0x3FF) | ((y & 0x3FF) << 16);
}

STATIC INLINE void IP_LCD_Cursor_SetClip(IP_LCD_001_T *pLCD, uint16_t x, uint16_t y)
{
 pLCD->CRSR_CLIP = (x & 0x3F) | ((y & 0x3F) << 8);
}

STATIC INLINE void IP_LCD_Color_LoadPalette(IP_LCD_001_T *pLCD, uint32_t *palette_addr, uint32_t index)
{
 pLCD->PAL[index] = *(uint32_t *) palette_addr;
}

void IP_LCD_Init(IP_LCD_001_T *pLCD, LCD_Config_T *LCD_ConfigStruct);

#ifdef __cplusplus
}
#endif

#endif /* __LCD_001_H_ */