Library for handling ILI9163 - based LCD displays.

Dependents:   TVZ_MU_Seminar

ILI9163 displays are typically 128*128 pixels with 15-bit color and controlled over 8-bit SPI.

This library is adapted from https://developer.mbed.org/teams/Temp/code/DL144128_LCD_b/, with some changes.

Revision:
0:06faf770a0c7
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/ili9163lcd.cpp	Wed Jan 25 23:46:47 2017 +0000
@@ -0,0 +1,433 @@
+/**
+ * @file ili9163lcd.c
+ * @brief ILI9163 128x128 LCD Driver
+ *
+ * This code has been ported from the ili9163lcd library for mbed
+ * made by Jun Morita.
+ * Source form <http://files.noccylabs.info/lib430/liblcd/ili9163lcd_8c.html>
+ *
+ * This code has been ported from the ili9163lcd library for avr made
+ * by Simon Inns, to run on a msp430.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @author Jun Morita (iccraft)
+ * @author Simon Inns <simon.inns@gmail.com>
+ * @author Christopher Vagnetoft (NoccyLabs)
+ * @copyright (C) 2012 Simon Inns
+ * @copyright parts (C) 2012 NoccyLabs
+ */
+
+#include "ili9163lcd.h"
+#include "mbed.h"
+
+//--------------------------------------------------------------------------
+// Initialize the object
+//
+ILI9163::ILI9163(PinName SCK, PinName SDA, PinName A0, PinName RESET, PinName CS, PinName LED)
+ : SPI_(SDA, NC, SCK), A0_(A0), RESET_(RESET), CS_(CS), LED_(LED)
+{
+  SPI_.format(8);
+  //TODO: allow user to change interface frequency
+  SPI_.frequency(20000000);
+  
+  setFont((unsigned char*)font5x8);  
+}
+
+//--------------------------------------------------------------------------
+// Low-level LCD driving functions
+
+// Reset the LCD hardware
+void ILI9163::reset(void)
+{
+    // Reset pin is active low (0 = reset, 1 = ready)
+    RESET_ = 0;
+    wait_ms(50);
+
+    RESET_ = 1;
+    wait_ms(120);
+}
+
+void ILI9163::writeCommand(uint8_t address)
+{
+    CS_ = 0;
+    A0_ = 0;
+    SPI_.write(address);
+    CS_ = 1;
+}
+
+void ILI9163::writeParameter(uint8_t parameter)
+{  
+    CS_ = 0;
+    A0_ = 1;
+    SPI_.write(parameter);
+    CS_ = 1;
+}
+ 
+void ILI9163::writeData(uint16_t data)
+{
+    CS_ = 0;
+    A0_ = 1;
+    SPI_.write(data >> 8);
+    SPI_.write(data & 0xFF);
+    CS_ = 1;
+}
+
+// Initialize the display with the require screen orientation
+void ILI9163::init(uint8_t orientation)
+{   
+    CS_ = 1;
+    RESET_ = 1;
+   
+    // Hardware reset the LCD
+    reset();
+    
+    writeCommand(EXIT_SLEEP_MODE);
+    wait_ms(5); // Wait for the screen to wake up
+    
+    writeCommand(SET_PIXEL_FORMAT);
+    writeParameter(0x05); // 16 bits per pixel
+   
+    writeCommand(SET_GAMMA_CURVE);
+    writeParameter(0x04); // Select gamma curve 3
+    
+    writeCommand(GAM_R_SEL);
+    writeParameter(0x01); // Gamma adjustment enabled
+    
+    writeCommand(POSITIVE_GAMMA_CORRECT);
+    writeParameter(0x3f); // 1st Parameter
+    writeParameter(0x25); // 2nd Parameter
+    writeParameter(0x1c); // 3rd Parameter
+    writeParameter(0x1e); // 4th Parameter
+    writeParameter(0x20); // 5th Parameter
+    writeParameter(0x12); // 6th Parameter
+    writeParameter(0x2a); // 7th Parameter
+    writeParameter(0x90); // 8th Parameter
+    writeParameter(0x24); // 9th Parameter
+    writeParameter(0x11); // 10th Parameter
+    writeParameter(0x00); // 11th Parameter
+    writeParameter(0x00); // 12th Parameter
+    writeParameter(0x00); // 13th Parameter
+    writeParameter(0x00); // 14th Parameter
+    writeParameter(0x00); // 15th Parameter
+     
+    writeCommand(NEGATIVE_GAMMA_CORRECT);
+    writeParameter(0x20); // 1st Parameter
+    writeParameter(0x20); // 2nd Parameter
+    writeParameter(0x20); // 3rd Parameter
+    writeParameter(0x20); // 4th Parameter
+    writeParameter(0x05); // 5th Parameter
+    writeParameter(0x00); // 6th Parameter
+    writeParameter(0x15); // 7th Parameter
+    writeParameter(0xa7); // 8th Parameter
+    writeParameter(0x3d); // 9th Parameter
+    writeParameter(0x18); // 10th Parameter
+    writeParameter(0x25); // 11th Parameter
+    writeParameter(0x2a); // 12th Parameter
+    writeParameter(0x2b); // 13th Parameter
+    writeParameter(0x2b); // 14th Parameter
+    writeParameter(0x3a); // 15th Parameter
+    
+    writeCommand(FRAME_RATE_CONTROL1);
+    writeParameter(0x11); // DIVA = 17
+    writeParameter(0x14); // VPA = 20
+    
+    writeCommand(DISPLAY_INVERSION);
+    writeParameter(0x07); // NLA = 1, NLB = 1, NLC = 1 (all on Frame Inversion)
+   
+    writeCommand(POWER_CONTROL1);
+    writeParameter(0x0a); // VRH = 10:  GVDD = 4.30
+    writeParameter(0x02); // VC = 2: VCI1 = 2.65
+      
+    writeCommand(POWER_CONTROL2);
+    writeParameter(0x02); // BT = 2: AVDD = 2xVCI1, VCL = -1xVCI1, VGH = 5xVCI1, VGL = -2xVCI1
+
+    writeCommand(VCOM_CONTROL1);
+    writeParameter(0x50); // VMH = 80: VCOMH voltage = 4.5
+    writeParameter(0x5b); // VML = 91: VCOML voltage = -0.225
+    
+    writeCommand(VCOM_OFFSET_CONTROL);
+    writeParameter(0x40); // nVM = 0, VMF = 64: VCOMH output = VMH, VCOML output = VML   
+    
+    writeCommand(SET_COLUMN_ADDRESS);
+    writeParameter(0x00); // XSH
+    writeParameter(0x00); // XSL
+    writeParameter(0x00); // XEH
+    writeParameter(0x7f); // XEL (128 pixels x)
+   
+    writeCommand(SET_PAGE_ADDRESS);
+    writeParameter(0x00);
+    writeParameter(0x00);
+    writeParameter(0x00);
+    writeParameter(0x7f); // 128 pixels y
+    
+    // Select display orientation
+    writeCommand(SET_ADDRESS_MODE);
+    writeParameter(orientation);
+
+    // Set the display to on
+    writeCommand(SET_DISPLAY_ON);
+    writeCommand(WRITE_MEMORY_START);
+}
+
+// LCD graphics functions -----------------------------------------------------------------------------------
+
+void ILI9163::clearDisplay(uint16_t colour)
+{
+    uint16_t pixel;
+  
+    // Set the column address to 0-127
+    writeCommand(SET_COLUMN_ADDRESS);
+    writeParameter(0x00);
+    writeParameter(0x00);
+    writeParameter(0x00);
+    writeParameter(0x7f);
+
+    // Set the page address to 0-127
+    writeCommand(SET_PAGE_ADDRESS);
+    writeParameter(0x00);
+    writeParameter(0x00);
+    writeParameter(0x00);
+    writeParameter(0x7f);
+  
+    // Plot the pixels
+    writeCommand(WRITE_MEMORY_START);
+    
+    for(pixel = 0; pixel < 128*128; pixel++)
+        writeData(colour);
+}
+
+void ILI9163::plot(uint8_t x, uint8_t y, uint16_t colour)
+{
+    // Horizontal Address Start Position
+    writeCommand(SET_COLUMN_ADDRESS);
+    writeParameter(0x00);
+    writeParameter(x);
+    writeParameter(0x00);
+    writeParameter(0x7f);
+  
+    // Vertical Address end Position
+    writeCommand(SET_PAGE_ADDRESS);
+    writeParameter(0x00);
+    writeParameter(y);
+    writeParameter(0x00);
+    writeParameter(0x7f);
+
+    // Plot the point
+    writeCommand(WRITE_MEMORY_START);
+    writeData(colour);
+}
+
+// Draw a line from x0, y0 to x1, y1
+// Note:    This is a version of Bresenham's line drawing algorithm
+//          It only draws lines from left to right!
+void ILI9163::line(int16_t x0, int16_t y0, int16_t x1, int16_t y1, uint16_t colour)
+{
+    int16_t dy = y1 - y0;
+    int16_t dx = x1 - x0;
+    int16_t stepx, stepy;
+
+    if (dy < 0)
+    {
+        dy = -dy; stepy = -1; 
+    }
+    else stepy = 1; 
+
+    if (dx < 0)
+    {
+        dx = -dx; stepx = -1; 
+    }
+    else stepx = 1; 
+
+    dy <<= 1;                           // dy is now 2*dy
+    dx <<= 1;                           // dx is now 2*dx
+ 
+    plot(x0, y0, colour);
+
+    if (dx > dy) {
+        int fraction = dy - (dx >> 1);  // same as 2*dy - dx
+        while (x0 != x1)
+        {
+            if (fraction >= 0)
+            {
+                y0 += stepy;
+                fraction -= dx;         // same as fraction -= 2*dx
+            }
+
+            x0 += stepx;
+            fraction += dy;                 // same as fraction -= 2*dy
+            plot(x0, y0, colour);
+        }
+    }
+    else
+    {
+        int fraction = dx - (dy >> 1);
+        while (y0 != y1)
+        {
+            if (fraction >= 0)
+            {
+                x0 += stepx;
+                fraction -= dy;
+            }
+
+            y0 += stepy;
+            fraction += dx;
+            plot(x0, y0, colour);
+        }
+    }
+}
+
+// Draw a rectangle between x0, y0 and x1, y1
+void ILI9163::rectangle(int16_t x0, int16_t y0, int16_t x1, int16_t y1, uint16_t colour)
+{
+    line(x0, y0, x0, y1, colour);
+    line(x0, y1, x1, y1, colour);
+    line(x1, y0, x1, y1, colour);
+    line(x0, y0, x1, y0, colour);
+}
+
+// Draw a filled rectangle
+// Note:    y1 must be greater than y0  and x1 must be greater than x0
+//          for this to work
+void ILI9163::filledRectangle(int16_t x0, int16_t y0, int16_t x1, int16_t y1, uint16_t colour)
+{
+    uint16_t pixels;
+            
+    // To speed up plotting we define a x window with the width of the 
+    // rectangle and then just output the required number of bytes to
+    // fill down to the end point
+    
+    writeCommand(SET_COLUMN_ADDRESS); // Horizontal Address Start Position
+    writeParameter(0x00);
+    writeParameter(x0);
+    writeParameter(0x00);
+    writeParameter(x1);
+  
+    writeCommand(SET_PAGE_ADDRESS); // Vertical Address end Position
+    writeParameter(0x00);
+    writeParameter(y0);
+    writeParameter(0x00);
+    writeParameter(0x7f);
+        
+    writeCommand(WRITE_MEMORY_START);
+    
+    for (pixels = 0; pixels < (((x1 - x0) + 1) * ((y1 - y0) + 1)); pixels++)
+        writeData(colour);;
+}
+
+// Draw a circle
+// Note:    This is another version of Bresenham's line drawing algorithm.
+//          There's plenty of documentation on the web if you are curious
+//          how this works.
+void ILI9163::circle(int16_t xCentre, int16_t yCentre, int16_t radius, uint16_t colour)
+{
+    int16_t x = 0, y = radius;
+    int16_t d = 3 - (2 * radius);
+ 
+    while(x <= y)
+    {
+        plot(xCentre + x, yCentre + y, colour);
+        plot(xCentre + y, yCentre + x, colour);
+        plot(xCentre - x, yCentre + y, colour);
+        plot(xCentre + y, yCentre - x, colour);
+        plot(xCentre - x, yCentre - y, colour);
+        plot(xCentre - y, yCentre - x, colour);
+        plot(xCentre + x, yCentre - y, colour);
+        plot(xCentre - y, yCentre + x, colour);
+
+        if (d < 0) d += (4 * x) + 6;
+        else
+        {
+            d += (4 * (x - y)) + 10;
+            y -= 1;
+        }
+
+        x++;
+    }
+}
+
+// LCD text manipulation functions --------------------------------------------------------------------------
+
+// Change the font and store its size information
+void ILI9163::setFont(unsigned char* f) {
+    font = f;
+    font_bp_char = font[0];                   // bytes per character
+    font_hor = font[1];                       // hor size of font
+    font_vert = font[2];                      // vert size of font
+    font_bp_line = font[3];                   // bytes per line
+}
+
+// Plot a character at the specified x, y co-ordinates (top left hand corner of character)
+void ILI9163::putCh(unsigned char c, uint8_t x, uint8_t y, uint16_t fgColour, uint16_t bgColour)
+{
+    uint16_t sign;
+    unsigned char z;
+    unsigned int j,i,b;
+    
+    if ((c < 31) || (c > 127)) return;   //Check if character is printable
+    
+    // To speed up plotting we define a x window of 6 pixels and then
+    // write out one row at a time.  This means the LCD will correctly
+    // update the memory pointer saving us a good few bytes
+    
+    writeCommand(SET_COLUMN_ADDRESS); // Horizontal Address Start Position
+    writeParameter(0x00);
+    writeParameter(x);
+    writeParameter(0x00);
+    writeParameter(x+font_hor-1);  // x + w -1 >> XEnd
+  
+    writeCommand(SET_PAGE_ADDRESS); // Vertical Address end Position
+    writeParameter(0x00);
+    writeParameter(y);
+    writeParameter(0x00);
+    writeParameter(y+font_vert-1);  // y + h -1 >> YEnd  0x7F
+        
+    writeCommand(WRITE_MEMORY_START);
+    
+    sign = (((c -32) * font_bp_char) + 4); // start of char bitmap
+  
+    // Plot the font data
+    for (j=0; j<font_vert; j++) {      //  vert line
+        for (i=0; i<font_hor; i++) {   //  horz line
+            z =  font[sign + (font_bp_line * i) + ((j & 0xF8) >> 3)+1];
+            b = 1 << (j & 0x07);
+            if (( z & b ) == 0x00)  writeData(fgColour);  
+            else                    writeData(bgColour);
+        }
+    }
+}
+
+// Plot a string of characters to the LCD
+void ILI9163::putS(const char *str, uint8_t x, uint8_t y, uint16_t fgColour, uint16_t bgColour)
+{
+    uint8_t origin = x;
+
+    for (uint8_t i = 0; i < strlen(str); i++)
+    {
+        // Check if we are out of bounds and move to 
+        // the next line if we are
+        if (x + font_hor > 127)
+        {
+            x = origin;
+            y += font_vert;
+        }
+
+        // If we move past the bottom of the screen just exit
+        if (y + font_vert > 127) break;
+        
+        // Plot the current character
+        putCh(str[i], x, y, fgColour, bgColour);
+        x += font_hor;
+    }
+}