2 * tc358767 eDP bridge driver
4 * Copyright (C) 2016 CogentEmbedded Inc
9 * Copyright (C) 2016 Zodiac Inflight Innovations
11 * Initially based on: drivers/gpu/drm/i2c/tda998x_drv.c
13 * Copyright (C) 2012 Texas Instruments
16 * This program is free software; you can redistribute it and/or modify
17 * it under the terms of the GNU General Public License as published by
18 * the Free Software Foundation; either version 2 of the License, or
19 * (at your option) any later version.
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU General Public License for more details.
27 #include <linux/clk.h>
28 #include <linux/device.h>
29 #include <linux/gpio/consumer.h>
30 #include <linux/i2c.h>
31 #include <linux/kernel.h>
32 #include <linux/module.h>
33 #include <linux/regmap.h>
34 #include <linux/slab.h>
36 #include <drm/drm_atomic_helper.h>
37 #include <drm/drm_crtc_helper.h>
38 #include <drm/drm_dp_helper.h>
39 #include <drm/drm_edid.h>
40 #include <drm/drm_of.h>
41 #include <drm/drm_panel.h>
45 /* Display Parallel Interface */
46 #define DPIPXLFMT 0x0440
47 #define VS_POL_ACTIVE_LOW (1 << 10)
48 #define HS_POL_ACTIVE_LOW (1 << 9)
49 #define DE_POL_ACTIVE_HIGH (0 << 8)
50 #define SUB_CFG_TYPE_CONFIG1 (0 << 2) /* LSB aligned */
51 #define SUB_CFG_TYPE_CONFIG2 (1 << 2) /* Loosely Packed */
52 #define SUB_CFG_TYPE_CONFIG3 (2 << 2) /* LSB aligned 8-bit */
53 #define DPI_BPP_RGB888 (0 << 0)
54 #define DPI_BPP_RGB666 (1 << 0)
55 #define DPI_BPP_RGB565 (2 << 0)
58 #define VPCTRL0 0x0450
59 #define OPXLFMT_RGB666 (0 << 8)
60 #define OPXLFMT_RGB888 (1 << 8)
61 #define FRMSYNC_DISABLED (0 << 4) /* Video Timing Gen Disabled */
62 #define FRMSYNC_ENABLED (1 << 4) /* Video Timing Gen Enabled */
63 #define MSF_DISABLED (0 << 0) /* Magic Square FRC disabled */
64 #define MSF_ENABLED (1 << 0) /* Magic Square FRC enabled */
70 #define VFUEN BIT(0) /* Video Frame Timing Upload */
73 #define TC_IDREG 0x0500
74 #define SYSCTRL 0x0510
75 #define DP0_AUDSRC_NO_INPUT (0 << 3)
76 #define DP0_AUDSRC_I2S_RX (1 << 3)
77 #define DP0_VIDSRC_NO_INPUT (0 << 0)
78 #define DP0_VIDSRC_DSI_RX (1 << 0)
79 #define DP0_VIDSRC_DPI_RX (2 << 0)
80 #define DP0_VIDSRC_COLOR_BAR (3 << 0)
84 #define VID_MN_GEN BIT(6) /* Auto-generate M/N values */
85 #define EF_EN BIT(5) /* Enable Enhanced Framing */
86 #define VID_EN BIT(1) /* Video transmission enable */
87 #define DP_EN BIT(0) /* Enable DPTX function */
90 #define DP0_VIDMNGEN0 0x0610
91 #define DP0_VIDMNGEN1 0x0614
92 #define DP0_VMNGENSTATUS 0x0618
95 #define DP0_SECSAMPLE 0x0640
96 #define DP0_VIDSYNCDELAY 0x0644
97 #define DP0_TOTALVAL 0x0648
98 #define DP0_STARTVAL 0x064c
99 #define DP0_ACTIVEVAL 0x0650
100 #define DP0_SYNCVAL 0x0654
101 #define DP0_MISC 0x0658
102 #define TU_SIZE_RECOMMENDED (63) /* LSCLK cycles per TU */
103 #define BPC_6 (0 << 5)
104 #define BPC_8 (1 << 5)
107 #define DP0_AUXCFG0 0x0660
108 #define DP0_AUXCFG1 0x0664
109 #define AUX_RX_FILTER_EN BIT(16)
111 #define DP0_AUXADDR 0x0668
112 #define DP0_AUXWDATA(i) (0x066c + (i) * 4)
113 #define DP0_AUXRDATA(i) (0x067c + (i) * 4)
114 #define DP0_AUXSTATUS 0x068c
115 #define AUX_STATUS_MASK 0xf0
116 #define AUX_STATUS_SHIFT 4
117 #define AUX_TIMEOUT BIT(1)
118 #define AUX_BUSY BIT(0)
119 #define DP0_AUXI2CADR 0x0698
122 #define DP0_SRCCTRL 0x06a0
123 #define DP0_SRCCTRL_SCRMBLDIS BIT(13)
124 #define DP0_SRCCTRL_EN810B BIT(12)
125 #define DP0_SRCCTRL_NOTP (0 << 8)
126 #define DP0_SRCCTRL_TP1 (1 << 8)
127 #define DP0_SRCCTRL_TP2 (2 << 8)
128 #define DP0_SRCCTRL_LANESKEW BIT(7)
129 #define DP0_SRCCTRL_SSCG BIT(3)
130 #define DP0_SRCCTRL_LANES_1 (0 << 2)
131 #define DP0_SRCCTRL_LANES_2 (1 << 2)
132 #define DP0_SRCCTRL_BW27 (1 << 1)
133 #define DP0_SRCCTRL_BW162 (0 << 1)
134 #define DP0_SRCCTRL_AUTOCORRECT BIT(0)
135 #define DP0_LTSTAT 0x06d0
136 #define LT_LOOPDONE BIT(13)
137 #define LT_STATUS_MASK (0x1f << 8)
138 #define LT_CHANNEL1_EQ_BITS (DP_CHANNEL_EQ_BITS << 4)
139 #define LT_INTERLANE_ALIGN_DONE BIT(3)
140 #define LT_CHANNEL0_EQ_BITS (DP_CHANNEL_EQ_BITS)
141 #define DP0_SNKLTCHGREQ 0x06d4
142 #define DP0_LTLOOPCTRL 0x06d8
143 #define DP0_SNKLTCTRL 0x06e4
146 #define DP_PHY_CTRL 0x0800
147 #define DP_PHY_RST BIT(28) /* DP PHY Global Soft Reset */
148 #define BGREN BIT(25) /* AUX PHY BGR Enable */
149 #define PWR_SW_EN BIT(24) /* PHY Power Switch Enable */
150 #define PHY_M1_RST BIT(12) /* Reset PHY1 Main Channel */
151 #define PHY_RDY BIT(16) /* PHY Main Channels Ready */
152 #define PHY_M0_RST BIT(8) /* Reset PHY0 Main Channel */
153 #define PHY_A0_EN BIT(1) /* PHY Aux Channel0 Enable */
154 #define PHY_M0_EN BIT(0) /* PHY Main Channel0 Enable */
157 #define DP0_PLLCTRL 0x0900
158 #define DP1_PLLCTRL 0x0904 /* not defined in DS */
159 #define PXL_PLLCTRL 0x0908
160 #define PLLUPDATE BIT(2)
161 #define PLLBYP BIT(1)
163 #define PXL_PLLPARAM 0x0914
164 #define IN_SEL_REFCLK (0 << 14)
165 #define SYS_PLLPARAM 0x0918
166 #define REF_FREQ_38M4 (0 << 8) /* 38.4 MHz */
167 #define REF_FREQ_19M2 (1 << 8) /* 19.2 MHz */
168 #define REF_FREQ_26M (2 << 8) /* 26 MHz */
169 #define REF_FREQ_13M (3 << 8) /* 13 MHz */
170 #define SYSCLK_SEL_LSCLK (0 << 4)
171 #define LSCLK_DIV_1 (0 << 0)
172 #define LSCLK_DIV_2 (1 << 0)
175 #define TSTCTL 0x0a00
176 #define PLL_DBG 0x0a04
178 static bool tc_test_pattern;
179 module_param_named(test, tc_test_pattern, bool, 0644);
182 struct drm_dp_link base;
193 struct regmap *regmap;
194 struct drm_dp_aux aux;
196 struct drm_bridge bridge;
197 struct drm_connector connector;
198 struct drm_panel *panel;
201 struct tc_edp_link link;
206 struct drm_display_mode *mode;
211 struct gpio_desc *sd_gpio;
212 struct gpio_desc *reset_gpio;
216 static inline struct tc_data *aux_to_tc(struct drm_dp_aux *a)
218 return container_of(a, struct tc_data, aux);
221 static inline struct tc_data *bridge_to_tc(struct drm_bridge *b)
223 return container_of(b, struct tc_data, bridge);
226 static inline struct tc_data *connector_to_tc(struct drm_connector *c)
228 return container_of(c, struct tc_data, connector);
231 /* Simple macros to avoid repeated error checks */
232 #define tc_write(reg, var) \
234 ret = regmap_write(tc->regmap, reg, var); \
238 #define tc_read(reg, var) \
240 ret = regmap_read(tc->regmap, reg, var); \
245 static inline int tc_poll_timeout(struct regmap *map, unsigned int addr,
246 unsigned int cond_mask,
247 unsigned int cond_value,
248 unsigned long sleep_us, u64 timeout_us)
250 ktime_t timeout = ktime_add_us(ktime_get(), timeout_us);
255 ret = regmap_read(map, addr, &val);
258 if ((val & cond_mask) == cond_value)
260 if (timeout_us && ktime_compare(ktime_get(), timeout) > 0) {
261 ret = regmap_read(map, addr, &val);
265 usleep_range((sleep_us >> 2) + 1, sleep_us);
267 return ret ?: (((val & cond_mask) == cond_value) ? 0 : -ETIMEDOUT);
270 static int tc_aux_wait_busy(struct tc_data *tc, unsigned int timeout_ms)
272 return tc_poll_timeout(tc->regmap, DP0_AUXSTATUS, AUX_BUSY, 0,
273 1000, 1000 * timeout_ms);
276 static int tc_aux_get_status(struct tc_data *tc, u8 *reply)
281 ret = regmap_read(tc->regmap, DP0_AUXSTATUS, &value);
284 if (value & AUX_BUSY) {
285 if (value & AUX_TIMEOUT) {
286 dev_err(tc->dev, "i2c access timeout!\n");
292 *reply = (value & AUX_STATUS_MASK) >> AUX_STATUS_SHIFT;
296 static ssize_t tc_aux_transfer(struct drm_dp_aux *aux,
297 struct drm_dp_aux_msg *msg)
299 struct tc_data *tc = aux_to_tc(aux);
300 size_t size = min_t(size_t, 8, msg->size);
301 u8 request = msg->request & ~DP_AUX_I2C_MOT;
302 u8 *buf = msg->buffer;
310 ret = tc_aux_wait_busy(tc, 100);
314 if (request == DP_AUX_I2C_WRITE || request == DP_AUX_NATIVE_WRITE) {
317 if (request == DP_AUX_NATIVE_WRITE)
318 tmp = tmp | (buf[i] << (8 * (i & 0x3)));
320 tmp = (tmp << 8) | buf[i];
322 if (((i % 4) == 0) || (i == size)) {
323 tc_write(DP0_AUXWDATA((i - 1) >> 2), tmp);
327 } else if (request != DP_AUX_I2C_READ &&
328 request != DP_AUX_NATIVE_READ) {
333 tc_write(DP0_AUXADDR, msg->address);
335 tc_write(DP0_AUXCFG0, ((size - 1) << 8) | request);
337 ret = tc_aux_wait_busy(tc, 100);
341 ret = tc_aux_get_status(tc, &msg->reply);
345 if (request == DP_AUX_I2C_READ || request == DP_AUX_NATIVE_READ) {
349 tc_read(DP0_AUXRDATA(i >> 2), &tmp);
361 static const char * const training_pattern1_errors[] = {
365 "Max voltage reached error",
366 "Loop counter expired error",
370 static const char * const training_pattern2_errors[] = {
374 "Clock recovery failed error",
375 "Loop counter expired error",
379 static u32 tc_srcctrl(struct tc_data *tc)
382 * No training pattern, skew lane 1 data by two LSCLK cycles with
383 * respect to lane 0 data, AutoCorrect Mode = 0
385 u32 reg = DP0_SRCCTRL_NOTP | DP0_SRCCTRL_LANESKEW;
387 if (tc->link.scrambler_dis)
388 reg |= DP0_SRCCTRL_SCRMBLDIS; /* Scrambler Disabled */
389 if (tc->link.coding8b10b)
390 /* Enable 8/10B Encoder (TxData[19:16] not used) */
391 reg |= DP0_SRCCTRL_EN810B;
393 reg |= DP0_SRCCTRL_SSCG; /* Spread Spectrum Enable */
394 if (tc->link.base.num_lanes == 2)
395 reg |= DP0_SRCCTRL_LANES_2; /* Two Main Channel Lanes */
396 if (tc->link.base.rate != 162000)
397 reg |= DP0_SRCCTRL_BW27; /* 2.7 Gbps link */
401 static void tc_wait_pll_lock(struct tc_data *tc)
403 /* Wait for PLL to lock: up to 2.09 ms, depending on refclk */
404 usleep_range(3000, 6000);
407 static int tc_pxl_pll_en(struct tc_data *tc, u32 refclk, u32 pixelclock)
410 int i_pre, best_pre = 1;
411 int i_post, best_post = 1;
412 int div, best_div = 1;
413 int mul, best_mul = 1;
414 int delta, best_delta;
415 int ext_div[] = {1, 2, 3, 5, 7};
416 int best_pixelclock = 0;
419 dev_dbg(tc->dev, "PLL: requested %d pixelclock, ref %d\n", pixelclock,
421 best_delta = pixelclock;
422 /* Loop over all possible ext_divs, skipping invalid configurations */
423 for (i_pre = 0; i_pre < ARRAY_SIZE(ext_div); i_pre++) {
425 * refclk / ext_pre_div should be in the 1 to 200 MHz range.
426 * We don't allow any refclk > 200 MHz, only check lower bounds.
428 if (refclk / ext_div[i_pre] < 1000000)
430 for (i_post = 0; i_post < ARRAY_SIZE(ext_div); i_post++) {
431 for (div = 1; div <= 16; div++) {
435 tmp = pixelclock * ext_div[i_pre] *
436 ext_div[i_post] * div;
441 if ((mul < 1) || (mul > 128))
444 clk = (refclk / ext_div[i_pre] / div) * mul;
446 * refclk * mul / (ext_pre_div * pre_div)
447 * should be in the 150 to 650 MHz range
449 if ((clk > 650000000) || (clk < 150000000))
452 clk = clk / ext_div[i_post];
453 delta = clk - pixelclock;
455 if (abs(delta) < abs(best_delta)) {
461 best_pixelclock = clk;
466 if (best_pixelclock == 0) {
467 dev_err(tc->dev, "Failed to calc clock for %d pixelclock\n",
472 dev_dbg(tc->dev, "PLL: got %d, delta %d\n", best_pixelclock,
474 dev_dbg(tc->dev, "PLL: %d / %d / %d * %d / %d\n", refclk,
475 ext_div[best_pre], best_div, best_mul, ext_div[best_post]);
477 /* if VCO >= 300 MHz */
478 if (refclk / ext_div[best_pre] / best_div * best_mul >= 300000000)
486 /* Power up PLL and switch to bypass */
487 tc_write(PXL_PLLCTRL, PLLBYP | PLLEN);
489 tc_write(PXL_PLLPARAM,
490 (vco_hi << 24) | /* For PLL VCO >= 300 MHz = 1 */
491 (ext_div[best_pre] << 20) | /* External Pre-divider */
492 (ext_div[best_post] << 16) | /* External Post-divider */
493 IN_SEL_REFCLK | /* Use RefClk as PLL input */
494 (best_div << 8) | /* Divider for PLL RefClk */
495 (best_mul << 0)); /* Multiplier for PLL */
497 /* Force PLL parameter update and disable bypass */
498 tc_write(PXL_PLLCTRL, PLLUPDATE | PLLEN);
500 tc_wait_pll_lock(tc);
507 static int tc_pxl_pll_dis(struct tc_data *tc)
509 /* Enable PLL bypass, power down PLL */
510 return regmap_write(tc->regmap, PXL_PLLCTRL, PLLBYP);
513 static int tc_stream_clock_calc(struct tc_data *tc)
517 * If the Stream clock and Link Symbol clock are
518 * asynchronous with each other, the value of M changes over
519 * time. This way of generating link clock and stream
520 * clock is called Asynchronous Clock mode. The value M
521 * must change while the value N stays constant. The
522 * value of N in this Asynchronous Clock mode must be set
525 * LSCLK = 1/10 of high speed link clock
527 * f_STRMCLK = M/N * f_LSCLK
528 * M/N = f_STRMCLK / f_LSCLK
531 tc_write(DP0_VIDMNGEN1, 32768);
538 static int tc_aux_link_setup(struct tc_data *tc)
544 rate = clk_get_rate(tc->refclk);
547 value = REF_FREQ_38M4;
550 value = REF_FREQ_26M;
553 value = REF_FREQ_19M2;
556 value = REF_FREQ_13M;
559 dev_err(tc->dev, "Invalid refclk rate: %lu Hz\n", rate);
563 /* Setup DP-PHY / PLL */
564 value |= SYSCLK_SEL_LSCLK | LSCLK_DIV_2;
565 tc_write(SYS_PLLPARAM, value);
567 tc_write(DP_PHY_CTRL, BGREN | PWR_SW_EN | BIT(2) | PHY_A0_EN);
570 * Initially PLLs are in bypass. Force PLL parameter update,
571 * disable PLL bypass, enable PLL
573 tc_write(DP0_PLLCTRL, PLLUPDATE | PLLEN);
574 tc_wait_pll_lock(tc);
576 tc_write(DP1_PLLCTRL, PLLUPDATE | PLLEN);
577 tc_wait_pll_lock(tc);
579 ret = tc_poll_timeout(tc->regmap, DP_PHY_CTRL, PHY_RDY, PHY_RDY, 1,
581 if (ret == -ETIMEDOUT) {
582 dev_err(tc->dev, "Timeout waiting for PHY to become ready");
588 tc_write(DP0_AUXCFG1, AUX_RX_FILTER_EN |
589 (0x06 << 8) | /* Aux Bit Period Calculator Threshold */
590 (0x3f << 0)); /* Aux Response Timeout Timer */
594 dev_err(tc->dev, "tc_aux_link_setup failed: %d\n", ret);
598 static int tc_get_display_props(struct tc_data *tc)
604 /* Read DP Rx Link Capability */
605 ret = drm_dp_link_probe(&tc->aux, &tc->link.base);
608 if (tc->link.base.rate != 162000 && tc->link.base.rate != 270000) {
609 dev_dbg(tc->dev, "Falling to 2.7 Gbps rate\n");
610 tc->link.base.rate = 270000;
613 if (tc->link.base.num_lanes > 2) {
614 dev_dbg(tc->dev, "Falling to 2 lanes\n");
615 tc->link.base.num_lanes = 2;
618 ret = drm_dp_dpcd_readb(&tc->aux, DP_MAX_DOWNSPREAD, tmp);
621 tc->link.spread = tmp[0] & BIT(0); /* 0.5% down spread */
623 ret = drm_dp_dpcd_readb(&tc->aux, DP_MAIN_LINK_CHANNEL_CODING, tmp);
626 tc->link.coding8b10b = tmp[0] & BIT(0);
627 tc->link.scrambler_dis = 0;
629 ret = drm_dp_dpcd_readb(&tc->aux, DP_EDP_CONFIGURATION_SET, tmp);
632 tc->link.assr = tmp[0] & DP_ALTERNATE_SCRAMBLER_RESET_ENABLE;
634 dev_dbg(tc->dev, "DPCD rev: %d.%d, rate: %s, lanes: %d, framing: %s\n",
635 tc->link.base.revision >> 4, tc->link.base.revision & 0x0f,
636 (tc->link.base.rate == 162000) ? "1.62Gbps" : "2.7Gbps",
637 tc->link.base.num_lanes,
638 (tc->link.base.capabilities & DP_LINK_CAP_ENHANCED_FRAMING) ?
639 "enhanced" : "non-enhanced");
640 dev_dbg(tc->dev, "ANSI 8B/10B: %d\n", tc->link.coding8b10b);
641 dev_dbg(tc->dev, "Display ASSR: %d, TC358767 ASSR: %d\n",
642 tc->link.assr, tc->assr);
647 dev_err(tc->dev, "failed to read DPCD: %d\n", ret);
651 static int tc_set_video_mode(struct tc_data *tc, struct drm_display_mode *mode)
657 int left_margin = mode->htotal - mode->hsync_end;
658 int right_margin = mode->hsync_start - mode->hdisplay;
659 int hsync_len = mode->hsync_end - mode->hsync_start;
660 int upper_margin = mode->vtotal - mode->vsync_end;
661 int lower_margin = mode->vsync_start - mode->vdisplay;
662 int vsync_len = mode->vsync_end - mode->vsync_start;
665 * Recommended maximum number of symbols transferred in a transfer unit:
666 * DIV_ROUND_UP((input active video bandwidth in bytes) * tu_size,
667 * (output active video bandwidth in bytes))
668 * Must be less than tu_size.
670 max_tu_symbol = TU_SIZE_RECOMMENDED - 1;
672 dev_dbg(tc->dev, "set mode %dx%d\n",
673 mode->hdisplay, mode->vdisplay);
674 dev_dbg(tc->dev, "H margin %d,%d sync %d\n",
675 left_margin, right_margin, hsync_len);
676 dev_dbg(tc->dev, "V margin %d,%d sync %d\n",
677 upper_margin, lower_margin, vsync_len);
678 dev_dbg(tc->dev, "total: %dx%d\n", mode->htotal, mode->vtotal);
683 * datasheet is not clear of vsdelay in case of DPI
684 * assume we do not need any delay when DPI is a source of
687 tc_write(VPCTRL0, (0 << 20) /* VSDELAY */ |
688 OPXLFMT_RGB888 | FRMSYNC_DISABLED | MSF_DISABLED);
689 tc_write(HTIM01, (ALIGN(left_margin, 2) << 16) | /* H back porch */
690 (ALIGN(hsync_len, 2) << 0)); /* Hsync */
691 tc_write(HTIM02, (ALIGN(right_margin, 2) << 16) | /* H front porch */
692 (ALIGN(mode->hdisplay, 2) << 0)); /* width */
693 tc_write(VTIM01, (upper_margin << 16) | /* V back porch */
694 (vsync_len << 0)); /* Vsync */
695 tc_write(VTIM02, (lower_margin << 16) | /* V front porch */
696 (mode->vdisplay << 0)); /* height */
697 tc_write(VFUEN0, VFUEN); /* update settings */
699 /* Test pattern settings */
701 (120 << 24) | /* Red Color component value */
702 (20 << 16) | /* Green Color component value */
703 (99 << 8) | /* Blue Color component value */
704 (1 << 4) | /* Enable I2C Filter */
705 (2 << 0) | /* Color bar Mode */
708 /* DP Main Stream Attributes */
709 vid_sync_dly = hsync_len + left_margin + mode->hdisplay;
710 tc_write(DP0_VIDSYNCDELAY,
711 (max_tu_symbol << 16) | /* thresh_dly */
712 (vid_sync_dly << 0));
714 tc_write(DP0_TOTALVAL, (mode->vtotal << 16) | (mode->htotal));
716 tc_write(DP0_STARTVAL,
717 ((upper_margin + vsync_len) << 16) |
718 ((left_margin + hsync_len) << 0));
720 tc_write(DP0_ACTIVEVAL, (mode->vdisplay << 16) | (mode->hdisplay));
722 tc_write(DP0_SYNCVAL, (vsync_len << 16) | (hsync_len << 0));
724 tc_write(DPIPXLFMT, VS_POL_ACTIVE_LOW | HS_POL_ACTIVE_LOW |
725 DE_POL_ACTIVE_HIGH | SUB_CFG_TYPE_CONFIG1 | DPI_BPP_RGB888);
727 tc_write(DP0_MISC, (max_tu_symbol << 23) | (TU_SIZE_RECOMMENDED << 16) |
735 static int tc_link_training(struct tc_data *tc, int pattern)
737 const char * const *errors;
738 u32 srcctrl = tc_srcctrl(tc) | DP0_SRCCTRL_SCRMBLDIS |
739 DP0_SRCCTRL_AUTOCORRECT;
745 if (pattern == DP_TRAINING_PATTERN_1) {
746 srcctrl |= DP0_SRCCTRL_TP1;
747 errors = training_pattern1_errors;
749 srcctrl |= DP0_SRCCTRL_TP2;
750 errors = training_pattern2_errors;
753 /* Set DPCD 0x102 for Training Part 1 or 2 */
754 tc_write(DP0_SNKLTCTRL, DP_LINK_SCRAMBLING_DISABLE | pattern);
756 tc_write(DP0_LTLOOPCTRL,
757 (0x0f << 28) | /* Defer Iteration Count */
758 (0x0f << 24) | /* Loop Iteration Count */
759 (0x0d << 0)); /* Loop Timer Delay */
763 /* Set DP0 Training Pattern */
764 tc_write(DP0_SRCCTRL, srcctrl);
766 /* Enable DP0 to start Link Training */
767 tc_write(DP0CTL, DP_EN);
772 tc_read(DP0_LTSTAT, &value);
774 } while ((!(value & LT_LOOPDONE)) && (--timeout));
776 dev_err(tc->dev, "Link training timeout!\n");
778 int pattern = (value >> 11) & 0x3;
779 int error = (value >> 8) & 0x7;
782 "Link training phase %d done after %d uS: %s\n",
783 pattern, 1000 - timeout, errors[error]);
784 if (pattern == DP_TRAINING_PATTERN_1 && error == 0)
786 if (pattern == DP_TRAINING_PATTERN_2) {
787 value &= LT_CHANNEL1_EQ_BITS |
788 LT_INTERLANE_ALIGN_DONE |
790 /* in case of two lanes */
791 if ((tc->link.base.num_lanes == 2) &&
792 (value == (LT_CHANNEL1_EQ_BITS |
793 LT_INTERLANE_ALIGN_DONE |
794 LT_CHANNEL0_EQ_BITS)))
796 /* in case of one line */
797 if ((tc->link.base.num_lanes == 1) &&
798 (value == (LT_INTERLANE_ALIGN_DONE |
799 LT_CHANNEL0_EQ_BITS)))
805 usleep_range(10, 20);
808 dev_err(tc->dev, "Failed to finish training phase %d\n",
817 static int tc_main_link_setup(struct tc_data *tc)
819 struct drm_dp_aux *aux = &tc->aux;
820 struct device *dev = tc->dev;
828 /* display mode should be set at this point */
832 /* from excel file - DP0_SrcCtrl */
833 tc_write(DP0_SRCCTRL, DP0_SRCCTRL_SCRMBLDIS | DP0_SRCCTRL_EN810B |
834 DP0_SRCCTRL_LANESKEW | DP0_SRCCTRL_LANES_2 |
835 DP0_SRCCTRL_BW27 | DP0_SRCCTRL_AUTOCORRECT);
836 /* from excel file - DP1_SrcCtrl */
837 tc_write(0x07a0, 0x00003083);
839 rate = clk_get_rate(tc->refclk);
842 value = REF_FREQ_38M4;
845 value = REF_FREQ_26M;
848 value = REF_FREQ_19M2;
851 value = REF_FREQ_13M;
856 value |= SYSCLK_SEL_LSCLK | LSCLK_DIV_2;
857 tc_write(SYS_PLLPARAM, value);
858 /* Setup Main Link */
859 dp_phy_ctrl = BGREN | PWR_SW_EN | BIT(2) | PHY_A0_EN | PHY_M0_EN;
860 tc_write(DP_PHY_CTRL, dp_phy_ctrl);
864 tc_write(DP0_PLLCTRL, PLLUPDATE | PLLEN);
865 tc_wait_pll_lock(tc);
867 tc_write(DP1_PLLCTRL, PLLUPDATE | PLLEN);
868 tc_wait_pll_lock(tc);
871 if (tc_test_pattern) {
872 ret = tc_pxl_pll_en(tc, clk_get_rate(tc->refclk),
873 1000 * tc->mode->clock);
878 /* Reset/Enable Main Links */
879 dp_phy_ctrl |= DP_PHY_RST | PHY_M1_RST | PHY_M0_RST;
880 tc_write(DP_PHY_CTRL, dp_phy_ctrl);
881 usleep_range(100, 200);
882 dp_phy_ctrl &= ~(DP_PHY_RST | PHY_M1_RST | PHY_M0_RST);
883 tc_write(DP_PHY_CTRL, dp_phy_ctrl);
887 tc_read(DP_PHY_CTRL, &value);
889 } while ((!(value & PHY_RDY)) && (--timeout));
892 dev_err(dev, "timeout waiting for phy become ready");
896 /* Set misc: 8 bits per color */
897 ret = regmap_update_bits(tc->regmap, DP0_MISC, BPC_8, BPC_8);
903 * on TC358767 side ASSR configured through strap pin
904 * seems there is no way to change this setting from SW
906 * check is tc configured for same mode
908 if (tc->assr != tc->link.assr) {
909 dev_dbg(dev, "Trying to set display to ASSR: %d\n",
911 /* try to set ASSR on display side */
913 ret = drm_dp_dpcd_writeb(aux, DP_EDP_CONFIGURATION_SET, tmp[0]);
917 ret = drm_dp_dpcd_readb(aux, DP_EDP_CONFIGURATION_SET, tmp);
921 if (tmp[0] != tc->assr) {
922 dev_dbg(dev, "Failed to switch display ASSR to %d, falling back to unscrambled mode\n",
924 /* trying with disabled scrambler */
925 tc->link.scrambler_dis = 1;
929 /* Setup Link & DPRx Config for Training */
930 ret = drm_dp_link_configure(aux, &tc->link.base);
934 /* DOWNSPREAD_CTRL */
935 tmp[0] = tc->link.spread ? DP_SPREAD_AMP_0_5 : 0x00;
936 /* MAIN_LINK_CHANNEL_CODING_SET */
937 tmp[1] = tc->link.coding8b10b ? DP_SET_ANSI_8B10B : 0x00;
938 ret = drm_dp_dpcd_write(aux, DP_DOWNSPREAD_CTRL, tmp, 2);
942 ret = tc_link_training(tc, DP_TRAINING_PATTERN_1);
946 ret = tc_link_training(tc, DP_TRAINING_PATTERN_2);
950 /* Clear DPCD 0x102 */
951 /* Note: Can Not use DP0_SNKLTCTRL (0x06E4) short cut */
952 tmp[0] = tc->link.scrambler_dis ? DP_LINK_SCRAMBLING_DISABLE : 0x00;
953 ret = drm_dp_dpcd_writeb(aux, DP_TRAINING_PATTERN_SET, tmp[0]);
957 /* Clear Training Pattern, set AutoCorrect Mode = 1 */
958 tc_write(DP0_SRCCTRL, tc_srcctrl(tc) | DP0_SRCCTRL_AUTOCORRECT);
964 /* Read DPCD 0x202-0x207 */
965 ret = drm_dp_dpcd_read_link_status(aux, tmp + 2);
968 } while ((--timeout) &&
969 !(drm_dp_channel_eq_ok(tmp + 2, tc->link.base.num_lanes)));
972 /* Read DPCD 0x200-0x201 */
973 ret = drm_dp_dpcd_read(aux, DP_SINK_COUNT, tmp, 2);
976 dev_err(dev, "channel(s) EQ not ok\n");
977 dev_info(dev, "0x0200 SINK_COUNT: 0x%02x\n", tmp[0]);
978 dev_info(dev, "0x0201 DEVICE_SERVICE_IRQ_VECTOR: 0x%02x\n",
980 dev_info(dev, "0x0202 LANE0_1_STATUS: 0x%02x\n", tmp[2]);
981 dev_info(dev, "0x0204 LANE_ALIGN_STATUS_UPDATED: 0x%02x\n",
983 dev_info(dev, "0x0205 SINK_STATUS: 0x%02x\n", tmp[5]);
984 dev_info(dev, "0x0206 ADJUST_REQUEST_LANE0_1: 0x%02x\n",
990 ret = tc_set_video_mode(tc, tc->mode);
995 ret = tc_stream_clock_calc(tc);
1001 dev_err(tc->dev, "Failed to read DPCD: %d\n", ret);
1004 dev_err(tc->dev, "Failed to write DPCD: %d\n", ret);
1009 static int tc_main_link_stream(struct tc_data *tc, int state)
1014 dev_dbg(tc->dev, "stream: %d\n", state);
1017 value = VID_MN_GEN | DP_EN;
1018 if (tc->link.base.capabilities & DP_LINK_CAP_ENHANCED_FRAMING)
1020 tc_write(DP0CTL, value);
1022 * VID_EN assertion should be delayed by at least N * LSCLK
1023 * cycles from the time VID_MN_GEN is enabled in order to
1024 * generate stable values for VID_M. LSCLK is 270 MHz or
1025 * 162 MHz, VID_N is set to 32768 in tc_stream_clock_calc(),
1026 * so a delay of at least 203 us should suffice.
1028 usleep_range(500, 1000);
1030 tc_write(DP0CTL, value);
1031 /* Set input interface */
1032 value = DP0_AUDSRC_NO_INPUT;
1033 if (tc_test_pattern)
1034 value |= DP0_VIDSRC_COLOR_BAR;
1036 value |= DP0_VIDSRC_DPI_RX;
1037 tc_write(SYSCTRL, value);
1039 tc_write(DP0CTL, 0);
1047 static void tc_bridge_pre_enable(struct drm_bridge *bridge)
1049 struct tc_data *tc = bridge_to_tc(bridge);
1051 drm_panel_prepare(tc->panel);
1054 static void tc_bridge_enable(struct drm_bridge *bridge)
1056 struct tc_data *tc = bridge_to_tc(bridge);
1059 ret = tc_main_link_setup(tc);
1061 dev_err(tc->dev, "main link setup error: %d\n", ret);
1065 ret = tc_main_link_stream(tc, 1);
1067 dev_err(tc->dev, "main link stream start error: %d\n", ret);
1071 drm_panel_enable(tc->panel);
1074 static void tc_bridge_disable(struct drm_bridge *bridge)
1076 struct tc_data *tc = bridge_to_tc(bridge);
1079 drm_panel_disable(tc->panel);
1081 ret = tc_main_link_stream(tc, 0);
1083 dev_err(tc->dev, "main link stream stop error: %d\n", ret);
1086 static void tc_bridge_post_disable(struct drm_bridge *bridge)
1088 struct tc_data *tc = bridge_to_tc(bridge);
1090 drm_panel_unprepare(tc->panel);
1093 static bool tc_bridge_mode_fixup(struct drm_bridge *bridge,
1094 const struct drm_display_mode *mode,
1095 struct drm_display_mode *adj)
1097 /* Fixup sync polarities, both hsync and vsync are active low */
1098 adj->flags = mode->flags;
1099 adj->flags |= (DRM_MODE_FLAG_NHSYNC | DRM_MODE_FLAG_NVSYNC);
1100 adj->flags &= ~(DRM_MODE_FLAG_PHSYNC | DRM_MODE_FLAG_PVSYNC);
1105 static enum drm_mode_status tc_connector_mode_valid(struct drm_connector *connector,
1106 struct drm_display_mode *mode)
1108 /* DPI interface clock limitation: upto 154 MHz */
1109 if (mode->clock > 154000)
1110 return MODE_CLOCK_HIGH;
1115 static void tc_bridge_mode_set(struct drm_bridge *bridge,
1116 struct drm_display_mode *mode,
1117 struct drm_display_mode *adj)
1119 struct tc_data *tc = bridge_to_tc(bridge);
1124 static int tc_connector_get_modes(struct drm_connector *connector)
1126 struct tc_data *tc = connector_to_tc(connector);
1130 if (tc->panel && tc->panel->funcs && tc->panel->funcs->get_modes) {
1131 count = tc->panel->funcs->get_modes(tc->panel);
1136 edid = drm_get_edid(connector, &tc->aux.ddc);
1143 drm_connector_update_edid_property(connector, edid);
1144 count = drm_add_edid_modes(connector, edid);
1149 static void tc_connector_set_polling(struct tc_data *tc,
1150 struct drm_connector *connector)
1152 /* TODO: add support for HPD */
1153 connector->polled = DRM_CONNECTOR_POLL_CONNECT |
1154 DRM_CONNECTOR_POLL_DISCONNECT;
1157 static struct drm_encoder *
1158 tc_connector_best_encoder(struct drm_connector *connector)
1160 struct tc_data *tc = connector_to_tc(connector);
1162 return tc->bridge.encoder;
1165 static const struct drm_connector_helper_funcs tc_connector_helper_funcs = {
1166 .get_modes = tc_connector_get_modes,
1167 .mode_valid = tc_connector_mode_valid,
1168 .best_encoder = tc_connector_best_encoder,
1171 static const struct drm_connector_funcs tc_connector_funcs = {
1172 .fill_modes = drm_helper_probe_single_connector_modes,
1173 .destroy = drm_connector_cleanup,
1174 .reset = drm_atomic_helper_connector_reset,
1175 .atomic_duplicate_state = drm_atomic_helper_connector_duplicate_state,
1176 .atomic_destroy_state = drm_atomic_helper_connector_destroy_state,
1179 static int tc_bridge_attach(struct drm_bridge *bridge)
1181 u32 bus_format = MEDIA_BUS_FMT_RGB888_1X24;
1182 struct tc_data *tc = bridge_to_tc(bridge);
1183 struct drm_device *drm = bridge->dev;
1186 /* Create eDP connector */
1187 drm_connector_helper_add(&tc->connector, &tc_connector_helper_funcs);
1188 ret = drm_connector_init(drm, &tc->connector, &tc_connector_funcs,
1189 DRM_MODE_CONNECTOR_eDP);
1194 drm_panel_attach(tc->panel, &tc->connector);
1196 drm_display_info_set_bus_formats(&tc->connector.display_info,
1198 drm_connector_attach_encoder(&tc->connector, tc->bridge.encoder);
1203 static const struct drm_bridge_funcs tc_bridge_funcs = {
1204 .attach = tc_bridge_attach,
1205 .mode_set = tc_bridge_mode_set,
1206 .pre_enable = tc_bridge_pre_enable,
1207 .enable = tc_bridge_enable,
1208 .disable = tc_bridge_disable,
1209 .post_disable = tc_bridge_post_disable,
1210 .mode_fixup = tc_bridge_mode_fixup,
1213 static bool tc_readable_reg(struct device *dev, unsigned int reg)
1215 return reg != SYSCTRL;
1218 static const struct regmap_range tc_volatile_ranges[] = {
1219 regmap_reg_range(DP0_AUXWDATA(0), DP0_AUXSTATUS),
1220 regmap_reg_range(DP0_LTSTAT, DP0_SNKLTCHGREQ),
1221 regmap_reg_range(DP_PHY_CTRL, DP_PHY_CTRL),
1222 regmap_reg_range(DP0_PLLCTRL, PXL_PLLCTRL),
1223 regmap_reg_range(VFUEN0, VFUEN0),
1226 static const struct regmap_access_table tc_volatile_table = {
1227 .yes_ranges = tc_volatile_ranges,
1228 .n_yes_ranges = ARRAY_SIZE(tc_volatile_ranges),
1231 static bool tc_writeable_reg(struct device *dev, unsigned int reg)
1233 return (reg != TC_IDREG) &&
1234 (reg != DP0_LTSTAT) &&
1235 (reg != DP0_SNKLTCHGREQ);
1238 static const struct regmap_config tc_regmap_config = {
1243 .max_register = PLL_DBG,
1244 .cache_type = REGCACHE_RBTREE,
1245 .readable_reg = tc_readable_reg,
1246 .volatile_table = &tc_volatile_table,
1247 .writeable_reg = tc_writeable_reg,
1248 .reg_format_endian = REGMAP_ENDIAN_BIG,
1249 .val_format_endian = REGMAP_ENDIAN_LITTLE,
1252 static int tc_probe(struct i2c_client *client, const struct i2c_device_id *id)
1254 struct device *dev = &client->dev;
1258 tc = devm_kzalloc(dev, sizeof(*tc), GFP_KERNEL);
1264 /* port@2 is the output port */
1265 ret = drm_of_find_panel_or_bridge(dev->of_node, 2, 0, &tc->panel, NULL);
1266 if (ret && ret != -ENODEV)
1269 /* Shut down GPIO is optional */
1270 tc->sd_gpio = devm_gpiod_get_optional(dev, "shutdown", GPIOD_OUT_HIGH);
1271 if (IS_ERR(tc->sd_gpio))
1272 return PTR_ERR(tc->sd_gpio);
1275 gpiod_set_value_cansleep(tc->sd_gpio, 0);
1276 usleep_range(5000, 10000);
1279 /* Reset GPIO is optional */
1280 tc->reset_gpio = devm_gpiod_get_optional(dev, "reset", GPIOD_OUT_LOW);
1281 if (IS_ERR(tc->reset_gpio))
1282 return PTR_ERR(tc->reset_gpio);
1284 if (tc->reset_gpio) {
1285 gpiod_set_value_cansleep(tc->reset_gpio, 1);
1286 usleep_range(5000, 10000);
1289 tc->refclk = devm_clk_get(dev, "ref");
1290 if (IS_ERR(tc->refclk)) {
1291 ret = PTR_ERR(tc->refclk);
1292 dev_err(dev, "Failed to get refclk: %d\n", ret);
1296 tc->regmap = devm_regmap_init_i2c(client, &tc_regmap_config);
1297 if (IS_ERR(tc->regmap)) {
1298 ret = PTR_ERR(tc->regmap);
1299 dev_err(dev, "Failed to initialize regmap: %d\n", ret);
1303 ret = regmap_read(tc->regmap, TC_IDREG, &tc->rev);
1305 dev_err(tc->dev, "can not read device ID: %d\n", ret);
1309 if ((tc->rev != 0x6601) && (tc->rev != 0x6603)) {
1310 dev_err(tc->dev, "invalid device ID: 0x%08x\n", tc->rev);
1314 tc->assr = (tc->rev == 0x6601); /* Enable ASSR for eDP panels */
1316 ret = tc_aux_link_setup(tc);
1320 /* Register DP AUX channel */
1321 tc->aux.name = "TC358767 AUX i2c adapter";
1322 tc->aux.dev = tc->dev;
1323 tc->aux.transfer = tc_aux_transfer;
1324 ret = drm_dp_aux_register(&tc->aux);
1328 ret = tc_get_display_props(tc);
1330 goto err_unregister_aux;
1332 tc_connector_set_polling(tc, &tc->connector);
1334 tc->bridge.funcs = &tc_bridge_funcs;
1335 tc->bridge.of_node = dev->of_node;
1336 drm_bridge_add(&tc->bridge);
1338 i2c_set_clientdata(client, tc);
1342 drm_dp_aux_unregister(&tc->aux);
1346 static int tc_remove(struct i2c_client *client)
1348 struct tc_data *tc = i2c_get_clientdata(client);
1350 drm_bridge_remove(&tc->bridge);
1351 drm_dp_aux_unregister(&tc->aux);
1358 static const struct i2c_device_id tc358767_i2c_ids[] = {
1362 MODULE_DEVICE_TABLE(i2c, tc358767_i2c_ids);
1364 static const struct of_device_id tc358767_of_ids[] = {
1365 { .compatible = "toshiba,tc358767", },
1368 MODULE_DEVICE_TABLE(of, tc358767_of_ids);
1370 static struct i2c_driver tc358767_driver = {
1373 .of_match_table = tc358767_of_ids,
1375 .id_table = tc358767_i2c_ids,
1377 .remove = tc_remove,
1379 module_i2c_driver(tc358767_driver);
1382 MODULE_DESCRIPTION("tc358767 eDP encoder driver");
1383 MODULE_LICENSE("GPL");