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/bits.h>
11 #include <linux/clk.h>
12 #include <linux/irq.h>
13 #include <linux/math64.h>
14 #include <linux/mfd/syscon.h>
15 #include <linux/module.h>
16 #include <linux/mux/consumer.h>
18 #include <linux/of_platform.h>
19 #include <linux/phy/phy.h>
20 #include <linux/regmap.h>
21 #include <linux/reset.h>
22 #include <linux/sys_soc.h>
23 #include <linux/time64.h>
25 #include <drm/drm_atomic_state_helper.h>
26 #include <drm/drm_bridge.h>
27 #include <drm/drm_mipi_dsi.h>
28 #include <drm/drm_of.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;
70 union phy_configure_opts phy_cfg;
73 struct regmap *regmap;
76 * The DSI host controller needs this reset sequence according to NWL:
77 * 1. Deassert pclk reset to get access to DSI regs
78 * 2. Configure DSI Host and DPHY and enable DPHY
79 * 3. Deassert ESC and BYTE resets to allow host TX operations)
80 * 4. Send DSI cmds to configure peripheral (handled by panel drv)
81 * 5. Deassert DPI reset so DPI receives pixels and starts sending
84 * TODO: Since panel_bridges do their DSI setup in enable we
85 * currently have 4. and 5. swapped.
87 struct reset_control *rst_byte;
88 struct reset_control *rst_esc;
89 struct reset_control *rst_dpi;
90 struct reset_control *rst_pclk;
91 struct mux_control *mux;
94 struct clk *phy_ref_clk;
95 struct clk *rx_esc_clk;
96 struct clk *tx_esc_clk;
99 * hardware bug: the i.MX8MQ needs this clock on during reset
100 * even when not using LCDIF.
102 struct clk *lcdif_clk;
106 enum mipi_dsi_pixel_format format;
107 struct drm_display_mode mode;
108 unsigned long dsi_mode_flags;
111 struct nwl_dsi_transfer *xfer;
114 static const struct regmap_config nwl_dsi_regmap_config = {
118 .max_register = NWL_DSI_IRQ_MASK2,
122 static inline struct nwl_dsi *bridge_to_dsi(struct drm_bridge *bridge)
124 return container_of(bridge, struct nwl_dsi, bridge);
127 static int nwl_dsi_clear_error(struct nwl_dsi *dsi)
129 int ret = dsi->error;
135 static void nwl_dsi_write(struct nwl_dsi *dsi, unsigned int reg, u32 val)
142 ret = regmap_write(dsi->regmap, reg, val);
144 DRM_DEV_ERROR(dsi->dev,
145 "Failed to write NWL DSI reg 0x%x: %d\n", reg,
151 static u32 nwl_dsi_read(struct nwl_dsi *dsi, u32 reg)
159 ret = regmap_read(dsi->regmap, reg, &val);
161 DRM_DEV_ERROR(dsi->dev, "Failed to read NWL DSI reg 0x%x: %d\n",
168 static int nwl_dsi_get_dpi_pixel_format(enum mipi_dsi_pixel_format format)
171 case MIPI_DSI_FMT_RGB565:
172 return NWL_DSI_PIXEL_FORMAT_16;
173 case MIPI_DSI_FMT_RGB666:
174 return NWL_DSI_PIXEL_FORMAT_18L;
175 case MIPI_DSI_FMT_RGB666_PACKED:
176 return NWL_DSI_PIXEL_FORMAT_18;
177 case MIPI_DSI_FMT_RGB888:
178 return NWL_DSI_PIXEL_FORMAT_24;
185 * ps2bc - Picoseconds to byte clock cycles
187 static u32 ps2bc(struct nwl_dsi *dsi, unsigned long long ps)
189 u32 bpp = mipi_dsi_pixel_format_to_bpp(dsi->format);
191 return DIV64_U64_ROUND_UP(ps * dsi->mode.clock * bpp,
192 dsi->lanes * 8ULL * NSEC_PER_SEC);
196 * ui2bc - UI time periods to byte clock cycles
198 static u32 ui2bc(unsigned int ui)
200 return DIV_ROUND_UP(ui, BITS_PER_BYTE);
204 * us2bc - micro seconds to lp clock cycles
206 static u32 us2lp(u32 lp_clk_rate, unsigned long us)
208 return DIV_ROUND_UP(us * lp_clk_rate, USEC_PER_SEC);
211 static int nwl_dsi_config_host(struct nwl_dsi *dsi)
214 struct phy_configure_opts_mipi_dphy *cfg = &dsi->phy_cfg.mipi_dphy;
216 if (dsi->lanes < 1 || dsi->lanes > 4)
219 DRM_DEV_DEBUG_DRIVER(dsi->dev, "DSI Lanes %d\n", dsi->lanes);
220 nwl_dsi_write(dsi, NWL_DSI_CFG_NUM_LANES, dsi->lanes - 1);
222 if (dsi->dsi_mode_flags & MIPI_DSI_CLOCK_NON_CONTINUOUS) {
223 nwl_dsi_write(dsi, NWL_DSI_CFG_NONCONTINUOUS_CLK, 0x01);
224 nwl_dsi_write(dsi, NWL_DSI_CFG_AUTOINSERT_EOTP, 0x01);
226 nwl_dsi_write(dsi, NWL_DSI_CFG_NONCONTINUOUS_CLK, 0x00);
227 nwl_dsi_write(dsi, NWL_DSI_CFG_AUTOINSERT_EOTP, 0x00);
230 /* values in byte clock cycles */
231 cycles = ui2bc(cfg->clk_pre);
232 DRM_DEV_DEBUG_DRIVER(dsi->dev, "cfg_t_pre: 0x%x\n", cycles);
233 nwl_dsi_write(dsi, NWL_DSI_CFG_T_PRE, cycles);
234 cycles = ps2bc(dsi, cfg->lpx + cfg->clk_prepare + cfg->clk_zero);
235 DRM_DEV_DEBUG_DRIVER(dsi->dev, "cfg_tx_gap (pre): 0x%x\n", cycles);
236 cycles += ui2bc(cfg->clk_pre);
237 DRM_DEV_DEBUG_DRIVER(dsi->dev, "cfg_t_post: 0x%x\n", cycles);
238 nwl_dsi_write(dsi, NWL_DSI_CFG_T_POST, cycles);
239 cycles = ps2bc(dsi, cfg->hs_exit);
240 DRM_DEV_DEBUG_DRIVER(dsi->dev, "cfg_tx_gap: 0x%x\n", cycles);
241 nwl_dsi_write(dsi, NWL_DSI_CFG_TX_GAP, cycles);
243 nwl_dsi_write(dsi, NWL_DSI_CFG_EXTRA_CMDS_AFTER_EOTP, 0x01);
244 nwl_dsi_write(dsi, NWL_DSI_CFG_HTX_TO_COUNT, 0x00);
245 nwl_dsi_write(dsi, NWL_DSI_CFG_LRX_H_TO_COUNT, 0x00);
246 nwl_dsi_write(dsi, NWL_DSI_CFG_BTA_H_TO_COUNT, 0x00);
247 /* In LP clock cycles */
248 cycles = us2lp(cfg->lp_clk_rate, cfg->wakeup);
249 DRM_DEV_DEBUG_DRIVER(dsi->dev, "cfg_twakeup: 0x%x\n", cycles);
250 nwl_dsi_write(dsi, NWL_DSI_CFG_TWAKEUP, cycles);
252 return nwl_dsi_clear_error(dsi);
255 static int nwl_dsi_config_dpi(struct nwl_dsi *dsi)
260 int hfront_porch, hback_porch, vfront_porch, vback_porch;
261 int hsync_len, vsync_len;
263 hfront_porch = dsi->mode.hsync_start - dsi->mode.hdisplay;
264 hsync_len = dsi->mode.hsync_end - dsi->mode.hsync_start;
265 hback_porch = dsi->mode.htotal - dsi->mode.hsync_end;
267 vfront_porch = dsi->mode.vsync_start - dsi->mode.vdisplay;
268 vsync_len = dsi->mode.vsync_end - dsi->mode.vsync_start;
269 vback_porch = dsi->mode.vtotal - dsi->mode.vsync_end;
271 DRM_DEV_DEBUG_DRIVER(dsi->dev, "hfront_porch = %d\n", hfront_porch);
272 DRM_DEV_DEBUG_DRIVER(dsi->dev, "hback_porch = %d\n", hback_porch);
273 DRM_DEV_DEBUG_DRIVER(dsi->dev, "hsync_len = %d\n", hsync_len);
274 DRM_DEV_DEBUG_DRIVER(dsi->dev, "hdisplay = %d\n", dsi->mode.hdisplay);
275 DRM_DEV_DEBUG_DRIVER(dsi->dev, "vfront_porch = %d\n", vfront_porch);
276 DRM_DEV_DEBUG_DRIVER(dsi->dev, "vback_porch = %d\n", vback_porch);
277 DRM_DEV_DEBUG_DRIVER(dsi->dev, "vsync_len = %d\n", vsync_len);
278 DRM_DEV_DEBUG_DRIVER(dsi->dev, "vactive = %d\n", dsi->mode.vdisplay);
279 DRM_DEV_DEBUG_DRIVER(dsi->dev, "clock = %d kHz\n", dsi->mode.clock);
281 color_format = nwl_dsi_get_dpi_pixel_format(dsi->format);
282 if (color_format < 0) {
283 DRM_DEV_ERROR(dsi->dev, "Invalid color format 0x%x\n",
287 DRM_DEV_DEBUG_DRIVER(dsi->dev, "pixel fmt = %d\n", dsi->format);
289 nwl_dsi_write(dsi, NWL_DSI_INTERFACE_COLOR_CODING, NWL_DSI_DPI_24_BIT);
290 nwl_dsi_write(dsi, NWL_DSI_PIXEL_FORMAT, color_format);
292 * Adjusting input polarity based on the video mode results in
293 * a black screen so always pick active low:
295 nwl_dsi_write(dsi, NWL_DSI_VSYNC_POLARITY,
296 NWL_DSI_VSYNC_POLARITY_ACTIVE_LOW);
297 nwl_dsi_write(dsi, NWL_DSI_HSYNC_POLARITY,
298 NWL_DSI_HSYNC_POLARITY_ACTIVE_LOW);
300 burst_mode = (dsi->dsi_mode_flags & MIPI_DSI_MODE_VIDEO_BURST) &&
301 !(dsi->dsi_mode_flags & MIPI_DSI_MODE_VIDEO_SYNC_PULSE);
304 nwl_dsi_write(dsi, NWL_DSI_VIDEO_MODE, NWL_DSI_VM_BURST_MODE);
305 nwl_dsi_write(dsi, NWL_DSI_PIXEL_FIFO_SEND_LEVEL, 256);
307 mode = ((dsi->dsi_mode_flags & MIPI_DSI_MODE_VIDEO_SYNC_PULSE) ?
308 NWL_DSI_VM_BURST_MODE_WITH_SYNC_PULSES :
309 NWL_DSI_VM_NON_BURST_MODE_WITH_SYNC_EVENTS);
310 nwl_dsi_write(dsi, NWL_DSI_VIDEO_MODE, mode);
311 nwl_dsi_write(dsi, NWL_DSI_PIXEL_FIFO_SEND_LEVEL,
315 nwl_dsi_write(dsi, NWL_DSI_HFP, hfront_porch);
316 nwl_dsi_write(dsi, NWL_DSI_HBP, hback_porch);
317 nwl_dsi_write(dsi, NWL_DSI_HSA, hsync_len);
319 nwl_dsi_write(dsi, NWL_DSI_ENABLE_MULT_PKTS, 0x0);
320 nwl_dsi_write(dsi, NWL_DSI_BLLP_MODE, 0x1);
321 nwl_dsi_write(dsi, NWL_DSI_USE_NULL_PKT_BLLP, 0x0);
322 nwl_dsi_write(dsi, NWL_DSI_VC, 0x0);
324 nwl_dsi_write(dsi, NWL_DSI_PIXEL_PAYLOAD_SIZE, dsi->mode.hdisplay);
325 nwl_dsi_write(dsi, NWL_DSI_VACTIVE, dsi->mode.vdisplay - 1);
326 nwl_dsi_write(dsi, NWL_DSI_VBP, vback_porch);
327 nwl_dsi_write(dsi, NWL_DSI_VFP, vfront_porch);
329 return nwl_dsi_clear_error(dsi);
332 static int nwl_dsi_init_interrupts(struct nwl_dsi *dsi)
334 u32 irq_enable = ~(u32)(NWL_DSI_TX_PKT_DONE_MASK |
335 NWL_DSI_RX_PKT_HDR_RCVD_MASK |
336 NWL_DSI_TX_FIFO_OVFLW_MASK |
337 NWL_DSI_HS_TX_TIMEOUT_MASK);
339 nwl_dsi_write(dsi, NWL_DSI_IRQ_MASK, irq_enable);
340 nwl_dsi_write(dsi, NWL_DSI_IRQ_MASK2, 0x7);
342 return nwl_dsi_clear_error(dsi);
345 static int nwl_dsi_host_attach(struct mipi_dsi_host *dsi_host,
346 struct mipi_dsi_device *device)
348 struct nwl_dsi *dsi = container_of(dsi_host, struct nwl_dsi, dsi_host);
349 struct device *dev = dsi->dev;
351 DRM_DEV_INFO(dev, "lanes=%u, format=0x%x flags=0x%lx\n", device->lanes,
352 device->format, device->mode_flags);
354 if (device->lanes < 1 || device->lanes > 4)
357 dsi->lanes = device->lanes;
358 dsi->format = device->format;
359 dsi->dsi_mode_flags = device->mode_flags;
364 static bool nwl_dsi_read_packet(struct nwl_dsi *dsi, u32 status)
366 struct device *dev = dsi->dev;
367 struct nwl_dsi_transfer *xfer = dsi->xfer;
369 u8 *payload = xfer->msg->rx_buf;
377 if (xfer->rx_word_count == 0) {
378 if (!(status & NWL_DSI_RX_PKT_HDR_RCVD))
380 /* Get the RX header and parse it */
381 val = nwl_dsi_read(dsi, NWL_DSI_RX_PKT_HEADER);
382 err = nwl_dsi_clear_error(dsi);
385 word_count = NWL_DSI_WC(val);
386 channel = NWL_DSI_RX_VC(val);
387 data_type = NWL_DSI_RX_DT(val);
389 if (channel != xfer->msg->channel) {
391 "[%02X] Channel mismatch (%u != %u)\n",
392 xfer->cmd, channel, xfer->msg->channel);
393 xfer->status = -EINVAL;
398 case MIPI_DSI_RX_GENERIC_SHORT_READ_RESPONSE_2BYTE:
399 case MIPI_DSI_RX_DCS_SHORT_READ_RESPONSE_2BYTE:
400 if (xfer->msg->rx_len > 1) {
401 /* read second byte */
402 payload[1] = word_count >> 8;
406 case MIPI_DSI_RX_GENERIC_SHORT_READ_RESPONSE_1BYTE:
407 case MIPI_DSI_RX_DCS_SHORT_READ_RESPONSE_1BYTE:
408 if (xfer->msg->rx_len > 0) {
409 /* read first byte */
410 payload[0] = word_count & 0xff;
413 xfer->status = xfer->rx_len;
415 case MIPI_DSI_RX_ACKNOWLEDGE_AND_ERROR_REPORT:
417 DRM_DEV_ERROR(dev, "[%02X] DSI error report: 0x%02x\n",
418 xfer->cmd, word_count);
419 xfer->status = -EPROTO;
423 if (word_count > xfer->msg->rx_len) {
425 "[%02X] Receive buffer too small: %zu (< %u)\n",
426 xfer->cmd, xfer->msg->rx_len, word_count);
427 xfer->status = -EINVAL;
431 xfer->rx_word_count = word_count;
433 /* Set word_count from previous header read */
434 word_count = xfer->rx_word_count;
437 /* If RX payload is not yet received, wait for it */
438 if (!(status & NWL_DSI_RX_PKT_PAYLOAD_DATA_RCVD))
441 /* Read the RX payload */
442 while (word_count >= 4) {
443 val = nwl_dsi_read(dsi, NWL_DSI_RX_PAYLOAD);
444 payload[0] = (val >> 0) & 0xff;
445 payload[1] = (val >> 8) & 0xff;
446 payload[2] = (val >> 16) & 0xff;
447 payload[3] = (val >> 24) & 0xff;
453 if (word_count > 0) {
454 val = nwl_dsi_read(dsi, NWL_DSI_RX_PAYLOAD);
455 switch (word_count) {
457 payload[2] = (val >> 16) & 0xff;
461 payload[1] = (val >> 8) & 0xff;
465 payload[0] = (val >> 0) & 0xff;
471 xfer->status = xfer->rx_len;
472 err = nwl_dsi_clear_error(dsi);
479 static void nwl_dsi_finish_transmission(struct nwl_dsi *dsi, u32 status)
481 struct nwl_dsi_transfer *xfer = dsi->xfer;
482 bool end_packet = false;
487 if (xfer->direction == DSI_PACKET_SEND &&
488 status & NWL_DSI_TX_PKT_DONE) {
489 xfer->status = xfer->tx_len;
491 } else if (status & NWL_DSI_DPHY_DIRECTION &&
492 ((status & (NWL_DSI_RX_PKT_HDR_RCVD |
493 NWL_DSI_RX_PKT_PAYLOAD_DATA_RCVD)))) {
494 end_packet = nwl_dsi_read_packet(dsi, status);
498 complete(&xfer->completed);
501 static void nwl_dsi_begin_transmission(struct nwl_dsi *dsi)
503 struct nwl_dsi_transfer *xfer = dsi->xfer;
504 struct mipi_dsi_packet *pkt = &xfer->packet;
510 u32 hs_workaround = 0;
512 /* Send the payload, if any */
513 length = pkt->payload_length;
514 payload = pkt->payload;
516 while (length >= 4) {
517 val = *(u32 *)payload;
518 hs_workaround |= !(val & 0xFFFF00);
519 nwl_dsi_write(dsi, NWL_DSI_TX_PAYLOAD, val);
523 /* Send the rest of the payload */
527 val |= payload[2] << 16;
530 val |= payload[1] << 8;
531 hs_workaround |= !(val & 0xFFFF00);
535 nwl_dsi_write(dsi, NWL_DSI_TX_PAYLOAD, val);
538 xfer->tx_len = pkt->payload_length;
542 * header[0] = Virtual Channel + Data Type
543 * header[1] = Word Count LSB (LP) or first param (SP)
544 * header[2] = Word Count MSB (LP) or second param (SP)
546 word_count = pkt->header[1] | (pkt->header[2] << 8);
547 if (hs_workaround && (dsi->quirks & E11418_HS_MODE_QUIRK)) {
548 DRM_DEV_DEBUG_DRIVER(dsi->dev,
549 "Using hs mode workaround for cmd 0x%x\n",
553 hs_mode = (xfer->msg->flags & MIPI_DSI_MSG_USE_LPM) ? 0 : 1;
555 val = NWL_DSI_WC(word_count) | NWL_DSI_TX_VC(xfer->msg->channel) |
556 NWL_DSI_TX_DT(xfer->msg->type) | NWL_DSI_HS_SEL(hs_mode) |
557 NWL_DSI_BTA_TX(xfer->need_bta);
558 nwl_dsi_write(dsi, NWL_DSI_PKT_CONTROL, val);
560 /* Send packet command */
561 nwl_dsi_write(dsi, NWL_DSI_SEND_PACKET, 0x1);
564 static ssize_t nwl_dsi_host_transfer(struct mipi_dsi_host *dsi_host,
565 const struct mipi_dsi_msg *msg)
567 struct nwl_dsi *dsi = container_of(dsi_host, struct nwl_dsi, dsi_host);
568 struct nwl_dsi_transfer xfer;
571 /* Create packet to be sent */
573 ret = mipi_dsi_create_packet(&xfer.packet, msg);
579 if ((msg->type & MIPI_DSI_GENERIC_READ_REQUEST_0_PARAM ||
580 msg->type & MIPI_DSI_GENERIC_READ_REQUEST_1_PARAM ||
581 msg->type & MIPI_DSI_GENERIC_READ_REQUEST_2_PARAM ||
582 msg->type & MIPI_DSI_DCS_READ) &&
583 msg->rx_len > 0 && msg->rx_buf)
584 xfer.direction = DSI_PACKET_RECEIVE;
586 xfer.direction = DSI_PACKET_SEND;
588 xfer.need_bta = (xfer.direction == DSI_PACKET_RECEIVE);
589 xfer.need_bta |= (msg->flags & MIPI_DSI_MSG_REQ_ACK) ? 1 : 0;
591 xfer.status = -ETIMEDOUT;
592 xfer.rx_word_count = 0;
596 xfer.cmd = ((u8 *)(msg->tx_buf))[0];
597 init_completion(&xfer.completed);
599 ret = clk_prepare_enable(dsi->rx_esc_clk);
601 DRM_DEV_ERROR(dsi->dev, "Failed to enable rx_esc clk: %zd\n",
605 DRM_DEV_DEBUG_DRIVER(dsi->dev, "Enabled rx_esc clk @%lu Hz\n",
606 clk_get_rate(dsi->rx_esc_clk));
608 /* Initiate the DSI packet transmision */
609 nwl_dsi_begin_transmission(dsi);
611 if (!wait_for_completion_timeout(&xfer.completed,
612 NWL_DSI_MIPI_FIFO_TIMEOUT)) {
613 DRM_DEV_ERROR(dsi_host->dev, "[%02X] DSI transfer timed out\n",
620 clk_disable_unprepare(dsi->rx_esc_clk);
625 static const struct mipi_dsi_host_ops nwl_dsi_host_ops = {
626 .attach = nwl_dsi_host_attach,
627 .transfer = nwl_dsi_host_transfer,
630 static irqreturn_t nwl_dsi_irq_handler(int irq, void *data)
633 struct nwl_dsi *dsi = data;
635 irq_status = nwl_dsi_read(dsi, NWL_DSI_IRQ_STATUS);
637 if (irq_status & NWL_DSI_TX_FIFO_OVFLW)
638 DRM_DEV_ERROR_RATELIMITED(dsi->dev, "tx fifo overflow\n");
640 if (irq_status & NWL_DSI_HS_TX_TIMEOUT)
641 DRM_DEV_ERROR_RATELIMITED(dsi->dev, "HS tx timeout\n");
643 if (irq_status & NWL_DSI_TX_PKT_DONE ||
644 irq_status & NWL_DSI_RX_PKT_HDR_RCVD ||
645 irq_status & NWL_DSI_RX_PKT_PAYLOAD_DATA_RCVD)
646 nwl_dsi_finish_transmission(dsi, irq_status);
651 static int nwl_dsi_mode_set(struct nwl_dsi *dsi)
653 struct device *dev = dsi->dev;
654 union phy_configure_opts *phy_cfg = &dsi->phy_cfg;
658 DRM_DEV_ERROR(dev, "Need DSI lanes: %d\n", dsi->lanes);
662 ret = phy_init(dsi->phy);
664 DRM_DEV_ERROR(dev, "Failed to init DSI phy: %d\n", ret);
668 ret = phy_configure(dsi->phy, phy_cfg);
670 DRM_DEV_ERROR(dev, "Failed to configure DSI phy: %d\n", ret);
674 ret = clk_prepare_enable(dsi->tx_esc_clk);
676 DRM_DEV_ERROR(dsi->dev, "Failed to enable tx_esc clk: %d\n",
680 DRM_DEV_DEBUG_DRIVER(dsi->dev, "Enabled tx_esc clk @%lu Hz\n",
681 clk_get_rate(dsi->tx_esc_clk));
683 ret = nwl_dsi_config_host(dsi);
685 DRM_DEV_ERROR(dev, "Failed to set up DSI: %d", ret);
689 ret = nwl_dsi_config_dpi(dsi);
691 DRM_DEV_ERROR(dev, "Failed to set up DPI: %d", ret);
695 ret = phy_power_on(dsi->phy);
697 DRM_DEV_ERROR(dev, "Failed to power on DPHY (%d)\n", ret);
701 ret = nwl_dsi_init_interrupts(dsi);
708 phy_power_off(dsi->phy);
710 clk_disable_unprepare(dsi->tx_esc_clk);
717 static int nwl_dsi_disable(struct nwl_dsi *dsi)
719 struct device *dev = dsi->dev;
721 DRM_DEV_DEBUG_DRIVER(dev, "Disabling clocks and phy\n");
723 phy_power_off(dsi->phy);
726 /* Disabling the clock before the phy breaks enabling dsi again */
727 clk_disable_unprepare(dsi->tx_esc_clk);
733 nwl_dsi_bridge_atomic_disable(struct drm_bridge *bridge,
734 struct drm_bridge_state *old_bridge_state)
736 struct nwl_dsi *dsi = bridge_to_dsi(bridge);
739 nwl_dsi_disable(dsi);
741 ret = reset_control_assert(dsi->rst_dpi);
743 DRM_DEV_ERROR(dsi->dev, "Failed to assert DPI: %d\n", ret);
746 ret = reset_control_assert(dsi->rst_byte);
748 DRM_DEV_ERROR(dsi->dev, "Failed to assert ESC: %d\n", ret);
751 ret = reset_control_assert(dsi->rst_esc);
753 DRM_DEV_ERROR(dsi->dev, "Failed to assert BYTE: %d\n", ret);
756 ret = reset_control_assert(dsi->rst_pclk);
758 DRM_DEV_ERROR(dsi->dev, "Failed to assert PCLK: %d\n", ret);
762 clk_disable_unprepare(dsi->core_clk);
763 clk_disable_unprepare(dsi->lcdif_clk);
765 pm_runtime_put(dsi->dev);
768 static int nwl_dsi_get_dphy_params(struct nwl_dsi *dsi,
769 const struct drm_display_mode *mode,
770 union phy_configure_opts *phy_opts)
775 if (dsi->lanes < 1 || dsi->lanes > 4)
779 * So far the DPHY spec minimal timings work for both mixel
780 * dphy and nwl dsi host
782 ret = phy_mipi_dphy_get_default_config(mode->clock * 1000,
783 mipi_dsi_pixel_format_to_bpp(dsi->format), dsi->lanes,
784 &phy_opts->mipi_dphy);
788 rate = clk_get_rate(dsi->tx_esc_clk);
789 DRM_DEV_DEBUG_DRIVER(dsi->dev, "LP clk is @%lu Hz\n", rate);
790 phy_opts->mipi_dphy.lp_clk_rate = rate;
795 static enum drm_mode_status
796 nwl_dsi_bridge_mode_valid(struct drm_bridge *bridge,
797 const struct drm_display_info *info,
798 const struct drm_display_mode *mode)
800 struct nwl_dsi *dsi = bridge_to_dsi(bridge);
801 int bpp = mipi_dsi_pixel_format_to_bpp(dsi->format);
803 if (mode->clock * bpp > 15000000 * dsi->lanes)
804 return MODE_CLOCK_HIGH;
806 if (mode->clock * bpp < 80000 * dsi->lanes)
807 return MODE_CLOCK_LOW;
812 static int nwl_dsi_bridge_atomic_check(struct drm_bridge *bridge,
813 struct drm_bridge_state *bridge_state,
814 struct drm_crtc_state *crtc_state,
815 struct drm_connector_state *conn_state)
817 struct drm_display_mode *adjusted_mode = &crtc_state->adjusted_mode;
819 /* At least LCDIF + NWL needs active high sync */
820 adjusted_mode->flags |= (DRM_MODE_FLAG_PHSYNC | DRM_MODE_FLAG_PVSYNC);
821 adjusted_mode->flags &= ~(DRM_MODE_FLAG_NHSYNC | DRM_MODE_FLAG_NVSYNC);
824 * Do a full modeset if crtc_state->active is changed to be true.
825 * This ensures our ->mode_set() is called to get the DSI controller
826 * and the PHY ready to send DCS commands, when only the connector's
827 * DPMS is brought out of "Off" status.
829 if (crtc_state->active_changed && crtc_state->active)
830 crtc_state->mode_changed = true;
836 nwl_dsi_bridge_mode_set(struct drm_bridge *bridge,
837 const struct drm_display_mode *mode,
838 const struct drm_display_mode *adjusted_mode)
840 struct nwl_dsi *dsi = bridge_to_dsi(bridge);
841 struct device *dev = dsi->dev;
842 union phy_configure_opts new_cfg;
843 unsigned long phy_ref_rate;
846 ret = nwl_dsi_get_dphy_params(dsi, adjusted_mode, &new_cfg);
850 phy_ref_rate = clk_get_rate(dsi->phy_ref_clk);
851 DRM_DEV_DEBUG_DRIVER(dev, "PHY at ref rate: %lu\n", phy_ref_rate);
852 /* Save the new desired phy config */
853 memcpy(&dsi->phy_cfg, &new_cfg, sizeof(new_cfg));
855 drm_mode_copy(&dsi->mode, adjusted_mode);
856 drm_mode_debug_printmodeline(adjusted_mode);
858 if (pm_runtime_resume_and_get(dev) < 0)
861 if (clk_prepare_enable(dsi->lcdif_clk) < 0)
863 if (clk_prepare_enable(dsi->core_clk) < 0)
866 /* Step 1 from DSI reset-out instructions */
867 ret = reset_control_deassert(dsi->rst_pclk);
869 DRM_DEV_ERROR(dev, "Failed to deassert PCLK: %d\n", ret);
873 /* Step 2 from DSI reset-out instructions */
874 nwl_dsi_mode_set(dsi);
876 /* Step 3 from DSI reset-out instructions */
877 ret = reset_control_deassert(dsi->rst_esc);
879 DRM_DEV_ERROR(dev, "Failed to deassert ESC: %d\n", ret);
882 ret = reset_control_deassert(dsi->rst_byte);
884 DRM_DEV_ERROR(dev, "Failed to deassert BYTE: %d\n", ret);
891 pm_runtime_put_sync(dev);
895 nwl_dsi_bridge_atomic_enable(struct drm_bridge *bridge,
896 struct drm_bridge_state *old_bridge_state)
898 struct nwl_dsi *dsi = bridge_to_dsi(bridge);
901 /* Step 5 from DSI reset-out instructions */
902 ret = reset_control_deassert(dsi->rst_dpi);
904 DRM_DEV_ERROR(dsi->dev, "Failed to deassert DPI: %d\n", ret);
907 static int nwl_dsi_bridge_attach(struct drm_bridge *bridge,
908 enum drm_bridge_attach_flags flags)
910 struct nwl_dsi *dsi = bridge_to_dsi(bridge);
911 struct drm_bridge *panel_bridge;
913 panel_bridge = devm_drm_of_get_bridge(dsi->dev, dsi->dev->of_node, 1, 0);
914 if (IS_ERR(panel_bridge))
915 return PTR_ERR(panel_bridge);
917 return drm_bridge_attach(bridge->encoder, panel_bridge, bridge, flags);
920 static u32 *nwl_bridge_atomic_get_input_bus_fmts(struct drm_bridge *bridge,
921 struct drm_bridge_state *bridge_state,
922 struct drm_crtc_state *crtc_state,
923 struct drm_connector_state *conn_state,
925 unsigned int *num_input_fmts)
927 u32 *input_fmts, input_fmt;
931 switch (output_fmt) {
932 /* If MEDIA_BUS_FMT_FIXED is tested, return default bus format */
933 case MEDIA_BUS_FMT_FIXED:
934 input_fmt = MEDIA_BUS_FMT_RGB888_1X24;
936 case MEDIA_BUS_FMT_RGB888_1X24:
937 case MEDIA_BUS_FMT_RGB666_1X18:
938 case MEDIA_BUS_FMT_RGB565_1X16:
939 input_fmt = output_fmt;
945 input_fmts = kcalloc(1, sizeof(*input_fmts), GFP_KERNEL);
948 input_fmts[0] = input_fmt;
954 static const struct drm_bridge_funcs nwl_dsi_bridge_funcs = {
955 .atomic_duplicate_state = drm_atomic_helper_bridge_duplicate_state,
956 .atomic_destroy_state = drm_atomic_helper_bridge_destroy_state,
957 .atomic_reset = drm_atomic_helper_bridge_reset,
958 .atomic_check = nwl_dsi_bridge_atomic_check,
959 .atomic_enable = nwl_dsi_bridge_atomic_enable,
960 .atomic_disable = nwl_dsi_bridge_atomic_disable,
961 .atomic_get_input_bus_fmts = nwl_bridge_atomic_get_input_bus_fmts,
962 .mode_set = nwl_dsi_bridge_mode_set,
963 .mode_valid = nwl_dsi_bridge_mode_valid,
964 .attach = nwl_dsi_bridge_attach,
967 static int nwl_dsi_parse_dt(struct nwl_dsi *dsi)
969 struct platform_device *pdev = to_platform_device(dsi->dev);
974 dsi->phy = devm_phy_get(dsi->dev, "dphy");
975 if (IS_ERR(dsi->phy)) {
976 ret = PTR_ERR(dsi->phy);
977 if (ret != -EPROBE_DEFER)
978 DRM_DEV_ERROR(dsi->dev, "Could not get PHY: %d\n", ret);
982 clk = devm_clk_get(dsi->dev, "lcdif");
985 DRM_DEV_ERROR(dsi->dev, "Failed to get lcdif clock: %d\n",
989 dsi->lcdif_clk = clk;
991 clk = devm_clk_get(dsi->dev, "core");
994 DRM_DEV_ERROR(dsi->dev, "Failed to get core clock: %d\n",
1000 clk = devm_clk_get(dsi->dev, "phy_ref");
1003 DRM_DEV_ERROR(dsi->dev, "Failed to get phy_ref clock: %d\n",
1007 dsi->phy_ref_clk = clk;
1009 clk = devm_clk_get(dsi->dev, "rx_esc");
1012 DRM_DEV_ERROR(dsi->dev, "Failed to get rx_esc clock: %d\n",
1016 dsi->rx_esc_clk = clk;
1018 clk = devm_clk_get(dsi->dev, "tx_esc");
1021 DRM_DEV_ERROR(dsi->dev, "Failed to get tx_esc clock: %d\n",
1025 dsi->tx_esc_clk = clk;
1027 dsi->mux = devm_mux_control_get(dsi->dev, NULL);
1028 if (IS_ERR(dsi->mux)) {
1029 ret = PTR_ERR(dsi->mux);
1030 if (ret != -EPROBE_DEFER)
1031 DRM_DEV_ERROR(dsi->dev, "Failed to get mux: %d\n", ret);
1035 base = devm_platform_ioremap_resource(pdev, 0);
1037 return PTR_ERR(base);
1040 devm_regmap_init_mmio(dsi->dev, base, &nwl_dsi_regmap_config);
1041 if (IS_ERR(dsi->regmap)) {
1042 ret = PTR_ERR(dsi->regmap);
1043 DRM_DEV_ERROR(dsi->dev, "Failed to create NWL DSI regmap: %d\n",
1048 dsi->irq = platform_get_irq(pdev, 0);
1050 DRM_DEV_ERROR(dsi->dev, "Failed to get device IRQ: %d\n",
1055 dsi->rst_pclk = devm_reset_control_get_exclusive(dsi->dev, "pclk");
1056 if (IS_ERR(dsi->rst_pclk)) {
1057 DRM_DEV_ERROR(dsi->dev, "Failed to get pclk reset: %ld\n",
1058 PTR_ERR(dsi->rst_pclk));
1059 return PTR_ERR(dsi->rst_pclk);
1061 dsi->rst_byte = devm_reset_control_get_exclusive(dsi->dev, "byte");
1062 if (IS_ERR(dsi->rst_byte)) {
1063 DRM_DEV_ERROR(dsi->dev, "Failed to get byte reset: %ld\n",
1064 PTR_ERR(dsi->rst_byte));
1065 return PTR_ERR(dsi->rst_byte);
1067 dsi->rst_esc = devm_reset_control_get_exclusive(dsi->dev, "esc");
1068 if (IS_ERR(dsi->rst_esc)) {
1069 DRM_DEV_ERROR(dsi->dev, "Failed to get esc reset: %ld\n",
1070 PTR_ERR(dsi->rst_esc));
1071 return PTR_ERR(dsi->rst_esc);
1073 dsi->rst_dpi = devm_reset_control_get_exclusive(dsi->dev, "dpi");
1074 if (IS_ERR(dsi->rst_dpi)) {
1075 DRM_DEV_ERROR(dsi->dev, "Failed to get dpi reset: %ld\n",
1076 PTR_ERR(dsi->rst_dpi));
1077 return PTR_ERR(dsi->rst_dpi);
1082 static int nwl_dsi_select_input(struct nwl_dsi *dsi)
1084 struct device_node *remote;
1088 remote = of_graph_get_remote_node(dsi->dev->of_node, 0,
1089 NWL_DSI_ENDPOINT_LCDIF);
1093 remote = of_graph_get_remote_node(dsi->dev->of_node, 0,
1094 NWL_DSI_ENDPOINT_DCSS);
1096 DRM_DEV_ERROR(dsi->dev,
1097 "No valid input endpoint found\n");
1102 DRM_DEV_INFO(dsi->dev, "Using %s as input source\n",
1103 (use_dcss) ? "DCSS" : "LCDIF");
1104 ret = mux_control_try_select(dsi->mux, use_dcss);
1106 DRM_DEV_ERROR(dsi->dev, "Failed to select input: %d\n", ret);
1108 of_node_put(remote);
1112 static int nwl_dsi_deselect_input(struct nwl_dsi *dsi)
1116 ret = mux_control_deselect(dsi->mux);
1118 DRM_DEV_ERROR(dsi->dev, "Failed to deselect input: %d\n", ret);
1123 static const struct drm_bridge_timings nwl_dsi_timings = {
1124 .input_bus_flags = DRM_BUS_FLAG_DE_LOW,
1127 static const struct of_device_id nwl_dsi_dt_ids[] = {
1128 { .compatible = "fsl,imx8mq-nwl-dsi", },
1131 MODULE_DEVICE_TABLE(of, nwl_dsi_dt_ids);
1133 static const struct soc_device_attribute nwl_dsi_quirks_match[] = {
1134 { .soc_id = "i.MX8MQ", .revision = "2.0",
1135 .data = (void *)E11418_HS_MODE_QUIRK },
1139 static int nwl_dsi_probe(struct platform_device *pdev)
1141 struct device *dev = &pdev->dev;
1142 const struct soc_device_attribute *attr;
1143 struct nwl_dsi *dsi;
1146 dsi = devm_kzalloc(dev, sizeof(*dsi), GFP_KERNEL);
1152 ret = nwl_dsi_parse_dt(dsi);
1156 ret = devm_request_irq(dev, dsi->irq, nwl_dsi_irq_handler, 0,
1157 dev_name(dev), dsi);
1159 DRM_DEV_ERROR(dev, "Failed to request IRQ %d: %d\n", dsi->irq,
1164 dsi->dsi_host.ops = &nwl_dsi_host_ops;
1165 dsi->dsi_host.dev = dev;
1166 ret = mipi_dsi_host_register(&dsi->dsi_host);
1168 DRM_DEV_ERROR(dev, "Failed to register MIPI host: %d\n", ret);
1172 attr = soc_device_match(nwl_dsi_quirks_match);
1174 dsi->quirks = (uintptr_t)attr->data;
1176 dsi->bridge.driver_private = dsi;
1177 dsi->bridge.funcs = &nwl_dsi_bridge_funcs;
1178 dsi->bridge.of_node = dev->of_node;
1179 dsi->bridge.timings = &nwl_dsi_timings;
1181 dev_set_drvdata(dev, dsi);
1182 pm_runtime_enable(dev);
1184 ret = nwl_dsi_select_input(dsi);
1186 pm_runtime_disable(dev);
1187 mipi_dsi_host_unregister(&dsi->dsi_host);
1191 drm_bridge_add(&dsi->bridge);
1195 static int nwl_dsi_remove(struct platform_device *pdev)
1197 struct nwl_dsi *dsi = platform_get_drvdata(pdev);
1199 nwl_dsi_deselect_input(dsi);
1200 mipi_dsi_host_unregister(&dsi->dsi_host);
1201 drm_bridge_remove(&dsi->bridge);
1202 pm_runtime_disable(&pdev->dev);
1206 static struct platform_driver nwl_dsi_driver = {
1207 .probe = nwl_dsi_probe,
1208 .remove = nwl_dsi_remove,
1210 .of_match_table = nwl_dsi_dt_ids,
1215 module_platform_driver(nwl_dsi_driver);
1217 MODULE_AUTHOR("NXP Semiconductor");
1218 MODULE_AUTHOR("Purism SPC");
1219 MODULE_DESCRIPTION("Northwest Logic MIPI-DSI driver");
1220 MODULE_LICENSE("GPL"); /* GPLv2 or later */