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

Committer:
ttodorov
Date:
Sun Dec 02 01:44:23 2012 +0000
Revision:
3:64a5b67d5b51
Parent:
ssd.h@2:81ed304b7e9b
Child:
4:3ac4239f6c9c
- fixed documentation; - renamed ssd* source files to match the name of the LCD controller

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ttodorov 0:881ff0b71102 1 /** \file ssd.h
ttodorov 0:881ff0b71102 2 * \brief mbed TFT LCD controller for displays with the SSD1289 IC.
ttodorov 0:881ff0b71102 3 * \copyright GNU Public License, v2. or later
ttodorov 0:881ff0b71102 4 *
ttodorov 0:881ff0b71102 5 * A known display with this type of controller chip is the ITDB02-3.2S
ttodorov 0:881ff0b71102 6 * from http://imall.iteadstudio.com
ttodorov 0:881ff0b71102 7 *
ttodorov 0:881ff0b71102 8 * This library is based on the Arduino/chipKIT UTFT library by Henning
ttodorov 0:881ff0b71102 9 * Karlsen, http://henningkarlsen.com/electronics/library.php?id=52
ttodorov 0:881ff0b71102 10 *
ttodorov 0:881ff0b71102 11 * Copyright (C)2010-2012 Henning Karlsen. All right reserved.
ttodorov 0:881ff0b71102 12 * Copyright (C)2012 Todor Todorov.
ttodorov 0:881ff0b71102 13 *
ttodorov 0:881ff0b71102 14 * This library is free software; you can redistribute it and/or
ttodorov 0:881ff0b71102 15 * modify it under the terms of the GNU Lesser General Public
ttodorov 0:881ff0b71102 16 * License as published by the Free Software Foundation; either
ttodorov 0:881ff0b71102 17 * version 2.1 of the License, or (at your option) any later version.
ttodorov 0:881ff0b71102 18 *
ttodorov 0:881ff0b71102 19 * This library is distributed in the hope that it will be useful,
ttodorov 0:881ff0b71102 20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
ttodorov 0:881ff0b71102 21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
ttodorov 0:881ff0b71102 22 * Lesser General Public License for more details.
ttodorov 0:881ff0b71102 23 *
ttodorov 0:881ff0b71102 24 * You should have received a copy of the GNU Lesser General Public
ttodorov 0:881ff0b71102 25 * License along with this library; if not, write to:
ttodorov 0:881ff0b71102 26 *
ttodorov 0:881ff0b71102 27 * Free Software Foundation, Inc.
ttodorov 0:881ff0b71102 28 * 51 Franklin St, 5th Floor, Boston, MA 02110-1301, USA
ttodorov 0:881ff0b71102 29 *
ttodorov 0:881ff0b71102 30 *********************************************************************/
ttodorov 3:64a5b67d5b51 31 #ifndef TFTLCD_SSD1289_H
ttodorov 3:64a5b67d5b51 32 #define TFTLCD_SSD1289_H
ttodorov 0:881ff0b71102 33
ttodorov 0:881ff0b71102 34 #include "lcd_base.h"
ttodorov 0:881ff0b71102 35
ttodorov 3:64a5b67d5b51 36 /** Represents a LCD instance.
ttodorov 3:64a5b67d5b51 37 *
ttodorov 3:64a5b67d5b51 38 * This is the utility class, through which the display can be manipulated
ttodorov 3:64a5b67d5b51 39 * and graphics objects can be shown to the user. A known display, which
ttodorov 3:64a5b67d5b51 40 * works with this library is the ITDB02-3.2S from iTeadStudio - a RGB TFT
ttodorov 3:64a5b67d5b51 41 * with 240x320 pixels resolution and 65K colors, using 16-bit interface.
ttodorov 3:64a5b67d5b51 42 *
ttodorov 3:64a5b67d5b51 43 * The display needs 20 or 21 pins to work with mbed, so it is possibly not
ttodorov 3:64a5b67d5b51 44 * the best of choices out there, but other than that it uses +3.3V for
ttodorov 3:64a5b67d5b51 45 * power and logic, as well as the backlight, thus can be interfaced directly
ttodorov 3:64a5b67d5b51 46 * to the mbed without the need of shields or level shifters as with Arduino.
ttodorov 3:64a5b67d5b51 47 *
ttodorov 3:64a5b67d5b51 48 * How to use:
ttodorov 3:64a5b67d5b51 49 * \code
ttodorov 3:64a5b67d5b51 50 * // include the library, this will also pull in the header for the provided fonts
ttodorov 3:64a5b67d5b51 51 * #include "ssd1289.h"
ttodorov 3:64a5b67d5b51 52 *
ttodorov 3:64a5b67d5b51 53 * // prepare the data bus for writing commands and pixel data
ttodorov 3:64a5b67d5b51 54 * BusOut dataBus( p30, p29, p28, p27, p26, p25, p24, p23, p22, p21, p20, p19, p18, p17, p16, p15 ); // 16 pins
ttodorov 3:64a5b67d5b51 55 * // create the lcd instance
ttodorov 3:64a5b67d5b51 56 * SSD1289 lcd( p14, p13, p12, p11, &dataBus ); // control pins and data bus
ttodorov 3:64a5b67d5b51 57 *
ttodorov 3:64a5b67d5b51 58 * int main()
ttodorov 3:64a5b67d5b51 59 * {
ttodorov 3:64a5b67d5b51 60 * // initialize display - place it in standard portrait mode and set background to black and
ttodorov 3:64a5b67d5b51 61 * // foreground to white color.
ttodorov 3:64a5b67d5b51 62 * lcd.Initialize();
ttodorov 3:64a5b67d5b51 63 * // set current font to the smallest 8x12 pixels font.
ttodorov 3:64a5b67d5b51 64 * lcd.SetFont( Font8x12 );
ttodorov 3:64a5b67d5b51 65 * // print something on the screen
ttodorov 3:64a5b67d5b51 66 * lcd.Print( "Hello, World!", CENTER, 25 ); // align text to center horizontally and use starndard colors
ttodorov 3:64a5b67d5b51 67 *
ttodorov 3:64a5b67d5b51 68 * while ( 1 ) { }
ttodorov 3:64a5b67d5b51 69 * }
ttodorov 3:64a5b67d5b51 70 *
ttodorov 3:64a5b67d5b51 71 * \endcode
ttodorov 3:64a5b67d5b51 72 * \version 0.1
ttodorov 3:64a5b67d5b51 73 * \author Todor Todorov
ttodorov 3:64a5b67d5b51 74 */
ttodorov 0:881ff0b71102 75 class SSD1289LCD : public LCD
ttodorov 0:881ff0b71102 76 {
ttodorov 0:881ff0b71102 77 public:
ttodorov 0:881ff0b71102 78 /** Creates a new instance of the class.
ttodorov 0:881ff0b71102 79 *
ttodorov 0:881ff0b71102 80 * \param CS Pin for the ChipSelect signal.
ttodorov 0:881ff0b71102 81 * \param RESET Pin for the RESET line.
ttodorov 0:881ff0b71102 82 * \param RS Pin for the RS signal.
ttodorov 0:881ff0b71102 83 * \param WR Pin for the WR signal.
ttodorov 0:881ff0b71102 84 * \param DATA_PORT Address of the data bus for transfer of commands and pixel data.
ttodorov 0:881ff0b71102 85 * \param RD Pin for the RD signal. This line is not needed by the driver, so if you would like to
ttodorov 0:881ff0b71102 86 * use the pin on the mbed for something else, just pull-up the respective pin on the LCD high,
ttodorov 0:881ff0b71102 87 * and do not assign a value to this parameter when creating the controller instance.
ttodorov 0:881ff0b71102 88 */
ttodorov 0:881ff0b71102 89 SSD1289LCD( PinName CS, PinName RESET, PinName RS, PinName WR, BusOut* DATA_PORT, PinName RD = NC );
ttodorov 0:881ff0b71102 90
ttodorov 0:881ff0b71102 91 /** Initialize display.
ttodorov 0:881ff0b71102 92 *
ttodorov 0:881ff0b71102 93 * Wakes up the display from sleep, initializes power parameters.
ttodorov 0:881ff0b71102 94 * This function must be called first, befor any painting on the
ttodorov 0:881ff0b71102 95 * display is done, otherwise the positioning of graphical elements
ttodorov 0:881ff0b71102 96 * will not work properly and any paynt operation will not be visible
ttodorov 0:881ff0b71102 97 * or produce garbage.
ttodorov 0:881ff0b71102 98 *
ttodorov 0:881ff0b71102 99 * \param oritentation The display orientation, landscape is default.
ttodorov 0:881ff0b71102 100 */
ttodorov 0:881ff0b71102 101 virtual void Initialize( orientation_t orientation = LANDSCAPE );
ttodorov 0:881ff0b71102 102
ttodorov 0:881ff0b71102 103 protected:
ttodorov 2:81ed304b7e9b 104 virtual void WriteCmd( unsigned short cmd );
ttodorov 2:81ed304b7e9b 105 virtual void WriteData( unsigned short data );
ttodorov 2:81ed304b7e9b 106 virtual void SetXY( uint16_t x1, uint16_t y1, uint16_t x2, uint16_t y2 );
ttodorov 0:881ff0b71102 107
ttodorov 0:881ff0b71102 108 private:
ttodorov 0:881ff0b71102 109 DigitalOut _lcd_pin_reset, _lcd_pin_wr;
ttodorov 0:881ff0b71102 110 BusOut* _lcd_port;
ttodorov 0:881ff0b71102 111 DigitalOut* _lcd_pin_rd;
ttodorov 0:881ff0b71102 112 };
ttodorov 0:881ff0b71102 113
ttodorov 3:64a5b67d5b51 114 #endif /* TFTLCD_SSD1289_H */