1 // SPDX-License-Identifier: GPL-2.0+
3 * DRM driver for Sitronix ST7735R panels
5 * Copyright 2017 David Lechner <david@lechnology.com>
6 * Copyright (C) 2019 Glider bvba
9 #include <linux/backlight.h>
10 #include <linux/delay.h>
11 #include <linux/dma-buf.h>
12 #include <linux/gpio/consumer.h>
13 #include <linux/module.h>
14 #include <linux/of_device.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_drv.h>
21 #include <drm/drm_fb_helper.h>
22 #include <drm/drm_gem_cma_helper.h>
23 #include <drm/drm_gem_framebuffer_helper.h>
24 #include <drm/drm_mipi_dbi.h>
26 #define ST7735R_FRMCTR1 0xb1
27 #define ST7735R_FRMCTR2 0xb2
28 #define ST7735R_FRMCTR3 0xb3
29 #define ST7735R_INVCTR 0xb4
30 #define ST7735R_PWCTR1 0xc0
31 #define ST7735R_PWCTR2 0xc1
32 #define ST7735R_PWCTR3 0xc2
33 #define ST7735R_PWCTR4 0xc3
34 #define ST7735R_PWCTR5 0xc4
35 #define ST7735R_VMCTR1 0xc5
36 #define ST7735R_GAMCTRP1 0xe0
37 #define ST7735R_GAMCTRN1 0xe1
39 #define ST7735R_MY BIT(7)
40 #define ST7735R_MX BIT(6)
41 #define ST7735R_MV BIT(5)
42 #define ST7735R_RGB BIT(3)
45 const struct drm_display_mode mode;
46 unsigned int left_offset;
47 unsigned int top_offset;
48 unsigned int write_only:1;
49 unsigned int rgb:1; /* RGB (vs. BGR) */
53 struct mipi_dbi_dev dbidev; /* Must be first for .release() */
54 const struct st7735r_cfg *cfg;
57 static void st7735r_pipe_enable(struct drm_simple_display_pipe *pipe,
58 struct drm_crtc_state *crtc_state,
59 struct drm_plane_state *plane_state)
61 struct mipi_dbi_dev *dbidev = drm_to_mipi_dbi_dev(pipe->crtc.dev);
62 struct st7735r_priv *priv = container_of(dbidev, struct st7735r_priv,
64 struct mipi_dbi *dbi = &dbidev->dbi;
68 if (!drm_dev_enter(pipe->crtc.dev, &idx))
73 ret = mipi_dbi_poweron_reset(dbidev);
79 mipi_dbi_command(dbi, MIPI_DCS_EXIT_SLEEP_MODE);
82 mipi_dbi_command(dbi, ST7735R_FRMCTR1, 0x01, 0x2c, 0x2d);
83 mipi_dbi_command(dbi, ST7735R_FRMCTR2, 0x01, 0x2c, 0x2d);
84 mipi_dbi_command(dbi, ST7735R_FRMCTR3, 0x01, 0x2c, 0x2d, 0x01, 0x2c,
86 mipi_dbi_command(dbi, ST7735R_INVCTR, 0x07);
87 mipi_dbi_command(dbi, ST7735R_PWCTR1, 0xa2, 0x02, 0x84);
88 mipi_dbi_command(dbi, ST7735R_PWCTR2, 0xc5);
89 mipi_dbi_command(dbi, ST7735R_PWCTR3, 0x0a, 0x00);
90 mipi_dbi_command(dbi, ST7735R_PWCTR4, 0x8a, 0x2a);
91 mipi_dbi_command(dbi, ST7735R_PWCTR5, 0x8a, 0xee);
92 mipi_dbi_command(dbi, ST7735R_VMCTR1, 0x0e);
93 mipi_dbi_command(dbi, MIPI_DCS_EXIT_INVERT_MODE);
94 switch (dbidev->rotation) {
96 addr_mode = ST7735R_MX | ST7735R_MY;
99 addr_mode = ST7735R_MX | ST7735R_MV;
105 addr_mode = ST7735R_MY | ST7735R_MV;
110 addr_mode |= ST7735R_RGB;
112 mipi_dbi_command(dbi, MIPI_DCS_SET_ADDRESS_MODE, addr_mode);
113 mipi_dbi_command(dbi, MIPI_DCS_SET_PIXEL_FORMAT,
114 MIPI_DCS_PIXEL_FMT_16BIT);
115 mipi_dbi_command(dbi, ST7735R_GAMCTRP1, 0x02, 0x1c, 0x07, 0x12, 0x37,
116 0x32, 0x29, 0x2d, 0x29, 0x25, 0x2b, 0x39, 0x00, 0x01,
118 mipi_dbi_command(dbi, ST7735R_GAMCTRN1, 0x03, 0x1d, 0x07, 0x06, 0x2e,
119 0x2c, 0x29, 0x2d, 0x2e, 0x2e, 0x37, 0x3f, 0x00, 0x00,
121 mipi_dbi_command(dbi, MIPI_DCS_SET_DISPLAY_ON);
125 mipi_dbi_command(dbi, MIPI_DCS_ENTER_NORMAL_MODE);
129 mipi_dbi_enable_flush(dbidev, crtc_state, plane_state);
134 static const struct drm_simple_display_pipe_funcs st7735r_pipe_funcs = {
135 .enable = st7735r_pipe_enable,
136 .disable = mipi_dbi_pipe_disable,
137 .update = mipi_dbi_pipe_update,
138 .prepare_fb = drm_gem_fb_simple_display_pipe_prepare_fb,
141 static const struct st7735r_cfg jd_t18003_t01_cfg = {
142 .mode = { DRM_SIMPLE_MODE(128, 160, 28, 35) },
143 /* Cannot read from Adafruit 1.8" display via SPI */
149 DEFINE_DRM_GEM_CMA_FOPS(st7735r_fops);
151 static struct drm_driver st7735r_driver = {
152 .driver_features = DRIVER_GEM | DRIVER_MODESET | DRIVER_ATOMIC,
153 .fops = &st7735r_fops,
154 .release = mipi_dbi_release,
155 DRM_GEM_CMA_VMAP_DRIVER_OPS,
156 .debugfs_init = mipi_dbi_debugfs_init,
158 .desc = "Sitronix ST7735R",
164 static const struct of_device_id st7735r_of_match[] = {
165 { .compatible = "jianda,jd-t18003-t01", .data = &jd_t18003_t01_cfg },
168 MODULE_DEVICE_TABLE(of, st7735r_of_match);
170 static const struct spi_device_id st7735r_id[] = {
171 { "jd-t18003-t01", (uintptr_t)&jd_t18003_t01_cfg },
174 MODULE_DEVICE_TABLE(spi, st7735r_id);
176 static int st7735r_probe(struct spi_device *spi)
178 struct device *dev = &spi->dev;
179 const struct st7735r_cfg *cfg;
180 struct mipi_dbi_dev *dbidev;
181 struct st7735r_priv *priv;
182 struct drm_device *drm;
183 struct mipi_dbi *dbi;
184 struct gpio_desc *dc;
188 cfg = of_device_get_match_data(&spi->dev);
190 cfg = (void *)spi_get_device_id(spi)->driver_data;
192 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
196 dbidev = &priv->dbidev;
201 ret = devm_drm_dev_init(dev, drm, &st7735r_driver);
207 drm_mode_config_init(drm);
209 dbi->reset = devm_gpiod_get(dev, "reset", GPIOD_OUT_HIGH);
210 if (IS_ERR(dbi->reset)) {
211 DRM_DEV_ERROR(dev, "Failed to get gpio 'reset'\n");
212 return PTR_ERR(dbi->reset);
215 dc = devm_gpiod_get(dev, "dc", GPIOD_OUT_LOW);
217 DRM_DEV_ERROR(dev, "Failed to get gpio 'dc'\n");
221 dbidev->backlight = devm_of_find_backlight(dev);
222 if (IS_ERR(dbidev->backlight))
223 return PTR_ERR(dbidev->backlight);
225 device_property_read_u32(dev, "rotation", &rotation);
227 ret = mipi_dbi_spi_init(spi, dbi, dc);
232 dbi->read_commands = NULL;
234 dbidev->left_offset = cfg->left_offset;
235 dbidev->top_offset = cfg->top_offset;
237 ret = mipi_dbi_dev_init(dbidev, &st7735r_pipe_funcs, &cfg->mode,
242 drm_mode_config_reset(drm);
244 ret = drm_dev_register(drm, 0);
248 spi_set_drvdata(spi, drm);
250 drm_fbdev_generic_setup(drm, 0);
255 static int st7735r_remove(struct spi_device *spi)
257 struct drm_device *drm = spi_get_drvdata(spi);
260 drm_atomic_helper_shutdown(drm);
265 static void st7735r_shutdown(struct spi_device *spi)
267 drm_atomic_helper_shutdown(spi_get_drvdata(spi));
270 static struct spi_driver st7735r_spi_driver = {
273 .owner = THIS_MODULE,
274 .of_match_table = st7735r_of_match,
276 .id_table = st7735r_id,
277 .probe = st7735r_probe,
278 .remove = st7735r_remove,
279 .shutdown = st7735r_shutdown,
281 module_spi_driver(st7735r_spi_driver);
283 MODULE_DESCRIPTION("Sitronix ST7735R DRM driver");
284 MODULE_AUTHOR("David Lechner <david@lechnology.com>");
285 MODULE_LICENSE("GPL");