xref: /linux/drivers/gpu/drm/bridge/fsl-ldb.c (revision 7d1f84f1b94e79cb95d974ab3ec54cb3a4d64f5b)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  * Copyright (C) 2022 Marek Vasut <marex@denx.de>
4  */
5 
6 #include <linux/clk.h>
7 #include <linux/media-bus-format.h>
8 #include <linux/mfd/syscon.h>
9 #include <linux/module.h>
10 #include <linux/of.h>
11 #include <linux/of_graph.h>
12 #include <linux/platform_device.h>
13 #include <linux/regmap.h>
14 
15 #include <drm/drm_atomic_helper.h>
16 #include <drm/drm_bridge.h>
17 #include <drm/drm_of.h>
18 
19 #define LDB_CTRL_CH0_ENABLE			BIT(0)
20 #define LDB_CTRL_CH0_DI_SELECT			BIT(1)
21 #define LDB_CTRL_CH1_ENABLE			BIT(2)
22 #define LDB_CTRL_CH1_DI_SELECT			BIT(3)
23 #define LDB_CTRL_SPLIT_MODE			BIT(4)
24 #define LDB_CTRL_CH0_DATA_WIDTH			BIT(5)
25 #define LDB_CTRL_CH0_BIT_MAPPING		BIT(6)
26 #define LDB_CTRL_CH1_DATA_WIDTH			BIT(7)
27 #define LDB_CTRL_CH1_BIT_MAPPING		BIT(8)
28 #define LDB_CTRL_DI0_VSYNC_POLARITY		BIT(9)
29 #define LDB_CTRL_DI1_VSYNC_POLARITY		BIT(10)
30 #define LDB_CTRL_REG_CH0_FIFO_RESET		BIT(11)
31 #define LDB_CTRL_REG_CH1_FIFO_RESET		BIT(12)
32 #define LDB_CTRL_ASYNC_FIFO_ENABLE		BIT(24)
33 #define LDB_CTRL_ASYNC_FIFO_THRESHOLD_MASK	GENMASK(27, 25)
34 
35 #define LVDS_CTRL_CH0_EN			BIT(0)
36 #define LVDS_CTRL_CH1_EN			BIT(1)
37 /*
38  * LVDS_CTRL_LVDS_EN bit is poorly named in i.MX93 reference manual.
39  * Clear it to enable LVDS and set it to disable LVDS.
40  */
41 #define LVDS_CTRL_LVDS_EN			BIT(1)
42 #define LVDS_CTRL_VBG_EN			BIT(2)
43 #define LVDS_CTRL_HS_EN				BIT(3)
44 #define LVDS_CTRL_PRE_EMPH_EN			BIT(4)
45 #define LVDS_CTRL_PRE_EMPH_ADJ(n)		(((n) & 0x7) << 5)
46 #define LVDS_CTRL_PRE_EMPH_ADJ_MASK		GENMASK(7, 5)
47 #define LVDS_CTRL_CM_ADJ(n)			(((n) & 0x7) << 8)
48 #define LVDS_CTRL_CM_ADJ_MASK			GENMASK(10, 8)
49 #define LVDS_CTRL_CC_ADJ(n)			(((n) & 0x7) << 11)
50 #define LVDS_CTRL_CC_ADJ_MASK			GENMASK(13, 11)
51 #define LVDS_CTRL_SLEW_ADJ(n)			(((n) & 0x7) << 14)
52 #define LVDS_CTRL_SLEW_ADJ_MASK			GENMASK(16, 14)
53 #define LVDS_CTRL_VBG_ADJ(n)			(((n) & 0x7) << 17)
54 #define LVDS_CTRL_VBG_ADJ_MASK			GENMASK(19, 17)
55 
56 enum fsl_ldb_devtype {
57 	IMX6SX_LDB,
58 	IMX8MP_LDB,
59 	IMX93_LDB,
60 };
61 
62 struct fsl_ldb_devdata {
63 	u32 ldb_ctrl;
64 	u32 lvds_ctrl;
65 	bool lvds_en_bit;
66 	bool single_ctrl_reg;
67 };
68 
69 static const struct fsl_ldb_devdata fsl_ldb_devdata[] = {
70 	[IMX6SX_LDB] = {
71 		.ldb_ctrl = 0x18,
72 		.single_ctrl_reg = true,
73 	},
74 	[IMX8MP_LDB] = {
75 		.ldb_ctrl = 0x5c,
76 		.lvds_ctrl = 0x128,
77 	},
78 	[IMX93_LDB] = {
79 		.ldb_ctrl = 0x20,
80 		.lvds_ctrl = 0x24,
81 		.lvds_en_bit = true,
82 	},
83 };
84 
85 struct fsl_ldb {
86 	struct device *dev;
87 	struct drm_bridge bridge;
88 	struct clk *clk;
89 	struct regmap *regmap;
90 	const struct fsl_ldb_devdata *devdata;
91 	bool ch0_enabled;
92 	bool ch1_enabled;
93 	bool use_termination_resistor;
94 };
95 
96 static bool fsl_ldb_is_dual(const struct fsl_ldb *fsl_ldb)
97 {
98 	return (fsl_ldb->ch0_enabled && fsl_ldb->ch1_enabled);
99 }
100 
101 static inline struct fsl_ldb *to_fsl_ldb(struct drm_bridge *bridge)
102 {
103 	return container_of(bridge, struct fsl_ldb, bridge);
104 }
105 
106 static unsigned long fsl_ldb_link_frequency(struct fsl_ldb *fsl_ldb, int clock)
107 {
108 	if (fsl_ldb_is_dual(fsl_ldb))
109 		return clock * 3500;
110 	else
111 		return clock * 7000;
112 }
113 
114 static int fsl_ldb_attach(struct drm_bridge *bridge,
115 			  struct drm_encoder *encoder,
116 			  enum drm_bridge_attach_flags flags)
117 {
118 	struct fsl_ldb *fsl_ldb = to_fsl_ldb(bridge);
119 
120 	return drm_bridge_attach(encoder, fsl_ldb->bridge.next_bridge,
121 				 bridge, flags);
122 }
123 
124 static void fsl_ldb_atomic_enable(struct drm_bridge *bridge,
125 				  struct drm_atomic_commit *state)
126 {
127 	struct fsl_ldb *fsl_ldb = to_fsl_ldb(bridge);
128 	const struct drm_bridge_state *bridge_state;
129 	const struct drm_crtc_state *crtc_state;
130 	const struct drm_display_mode *mode;
131 	struct drm_connector *connector;
132 	struct drm_crtc *crtc;
133 	unsigned long configured_link_freq;
134 	unsigned long requested_link_freq;
135 	bool lvds_format_24bpp;
136 	bool lvds_format_jeida;
137 	u32 reg;
138 
139 	/* Get the LVDS format from the bridge state. */
140 	bridge_state = drm_atomic_get_new_bridge_state(state, bridge);
141 
142 	switch (bridge_state->output_bus_cfg.format) {
143 	case MEDIA_BUS_FMT_RGB666_1X7X3_SPWG:
144 		lvds_format_24bpp = false;
145 		lvds_format_jeida = true;
146 		break;
147 	case MEDIA_BUS_FMT_RGB888_1X7X4_JEIDA:
148 		lvds_format_24bpp = true;
149 		lvds_format_jeida = true;
150 		break;
151 	case MEDIA_BUS_FMT_RGB888_1X7X4_SPWG:
152 		lvds_format_24bpp = true;
153 		lvds_format_jeida = false;
154 		break;
155 	default:
156 		/*
157 		 * Some bridges still don't set the correct LVDS bus pixel
158 		 * format, use SPWG24 default format until those are fixed.
159 		 */
160 		lvds_format_24bpp = true;
161 		lvds_format_jeida = false;
162 		dev_warn(fsl_ldb->dev,
163 			 "Unsupported LVDS bus format 0x%04x, please check output bridge driver. Falling back to SPWG24.\n",
164 			 bridge_state->output_bus_cfg.format);
165 		break;
166 	}
167 
168 	/*
169 	 * Retrieve the CRTC adjusted mode. This requires a little dance to go
170 	 * from the bridge to the encoder, to the connector and to the CRTC.
171 	 */
172 	connector = drm_atomic_get_new_connector_for_encoder(state,
173 							     bridge->encoder);
174 	crtc = drm_atomic_get_new_connector_state(state, connector)->crtc;
175 	crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
176 	mode = &crtc_state->adjusted_mode;
177 
178 	requested_link_freq = fsl_ldb_link_frequency(fsl_ldb, mode->clock);
179 	clk_set_rate(fsl_ldb->clk, requested_link_freq);
180 
181 	configured_link_freq = clk_get_rate(fsl_ldb->clk);
182 	if (configured_link_freq != requested_link_freq)
183 		dev_warn(fsl_ldb->dev,
184 			 "Configured %pC clock (%lu Hz) does not match requested LVDS clock: %lu Hz\n",
185 			 fsl_ldb->clk, configured_link_freq, requested_link_freq);
186 
187 	clk_prepare_enable(fsl_ldb->clk);
188 
189 	/* Program LDB_CTRL */
190 	reg =	(fsl_ldb->ch0_enabled ? LDB_CTRL_CH0_ENABLE : 0) |
191 		(fsl_ldb->ch1_enabled ? LDB_CTRL_CH1_ENABLE : 0) |
192 		(fsl_ldb_is_dual(fsl_ldb) ? LDB_CTRL_SPLIT_MODE : 0);
193 
194 	if (lvds_format_24bpp)
195 		reg |=	(fsl_ldb->ch0_enabled ? LDB_CTRL_CH0_DATA_WIDTH : 0) |
196 			(fsl_ldb->ch1_enabled ? LDB_CTRL_CH1_DATA_WIDTH : 0);
197 
198 	if (lvds_format_jeida)
199 		reg |=	(fsl_ldb->ch0_enabled ? LDB_CTRL_CH0_BIT_MAPPING : 0) |
200 			(fsl_ldb->ch1_enabled ? LDB_CTRL_CH1_BIT_MAPPING : 0);
201 
202 	if (mode->flags & DRM_MODE_FLAG_PVSYNC)
203 		reg |=	(fsl_ldb->ch0_enabled ? LDB_CTRL_DI0_VSYNC_POLARITY : 0) |
204 			(fsl_ldb->ch1_enabled ? LDB_CTRL_DI1_VSYNC_POLARITY : 0);
205 
206 	regmap_write(fsl_ldb->regmap, fsl_ldb->devdata->ldb_ctrl, reg);
207 
208 	if (fsl_ldb->devdata->single_ctrl_reg)
209 		return;
210 
211 	/* Program LVDS_CTRL */
212 	reg = LVDS_CTRL_CC_ADJ(2) | LVDS_CTRL_PRE_EMPH_EN |
213 	      LVDS_CTRL_PRE_EMPH_ADJ(3) | LVDS_CTRL_VBG_EN;
214 
215 	if (fsl_ldb->use_termination_resistor)
216 		reg |= LVDS_CTRL_HS_EN;
217 	regmap_write(fsl_ldb->regmap, fsl_ldb->devdata->lvds_ctrl, reg);
218 
219 	/* Wait for VBG to stabilize. */
220 	usleep_range(15, 20);
221 
222 	reg |=	(fsl_ldb->ch0_enabled ? LVDS_CTRL_CH0_EN : 0) |
223 		(fsl_ldb->ch1_enabled ? LVDS_CTRL_CH1_EN : 0);
224 
225 	regmap_write(fsl_ldb->regmap, fsl_ldb->devdata->lvds_ctrl, reg);
226 }
227 
228 static void fsl_ldb_atomic_disable(struct drm_bridge *bridge,
229 				   struct drm_atomic_commit *state)
230 {
231 	struct fsl_ldb *fsl_ldb = to_fsl_ldb(bridge);
232 
233 	/* Stop channel(s). */
234 	if (fsl_ldb->devdata->lvds_en_bit)
235 		/* Set LVDS_CTRL_LVDS_EN bit to disable. */
236 		regmap_write(fsl_ldb->regmap, fsl_ldb->devdata->lvds_ctrl,
237 			     LVDS_CTRL_LVDS_EN);
238 	else
239 		if (!fsl_ldb->devdata->single_ctrl_reg)
240 			regmap_write(fsl_ldb->regmap, fsl_ldb->devdata->lvds_ctrl, 0);
241 	regmap_write(fsl_ldb->regmap, fsl_ldb->devdata->ldb_ctrl, 0);
242 
243 	clk_disable_unprepare(fsl_ldb->clk);
244 }
245 
246 #define MAX_INPUT_SEL_FORMATS 1
247 static u32 *
248 fsl_ldb_atomic_get_input_bus_fmts(struct drm_bridge *bridge,
249 				  struct drm_bridge_state *bridge_state,
250 				  struct drm_crtc_state *crtc_state,
251 				  struct drm_connector_state *conn_state,
252 				  u32 output_fmt,
253 				  unsigned int *num_input_fmts)
254 {
255 	u32 *input_fmts;
256 
257 	*num_input_fmts = 0;
258 
259 	input_fmts = kcalloc(MAX_INPUT_SEL_FORMATS, sizeof(*input_fmts),
260 			     GFP_KERNEL);
261 	if (!input_fmts)
262 		return NULL;
263 
264 	input_fmts[0] = MEDIA_BUS_FMT_RGB888_1X24;
265 	*num_input_fmts = MAX_INPUT_SEL_FORMATS;
266 
267 	return input_fmts;
268 }
269 
270 static enum drm_mode_status
271 fsl_ldb_mode_valid(struct drm_bridge *bridge,
272 		   const struct drm_display_info *info,
273 		   const struct drm_display_mode *mode)
274 {
275 	struct fsl_ldb *fsl_ldb = to_fsl_ldb(bridge);
276 
277 	if (mode->clock > (fsl_ldb_is_dual(fsl_ldb) ? 160000 : 80000))
278 		return MODE_CLOCK_HIGH;
279 
280 	return MODE_OK;
281 }
282 
283 static const struct drm_bridge_funcs funcs = {
284 	.attach = fsl_ldb_attach,
285 	.atomic_enable = fsl_ldb_atomic_enable,
286 	.atomic_disable = fsl_ldb_atomic_disable,
287 	.atomic_duplicate_state = drm_atomic_helper_bridge_duplicate_state,
288 	.atomic_destroy_state = drm_atomic_helper_bridge_destroy_state,
289 	.atomic_get_input_bus_fmts = fsl_ldb_atomic_get_input_bus_fmts,
290 	.atomic_create_state = drm_atomic_helper_bridge_create_state,
291 	.mode_valid = fsl_ldb_mode_valid,
292 };
293 
294 static int fsl_ldb_probe(struct platform_device *pdev)
295 {
296 	struct device *dev = &pdev->dev;
297 	struct device_node *panel_node;
298 	struct device_node *remote1, *remote2;
299 	struct fsl_ldb *fsl_ldb;
300 	int dual_link;
301 
302 	fsl_ldb = devm_drm_bridge_alloc(dev, struct fsl_ldb, bridge, &funcs);
303 	if (IS_ERR(fsl_ldb))
304 		return PTR_ERR(fsl_ldb);
305 
306 	fsl_ldb->devdata = of_device_get_match_data(dev);
307 	if (!fsl_ldb->devdata)
308 		return -EINVAL;
309 
310 	fsl_ldb->dev = &pdev->dev;
311 	fsl_ldb->bridge.of_node = dev->of_node;
312 
313 	fsl_ldb->clk = devm_clk_get(dev, "ldb");
314 	if (IS_ERR(fsl_ldb->clk))
315 		return PTR_ERR(fsl_ldb->clk);
316 
317 	fsl_ldb->regmap = syscon_node_to_regmap(dev->of_node->parent);
318 	if (IS_ERR(fsl_ldb->regmap))
319 		return PTR_ERR(fsl_ldb->regmap);
320 
321 	/* Locate the remote ports and the panel node */
322 	remote1 = of_graph_get_remote_node(dev->of_node, 1, 0);
323 	remote2 = of_graph_get_remote_node(dev->of_node, 2, 0);
324 	fsl_ldb->ch0_enabled = (remote1 != NULL);
325 	fsl_ldb->ch1_enabled = (remote2 != NULL);
326 	panel_node = of_node_get(remote1 ? remote1 : remote2);
327 	of_node_put(remote1);
328 	of_node_put(remote2);
329 
330 	if (!fsl_ldb->ch0_enabled && !fsl_ldb->ch1_enabled) {
331 		of_node_put(panel_node);
332 		return dev_err_probe(dev, -ENXIO, "No panel node found");
333 	}
334 
335 	dev_dbg(dev, "Using %s\n",
336 		fsl_ldb_is_dual(fsl_ldb) ? "dual-link mode" :
337 		fsl_ldb->ch0_enabled ? "channel 0" : "channel 1");
338 
339 	if (of_property_present(dev->of_node, "nxp,enable-termination-resistor"))
340 		fsl_ldb->use_termination_resistor = true;
341 
342 	fsl_ldb->bridge.next_bridge = of_drm_find_and_get_bridge(panel_node);
343 	of_node_put(panel_node);
344 	if (!fsl_ldb->bridge.next_bridge)
345 		return -ENODEV;
346 
347 	if (fsl_ldb_is_dual(fsl_ldb)) {
348 		struct device_node *port1, *port2;
349 
350 		port1 = of_graph_get_port_by_id(dev->of_node, 1);
351 		port2 = of_graph_get_port_by_id(dev->of_node, 2);
352 		dual_link = drm_of_lvds_get_dual_link_pixel_order(port1, port2);
353 		of_node_put(port1);
354 		of_node_put(port2);
355 
356 		if (dual_link < 0)
357 			return dev_err_probe(dev, dual_link,
358 					     "Error getting dual link configuration\n");
359 
360 		/* Only DRM_LVDS_DUAL_LINK_ODD_EVEN_PIXELS is supported */
361 		if (dual_link == DRM_LVDS_DUAL_LINK_EVEN_ODD_PIXELS) {
362 			dev_err(dev, "LVDS channel pixel swap not supported.\n");
363 			return -EINVAL;
364 		}
365 	}
366 
367 	platform_set_drvdata(pdev, fsl_ldb);
368 
369 	drm_bridge_add(&fsl_ldb->bridge);
370 
371 	return 0;
372 }
373 
374 static void fsl_ldb_remove(struct platform_device *pdev)
375 {
376 	struct fsl_ldb *fsl_ldb = platform_get_drvdata(pdev);
377 
378 	drm_bridge_remove(&fsl_ldb->bridge);
379 }
380 
381 static const struct of_device_id fsl_ldb_match[] = {
382 	{ .compatible = "fsl,imx6sx-ldb",
383 	  .data = &fsl_ldb_devdata[IMX6SX_LDB], },
384 	{ .compatible = "fsl,imx8mp-ldb",
385 	  .data = &fsl_ldb_devdata[IMX8MP_LDB], },
386 	{ .compatible = "fsl,imx93-ldb",
387 	  .data = &fsl_ldb_devdata[IMX93_LDB], },
388 	{ /* sentinel */ },
389 };
390 MODULE_DEVICE_TABLE(of, fsl_ldb_match);
391 
392 static struct platform_driver fsl_ldb_driver = {
393 	.probe	= fsl_ldb_probe,
394 	.remove = fsl_ldb_remove,
395 	.driver		= {
396 		.name		= "fsl-ldb",
397 		.of_match_table	= fsl_ldb_match,
398 	},
399 };
400 module_platform_driver(fsl_ldb_driver);
401 
402 MODULE_AUTHOR("Marek Vasut <marex@denx.de>");
403 MODULE_DESCRIPTION("Freescale i.MX8MP LDB");
404 MODULE_LICENSE("GPL");
405