JP PANG / NokiaLCD_SWSPI

Rewrite the NokiaLCD lib with SWSPI lib in order to fit in with 9 bits SPI mode

Dependents:   KL46Z_NokiaLCD

NokiaLCD_SWSPI.h@0:34125ddb025e, 2014-02-18 (annotated)

Committer:
jppang
Date:
Tue Feb 18 04:19:55 2014 +0000
Revision:
0:34125ddb025e
Rewrite the NokiaLCD lib by using the SWSPI lib in order to fit in with 9 bits SPI mode.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jppang 0:34125ddb025e 1 /* mbed NokiaLCD Library, for a 130x130 Nokia colour LCD
jppang 0:34125ddb025e 2 * Copyright (c) 2007-2010, sford
jppang 0:34125ddb025e 3 *
jppang 0:34125ddb025e 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
jppang 0:34125ddb025e 5 * of this software and associated documentation files (the "Software"), to deal
jppang 0:34125ddb025e 6 * in the Software without restriction, including without limitation the rights
jppang 0:34125ddb025e 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
jppang 0:34125ddb025e 8 * copies of the Software, and to permit persons to whom the Software is
jppang 0:34125ddb025e 9 * furnished to do so, subject to the following conditions:
jppang 0:34125ddb025e 10 *
jppang 0:34125ddb025e 11 * The above copyright notice and this permission notice shall be included in
jppang 0:34125ddb025e 12 * all copies or substantial portions of the Software.
jppang 0:34125ddb025e 13 *
jppang 0:34125ddb025e 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
jppang 0:34125ddb025e 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
jppang 0:34125ddb025e 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
jppang 0:34125ddb025e 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
jppang 0:34125ddb025e 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
jppang 0:34125ddb025e 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
jppang 0:34125ddb025e 20 * THE SOFTWARE.
jppang 0:34125ddb025e 21 */
jppang 0:34125ddb025e 22
jppang 0:34125ddb025e 23 /*
jppang 0:34125ddb025e 24 2014/02/18
jppang 0:34125ddb025e 25 Rewritten this library in order to fit in with the 9 bit SPI mode by using SWSPI lib.
jppang 0:34125ddb025e 26 FRDM-KL46Z supports only 8/16 bits SPI mode.
jppang 0:34125ddb025e 27 */
jppang 0:34125ddb025e 28
jppang 0:34125ddb025e 29 #ifndef MBED_NOKIALCD_H
jppang 0:34125ddb025e 30 #define MBED_NOKIALCD_H
jppang 0:34125ddb025e 31
jppang 0:34125ddb025e 32 #include "mbed.h"
jppang 0:34125ddb025e 33 #include "SWSPI.h"
jppang 0:34125ddb025e 34
jppang 0:34125ddb025e 35 /** An interface for the 130x130 Nokia Mobile phone screens
jppang 0:34125ddb025e 36 *
jppang 0:34125ddb025e 37 * @code
jppang 0:34125ddb025e 38 * #include "mbed.h"
jppang 0:34125ddb025e 39 * #include "NokiaLCD.h"
jppang 0:34125ddb025e 40 *
jppang 0:34125ddb025e 41 * NokiaLCD lcd(p5, p7, p8, p9, NokiaLCD::6610); // mosi, sclk, cs, rst, type
jppang 0:34125ddb025e 42 *
jppang 0:34125ddb025e 43 * int main() {
jppang 0:34125ddb025e 44 * lcd.printf("Hello World!");
jppang 0:34125ddb025e 45 * }
jppang 0:34125ddb025e 46 * @endcode
jppang 0:34125ddb025e 47 */
jppang 0:34125ddb025e 48 class NokiaLCD_SWSPI : public Stream {
jppang 0:34125ddb025e 49
jppang 0:34125ddb025e 50 public:
jppang 0:34125ddb025e 51 /** LCD panel format */
jppang 0:34125ddb025e 52 enum LCDType {
jppang 0:34125ddb025e 53 LCD6100 /**< Nokia 6100, as found on sparkfun board (default) */
jppang 0:34125ddb025e 54 , LCD6610 /**< Nokia 6610, as found on olimex board */
jppang 0:34125ddb025e 55 , PCF8833
jppang 0:34125ddb025e 56 };
jppang 0:34125ddb025e 57
jppang 0:34125ddb025e 58 /** Create and Nokia LCD interface, using a SPI and two DigitalOut interfaces
jppang 0:34125ddb025e 59 *
jppang 0:34125ddb025e 60 * @param mosi SPI data out
jppang 0:34125ddb025e 61 * @param miso SPI data in
jppang 0:34125ddb025e 62 * @param sclk SPI clock
jppang 0:34125ddb025e 63 * @param cs Chip Select (DigitalOut)
jppang 0:34125ddb025e 64 * @param rst Reset (DigitalOut)
jppang 0:34125ddb025e 65 * @param type The LCDType to select driver chip variants
jppang 0:34125ddb025e 66 */
jppang 0:34125ddb025e 67 NokiaLCD_SWSPI(PinName mosi, PinName miso, PinName sclk, PinName cs, PinName rst, LCDType type = LCD6100);
jppang 0:34125ddb025e 68
jppang 0:34125ddb025e 69 #if DOXYGEN_ONLY
jppang 0:34125ddb025e 70 /** Write a character to the LCD
jppang 0:34125ddb025e 71 *
jppang 0:34125ddb025e 72 * @param c The character to write to the display
jppang 0:34125ddb025e 73 */
jppang 0:34125ddb025e 74 int putc(int c);
jppang 0:34125ddb025e 75
jppang 0:34125ddb025e 76 /** Write a formated string to the LCD
jppang 0:34125ddb025e 77 *
jppang 0:34125ddb025e 78 * @param format A printf-style format string, followed by the
jppang 0:34125ddb025e 79 * variables to use in formating the string.
jppang 0:34125ddb025e 80 */
jppang 0:34125ddb025e 81 int printf(const char* format, ...);
jppang 0:34125ddb025e 82 #endif
jppang 0:34125ddb025e 83
jppang 0:34125ddb025e 84 /** Locate to a screen column and row
jppang 0:34125ddb025e 85 *
jppang 0:34125ddb025e 86 * @param column The horizontal position from the left, indexed from 0
jppang 0:34125ddb025e 87 * @param row The vertical position from the top, indexed from 0
jppang 0:34125ddb025e 88 */
jppang 0:34125ddb025e 89 void locate(int column, int row);
jppang 0:34125ddb025e 90
jppang 0:34125ddb025e 91 /** Clear the screen and locate to 0,0 */
jppang 0:34125ddb025e 92 void cls();
jppang 0:34125ddb025e 93
jppang 0:34125ddb025e 94 /** Set a pixel on te screen
jppang 0:34125ddb025e 95 *
jppang 0:34125ddb025e 96 * @param x horizontal position from left
jppang 0:34125ddb025e 97 * @param y vertical position from top
jppang 0:34125ddb025e 98 * @param colour 24-bit colour in format 0x00RRGGBB
jppang 0:34125ddb025e 99 */
jppang 0:34125ddb025e 100 void pixel(int x, int y, int colour);
jppang 0:34125ddb025e 101
jppang 0:34125ddb025e 102 /** Fill an area of the screen
jppang 0:34125ddb025e 103 *
jppang 0:34125ddb025e 104 * @param x horizontal position from left
jppang 0:34125ddb025e 105 * @param y vertical position from top
jppang 0:34125ddb025e 106 * @param width width in pixels
jppang 0:34125ddb025e 107 * @param height height in pixels
jppang 0:34125ddb025e 108 * @param colour 24-bit colour in format 0x00RRGGBB
jppang 0:34125ddb025e 109 */
jppang 0:34125ddb025e 110 void fill(int x, int y, int width, int height, int colour);
jppang 0:34125ddb025e 111
jppang 0:34125ddb025e 112 void blit(int x, int y, int width, int height, const int* colour);
jppang 0:34125ddb025e 113 void bitblit(int x, int y, int width, int height, const char* bitstream);
jppang 0:34125ddb025e 114
jppang 0:34125ddb025e 115 int width();
jppang 0:34125ddb025e 116 int height();
jppang 0:34125ddb025e 117 int columns();
jppang 0:34125ddb025e 118 int rows();
jppang 0:34125ddb025e 119
jppang 0:34125ddb025e 120 void reset();
jppang 0:34125ddb025e 121
jppang 0:34125ddb025e 122 /** Set the foreground colour
jppang 0:34125ddb025e 123 *
jppang 0:34125ddb025e 124 * @param c 24-bit colour
jppang 0:34125ddb025e 125 */
jppang 0:34125ddb025e 126 void foreground(int c);
jppang 0:34125ddb025e 127
jppang 0:34125ddb025e 128 /** Set the background colour
jppang 0:34125ddb025e 129 *
jppang 0:34125ddb025e 130 * @param c 24-bit colour
jppang 0:34125ddb025e 131 */
jppang 0:34125ddb025e 132 void background(int c);
jppang 0:34125ddb025e 133
jppang 0:34125ddb025e 134 protected:
jppang 0:34125ddb025e 135 virtual void _window(int x, int y, int width, int height);
jppang 0:34125ddb025e 136 virtual void _putp(int colour);
jppang 0:34125ddb025e 137
jppang 0:34125ddb025e 138 void command(int value);
jppang 0:34125ddb025e 139 void data(int value);
jppang 0:34125ddb025e 140
jppang 0:34125ddb025e 141 void newline();
jppang 0:34125ddb025e 142 virtual int _putc(int c);
jppang 0:34125ddb025e 143 virtual int _getc() {
jppang 0:34125ddb025e 144 return 0;
jppang 0:34125ddb025e 145 }
jppang 0:34125ddb025e 146 void putp(int v);
jppang 0:34125ddb025e 147 void window(int x, int y, int width, int height);
jppang 0:34125ddb025e 148
jppang 0:34125ddb025e 149 SWSPI _spi;
jppang 0:34125ddb025e 150 DigitalOut _cs;
jppang 0:34125ddb025e 151 DigitalOut _rst;
jppang 0:34125ddb025e 152
jppang 0:34125ddb025e 153 LCDType _type;
jppang 0:34125ddb025e 154 int _row, _column, _rows, _columns, _foreground, _background, _width, _height;
jppang 0:34125ddb025e 155 };
jppang 0:34125ddb025e 156
jppang 0:34125ddb025e 157 #endif
jppang 0:34125ddb025e 158
jppang 0:34125ddb025e 159