1// SPDX-License-Identifier: GPL-2.0+
2/*
3 * DRM driver for Ilitek ILI9341 panels
4 *
5 * Copyright 2018 David Lechner <david@lechnology.com>
6 *
7 * Based on mi0283qt.c:
8 * Copyright 2016 Noralf Trønnes
9 */
10
11#include <linux/backlight.h>
12#include <linux/delay.h>
13#include <linux/gpio/consumer.h>
14#include <linux/module.h>
15#include <linux/property.h>
16#include <linux/spi/spi.h>
17
18#include <drm/drm_atomic_helper.h>
19#include <drm/drm_drv.h>
20#include <drm/drm_fbdev_generic.h>
21#include <drm/drm_gem_atomic_helper.h>
22#include <drm/drm_gem_dma_helper.h>
23#include <drm/drm_managed.h>
24#include <drm/drm_mipi_dbi.h>
25#include <drm/drm_modeset_helper.h>
26#include <video/mipi_display.h>
27
28#define ILI9341_FRMCTR1 0xb1
29#define ILI9341_DISCTRL 0xb6
30#define ILI9341_ETMOD 0xb7
31
32#define ILI9341_PWCTRL1 0xc0
33#define ILI9341_PWCTRL2 0xc1
34#define ILI9341_VMCTRL1 0xc5
35#define ILI9341_VMCTRL2 0xc7
36#define ILI9341_PWCTRLA 0xcb
37#define ILI9341_PWCTRLB 0xcf
38
39#define ILI9341_PGAMCTRL 0xe0
40#define ILI9341_NGAMCTRL 0xe1
41#define ILI9341_DTCTRLA 0xe8
42#define ILI9341_DTCTRLB 0xea
43#define ILI9341_PWRSEQ 0xed
44
45#define ILI9341_EN3GAM 0xf2
46#define ILI9341_PUMPCTRL 0xf7
47
48#define ILI9341_MADCTL_BGR BIT(3)
49#define ILI9341_MADCTL_MV BIT(5)
50#define ILI9341_MADCTL_MX BIT(6)
51#define ILI9341_MADCTL_MY BIT(7)
52
53static void yx240qv29_enable(struct drm_simple_display_pipe *pipe,
54 struct drm_crtc_state *crtc_state,
55 struct drm_plane_state *plane_state)
56{
57 struct mipi_dbi_dev *dbidev = drm_to_mipi_dbi_dev(drm: pipe->crtc.dev);
58 struct mipi_dbi *dbi = &dbidev->dbi;
59 u8 addr_mode;
60 int ret, idx;
61
62 if (!drm_dev_enter(dev: pipe->crtc.dev, idx: &idx))
63 return;
64
65 DRM_DEBUG_KMS("\n");
66
67 ret = mipi_dbi_poweron_conditional_reset(dbidev);
68 if (ret < 0)
69 goto out_exit;
70 if (ret == 1)
71 goto out_enable;
72
73 mipi_dbi_command(dbi, MIPI_DCS_SET_DISPLAY_OFF);
74
75 mipi_dbi_command(dbi, ILI9341_PWCTRLB, 0x00, 0xc1, 0x30);
76 mipi_dbi_command(dbi, ILI9341_PWRSEQ, 0x64, 0x03, 0x12, 0x81);
77 mipi_dbi_command(dbi, ILI9341_DTCTRLA, 0x85, 0x00, 0x78);
78 mipi_dbi_command(dbi, ILI9341_PWCTRLA, 0x39, 0x2c, 0x00, 0x34, 0x02);
79 mipi_dbi_command(dbi, ILI9341_PUMPCTRL, 0x20);
80 mipi_dbi_command(dbi, ILI9341_DTCTRLB, 0x00, 0x00);
81
82 /* Power Control */
83 mipi_dbi_command(dbi, ILI9341_PWCTRL1, 0x23);
84 mipi_dbi_command(dbi, ILI9341_PWCTRL2, 0x10);
85 /* VCOM */
86 mipi_dbi_command(dbi, ILI9341_VMCTRL1, 0x3e, 0x28);
87 mipi_dbi_command(dbi, ILI9341_VMCTRL2, 0x86);
88
89 /* Memory Access Control */
90 mipi_dbi_command(dbi, MIPI_DCS_SET_PIXEL_FORMAT, MIPI_DCS_PIXEL_FMT_16BIT);
91
92 /* Frame Rate */
93 mipi_dbi_command(dbi, ILI9341_FRMCTR1, 0x00, 0x1b);
94
95 /* Gamma */
96 mipi_dbi_command(dbi, ILI9341_EN3GAM, 0x00);
97 mipi_dbi_command(dbi, MIPI_DCS_SET_GAMMA_CURVE, 0x01);
98 mipi_dbi_command(dbi, ILI9341_PGAMCTRL,
99 0x0f, 0x31, 0x2b, 0x0c, 0x0e, 0x08, 0x4e, 0xf1,
100 0x37, 0x07, 0x10, 0x03, 0x0e, 0x09, 0x00);
101 mipi_dbi_command(dbi, ILI9341_NGAMCTRL,
102 0x00, 0x0e, 0x14, 0x03, 0x11, 0x07, 0x31, 0xc1,
103 0x48, 0x08, 0x0f, 0x0c, 0x31, 0x36, 0x0f);
104
105 /* DDRAM */
106 mipi_dbi_command(dbi, ILI9341_ETMOD, 0x07);
107
108 /* Display */
109 mipi_dbi_command(dbi, ILI9341_DISCTRL, 0x08, 0x82, 0x27, 0x00);
110 mipi_dbi_command(dbi, MIPI_DCS_EXIT_SLEEP_MODE);
111 msleep(msecs: 100);
112
113 mipi_dbi_command(dbi, MIPI_DCS_SET_DISPLAY_ON);
114 msleep(msecs: 100);
115
116out_enable:
117 switch (dbidev->rotation) {
118 default:
119 addr_mode = ILI9341_MADCTL_MX;
120 break;
121 case 90:
122 addr_mode = ILI9341_MADCTL_MV;
123 break;
124 case 180:
125 addr_mode = ILI9341_MADCTL_MY;
126 break;
127 case 270:
128 addr_mode = ILI9341_MADCTL_MV | ILI9341_MADCTL_MY |
129 ILI9341_MADCTL_MX;
130 break;
131 }
132 addr_mode |= ILI9341_MADCTL_BGR;
133 mipi_dbi_command(dbi, MIPI_DCS_SET_ADDRESS_MODE, addr_mode);
134 mipi_dbi_enable_flush(dbidev, crtc_state, plan_state: plane_state);
135out_exit:
136 drm_dev_exit(idx);
137}
138
139static const struct drm_simple_display_pipe_funcs ili9341_pipe_funcs = {
140 DRM_MIPI_DBI_SIMPLE_DISPLAY_PIPE_FUNCS(yx240qv29_enable),
141};
142
143static const struct drm_display_mode yx240qv29_mode = {
144 DRM_SIMPLE_MODE(240, 320, 37, 49),
145};
146
147DEFINE_DRM_GEM_DMA_FOPS(ili9341_fops);
148
149static const struct drm_driver ili9341_driver = {
150 .driver_features = DRIVER_GEM | DRIVER_MODESET | DRIVER_ATOMIC,
151 .fops = &ili9341_fops,
152 DRM_GEM_DMA_DRIVER_OPS_VMAP,
153 .debugfs_init = mipi_dbi_debugfs_init,
154 .name = "ili9341",
155 .desc = "Ilitek ILI9341",
156 .date = "20180514",
157 .major = 1,
158 .minor = 0,
159};
160
161static const struct of_device_id ili9341_of_match[] = {
162 { .compatible = "adafruit,yx240qv29" },
163 { }
164};
165MODULE_DEVICE_TABLE(of, ili9341_of_match);
166
167static const struct spi_device_id ili9341_id[] = {
168 { "yx240qv29", 0 },
169 { }
170};
171MODULE_DEVICE_TABLE(spi, ili9341_id);
172
173static int ili9341_probe(struct spi_device *spi)
174{
175 struct device *dev = &spi->dev;
176 struct mipi_dbi_dev *dbidev;
177 struct drm_device *drm;
178 struct mipi_dbi *dbi;
179 struct gpio_desc *dc;
180 u32 rotation = 0;
181 int ret;
182
183 dbidev = devm_drm_dev_alloc(dev, &ili9341_driver,
184 struct mipi_dbi_dev, drm);
185 if (IS_ERR(ptr: dbidev))
186 return PTR_ERR(ptr: dbidev);
187
188 dbi = &dbidev->dbi;
189 drm = &dbidev->drm;
190
191 dbi->reset = devm_gpiod_get_optional(dev, con_id: "reset", flags: GPIOD_OUT_HIGH);
192 if (IS_ERR(ptr: dbi->reset))
193 return dev_err_probe(dev, err: PTR_ERR(ptr: dbi->reset), fmt: "Failed to get GPIO 'reset'\n");
194
195 dc = devm_gpiod_get_optional(dev, con_id: "dc", flags: GPIOD_OUT_LOW);
196 if (IS_ERR(ptr: dc))
197 return dev_err_probe(dev, err: PTR_ERR(ptr: dc), fmt: "Failed to get GPIO 'dc'\n");
198
199 dbidev->backlight = devm_of_find_backlight(dev);
200 if (IS_ERR(ptr: dbidev->backlight))
201 return PTR_ERR(ptr: dbidev->backlight);
202
203 device_property_read_u32(dev, propname: "rotation", val: &rotation);
204
205 ret = mipi_dbi_spi_init(spi, dbi, dc);
206 if (ret)
207 return ret;
208
209 ret = mipi_dbi_dev_init(dbidev, funcs: &ili9341_pipe_funcs, mode: &yx240qv29_mode, rotation);
210 if (ret)
211 return ret;
212
213 drm_mode_config_reset(dev: drm);
214
215 ret = drm_dev_register(dev: drm, flags: 0);
216 if (ret)
217 return ret;
218
219 spi_set_drvdata(spi, data: drm);
220
221 drm_fbdev_generic_setup(dev: drm, preferred_bpp: 0);
222
223 return 0;
224}
225
226static void ili9341_remove(struct spi_device *spi)
227{
228 struct drm_device *drm = spi_get_drvdata(spi);
229
230 drm_dev_unplug(dev: drm);
231 drm_atomic_helper_shutdown(dev: drm);
232}
233
234static void ili9341_shutdown(struct spi_device *spi)
235{
236 drm_atomic_helper_shutdown(dev: spi_get_drvdata(spi));
237}
238
239static struct spi_driver ili9341_spi_driver = {
240 .driver = {
241 .name = "ili9341",
242 .of_match_table = ili9341_of_match,
243 },
244 .id_table = ili9341_id,
245 .probe = ili9341_probe,
246 .remove = ili9341_remove,
247 .shutdown = ili9341_shutdown,
248};
249module_spi_driver(ili9341_spi_driver);
250
251MODULE_DESCRIPTION("Ilitek ILI9341 DRM driver");
252MODULE_AUTHOR("David Lechner <david@lechnology.com>");
253MODULE_LICENSE("GPL");
254

source code of linux/drivers/gpu/drm/tiny/ili9341.c