1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (c) 2016 MediaTek Inc.
6 #include <linux/delay.h>
8 #include <linux/gpio/consumer.h>
10 #include <linux/module.h>
11 #include <linux/of_graph.h>
12 #include <linux/pm_runtime.h>
13 #include <linux/regmap.h>
14 #include <linux/regulator/consumer.h>
16 #include <drm/display/drm_dp_aux_bus.h>
17 #include <drm/display/drm_dp_helper.h>
18 #include <drm/drm_bridge.h>
19 #include <drm/drm_mipi_dsi.h>
20 #include <drm/drm_of.h>
21 #include <drm/drm_panel.h>
22 #include <drm/drm_print.h>
24 #define PAGE0_AUXCH_CFG3 0x76
25 #define AUXCH_CFG3_RESET 0xff
26 #define PAGE0_SWAUX_ADDR_7_0 0x7d
27 #define PAGE0_SWAUX_ADDR_15_8 0x7e
28 #define PAGE0_SWAUX_ADDR_23_16 0x7f
29 #define SWAUX_ADDR_MASK GENMASK(19, 0)
30 #define PAGE0_SWAUX_LENGTH 0x80
31 #define SWAUX_LENGTH_MASK GENMASK(3, 0)
32 #define SWAUX_NO_PAYLOAD BIT(7)
33 #define PAGE0_SWAUX_WDATA 0x81
34 #define PAGE0_SWAUX_RDATA 0x82
35 #define PAGE0_SWAUX_CTRL 0x83
36 #define SWAUX_SEND BIT(0)
37 #define PAGE0_SWAUX_STATUS 0x84
38 #define SWAUX_M_MASK GENMASK(4, 0)
39 #define SWAUX_STATUS_MASK GENMASK(7, 5)
40 #define SWAUX_STATUS_NACK (0x1 << 5)
41 #define SWAUX_STATUS_DEFER (0x2 << 5)
42 #define SWAUX_STATUS_ACKM (0x3 << 5)
43 #define SWAUX_STATUS_INVALID (0x4 << 5)
44 #define SWAUX_STATUS_I2C_NACK (0x5 << 5)
45 #define SWAUX_STATUS_I2C_DEFER (0x6 << 5)
46 #define SWAUX_STATUS_TIMEOUT (0x7 << 5)
48 #define PAGE2_GPIO_H 0xa7
49 #define PS_GPIO9 BIT(1)
50 #define PAGE2_I2C_BYPASS 0xea
51 #define I2C_BYPASS_EN 0xd0
52 #define PAGE2_MCS_EN 0xf3
55 #define PAGE3_SET_ADD 0xfe
56 #define VDO_CTL_ADD 0x13
60 #define NUM_MIPI_LANES 4
62 #define COMMON_PS8640_REGMAP_CONFIG \
65 .cache_type = REGCACHE_NONE
68 * PS8640 uses multiple addresses:
69 * page[0]: for DP control
70 * page[1]: for VIDEO Bridge
71 * page[2]: for control top
72 * page[3]: for DSI Link Control1
73 * page[4]: for MIPI Phy
75 * page[6]: for DSI Link Control2
76 * page[7]: for SPI ROM mapping
78 enum page_addr_offset {
90 enum ps8640_vdo_control {
96 struct drm_bridge bridge;
97 struct drm_bridge *panel_bridge;
98 struct drm_dp_aux aux;
99 struct mipi_dsi_device *dsi;
100 struct i2c_client *page[MAX_DEVS];
101 struct regmap *regmap[MAX_DEVS];
102 struct regulator_bulk_data supplies[2];
103 struct gpio_desc *gpio_reset;
104 struct gpio_desc *gpio_powerdown;
105 struct device_link *link;
109 static const struct regmap_config ps8640_regmap_config[] = {
111 COMMON_PS8640_REGMAP_CONFIG,
112 .max_register = 0xbf,
115 COMMON_PS8640_REGMAP_CONFIG,
116 .max_register = 0xff,
119 COMMON_PS8640_REGMAP_CONFIG,
120 .max_register = 0xff,
122 [PAGE3_DSI_CNTL1] = {
123 COMMON_PS8640_REGMAP_CONFIG,
124 .max_register = 0xff,
127 COMMON_PS8640_REGMAP_CONFIG,
128 .max_register = 0xff,
131 COMMON_PS8640_REGMAP_CONFIG,
132 .max_register = 0x7f,
134 [PAGE6_DSI_CNTL2] = {
135 COMMON_PS8640_REGMAP_CONFIG,
136 .max_register = 0xff,
139 COMMON_PS8640_REGMAP_CONFIG,
140 .max_register = 0xff,
144 static inline struct ps8640 *bridge_to_ps8640(struct drm_bridge *e)
146 return container_of(e, struct ps8640, bridge);
149 static inline struct ps8640 *aux_to_ps8640(struct drm_dp_aux *aux)
151 return container_of(aux, struct ps8640, aux);
154 static bool ps8640_of_panel_on_aux_bus(struct device *dev)
156 struct device_node *bus, *panel;
158 bus = of_get_child_by_name(dev->of_node, "aux-bus");
162 panel = of_get_child_by_name(bus, "panel");
171 static int ps8640_ensure_hpd(struct ps8640 *ps_bridge)
173 struct regmap *map = ps_bridge->regmap[PAGE2_TOP_CNTL];
174 struct device *dev = &ps_bridge->page[PAGE2_TOP_CNTL]->dev;
179 * Apparently something about the firmware in the chip signals that
180 * HPD goes high by reporting GPIO9 as high (even though HPD isn't
181 * actually connected to GPIO9).
183 ret = regmap_read_poll_timeout(map, PAGE2_GPIO_H, status,
184 status & PS_GPIO9, 20 * 1000, 200 * 1000);
187 dev_warn(dev, "HPD didn't go high: %d\n", ret);
192 static ssize_t ps8640_aux_transfer_msg(struct drm_dp_aux *aux,
193 struct drm_dp_aux_msg *msg)
195 struct ps8640 *ps_bridge = aux_to_ps8640(aux);
196 struct regmap *map = ps_bridge->regmap[PAGE0_DP_CNTL];
197 struct device *dev = &ps_bridge->page[PAGE0_DP_CNTL]->dev;
198 unsigned int len = msg->size;
202 u8 request = msg->request &
203 ~(DP_AUX_I2C_MOT | DP_AUX_I2C_WRITE_STATUS_UPDATE);
204 u8 *buf = msg->buffer;
205 u8 addr_len[PAGE0_SWAUX_LENGTH + 1 - PAGE0_SWAUX_ADDR_7_0];
207 bool is_native_aux = false;
209 if (len > DP_AUX_MAX_PAYLOAD_BYTES)
212 if (msg->address & ~SWAUX_ADDR_MASK)
216 case DP_AUX_NATIVE_WRITE:
217 case DP_AUX_NATIVE_READ:
218 is_native_aux = true;
220 case DP_AUX_I2C_WRITE:
221 case DP_AUX_I2C_READ:
227 ret = regmap_write(map, PAGE0_AUXCH_CFG3, AUXCH_CFG3_RESET);
229 DRM_DEV_ERROR(dev, "failed to write PAGE0_AUXCH_CFG3: %d\n",
234 /* Assume it's good */
237 base = PAGE0_SWAUX_ADDR_7_0;
238 addr_len[PAGE0_SWAUX_ADDR_7_0 - base] = msg->address;
239 addr_len[PAGE0_SWAUX_ADDR_15_8 - base] = msg->address >> 8;
240 addr_len[PAGE0_SWAUX_ADDR_23_16 - base] = (msg->address >> 16) |
242 addr_len[PAGE0_SWAUX_LENGTH - base] = (len == 0) ? SWAUX_NO_PAYLOAD :
243 ((len - 1) & SWAUX_LENGTH_MASK);
245 regmap_bulk_write(map, PAGE0_SWAUX_ADDR_7_0, addr_len,
246 ARRAY_SIZE(addr_len));
248 if (len && (request == DP_AUX_NATIVE_WRITE ||
249 request == DP_AUX_I2C_WRITE)) {
250 /* Write to the internal FIFO buffer */
251 for (i = 0; i < len; i++) {
252 ret = regmap_write(map, PAGE0_SWAUX_WDATA, buf[i]);
255 "failed to write WDATA: %d\n",
262 regmap_write(map, PAGE0_SWAUX_CTRL, SWAUX_SEND);
264 /* Zero delay loop because i2c transactions are slow already */
265 regmap_read_poll_timeout(map, PAGE0_SWAUX_CTRL, data,
266 !(data & SWAUX_SEND), 0, 50 * 1000);
268 regmap_read(map, PAGE0_SWAUX_STATUS, &data);
270 DRM_DEV_ERROR(dev, "failed to read PAGE0_SWAUX_STATUS: %d\n",
275 switch (data & SWAUX_STATUS_MASK) {
276 /* Ignore the DEFER cases as they are already handled in hardware */
277 case SWAUX_STATUS_NACK:
278 case SWAUX_STATUS_I2C_NACK:
280 * The programming guide is not clear about whether a I2C NACK
281 * would trigger SWAUX_STATUS_NACK or SWAUX_STATUS_I2C_NACK. So
282 * we handle both cases together.
285 msg->reply |= DP_AUX_NATIVE_REPLY_NACK;
287 msg->reply |= DP_AUX_I2C_REPLY_NACK;
290 case SWAUX_STATUS_ACKM:
291 len = data & SWAUX_M_MASK;
293 case SWAUX_STATUS_INVALID:
295 case SWAUX_STATUS_TIMEOUT:
299 if (len && (request == DP_AUX_NATIVE_READ ||
300 request == DP_AUX_I2C_READ)) {
301 /* Read from the internal FIFO buffer */
302 for (i = 0; i < len; i++) {
303 ret = regmap_read(map, PAGE0_SWAUX_RDATA, &data);
306 "failed to read RDATA: %d\n",
318 static ssize_t ps8640_aux_transfer(struct drm_dp_aux *aux,
319 struct drm_dp_aux_msg *msg)
321 struct ps8640 *ps_bridge = aux_to_ps8640(aux);
322 struct device *dev = &ps_bridge->page[PAGE0_DP_CNTL]->dev;
325 pm_runtime_get_sync(dev);
326 ret = ps8640_ensure_hpd(ps_bridge);
328 ret = ps8640_aux_transfer_msg(aux, msg);
329 pm_runtime_mark_last_busy(dev);
330 pm_runtime_put_autosuspend(dev);
335 static void ps8640_bridge_vdo_control(struct ps8640 *ps_bridge,
336 const enum ps8640_vdo_control ctrl)
338 struct regmap *map = ps_bridge->regmap[PAGE3_DSI_CNTL1];
339 struct device *dev = &ps_bridge->page[PAGE3_DSI_CNTL1]->dev;
340 u8 vdo_ctrl_buf[] = { VDO_CTL_ADD, ctrl };
343 ret = regmap_bulk_write(map, PAGE3_SET_ADD,
344 vdo_ctrl_buf, sizeof(vdo_ctrl_buf));
347 dev_err(dev, "failed to %sable VDO: %d\n",
348 ctrl == ENABLE ? "en" : "dis", ret);
351 static int __maybe_unused ps8640_resume(struct device *dev)
353 struct ps8640 *ps_bridge = dev_get_drvdata(dev);
356 ret = regulator_bulk_enable(ARRAY_SIZE(ps_bridge->supplies),
357 ps_bridge->supplies);
359 dev_err(dev, "cannot enable regulators %d\n", ret);
363 gpiod_set_value(ps_bridge->gpio_powerdown, 0);
364 gpiod_set_value(ps_bridge->gpio_reset, 1);
365 usleep_range(2000, 2500);
366 gpiod_set_value(ps_bridge->gpio_reset, 0);
369 * Mystery 200 ms delay for the "MCU to be ready". It's unclear if
370 * this is truly necessary since the MCU will already signal that
371 * things are "good to go" by signaling HPD on "gpio 9". See
372 * ps8640_ensure_hpd(). For now we'll keep this mystery delay just in
380 static int __maybe_unused ps8640_suspend(struct device *dev)
382 struct ps8640 *ps_bridge = dev_get_drvdata(dev);
385 gpiod_set_value(ps_bridge->gpio_reset, 1);
386 gpiod_set_value(ps_bridge->gpio_powerdown, 1);
387 ret = regulator_bulk_disable(ARRAY_SIZE(ps_bridge->supplies),
388 ps_bridge->supplies);
390 dev_err(dev, "cannot disable regulators %d\n", ret);
395 static const struct dev_pm_ops ps8640_pm_ops = {
396 SET_RUNTIME_PM_OPS(ps8640_suspend, ps8640_resume, NULL)
397 SET_SYSTEM_SLEEP_PM_OPS(pm_runtime_force_suspend,
398 pm_runtime_force_resume)
401 static void ps8640_pre_enable(struct drm_bridge *bridge)
403 struct ps8640 *ps_bridge = bridge_to_ps8640(bridge);
404 struct regmap *map = ps_bridge->regmap[PAGE2_TOP_CNTL];
405 struct device *dev = &ps_bridge->page[PAGE0_DP_CNTL]->dev;
408 pm_runtime_get_sync(dev);
409 ps8640_ensure_hpd(ps_bridge);
412 * The Manufacturer Command Set (MCS) is a device dependent interface
413 * intended for factory programming of the display module default
414 * parameters. Once the display module is configured, the MCS shall be
415 * disabled by the manufacturer. Once disabled, all MCS commands are
416 * ignored by the display interface.
419 ret = regmap_update_bits(map, PAGE2_MCS_EN, MCS_EN, 0);
421 dev_warn(dev, "failed write PAGE2_MCS_EN: %d\n", ret);
423 /* Switch access edp panel's edid through i2c */
424 ret = regmap_write(map, PAGE2_I2C_BYPASS, I2C_BYPASS_EN);
426 dev_warn(dev, "failed write PAGE2_MCS_EN: %d\n", ret);
428 ps8640_bridge_vdo_control(ps_bridge, ENABLE);
430 ps_bridge->pre_enabled = true;
433 static void ps8640_post_disable(struct drm_bridge *bridge)
435 struct ps8640 *ps_bridge = bridge_to_ps8640(bridge);
437 ps_bridge->pre_enabled = false;
439 ps8640_bridge_vdo_control(ps_bridge, DISABLE);
440 pm_runtime_put_sync_suspend(&ps_bridge->page[PAGE0_DP_CNTL]->dev);
443 static int ps8640_bridge_attach(struct drm_bridge *bridge,
444 enum drm_bridge_attach_flags flags)
446 struct ps8640 *ps_bridge = bridge_to_ps8640(bridge);
447 struct device *dev = &ps_bridge->page[0]->dev;
450 if (!(flags & DRM_BRIDGE_ATTACH_NO_CONNECTOR))
453 ps_bridge->aux.drm_dev = bridge->dev;
454 ret = drm_dp_aux_register(&ps_bridge->aux);
456 dev_err(dev, "failed to register DP AUX channel: %d\n", ret);
460 ps_bridge->link = device_link_add(bridge->dev->dev, dev, DL_FLAG_STATELESS);
461 if (!ps_bridge->link) {
462 dev_err(dev, "failed to create device link");
467 /* Attach the panel-bridge to the dsi bridge */
468 ret = drm_bridge_attach(bridge->encoder, ps_bridge->panel_bridge,
469 &ps_bridge->bridge, flags);
471 goto err_bridge_attach;
476 device_link_del(ps_bridge->link);
478 drm_dp_aux_unregister(&ps_bridge->aux);
483 static void ps8640_bridge_detach(struct drm_bridge *bridge)
485 struct ps8640 *ps_bridge = bridge_to_ps8640(bridge);
487 drm_dp_aux_unregister(&ps_bridge->aux);
489 device_link_del(ps_bridge->link);
492 static struct edid *ps8640_bridge_get_edid(struct drm_bridge *bridge,
493 struct drm_connector *connector)
495 struct ps8640 *ps_bridge = bridge_to_ps8640(bridge);
496 bool poweroff = !ps_bridge->pre_enabled;
500 * When we end calling get_edid() triggered by an ioctl, i.e
502 * drm_mode_getconnector (ioctl)
503 * -> drm_helper_probe_single_connector_modes
504 * -> drm_bridge_connector_get_modes
505 * -> ps8640_bridge_get_edid
507 * We need to make sure that what we need is enabled before reading
508 * EDID, for this chip, we need to do a full poweron, otherwise it will
511 drm_bridge_chain_pre_enable(bridge);
513 edid = drm_get_edid(connector,
514 ps_bridge->page[PAGE0_DP_CNTL]->adapter);
517 * If we call the get_edid() function without having enabled the chip
518 * before, return the chip to its original power state.
521 drm_bridge_chain_post_disable(bridge);
526 static void ps8640_runtime_disable(void *data)
528 pm_runtime_dont_use_autosuspend(data);
529 pm_runtime_disable(data);
532 static const struct drm_bridge_funcs ps8640_bridge_funcs = {
533 .attach = ps8640_bridge_attach,
534 .detach = ps8640_bridge_detach,
535 .get_edid = ps8640_bridge_get_edid,
536 .post_disable = ps8640_post_disable,
537 .pre_enable = ps8640_pre_enable,
540 static int ps8640_bridge_host_attach(struct device *dev, struct ps8640 *ps_bridge)
542 struct device_node *in_ep, *dsi_node;
543 struct mipi_dsi_device *dsi;
544 struct mipi_dsi_host *host;
546 const struct mipi_dsi_device_info info = { .type = "ps8640",
551 /* port@0 is ps8640 dsi input port */
552 in_ep = of_graph_get_endpoint_by_regs(dev->of_node, 0, -1);
556 dsi_node = of_graph_get_remote_port_parent(in_ep);
561 host = of_find_mipi_dsi_host_by_node(dsi_node);
562 of_node_put(dsi_node);
564 return -EPROBE_DEFER;
566 dsi = devm_mipi_dsi_device_register_full(dev, host, &info);
568 dev_err(dev, "failed to create dsi device\n");
572 ps_bridge->dsi = dsi;
575 dsi->mode_flags = MIPI_DSI_MODE_VIDEO |
576 MIPI_DSI_MODE_VIDEO_SYNC_PULSE;
577 dsi->format = MIPI_DSI_FMT_RGB888;
578 dsi->lanes = NUM_MIPI_LANES;
580 ret = devm_mipi_dsi_attach(dev, dsi);
587 static int ps8640_probe(struct i2c_client *client)
589 struct device *dev = &client->dev;
590 struct device_node *np = dev->of_node;
591 struct ps8640 *ps_bridge;
595 ps_bridge = devm_kzalloc(dev, sizeof(*ps_bridge), GFP_KERNEL);
599 ps_bridge->supplies[0].supply = "vdd33";
600 ps_bridge->supplies[1].supply = "vdd12";
601 ret = devm_regulator_bulk_get(dev, ARRAY_SIZE(ps_bridge->supplies),
602 ps_bridge->supplies);
606 ps_bridge->gpio_powerdown = devm_gpiod_get(&client->dev, "powerdown",
608 if (IS_ERR(ps_bridge->gpio_powerdown))
609 return PTR_ERR(ps_bridge->gpio_powerdown);
612 * Assert the reset to avoid the bridge being initialized prematurely
614 ps_bridge->gpio_reset = devm_gpiod_get(&client->dev, "reset",
616 if (IS_ERR(ps_bridge->gpio_reset))
617 return PTR_ERR(ps_bridge->gpio_reset);
619 ps_bridge->bridge.funcs = &ps8640_bridge_funcs;
620 ps_bridge->bridge.of_node = dev->of_node;
621 ps_bridge->bridge.type = DRM_MODE_CONNECTOR_eDP;
624 * In the device tree, if panel is listed under aux-bus of the bridge
625 * node, panel driver should be able to retrieve EDID by itself using
626 * aux-bus. So let's not set DRM_BRIDGE_OP_EDID here.
628 if (!ps8640_of_panel_on_aux_bus(&client->dev))
629 ps_bridge->bridge.ops = DRM_BRIDGE_OP_EDID;
631 ps_bridge->page[PAGE0_DP_CNTL] = client;
633 ps_bridge->regmap[PAGE0_DP_CNTL] = devm_regmap_init_i2c(client, ps8640_regmap_config);
634 if (IS_ERR(ps_bridge->regmap[PAGE0_DP_CNTL]))
635 return PTR_ERR(ps_bridge->regmap[PAGE0_DP_CNTL]);
637 for (i = 1; i < ARRAY_SIZE(ps_bridge->page); i++) {
638 ps_bridge->page[i] = devm_i2c_new_dummy_device(&client->dev,
641 if (IS_ERR(ps_bridge->page[i]))
642 return PTR_ERR(ps_bridge->page[i]);
644 ps_bridge->regmap[i] = devm_regmap_init_i2c(ps_bridge->page[i],
645 ps8640_regmap_config + i);
646 if (IS_ERR(ps_bridge->regmap[i]))
647 return PTR_ERR(ps_bridge->regmap[i]);
650 i2c_set_clientdata(client, ps_bridge);
652 ps_bridge->aux.name = "parade-ps8640-aux";
653 ps_bridge->aux.dev = dev;
654 ps_bridge->aux.transfer = ps8640_aux_transfer;
655 drm_dp_aux_init(&ps_bridge->aux);
657 pm_runtime_enable(dev);
659 * Powering on ps8640 takes ~300ms. To avoid wasting time on power
660 * cycling ps8640 too often, set autosuspend_delay to 1000ms to ensure
661 * the bridge wouldn't suspend in between each _aux_transfer_msg() call
662 * during EDID read (~20ms in my experiment) and in between the last
663 * _aux_transfer_msg() call during EDID read and the _pre_enable() call
664 * (~100ms in my experiment).
666 pm_runtime_set_autosuspend_delay(dev, 1000);
667 pm_runtime_use_autosuspend(dev);
668 pm_suspend_ignore_children(dev, true);
669 ret = devm_add_action_or_reset(dev, ps8640_runtime_disable, dev);
673 devm_of_dp_aux_populate_ep_devices(&ps_bridge->aux);
675 /* port@1 is ps8640 output port */
676 ps_bridge->panel_bridge = devm_drm_of_get_bridge(dev, np, 1, 0);
677 if (IS_ERR(ps_bridge->panel_bridge))
678 return PTR_ERR(ps_bridge->panel_bridge);
680 drm_bridge_add(&ps_bridge->bridge);
682 ret = ps8640_bridge_host_attach(dev, ps_bridge);
684 goto err_bridge_remove;
689 drm_bridge_remove(&ps_bridge->bridge);
693 static int ps8640_remove(struct i2c_client *client)
695 struct ps8640 *ps_bridge = i2c_get_clientdata(client);
697 drm_bridge_remove(&ps_bridge->bridge);
702 static const struct of_device_id ps8640_match[] = {
703 { .compatible = "parade,ps8640" },
706 MODULE_DEVICE_TABLE(of, ps8640_match);
708 static struct i2c_driver ps8640_driver = {
709 .probe_new = ps8640_probe,
710 .remove = ps8640_remove,
713 .of_match_table = ps8640_match,
714 .pm = &ps8640_pm_ops,
717 module_i2c_driver(ps8640_driver);
719 MODULE_AUTHOR("Jitao Shi <jitao.shi@mediatek.com>");
720 MODULE_AUTHOR("CK Hu <ck.hu@mediatek.com>");
721 MODULE_AUTHOR("Enric Balletbo i Serra <enric.balletbo@collabora.com>");
722 MODULE_DESCRIPTION("PARADE ps8640 DSI-eDP converter driver");
723 MODULE_LICENSE("GPL v2");