1 // SPDX-License-Identifier: GPL-2.0
3 * Raydium RM67191 MIPI-DSI panel driver
8 #include <linux/backlight.h>
9 #include <linux/delay.h>
10 #include <linux/gpio/consumer.h>
11 #include <linux/module.h>
13 #include <linux/regulator/consumer.h>
15 #include <video/mipi_display.h>
16 #include <video/of_videomode.h>
17 #include <video/videomode.h>
19 #include <drm/drm_crtc.h>
20 #include <drm/drm_mipi_dsi.h>
21 #include <drm/drm_panel.h>
22 #include <drm/drm_print.h>
24 /* Panel specific color-format bits */
25 #define COL_FMT_16BPP 0x55
26 #define COL_FMT_18BPP 0x66
27 #define COL_FMT_24BPP 0x77
29 /* Write Manufacture Command Set Control */
30 #define WRMAUCCTR 0xFE
32 /* Manufacturer Command Set pages (CMD2) */
33 struct cmd_set_entry {
39 * There is no description in the Reference Manual about these commands.
40 * We received them from vendor, so just use them as is.
42 static const struct cmd_set_entry manufacturer_cmd_set[] = {
188 static const u32 rad_bus_formats[] = {
189 MEDIA_BUS_FMT_RGB888_1X24,
190 MEDIA_BUS_FMT_RGB666_1X18,
191 MEDIA_BUS_FMT_RGB565_1X16,
194 static const u32 rad_bus_flags = DRM_BUS_FLAG_DE_LOW |
195 DRM_BUS_FLAG_PIXDATA_SAMPLE_POSEDGE;
198 struct drm_panel panel;
199 struct mipi_dsi_device *dsi;
201 struct gpio_desc *reset;
202 struct backlight_device *backlight;
204 struct regulator_bulk_data *supplies;
205 unsigned int num_supplies;
211 static const struct drm_display_mode default_mode = {
214 .hsync_start = 1080 + 20,
215 .hsync_end = 1080 + 20 + 2,
216 .htotal = 1080 + 20 + 2 + 34,
218 .vsync_start = 1920 + 10,
219 .vsync_end = 1920 + 10 + 2,
220 .vtotal = 1920 + 10 + 2 + 4,
223 .flags = DRM_MODE_FLAG_NHSYNC |
224 DRM_MODE_FLAG_NVSYNC,
227 static inline struct rad_panel *to_rad_panel(struct drm_panel *panel)
229 return container_of(panel, struct rad_panel, panel);
232 static int rad_panel_push_cmd_list(struct mipi_dsi_device *dsi)
235 size_t count = ARRAY_SIZE(manufacturer_cmd_set);
238 for (i = 0; i < count; i++) {
239 const struct cmd_set_entry *entry = &manufacturer_cmd_set[i];
240 u8 buffer[2] = { entry->cmd, entry->param };
242 ret = mipi_dsi_generic_write(dsi, &buffer, sizeof(buffer));
250 static int color_format_from_dsi_format(enum mipi_dsi_pixel_format format)
253 case MIPI_DSI_FMT_RGB565:
254 return COL_FMT_16BPP;
255 case MIPI_DSI_FMT_RGB666:
256 case MIPI_DSI_FMT_RGB666_PACKED:
257 return COL_FMT_18BPP;
258 case MIPI_DSI_FMT_RGB888:
259 return COL_FMT_24BPP;
261 return COL_FMT_24BPP; /* for backward compatibility */
265 static int rad_panel_prepare(struct drm_panel *panel)
267 struct rad_panel *rad = to_rad_panel(panel);
273 ret = regulator_bulk_enable(rad->num_supplies, rad->supplies);
278 gpiod_set_value_cansleep(rad->reset, 1);
279 usleep_range(3000, 5000);
280 gpiod_set_value_cansleep(rad->reset, 0);
281 usleep_range(18000, 20000);
284 rad->prepared = true;
289 static int rad_panel_unprepare(struct drm_panel *panel)
291 struct rad_panel *rad = to_rad_panel(panel);
298 * Right after asserting the reset, we need to release it, so that the
299 * touch driver can have an active connection with the touch controller
300 * even after the display is turned off.
303 gpiod_set_value_cansleep(rad->reset, 1);
304 usleep_range(15000, 17000);
305 gpiod_set_value_cansleep(rad->reset, 0);
308 ret = regulator_bulk_disable(rad->num_supplies, rad->supplies);
312 rad->prepared = false;
317 static int rad_panel_enable(struct drm_panel *panel)
319 struct rad_panel *rad = to_rad_panel(panel);
320 struct mipi_dsi_device *dsi = rad->dsi;
321 struct device *dev = &dsi->dev;
322 int color_format = color_format_from_dsi_format(dsi->format);
328 dsi->mode_flags |= MIPI_DSI_MODE_LPM;
330 ret = rad_panel_push_cmd_list(dsi);
332 DRM_DEV_ERROR(dev, "Failed to send MCS (%d)\n", ret);
336 /* Select User Command Set table (CMD1) */
337 ret = mipi_dsi_generic_write(dsi, (u8[]){ WRMAUCCTR, 0x00 }, 2);
342 ret = mipi_dsi_dcs_soft_reset(dsi);
344 DRM_DEV_ERROR(dev, "Failed to do Software Reset (%d)\n", ret);
348 usleep_range(15000, 17000);
351 ret = mipi_dsi_generic_write(dsi, (u8[]){ 0xC2, 0x0B }, 2);
353 DRM_DEV_ERROR(dev, "Failed to set DSI mode (%d)\n", ret);
357 ret = mipi_dsi_dcs_set_tear_on(dsi, MIPI_DSI_DCS_TEAR_MODE_VBLANK);
359 DRM_DEV_ERROR(dev, "Failed to set tear ON (%d)\n", ret);
362 /* Set tear scanline */
363 ret = mipi_dsi_dcs_set_tear_scanline(dsi, 0x380);
365 DRM_DEV_ERROR(dev, "Failed to set tear scanline (%d)\n", ret);
368 /* Set pixel format */
369 ret = mipi_dsi_dcs_set_pixel_format(dsi, color_format);
370 DRM_DEV_DEBUG_DRIVER(dev, "Interface color format set to 0x%x\n",
373 DRM_DEV_ERROR(dev, "Failed to set pixel format (%d)\n", ret);
376 /* Exit sleep mode */
377 ret = mipi_dsi_dcs_exit_sleep_mode(dsi);
379 DRM_DEV_ERROR(dev, "Failed to exit sleep mode (%d)\n", ret);
383 usleep_range(5000, 7000);
385 ret = mipi_dsi_dcs_set_display_on(dsi);
387 DRM_DEV_ERROR(dev, "Failed to set display ON (%d)\n", ret);
391 backlight_enable(rad->backlight);
398 gpiod_set_value_cansleep(rad->reset, 1);
403 static int rad_panel_disable(struct drm_panel *panel)
405 struct rad_panel *rad = to_rad_panel(panel);
406 struct mipi_dsi_device *dsi = rad->dsi;
407 struct device *dev = &dsi->dev;
413 dsi->mode_flags |= MIPI_DSI_MODE_LPM;
415 backlight_disable(rad->backlight);
417 usleep_range(10000, 12000);
419 ret = mipi_dsi_dcs_set_display_off(dsi);
421 DRM_DEV_ERROR(dev, "Failed to set display OFF (%d)\n", ret);
425 usleep_range(5000, 10000);
427 ret = mipi_dsi_dcs_enter_sleep_mode(dsi);
429 DRM_DEV_ERROR(dev, "Failed to enter sleep mode (%d)\n", ret);
433 rad->enabled = false;
438 static int rad_panel_get_modes(struct drm_panel *panel,
439 struct drm_connector *connector)
441 struct drm_display_mode *mode;
443 mode = drm_mode_duplicate(connector->dev, &default_mode);
445 DRM_DEV_ERROR(panel->dev, "failed to add mode %ux%ux@%u\n",
446 default_mode.hdisplay, default_mode.vdisplay,
447 drm_mode_vrefresh(&default_mode));
451 drm_mode_set_name(mode);
452 mode->type = DRM_MODE_TYPE_DRIVER | DRM_MODE_TYPE_PREFERRED;
453 drm_mode_probed_add(connector, mode);
455 connector->display_info.width_mm = mode->width_mm;
456 connector->display_info.height_mm = mode->height_mm;
457 connector->display_info.bus_flags = rad_bus_flags;
459 drm_display_info_set_bus_formats(&connector->display_info,
461 ARRAY_SIZE(rad_bus_formats));
465 static int rad_bl_get_brightness(struct backlight_device *bl)
467 struct mipi_dsi_device *dsi = bl_get_data(bl);
468 struct rad_panel *rad = mipi_dsi_get_drvdata(dsi);
475 dsi->mode_flags &= ~MIPI_DSI_MODE_LPM;
477 ret = mipi_dsi_dcs_get_display_brightness(dsi, &brightness);
481 bl->props.brightness = brightness;
483 return brightness & 0xff;
486 static int rad_bl_update_status(struct backlight_device *bl)
488 struct mipi_dsi_device *dsi = bl_get_data(bl);
489 struct rad_panel *rad = mipi_dsi_get_drvdata(dsi);
495 dsi->mode_flags &= ~MIPI_DSI_MODE_LPM;
497 ret = mipi_dsi_dcs_set_display_brightness(dsi, bl->props.brightness);
504 static const struct backlight_ops rad_bl_ops = {
505 .update_status = rad_bl_update_status,
506 .get_brightness = rad_bl_get_brightness,
509 static const struct drm_panel_funcs rad_panel_funcs = {
510 .prepare = rad_panel_prepare,
511 .unprepare = rad_panel_unprepare,
512 .enable = rad_panel_enable,
513 .disable = rad_panel_disable,
514 .get_modes = rad_panel_get_modes,
517 static const char * const rad_supply_names[] = {
522 static int rad_init_regulators(struct rad_panel *rad)
524 struct device *dev = &rad->dsi->dev;
527 rad->num_supplies = ARRAY_SIZE(rad_supply_names);
528 rad->supplies = devm_kcalloc(dev, rad->num_supplies,
529 sizeof(*rad->supplies), GFP_KERNEL);
533 for (i = 0; i < rad->num_supplies; i++)
534 rad->supplies[i].supply = rad_supply_names[i];
536 return devm_regulator_bulk_get(dev, rad->num_supplies, rad->supplies);
539 static int rad_panel_probe(struct mipi_dsi_device *dsi)
541 struct device *dev = &dsi->dev;
542 struct device_node *np = dev->of_node;
543 struct rad_panel *panel;
544 struct backlight_properties bl_props;
548 panel = devm_kzalloc(&dsi->dev, sizeof(*panel), GFP_KERNEL);
552 mipi_dsi_set_drvdata(dsi, panel);
556 dsi->format = MIPI_DSI_FMT_RGB888;
557 dsi->mode_flags = MIPI_DSI_MODE_VIDEO_HSE | MIPI_DSI_MODE_VIDEO |
558 MIPI_DSI_CLOCK_NON_CONTINUOUS;
560 ret = of_property_read_u32(np, "video-mode", &video_mode);
562 switch (video_mode) {
565 dsi->mode_flags |= MIPI_DSI_MODE_VIDEO_BURST;
568 /* non-burst mode with sync event */
571 /* non-burst mode with sync pulse */
572 dsi->mode_flags |= MIPI_DSI_MODE_VIDEO_SYNC_PULSE;
575 dev_warn(dev, "invalid video mode %d\n", video_mode);
580 ret = of_property_read_u32(np, "dsi-lanes", &dsi->lanes);
582 dev_err(dev, "Failed to get dsi-lanes property (%d)\n", ret);
586 panel->reset = devm_gpiod_get_optional(dev, "reset", GPIOD_OUT_LOW);
587 if (IS_ERR(panel->reset))
588 return PTR_ERR(panel->reset);
590 memset(&bl_props, 0, sizeof(bl_props));
591 bl_props.type = BACKLIGHT_RAW;
592 bl_props.brightness = 255;
593 bl_props.max_brightness = 255;
595 panel->backlight = devm_backlight_device_register(dev, dev_name(dev),
596 dev, dsi, &rad_bl_ops,
598 if (IS_ERR(panel->backlight)) {
599 ret = PTR_ERR(panel->backlight);
600 dev_err(dev, "Failed to register backlight (%d)\n", ret);
604 ret = rad_init_regulators(panel);
608 drm_panel_init(&panel->panel, dev, &rad_panel_funcs,
609 DRM_MODE_CONNECTOR_DSI);
610 dev_set_drvdata(dev, panel);
612 ret = drm_panel_add(&panel->panel);
616 ret = mipi_dsi_attach(dsi);
618 drm_panel_remove(&panel->panel);
623 static int rad_panel_remove(struct mipi_dsi_device *dsi)
625 struct rad_panel *rad = mipi_dsi_get_drvdata(dsi);
626 struct device *dev = &dsi->dev;
629 ret = mipi_dsi_detach(dsi);
631 DRM_DEV_ERROR(dev, "Failed to detach from host (%d)\n",
634 drm_panel_remove(&rad->panel);
639 static void rad_panel_shutdown(struct mipi_dsi_device *dsi)
641 struct rad_panel *rad = mipi_dsi_get_drvdata(dsi);
643 rad_panel_disable(&rad->panel);
644 rad_panel_unprepare(&rad->panel);
647 static const struct of_device_id rad_of_match[] = {
648 { .compatible = "raydium,rm67191", },
651 MODULE_DEVICE_TABLE(of, rad_of_match);
653 static struct mipi_dsi_driver rad_panel_driver = {
655 .name = "panel-raydium-rm67191",
656 .of_match_table = rad_of_match,
658 .probe = rad_panel_probe,
659 .remove = rad_panel_remove,
660 .shutdown = rad_panel_shutdown,
662 module_mipi_dsi_driver(rad_panel_driver);
664 MODULE_AUTHOR("Robert Chiras <robert.chiras@nxp.com>");
665 MODULE_DESCRIPTION("DRM Driver for Raydium RM67191 MIPI DSI panel");
666 MODULE_LICENSE("GPL v2");