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:
Fri Dec 07 16:14:13 2012 +0000
Revision:
9:58b328831d0a
Child:
10:69571adcfad5
- reverted changes for 262K colors, will branch out later; - added ST7735 LCD driver

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ttodorov 9:58b328831d0a 1 /*
ttodorov 9:58b328831d0a 2 * Copyright (C)2010-2012 Henning Karlsen. All right reserved.
ttodorov 9:58b328831d0a 3 * Copyright (C)2012 Todor Todorov.
ttodorov 9:58b328831d0a 4 *
ttodorov 9:58b328831d0a 5 * This library is free software; you can redistribute it and/or
ttodorov 9:58b328831d0a 6 * modify it under the terms of the GNU Lesser General Public
ttodorov 9:58b328831d0a 7 * License as published by the Free Software Foundation; either
ttodorov 9:58b328831d0a 8 * version 2.1 of the License, or (at your option) any later version.
ttodorov 9:58b328831d0a 9 *
ttodorov 9:58b328831d0a 10 * This library is distributed in the hope that it will be useful,
ttodorov 9:58b328831d0a 11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
ttodorov 9:58b328831d0a 12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
ttodorov 9:58b328831d0a 13 * Lesser General Public License for more details.
ttodorov 9:58b328831d0a 14 *
ttodorov 9:58b328831d0a 15 * You should have received a copy of the GNU Lesser General Public
ttodorov 9:58b328831d0a 16 * License along with this library; if not, write to:
ttodorov 9:58b328831d0a 17 *
ttodorov 9:58b328831d0a 18 * Free Software Foundation, Inc.
ttodorov 9:58b328831d0a 19 * 51 Franklin St, 5th Floor, Boston, MA 02110-1301, USA
ttodorov 9:58b328831d0a 20 *
ttodorov 9:58b328831d0a 21 *********************************************************************/
ttodorov 9:58b328831d0a 22 #include "st7735.h"
ttodorov 9:58b328831d0a 23 #include "helpers.h"
ttodorov 9:58b328831d0a 24
ttodorov 9:58b328831d0a 25 ST7735_LCD::ST7735_LCD( PinName CS, PinName RESET, PinName RS, PinName SCL, PinName SDA, PinName BL )
ttodorov 9:58b328831d0a 26 : LCD( 128, 160, CS, RS, RESET ), _lcd_pin_scl( SCL ), _lcd_pin_sda( SDA )
ttodorov 9:58b328831d0a 27 {
ttodorov 9:58b328831d0a 28 if ( BL != NC ) _lcd_pin_bl = new DigitalOut( BL );
ttodorov 9:58b328831d0a 29 else _lcd_pin_bl = 0;
ttodorov 9:58b328831d0a 30 }
ttodorov 9:58b328831d0a 31
ttodorov 9:58b328831d0a 32 void ST7735_LCD::Initialize( orientation_t orientation )
ttodorov 9:58b328831d0a 33 {
ttodorov 9:58b328831d0a 34 _orientation = orientation;
ttodorov 9:58b328831d0a 35
ttodorov 9:58b328831d0a 36 wait_ms( 100 );
ttodorov 9:58b328831d0a 37 _lcd_pin_reset = HIGH;
ttodorov 9:58b328831d0a 38 wait_ms( 5 );
ttodorov 9:58b328831d0a 39 _lcd_pin_reset = LOW;
ttodorov 9:58b328831d0a 40 wait_ms( 15 );
ttodorov 9:58b328831d0a 41 _lcd_pin_reset = HIGH;
ttodorov 9:58b328831d0a 42 _lcd_pin_cs = HIGH;
ttodorov 9:58b328831d0a 43 _lcd_pin_rs = HIGH;
ttodorov 9:58b328831d0a 44 _lcd_pin_scl = HIGH;
ttodorov 9:58b328831d0a 45 _lcd_pin_sda = HIGH;
ttodorov 9:58b328831d0a 46 if ( _lcd_pin_bl != 0 )
ttodorov 9:58b328831d0a 47 *_lcd_pin_bl = HIGH;
ttodorov 9:58b328831d0a 48 wait_ms( 55 );
ttodorov 9:58b328831d0a 49
ttodorov 9:58b328831d0a 50 Activate();
ttodorov 9:58b328831d0a 51 WriteCmd( 0x01 ); // SW reset
ttodorov 9:58b328831d0a 52 wait_ms( 120 );
ttodorov 9:58b328831d0a 53
ttodorov 9:58b328831d0a 54 WriteCmd( 0x11 ); // sleep out
ttodorov 9:58b328831d0a 55 wait_ms( 120 );
ttodorov 9:58b328831d0a 56
ttodorov 9:58b328831d0a 57 WriteCmd( 0xB1 ); // frame control 1
ttodorov 9:58b328831d0a 58 WriteByteData( 0x01 );
ttodorov 9:58b328831d0a 59 WriteByteData( 0x2C );
ttodorov 9:58b328831d0a 60 WriteByteData( 0x2D );
ttodorov 9:58b328831d0a 61 WriteCmd( 0xB2 ); // frame control 2
ttodorov 9:58b328831d0a 62 WriteByteData( 0x01 );
ttodorov 9:58b328831d0a 63 WriteByteData( 0x2C );
ttodorov 9:58b328831d0a 64 WriteByteData( 0x2D );
ttodorov 9:58b328831d0a 65 WriteCmd( 0xB3 ); // frame control 3
ttodorov 9:58b328831d0a 66 WriteByteData( 0x01 );
ttodorov 9:58b328831d0a 67 WriteByteData( 0x2C );
ttodorov 9:58b328831d0a 68 WriteByteData( 0x2D );
ttodorov 9:58b328831d0a 69 WriteByteData( 0x01 );
ttodorov 9:58b328831d0a 70 WriteByteData( 0x2C );
ttodorov 9:58b328831d0a 71 WriteByteData( 0x2D );
ttodorov 9:58b328831d0a 72
ttodorov 9:58b328831d0a 73 WriteCmd( 0xB4 ); // column inversion
ttodorov 9:58b328831d0a 74 WriteByteData( 0x07 );
ttodorov 9:58b328831d0a 75
ttodorov 9:58b328831d0a 76 // ST7735R Power Sequence
ttodorov 9:58b328831d0a 77 WriteCmd( 0xC0 ); // power control 1
ttodorov 9:58b328831d0a 78 WriteByteData( 0xA2 );
ttodorov 9:58b328831d0a 79 WriteByteData( 0x02 );
ttodorov 9:58b328831d0a 80 WriteByteData( 0x84 );
ttodorov 9:58b328831d0a 81 WriteCmd( 0xC1 ); // power control 2
ttodorov 9:58b328831d0a 82 WriteByteData( 0xC5 );
ttodorov 9:58b328831d0a 83 WriteCmd( 0xC2 ); // power control 3
ttodorov 9:58b328831d0a 84 WriteByteData( 0x0A );
ttodorov 9:58b328831d0a 85 WriteByteData( 0x00 );
ttodorov 9:58b328831d0a 86 WriteCmd( 0xC3 ); // power control 4
ttodorov 9:58b328831d0a 87 WriteByteData( 0x8A );
ttodorov 9:58b328831d0a 88 WriteByteData( 0x2A );
ttodorov 9:58b328831d0a 89 WriteCmd( 0xC4 ); // power control 5
ttodorov 9:58b328831d0a 90 WriteByteData( 0x8A );
ttodorov 9:58b328831d0a 91 WriteByteData( 0xEE );
ttodorov 9:58b328831d0a 92
ttodorov 9:58b328831d0a 93 WriteCmd( 0xC5 ); // voltage control 1
ttodorov 9:58b328831d0a 94 WriteByteData( 0x0E );
ttodorov 9:58b328831d0a 95
ttodorov 9:58b328831d0a 96 WriteCmd( 0x36 ); //MX, MY, RGB mode
ttodorov 9:58b328831d0a 97 WriteByteData( 0xC8 );
ttodorov 9:58b328831d0a 98
ttodorov 9:58b328831d0a 99 // ST7735R Gamma Sequence
ttodorov 9:58b328831d0a 100 WriteCmd( 0xE0 ); // gamma positive
ttodorov 9:58b328831d0a 101 WriteByteData( 0x0F );
ttodorov 9:58b328831d0a 102 WriteByteData( 0x1A );
ttodorov 9:58b328831d0a 103 WriteByteData( 0x0F );
ttodorov 9:58b328831d0a 104 WriteByteData( 0x18 );
ttodorov 9:58b328831d0a 105 WriteByteData( 0x2F );
ttodorov 9:58b328831d0a 106 WriteByteData( 0x28 );
ttodorov 9:58b328831d0a 107 WriteByteData( 0x20 );
ttodorov 9:58b328831d0a 108 WriteByteData( 0x22 );
ttodorov 9:58b328831d0a 109 WriteByteData( 0x1F );
ttodorov 9:58b328831d0a 110 WriteByteData( 0x1B );
ttodorov 9:58b328831d0a 111 WriteByteData( 0x23 );
ttodorov 9:58b328831d0a 112 WriteByteData( 0x37 );
ttodorov 9:58b328831d0a 113 WriteByteData( 0x00 );
ttodorov 9:58b328831d0a 114 WriteByteData( 0x07 );
ttodorov 9:58b328831d0a 115 WriteByteData( 0x02 );
ttodorov 9:58b328831d0a 116 WriteByteData( 0x10 );
ttodorov 9:58b328831d0a 117 WriteCmd( 0xE1 ); // gamma negative
ttodorov 9:58b328831d0a 118 WriteByteData( 0x0F );
ttodorov 9:58b328831d0a 119 WriteByteData( 0x1B );
ttodorov 9:58b328831d0a 120 WriteByteData( 0x0F );
ttodorov 9:58b328831d0a 121 WriteByteData( 0x17 );
ttodorov 9:58b328831d0a 122 WriteByteData( 0x33 );
ttodorov 9:58b328831d0a 123 WriteByteData( 0x2C );
ttodorov 9:58b328831d0a 124 WriteByteData( 0x29 );
ttodorov 9:58b328831d0a 125 WriteByteData( 0x2E );
ttodorov 9:58b328831d0a 126 WriteByteData( 0x30 );
ttodorov 9:58b328831d0a 127 WriteByteData( 0x30 );
ttodorov 9:58b328831d0a 128 WriteByteData( 0x39 );
ttodorov 9:58b328831d0a 129 WriteByteData( 0x3F );
ttodorov 9:58b328831d0a 130 WriteByteData( 0x00 );
ttodorov 9:58b328831d0a 131 WriteByteData( 0x07 );
ttodorov 9:58b328831d0a 132 WriteByteData( 0x03 );
ttodorov 9:58b328831d0a 133 WriteByteData( 0x10 );
ttodorov 9:58b328831d0a 134
ttodorov 9:58b328831d0a 135 WriteCmd( 0x2A ); // set column address
ttodorov 9:58b328831d0a 136 WriteByteData( 0x00 );
ttodorov 9:58b328831d0a 137 WriteByteData( 0x00 );
ttodorov 9:58b328831d0a 138 WriteByteData( 0x00 );
ttodorov 9:58b328831d0a 139 WriteByteData( 0x7F );
ttodorov 9:58b328831d0a 140 WriteCmd( 0x2B ); // set row address
ttodorov 9:58b328831d0a 141 WriteByteData( 0x00 );
ttodorov 9:58b328831d0a 142 WriteByteData( 0x00 );
ttodorov 9:58b328831d0a 143 WriteByteData( 0x00 );
ttodorov 9:58b328831d0a 144 WriteByteData( 0x9F );
ttodorov 9:58b328831d0a 145
ttodorov 9:58b328831d0a 146 WriteCmd( 0xF0 ); // enable extensions command
ttodorov 9:58b328831d0a 147 WriteByteData( 0x01 );
ttodorov 9:58b328831d0a 148 WriteCmd( 0xF6 ); // disable ram power save mode
ttodorov 9:58b328831d0a 149 WriteByteData( 0x00 );
ttodorov 9:58b328831d0a 150
ttodorov 9:58b328831d0a 151 WriteCmd( 0x3A ); // interface pixel format (color mode)
ttodorov 9:58b328831d0a 152 WriteByteData( 0x05 ); // 65k mode
ttodorov 9:58b328831d0a 153 WriteCmd( 0x29 ); // display on
ttodorov 9:58b328831d0a 154
ttodorov 9:58b328831d0a 155 Deactivate();
ttodorov 9:58b328831d0a 156 }
ttodorov 9:58b328831d0a 157
ttodorov 9:58b328831d0a 158 void ST7735_LCD::Sleep( void )
ttodorov 9:58b328831d0a 159 {
ttodorov 9:58b328831d0a 160 Activate();
ttodorov 9:58b328831d0a 161 WriteCmd( 0x28 );
ttodorov 9:58b328831d0a 162 wait_ms( 10 );
ttodorov 9:58b328831d0a 163 WriteCmd( 0x10 );
ttodorov 9:58b328831d0a 164 wait_ms( 125 );
ttodorov 9:58b328831d0a 165 if ( _lcd_pin_bl != 0 )
ttodorov 9:58b328831d0a 166 *_lcd_pin_bl = LOW;
ttodorov 9:58b328831d0a 167 Deactivate();
ttodorov 9:58b328831d0a 168 }
ttodorov 9:58b328831d0a 169
ttodorov 9:58b328831d0a 170 void ST7735_LCD::WakeUp( void )
ttodorov 9:58b328831d0a 171 {
ttodorov 9:58b328831d0a 172 Activate();
ttodorov 9:58b328831d0a 173 WriteCmd( 0x29 );
ttodorov 9:58b328831d0a 174 wait_ms( 10 );
ttodorov 9:58b328831d0a 175 WriteCmd( 0x11 );
ttodorov 9:58b328831d0a 176 wait_ms( 125 );
ttodorov 9:58b328831d0a 177 if ( _lcd_pin_bl != 0 )
ttodorov 9:58b328831d0a 178 *_lcd_pin_bl = HIGH;
ttodorov 9:58b328831d0a 179 Deactivate();
ttodorov 9:58b328831d0a 180 }
ttodorov 9:58b328831d0a 181
ttodorov 9:58b328831d0a 182 void ST7735_LCD::WriteCmd( unsigned short cmd )
ttodorov 9:58b328831d0a 183 {
ttodorov 9:58b328831d0a 184 _lcd_pin_rs = LOW;
ttodorov 9:58b328831d0a 185 serializeByte( cmd & 0xFF );
ttodorov 9:58b328831d0a 186 }
ttodorov 9:58b328831d0a 187
ttodorov 9:58b328831d0a 188 void ST7735_LCD::WriteData( unsigned short data )
ttodorov 9:58b328831d0a 189 {
ttodorov 9:58b328831d0a 190 _lcd_pin_rs = HIGH;
ttodorov 9:58b328831d0a 191 serializeByte( ( data >> 8 ) & 0xFF );
ttodorov 9:58b328831d0a 192 serializeByte( data & 0xFF );
ttodorov 9:58b328831d0a 193 }
ttodorov 9:58b328831d0a 194
ttodorov 9:58b328831d0a 195 void ST7735_LCD::WriteByteData( unsigned char data )
ttodorov 9:58b328831d0a 196 {
ttodorov 9:58b328831d0a 197 _lcd_pin_rs = HIGH;
ttodorov 9:58b328831d0a 198 serializeByte( data );
ttodorov 9:58b328831d0a 199 }
ttodorov 9:58b328831d0a 200
ttodorov 9:58b328831d0a 201 void ST7735_LCD::SetXY( uint16_t x1, uint16_t y1, uint16_t x2, uint16_t y2 )
ttodorov 9:58b328831d0a 202 {
ttodorov 9:58b328831d0a 203 if ( _orientation == LANDSCAPE )
ttodorov 9:58b328831d0a 204 {
ttodorov 9:58b328831d0a 205 swap( uint16_t, x1, y1 )
ttodorov 9:58b328831d0a 206 swap( uint16_t, x2, y2 )
ttodorov 9:58b328831d0a 207 y1 = _disp_height - y1;
ttodorov 9:58b328831d0a 208 y2 = _disp_height - y2;
ttodorov 9:58b328831d0a 209 swap( uint16_t, y1, y2 )
ttodorov 9:58b328831d0a 210 }
ttodorov 9:58b328831d0a 211
ttodorov 9:58b328831d0a 212 WriteCmdData( 0x2a, x1 );
ttodorov 9:58b328831d0a 213 WriteData( x2 );
ttodorov 9:58b328831d0a 214 WriteCmdData( 0x2b, y1 );
ttodorov 9:58b328831d0a 215 WriteData( y2 );
ttodorov 9:58b328831d0a 216 WriteCmd( 0x2c );
ttodorov 9:58b328831d0a 217 }
ttodorov 9:58b328831d0a 218
ttodorov 9:58b328831d0a 219 void ST7735_LCD::serializeByte( unsigned char data )
ttodorov 9:58b328831d0a 220 {
ttodorov 9:58b328831d0a 221 for ( int i = 0; i < 8; i++ )
ttodorov 9:58b328831d0a 222 {
ttodorov 9:58b328831d0a 223 if ( data & 0x80 ) _lcd_pin_sda = HIGH;
ttodorov 9:58b328831d0a 224 else _lcd_pin_sda = LOW;
ttodorov 9:58b328831d0a 225 pulseLow( _lcd_pin_scl );
ttodorov 9:58b328831d0a 226 data = data << 1;
ttodorov 9:58b328831d0a 227 }
ttodorov 9:58b328831d0a 228 }