Stepan Smejkal / UniGraphic

.

Display/LCD.h@15:b9483ba842c8, 2015-02-23 (annotated)

Committer:
Geremia
Date:
Mon Feb 23 16:05:16 2015 +0000
Revision:
15:b9483ba842c8
Parent:
10:668cf78ff93a
Child:
20:14daa48ffd4c
LCD macro undef workaround for KL46Z KL43Z, thanks ban4jp

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Geremia 0:75ec1b3cde17 1
Geremia 0:75ec1b3cde17 2 #ifndef MBED_LCD_H
Geremia 0:75ec1b3cde17 3 #define MBED_LCD_H
Geremia 0:75ec1b3cde17 4
Geremia 0:75ec1b3cde17 5 #include "GraphicsDisplay.h"
Geremia 0:75ec1b3cde17 6 #include "PAR8.h"
Geremia 0:75ec1b3cde17 7 #include "SPI8.h"
Geremia 1:ff019d22b275 8 #include "SPI16.h"
Geremia 0:75ec1b3cde17 9 #include "Protocols.h"
Geremia 0:75ec1b3cde17 10
Geremia 15:b9483ba842c8 11 // undefine the KL43Z and KL46Z LCD macro
Geremia 15:b9483ba842c8 12 #ifdef LCD
Geremia 15:b9483ba842c8 13 #undef LCD
Geremia 15:b9483ba842c8 14 #endif
Geremia 1:ff019d22b275 15
Geremia 0:75ec1b3cde17 16 /** Draw mode
Geremia 0:75ec1b3cde17 17 * NORMAl
Geremia 0:75ec1b3cde17 18 * XOR set pixel by xor the screen
Geremia 0:75ec1b3cde17 19 */
Geremia 0:75ec1b3cde17 20 enum {NORMAL,XOR};
Geremia 0:75ec1b3cde17 21
Geremia 0:75ec1b3cde17 22 /** Mirror mode */
Geremia 0:75ec1b3cde17 23 enum mirror_t {X,Y,XY,NONE};
Geremia 0:75ec1b3cde17 24
Geremia 0:75ec1b3cde17 25
Geremia 0:75ec1b3cde17 26 /** A common base class for monochrome Display
Geremia 0:75ec1b3cde17 27 */
Geremia 0:75ec1b3cde17 28 class LCD : public GraphicsDisplay
Geremia 0:75ec1b3cde17 29 {
Geremia 0:75ec1b3cde17 30
Geremia 0:75ec1b3cde17 31 public:
Geremia 0:75ec1b3cde17 32
Geremia 0:75ec1b3cde17 33 /** Create a monochrome LCD Parallel interface
Geremia 0:75ec1b3cde17 34 * @param name The name used by the parent class to access the interface
Geremia 0:75ec1b3cde17 35 */
Geremia 0:75ec1b3cde17 36 LCD(proto_t displayproto,PortName port, PinName CS, PinName reset, PinName DC, PinName WR, PinName RD, const int lcdsize_x, const int lcdsize_y, const int ic_x_segs, const int ic_y_coms, const char* name);
Geremia 0:75ec1b3cde17 37
Geremia 0:75ec1b3cde17 38 /** Create a monochrome LCD SPI interface
Geremia 0:75ec1b3cde17 39 * @param name The name used by the parent class to access the interface
Geremia 0:75ec1b3cde17 40 */
Geremia 1:ff019d22b275 41 LCD(proto_t displayproto, int Hz, PinName mosi, PinName miso, PinName sclk, PinName CS, PinName reset, PinName DC, const int lcdsize_x, const int lcdsize_y, const int ic_x_segs, const int ic_y_coms, const char* name);
Geremia 0:75ec1b3cde17 42
Geremia 0:75ec1b3cde17 43 /** Destructor
Geremia 0:75ec1b3cde17 44 * will free framebuffer
Geremia 0:75ec1b3cde17 45 */
Geremia 0:75ec1b3cde17 46 virtual ~LCD();
Geremia 0:75ec1b3cde17 47
Geremia 0:75ec1b3cde17 48
Geremia 0:75ec1b3cde17 49
Geremia 0:75ec1b3cde17 50 /////// functions that come for free, but can be overwritten///////////////////////////////////////////////////
Geremia 0:75ec1b3cde17 51 /////// ----------------------------------------------------///////////////////////////////////////////////////
Geremia 0:75ec1b3cde17 52
Geremia 0:75ec1b3cde17 53 /** Draw a pixel in the specified color.
Geremia 0:75ec1b3cde17 54 * @param x is the horizontal offset to this pixel.
Geremia 0:75ec1b3cde17 55 * @param y is the vertical offset to this pixel.
Geremia 0:75ec1b3cde17 56 * @param color defines the color for the pixel.
Geremia 0:75ec1b3cde17 57 */
Geremia 0:75ec1b3cde17 58 virtual void pixel(int x, int y, unsigned short color);
Geremia 0:75ec1b3cde17 59
Geremia 0:75ec1b3cde17 60 /** Set the window, which controls where items are written to the screen.
Geremia 0:75ec1b3cde17 61 * When something hits the window width, it wraps back to the left side
Geremia 0:75ec1b3cde17 62 * and down a row. If the initial write is outside the window, it will
Geremia 0:75ec1b3cde17 63 * be captured into the window when it crosses a boundary.
Geremia 0:75ec1b3cde17 64 * @param x is the left edge in pixels.
Geremia 0:75ec1b3cde17 65 * @param y is the top edge in pixels.
Geremia 0:75ec1b3cde17 66 * @param w is the window width in pixels.
Geremia 0:75ec1b3cde17 67 * @param h is the window height in pixels.
Geremia 0:75ec1b3cde17 68 */
Geremia 0:75ec1b3cde17 69 virtual void window(int x, int y, int w, int h);
Geremia 7:bb0383b91104 70
Geremia 7:bb0383b91104 71
Geremia 0:75ec1b3cde17 72
Geremia 0:75ec1b3cde17 73 /** Push a single pixel into the window and increment position.
Geremia 0:75ec1b3cde17 74 * You must first call window() then push pixels in loop.
Geremia 0:75ec1b3cde17 75 * @param color is the pixel color.
Geremia 0:75ec1b3cde17 76 */
Geremia 0:75ec1b3cde17 77 virtual void window_pushpixel(unsigned short color);
Geremia 2:713844a55c4e 78
Geremia 2:713844a55c4e 79 /** Push some pixels of the same color into the window and increment position.
Geremia 2:713844a55c4e 80 * You must first call window() then push pixels.
Geremia 2:713844a55c4e 81 * @param color is the pixel color.
Geremia 2:713844a55c4e 82 * @param count: how many
Geremia 2:713844a55c4e 83 */
Geremia 2:713844a55c4e 84 virtual void window_pushpixel(unsigned short color, unsigned int count);
Geremia 2:713844a55c4e 85
Geremia 2:713844a55c4e 86 /** Push array of pixel colors into the window and increment position.
Geremia 2:713844a55c4e 87 * You must first call window() then push pixels.
Geremia 2:713844a55c4e 88 * @param color is the pixel color.
Geremia 2:713844a55c4e 89 */
Geremia 2:713844a55c4e 90 virtual void window_pushpixelbuf(unsigned short* color, unsigned int lenght);
Geremia 0:75ec1b3cde17 91
Geremia 0:75ec1b3cde17 92 /** Framebuffer is used, it needs to be sent to LCD from time to time
Geremia 0:75ec1b3cde17 93 */
Geremia 0:75ec1b3cde17 94 virtual void copy_to_lcd();
Geremia 0:75ec1b3cde17 95
Geremia 0:75ec1b3cde17 96 /** set the contrast of the screen
Geremia 0:75ec1b3cde17 97 *
Geremia 0:75ec1b3cde17 98 * @param o contrast 0-63
Geremia 0:75ec1b3cde17 99 * @note may be overrided in case of not standard command
Geremia 0:75ec1b3cde17 100 */
Geremia 0:75ec1b3cde17 101 virtual void set_contrast(int o);
Geremia 0:75ec1b3cde17 102
Geremia 0:75ec1b3cde17 103 /** read the contrast level
Geremia 0:75ec1b3cde17 104 *
Geremia 0:75ec1b3cde17 105 */
Geremia 0:75ec1b3cde17 106 int get_contrast(void);
Geremia 0:75ec1b3cde17 107
Geremia 7:bb0383b91104 108 /** display inverted colors
Geremia 0:75ec1b3cde17 109 *
Geremia 0:75ec1b3cde17 110 * @param o = 0 normal, 1 invert
Geremia 0:75ec1b3cde17 111 */
Geremia 0:75ec1b3cde17 112 void invert(unsigned char o);
Geremia 0:75ec1b3cde17 113
Geremia 0:75ec1b3cde17 114 /** clear the entire screen
Geremia 0:75ec1b3cde17 115 * The inherited one sets windomax then fill with background color
Geremia 0:75ec1b3cde17 116 * We override it to speedup
Geremia 0:75ec1b3cde17 117 */
Geremia 0:75ec1b3cde17 118 virtual void cls();
Geremia 0:75ec1b3cde17 119
Geremia 0:75ec1b3cde17 120 /** Set the orientation of the screen
Geremia 0:75ec1b3cde17 121 * x,y: 0,0 is always top left
Geremia 0:75ec1b3cde17 122 *
Geremia 0:75ec1b3cde17 123 * @param o direction to use the screen (0-3)
Geremia 0:75ec1b3cde17 124 * 0 = -90°
Geremia 0:75ec1b3cde17 125 * 1 = default 0°
Geremia 0:75ec1b3cde17 126 * 2 = +90°
Geremia 0:75ec1b3cde17 127 * 3 = +180°
Geremia 0:75ec1b3cde17 128 *
Geremia 0:75ec1b3cde17 129 */
Geremia 0:75ec1b3cde17 130 void set_orientation(int o);
Geremia 0:75ec1b3cde17 131
Geremia 0:75ec1b3cde17 132 /** Set ChipSelect high or low
Geremia 0:75ec1b3cde17 133 * @param enable 0/1
Geremia 0:75ec1b3cde17 134 */
Geremia 0:75ec1b3cde17 135 virtual void BusEnable(bool enable);
Geremia 0:75ec1b3cde17 136
Geremia 7:bb0383b91104 137 /** get display X size in pixels (native, orientation independent)
Geremia 7:bb0383b91104 138 * @returns X size in pixels
Geremia 7:bb0383b91104 139 */
Geremia 7:bb0383b91104 140 int sizeX();
Geremia 7:bb0383b91104 141
Geremia 7:bb0383b91104 142 /** get display X size in pixels (native, orientation independent)
Geremia 7:bb0383b91104 143 * @returns screen height in pixels.
Geremia 7:bb0383b91104 144 */
Geremia 7:bb0383b91104 145 int sizeY();
Geremia 7:bb0383b91104 146
Geremia 7:bb0383b91104 147 ////////////////////////////////////////////////////////////////////////////////
Geremia 7:bb0383b91104 148 // not implemented yet
Geremia 7:bb0383b91104 149 //////////////////////////////////////////////////////////////////
Geremia 7:bb0383b91104 150 virtual unsigned short pixelread(int x, int y){return 0;};
Geremia 7:bb0383b91104 151 virtual void window4read(int x, int y, int w, int h){};
Geremia 7:bb0383b91104 152 void setscrollarea (int startY, int areasize){};
Geremia 7:bb0383b91104 153 void scroll (int lines){};
Geremia 7:bb0383b91104 154 void scrollreset(){};
Geremia 10:668cf78ff93a 155 void FastWindow(bool enable){};
Geremia 7:bb0383b91104 156
Geremia 7:bb0383b91104 157 unsigned int tftID;
Geremia 7:bb0383b91104 158
Geremia 7:bb0383b91104 159
Geremia 7:bb0383b91104 160
Geremia 0:75ec1b3cde17 161
Geremia 0:75ec1b3cde17 162 protected:
Geremia 0:75ec1b3cde17 163
Geremia 0:75ec1b3cde17 164 /** set mirror mode
Geremia 0:75ec1b3cde17 165 * @note may be overridden by specific display init class in case of not standard cmds or inverted wiring
Geremia 0:75ec1b3cde17 166 * @param mode NONE, X, Y, XY
Geremia 0:75ec1b3cde17 167 */
Geremia 0:75ec1b3cde17 168 virtual void mirrorXY(mirror_t mode);
Geremia 0:75ec1b3cde17 169
Geremia 0:75ec1b3cde17 170 ////// functions needed by parent class ///////////////////////////////////////
Geremia 0:75ec1b3cde17 171 ////// -------------------------------- ///////////////////////////////////////
Geremia 0:75ec1b3cde17 172
Geremia 1:ff019d22b275 173 /** Send 8bit command to display controller
Geremia 1:ff019d22b275 174 *
Geremia 1:ff019d22b275 175 * @param cmd: byte to send
Geremia 1:ff019d22b275 176 * @note if protocol is SPI16, it will insert NOP cmd before, so if cmd is a 2byte cmd, the second cmd will be broken. Use wr_cmd16 for 2bytes cmds
Geremia 1:ff019d22b275 177 */
Geremia 1:ff019d22b275 178 void wr_cmd8(unsigned char cmd);
Geremia 0:75ec1b3cde17 179
Geremia 1:ff019d22b275 180 /** Send 8bit data to display controller
Geremia 1:ff019d22b275 181 *
Geremia 1:ff019d22b275 182 * @param data: byte to send
Geremia 1:ff019d22b275 183 *
Geremia 1:ff019d22b275 184 */
Geremia 1:ff019d22b275 185 void wr_data8(unsigned char data);
Geremia 0:75ec1b3cde17 186
Geremia 1:ff019d22b275 187 /** Send 16bit command to display controller
Geremia 1:ff019d22b275 188 *
Geremia 1:ff019d22b275 189 * @param cmd: halfword to send
Geremia 1:ff019d22b275 190 *
Geremia 1:ff019d22b275 191 */
Geremia 1:ff019d22b275 192 void wr_cmd16(unsigned short cmd);
Geremia 1:ff019d22b275 193
Geremia 4:12ba0ecc2c1f 194 /** Send same 16bit pixeldata to display controller multiple times
Geremia 1:ff019d22b275 195 *
Geremia 1:ff019d22b275 196 * @param data: halfword to send
Geremia 1:ff019d22b275 197 * @param count: how many
Geremia 1:ff019d22b275 198 *
Geremia 1:ff019d22b275 199 */
Geremia 4:12ba0ecc2c1f 200 virtual void wr_gram(unsigned short data, unsigned int count);
Geremia 1:ff019d22b275 201
Geremia 4:12ba0ecc2c1f 202 /** Send array of pixeldata shorts to display controller
Geremia 1:ff019d22b275 203 *
Geremia 4:12ba0ecc2c1f 204 * @param data: unsigned short pixeldata array
Geremia 1:ff019d22b275 205 * @param lenght: lenght (in shorts)
Geremia 1:ff019d22b275 206 *
Geremia 1:ff019d22b275 207 */
Geremia 4:12ba0ecc2c1f 208 virtual void wr_grambuf(unsigned short* data, unsigned int lenght);
Geremia 0:75ec1b3cde17 209
Geremia 0:75ec1b3cde17 210 /** HW reset sequence (without display init commands)
Geremia 0:75ec1b3cde17 211 */
Geremia 0:75ec1b3cde17 212 void hw_reset();
Geremia 0:75ec1b3cde17 213
Geremia 0:75ec1b3cde17 214 int draw_mode;
Geremia 0:75ec1b3cde17 215 int contrast;
Geremia 0:75ec1b3cde17 216
Geremia 0:75ec1b3cde17 217 private:
Geremia 0:75ec1b3cde17 218
Geremia 2:713844a55c4e 219 Protocols* proto;
Geremia 0:75ec1b3cde17 220 unsigned char *buffer;
Geremia 1:ff019d22b275 221 unsigned short *buffer16;
Geremia 7:bb0383b91104 222 const int screensize_X;
Geremia 7:bb0383b91104 223 const int screensize_Y;
Geremia 7:bb0383b91104 224 const int _LCDPAGES;
Geremia 7:bb0383b91104 225 const int _IC_X_SEGS;
Geremia 7:bb0383b91104 226 const int _IC_Y_COMS;
Geremia 7:bb0383b91104 227 const int _IC_PAGES;
Geremia 0:75ec1b3cde17 228
Geremia 0:75ec1b3cde17 229 int page_offset;
Geremia 0:75ec1b3cde17 230 int col_offset;
Geremia 0:75ec1b3cde17 231 // pixel location
Geremia 0:75ec1b3cde17 232 int cur_x;
Geremia 0:75ec1b3cde17 233 int cur_y;
Geremia 0:75ec1b3cde17 234 // window location
Geremia 0:75ec1b3cde17 235 int win_x1;
Geremia 0:75ec1b3cde17 236 int win_x2;
Geremia 0:75ec1b3cde17 237 int win_y1;
Geremia 0:75ec1b3cde17 238 int win_y2;
Geremia 0:75ec1b3cde17 239 int orientation;
Geremia 1:ff019d22b275 240 bool useNOP;
Geremia 0:75ec1b3cde17 241 };
Geremia 0:75ec1b3cde17 242
Geremia 0:75ec1b3cde17 243 #endif