blob: c36ba08acda1896376a56c79efbfed3ecd8fd7ce [file] [log] [blame]
David Lechner5b8ea812018-01-01 13:02:16 -06001// SPDX-License-Identifier: GPL-2.0+
2/*
Geert Uytterhoevend1d511d2020-01-15 13:45:48 +01003 * DRM driver for display panels connected to a Sitronix ST7715R or ST7735R
4 * display controller in SPI mode.
David Lechner5b8ea812018-01-01 13:02:16 -06005 *
6 * Copyright 2017 David Lechner <david@lechnology.com>
Geert Uytterhoeven98823f32020-01-15 13:45:47 +01007 * Copyright (C) 2019 Glider bvba
David Lechner5b8ea812018-01-01 13:02:16 -06008 */
9
Meghana Madhyasthad1a2e702018-01-24 16:36:09 +000010#include <linux/backlight.h>
David Lechner5b8ea812018-01-01 13:02:16 -060011#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>
18
Noralf Trønnesd0a51632019-02-10 14:10:33 +010019#include <drm/drm_atomic_helper.h>
Sam Ravnborg84056e92019-01-08 20:29:38 +010020#include <drm/drm_drv.h>
Noralf Trønnes3eba3922019-02-25 15:42:30 +010021#include <drm/drm_fb_helper.h>
Thomas Zimmermann820c1702021-02-22 15:17:56 +010022#include <drm/drm_gem_atomic_helper.h>
Danilo Krummrich4a83c262022-08-02 02:04:03 +020023#include <drm/drm_gem_dma_helper.h>
Daniel Vetterf5ad6712020-03-23 15:49:04 +010024#include <drm/drm_managed.h>
Noralf Trønnes174102f2019-07-22 12:43:11 +020025#include <drm/drm_mipi_dbi.h>
David Lechner5b8ea812018-01-01 13:02:16 -060026
27#define ST7735R_FRMCTR1 0xb1
28#define ST7735R_FRMCTR2 0xb2
29#define ST7735R_FRMCTR3 0xb3
30#define ST7735R_INVCTR 0xb4
31#define ST7735R_PWCTR1 0xc0
32#define ST7735R_PWCTR2 0xc1
33#define ST7735R_PWCTR3 0xc2
34#define ST7735R_PWCTR4 0xc3
35#define ST7735R_PWCTR5 0xc4
36#define ST7735R_VMCTR1 0xc5
37#define ST7735R_GAMCTRP1 0xe0
38#define ST7735R_GAMCTRN1 0xe1
39
40#define ST7735R_MY BIT(7)
41#define ST7735R_MX BIT(6)
42#define ST7735R_MV BIT(5)
Geert Uytterhoeven98823f32020-01-15 13:45:47 +010043#define ST7735R_RGB BIT(3)
David Lechner5b8ea812018-01-01 13:02:16 -060044
Geert Uytterhoeven98823f32020-01-15 13:45:47 +010045struct st7735r_cfg {
46 const struct drm_display_mode mode;
47 unsigned int left_offset;
48 unsigned int top_offset;
49 unsigned int write_only:1;
50 unsigned int rgb:1; /* RGB (vs. BGR) */
51};
52
53struct st7735r_priv {
54 struct mipi_dbi_dev dbidev; /* Must be first for .release() */
55 const struct st7735r_cfg *cfg;
56};
57
58static void st7735r_pipe_enable(struct drm_simple_display_pipe *pipe,
59 struct drm_crtc_state *crtc_state,
60 struct drm_plane_state *plane_state)
David Lechner5b8ea812018-01-01 13:02:16 -060061{
Noralf Trønnes84137b82019-07-22 12:43:07 +020062 struct mipi_dbi_dev *dbidev = drm_to_mipi_dbi_dev(pipe->crtc.dev);
Geert Uytterhoeven98823f32020-01-15 13:45:47 +010063 struct st7735r_priv *priv = container_of(dbidev, struct st7735r_priv,
64 dbidev);
Noralf Trønnes84137b82019-07-22 12:43:07 +020065 struct mipi_dbi *dbi = &dbidev->dbi;
Noralf Trønnes9d5645a2019-02-25 15:42:32 +010066 int ret, idx;
David Lechner5b8ea812018-01-01 13:02:16 -060067 u8 addr_mode;
68
Noralf Trønnes9d5645a2019-02-25 15:42:32 +010069 if (!drm_dev_enter(pipe->crtc.dev, &idx))
70 return;
71
David Lechner5b8ea812018-01-01 13:02:16 -060072 DRM_DEBUG_KMS("\n");
73
Noralf Trønnes440961d2019-07-22 12:43:06 +020074 ret = mipi_dbi_poweron_reset(dbidev);
Noralf Trønnes070ab122018-01-10 19:59:37 +010075 if (ret)
Noralf Trønnes9d5645a2019-02-25 15:42:32 +010076 goto out_exit;
David Lechner5b8ea812018-01-01 13:02:16 -060077
78 msleep(150);
79
Noralf Trønnes36b50572019-07-22 12:43:05 +020080 mipi_dbi_command(dbi, MIPI_DCS_EXIT_SLEEP_MODE);
David Lechner5b8ea812018-01-01 13:02:16 -060081 msleep(500);
82
Noralf Trønnes36b50572019-07-22 12:43:05 +020083 mipi_dbi_command(dbi, ST7735R_FRMCTR1, 0x01, 0x2c, 0x2d);
84 mipi_dbi_command(dbi, ST7735R_FRMCTR2, 0x01, 0x2c, 0x2d);
85 mipi_dbi_command(dbi, ST7735R_FRMCTR3, 0x01, 0x2c, 0x2d, 0x01, 0x2c,
David Lechner5b8ea812018-01-01 13:02:16 -060086 0x2d);
Noralf Trønnes36b50572019-07-22 12:43:05 +020087 mipi_dbi_command(dbi, ST7735R_INVCTR, 0x07);
88 mipi_dbi_command(dbi, ST7735R_PWCTR1, 0xa2, 0x02, 0x84);
89 mipi_dbi_command(dbi, ST7735R_PWCTR2, 0xc5);
90 mipi_dbi_command(dbi, ST7735R_PWCTR3, 0x0a, 0x00);
91 mipi_dbi_command(dbi, ST7735R_PWCTR4, 0x8a, 0x2a);
92 mipi_dbi_command(dbi, ST7735R_PWCTR5, 0x8a, 0xee);
93 mipi_dbi_command(dbi, ST7735R_VMCTR1, 0x0e);
94 mipi_dbi_command(dbi, MIPI_DCS_EXIT_INVERT_MODE);
Noralf Trønnes440961d2019-07-22 12:43:06 +020095 switch (dbidev->rotation) {
David Lechner5b8ea812018-01-01 13:02:16 -060096 default:
97 addr_mode = ST7735R_MX | ST7735R_MY;
98 break;
99 case 90:
100 addr_mode = ST7735R_MX | ST7735R_MV;
101 break;
102 case 180:
103 addr_mode = 0;
104 break;
105 case 270:
106 addr_mode = ST7735R_MY | ST7735R_MV;
107 break;
108 }
Geert Uytterhoeven98823f32020-01-15 13:45:47 +0100109
110 if (priv->cfg->rgb)
111 addr_mode |= ST7735R_RGB;
112
Noralf Trønnes36b50572019-07-22 12:43:05 +0200113 mipi_dbi_command(dbi, MIPI_DCS_SET_ADDRESS_MODE, addr_mode);
114 mipi_dbi_command(dbi, MIPI_DCS_SET_PIXEL_FORMAT,
David Lechner5b8ea812018-01-01 13:02:16 -0600115 MIPI_DCS_PIXEL_FMT_16BIT);
Noralf Trønnes36b50572019-07-22 12:43:05 +0200116 mipi_dbi_command(dbi, ST7735R_GAMCTRP1, 0x02, 0x1c, 0x07, 0x12, 0x37,
David Lechner5b8ea812018-01-01 13:02:16 -0600117 0x32, 0x29, 0x2d, 0x29, 0x25, 0x2b, 0x39, 0x00, 0x01,
118 0x03, 0x10);
Noralf Trønnes36b50572019-07-22 12:43:05 +0200119 mipi_dbi_command(dbi, ST7735R_GAMCTRN1, 0x03, 0x1d, 0x07, 0x06, 0x2e,
David Lechner5b8ea812018-01-01 13:02:16 -0600120 0x2c, 0x29, 0x2d, 0x2e, 0x2e, 0x37, 0x3f, 0x00, 0x00,
121 0x02, 0x10);
Noralf Trønnes36b50572019-07-22 12:43:05 +0200122 mipi_dbi_command(dbi, MIPI_DCS_SET_DISPLAY_ON);
David Lechner5b8ea812018-01-01 13:02:16 -0600123
124 msleep(100);
125
Noralf Trønnes36b50572019-07-22 12:43:05 +0200126 mipi_dbi_command(dbi, MIPI_DCS_ENTER_NORMAL_MODE);
David Lechner5b8ea812018-01-01 13:02:16 -0600127
128 msleep(20);
129
Noralf Trønnes440961d2019-07-22 12:43:06 +0200130 mipi_dbi_enable_flush(dbidev, crtc_state, plane_state);
Noralf Trønnes9d5645a2019-02-25 15:42:32 +0100131out_exit:
132 drm_dev_exit(idx);
David Lechner5b8ea812018-01-01 13:02:16 -0600133}
134
Geert Uytterhoeven98823f32020-01-15 13:45:47 +0100135static const struct drm_simple_display_pipe_funcs st7735r_pipe_funcs = {
Thomas Zimmermann216b9bb2022-09-05 16:16:46 +0200136 .mode_valid = mipi_dbi_pipe_mode_valid,
Geert Uytterhoeven98823f32020-01-15 13:45:47 +0100137 .enable = st7735r_pipe_enable,
David Lechner5b8ea812018-01-01 13:02:16 -0600138 .disable = mipi_dbi_pipe_disable,
Noralf Trønnesaf741382019-01-15 05:36:42 +0100139 .update = mipi_dbi_pipe_update,
David Lechner5b8ea812018-01-01 13:02:16 -0600140};
141
Geert Uytterhoeven98823f32020-01-15 13:45:47 +0100142static const struct st7735r_cfg jd_t18003_t01_cfg = {
143 .mode = { DRM_SIMPLE_MODE(128, 160, 28, 35) },
144 /* Cannot read from Adafruit 1.8" display via SPI */
145 .write_only = true,
146};
147
Geert Uytterhoevend1d511d2020-01-15 13:45:48 +0100148static const struct st7735r_cfg rh128128t_cfg = {
149 .mode = { DRM_SIMPLE_MODE(128, 128, 25, 26) },
150 .left_offset = 2,
151 .top_offset = 3,
152 .rgb = true,
David Lechner5b8ea812018-01-01 13:02:16 -0600153};
154
Danilo Krummrich4a83c262022-08-02 02:04:03 +0200155DEFINE_DRM_GEM_DMA_FOPS(st7735r_fops);
David Lechner5b8ea812018-01-01 13:02:16 -0600156
Daniel Vetter70a59dd2020-11-04 11:04:24 +0100157static const struct drm_driver st7735r_driver = {
Daniel Vetter0424fda2019-06-17 17:39:24 +0200158 .driver_features = DRIVER_GEM | DRIVER_MODESET | DRIVER_ATOMIC,
David Lechner5b8ea812018-01-01 13:02:16 -0600159 .fops = &st7735r_fops,
Danilo Krummrich4a83c262022-08-02 02:04:03 +0200160 DRM_GEM_DMA_DRIVER_OPS_VMAP,
David Lechner5b8ea812018-01-01 13:02:16 -0600161 .debugfs_init = mipi_dbi_debugfs_init,
162 .name = "st7735r",
163 .desc = "Sitronix ST7735R",
164 .date = "20171128",
165 .major = 1,
166 .minor = 0,
167};
168
169static const struct of_device_id st7735r_of_match[] = {
Geert Uytterhoeven98823f32020-01-15 13:45:47 +0100170 { .compatible = "jianda,jd-t18003-t01", .data = &jd_t18003_t01_cfg },
Geert Uytterhoevend1d511d2020-01-15 13:45:48 +0100171 { .compatible = "okaya,rh128128t", .data = &rh128128t_cfg },
David Lechner5b8ea812018-01-01 13:02:16 -0600172 { },
173};
174MODULE_DEVICE_TABLE(of, st7735r_of_match);
175
176static const struct spi_device_id st7735r_id[] = {
Geert Uytterhoeven98823f32020-01-15 13:45:47 +0100177 { "jd-t18003-t01", (uintptr_t)&jd_t18003_t01_cfg },
Javier Martinez Canillas9ad6f182022-05-20 11:16:02 +0200178 { "rh128128t", (uintptr_t)&rh128128t_cfg },
David Lechner5b8ea812018-01-01 13:02:16 -0600179 { },
180};
181MODULE_DEVICE_TABLE(spi, st7735r_id);
182
183static int st7735r_probe(struct spi_device *spi)
184{
185 struct device *dev = &spi->dev;
Geert Uytterhoeven98823f32020-01-15 13:45:47 +0100186 const struct st7735r_cfg *cfg;
Noralf Trønnes84137b82019-07-22 12:43:07 +0200187 struct mipi_dbi_dev *dbidev;
Geert Uytterhoeven98823f32020-01-15 13:45:47 +0100188 struct st7735r_priv *priv;
Noralf Trønnes3eba3922019-02-25 15:42:30 +0100189 struct drm_device *drm;
Noralf Trønnes36b50572019-07-22 12:43:05 +0200190 struct mipi_dbi *dbi;
David Lechner5b8ea812018-01-01 13:02:16 -0600191 struct gpio_desc *dc;
192 u32 rotation = 0;
193 int ret;
194
Andy Shevchenko5703d6a2020-01-31 22:49:26 +0200195 cfg = device_get_match_data(&spi->dev);
Geert Uytterhoeven98823f32020-01-15 13:45:47 +0100196 if (!cfg)
197 cfg = (void *)spi_get_device_id(spi)->driver_data;
198
Daniel Vetter14877bc72020-04-15 09:39:48 +0200199 priv = devm_drm_dev_alloc(dev, &st7735r_driver,
200 struct st7735r_priv, dbidev.drm);
201 if (IS_ERR(priv))
202 return PTR_ERR(priv);
David Lechner5b8ea812018-01-01 13:02:16 -0600203
Geert Uytterhoeven98823f32020-01-15 13:45:47 +0100204 dbidev = &priv->dbidev;
205 priv->cfg = cfg;
206
Noralf Trønnes84137b82019-07-22 12:43:07 +0200207 dbi = &dbidev->dbi;
Noralf Trønnes440961d2019-07-22 12:43:06 +0200208 drm = &dbidev->drm;
Noralf Trønnes3eba3922019-02-25 15:42:30 +0100209
Noralf Trønnes36b50572019-07-22 12:43:05 +0200210 dbi->reset = devm_gpiod_get(dev, "reset", GPIOD_OUT_HIGH);
Andy Shevchenkoa3204e22021-04-21 19:31:51 +0300211 if (IS_ERR(dbi->reset))
212 return dev_err_probe(dev, PTR_ERR(dbi->reset), "Failed to get GPIO 'reset'\n");
David Lechner5b8ea812018-01-01 13:02:16 -0600213
214 dc = devm_gpiod_get(dev, "dc", GPIOD_OUT_LOW);
Andy Shevchenkoa3204e22021-04-21 19:31:51 +0300215 if (IS_ERR(dc))
216 return dev_err_probe(dev, PTR_ERR(dc), "Failed to get GPIO 'dc'\n");
David Lechner5b8ea812018-01-01 13:02:16 -0600217
Noralf Trønnes440961d2019-07-22 12:43:06 +0200218 dbidev->backlight = devm_of_find_backlight(dev);
219 if (IS_ERR(dbidev->backlight))
220 return PTR_ERR(dbidev->backlight);
David Lechner5b8ea812018-01-01 13:02:16 -0600221
222 device_property_read_u32(dev, "rotation", &rotation);
223
Noralf Trønnes36b50572019-07-22 12:43:05 +0200224 ret = mipi_dbi_spi_init(spi, dbi, dc);
David Lechner5b8ea812018-01-01 13:02:16 -0600225 if (ret)
226 return ret;
227
Geert Uytterhoeven98823f32020-01-15 13:45:47 +0100228 if (cfg->write_only)
229 dbi->read_commands = NULL;
David Lechner5b8ea812018-01-01 13:02:16 -0600230
Geert Uytterhoeven98823f32020-01-15 13:45:47 +0100231 dbidev->left_offset = cfg->left_offset;
232 dbidev->top_offset = cfg->top_offset;
233
234 ret = mipi_dbi_dev_init(dbidev, &st7735r_pipe_funcs, &cfg->mode,
235 rotation);
David Lechner5b8ea812018-01-01 13:02:16 -0600236 if (ret)
237 return ret;
238
Noralf Trønnes3eba3922019-02-25 15:42:30 +0100239 drm_mode_config_reset(drm);
David Lechner5b8ea812018-01-01 13:02:16 -0600240
Noralf Trønnes3eba3922019-02-25 15:42:30 +0100241 ret = drm_dev_register(drm, 0);
242 if (ret)
243 return ret;
244
245 spi_set_drvdata(spi, drm);
246
Noralf Trønnesf47056e2019-04-10 14:43:45 +0200247 drm_fbdev_generic_setup(drm, 0);
Noralf Trønnes3eba3922019-02-25 15:42:30 +0100248
249 return 0;
250}
251
Uwe Kleine-Königa0386bb2022-01-23 18:52:01 +0100252static void st7735r_remove(struct spi_device *spi)
Noralf Trønnes3eba3922019-02-25 15:42:30 +0100253{
254 struct drm_device *drm = spi_get_drvdata(spi);
255
256 drm_dev_unplug(drm);
257 drm_atomic_helper_shutdown(drm);
David Lechner5b8ea812018-01-01 13:02:16 -0600258}
259
260static void st7735r_shutdown(struct spi_device *spi)
261{
Noralf Trønnesd0a51632019-02-10 14:10:33 +0100262 drm_atomic_helper_shutdown(spi_get_drvdata(spi));
David Lechner5b8ea812018-01-01 13:02:16 -0600263}
264
265static struct spi_driver st7735r_spi_driver = {
266 .driver = {
267 .name = "st7735r",
David Lechner5b8ea812018-01-01 13:02:16 -0600268 .of_match_table = st7735r_of_match,
269 },
270 .id_table = st7735r_id,
271 .probe = st7735r_probe,
Noralf Trønnes3eba3922019-02-25 15:42:30 +0100272 .remove = st7735r_remove,
David Lechner5b8ea812018-01-01 13:02:16 -0600273 .shutdown = st7735r_shutdown,
274};
275module_spi_driver(st7735r_spi_driver);
276
277MODULE_DESCRIPTION("Sitronix ST7735R DRM driver");
278MODULE_AUTHOR("David Lechner <david@lechnology.com>");
279MODULE_LICENSE("GPL");