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