1 // SPDX-License-Identifier: GPL-2.0-or-later 2 /* 3 * DRM driver for Ilitek ILI9225 panels 4 * 5 * Copyright 2017 David Lechner <david@lechnology.com> 6 * 7 * Some code copied from mipi-dbi.c 8 * Copyright 2016 Noralf Trønnes 9 */ 10 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> 18 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_managed.h> 28 #include <drm/drm_mipi_dbi.h> 29 #include <drm/drm_rect.h> 30 31 #define ILI9225_DRIVER_READ_CODE 0x00 32 #define ILI9225_DRIVER_OUTPUT_CONTROL 0x01 33 #define ILI9225_LCD_AC_DRIVING_CONTROL 0x02 34 #define ILI9225_ENTRY_MODE 0x03 35 #define ILI9225_DISPLAY_CONTROL_1 0x07 36 #define ILI9225_BLANK_PERIOD_CONTROL_1 0x08 37 #define ILI9225_FRAME_CYCLE_CONTROL 0x0b 38 #define ILI9225_INTERFACE_CONTROL 0x0c 39 #define ILI9225_OSCILLATION_CONTROL 0x0f 40 #define ILI9225_POWER_CONTROL_1 0x10 41 #define ILI9225_POWER_CONTROL_2 0x11 42 #define ILI9225_POWER_CONTROL_3 0x12 43 #define ILI9225_POWER_CONTROL_4 0x13 44 #define ILI9225_POWER_CONTROL_5 0x14 45 #define ILI9225_VCI_RECYCLING 0x15 46 #define ILI9225_RAM_ADDRESS_SET_1 0x20 47 #define ILI9225_RAM_ADDRESS_SET_2 0x21 48 #define ILI9225_WRITE_DATA_TO_GRAM 0x22 49 #define ILI9225_SOFTWARE_RESET 0x28 50 #define ILI9225_GATE_SCAN_CONTROL 0x30 51 #define ILI9225_VERTICAL_SCROLL_1 0x31 52 #define ILI9225_VERTICAL_SCROLL_2 0x32 53 #define ILI9225_VERTICAL_SCROLL_3 0x33 54 #define ILI9225_PARTIAL_DRIVING_POS_1 0x34 55 #define ILI9225_PARTIAL_DRIVING_POS_2 0x35 56 #define ILI9225_HORIZ_WINDOW_ADDR_1 0x36 57 #define ILI9225_HORIZ_WINDOW_ADDR_2 0x37 58 #define ILI9225_VERT_WINDOW_ADDR_1 0x38 59 #define ILI9225_VERT_WINDOW_ADDR_2 0x39 60 #define ILI9225_GAMMA_CONTROL_1 0x50 61 #define ILI9225_GAMMA_CONTROL_2 0x51 62 #define ILI9225_GAMMA_CONTROL_3 0x52 63 #define ILI9225_GAMMA_CONTROL_4 0x53 64 #define ILI9225_GAMMA_CONTROL_5 0x54 65 #define ILI9225_GAMMA_CONTROL_6 0x55 66 #define ILI9225_GAMMA_CONTROL_7 0x56 67 #define ILI9225_GAMMA_CONTROL_8 0x57 68 #define ILI9225_GAMMA_CONTROL_9 0x58 69 #define ILI9225_GAMMA_CONTROL_10 0x59 70 71 static inline int ili9225_command(struct mipi_dbi *dbi, u8 cmd, u16 data) 72 { 73 u8 par[2] = { data >> 8, data & 0xff }; 74 75 return mipi_dbi_command_buf(dbi, cmd, par, 2); 76 } 77 78 static void ili9225_fb_dirty(struct drm_framebuffer *fb, struct drm_rect *rect) 79 { 80 struct drm_gem_cma_object *cma_obj = drm_fb_cma_get_gem_obj(fb, 0); 81 struct mipi_dbi_dev *dbidev = drm_to_mipi_dbi_dev(fb->dev); 82 unsigned int height = rect->y2 - rect->y1; 83 unsigned int width = rect->x2 - rect->x1; 84 struct mipi_dbi *dbi = &dbidev->dbi; 85 bool swap = dbi->swap_bytes; 86 u16 x_start, y_start; 87 u16 x1, x2, y1, y2; 88 int idx, ret = 0; 89 bool full; 90 void *tr; 91 92 if (!dbidev->enabled) 93 return; 94 95 if (!drm_dev_enter(fb->dev, &idx)) 96 return; 97 98 full = width == fb->width && height == fb->height; 99 100 DRM_DEBUG_KMS("Flushing [FB:%d] " DRM_RECT_FMT "\n", fb->base.id, DRM_RECT_ARG(rect)); 101 102 if (!dbi->dc || !full || swap || 103 fb->format->format == DRM_FORMAT_XRGB8888) { 104 tr = dbidev->tx_buf; 105 ret = mipi_dbi_buf_copy(dbidev->tx_buf, fb, rect, swap); 106 if (ret) 107 goto err_msg; 108 } else { 109 tr = cma_obj->vaddr; 110 } 111 112 switch (dbidev->rotation) { 113 default: 114 x1 = rect->x1; 115 x2 = rect->x2 - 1; 116 y1 = rect->y1; 117 y2 = rect->y2 - 1; 118 x_start = x1; 119 y_start = y1; 120 break; 121 case 90: 122 x1 = rect->y1; 123 x2 = rect->y2 - 1; 124 y1 = fb->width - rect->x2; 125 y2 = fb->width - rect->x1 - 1; 126 x_start = x1; 127 y_start = y2; 128 break; 129 case 180: 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; 134 x_start = x2; 135 y_start = y2; 136 break; 137 case 270: 138 x1 = fb->height - rect->y2; 139 x2 = fb->height - rect->y1 - 1; 140 y1 = rect->x1; 141 y2 = rect->x2 - 1; 142 x_start = x2; 143 y_start = y1; 144 break; 145 } 146 147 ili9225_command(dbi, ILI9225_HORIZ_WINDOW_ADDR_1, x2); 148 ili9225_command(dbi, ILI9225_HORIZ_WINDOW_ADDR_2, x1); 149 ili9225_command(dbi, ILI9225_VERT_WINDOW_ADDR_1, y2); 150 ili9225_command(dbi, ILI9225_VERT_WINDOW_ADDR_2, y1); 151 152 ili9225_command(dbi, ILI9225_RAM_ADDRESS_SET_1, x_start); 153 ili9225_command(dbi, ILI9225_RAM_ADDRESS_SET_2, y_start); 154 155 ret = mipi_dbi_command_buf(dbi, ILI9225_WRITE_DATA_TO_GRAM, tr, 156 width * height * 2); 157 err_msg: 158 if (ret) 159 dev_err_once(fb->dev->dev, "Failed to update display %d\n", ret); 160 161 drm_dev_exit(idx); 162 } 163 164 static void ili9225_pipe_update(struct drm_simple_display_pipe *pipe, 165 struct drm_plane_state *old_state) 166 { 167 struct drm_plane_state *state = pipe->plane.state; 168 struct drm_rect rect; 169 170 if (drm_atomic_helper_damage_merged(old_state, state, &rect)) 171 ili9225_fb_dirty(state->fb, &rect); 172 } 173 174 static void ili9225_pipe_enable(struct drm_simple_display_pipe *pipe, 175 struct drm_crtc_state *crtc_state, 176 struct drm_plane_state *plane_state) 177 { 178 struct mipi_dbi_dev *dbidev = drm_to_mipi_dbi_dev(pipe->crtc.dev); 179 struct drm_framebuffer *fb = plane_state->fb; 180 struct device *dev = pipe->crtc.dev->dev; 181 struct mipi_dbi *dbi = &dbidev->dbi; 182 struct drm_rect rect = { 183 .x1 = 0, 184 .x2 = fb->width, 185 .y1 = 0, 186 .y2 = fb->height, 187 }; 188 int ret, idx; 189 u8 am_id; 190 191 if (!drm_dev_enter(pipe->crtc.dev, &idx)) 192 return; 193 194 DRM_DEBUG_KMS("\n"); 195 196 mipi_dbi_hw_reset(dbi); 197 198 /* 199 * There don't seem to be two example init sequences that match, so 200 * using the one from the popular Arduino library for this display. 201 * https://github.com/Nkawu/TFT_22_ILI9225/blob/master/src/TFT_22_ILI9225.cpp 202 */ 203 204 ret = ili9225_command(dbi, ILI9225_POWER_CONTROL_1, 0x0000); 205 if (ret) { 206 DRM_DEV_ERROR(dev, "Error sending command %d\n", ret); 207 goto out_exit; 208 } 209 ili9225_command(dbi, ILI9225_POWER_CONTROL_2, 0x0000); 210 ili9225_command(dbi, ILI9225_POWER_CONTROL_3, 0x0000); 211 ili9225_command(dbi, ILI9225_POWER_CONTROL_4, 0x0000); 212 ili9225_command(dbi, ILI9225_POWER_CONTROL_5, 0x0000); 213 214 msleep(40); 215 216 ili9225_command(dbi, ILI9225_POWER_CONTROL_2, 0x0018); 217 ili9225_command(dbi, ILI9225_POWER_CONTROL_3, 0x6121); 218 ili9225_command(dbi, ILI9225_POWER_CONTROL_4, 0x006f); 219 ili9225_command(dbi, ILI9225_POWER_CONTROL_5, 0x495f); 220 ili9225_command(dbi, ILI9225_POWER_CONTROL_1, 0x0800); 221 222 msleep(10); 223 224 ili9225_command(dbi, ILI9225_POWER_CONTROL_2, 0x103b); 225 226 msleep(50); 227 228 switch (dbidev->rotation) { 229 default: 230 am_id = 0x30; 231 break; 232 case 90: 233 am_id = 0x18; 234 break; 235 case 180: 236 am_id = 0x00; 237 break; 238 case 270: 239 am_id = 0x28; 240 break; 241 } 242 ili9225_command(dbi, ILI9225_DRIVER_OUTPUT_CONTROL, 0x011c); 243 ili9225_command(dbi, ILI9225_LCD_AC_DRIVING_CONTROL, 0x0100); 244 ili9225_command(dbi, ILI9225_ENTRY_MODE, 0x1000 | am_id); 245 ili9225_command(dbi, ILI9225_DISPLAY_CONTROL_1, 0x0000); 246 ili9225_command(dbi, ILI9225_BLANK_PERIOD_CONTROL_1, 0x0808); 247 ili9225_command(dbi, ILI9225_FRAME_CYCLE_CONTROL, 0x1100); 248 ili9225_command(dbi, ILI9225_INTERFACE_CONTROL, 0x0000); 249 ili9225_command(dbi, ILI9225_OSCILLATION_CONTROL, 0x0d01); 250 ili9225_command(dbi, ILI9225_VCI_RECYCLING, 0x0020); 251 ili9225_command(dbi, ILI9225_RAM_ADDRESS_SET_1, 0x0000); 252 ili9225_command(dbi, ILI9225_RAM_ADDRESS_SET_2, 0x0000); 253 254 ili9225_command(dbi, ILI9225_GATE_SCAN_CONTROL, 0x0000); 255 ili9225_command(dbi, ILI9225_VERTICAL_SCROLL_1, 0x00db); 256 ili9225_command(dbi, ILI9225_VERTICAL_SCROLL_2, 0x0000); 257 ili9225_command(dbi, ILI9225_VERTICAL_SCROLL_3, 0x0000); 258 ili9225_command(dbi, ILI9225_PARTIAL_DRIVING_POS_1, 0x00db); 259 ili9225_command(dbi, ILI9225_PARTIAL_DRIVING_POS_2, 0x0000); 260 261 ili9225_command(dbi, ILI9225_GAMMA_CONTROL_1, 0x0000); 262 ili9225_command(dbi, ILI9225_GAMMA_CONTROL_2, 0x0808); 263 ili9225_command(dbi, ILI9225_GAMMA_CONTROL_3, 0x080a); 264 ili9225_command(dbi, ILI9225_GAMMA_CONTROL_4, 0x000a); 265 ili9225_command(dbi, ILI9225_GAMMA_CONTROL_5, 0x0a08); 266 ili9225_command(dbi, ILI9225_GAMMA_CONTROL_6, 0x0808); 267 ili9225_command(dbi, ILI9225_GAMMA_CONTROL_7, 0x0000); 268 ili9225_command(dbi, ILI9225_GAMMA_CONTROL_8, 0x0a00); 269 ili9225_command(dbi, ILI9225_GAMMA_CONTROL_9, 0x0710); 270 ili9225_command(dbi, ILI9225_GAMMA_CONTROL_10, 0x0710); 271 272 ili9225_command(dbi, ILI9225_DISPLAY_CONTROL_1, 0x0012); 273 274 msleep(50); 275 276 ili9225_command(dbi, ILI9225_DISPLAY_CONTROL_1, 0x1017); 277 278 dbidev->enabled = true; 279 ili9225_fb_dirty(fb, &rect); 280 out_exit: 281 drm_dev_exit(idx); 282 } 283 284 static void ili9225_pipe_disable(struct drm_simple_display_pipe *pipe) 285 { 286 struct mipi_dbi_dev *dbidev = drm_to_mipi_dbi_dev(pipe->crtc.dev); 287 struct mipi_dbi *dbi = &dbidev->dbi; 288 289 DRM_DEBUG_KMS("\n"); 290 291 /* 292 * This callback is not protected by drm_dev_enter/exit since we want to 293 * turn off the display on regular driver unload. It's highly unlikely 294 * that the underlying SPI controller is gone should this be called after 295 * unplug. 296 */ 297 298 if (!dbidev->enabled) 299 return; 300 301 ili9225_command(dbi, ILI9225_DISPLAY_CONTROL_1, 0x0000); 302 msleep(50); 303 ili9225_command(dbi, ILI9225_POWER_CONTROL_2, 0x0007); 304 msleep(50); 305 ili9225_command(dbi, ILI9225_POWER_CONTROL_1, 0x0a02); 306 307 dbidev->enabled = false; 308 } 309 310 static int ili9225_dbi_command(struct mipi_dbi *dbi, u8 *cmd, u8 *par, 311 size_t num) 312 { 313 struct spi_device *spi = dbi->spi; 314 unsigned int bpw = 8; 315 u32 speed_hz; 316 int ret; 317 318 gpiod_set_value_cansleep(dbi->dc, 0); 319 speed_hz = mipi_dbi_spi_cmd_max_speed(spi, 1); 320 ret = mipi_dbi_spi_transfer(spi, speed_hz, 8, cmd, 1); 321 if (ret || !num) 322 return ret; 323 324 if (*cmd == ILI9225_WRITE_DATA_TO_GRAM && !dbi->swap_bytes) 325 bpw = 16; 326 327 gpiod_set_value_cansleep(dbi->dc, 1); 328 speed_hz = mipi_dbi_spi_cmd_max_speed(spi, num); 329 330 return mipi_dbi_spi_transfer(spi, speed_hz, bpw, par, num); 331 } 332 333 static const struct drm_simple_display_pipe_funcs ili9225_pipe_funcs = { 334 .enable = ili9225_pipe_enable, 335 .disable = ili9225_pipe_disable, 336 .update = ili9225_pipe_update, 337 .prepare_fb = drm_gem_fb_simple_display_pipe_prepare_fb, 338 }; 339 340 static const struct drm_display_mode ili9225_mode = { 341 DRM_SIMPLE_MODE(176, 220, 35, 44), 342 }; 343 344 DEFINE_DRM_GEM_CMA_FOPS(ili9225_fops); 345 346 static struct drm_driver ili9225_driver = { 347 .driver_features = DRIVER_GEM | DRIVER_MODESET | DRIVER_ATOMIC, 348 .fops = &ili9225_fops, 349 DRM_GEM_CMA_VMAP_DRIVER_OPS, 350 .name = "ili9225", 351 .desc = "Ilitek ILI9225", 352 .date = "20171106", 353 .major = 1, 354 .minor = 0, 355 }; 356 357 static const struct of_device_id ili9225_of_match[] = { 358 { .compatible = "vot,v220hf01a-t" }, 359 {}, 360 }; 361 MODULE_DEVICE_TABLE(of, ili9225_of_match); 362 363 static const struct spi_device_id ili9225_id[] = { 364 { "v220hf01a-t", 0 }, 365 { }, 366 }; 367 MODULE_DEVICE_TABLE(spi, ili9225_id); 368 369 static int ili9225_probe(struct spi_device *spi) 370 { 371 struct device *dev = &spi->dev; 372 struct mipi_dbi_dev *dbidev; 373 struct drm_device *drm; 374 struct mipi_dbi *dbi; 375 struct gpio_desc *rs; 376 u32 rotation = 0; 377 int ret; 378 379 dbidev = devm_drm_dev_alloc(dev, &ili9225_driver, 380 struct mipi_dbi_dev, drm); 381 if (IS_ERR(dbidev)) 382 return PTR_ERR(dbidev); 383 384 dbi = &dbidev->dbi; 385 drm = &dbidev->drm; 386 387 dbi->reset = devm_gpiod_get(dev, "reset", GPIOD_OUT_HIGH); 388 if (IS_ERR(dbi->reset)) { 389 DRM_DEV_ERROR(dev, "Failed to get gpio 'reset'\n"); 390 return PTR_ERR(dbi->reset); 391 } 392 393 rs = devm_gpiod_get(dev, "rs", GPIOD_OUT_LOW); 394 if (IS_ERR(rs)) { 395 DRM_DEV_ERROR(dev, "Failed to get gpio 'rs'\n"); 396 return PTR_ERR(rs); 397 } 398 399 device_property_read_u32(dev, "rotation", &rotation); 400 401 ret = mipi_dbi_spi_init(spi, dbi, rs); 402 if (ret) 403 return ret; 404 405 /* override the command function set in mipi_dbi_spi_init() */ 406 dbi->command = ili9225_dbi_command; 407 408 ret = mipi_dbi_dev_init(dbidev, &ili9225_pipe_funcs, &ili9225_mode, rotation); 409 if (ret) 410 return ret; 411 412 drm_mode_config_reset(drm); 413 414 ret = drm_dev_register(drm, 0); 415 if (ret) 416 return ret; 417 418 spi_set_drvdata(spi, drm); 419 420 drm_fbdev_generic_setup(drm, 0); 421 422 return 0; 423 } 424 425 static int ili9225_remove(struct spi_device *spi) 426 { 427 struct drm_device *drm = spi_get_drvdata(spi); 428 429 drm_dev_unplug(drm); 430 drm_atomic_helper_shutdown(drm); 431 432 return 0; 433 } 434 435 static void ili9225_shutdown(struct spi_device *spi) 436 { 437 drm_atomic_helper_shutdown(spi_get_drvdata(spi)); 438 } 439 440 static struct spi_driver ili9225_spi_driver = { 441 .driver = { 442 .name = "ili9225", 443 .owner = THIS_MODULE, 444 .of_match_table = ili9225_of_match, 445 }, 446 .id_table = ili9225_id, 447 .probe = ili9225_probe, 448 .remove = ili9225_remove, 449 .shutdown = ili9225_shutdown, 450 }; 451 module_spi_driver(ili9225_spi_driver); 452 453 MODULE_DESCRIPTION("Ilitek ILI9225 DRM driver"); 454 MODULE_AUTHOR("David Lechner <david@lechnology.com>"); 455 MODULE_LICENSE("GPL"); 456