EasyRad / TFTLCD

Programme de test pour lcd ITDB02

Fork of TFTLCD by Todor Todorov

ssd1289.h@5:09b6d228ceea, 2012-12-02 (annotated)

Committer:
ttodorov
Date:
Sun Dec 02 05:58:00 2012 +0000
Revision:
5:09b6d228ceea
Parent:
4:3ac4239f6c9c
Child:
6:059ca1648211
- fixed some more doxygen comments

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ttodorov 4:3ac4239f6c9c 1 /** \file ssd1289.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 5:09b6d228ceea 12 *
ttodorov 0:881ff0b71102 13 * Copyright (C)2012 Todor Todorov.
ttodorov 0:881ff0b71102 14 *
ttodorov 0:881ff0b71102 15 * This library is free software; you can redistribute it and/or
ttodorov 0:881ff0b71102 16 * modify it under the terms of the GNU Lesser General Public
ttodorov 0:881ff0b71102 17 * License as published by the Free Software Foundation; either
ttodorov 0:881ff0b71102 18 * version 2.1 of the License, or (at your option) any later version.
ttodorov 0:881ff0b71102 19 *
ttodorov 0:881ff0b71102 20 * This library is distributed in the hope that it will be useful,
ttodorov 0:881ff0b71102 21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
ttodorov 0:881ff0b71102 22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
ttodorov 0:881ff0b71102 23 * Lesser General Public License for more details.
ttodorov 0:881ff0b71102 24 *
ttodorov 0:881ff0b71102 25 * You should have received a copy of the GNU Lesser General Public
ttodorov 0:881ff0b71102 26 * License along with this library; if not, write to:
ttodorov 0:881ff0b71102 27 *
ttodorov 0:881ff0b71102 28 * Free Software Foundation, Inc.
ttodorov 0:881ff0b71102 29 * 51 Franklin St, 5th Floor, Boston, MA 02110-1301, USA
ttodorov 0:881ff0b71102 30 *
ttodorov 0:881ff0b71102 31 *********************************************************************/
ttodorov 3:64a5b67d5b51 32 #ifndef TFTLCD_SSD1289_H
ttodorov 3:64a5b67d5b51 33 #define TFTLCD_SSD1289_H
ttodorov 0:881ff0b71102 34
ttodorov 0:881ff0b71102 35 #include "lcd_base.h"
ttodorov 0:881ff0b71102 36
ttodorov 3:64a5b67d5b51 37 /** Represents a LCD instance.
ttodorov 3:64a5b67d5b51 38 *
ttodorov 3:64a5b67d5b51 39 * This is the utility class, through which the display can be manipulated
ttodorov 3:64a5b67d5b51 40 * and graphics objects can be shown to the user. A known display, which
ttodorov 3:64a5b67d5b51 41 * works with this library is the ITDB02-3.2S from iTeadStudio - a RGB TFT
ttodorov 3:64a5b67d5b51 42 * with 240x320 pixels resolution and 65K colors, using 16-bit interface.
ttodorov 3:64a5b67d5b51 43 *
ttodorov 4:3ac4239f6c9c 44 * The display needs 20 to 22 pins to work with mbed, so it is possibly not
ttodorov 3:64a5b67d5b51 45 * the best of choices out there, but other than that it uses +3.3V for
ttodorov 3:64a5b67d5b51 46 * power and logic, as well as the backlight, thus can be interfaced directly
ttodorov 3:64a5b67d5b51 47 * to the mbed without the need of shields or level shifters as with Arduino.
ttodorov 3:64a5b67d5b51 48 *
ttodorov 3:64a5b67d5b51 49 * How to use:
ttodorov 3:64a5b67d5b51 50 * \code
ttodorov 3:64a5b67d5b51 51 * // include the library, this will also pull in the header for the provided fonts
ttodorov 3:64a5b67d5b51 52 * #include "ssd1289.h"
ttodorov 3:64a5b67d5b51 53 *
ttodorov 3:64a5b67d5b51 54 * // prepare the data bus for writing commands and pixel data
ttodorov 3:64a5b67d5b51 55 * BusOut dataBus( p30, p29, p28, p27, p26, p25, p24, p23, p22, p21, p20, p19, p18, p17, p16, p15 ); // 16 pins
ttodorov 3:64a5b67d5b51 56 * // create the lcd instance
ttodorov 4:3ac4239f6c9c 57 * SSD1289_LCD lcd( p14, p13, p12, p11, &dataBus ); // control pins and data bus
ttodorov 3:64a5b67d5b51 58 *
ttodorov 3:64a5b67d5b51 59 * int main()
ttodorov 3:64a5b67d5b51 60 * {
ttodorov 3:64a5b67d5b51 61 * // initialize display - place it in standard portrait mode and set background to black and
ttodorov 3:64a5b67d5b51 62 * // foreground to white color.
ttodorov 3:64a5b67d5b51 63 * lcd.Initialize();
ttodorov 3:64a5b67d5b51 64 * // set current font to the smallest 8x12 pixels font.
ttodorov 3:64a5b67d5b51 65 * lcd.SetFont( Font8x12 );
ttodorov 3:64a5b67d5b51 66 * // print something on the screen
ttodorov 3:64a5b67d5b51 67 * lcd.Print( "Hello, World!", CENTER, 25 ); // align text to center horizontally and use starndard colors
ttodorov 3:64a5b67d5b51 68 *
ttodorov 3:64a5b67d5b51 69 * while ( 1 ) { }
ttodorov 3:64a5b67d5b51 70 * }
ttodorov 3:64a5b67d5b51 71 *
ttodorov 3:64a5b67d5b51 72 * \endcode
ttodorov 3:64a5b67d5b51 73 * \version 0.1
ttodorov 3:64a5b67d5b51 74 * \author Todor Todorov
ttodorov 3:64a5b67d5b51 75 */
ttodorov 4:3ac4239f6c9c 76 class SSD1289_LCD : public LCD
ttodorov 0:881ff0b71102 77 {
ttodorov 0:881ff0b71102 78 public:
ttodorov 0:881ff0b71102 79 /** Creates a new instance of the class.
ttodorov 0:881ff0b71102 80 *
ttodorov 0:881ff0b71102 81 * \param CS Pin for the ChipSelect signal.
ttodorov 0:881ff0b71102 82 * \param RESET Pin for the RESET line.
ttodorov 0:881ff0b71102 83 * \param RS Pin for the RS signal.
ttodorov 0:881ff0b71102 84 * \param WR Pin for the WR signal.
ttodorov 0:881ff0b71102 85 * \param DATA_PORT Address of the data bus for transfer of commands and pixel data.
ttodorov 4:3ac4239f6c9c 86 * \param BL Pin for controlling the backlight. By default not used.
ttodorov 0:881ff0b71102 87 * \param RD Pin for the RD signal. This line is not needed by the driver, so if you would like to
ttodorov 0:881ff0b71102 88 * use the pin on the mbed for something else, just pull-up the respective pin on the LCD high,
ttodorov 0:881ff0b71102 89 * and do not assign a value to this parameter when creating the controller instance.
ttodorov 0:881ff0b71102 90 */
ttodorov 4:3ac4239f6c9c 91 SSD1289_LCD( PinName CS, PinName RESET, PinName RS, PinName WR, BusOut* DATA_PORT, PinName BL = NC, PinName RD = NC );
ttodorov 0:881ff0b71102 92
ttodorov 0:881ff0b71102 93 /** Initialize display.
ttodorov 0:881ff0b71102 94 *
ttodorov 0:881ff0b71102 95 * Wakes up the display from sleep, initializes power parameters.
ttodorov 0:881ff0b71102 96 * This function must be called first, befor any painting on the
ttodorov 0:881ff0b71102 97 * display is done, otherwise the positioning of graphical elements
ttodorov 0:881ff0b71102 98 * will not work properly and any paynt operation will not be visible
ttodorov 0:881ff0b71102 99 * or produce garbage.
ttodorov 0:881ff0b71102 100 *
ttodorov 0:881ff0b71102 101 * \param oritentation The display orientation, landscape is default.
ttodorov 0:881ff0b71102 102 */
ttodorov 0:881ff0b71102 103 virtual void Initialize( orientation_t orientation = LANDSCAPE );
ttodorov 0:881ff0b71102 104
ttodorov 4:3ac4239f6c9c 105 /** Puts the display to sleep.
ttodorov 4:3ac4239f6c9c 106 *
ttodorov 4:3ac4239f6c9c 107 * When the display is in sleep mode, its power consumption is
ttodorov 4:3ac4239f6c9c 108 * minimized. Before new pixel data can be written to the display
ttodorov 4:3ac4239f6c9c 109 * memory, the controller needs to be brought out of sleep mode.
ttodorov 4:3ac4239f6c9c 110 * \sa #WakeUp( void );
ttodorov 4:3ac4239f6c9c 111 * \remarks The result of this operation might not be exactly as
ttodorov 4:3ac4239f6c9c 112 * expected. Putting the display to sleep will cause the
ttodorov 4:3ac4239f6c9c 113 * controller to switch to the standard color of the LCD,
ttodorov 4:3ac4239f6c9c 114 * so depending on whether the display is normally white,
ttodorov 4:3ac4239f6c9c 115 * or normally dark, the screen might or might not go
ttodorov 4:3ac4239f6c9c 116 * dark. Additional power saving can be achieved, if
ttodorov 4:3ac4239f6c9c 117 * the backlight of the used display is not hardwired on
ttodorov 4:3ac4239f6c9c 118 * the PCB and can be controlled via the BL pin.
ttodorov 4:3ac4239f6c9c 119 */
ttodorov 4:3ac4239f6c9c 120 virtual void Sleep( void );
ttodorov 4:3ac4239f6c9c 121
ttodorov 4:3ac4239f6c9c 122 /** Wakes up the display from sleep mode.
ttodorov 4:3ac4239f6c9c 123 *
ttodorov 4:3ac4239f6c9c 124 * This function needs to be called before any other, when the
ttodorov 4:3ac4239f6c9c 125 * display has been put into sleep mode by a previois call to
ttodorov 4:3ac4239f6c9c 126 * #Sleep( void ).
ttodorov 4:3ac4239f6c9c 127 */
ttodorov 4:3ac4239f6c9c 128 virtual void WakeUp( void );
ttodorov 4:3ac4239f6c9c 129
ttodorov 0:881ff0b71102 130 protected:
ttodorov 4:3ac4239f6c9c 131 /** Sends a command to the display.
ttodorov 4:3ac4239f6c9c 132 *
ttodorov 4:3ac4239f6c9c 133 * \param cmd The display command.
ttodorov 4:3ac4239f6c9c 134 * \remarks Commands are controller-specific and this function needs to
ttodorov 4:3ac4239f6c9c 135 * be implemented separately for each available controller.
ttodorov 4:3ac4239f6c9c 136 */
ttodorov 2:81ed304b7e9b 137 virtual void WriteCmd( unsigned short cmd );
ttodorov 4:3ac4239f6c9c 138
ttodorov 4:3ac4239f6c9c 139 /** Sends pixel data to the display.
ttodorov 4:3ac4239f6c9c 140 *
ttodorov 4:3ac4239f6c9c 141 * \param data The display data.
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 2:81ed304b7e9b 145 virtual void WriteData( unsigned short 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 2:81ed304b7e9b 163 virtual void SetXY( uint16_t x1, uint16_t y1, uint16_t x2, uint16_t y2 );
ttodorov 0:881ff0b71102 164
ttodorov 0:881ff0b71102 165 private:
ttodorov 4:3ac4239f6c9c 166 DigitalOut _lcd_pin_wr;
ttodorov 4:3ac4239f6c9c 167 BusOut* _lcd_port;
ttodorov 4:3ac4239f6c9c 168 DigitalOut* _lcd_pin_bl;
ttodorov 0:881ff0b71102 169 DigitalOut* _lcd_pin_rd;
ttodorov 0:881ff0b71102 170 };
ttodorov 0:881ff0b71102 171
ttodorov 3:64a5b67d5b51 172 #endif /* TFTLCD_SSD1289_H */