drivers/gpu/drm/tinydrm/mipi-dbi.c

   1 /*
   2  * MIPI Display Bus Interface (DBI) LCD controller support
   3  *
   4  * Copyright 2016 Noralf Trønnes
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  */
  11
  12 #include <drm/drm_gem_framebuffer_helper.h>
  13 #include <drm/tinydrm/mipi-dbi.h>
  14 #include <drm/tinydrm/tinydrm-helpers.h>
  15 #include <linux/debugfs.h>
  16 #include <linux/dma-buf.h>
  17 #include <linux/gpio/consumer.h>
  18 #include <linux/module.h>
  19 #include <linux/regulator/consumer.h>
  20 #include <linux/spi/spi.h>
  21 #include <video/mipi_display.h>
  22
  23 #define MIPI_DBI_MAX_SPI_READ_SPEED 2000000 /* 2MHz */
  24
  25 #define DCS_POWER_MODE_DISPLAY                  BIT(2)
  26 #define DCS_POWER_MODE_DISPLAY_NORMAL_MODE      BIT(3)
  27 #define DCS_POWER_MODE_SLEEP_MODE               BIT(4)
  28 #define DCS_POWER_MODE_PARTIAL_MODE             BIT(5)
  29 #define DCS_POWER_MODE_IDLE_MODE                BIT(6)
  30 #define DCS_POWER_MODE_RESERVED_MASK            (BIT(0) | BIT(1) | BIT(7))
  31
  32 /**
  33  * DOC: overview
  34  *
  35  * This library provides helpers for MIPI Display Bus Interface (DBI)
  36  * compatible display controllers.
  37  *
  38  * Many controllers for tiny lcd displays are MIPI compliant and can use this
  39  * library. If a controller uses registers 0x2A and 0x2B to set the area to
  40  * update and uses register 0x2C to write to frame memory, it is most likely
  41  * MIPI compliant.
  42  *
  43  * Only MIPI Type 1 displays are supported since a full frame memory is needed.
  44  *
  45  * There are 3 MIPI DBI implementation types:
  46  *
  47  * A. Motorola 6800 type parallel bus
  48  *
  49  * B. Intel 8080 type parallel bus
  50  *
  51  * C. SPI type with 3 options:
  52  *
  53  *    1. 9-bit with the Data/Command signal as the ninth bit
  54  *    2. Same as above except it's sent as 16 bits
  55  *    3. 8-bit with the Data/Command signal as a separate D/CX pin
  56  *
  57  * Currently mipi_dbi only supports Type C options 1 and 3 with
  58  * mipi_dbi_spi_init().
  59  */
  60
  61 #define MIPI_DBI_DEBUG_COMMAND(cmd, data, len) \
  62 ({ \
  63         if (!len) \
  64                 DRM_DEBUG_DRIVER("cmd=%02x\n", cmd); \
  65         else if (len <= 32) \
  66                 DRM_DEBUG_DRIVER("cmd=%02x, par=%*ph\n", cmd, (int)len, data);\
  67         else \
  68                 DRM_DEBUG_DRIVER("cmd=%02x, len=%zu\n", cmd, len); \
  69 })
  70
  71 static const u8 mipi_dbi_dcs_read_commands[] = {
  72         MIPI_DCS_GET_DISPLAY_ID,
  73         MIPI_DCS_GET_RED_CHANNEL,
  74         MIPI_DCS_GET_GREEN_CHANNEL,
  75         MIPI_DCS_GET_BLUE_CHANNEL,
  76         MIPI_DCS_GET_DISPLAY_STATUS,
  77         MIPI_DCS_GET_POWER_MODE,
  78         MIPI_DCS_GET_ADDRESS_MODE,
  79         MIPI_DCS_GET_PIXEL_FORMAT,
  80         MIPI_DCS_GET_DISPLAY_MODE,
  81         MIPI_DCS_GET_SIGNAL_MODE,
  82         MIPI_DCS_GET_DIAGNOSTIC_RESULT,
  83         MIPI_DCS_READ_MEMORY_START,
  84         MIPI_DCS_READ_MEMORY_CONTINUE,
  85         MIPI_DCS_GET_SCANLINE,
  86         MIPI_DCS_GET_DISPLAY_BRIGHTNESS,
  87         MIPI_DCS_GET_CONTROL_DISPLAY,
  88         MIPI_DCS_GET_POWER_SAVE,
  89         MIPI_DCS_GET_CABC_MIN_BRIGHTNESS,
  90         MIPI_DCS_READ_DDB_START,
  91         MIPI_DCS_READ_DDB_CONTINUE,
  92         0, /* sentinel */
  93 };
  94
  95 static bool mipi_dbi_command_is_read(struct mipi_dbi *mipi, u8 cmd)
  96 {
  97         unsigned int i;
  98
  99         if (!mipi->read_commands)
 100                 return false;
 101
 102         for (i = 0; i < 0xff; i++) {
 103                 if (!mipi->read_commands[i])
 104                         return false;
 105                 if (cmd == mipi->read_commands[i])
 106                         return true;
 107         }
 108
 109         return false;
 110 }
 111
 112 /**
 113  * mipi_dbi_command_read - MIPI DCS read command
 114  * @mipi: MIPI structure
 115  * @cmd: Command
 116  * @val: Value read
 117  *
 118  * Send MIPI DCS read command to the controller.
 119  *
 120  * Returns:
 121  * Zero on success, negative error code on failure.
 122  */
 123 int mipi_dbi_command_read(struct mipi_dbi *mipi, u8 cmd, u8 *val)
 124 {
 125         if (!mipi->read_commands)
 126                 return -EACCES;
 127
 128         if (!mipi_dbi_command_is_read(mipi, cmd))
 129                 return -EINVAL;
 130
 131         return mipi_dbi_command_buf(mipi, cmd, val, 1);
 132 }
 133 EXPORT_SYMBOL(mipi_dbi_command_read);
 134
 135 /**
 136  * mipi_dbi_command_buf - MIPI DCS command with parameter(s) in an array
 137  * @mipi: MIPI structure
 138  * @cmd: Command
 139  * @data: Parameter buffer
 140  * @len: Buffer length
 141  *
 142  * Returns:
 143  * Zero on success, negative error code on failure.
 144  */
 145 int mipi_dbi_command_buf(struct mipi_dbi *mipi, u8 cmd, u8 *data, size_t len)
 146 {
 147         int ret;
 148
 149         mutex_lock(&mipi->cmdlock);
 150         ret = mipi->command(mipi, cmd, data, len);
 151         mutex_unlock(&mipi->cmdlock);
 152
 153         return ret;
 154 }
 155 EXPORT_SYMBOL(mipi_dbi_command_buf);
 156
 157 /**
 158  * mipi_dbi_buf_copy - Copy a framebuffer, transforming it if necessary
 159  * @dst: The destination buffer
 160  * @fb: The source framebuffer
 161  * @clip: Clipping rectangle of the area to be copied
 162  * @swap: When true, swap MSB/LSB of 16-bit values
 163  *
 164  * Returns:
 165  * Zero on success, negative error code on failure.
 166  */
 167 int mipi_dbi_buf_copy(void *dst, struct drm_framebuffer *fb,
 168                       struct drm_clip_rect *clip, bool swap)
 169 {
 170         struct drm_gem_cma_object *cma_obj = drm_fb_cma_get_gem_obj(fb, 0);
 171         struct dma_buf_attachment *import_attach = cma_obj->base.import_attach;
 172         struct drm_format_name_buf format_name;
 173         void *src = cma_obj->vaddr;
 174         int ret = 0;
 175
 176         if (import_attach) {
 177                 ret = dma_buf_begin_cpu_access(import_attach->dmabuf,
 178                                                DMA_FROM_DEVICE);
 179                 if (ret)
 180                         return ret;
 181         }
 182
 183         switch (fb->format->format) {
 184         case DRM_FORMAT_RGB565:
 185                 if (swap)
 186                         tinydrm_swab16(dst, src, fb, clip);
 187                 else
 188                         tinydrm_memcpy(dst, src, fb, clip);
 189                 break;
 190         case DRM_FORMAT_XRGB8888:
 191                 tinydrm_xrgb8888_to_rgb565(dst, src, fb, clip, swap);
 192                 break;
 193         default:
 194                 dev_err_once(fb->dev->dev, "Format is not supported: %s\n",
 195                              drm_get_format_name(fb->format->format,
 196                                                  &format_name));
 197                 return -EINVAL;
 198         }
 199
 200         if (import_attach)
 201                 ret = dma_buf_end_cpu_access(import_attach->dmabuf,
 202                                              DMA_FROM_DEVICE);
 203         return ret;
 204 }
 205 EXPORT_SYMBOL(mipi_dbi_buf_copy);
 206
 207 static int mipi_dbi_fb_dirty(struct drm_framebuffer *fb,
 208                              struct drm_file *file_priv,
 209                              unsigned int flags, unsigned int color,
 210                              struct drm_clip_rect *clips,
 211                              unsigned int num_clips)
 212 {
 213         struct drm_gem_cma_object *cma_obj = drm_fb_cma_get_gem_obj(fb, 0);
 214         struct tinydrm_device *tdev = fb->dev->dev_private;
 215         struct mipi_dbi *mipi = mipi_dbi_from_tinydrm(tdev);
 216         bool swap = mipi->swap_bytes;
 217         struct drm_clip_rect clip;
 218         int ret = 0;
 219         bool full;
 220         void *tr;
 221
 222         if (!mipi->enabled)
 223                 return 0;
 224
 225         full = tinydrm_merge_clips(&clip, clips, num_clips, flags,
 226                                    fb->width, fb->height);
 227
 228         DRM_DEBUG("Flushing [FB:%d] x1=%u, x2=%u, y1=%u, y2=%u\n", fb->base.id,
 229                   clip.x1, clip.x2, clip.y1, clip.y2);
 230
 231         if (!mipi->dc || !full || swap ||
 232             fb->format->format == DRM_FORMAT_XRGB8888) {
 233                 tr = mipi->tx_buf;
 234                 ret = mipi_dbi_buf_copy(mipi->tx_buf, fb, &clip, swap);
 235                 if (ret)
 236                         return ret;
 237         } else {
 238                 tr = cma_obj->vaddr;
 239         }
 240
 241         mipi_dbi_command(mipi, MIPI_DCS_SET_COLUMN_ADDRESS,
 242                          (clip.x1 >> 8) & 0xFF, clip.x1 & 0xFF,
 243                          (clip.x2 >> 8) & 0xFF, (clip.x2 - 1) & 0xFF);
 244         mipi_dbi_command(mipi, MIPI_DCS_SET_PAGE_ADDRESS,
 245                          (clip.y1 >> 8) & 0xFF, clip.y1 & 0xFF,
 246                          (clip.y2 >> 8) & 0xFF, (clip.y2 - 1) & 0xFF);
 247
 248         ret = mipi_dbi_command_buf(mipi, MIPI_DCS_WRITE_MEMORY_START, tr,
 249                                 (clip.x2 - clip.x1) * (clip.y2 - clip.y1) * 2);
 250
 251         return ret;
 252 }
 253
 254 static const struct drm_framebuffer_funcs mipi_dbi_fb_funcs = {
 255         .destroy        = drm_gem_fb_destroy,
 256         .create_handle  = drm_gem_fb_create_handle,
 257         .dirty          = tinydrm_fb_dirty,
 258 };
 259
 260 /**
 261  * mipi_dbi_enable_flush - MIPI DBI enable helper
 262  * @mipi: MIPI DBI structure
 263  *
 264  * This function sets &mipi_dbi->enabled, flushes the whole framebuffer and
 265  * enables the backlight. Drivers can use this in their
 266  * &drm_simple_display_pipe_funcs->enable callback.
 267  */
 268 void mipi_dbi_enable_flush(struct mipi_dbi *mipi,
 269                            struct drm_crtc_state *crtc_state,
 270                            struct drm_plane_state *plane_state)
 271 {
 272         struct tinydrm_device *tdev = &mipi->tinydrm;
 273         struct drm_framebuffer *fb = plane_state->fb;
 274
 275         mipi->enabled = true;
 276         if (fb)
 277                 tdev->fb_dirty(fb, NULL, 0, 0, NULL, 0);
 278
 279         backlight_enable(mipi->backlight);
 280 }
 281 EXPORT_SYMBOL(mipi_dbi_enable_flush);
 282
 283 static void mipi_dbi_blank(struct mipi_dbi *mipi)
 284 {
 285         struct drm_device *drm = mipi->tinydrm.drm;
 286         u16 height = drm->mode_config.min_height;
 287         u16 width = drm->mode_config.min_width;
 288         size_t len = width * height * 2;
 289
 290         memset(mipi->tx_buf, 0, len);
 291
 292         mipi_dbi_command(mipi, MIPI_DCS_SET_COLUMN_ADDRESS, 0, 0,
 293                          (width >> 8) & 0xFF, (width - 1) & 0xFF);
 294         mipi_dbi_command(mipi, MIPI_DCS_SET_PAGE_ADDRESS, 0, 0,
 295                          (height >> 8) & 0xFF, (height - 1) & 0xFF);
 296         mipi_dbi_command_buf(mipi, MIPI_DCS_WRITE_MEMORY_START,
 297                              (u8 *)mipi->tx_buf, len);
 298 }
 299
 300 /**
 301  * mipi_dbi_pipe_disable - MIPI DBI pipe disable helper
 302  * @pipe: Display pipe
 303  *
 304  * This function disables backlight if present, if not the display memory is
 305  * blanked. The regulator is disabled if in use. Drivers can use this as their
 306  * &drm_simple_display_pipe_funcs->disable callback.
 307  */
 308 void mipi_dbi_pipe_disable(struct drm_simple_display_pipe *pipe)
 309 {
 310         struct tinydrm_device *tdev = pipe_to_tinydrm(pipe);
 311         struct mipi_dbi *mipi = mipi_dbi_from_tinydrm(tdev);
 312
 313         DRM_DEBUG_KMS("\n");
 314
 315         mipi->enabled = false;
 316
 317         if (mipi->backlight)
 318                 backlight_disable(mipi->backlight);
 319         else
 320                 mipi_dbi_blank(mipi);
 321
 322         if (mipi->regulator)
 323                 regulator_disable(mipi->regulator);
 324 }
 325 EXPORT_SYMBOL(mipi_dbi_pipe_disable);
 326
 327 static const uint32_t mipi_dbi_formats[] = {
 328         DRM_FORMAT_RGB565,
 329         DRM_FORMAT_XRGB8888,
 330 };
 331
 332 /**
 333  * mipi_dbi_init - MIPI DBI initialization
 334  * @dev: Parent device
 335  * @mipi: &mipi_dbi structure to initialize
 336  * @pipe_funcs: Display pipe functions
 337  * @driver: DRM driver
 338  * @mode: Display mode
 339  * @rotation: Initial rotation in degrees Counter Clock Wise
 340  *
 341  * This function initializes a &mipi_dbi structure and it's underlying
 342  * @tinydrm_device. It also sets up the display pipeline.
 343  *
 344  * Supported formats: Native RGB565 and emulated XRGB8888.
 345  *
 346  * Objects created by this function will be automatically freed on driver
 347  * detach (devres).
 348  *
 349  * Returns:
 350  * Zero on success, negative error code on failure.
 351  */
 352 int mipi_dbi_init(struct device *dev, struct mipi_dbi *mipi,
 353                   const struct drm_simple_display_pipe_funcs *pipe_funcs,
 354                   struct drm_driver *driver,
 355                   const struct drm_display_mode *mode, unsigned int rotation)
 356 {
 357         size_t bufsize = mode->vdisplay * mode->hdisplay * sizeof(u16);
 358         struct tinydrm_device *tdev = &mipi->tinydrm;
 359         int ret;
 360
 361         if (!mipi->command)
 362                 return -EINVAL;
 363
 364         mutex_init(&mipi->cmdlock);
 365
 366         mipi->tx_buf = devm_kmalloc(dev, bufsize, GFP_KERNEL);
 367         if (!mipi->tx_buf)
 368                 return -ENOMEM;
 369
 370         ret = devm_tinydrm_init(dev, tdev, &mipi_dbi_fb_funcs, driver);
 371         if (ret)
 372                 return ret;
 373
 374         tdev->fb_dirty = mipi_dbi_fb_dirty;
 375
 376         /* TODO: Maybe add DRM_MODE_CONNECTOR_SPI */
 377         ret = tinydrm_display_pipe_init(tdev, pipe_funcs,
 378                                         DRM_MODE_CONNECTOR_VIRTUAL,
 379                                         mipi_dbi_formats,
 380                                         ARRAY_SIZE(mipi_dbi_formats), mode,
 381                                         rotation);
 382         if (ret)
 383                 return ret;
 384
 385         tdev->drm->mode_config.preferred_depth = 16;
 386         mipi->rotation = rotation;
 387
 388         drm_mode_config_reset(tdev->drm);
 389
 390         DRM_DEBUG_KMS("preferred_depth=%u, rotation = %u\n",
 391                       tdev->drm->mode_config.preferred_depth, rotation);
 392
 393         return 0;
 394 }
 395 EXPORT_SYMBOL(mipi_dbi_init);
 396
 397 /**
 398  * mipi_dbi_hw_reset - Hardware reset of controller
 399  * @mipi: MIPI DBI structure
 400  *
 401  * Reset controller if the &mipi_dbi->reset gpio is set.
 402  */
 403 void mipi_dbi_hw_reset(struct mipi_dbi *mipi)
 404 {
 405         if (!mipi->reset)
 406                 return;
 407
 408         gpiod_set_value_cansleep(mipi->reset, 0);
 409         usleep_range(20, 1000);
 410         gpiod_set_value_cansleep(mipi->reset, 1);
 411         msleep(120);
 412 }
 413 EXPORT_SYMBOL(mipi_dbi_hw_reset);
 414
 415 /**
 416  * mipi_dbi_display_is_on - Check if display is on
 417  * @mipi: MIPI DBI structure
 418  *
 419  * This function checks the Power Mode register (if readable) to see if
 420  * display output is turned on. This can be used to see if the bootloader
 421  * has already turned on the display avoiding flicker when the pipeline is
 422  * enabled.
 423  *
 424  * Returns:
 425  * true if the display can be verified to be on, false otherwise.
 426  */
 427 bool mipi_dbi_display_is_on(struct mipi_dbi *mipi)
 428 {
 429         u8 val;
 430
 431         if (mipi_dbi_command_read(mipi, MIPI_DCS_GET_POWER_MODE, &val))
 432                 return false;
 433
 434         val &= ~DCS_POWER_MODE_RESERVED_MASK;
 435
 436         /* The poweron/reset value is 08h DCS_POWER_MODE_DISPLAY_NORMAL_MODE */
 437         if (val != (DCS_POWER_MODE_DISPLAY |
 438             DCS_POWER_MODE_DISPLAY_NORMAL_MODE | DCS_POWER_MODE_SLEEP_MODE))
 439                 return false;
 440
 441         DRM_DEBUG_DRIVER("Display is ON\n");
 442
 443         return true;
 444 }
 445 EXPORT_SYMBOL(mipi_dbi_display_is_on);
 446
 447 static int mipi_dbi_poweron_reset_conditional(struct mipi_dbi *mipi, bool cond)
 448 {
 449         struct device *dev = mipi->tinydrm.drm->dev;
 450         int ret;
 451
 452         if (mipi->regulator) {
 453                 ret = regulator_enable(mipi->regulator);
 454                 if (ret) {
 455                         DRM_DEV_ERROR(dev, "Failed to enable regulator (%d)\n", ret);
 456                         return ret;
 457                 }
 458         }
 459
 460         if (cond && mipi_dbi_display_is_on(mipi))
 461                 return 1;
 462
 463         mipi_dbi_hw_reset(mipi);
 464         ret = mipi_dbi_command(mipi, MIPI_DCS_SOFT_RESET);
 465         if (ret) {
 466                 DRM_DEV_ERROR(dev, "Failed to send reset command (%d)\n", ret);
 467                 if (mipi->regulator)
 468                         regulator_disable(mipi->regulator);
 469                 return ret;
 470         }
 471
 472         /*
 473          * If we did a hw reset, we know the controller is in Sleep mode and
 474          * per MIPI DSC spec should wait 5ms after soft reset. If we didn't,
 475          * we assume worst case and wait 120ms.
 476          */
 477         if (mipi->reset)
 478                 usleep_range(5000, 20000);
 479         else
 480                 msleep(120);
 481
 482         return 0;
 483 }
 484
 485 /**
 486  * mipi_dbi_poweron_reset - MIPI DBI poweron and reset
 487  * @mipi: MIPI DBI structure
 488  *
 489  * This function enables the regulator if used and does a hardware and software
 490  * reset.
 491  *
 492  * Returns:
 493  * Zero on success, or a negative error code.
 494  */
 495 int mipi_dbi_poweron_reset(struct mipi_dbi *mipi)
 496 {
 497         return mipi_dbi_poweron_reset_conditional(mipi, false);
 498 }
 499 EXPORT_SYMBOL(mipi_dbi_poweron_reset);
 500
 501 /**
 502  * mipi_dbi_poweron_conditional_reset - MIPI DBI poweron and conditional reset
 503  * @mipi: MIPI DBI structure
 504  *
 505  * This function enables the regulator if used and if the display is off, it
 506  * does a hardware and software reset. If mipi_dbi_display_is_on() determines
 507  * that the display is on, no reset is performed.
 508  *
 509  * Returns:
 510  * Zero if the controller was reset, 1 if the display was already on, or a
 511  * negative error code.
 512  */
 513 int mipi_dbi_poweron_conditional_reset(struct mipi_dbi *mipi)
 514 {
 515         return mipi_dbi_poweron_reset_conditional(mipi, true);
 516 }
 517 EXPORT_SYMBOL(mipi_dbi_poweron_conditional_reset);
 518
 519 #if IS_ENABLED(CONFIG_SPI)
 520
 521 /**
 522  * mipi_dbi_spi_cmd_max_speed - get the maximum SPI bus speed
 523  * @spi: SPI device
 524  * @len: The transfer buffer length.
 525  *
 526  * Many controllers have a max speed of 10MHz, but can be pushed way beyond
 527  * that. Increase reliability by running pixel data at max speed and the rest
 528  * at 10MHz, preventing transfer glitches from messing up the init settings.
 529  */
 530 u32 mipi_dbi_spi_cmd_max_speed(struct spi_device *spi, size_t len)
 531 {
 532         if (len > 64)
 533                 return 0; /* use default */
 534
 535         return min_t(u32, 10000000, spi->max_speed_hz);
 536 }
 537 EXPORT_SYMBOL(mipi_dbi_spi_cmd_max_speed);
 538
 539 /*
 540  * MIPI DBI Type C Option 1
 541  *
 542  * If the SPI controller doesn't have 9 bits per word support,
 543  * use blocks of 9 bytes to send 8x 9-bit words using a 8-bit SPI transfer.
 544  * Pad partial blocks with MIPI_DCS_NOP (zero).
 545  * This is how the D/C bit (x) is added:
 546  *     x7654321
 547  *     0x765432
 548  *     10x76543
 549  *     210x7654
 550  *     3210x765
 551  *     43210x76
 552  *     543210x7
 553  *     6543210x
 554  *     76543210
 555  */
 556
 557 static int mipi_dbi_spi1e_transfer(struct mipi_dbi *mipi, int dc,
 558                                    const void *buf, size_t len,
 559                                    unsigned int bpw)
 560 {
 561         bool swap_bytes = (bpw == 16 && tinydrm_machine_little_endian());
 562         size_t chunk, max_chunk = mipi->tx_buf9_len;
 563         struct spi_device *spi = mipi->spi;
 564         struct spi_transfer tr = {
 565                 .tx_buf = mipi->tx_buf9,
 566                 .bits_per_word = 8,
 567         };
 568         struct spi_message m;
 569         const u8 *src = buf;
 570         int i, ret;
 571         u8 *dst;
 572
 573         if (drm_debug & DRM_UT_DRIVER)
 574                 pr_debug("[drm:%s] dc=%d, max_chunk=%zu, transfers:\n",
 575                          __func__, dc, max_chunk);
 576
 577         tr.speed_hz = mipi_dbi_spi_cmd_max_speed(spi, len);
 578         spi_message_init_with_transfers(&m, &tr, 1);
 579
 580         if (!dc) {
 581                 if (WARN_ON_ONCE(len != 1))
 582                         return -EINVAL;
 583
 584                 /* Command: pad no-op's (zeroes) at beginning of block */
 585                 dst = mipi->tx_buf9;
 586                 memset(dst, 0, 9);
 587                 dst[8] = *src;
 588                 tr.len = 9;
 589
 590                 tinydrm_dbg_spi_message(spi, &m);
 591
 592                 return spi_sync(spi, &m);
 593         }
 594
 595         /* max with room for adding one bit per byte */
 596         max_chunk = max_chunk / 9 * 8;
 597         /* but no bigger than len */
 598         max_chunk = min(max_chunk, len);
 599         /* 8 byte blocks */
 600         max_chunk = max_t(size_t, 8, max_chunk & ~0x7);
 601
 602         while (len) {
 603                 size_t added = 0;
 604
 605                 chunk = min(len, max_chunk);
 606                 len -= chunk;
 607                 dst = mipi->tx_buf9;
 608
 609                 if (chunk < 8) {
 610                         u8 val, carry = 0;
 611
 612                         /* Data: pad no-op's (zeroes) at end of block */
 613                         memset(dst, 0, 9);
 614
 615                         if (swap_bytes) {
 616                                 for (i = 1; i < (chunk + 1); i++) {
 617                                         val = src[1];
 618                                         *dst++ = carry | BIT(8 - i) | (val >> i);
 619                                         carry = val << (8 - i);
 620                                         i++;
 621                                         val = src[0];
 622                                         *dst++ = carry | BIT(8 - i) | (val >> i);
 623                                         carry = val << (8 - i);
 624                                         src += 2;
 625                                 }
 626                                 *dst++ = carry;
 627                         } else {
 628                                 for (i = 1; i < (chunk + 1); i++) {
 629                                         val = *src++;
 630                                         *dst++ = carry | BIT(8 - i) | (val >> i);
 631                                         carry = val << (8 - i);
 632                                 }
 633                                 *dst++ = carry;
 634                         }
 635
 636                         chunk = 8;
 637                         added = 1;
 638                 } else {
 639                         for (i = 0; i < chunk; i += 8) {
 640                                 if (swap_bytes) {
 641                                         *dst++ =                 BIT(7) | (src[1] >> 1);
 642                                         *dst++ = (src[1] << 7) | BIT(6) | (src[0] >> 2);
 643                                         *dst++ = (src[0] << 6) | BIT(5) | (src[3] >> 3);
 644                                         *dst++ = (src[3] << 5) | BIT(4) | (src[2] >> 4);
 645                                         *dst++ = (src[2] << 4) | BIT(3) | (src[5] >> 5);
 646                                         *dst++ = (src[5] << 3) | BIT(2) | (src[4] >> 6);
 647                                         *dst++ = (src[4] << 2) | BIT(1) | (src[7] >> 7);
 648                                         *dst++ = (src[7] << 1) | BIT(0);
 649                                         *dst++ = src[6];
 650                                 } else {
 651                                         *dst++ =                 BIT(7) | (src[0] >> 1);
 652                                         *dst++ = (src[0] << 7) | BIT(6) | (src[1] >> 2);
 653                                         *dst++ = (src[1] << 6) | BIT(5) | (src[2] >> 3);
 654                                         *dst++ = (src[2] << 5) | BIT(4) | (src[3] >> 4);
 655                                         *dst++ = (src[3] << 4) | BIT(3) | (src[4] >> 5);
 656                                         *dst++ = (src[4] << 3) | BIT(2) | (src[5] >> 6);
 657                                         *dst++ = (src[5] << 2) | BIT(1) | (src[6] >> 7);
 658                                         *dst++ = (src[6] << 1) | BIT(0);
 659                                         *dst++ = src[7];
 660                                 }
 661
 662                                 src += 8;
 663                                 added++;
 664                         }
 665                 }
 666
 667                 tr.len = chunk + added;
 668
 669                 tinydrm_dbg_spi_message(spi, &m);
 670                 ret = spi_sync(spi, &m);
 671                 if (ret)
 672                         return ret;
 673         }
 674
 675         return 0;
 676 }
 677
 678 static int mipi_dbi_spi1_transfer(struct mipi_dbi *mipi, int dc,
 679                                   const void *buf, size_t len,
 680                                   unsigned int bpw)
 681 {
 682         struct spi_device *spi = mipi->spi;
 683         struct spi_transfer tr = {
 684                 .bits_per_word = 9,
 685         };
 686         const u16 *src16 = buf;
 687         const u8 *src8 = buf;
 688         struct spi_message m;
 689         size_t max_chunk;
 690         u16 *dst16;
 691         int ret;
 692
 693         if (!tinydrm_spi_bpw_supported(spi, 9))
 694                 return mipi_dbi_spi1e_transfer(mipi, dc, buf, len, bpw);
 695
 696         tr.speed_hz = mipi_dbi_spi_cmd_max_speed(spi, len);
 697         max_chunk = mipi->tx_buf9_len;
 698         dst16 = mipi->tx_buf9;
 699
 700         if (drm_debug & DRM_UT_DRIVER)
 701                 pr_debug("[drm:%s] dc=%d, max_chunk=%zu, transfers:\n",
 702                          __func__, dc, max_chunk);
 703
 704         max_chunk = min(max_chunk / 2, len);
 705
 706         spi_message_init_with_transfers(&m, &tr, 1);
 707         tr.tx_buf = dst16;
 708
 709         while (len) {
 710                 size_t chunk = min(len, max_chunk);
 711                 unsigned int i;
 712
 713                 if (bpw == 16 && tinydrm_machine_little_endian()) {
 714                         for (i = 0; i < (chunk * 2); i += 2) {
 715                                 dst16[i]     = *src16 >> 8;
 716                                 dst16[i + 1] = *src16++ & 0xFF;
 717                                 if (dc) {
 718                                         dst16[i]     |= 0x0100;
 719                                         dst16[i + 1] |= 0x0100;
 720                                 }
 721                         }
 722                 } else {
 723                         for (i = 0; i < chunk; i++) {
 724                                 dst16[i] = *src8++;
 725                                 if (dc)
 726                                         dst16[i] |= 0x0100;
 727                         }
 728                 }
 729
 730                 tr.len = chunk;
 731                 len -= chunk;
 732
 733                 tinydrm_dbg_spi_message(spi, &m);
 734                 ret = spi_sync(spi, &m);
 735                 if (ret)
 736                         return ret;
 737         }
 738
 739         return 0;
 740 }
 741
 742 static int mipi_dbi_typec1_command(struct mipi_dbi *mipi, u8 cmd,
 743                                    u8 *parameters, size_t num)
 744 {
 745         unsigned int bpw = (cmd == MIPI_DCS_WRITE_MEMORY_START) ? 16 : 8;
 746         int ret;
 747
 748         if (mipi_dbi_command_is_read(mipi, cmd))
 749                 return -ENOTSUPP;
 750
 751         MIPI_DBI_DEBUG_COMMAND(cmd, parameters, num);
 752
 753         ret = mipi_dbi_spi1_transfer(mipi, 0, &cmd, 1, 8);
 754         if (ret || !num)
 755                 return ret;
 756
 757         return mipi_dbi_spi1_transfer(mipi, 1, parameters, num, bpw);
 758 }
 759
 760 /* MIPI DBI Type C Option 3 */
 761
 762 static int mipi_dbi_typec3_command_read(struct mipi_dbi *mipi, u8 cmd,
 763                                         u8 *data, size_t len)
 764 {
 765         struct spi_device *spi = mipi->spi;
 766         u32 speed_hz = min_t(u32, MIPI_DBI_MAX_SPI_READ_SPEED,
 767                              spi->max_speed_hz / 2);
 768         struct spi_transfer tr[2] = {
 769                 {
 770                         .speed_hz = speed_hz,
 771                         .tx_buf = &cmd,
 772                         .len = 1,
 773                 }, {
 774                         .speed_hz = speed_hz,
 775                         .len = len,
 776                 },
 777         };
 778         struct spi_message m;
 779         u8 *buf;
 780         int ret;
 781
 782         if (!len)
 783                 return -EINVAL;
 784
 785         /*
 786          * Support non-standard 24-bit and 32-bit Nokia read commands which
 787          * start with a dummy clock, so we need to read an extra byte.
 788          */
 789         if (cmd == MIPI_DCS_GET_DISPLAY_ID ||
 790             cmd == MIPI_DCS_GET_DISPLAY_STATUS) {
 791                 if (!(len == 3 || len == 4))
 792                         return -EINVAL;
 793
 794                 tr[1].len = len + 1;
 795         }
 796
 797         buf = kmalloc(tr[1].len, GFP_KERNEL);
 798         if (!buf)
 799                 return -ENOMEM;
 800
 801         tr[1].rx_buf = buf;
 802         gpiod_set_value_cansleep(mipi->dc, 0);
 803
 804         spi_message_init_with_transfers(&m, tr, ARRAY_SIZE(tr));
 805         ret = spi_sync(spi, &m);
 806         if (ret)
 807                 goto err_free;
 808
 809         tinydrm_dbg_spi_message(spi, &m);
 810
 811         if (tr[1].len == len) {
 812                 memcpy(data, buf, len);
 813         } else {
 814                 unsigned int i;
 815
 816                 for (i = 0; i < len; i++)
 817                         data[i] = (buf[i] << 1) | !!(buf[i + 1] & BIT(7));
 818         }
 819
 820         MIPI_DBI_DEBUG_COMMAND(cmd, data, len);
 821
 822 err_free:
 823         kfree(buf);
 824
 825         return ret;
 826 }
 827
 828 static int mipi_dbi_typec3_command(struct mipi_dbi *mipi, u8 cmd,
 829                                    u8 *par, size_t num)
 830 {
 831         struct spi_device *spi = mipi->spi;
 832         unsigned int bpw = 8;
 833         u32 speed_hz;
 834         int ret;
 835
 836         if (mipi_dbi_command_is_read(mipi, cmd))
 837                 return mipi_dbi_typec3_command_read(mipi, cmd, par, num);
 838
 839         MIPI_DBI_DEBUG_COMMAND(cmd, par, num);
 840
 841         gpiod_set_value_cansleep(mipi->dc, 0);
 842         speed_hz = mipi_dbi_spi_cmd_max_speed(spi, 1);
 843         ret = tinydrm_spi_transfer(spi, speed_hz, NULL, 8, &cmd, 1);
 844         if (ret || !num)
 845                 return ret;
 846
 847         if (cmd == MIPI_DCS_WRITE_MEMORY_START && !mipi->swap_bytes)
 848                 bpw = 16;
 849
 850         gpiod_set_value_cansleep(mipi->dc, 1);
 851         speed_hz = mipi_dbi_spi_cmd_max_speed(spi, num);
 852
 853         return tinydrm_spi_transfer(spi, speed_hz, NULL, bpw, par, num);
 854 }
 855
 856 /**
 857  * mipi_dbi_spi_init - Initialize MIPI DBI SPI interfaced controller
 858  * @spi: SPI device
 859  * @mipi: &mipi_dbi structure to initialize
 860  * @dc: D/C gpio (optional)
 861  *
 862  * This function sets &mipi_dbi->command, enables &mipi->read_commands for the
 863  * usual read commands. It should be followed by a call to mipi_dbi_init() or
 864  * a driver-specific init.
 865  *
 866  * If @dc is set, a Type C Option 3 interface is assumed, if not
 867  * Type C Option 1.
 868  *
 869  * If the SPI master driver doesn't support the necessary bits per word,
 870  * the following transformation is used:
 871  *
 872  * - 9-bit: reorder buffer as 9x 8-bit words, padded with no-op command.
 873  * - 16-bit: if big endian send as 8-bit, if little endian swap bytes
 874  *
 875  * Returns:
 876  * Zero on success, negative error code on failure.
 877  */
 878 int mipi_dbi_spi_init(struct spi_device *spi, struct mipi_dbi *mipi,
 879                       struct gpio_desc *dc)
 880 {
 881         size_t tx_size = tinydrm_spi_max_transfer_size(spi, 0);
 882         struct device *dev = &spi->dev;
 883         int ret;
 884
 885         if (tx_size < 16) {
 886                 DRM_ERROR("SPI transmit buffer too small: %zu\n", tx_size);
 887                 return -EINVAL;
 888         }
 889
 890         /*
 891          * Even though it's not the SPI device that does DMA (the master does),
 892          * the dma mask is necessary for the dma_alloc_wc() in
 893          * drm_gem_cma_create(). The dma_addr returned will be a physical
 894          * adddress which might be different from the bus address, but this is
 895          * not a problem since the address will not be used.
 896          * The virtual address is used in the transfer and the SPI core
 897          * re-maps it on the SPI master device using the DMA streaming API
 898          * (spi_map_buf()).
 899          */
 900         if (!dev->coherent_dma_mask) {
 901                 ret = dma_coerce_mask_and_coherent(dev, DMA_BIT_MASK(32));
 902                 if (ret) {
 903                         dev_warn(dev, "Failed to set dma mask %d\n", ret);
 904                         return ret;
 905                 }
 906         }
 907
 908         mipi->spi = spi;
 909         mipi->read_commands = mipi_dbi_dcs_read_commands;
 910
 911         if (dc) {
 912                 mipi->command = mipi_dbi_typec3_command;
 913                 mipi->dc = dc;
 914                 if (tinydrm_machine_little_endian() &&
 915                     !tinydrm_spi_bpw_supported(spi, 16))
 916                         mipi->swap_bytes = true;
 917         } else {
 918                 mipi->command = mipi_dbi_typec1_command;
 919                 mipi->tx_buf9_len = tx_size;
 920                 mipi->tx_buf9 = devm_kmalloc(dev, tx_size, GFP_KERNEL);
 921                 if (!mipi->tx_buf9)
 922                         return -ENOMEM;
 923         }
 924
 925         DRM_DEBUG_DRIVER("SPI speed: %uMHz\n", spi->max_speed_hz / 1000000);
 926
 927         return 0;
 928 }
 929 EXPORT_SYMBOL(mipi_dbi_spi_init);
 930
 931 #endif /* CONFIG_SPI */
 932
 933 #ifdef CONFIG_DEBUG_FS
 934
 935 static ssize_t mipi_dbi_debugfs_command_write(struct file *file,
 936                                               const char __user *ubuf,
 937                                               size_t count, loff_t *ppos)
 938 {
 939         struct seq_file *m = file->private_data;
 940         struct mipi_dbi *mipi = m->private;
 941         u8 val, cmd = 0, parameters[64];
 942         char *buf, *pos, *token;
 943         unsigned int i;
 944         int ret;
 945
 946         buf = memdup_user_nul(ubuf, count);
 947         if (IS_ERR(buf))
 948                 return PTR_ERR(buf);
 949
 950         /* strip trailing whitespace */
 951         for (i = count - 1; i > 0; i--)
 952                 if (isspace(buf[i]))
 953                         buf[i] = '\0';
 954                 else
 955                         break;
 956         i = 0;
 957         pos = buf;
 958         while (pos) {
 959                 token = strsep(&pos, " ");
 960                 if (!token) {
 961                         ret = -EINVAL;
 962                         goto err_free;
 963                 }
 964
 965                 ret = kstrtou8(token, 16, &val);
 966                 if (ret < 0)
 967                         goto err_free;
 968
 969                 if (token == buf)
 970                         cmd = val;
 971                 else
 972                         parameters[i++] = val;
 973
 974                 if (i == 64) {
 975                         ret = -E2BIG;
 976                         goto err_free;
 977                 }
 978         }
 979
 980         ret = mipi_dbi_command_buf(mipi, cmd, parameters, i);
 981
 982 err_free:
 983         kfree(buf);
 984
 985         return ret < 0 ? ret : count;
 986 }
 987
 988 static int mipi_dbi_debugfs_command_show(struct seq_file *m, void *unused)
 989 {
 990         struct mipi_dbi *mipi = m->private;
 991         u8 cmd, val[4];
 992         size_t len;
 993         int ret;
 994
 995         for (cmd = 0; cmd < 255; cmd++) {
 996                 if (!mipi_dbi_command_is_read(mipi, cmd))
 997                         continue;
 998
 999                 switch (cmd) {
1000                 case MIPI_DCS_READ_MEMORY_START:
1001                 case MIPI_DCS_READ_MEMORY_CONTINUE:
1002                         len = 2;
1003                         break;
1004                 case MIPI_DCS_GET_DISPLAY_ID:
1005                         len = 3;
1006                         break;
1007                 case MIPI_DCS_GET_DISPLAY_STATUS:
1008                         len = 4;
1009                         break;
1010                 default:
1011                         len = 1;
1012                         break;
1013                 }
1014
1015                 seq_printf(m, "%02x: ", cmd);
1016                 ret = mipi_dbi_command_buf(mipi, cmd, val, len);
1017                 if (ret) {
1018                         seq_puts(m, "XX\n");
1019                         continue;
1020                 }
1021                 seq_printf(m, "%*phN\n", (int)len, val);
1022         }
1023
1024         return 0;
1025 }
1026
1027 static int mipi_dbi_debugfs_command_open(struct inode *inode,
1028                                          struct file *file)
1029 {
1030         return single_open(file, mipi_dbi_debugfs_command_show,
1031                            inode->i_private);
1032 }
1033
1034 static const struct file_operations mipi_dbi_debugfs_command_fops = {
1035         .owner = THIS_MODULE,
1036         .open = mipi_dbi_debugfs_command_open,
1037         .read = seq_read,
1038         .llseek = seq_lseek,
1039         .release = single_release,
1040         .write = mipi_dbi_debugfs_command_write,
1041 };
1042
1043 /**
1044  * mipi_dbi_debugfs_init - Create debugfs entries
1045  * @minor: DRM minor
1046  *
1047  * This function creates a 'command' debugfs file for sending commands to the
1048  * controller or getting the read command values.
1049  * Drivers can use this as their &drm_driver->debugfs_init callback.
1050  *
1051  * Returns:
1052  * Zero on success, negative error code on failure.
1053  */
1054 int mipi_dbi_debugfs_init(struct drm_minor *minor)
1055 {
1056         struct tinydrm_device *tdev = minor->dev->dev_private;
1057         struct mipi_dbi *mipi = mipi_dbi_from_tinydrm(tdev);
1058         umode_t mode = S_IFREG | S_IWUSR;
1059
1060         if (mipi->read_commands)
1061                 mode |= S_IRUGO;
1062         debugfs_create_file("command", mode, minor->debugfs_root, mipi,
1063                             &mipi_dbi_debugfs_command_fops);
1064
1065         return 0;
1066 }
1067 EXPORT_SYMBOL(mipi_dbi_debugfs_init);
1068
1069 #endif
1070
1071 MODULE_LICENSE("GPL");