Chris Taylor / LCD_ST7735 Featured

SPI based library for the ST7735 LCD controller.

Dependents:   RayCastingEngine RETRO_LCD_PerformanceTest RETRO_loop_test RETRO_RickGame ... more

LCD_ST7735.h@5:21c987ee68d2, 2014-10-05 (annotated)

Committer:
taylorza
Date:
Sun Oct 05 22:24:22 2014 +0000
Revision:
5:21c987ee68d2
Parent:
4:88d22437119c
Child:
7:f39c980a589c
Fixed initialization routine and added fast SPI handling for the LPC11U24

Who changed what in which revision?

UserRevisionLine numberNew contents of line
taylorza 0:7b3fb3085867 1 ///////////////////////////////////////////////////////////////////////////////
taylorza 0:7b3fb3085867 2 // LCD_ST7735 - Driver for ST7735 LCD display controller
taylorza 0:7b3fb3085867 3 // Author: Chris Taylor (taylorza)
taylorza 0:7b3fb3085867 4
taylorza 0:7b3fb3085867 5 #ifndef __LCD_ST7735__
taylorza 0:7b3fb3085867 6 #define __LCD_ST7735__
taylorza 0:7b3fb3085867 7 /** LCD_ST7735 is a simple driver for the ST7735 LCD controller. It provides basic drawing primitives sa well as text and font capabilities.
taylorza 0:7b3fb3085867 8 * The driver is currently hardcoded to support 65K colors using a 565 RGB pixel format.
taylorza 0:7b3fb3085867 9 */
taylorza 0:7b3fb3085867 10 class LCD_ST7735
taylorza 0:7b3fb3085867 11 {
taylorza 0:7b3fb3085867 12 public:
taylorza 3:451148656b76 13 /** Orientation of the display */
taylorza 3:451148656b76 14 enum Orientation
taylorza 3:451148656b76 15 {
taylorza 3:451148656b76 16 /** No rotation of the display image*/
taylorza 3:451148656b76 17 Rotate0,
taylorza 3:451148656b76 18 /** Rotate the display image 90 degrees */
taylorza 3:451148656b76 19 Rotate90,
taylorza 3:451148656b76 20 /** Rotate the display image 180 degrees */
taylorza 3:451148656b76 21 Rotate180,
taylorza 3:451148656b76 22 /** Rotate the display image 270 degrees */
taylorza 3:451148656b76 23 Rotate270
taylorza 3:451148656b76 24 };
taylorza 3:451148656b76 25
taylorza 3:451148656b76 26 public:
taylorza 0:7b3fb3085867 27 /**Creates an instance of the LCD_ST7735 driver
taylorza 0:7b3fb3085867 28 * @param backlightPin pin used to control the backlight
taylorza 0:7b3fb3085867 29 * @param resetPin pin used to reset the display controller
taylorza 0:7b3fb3085867 30 * @param dsPin pin used to put the display controller into data mode
taylorza 0:7b3fb3085867 31 * @param mosiPin SPI channel MOSI pin
taylorza 0:7b3fb3085867 32 * @param misoPin SPI channel MISO pin
taylorza 0:7b3fb3085867 33 * @param clkPin SPI channel clock pin
taylorza 0:7b3fb3085867 34 * @param csPin SPI chip select pin
taylorza 0:7b3fb3085867 35 */
taylorza 0:7b3fb3085867 36 LCD_ST7735(
taylorza 0:7b3fb3085867 37 PinName backlightPin,
taylorza 0:7b3fb3085867 38 PinName resetPin,
taylorza 0:7b3fb3085867 39 PinName dsPin,
taylorza 0:7b3fb3085867 40 PinName mosiPin,
taylorza 0:7b3fb3085867 41 PinName misoPin,
taylorza 0:7b3fb3085867 42 PinName clkPin,
taylorza 0:7b3fb3085867 43 PinName csPin
taylorza 0:7b3fb3085867 44 );
taylorza 3:451148656b76 45
taylorza 3:451148656b76 46 /** Set the orientation of the display
taylorza 3:451148656b76 47 * @param orientation Orientation of the display.
taylorza 3:451148656b76 48 * @param flip Flips the display direction
taylorza 3:451148656b76 49 */
taylorza 3:451148656b76 50 void setOrientation(Orientation orientation, bool flip);
taylorza 3:451148656b76 51
taylorza 3:451148656b76 52 /** Get the width of the display given the current orientation */
taylorza 3:451148656b76 53 int getWidth();
taylorza 3:451148656b76 54
taylorza 3:451148656b76 55 /** Get the height of the display given the current orientation */
taylorza 3:451148656b76 56 int getHeight();
taylorza 0:7b3fb3085867 57
taylorza 0:7b3fb3085867 58 /** Control the display's backlight
taylorza 0:7b3fb3085867 59 * @param state true to turn the backlight on, false to turn it off
taylorza 0:7b3fb3085867 60 */
taylorza 0:7b3fb3085867 61 void setBacklight(bool state);
taylorza 0:7b3fb3085867 62
taylorza 0:7b3fb3085867 63 /** Clear the screen
taylorza 0:7b3fb3085867 64 * @param color The color used to clear the screen. Defaults to black if not passed.
taylorza 0:7b3fb3085867 65 */
taylorza 0:7b3fb3085867 66 void clearScreen(uint16_t color = 0x0000);
taylorza 0:7b3fb3085867 67
taylorza 0:7b3fb3085867 68 /** Set a pixel on the display to the specified color
taylorza 0:7b3fb3085867 69 * @param x The X coordinate of the pixel (0..127)
taylorza 0:7b3fb3085867 70 * @param y The Y coordinate of the pixel (0..159)
taylorza 0:7b3fb3085867 71 * @param color Color to set the pixel to.
taylorza 0:7b3fb3085867 72 */
taylorza 0:7b3fb3085867 73 void setPixel(int x, int y, uint16_t color);
taylorza 0:7b3fb3085867 74
taylorza 0:7b3fb3085867 75 /** Draw a line on the display
taylorza 0:7b3fb3085867 76 * @param x1 The X coordinate of the starting point on the line
taylorza 0:7b3fb3085867 77 * @param y1 The Y coordinate of the starting point on the line
taylorza 0:7b3fb3085867 78 * @param x2 The X coordinate of the end point on the line
taylorza 0:7b3fb3085867 79 * @param y2 The Y coordinate of the end point on the line
taylorza 0:7b3fb3085867 80 * @param color The color used to draw the pixel
taylorza 0:7b3fb3085867 81 */
taylorza 0:7b3fb3085867 82 void drawLine(int x1, int y1, int x2, int y2, uint16_t color);
taylorza 0:7b3fb3085867 83
taylorza 0:7b3fb3085867 84 /** Draw a rectangle on the display
taylorza 0:7b3fb3085867 85 * @param x1 The X coordinate of the upper left corner
taylorza 0:7b3fb3085867 86 * @param y1 The Y coordinate of the upper left corner
taylorza 0:7b3fb3085867 87 * @param x2 The X coordinate of the lower right corner
taylorza 0:7b3fb3085867 88 * @param y2 The Y coordinate of the lower right corner
taylorza 0:7b3fb3085867 89 * @param color The color used to draw the rectangle
taylorza 0:7b3fb3085867 90 */
taylorza 0:7b3fb3085867 91 void drawRect(int x1, int y1, int x2, int y2, uint16_t color);
taylorza 0:7b3fb3085867 92
taylorza 0:7b3fb3085867 93 /** Draw a circle on the display
taylorza 0:7b3fb3085867 94 * @param x The X coordinate of the center of the circle
taylorza 0:7b3fb3085867 95 * @param y The Y coordinate of the center of the circle
taylorza 0:7b3fb3085867 96 * @param r The radius of the circle
taylorza 0:7b3fb3085867 97 * @param color The color used to draw the circle
taylorza 0:7b3fb3085867 98 */
taylorza 0:7b3fb3085867 99 void drawCircle(int x, int y, int r, uint16_t color);
taylorza 0:7b3fb3085867 100
taylorza 1:33ff5fad4320 101 /** Draw an ellipse on the display
taylorza 1:33ff5fad4320 102 * @param x The X coordinate of the center of the ellipse
taylorza 1:33ff5fad4320 103 * @param y The Y coordinate of the center of the ellipse
taylorza 1:33ff5fad4320 104 * @param rx The X radius of the ellipse
taylorza 1:33ff5fad4320 105 * @param ry The X radius of the ellipse
taylorza 1:33ff5fad4320 106 * @param color The color used to draw the ellipse
taylorza 1:33ff5fad4320 107 */
taylorza 1:33ff5fad4320 108 void drawEllipse(int x, int y, int rx, int ry, uint16_t color);
taylorza 1:33ff5fad4320 109
taylorza 0:7b3fb3085867 110 /** Draw a filled rectangle on the display
taylorza 0:7b3fb3085867 111 * @param x1 The X coordinate of the upper left corner
taylorza 0:7b3fb3085867 112 * @param y1 The Y coordinate of the upper left corner
taylorza 0:7b3fb3085867 113 * @param x2 The X coordinate of the lower right corner
taylorza 0:7b3fb3085867 114 * @param y2 The Y coordinate of the lower right corner
taylorza 4:88d22437119c 115 * @param fillColor The color used to fill the rectangle
taylorza 4:88d22437119c 116 */
taylorza 4:88d22437119c 117 void fillRect(int x1, int y1, int x2, int y2, uint16_t fillColor);
taylorza 4:88d22437119c 118
taylorza 4:88d22437119c 119 /** Draw a filled rectangle on the display
taylorza 4:88d22437119c 120 * @param x1 The X coordinate of the upper left corner
taylorza 4:88d22437119c 121 * @param y1 The Y coordinate of the upper left corner
taylorza 4:88d22437119c 122 * @param x2 The X coordinate of the lower right corner
taylorza 4:88d22437119c 123 * @param y2 The Y coordinate of the lower right corner
taylorza 0:7b3fb3085867 124 * @param borderColor The color used to draw the rectangle frame
taylorza 0:7b3fb3085867 125 * @param fillColor The color used to fill the rectangle
taylorza 0:7b3fb3085867 126 */
taylorza 0:7b3fb3085867 127 void fillRect(int x1, int y1, int x2, int y2, uint16_t borderColor, uint16_t fillColor);
taylorza 0:7b3fb3085867 128
taylorza 0:7b3fb3085867 129 /** Draw a filled circle on the display
taylorza 0:7b3fb3085867 130 * @param x The X coordinate of the center of the circle
taylorza 0:7b3fb3085867 131 * @param y The Y coordinate of the center of the circle
taylorza 0:7b3fb3085867 132 * @param borderColor The color used to draw the circumference of the circle
taylorza 0:7b3fb3085867 133 * @param fillColor The color used to fill the circle
taylorza 0:7b3fb3085867 134 */
taylorza 0:7b3fb3085867 135 void fillCircle(int x, int y, int r, uint16_t borderColor, uint16_t fillColor);
taylorza 0:7b3fb3085867 136
taylorza 1:33ff5fad4320 137 /** Draw a filled ellipse on the display
taylorza 1:33ff5fad4320 138 * @param x The X coordinate of the center of the ellipse
taylorza 1:33ff5fad4320 139 * @param y The Y coordinate of the center of the ellipse
taylorza 1:33ff5fad4320 140 * @param rx The X radius of the ellipse
taylorza 1:33ff5fad4320 141 * @param ry The X radius of the ellipse
taylorza 1:33ff5fad4320 142 * @param borderColor The color used to draw the circumference of the circle
taylorza 1:33ff5fad4320 143 * @param fillColor The color used to fill the circle
taylorza 1:33ff5fad4320 144 */
taylorza 1:33ff5fad4320 145 void fillEllipse(int x, int y, int rx, int ry, uint16_t borderColor, uint16_t fillColor);
taylorza 1:33ff5fad4320 146
taylorza 0:7b3fb3085867 147 /** Draw a bitmap on the screen
taylorza 0:7b3fb3085867 148 * @param x The X coordinate location to draw the bitmap.
taylorza 0:7b3fb3085867 149 * @param y The Y coordinate location to draw the bitmap.
taylorza 0:7b3fb3085867 150 * @param pbmp Pointer to the bitmap.
taylorza 0:7b3fb3085867 151 * @note The bitmap is an single dimensional uint8_t (unsigned short) array.
taylorza 0:7b3fb3085867 152 * The first to elements of the array indicate the width and height of the bitmap repectively.
taylorza 0:7b3fb3085867 153 * The rest of the entries int the array make up the pixel data for the array.
taylorza 0:7b3fb3085867 154 */
taylorza 0:7b3fb3085867 155 void drawBitmap(int x, int y, const uint16_t *pbmp);
taylorza 0:7b3fb3085867 156
taylorza 1:33ff5fad4320 157 /** Extracts a portion of a bitmap and draws it on the screen
taylorza 1:33ff5fad4320 158 * @param x The X coordinate location to draw the bitmap.
taylorza 1:33ff5fad4320 159 * @param y The Y coordinate location to draw the bitmap.
taylorza 1:33ff5fad4320 160 * @param pbmp Pointer to the bitmap.
taylorza 1:33ff5fad4320 161 * @param srcX X offset into the source bitmap of the portion to extract
taylorza 1:33ff5fad4320 162 * @param srcY Y offset into the source bitmap of the portion to extract
taylorza 1:33ff5fad4320 163 * @param srcWidth Width of the bitmap portion to draw
taylorza 1:33ff5fad4320 164 * @param srcHeight Height of the bitmap portion to draw
taylorza 1:33ff5fad4320 165 * @note The bitmap is an single dimensional uint8_t (unsigned short) array.
taylorza 1:33ff5fad4320 166 * The first to elements of the array indicate the width and height of the bitmap repectively.
taylorza 1:33ff5fad4320 167 * The rest of the entries int the array make up the pixel data for the array.
taylorza 1:33ff5fad4320 168 */
taylorza 1:33ff5fad4320 169 void drawBitmap(int x, int y, const uint16_t *pbmp, int srcX, int srcY, int srcWidth, int srcHeight);
taylorza 1:33ff5fad4320 170
taylorza 0:7b3fb3085867 171 /** Set the foreground color used to render text
taylorza 0:7b3fb3085867 172 * @param color Color used when drawing text to the display
taylorza 0:7b3fb3085867 173 * @note The color can be changed multiple times to render text in various colors on the display
taylorza 0:7b3fb3085867 174 */
taylorza 0:7b3fb3085867 175 void setForegroundColor(uint16_t color);
taylorza 0:7b3fb3085867 176
taylorza 0:7b3fb3085867 177 /** Set the background color used to render text
taylorza 0:7b3fb3085867 178 * @param color Color used when drawing background portions of the text
taylorza 0:7b3fb3085867 179 * @note The color can be changed multiple times to render text with various background colors on the display
taylorza 0:7b3fb3085867 180 */
taylorza 0:7b3fb3085867 181 void setBackgroundColor(uint16_t color);
taylorza 0:7b3fb3085867 182
taylorza 0:7b3fb3085867 183 /** Draw a string to the screen using the currently active foreground and background colors
taylorza 0:7b3fb3085867 184 * @param pFont Pointer to the font used to render the string to the display
taylorza 0:7b3fb3085867 185 * @param x The X coordinate location to draw the string.
taylorza 0:7b3fb3085867 186 * @param y The Y coordinate location to draw the string.
taylorza 0:7b3fb3085867 187 * @param pString ASCIIZ string to draw to the display.
taylorza 0:7b3fb3085867 188 * @note The font is currently limited to an 8x8 font. See the font_IBM.h file for an example font.
taylorza 0:7b3fb3085867 189 */
taylorza 3:451148656b76 190 void drawString(const uint8_t *pFont, int x, int y, const char *pString);
taylorza 0:7b3fb3085867 191
taylorza 0:7b3fb3085867 192 private:
taylorza 0:7b3fb3085867 193 void drawVertLine(int x1, int y1, int y2, uint16_t color);
taylorza 0:7b3fb3085867 194 void drawHorizLine(int x1, int y1, int x2, uint16_t color);
taylorza 0:7b3fb3085867 195 void drawChar(const uint8_t *pFont, int x, int y, char c);
taylorza 0:7b3fb3085867 196
taylorza 0:7b3fb3085867 197 private:
taylorza 0:7b3fb3085867 198 void swap(int &a, int &b);
taylorza 0:7b3fb3085867 199
taylorza 0:7b3fb3085867 200 private:
taylorza 0:7b3fb3085867 201 void initDisplay();
taylorza 0:7b3fb3085867 202 void reset();
taylorza 5:21c987ee68d2 203
taylorza 5:21c987ee68d2 204 void writeCommand(uint8_t cmd);
taylorza 0:7b3fb3085867 205 void write(uint8_t cmd, uint8_t data[], int dataLen);
taylorza 0:7b3fb3085867 206 void write(uint8_t cmd, uint16_t data);
taylorza 5:21c987ee68d2 207
taylorza 0:7b3fb3085867 208 void beginBatchCommand(uint8_t cmd);
taylorza 0:7b3fb3085867 209 void writeBatchData(uint8_t data);
taylorza 4:88d22437119c 210 void writeBatchData(uint8_t dataHigh, uint8_t dataLow);
taylorza 0:7b3fb3085867 211 void writeBatchData(uint16_t data);
taylorza 0:7b3fb3085867 212 void endBatchCommand();
taylorza 0:7b3fb3085867 213
taylorza 0:7b3fb3085867 214 void clip(int x, int y, int w, int h);
taylorza 0:7b3fb3085867 215 void clipRect(int x1, int y1, int x2, int y2);
taylorza 0:7b3fb3085867 216
taylorza 0:7b3fb3085867 217 private:
taylorza 3:451148656b76 218 int _width;
taylorza 3:451148656b76 219 int _height;
taylorza 3:451148656b76 220 Orientation _orientation;
taylorza 3:451148656b76 221 bool _flip;
taylorza 4:88d22437119c 222 uint8_t _foregroundColorHigh;
taylorza 4:88d22437119c 223 uint8_t _foregroundColorLow;
taylorza 4:88d22437119c 224 uint8_t _backgroundColorHigh;
taylorza 4:88d22437119c 225 uint8_t _backgroundColorLow;
taylorza 0:7b3fb3085867 226
taylorza 5:21c987ee68d2 227 private:
taylorza 5:21c987ee68d2 228 class LCDSPI : public SPI
taylorza 5:21c987ee68d2 229 {
taylorza 5:21c987ee68d2 230 public:
taylorza 5:21c987ee68d2 231 LCDSPI(PinName mosi, PinName miso, PinName sclk) :
taylorza 5:21c987ee68d2 232 SPI(mosi, miso, sclk)
taylorza 5:21c987ee68d2 233 {
taylorza 5:21c987ee68d2 234 }
taylorza 5:21c987ee68d2 235
taylorza 5:21c987ee68d2 236 void waitWhileBusy()
taylorza 5:21c987ee68d2 237 {
taylorza 5:21c987ee68d2 238 #ifdef TARGET_LPC11U24
taylorza 5:21c987ee68d2 239 while (((_spi.spi->SR) & 0x10) != 0);
taylorza 5:21c987ee68d2 240 #endif
taylorza 5:21c987ee68d2 241 }
taylorza 5:21c987ee68d2 242
taylorza 5:21c987ee68d2 243 void fastWrite(uint8_t data)
taylorza 5:21c987ee68d2 244 {
taylorza 5:21c987ee68d2 245 #ifdef TARGET_LPC11U24
taylorza 5:21c987ee68d2 246 while (((_spi.spi->SR) & 0x01) == 0);
taylorza 5:21c987ee68d2 247 _spi.spi->DR = data;
taylorza 5:21c987ee68d2 248 #else
taylorza 5:21c987ee68d2 249 SPI::write(data);
taylorza 5:21c987ee68d2 250 #endif
taylorza 5:21c987ee68d2 251 }
taylorza 5:21c987ee68d2 252
taylorza 5:21c987ee68d2 253 void clearRx()
taylorza 5:21c987ee68d2 254 {
taylorza 5:21c987ee68d2 255 #ifdef TARGET_LPC11U24
taylorza 5:21c987ee68d2 256 while (((_spi.spi->SR) & 0x14) != 0)
taylorza 5:21c987ee68d2 257 {
taylorza 5:21c987ee68d2 258 while (((_spi.spi->SR) & 0x04) == 0);
taylorza 5:21c987ee68d2 259 int data = _spi.spi->DR;
taylorza 5:21c987ee68d2 260 }
taylorza 5:21c987ee68d2 261 #endif
taylorza 5:21c987ee68d2 262 }
taylorza 5:21c987ee68d2 263 };
taylorza 5:21c987ee68d2 264
taylorza 0:7b3fb3085867 265 private:
taylorza 0:7b3fb3085867 266 DigitalOut _backlight;
taylorza 0:7b3fb3085867 267 DigitalOut _reset;
taylorza 0:7b3fb3085867 268 DigitalOut _ds;
taylorza 0:7b3fb3085867 269 DigitalOut _cs;
taylorza 5:21c987ee68d2 270 LCDSPI _spi;
taylorza 0:7b3fb3085867 271
taylorza 0:7b3fb3085867 272 private:
taylorza 0:7b3fb3085867 273 static const uint8_t CMD_SLPOUT = 0x11;
taylorza 0:7b3fb3085867 274 static const uint8_t CMD_DISPON = 0x29;
taylorza 0:7b3fb3085867 275 static const uint8_t CMD_CASET = 0x2a;
taylorza 0:7b3fb3085867 276 static const uint8_t CMD_RASET = 0x2b;
taylorza 0:7b3fb3085867 277 static const uint8_t CMD_RAMWR = 0x2c;
taylorza 0:7b3fb3085867 278
taylorza 0:7b3fb3085867 279 static const uint8_t CMD_MADCTL = 0x36;
taylorza 0:7b3fb3085867 280 static const uint8_t CMD_COLMOD = 0x3a;
taylorza 0:7b3fb3085867 281
taylorza 0:7b3fb3085867 282 static const uint8_t CMD_FRMCTR1 = 0xb1;
taylorza 0:7b3fb3085867 283 static const uint8_t CMD_FRMCTR2 = 0xb2;
taylorza 0:7b3fb3085867 284 static const uint8_t CMD_FRMCTR3 = 0xb3;
taylorza 0:7b3fb3085867 285 static const uint8_t CMD_INVCTR = 0xb4;
taylorza 0:7b3fb3085867 286
taylorza 0:7b3fb3085867 287 static const uint8_t CMD_PWCTR1 = 0xc0;
taylorza 0:7b3fb3085867 288 static const uint8_t CMD_PWCTR2 = 0xc1;
taylorza 0:7b3fb3085867 289 static const uint8_t CMD_PWCTR3 = 0xc2;
taylorza 0:7b3fb3085867 290 static const uint8_t CMD_PWCTR4 = 0xc3;
taylorza 0:7b3fb3085867 291 static const uint8_t CMD_PWCTR5 = 0xc4;
taylorza 0:7b3fb3085867 292 static const uint8_t CMD_VMCTR1 = 0xc5;
taylorza 0:7b3fb3085867 293
taylorza 0:7b3fb3085867 294 static const uint8_t CMD_GAMCTRP1 = 0xe0;
taylorza 0:7b3fb3085867 295 static const uint8_t CMD_GAMCTRN1 = 0xe1;
taylorza 0:7b3fb3085867 296
taylorza 5:21c987ee68d2 297 static const uint8_t CMD_EXTCTRL = 0xf0;
taylorza 0:7b3fb3085867 298 };
taylorza 0:7b3fb3085867 299
taylorza 0:7b3fb3085867 300 #endif // __LCD_ST7735__