Stepan Smejkal / UniGraphic

.

Display/LCD.h@27:acb2594b8aa4, 2015-10-26 (annotated)

Committer:
dreschpe
Date:
Mon Oct 26 12:49:02 2015 +0000
Revision:
27:acb2594b8aa4
Parent:
25:daacdcf34e52
Child:
33:f87f06292637
fix handling of PAR8 / PAR16 includes

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