1 // SPDX-License-Identifier: GPL-2.0+ 2 /* 3 * DRM driver for display panels connected to a Sitronix ST7715R or ST7735R 4 * display controller in SPI mode. 5 * 6 * Copyright 2017 David Lechner <david@lechnology.com> 7 * Copyright (C) 2019 Glider bvba 8 */ 9 10 #include <linux/backlight.h> 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/of_device.h> 16 #include <linux/property.h> 17 #include <linux/spi/spi.h> 18 #include <video/mipi_display.h> 19 20 #include <drm/drm_atomic_helper.h> 21 #include <drm/drm_drv.h> 22 #include <drm/drm_fb_helper.h> 23 #include <drm/drm_gem_cma_helper.h> 24 #include <drm/drm_gem_framebuffer_helper.h> 25 #include <drm/drm_mipi_dbi.h> 26 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) 43 #define ST7735R_RGB BIT(3) 44 45 struct 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 53 struct st7735r_priv { 54 struct mipi_dbi_dev dbidev; /* Must be first for .release() */ 55 const struct st7735r_cfg *cfg; 56 }; 57 58 static void st7735r_pipe_enable(struct drm_simple_display_pipe *pipe, 59 struct drm_crtc_state *crtc_state, 60 struct drm_plane_state *plane_state) 61 { 62 struct mipi_dbi_dev *dbidev = drm_to_mipi_dbi_dev(pipe->crtc.dev); 63 struct st7735r_priv *priv = container_of(dbidev, struct st7735r_priv, 64 dbidev); 65 struct mipi_dbi *dbi = &dbidev->dbi; 66 int ret, idx; 67 u8 addr_mode; 68 69 if (!drm_dev_enter(pipe->crtc.dev, &idx)) 70 return; 71 72 DRM_DEBUG_KMS("\n"); 73 74 ret = mipi_dbi_poweron_reset(dbidev); 75 if (ret) 76 goto out_exit; 77 78 msleep(150); 79 80 mipi_dbi_command(dbi, MIPI_DCS_EXIT_SLEEP_MODE); 81 msleep(500); 82 83 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, 86 0x2d); 87 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); 95 switch (dbidev->rotation) { 96 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 } 109 110 if (priv->cfg->rgb) 111 addr_mode |= ST7735R_RGB; 112 113 mipi_dbi_command(dbi, MIPI_DCS_SET_ADDRESS_MODE, addr_mode); 114 mipi_dbi_command(dbi, MIPI_DCS_SET_PIXEL_FORMAT, 115 MIPI_DCS_PIXEL_FMT_16BIT); 116 mipi_dbi_command(dbi, ST7735R_GAMCTRP1, 0x02, 0x1c, 0x07, 0x12, 0x37, 117 0x32, 0x29, 0x2d, 0x29, 0x25, 0x2b, 0x39, 0x00, 0x01, 118 0x03, 0x10); 119 mipi_dbi_command(dbi, ST7735R_GAMCTRN1, 0x03, 0x1d, 0x07, 0x06, 0x2e, 120 0x2c, 0x29, 0x2d, 0x2e, 0x2e, 0x37, 0x3f, 0x00, 0x00, 121 0x02, 0x10); 122 mipi_dbi_command(dbi, MIPI_DCS_SET_DISPLAY_ON); 123 124 msleep(100); 125 126 mipi_dbi_command(dbi, MIPI_DCS_ENTER_NORMAL_MODE); 127 128 msleep(20); 129 130 mipi_dbi_enable_flush(dbidev, crtc_state, plane_state); 131 out_exit: 132 drm_dev_exit(idx); 133 } 134 135 static const struct drm_simple_display_pipe_funcs st7735r_pipe_funcs = { 136 .enable = st7735r_pipe_enable, 137 .disable = mipi_dbi_pipe_disable, 138 .update = mipi_dbi_pipe_update, 139 .prepare_fb = drm_gem_fb_simple_display_pipe_prepare_fb, 140 }; 141 142 static 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 148 static 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, 153 }; 154 155 DEFINE_DRM_GEM_CMA_FOPS(st7735r_fops); 156 157 static struct drm_driver st7735r_driver = { 158 .driver_features = DRIVER_GEM | DRIVER_MODESET | DRIVER_ATOMIC, 159 .fops = &st7735r_fops, 160 .release = mipi_dbi_release, 161 DRM_GEM_CMA_VMAP_DRIVER_OPS, 162 .debugfs_init = mipi_dbi_debugfs_init, 163 .name = "st7735r", 164 .desc = "Sitronix ST7735R", 165 .date = "20171128", 166 .major = 1, 167 .minor = 0, 168 }; 169 170 static const struct of_device_id st7735r_of_match[] = { 171 { .compatible = "jianda,jd-t18003-t01", .data = &jd_t18003_t01_cfg }, 172 { .compatible = "okaya,rh128128t", .data = &rh128128t_cfg }, 173 { }, 174 }; 175 MODULE_DEVICE_TABLE(of, st7735r_of_match); 176 177 static const struct spi_device_id st7735r_id[] = { 178 { "jd-t18003-t01", (uintptr_t)&jd_t18003_t01_cfg }, 179 { }, 180 }; 181 MODULE_DEVICE_TABLE(spi, st7735r_id); 182 183 static int st7735r_probe(struct spi_device *spi) 184 { 185 struct device *dev = &spi->dev; 186 const struct st7735r_cfg *cfg; 187 struct mipi_dbi_dev *dbidev; 188 struct st7735r_priv *priv; 189 struct drm_device *drm; 190 struct mipi_dbi *dbi; 191 struct gpio_desc *dc; 192 u32 rotation = 0; 193 int ret; 194 195 cfg = of_device_get_match_data(&spi->dev); 196 if (!cfg) 197 cfg = (void *)spi_get_device_id(spi)->driver_data; 198 199 priv = kzalloc(sizeof(*priv), GFP_KERNEL); 200 if (!priv) 201 return -ENOMEM; 202 203 dbidev = &priv->dbidev; 204 priv->cfg = cfg; 205 206 dbi = &dbidev->dbi; 207 drm = &dbidev->drm; 208 ret = devm_drm_dev_init(dev, drm, &st7735r_driver); 209 if (ret) { 210 kfree(dbidev); 211 return ret; 212 } 213 214 drm_mode_config_init(drm); 215 216 dbi->reset = devm_gpiod_get(dev, "reset", GPIOD_OUT_HIGH); 217 if (IS_ERR(dbi->reset)) { 218 DRM_DEV_ERROR(dev, "Failed to get gpio 'reset'\n"); 219 return PTR_ERR(dbi->reset); 220 } 221 222 dc = devm_gpiod_get(dev, "dc", GPIOD_OUT_LOW); 223 if (IS_ERR(dc)) { 224 DRM_DEV_ERROR(dev, "Failed to get gpio 'dc'\n"); 225 return PTR_ERR(dc); 226 } 227 228 dbidev->backlight = devm_of_find_backlight(dev); 229 if (IS_ERR(dbidev->backlight)) 230 return PTR_ERR(dbidev->backlight); 231 232 device_property_read_u32(dev, "rotation", &rotation); 233 234 ret = mipi_dbi_spi_init(spi, dbi, dc); 235 if (ret) 236 return ret; 237 238 if (cfg->write_only) 239 dbi->read_commands = NULL; 240 241 dbidev->left_offset = cfg->left_offset; 242 dbidev->top_offset = cfg->top_offset; 243 244 ret = mipi_dbi_dev_init(dbidev, &st7735r_pipe_funcs, &cfg->mode, 245 rotation); 246 if (ret) 247 return ret; 248 249 drm_mode_config_reset(drm); 250 251 ret = drm_dev_register(drm, 0); 252 if (ret) 253 return ret; 254 255 spi_set_drvdata(spi, drm); 256 257 drm_fbdev_generic_setup(drm, 0); 258 259 return 0; 260 } 261 262 static int st7735r_remove(struct spi_device *spi) 263 { 264 struct drm_device *drm = spi_get_drvdata(spi); 265 266 drm_dev_unplug(drm); 267 drm_atomic_helper_shutdown(drm); 268 269 return 0; 270 } 271 272 static void st7735r_shutdown(struct spi_device *spi) 273 { 274 drm_atomic_helper_shutdown(spi_get_drvdata(spi)); 275 } 276 277 static struct spi_driver st7735r_spi_driver = { 278 .driver = { 279 .name = "st7735r", 280 .owner = THIS_MODULE, 281 .of_match_table = st7735r_of_match, 282 }, 283 .id_table = st7735r_id, 284 .probe = st7735r_probe, 285 .remove = st7735r_remove, 286 .shutdown = st7735r_shutdown, 287 }; 288 module_spi_driver(st7735r_spi_driver); 289 290 MODULE_DESCRIPTION("Sitronix ST7735R DRM driver"); 291 MODULE_AUTHOR("David Lechner <david@lechnology.com>"); 292 MODULE_LICENSE("GPL"); 293