nuttx/arch/arm/src/lpc17xx_40xx/lpc17_40_lcd.h
Xiang Xiao cde88cabcc Run codespell -w with the latest dictonary again
Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-02-23 22:27:46 +01:00

196 lines
7.1 KiB
C

/************************************************************************************
* arch/arm/src/lpc17xx_40xx/lpc17_40_lcd.h
*
* Copyright (C) 2013 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. 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.
* 3. Neither the name NuttX 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 THE
* COPYRIGHT OWNER OR 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.
*
************************************************************************************/
#ifndef __ARCH_ARM_SRC_LPC17XX_40XX_LPC17_40_LCD_H
#define __ARCH_ARM_SRC_LPC17XX_40XX_LPC17_40_LCD_H
/************************************************************************************
* Included Files
************************************************************************************/
#include <nuttx/config.h>
#include <stdbool.h>
#include <nuttx/nx/nxglib.h>
#include "hardware/lpc17_40_lcd.h"
/************************************************************************************
* Pre-processor Definitions
************************************************************************************/
/* Configuration */
/* Base address of the video RAM frame buffer */
#ifndef CONFIG_LPC17_40_LCD_VRAMBASE
# define CONFIG_LPC17_40_LCD_VRAMBASE ((uint32_t)LPC17_40_EXTDRAM_CS0 + 0x00010000)
#endif
/* LCD refresh rate */
#ifndef CONFIG_LPC17_40_LCD_REFRESH_FREQ
# define CONFIG_LPC17_40_LCD_REFRESH_FREQ (50) /* Hz */
#endif
/* Bits per pixel / color format */
#undef LPC17_40_COLOR_FMT
#if defined(CONFIG_LPC17_40_LCD_BPP1)
# define LPC17_40_BPP 1
# define LPC17_40_COLOR_FMT FB_FMT_Y1
#elif defined(CONFIG_LPC17_40_LCD_BPP2)
# define LPC17_40_BPP 2
# define LPC17_40_COLOR_FMT FB_FMT_Y2
#elif defined(CONFIG_LPC17_40_LCD_BPP4)
# define LPC17_40_BPP 4
# define LPC17_40_COLOR_FMT FB_FMT_Y4
#elif defined(CONFIG_LPC17_40_LCD_BPP8)
# define LPC17_40_BPP 8
# define LPC17_40_COLOR_FMT FB_FMT_Y8
#elif defined(CONFIG_LPC17_40_LCD_BPP16)
# define LPC17_40_BPP 16
# define LPC17_40_COLOR_FMT FB_FMT_Y16
#elif defined(CONFIG_LPC17_40_LCD_BPP24)
# define LPC17_40_BPP 32 /* Only 24 of 32 bits used for RGB */
# define LPC17_40_COLOR_FMT FB_FMT_RGB24
# ifndef CONFIG_LPC17_40_LCD_TFTPANEL
# error "24 BPP is only available for a TFT panel"
# endif
#elif defined(CONFIG_LPC17_40_LCD_BPP16_565)
# define LPC17_40_BPP 16
# define LPC17_40_COLOR_FMT FB_FMT_RGB16_565
#elif defined(CONFIG_LPC17_40_LCD_BPP12_444)
# define LPC17_40_BPP 1 2
# define LPC17_40_COLOR_FMT FB_FMT_RGB12_444
#else
# ifndef CONFIG_LPC17_40_LCD_TFTPANEL
# warning "Assuming 24 BPP"
# define LPC17_40_BPP 24
# define CONFIG_LPC17_40_LCD_BPP24 1
# define LPC17_40_COLOR_FMT FB_FMT_RGB24
# else
# warning "Assuming 16 BPP 5:6:5"
# define LPC17_40_BPP 16
# define CONFIG_LPC17_40_LCD_BPP16_565 1
# define LPC17_40_COLOR_FMT FB_FMT_RGB16_565
# endif
#endif
/* Background color */
#ifndef CONFIG_LPC17_40_LCD_BACKCOLOR
# define CONFIG_LPC17_40_LCD_BACKCOLOR 0 /* Initial background color */
#endif
/* Horizontal video characteristics */
#ifndef CONFIG_LPC17_40_LCD_HWIDTH
# define CONFIG_LPC17_40_LCD_HWIDTH 480 /* Width in pixels */
#endif
#ifndef CONFIG_LPC17_40_LCD_HPULSE
# define CONFIG_LPC17_40_LCD_HPULSE 2
#endif
#ifndef CONFIG_LPC17_40_LCD_HFRONTPORCH
# define CONFIG_LPC17_40_LCD_HFRONTPORCH 5
#endif
#ifndef CONFIG_LPC17_40_LCD_HBACKPORCH
# define CONFIG_LPC17_40_LCD_HBACKPORCH 40
#endif
/* Vertical video characteristics */
#ifndef CONFIG_LPC17_40_LCD_VHEIGHT
# define CONFIG_LPC17_40_LCD_VHEIGHT 272 /* Height in rows */
#endif
#ifndef CONFIG_LPC17_40_LCD_VPULSE
# define CONFIG_LPC17_40_LCD_VPULSE 2
#endif
#ifndef CONFIG_LPC17_40_LCD_VFRONTPORCH
# define CONFIG_LPC17_40_LCD_VFRONTPORCH 8
#endif
#ifndef CONFIG_LPC17_40_LCD_VBACKPORCH
# define CONFIG_LPC17_40_LCD_VBACKPORCH 8
#endif
/************************************************************************************
* Public Types
************************************************************************************/
/************************************************************************************
* Public Data
************************************************************************************/
/************************************************************************************
* Public Functions
************************************************************************************/
/* The LPC17 LCD driver uses the common framebuffer interfaces declared in
* include/nuttx/video/fb.h.
*/
/************************************************************************************
* Name: lpc17_40_lcdclear
*
* Description:
* This is a non-standard LCD interface just for the LPC17xx/LPC40xx. Clearing the display
* in the normal way by writing a sequences of runs that covers the entire display
* can be slow. Here the display is cleared by simply setting all VRAM memory to
* the specified color.
*
************************************************************************************/
void lpc17_40_lcdclear(nxgl_mxpixel_t color);
/************************************************************************************
* Name: lpc17_40_backlight
*
* Description:
* If CONFIG_LPC17_40_LCD_BACKLIGHT is defined, then the board-specific logic must
* provide this interface to turn the backlight on and off.
*
************************************************************************************/
#ifdef CONFIG_LPC17_40_LCD_BACKLIGHT
void lpc17_40_backlight(bool blon);
#endif
#endif /* __ARCH_ARM_SRC_LPC17XX_40XX_LPC17_40_LCD_H */