include/bsp/lcd.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSBSPsARMLPC24XX_lcd
0007  *
0008  * @brief LCD support.
0009  */
0010
0011 /*
0012  * Copyright (C) 2010, 2012 embedded brains GmbH & Co. KG
0013  *
0014  * Redistribution and use in source and binary forms, with or without
0015  * modification, are permitted provided that the following conditions
0016  * are met:
0017  * 1. Redistributions of source code must retain the above copyright
0018  *    notice, this list of conditions and the following disclaimer.
0019  * 2. Redistributions in binary form must reproduce the above copyright
0020  *    notice, this list of conditions and the following disclaimer in the
0021  *    documentation and/or other materials provided with the distribution.
0022  *
0023  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0024  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0025  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0026  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0027  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0028  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0029  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0030  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0031  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0032  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0033  * POSSIBILITY OF SUCH DAMAGE.
0034  */
0035
0036 #ifndef LIBBSP_ARM_LPC24XX_LCD_H
0037 #define LIBBSP_ARM_LPC24XX_LCD_H
0038
0039 #include <rtems.h>
0040
0041 #include <bsp/io.h>
0042
0043 #ifdef __cplusplus
0044 extern "C" {
0045 #endif
0046
0047 /**
0048  * @defgroup lpc_dma LCD Support
0049  *
0050  * @ingroup RTEMSBSPsARMLPC24XX
0051  *
0052  * @brief LCD support.
0053  *
0054  * @{
0055  */
0056
0057 typedef enum {
0058   #ifdef ARM_MULTILIB_ARCH_V4
0059     LCD_MODE_STN_4_BIT = 0,
0060     LCD_MODE_STN_8_BIT,
0061     LCD_MODE_STN_DUAL_PANEL_4_BIT,
0062     LCD_MODE_STN_DUAL_PANEL_8_BIT,
0063     LCD_MODE_TFT_12_BIT_4_4_4,
0064     LCD_MODE_TFT_16_BIT_5_6_5,
0065     LCD_MODE_TFT_16_BIT_1_5_5_5,
0066     LCD_MODE_TFT_24_BIT,
0067     LCD_MODE_DISABLED
0068   #else
0069     LCD_MODE_STN_4_BIT = 0x4,
0070     LCD_MODE_STN_8_BIT = 0x6,
0071     LCD_MODE_STN_DUAL_PANEL_4_BIT = 0x84,
0072     LCD_MODE_STN_DUAL_PANEL_8_BIT = 0x86,
0073     LCD_MODE_TFT_12_BIT_4_4_4 = 0x2e,
0074     LCD_MODE_TFT_16_BIT_5_6_5 = 0x2c,
0075     LCD_MODE_TFT_16_BIT_1_5_5_5 = 0x28,
0076     LCD_MODE_TFT_24_BIT = 0x2a,
0077     LCD_MODE_DISABLED = 0xff
0078   #endif
0079 } lpc24xx_lcd_mode;
0080
0081 /**
0082  * @brief Set the LCD @a mode.
0083  *
0084  * The pins are configured according to @a pins.
0085  *
0086  * @see lpc24xx_pin_config().
0087  *
0088  * @retval RTEMS_SUCCESSFUL Successful operation.
0089  * @retval RTEMS_IO_ERROR Invalid mode.
0090  */
0091 rtems_status_code lpc24xx_lcd_set_mode(
0092   lpc24xx_lcd_mode mode,
0093   const lpc24xx_pin_range *pins
0094 );
0095
0096 lpc24xx_lcd_mode lpc24xx_lcd_current_mode(void);
0097
0098 /** @} */
0099
0100 #ifdef __cplusplus
0101 }
0102 #endif /* __cplusplus */
0103
0104 #endif /* LIBBSP_ARM_LPC24XX_LCD_H */