1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * MIPI Display Bus Interface (DBI) LCD controller support
5 * Copyright 2016 Noralf Trønnes
8 #include <linux/debugfs.h>
9 #include <linux/delay.h>
10 #include <linux/gpio/consumer.h>
11 #include <linux/module.h>
12 #include <linux/regulator/consumer.h>
13 #include <linux/spi/spi.h>
15 #include <drm/drm_connector.h>
16 #include <drm/drm_damage_helper.h>
17 #include <drm/drm_drv.h>
18 #include <drm/drm_gem_cma_helper.h>
19 #include <drm/drm_format_helper.h>
20 #include <drm/drm_fourcc.h>
21 #include <drm/drm_gem_framebuffer_helper.h>
22 #include <drm/drm_mipi_dbi.h>
23 #include <drm/drm_modes.h>
24 #include <drm/drm_probe_helper.h>
25 #include <drm/drm_rect.h>
26 #include <video/mipi_display.h>
28 #define MIPI_DBI_MAX_SPI_READ_SPEED 2000000 /* 2MHz */
30 #define DCS_POWER_MODE_DISPLAY BIT(2)
31 #define DCS_POWER_MODE_DISPLAY_NORMAL_MODE BIT(3)
32 #define DCS_POWER_MODE_SLEEP_MODE BIT(4)
33 #define DCS_POWER_MODE_PARTIAL_MODE BIT(5)
34 #define DCS_POWER_MODE_IDLE_MODE BIT(6)
35 #define DCS_POWER_MODE_RESERVED_MASK (BIT(0) | BIT(1) | BIT(7))
40 * This library provides helpers for MIPI Display Bus Interface (DBI)
41 * compatible display controllers.
43 * Many controllers for tiny lcd displays are MIPI compliant and can use this
44 * library. If a controller uses registers 0x2A and 0x2B to set the area to
45 * update and uses register 0x2C to write to frame memory, it is most likely
48 * Only MIPI Type 1 displays are supported since a full frame memory is needed.
50 * There are 3 MIPI DBI implementation types:
52 * A. Motorola 6800 type parallel bus
54 * B. Intel 8080 type parallel bus
56 * C. SPI type with 3 options:
58 * 1. 9-bit with the Data/Command signal as the ninth bit
59 * 2. Same as above except it's sent as 16 bits
60 * 3. 8-bit with the Data/Command signal as a separate D/CX pin
62 * Currently mipi_dbi only supports Type C options 1 and 3 with
63 * mipi_dbi_spi_init().
66 #define MIPI_DBI_DEBUG_COMMAND(cmd, data, len) \
69 DRM_DEBUG_DRIVER("cmd=%02x\n", cmd); \
71 DRM_DEBUG_DRIVER("cmd=%02x, par=%*ph\n", cmd, (int)len, data);\
73 DRM_DEBUG_DRIVER("cmd=%02x, len=%zu\n", cmd, len); \
76 static const u8 mipi_dbi_dcs_read_commands[] = {
77 MIPI_DCS_GET_DISPLAY_ID,
78 MIPI_DCS_GET_RED_CHANNEL,
79 MIPI_DCS_GET_GREEN_CHANNEL,
80 MIPI_DCS_GET_BLUE_CHANNEL,
81 MIPI_DCS_GET_DISPLAY_STATUS,
82 MIPI_DCS_GET_POWER_MODE,
83 MIPI_DCS_GET_ADDRESS_MODE,
84 MIPI_DCS_GET_PIXEL_FORMAT,
85 MIPI_DCS_GET_DISPLAY_MODE,
86 MIPI_DCS_GET_SIGNAL_MODE,
87 MIPI_DCS_GET_DIAGNOSTIC_RESULT,
88 MIPI_DCS_READ_MEMORY_START,
89 MIPI_DCS_READ_MEMORY_CONTINUE,
90 MIPI_DCS_GET_SCANLINE,
91 MIPI_DCS_GET_DISPLAY_BRIGHTNESS,
92 MIPI_DCS_GET_CONTROL_DISPLAY,
93 MIPI_DCS_GET_POWER_SAVE,
94 MIPI_DCS_GET_CABC_MIN_BRIGHTNESS,
95 MIPI_DCS_READ_DDB_START,
96 MIPI_DCS_READ_DDB_CONTINUE,
100 static bool mipi_dbi_command_is_read(struct mipi_dbi *dbi, u8 cmd)
104 if (!dbi->read_commands)
107 for (i = 0; i < 0xff; i++) {
108 if (!dbi->read_commands[i])
110 if (cmd == dbi->read_commands[i])
118 * mipi_dbi_command_read - MIPI DCS read command
119 * @dbi: MIPI DBI structure
123 * Send MIPI DCS read command to the controller.
126 * Zero on success, negative error code on failure.
128 int mipi_dbi_command_read(struct mipi_dbi *dbi, u8 cmd, u8 *val)
130 if (!dbi->read_commands)
133 if (!mipi_dbi_command_is_read(dbi, cmd))
136 return mipi_dbi_command_buf(dbi, cmd, val, 1);
138 EXPORT_SYMBOL(mipi_dbi_command_read);
141 * mipi_dbi_command_buf - MIPI DCS command with parameter(s) in an array
142 * @dbi: MIPI DBI structure
144 * @data: Parameter buffer
145 * @len: Buffer length
148 * Zero on success, negative error code on failure.
150 int mipi_dbi_command_buf(struct mipi_dbi *dbi, u8 cmd, u8 *data, size_t len)
155 /* SPI requires dma-safe buffers */
156 cmdbuf = kmemdup(&cmd, 1, GFP_KERNEL);
160 mutex_lock(&dbi->cmdlock);
161 ret = dbi->command(dbi, cmdbuf, data, len);
162 mutex_unlock(&dbi->cmdlock);
168 EXPORT_SYMBOL(mipi_dbi_command_buf);
170 /* This should only be used by mipi_dbi_command() */
171 int mipi_dbi_command_stackbuf(struct mipi_dbi *dbi, u8 cmd, const u8 *data,
177 buf = kmemdup(data, len, GFP_KERNEL);
181 ret = mipi_dbi_command_buf(dbi, cmd, buf, len);
187 EXPORT_SYMBOL(mipi_dbi_command_stackbuf);
190 * mipi_dbi_buf_copy - Copy a framebuffer, transforming it if necessary
191 * @dst: The destination buffer
192 * @fb: The source framebuffer
193 * @clip: Clipping rectangle of the area to be copied
194 * @swap: When true, swap MSB/LSB of 16-bit values
197 * Zero on success, negative error code on failure.
199 int mipi_dbi_buf_copy(void *dst, struct drm_framebuffer *fb,
200 struct drm_rect *clip, bool swap)
202 struct drm_gem_object *gem = drm_gem_fb_get_obj(fb, 0);
203 struct drm_gem_cma_object *cma_obj = to_drm_gem_cma_obj(gem);
204 void *src = cma_obj->vaddr;
207 ret = drm_gem_fb_begin_cpu_access(fb, DMA_FROM_DEVICE);
211 switch (fb->format->format) {
212 case DRM_FORMAT_RGB565:
214 drm_fb_swab(dst, src, fb, clip, !gem->import_attach);
216 drm_fb_memcpy(dst, src, fb, clip);
218 case DRM_FORMAT_XRGB8888:
219 drm_fb_xrgb8888_to_rgb565(dst, src, fb, clip, swap);
222 drm_err_once(fb->dev, "Format is not supported: %p4cc\n",
223 &fb->format->format);
227 drm_gem_fb_end_cpu_access(fb, DMA_FROM_DEVICE);
231 EXPORT_SYMBOL(mipi_dbi_buf_copy);
233 static void mipi_dbi_set_window_address(struct mipi_dbi_dev *dbidev,
234 unsigned int xs, unsigned int xe,
235 unsigned int ys, unsigned int ye)
237 struct mipi_dbi *dbi = &dbidev->dbi;
239 xs += dbidev->left_offset;
240 xe += dbidev->left_offset;
241 ys += dbidev->top_offset;
242 ye += dbidev->top_offset;
244 mipi_dbi_command(dbi, MIPI_DCS_SET_COLUMN_ADDRESS, (xs >> 8) & 0xff,
245 xs & 0xff, (xe >> 8) & 0xff, xe & 0xff);
246 mipi_dbi_command(dbi, MIPI_DCS_SET_PAGE_ADDRESS, (ys >> 8) & 0xff,
247 ys & 0xff, (ye >> 8) & 0xff, ye & 0xff);
250 static void mipi_dbi_fb_dirty(struct drm_framebuffer *fb, struct drm_rect *rect)
252 struct drm_gem_object *gem = drm_gem_fb_get_obj(fb, 0);
253 struct drm_gem_cma_object *cma_obj = to_drm_gem_cma_obj(gem);
254 struct mipi_dbi_dev *dbidev = drm_to_mipi_dbi_dev(fb->dev);
255 unsigned int height = rect->y2 - rect->y1;
256 unsigned int width = rect->x2 - rect->x1;
257 struct mipi_dbi *dbi = &dbidev->dbi;
258 bool swap = dbi->swap_bytes;
266 if (!drm_dev_enter(fb->dev, &idx))
269 full = width == fb->width && height == fb->height;
271 DRM_DEBUG_KMS("Flushing [FB:%d] " DRM_RECT_FMT "\n", fb->base.id, DRM_RECT_ARG(rect));
273 if (!dbi->dc || !full || swap ||
274 fb->format->format == DRM_FORMAT_XRGB8888) {
276 ret = mipi_dbi_buf_copy(dbidev->tx_buf, fb, rect, swap);
283 mipi_dbi_set_window_address(dbidev, rect->x1, rect->x2 - 1, rect->y1,
286 ret = mipi_dbi_command_buf(dbi, MIPI_DCS_WRITE_MEMORY_START, tr,
290 drm_err_once(fb->dev, "Failed to update display %d\n", ret);
296 * mipi_dbi_pipe_update - Display pipe update helper
297 * @pipe: Simple display pipe
298 * @old_state: Old plane state
300 * This function handles framebuffer flushing and vblank events. Drivers can use
301 * this as their &drm_simple_display_pipe_funcs->update callback.
303 void mipi_dbi_pipe_update(struct drm_simple_display_pipe *pipe,
304 struct drm_plane_state *old_state)
306 struct drm_plane_state *state = pipe->plane.state;
307 struct drm_rect rect;
309 if (!pipe->crtc.state->active)
312 if (drm_atomic_helper_damage_merged(old_state, state, &rect))
313 mipi_dbi_fb_dirty(state->fb, &rect);
315 EXPORT_SYMBOL(mipi_dbi_pipe_update);
318 * mipi_dbi_enable_flush - MIPI DBI enable helper
319 * @dbidev: MIPI DBI device structure
320 * @crtc_state: CRTC state
321 * @plane_state: Plane state
323 * Flushes the whole framebuffer and enables the backlight. Drivers can use this
324 * in their &drm_simple_display_pipe_funcs->enable callback.
326 * Note: Drivers which don't use mipi_dbi_pipe_update() because they have custom
327 * framebuffer flushing, can't use this function since they both use the same
330 void mipi_dbi_enable_flush(struct mipi_dbi_dev *dbidev,
331 struct drm_crtc_state *crtc_state,
332 struct drm_plane_state *plane_state)
334 struct drm_framebuffer *fb = plane_state->fb;
335 struct drm_rect rect = {
343 if (!drm_dev_enter(&dbidev->drm, &idx))
346 mipi_dbi_fb_dirty(fb, &rect);
347 backlight_enable(dbidev->backlight);
351 EXPORT_SYMBOL(mipi_dbi_enable_flush);
353 static void mipi_dbi_blank(struct mipi_dbi_dev *dbidev)
355 struct drm_device *drm = &dbidev->drm;
356 u16 height = drm->mode_config.min_height;
357 u16 width = drm->mode_config.min_width;
358 struct mipi_dbi *dbi = &dbidev->dbi;
359 size_t len = width * height * 2;
362 if (!drm_dev_enter(drm, &idx))
365 memset(dbidev->tx_buf, 0, len);
367 mipi_dbi_set_window_address(dbidev, 0, width - 1, 0, height - 1);
368 mipi_dbi_command_buf(dbi, MIPI_DCS_WRITE_MEMORY_START,
369 (u8 *)dbidev->tx_buf, len);
375 * mipi_dbi_pipe_disable - MIPI DBI pipe disable helper
376 * @pipe: Display pipe
378 * This function disables backlight if present, if not the display memory is
379 * blanked. The regulator is disabled if in use. Drivers can use this as their
380 * &drm_simple_display_pipe_funcs->disable callback.
382 void mipi_dbi_pipe_disable(struct drm_simple_display_pipe *pipe)
384 struct mipi_dbi_dev *dbidev = drm_to_mipi_dbi_dev(pipe->crtc.dev);
388 if (dbidev->backlight)
389 backlight_disable(dbidev->backlight);
391 mipi_dbi_blank(dbidev);
393 if (dbidev->regulator)
394 regulator_disable(dbidev->regulator);
396 EXPORT_SYMBOL(mipi_dbi_pipe_disable);
398 static int mipi_dbi_connector_get_modes(struct drm_connector *connector)
400 struct mipi_dbi_dev *dbidev = drm_to_mipi_dbi_dev(connector->dev);
401 struct drm_display_mode *mode;
403 mode = drm_mode_duplicate(connector->dev, &dbidev->mode);
405 DRM_ERROR("Failed to duplicate mode\n");
409 if (mode->name[0] == '\0')
410 drm_mode_set_name(mode);
412 mode->type |= DRM_MODE_TYPE_PREFERRED;
413 drm_mode_probed_add(connector, mode);
415 if (mode->width_mm) {
416 connector->display_info.width_mm = mode->width_mm;
417 connector->display_info.height_mm = mode->height_mm;
423 static const struct drm_connector_helper_funcs mipi_dbi_connector_hfuncs = {
424 .get_modes = mipi_dbi_connector_get_modes,
427 static const struct drm_connector_funcs mipi_dbi_connector_funcs = {
428 .reset = drm_atomic_helper_connector_reset,
429 .fill_modes = drm_helper_probe_single_connector_modes,
430 .destroy = drm_connector_cleanup,
431 .atomic_duplicate_state = drm_atomic_helper_connector_duplicate_state,
432 .atomic_destroy_state = drm_atomic_helper_connector_destroy_state,
435 static int mipi_dbi_rotate_mode(struct drm_display_mode *mode,
436 unsigned int rotation)
438 if (rotation == 0 || rotation == 180) {
440 } else if (rotation == 90 || rotation == 270) {
441 swap(mode->hdisplay, mode->vdisplay);
442 swap(mode->hsync_start, mode->vsync_start);
443 swap(mode->hsync_end, mode->vsync_end);
444 swap(mode->htotal, mode->vtotal);
445 swap(mode->width_mm, mode->height_mm);
452 static const struct drm_mode_config_funcs mipi_dbi_mode_config_funcs = {
453 .fb_create = drm_gem_fb_create_with_dirty,
454 .atomic_check = drm_atomic_helper_check,
455 .atomic_commit = drm_atomic_helper_commit,
458 static const uint32_t mipi_dbi_formats[] = {
464 * mipi_dbi_dev_init_with_formats - MIPI DBI device initialization with custom formats
465 * @dbidev: MIPI DBI device structure to initialize
466 * @funcs: Display pipe functions
467 * @formats: Array of supported formats (DRM_FORMAT\_\*).
468 * @format_count: Number of elements in @formats
469 * @mode: Display mode
470 * @rotation: Initial rotation in degrees Counter Clock Wise
471 * @tx_buf_size: Allocate a transmit buffer of this size.
473 * This function sets up a &drm_simple_display_pipe with a &drm_connector that
474 * has one fixed &drm_display_mode which is rotated according to @rotation.
475 * This mode is used to set the mode config min/max width/height properties.
477 * Use mipi_dbi_dev_init() if you don't need custom formats.
480 * Some of the helper functions expects RGB565 to be the default format and the
481 * transmit buffer sized to fit that.
484 * Zero on success, negative error code on failure.
486 int mipi_dbi_dev_init_with_formats(struct mipi_dbi_dev *dbidev,
487 const struct drm_simple_display_pipe_funcs *funcs,
488 const uint32_t *formats, unsigned int format_count,
489 const struct drm_display_mode *mode,
490 unsigned int rotation, size_t tx_buf_size)
492 static const uint64_t modifiers[] = {
493 DRM_FORMAT_MOD_LINEAR,
494 DRM_FORMAT_MOD_INVALID
496 struct drm_device *drm = &dbidev->drm;
499 if (!dbidev->dbi.command)
502 ret = drmm_mode_config_init(drm);
506 dbidev->tx_buf = devm_kmalloc(drm->dev, tx_buf_size, GFP_KERNEL);
510 drm_mode_copy(&dbidev->mode, mode);
511 ret = mipi_dbi_rotate_mode(&dbidev->mode, rotation);
513 DRM_ERROR("Illegal rotation value %u\n", rotation);
517 drm_connector_helper_add(&dbidev->connector, &mipi_dbi_connector_hfuncs);
518 ret = drm_connector_init(drm, &dbidev->connector, &mipi_dbi_connector_funcs,
519 DRM_MODE_CONNECTOR_SPI);
523 ret = drm_simple_display_pipe_init(drm, &dbidev->pipe, funcs, formats, format_count,
524 modifiers, &dbidev->connector);
528 drm_plane_enable_fb_damage_clips(&dbidev->pipe.plane);
530 drm->mode_config.funcs = &mipi_dbi_mode_config_funcs;
531 drm->mode_config.min_width = dbidev->mode.hdisplay;
532 drm->mode_config.max_width = dbidev->mode.hdisplay;
533 drm->mode_config.min_height = dbidev->mode.vdisplay;
534 drm->mode_config.max_height = dbidev->mode.vdisplay;
535 dbidev->rotation = rotation;
537 DRM_DEBUG_KMS("rotation = %u\n", rotation);
541 EXPORT_SYMBOL(mipi_dbi_dev_init_with_formats);
544 * mipi_dbi_dev_init - MIPI DBI device initialization
545 * @dbidev: MIPI DBI device structure to initialize
546 * @funcs: Display pipe functions
547 * @mode: Display mode
548 * @rotation: Initial rotation in degrees Counter Clock Wise
550 * This function sets up a &drm_simple_display_pipe with a &drm_connector that
551 * has one fixed &drm_display_mode which is rotated according to @rotation.
552 * This mode is used to set the mode config min/max width/height properties.
553 * Additionally &mipi_dbi.tx_buf is allocated.
555 * Supported formats: Native RGB565 and emulated XRGB8888.
558 * Zero on success, negative error code on failure.
560 int mipi_dbi_dev_init(struct mipi_dbi_dev *dbidev,
561 const struct drm_simple_display_pipe_funcs *funcs,
562 const struct drm_display_mode *mode, unsigned int rotation)
564 size_t bufsize = mode->vdisplay * mode->hdisplay * sizeof(u16);
566 dbidev->drm.mode_config.preferred_depth = 16;
568 return mipi_dbi_dev_init_with_formats(dbidev, funcs, mipi_dbi_formats,
569 ARRAY_SIZE(mipi_dbi_formats), mode,
572 EXPORT_SYMBOL(mipi_dbi_dev_init);
575 * mipi_dbi_hw_reset - Hardware reset of controller
576 * @dbi: MIPI DBI structure
578 * Reset controller if the &mipi_dbi->reset gpio is set.
580 void mipi_dbi_hw_reset(struct mipi_dbi *dbi)
585 gpiod_set_value_cansleep(dbi->reset, 0);
586 usleep_range(20, 1000);
587 gpiod_set_value_cansleep(dbi->reset, 1);
590 EXPORT_SYMBOL(mipi_dbi_hw_reset);
593 * mipi_dbi_display_is_on - Check if display is on
594 * @dbi: MIPI DBI structure
596 * This function checks the Power Mode register (if readable) to see if
597 * display output is turned on. This can be used to see if the bootloader
598 * has already turned on the display avoiding flicker when the pipeline is
602 * true if the display can be verified to be on, false otherwise.
604 bool mipi_dbi_display_is_on(struct mipi_dbi *dbi)
608 if (mipi_dbi_command_read(dbi, MIPI_DCS_GET_POWER_MODE, &val))
611 val &= ~DCS_POWER_MODE_RESERVED_MASK;
613 /* The poweron/reset value is 08h DCS_POWER_MODE_DISPLAY_NORMAL_MODE */
614 if (val != (DCS_POWER_MODE_DISPLAY |
615 DCS_POWER_MODE_DISPLAY_NORMAL_MODE | DCS_POWER_MODE_SLEEP_MODE))
618 DRM_DEBUG_DRIVER("Display is ON\n");
622 EXPORT_SYMBOL(mipi_dbi_display_is_on);
624 static int mipi_dbi_poweron_reset_conditional(struct mipi_dbi_dev *dbidev, bool cond)
626 struct device *dev = dbidev->drm.dev;
627 struct mipi_dbi *dbi = &dbidev->dbi;
630 if (dbidev->regulator) {
631 ret = regulator_enable(dbidev->regulator);
633 DRM_DEV_ERROR(dev, "Failed to enable regulator (%d)\n", ret);
638 if (cond && mipi_dbi_display_is_on(dbi))
641 mipi_dbi_hw_reset(dbi);
642 ret = mipi_dbi_command(dbi, MIPI_DCS_SOFT_RESET);
644 DRM_DEV_ERROR(dev, "Failed to send reset command (%d)\n", ret);
645 if (dbidev->regulator)
646 regulator_disable(dbidev->regulator);
651 * If we did a hw reset, we know the controller is in Sleep mode and
652 * per MIPI DSC spec should wait 5ms after soft reset. If we didn't,
653 * we assume worst case and wait 120ms.
656 usleep_range(5000, 20000);
664 * mipi_dbi_poweron_reset - MIPI DBI poweron and reset
665 * @dbidev: MIPI DBI device structure
667 * This function enables the regulator if used and does a hardware and software
671 * Zero on success, or a negative error code.
673 int mipi_dbi_poweron_reset(struct mipi_dbi_dev *dbidev)
675 return mipi_dbi_poweron_reset_conditional(dbidev, false);
677 EXPORT_SYMBOL(mipi_dbi_poweron_reset);
680 * mipi_dbi_poweron_conditional_reset - MIPI DBI poweron and conditional reset
681 * @dbidev: MIPI DBI device structure
683 * This function enables the regulator if used and if the display is off, it
684 * does a hardware and software reset. If mipi_dbi_display_is_on() determines
685 * that the display is on, no reset is performed.
688 * Zero if the controller was reset, 1 if the display was already on, or a
689 * negative error code.
691 int mipi_dbi_poweron_conditional_reset(struct mipi_dbi_dev *dbidev)
693 return mipi_dbi_poweron_reset_conditional(dbidev, true);
695 EXPORT_SYMBOL(mipi_dbi_poweron_conditional_reset);
697 #if IS_ENABLED(CONFIG_SPI)
700 * mipi_dbi_spi_cmd_max_speed - get the maximum SPI bus speed
702 * @len: The transfer buffer length.
704 * Many controllers have a max speed of 10MHz, but can be pushed way beyond
705 * that. Increase reliability by running pixel data at max speed and the rest
706 * at 10MHz, preventing transfer glitches from messing up the init settings.
708 u32 mipi_dbi_spi_cmd_max_speed(struct spi_device *spi, size_t len)
711 return 0; /* use default */
713 return min_t(u32, 10000000, spi->max_speed_hz);
715 EXPORT_SYMBOL(mipi_dbi_spi_cmd_max_speed);
717 static bool mipi_dbi_machine_little_endian(void)
719 #if defined(__LITTLE_ENDIAN)
727 * MIPI DBI Type C Option 1
729 * If the SPI controller doesn't have 9 bits per word support,
730 * use blocks of 9 bytes to send 8x 9-bit words using a 8-bit SPI transfer.
731 * Pad partial blocks with MIPI_DCS_NOP (zero).
732 * This is how the D/C bit (x) is added:
744 static int mipi_dbi_spi1e_transfer(struct mipi_dbi *dbi, int dc,
745 const void *buf, size_t len,
748 bool swap_bytes = (bpw == 16 && mipi_dbi_machine_little_endian());
749 size_t chunk, max_chunk = dbi->tx_buf9_len;
750 struct spi_device *spi = dbi->spi;
751 struct spi_transfer tr = {
752 .tx_buf = dbi->tx_buf9,
755 struct spi_message m;
760 if (drm_debug_enabled(DRM_UT_DRIVER))
761 pr_debug("[drm:%s] dc=%d, max_chunk=%zu, transfers:\n",
762 __func__, dc, max_chunk);
764 tr.speed_hz = mipi_dbi_spi_cmd_max_speed(spi, len);
765 spi_message_init_with_transfers(&m, &tr, 1);
768 if (WARN_ON_ONCE(len != 1))
771 /* Command: pad no-op's (zeroes) at beginning of block */
777 return spi_sync(spi, &m);
780 /* max with room for adding one bit per byte */
781 max_chunk = max_chunk / 9 * 8;
782 /* but no bigger than len */
783 max_chunk = min(max_chunk, len);
785 max_chunk = max_t(size_t, 8, max_chunk & ~0x7);
790 chunk = min(len, max_chunk);
797 /* Data: pad no-op's (zeroes) at end of block */
801 for (i = 1; i < (chunk + 1); i++) {
803 *dst++ = carry | BIT(8 - i) | (val >> i);
804 carry = val << (8 - i);
807 *dst++ = carry | BIT(8 - i) | (val >> i);
808 carry = val << (8 - i);
813 for (i = 1; i < (chunk + 1); i++) {
815 *dst++ = carry | BIT(8 - i) | (val >> i);
816 carry = val << (8 - i);
824 for (i = 0; i < chunk; i += 8) {
826 *dst++ = BIT(7) | (src[1] >> 1);
827 *dst++ = (src[1] << 7) | BIT(6) | (src[0] >> 2);
828 *dst++ = (src[0] << 6) | BIT(5) | (src[3] >> 3);
829 *dst++ = (src[3] << 5) | BIT(4) | (src[2] >> 4);
830 *dst++ = (src[2] << 4) | BIT(3) | (src[5] >> 5);
831 *dst++ = (src[5] << 3) | BIT(2) | (src[4] >> 6);
832 *dst++ = (src[4] << 2) | BIT(1) | (src[7] >> 7);
833 *dst++ = (src[7] << 1) | BIT(0);
836 *dst++ = BIT(7) | (src[0] >> 1);
837 *dst++ = (src[0] << 7) | BIT(6) | (src[1] >> 2);
838 *dst++ = (src[1] << 6) | BIT(5) | (src[2] >> 3);
839 *dst++ = (src[2] << 5) | BIT(4) | (src[3] >> 4);
840 *dst++ = (src[3] << 4) | BIT(3) | (src[4] >> 5);
841 *dst++ = (src[4] << 3) | BIT(2) | (src[5] >> 6);
842 *dst++ = (src[5] << 2) | BIT(1) | (src[6] >> 7);
843 *dst++ = (src[6] << 1) | BIT(0);
852 tr.len = chunk + added;
854 ret = spi_sync(spi, &m);
862 static int mipi_dbi_spi1_transfer(struct mipi_dbi *dbi, int dc,
863 const void *buf, size_t len,
866 struct spi_device *spi = dbi->spi;
867 struct spi_transfer tr = {
870 const u16 *src16 = buf;
871 const u8 *src8 = buf;
872 struct spi_message m;
877 if (!spi_is_bpw_supported(spi, 9))
878 return mipi_dbi_spi1e_transfer(dbi, dc, buf, len, bpw);
880 tr.speed_hz = mipi_dbi_spi_cmd_max_speed(spi, len);
881 max_chunk = dbi->tx_buf9_len;
882 dst16 = dbi->tx_buf9;
884 if (drm_debug_enabled(DRM_UT_DRIVER))
885 pr_debug("[drm:%s] dc=%d, max_chunk=%zu, transfers:\n",
886 __func__, dc, max_chunk);
888 max_chunk = min(max_chunk / 2, len);
890 spi_message_init_with_transfers(&m, &tr, 1);
894 size_t chunk = min(len, max_chunk);
897 if (bpw == 16 && mipi_dbi_machine_little_endian()) {
898 for (i = 0; i < (chunk * 2); i += 2) {
899 dst16[i] = *src16 >> 8;
900 dst16[i + 1] = *src16++ & 0xFF;
903 dst16[i + 1] |= 0x0100;
907 for (i = 0; i < chunk; i++) {
917 ret = spi_sync(spi, &m);
925 static int mipi_dbi_typec1_command_read(struct mipi_dbi *dbi, u8 *cmd,
926 u8 *data, size_t len)
928 struct spi_device *spi = dbi->spi;
929 u32 speed_hz = min_t(u32, MIPI_DBI_MAX_SPI_READ_SPEED,
930 spi->max_speed_hz / 2);
931 struct spi_transfer tr[2] = {
933 .speed_hz = speed_hz,
935 .tx_buf = dbi->tx_buf9,
938 .speed_hz = speed_hz,
944 struct spi_message m;
951 if (!spi_is_bpw_supported(spi, 9)) {
953 * FIXME: implement something like mipi_dbi_spi1e_transfer() but
954 * for reads using emulation.
957 "reading on host not supporting 9 bpw not yet implemented\n");
962 * Turn the 8bit command into a 16bit version of the command in the
963 * buffer. Only 9 bits of this will be used when executing the actual
966 dst16 = dbi->tx_buf9;
969 spi_message_init_with_transfers(&m, tr, ARRAY_SIZE(tr));
970 ret = spi_sync(spi, &m);
973 MIPI_DBI_DEBUG_COMMAND(*cmd, data, len);
978 static int mipi_dbi_typec1_command(struct mipi_dbi *dbi, u8 *cmd,
979 u8 *parameters, size_t num)
981 unsigned int bpw = (*cmd == MIPI_DCS_WRITE_MEMORY_START) ? 16 : 8;
984 if (mipi_dbi_command_is_read(dbi, *cmd))
985 return mipi_dbi_typec1_command_read(dbi, cmd, parameters, num);
987 MIPI_DBI_DEBUG_COMMAND(*cmd, parameters, num);
989 ret = mipi_dbi_spi1_transfer(dbi, 0, cmd, 1, 8);
993 return mipi_dbi_spi1_transfer(dbi, 1, parameters, num, bpw);
996 /* MIPI DBI Type C Option 3 */
998 static int mipi_dbi_typec3_command_read(struct mipi_dbi *dbi, u8 *cmd,
999 u8 *data, size_t len)
1001 struct spi_device *spi = dbi->spi;
1002 u32 speed_hz = min_t(u32, MIPI_DBI_MAX_SPI_READ_SPEED,
1003 spi->max_speed_hz / 2);
1004 struct spi_transfer tr[2] = {
1006 .speed_hz = speed_hz,
1010 .speed_hz = speed_hz,
1014 struct spi_message m;
1022 * Support non-standard 24-bit and 32-bit Nokia read commands which
1023 * start with a dummy clock, so we need to read an extra byte.
1025 if (*cmd == MIPI_DCS_GET_DISPLAY_ID ||
1026 *cmd == MIPI_DCS_GET_DISPLAY_STATUS) {
1027 if (!(len == 3 || len == 4))
1030 tr[1].len = len + 1;
1033 buf = kmalloc(tr[1].len, GFP_KERNEL);
1038 gpiod_set_value_cansleep(dbi->dc, 0);
1040 spi_message_init_with_transfers(&m, tr, ARRAY_SIZE(tr));
1041 ret = spi_sync(spi, &m);
1045 if (tr[1].len == len) {
1046 memcpy(data, buf, len);
1050 for (i = 0; i < len; i++)
1051 data[i] = (buf[i] << 1) | (buf[i + 1] >> 7);
1054 MIPI_DBI_DEBUG_COMMAND(*cmd, data, len);
1062 static int mipi_dbi_typec3_command(struct mipi_dbi *dbi, u8 *cmd,
1063 u8 *par, size_t num)
1065 struct spi_device *spi = dbi->spi;
1066 unsigned int bpw = 8;
1070 if (mipi_dbi_command_is_read(dbi, *cmd))
1071 return mipi_dbi_typec3_command_read(dbi, cmd, par, num);
1073 MIPI_DBI_DEBUG_COMMAND(*cmd, par, num);
1075 gpiod_set_value_cansleep(dbi->dc, 0);
1076 speed_hz = mipi_dbi_spi_cmd_max_speed(spi, 1);
1077 ret = mipi_dbi_spi_transfer(spi, speed_hz, 8, cmd, 1);
1081 if (*cmd == MIPI_DCS_WRITE_MEMORY_START && !dbi->swap_bytes)
1084 gpiod_set_value_cansleep(dbi->dc, 1);
1085 speed_hz = mipi_dbi_spi_cmd_max_speed(spi, num);
1087 return mipi_dbi_spi_transfer(spi, speed_hz, bpw, par, num);
1091 * mipi_dbi_spi_init - Initialize MIPI DBI SPI interface
1093 * @dbi: MIPI DBI structure to initialize
1094 * @dc: D/C gpio (optional)
1096 * This function sets &mipi_dbi->command, enables &mipi_dbi->read_commands for the
1097 * usual read commands. It should be followed by a call to mipi_dbi_dev_init() or
1098 * a driver-specific init.
1100 * If @dc is set, a Type C Option 3 interface is assumed, if not
1103 * If the SPI master driver doesn't support the necessary bits per word,
1104 * the following transformation is used:
1106 * - 9-bit: reorder buffer as 9x 8-bit words, padded with no-op command.
1107 * - 16-bit: if big endian send as 8-bit, if little endian swap bytes
1110 * Zero on success, negative error code on failure.
1112 int mipi_dbi_spi_init(struct spi_device *spi, struct mipi_dbi *dbi,
1113 struct gpio_desc *dc)
1115 struct device *dev = &spi->dev;
1119 * Even though it's not the SPI device that does DMA (the master does),
1120 * the dma mask is necessary for the dma_alloc_wc() in
1121 * drm_gem_cma_create(). The dma_addr returned will be a physical
1122 * address which might be different from the bus address, but this is
1123 * not a problem since the address will not be used.
1124 * The virtual address is used in the transfer and the SPI core
1125 * re-maps it on the SPI master device using the DMA streaming API
1128 if (!dev->coherent_dma_mask) {
1129 ret = dma_coerce_mask_and_coherent(dev, DMA_BIT_MASK(32));
1131 dev_warn(dev, "Failed to set dma mask %d\n", ret);
1137 dbi->read_commands = mipi_dbi_dcs_read_commands;
1140 dbi->command = mipi_dbi_typec3_command;
1142 if (mipi_dbi_machine_little_endian() && !spi_is_bpw_supported(spi, 16))
1143 dbi->swap_bytes = true;
1145 dbi->command = mipi_dbi_typec1_command;
1146 dbi->tx_buf9_len = SZ_16K;
1147 dbi->tx_buf9 = devm_kmalloc(dev, dbi->tx_buf9_len, GFP_KERNEL);
1152 mutex_init(&dbi->cmdlock);
1154 DRM_DEBUG_DRIVER("SPI speed: %uMHz\n", spi->max_speed_hz / 1000000);
1158 EXPORT_SYMBOL(mipi_dbi_spi_init);
1161 * mipi_dbi_spi_transfer - SPI transfer helper
1163 * @speed_hz: Override speed (optional)
1164 * @bpw: Bits per word
1165 * @buf: Buffer to transfer
1166 * @len: Buffer length
1168 * This SPI transfer helper breaks up the transfer of @buf into chunks which
1169 * the SPI controller driver can handle.
1172 * Zero on success, negative error code on failure.
1174 int mipi_dbi_spi_transfer(struct spi_device *spi, u32 speed_hz,
1175 u8 bpw, const void *buf, size_t len)
1177 size_t max_chunk = spi_max_transfer_size(spi);
1178 struct spi_transfer tr = {
1179 .bits_per_word = bpw,
1180 .speed_hz = speed_hz,
1182 struct spi_message m;
1186 /* In __spi_validate, there's a validation that no partial transfers
1187 * are accepted (xfer->len % w_size must be zero).
1188 * Here we align max_chunk to multiple of 2 (16bits),
1189 * to prevent transfers from being rejected.
1191 max_chunk = ALIGN_DOWN(max_chunk, 2);
1193 spi_message_init_with_transfers(&m, &tr, 1);
1196 chunk = min(len, max_chunk);
1203 ret = spi_sync(spi, &m);
1210 EXPORT_SYMBOL(mipi_dbi_spi_transfer);
1212 #endif /* CONFIG_SPI */
1214 #ifdef CONFIG_DEBUG_FS
1216 static ssize_t mipi_dbi_debugfs_command_write(struct file *file,
1217 const char __user *ubuf,
1218 size_t count, loff_t *ppos)
1220 struct seq_file *m = file->private_data;
1221 struct mipi_dbi_dev *dbidev = m->private;
1222 u8 val, cmd = 0, parameters[64];
1223 char *buf, *pos, *token;
1226 if (!drm_dev_enter(&dbidev->drm, &idx))
1229 buf = memdup_user_nul(ubuf, count);
1235 /* strip trailing whitespace */
1236 for (i = count - 1; i > 0; i--)
1237 if (isspace(buf[i]))
1244 token = strsep(&pos, " ");
1250 ret = kstrtou8(token, 16, &val);
1257 parameters[i++] = val;
1265 ret = mipi_dbi_command_buf(&dbidev->dbi, cmd, parameters, i);
1272 return ret < 0 ? ret : count;
1275 static int mipi_dbi_debugfs_command_show(struct seq_file *m, void *unused)
1277 struct mipi_dbi_dev *dbidev = m->private;
1278 struct mipi_dbi *dbi = &dbidev->dbi;
1283 if (!drm_dev_enter(&dbidev->drm, &idx))
1286 for (cmd = 0; cmd < 255; cmd++) {
1287 if (!mipi_dbi_command_is_read(dbi, cmd))
1291 case MIPI_DCS_READ_MEMORY_START:
1292 case MIPI_DCS_READ_MEMORY_CONTINUE:
1295 case MIPI_DCS_GET_DISPLAY_ID:
1298 case MIPI_DCS_GET_DISPLAY_STATUS:
1306 seq_printf(m, "%02x: ", cmd);
1307 ret = mipi_dbi_command_buf(dbi, cmd, val, len);
1309 seq_puts(m, "XX\n");
1312 seq_printf(m, "%*phN\n", (int)len, val);
1320 static int mipi_dbi_debugfs_command_open(struct inode *inode,
1323 return single_open(file, mipi_dbi_debugfs_command_show,
1327 static const struct file_operations mipi_dbi_debugfs_command_fops = {
1328 .owner = THIS_MODULE,
1329 .open = mipi_dbi_debugfs_command_open,
1331 .llseek = seq_lseek,
1332 .release = single_release,
1333 .write = mipi_dbi_debugfs_command_write,
1337 * mipi_dbi_debugfs_init - Create debugfs entries
1340 * This function creates a 'command' debugfs file for sending commands to the
1341 * controller or getting the read command values.
1342 * Drivers can use this as their &drm_driver->debugfs_init callback.
1345 void mipi_dbi_debugfs_init(struct drm_minor *minor)
1347 struct mipi_dbi_dev *dbidev = drm_to_mipi_dbi_dev(minor->dev);
1348 umode_t mode = S_IFREG | S_IWUSR;
1350 if (dbidev->dbi.read_commands)
1352 debugfs_create_file("command", mode, minor->debugfs_root, dbidev,
1353 &mipi_dbi_debugfs_command_fops);
1355 EXPORT_SYMBOL(mipi_dbi_debugfs_init);
1359 MODULE_LICENSE("GPL");