1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * DRM driver for Ilitek ILI9225 panels
5 * Copyright 2017 David Lechner <david@lechnology.com>
7 * Some code copied from mipi-dbi.c
8 * Copyright 2016 Noralf Trønnes
11 #include <linux/delay.h>
12 #include <linux/dma-buf.h>
13 #include <linux/gpio/consumer.h>
14 #include <linux/module.h>
15 #include <linux/property.h>
16 #include <linux/spi/spi.h>
17 #include <video/mipi_display.h>
19 #include <drm/drm_atomic_helper.h>
20 #include <drm/drm_damage_helper.h>
21 #include <drm/drm_drv.h>
22 #include <drm/drm_fb_cma_helper.h>
23 #include <drm/drm_fb_helper.h>
24 #include <drm/drm_fourcc.h>
25 #include <drm/drm_gem_cma_helper.h>
26 #include <drm/drm_gem_framebuffer_helper.h>
27 #include <drm/drm_rect.h>
28 #include <drm/drm_vblank.h>
29 #include <drm/tinydrm/mipi-dbi.h>
30 #include <drm/tinydrm/tinydrm-helpers.h>
32 #define ILI9225_DRIVER_READ_CODE 0x00
33 #define ILI9225_DRIVER_OUTPUT_CONTROL 0x01
34 #define ILI9225_LCD_AC_DRIVING_CONTROL 0x02
35 #define ILI9225_ENTRY_MODE 0x03
36 #define ILI9225_DISPLAY_CONTROL_1 0x07
37 #define ILI9225_BLANK_PERIOD_CONTROL_1 0x08
38 #define ILI9225_FRAME_CYCLE_CONTROL 0x0b
39 #define ILI9225_INTERFACE_CONTROL 0x0c
40 #define ILI9225_OSCILLATION_CONTROL 0x0f
41 #define ILI9225_POWER_CONTROL_1 0x10
42 #define ILI9225_POWER_CONTROL_2 0x11
43 #define ILI9225_POWER_CONTROL_3 0x12
44 #define ILI9225_POWER_CONTROL_4 0x13
45 #define ILI9225_POWER_CONTROL_5 0x14
46 #define ILI9225_VCI_RECYCLING 0x15
47 #define ILI9225_RAM_ADDRESS_SET_1 0x20
48 #define ILI9225_RAM_ADDRESS_SET_2 0x21
49 #define ILI9225_WRITE_DATA_TO_GRAM 0x22
50 #define ILI9225_SOFTWARE_RESET 0x28
51 #define ILI9225_GATE_SCAN_CONTROL 0x30
52 #define ILI9225_VERTICAL_SCROLL_1 0x31
53 #define ILI9225_VERTICAL_SCROLL_2 0x32
54 #define ILI9225_VERTICAL_SCROLL_3 0x33
55 #define ILI9225_PARTIAL_DRIVING_POS_1 0x34
56 #define ILI9225_PARTIAL_DRIVING_POS_2 0x35
57 #define ILI9225_HORIZ_WINDOW_ADDR_1 0x36
58 #define ILI9225_HORIZ_WINDOW_ADDR_2 0x37
59 #define ILI9225_VERT_WINDOW_ADDR_1 0x38
60 #define ILI9225_VERT_WINDOW_ADDR_2 0x39
61 #define ILI9225_GAMMA_CONTROL_1 0x50
62 #define ILI9225_GAMMA_CONTROL_2 0x51
63 #define ILI9225_GAMMA_CONTROL_3 0x52
64 #define ILI9225_GAMMA_CONTROL_4 0x53
65 #define ILI9225_GAMMA_CONTROL_5 0x54
66 #define ILI9225_GAMMA_CONTROL_6 0x55
67 #define ILI9225_GAMMA_CONTROL_7 0x56
68 #define ILI9225_GAMMA_CONTROL_8 0x57
69 #define ILI9225_GAMMA_CONTROL_9 0x58
70 #define ILI9225_GAMMA_CONTROL_10 0x59
72 static inline int ili9225_command(struct mipi_dbi *mipi, u8 cmd, u16 data)
74 u8 par[2] = { data >> 8, data & 0xff };
76 return mipi_dbi_command_buf(mipi, cmd, par, 2);
79 static void ili9225_fb_dirty(struct drm_framebuffer *fb, struct drm_rect *rect)
81 struct drm_gem_cma_object *cma_obj = drm_fb_cma_get_gem_obj(fb, 0);
82 struct mipi_dbi *mipi = drm_to_mipi_dbi(fb->dev);
83 unsigned int height = rect->y2 - rect->y1;
84 unsigned int width = rect->x2 - rect->x1;
85 bool swap = mipi->swap_bytes;
95 if (!drm_dev_enter(fb->dev, &idx))
98 full = width == fb->width && height == fb->height;
100 DRM_DEBUG_KMS("Flushing [FB:%d] " DRM_RECT_FMT "\n", fb->base.id, DRM_RECT_ARG(rect));
102 if (!mipi->dc || !full || swap ||
103 fb->format->format == DRM_FORMAT_XRGB8888) {
105 ret = mipi_dbi_buf_copy(mipi->tx_buf, fb, rect, swap);
112 switch (mipi->rotation) {
124 y1 = fb->width - rect->x2;
125 y2 = fb->width - rect->x1 - 1;
130 x1 = fb->width - rect->x2;
131 x2 = fb->width - rect->x1 - 1;
132 y1 = fb->height - rect->y2;
133 y2 = fb->height - rect->y1 - 1;
138 x1 = fb->height - rect->y2;
139 x2 = fb->height - rect->y1 - 1;
147 ili9225_command(mipi, ILI9225_HORIZ_WINDOW_ADDR_1, x2);
148 ili9225_command(mipi, ILI9225_HORIZ_WINDOW_ADDR_2, x1);
149 ili9225_command(mipi, ILI9225_VERT_WINDOW_ADDR_1, y2);
150 ili9225_command(mipi, ILI9225_VERT_WINDOW_ADDR_2, y1);
152 ili9225_command(mipi, ILI9225_RAM_ADDRESS_SET_1, x_start);
153 ili9225_command(mipi, ILI9225_RAM_ADDRESS_SET_2, y_start);
155 ret = mipi_dbi_command_buf(mipi, ILI9225_WRITE_DATA_TO_GRAM, tr,
159 dev_err_once(fb->dev->dev, "Failed to update display %d\n", ret);
164 static void ili9225_pipe_update(struct drm_simple_display_pipe *pipe,
165 struct drm_plane_state *old_state)
167 struct drm_plane_state *state = pipe->plane.state;
168 struct drm_crtc *crtc = &pipe->crtc;
169 struct drm_rect rect;
171 if (drm_atomic_helper_damage_merged(old_state, state, &rect))
172 ili9225_fb_dirty(state->fb, &rect);
174 if (crtc->state->event) {
175 spin_lock_irq(&crtc->dev->event_lock);
176 drm_crtc_send_vblank_event(crtc, crtc->state->event);
177 spin_unlock_irq(&crtc->dev->event_lock);
178 crtc->state->event = NULL;
182 static void ili9225_pipe_enable(struct drm_simple_display_pipe *pipe,
183 struct drm_crtc_state *crtc_state,
184 struct drm_plane_state *plane_state)
186 struct mipi_dbi *mipi = drm_to_mipi_dbi(pipe->crtc.dev);
187 struct drm_framebuffer *fb = plane_state->fb;
188 struct device *dev = pipe->crtc.dev->dev;
189 struct drm_rect rect = {
198 if (!drm_dev_enter(pipe->crtc.dev, &idx))
203 mipi_dbi_hw_reset(mipi);
206 * There don't seem to be two example init sequences that match, so
207 * using the one from the popular Arduino library for this display.
208 * https://github.com/Nkawu/TFT_22_ILI9225/blob/master/src/TFT_22_ILI9225.cpp
211 ret = ili9225_command(mipi, ILI9225_POWER_CONTROL_1, 0x0000);
213 DRM_DEV_ERROR(dev, "Error sending command %d\n", ret);
216 ili9225_command(mipi, ILI9225_POWER_CONTROL_2, 0x0000);
217 ili9225_command(mipi, ILI9225_POWER_CONTROL_3, 0x0000);
218 ili9225_command(mipi, ILI9225_POWER_CONTROL_4, 0x0000);
219 ili9225_command(mipi, ILI9225_POWER_CONTROL_5, 0x0000);
223 ili9225_command(mipi, ILI9225_POWER_CONTROL_2, 0x0018);
224 ili9225_command(mipi, ILI9225_POWER_CONTROL_3, 0x6121);
225 ili9225_command(mipi, ILI9225_POWER_CONTROL_4, 0x006f);
226 ili9225_command(mipi, ILI9225_POWER_CONTROL_5, 0x495f);
227 ili9225_command(mipi, ILI9225_POWER_CONTROL_1, 0x0800);
231 ili9225_command(mipi, ILI9225_POWER_CONTROL_2, 0x103b);
235 switch (mipi->rotation) {
249 ili9225_command(mipi, ILI9225_DRIVER_OUTPUT_CONTROL, 0x011c);
250 ili9225_command(mipi, ILI9225_LCD_AC_DRIVING_CONTROL, 0x0100);
251 ili9225_command(mipi, ILI9225_ENTRY_MODE, 0x1000 | am_id);
252 ili9225_command(mipi, ILI9225_DISPLAY_CONTROL_1, 0x0000);
253 ili9225_command(mipi, ILI9225_BLANK_PERIOD_CONTROL_1, 0x0808);
254 ili9225_command(mipi, ILI9225_FRAME_CYCLE_CONTROL, 0x1100);
255 ili9225_command(mipi, ILI9225_INTERFACE_CONTROL, 0x0000);
256 ili9225_command(mipi, ILI9225_OSCILLATION_CONTROL, 0x0d01);
257 ili9225_command(mipi, ILI9225_VCI_RECYCLING, 0x0020);
258 ili9225_command(mipi, ILI9225_RAM_ADDRESS_SET_1, 0x0000);
259 ili9225_command(mipi, ILI9225_RAM_ADDRESS_SET_2, 0x0000);
261 ili9225_command(mipi, ILI9225_GATE_SCAN_CONTROL, 0x0000);
262 ili9225_command(mipi, ILI9225_VERTICAL_SCROLL_1, 0x00db);
263 ili9225_command(mipi, ILI9225_VERTICAL_SCROLL_2, 0x0000);
264 ili9225_command(mipi, ILI9225_VERTICAL_SCROLL_3, 0x0000);
265 ili9225_command(mipi, ILI9225_PARTIAL_DRIVING_POS_1, 0x00db);
266 ili9225_command(mipi, ILI9225_PARTIAL_DRIVING_POS_2, 0x0000);
268 ili9225_command(mipi, ILI9225_GAMMA_CONTROL_1, 0x0000);
269 ili9225_command(mipi, ILI9225_GAMMA_CONTROL_2, 0x0808);
270 ili9225_command(mipi, ILI9225_GAMMA_CONTROL_3, 0x080a);
271 ili9225_command(mipi, ILI9225_GAMMA_CONTROL_4, 0x000a);
272 ili9225_command(mipi, ILI9225_GAMMA_CONTROL_5, 0x0a08);
273 ili9225_command(mipi, ILI9225_GAMMA_CONTROL_6, 0x0808);
274 ili9225_command(mipi, ILI9225_GAMMA_CONTROL_7, 0x0000);
275 ili9225_command(mipi, ILI9225_GAMMA_CONTROL_8, 0x0a00);
276 ili9225_command(mipi, ILI9225_GAMMA_CONTROL_9, 0x0710);
277 ili9225_command(mipi, ILI9225_GAMMA_CONTROL_10, 0x0710);
279 ili9225_command(mipi, ILI9225_DISPLAY_CONTROL_1, 0x0012);
283 ili9225_command(mipi, ILI9225_DISPLAY_CONTROL_1, 0x1017);
285 mipi->enabled = true;
286 ili9225_fb_dirty(fb, &rect);
291 static void ili9225_pipe_disable(struct drm_simple_display_pipe *pipe)
293 struct mipi_dbi *mipi = drm_to_mipi_dbi(pipe->crtc.dev);
298 * This callback is not protected by drm_dev_enter/exit since we want to
299 * turn off the display on regular driver unload. It's highly unlikely
300 * that the underlying SPI controller is gone should this be called after
307 ili9225_command(mipi, ILI9225_DISPLAY_CONTROL_1, 0x0000);
309 ili9225_command(mipi, ILI9225_POWER_CONTROL_2, 0x0007);
311 ili9225_command(mipi, ILI9225_POWER_CONTROL_1, 0x0a02);
313 mipi->enabled = false;
316 static int ili9225_dbi_command(struct mipi_dbi *mipi, u8 *cmd, u8 *par,
319 struct spi_device *spi = mipi->spi;
320 unsigned int bpw = 8;
324 gpiod_set_value_cansleep(mipi->dc, 0);
325 speed_hz = mipi_dbi_spi_cmd_max_speed(spi, 1);
326 ret = tinydrm_spi_transfer(spi, speed_hz, NULL, 8, cmd, 1);
330 if (*cmd == ILI9225_WRITE_DATA_TO_GRAM && !mipi->swap_bytes)
333 gpiod_set_value_cansleep(mipi->dc, 1);
334 speed_hz = mipi_dbi_spi_cmd_max_speed(spi, num);
336 return tinydrm_spi_transfer(spi, speed_hz, NULL, bpw, par, num);
339 static const struct drm_simple_display_pipe_funcs ili9225_pipe_funcs = {
340 .enable = ili9225_pipe_enable,
341 .disable = ili9225_pipe_disable,
342 .update = ili9225_pipe_update,
343 .prepare_fb = drm_gem_fb_simple_display_pipe_prepare_fb,
346 static const struct drm_display_mode ili9225_mode = {
347 DRM_SIMPLE_MODE(176, 220, 35, 44),
350 DEFINE_DRM_GEM_CMA_FOPS(ili9225_fops);
352 static struct drm_driver ili9225_driver = {
353 .driver_features = DRIVER_GEM | DRIVER_MODESET | DRIVER_PRIME |
355 .fops = &ili9225_fops,
356 .release = mipi_dbi_release,
357 DRM_GEM_CMA_VMAP_DRIVER_OPS,
359 .desc = "Ilitek ILI9225",
365 static const struct of_device_id ili9225_of_match[] = {
366 { .compatible = "vot,v220hf01a-t" },
369 MODULE_DEVICE_TABLE(of, ili9225_of_match);
371 static const struct spi_device_id ili9225_id[] = {
372 { "v220hf01a-t", 0 },
375 MODULE_DEVICE_TABLE(spi, ili9225_id);
377 static int ili9225_probe(struct spi_device *spi)
379 struct device *dev = &spi->dev;
380 struct drm_device *drm;
381 struct mipi_dbi *mipi;
382 struct gpio_desc *rs;
386 mipi = kzalloc(sizeof(*mipi), GFP_KERNEL);
391 ret = devm_drm_dev_init(dev, drm, &ili9225_driver);
397 drm_mode_config_init(drm);
399 mipi->reset = devm_gpiod_get(dev, "reset", GPIOD_OUT_HIGH);
400 if (IS_ERR(mipi->reset)) {
401 DRM_DEV_ERROR(dev, "Failed to get gpio 'reset'\n");
402 return PTR_ERR(mipi->reset);
405 rs = devm_gpiod_get(dev, "rs", GPIOD_OUT_LOW);
407 DRM_DEV_ERROR(dev, "Failed to get gpio 'rs'\n");
411 device_property_read_u32(dev, "rotation", &rotation);
413 ret = mipi_dbi_spi_init(spi, mipi, rs);
417 /* override the command function set in mipi_dbi_spi_init() */
418 mipi->command = ili9225_dbi_command;
420 ret = mipi_dbi_init(mipi, &ili9225_pipe_funcs, &ili9225_mode, rotation);
424 drm_mode_config_reset(drm);
426 ret = drm_dev_register(drm, 0);
430 spi_set_drvdata(spi, drm);
432 drm_fbdev_generic_setup(drm, 0);
437 static int ili9225_remove(struct spi_device *spi)
439 struct drm_device *drm = spi_get_drvdata(spi);
442 drm_atomic_helper_shutdown(drm);
447 static void ili9225_shutdown(struct spi_device *spi)
449 drm_atomic_helper_shutdown(spi_get_drvdata(spi));
452 static struct spi_driver ili9225_spi_driver = {
455 .owner = THIS_MODULE,
456 .of_match_table = ili9225_of_match,
458 .id_table = ili9225_id,
459 .probe = ili9225_probe,
460 .remove = ili9225_remove,
461 .shutdown = ili9225_shutdown,
463 module_spi_driver(ili9225_spi_driver);
465 MODULE_DESCRIPTION("Ilitek ILI9225 DRM driver");
466 MODULE_AUTHOR("David Lechner <david@lechnology.com>");
467 MODULE_LICENSE("GPL");