Kazuki Yamamoto / AkiSpiLcd

Basic library for SHARP LCD LS027B4DH01/LS027B7DH01

Dependents:   AkiSpiLcd_demo AkiSpiLcd_demo2 LCDRAM AkiSpiLcd_example

AkiSpiLcd.h@31:7c7faf88edcc, 2016-10-23 (annotated)

Committer:
Kazuki Yamamoto
Date:
Sun Oct 23 02:27:02 2016 +0900
Revision:
31:7c7faf88edcc
Parent:
30:d5c18e268866
Child:
32:7e37fd2ddaa4
Declare license (MIT)

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Kazuki Yamamoto 31:7c7faf88edcc 1 /*
Kazuki Yamamoto 31:7c7faf88edcc 2 Copyright (c) 2016 Kazuki Yamamoto <k.yamamoto.08136891@gmail.com>
Kazuki Yamamoto 31:7c7faf88edcc 3 Permission is hereby granted, free of charge, to any person obtaining
Kazuki Yamamoto 31:7c7faf88edcc 4 a copy of this software and associated documentation files
Kazuki Yamamoto 31:7c7faf88edcc 5 (the "Software"), to deal in the Software without restriction,
Kazuki Yamamoto 31:7c7faf88edcc 6 including without limitation the rights to use, copy, modify, merge,
Kazuki Yamamoto 31:7c7faf88edcc 7 publish, distribute, sublicense, and/or sell copies of the Software,
Kazuki Yamamoto 31:7c7faf88edcc 8 and to permit persons to whom the Software is furnished to do so,
Kazuki Yamamoto 31:7c7faf88edcc 9 subject to the following conditions:
Kazuki Yamamoto 31:7c7faf88edcc 10 The above copyright notice and this permission notice shall be
Kazuki Yamamoto 31:7c7faf88edcc 11 included in all copies or substantial portions of the Software.
Kazuki Yamamoto 31:7c7faf88edcc 12 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
Kazuki Yamamoto 31:7c7faf88edcc 13 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
Kazuki Yamamoto 31:7c7faf88edcc 14 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
Kazuki Yamamoto 31:7c7faf88edcc 15 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
Kazuki Yamamoto 31:7c7faf88edcc 16 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
Kazuki Yamamoto 31:7c7faf88edcc 17 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
Kazuki Yamamoto 31:7c7faf88edcc 18 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Kazuki Yamamoto 31:7c7faf88edcc 19 */
k4zuki 1:57de84d2025c 20 /** this is for SHARP LCD LS027B4DH01
k4zuki 2:01979b296ab5 21 * by Kazuki Yamamoto, or _K4ZUKI_
k4zuki 0:b3c8fdd01601 22 */
k4zuki 0:b3c8fdd01601 23
k4zuki 0:b3c8fdd01601 24 #ifndef __AKISPILCD_H__
k4zuki 13:20ba395cbf2a 25 #define __AKISPILCD_H__
k4zuki 0:b3c8fdd01601 26
k4zuki 5:7061ce47a359 27 #include "mbed.h"
k4zuki 13:20ba395cbf2a 28
k4zuki 14:812873f3a933 29 /** \class AkiSpiLcd
k4zuki 14:812873f3a933 30 * \brief mbed library for SHARP LCD LS027B4DH01
k4zuki 2:01979b296ab5 31 *
k4zuki 2:01979b296ab5 32 * Example:
k4zuki 2:01979b296ab5 33 * @code
k4zuki 2:01979b296ab5 34 * #include "mbed.h"
k4zuki 2:01979b296ab5 35 * #include "AkiSpiLcd.h"
k4zuki 2:01979b296ab5 36 *
k4zuki 13:20ba395cbf2a 37 * AkiSpiLcd LCD(MOSI_, MISO_, SCK_, D2, D5);
k4zuki 2:01979b296ab5 38 * extern const uint8_t hogepic[];
k4zuki 2:01979b296ab5 39 * int main()
k4zuki 2:01979b296ab5 40 * {
k4zuki 10:eed99ef09e63 41 *
k4zuki 2:01979b296ab5 42 * wait_ms(1);
k4zuki 2:01979b296ab5 43 * LCD.cls();
k4zuki 13:20ba395cbf2a 44 * LCD.directUpdateSingle(10,(uint8_t*)(hogepic+2000));
k4zuki 13:20ba395cbf2a 45 * LCD.directUpdateMulti(100,(240-100),(uint8_t*)(hogepic));
k4zuki 2:01979b296ab5 46 *
k4zuki 2:01979b296ab5 47 * while(1) {
k4zuki 2:01979b296ab5 48 * for(int i=0; i<240; i++) {
k4zuki 13:20ba395cbf2a 49 * LCD.directUpdateMulti(i,(240-i),(uint8_t*)(hogepic));
k4zuki 13:20ba395cbf2a 50 * LCD.directUpdateMulti(0,(i),(uint8_t*)(hogepic+50*(240-i)));
k4zuki 2:01979b296ab5 51 * }
k4zuki 2:01979b296ab5 52 * }
k4zuki 2:01979b296ab5 53 * }
k4zuki 2:01979b296ab5 54 * @endcode
k4zuki 2:01979b296ab5 55 */
k4zuki 14:812873f3a933 56
k4zuki 14:812873f3a933 57 #define SCREEN0 0
k4zuki 14:812873f3a933 58 #define SCREEN1 1
k4zuki 14:812873f3a933 59 #define LINE_LENGTH 50
k4zuki 14:812873f3a933 60 #define RAMLINE_LENGTH 52
k4zuki 14:812873f3a933 61
Kazuki Yamamoto 30:d5c18e268866 62 const uint8_t lcd_line[256] = {
Kazuki Yamamoto 30:d5c18e268866 63 0x00, 0x80, 0x40, 0xC0, 0x20, 0xA0, 0x60, 0xE0, 0x10, 0x90, 0x50, 0xD0,
Kazuki Yamamoto 30:d5c18e268866 64 0x30, 0xB0, 0x70, 0xF0, 0x08, 0x88, 0x48, 0xC8, 0x28, 0xA8, 0x68, 0xE8,
Kazuki Yamamoto 30:d5c18e268866 65 0x18, 0x98, 0x58, 0xD8, 0x38, 0xB8, 0x78, 0xF8, 0x04, 0x84, 0x44, 0xC4,
Kazuki Yamamoto 30:d5c18e268866 66 0x24, 0xA4, 0x64, 0xE4, 0x14, 0x94, 0x54, 0xD4, 0x34, 0xB4, 0x74, 0xF4,
Kazuki Yamamoto 30:d5c18e268866 67 0x0C, 0x8C, 0x4C, 0xCC, 0x2C, 0xAC, 0x6C, 0xEC, 0x1C, 0x9C, 0x5C, 0xDC,
Kazuki Yamamoto 30:d5c18e268866 68 0x3C, 0xBC, 0x7C, 0xFC, 0x02, 0x82, 0x42, 0xC2, 0x22, 0xA2, 0x62, 0xE2,
Kazuki Yamamoto 30:d5c18e268866 69 0x12, 0x92, 0x52, 0xD2, 0x32, 0xB2, 0x72, 0xF2, 0x0A, 0x8A, 0x4A, 0xCA,
Kazuki Yamamoto 30:d5c18e268866 70 0x2A, 0xAA, 0x6A, 0xEA, 0x1A, 0x9A, 0x5A, 0xDA, 0x3A, 0xBA, 0x7A, 0xFA,
Kazuki Yamamoto 30:d5c18e268866 71 0x06, 0x86, 0x46, 0xC6, 0x26, 0xA6, 0x66, 0xE6, 0x16, 0x96, 0x56, 0xD6,
Kazuki Yamamoto 30:d5c18e268866 72 0x36, 0xB6, 0x76, 0xF6, 0x0E, 0x8E, 0x4E, 0xCE, 0x2E, 0xAE, 0x6E, 0xEE,
Kazuki Yamamoto 30:d5c18e268866 73 0x1E, 0x9E, 0x5E, 0xDE, 0x3E, 0xBE, 0x7E, 0xFE, 0x01, 0x81, 0x41, 0xC1,
Kazuki Yamamoto 30:d5c18e268866 74 0x21, 0xA1, 0x61, 0xE1, 0x11, 0x91, 0x51, 0xD1, 0x31, 0xB1, 0x71, 0xF1,
Kazuki Yamamoto 30:d5c18e268866 75 0x09, 0x89, 0x49, 0xC9, 0x29, 0xA9, 0x69, 0xE9, 0x19, 0x99, 0x59, 0xD9,
Kazuki Yamamoto 30:d5c18e268866 76 0x39, 0xB9, 0x79, 0xF9, 0x05, 0x85, 0x45, 0xC5, 0x25, 0xA5, 0x65, 0xE5,
Kazuki Yamamoto 30:d5c18e268866 77 0x15, 0x95, 0x55, 0xD5, 0x35, 0xB5, 0x75, 0xF5, 0x0D, 0x8D, 0x4D, 0xCD,
Kazuki Yamamoto 30:d5c18e268866 78 0x2D, 0xAD, 0x6D, 0xED, 0x1D, 0x9D, 0x5D, 0xDD, 0x3D, 0xBD, 0x7D, 0xFD,
Kazuki Yamamoto 30:d5c18e268866 79 0x03, 0x83, 0x43, 0xC3, 0x23, 0xA3, 0x63, 0xE3, 0x13, 0x93, 0x53, 0xD3,
Kazuki Yamamoto 30:d5c18e268866 80 0x33, 0xB3, 0x73, 0xF3, 0x0B, 0x8B, 0x4B, 0xCB, 0x2B, 0xAB, 0x6B, 0xEB,
Kazuki Yamamoto 30:d5c18e268866 81 0x1B, 0x9B, 0x5B, 0xDB, 0x3B, 0xBB, 0x7B, 0xFB, 0x07, 0x87, 0x47, 0xC7,
Kazuki Yamamoto 30:d5c18e268866 82 0x27, 0xA7, 0x67, 0xE7, 0x17, 0x97, 0x57, 0xD7, 0x37, 0xB7, 0x77, 0xF7,
Kazuki Yamamoto 30:d5c18e268866 83 0x0F,
k4zuki 14:812873f3a933 84 };
k4zuki 14:812873f3a933 85
Kazuki Yamamoto 30:d5c18e268866 86 class AkiSpiLcd {
k4zuki 0:b3c8fdd01601 87 public:
Kazuki Yamamoto 30:d5c18e268866 88 /** \enum BASE_ADDR
Kazuki Yamamoto 30:d5c18e268866 89 \brief base address list for 23K256
Kazuki Yamamoto 30:d5c18e268866 90 @param SCREEN0_BASE = 0x0000,
Kazuki Yamamoto 30:d5c18e268866 91 @param SCREEN1_BASE = 0x3000,
Kazuki Yamamoto 30:d5c18e268866 92 @param RAMLINE_BASE = 0x6000,
Kazuki Yamamoto 30:d5c18e268866 93 */
Kazuki Yamamoto 30:d5c18e268866 94 enum BASE_ADDR {
Kazuki Yamamoto 30:d5c18e268866 95 SCREEN0_BASE = 0x0000,
Kazuki Yamamoto 30:d5c18e268866 96 SCREEN1_BASE = 0x4000,
Kazuki Yamamoto 30:d5c18e268866 97 // RAMLINE_BASE = 0x7000,
Kazuki Yamamoto 30:d5c18e268866 98 };
k4zuki 10:eed99ef09e63 99
Kazuki Yamamoto 30:d5c18e268866 100 /** Constructor
Kazuki Yamamoto 30:d5c18e268866 101 * @param mosi SPI data output from mbed
Kazuki Yamamoto 30:d5c18e268866 102 * @param mosi SPI data input from slave
Kazuki Yamamoto 30:d5c18e268866 103 * @param sck SPI clock output from mbed
Kazuki Yamamoto 30:d5c18e268866 104 * @param csl HIGH-active chip select input for LCD
Kazuki Yamamoto 30:d5c18e268866 105 * @param csr LOW-active chip select input for SRAM
Kazuki Yamamoto 30:d5c18e268866 106 */
Kazuki Yamamoto 30:d5c18e268866 107 AkiSpiLcd(PinName mosi, PinName miso, PinName sck, PinName csl, PinName csr);
k4zuki 0:b3c8fdd01601 108
Kazuki Yamamoto 30:d5c18e268866 109 /** Clear screen
Kazuki Yamamoto 30:d5c18e268866 110 */
Kazuki Yamamoto 30:d5c18e268866 111 void cls();
k4zuki 0:b3c8fdd01601 112
Kazuki Yamamoto 30:d5c18e268866 113 /** Clear screen of SRAM
Kazuki Yamamoto 30:d5c18e268866 114 * @param screen screen number (0 or 1)
Kazuki Yamamoto 30:d5c18e268866 115 */
Kazuki Yamamoto 30:d5c18e268866 116 void cls_ram(int screen);
Kazuki Yamamoto 30:d5c18e268866 117
Kazuki Yamamoto 30:d5c18e268866 118 /** place a dot pixel
Kazuki Yamamoto 30:d5c18e268866 119 * @param x x position
Kazuki Yamamoto 30:d5c18e268866 120 * @param y y position
Kazuki Yamamoto 30:d5c18e268866 121 */
Kazuki Yamamoto 30:d5c18e268866 122 // virtual void pixel(int x, int y, int colour);
Kazuki Yamamoto 30:d5c18e268866 123 // virtual int width() = 0;
Kazuki Yamamoto 30:d5c18e268866 124 // virtual int height() = 0;
k4zuki 13:20ba395cbf2a 125
Kazuki Yamamoto 30:d5c18e268866 126 /** Writes single line(400 bits = 50 bytes)
Kazuki Yamamoto 30:d5c18e268866 127 * @param line line number(1-240)
Kazuki Yamamoto 30:d5c18e268866 128 * @param *data pointer to data
Kazuki Yamamoto 30:d5c18e268866 129 */
Kazuki Yamamoto 30:d5c18e268866 130 void directUpdateSingle(int line, uint8_t *data);
k4zuki 0:b3c8fdd01601 131
Kazuki Yamamoto 30:d5c18e268866 132 /** Writes multi lines(400 x N bits = 50 x N bytes)
Kazuki Yamamoto 30:d5c18e268866 133 * @param line line number(1-240)
Kazuki Yamamoto 30:d5c18e268866 134 * @param length number of line to write
Kazuki Yamamoto 30:d5c18e268866 135 * @param *data pointer to data
Kazuki Yamamoto 30:d5c18e268866 136 */
Kazuki Yamamoto 30:d5c18e268866 137 void directUpdateMulti(int startline, int length, uint8_t *data);
k4zuki 0:b3c8fdd01601 138
Kazuki Yamamoto 30:d5c18e268866 139 /** Inverting internal COM signal
Kazuki Yamamoto 30:d5c18e268866 140 */
Kazuki Yamamoto 30:d5c18e268866 141 void cominvert();
k4zuki 10:eed99ef09e63 142
Kazuki Yamamoto 30:d5c18e268866 143 /** Reads single line (400 bits = 50 bytes) from a screen and writes into
Kazuki Yamamoto 30:d5c18e268866 144 * buffer
Kazuki Yamamoto 30:d5c18e268866 145 * @param line line number(1-240)
Kazuki Yamamoto 30:d5c18e268866 146 * @param buffer pointer to buffer(50 bytes)
Kazuki Yamamoto 30:d5c18e268866 147 * @param screen screen to read from(0 or 1)
Kazuki Yamamoto 30:d5c18e268866 148 */
Kazuki Yamamoto 30:d5c18e268866 149 void ramReadSingleLine(int line, uint8_t *buffer, int screen);
k4zuki 10:eed99ef09e63 150
Kazuki Yamamoto 30:d5c18e268866 151 /** Reads multi lines(400 x N bits = 50 x N bytes) from a screen
Kazuki Yamamoto 30:d5c18e268866 152 * @param startline starting line number(1-240)
Kazuki Yamamoto 30:d5c18e268866 153 * @param length number of line to read
Kazuki Yamamoto 30:d5c18e268866 154 * @param *buffer pointer to buffer
Kazuki Yamamoto 30:d5c18e268866 155 * @param screen screen to read from(0 or 1)
Kazuki Yamamoto 30:d5c18e268866 156 */
Kazuki Yamamoto 30:d5c18e268866 157 void ramReadMultiLine(int startline, int length, uint8_t *buffer, int screen);
k4zuki 4:844693a617dc 158
Kazuki Yamamoto 30:d5c18e268866 159 /** Writes single line (400 bits = 50 bytes) into a screen
Kazuki Yamamoto 30:d5c18e268866 160 * @param line line number(1-240)
Kazuki Yamamoto 30:d5c18e268866 161 * @param *data pointer to data to write(50 bytes)
Kazuki Yamamoto 30:d5c18e268866 162 * @param screen screen to read from(0 or 1)
Kazuki Yamamoto 30:d5c18e268866 163 */
Kazuki Yamamoto 30:d5c18e268866 164 void ramWriteSingleLine(int line, uint8_t *data, int screen);
Kazuki Yamamoto 30:d5c18e268866 165
Kazuki Yamamoto 30:d5c18e268866 166 /** Writes multi lines(400 x N bits = 50 x N bytes) into a screen
Kazuki Yamamoto 30:d5c18e268866 167 * @param startline starting line number(1-240)
Kazuki Yamamoto 30:d5c18e268866 168 * @param length number of line to read
Kazuki Yamamoto 30:d5c18e268866 169 * @param *data pointer to data to write
Kazuki Yamamoto 30:d5c18e268866 170 * @param screen screen to read from(0 or 1)
Kazuki Yamamoto 30:d5c18e268866 171 */
Kazuki Yamamoto 30:d5c18e268866 172 void ramWriteMultiLine(int startline, int length, uint8_t *data, int screen);
k4zuki 10:eed99ef09e63 173
Kazuki Yamamoto 30:d5c18e268866 174 /** copies whole data in screen into LCD
Kazuki Yamamoto 30:d5c18e268866 175 * @param startline starting line number(1-240)
Kazuki Yamamoto 30:d5c18e268866 176 * @param length number of line to read
Kazuki Yamamoto 30:d5c18e268866 177 * @param screen screen to copy (0 or 1)
Kazuki Yamamoto 30:d5c18e268866 178 */
Kazuki Yamamoto 30:d5c18e268866 179 void ram2lcd(int startline, int length, int screen);
k4zuki 0:b3c8fdd01601 180
Kazuki Yamamoto 30:d5c18e268866 181 /** copies whole data in screen into LCD
Kazuki Yamamoto 30:d5c18e268866 182 * @param screen screen to copy (0 or 1)
Kazuki Yamamoto 30:d5c18e268866 183 */
Kazuki Yamamoto 30:d5c18e268866 184 void ram2lcd(int screen);
k4zuki 16:fa277cbcc890 185
Kazuki Yamamoto 30:d5c18e268866 186 /** read a byte from SRAM (copied from Ser23K256)
Kazuki Yamamoto 30:d5c18e268866 187 * @param address The address to read from
Kazuki Yamamoto 30:d5c18e268866 188 * @return the character at that address
Kazuki Yamamoto 30:d5c18e268866 189 */
Kazuki Yamamoto 30:d5c18e268866 190 uint8_t ram_read(int address);
k4zuki 14:812873f3a933 191
Kazuki Yamamoto 30:d5c18e268866 192 /** read multiple bytes from SRAM into a buffer (copied from Ser23K256)
Kazuki Yamamoto 30:d5c18e268866 193 * @param address The SRAM address to read from
Kazuki Yamamoto 30:d5c18e268866 194 * @param buffer The buffer to read into (must be big enough!)
Kazuki Yamamoto 30:d5c18e268866 195 * @param count The number of bytes to read
Kazuki Yamamoto 30:d5c18e268866 196 */
Kazuki Yamamoto 30:d5c18e268866 197 void ram_read(int address, uint8_t *buffer, int count);
k4zuki 14:812873f3a933 198
Kazuki Yamamoto 30:d5c18e268866 199 /** write a byte to SRAM (copied from Ser23K256)
Kazuki Yamamoto 30:d5c18e268866 200 * @param address The SRAM address to write to
Kazuki Yamamoto 30:d5c18e268866 201 * @param byte The byte to write there
Kazuki Yamamoto 30:d5c18e268866 202 */
Kazuki Yamamoto 30:d5c18e268866 203 void ram_write(int address, uint8_t byte);
k4zuki 14:812873f3a933 204
Kazuki Yamamoto 30:d5c18e268866 205 /** write multiple bytes to SRAM from a buffer (copied from Ser23K256)
Kazuki Yamamoto 30:d5c18e268866 206 * @param address The SRAM address write to
Kazuki Yamamoto 30:d5c18e268866 207 * @param buffer The buffer to write from
Kazuki Yamamoto 30:d5c18e268866 208 * @param count The number of bytes to write
Kazuki Yamamoto 30:d5c18e268866 209 */
Kazuki Yamamoto 30:d5c18e268866 210 void ram_write(int address, uint8_t *buffer, int count);
k4zuki 9:33d5888d1fb9 211
k4zuki 0:b3c8fdd01601 212 private:
Kazuki Yamamoto 30:d5c18e268866 213 // Ser23K256 _ram;
k4zuki 14:812873f3a933 214
Kazuki Yamamoto 30:d5c18e268866 215 enum MODE { BYTE_MODE = 0x00, SEQUENTIAL_MODE = 0x40 };
k4zuki 14:812873f3a933 216
Kazuki Yamamoto 30:d5c18e268866 217 enum COMMAND {
Kazuki Yamamoto 30:d5c18e268866 218 READ = 0x03,
Kazuki Yamamoto 30:d5c18e268866 219 WRITE = 0x02,
Kazuki Yamamoto 30:d5c18e268866 220 READ_STATUS = 0x05, // called RDSR in datasheet
Kazuki Yamamoto 30:d5c18e268866 221 WRITE_STATUS = 0x01 // called WRSR in datasheet
Kazuki Yamamoto 30:d5c18e268866 222 };
k4zuki 14:812873f3a933 223
Kazuki Yamamoto 30:d5c18e268866 224 int _comflag;
Kazuki Yamamoto 30:d5c18e268866 225 int _modeflag;
Kazuki Yamamoto 30:d5c18e268866 226 int _clearflag;
Kazuki Yamamoto 30:d5c18e268866 227 SPI _spi;
Kazuki Yamamoto 30:d5c18e268866 228 DigitalOut _csl;
Kazuki Yamamoto 30:d5c18e268866 229 DigitalOut _csr;
k4zuki 9:33d5888d1fb9 230
Kazuki Yamamoto 30:d5c18e268866 231 void _cls_ram(int address);
Kazuki Yamamoto 30:d5c18e268866 232 uint8_t ram_readStatus();
Kazuki Yamamoto 30:d5c18e268866 233 void _ram_writeStatus(uint8_t status);
Kazuki Yamamoto 30:d5c18e268866 234 void _ram_prepareCommand(uint8_t command, int address);
Kazuki Yamamoto 30:d5c18e268866 235 void _ram_select();
Kazuki Yamamoto 30:d5c18e268866 236 void _ram_deselect();
k4zuki 0:b3c8fdd01601 237 };
k4zuki 0:b3c8fdd01601 238 #endif