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.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 #include <linux/module.h>
22 #include <linux/kernel.h>
23 #include <linux/init.h>
24 #include <linux/vmalloc.h>
25 #include <linux/gpio.h>
26 #include <linux/spi/spi.h>
27 #include <linux/delay.h>
31 #define DRVNAME "flexfb"
35 module_param(chip, charp, 0);
36 MODULE_PARM_DESC(chip, "LCD controller");
38 static unsigned int width;
39 module_param(width, uint, 0);
40 MODULE_PARM_DESC(width, "Display width");
42 static unsigned int height;
43 module_param(height, uint, 0);
44 MODULE_PARM_DESC(height, "Display height");
48 module_param_array(init, int, &init_num, 0);
49 MODULE_PARM_DESC(init, "Init sequence");
51 static unsigned int setaddrwin;
52 module_param(setaddrwin, uint, 0);
53 MODULE_PARM_DESC(setaddrwin, "Which set_addr_win() implementation to use");
55 static unsigned int buswidth = 8;
56 module_param(buswidth, uint, 0);
57 MODULE_PARM_DESC(buswidth, "Width of databus (default: 8)");
59 static unsigned int regwidth = 8;
60 module_param(regwidth, uint, 0);
61 MODULE_PARM_DESC(regwidth, "Width of controller register (default: 8)");
63 static bool nobacklight;
64 module_param(nobacklight, bool, 0);
65 MODULE_PARM_DESC(nobacklight, "Turn off backlight functionality.");
68 module_param(latched, bool, 0);
69 MODULE_PARM_DESC(latched, "Use with latched 16-bit databus");
75 /* default init sequences */
76 static int st7735r_init[] = { \
77 -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, \
78 -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, \
79 -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, \
80 -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 };
82 static int ssd1289_init[] = { \
83 -1,0x00,0x0001,-1,0x03,0xA8A4,-1,0x0C,0x0000,-1,0x0D,0x080C,-1,0x0E,0x2B00,-1,0x1E,0x00B7,-1,0x01,0x2B3F,-1,0x02,0x0600, \
84 -1,0x10,0x0000,-1,0x11,0x6070,-1,0x05,0x0000,-1,0x06,0x0000,-1,0x16,0xEF1C,-1,0x17,0x0003,-1,0x07,0x0233,-1,0x0B,0x0000, \
85 -1,0x0F,0x0000,-1,0x41,0x0000,-1,0x42,0x0000,-1,0x48,0x0000,-1,0x49,0x013F,-1,0x4A,0x0000,-1,0x4B,0x0000,-1,0x44,0xEF00, \
86 -1,0x45,0x0000,-1,0x46,0x013F,-1,0x30,0x0707,-1,0x31,0x0204,-1,0x32,0x0204,-1,0x33,0x0502,-1,0x34,0x0507,-1,0x35,0x0204, \
87 -1,0x36,0x0204,-1,0x37,0x0502,-1,0x3A,0x0302,-1,0x3B,0x0302,-1,0x23,0x0000,-1,0x24,0x0000,-1,0x25,0x8000,-1,0x4f,0x0000, \
88 -1,0x4e,0x0000,-1,0x22,-3 };
90 static int hx8340bn_init[] = { \
91 -1,0xC1,0xFF,0x83,0x40,-1,0x11,-2,150,-1,0xCA,0x70,0x00,0xD9,-1,0xB0,0x01,0x11, \
92 -1,0xC9,0x90,0x49,0x10,0x28,0x28,0x10,0x00,0x06,-2,20,-1,0xC2,0x60,0x71,0x01,0x0E,0x05,0x02,0x09,0x31,0x0A, \
93 -1,0xC3,0x67,0x30,0x61,0x17,0x48,0x07,0x05,0x33,-2,10,-1,0xB5,0x35,0x20,0x45,-1,0xB4,0x33,0x25,0x4C,-2,10, \
94 -1,0x3A,0x05,-1,0x29,-2,10,-3 };
96 static int ili9225_init[] = { \
97 -1,0x0001,0x011C,-1,0x0002,0x0100,-1,0x0003,0x1030,-1,0x0008,0x0808,-1,0x000C,0x0000,-1,0x000F,0x0A01,-1,0x0020,0x0000, \
98 -1,0x0021,0x0000,-2,50,-1,0x0010,0x0A00,-1,0x0011,0x1038,-2,50,-1,0x0012,0x1121,-1,0x0013,0x004E,-1,0x0014,0x676F, \
99 -1,0x0030,0x0000,-1,0x0031,0x00DB,-1,0x0032,0x0000,-1,0x0033,0x0000,-1,0x0034,0x00DB,-1,0x0035,0x0000,-1,0x0036,0x00AF, \
100 -1,0x0037,0x0000,-1,0x0038,0x00DB,-1,0x0039,0x0000,-1,0x0050,0x0000,-1,0x0051,0x060A,-1,0x0052,0x0D0A,-1,0x0053,0x0303, \
101 -1,0x0054,0x0A0D,-1,0x0055,0x0A06,-1,0x0056,0x0000,-1,0x0057,0x0303,-1,0x0058,0x0000,-1,0x0059,0x0000,-2,50, \
102 -1,0x0007,0x1017,-2,50,-3 };
104 static int ili9320_init[] = { \
105 -1,0x00E5,0x8000,-1,0x0000,0x0001,-1,0x0001,0x0100,-1,0x0002,0x0700,-1,0x0003,0x1030,-1,0x0004,0x0000,-1,0x0008,0x0202, \
106 -1,0x0009,0x0000,-1,0x000A,0x0000,-1,0x000C,0x0000,-1,0x000D,0x0000,-1,0x000F,0x0000,-1,0x0010,0x0000,-1,0x0011,0x0007, \
107 -1,0x0012,0x0000,-1,0x0013,0x0000,-2,200,-1,0x0010,0x17B0,-1,0x0011,0x0031,-2,50,-1,0x0012,0x0138,-2,50,-1,0x0013,0x1800, \
108 -1,0x0029,0x0008,-2,50,-1,0x0020,0x0000,-1,0x0021,0x0000,-1,0x0030,0x0000,-1,0x0031,0x0505,-1,0x0032,0x0004, \
109 -1,0x0035,0x0006,-1,0x0036,0x0707,-1,0x0037,0x0105,-1,0x0038,0x0002,-1,0x0039,0x0707,-1,0x003C,0x0704,-1,0x003D,0x0807, \
110 -1,0x0050,0x0000,-1,0x0051,0x00EF,-1,0x0052,0x0000,-1,0x0053,0x013F,-1,0x0060,0x2700,-1,0x0061,0x0001,-1,0x006A,0x0000, \
111 -1,0x0080,0x0000,-1,0x0081,0x0000,-1,0x0082,0x0000,-1,0x0083,0x0000,-1,0x0084,0x0000,-1,0x0085,0x0000,-1,0x0090,0x0010, \
112 -1,0x0092,0x0000,-1,0x0093,0x0003,-1,0x0095,0x0110,-1,0x0097,0x0000,-1,0x0098,0x0000,-1,0x0007,0x0173,-3 };
114 static int ili9325_init[] = { \
115 -1,0x00E3,0x3008,-1,0x00E7,0x0012,-1,0x00EF,0x1231,-1,0x0001,0x0100,-1,0x0002,0x0700,-1,0x0003,0x1030,-1,0x0004,0x0000, \
116 -1,0x0008,0x0207,-1,0x0009,0x0000,-1,0x000A,0x0000,-1,0x000C,0x0000,-1,0x000D,0x0000,-1,0x000F,0x0000,-1,0x0010,0x0000, \
117 -1,0x0011,0x0007,-1,0x0012,0x0000,-1,0x0013,0x0000,-2,200,-1,0x0010,0x1690,-1,0x0011,0x0223,-2,50,-1,0x0012,0x000D,-2,50, \
118 -1,0x0013,0x1200,-1,0x0029,0x000A,-1,0x002B,0x000C,-2,50,-1,0x0020,0x0000,-1,0x0021,0x0000,-1,0x0030,0x0000, \
119 -1,0x0031,0x0506,-1,0x0032,0x0104,-1,0x0035,0x0207,-1,0x0036,0x000F,-1,0x0037,0x0306,-1,0x0038,0x0102,-1,0x0039,0x0707, \
120 -1,0x003C,0x0702,-1,0x003D,0x1604,-1,0x0050,0x0000,-1,0x0051,0x00EF,-1,0x0052,0x0000,-1,0x0053,0x013F,-1,0x0060,0xA700, \
121 -1,0x0061,0x0001,-1,0x006A,0x0000,-1,0x0080,0x0000,-1,0x0081,0x0000,-1,0x0082,0x0000,-1,0x0083,0x0000,-1,0x0084,0x0000, \
122 -1,0x0085,0x0000,-1,0x0090,0x0010,-1,0x0092,0x0600,-1,0x0007,0x0133,-3 };
124 static int ili9341_init[] = { \
125 -1,0x28,-2,20,-1,0xCF,0x00,0x83,0x30,-1,0xED,0x64,0x03,0x12,0x81,-1,0xE8,0x85,0x01,0x79, \
126 -1,0xCB,0x39,0x2c,0x00,0x34,0x02,-1,0xF7,0x20,-1,0xEA,0x00,0x00,-1,0xC0,0x26,-1,0xC1,0x11, \
127 -1,0xC5,0x35,0x3E,-1,0xC7,0xBE,-1,0xB1,0x00,0x1B,-1,0xB6,0x0a,0x82,0x27,0x00,-1,0xB7,0x07, \
128 -1,0x3A,0x55,-1,0x36,0x48,-1,0x11,-2,120,-1,0x29,-2,20,-3 };
130 static int ssd1351_init[] = { -1,0xfd,0x12,-1,0xfd,0xb1,-1,0xae,-1,0xb3,0xf1,-1,0xca,0x7f,-1,0xa0,0x74, \
131 -1,0x15,0x00,0x7f,-1,0x75,0x00,0x7f,-1,0xa1,0x00,-1,0xa2,0x00,-1,0xb5,0x00, \
132 -1,0xab,0x01,-1,0xb1,0x32,-1,0xb4,0xa0,0xb5,0x55,-1,0xbb,0x17,-1,0xbe,0x05, \
133 -1,0xc1,0xc8,0x80,0xc8,-1,0xc7,0x0f,-1,0xb6,0x01,-1,0xa6,-1,0xaf,-3 };
136 /* ili9320, ili9325 */
137 static void flexfb_set_addr_win_1(struct fbtft_par *par, int xs, int ys, int xe, int ye)
139 fbtft_par_dbg(DEBUG_SET_ADDR_WIN, par, "%s(xs=%d, ys=%d, xe=%d, ye=%d)\n", __func__, xs, ys, xe, ye);
140 switch (par->info->var.rotate) {
141 /* R20h = Horizontal GRAM Start Address */
142 /* R21h = Vertical GRAM Start Address */
144 write_reg(par, 0x0020, xs);
145 write_reg(par, 0x0021, ys);
148 write_reg(par, 0x0020, width - 1 - xs);
149 write_reg(par, 0x0021, height - 1 - ys);
152 write_reg(par, 0x0020, width - 1 - ys);
153 write_reg(par, 0x0021, xs);
156 write_reg(par, 0x0020, ys);
157 write_reg(par, 0x0021, height - 1 - xs);
160 write_reg(par, 0x0022); /* Write Data to GRAM */
164 static void flexfb_set_addr_win_2(struct fbtft_par *par, int xs, int ys, int xe, int ye)
166 fbtft_par_dbg(DEBUG_SET_ADDR_WIN, par, "%s(xs=%d, ys=%d, xe=%d, ye=%d)\n", __func__, xs, ys, xe, ye);
168 switch (par->info->var.rotate) {
169 /* R4Eh - Set GDDRAM X address counter */
170 /* R4Fh - Set GDDRAM Y address counter */
172 write_reg(par, 0x4e, xs);
173 write_reg(par, 0x4f, ys);
176 write_reg(par, 0x4e, par->info->var.xres - 1 - xs);
177 write_reg(par, 0x4f, par->info->var.yres - 1 - ys);
180 write_reg(par, 0x4e, par->info->var.yres - 1 - ys);
181 write_reg(par, 0x4f, xs);
184 write_reg(par, 0x4e, ys);
185 write_reg(par, 0x4f, par->info->var.xres - 1 - xs);
189 /* R22h - RAM data write */
190 write_reg(par, 0x22, 0);
194 static void set_addr_win_3(struct fbtft_par *par, int xs, int ys, int xe, int ye)
196 fbtft_par_dbg(DEBUG_SET_ADDR_WIN, par, "%s(xs=%d, ys=%d, xe=%d, ye=%d)\n", __func__, xs, ys, xe, ye);
198 write_reg(par, 0x15, xs, xe);
199 write_reg(par, 0x75, ys, ye);
200 write_reg(par, 0x5C);
203 static int flexfb_verify_gpios_dc(struct fbtft_par *par)
205 fbtft_par_dbg(DEBUG_VERIFY_GPIOS, par, "%s()\n", __func__);
207 if (par->gpio.dc < 0) {
208 dev_err(par->info->device, "Missing info about 'dc' gpio. Aborting.\n");
215 static int flexfb_verify_gpios_db(struct fbtft_par *par)
218 int num_db = buswidth;
220 fbtft_par_dbg(DEBUG_VERIFY_GPIOS, par, "%s()\n", __func__);
222 if (par->gpio.dc < 0) {
223 dev_err(par->info->device, "Missing info about 'dc' gpio. Aborting.\n");
226 if (par->gpio.wr < 0) {
227 dev_err(par->info->device, "Missing info about 'wr' gpio. Aborting.\n");
230 if (latched && (par->gpio.latch < 0)) {
231 dev_err(par->info->device, "Missing info about 'latch' gpio. Aborting.\n");
236 for (i=0;i < num_db;i++) {
237 if (par->gpio.db[i] < 0) {
238 dev_err(par->info->device, "Missing info about 'db%02d' gpio. Aborting.\n", i);
246 static struct fbtft_display flex_display = { };
248 static int flexfb_probe_common(struct spi_device *sdev, struct platform_device *pdev)
251 struct fb_info *info;
252 struct fbtft_par *par;
256 initp_num = init_num;
263 fbtft_init_dbg(dev, "%s(%s)\n", __func__, sdev ? "'SPI device'" : "'Platform device'");
267 if (!strcmp(chip, "st7735r")) {
273 initp = st7735r_init;
274 initp_num = ARRAY_SIZE(st7735r_init);
278 } else if (!strcmp(chip, "hx8340bn")) {
285 initp = hx8340bn_init;
286 initp_num = ARRAY_SIZE(hx8340bn_init);
290 } else if (!strcmp(chip, "ili9225")) {
298 initp = ili9225_init;
299 initp_num = ARRAY_SIZE(ili9225_init);
304 } else if (!strcmp(chip, "ili9320")) {
312 initp = ili9320_init;
313 initp_num = ARRAY_SIZE(ili9320_init);
317 } else if (!strcmp(chip, "ili9325")) {
325 initp = ili9325_init;
326 initp_num = ARRAY_SIZE(ili9325_init);
329 } else if (!strcmp(chip, "ili9341")) {
337 initp = ili9341_init;
338 initp_num = ARRAY_SIZE(ili9341_init);
342 } else if (!strcmp(chip, "ssd1289")) {
350 initp = ssd1289_init;
351 initp_num = ARRAY_SIZE(ssd1289_init);
356 } else if (!strcmp(chip, "ssd1351")) {
363 initp = ssd1351_init;
364 initp_num = ARRAY_SIZE(ssd1351_init);
367 dev_err(dev, "chip=%s is not supported\n", chip);
372 if (width == 0 || height == 0) {
373 dev_err(dev, "argument(s) missing: width and height has to be set.\n");
376 flex_display.width = width;
377 flex_display.height = height;
378 fbtft_init_dbg(dev, "Display resolution: %dx%d\n", width, height);
379 fbtft_init_dbg(dev, "chip = %s\n", chip ? chip : "not set");
380 fbtft_init_dbg(dev, "setaddrwin = %d\n", setaddrwin);
381 fbtft_init_dbg(dev, "regwidth = %d\n", regwidth);
382 fbtft_init_dbg(dev, "buswidth = %d\n", buswidth);
384 info = fbtft_framebuffer_alloc(&flex_display, dev);
393 if (!par->init_sequence)
394 par->init_sequence = initp;
395 par->fbtftops.init_display = fbtft_init_display;
397 /* registerwrite functions */
400 par->fbtftops.write_register = fbtft_write_reg8_bus8;
403 par->fbtftops.write_register = fbtft_write_reg16_bus8;
406 dev_err(dev, "argument 'regwidth': %d is not supported.\n", regwidth);
412 par->fbtftops.write = fbtft_write_spi;
415 par->fbtftops.write_vmem = fbtft_write_vmem16_bus8;
417 par->fbtftops.verify_gpios = flexfb_verify_gpios_dc;
420 if (regwidth == 16) {
421 dev_err(dev, "argument 'regwidth': %d is not supported with buswidth=%d and SPI.\n", regwidth, buswidth);
424 par->fbtftops.write_register = fbtft_write_reg8_bus9;
425 par->fbtftops.write_vmem = fbtft_write_vmem16_bus9;
426 sdev->bits_per_word = 9;
427 ret = sdev->master->setup(sdev);
430 "9-bit SPI not available, emulating using 8-bit.\n");
431 sdev->bits_per_word = 8;
432 ret = sdev->master->setup(sdev);
435 /* allocate buffer with room for dc bits */
436 par->extra = devm_kzalloc(par->info->device,
437 par->txbuf.len + (par->txbuf.len / 8) + 8,
443 par->fbtftops.write = fbtft_write_spi_emulate_9;
447 dev_err(dev, "argument 'buswidth': %d is not supported with SPI.\n", buswidth);
451 par->fbtftops.verify_gpios = flexfb_verify_gpios_db;
454 par->fbtftops.write = fbtft_write_gpio8_wr;
455 par->fbtftops.write_vmem = fbtft_write_vmem16_bus8;
458 par->fbtftops.write_register = fbtft_write_reg16_bus16;
460 par->fbtftops.write = fbtft_write_gpio16_wr_latched;
462 par->fbtftops.write = fbtft_write_gpio16_wr;
463 par->fbtftops.write_vmem = fbtft_write_vmem16_bus16;
466 dev_err(dev, "argument 'buswidth': %d is not supported with parallel.\n", buswidth);
471 /* set_addr_win function */
472 switch (setaddrwin) {
477 par->fbtftops.set_addr_win = flexfb_set_addr_win_1;
480 par->fbtftops.set_addr_win = flexfb_set_addr_win_2;
483 par->fbtftops.set_addr_win = set_addr_win_3;
486 dev_err(dev, "argument 'setaddrwin': unknown value %d.\n", setaddrwin);
491 par->fbtftops.register_backlight = fbtft_register_backlight;
493 ret = fbtft_register_framebuffer(info);
500 fbtft_framebuffer_release(info);
505 static int flexfb_remove_common(struct device *dev, struct fb_info *info)
507 struct fbtft_par *par;
513 fbtft_par_dbg(DEBUG_DRIVER_INIT_FUNCTIONS, par,
515 fbtft_unregister_framebuffer(info);
516 fbtft_framebuffer_release(info);
521 static int flexfb_probe_spi(struct spi_device *spi)
523 return flexfb_probe_common(spi, NULL);
526 static int flexfb_remove_spi(struct spi_device *spi)
528 struct fb_info *info = spi_get_drvdata(spi);
530 return flexfb_remove_common(&spi->dev, info);
533 static int flexfb_probe_pdev(struct platform_device *pdev)
535 return flexfb_probe_common(NULL, pdev);
538 static int flexfb_remove_pdev(struct platform_device *pdev)
540 struct fb_info *info = platform_get_drvdata(pdev);
542 return flexfb_remove_common(&pdev->dev, info);
545 static struct spi_driver flexfb_spi_driver = {
548 .owner = THIS_MODULE,
550 .probe = flexfb_probe_spi,
551 .remove = flexfb_remove_spi,
554 static const struct platform_device_id flexfb_platform_ids[] = {
559 static struct platform_driver flexfb_platform_driver = {
563 .id_table = flexfb_platform_ids,
564 .probe = flexfb_probe_pdev,
565 .remove = flexfb_remove_pdev,
568 static int __init flexfb_init(void)
572 ret = spi_register_driver(&flexfb_spi_driver);
573 ret2 = platform_driver_register(&flexfb_platform_driver);
579 static void __exit flexfb_exit(void)
581 spi_unregister_driver(&flexfb_spi_driver);
582 platform_driver_unregister(&flexfb_platform_driver);
585 /* ------------------------------------------------------------------------- */
587 module_init(flexfb_init);
588 module_exit(flexfb_exit);
590 MODULE_DESCRIPTION("Generic FB driver for TFT LCD displays");
591 MODULE_AUTHOR("Noralf Tronnes");
592 MODULE_LICENSE("GPL");