1 // SPDX-License-Identifier: GPL-2.0
3 * Lontium LT9211 bridge driver
5 * LT9211 is capable of converting:
6 * 2xDSI/2xLVDS/1xDPI -> 2xDSI/2xLVDS/1xDPI
7 * Currently supported is:
10 * Copyright (C) 2022 Marek Vasut <marex@denx.de>
13 #include <linux/bits.h>
14 #include <linux/clk.h>
15 #include <linux/gpio/consumer.h>
16 #include <linux/i2c.h>
17 #include <linux/module.h>
18 #include <linux/of_device.h>
19 #include <linux/of_graph.h>
20 #include <linux/regmap.h>
21 #include <linux/regulator/consumer.h>
23 #include <drm/drm_atomic_helper.h>
24 #include <drm/drm_bridge.h>
25 #include <drm/drm_mipi_dsi.h>
26 #include <drm/drm_of.h>
27 #include <drm/drm_panel.h>
28 #include <drm/drm_print.h>
29 #include <drm/drm_probe_helper.h>
31 #define REG_PAGE_CONTROL 0xff
32 #define REG_CHIPID0 0x8100
33 #define REG_CHIPID0_VALUE 0x18
34 #define REG_CHIPID1 0x8101
35 #define REG_CHIPID1_VALUE 0x01
36 #define REG_CHIPID2 0x8102
37 #define REG_CHIPID2_VALUE 0xe3
39 #define REG_DSI_LANE 0xd000
40 /* DSI lane count - 0 means 4 lanes ; 1, 2, 3 means 1, 2, 3 lanes. */
41 #define REG_DSI_LANE_COUNT(n) ((n) & 3)
44 struct drm_bridge bridge;
46 struct regmap *regmap;
47 struct mipi_dsi_device *dsi;
48 struct drm_bridge *panel_bridge;
49 struct gpio_desc *reset_gpio;
50 struct regulator *vccio;
52 bool lvds_dual_link_even_odd_swap;
55 static const struct regmap_range lt9211_rw_ranges[] = {
56 regmap_reg_range(0xff, 0xff),
57 regmap_reg_range(0x8100, 0x816b),
58 regmap_reg_range(0x8200, 0x82aa),
59 regmap_reg_range(0x8500, 0x85ff),
60 regmap_reg_range(0x8600, 0x86a0),
61 regmap_reg_range(0x8700, 0x8746),
62 regmap_reg_range(0xd000, 0xd0a7),
63 regmap_reg_range(0xd400, 0xd42c),
64 regmap_reg_range(0xd800, 0xd838),
65 regmap_reg_range(0xd9c0, 0xd9d5),
68 static const struct regmap_access_table lt9211_rw_table = {
69 .yes_ranges = lt9211_rw_ranges,
70 .n_yes_ranges = ARRAY_SIZE(lt9211_rw_ranges),
73 static const struct regmap_range_cfg lt9211_range = {
77 .selector_reg = REG_PAGE_CONTROL,
78 .selector_mask = 0xff,
84 static const struct regmap_config lt9211_regmap_config = {
87 .rd_table = <9211_rw_table,
88 .wr_table = <9211_rw_table,
89 .volatile_table = <9211_rw_table,
90 .ranges = <9211_range,
92 .cache_type = REGCACHE_RBTREE,
93 .max_register = 0xda00,
96 static struct lt9211 *bridge_to_lt9211(struct drm_bridge *bridge)
98 return container_of(bridge, struct lt9211, bridge);
101 static int lt9211_attach(struct drm_bridge *bridge,
102 enum drm_bridge_attach_flags flags)
104 struct lt9211 *ctx = bridge_to_lt9211(bridge);
106 return drm_bridge_attach(bridge->encoder, ctx->panel_bridge,
107 &ctx->bridge, flags);
110 static int lt9211_read_chipid(struct lt9211 *ctx)
115 /* Read Chip ID registers and verify the chip can communicate. */
116 ret = regmap_bulk_read(ctx->regmap, REG_CHIPID0, chipid, 3);
118 dev_err(ctx->dev, "Failed to read Chip ID: %d\n", ret);
122 /* Test for known Chip ID. */
123 if (chipid[0] != REG_CHIPID0_VALUE || chipid[1] != REG_CHIPID1_VALUE ||
124 chipid[2] != REG_CHIPID2_VALUE) {
125 dev_err(ctx->dev, "Unknown Chip ID: 0x%02x 0x%02x 0x%02x\n",
126 chipid[0], chipid[1], chipid[2]);
133 static int lt9211_system_init(struct lt9211 *ctx)
135 const struct reg_sequence lt9211_system_init_seq[] = {
148 return regmap_multi_reg_write(ctx->regmap, lt9211_system_init_seq,
149 ARRAY_SIZE(lt9211_system_init_seq));
152 static int lt9211_configure_rx(struct lt9211 *ctx)
154 const struct reg_sequence lt9211_rx_phy_seq[] = {
160 /* ORR with 0xf8 here to enable DSI DN/DP swap. */
166 const struct reg_sequence lt9211_rx_cal_reset_seq[] = {
171 const struct reg_sequence lt9211_rx_dig_seq[] = {
173 /* 0x8588: BIT 6 set = MIPI-RX, BIT 4 unset = LVDS-TX */
176 { REG_DSI_LANE, REG_DSI_LANE_COUNT(ctx->dsi->lanes) },
180 const struct reg_sequence lt9211_rx_div_reset_seq[] = {
185 const struct reg_sequence lt9211_rx_div_clear_seq[] = {
192 ret = regmap_multi_reg_write(ctx->regmap, lt9211_rx_phy_seq,
193 ARRAY_SIZE(lt9211_rx_phy_seq));
197 ret = regmap_multi_reg_write(ctx->regmap, lt9211_rx_cal_reset_seq,
198 ARRAY_SIZE(lt9211_rx_cal_reset_seq));
202 ret = regmap_multi_reg_write(ctx->regmap, lt9211_rx_dig_seq,
203 ARRAY_SIZE(lt9211_rx_dig_seq));
207 ret = regmap_multi_reg_write(ctx->regmap, lt9211_rx_div_reset_seq,
208 ARRAY_SIZE(lt9211_rx_div_reset_seq));
212 usleep_range(10000, 15000);
214 return regmap_multi_reg_write(ctx->regmap, lt9211_rx_div_clear_seq,
215 ARRAY_SIZE(lt9211_rx_div_clear_seq));
218 static int lt9211_autodetect_rx(struct lt9211 *ctx,
219 const struct drm_display_mode *mode)
228 /* Measure ByteClock frequency. */
229 ret = regmap_write(ctx->regmap, 0x8600, 0x01);
233 /* Give the chip time to lock onto RX stream. */
236 /* Read the ByteClock frequency from the chip. */
237 ret = regmap_bulk_read(ctx->regmap, 0x8608, bc, sizeof(bc));
241 /* RX ByteClock in kHz */
242 byteclk = ((bc[0] & 0xf) << 16) | (bc[1] << 8) | bc[2];
244 /* Width/Height/Format Auto-detection */
245 ret = regmap_bulk_read(ctx->regmap, 0xd082, buf, sizeof(buf));
249 width = (buf[0] << 8) | buf[1];
250 height = (buf[3] << 8) | buf[4];
251 format = buf[2] & 0xf;
253 if (format == 0x3) { /* YUV422 16bit */
255 } else if (format == 0xa) { /* RGB888 24bit */
258 dev_err(ctx->dev, "Unsupported DSI pixel format 0x%01x\n",
263 if (width != mode->hdisplay) {
265 "RX: Detected DSI width (%d) does not match mode hdisplay (%d)\n",
266 width, mode->hdisplay);
270 if (height != mode->vdisplay) {
272 "RX: Detected DSI height (%d) does not match mode vdisplay (%d)\n",
273 height, mode->vdisplay);
277 dev_dbg(ctx->dev, "RX: %dx%d format=0x%01x byteclock=%d kHz\n",
278 width, height, format, byteclk);
283 static int lt9211_configure_timing(struct lt9211 *ctx,
284 const struct drm_display_mode *mode)
286 const struct reg_sequence lt9211_timing[] = {
287 { 0xd00d, (mode->vtotal >> 8) & 0xff },
288 { 0xd00e, mode->vtotal & 0xff },
289 { 0xd00f, (mode->vdisplay >> 8) & 0xff },
290 { 0xd010, mode->vdisplay & 0xff },
291 { 0xd011, (mode->htotal >> 8) & 0xff },
292 { 0xd012, mode->htotal & 0xff },
293 { 0xd013, (mode->hdisplay >> 8) & 0xff },
294 { 0xd014, mode->hdisplay & 0xff },
295 { 0xd015, (mode->vsync_end - mode->vsync_start) & 0xff },
296 { 0xd016, (mode->hsync_end - mode->hsync_start) & 0xff },
297 { 0xd017, ((mode->vsync_start - mode->vdisplay) >> 8) & 0xff },
298 { 0xd018, (mode->vsync_start - mode->vdisplay) & 0xff },
299 { 0xd019, ((mode->hsync_start - mode->hdisplay) >> 8) & 0xff },
300 { 0xd01a, (mode->hsync_start - mode->hdisplay) & 0xff },
303 return regmap_multi_reg_write(ctx->regmap, lt9211_timing,
304 ARRAY_SIZE(lt9211_timing));
307 static int lt9211_configure_plls(struct lt9211 *ctx,
308 const struct drm_display_mode *mode)
310 const struct reg_sequence lt9211_pcr_seq[] = {
330 /* DeSSC PLL reference clock is 25 MHz XTal. */
331 ret = regmap_write(ctx->regmap, 0x822d, 0x48);
335 if (mode->clock < 44000) {
336 ret = regmap_write(ctx->regmap, 0x8235, 0x83);
337 } else if (mode->clock < 88000) {
338 ret = regmap_write(ctx->regmap, 0x8235, 0x82);
339 } else if (mode->clock < 176000) {
340 ret = regmap_write(ctx->regmap, 0x8235, 0x81);
343 "Unsupported mode clock (%d kHz) above 176 MHz.\n",
351 /* Wait for the DeSSC PLL to stabilize. */
354 ret = regmap_multi_reg_write(ctx->regmap, lt9211_pcr_seq,
355 ARRAY_SIZE(lt9211_pcr_seq));
359 /* PCR stability test takes seconds. */
360 ret = regmap_read_poll_timeout(ctx->regmap, 0xd087, pval, pval & 0x8,
363 dev_err(ctx->dev, "PCR unstable, ret=%i\n", ret);
368 static int lt9211_configure_tx(struct lt9211 *ctx, bool jeida,
371 const struct reg_sequence system_lt9211_tx_phy_seq[] = {
372 /* DPI output disable */
374 /* BIT(7) is LVDS dual-port */
375 { 0x823b, 0x38 | (ctx->lvds_dual_link ? BIT(7) : 0) },
389 /* LVDS channel order, Odd:Even 0x10..A:B, 0x40..B:A */
390 { 0x8646, ctx->lvds_dual_link_even_odd_swap ? 0x40 : 0x10 },
395 const struct reg_sequence system_lt9211_tx_dig_seq[] = {
396 { 0x8559, 0x40 | (jeida ? BIT(7) : 0) |
397 (de ? BIT(5) : 0) | (bpp24 ? BIT(4) : 0) },
400 { 0x855c, ctx->lvds_dual_link ? BIT(0) : 0 },
410 const struct reg_sequence system_lt9211_tx_pll_seq[] = {
411 /* TX PLL power down */
413 { 0x8237, ctx->lvds_dual_link ? 0x2a : 0x29 },
425 ret = regmap_multi_reg_write(ctx->regmap, system_lt9211_tx_phy_seq,
426 ARRAY_SIZE(system_lt9211_tx_phy_seq));
430 ret = regmap_multi_reg_write(ctx->regmap, system_lt9211_tx_dig_seq,
431 ARRAY_SIZE(system_lt9211_tx_dig_seq));
435 ret = regmap_multi_reg_write(ctx->regmap, system_lt9211_tx_pll_seq,
436 ARRAY_SIZE(system_lt9211_tx_pll_seq));
440 ret = regmap_read_poll_timeout(ctx->regmap, 0x871f, pval, pval & 0x80,
443 dev_err(ctx->dev, "TX PLL unstable, ret=%i\n", ret);
447 ret = regmap_read_poll_timeout(ctx->regmap, 0x8720, pval, pval & 0x80,
450 dev_err(ctx->dev, "TX PLL unstable, ret=%i\n", ret);
457 static void lt9211_atomic_enable(struct drm_bridge *bridge,
458 struct drm_bridge_state *old_bridge_state)
460 struct lt9211 *ctx = bridge_to_lt9211(bridge);
461 struct drm_atomic_state *state = old_bridge_state->base.state;
462 const struct drm_bridge_state *bridge_state;
463 const struct drm_crtc_state *crtc_state;
464 const struct drm_display_mode *mode;
465 struct drm_connector *connector;
466 struct drm_crtc *crtc;
467 bool lvds_format_24bpp;
468 bool lvds_format_jeida;
472 ret = regulator_enable(ctx->vccio);
474 dev_err(ctx->dev, "Failed to enable vccio: %d\n", ret);
479 gpiod_set_value(ctx->reset_gpio, 1);
480 usleep_range(20000, 21000); /* Very long post-reset delay. */
482 /* Get the LVDS format from the bridge state. */
483 bridge_state = drm_atomic_get_new_bridge_state(state, bridge);
484 bus_flags = bridge_state->output_bus_cfg.flags;
486 switch (bridge_state->output_bus_cfg.format) {
487 case MEDIA_BUS_FMT_RGB666_1X7X3_SPWG:
488 lvds_format_24bpp = false;
489 lvds_format_jeida = true;
491 case MEDIA_BUS_FMT_RGB888_1X7X4_JEIDA:
492 lvds_format_24bpp = true;
493 lvds_format_jeida = true;
495 case MEDIA_BUS_FMT_RGB888_1X7X4_SPWG:
496 lvds_format_24bpp = true;
497 lvds_format_jeida = false;
501 * Some bridges still don't set the correct
502 * LVDS bus pixel format, use SPWG24 default
503 * format until those are fixed.
505 lvds_format_24bpp = true;
506 lvds_format_jeida = false;
508 "Unsupported LVDS bus format 0x%04x, please check output bridge driver. Falling back to SPWG24.\n",
509 bridge_state->output_bus_cfg.format);
514 * Retrieve the CRTC adjusted mode. This requires a little dance to go
515 * from the bridge to the encoder, to the connector and to the CRTC.
517 connector = drm_atomic_get_new_connector_for_encoder(state,
519 crtc = drm_atomic_get_new_connector_state(state, connector)->crtc;
520 crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
521 mode = &crtc_state->adjusted_mode;
523 ret = lt9211_read_chipid(ctx);
527 ret = lt9211_system_init(ctx);
531 ret = lt9211_configure_rx(ctx);
535 ret = lt9211_autodetect_rx(ctx, mode);
539 ret = lt9211_configure_timing(ctx, mode);
543 ret = lt9211_configure_plls(ctx, mode);
547 ret = lt9211_configure_tx(ctx, lvds_format_jeida, lvds_format_24bpp,
548 bus_flags & DRM_BUS_FLAG_DE_HIGH);
552 dev_dbg(ctx->dev, "LT9211 enabled.\n");
555 static void lt9211_atomic_disable(struct drm_bridge *bridge,
556 struct drm_bridge_state *old_bridge_state)
558 struct lt9211 *ctx = bridge_to_lt9211(bridge);
562 * Put the chip in reset, pull nRST line low,
563 * and assure lengthy 10ms reset low timing.
565 gpiod_set_value(ctx->reset_gpio, 0);
566 usleep_range(10000, 11000); /* Very long reset duration. */
568 ret = regulator_disable(ctx->vccio);
570 dev_err(ctx->dev, "Failed to disable vccio: %d\n", ret);
572 regcache_mark_dirty(ctx->regmap);
575 static enum drm_mode_status
576 lt9211_mode_valid(struct drm_bridge *bridge,
577 const struct drm_display_info *info,
578 const struct drm_display_mode *mode)
580 /* LVDS output clock range 25..176 MHz */
581 if (mode->clock < 25000)
582 return MODE_CLOCK_LOW;
583 if (mode->clock > 176000)
584 return MODE_CLOCK_HIGH;
589 #define MAX_INPUT_SEL_FORMATS 1
592 lt9211_atomic_get_input_bus_fmts(struct drm_bridge *bridge,
593 struct drm_bridge_state *bridge_state,
594 struct drm_crtc_state *crtc_state,
595 struct drm_connector_state *conn_state,
597 unsigned int *num_input_fmts)
603 input_fmts = kcalloc(MAX_INPUT_SEL_FORMATS, sizeof(*input_fmts),
608 /* This is the DSI-end bus format */
609 input_fmts[0] = MEDIA_BUS_FMT_RGB888_1X24;
615 static const struct drm_bridge_funcs lt9211_funcs = {
616 .attach = lt9211_attach,
617 .mode_valid = lt9211_mode_valid,
618 .atomic_enable = lt9211_atomic_enable,
619 .atomic_disable = lt9211_atomic_disable,
620 .atomic_duplicate_state = drm_atomic_helper_bridge_duplicate_state,
621 .atomic_destroy_state = drm_atomic_helper_bridge_destroy_state,
622 .atomic_get_input_bus_fmts = lt9211_atomic_get_input_bus_fmts,
623 .atomic_reset = drm_atomic_helper_bridge_reset,
626 static int lt9211_parse_dt(struct lt9211 *ctx)
628 struct device_node *port2, *port3;
629 struct drm_bridge *panel_bridge;
630 struct device *dev = ctx->dev;
631 struct drm_panel *panel;
635 ctx->vccio = devm_regulator_get(dev, "vccio");
636 if (IS_ERR(ctx->vccio))
637 return dev_err_probe(dev, PTR_ERR(ctx->vccio),
638 "Failed to get supply 'vccio'\n");
640 ctx->lvds_dual_link = false;
641 ctx->lvds_dual_link_even_odd_swap = false;
643 port2 = of_graph_get_port_by_id(dev->of_node, 2);
644 port3 = of_graph_get_port_by_id(dev->of_node, 3);
645 dual_link = drm_of_lvds_get_dual_link_pixel_order(port2, port3);
649 if (dual_link == DRM_LVDS_DUAL_LINK_ODD_EVEN_PIXELS) {
650 ctx->lvds_dual_link = true;
651 /* Odd pixels to LVDS Channel A, even pixels to B */
652 ctx->lvds_dual_link_even_odd_swap = false;
653 } else if (dual_link == DRM_LVDS_DUAL_LINK_EVEN_ODD_PIXELS) {
654 ctx->lvds_dual_link = true;
655 /* Even pixels to LVDS Channel A, odd pixels to B */
656 ctx->lvds_dual_link_even_odd_swap = true;
659 ret = drm_of_find_panel_or_bridge(dev->of_node, 2, 0, &panel, &panel_bridge);
663 panel_bridge = devm_drm_panel_bridge_add(dev, panel);
664 if (IS_ERR(panel_bridge))
665 return PTR_ERR(panel_bridge);
668 ctx->panel_bridge = panel_bridge;
673 static int lt9211_host_attach(struct lt9211 *ctx)
675 const struct mipi_dsi_device_info info = {
680 struct device *dev = ctx->dev;
681 struct device_node *host_node;
682 struct device_node *endpoint;
683 struct mipi_dsi_device *dsi;
684 struct mipi_dsi_host *host;
688 endpoint = of_graph_get_endpoint_by_regs(dev->of_node, 0, -1);
689 dsi_lanes = of_property_count_u32_elems(endpoint, "data-lanes");
690 host_node = of_graph_get_remote_port_parent(endpoint);
691 host = of_find_mipi_dsi_host_by_node(host_node);
692 of_node_put(host_node);
693 of_node_put(endpoint);
696 return -EPROBE_DEFER;
698 if (dsi_lanes < 0 || dsi_lanes > 4)
701 dsi = devm_mipi_dsi_device_register_full(dev, host, &info);
703 return dev_err_probe(dev, PTR_ERR(dsi),
704 "failed to create dsi device\n");
708 dsi->lanes = dsi_lanes;
709 dsi->format = MIPI_DSI_FMT_RGB888;
710 dsi->mode_flags = MIPI_DSI_MODE_VIDEO | MIPI_DSI_MODE_VIDEO_SYNC_PULSE |
711 MIPI_DSI_MODE_VIDEO_HSE;
713 ret = devm_mipi_dsi_attach(dev, dsi);
715 dev_err(dev, "failed to attach dsi to host: %d\n", ret);
722 static int lt9211_probe(struct i2c_client *client,
723 const struct i2c_device_id *id)
725 struct device *dev = &client->dev;
729 ctx = devm_kzalloc(dev, sizeof(*ctx), GFP_KERNEL);
736 * Put the chip in reset, pull nRST line low,
737 * and assure lengthy 10ms reset low timing.
739 ctx->reset_gpio = devm_gpiod_get_optional(ctx->dev, "reset",
741 if (IS_ERR(ctx->reset_gpio))
742 return PTR_ERR(ctx->reset_gpio);
744 usleep_range(10000, 11000); /* Very long reset duration. */
746 ret = lt9211_parse_dt(ctx);
750 ctx->regmap = devm_regmap_init_i2c(client, <9211_regmap_config);
751 if (IS_ERR(ctx->regmap))
752 return PTR_ERR(ctx->regmap);
754 dev_set_drvdata(dev, ctx);
755 i2c_set_clientdata(client, ctx);
757 ctx->bridge.funcs = <9211_funcs;
758 ctx->bridge.of_node = dev->of_node;
759 drm_bridge_add(&ctx->bridge);
761 ret = lt9211_host_attach(ctx);
763 drm_bridge_remove(&ctx->bridge);
768 static int lt9211_remove(struct i2c_client *client)
770 struct lt9211 *ctx = i2c_get_clientdata(client);
772 drm_bridge_remove(&ctx->bridge);
777 static struct i2c_device_id lt9211_id[] = {
778 { "lontium,lt9211" },
781 MODULE_DEVICE_TABLE(i2c, lt9211_id);
783 static const struct of_device_id lt9211_match_table[] = {
784 { .compatible = "lontium,lt9211" },
787 MODULE_DEVICE_TABLE(of, lt9211_match_table);
789 static struct i2c_driver lt9211_driver = {
790 .probe = lt9211_probe,
791 .remove = lt9211_remove,
792 .id_table = lt9211_id,
795 .of_match_table = lt9211_match_table,
798 module_i2c_driver(lt9211_driver);
800 MODULE_AUTHOR("Marek Vasut <marex@denx.de>");
801 MODULE_DESCRIPTION("Lontium LT9211 DSI/LVDS/DPI bridge driver");
802 MODULE_LICENSE("GPL");