Diff: ssd1289.h

Revision:

3:64a5b67d5b51

Parent:

2:81ed304b7e9b

Child:

4:3ac4239f6c9c

diff -r 81ed304b7e9b -r 64a5b67d5b51 ssd1289.h
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/ssd1289.h	Sun Dec 02 01:44:23 2012 +0000
@@ -0,0 +1,114 @@
+/** \file ssd.h
+ *  \brief mbed TFT LCD controller for displays with the SSD1289 IC.
+ *  \copyright GNU Public License, v2. or later
+ *
+ * A known display with this type of controller chip is the ITDB02-3.2S
+ * from http://imall.iteadstudio.com
+ *
+ * This library is based on the Arduino/chipKIT UTFT library by Henning
+ * Karlsen, http://henningkarlsen.com/electronics/library.php?id=52
+ *
+ * Copyright (C)2010-2012 Henning Karlsen. All right reserved.
+ * Copyright (C)2012 Todor Todorov.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to:
+ *
+ * Free Software Foundation, Inc.
+ * 51 Franklin St, 5th Floor, Boston, MA 02110-1301, USA
+ *
+ *********************************************************************/
+#ifndef TFTLCD_SSD1289_H
+#define TFTLCD_SSD1289_H
+
+#include "lcd_base.h"
+
+/** Represents a LCD instance.
+ *
+ * This is the utility class, through which the display can be manipulated
+ * and graphics objects can be shown to the user.  A known display, which
+ * works with this library is the ITDB02-3.2S from iTeadStudio - a RGB TFT
+ * with 240x320 pixels resolution and 65K colors, using 16-bit interface.
+ *
+ * The display needs 20 or 21 pins to work with mbed, so it is possibly not
+ * the best of choices out there, but other than that it uses +3.3V for
+ * power and logic, as well as the backlight, thus can be interfaced directly
+ * to the mbed without the need of shields or level shifters as with Arduino.
+ *
+ * How to use:
+ * \code
+ * // include the library, this will also pull in the header for the provided fonts
+ * #include "ssd1289.h"
+ * 
+ * // prepare the data bus for writing commands and pixel data
+ * BusOut dataBus( p30, p29, p28, p27, p26, p25, p24, p23, p22, p21, p20, p19, p18, p17, p16, p15 ); // 16 pins
+ * // create the lcd instance
+ * SSD1289 lcd( p14, p13, p12, p11, &dataBus ); // control pins and data bus
+ *
+ * int main()
+ * {
+ *     // initialize display - place it in standard portrait mode and set background to black and
+ *     //                      foreground to white color.
+ *     lcd.Initialize();
+ *     // set current font to the smallest 8x12 pixels font.
+ *     lcd.SetFont( Font8x12 );
+ *     // print something on the screen
+ *     lcd.Print( "Hello, World!", CENTER, 25 ); // align text to center horizontally and use starndard colors
+ *
+ *     while ( 1 ) { }
+ * }
+ *
+ * \endcode
+ * \version 0.1
+ * \author Todor Todorov
+ */
+class SSD1289LCD : public LCD
+{
+public:
+    /** Creates a new instance of the class.
+     *
+     * \param CS Pin for the ChipSelect signal.
+     * \param RESET Pin for the RESET line.
+     * \param RS Pin for the RS signal.
+     * \param WR Pin for the WR signal.
+     * \param DATA_PORT Address of the data bus for transfer of commands and pixel data.
+     * \param RD Pin for the RD signal. This line is not needed by the driver, so if you would like to
+     *       use the pin on the mbed for something else, just pull-up the respective pin on the LCD high,
+     *       and do not assign a value to this parameter when creating the controller instance.
+     */
+    SSD1289LCD( PinName CS, PinName RESET, PinName RS, PinName WR, BusOut* DATA_PORT, PinName RD = NC );
+    
+    /** Initialize display.
+     *
+     * Wakes up the display from sleep, initializes power parameters.
+     * This function must be called first, befor any painting on the
+     * display is done, otherwise the positioning of graphical elements
+     * will not work properly and any paynt operation will not be visible
+     * or produce garbage.
+     *
+     * \param oritentation The display orientation, landscape is default.
+     */
+    virtual void Initialize( orientation_t orientation = LANDSCAPE );
+    
+protected:
+    virtual void WriteCmd( unsigned short cmd );
+    virtual void WriteData( unsigned short data );
+    virtual void SetXY( uint16_t x1, uint16_t y1, uint16_t x2, uint16_t y2 );
+    
+private:
+    DigitalOut _lcd_pin_reset, _lcd_pin_wr;
+    BusOut* _lcd_port;
+    DigitalOut* _lcd_pin_rd;
+};
+
+#endif /* TFTLCD_SSD1289_H */