2 * Generic FB driver for TFT LCD displays
4 * Copyright (C) 2013 Noralf Tronnes
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
17 #include <linux/module.h>
18 #include <linux/kernel.h>
19 #include <linux/init.h>
20 #include <linux/vmalloc.h>
21 #include <linux/gpio.h>
22 #include <linux/spi/spi.h>
23 #include <linux/delay.h>
27 #define DRVNAME "flexfb"
30 module_param(chip, charp, 0);
31 MODULE_PARM_DESC(chip, "LCD controller");
33 static unsigned int width;
34 module_param(width, uint, 0);
35 MODULE_PARM_DESC(width, "Display width");
37 static unsigned int height;
38 module_param(height, uint, 0);
39 MODULE_PARM_DESC(height, "Display height");
43 module_param_array(init, int, &init_num, 0);
44 MODULE_PARM_DESC(init, "Init sequence");
46 static unsigned int setaddrwin;
47 module_param(setaddrwin, uint, 0);
48 MODULE_PARM_DESC(setaddrwin, "Which set_addr_win() implementation to use");
50 static unsigned int buswidth = 8;
51 module_param(buswidth, uint, 0);
52 MODULE_PARM_DESC(buswidth, "Width of databus (default: 8)");
54 static unsigned int regwidth = 8;
55 module_param(regwidth, uint, 0);
56 MODULE_PARM_DESC(regwidth, "Width of controller register (default: 8)");
58 static bool nobacklight;
59 module_param(nobacklight, bool, 0);
60 MODULE_PARM_DESC(nobacklight, "Turn off backlight functionality.");
63 module_param(latched, bool, 0);
64 MODULE_PARM_DESC(latched, "Use with latched 16-bit databus");
69 /* default init sequences */
70 static int st7735r_init[] = {
71 -1, 0x01, -2, 150, -1, 0x11, -2, 500, -1, 0xB1, 0x01, 0x2C, 0x2D, -1, 0xB2, 0x01, 0x2C, 0x2D, -1, 0xB3, 0x01, 0x2C, 0x2D, 0x01, 0x2C, 0x2D,
72 -1, 0xB4, 0x07, -1, 0xC0, 0xA2, 0x02, 0x84, -1, 0xC1, 0xC5, -1, 0xC2, 0x0A, 0x00, -1, 0xC3, 0x8A, 0x2A, -1, 0xC4, 0x8A, 0xEE, -1, 0xC5, 0x0E,
73 -1, 0x20, -1, 0x36, 0xC0, -1, 0x3A, 0x05, -1, 0xE0, 0x0f, 0x1a, 0x0f, 0x18, 0x2f, 0x28, 0x20, 0x22, 0x1f, 0x1b, 0x23, 0x37, 0x00, 0x07, 0x02, 0x10,
74 -1, 0xE1, 0x0f, 0x1b, 0x0f, 0x17, 0x33, 0x2c, 0x29, 0x2e, 0x30, 0x30, 0x39, 0x3f, 0x00, 0x07, 0x03, 0x10, -1, 0x29, -2, 100, -1, 0x13, -2, 10, -3 };
76 static int ssd1289_init[] = {
77 -1, 0x00, 0x0001, -1, 0x03, 0xA8A4, -1, 0x0C, 0x0000, -1, 0x0D, 0x080C, -1, 0x0E, 0x2B00, -1, 0x1E, 0x00B7, -1, 0x01, 0x2B3F, -1, 0x02, 0x0600,
78 -1, 0x10, 0x0000, -1, 0x11, 0x6070, -1, 0x05, 0x0000, -1, 0x06, 0x0000, -1, 0x16, 0xEF1C, -1, 0x17, 0x0003, -1, 0x07, 0x0233, -1, 0x0B, 0x0000,
79 -1, 0x0F, 0x0000, -1, 0x41, 0x0000, -1, 0x42, 0x0000, -1, 0x48, 0x0000, -1, 0x49, 0x013F, -1, 0x4A, 0x0000, -1, 0x4B, 0x0000, -1, 0x44, 0xEF00,
80 -1, 0x45, 0x0000, -1, 0x46, 0x013F, -1, 0x30, 0x0707, -1, 0x31, 0x0204, -1, 0x32, 0x0204, -1, 0x33, 0x0502, -1, 0x34, 0x0507, -1, 0x35, 0x0204,
81 -1, 0x36, 0x0204, -1, 0x37, 0x0502, -1, 0x3A, 0x0302, -1, 0x3B, 0x0302, -1, 0x23, 0x0000, -1, 0x24, 0x0000, -1, 0x25, 0x8000, -1, 0x4f, 0x0000,
82 -1, 0x4e, 0x0000, -1, 0x22, -3 };
84 static int hx8340bn_init[] = {
85 -1, 0xC1, 0xFF, 0x83, 0x40, -1, 0x11, -2, 150, -1, 0xCA, 0x70, 0x00, 0xD9, -1, 0xB0, 0x01, 0x11,
86 -1, 0xC9, 0x90, 0x49, 0x10, 0x28, 0x28, 0x10, 0x00, 0x06, -2, 20, -1, 0xC2, 0x60, 0x71, 0x01, 0x0E, 0x05, 0x02, 0x09, 0x31, 0x0A,
87 -1, 0xC3, 0x67, 0x30, 0x61, 0x17, 0x48, 0x07, 0x05, 0x33, -2, 10, -1, 0xB5, 0x35, 0x20, 0x45, -1, 0xB4, 0x33, 0x25, 0x4C, -2, 10,
88 -1, 0x3A, 0x05, -1, 0x29, -2, 10, -3 };
90 static int ili9225_init[] = {
91 -1, 0x0001, 0x011C, -1, 0x0002, 0x0100, -1, 0x0003, 0x1030, -1, 0x0008, 0x0808, -1, 0x000C, 0x0000, -1, 0x000F, 0x0A01, -1, 0x0020, 0x0000,
92 -1, 0x0021, 0x0000, -2, 50, -1, 0x0010, 0x0A00, -1, 0x0011, 0x1038, -2, 50, -1, 0x0012, 0x1121, -1, 0x0013, 0x004E, -1, 0x0014, 0x676F,
93 -1, 0x0030, 0x0000, -1, 0x0031, 0x00DB, -1, 0x0032, 0x0000, -1, 0x0033, 0x0000, -1, 0x0034, 0x00DB, -1, 0x0035, 0x0000, -1, 0x0036, 0x00AF,
94 -1, 0x0037, 0x0000, -1, 0x0038, 0x00DB, -1, 0x0039, 0x0000, -1, 0x0050, 0x0000, -1, 0x0051, 0x060A, -1, 0x0052, 0x0D0A, -1, 0x0053, 0x0303,
95 -1, 0x0054, 0x0A0D, -1, 0x0055, 0x0A06, -1, 0x0056, 0x0000, -1, 0x0057, 0x0303, -1, 0x0058, 0x0000, -1, 0x0059, 0x0000, -2, 50,
96 -1, 0x0007, 0x1017, -2, 50, -3 };
98 static int ili9320_init[] = {
99 -1, 0x00E5, 0x8000, -1, 0x0000, 0x0001, -1, 0x0001, 0x0100, -1, 0x0002, 0x0700, -1, 0x0003, 0x1030, -1, 0x0004, 0x0000, -1, 0x0008, 0x0202,
100 -1, 0x0009, 0x0000, -1, 0x000A, 0x0000, -1, 0x000C, 0x0000, -1, 0x000D, 0x0000, -1, 0x000F, 0x0000, -1, 0x0010, 0x0000, -1, 0x0011, 0x0007,
101 -1, 0x0012, 0x0000, -1, 0x0013, 0x0000, -2, 200, -1, 0x0010, 0x17B0, -1, 0x0011, 0x0031, -2, 50, -1, 0x0012, 0x0138, -2, 50, -1, 0x0013, 0x1800,
102 -1, 0x0029, 0x0008, -2, 50, -1, 0x0020, 0x0000, -1, 0x0021, 0x0000, -1, 0x0030, 0x0000, -1, 0x0031, 0x0505, -1, 0x0032, 0x0004,
103 -1, 0x0035, 0x0006, -1, 0x0036, 0x0707, -1, 0x0037, 0x0105, -1, 0x0038, 0x0002, -1, 0x0039, 0x0707, -1, 0x003C, 0x0704, -1, 0x003D, 0x0807,
104 -1, 0x0050, 0x0000, -1, 0x0051, 0x00EF, -1, 0x0052, 0x0000, -1, 0x0053, 0x013F, -1, 0x0060, 0x2700, -1, 0x0061, 0x0001, -1, 0x006A, 0x0000,
105 -1, 0x0080, 0x0000, -1, 0x0081, 0x0000, -1, 0x0082, 0x0000, -1, 0x0083, 0x0000, -1, 0x0084, 0x0000, -1, 0x0085, 0x0000, -1, 0x0090, 0x0010,
106 -1, 0x0092, 0x0000, -1, 0x0093, 0x0003, -1, 0x0095, 0x0110, -1, 0x0097, 0x0000, -1, 0x0098, 0x0000, -1, 0x0007, 0x0173, -3 };
108 static int ili9325_init[] = {
109 -1, 0x00E3, 0x3008, -1, 0x00E7, 0x0012, -1, 0x00EF, 0x1231, -1, 0x0001, 0x0100, -1, 0x0002, 0x0700, -1, 0x0003, 0x1030, -1, 0x0004, 0x0000,
110 -1, 0x0008, 0x0207, -1, 0x0009, 0x0000, -1, 0x000A, 0x0000, -1, 0x000C, 0x0000, -1, 0x000D, 0x0000, -1, 0x000F, 0x0000, -1, 0x0010, 0x0000,
111 -1, 0x0011, 0x0007, -1, 0x0012, 0x0000, -1, 0x0013, 0x0000, -2, 200, -1, 0x0010, 0x1690, -1, 0x0011, 0x0223, -2, 50, -1, 0x0012, 0x000D, -2, 50,
112 -1, 0x0013, 0x1200, -1, 0x0029, 0x000A, -1, 0x002B, 0x000C, -2, 50, -1, 0x0020, 0x0000, -1, 0x0021, 0x0000, -1, 0x0030, 0x0000,
113 -1, 0x0031, 0x0506, -1, 0x0032, 0x0104, -1, 0x0035, 0x0207, -1, 0x0036, 0x000F, -1, 0x0037, 0x0306, -1, 0x0038, 0x0102, -1, 0x0039, 0x0707,
114 -1, 0x003C, 0x0702, -1, 0x003D, 0x1604, -1, 0x0050, 0x0000, -1, 0x0051, 0x00EF, -1, 0x0052, 0x0000, -1, 0x0053, 0x013F, -1, 0x0060, 0xA700,
115 -1, 0x0061, 0x0001, -1, 0x006A, 0x0000, -1, 0x0080, 0x0000, -1, 0x0081, 0x0000, -1, 0x0082, 0x0000, -1, 0x0083, 0x0000, -1, 0x0084, 0x0000,
116 -1, 0x0085, 0x0000, -1, 0x0090, 0x0010, -1, 0x0092, 0x0600, -1, 0x0007, 0x0133, -3 };
118 static int ili9341_init[] = {
119 -1, 0x28, -2, 20, -1, 0xCF, 0x00, 0x83, 0x30, -1, 0xED, 0x64, 0x03, 0x12, 0x81, -1, 0xE8, 0x85, 0x01, 0x79,
120 -1, 0xCB, 0x39, 0x2c, 0x00, 0x34, 0x02, -1, 0xF7, 0x20, -1, 0xEA, 0x00, 0x00, -1, 0xC0, 0x26, -1, 0xC1, 0x11,
121 -1, 0xC5, 0x35, 0x3E, -1, 0xC7, 0xBE, -1, 0xB1, 0x00, 0x1B, -1, 0xB6, 0x0a, 0x82, 0x27, 0x00, -1, 0xB7, 0x07,
122 -1, 0x3A, 0x55, -1, 0x36, 0x48, -1, 0x11, -2, 120, -1, 0x29, -2, 20, -3 };
124 static int ssd1351_init[] = { -1, 0xfd, 0x12, -1, 0xfd, 0xb1, -1, 0xae, -1, 0xb3, 0xf1, -1, 0xca, 0x7f, -1, 0xa0, 0x74,
125 -1, 0x15, 0x00, 0x7f, -1, 0x75, 0x00, 0x7f, -1, 0xa1, 0x00, -1, 0xa2, 0x00, -1, 0xb5, 0x00,
126 -1, 0xab, 0x01, -1, 0xb1, 0x32, -1, 0xb4, 0xa0, 0xb5, 0x55, -1, 0xbb, 0x17, -1, 0xbe, 0x05,
127 -1, 0xc1, 0xc8, 0x80, 0xc8, -1, 0xc7, 0x0f, -1, 0xb6, 0x01, -1, 0xa6, -1, 0xaf, -3 };
130 * struct flexfb_lcd_controller - Describes the LCD controller properties
131 * @name: Model name of the chip
132 * @width: Width of display in pixels
133 * @height: Height of display in pixels
134 * @setaddrwin: Which set_addr_win() implementation to use
135 * @regwidth: LCD Controller Register width in bits
136 * @init_seq: LCD initialization sequence
137 * @init_seq_sz: Size of LCD initialization sequence
139 struct flexfb_lcd_controller {
143 unsigned int setaddrwin;
144 unsigned int regwidth;
149 static const struct flexfb_lcd_controller flexfb_chip_table[] = {
154 .init_seq = st7735r_init,
155 .init_seq_sz = ARRAY_SIZE(st7735r_init),
161 .init_seq = hx8340bn_init,
162 .init_seq_sz = ARRAY_SIZE(hx8340bn_init),
169 .init_seq = ili9225_init,
170 .init_seq_sz = ARRAY_SIZE(ili9225_init),
177 .init_seq = ili9225_init,
178 .init_seq_sz = ARRAY_SIZE(ili9225_init),
185 .init_seq = ili9225_init,
186 .init_seq_sz = ARRAY_SIZE(ili9225_init),
194 .init_seq = ili9320_init,
195 .init_seq_sz = ARRAY_SIZE(ili9320_init),
203 .init_seq = ili9325_init,
204 .init_seq_sz = ARRAY_SIZE(ili9325_init),
210 .init_seq = ili9341_init,
211 .init_seq_sz = ARRAY_SIZE(ili9341_init),
219 .init_seq = ssd1289_init,
220 .init_seq_sz = ARRAY_SIZE(ssd1289_init),
227 .init_seq = ssd1351_init,
228 .init_seq_sz = ARRAY_SIZE(ssd1351_init),
232 /* ili9320, ili9325 */
233 static void flexfb_set_addr_win_1(struct fbtft_par *par,
234 int xs, int ys, int xe, int ye)
236 fbtft_par_dbg(DEBUG_SET_ADDR_WIN, par, "%s(xs=%d, ys=%d, xe=%d, ye=%d)\n",
237 __func__, xs, ys, xe, ye);
238 switch (par->info->var.rotate) {
239 /* R20h = Horizontal GRAM Start Address */
240 /* R21h = Vertical GRAM Start Address */
242 write_reg(par, 0x0020, xs);
243 write_reg(par, 0x0021, ys);
246 write_reg(par, 0x0020, width - 1 - xs);
247 write_reg(par, 0x0021, height - 1 - ys);
250 write_reg(par, 0x0020, width - 1 - ys);
251 write_reg(par, 0x0021, xs);
254 write_reg(par, 0x0020, ys);
255 write_reg(par, 0x0021, height - 1 - xs);
258 write_reg(par, 0x0022); /* Write Data to GRAM */
262 static void flexfb_set_addr_win_2(struct fbtft_par *par,
263 int xs, int ys, int xe, int ye)
265 fbtft_par_dbg(DEBUG_SET_ADDR_WIN, par,
266 "%s(xs=%d, ys=%d, xe=%d, ye=%d)\n",
267 __func__, xs, ys, xe, ye);
269 switch (par->info->var.rotate) {
270 /* R4Eh - Set GDDRAM X address counter */
271 /* R4Fh - Set GDDRAM Y address counter */
273 write_reg(par, 0x4e, xs);
274 write_reg(par, 0x4f, ys);
277 write_reg(par, 0x4e, par->info->var.xres - 1 - xs);
278 write_reg(par, 0x4f, par->info->var.yres - 1 - ys);
281 write_reg(par, 0x4e, par->info->var.yres - 1 - ys);
282 write_reg(par, 0x4f, xs);
285 write_reg(par, 0x4e, ys);
286 write_reg(par, 0x4f, par->info->var.xres - 1 - xs);
290 /* R22h - RAM data write */
291 write_reg(par, 0x22, 0);
295 static void set_addr_win_3(struct fbtft_par *par,
296 int xs, int ys, int xe, int ye)
298 fbtft_par_dbg(DEBUG_SET_ADDR_WIN, par,
299 "%s(xs=%d, ys=%d, xe=%d, ye=%d)\n", __func__,
302 write_reg(par, 0x15, xs, xe);
303 write_reg(par, 0x75, ys, ye);
304 write_reg(par, 0x5C);
307 static int flexfb_verify_gpios_dc(struct fbtft_par *par)
309 fbtft_par_dbg(DEBUG_VERIFY_GPIOS, par, "%s()\n", __func__);
311 if (par->gpio.dc < 0) {
312 dev_err(par->info->device,
313 "Missing info about 'dc' gpio. Aborting.\n");
320 static int flexfb_verify_gpios_db(struct fbtft_par *par)
323 int num_db = buswidth;
325 fbtft_par_dbg(DEBUG_VERIFY_GPIOS, par, "%s()\n", __func__);
327 if (par->gpio.dc < 0) {
328 dev_err(par->info->device, "Missing info about 'dc' gpio. Aborting.\n");
331 if (par->gpio.wr < 0) {
332 dev_err(par->info->device, "Missing info about 'wr' gpio. Aborting.\n");
335 if (latched && (par->gpio.latch < 0)) {
336 dev_err(par->info->device, "Missing info about 'latch' gpio. Aborting.\n");
340 num_db = buswidth / 2;
341 for (i = 0; i < num_db; i++) {
342 if (par->gpio.db[i] < 0) {
343 dev_err(par->info->device,
344 "Missing info about 'db%02d' gpio. Aborting.\n",
353 static void flexfb_chip_load_param(const struct flexfb_lcd_controller *chip)
358 height = chip->height;
359 setaddrwin = chip->setaddrwin;
361 regwidth = chip->regwidth;
363 initp = chip->init_seq;
364 initp_num = chip->init_seq_sz;
368 static struct fbtft_display flex_display = { };
370 static int flexfb_chip_init(const struct device *dev)
374 for (i = 0; i < ARRAY_SIZE(flexfb_chip_table); i++)
375 if (!strcmp(chip, flexfb_chip_table[i].name)) {
376 flexfb_chip_load_param(&flexfb_chip_table[i]);
380 dev_err(dev, "chip=%s is not supported\n", chip);
385 static int flexfb_probe_common(struct spi_device *sdev,
386 struct platform_device *pdev)
389 struct fb_info *info;
390 struct fbtft_par *par;
394 initp_num = init_num;
401 fbtft_init_dbg(dev, "%s(%s)\n", __func__,
402 sdev ? "'SPI device'" : "'Platform device'");
405 ret = flexfb_chip_init(dev);
410 if (width == 0 || height == 0) {
411 dev_err(dev, "argument(s) missing: width and height has to be set.\n");
414 flex_display.width = width;
415 flex_display.height = height;
416 fbtft_init_dbg(dev, "Display resolution: %dx%d\n", width, height);
417 fbtft_init_dbg(dev, "chip = %s\n", chip ? chip : "not set");
418 fbtft_init_dbg(dev, "setaddrwin = %d\n", setaddrwin);
419 fbtft_init_dbg(dev, "regwidth = %d\n", regwidth);
420 fbtft_init_dbg(dev, "buswidth = %d\n", buswidth);
422 info = fbtft_framebuffer_alloc(&flex_display, dev, dev->platform_data);
431 if (!par->init_sequence)
432 par->init_sequence = initp;
433 par->fbtftops.init_display = fbtft_init_display;
435 /* registerwrite functions */
438 par->fbtftops.write_register = fbtft_write_reg8_bus8;
441 par->fbtftops.write_register = fbtft_write_reg16_bus8;
445 "argument 'regwidth': %d is not supported.\n",
452 par->fbtftops.write = fbtft_write_spi;
455 par->fbtftops.write_vmem = fbtft_write_vmem16_bus8;
457 par->fbtftops.verify_gpios = flexfb_verify_gpios_dc;
460 if (regwidth == 16) {
461 dev_err(dev, "argument 'regwidth': %d is not supported with buswidth=%d and SPI.\n", regwidth, buswidth);
464 par->fbtftops.write_register = fbtft_write_reg8_bus9;
465 par->fbtftops.write_vmem = fbtft_write_vmem16_bus9;
466 if (par->spi->master->bits_per_word_mask
468 par->spi->bits_per_word = 9;
471 "9-bit SPI not available, emulating using 8-bit.\n");
472 /* allocate buffer with room for dc bits */
473 par->extra = devm_kzalloc(par->info->device,
474 par->txbuf.len + (par->txbuf.len / 8) + 8,
480 par->fbtftops.write = fbtft_write_spi_emulate_9;
484 dev_err(dev, "argument 'buswidth': %d is not supported with SPI.\n", buswidth);
488 par->fbtftops.verify_gpios = flexfb_verify_gpios_db;
491 par->fbtftops.write = fbtft_write_gpio8_wr;
492 par->fbtftops.write_vmem = fbtft_write_vmem16_bus8;
495 par->fbtftops.write_register = fbtft_write_reg16_bus16;
497 par->fbtftops.write = fbtft_write_gpio16_wr_latched;
499 par->fbtftops.write = fbtft_write_gpio16_wr;
500 par->fbtftops.write_vmem = fbtft_write_vmem16_bus16;
503 dev_err(dev, "argument 'buswidth': %d is not supported with parallel.\n", buswidth);
508 /* set_addr_win function */
509 switch (setaddrwin) {
514 par->fbtftops.set_addr_win = flexfb_set_addr_win_1;
517 par->fbtftops.set_addr_win = flexfb_set_addr_win_2;
520 par->fbtftops.set_addr_win = set_addr_win_3;
523 dev_err(dev, "argument 'setaddrwin': unknown value %d.\n",
529 par->fbtftops.register_backlight = fbtft_register_backlight;
531 ret = fbtft_register_framebuffer(info);
538 fbtft_framebuffer_release(info);
543 static int flexfb_remove_common(struct device *dev, struct fb_info *info)
545 struct fbtft_par *par;
551 fbtft_par_dbg(DEBUG_DRIVER_INIT_FUNCTIONS, par, "%s()\n",
553 fbtft_unregister_framebuffer(info);
554 fbtft_framebuffer_release(info);
559 static int flexfb_probe_spi(struct spi_device *spi)
561 return flexfb_probe_common(spi, NULL);
564 static int flexfb_remove_spi(struct spi_device *spi)
566 struct fb_info *info = spi_get_drvdata(spi);
568 return flexfb_remove_common(&spi->dev, info);
571 static int flexfb_probe_pdev(struct platform_device *pdev)
573 return flexfb_probe_common(NULL, pdev);
576 static int flexfb_remove_pdev(struct platform_device *pdev)
578 struct fb_info *info = platform_get_drvdata(pdev);
580 return flexfb_remove_common(&pdev->dev, info);
583 static struct spi_driver flexfb_spi_driver = {
587 .probe = flexfb_probe_spi,
588 .remove = flexfb_remove_spi,
591 static const struct platform_device_id flexfb_platform_ids[] = {
596 static struct platform_driver flexfb_platform_driver = {
600 .id_table = flexfb_platform_ids,
601 .probe = flexfb_probe_pdev,
602 .remove = flexfb_remove_pdev,
605 static int __init flexfb_init(void)
609 ret = spi_register_driver(&flexfb_spi_driver);
610 ret2 = platform_driver_register(&flexfb_platform_driver);
616 static void __exit flexfb_exit(void)
618 spi_unregister_driver(&flexfb_spi_driver);
619 platform_driver_unregister(&flexfb_platform_driver);
622 /* ------------------------------------------------------------------------- */
624 module_init(flexfb_init);
625 module_exit(flexfb_exit);
627 MODULE_DESCRIPTION("Generic FB driver for TFT LCD displays");
628 MODULE_AUTHOR("Noralf Tronnes");
629 MODULE_LICENSE("GPL");