1 // SPDX-License-Identifier: GPL-2.0+
3 * i.MX8 NWL MIPI DSI host driver
5 * Copyright (C) 2017 NXP
6 * Copyright (C) 2020 Purism SPC
9 #include <linux/bitfield.h>
10 #include <linux/clk.h>
11 #include <linux/irq.h>
12 #include <linux/math64.h>
13 #include <linux/mfd/syscon.h>
14 #include <linux/module.h>
15 #include <linux/mux/consumer.h>
17 #include <linux/of_platform.h>
18 #include <linux/phy/phy.h>
19 #include <linux/regmap.h>
20 #include <linux/reset.h>
21 #include <linux/sys_soc.h>
22 #include <linux/time64.h>
24 #include <drm/drm_atomic_state_helper.h>
25 #include <drm/drm_bridge.h>
26 #include <drm/drm_mipi_dsi.h>
27 #include <drm/drm_of.h>
28 #include <drm/drm_panel.h>
29 #include <drm/drm_print.h>
31 #include <video/mipi_display.h>
35 #define DRV_NAME "nwl-dsi"
37 /* i.MX8 NWL quirks */
38 /* i.MX8MQ errata E11418 */
39 #define E11418_HS_MODE_QUIRK BIT(0)
41 #define NWL_DSI_MIPI_FIFO_TIMEOUT msecs_to_jiffies(500)
43 enum transfer_direction {
48 #define NWL_DSI_ENDPOINT_LCDIF 0
49 #define NWL_DSI_ENDPOINT_DCSS 1
51 struct nwl_dsi_transfer {
52 const struct mipi_dsi_msg *msg;
53 struct mipi_dsi_packet packet;
54 struct completion completed;
56 int status; /* status of transmission */
57 enum transfer_direction direction;
61 size_t tx_len; /* in bytes */
62 size_t rx_len; /* in bytes */
66 struct drm_bridge bridge;
67 struct mipi_dsi_host dsi_host;
68 struct drm_bridge *panel_bridge;
71 union phy_configure_opts phy_cfg;
74 struct regmap *regmap;
77 * The DSI host controller needs this reset sequence according to NWL:
78 * 1. Deassert pclk reset to get access to DSI regs
79 * 2. Configure DSI Host and DPHY and enable DPHY
80 * 3. Deassert ESC and BYTE resets to allow host TX operations)
81 * 4. Send DSI cmds to configure peripheral (handled by panel drv)
82 * 5. Deassert DPI reset so DPI receives pixels and starts sending
85 * TODO: Since panel_bridges do their DSI setup in enable we
86 * currently have 4. and 5. swapped.
88 struct reset_control *rst_byte;
89 struct reset_control *rst_esc;
90 struct reset_control *rst_dpi;
91 struct reset_control *rst_pclk;
92 struct mux_control *mux;
95 struct clk *phy_ref_clk;
96 struct clk *rx_esc_clk;
97 struct clk *tx_esc_clk;
100 * hardware bug: the i.MX8MQ needs this clock on during reset
101 * even when not using LCDIF.
103 struct clk *lcdif_clk;
107 enum mipi_dsi_pixel_format format;
108 struct drm_display_mode mode;
109 unsigned long dsi_mode_flags;
112 struct nwl_dsi_transfer *xfer;
115 static const struct regmap_config nwl_dsi_regmap_config = {
119 .max_register = NWL_DSI_IRQ_MASK2,
123 static inline struct nwl_dsi *bridge_to_dsi(struct drm_bridge *bridge)
125 return container_of(bridge, struct nwl_dsi, bridge);
128 static int nwl_dsi_clear_error(struct nwl_dsi *dsi)
130 int ret = dsi->error;
136 static void nwl_dsi_write(struct nwl_dsi *dsi, unsigned int reg, u32 val)
143 ret = regmap_write(dsi->regmap, reg, val);
145 DRM_DEV_ERROR(dsi->dev,
146 "Failed to write NWL DSI reg 0x%x: %d\n", reg,
152 static u32 nwl_dsi_read(struct nwl_dsi *dsi, u32 reg)
160 ret = regmap_read(dsi->regmap, reg, &val);
162 DRM_DEV_ERROR(dsi->dev, "Failed to read NWL DSI reg 0x%x: %d\n",
169 static int nwl_dsi_get_dpi_pixel_format(enum mipi_dsi_pixel_format format)
172 case MIPI_DSI_FMT_RGB565:
173 return NWL_DSI_PIXEL_FORMAT_16;
174 case MIPI_DSI_FMT_RGB666:
175 return NWL_DSI_PIXEL_FORMAT_18L;
176 case MIPI_DSI_FMT_RGB666_PACKED:
177 return NWL_DSI_PIXEL_FORMAT_18;
178 case MIPI_DSI_FMT_RGB888:
179 return NWL_DSI_PIXEL_FORMAT_24;
186 * ps2bc - Picoseconds to byte clock cycles
188 static u32 ps2bc(struct nwl_dsi *dsi, unsigned long long ps)
190 u32 bpp = mipi_dsi_pixel_format_to_bpp(dsi->format);
192 return DIV64_U64_ROUND_UP(ps * dsi->mode.clock * bpp,
193 dsi->lanes * 8ULL * NSEC_PER_SEC);
197 * ui2bc - UI time periods to byte clock cycles
199 static u32 ui2bc(struct nwl_dsi *dsi, unsigned long long ui)
201 u32 bpp = mipi_dsi_pixel_format_to_bpp(dsi->format);
203 return DIV64_U64_ROUND_UP(ui * dsi->lanes,
204 dsi->mode.clock * 1000 * bpp);
208 * us2bc - micro seconds to lp clock cycles
210 static u32 us2lp(u32 lp_clk_rate, unsigned long us)
212 return DIV_ROUND_UP(us * lp_clk_rate, USEC_PER_SEC);
215 static int nwl_dsi_config_host(struct nwl_dsi *dsi)
218 struct phy_configure_opts_mipi_dphy *cfg = &dsi->phy_cfg.mipi_dphy;
220 if (dsi->lanes < 1 || dsi->lanes > 4)
223 DRM_DEV_DEBUG_DRIVER(dsi->dev, "DSI Lanes %d\n", dsi->lanes);
224 nwl_dsi_write(dsi, NWL_DSI_CFG_NUM_LANES, dsi->lanes - 1);
226 if (dsi->dsi_mode_flags & MIPI_DSI_CLOCK_NON_CONTINUOUS) {
227 nwl_dsi_write(dsi, NWL_DSI_CFG_NONCONTINUOUS_CLK, 0x01);
228 nwl_dsi_write(dsi, NWL_DSI_CFG_AUTOINSERT_EOTP, 0x01);
230 nwl_dsi_write(dsi, NWL_DSI_CFG_NONCONTINUOUS_CLK, 0x00);
231 nwl_dsi_write(dsi, NWL_DSI_CFG_AUTOINSERT_EOTP, 0x00);
234 /* values in byte clock cycles */
235 cycles = ui2bc(dsi, cfg->clk_pre);
236 DRM_DEV_DEBUG_DRIVER(dsi->dev, "cfg_t_pre: 0x%x\n", cycles);
237 nwl_dsi_write(dsi, NWL_DSI_CFG_T_PRE, cycles);
238 cycles = ps2bc(dsi, cfg->lpx + cfg->clk_prepare + cfg->clk_zero);
239 DRM_DEV_DEBUG_DRIVER(dsi->dev, "cfg_tx_gap (pre): 0x%x\n", cycles);
240 cycles += ui2bc(dsi, cfg->clk_pre);
241 DRM_DEV_DEBUG_DRIVER(dsi->dev, "cfg_t_post: 0x%x\n", cycles);
242 nwl_dsi_write(dsi, NWL_DSI_CFG_T_POST, cycles);
243 cycles = ps2bc(dsi, cfg->hs_exit);
244 DRM_DEV_DEBUG_DRIVER(dsi->dev, "cfg_tx_gap: 0x%x\n", cycles);
245 nwl_dsi_write(dsi, NWL_DSI_CFG_TX_GAP, cycles);
247 nwl_dsi_write(dsi, NWL_DSI_CFG_EXTRA_CMDS_AFTER_EOTP, 0x01);
248 nwl_dsi_write(dsi, NWL_DSI_CFG_HTX_TO_COUNT, 0x00);
249 nwl_dsi_write(dsi, NWL_DSI_CFG_LRX_H_TO_COUNT, 0x00);
250 nwl_dsi_write(dsi, NWL_DSI_CFG_BTA_H_TO_COUNT, 0x00);
251 /* In LP clock cycles */
252 cycles = us2lp(cfg->lp_clk_rate, cfg->wakeup);
253 DRM_DEV_DEBUG_DRIVER(dsi->dev, "cfg_twakeup: 0x%x\n", cycles);
254 nwl_dsi_write(dsi, NWL_DSI_CFG_TWAKEUP, cycles);
256 return nwl_dsi_clear_error(dsi);
259 static int nwl_dsi_config_dpi(struct nwl_dsi *dsi)
264 int hfront_porch, hback_porch, vfront_porch, vback_porch;
265 int hsync_len, vsync_len;
267 hfront_porch = dsi->mode.hsync_start - dsi->mode.hdisplay;
268 hsync_len = dsi->mode.hsync_end - dsi->mode.hsync_start;
269 hback_porch = dsi->mode.htotal - dsi->mode.hsync_end;
271 vfront_porch = dsi->mode.vsync_start - dsi->mode.vdisplay;
272 vsync_len = dsi->mode.vsync_end - dsi->mode.vsync_start;
273 vback_porch = dsi->mode.vtotal - dsi->mode.vsync_end;
275 DRM_DEV_DEBUG_DRIVER(dsi->dev, "hfront_porch = %d\n", hfront_porch);
276 DRM_DEV_DEBUG_DRIVER(dsi->dev, "hback_porch = %d\n", hback_porch);
277 DRM_DEV_DEBUG_DRIVER(dsi->dev, "hsync_len = %d\n", hsync_len);
278 DRM_DEV_DEBUG_DRIVER(dsi->dev, "hdisplay = %d\n", dsi->mode.hdisplay);
279 DRM_DEV_DEBUG_DRIVER(dsi->dev, "vfront_porch = %d\n", vfront_porch);
280 DRM_DEV_DEBUG_DRIVER(dsi->dev, "vback_porch = %d\n", vback_porch);
281 DRM_DEV_DEBUG_DRIVER(dsi->dev, "vsync_len = %d\n", vsync_len);
282 DRM_DEV_DEBUG_DRIVER(dsi->dev, "vactive = %d\n", dsi->mode.vdisplay);
283 DRM_DEV_DEBUG_DRIVER(dsi->dev, "clock = %d kHz\n", dsi->mode.clock);
285 color_format = nwl_dsi_get_dpi_pixel_format(dsi->format);
286 if (color_format < 0) {
287 DRM_DEV_ERROR(dsi->dev, "Invalid color format 0x%x\n",
291 DRM_DEV_DEBUG_DRIVER(dsi->dev, "pixel fmt = %d\n", dsi->format);
293 nwl_dsi_write(dsi, NWL_DSI_INTERFACE_COLOR_CODING, NWL_DSI_DPI_24_BIT);
294 nwl_dsi_write(dsi, NWL_DSI_PIXEL_FORMAT, color_format);
296 * Adjusting input polarity based on the video mode results in
297 * a black screen so always pick active low:
299 nwl_dsi_write(dsi, NWL_DSI_VSYNC_POLARITY,
300 NWL_DSI_VSYNC_POLARITY_ACTIVE_LOW);
301 nwl_dsi_write(dsi, NWL_DSI_HSYNC_POLARITY,
302 NWL_DSI_HSYNC_POLARITY_ACTIVE_LOW);
304 burst_mode = (dsi->dsi_mode_flags & MIPI_DSI_MODE_VIDEO_BURST) &&
305 !(dsi->dsi_mode_flags & MIPI_DSI_MODE_VIDEO_SYNC_PULSE);
308 nwl_dsi_write(dsi, NWL_DSI_VIDEO_MODE, NWL_DSI_VM_BURST_MODE);
309 nwl_dsi_write(dsi, NWL_DSI_PIXEL_FIFO_SEND_LEVEL, 256);
311 mode = ((dsi->dsi_mode_flags & MIPI_DSI_MODE_VIDEO_SYNC_PULSE) ?
312 NWL_DSI_VM_BURST_MODE_WITH_SYNC_PULSES :
313 NWL_DSI_VM_NON_BURST_MODE_WITH_SYNC_EVENTS);
314 nwl_dsi_write(dsi, NWL_DSI_VIDEO_MODE, mode);
315 nwl_dsi_write(dsi, NWL_DSI_PIXEL_FIFO_SEND_LEVEL,
319 nwl_dsi_write(dsi, NWL_DSI_HFP, hfront_porch);
320 nwl_dsi_write(dsi, NWL_DSI_HBP, hback_porch);
321 nwl_dsi_write(dsi, NWL_DSI_HSA, hsync_len);
323 nwl_dsi_write(dsi, NWL_DSI_ENABLE_MULT_PKTS, 0x0);
324 nwl_dsi_write(dsi, NWL_DSI_BLLP_MODE, 0x1);
325 nwl_dsi_write(dsi, NWL_DSI_USE_NULL_PKT_BLLP, 0x0);
326 nwl_dsi_write(dsi, NWL_DSI_VC, 0x0);
328 nwl_dsi_write(dsi, NWL_DSI_PIXEL_PAYLOAD_SIZE, dsi->mode.hdisplay);
329 nwl_dsi_write(dsi, NWL_DSI_VACTIVE, dsi->mode.vdisplay - 1);
330 nwl_dsi_write(dsi, NWL_DSI_VBP, vback_porch);
331 nwl_dsi_write(dsi, NWL_DSI_VFP, vfront_porch);
333 return nwl_dsi_clear_error(dsi);
336 static int nwl_dsi_init_interrupts(struct nwl_dsi *dsi)
340 nwl_dsi_write(dsi, NWL_DSI_IRQ_MASK, 0xffffffff);
341 nwl_dsi_write(dsi, NWL_DSI_IRQ_MASK2, 0x7);
343 irq_enable = ~(u32)(NWL_DSI_TX_PKT_DONE_MASK |
344 NWL_DSI_RX_PKT_HDR_RCVD_MASK |
345 NWL_DSI_TX_FIFO_OVFLW_MASK |
346 NWL_DSI_HS_TX_TIMEOUT_MASK);
348 nwl_dsi_write(dsi, NWL_DSI_IRQ_MASK, irq_enable);
350 return nwl_dsi_clear_error(dsi);
353 static int nwl_dsi_host_attach(struct mipi_dsi_host *dsi_host,
354 struct mipi_dsi_device *device)
356 struct nwl_dsi *dsi = container_of(dsi_host, struct nwl_dsi, dsi_host);
357 struct device *dev = dsi->dev;
359 DRM_DEV_INFO(dev, "lanes=%u, format=0x%x flags=0x%lx\n", device->lanes,
360 device->format, device->mode_flags);
362 if (device->lanes < 1 || device->lanes > 4)
365 dsi->lanes = device->lanes;
366 dsi->format = device->format;
367 dsi->dsi_mode_flags = device->mode_flags;
372 static bool nwl_dsi_read_packet(struct nwl_dsi *dsi, u32 status)
374 struct device *dev = dsi->dev;
375 struct nwl_dsi_transfer *xfer = dsi->xfer;
377 u8 *payload = xfer->msg->rx_buf;
385 if (xfer->rx_word_count == 0) {
386 if (!(status & NWL_DSI_RX_PKT_HDR_RCVD))
388 /* Get the RX header and parse it */
389 val = nwl_dsi_read(dsi, NWL_DSI_RX_PKT_HEADER);
390 err = nwl_dsi_clear_error(dsi);
393 word_count = NWL_DSI_WC(val);
394 channel = NWL_DSI_RX_VC(val);
395 data_type = NWL_DSI_RX_DT(val);
397 if (channel != xfer->msg->channel) {
399 "[%02X] Channel mismatch (%u != %u)\n",
400 xfer->cmd, channel, xfer->msg->channel);
401 xfer->status = -EINVAL;
406 case MIPI_DSI_RX_GENERIC_SHORT_READ_RESPONSE_2BYTE:
407 case MIPI_DSI_RX_DCS_SHORT_READ_RESPONSE_2BYTE:
408 if (xfer->msg->rx_len > 1) {
409 /* read second byte */
410 payload[1] = word_count >> 8;
414 case MIPI_DSI_RX_GENERIC_SHORT_READ_RESPONSE_1BYTE:
415 case MIPI_DSI_RX_DCS_SHORT_READ_RESPONSE_1BYTE:
416 if (xfer->msg->rx_len > 0) {
417 /* read first byte */
418 payload[0] = word_count & 0xff;
421 xfer->status = xfer->rx_len;
423 case MIPI_DSI_RX_ACKNOWLEDGE_AND_ERROR_REPORT:
425 DRM_DEV_ERROR(dev, "[%02X] DSI error report: 0x%02x\n",
426 xfer->cmd, word_count);
427 xfer->status = -EPROTO;
431 if (word_count > xfer->msg->rx_len) {
433 "[%02X] Receive buffer too small: %zu (< %u)\n",
434 xfer->cmd, xfer->msg->rx_len, word_count);
435 xfer->status = -EINVAL;
439 xfer->rx_word_count = word_count;
441 /* Set word_count from previous header read */
442 word_count = xfer->rx_word_count;
445 /* If RX payload is not yet received, wait for it */
446 if (!(status & NWL_DSI_RX_PKT_PAYLOAD_DATA_RCVD))
449 /* Read the RX payload */
450 while (word_count >= 4) {
451 val = nwl_dsi_read(dsi, NWL_DSI_RX_PAYLOAD);
452 payload[0] = (val >> 0) & 0xff;
453 payload[1] = (val >> 8) & 0xff;
454 payload[2] = (val >> 16) & 0xff;
455 payload[3] = (val >> 24) & 0xff;
461 if (word_count > 0) {
462 val = nwl_dsi_read(dsi, NWL_DSI_RX_PAYLOAD);
463 switch (word_count) {
465 payload[2] = (val >> 16) & 0xff;
469 payload[1] = (val >> 8) & 0xff;
473 payload[0] = (val >> 0) & 0xff;
479 xfer->status = xfer->rx_len;
480 err = nwl_dsi_clear_error(dsi);
487 static void nwl_dsi_finish_transmission(struct nwl_dsi *dsi, u32 status)
489 struct nwl_dsi_transfer *xfer = dsi->xfer;
490 bool end_packet = false;
495 if (xfer->direction == DSI_PACKET_SEND &&
496 status & NWL_DSI_TX_PKT_DONE) {
497 xfer->status = xfer->tx_len;
499 } else if (status & NWL_DSI_DPHY_DIRECTION &&
500 ((status & (NWL_DSI_RX_PKT_HDR_RCVD |
501 NWL_DSI_RX_PKT_PAYLOAD_DATA_RCVD)))) {
502 end_packet = nwl_dsi_read_packet(dsi, status);
506 complete(&xfer->completed);
509 static void nwl_dsi_begin_transmission(struct nwl_dsi *dsi)
511 struct nwl_dsi_transfer *xfer = dsi->xfer;
512 struct mipi_dsi_packet *pkt = &xfer->packet;
518 u32 hs_workaround = 0;
520 /* Send the payload, if any */
521 length = pkt->payload_length;
522 payload = pkt->payload;
524 while (length >= 4) {
525 val = *(u32 *)payload;
526 hs_workaround |= !(val & 0xFFFF00);
527 nwl_dsi_write(dsi, NWL_DSI_TX_PAYLOAD, val);
531 /* Send the rest of the payload */
535 val |= payload[2] << 16;
538 val |= payload[1] << 8;
539 hs_workaround |= !(val & 0xFFFF00);
543 nwl_dsi_write(dsi, NWL_DSI_TX_PAYLOAD, val);
546 xfer->tx_len = pkt->payload_length;
550 * header[0] = Virtual Channel + Data Type
551 * header[1] = Word Count LSB (LP) or first param (SP)
552 * header[2] = Word Count MSB (LP) or second param (SP)
554 word_count = pkt->header[1] | (pkt->header[2] << 8);
555 if (hs_workaround && (dsi->quirks & E11418_HS_MODE_QUIRK)) {
556 DRM_DEV_DEBUG_DRIVER(dsi->dev,
557 "Using hs mode workaround for cmd 0x%x\n",
561 hs_mode = (xfer->msg->flags & MIPI_DSI_MSG_USE_LPM) ? 0 : 1;
563 val = NWL_DSI_WC(word_count) | NWL_DSI_TX_VC(xfer->msg->channel) |
564 NWL_DSI_TX_DT(xfer->msg->type) | NWL_DSI_HS_SEL(hs_mode) |
565 NWL_DSI_BTA_TX(xfer->need_bta);
566 nwl_dsi_write(dsi, NWL_DSI_PKT_CONTROL, val);
568 /* Send packet command */
569 nwl_dsi_write(dsi, NWL_DSI_SEND_PACKET, 0x1);
572 static ssize_t nwl_dsi_host_transfer(struct mipi_dsi_host *dsi_host,
573 const struct mipi_dsi_msg *msg)
575 struct nwl_dsi *dsi = container_of(dsi_host, struct nwl_dsi, dsi_host);
576 struct nwl_dsi_transfer xfer;
579 /* Create packet to be sent */
581 ret = mipi_dsi_create_packet(&xfer.packet, msg);
587 if ((msg->type & MIPI_DSI_GENERIC_READ_REQUEST_0_PARAM ||
588 msg->type & MIPI_DSI_GENERIC_READ_REQUEST_1_PARAM ||
589 msg->type & MIPI_DSI_GENERIC_READ_REQUEST_2_PARAM ||
590 msg->type & MIPI_DSI_DCS_READ) &&
591 msg->rx_len > 0 && msg->rx_buf)
592 xfer.direction = DSI_PACKET_RECEIVE;
594 xfer.direction = DSI_PACKET_SEND;
596 xfer.need_bta = (xfer.direction == DSI_PACKET_RECEIVE);
597 xfer.need_bta |= (msg->flags & MIPI_DSI_MSG_REQ_ACK) ? 1 : 0;
599 xfer.status = -ETIMEDOUT;
600 xfer.rx_word_count = 0;
604 xfer.cmd = ((u8 *)(msg->tx_buf))[0];
605 init_completion(&xfer.completed);
607 ret = clk_prepare_enable(dsi->rx_esc_clk);
609 DRM_DEV_ERROR(dsi->dev, "Failed to enable rx_esc clk: %zd\n",
613 DRM_DEV_DEBUG_DRIVER(dsi->dev, "Enabled rx_esc clk @%lu Hz\n",
614 clk_get_rate(dsi->rx_esc_clk));
616 /* Initiate the DSI packet transmision */
617 nwl_dsi_begin_transmission(dsi);
619 if (!wait_for_completion_timeout(&xfer.completed,
620 NWL_DSI_MIPI_FIFO_TIMEOUT)) {
621 DRM_DEV_ERROR(dsi_host->dev, "[%02X] DSI transfer timed out\n",
628 clk_disable_unprepare(dsi->rx_esc_clk);
633 static const struct mipi_dsi_host_ops nwl_dsi_host_ops = {
634 .attach = nwl_dsi_host_attach,
635 .transfer = nwl_dsi_host_transfer,
638 static irqreturn_t nwl_dsi_irq_handler(int irq, void *data)
641 struct nwl_dsi *dsi = data;
643 irq_status = nwl_dsi_read(dsi, NWL_DSI_IRQ_STATUS);
645 if (irq_status & NWL_DSI_TX_FIFO_OVFLW)
646 DRM_DEV_ERROR_RATELIMITED(dsi->dev, "tx fifo overflow\n");
648 if (irq_status & NWL_DSI_HS_TX_TIMEOUT)
649 DRM_DEV_ERROR_RATELIMITED(dsi->dev, "HS tx timeout\n");
651 if (irq_status & NWL_DSI_TX_PKT_DONE ||
652 irq_status & NWL_DSI_RX_PKT_HDR_RCVD ||
653 irq_status & NWL_DSI_RX_PKT_PAYLOAD_DATA_RCVD)
654 nwl_dsi_finish_transmission(dsi, irq_status);
659 static int nwl_dsi_mode_set(struct nwl_dsi *dsi)
661 struct device *dev = dsi->dev;
662 union phy_configure_opts *phy_cfg = &dsi->phy_cfg;
666 DRM_DEV_ERROR(dev, "Need DSI lanes: %d\n", dsi->lanes);
670 ret = phy_init(dsi->phy);
672 DRM_DEV_ERROR(dev, "Failed to init DSI phy: %d\n", ret);
676 ret = phy_configure(dsi->phy, phy_cfg);
678 DRM_DEV_ERROR(dev, "Failed to configure DSI phy: %d\n", ret);
682 ret = clk_prepare_enable(dsi->tx_esc_clk);
684 DRM_DEV_ERROR(dsi->dev, "Failed to enable tx_esc clk: %d\n",
688 DRM_DEV_DEBUG_DRIVER(dsi->dev, "Enabled tx_esc clk @%lu Hz\n",
689 clk_get_rate(dsi->tx_esc_clk));
691 ret = nwl_dsi_config_host(dsi);
693 DRM_DEV_ERROR(dev, "Failed to set up DSI: %d", ret);
697 ret = nwl_dsi_config_dpi(dsi);
699 DRM_DEV_ERROR(dev, "Failed to set up DPI: %d", ret);
703 ret = phy_power_on(dsi->phy);
705 DRM_DEV_ERROR(dev, "Failed to power on DPHY (%d)\n", ret);
709 ret = nwl_dsi_init_interrupts(dsi);
716 phy_power_off(dsi->phy);
718 clk_disable_unprepare(dsi->tx_esc_clk);
725 static int nwl_dsi_disable(struct nwl_dsi *dsi)
727 struct device *dev = dsi->dev;
729 DRM_DEV_DEBUG_DRIVER(dev, "Disabling clocks and phy\n");
731 phy_power_off(dsi->phy);
734 /* Disabling the clock before the phy breaks enabling dsi again */
735 clk_disable_unprepare(dsi->tx_esc_clk);
741 nwl_dsi_bridge_atomic_disable(struct drm_bridge *bridge,
742 struct drm_bridge_state *old_bridge_state)
744 struct nwl_dsi *dsi = bridge_to_dsi(bridge);
747 nwl_dsi_disable(dsi);
749 ret = reset_control_assert(dsi->rst_dpi);
751 DRM_DEV_ERROR(dsi->dev, "Failed to assert DPI: %d\n", ret);
754 ret = reset_control_assert(dsi->rst_byte);
756 DRM_DEV_ERROR(dsi->dev, "Failed to assert ESC: %d\n", ret);
759 ret = reset_control_assert(dsi->rst_esc);
761 DRM_DEV_ERROR(dsi->dev, "Failed to assert BYTE: %d\n", ret);
764 ret = reset_control_assert(dsi->rst_pclk);
766 DRM_DEV_ERROR(dsi->dev, "Failed to assert PCLK: %d\n", ret);
770 clk_disable_unprepare(dsi->core_clk);
771 clk_disable_unprepare(dsi->lcdif_clk);
773 pm_runtime_put(dsi->dev);
776 static int nwl_dsi_get_dphy_params(struct nwl_dsi *dsi,
777 const struct drm_display_mode *mode,
778 union phy_configure_opts *phy_opts)
783 if (dsi->lanes < 1 || dsi->lanes > 4)
787 * So far the DPHY spec minimal timings work for both mixel
788 * dphy and nwl dsi host
790 ret = phy_mipi_dphy_get_default_config(mode->clock * 1000,
791 mipi_dsi_pixel_format_to_bpp(dsi->format), dsi->lanes,
792 &phy_opts->mipi_dphy);
796 rate = clk_get_rate(dsi->tx_esc_clk);
797 DRM_DEV_DEBUG_DRIVER(dsi->dev, "LP clk is @%lu Hz\n", rate);
798 phy_opts->mipi_dphy.lp_clk_rate = rate;
803 static enum drm_mode_status
804 nwl_dsi_bridge_mode_valid(struct drm_bridge *bridge,
805 const struct drm_display_info *info,
806 const struct drm_display_mode *mode)
808 struct nwl_dsi *dsi = bridge_to_dsi(bridge);
809 int bpp = mipi_dsi_pixel_format_to_bpp(dsi->format);
811 if (mode->clock * bpp > 15000000 * dsi->lanes)
812 return MODE_CLOCK_HIGH;
814 if (mode->clock * bpp < 80000 * dsi->lanes)
815 return MODE_CLOCK_LOW;
820 static int nwl_dsi_bridge_atomic_check(struct drm_bridge *bridge,
821 struct drm_bridge_state *bridge_state,
822 struct drm_crtc_state *crtc_state,
823 struct drm_connector_state *conn_state)
825 struct drm_display_mode *adjusted_mode = &crtc_state->adjusted_mode;
827 /* At least LCDIF + NWL needs active high sync */
828 adjusted_mode->flags |= (DRM_MODE_FLAG_PHSYNC | DRM_MODE_FLAG_PVSYNC);
829 adjusted_mode->flags &= ~(DRM_MODE_FLAG_NHSYNC | DRM_MODE_FLAG_NVSYNC);
832 * Do a full modeset if crtc_state->active is changed to be true.
833 * This ensures our ->mode_set() is called to get the DSI controller
834 * and the PHY ready to send DCS commands, when only the connector's
835 * DPMS is brought out of "Off" status.
837 if (crtc_state->active_changed && crtc_state->active)
838 crtc_state->mode_changed = true;
844 nwl_dsi_bridge_mode_set(struct drm_bridge *bridge,
845 const struct drm_display_mode *mode,
846 const struct drm_display_mode *adjusted_mode)
848 struct nwl_dsi *dsi = bridge_to_dsi(bridge);
849 struct device *dev = dsi->dev;
850 union phy_configure_opts new_cfg;
851 unsigned long phy_ref_rate;
854 ret = nwl_dsi_get_dphy_params(dsi, adjusted_mode, &new_cfg);
858 phy_ref_rate = clk_get_rate(dsi->phy_ref_clk);
859 DRM_DEV_DEBUG_DRIVER(dev, "PHY at ref rate: %lu\n", phy_ref_rate);
860 /* Save the new desired phy config */
861 memcpy(&dsi->phy_cfg, &new_cfg, sizeof(new_cfg));
863 memcpy(&dsi->mode, adjusted_mode, sizeof(dsi->mode));
864 drm_mode_debug_printmodeline(adjusted_mode);
866 pm_runtime_get_sync(dev);
868 if (clk_prepare_enable(dsi->lcdif_clk) < 0)
870 if (clk_prepare_enable(dsi->core_clk) < 0)
873 /* Step 1 from DSI reset-out instructions */
874 ret = reset_control_deassert(dsi->rst_pclk);
876 DRM_DEV_ERROR(dev, "Failed to deassert PCLK: %d\n", ret);
880 /* Step 2 from DSI reset-out instructions */
881 nwl_dsi_mode_set(dsi);
883 /* Step 3 from DSI reset-out instructions */
884 ret = reset_control_deassert(dsi->rst_esc);
886 DRM_DEV_ERROR(dev, "Failed to deassert ESC: %d\n", ret);
889 ret = reset_control_deassert(dsi->rst_byte);
891 DRM_DEV_ERROR(dev, "Failed to deassert BYTE: %d\n", ret);
897 nwl_dsi_bridge_atomic_enable(struct drm_bridge *bridge,
898 struct drm_bridge_state *old_bridge_state)
900 struct nwl_dsi *dsi = bridge_to_dsi(bridge);
903 /* Step 5 from DSI reset-out instructions */
904 ret = reset_control_deassert(dsi->rst_dpi);
906 DRM_DEV_ERROR(dsi->dev, "Failed to deassert DPI: %d\n", ret);
909 static int nwl_dsi_bridge_attach(struct drm_bridge *bridge,
910 enum drm_bridge_attach_flags flags)
912 struct nwl_dsi *dsi = bridge_to_dsi(bridge);
913 struct drm_bridge *panel_bridge;
914 struct drm_panel *panel;
917 ret = drm_of_find_panel_or_bridge(dsi->dev->of_node, 1, 0, &panel,
923 panel_bridge = drm_panel_bridge_add(panel);
924 if (IS_ERR(panel_bridge))
925 return PTR_ERR(panel_bridge);
927 dsi->panel_bridge = panel_bridge;
929 if (!dsi->panel_bridge)
930 return -EPROBE_DEFER;
932 return drm_bridge_attach(bridge->encoder, dsi->panel_bridge, bridge,
936 static void nwl_dsi_bridge_detach(struct drm_bridge *bridge)
937 { struct nwl_dsi *dsi = bridge_to_dsi(bridge);
939 drm_of_panel_bridge_remove(dsi->dev->of_node, 1, 0);
942 static u32 *nwl_bridge_atomic_get_input_bus_fmts(struct drm_bridge *bridge,
943 struct drm_bridge_state *bridge_state,
944 struct drm_crtc_state *crtc_state,
945 struct drm_connector_state *conn_state,
947 unsigned int *num_input_fmts)
949 u32 *input_fmts, input_fmt;
953 switch (output_fmt) {
954 /* If MEDIA_BUS_FMT_FIXED is tested, return default bus format */
955 case MEDIA_BUS_FMT_FIXED:
956 input_fmt = MEDIA_BUS_FMT_RGB888_1X24;
958 case MEDIA_BUS_FMT_RGB888_1X24:
959 case MEDIA_BUS_FMT_RGB666_1X18:
960 case MEDIA_BUS_FMT_RGB565_1X16:
961 input_fmt = output_fmt;
967 input_fmts = kcalloc(1, sizeof(*input_fmts), GFP_KERNEL);
970 input_fmts[0] = input_fmt;
976 static const struct drm_bridge_funcs nwl_dsi_bridge_funcs = {
977 .atomic_duplicate_state = drm_atomic_helper_bridge_duplicate_state,
978 .atomic_destroy_state = drm_atomic_helper_bridge_destroy_state,
979 .atomic_reset = drm_atomic_helper_bridge_reset,
980 .atomic_check = nwl_dsi_bridge_atomic_check,
981 .atomic_enable = nwl_dsi_bridge_atomic_enable,
982 .atomic_disable = nwl_dsi_bridge_atomic_disable,
983 .atomic_get_input_bus_fmts = nwl_bridge_atomic_get_input_bus_fmts,
984 .mode_set = nwl_dsi_bridge_mode_set,
985 .mode_valid = nwl_dsi_bridge_mode_valid,
986 .attach = nwl_dsi_bridge_attach,
987 .detach = nwl_dsi_bridge_detach,
990 static int nwl_dsi_parse_dt(struct nwl_dsi *dsi)
992 struct platform_device *pdev = to_platform_device(dsi->dev);
997 dsi->phy = devm_phy_get(dsi->dev, "dphy");
998 if (IS_ERR(dsi->phy)) {
999 ret = PTR_ERR(dsi->phy);
1000 if (ret != -EPROBE_DEFER)
1001 DRM_DEV_ERROR(dsi->dev, "Could not get PHY: %d\n", ret);
1005 clk = devm_clk_get(dsi->dev, "lcdif");
1008 DRM_DEV_ERROR(dsi->dev, "Failed to get lcdif clock: %d\n",
1012 dsi->lcdif_clk = clk;
1014 clk = devm_clk_get(dsi->dev, "core");
1017 DRM_DEV_ERROR(dsi->dev, "Failed to get core clock: %d\n",
1021 dsi->core_clk = clk;
1023 clk = devm_clk_get(dsi->dev, "phy_ref");
1026 DRM_DEV_ERROR(dsi->dev, "Failed to get phy_ref clock: %d\n",
1030 dsi->phy_ref_clk = clk;
1032 clk = devm_clk_get(dsi->dev, "rx_esc");
1035 DRM_DEV_ERROR(dsi->dev, "Failed to get rx_esc clock: %d\n",
1039 dsi->rx_esc_clk = clk;
1041 clk = devm_clk_get(dsi->dev, "tx_esc");
1044 DRM_DEV_ERROR(dsi->dev, "Failed to get tx_esc clock: %d\n",
1048 dsi->tx_esc_clk = clk;
1050 dsi->mux = devm_mux_control_get(dsi->dev, NULL);
1051 if (IS_ERR(dsi->mux)) {
1052 ret = PTR_ERR(dsi->mux);
1053 if (ret != -EPROBE_DEFER)
1054 DRM_DEV_ERROR(dsi->dev, "Failed to get mux: %d\n", ret);
1058 base = devm_platform_ioremap_resource(pdev, 0);
1060 return PTR_ERR(base);
1063 devm_regmap_init_mmio(dsi->dev, base, &nwl_dsi_regmap_config);
1064 if (IS_ERR(dsi->regmap)) {
1065 ret = PTR_ERR(dsi->regmap);
1066 DRM_DEV_ERROR(dsi->dev, "Failed to create NWL DSI regmap: %d\n",
1071 dsi->irq = platform_get_irq(pdev, 0);
1073 DRM_DEV_ERROR(dsi->dev, "Failed to get device IRQ: %d\n",
1078 dsi->rst_pclk = devm_reset_control_get_exclusive(dsi->dev, "pclk");
1079 if (IS_ERR(dsi->rst_pclk)) {
1080 DRM_DEV_ERROR(dsi->dev, "Failed to get pclk reset: %ld\n",
1081 PTR_ERR(dsi->rst_pclk));
1082 return PTR_ERR(dsi->rst_pclk);
1084 dsi->rst_byte = devm_reset_control_get_exclusive(dsi->dev, "byte");
1085 if (IS_ERR(dsi->rst_byte)) {
1086 DRM_DEV_ERROR(dsi->dev, "Failed to get byte reset: %ld\n",
1087 PTR_ERR(dsi->rst_byte));
1088 return PTR_ERR(dsi->rst_byte);
1090 dsi->rst_esc = devm_reset_control_get_exclusive(dsi->dev, "esc");
1091 if (IS_ERR(dsi->rst_esc)) {
1092 DRM_DEV_ERROR(dsi->dev, "Failed to get esc reset: %ld\n",
1093 PTR_ERR(dsi->rst_esc));
1094 return PTR_ERR(dsi->rst_esc);
1096 dsi->rst_dpi = devm_reset_control_get_exclusive(dsi->dev, "dpi");
1097 if (IS_ERR(dsi->rst_dpi)) {
1098 DRM_DEV_ERROR(dsi->dev, "Failed to get dpi reset: %ld\n",
1099 PTR_ERR(dsi->rst_dpi));
1100 return PTR_ERR(dsi->rst_dpi);
1105 static int nwl_dsi_select_input(struct nwl_dsi *dsi)
1107 struct device_node *remote;
1111 remote = of_graph_get_remote_node(dsi->dev->of_node, 0,
1112 NWL_DSI_ENDPOINT_LCDIF);
1116 remote = of_graph_get_remote_node(dsi->dev->of_node, 0,
1117 NWL_DSI_ENDPOINT_DCSS);
1119 DRM_DEV_ERROR(dsi->dev,
1120 "No valid input endpoint found\n");
1125 DRM_DEV_INFO(dsi->dev, "Using %s as input source\n",
1126 (use_dcss) ? "DCSS" : "LCDIF");
1127 ret = mux_control_try_select(dsi->mux, use_dcss);
1129 DRM_DEV_ERROR(dsi->dev, "Failed to select input: %d\n", ret);
1131 of_node_put(remote);
1135 static int nwl_dsi_deselect_input(struct nwl_dsi *dsi)
1139 ret = mux_control_deselect(dsi->mux);
1141 DRM_DEV_ERROR(dsi->dev, "Failed to deselect input: %d\n", ret);
1146 static const struct drm_bridge_timings nwl_dsi_timings = {
1147 .input_bus_flags = DRM_BUS_FLAG_DE_LOW,
1150 static const struct of_device_id nwl_dsi_dt_ids[] = {
1151 { .compatible = "fsl,imx8mq-nwl-dsi", },
1154 MODULE_DEVICE_TABLE(of, nwl_dsi_dt_ids);
1156 static const struct soc_device_attribute nwl_dsi_quirks_match[] = {
1157 { .soc_id = "i.MX8MQ", .revision = "2.0",
1158 .data = (void *)E11418_HS_MODE_QUIRK },
1159 { /* sentinel. */ },
1162 static int nwl_dsi_probe(struct platform_device *pdev)
1164 struct device *dev = &pdev->dev;
1165 const struct soc_device_attribute *attr;
1166 struct nwl_dsi *dsi;
1169 dsi = devm_kzalloc(dev, sizeof(*dsi), GFP_KERNEL);
1175 ret = nwl_dsi_parse_dt(dsi);
1179 ret = devm_request_irq(dev, dsi->irq, nwl_dsi_irq_handler, 0,
1180 dev_name(dev), dsi);
1182 DRM_DEV_ERROR(dev, "Failed to request IRQ %d: %d\n", dsi->irq,
1187 dsi->dsi_host.ops = &nwl_dsi_host_ops;
1188 dsi->dsi_host.dev = dev;
1189 ret = mipi_dsi_host_register(&dsi->dsi_host);
1191 DRM_DEV_ERROR(dev, "Failed to register MIPI host: %d\n", ret);
1195 attr = soc_device_match(nwl_dsi_quirks_match);
1197 dsi->quirks = (uintptr_t)attr->data;
1199 dsi->bridge.driver_private = dsi;
1200 dsi->bridge.funcs = &nwl_dsi_bridge_funcs;
1201 dsi->bridge.of_node = dev->of_node;
1202 dsi->bridge.timings = &nwl_dsi_timings;
1204 dev_set_drvdata(dev, dsi);
1205 pm_runtime_enable(dev);
1207 ret = nwl_dsi_select_input(dsi);
1209 mipi_dsi_host_unregister(&dsi->dsi_host);
1213 drm_bridge_add(&dsi->bridge);
1217 static int nwl_dsi_remove(struct platform_device *pdev)
1219 struct nwl_dsi *dsi = platform_get_drvdata(pdev);
1221 nwl_dsi_deselect_input(dsi);
1222 mipi_dsi_host_unregister(&dsi->dsi_host);
1223 drm_bridge_remove(&dsi->bridge);
1224 pm_runtime_disable(&pdev->dev);
1228 static struct platform_driver nwl_dsi_driver = {
1229 .probe = nwl_dsi_probe,
1230 .remove = nwl_dsi_remove,
1232 .of_match_table = nwl_dsi_dt_ids,
1237 module_platform_driver(nwl_dsi_driver);
1239 MODULE_AUTHOR("NXP Semiconductor");
1240 MODULE_AUTHOR("Purism SPC");
1241 MODULE_DESCRIPTION("Northwest Logic MIPI-DSI driver");
1242 MODULE_LICENSE("GPL"); /* GPLv2 or later */