drivers/gpu/drm/tiny/ili9225.c

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