Steffen Arntz
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.
Fork of
TFTLCD
by 
Todor Todorov
hx8340bs.h@4:3ac4239f6c9c, 2012-12-02 (annotated)
- Committer:
- ttodorov
- Date:
- Sun Dec 02 05:44:52 2012 +0000
- Revision:
- 4:3ac4239f6c9c
- Child:
- 5:09b6d228ceea
- renamed SSD1289 implementation; - refactored base class functions and removed redundant addressing; - added sleep and wake functions; - added HX8340B serial implementation; - fixed test case
Who changed what in which revision?
| User | Revision | Line number | New 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 | 4:3ac4239f6c9c | 12 | * Copyright (C)2012 Todor Todorov. |
| ttodorov | 4:3ac4239f6c9c | 13 | * |
| ttodorov | 4:3ac4239f6c9c | 14 | * This library is free software; you can redistribute it and/or |
| ttodorov | 4:3ac4239f6c9c | 15 | * modify it under the terms of the GNU Lesser General Public |
| ttodorov | 4:3ac4239f6c9c | 16 | * License as published by the Free Software Foundation; either |
| ttodorov | 4:3ac4239f6c9c | 17 | * version 2.1 of the License, or (at your option) any later version. |
| ttodorov | 4:3ac4239f6c9c | 18 | * |
| ttodorov | 4:3ac4239f6c9c | 19 | * This library is distributed in the hope that it will be useful, |
| ttodorov | 4:3ac4239f6c9c | 20 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| ttodorov | 4:3ac4239f6c9c | 21 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| ttodorov | 4:3ac4239f6c9c | 22 | * Lesser General Public License for more details. |
| ttodorov | 4:3ac4239f6c9c | 23 | * |
| ttodorov | 4:3ac4239f6c9c | 24 | * You should have received a copy of the GNU Lesser General Public |
| ttodorov | 4:3ac4239f6c9c | 25 | * License along with this library; if not, write to: |
| ttodorov | 4:3ac4239f6c9c | 26 | * |
| ttodorov | 4:3ac4239f6c9c | 27 | * Free Software Foundation, Inc. |
| ttodorov | 4:3ac4239f6c9c | 28 | * 51 Franklin St, 5th Floor, Boston, MA 02110-1301, USA |
| ttodorov | 4:3ac4239f6c9c | 29 | * |
| ttodorov | 4:3ac4239f6c9c | 30 | *********************************************************************/ |
| ttodorov | 4:3ac4239f6c9c | 31 | #ifndef TFTLCD_HX8340B_H |
| ttodorov | 4:3ac4239f6c9c | 32 | #define TFTLCD_HX8340B_H |
| ttodorov | 4:3ac4239f6c9c | 33 | |
| ttodorov | 4:3ac4239f6c9c | 34 | #include "lcd_base.h" |
| ttodorov | 4:3ac4239f6c9c | 35 | |
| ttodorov | 4:3ac4239f6c9c | 36 | /** Represents a LCD instance. |
| ttodorov | 4:3ac4239f6c9c | 37 | * |
| ttodorov | 4:3ac4239f6c9c | 38 | * This is the utility class, through which the display can be manipulated |
| ttodorov | 4:3ac4239f6c9c | 39 | * and graphics objects can be shown to the user. A known display, which |
| ttodorov | 4:3ac4239f6c9c | 40 | * works with this library is the ITDB02-2.2SP from iTeadStudio - a RGB TFT |
| ttodorov | 4:3ac4239f6c9c | 41 | * with 176x220 pixels resolution and 65K/256K colors, using serial interface. |
| ttodorov | 4:3ac4239f6c9c | 42 | * |
| ttodorov | 4:3ac4239f6c9c | 43 | * The display needs 4 or 5 pins to work with mbed. As it uses +3.3V for power |
| ttodorov | 4:3ac4239f6c9c | 44 | * and logic, as well as the backlight, interfacing could happen directly |
| ttodorov | 4:3ac4239f6c9c | 45 | * to the mbed without the need of shields or level shifters as with Arduino. |
| ttodorov | 4:3ac4239f6c9c | 46 | * |
| ttodorov | 4:3ac4239f6c9c | 47 | * How to use: |
| ttodorov | 4:3ac4239f6c9c | 48 | * \code |
| ttodorov | 4:3ac4239f6c9c | 49 | * // include the library, this will also pull in the header for the provided fonts |
| ttodorov | 4:3ac4239f6c9c | 50 | * #include "hx8340bs.h" |
| ttodorov | 4:3ac4239f6c9c | 51 | * |
| ttodorov | 4:3ac4239f6c9c | 52 | * // create the lcd instance |
| ttodorov | 4:3ac4239f6c9c | 53 | * HX8340S_LCD lcd( p14, p13, p12, p11 ); // control pins |
| ttodorov | 4:3ac4239f6c9c | 54 | * |
| ttodorov | 4:3ac4239f6c9c | 55 | * int main() |
| ttodorov | 4:3ac4239f6c9c | 56 | * { |
| ttodorov | 4:3ac4239f6c9c | 57 | * // initialize display - place it in standard portrait mode and set background to black and |
| ttodorov | 4:3ac4239f6c9c | 58 | * // foreground to white color. |
| ttodorov | 4:3ac4239f6c9c | 59 | * lcd.Initialize(); |
| ttodorov | 4:3ac4239f6c9c | 60 | * // set current font to the smallest 8x12 pixels font. |
| ttodorov | 4:3ac4239f6c9c | 61 | * lcd.SetFont( Font8x12 ); |
| ttodorov | 4:3ac4239f6c9c | 62 | * // print something on the screen |
| ttodorov | 4:3ac4239f6c9c | 63 | * lcd.Print( "Hello, World!", CENTER, 25 ); // align text to center horizontally and use starndard colors |
| ttodorov | 4:3ac4239f6c9c | 64 | * |
| ttodorov | 4:3ac4239f6c9c | 65 | * while ( 1 ) { } |
| ttodorov | 4:3ac4239f6c9c | 66 | * } |
| ttodorov | 4:3ac4239f6c9c | 67 | * |
| ttodorov | 4:3ac4239f6c9c | 68 | * \endcode |
| ttodorov | 4:3ac4239f6c9c | 69 | * \version 0.1 |
| ttodorov | 4:3ac4239f6c9c | 70 | * \author Todor Todorov |
| ttodorov | 4:3ac4239f6c9c | 71 | */ |
| ttodorov | 4:3ac4239f6c9c | 72 | class HX8340S_LCD : public LCD |
| ttodorov | 4:3ac4239f6c9c | 73 | { |
| ttodorov | 4:3ac4239f6c9c | 74 | public: |
| ttodorov | 4:3ac4239f6c9c | 75 | /** Creates a new instance of the class. |
| ttodorov | 4:3ac4239f6c9c | 76 | * |
| ttodorov | 4:3ac4239f6c9c | 77 | * \param CS Pin for the ChipSelect signal. |
| ttodorov | 4:3ac4239f6c9c | 78 | * \param RESET Pin for the RESET line. |
| ttodorov | 4:3ac4239f6c9c | 79 | * \param SCL Pin for the serial clock signal. |
| ttodorov | 4:3ac4239f6c9c | 80 | * \param SDI Pin for the serial data signal. |
| ttodorov | 4:3ac4239f6c9c | 81 | * \param BL Pin for controlling the backlight. By default not used. |
| ttodorov | 4:3ac4239f6c9c | 82 | */ |
| ttodorov | 4:3ac4239f6c9c | 83 | HX8340S_LCD( PinName CS, PinName RESET, PinName SCL, PinName SDI, PinName BL = NC ); |
| ttodorov | 4:3ac4239f6c9c | 84 | |
| ttodorov | 4:3ac4239f6c9c | 85 | /** Initialize display. |
| ttodorov | 4:3ac4239f6c9c | 86 | * |
| ttodorov | 4:3ac4239f6c9c | 87 | * Wakes up the display from sleep, initializes power parameters. |
| ttodorov | 4:3ac4239f6c9c | 88 | * This function must be called first, befor any painting on the |
| ttodorov | 4:3ac4239f6c9c | 89 | * display is done, otherwise the positioning of graphical elements |
| ttodorov | 4:3ac4239f6c9c | 90 | * will not work properly and any paynt operation will not be visible |
| ttodorov | 4:3ac4239f6c9c | 91 | * or produce garbage. |
| ttodorov | 4:3ac4239f6c9c | 92 | * |
| ttodorov | 4:3ac4239f6c9c | 93 | * \param oritentation The display orientation, landscape is default. |
| ttodorov | 4:3ac4239f6c9c | 94 | */ |
| ttodorov | 4:3ac4239f6c9c | 95 | virtual void Initialize( orientation_t orientation = LANDSCAPE ); |
| ttodorov | 4:3ac4239f6c9c | 96 | |
| ttodorov | 4:3ac4239f6c9c | 97 | /** Puts the display to sleep. |
| ttodorov | 4:3ac4239f6c9c | 98 | * |
| ttodorov | 4:3ac4239f6c9c | 99 | * When the display is in sleep mode, its power consumption is |
| ttodorov | 4:3ac4239f6c9c | 100 | * minimized. Before new pixel data can be written to the display |
| ttodorov | 4:3ac4239f6c9c | 101 | * memory, the controller needs to be brought out of sleep mode. |
| ttodorov | 4:3ac4239f6c9c | 102 | * \sa #WakeUp( void ); |
| ttodorov | 4:3ac4239f6c9c | 103 | * \remarks The result of this operation might not be exactly as |
| ttodorov | 4:3ac4239f6c9c | 104 | * expected. Putting the display to sleep will cause the |
| ttodorov | 4:3ac4239f6c9c | 105 | * controller to switch to the standard color of the LCD, |
| ttodorov | 4:3ac4239f6c9c | 106 | * so depending on whether the display is normally white, |
| ttodorov | 4:3ac4239f6c9c | 107 | * or normally dark, the screen might or might not go |
| ttodorov | 4:3ac4239f6c9c | 108 | * dark. Additional power saving can be achieved, if |
| ttodorov | 4:3ac4239f6c9c | 109 | * the backlight of the used display is not hardwired on |
| ttodorov | 4:3ac4239f6c9c | 110 | * the PCB and can be controlled via the BL pin. |
| ttodorov | 4:3ac4239f6c9c | 111 | */ |
| ttodorov | 4:3ac4239f6c9c | 112 | virtual void Sleep( void ); |
| ttodorov | 4:3ac4239f6c9c | 113 | |
| ttodorov | 4:3ac4239f6c9c | 114 | /** Wakes up the display from sleep mode. |
| ttodorov | 4:3ac4239f6c9c | 115 | * |
| ttodorov | 4:3ac4239f6c9c | 116 | * This function needs to be called before any other, when the |
| ttodorov | 4:3ac4239f6c9c | 117 | * display has been put into sleep mode by a previois call to |
| ttodorov | 4:3ac4239f6c9c | 118 | * #Sleep( void ). |
| ttodorov | 4:3ac4239f6c9c | 119 | */ |
| ttodorov | 4:3ac4239f6c9c | 120 | virtual void WakeUp( void ); |
| ttodorov | 4:3ac4239f6c9c | 121 | |
| ttodorov | 4:3ac4239f6c9c | 122 | protected: |
| ttodorov | 4:3ac4239f6c9c | 123 | /** Sends a command to the display. |
| ttodorov | 4:3ac4239f6c9c | 124 | * |
| ttodorov | 4:3ac4239f6c9c | 125 | * \param cmd The display command. |
| ttodorov | 4:3ac4239f6c9c | 126 | * \remarks Commands are controller-specific and this function needs to |
| ttodorov | 4:3ac4239f6c9c | 127 | * be implemented separately for each available controller. |
| ttodorov | 4:3ac4239f6c9c | 128 | */ |
| ttodorov | 4:3ac4239f6c9c | 129 | virtual void WriteCmd( unsigned short cmd ); |
| ttodorov | 4:3ac4239f6c9c | 130 | |
| ttodorov | 4:3ac4239f6c9c | 131 | /** Sends pixel data to the display. |
| ttodorov | 4:3ac4239f6c9c | 132 | * |
| ttodorov | 4:3ac4239f6c9c | 133 | * \param data The display data. |
| ttodorov | 4:3ac4239f6c9c | 134 | * \remarks Sendin data is 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 WriteData( unsigned short data ); |
| ttodorov | 4:3ac4239f6c9c | 138 | |
| ttodorov | 4:3ac4239f6c9c | 139 | /** Writes a single byte of pixel data to the display. |
| ttodorov | 4:3ac4239f6c9c | 140 | * |
| ttodorov | 4:3ac4239f6c9c | 141 | * \param data The data to be written. |
| 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 WriteByteData( unsigned char data ); |
| ttodorov | 4:3ac4239f6c9c | 146 | |
| ttodorov | 4:3ac4239f6c9c | 147 | /** Assigns a chunk of the display memory to receive data. |
| ttodorov | 4:3ac4239f6c9c | 148 | * |
| ttodorov | 4:3ac4239f6c9c | 149 | * When data is sent to the display after this function completes, the opertion will |
| ttodorov | 4:3ac4239f6c9c | 150 | * start from the begining of the assigned address (pixel position) and the pointer |
| ttodorov | 4:3ac4239f6c9c | 151 | * will be automatically incremented so that the next data write operation will continue |
| ttodorov | 4:3ac4239f6c9c | 152 | * with the next pixel from the memory block. If more data is written than available |
| ttodorov | 4:3ac4239f6c9c | 153 | * pixels, at the end of the block the pointer will jump back to its beginning and |
| ttodorov | 4:3ac4239f6c9c | 154 | * commence again, until the next address change command is sent to the display. |
| ttodorov | 4:3ac4239f6c9c | 155 | * |
| ttodorov | 4:3ac4239f6c9c | 156 | * \param x1 The X coordinate of the pixel at the beginning of the block. |
| ttodorov | 4:3ac4239f6c9c | 157 | * \param y1 The Y coordinate of the pixel at the beginning of the block. |
| ttodorov | 4:3ac4239f6c9c | 158 | * \param x2 The X coordinate of the pixel at the end of the block. |
| ttodorov | 4:3ac4239f6c9c | 159 | * \param y2 The Y coordinate of the pixel at the end of the block. |
| ttodorov | 4:3ac4239f6c9c | 160 | * \remarks Addressing commands are controller-specific and this function needs to be |
| ttodorov | 4:3ac4239f6c9c | 161 | * implemented separately for each available controller. |
| ttodorov | 4:3ac4239f6c9c | 162 | */ |
| ttodorov | 4:3ac4239f6c9c | 163 | virtual void SetXY( uint16_t x1, uint16_t y1, uint16_t x2, uint16_t y2 ); |
| ttodorov | 4:3ac4239f6c9c | 164 | |
| ttodorov | 4:3ac4239f6c9c | 165 | private: |
| ttodorov | 4:3ac4239f6c9c | 166 | void serializeByte( unsigned char data ); |
| ttodorov | 4:3ac4239f6c9c | 167 | |
| ttodorov | 4:3ac4239f6c9c | 168 | private: |
| ttodorov | 4:3ac4239f6c9c | 169 | DigitalOut _lcd_pin_scl, _lcd_pin_sdi; |
| ttodorov | 4:3ac4239f6c9c | 170 | DigitalOut* _lcd_pin_bl; |
| ttodorov | 4:3ac4239f6c9c | 171 | }; |
| ttodorov | 4:3ac4239f6c9c | 172 | |
| ttodorov | 4:3ac4239f6c9c | 173 | #endif /* TFTLCD_HX8340B_H */ |