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:   test SDCard capstone_display capstone_display_2 ... more

TFTLCD Library

NOTE (2013-03-25) Tested with both mbed LPC1768 and Freedom KL25Z. -todor

A TFT LCD driver library, which at the moment provides support for the following display controllers: HX8340-B (serial interface), SSD1289 (16-bit interface), ST7735-R (serial interface), ILI9325/ILI9328 (16-bit interface).

As I am acquiring and testing out new displays, I decided to combine all ported drivers into one library as with the original work done by Henning. However I also had as a goal to make the code maintenance and readability easier/better, so the code has been heavily refactored to make full use of C++ facilities as inheritance and access control. I extracted the common pieces of code into a base class, which every driver inherits and only the controller-specific side is provided in the actual driver - things like initialization, addressing, data transfer, etc.

Another nice extension is that the display's backlight can now be controlled through the driver. Either a simple on/off method of control could be selected, or the brightness can be set through use of PWM (the latter placing some restrictions on which pins can be used for this, as mbed offers hardware PWM on only 6 pins).

I also plan to add support for touch screens as part of the library. The goal is to grow this piece of software into a lightweight graphics widgets library, which can be used to construct control screens with buttons or menus in a speedy and intuitive way.

Changes

2013-07-21

  • Fixed the sleep/wake-up functions of the ILI9328 driver.

2013-06-15

  • Added driver for ILI9328 (works with ILI9325) controller, 16-bit data bus. Screen rotation works as usual with the TFTLCD library, but for now only RGB565 color depth is working and you can use both 65K and 262K color space with this driver. But for some reason the sleep function is not behaving as expected; I am working on this.
  • This is only on my to-do list for now - haven't really had the time yet - but I am going to refactor the library a bit to allow use of GPIO ports for data transfers instead of DigitalOut: faster and cleaner that way. For those who are using it already in a working design and cannot repurpose the pins anymore, the current way it's working will still be available; I am hoping not to tear up the public interfaces of the library (... too much). Anyway, since I am at it, I will also try to add support for multiple bus interfaces to drivers that support it (i.e. both 8bit and 16bit use of ILI932x or SSD1289). Thought this might be a good place to give you guys the heads-up.

2013-01-25

  • Replaced all existing fonts from the UTFT library with the free Terminus font. Two different sizes are provided: 8x12 pixels and 16x28 pixels. I found the old fonts not so good looking and then they supported only the ASCII codes in the range 30 (space) to 126 (the tilde ). The 7segment font didn't even implement anything else than the numbers from 0 to 9 - so it was unusable for anything (one couldn't even display the time or date as it lacked the colon [:] or the period [.] or the slash [/] or the space [ ] characters). So I completely revamped the fonts and added Terminus as the new default with its 2 sizes. Further more I added in both sizes most of the characters up to ASCII code 255. For any code not in there, the space character is substituted. In the case, when you already have provided your own fonts, please have a look at the API changes in the files <terminus.h> and <terminus.cpp>: I promise you whatever time you spent designing your own font, it is not wasted; you merely need to add a second array, which describes which ASCII codes are available in your font, and their byte offset in the original character bitmap array; and a struct to tie all parts together and describe the character size. I am sorry for breaking the old API, but you will like the change and new options it brings you. Now you can insert any char above 127 up to code 255 (if available, of course) with its hex representation, e.g displaying the current temperature would look something like 85\xB0 F or 26\xB0 C (the space in between degree and F or C is needed because both F and C are used in hex numbers, so \xB0F is interpreted as ASCII code 2831 instead of ASCII code 176, followed by the temperature scale denomination; if you insist on avoiding the space, you could write 85\xB0\x46 which will be displayed correctly as 85°F). You can either look up the ASCII code you need on Google or Bing, or just look at what's available - how it looks and its hex value - in the comments in <terminus.cpp>.
  • Added PWM backlight control. If you intend to use this, please make sure that control pin is either one of p21, p22, p23, p24, p25, or p26, as only they support hardware PWM. Please be aware that the mbed pins do not have much juice behind them, so if your display's backlight requires a lot of current, you are better off interfacing through as small signal transistor or a MOSFET. For the rest please consult the updated Doxygen documentation. NOTE The addition of PWM-controlled backlight will not break your existing code, the new options have default values, which initialize the used driver to behave as prior to PWM. Only if you want to use the new feature, some changes need to be made. The PWM is configured to be 120Hz (period of 8.33 milliseconds), in order to avoid noticeable flicker in the backlight. If in your opinion this value is too fine, then you can reduce the frequency in the LCD constructor in <lcd_base.cpp> by increasing the period value. My recommendation is to avoid frequencies lower than 60Hz.

2012-12-21

  • Internal-only changes in the way drivers transmit colors - done to simplify the bitmap drawing routines; client API remains unchanged.

2012-12-12

  • Added the driver for the ST7735 display controller.
  • Added the RGB18 color mode: choose between 16-bit (65K distinct colors) and 18-bit (262K distinct colors) color space [supported by all drivers]. NOTE This feature requires the image drawing functions to be changed, in order to account for differences between configured display color depth and the color depth of the image. Please review the API docs, in particular the new type bitmap_t and the DrawBitmap functions.
  • Changed display rotation to be achieved through the correspondent settings in the respective controller registers: no more software translation between width and height in different display orientations.
  • Extended the orientation options: PORTRAIT (top line to 12 o'clock/upright) and LANDSCAPE (top line to 9 o'clock) positions are the old options, PORTRAIT_REV (top line to 6 o'clock/upside-down) and LANDSCAPE_REV (top line to 3 o'clock) are the new orientations.
  • Added more pre-defined colors: available now are COLOR_BLACK, COLOR_WHITE, COLOR_RED, COLOR_GREEN, COLOR_BLUE, COLOR_CYAN, COLOR_MAGENTA and COLOR_YELLOW.

TODO

  • Finish implementing PWM-controlled backlight (current-sink configuration).
  • Add a driver for the HX8352-A controller (ITDB02-3.2WD 16:9 240x400 pixel resolution display).

How to Use

The code is documented, so please review the API docs. There is a simple example to get you started...

Committer:
ttodorov
Date:
Sun Dec 02 05:44:52 2012 +0000
Revision:
4:3ac4239f6c9c
Child:
9:58b328831d0a
- 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?

UserRevisionLine numberNew contents of line
ttodorov 4:3ac4239f6c9c 1 /*
ttodorov 4:3ac4239f6c9c 2 * Copyright (C)2010-2012 Henning Karlsen. All right reserved.
ttodorov 4:3ac4239f6c9c 3 * Copyright (C)2012 Todor Todorov.
ttodorov 4:3ac4239f6c9c 4 *
ttodorov 4:3ac4239f6c9c 5 * This library is free software; you can redistribute it and/or
ttodorov 4:3ac4239f6c9c 6 * modify it under the terms of the GNU Lesser General Public
ttodorov 4:3ac4239f6c9c 7 * License as published by the Free Software Foundation; either
ttodorov 4:3ac4239f6c9c 8 * version 2.1 of the License, or (at your option) any later version.
ttodorov 4:3ac4239f6c9c 9 *
ttodorov 4:3ac4239f6c9c 10 * This library is distributed in the hope that it will be useful,
ttodorov 4:3ac4239f6c9c 11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
ttodorov 4:3ac4239f6c9c 12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
ttodorov 4:3ac4239f6c9c 13 * Lesser General Public License for more details.
ttodorov 4:3ac4239f6c9c 14 *
ttodorov 4:3ac4239f6c9c 15 * You should have received a copy of the GNU Lesser General Public
ttodorov 4:3ac4239f6c9c 16 * License along with this library; if not, write to:
ttodorov 4:3ac4239f6c9c 17 *
ttodorov 4:3ac4239f6c9c 18 * Free Software Foundation, Inc.
ttodorov 4:3ac4239f6c9c 19 * 51 Franklin St, 5th Floor, Boston, MA 02110-1301, USA
ttodorov 4:3ac4239f6c9c 20 *
ttodorov 4:3ac4239f6c9c 21 *********************************************************************/
ttodorov 4:3ac4239f6c9c 22 #include "hx8340bs.h"
ttodorov 4:3ac4239f6c9c 23 #include "helpers.h"
ttodorov 4:3ac4239f6c9c 24
ttodorov 4:3ac4239f6c9c 25 HX8340S_LCD::HX8340S_LCD( PinName CS, PinName RESET, PinName SCL, PinName SDI, PinName BL )
ttodorov 4:3ac4239f6c9c 26 : LCD( 176, 220, CS, NC, RESET ), _lcd_pin_scl( SCL ), _lcd_pin_sdi( SDI )
ttodorov 4:3ac4239f6c9c 27 {
ttodorov 4:3ac4239f6c9c 28 if ( BL != NC ) _lcd_pin_bl = new DigitalOut( BL );
ttodorov 4:3ac4239f6c9c 29 else _lcd_pin_bl = 0;
ttodorov 4:3ac4239f6c9c 30 }
ttodorov 4:3ac4239f6c9c 31
ttodorov 4:3ac4239f6c9c 32 void HX8340S_LCD::Initialize( orientation_t orientation )
ttodorov 4:3ac4239f6c9c 33 {
ttodorov 4:3ac4239f6c9c 34 _orientation = orientation;
ttodorov 4:3ac4239f6c9c 35
ttodorov 4:3ac4239f6c9c 36 wait_ms( 100 );
ttodorov 4:3ac4239f6c9c 37 _lcd_pin_reset = HIGH;
ttodorov 4:3ac4239f6c9c 38 wait_ms( 5 );
ttodorov 4:3ac4239f6c9c 39 _lcd_pin_reset = LOW;
ttodorov 4:3ac4239f6c9c 40 wait_ms( 15 );
ttodorov 4:3ac4239f6c9c 41 _lcd_pin_reset = HIGH;
ttodorov 4:3ac4239f6c9c 42 _lcd_pin_cs = HIGH;
ttodorov 4:3ac4239f6c9c 43 _lcd_pin_scl = HIGH;
ttodorov 4:3ac4239f6c9c 44 _lcd_pin_sdi = HIGH;
ttodorov 4:3ac4239f6c9c 45 if ( _lcd_pin_bl != 0 )
ttodorov 4:3ac4239f6c9c 46 *_lcd_pin_bl = HIGH;
ttodorov 4:3ac4239f6c9c 47 wait_ms( 55 );
ttodorov 4:3ac4239f6c9c 48
ttodorov 4:3ac4239f6c9c 49 Activate();
ttodorov 4:3ac4239f6c9c 50 WriteCmd( 0xC1 );
ttodorov 4:3ac4239f6c9c 51 WriteByteData( 0xFF );
ttodorov 4:3ac4239f6c9c 52 WriteByteData( 0x83 );
ttodorov 4:3ac4239f6c9c 53 WriteByteData( 0x40 );
ttodorov 4:3ac4239f6c9c 54 WriteCmd( 0x11 );
ttodorov 4:3ac4239f6c9c 55 wait_ms( 160 );
ttodorov 4:3ac4239f6c9c 56 WriteCmd( 0xCA );
ttodorov 4:3ac4239f6c9c 57 WriteByteData( 0x70 );
ttodorov 4:3ac4239f6c9c 58 WriteByteData( 0x00 );
ttodorov 4:3ac4239f6c9c 59 WriteByteData( 0xD9 );
ttodorov 4:3ac4239f6c9c 60 WriteCmd( 0xB0 );
ttodorov 4:3ac4239f6c9c 61 WriteByteData( 0x01 );
ttodorov 4:3ac4239f6c9c 62 WriteByteData( 0x11 );
ttodorov 4:3ac4239f6c9c 63
ttodorov 4:3ac4239f6c9c 64 WriteCmd( 0xC9 );
ttodorov 4:3ac4239f6c9c 65 WriteByteData( 0x90 );
ttodorov 4:3ac4239f6c9c 66 WriteByteData( 0x49 );
ttodorov 4:3ac4239f6c9c 67 WriteByteData( 0x10 );
ttodorov 4:3ac4239f6c9c 68 WriteByteData( 0x28 );
ttodorov 4:3ac4239f6c9c 69 WriteByteData( 0x28 );
ttodorov 4:3ac4239f6c9c 70 WriteByteData( 0x10 );
ttodorov 4:3ac4239f6c9c 71 WriteByteData( 0x00 );
ttodorov 4:3ac4239f6c9c 72 WriteByteData( 0x06 );
ttodorov 4:3ac4239f6c9c 73 wait_ms( 20 );
ttodorov 4:3ac4239f6c9c 74 WriteCmd( 0xC2 );
ttodorov 4:3ac4239f6c9c 75 WriteByteData( 0x60 );
ttodorov 4:3ac4239f6c9c 76 WriteByteData( 0x71 );
ttodorov 4:3ac4239f6c9c 77 WriteByteData( 0x01 );
ttodorov 4:3ac4239f6c9c 78 WriteByteData( 0x0E );
ttodorov 4:3ac4239f6c9c 79 WriteByteData( 0x05 );
ttodorov 4:3ac4239f6c9c 80 WriteByteData( 0x02 );
ttodorov 4:3ac4239f6c9c 81 WriteByteData( 0x09 );
ttodorov 4:3ac4239f6c9c 82 WriteByteData( 0x31 );
ttodorov 4:3ac4239f6c9c 83 WriteByteData( 0x0A );
ttodorov 4:3ac4239f6c9c 84
ttodorov 4:3ac4239f6c9c 85 WriteCmd( 0xc3 );
ttodorov 4:3ac4239f6c9c 86 WriteByteData( 0x67 );
ttodorov 4:3ac4239f6c9c 87 WriteByteData( 0x30 );
ttodorov 4:3ac4239f6c9c 88 WriteByteData( 0x61 );
ttodorov 4:3ac4239f6c9c 89 WriteByteData( 0x17 );
ttodorov 4:3ac4239f6c9c 90 WriteByteData( 0x48 );
ttodorov 4:3ac4239f6c9c 91 WriteByteData( 0x07 );
ttodorov 4:3ac4239f6c9c 92 WriteByteData( 0x05 );
ttodorov 4:3ac4239f6c9c 93 WriteByteData( 0x33 );
ttodorov 4:3ac4239f6c9c 94 wait_ms( 10 );
ttodorov 4:3ac4239f6c9c 95 WriteCmd( 0xB5 );
ttodorov 4:3ac4239f6c9c 96 WriteByteData( 0x35 );
ttodorov 4:3ac4239f6c9c 97 WriteByteData( 0x20 );
ttodorov 4:3ac4239f6c9c 98 WriteByteData( 0x45 );
ttodorov 4:3ac4239f6c9c 99
ttodorov 4:3ac4239f6c9c 100 WriteCmd( 0xB4 );
ttodorov 4:3ac4239f6c9c 101 WriteByteData( 0x33 );
ttodorov 4:3ac4239f6c9c 102 WriteByteData( 0x25 );
ttodorov 4:3ac4239f6c9c 103 WriteByteData( 0x4c );
ttodorov 4:3ac4239f6c9c 104 wait_ms( 10 );
ttodorov 4:3ac4239f6c9c 105 WriteCmd( 0x3a );
ttodorov 4:3ac4239f6c9c 106 WriteByteData( 0x05 );
ttodorov 4:3ac4239f6c9c 107 WriteCmd( 0x29 );
ttodorov 4:3ac4239f6c9c 108 wait_ms( 10 );
ttodorov 4:3ac4239f6c9c 109 WriteCmd( 0x2a );
ttodorov 4:3ac4239f6c9c 110 WriteByteData( 0x00 );
ttodorov 4:3ac4239f6c9c 111 WriteByteData( 0x00 );
ttodorov 4:3ac4239f6c9c 112 WriteByteData( 0x00 );
ttodorov 4:3ac4239f6c9c 113 WriteByteData( 0xaf );
ttodorov 4:3ac4239f6c9c 114 WriteCmd( 0x2b );
ttodorov 4:3ac4239f6c9c 115 WriteByteData( 0x00 );
ttodorov 4:3ac4239f6c9c 116 WriteByteData( 0x00 );
ttodorov 4:3ac4239f6c9c 117 WriteByteData( 0x00 );
ttodorov 4:3ac4239f6c9c 118 WriteByteData( 0xdb );
ttodorov 4:3ac4239f6c9c 119 WriteCmd( 0x2c );
ttodorov 4:3ac4239f6c9c 120 Deactivate();
ttodorov 4:3ac4239f6c9c 121 }
ttodorov 4:3ac4239f6c9c 122
ttodorov 4:3ac4239f6c9c 123 void HX8340S_LCD::Sleep( void )
ttodorov 4:3ac4239f6c9c 124 {
ttodorov 4:3ac4239f6c9c 125 Activate();
ttodorov 4:3ac4239f6c9c 126 WriteCmd( 0x28 );
ttodorov 4:3ac4239f6c9c 127 wait_ms( 10 );
ttodorov 4:3ac4239f6c9c 128 WriteCmd( 0x10 );
ttodorov 4:3ac4239f6c9c 129 wait_ms( 125 );
ttodorov 4:3ac4239f6c9c 130 if ( _lcd_pin_bl != 0 )
ttodorov 4:3ac4239f6c9c 131 *_lcd_pin_bl = LOW;
ttodorov 4:3ac4239f6c9c 132 Deactivate();
ttodorov 4:3ac4239f6c9c 133 }
ttodorov 4:3ac4239f6c9c 134
ttodorov 4:3ac4239f6c9c 135 void HX8340S_LCD::WakeUp( void )
ttodorov 4:3ac4239f6c9c 136 {
ttodorov 4:3ac4239f6c9c 137 Activate();
ttodorov 4:3ac4239f6c9c 138 WriteCmd( 0x29 );
ttodorov 4:3ac4239f6c9c 139 wait_ms( 10 );
ttodorov 4:3ac4239f6c9c 140 WriteCmd( 0x11 );
ttodorov 4:3ac4239f6c9c 141 wait_ms( 125 );
ttodorov 4:3ac4239f6c9c 142 if ( _lcd_pin_bl != 0 )
ttodorov 4:3ac4239f6c9c 143 *_lcd_pin_bl = HIGH;
ttodorov 4:3ac4239f6c9c 144 Deactivate();
ttodorov 4:3ac4239f6c9c 145 }
ttodorov 4:3ac4239f6c9c 146
ttodorov 4:3ac4239f6c9c 147 void HX8340S_LCD::WriteCmd( unsigned short cmd )
ttodorov 4:3ac4239f6c9c 148 {
ttodorov 4:3ac4239f6c9c 149 _lcd_pin_sdi = LOW;
ttodorov 4:3ac4239f6c9c 150 pulseLow( _lcd_pin_scl );
ttodorov 4:3ac4239f6c9c 151 serializeByte( cmd & 0xFF );
ttodorov 4:3ac4239f6c9c 152 }
ttodorov 4:3ac4239f6c9c 153
ttodorov 4:3ac4239f6c9c 154 void HX8340S_LCD::WriteData( unsigned short data )
ttodorov 4:3ac4239f6c9c 155 {
ttodorov 4:3ac4239f6c9c 156 _lcd_pin_sdi = HIGH;
ttodorov 4:3ac4239f6c9c 157 pulseLow( _lcd_pin_scl );
ttodorov 4:3ac4239f6c9c 158 serializeByte( ( data >> 8 ) & 0xFF );
ttodorov 4:3ac4239f6c9c 159 _lcd_pin_sdi = HIGH;
ttodorov 4:3ac4239f6c9c 160 pulseLow( _lcd_pin_scl );
ttodorov 4:3ac4239f6c9c 161 serializeByte( data & 0xFF );
ttodorov 4:3ac4239f6c9c 162 }
ttodorov 4:3ac4239f6c9c 163
ttodorov 4:3ac4239f6c9c 164 void HX8340S_LCD::WriteByteData( unsigned char data )
ttodorov 4:3ac4239f6c9c 165 {
ttodorov 4:3ac4239f6c9c 166 _lcd_pin_sdi = HIGH;
ttodorov 4:3ac4239f6c9c 167 pulseLow( _lcd_pin_scl );
ttodorov 4:3ac4239f6c9c 168 serializeByte( data );
ttodorov 4:3ac4239f6c9c 169 }
ttodorov 4:3ac4239f6c9c 170
ttodorov 4:3ac4239f6c9c 171 void HX8340S_LCD::SetXY( uint16_t x1, uint16_t y1, uint16_t x2, uint16_t y2 )
ttodorov 4:3ac4239f6c9c 172 {
ttodorov 4:3ac4239f6c9c 173 if ( _orientation == LANDSCAPE )
ttodorov 4:3ac4239f6c9c 174 {
ttodorov 4:3ac4239f6c9c 175 swap( uint16_t, x1, y1 )
ttodorov 4:3ac4239f6c9c 176 swap( uint16_t, x2, y2 )
ttodorov 4:3ac4239f6c9c 177 y1 = _disp_height - y1;
ttodorov 4:3ac4239f6c9c 178 y2 = _disp_height - y2;
ttodorov 4:3ac4239f6c9c 179 swap( uint16_t, y1, y2 )
ttodorov 4:3ac4239f6c9c 180 }
ttodorov 4:3ac4239f6c9c 181
ttodorov 4:3ac4239f6c9c 182 WriteCmdData( 0x2a, x1 );
ttodorov 4:3ac4239f6c9c 183 WriteData( x2 );
ttodorov 4:3ac4239f6c9c 184 WriteCmdData( 0x2b, y1 );
ttodorov 4:3ac4239f6c9c 185 WriteData( y2 );
ttodorov 4:3ac4239f6c9c 186 WriteCmd( 0x2c );
ttodorov 4:3ac4239f6c9c 187 }
ttodorov 4:3ac4239f6c9c 188
ttodorov 4:3ac4239f6c9c 189 void HX8340S_LCD::serializeByte( unsigned char data )
ttodorov 4:3ac4239f6c9c 190 {
ttodorov 4:3ac4239f6c9c 191 for ( int i = 0; i < 8; i++ )
ttodorov 4:3ac4239f6c9c 192 {
ttodorov 4:3ac4239f6c9c 193 if ( data & 0x80 ) _lcd_pin_sdi = HIGH;
ttodorov 4:3ac4239f6c9c 194 else _lcd_pin_sdi = LOW;
ttodorov 4:3ac4239f6c9c 195 pulseLow( _lcd_pin_scl );
ttodorov 4:3ac4239f6c9c 196 data = data << 1;
ttodorov 4:3ac4239f6c9c 197 }
ttodorov 4:3ac4239f6c9c 198 }