1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (C) STMicroelectronics SA 2017
5 * Authors: Philippe Cornu <philippe.cornu@st.com>
6 * Yannick Fertre <yannick.fertre@st.com>
10 #include <linux/iopoll.h>
11 #include <linux/mod_devicetable.h>
12 #include <linux/module.h>
13 #include <linux/platform_device.h>
14 #include <linux/regulator/consumer.h>
16 #include <video/mipi_display.h>
18 #include <drm/bridge/dw_mipi_dsi.h>
19 #include <drm/drm_mipi_dsi.h>
20 #include <drm/drm_print.h>
22 #define HWVER_130 0x31333000 /* IP version 1.30 */
23 #define HWVER_131 0x31333100 /* IP version 1.31 */
25 /* DSI digital registers & bit definitions */
26 #define DSI_VERSION 0x00
27 #define VERSION GENMASK(31, 8)
29 /* DSI wrapper registers & bit definitions */
30 /* Note: registers are named as in the Reference Manual */
31 #define DSI_WCFGR 0x0400 /* Wrapper ConFiGuration Reg */
32 #define WCFGR_DSIM BIT(0) /* DSI Mode */
33 #define WCFGR_COLMUX GENMASK(3, 1) /* COLor MUltipleXing */
35 #define DSI_WCR 0x0404 /* Wrapper Control Reg */
36 #define WCR_DSIEN BIT(3) /* DSI ENable */
38 #define DSI_WISR 0x040C /* Wrapper Interrupt and Status Reg */
39 #define WISR_PLLLS BIT(8) /* PLL Lock Status */
40 #define WISR_RRS BIT(12) /* Regulator Ready Status */
42 #define DSI_WPCR0 0x0418 /* Wrapper Phy Conf Reg 0 */
43 #define WPCR0_UIX4 GENMASK(5, 0) /* Unit Interval X 4 */
44 #define WPCR0_TDDL BIT(16) /* Turn Disable Data Lanes */
46 #define DSI_WRPCR 0x0430 /* Wrapper Regulator & Pll Ctrl Reg */
47 #define WRPCR_PLLEN BIT(0) /* PLL ENable */
48 #define WRPCR_NDIV GENMASK(8, 2) /* pll loop DIVision Factor */
49 #define WRPCR_IDF GENMASK(14, 11) /* pll Input Division Factor */
50 #define WRPCR_ODF GENMASK(17, 16) /* pll Output Division Factor */
51 #define WRPCR_REGEN BIT(24) /* REGulator ENable */
52 #define WRPCR_BGREN BIT(28) /* BandGap Reference ENable */
60 /* dsi color format coding according to the datasheet */
70 #define LANE_MIN_KBPS 31250
71 #define LANE_MAX_KBPS 500000
73 /* Sleep & timeout for regulator on/off, pll lock/unlock & fifo empty */
75 #define TIMEOUT_US 200000
77 struct dw_mipi_dsi_stm {
79 struct clk *pllref_clk;
80 struct dw_mipi_dsi *dsi;
84 struct regulator *vdd_supply;
87 static inline void dsi_write(struct dw_mipi_dsi_stm *dsi, u32 reg, u32 val)
89 writel(val, dsi->base + reg);
92 static inline u32 dsi_read(struct dw_mipi_dsi_stm *dsi, u32 reg)
94 return readl(dsi->base + reg);
97 static inline void dsi_set(struct dw_mipi_dsi_stm *dsi, u32 reg, u32 mask)
99 dsi_write(dsi, reg, dsi_read(dsi, reg) | mask);
102 static inline void dsi_clear(struct dw_mipi_dsi_stm *dsi, u32 reg, u32 mask)
104 dsi_write(dsi, reg, dsi_read(dsi, reg) & ~mask);
107 static inline void dsi_update_bits(struct dw_mipi_dsi_stm *dsi, u32 reg,
110 dsi_write(dsi, reg, (dsi_read(dsi, reg) & ~mask) | val);
113 static enum dsi_color dsi_color_from_mipi(enum mipi_dsi_pixel_format fmt)
116 case MIPI_DSI_FMT_RGB888:
118 case MIPI_DSI_FMT_RGB666:
119 return DSI_RGB666_CONF2;
120 case MIPI_DSI_FMT_RGB666_PACKED:
121 return DSI_RGB666_CONF1;
122 case MIPI_DSI_FMT_RGB565:
123 return DSI_RGB565_CONF1;
125 DRM_DEBUG_DRIVER("MIPI color invalid, so we use rgb888\n");
130 static int dsi_pll_get_clkout_khz(int clkin_khz, int idf, int ndiv, int odf)
132 int divisor = idf * odf;
134 /* prevent from division by 0 */
138 return DIV_ROUND_CLOSEST(clkin_khz * ndiv, divisor);
141 static int dsi_pll_get_params(struct dw_mipi_dsi_stm *dsi,
142 int clkin_khz, int clkout_khz,
143 int *idf, int *ndiv, int *odf)
145 int i, o, n, n_min, n_max;
146 int fvco_min, fvco_max, delta, best_delta; /* all in khz */
148 /* Early checks preventing division by 0 & odd results */
149 if (clkin_khz <= 0 || clkout_khz <= 0)
152 fvco_min = dsi->lane_min_kbps * 2 * ODF_MAX;
153 fvco_max = dsi->lane_max_kbps * 2 * ODF_MIN;
155 best_delta = 1000000; /* big started value (1000000khz) */
157 for (i = IDF_MIN; i <= IDF_MAX; i++) {
158 /* Compute ndiv range according to Fvco */
159 n_min = ((fvco_min * i) / (2 * clkin_khz)) + 1;
160 n_max = (fvco_max * i) / (2 * clkin_khz);
162 /* No need to continue idf loop if we reach ndiv max */
163 if (n_min >= NDIV_MAX)
166 /* Clamp ndiv to valid values */
167 if (n_min < NDIV_MIN)
169 if (n_max > NDIV_MAX)
172 for (o = ODF_MIN; o <= ODF_MAX; o *= 2) {
173 n = DIV_ROUND_CLOSEST(i * o * clkout_khz, clkin_khz);
174 /* Check ndiv according to vco range */
175 if (n < n_min || n > n_max)
177 /* Check if new delta is better & saves parameters */
178 delta = dsi_pll_get_clkout_khz(clkin_khz, i, n, o) -
182 if (delta < best_delta) {
188 /* fast return in case of "perfect result" */
197 static int dw_mipi_dsi_phy_init(void *priv_data)
199 struct dw_mipi_dsi_stm *dsi = priv_data;
203 /* Enable the regulator */
204 dsi_set(dsi, DSI_WRPCR, WRPCR_REGEN | WRPCR_BGREN);
205 ret = readl_poll_timeout(dsi->base + DSI_WISR, val, val & WISR_RRS,
206 SLEEP_US, TIMEOUT_US);
208 DRM_DEBUG_DRIVER("!TIMEOUT! waiting REGU, let's continue\n");
210 /* Enable the DSI PLL & wait for its lock */
211 dsi_set(dsi, DSI_WRPCR, WRPCR_PLLEN);
212 ret = readl_poll_timeout(dsi->base + DSI_WISR, val, val & WISR_PLLLS,
213 SLEEP_US, TIMEOUT_US);
215 DRM_DEBUG_DRIVER("!TIMEOUT! waiting PLL, let's continue\n");
220 static void dw_mipi_dsi_phy_power_on(void *priv_data)
222 struct dw_mipi_dsi_stm *dsi = priv_data;
224 DRM_DEBUG_DRIVER("\n");
226 /* Enable the DSI wrapper */
227 dsi_set(dsi, DSI_WCR, WCR_DSIEN);
230 static void dw_mipi_dsi_phy_power_off(void *priv_data)
232 struct dw_mipi_dsi_stm *dsi = priv_data;
234 DRM_DEBUG_DRIVER("\n");
236 /* Disable the DSI wrapper */
237 dsi_clear(dsi, DSI_WCR, WCR_DSIEN);
241 dw_mipi_dsi_get_lane_mbps(void *priv_data, const struct drm_display_mode *mode,
242 unsigned long mode_flags, u32 lanes, u32 format,
243 unsigned int *lane_mbps)
245 struct dw_mipi_dsi_stm *dsi = priv_data;
246 unsigned int idf, ndiv, odf, pll_in_khz, pll_out_khz;
250 pll_in_khz = (unsigned int)(clk_get_rate(dsi->pllref_clk) / 1000);
252 /* Compute requested pll out */
253 bpp = mipi_dsi_pixel_format_to_bpp(format);
254 pll_out_khz = mode->clock * bpp / lanes;
256 /* Add 20% to pll out to be higher than pixel bw (burst mode only) */
257 if (mode_flags & MIPI_DSI_MODE_VIDEO_BURST)
258 pll_out_khz = (pll_out_khz * 12) / 10;
260 if (pll_out_khz > dsi->lane_max_kbps) {
261 pll_out_khz = dsi->lane_max_kbps;
262 DRM_WARN("Warning max phy mbps is used\n");
264 if (pll_out_khz < dsi->lane_min_kbps) {
265 pll_out_khz = dsi->lane_min_kbps;
266 DRM_WARN("Warning min phy mbps is used\n");
269 /* Compute best pll parameters */
273 ret = dsi_pll_get_params(dsi, pll_in_khz, pll_out_khz,
276 DRM_WARN("Warning dsi_pll_get_params(): bad params\n");
278 /* Get the adjusted pll out value */
279 pll_out_khz = dsi_pll_get_clkout_khz(pll_in_khz, idf, ndiv, odf);
281 /* Set the PLL division factors */
282 dsi_update_bits(dsi, DSI_WRPCR, WRPCR_NDIV | WRPCR_IDF | WRPCR_ODF,
283 (ndiv << 2) | (idf << 11) | ((ffs(odf) - 1) << 16));
285 /* Compute uix4 & set the bit period in high-speed mode */
286 val = 4000000 / pll_out_khz;
287 dsi_update_bits(dsi, DSI_WPCR0, WPCR0_UIX4, val);
289 /* Select video mode by resetting DSIM bit */
290 dsi_clear(dsi, DSI_WCFGR, WCFGR_DSIM);
292 /* Select the color coding */
293 dsi_update_bits(dsi, DSI_WCFGR, WCFGR_COLMUX,
294 dsi_color_from_mipi(format) << 1);
296 *lane_mbps = pll_out_khz / 1000;
298 DRM_DEBUG_DRIVER("pll_in %ukHz pll_out %ukHz lane_mbps %uMHz\n",
299 pll_in_khz, pll_out_khz, *lane_mbps);
304 #define DSI_PHY_DELAY(fp, vp, mbps) DIV_ROUND_UP((fp) * (mbps) + 1000 * (vp), 8000)
307 dw_mipi_dsi_phy_get_timing(void *priv_data, unsigned int lane_mbps,
308 struct dw_mipi_dsi_dphy_timing *timing)
311 * From STM32MP157 datasheet, valid for STM32F469, STM32F7x9, STM32H747
312 * phy_clkhs2lp_time = (272+136*UI)/(8*UI)
313 * phy_clklp2hs_time = (512+40*UI)/(8*UI)
314 * phy_hs2lp_time = (192+64*UI)/(8*UI)
315 * phy_lp2hs_time = (256+32*UI)/(8*UI)
317 timing->clk_hs2lp = DSI_PHY_DELAY(272, 136, lane_mbps);
318 timing->clk_lp2hs = DSI_PHY_DELAY(512, 40, lane_mbps);
319 timing->data_hs2lp = DSI_PHY_DELAY(192, 64, lane_mbps);
320 timing->data_lp2hs = DSI_PHY_DELAY(256, 32, lane_mbps);
325 #define CLK_TOLERANCE_HZ 50
327 static enum drm_mode_status
328 dw_mipi_dsi_stm_mode_valid(void *priv_data,
329 const struct drm_display_mode *mode,
330 unsigned long mode_flags, u32 lanes, u32 format)
332 struct dw_mipi_dsi_stm *dsi = priv_data;
333 unsigned int idf, ndiv, odf, pll_in_khz, pll_out_khz;
336 bpp = mipi_dsi_pixel_format_to_bpp(format);
340 /* Compute requested pll out */
341 pll_out_khz = mode->clock * bpp / lanes;
343 if (pll_out_khz > dsi->lane_max_kbps)
344 return MODE_CLOCK_HIGH;
346 if (mode_flags & MIPI_DSI_MODE_VIDEO_BURST) {
347 /* Add 20% to pll out to be higher than pixel bw */
348 pll_out_khz = (pll_out_khz * 12) / 10;
350 if (pll_out_khz < dsi->lane_min_kbps)
351 return MODE_CLOCK_LOW;
354 /* Compute best pll parameters */
358 pll_in_khz = clk_get_rate(dsi->pllref_clk) / 1000;
359 ret = dsi_pll_get_params(dsi, pll_in_khz, pll_out_khz, &idf, &ndiv, &odf);
361 DRM_WARN("Warning dsi_pll_get_params(): bad params\n");
365 if (!(mode_flags & MIPI_DSI_MODE_VIDEO_BURST)) {
366 unsigned int px_clock_hz, target_px_clock_hz, lane_mbps;
367 int dsi_short_packet_size_px, hfp, hsync, hbp, delay_to_lp;
368 struct dw_mipi_dsi_dphy_timing dphy_timing;
370 /* Get the adjusted pll out value */
371 pll_out_khz = dsi_pll_get_clkout_khz(pll_in_khz, idf, ndiv, odf);
373 px_clock_hz = DIV_ROUND_CLOSEST_ULL(1000ULL * pll_out_khz * lanes, bpp);
374 target_px_clock_hz = mode->clock * 1000;
376 * Filter modes according to the clock value, particularly useful for
377 * hdmi modes that require precise pixel clocks.
379 if (px_clock_hz < target_px_clock_hz - CLK_TOLERANCE_HZ ||
380 px_clock_hz > target_px_clock_hz + CLK_TOLERANCE_HZ)
381 return MODE_CLOCK_RANGE;
383 /* sync packets are codes as DSI short packets (4 bytes) */
384 dsi_short_packet_size_px = DIV_ROUND_UP(4 * BITS_PER_BYTE, bpp);
386 hfp = mode->hsync_start - mode->hdisplay;
387 hsync = mode->hsync_end - mode->hsync_start;
388 hbp = mode->htotal - mode->hsync_end;
390 /* hsync must be longer than 4 bytes HSS packets */
391 if (hsync < dsi_short_packet_size_px)
392 return MODE_HSYNC_NARROW;
394 if (mode_flags & MIPI_DSI_MODE_VIDEO_SYNC_PULSE) {
395 /* HBP must be longer than 4 bytes HSE packets */
396 if (hbp < dsi_short_packet_size_px)
397 return MODE_HSYNC_NARROW;
398 hbp -= dsi_short_packet_size_px;
400 /* With sync events HBP extends in the hsync */
401 hbp += hsync - dsi_short_packet_size_px;
404 lane_mbps = pll_out_khz / 1000;
405 ret = dw_mipi_dsi_phy_get_timing(priv_data, lane_mbps, &dphy_timing);
409 * In non-burst mode DSI has to enter in LP during HFP
410 * (horizontal front porch) or HBP (horizontal back porch) to
411 * resync with LTDC pixel clock.
413 delay_to_lp = DIV_ROUND_UP((dphy_timing.data_hs2lp + dphy_timing.data_lp2hs) *
414 lanes * BITS_PER_BYTE, bpp);
415 if (hfp < delay_to_lp && hbp < delay_to_lp)
422 static const struct dw_mipi_dsi_phy_ops dw_mipi_dsi_stm_phy_ops = {
423 .init = dw_mipi_dsi_phy_init,
424 .power_on = dw_mipi_dsi_phy_power_on,
425 .power_off = dw_mipi_dsi_phy_power_off,
426 .get_lane_mbps = dw_mipi_dsi_get_lane_mbps,
427 .get_timing = dw_mipi_dsi_phy_get_timing,
430 static struct dw_mipi_dsi_plat_data dw_mipi_dsi_stm_plat_data = {
432 .mode_valid = dw_mipi_dsi_stm_mode_valid,
433 .phy_ops = &dw_mipi_dsi_stm_phy_ops,
436 static const struct of_device_id dw_mipi_dsi_stm_dt_ids[] = {
437 { .compatible = "st,stm32-dsi", .data = &dw_mipi_dsi_stm_plat_data, },
440 MODULE_DEVICE_TABLE(of, dw_mipi_dsi_stm_dt_ids);
442 static int dw_mipi_dsi_stm_probe(struct platform_device *pdev)
444 struct device *dev = &pdev->dev;
445 struct dw_mipi_dsi_stm *dsi;
447 struct resource *res;
450 dsi = devm_kzalloc(dev, sizeof(*dsi), GFP_KERNEL);
454 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
455 dsi->base = devm_ioremap_resource(dev, res);
456 if (IS_ERR(dsi->base)) {
457 ret = PTR_ERR(dsi->base);
458 DRM_ERROR("Unable to get dsi registers %d\n", ret);
462 dsi->vdd_supply = devm_regulator_get(dev, "phy-dsi");
463 if (IS_ERR(dsi->vdd_supply)) {
464 ret = PTR_ERR(dsi->vdd_supply);
465 dev_err_probe(dev, ret, "Failed to request regulator\n");
469 ret = regulator_enable(dsi->vdd_supply);
471 DRM_ERROR("Failed to enable regulator: %d\n", ret);
475 dsi->pllref_clk = devm_clk_get(dev, "ref");
476 if (IS_ERR(dsi->pllref_clk)) {
477 ret = PTR_ERR(dsi->pllref_clk);
478 dev_err_probe(dev, ret, "Unable to get pll reference clock\n");
482 ret = clk_prepare_enable(dsi->pllref_clk);
484 DRM_ERROR("Failed to enable pllref_clk: %d\n", ret);
488 pclk = devm_clk_get(dev, "pclk");
491 DRM_ERROR("Unable to get peripheral clock: %d\n", ret);
495 ret = clk_prepare_enable(pclk);
497 DRM_ERROR("%s: Failed to enable peripheral clk\n", __func__);
501 dsi->hw_version = dsi_read(dsi, DSI_VERSION) & VERSION;
502 clk_disable_unprepare(pclk);
504 if (dsi->hw_version != HWVER_130 && dsi->hw_version != HWVER_131) {
506 DRM_ERROR("bad dsi hardware version\n");
510 /* set lane capabilities according to hw version */
511 dsi->lane_min_kbps = LANE_MIN_KBPS;
512 dsi->lane_max_kbps = LANE_MAX_KBPS;
513 if (dsi->hw_version == HWVER_131) {
514 dsi->lane_min_kbps *= 2;
515 dsi->lane_max_kbps *= 2;
518 dw_mipi_dsi_stm_plat_data.base = dsi->base;
519 dw_mipi_dsi_stm_plat_data.priv_data = dsi;
521 platform_set_drvdata(pdev, dsi);
523 dsi->dsi = dw_mipi_dsi_probe(pdev, &dw_mipi_dsi_stm_plat_data);
524 if (IS_ERR(dsi->dsi)) {
525 ret = PTR_ERR(dsi->dsi);
526 dev_err_probe(dev, ret, "Failed to initialize mipi dsi host\n");
533 clk_disable_unprepare(dsi->pllref_clk);
535 regulator_disable(dsi->vdd_supply);
540 static int dw_mipi_dsi_stm_remove(struct platform_device *pdev)
542 struct dw_mipi_dsi_stm *dsi = platform_get_drvdata(pdev);
544 dw_mipi_dsi_remove(dsi->dsi);
545 clk_disable_unprepare(dsi->pllref_clk);
546 regulator_disable(dsi->vdd_supply);
551 static int __maybe_unused dw_mipi_dsi_stm_suspend(struct device *dev)
553 struct dw_mipi_dsi_stm *dsi = dw_mipi_dsi_stm_plat_data.priv_data;
555 DRM_DEBUG_DRIVER("\n");
557 clk_disable_unprepare(dsi->pllref_clk);
558 regulator_disable(dsi->vdd_supply);
563 static int __maybe_unused dw_mipi_dsi_stm_resume(struct device *dev)
565 struct dw_mipi_dsi_stm *dsi = dw_mipi_dsi_stm_plat_data.priv_data;
568 DRM_DEBUG_DRIVER("\n");
570 ret = regulator_enable(dsi->vdd_supply);
572 DRM_ERROR("Failed to enable regulator: %d\n", ret);
576 ret = clk_prepare_enable(dsi->pllref_clk);
578 regulator_disable(dsi->vdd_supply);
579 DRM_ERROR("Failed to enable pllref_clk: %d\n", ret);
586 static const struct dev_pm_ops dw_mipi_dsi_stm_pm_ops = {
587 SET_SYSTEM_SLEEP_PM_OPS(dw_mipi_dsi_stm_suspend,
588 dw_mipi_dsi_stm_resume)
591 static struct platform_driver dw_mipi_dsi_stm_driver = {
592 .probe = dw_mipi_dsi_stm_probe,
593 .remove = dw_mipi_dsi_stm_remove,
595 .of_match_table = dw_mipi_dsi_stm_dt_ids,
596 .name = "stm32-display-dsi",
597 .pm = &dw_mipi_dsi_stm_pm_ops,
601 module_platform_driver(dw_mipi_dsi_stm_driver);
603 MODULE_AUTHOR("Philippe Cornu <philippe.cornu@st.com>");
604 MODULE_AUTHOR("Yannick Fertre <yannick.fertre@st.com>");
605 MODULE_DESCRIPTION("STMicroelectronics DW MIPI DSI host controller driver");
606 MODULE_LICENSE("GPL v2");