Steffen Arntz / TFTLCD

This is a port of Henning Kralsen's UTFT library for Arduino/chipKIT to mbed, refactored to make full use of C inheritance and access control, in order to reduce work when implementing new drivers and at the same time make the code more readable and easier to maintain. As of now supported are SSD1289 (16-bit interface), HX8340-B (serial interface) and ST7735 (serial interface). Drivers for other controllers will be added as time and resources to acquire the displays to test the code permit.

Dependents:   UTFT_SSD1289

Fork of TFTLCD by Todor Todorov

hx8340bs.h@28:89a1399409ff, 2016-02-16 (annotated)

Committer:
DooMMasteR
Date:
Tue Feb 16 19:09:15 2016 +0000
Revision:
28:89a1399409ff
Parent:
22:4c169297f374 
make size of the ST7735 variable, while not breaking old functionality;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ttodorov 4:3ac4239f6c9c 1 /** \file hx8340b.h
ttodorov 4:3ac4239f6c9c 2 * \brief mbed TFT LCD controller for displays with the HX8340-B IC (serial interface).
ttodorov 4:3ac4239f6c9c 3 * \copyright GNU Public License, v2. or later
ttodorov 4:3ac4239f6c9c 4 *
ttodorov 4:3ac4239f6c9c 5 * A known display with this type of controller chip is the ITDB02-2.2SP
ttodorov 4:3ac4239f6c9c 6 * from http://imall.iteadstudio.com
ttodorov 4:3ac4239f6c9c 7 *
ttodorov 4:3ac4239f6c9c 8 * This library is based on the Arduino/chipKIT UTFT library by Henning
ttodorov 4:3ac4239f6c9c 9 * Karlsen, http://henningkarlsen.com/electronics/library.php?id=52
ttodorov 4:3ac4239f6c9c 10 *
ttodorov 4:3ac4239f6c9c 11 * Copyright (C)2010-2012 Henning Karlsen. All right reserved.
ttodorov 5:09b6d228ceea 12 *
ttodorov 4:3ac4239f6c9c 13 * Copyright (C)2012 Todor Todorov.
ttodorov 4:3ac4239f6c9c 14 *
ttodorov 4:3ac4239f6c9c 15 * This library is free software; you can redistribute it and/or
ttodorov 4:3ac4239f6c9c 16 * modify it under the terms of the GNU Lesser General Public
ttodorov 4:3ac4239f6c9c 17 * License as published by the Free Software Foundation; either
ttodorov 4:3ac4239f6c9c 18 * version 2.1 of the License, or (at your option) any later version.
ttodorov 4:3ac4239f6c9c 19 *
ttodorov 4:3ac4239f6c9c 20 * This library is distributed in the hope that it will be useful,
ttodorov 4:3ac4239f6c9c 21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
ttodorov 4:3ac4239f6c9c 22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
ttodorov 4:3ac4239f6c9c 23 * Lesser General Public License for more details.
ttodorov 4:3ac4239f6c9c 24 *
ttodorov 4:3ac4239f6c9c 25 * You should have received a copy of the GNU Lesser General Public
ttodorov 4:3ac4239f6c9c 26 * License along with this library; if not, write to:
ttodorov 4:3ac4239f6c9c 27 *
ttodorov 4:3ac4239f6c9c 28 * Free Software Foundation, Inc.
ttodorov 4:3ac4239f6c9c 29 * 51 Franklin St, 5th Floor, Boston, MA 02110-1301, USA
ttodorov 4:3ac4239f6c9c 30 *
ttodorov 4:3ac4239f6c9c 31 *********************************************************************/
ttodorov 4:3ac4239f6c9c 32 #ifndef TFTLCD_HX8340B_H
ttodorov 4:3ac4239f6c9c 33 #define TFTLCD_HX8340B_H
ttodorov 4:3ac4239f6c9c 34
ttodorov 4:3ac4239f6c9c 35 #include "lcd_base.h"
ttodorov 4:3ac4239f6c9c 36
ttodorov 6:059ca1648211 37 #ifdef __cplusplus
ttodorov 6:059ca1648211 38 extern "C" {
ttodorov 6:059ca1648211 39 #endif
ttodorov 6:059ca1648211 40
ttodorov 4:3ac4239f6c9c 41 /** Represents a LCD instance.
ttodorov 4:3ac4239f6c9c 42 *
ttodorov 4:3ac4239f6c9c 43 * This is the utility class, through which the display can be manipulated
ttodorov 4:3ac4239f6c9c 44 * and graphics objects can be shown to the user. A known display, which
ttodorov 4:3ac4239f6c9c 45 * works with this library is the ITDB02-2.2SP from iTeadStudio - a RGB TFT
ttodorov 4:3ac4239f6c9c 46 * with 176x220 pixels resolution and 65K/256K colors, using serial interface.
ttodorov 4:3ac4239f6c9c 47 *
ttodorov 4:3ac4239f6c9c 48 * The display needs 4 or 5 pins to work with mbed. As it uses +3.3V for power
ttodorov 4:3ac4239f6c9c 49 * and logic, as well as the backlight, interfacing could happen directly
ttodorov 4:3ac4239f6c9c 50 * to the mbed without the need of shields or level shifters as with Arduino.
ttodorov 4:3ac4239f6c9c 51 *
ttodorov 4:3ac4239f6c9c 52 * How to use:
ttodorov 4:3ac4239f6c9c 53 * \code
ttodorov 4:3ac4239f6c9c 54 * // include the library, this will also pull in the header for the provided fonts
ttodorov 4:3ac4239f6c9c 55 * #include "hx8340bs.h"
ttodorov 4:3ac4239f6c9c 56 *
ttodorov 4:3ac4239f6c9c 57 * // create the lcd instance
ttodorov 4:3ac4239f6c9c 58 * HX8340S_LCD lcd( p14, p13, p12, p11 ); // control pins
ttodorov 4:3ac4239f6c9c 59 *
ttodorov 4:3ac4239f6c9c 60 * int main()
ttodorov 4:3ac4239f6c9c 61 * {
ttodorov 4:3ac4239f6c9c 62 * // initialize display - place it in standard portrait mode and set background to black and
ttodorov 4:3ac4239f6c9c 63 * // foreground to white color.
ttodorov 4:3ac4239f6c9c 64 * lcd.Initialize();
ttodorov 4:3ac4239f6c9c 65 * // set current font to the smallest 8x12 pixels font.
ttodorov 4:3ac4239f6c9c 66 * lcd.SetFont( Font8x12 );
ttodorov 4:3ac4239f6c9c 67 * // print something on the screen
ttodorov 4:3ac4239f6c9c 68 * lcd.Print( "Hello, World!", CENTER, 25 ); // align text to center horizontally and use starndard colors
ttodorov 4:3ac4239f6c9c 69 *
ttodorov 4:3ac4239f6c9c 70 * while ( 1 ) { }
ttodorov 4:3ac4239f6c9c 71 * }
ttodorov 4:3ac4239f6c9c 72 *
ttodorov 4:3ac4239f6c9c 73 * \endcode
ttodorov 4:3ac4239f6c9c 74 * \version 0.1
ttodorov 4:3ac4239f6c9c 75 * \author Todor Todorov
ttodorov 4:3ac4239f6c9c 76 */
ttodorov 4:3ac4239f6c9c 77 class HX8340S_LCD : public LCD
ttodorov 4:3ac4239f6c9c 78 {
ttodorov 4:3ac4239f6c9c 79 public:
ttodorov 4:3ac4239f6c9c 80 /** Creates a new instance of the class.
ttodorov 4:3ac4239f6c9c 81 *
ttodorov 4:3ac4239f6c9c 82 * \param CS Pin for the ChipSelect signal.
ttodorov 4:3ac4239f6c9c 83 * \param RESET Pin for the RESET line.
ttodorov 4:3ac4239f6c9c 84 * \param SCL Pin for the serial clock signal.
ttodorov 4:3ac4239f6c9c 85 * \param SDI Pin for the serial data signal.
ttodorov 4:3ac4239f6c9c 86 * \param BL Pin for controlling the backlight. By default not used.
ttodorov 22:4c169297f374 87 * \param blType The backlight type, the default is to utilize the pin - if supplied - as a simple on/off switch
ttodorov 22:4c169297f374 88 * \param defaultBacklightLevel If using PWM to control backlight, this would be the default brightness in percent after LCD initialization.
ttodorov 4:3ac4239f6c9c 89 */
ttodorov 22:4c169297f374 90 HX8340S_LCD( PinName CS, PinName RESET, PinName SCL, PinName SDI, PinName BL = NC, backlight_t blType = Constant, float defaultBackLightLevel = 1.0 );
ttodorov 4:3ac4239f6c9c 91
ttodorov 4:3ac4239f6c9c 92 /** Initialize display.
ttodorov 4:3ac4239f6c9c 93 *
ttodorov 4:3ac4239f6c9c 94 * Wakes up the display from sleep, initializes power parameters.
ttodorov 4:3ac4239f6c9c 95 * This function must be called first, befor any painting on the
ttodorov 4:3ac4239f6c9c 96 * display is done, otherwise the positioning of graphical elements
ttodorov 4:3ac4239f6c9c 97 * will not work properly and any paynt operation will not be visible
ttodorov 4:3ac4239f6c9c 98 * or produce garbage.
ttodorov 4:3ac4239f6c9c 99 *
ttodorov 4:3ac4239f6c9c 100 * \param oritentation The display orientation, landscape is default.
ttodorov 12:d0978272a340 101 * \param colors The correct color depth to use for the pixel data.
ttodorov 4:3ac4239f6c9c 102 */
ttodorov 12:d0978272a340 103 virtual void Initialize( orientation_t orientation = LANDSCAPE, colordepth_t colors = RGB16 );
ttodorov 4:3ac4239f6c9c 104
ttodorov 4:3ac4239f6c9c 105 /** Puts the display to sleep.
ttodorov 4:3ac4239f6c9c 106 *
ttodorov 4:3ac4239f6c9c 107 * When the display is in sleep mode, its power consumption is
ttodorov 4:3ac4239f6c9c 108 * minimized. Before new pixel data can be written to the display
ttodorov 4:3ac4239f6c9c 109 * memory, the controller needs to be brought out of sleep mode.
ttodorov 4:3ac4239f6c9c 110 * \sa #WakeUp( void );
ttodorov 4:3ac4239f6c9c 111 * \remarks The result of this operation might not be exactly as
ttodorov 4:3ac4239f6c9c 112 * expected. Putting the display to sleep will cause the
ttodorov 4:3ac4239f6c9c 113 * controller to switch to the standard color of the LCD,
ttodorov 4:3ac4239f6c9c 114 * so depending on whether the display is normally white,
ttodorov 4:3ac4239f6c9c 115 * or normally dark, the screen might or might not go
ttodorov 4:3ac4239f6c9c 116 * dark. Additional power saving can be achieved, if
ttodorov 4:3ac4239f6c9c 117 * the backlight of the used display is not hardwired on
ttodorov 4:3ac4239f6c9c 118 * the PCB and can be controlled via the BL pin.
ttodorov 4:3ac4239f6c9c 119 */
ttodorov 4:3ac4239f6c9c 120 virtual void Sleep( void );
ttodorov 4:3ac4239f6c9c 121
ttodorov 4:3ac4239f6c9c 122 /** Wakes up the display from sleep mode.
ttodorov 4:3ac4239f6c9c 123 *
ttodorov 4:3ac4239f6c9c 124 * This function needs to be called before any other, when the
ttodorov 4:3ac4239f6c9c 125 * display has been put into sleep mode by a previois call to
ttodorov 4:3ac4239f6c9c 126 * #Sleep( void ).
ttodorov 4:3ac4239f6c9c 127 */
ttodorov 4:3ac4239f6c9c 128 virtual void WakeUp( void );
ttodorov 4:3ac4239f6c9c 129
ttodorov 4:3ac4239f6c9c 130 protected:
ttodorov 4:3ac4239f6c9c 131 /** Sends a command to the display.
ttodorov 4:3ac4239f6c9c 132 *
ttodorov 4:3ac4239f6c9c 133 * \param cmd The display command.
ttodorov 4:3ac4239f6c9c 134 * \remarks Commands are controller-specific and this function needs to
ttodorov 4:3ac4239f6c9c 135 * be implemented separately for each available controller.
ttodorov 4:3ac4239f6c9c 136 */
ttodorov 4:3ac4239f6c9c 137 virtual void WriteCmd( unsigned short cmd );
ttodorov 4:3ac4239f6c9c 138
ttodorov 4:3ac4239f6c9c 139 /** Sends pixel data to the display.
ttodorov 4:3ac4239f6c9c 140 *
ttodorov 4:3ac4239f6c9c 141 * \param data The display data.
ttodorov 4:3ac4239f6c9c 142 * \remarks Sendin data is controller-specific and this function needs to
ttodorov 4:3ac4239f6c9c 143 * be implemented separately for each available controller.
ttodorov 4:3ac4239f6c9c 144 */
ttodorov 4:3ac4239f6c9c 145 virtual void WriteData( unsigned short data );
ttodorov 4:3ac4239f6c9c 146
ttodorov 4:3ac4239f6c9c 147 /** Writes a single byte of pixel data to the display.
ttodorov 4:3ac4239f6c9c 148 *
ttodorov 4:3ac4239f6c9c 149 * \param data The data to be written.
ttodorov 4:3ac4239f6c9c 150 * \remarks Sendin data is controller-specific and this function needs to
ttodorov 4:3ac4239f6c9c 151 * be implemented separately for each available controller.
ttodorov 4:3ac4239f6c9c 152 */
ttodorov 4:3ac4239f6c9c 153 virtual void WriteByteData( unsigned char data );
ttodorov 4:3ac4239f6c9c 154
ttodorov 4:3ac4239f6c9c 155 /** Assigns a chunk of the display memory to receive data.
ttodorov 4:3ac4239f6c9c 156 *
ttodorov 4:3ac4239f6c9c 157 * When data is sent to the display after this function completes, the opertion will
ttodorov 4:3ac4239f6c9c 158 * start from the begining of the assigned address (pixel position) and the pointer
ttodorov 4:3ac4239f6c9c 159 * will be automatically incremented so that the next data write operation will continue
ttodorov 4:3ac4239f6c9c 160 * with the next pixel from the memory block. If more data is written than available
ttodorov 4:3ac4239f6c9c 161 * pixels, at the end of the block the pointer will jump back to its beginning and
ttodorov 4:3ac4239f6c9c 162 * commence again, until the next address change command is sent to the display.
ttodorov 4:3ac4239f6c9c 163 *
ttodorov 4:3ac4239f6c9c 164 * \param x1 The X coordinate of the pixel at the beginning of the block.
ttodorov 4:3ac4239f6c9c 165 * \param y1 The Y coordinate of the pixel at the beginning of the block.
ttodorov 4:3ac4239f6c9c 166 * \param x2 The X coordinate of the pixel at the end of the block.
ttodorov 4:3ac4239f6c9c 167 * \param y2 The Y coordinate of the pixel at the end of the block.
ttodorov 4:3ac4239f6c9c 168 * \remarks Addressing commands are controller-specific and this function needs to be
ttodorov 4:3ac4239f6c9c 169 * implemented separately for each available controller.
ttodorov 4:3ac4239f6c9c 170 */
ttodorov 20:4bdca8d8dadc 171 virtual void SetXY( unsigned short x1, unsigned short y1, unsigned short x2, unsigned short y2 );
ttodorov 4:3ac4239f6c9c 172
ttodorov 10:69571adcfad5 173 /** Sets the color of the pixel at the address pointer of the controller.
ttodorov 10:69571adcfad5 174 *
ttodorov 10:69571adcfad5 175 * This function is to be provided by each implementation separately in
ttodorov 10:69571adcfad5 176 * order to account for different color depth used by the controller.
ttodorov 10:69571adcfad5 177 * \param color The color of the pixel.
ttodorov 20:4bdca8d8dadc 178 * \param mode The depth (palette) of the color.
ttodorov 10:69571adcfad5 179 */
ttodorov 20:4bdca8d8dadc 180 virtual void SetPixelColor( unsigned int color, colordepth_t mode = RGB24 );
ttodorov 10:69571adcfad5 181
ttodorov 4:3ac4239f6c9c 182 private:
ttodorov 4:3ac4239f6c9c 183 void serializeByte( unsigned char data );
ttodorov 4:3ac4239f6c9c 184
ttodorov 4:3ac4239f6c9c 185 private:
ttodorov 4:3ac4239f6c9c 186 DigitalOut _lcd_pin_scl, _lcd_pin_sdi;
ttodorov 4:3ac4239f6c9c 187 };
ttodorov 4:3ac4239f6c9c 188
ttodorov 6:059ca1648211 189 #ifdef __cplusplus
ttodorov 6:059ca1648211 190 }
ttodorov 6:059ca1648211 191 #endif
ttodorov 6:059ca1648211 192
ttodorov 4:3ac4239f6c9c 193 #endif /* TFTLCD_HX8340B_H */