1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (c) 2018, The Linux Foundation. All rights reserved.
4 * datasheet: https://www.ti.com/lit/ds/symlink/sn65dsi86.pdf
7 #include <linux/atomic.h>
8 #include <linux/auxiliary_bus.h>
9 #include <linux/bitfield.h>
10 #include <linux/bits.h>
11 #include <linux/clk.h>
12 #include <linux/debugfs.h>
13 #include <linux/gpio/consumer.h>
14 #include <linux/gpio/driver.h>
15 #include <linux/i2c.h>
16 #include <linux/iopoll.h>
17 #include <linux/module.h>
18 #include <linux/of_graph.h>
19 #include <linux/pm_runtime.h>
20 #include <linux/pwm.h>
21 #include <linux/regmap.h>
22 #include <linux/regulator/consumer.h>
24 #include <asm/unaligned.h>
26 #include <drm/drm_atomic.h>
27 #include <drm/drm_atomic_helper.h>
28 #include <drm/drm_bridge.h>
29 #include <drm/drm_dp_aux_bus.h>
30 #include <drm/drm_dp_helper.h>
31 #include <drm/drm_mipi_dsi.h>
32 #include <drm/drm_of.h>
33 #include <drm/drm_panel.h>
34 #include <drm/drm_print.h>
35 #include <drm/drm_probe_helper.h>
37 #define SN_DEVICE_REV_REG 0x08
38 #define SN_DPPLL_SRC_REG 0x0A
39 #define DPPLL_CLK_SRC_DSICLK BIT(0)
40 #define REFCLK_FREQ_MASK GENMASK(3, 1)
41 #define REFCLK_FREQ(x) ((x) << 1)
42 #define DPPLL_SRC_DP_PLL_LOCK BIT(7)
43 #define SN_PLL_ENABLE_REG 0x0D
44 #define SN_DSI_LANES_REG 0x10
45 #define CHA_DSI_LANES_MASK GENMASK(4, 3)
46 #define CHA_DSI_LANES(x) ((x) << 3)
47 #define SN_DSIA_CLK_FREQ_REG 0x12
48 #define SN_CHA_ACTIVE_LINE_LENGTH_LOW_REG 0x20
49 #define SN_CHA_VERTICAL_DISPLAY_SIZE_LOW_REG 0x24
50 #define SN_CHA_HSYNC_PULSE_WIDTH_LOW_REG 0x2C
51 #define SN_CHA_HSYNC_PULSE_WIDTH_HIGH_REG 0x2D
52 #define CHA_HSYNC_POLARITY BIT(7)
53 #define SN_CHA_VSYNC_PULSE_WIDTH_LOW_REG 0x30
54 #define SN_CHA_VSYNC_PULSE_WIDTH_HIGH_REG 0x31
55 #define CHA_VSYNC_POLARITY BIT(7)
56 #define SN_CHA_HORIZONTAL_BACK_PORCH_REG 0x34
57 #define SN_CHA_VERTICAL_BACK_PORCH_REG 0x36
58 #define SN_CHA_HORIZONTAL_FRONT_PORCH_REG 0x38
59 #define SN_CHA_VERTICAL_FRONT_PORCH_REG 0x3A
60 #define SN_LN_ASSIGN_REG 0x59
61 #define LN_ASSIGN_WIDTH 2
62 #define SN_ENH_FRAME_REG 0x5A
63 #define VSTREAM_ENABLE BIT(3)
64 #define LN_POLRS_OFFSET 4
65 #define LN_POLRS_MASK 0xf0
66 #define SN_DATA_FORMAT_REG 0x5B
67 #define BPP_18_RGB BIT(0)
68 #define SN_HPD_DISABLE_REG 0x5C
69 #define HPD_DISABLE BIT(0)
70 #define SN_GPIO_IO_REG 0x5E
71 #define SN_GPIO_INPUT_SHIFT 4
72 #define SN_GPIO_OUTPUT_SHIFT 0
73 #define SN_GPIO_CTRL_REG 0x5F
74 #define SN_GPIO_MUX_INPUT 0
75 #define SN_GPIO_MUX_OUTPUT 1
76 #define SN_GPIO_MUX_SPECIAL 2
77 #define SN_GPIO_MUX_MASK 0x3
78 #define SN_AUX_WDATA_REG(x) (0x64 + (x))
79 #define SN_AUX_ADDR_19_16_REG 0x74
80 #define SN_AUX_ADDR_15_8_REG 0x75
81 #define SN_AUX_ADDR_7_0_REG 0x76
82 #define SN_AUX_ADDR_MASK GENMASK(19, 0)
83 #define SN_AUX_LENGTH_REG 0x77
84 #define SN_AUX_CMD_REG 0x78
85 #define AUX_CMD_SEND BIT(0)
86 #define AUX_CMD_REQ(x) ((x) << 4)
87 #define SN_AUX_RDATA_REG(x) (0x79 + (x))
88 #define SN_SSC_CONFIG_REG 0x93
89 #define DP_NUM_LANES_MASK GENMASK(5, 4)
90 #define DP_NUM_LANES(x) ((x) << 4)
91 #define SN_DATARATE_CONFIG_REG 0x94
92 #define DP_DATARATE_MASK GENMASK(7, 5)
93 #define DP_DATARATE(x) ((x) << 5)
94 #define SN_ML_TX_MODE_REG 0x96
95 #define ML_TX_MAIN_LINK_OFF 0
96 #define ML_TX_NORMAL_MODE BIT(0)
97 #define SN_PWM_PRE_DIV_REG 0xA0
98 #define SN_BACKLIGHT_SCALE_REG 0xA1
99 #define BACKLIGHT_SCALE_MAX 0xFFFF
100 #define SN_BACKLIGHT_REG 0xA3
101 #define SN_PWM_EN_INV_REG 0xA5
102 #define SN_PWM_INV_MASK BIT(0)
103 #define SN_PWM_EN_MASK BIT(1)
104 #define SN_AUX_CMD_STATUS_REG 0xF4
105 #define AUX_IRQ_STATUS_AUX_RPLY_TOUT BIT(3)
106 #define AUX_IRQ_STATUS_AUX_SHORT BIT(5)
107 #define AUX_IRQ_STATUS_NAT_I2C_FAIL BIT(6)
109 #define MIN_DSI_CLK_FREQ_MHZ 40
111 /* fudge factor required to account for 8b/10b encoding */
112 #define DP_CLK_FUDGE_NUM 10
113 #define DP_CLK_FUDGE_DEN 8
115 /* Matches DP_AUX_MAX_PAYLOAD_BYTES (for now) */
116 #define SN_AUX_MAX_PAYLOAD_BYTES 16
118 #define SN_REGULATOR_SUPPLY_NUM 4
120 #define SN_MAX_DP_LANES 4
121 #define SN_NUM_GPIOS 4
122 #define SN_GPIO_PHYSICAL_OFFSET 1
124 #define SN_LINK_TRAINING_TRIES 10
126 #define SN_PWM_GPIO_IDX 3 /* 4th GPIO */
129 * struct ti_sn65dsi86 - Platform data for ti-sn65dsi86 driver.
130 * @bridge_aux: AUX-bus sub device for MIPI-to-eDP bridge functionality.
131 * @gpio_aux: AUX-bus sub device for GPIO controller functionality.
132 * @aux_aux: AUX-bus sub device for eDP AUX channel functionality.
133 * @pwm_aux: AUX-bus sub device for PWM controller functionality.
135 * @dev: Pointer to the top level (i2c) device.
136 * @regmap: Regmap for accessing i2c.
137 * @aux: Our aux channel.
138 * @bridge: Our bridge.
139 * @connector: Our connector.
140 * @host_node: Remote DSI node.
141 * @dsi: Our MIPI DSI source.
142 * @refclk: Our reference clock.
143 * @next_bridge: The bridge on the eDP side.
144 * @enable_gpio: The GPIO we toggle to enable the bridge.
145 * @supplies: Data for bulk enabling/disabling our regulators.
146 * @dp_lanes: Count of dp_lanes we're using.
147 * @ln_assign: Value to program to the LN_ASSIGN register.
148 * @ln_polrs: Value for the 4-bit LN_POLRS field of SN_ENH_FRAME_REG.
149 * @comms_enabled: If true then communication over the aux channel is enabled.
150 * @comms_mutex: Protects modification of comms_enabled.
152 * @gchip: If we expose our GPIOs, this is used.
153 * @gchip_output: A cache of whether we've set GPIOs to output. This
154 * serves double-duty of keeping track of the direction and
155 * also keeping track of whether we've incremented the
156 * pm_runtime reference count for this pin, which we do
157 * whenever a pin is configured as an output. This is a
158 * bitmap so we can do atomic ops on it without an extra
159 * lock so concurrent users of our 4 GPIOs don't stomp on
160 * each other's read-modify-write.
162 * @pchip: pwm_chip if the PWM is exposed.
163 * @pwm_enabled: Used to track if the PWM signal is currently enabled.
164 * @pwm_pin_busy: Track if GPIO4 is currently requested for GPIO or PWM.
165 * @pwm_refclk_freq: Cache for the reference clock input to the PWM.
167 struct ti_sn65dsi86 {
168 struct auxiliary_device bridge_aux;
169 struct auxiliary_device gpio_aux;
170 struct auxiliary_device aux_aux;
171 struct auxiliary_device pwm_aux;
174 struct regmap *regmap;
175 struct drm_dp_aux aux;
176 struct drm_bridge bridge;
177 struct drm_connector connector;
178 struct device_node *host_node;
179 struct mipi_dsi_device *dsi;
181 struct drm_bridge *next_bridge;
182 struct gpio_desc *enable_gpio;
183 struct regulator_bulk_data supplies[SN_REGULATOR_SUPPLY_NUM];
188 struct mutex comms_mutex;
190 #if defined(CONFIG_OF_GPIO)
191 struct gpio_chip gchip;
192 DECLARE_BITMAP(gchip_output, SN_NUM_GPIOS);
194 #if defined(CONFIG_PWM)
195 struct pwm_chip pchip;
197 atomic_t pwm_pin_busy;
199 unsigned int pwm_refclk_freq;
202 static const struct regmap_range ti_sn65dsi86_volatile_ranges[] = {
203 { .range_min = 0, .range_max = 0xFF },
206 static const struct regmap_access_table ti_sn_bridge_volatile_table = {
207 .yes_ranges = ti_sn65dsi86_volatile_ranges,
208 .n_yes_ranges = ARRAY_SIZE(ti_sn65dsi86_volatile_ranges),
211 static const struct regmap_config ti_sn65dsi86_regmap_config = {
214 .volatile_table = &ti_sn_bridge_volatile_table,
215 .cache_type = REGCACHE_NONE,
218 static int ti_sn65dsi86_read_u16(struct ti_sn65dsi86 *pdata,
219 unsigned int reg, u16 *val)
224 ret = regmap_bulk_read(pdata->regmap, reg, buf, ARRAY_SIZE(buf));
228 *val = buf[0] | (buf[1] << 8);
233 static void ti_sn65dsi86_write_u16(struct ti_sn65dsi86 *pdata,
234 unsigned int reg, u16 val)
236 u8 buf[2] = { val & 0xff, val >> 8 };
238 regmap_bulk_write(pdata->regmap, reg, buf, ARRAY_SIZE(buf));
241 static u32 ti_sn_bridge_get_dsi_freq(struct ti_sn65dsi86 *pdata)
243 u32 bit_rate_khz, clk_freq_khz;
244 struct drm_display_mode *mode =
245 &pdata->bridge.encoder->crtc->state->adjusted_mode;
247 bit_rate_khz = mode->clock *
248 mipi_dsi_pixel_format_to_bpp(pdata->dsi->format);
249 clk_freq_khz = bit_rate_khz / (pdata->dsi->lanes * 2);
254 /* clk frequencies supported by bridge in Hz in case derived from REFCLK pin */
255 static const u32 ti_sn_bridge_refclk_lut[] = {
263 /* clk frequencies supported by bridge in Hz in case derived from DACP/N pin */
264 static const u32 ti_sn_bridge_dsiclk_lut[] = {
272 static void ti_sn_bridge_set_refclk_freq(struct ti_sn65dsi86 *pdata)
276 const u32 *refclk_lut;
277 size_t refclk_lut_size;
280 refclk_rate = clk_get_rate(pdata->refclk);
281 refclk_lut = ti_sn_bridge_refclk_lut;
282 refclk_lut_size = ARRAY_SIZE(ti_sn_bridge_refclk_lut);
283 clk_prepare_enable(pdata->refclk);
285 refclk_rate = ti_sn_bridge_get_dsi_freq(pdata) * 1000;
286 refclk_lut = ti_sn_bridge_dsiclk_lut;
287 refclk_lut_size = ARRAY_SIZE(ti_sn_bridge_dsiclk_lut);
290 /* for i equals to refclk_lut_size means default frequency */
291 for (i = 0; i < refclk_lut_size; i++)
292 if (refclk_lut[i] == refclk_rate)
295 regmap_update_bits(pdata->regmap, SN_DPPLL_SRC_REG, REFCLK_FREQ_MASK,
299 * The PWM refclk is based on the value written to SN_DPPLL_SRC_REG,
300 * regardless of its actual sourcing.
302 pdata->pwm_refclk_freq = ti_sn_bridge_refclk_lut[i];
305 static void ti_sn65dsi86_enable_comms(struct ti_sn65dsi86 *pdata)
307 mutex_lock(&pdata->comms_mutex);
309 /* configure bridge ref_clk */
310 ti_sn_bridge_set_refclk_freq(pdata);
313 * HPD on this bridge chip is a bit useless. This is an eDP bridge
314 * so the HPD is an internal signal that's only there to signal that
315 * the panel is done powering up. ...but the bridge chip debounces
316 * this signal by between 100 ms and 400 ms (depending on process,
317 * voltage, and temperate--I measured it at about 200 ms). One
318 * particular panel asserted HPD 84 ms after it was powered on meaning
319 * that we saw HPD 284 ms after power on. ...but the same panel said
320 * that instead of looking at HPD you could just hardcode a delay of
321 * 200 ms. We'll assume that the panel driver will have the hardcoded
322 * delay in its prepare and always disable HPD.
324 * If HPD somehow makes sense on some future panel we'll have to
325 * change this to be conditional on someone specifying that HPD should
328 regmap_update_bits(pdata->regmap, SN_HPD_DISABLE_REG, HPD_DISABLE,
331 pdata->comms_enabled = true;
333 mutex_unlock(&pdata->comms_mutex);
336 static void ti_sn65dsi86_disable_comms(struct ti_sn65dsi86 *pdata)
338 mutex_lock(&pdata->comms_mutex);
340 pdata->comms_enabled = false;
341 clk_disable_unprepare(pdata->refclk);
343 mutex_unlock(&pdata->comms_mutex);
346 static int __maybe_unused ti_sn65dsi86_resume(struct device *dev)
348 struct ti_sn65dsi86 *pdata = dev_get_drvdata(dev);
351 ret = regulator_bulk_enable(SN_REGULATOR_SUPPLY_NUM, pdata->supplies);
353 DRM_ERROR("failed to enable supplies %d\n", ret);
357 /* td2: min 100 us after regulators before enabling the GPIO */
358 usleep_range(100, 110);
360 gpiod_set_value(pdata->enable_gpio, 1);
363 * If we have a reference clock we can enable communication w/ the
364 * panel (including the aux channel) w/out any need for an input clock
365 * so we can do it in resume which lets us read the EDID before
366 * pre_enable(). Without a reference clock we need the MIPI reference
367 * clock so reading early doesn't work.
370 ti_sn65dsi86_enable_comms(pdata);
375 static int __maybe_unused ti_sn65dsi86_suspend(struct device *dev)
377 struct ti_sn65dsi86 *pdata = dev_get_drvdata(dev);
381 ti_sn65dsi86_disable_comms(pdata);
383 gpiod_set_value(pdata->enable_gpio, 0);
385 ret = regulator_bulk_disable(SN_REGULATOR_SUPPLY_NUM, pdata->supplies);
387 DRM_ERROR("failed to disable supplies %d\n", ret);
392 static const struct dev_pm_ops ti_sn65dsi86_pm_ops = {
393 SET_RUNTIME_PM_OPS(ti_sn65dsi86_suspend, ti_sn65dsi86_resume, NULL)
394 SET_SYSTEM_SLEEP_PM_OPS(pm_runtime_force_suspend,
395 pm_runtime_force_resume)
398 static int status_show(struct seq_file *s, void *data)
400 struct ti_sn65dsi86 *pdata = s->private;
401 unsigned int reg, val;
403 seq_puts(s, "STATUS REGISTERS:\n");
405 pm_runtime_get_sync(pdata->dev);
407 /* IRQ Status Registers, see Table 31 in datasheet */
408 for (reg = 0xf0; reg <= 0xf8; reg++) {
409 regmap_read(pdata->regmap, reg, &val);
410 seq_printf(s, "[0x%02x] = 0x%08x\n", reg, val);
413 pm_runtime_put_autosuspend(pdata->dev);
418 DEFINE_SHOW_ATTRIBUTE(status);
420 static void ti_sn65dsi86_debugfs_remove(void *data)
422 debugfs_remove_recursive(data);
425 static void ti_sn65dsi86_debugfs_init(struct ti_sn65dsi86 *pdata)
427 struct device *dev = pdata->dev;
428 struct dentry *debugfs;
431 debugfs = debugfs_create_dir(dev_name(dev), NULL);
434 * We might get an error back if debugfs wasn't enabled in the kernel
435 * so let's just silently return upon failure.
437 if (IS_ERR_OR_NULL(debugfs))
440 ret = devm_add_action_or_reset(dev, ti_sn65dsi86_debugfs_remove, debugfs);
444 debugfs_create_file("status", 0600, debugfs, pdata, &status_fops);
447 /* -----------------------------------------------------------------------------
448 * Auxiliary Devices (*not* AUX)
451 static void ti_sn65dsi86_uninit_aux(void *data)
453 auxiliary_device_uninit(data);
456 static void ti_sn65dsi86_delete_aux(void *data)
458 auxiliary_device_delete(data);
462 * AUX bus docs say that a non-NULL release is mandatory, but it makes no
463 * sense for the model used here where all of the aux devices are allocated
464 * in the single shared structure. We'll use this noop as a workaround.
466 static void ti_sn65dsi86_noop(struct device *dev) {}
468 static int ti_sn65dsi86_add_aux_device(struct ti_sn65dsi86 *pdata,
469 struct auxiliary_device *aux,
472 struct device *dev = pdata->dev;
476 aux->dev.parent = dev;
477 aux->dev.release = ti_sn65dsi86_noop;
478 device_set_of_node_from_dev(&aux->dev, dev);
479 ret = auxiliary_device_init(aux);
482 ret = devm_add_action_or_reset(dev, ti_sn65dsi86_uninit_aux, aux);
486 ret = auxiliary_device_add(aux);
489 ret = devm_add_action_or_reset(dev, ti_sn65dsi86_delete_aux, aux);
494 /* -----------------------------------------------------------------------------
498 static struct ti_sn65dsi86 *aux_to_ti_sn65dsi86(struct drm_dp_aux *aux)
500 return container_of(aux, struct ti_sn65dsi86, aux);
503 static ssize_t ti_sn_aux_transfer(struct drm_dp_aux *aux,
504 struct drm_dp_aux_msg *msg)
506 struct ti_sn65dsi86 *pdata = aux_to_ti_sn65dsi86(aux);
507 u32 request = msg->request & ~(DP_AUX_I2C_MOT | DP_AUX_I2C_WRITE_STATUS_UPDATE);
508 u32 request_val = AUX_CMD_REQ(msg->request);
509 u8 *buf = msg->buffer;
510 unsigned int len = msg->size;
513 u8 addr_len[SN_AUX_LENGTH_REG + 1 - SN_AUX_ADDR_19_16_REG];
515 if (len > SN_AUX_MAX_PAYLOAD_BYTES)
518 pm_runtime_get_sync(pdata->dev);
519 mutex_lock(&pdata->comms_mutex);
522 * If someone tries to do a DDC over AUX transaction before pre_enable()
523 * on a device without a dedicated reference clock then we just can't
524 * do it. Fail right away. This prevents non-refclk users from reading
525 * the EDID before enabling the panel but such is life.
527 if (!pdata->comms_enabled) {
533 case DP_AUX_NATIVE_WRITE:
534 case DP_AUX_I2C_WRITE:
535 case DP_AUX_NATIVE_READ:
536 case DP_AUX_I2C_READ:
537 regmap_write(pdata->regmap, SN_AUX_CMD_REG, request_val);
538 /* Assume it's good */
546 BUILD_BUG_ON(sizeof(addr_len) != sizeof(__be32));
547 put_unaligned_be32((msg->address & SN_AUX_ADDR_MASK) << 8 | len,
549 regmap_bulk_write(pdata->regmap, SN_AUX_ADDR_19_16_REG, addr_len,
550 ARRAY_SIZE(addr_len));
552 if (request == DP_AUX_NATIVE_WRITE || request == DP_AUX_I2C_WRITE)
553 regmap_bulk_write(pdata->regmap, SN_AUX_WDATA_REG(0), buf, len);
555 /* Clear old status bits before start so we don't get confused */
556 regmap_write(pdata->regmap, SN_AUX_CMD_STATUS_REG,
557 AUX_IRQ_STATUS_NAT_I2C_FAIL |
558 AUX_IRQ_STATUS_AUX_RPLY_TOUT |
559 AUX_IRQ_STATUS_AUX_SHORT);
561 regmap_write(pdata->regmap, SN_AUX_CMD_REG, request_val | AUX_CMD_SEND);
563 /* Zero delay loop because i2c transactions are slow already */
564 ret = regmap_read_poll_timeout(pdata->regmap, SN_AUX_CMD_REG, val,
565 !(val & AUX_CMD_SEND), 0, 50 * 1000);
569 ret = regmap_read(pdata->regmap, SN_AUX_CMD_STATUS_REG, &val);
573 if (val & AUX_IRQ_STATUS_AUX_RPLY_TOUT) {
575 * The hardware tried the message seven times per the DP spec
576 * but it hit a timeout. We ignore defers here because they're
577 * handled in hardware.
583 if (val & AUX_IRQ_STATUS_AUX_SHORT) {
584 ret = regmap_read(pdata->regmap, SN_AUX_LENGTH_REG, &len);
587 } else if (val & AUX_IRQ_STATUS_NAT_I2C_FAIL) {
589 case DP_AUX_I2C_WRITE:
590 case DP_AUX_I2C_READ:
591 msg->reply |= DP_AUX_I2C_REPLY_NACK;
593 case DP_AUX_NATIVE_READ:
594 case DP_AUX_NATIVE_WRITE:
595 msg->reply |= DP_AUX_NATIVE_REPLY_NACK;
602 if (request != DP_AUX_NATIVE_WRITE && request != DP_AUX_I2C_WRITE && len != 0)
603 ret = regmap_bulk_read(pdata->regmap, SN_AUX_RDATA_REG(0), buf, len);
606 mutex_unlock(&pdata->comms_mutex);
607 pm_runtime_mark_last_busy(pdata->dev);
608 pm_runtime_put_autosuspend(pdata->dev);
615 static int ti_sn_aux_probe(struct auxiliary_device *adev,
616 const struct auxiliary_device_id *id)
618 struct ti_sn65dsi86 *pdata = dev_get_drvdata(adev->dev.parent);
621 pdata->aux.name = "ti-sn65dsi86-aux";
622 pdata->aux.dev = &adev->dev;
623 pdata->aux.transfer = ti_sn_aux_transfer;
624 drm_dp_aux_init(&pdata->aux);
626 ret = devm_of_dp_aux_populate_ep_devices(&pdata->aux);
631 * The eDP to MIPI bridge parts don't work until the AUX channel is
632 * setup so we don't add it in the main driver probe, we add it now.
634 return ti_sn65dsi86_add_aux_device(pdata, &pdata->bridge_aux, "bridge");
637 static const struct auxiliary_device_id ti_sn_aux_id_table[] = {
638 { .name = "ti_sn65dsi86.aux", },
642 static struct auxiliary_driver ti_sn_aux_driver = {
644 .probe = ti_sn_aux_probe,
645 .id_table = ti_sn_aux_id_table,
648 /* -----------------------------------------------------------------------------
649 * DRM Connector Operations
652 static struct ti_sn65dsi86 *
653 connector_to_ti_sn65dsi86(struct drm_connector *connector)
655 return container_of(connector, struct ti_sn65dsi86, connector);
658 static int ti_sn_bridge_connector_get_modes(struct drm_connector *connector)
660 struct ti_sn65dsi86 *pdata = connector_to_ti_sn65dsi86(connector);
662 return drm_bridge_get_modes(pdata->next_bridge, connector);
665 static struct drm_connector_helper_funcs ti_sn_bridge_connector_helper_funcs = {
666 .get_modes = ti_sn_bridge_connector_get_modes,
669 static const struct drm_connector_funcs ti_sn_bridge_connector_funcs = {
670 .fill_modes = drm_helper_probe_single_connector_modes,
671 .destroy = drm_connector_cleanup,
672 .reset = drm_atomic_helper_connector_reset,
673 .atomic_duplicate_state = drm_atomic_helper_connector_duplicate_state,
674 .atomic_destroy_state = drm_atomic_helper_connector_destroy_state,
677 static int ti_sn_bridge_connector_init(struct ti_sn65dsi86 *pdata)
681 ret = drm_connector_init(pdata->bridge.dev, &pdata->connector,
682 &ti_sn_bridge_connector_funcs,
683 DRM_MODE_CONNECTOR_eDP);
685 DRM_ERROR("Failed to initialize connector with drm\n");
689 drm_connector_helper_add(&pdata->connector,
690 &ti_sn_bridge_connector_helper_funcs);
691 drm_connector_attach_encoder(&pdata->connector, pdata->bridge.encoder);
696 /*------------------------------------------------------------------------------
700 static struct ti_sn65dsi86 *bridge_to_ti_sn65dsi86(struct drm_bridge *bridge)
702 return container_of(bridge, struct ti_sn65dsi86, bridge);
705 static int ti_sn_bridge_attach(struct drm_bridge *bridge,
706 enum drm_bridge_attach_flags flags)
709 struct ti_sn65dsi86 *pdata = bridge_to_ti_sn65dsi86(bridge);
710 struct mipi_dsi_host *host;
711 struct mipi_dsi_device *dsi;
712 const struct mipi_dsi_device_info info = { .type = "ti_sn_bridge",
717 if (flags & DRM_BRIDGE_ATTACH_NO_CONNECTOR) {
718 DRM_ERROR("Fix bridge driver to make connector optional!");
722 pdata->aux.drm_dev = bridge->dev;
723 ret = drm_dp_aux_register(&pdata->aux);
725 drm_err(bridge->dev, "Failed to register DP AUX channel: %d\n", ret);
729 ret = ti_sn_bridge_connector_init(pdata);
734 * TODO: ideally finding host resource and dsi dev registration needs
735 * to be done in bridge probe. But some existing DSI host drivers will
736 * wait for any of the drm_bridge/drm_panel to get added to the global
737 * bridge/panel list, before completing their probe. So if we do the
738 * dsi dev registration part in bridge probe, before populating in
739 * the global bridge list, then it will cause deadlock as dsi host probe
740 * will never complete, neither our bridge probe. So keeping it here
741 * will satisfy most of the existing host drivers. Once the host driver
742 * is fixed we can move the below code to bridge probe safely.
744 host = of_find_mipi_dsi_host_by_node(pdata->host_node);
746 DRM_ERROR("failed to find dsi host\n");
751 dsi = mipi_dsi_device_register_full(host, &info);
753 DRM_ERROR("failed to create dsi device\n");
758 /* TODO: setting to 4 MIPI lanes always for now */
760 dsi->format = MIPI_DSI_FMT_RGB888;
761 dsi->mode_flags = MIPI_DSI_MODE_VIDEO;
763 /* check if continuous dsi clock is required or not */
764 pm_runtime_get_sync(pdata->dev);
765 regmap_read(pdata->regmap, SN_DPPLL_SRC_REG, &val);
766 pm_runtime_put_autosuspend(pdata->dev);
767 if (!(val & DPPLL_CLK_SRC_DSICLK))
768 dsi->mode_flags |= MIPI_DSI_CLOCK_NON_CONTINUOUS;
770 ret = mipi_dsi_attach(dsi);
772 DRM_ERROR("failed to attach dsi to host\n");
777 /* We never want the next bridge to *also* create a connector: */
778 flags |= DRM_BRIDGE_ATTACH_NO_CONNECTOR;
780 /* Attach the next bridge */
781 ret = drm_bridge_attach(bridge->encoder, pdata->next_bridge,
782 &pdata->bridge, flags);
789 mipi_dsi_detach(dsi);
791 mipi_dsi_device_unregister(dsi);
793 drm_connector_cleanup(&pdata->connector);
795 drm_dp_aux_unregister(&pdata->aux);
799 static void ti_sn_bridge_detach(struct drm_bridge *bridge)
801 drm_dp_aux_unregister(&bridge_to_ti_sn65dsi86(bridge)->aux);
804 static enum drm_mode_status
805 ti_sn_bridge_mode_valid(struct drm_bridge *bridge,
806 const struct drm_display_info *info,
807 const struct drm_display_mode *mode)
809 /* maximum supported resolution is 4K at 60 fps */
810 if (mode->clock > 594000)
811 return MODE_CLOCK_HIGH;
816 static void ti_sn_bridge_disable(struct drm_bridge *bridge)
818 struct ti_sn65dsi86 *pdata = bridge_to_ti_sn65dsi86(bridge);
820 /* disable video stream */
821 regmap_update_bits(pdata->regmap, SN_ENH_FRAME_REG, VSTREAM_ENABLE, 0);
824 static void ti_sn_bridge_set_dsi_rate(struct ti_sn65dsi86 *pdata)
826 unsigned int bit_rate_mhz, clk_freq_mhz;
828 struct drm_display_mode *mode =
829 &pdata->bridge.encoder->crtc->state->adjusted_mode;
831 /* set DSIA clk frequency */
832 bit_rate_mhz = (mode->clock / 1000) *
833 mipi_dsi_pixel_format_to_bpp(pdata->dsi->format);
834 clk_freq_mhz = bit_rate_mhz / (pdata->dsi->lanes * 2);
836 /* for each increment in val, frequency increases by 5MHz */
837 val = (MIN_DSI_CLK_FREQ_MHZ / 5) +
838 (((clk_freq_mhz - MIN_DSI_CLK_FREQ_MHZ) / 5) & 0xFF);
839 regmap_write(pdata->regmap, SN_DSIA_CLK_FREQ_REG, val);
842 static unsigned int ti_sn_bridge_get_bpp(struct ti_sn65dsi86 *pdata)
844 if (pdata->connector.display_info.bpc <= 6)
851 * LUT index corresponds to register value and
852 * LUT values corresponds to dp data rate supported
853 * by the bridge in Mbps unit.
855 static const unsigned int ti_sn_bridge_dp_rate_lut[] = {
856 0, 1620, 2160, 2430, 2700, 3240, 4320, 5400
859 static int ti_sn_bridge_calc_min_dp_rate_idx(struct ti_sn65dsi86 *pdata)
861 unsigned int bit_rate_khz, dp_rate_mhz;
863 struct drm_display_mode *mode =
864 &pdata->bridge.encoder->crtc->state->adjusted_mode;
866 /* Calculate minimum bit rate based on our pixel clock. */
867 bit_rate_khz = mode->clock * ti_sn_bridge_get_bpp(pdata);
869 /* Calculate minimum DP data rate, taking 80% as per DP spec */
870 dp_rate_mhz = DIV_ROUND_UP(bit_rate_khz * DP_CLK_FUDGE_NUM,
871 1000 * pdata->dp_lanes * DP_CLK_FUDGE_DEN);
873 for (i = 1; i < ARRAY_SIZE(ti_sn_bridge_dp_rate_lut) - 1; i++)
874 if (ti_sn_bridge_dp_rate_lut[i] >= dp_rate_mhz)
880 static unsigned int ti_sn_bridge_read_valid_rates(struct ti_sn65dsi86 *pdata)
882 unsigned int valid_rates = 0;
883 unsigned int rate_per_200khz;
884 unsigned int rate_mhz;
889 ret = drm_dp_dpcd_readb(&pdata->aux, DP_EDP_DPCD_REV, &dpcd_val);
891 DRM_DEV_ERROR(pdata->dev,
892 "Can't read eDP rev (%d), assuming 1.1\n", ret);
893 dpcd_val = DP_EDP_11;
896 if (dpcd_val >= DP_EDP_14) {
897 /* eDP 1.4 devices must provide a custom table */
898 __le16 sink_rates[DP_MAX_SUPPORTED_RATES];
900 ret = drm_dp_dpcd_read(&pdata->aux, DP_SUPPORTED_LINK_RATES,
901 sink_rates, sizeof(sink_rates));
903 if (ret != sizeof(sink_rates)) {
904 DRM_DEV_ERROR(pdata->dev,
905 "Can't read supported rate table (%d)\n", ret);
907 /* By zeroing we'll fall back to DP_MAX_LINK_RATE. */
908 memset(sink_rates, 0, sizeof(sink_rates));
911 for (i = 0; i < ARRAY_SIZE(sink_rates); i++) {
912 rate_per_200khz = le16_to_cpu(sink_rates[i]);
914 if (!rate_per_200khz)
917 rate_mhz = rate_per_200khz * 200 / 1000;
919 j < ARRAY_SIZE(ti_sn_bridge_dp_rate_lut);
921 if (ti_sn_bridge_dp_rate_lut[j] == rate_mhz)
922 valid_rates |= BIT(j);
926 for (i = 0; i < ARRAY_SIZE(ti_sn_bridge_dp_rate_lut); i++) {
927 if (valid_rates & BIT(i))
930 DRM_DEV_ERROR(pdata->dev,
931 "No matching eDP rates in table; falling back\n");
934 /* On older versions best we can do is use DP_MAX_LINK_RATE */
935 ret = drm_dp_dpcd_readb(&pdata->aux, DP_MAX_LINK_RATE, &dpcd_val);
937 DRM_DEV_ERROR(pdata->dev,
938 "Can't read max rate (%d); assuming 5.4 GHz\n",
940 dpcd_val = DP_LINK_BW_5_4;
945 DRM_DEV_ERROR(pdata->dev,
946 "Unexpected max rate (%#x); assuming 5.4 GHz\n",
950 valid_rates |= BIT(7);
953 valid_rates |= BIT(4);
955 case DP_LINK_BW_1_62:
956 valid_rates |= BIT(1);
963 static void ti_sn_bridge_set_video_timings(struct ti_sn65dsi86 *pdata)
965 struct drm_display_mode *mode =
966 &pdata->bridge.encoder->crtc->state->adjusted_mode;
967 u8 hsync_polarity = 0, vsync_polarity = 0;
969 if (mode->flags & DRM_MODE_FLAG_PHSYNC)
970 hsync_polarity = CHA_HSYNC_POLARITY;
971 if (mode->flags & DRM_MODE_FLAG_PVSYNC)
972 vsync_polarity = CHA_VSYNC_POLARITY;
974 ti_sn65dsi86_write_u16(pdata, SN_CHA_ACTIVE_LINE_LENGTH_LOW_REG,
976 ti_sn65dsi86_write_u16(pdata, SN_CHA_VERTICAL_DISPLAY_SIZE_LOW_REG,
978 regmap_write(pdata->regmap, SN_CHA_HSYNC_PULSE_WIDTH_LOW_REG,
979 (mode->hsync_end - mode->hsync_start) & 0xFF);
980 regmap_write(pdata->regmap, SN_CHA_HSYNC_PULSE_WIDTH_HIGH_REG,
981 (((mode->hsync_end - mode->hsync_start) >> 8) & 0x7F) |
983 regmap_write(pdata->regmap, SN_CHA_VSYNC_PULSE_WIDTH_LOW_REG,
984 (mode->vsync_end - mode->vsync_start) & 0xFF);
985 regmap_write(pdata->regmap, SN_CHA_VSYNC_PULSE_WIDTH_HIGH_REG,
986 (((mode->vsync_end - mode->vsync_start) >> 8) & 0x7F) |
989 regmap_write(pdata->regmap, SN_CHA_HORIZONTAL_BACK_PORCH_REG,
990 (mode->htotal - mode->hsync_end) & 0xFF);
991 regmap_write(pdata->regmap, SN_CHA_VERTICAL_BACK_PORCH_REG,
992 (mode->vtotal - mode->vsync_end) & 0xFF);
994 regmap_write(pdata->regmap, SN_CHA_HORIZONTAL_FRONT_PORCH_REG,
995 (mode->hsync_start - mode->hdisplay) & 0xFF);
996 regmap_write(pdata->regmap, SN_CHA_VERTICAL_FRONT_PORCH_REG,
997 (mode->vsync_start - mode->vdisplay) & 0xFF);
999 usleep_range(10000, 10500); /* 10ms delay recommended by spec */
1002 static unsigned int ti_sn_get_max_lanes(struct ti_sn65dsi86 *pdata)
1007 ret = drm_dp_dpcd_readb(&pdata->aux, DP_MAX_LANE_COUNT, &data);
1009 DRM_DEV_ERROR(pdata->dev,
1010 "Can't read lane count (%d); assuming 4\n", ret);
1014 return data & DP_LANE_COUNT_MASK;
1017 static int ti_sn_link_training(struct ti_sn65dsi86 *pdata, int dp_rate_idx,
1018 const char **last_err_str)
1024 /* set dp clk frequency value */
1025 regmap_update_bits(pdata->regmap, SN_DATARATE_CONFIG_REG,
1026 DP_DATARATE_MASK, DP_DATARATE(dp_rate_idx));
1029 regmap_write(pdata->regmap, SN_PLL_ENABLE_REG, 1);
1031 ret = regmap_read_poll_timeout(pdata->regmap, SN_DPPLL_SRC_REG, val,
1032 val & DPPLL_SRC_DP_PLL_LOCK, 1000,
1035 *last_err_str = "DP_PLL_LOCK polling failed";
1040 * We'll try to link train several times. As part of link training
1041 * the bridge chip will write DP_SET_POWER_D0 to DP_SET_POWER. If
1042 * the panel isn't ready quite it might respond NAK here which means
1043 * we need to try again.
1045 for (i = 0; i < SN_LINK_TRAINING_TRIES; i++) {
1046 /* Semi auto link training mode */
1047 regmap_write(pdata->regmap, SN_ML_TX_MODE_REG, 0x0A);
1048 ret = regmap_read_poll_timeout(pdata->regmap, SN_ML_TX_MODE_REG, val,
1049 val == ML_TX_MAIN_LINK_OFF ||
1050 val == ML_TX_NORMAL_MODE, 1000,
1053 *last_err_str = "Training complete polling failed";
1054 } else if (val == ML_TX_MAIN_LINK_OFF) {
1055 *last_err_str = "Link training failed, link is off";
1063 /* If we saw quite a few retries, add a note about it */
1064 if (!ret && i > SN_LINK_TRAINING_TRIES / 2)
1065 DRM_DEV_INFO(pdata->dev, "Link training needed %d retries\n", i);
1068 /* Disable the PLL if we failed */
1070 regmap_write(pdata->regmap, SN_PLL_ENABLE_REG, 0);
1075 static void ti_sn_bridge_enable(struct drm_bridge *bridge)
1077 struct ti_sn65dsi86 *pdata = bridge_to_ti_sn65dsi86(bridge);
1078 const char *last_err_str = "No supported DP rate";
1079 unsigned int valid_rates;
1085 max_dp_lanes = ti_sn_get_max_lanes(pdata);
1086 pdata->dp_lanes = min(pdata->dp_lanes, max_dp_lanes);
1088 /* DSI_A lane config */
1089 val = CHA_DSI_LANES(SN_MAX_DP_LANES - pdata->dsi->lanes);
1090 regmap_update_bits(pdata->regmap, SN_DSI_LANES_REG,
1091 CHA_DSI_LANES_MASK, val);
1093 regmap_write(pdata->regmap, SN_LN_ASSIGN_REG, pdata->ln_assign);
1094 regmap_update_bits(pdata->regmap, SN_ENH_FRAME_REG, LN_POLRS_MASK,
1095 pdata->ln_polrs << LN_POLRS_OFFSET);
1097 /* set dsi clk frequency value */
1098 ti_sn_bridge_set_dsi_rate(pdata);
1101 * The SN65DSI86 only supports ASSR Display Authentication method and
1102 * this method is enabled by default. An eDP panel must support this
1103 * authentication method. We need to enable this method in the eDP panel
1104 * at DisplayPort address 0x0010A prior to link training.
1106 drm_dp_dpcd_writeb(&pdata->aux, DP_EDP_CONFIGURATION_SET,
1107 DP_ALTERNATE_SCRAMBLER_RESET_ENABLE);
1109 /* Set the DP output format (18 bpp or 24 bpp) */
1110 val = (ti_sn_bridge_get_bpp(pdata) == 18) ? BPP_18_RGB : 0;
1111 regmap_update_bits(pdata->regmap, SN_DATA_FORMAT_REG, BPP_18_RGB, val);
1113 /* DP lane config */
1114 val = DP_NUM_LANES(min(pdata->dp_lanes, 3));
1115 regmap_update_bits(pdata->regmap, SN_SSC_CONFIG_REG, DP_NUM_LANES_MASK,
1118 valid_rates = ti_sn_bridge_read_valid_rates(pdata);
1120 /* Train until we run out of rates */
1121 for (dp_rate_idx = ti_sn_bridge_calc_min_dp_rate_idx(pdata);
1122 dp_rate_idx < ARRAY_SIZE(ti_sn_bridge_dp_rate_lut);
1124 if (!(valid_rates & BIT(dp_rate_idx)))
1127 ret = ti_sn_link_training(pdata, dp_rate_idx, &last_err_str);
1132 DRM_DEV_ERROR(pdata->dev, "%s (%d)\n", last_err_str, ret);
1136 /* config video parameters */
1137 ti_sn_bridge_set_video_timings(pdata);
1139 /* enable video stream */
1140 regmap_update_bits(pdata->regmap, SN_ENH_FRAME_REG, VSTREAM_ENABLE,
1144 static void ti_sn_bridge_pre_enable(struct drm_bridge *bridge)
1146 struct ti_sn65dsi86 *pdata = bridge_to_ti_sn65dsi86(bridge);
1148 pm_runtime_get_sync(pdata->dev);
1151 ti_sn65dsi86_enable_comms(pdata);
1153 /* td7: min 100 us after enable before DSI data */
1154 usleep_range(100, 110);
1157 static void ti_sn_bridge_post_disable(struct drm_bridge *bridge)
1159 struct ti_sn65dsi86 *pdata = bridge_to_ti_sn65dsi86(bridge);
1161 /* semi auto link training mode OFF */
1162 regmap_write(pdata->regmap, SN_ML_TX_MODE_REG, 0);
1163 /* Num lanes to 0 as per power sequencing in data sheet */
1164 regmap_update_bits(pdata->regmap, SN_SSC_CONFIG_REG, DP_NUM_LANES_MASK, 0);
1165 /* disable DP PLL */
1166 regmap_write(pdata->regmap, SN_PLL_ENABLE_REG, 0);
1169 ti_sn65dsi86_disable_comms(pdata);
1171 pm_runtime_put_sync(pdata->dev);
1174 static const struct drm_bridge_funcs ti_sn_bridge_funcs = {
1175 .attach = ti_sn_bridge_attach,
1176 .detach = ti_sn_bridge_detach,
1177 .mode_valid = ti_sn_bridge_mode_valid,
1178 .pre_enable = ti_sn_bridge_pre_enable,
1179 .enable = ti_sn_bridge_enable,
1180 .disable = ti_sn_bridge_disable,
1181 .post_disable = ti_sn_bridge_post_disable,
1184 static void ti_sn_bridge_parse_lanes(struct ti_sn65dsi86 *pdata,
1185 struct device_node *np)
1187 u32 lane_assignments[SN_MAX_DP_LANES] = { 0, 1, 2, 3 };
1188 u32 lane_polarities[SN_MAX_DP_LANES] = { };
1189 struct device_node *endpoint;
1196 * Read config from the device tree about lane remapping and lane
1197 * polarities. These are optional and we assume identity map and
1198 * normal polarity if nothing is specified. It's OK to specify just
1199 * data-lanes but not lane-polarities but not vice versa.
1201 * Error checking is light (we just make sure we don't crash or
1202 * buffer overrun) and we assume dts is well formed and specifying
1203 * mappings that the hardware supports.
1205 endpoint = of_graph_get_endpoint_by_regs(np, 1, -1);
1206 dp_lanes = of_property_count_u32_elems(endpoint, "data-lanes");
1207 if (dp_lanes > 0 && dp_lanes <= SN_MAX_DP_LANES) {
1208 of_property_read_u32_array(endpoint, "data-lanes",
1209 lane_assignments, dp_lanes);
1210 of_property_read_u32_array(endpoint, "lane-polarities",
1211 lane_polarities, dp_lanes);
1213 dp_lanes = SN_MAX_DP_LANES;
1215 of_node_put(endpoint);
1218 * Convert into register format. Loop over all lanes even if
1219 * data-lanes had fewer elements so that we nicely initialize
1220 * the LN_ASSIGN register.
1222 for (i = SN_MAX_DP_LANES - 1; i >= 0; i--) {
1223 ln_assign = ln_assign << LN_ASSIGN_WIDTH | lane_assignments[i];
1224 ln_polrs = ln_polrs << 1 | lane_polarities[i];
1227 /* Stash in our struct for when we power on */
1228 pdata->dp_lanes = dp_lanes;
1229 pdata->ln_assign = ln_assign;
1230 pdata->ln_polrs = ln_polrs;
1233 static int ti_sn_bridge_parse_dsi_host(struct ti_sn65dsi86 *pdata)
1235 struct device_node *np = pdata->dev->of_node;
1237 pdata->host_node = of_graph_get_remote_node(np, 0, 0);
1239 if (!pdata->host_node) {
1240 DRM_ERROR("remote dsi host node not found\n");
1247 static int ti_sn_bridge_probe(struct auxiliary_device *adev,
1248 const struct auxiliary_device_id *id)
1250 struct ti_sn65dsi86 *pdata = dev_get_drvdata(adev->dev.parent);
1251 struct device_node *np = pdata->dev->of_node;
1252 struct drm_panel *panel;
1255 ret = drm_of_find_panel_or_bridge(np, 1, 0, &panel, NULL);
1257 return dev_err_probe(&adev->dev, ret,
1258 "could not find any panel node\n");
1260 pdata->next_bridge = devm_drm_panel_bridge_add(pdata->dev, panel);
1261 if (IS_ERR(pdata->next_bridge)) {
1262 DRM_ERROR("failed to create panel bridge\n");
1263 return PTR_ERR(pdata->next_bridge);
1266 ti_sn_bridge_parse_lanes(pdata, np);
1268 ret = ti_sn_bridge_parse_dsi_host(pdata);
1272 pdata->bridge.funcs = &ti_sn_bridge_funcs;
1273 pdata->bridge.of_node = np;
1275 drm_bridge_add(&pdata->bridge);
1280 static void ti_sn_bridge_remove(struct auxiliary_device *adev)
1282 struct ti_sn65dsi86 *pdata = dev_get_drvdata(adev->dev.parent);
1288 mipi_dsi_detach(pdata->dsi);
1289 mipi_dsi_device_unregister(pdata->dsi);
1292 drm_bridge_remove(&pdata->bridge);
1294 of_node_put(pdata->host_node);
1297 static const struct auxiliary_device_id ti_sn_bridge_id_table[] = {
1298 { .name = "ti_sn65dsi86.bridge", },
1302 static struct auxiliary_driver ti_sn_bridge_driver = {
1304 .probe = ti_sn_bridge_probe,
1305 .remove = ti_sn_bridge_remove,
1306 .id_table = ti_sn_bridge_id_table,
1309 /* -----------------------------------------------------------------------------
1312 #if defined(CONFIG_PWM)
1313 static int ti_sn_pwm_pin_request(struct ti_sn65dsi86 *pdata)
1315 return atomic_xchg(&pdata->pwm_pin_busy, 1) ? -EBUSY : 0;
1318 static void ti_sn_pwm_pin_release(struct ti_sn65dsi86 *pdata)
1320 atomic_set(&pdata->pwm_pin_busy, 0);
1323 static struct ti_sn65dsi86 *pwm_chip_to_ti_sn_bridge(struct pwm_chip *chip)
1325 return container_of(chip, struct ti_sn65dsi86, pchip);
1328 static int ti_sn_pwm_request(struct pwm_chip *chip, struct pwm_device *pwm)
1330 struct ti_sn65dsi86 *pdata = pwm_chip_to_ti_sn_bridge(chip);
1332 return ti_sn_pwm_pin_request(pdata);
1335 static void ti_sn_pwm_free(struct pwm_chip *chip, struct pwm_device *pwm)
1337 struct ti_sn65dsi86 *pdata = pwm_chip_to_ti_sn_bridge(chip);
1339 ti_sn_pwm_pin_release(pdata);
1344 * - The PWM signal is not driven when the chip is powered down, or in its
1345 * reset state and the driver does not implement the "suspend state"
1346 * described in the documentation. In order to save power, state->enabled is
1347 * interpreted as denoting if the signal is expected to be valid, and is used
1348 * to determine if the chip needs to be kept powered.
1349 * - Changing both period and duty_cycle is not done atomically, neither is the
1350 * multi-byte register updates, so the output might briefly be undefined
1353 static int ti_sn_pwm_apply(struct pwm_chip *chip, struct pwm_device *pwm,
1354 const struct pwm_state *state)
1356 struct ti_sn65dsi86 *pdata = pwm_chip_to_ti_sn_bridge(chip);
1357 unsigned int pwm_en_inv;
1358 unsigned int backlight;
1359 unsigned int pre_div;
1365 if (!pdata->pwm_enabled) {
1366 ret = pm_runtime_get_sync(pdata->dev);
1368 pm_runtime_put_sync(pdata->dev);
1373 if (state->enabled) {
1374 if (!pdata->pwm_enabled) {
1376 * The chip might have been powered down while we
1377 * didn't hold a PM runtime reference, so mux in the
1378 * PWM function on the GPIO pin again.
1380 ret = regmap_update_bits(pdata->regmap, SN_GPIO_CTRL_REG,
1381 SN_GPIO_MUX_MASK << (2 * SN_PWM_GPIO_IDX),
1382 SN_GPIO_MUX_SPECIAL << (2 * SN_PWM_GPIO_IDX));
1384 dev_err(pdata->dev, "failed to mux in PWM function\n");
1390 * Per the datasheet the PWM frequency is given by:
1393 * PWM_FREQ = -----------------------------------
1394 * PWM_PRE_DIV * BACKLIGHT_SCALE + 1
1396 * However, after careful review the author is convinced that
1397 * the documentation has lost some parenthesis around
1398 * "BACKLIGHT_SCALE + 1".
1400 * With the period T_pwm = 1/PWM_FREQ this can be written:
1402 * T_pwm * REFCLK_FREQ = PWM_PRE_DIV * (BACKLIGHT_SCALE + 1)
1404 * In order to keep BACKLIGHT_SCALE within its 16 bits,
1405 * PWM_PRE_DIV must be:
1407 * T_pwm * REFCLK_FREQ
1408 * PWM_PRE_DIV >= -------------------------
1409 * BACKLIGHT_SCALE_MAX + 1
1411 * To simplify the search and to favour higher resolution of
1412 * the duty cycle over accuracy of the period, the lowest
1413 * possible PWM_PRE_DIV is used. Finally the scale is
1416 * T_pwm * REFCLK_FREQ
1417 * BACKLIGHT_SCALE = ---------------------- - 1
1420 * Here T_pwm is represented in seconds, so appropriate scaling
1421 * to nanoseconds is necessary.
1424 /* Minimum T_pwm is 1 / REFCLK_FREQ */
1425 if (state->period <= NSEC_PER_SEC / pdata->pwm_refclk_freq) {
1431 * Maximum T_pwm is 255 * (65535 + 1) / REFCLK_FREQ
1432 * Limit period to this to avoid overflows
1434 period_max = div_u64((u64)NSEC_PER_SEC * 255 * (65535 + 1),
1435 pdata->pwm_refclk_freq);
1436 period = min(state->period, period_max);
1438 pre_div = DIV64_U64_ROUND_UP(period * pdata->pwm_refclk_freq,
1439 (u64)NSEC_PER_SEC * (BACKLIGHT_SCALE_MAX + 1));
1440 scale = div64_u64(period * pdata->pwm_refclk_freq, (u64)NSEC_PER_SEC * pre_div) - 1;
1443 * The documentation has the duty ratio given as:
1446 * ------- = ---------------------
1447 * period BACKLIGHT_SCALE + 1
1449 * Solve for BACKLIGHT, substituting BACKLIGHT_SCALE according
1450 * to definition above and adjusting for nanosecond
1451 * representation of duty cycle gives us:
1453 backlight = div64_u64(state->duty_cycle * pdata->pwm_refclk_freq,
1454 (u64)NSEC_PER_SEC * pre_div);
1455 if (backlight > scale)
1458 ret = regmap_write(pdata->regmap, SN_PWM_PRE_DIV_REG, pre_div);
1460 dev_err(pdata->dev, "failed to update PWM_PRE_DIV\n");
1464 ti_sn65dsi86_write_u16(pdata, SN_BACKLIGHT_SCALE_REG, scale);
1465 ti_sn65dsi86_write_u16(pdata, SN_BACKLIGHT_REG, backlight);
1468 pwm_en_inv = FIELD_PREP(SN_PWM_EN_MASK, state->enabled) |
1469 FIELD_PREP(SN_PWM_INV_MASK, state->polarity == PWM_POLARITY_INVERSED);
1470 ret = regmap_write(pdata->regmap, SN_PWM_EN_INV_REG, pwm_en_inv);
1472 dev_err(pdata->dev, "failed to update PWM_EN/PWM_INV\n");
1476 pdata->pwm_enabled = state->enabled;
1479 if (!pdata->pwm_enabled)
1480 pm_runtime_put_sync(pdata->dev);
1485 static void ti_sn_pwm_get_state(struct pwm_chip *chip, struct pwm_device *pwm,
1486 struct pwm_state *state)
1488 struct ti_sn65dsi86 *pdata = pwm_chip_to_ti_sn_bridge(chip);
1489 unsigned int pwm_en_inv;
1490 unsigned int pre_div;
1495 ret = regmap_read(pdata->regmap, SN_PWM_EN_INV_REG, &pwm_en_inv);
1499 ret = ti_sn65dsi86_read_u16(pdata, SN_BACKLIGHT_SCALE_REG, &scale);
1503 ret = ti_sn65dsi86_read_u16(pdata, SN_BACKLIGHT_REG, &backlight);
1507 ret = regmap_read(pdata->regmap, SN_PWM_PRE_DIV_REG, &pre_div);
1511 state->enabled = FIELD_GET(SN_PWM_EN_MASK, pwm_en_inv);
1512 if (FIELD_GET(SN_PWM_INV_MASK, pwm_en_inv))
1513 state->polarity = PWM_POLARITY_INVERSED;
1515 state->polarity = PWM_POLARITY_NORMAL;
1517 state->period = DIV_ROUND_UP_ULL((u64)NSEC_PER_SEC * pre_div * (scale + 1),
1518 pdata->pwm_refclk_freq);
1519 state->duty_cycle = DIV_ROUND_UP_ULL((u64)NSEC_PER_SEC * pre_div * backlight,
1520 pdata->pwm_refclk_freq);
1522 if (state->duty_cycle > state->period)
1523 state->duty_cycle = state->period;
1526 static const struct pwm_ops ti_sn_pwm_ops = {
1527 .request = ti_sn_pwm_request,
1528 .free = ti_sn_pwm_free,
1529 .apply = ti_sn_pwm_apply,
1530 .get_state = ti_sn_pwm_get_state,
1531 .owner = THIS_MODULE,
1534 static int ti_sn_pwm_probe(struct auxiliary_device *adev,
1535 const struct auxiliary_device_id *id)
1537 struct ti_sn65dsi86 *pdata = dev_get_drvdata(adev->dev.parent);
1539 pdata->pchip.dev = pdata->dev;
1540 pdata->pchip.ops = &ti_sn_pwm_ops;
1541 pdata->pchip.npwm = 1;
1542 pdata->pchip.of_xlate = of_pwm_single_xlate;
1543 pdata->pchip.of_pwm_n_cells = 1;
1545 return pwmchip_add(&pdata->pchip);
1548 static void ti_sn_pwm_remove(struct auxiliary_device *adev)
1550 struct ti_sn65dsi86 *pdata = dev_get_drvdata(adev->dev.parent);
1552 pwmchip_remove(&pdata->pchip);
1554 if (pdata->pwm_enabled)
1555 pm_runtime_put_sync(pdata->dev);
1558 static const struct auxiliary_device_id ti_sn_pwm_id_table[] = {
1559 { .name = "ti_sn65dsi86.pwm", },
1563 static struct auxiliary_driver ti_sn_pwm_driver = {
1565 .probe = ti_sn_pwm_probe,
1566 .remove = ti_sn_pwm_remove,
1567 .id_table = ti_sn_pwm_id_table,
1570 static int __init ti_sn_pwm_register(void)
1572 return auxiliary_driver_register(&ti_sn_pwm_driver);
1575 static void ti_sn_pwm_unregister(void)
1577 auxiliary_driver_unregister(&ti_sn_pwm_driver);
1581 static inline int ti_sn_pwm_pin_request(struct ti_sn65dsi86 *pdata) { return 0; }
1582 static inline void ti_sn_pwm_pin_release(struct ti_sn65dsi86 *pdata) {}
1584 static inline int ti_sn_pwm_register(void) { return 0; }
1585 static inline void ti_sn_pwm_unregister(void) {}
1588 /* -----------------------------------------------------------------------------
1591 #if defined(CONFIG_OF_GPIO)
1593 static int tn_sn_bridge_of_xlate(struct gpio_chip *chip,
1594 const struct of_phandle_args *gpiospec,
1597 if (WARN_ON(gpiospec->args_count < chip->of_gpio_n_cells))
1600 if (gpiospec->args[0] > chip->ngpio || gpiospec->args[0] < 1)
1604 *flags = gpiospec->args[1];
1606 return gpiospec->args[0] - SN_GPIO_PHYSICAL_OFFSET;
1609 static int ti_sn_bridge_gpio_get_direction(struct gpio_chip *chip,
1610 unsigned int offset)
1612 struct ti_sn65dsi86 *pdata = gpiochip_get_data(chip);
1615 * We already have to keep track of the direction because we use
1616 * that to figure out whether we've powered the device. We can
1617 * just return that rather than (maybe) powering up the device
1618 * to ask its direction.
1620 return test_bit(offset, pdata->gchip_output) ?
1621 GPIO_LINE_DIRECTION_OUT : GPIO_LINE_DIRECTION_IN;
1624 static int ti_sn_bridge_gpio_get(struct gpio_chip *chip, unsigned int offset)
1626 struct ti_sn65dsi86 *pdata = gpiochip_get_data(chip);
1631 * When the pin is an input we don't forcibly keep the bridge
1632 * powered--we just power it on to read the pin. NOTE: part of
1633 * the reason this works is that the bridge defaults (when
1634 * powered back on) to all 4 GPIOs being configured as GPIO input.
1635 * Also note that if something else is keeping the chip powered the
1636 * pm_runtime functions are lightweight increments of a refcount.
1638 pm_runtime_get_sync(pdata->dev);
1639 ret = regmap_read(pdata->regmap, SN_GPIO_IO_REG, &val);
1640 pm_runtime_put_autosuspend(pdata->dev);
1645 return !!(val & BIT(SN_GPIO_INPUT_SHIFT + offset));
1648 static void ti_sn_bridge_gpio_set(struct gpio_chip *chip, unsigned int offset,
1651 struct ti_sn65dsi86 *pdata = gpiochip_get_data(chip);
1654 if (!test_bit(offset, pdata->gchip_output)) {
1655 dev_err(pdata->dev, "Ignoring GPIO set while input\n");
1660 ret = regmap_update_bits(pdata->regmap, SN_GPIO_IO_REG,
1661 BIT(SN_GPIO_OUTPUT_SHIFT + offset),
1662 val << (SN_GPIO_OUTPUT_SHIFT + offset));
1664 dev_warn(pdata->dev,
1665 "Failed to set bridge GPIO %u: %d\n", offset, ret);
1668 static int ti_sn_bridge_gpio_direction_input(struct gpio_chip *chip,
1669 unsigned int offset)
1671 struct ti_sn65dsi86 *pdata = gpiochip_get_data(chip);
1672 int shift = offset * 2;
1675 if (!test_and_clear_bit(offset, pdata->gchip_output))
1678 ret = regmap_update_bits(pdata->regmap, SN_GPIO_CTRL_REG,
1679 SN_GPIO_MUX_MASK << shift,
1680 SN_GPIO_MUX_INPUT << shift);
1682 set_bit(offset, pdata->gchip_output);
1687 * NOTE: if nobody else is powering the device this may fully power
1688 * it off and when it comes back it will have lost all state, but
1689 * that's OK because the default is input and we're now an input.
1691 pm_runtime_put_autosuspend(pdata->dev);
1696 static int ti_sn_bridge_gpio_direction_output(struct gpio_chip *chip,
1697 unsigned int offset, int val)
1699 struct ti_sn65dsi86 *pdata = gpiochip_get_data(chip);
1700 int shift = offset * 2;
1703 if (test_and_set_bit(offset, pdata->gchip_output))
1706 pm_runtime_get_sync(pdata->dev);
1708 /* Set value first to avoid glitching */
1709 ti_sn_bridge_gpio_set(chip, offset, val);
1712 ret = regmap_update_bits(pdata->regmap, SN_GPIO_CTRL_REG,
1713 SN_GPIO_MUX_MASK << shift,
1714 SN_GPIO_MUX_OUTPUT << shift);
1716 clear_bit(offset, pdata->gchip_output);
1717 pm_runtime_put_autosuspend(pdata->dev);
1723 static int ti_sn_bridge_gpio_request(struct gpio_chip *chip, unsigned int offset)
1725 struct ti_sn65dsi86 *pdata = gpiochip_get_data(chip);
1727 if (offset == SN_PWM_GPIO_IDX)
1728 return ti_sn_pwm_pin_request(pdata);
1733 static void ti_sn_bridge_gpio_free(struct gpio_chip *chip, unsigned int offset)
1735 struct ti_sn65dsi86 *pdata = gpiochip_get_data(chip);
1737 /* We won't keep pm_runtime if we're input, so switch there on free */
1738 ti_sn_bridge_gpio_direction_input(chip, offset);
1740 if (offset == SN_PWM_GPIO_IDX)
1741 ti_sn_pwm_pin_release(pdata);
1744 static const char * const ti_sn_bridge_gpio_names[SN_NUM_GPIOS] = {
1745 "GPIO1", "GPIO2", "GPIO3", "GPIO4"
1748 static int ti_sn_gpio_probe(struct auxiliary_device *adev,
1749 const struct auxiliary_device_id *id)
1751 struct ti_sn65dsi86 *pdata = dev_get_drvdata(adev->dev.parent);
1754 /* Only init if someone is going to use us as a GPIO controller */
1755 if (!of_property_read_bool(pdata->dev->of_node, "gpio-controller"))
1758 pdata->gchip.label = dev_name(pdata->dev);
1759 pdata->gchip.parent = pdata->dev;
1760 pdata->gchip.owner = THIS_MODULE;
1761 pdata->gchip.of_xlate = tn_sn_bridge_of_xlate;
1762 pdata->gchip.of_gpio_n_cells = 2;
1763 pdata->gchip.request = ti_sn_bridge_gpio_request;
1764 pdata->gchip.free = ti_sn_bridge_gpio_free;
1765 pdata->gchip.get_direction = ti_sn_bridge_gpio_get_direction;
1766 pdata->gchip.direction_input = ti_sn_bridge_gpio_direction_input;
1767 pdata->gchip.direction_output = ti_sn_bridge_gpio_direction_output;
1768 pdata->gchip.get = ti_sn_bridge_gpio_get;
1769 pdata->gchip.set = ti_sn_bridge_gpio_set;
1770 pdata->gchip.can_sleep = true;
1771 pdata->gchip.names = ti_sn_bridge_gpio_names;
1772 pdata->gchip.ngpio = SN_NUM_GPIOS;
1773 pdata->gchip.base = -1;
1774 ret = devm_gpiochip_add_data(&adev->dev, &pdata->gchip, pdata);
1776 dev_err(pdata->dev, "can't add gpio chip\n");
1781 static const struct auxiliary_device_id ti_sn_gpio_id_table[] = {
1782 { .name = "ti_sn65dsi86.gpio", },
1786 MODULE_DEVICE_TABLE(auxiliary, ti_sn_gpio_id_table);
1788 static struct auxiliary_driver ti_sn_gpio_driver = {
1790 .probe = ti_sn_gpio_probe,
1791 .id_table = ti_sn_gpio_id_table,
1794 static int __init ti_sn_gpio_register(void)
1796 return auxiliary_driver_register(&ti_sn_gpio_driver);
1799 static void ti_sn_gpio_unregister(void)
1801 auxiliary_driver_unregister(&ti_sn_gpio_driver);
1806 static inline int ti_sn_gpio_register(void) { return 0; }
1807 static inline void ti_sn_gpio_unregister(void) {}
1811 /* -----------------------------------------------------------------------------
1815 static void ti_sn65dsi86_runtime_disable(void *data)
1817 pm_runtime_disable(data);
1820 static int ti_sn65dsi86_parse_regulators(struct ti_sn65dsi86 *pdata)
1823 const char * const ti_sn_bridge_supply_names[] = {
1824 "vcca", "vcc", "vccio", "vpll",
1827 for (i = 0; i < SN_REGULATOR_SUPPLY_NUM; i++)
1828 pdata->supplies[i].supply = ti_sn_bridge_supply_names[i];
1830 return devm_regulator_bulk_get(pdata->dev, SN_REGULATOR_SUPPLY_NUM,
1834 static int ti_sn65dsi86_probe(struct i2c_client *client,
1835 const struct i2c_device_id *id)
1837 struct device *dev = &client->dev;
1838 struct ti_sn65dsi86 *pdata;
1841 if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) {
1842 DRM_ERROR("device doesn't support I2C\n");
1846 pdata = devm_kzalloc(dev, sizeof(struct ti_sn65dsi86), GFP_KERNEL);
1849 dev_set_drvdata(dev, pdata);
1852 mutex_init(&pdata->comms_mutex);
1854 pdata->regmap = devm_regmap_init_i2c(client,
1855 &ti_sn65dsi86_regmap_config);
1856 if (IS_ERR(pdata->regmap))
1857 return dev_err_probe(dev, PTR_ERR(pdata->regmap),
1858 "regmap i2c init failed\n");
1860 pdata->enable_gpio = devm_gpiod_get_optional(dev, "enable",
1862 if (IS_ERR(pdata->enable_gpio))
1863 return dev_err_probe(dev, PTR_ERR(pdata->enable_gpio),
1864 "failed to get enable gpio from DT\n");
1866 ret = ti_sn65dsi86_parse_regulators(pdata);
1868 return dev_err_probe(dev, ret, "failed to parse regulators\n");
1870 pdata->refclk = devm_clk_get_optional(dev, "refclk");
1871 if (IS_ERR(pdata->refclk))
1872 return dev_err_probe(dev, PTR_ERR(pdata->refclk),
1873 "failed to get reference clock\n");
1875 pm_runtime_enable(dev);
1876 ret = devm_add_action_or_reset(dev, ti_sn65dsi86_runtime_disable, dev);
1879 pm_runtime_set_autosuspend_delay(pdata->dev, 500);
1880 pm_runtime_use_autosuspend(pdata->dev);
1882 ti_sn65dsi86_debugfs_init(pdata);
1885 * Break ourselves up into a collection of aux devices. The only real
1886 * motiviation here is to solve the chicken-and-egg problem of probe
1887 * ordering. The bridge wants the panel to be there when it probes.
1888 * The panel wants its HPD GPIO (provided by sn65dsi86 on some boards)
1889 * when it probes. The panel and maybe backlight might want the DDC
1890 * bus or the pwm_chip. Having sub-devices allows the some sub devices
1891 * to finish probing even if others return -EPROBE_DEFER and gets us
1892 * around the problems.
1895 if (IS_ENABLED(CONFIG_OF_GPIO)) {
1896 ret = ti_sn65dsi86_add_aux_device(pdata, &pdata->gpio_aux, "gpio");
1901 if (IS_ENABLED(CONFIG_PWM)) {
1902 ret = ti_sn65dsi86_add_aux_device(pdata, &pdata->pwm_aux, "pwm");
1908 * NOTE: At the end of the AUX channel probe we'll add the aux device
1909 * for the bridge. This is because the bridge can't be used until the
1910 * AUX channel is there and this is a very simple solution to the
1911 * dependency problem.
1913 return ti_sn65dsi86_add_aux_device(pdata, &pdata->aux_aux, "aux");
1916 static struct i2c_device_id ti_sn65dsi86_id[] = {
1917 { "ti,sn65dsi86", 0},
1920 MODULE_DEVICE_TABLE(i2c, ti_sn65dsi86_id);
1922 static const struct of_device_id ti_sn65dsi86_match_table[] = {
1923 {.compatible = "ti,sn65dsi86"},
1926 MODULE_DEVICE_TABLE(of, ti_sn65dsi86_match_table);
1928 static struct i2c_driver ti_sn65dsi86_driver = {
1930 .name = "ti_sn65dsi86",
1931 .of_match_table = ti_sn65dsi86_match_table,
1932 .pm = &ti_sn65dsi86_pm_ops,
1934 .probe = ti_sn65dsi86_probe,
1935 .id_table = ti_sn65dsi86_id,
1938 static int __init ti_sn65dsi86_init(void)
1942 ret = i2c_add_driver(&ti_sn65dsi86_driver);
1946 ret = ti_sn_gpio_register();
1948 goto err_main_was_registered;
1950 ret = ti_sn_pwm_register();
1952 goto err_gpio_was_registered;
1954 ret = auxiliary_driver_register(&ti_sn_aux_driver);
1956 goto err_pwm_was_registered;
1958 ret = auxiliary_driver_register(&ti_sn_bridge_driver);
1960 goto err_aux_was_registered;
1964 err_aux_was_registered:
1965 auxiliary_driver_unregister(&ti_sn_aux_driver);
1966 err_pwm_was_registered:
1967 ti_sn_pwm_unregister();
1968 err_gpio_was_registered:
1969 ti_sn_gpio_unregister();
1970 err_main_was_registered:
1971 i2c_del_driver(&ti_sn65dsi86_driver);
1975 module_init(ti_sn65dsi86_init);
1977 static void __exit ti_sn65dsi86_exit(void)
1979 auxiliary_driver_unregister(&ti_sn_bridge_driver);
1980 auxiliary_driver_unregister(&ti_sn_aux_driver);
1981 ti_sn_pwm_unregister();
1982 ti_sn_gpio_unregister();
1983 i2c_del_driver(&ti_sn65dsi86_driver);
1985 module_exit(ti_sn65dsi86_exit);
1987 MODULE_AUTHOR("Sandeep Panda <spanda@codeaurora.org>");
1988 MODULE_DESCRIPTION("sn65dsi86 DSI to eDP bridge driver");
1989 MODULE_LICENSE("GPL v2");