ssd1289.h

00001 /** \file ssd1289.h
00002  *  \brief mbed TFT LCD controller for displays with the SSD1289 IC.
00003  *  \copyright GNU Public License, v2. or later
00004  *
00005  * A known display with this type of controller chip is the ITDB02-3.2S
00006  * from http://imall.iteadstudio.com
00007  *
00008  * This library is based on the Arduino/chipKIT UTFT library by Henning
00009  * Karlsen, http://henningkarlsen.com/electronics/library.php?id=52
00010  *
00011  * Copyright (C)2010-2012 Henning Karlsen. All right reserved.
00012  *
00013  * Copyright (C)2012 Todor Todorov.
00014  *
00015  * This library is free software; you can redistribute it and/or
00016  * modify it under the terms of the GNU Lesser General Public
00017  * License as published by the Free Software Foundation; either
00018  * version 2.1 of the License, or (at your option) any later version.
00019  *
00020  * This library is distributed in the hope that it will be useful,
00021  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00022  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00023  * Lesser General Public License for more details.
00024  *
00025  * You should have received a copy of the GNU Lesser General Public
00026  * License along with this library; if not, write to:
00027  *
00028  * Free Software Foundation, Inc.
00029  * 51 Franklin St, 5th Floor, Boston, MA 02110-1301, USA
00030  *
00031  *********************************************************************/
00032 #ifndef TFTLCD_SSD1289_H
00033 #define TFTLCD_SSD1289_H
00034 
00035 #include "lcd_base.h"
00036 
00037 #ifdef __cplusplus
00038 extern "C" {
00039 #endif
00040 
00041 /** Represents a LCD instance.
00042  *
00043  * This is the utility class, through which the display can be manipulated
00044  * and graphics objects can be shown to the user.  A known display, which
00045  * works with this library is the ITDB02-3.2S from iTeadStudio - a RGB TFT
00046  * with 240x320 pixels resolution and 65K colors, using 16-bit interface.
00047  *
00048  * The display needs 20 to 22 pins to work with mbed, so it is possibly not
00049  * the best of choices out there, but other than that it uses +3.3V for
00050  * power and logic, as well as the backlight, thus can be interfaced directly
00051  * to the mbed without the need of shields or level shifters as with Arduino.
00052  *
00053  * How to use:
00054  * \code
00055  * // include the library, this will also pull in the header for the provided fonts
00056  * #include "ssd1289.h"
00057  * 
00058  * // prepare the data bus for writing commands and pixel data
00059  * BusOut dataBus( p30, p29, p28, p27, p26, p25, p24, p23, p22, p21, p20, p19, p18, p17, p16, p15 ); // 16 pins
00060  * // create the lcd instance
00061  * SSD1289_LCD lcd( p14, p13, p12, p11, &dataBus ); // control pins and data bus
00062  *
00063  * int main()
00064  * {
00065  *     // initialize display - place it in standard portrait mode and set background to black and
00066  *     //                      foreground to white color.
00067  *     lcd.Initialize();
00068  *     // set current font to the smallest 8x12 pixels font.
00069  *     lcd.SetFont( Font8x12 );
00070  *     // print something on the screen
00071  *     lcd.Print( "Hello, World!", CENTER, 25 ); // align text to center horizontally and use starndard colors
00072  *
00073  *     while ( 1 ) { }
00074  * }
00075  *
00076  * \endcode
00077  * \version 0.1
00078  * \author Todor Todorov
00079  */
00080 class SSD1289_LCD : public LCD
00081 {
00082 public:
00083     /** Creates a new instance of the class.
00084      *
00085      * \param CS Pin for the ChipSelect signal.
00086      * \param RESET Pin for the RESET line.
00087      * \param RS Pin for the RS signal.
00088      * \param WR Pin for the WR signal.
00089      * \param DATA_PORT Address of the data bus for transfer of commands and pixel data.
00090      * \param BL Pin for controlling the backlight. By default not used.
00091      * \param RD Pin for the RD signal. This line is not needed by the driver, so if you would like to
00092      *       use the pin on the mbed for something else, just pull-up the respective pin on the LCD high,
00093      *       and do not assign a value to this parameter when creating the controller instance.
00094      * \param blType The backlight type, the default is to utilize the pin - if supplied - as a simple on/off switch
00095      * \param defaultBacklightLevel If using PWM to control backlight, this would be the default brightness in percent after LCD initialization.
00096      */
00097     SSD1289_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 );
00098     
00099     /** Initialize display.
00100      *
00101      * Wakes up the display from sleep, initializes power parameters.
00102      * This function must be called first, befor any painting on the
00103      * display is done, otherwise the positioning of graphical elements
00104      * will not work properly and any paynt operation will not be visible
00105      * or produce garbage.
00106      *
00107      * \param oritentation The display orientation, landscape is default.
00108      * \param colors The correct color depth to use for the pixel data. Value is disregarded.
00109      */
00110     virtual void Initialize( orientation_t orientation = LANDSCAPE, colordepth_t colors = RGB16 );
00111     
00112     /** Puts the display to sleep.
00113      *
00114      * When the display is in sleep mode, its power consumption is
00115      * minimized.  Before new pixel data can be written to the display
00116      * memory, the controller needs to be brought out of sleep mode.
00117      * \sa #WakeUp( void );
00118      * \remarks The result of this operation might not be exactly as
00119      *          expected. Putting the display to sleep will cause the
00120      *          controller to switch to the standard color of the LCD,
00121      *          so depending on whether the display is normally white,
00122      *          or normally dark, the screen might or might not go
00123      *          dark.  Additional power saving can be achieved, if
00124      *          the backlight of the used display is not hardwired on
00125      *          the PCB and can be controlled via the BL pin.
00126      */
00127     virtual void Sleep( void );
00128     
00129     /** Wakes up the display from sleep mode.
00130      *
00131      * This function needs to be called before any other, when the
00132      * display has been put into sleep mode by a previois call to
00133      * #Sleep( void ).
00134      */
00135     virtual void WakeUp( void );
00136     
00137 protected:
00138     /** Sends a command to the display.
00139      *
00140      * \param cmd The display command.
00141      * \remarks Commands are controller-specific and this function needs to
00142      *          be implemented separately for each available controller.
00143      */
00144     virtual void WriteCmd( unsigned short cmd );
00145     
00146     /** Sends pixel data to the display.
00147      *
00148      * \param data The display data.
00149      * \remarks Sending data is controller-specific and this function needs to
00150      *          be implemented separately for each available controller.
00151      */
00152     virtual void WriteData( unsigned short data );
00153     
00154     /** Assigns a chunk of the display memory to receive data.
00155      *
00156      * When data is sent to the display after this function completes, the opertion will
00157      * start from the begining of the assigned address (pixel position) and the pointer
00158      * will be automatically incremented so that the next data write operation will continue
00159      * with the next pixel from the memory block.  If more data is written than available
00160      * pixels, at the end of the block the pointer will jump back to its beginning and
00161      * commence again, until the next address change command is sent to the display.
00162      *
00163      * \param x1 The X coordinate of the pixel at the beginning of the block.
00164      * \param y1 The Y coordinate of the pixel at the beginning of the block.
00165      * \param x2 The X coordinate of the pixel at the end of the block.
00166      * \param y2 The Y coordinate of the pixel at the end of the block.
00167      * \remarks Addressing commands are controller-specific and this function needs to be
00168      *          implemented separately for each available controller.
00169      */
00170     virtual void SetXY( unsigned short x1, unsigned short y1, unsigned short x2, unsigned short y2 );
00171     
00172     /** Sets the color of the pixel at the address pointer of the controller.
00173      *
00174      * This function is to be provided by each implementation separately in
00175      * order to account for different color depth used by the controller.
00176      * \param color The color of the pixel.
00177      * \param mode The depth (palette) of the color.
00178      */
00179     virtual void SetPixelColor( unsigned int color, colordepth_t mode = RGB24 );
00180     
00181 private:
00182     DigitalOut  _lcd_pin_wr;
00183     BusOut*     _lcd_port;
00184     DigitalOut* _lcd_pin_bl;
00185     DigitalOut* _lcd_pin_rd;
00186 };
00187 
00188 #ifdef __cplusplus
00189 }
00190 #endif
00191 
00192 #endif /* TFTLCD_SSD1289_H */