Carlos Silva / 24_TFT_STMNUCLEO

Code to run the cheap 2.4" TFT made by mcufriend.com on the STM nucleo. No modifications required, this plugs into the arduino header.

Dependents:   ST7735_V2_STM32F407

Fork of TFTLCD_8bit by Thiha Electronics

ili9325.h@29:060b167a46ba, 2014-06-30 (annotated)

Committer:
cdtsilva
Date:
Mon Jun 30 17:29:42 2014 +0000
Revision:
29:060b167a46ba
Parent:
28:8808898a7f0c 
This is a modified Library to work with the ST Nucleo and the Cheap Red PCB 2.4" TFT displays from china.

; No modifications required, just plug the shield into the arduino header.

Who changed what in which revision?

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