xref: /linux/drivers/gpu/drm/ingenic/ingenic-drm-drv.c (revision 3590a52f0d0903e600dd01e2cf30820c404beca4)
1 // SPDX-License-Identifier: GPL-2.0
2 //
3 // Ingenic JZ47xx KMS driver
4 //
5 // Copyright (C) 2019, Paul Cercueil <paul@crapouillou.net>
6 
7 #include "ingenic-drm.h"
8 
9 #include <linux/bitfield.h>
10 #include <linux/component.h>
11 #include <linux/clk.h>
12 #include <linux/dma-mapping.h>
13 #include <linux/io.h>
14 #include <linux/media-bus-format.h>
15 #include <linux/module.h>
16 #include <linux/mutex.h>
17 #include <linux/of.h>
18 #include <linux/of_reserved_mem.h>
19 #include <linux/platform_device.h>
20 #include <linux/pm.h>
21 #include <linux/regmap.h>
22 
23 #include <drm/clients/drm_client_setup.h>
24 #include <drm/drm_atomic.h>
25 #include <drm/drm_atomic_helper.h>
26 #include <drm/drm_bridge.h>
27 #include <drm/drm_bridge_connector.h>
28 #include <drm/drm_color_mgmt.h>
29 #include <drm/drm_crtc.h>
30 #include <drm/drm_damage_helper.h>
31 #include <drm/drm_drv.h>
32 #include <drm/drm_encoder.h>
33 #include <drm/drm_gem_dma_helper.h>
34 #include <drm/drm_fb_dma_helper.h>
35 #include <drm/drm_fbdev_dma.h>
36 #include <drm/drm_fourcc.h>
37 #include <drm/drm_framebuffer.h>
38 #include <drm/drm_gem_atomic_helper.h>
39 #include <drm/drm_gem_framebuffer_helper.h>
40 #include <drm/drm_managed.h>
41 #include <drm/drm_of.h>
42 #include <drm/drm_panel.h>
43 #include <drm/drm_plane.h>
44 #include <drm/drm_probe_helper.h>
45 #include <drm/drm_vblank.h>
46 
47 #define HWDESC_PALETTE 2
48 
49 struct ingenic_dma_hwdesc {
50 	u32 next;
51 	u32 addr;
52 	u32 id;
53 	u32 cmd;
54 	/* extended hw descriptor for jz4780 */
55 	u32 offsize;
56 	u32 pagewidth;
57 	u32 cpos;
58 	u32 dessize;
59 } __aligned(16);
60 
61 struct ingenic_dma_hwdescs {
62 	struct ingenic_dma_hwdesc hwdesc[3];
63 	u16 palette[256] __aligned(16);
64 };
65 
66 struct jz_soc_info {
67 	bool needs_dev_clk;
68 	bool has_osd;
69 	bool has_alpha;
70 	bool map_noncoherent;
71 	bool use_extended_hwdesc;
72 	bool plane_f0_not_working;
73 	u32 max_burst;
74 	unsigned int max_width, max_height;
75 	const u32 *formats_f0, *formats_f1;
76 	unsigned int num_formats_f0, num_formats_f1;
77 };
78 
79 struct ingenic_drm_private_state {
80 	struct drm_private_state base;
81 	bool use_palette;
82 };
83 
84 struct ingenic_drm {
85 	struct drm_device drm;
86 	/*
87 	 * f1 (aka. foreground1) is our primary plane, on top of which
88 	 * f0 (aka. foreground0) can be overlayed. Z-order is fixed in
89 	 * hardware and cannot be changed.
90 	 */
91 	struct drm_plane f0, f1, *ipu_plane;
92 	struct drm_crtc crtc;
93 
94 	struct device *dev;
95 	struct regmap *map;
96 	struct clk *lcd_clk, *pix_clk;
97 	const struct jz_soc_info *soc_info;
98 
99 	struct ingenic_dma_hwdescs *dma_hwdescs;
100 	dma_addr_t dma_hwdescs_phys;
101 
102 	bool panel_is_sharp;
103 	bool no_vblank;
104 
105 	/*
106 	 * clk_mutex is used to synchronize the pixel clock rate update with
107 	 * the VBLANK. When the pixel clock's parent clock needs to be updated,
108 	 * clock_nb's notifier function will lock the mutex, then wait until the
109 	 * next VBLANK. At that point, the parent clock's rate can be updated,
110 	 * and the mutex is then unlocked. If an atomic commit happens in the
111 	 * meantime, it will lock on the mutex, effectively waiting until the
112 	 * clock update process finishes. Finally, the pixel clock's rate will
113 	 * be recomputed when the mutex has been released, in the pending atomic
114 	 * commit, or a future one.
115 	 */
116 	struct mutex clk_mutex;
117 	bool update_clk_rate;
118 	struct notifier_block clock_nb;
119 
120 	struct drm_private_obj private_obj;
121 };
122 
123 struct ingenic_drm_bridge {
124 	struct drm_encoder encoder;
125 	struct drm_bridge bridge, *next_bridge;
126 
127 	struct drm_bus_cfg bus_cfg;
128 };
129 
130 static inline struct ingenic_drm_bridge *
131 to_ingenic_drm_bridge(struct drm_encoder *encoder)
132 {
133 	return container_of(encoder, struct ingenic_drm_bridge, encoder);
134 }
135 
136 static inline struct ingenic_drm_private_state *
137 to_ingenic_drm_priv_state(struct drm_private_state *state)
138 {
139 	return container_of(state, struct ingenic_drm_private_state, base);
140 }
141 
142 static struct ingenic_drm_private_state *
143 ingenic_drm_get_priv_state(struct ingenic_drm *priv, struct drm_atomic_state *state)
144 {
145 	struct drm_private_state *priv_state;
146 
147 	priv_state = drm_atomic_get_private_obj_state(state, &priv->private_obj);
148 	if (IS_ERR(priv_state))
149 		return ERR_CAST(priv_state);
150 
151 	return to_ingenic_drm_priv_state(priv_state);
152 }
153 
154 static struct ingenic_drm_private_state *
155 ingenic_drm_get_new_priv_state(struct ingenic_drm *priv, struct drm_atomic_state *state)
156 {
157 	struct drm_private_state *priv_state;
158 
159 	priv_state = drm_atomic_get_new_private_obj_state(state, &priv->private_obj);
160 	if (!priv_state)
161 		return NULL;
162 
163 	return to_ingenic_drm_priv_state(priv_state);
164 }
165 
166 static bool ingenic_drm_writeable_reg(struct device *dev, unsigned int reg)
167 {
168 	switch (reg) {
169 	case JZ_REG_LCD_IID:
170 	case JZ_REG_LCD_SA0:
171 	case JZ_REG_LCD_FID0:
172 	case JZ_REG_LCD_CMD0:
173 	case JZ_REG_LCD_SA1:
174 	case JZ_REG_LCD_FID1:
175 	case JZ_REG_LCD_CMD1:
176 		return false;
177 	default:
178 		return true;
179 	}
180 }
181 
182 static const struct regmap_config ingenic_drm_regmap_config = {
183 	.reg_bits = 32,
184 	.val_bits = 32,
185 	.reg_stride = 4,
186 
187 	.writeable_reg = ingenic_drm_writeable_reg,
188 };
189 
190 static inline struct ingenic_drm *drm_device_get_priv(struct drm_device *drm)
191 {
192 	return container_of(drm, struct ingenic_drm, drm);
193 }
194 
195 static inline struct ingenic_drm *drm_crtc_get_priv(struct drm_crtc *crtc)
196 {
197 	return container_of(crtc, struct ingenic_drm, crtc);
198 }
199 
200 static inline struct ingenic_drm *drm_nb_get_priv(struct notifier_block *nb)
201 {
202 	return container_of(nb, struct ingenic_drm, clock_nb);
203 }
204 
205 static inline dma_addr_t dma_hwdesc_addr(const struct ingenic_drm *priv,
206 					 unsigned int idx)
207 {
208 	u32 offset = offsetof(struct ingenic_dma_hwdescs, hwdesc[idx]);
209 
210 	return priv->dma_hwdescs_phys + offset;
211 }
212 
213 static int ingenic_drm_update_pixclk(struct notifier_block *nb,
214 				     unsigned long action,
215 				     void *data)
216 {
217 	struct ingenic_drm *priv = drm_nb_get_priv(nb);
218 
219 	switch (action) {
220 	case PRE_RATE_CHANGE:
221 		mutex_lock(&priv->clk_mutex);
222 		priv->update_clk_rate = true;
223 		drm_crtc_wait_one_vblank(&priv->crtc);
224 		return NOTIFY_OK;
225 	default:
226 		mutex_unlock(&priv->clk_mutex);
227 		return NOTIFY_OK;
228 	}
229 }
230 
231 static void ingenic_drm_bridge_atomic_enable(struct drm_bridge *bridge,
232 					     struct drm_atomic_state *state)
233 {
234 	struct ingenic_drm *priv = drm_device_get_priv(bridge->dev);
235 
236 	regmap_write(priv->map, JZ_REG_LCD_STATE, 0);
237 
238 	regmap_update_bits(priv->map, JZ_REG_LCD_CTRL,
239 			   JZ_LCD_CTRL_ENABLE | JZ_LCD_CTRL_DISABLE,
240 			   JZ_LCD_CTRL_ENABLE);
241 }
242 
243 static void ingenic_drm_crtc_atomic_enable(struct drm_crtc *crtc,
244 					   struct drm_atomic_state *state)
245 {
246 	struct ingenic_drm *priv = drm_crtc_get_priv(crtc);
247 	struct ingenic_drm_private_state *priv_state;
248 	unsigned int next_id;
249 
250 	priv_state = ingenic_drm_get_new_priv_state(priv, state);
251 	if (WARN_ON(!priv_state))
252 		return;
253 
254 	/* Set addresses of our DMA descriptor chains */
255 	next_id = priv_state->use_palette ? HWDESC_PALETTE : 0;
256 	regmap_write(priv->map, JZ_REG_LCD_DA0, dma_hwdesc_addr(priv, next_id));
257 	regmap_write(priv->map, JZ_REG_LCD_DA1, dma_hwdesc_addr(priv, 1));
258 
259 	drm_crtc_vblank_on(crtc);
260 }
261 
262 static void ingenic_drm_bridge_atomic_disable(struct drm_bridge *bridge,
263 					      struct drm_atomic_state *state)
264 {
265 	struct ingenic_drm *priv = drm_device_get_priv(bridge->dev);
266 	unsigned int var;
267 
268 	regmap_update_bits(priv->map, JZ_REG_LCD_CTRL,
269 			   JZ_LCD_CTRL_DISABLE, JZ_LCD_CTRL_DISABLE);
270 
271 	regmap_read_poll_timeout(priv->map, JZ_REG_LCD_STATE, var,
272 				 var & JZ_LCD_STATE_DISABLED,
273 				 1000, 0);
274 }
275 
276 static void ingenic_drm_crtc_atomic_disable(struct drm_crtc *crtc,
277 					    struct drm_atomic_state *state)
278 {
279 	drm_crtc_vblank_off(crtc);
280 }
281 
282 static void ingenic_drm_crtc_update_timings(struct ingenic_drm *priv,
283 					    struct drm_display_mode *mode)
284 {
285 	unsigned int vpe, vds, vde, vt, hpe, hds, hde, ht;
286 
287 	vpe = mode->crtc_vsync_end - mode->crtc_vsync_start;
288 	vds = mode->crtc_vtotal - mode->crtc_vsync_start;
289 	vde = vds + mode->crtc_vdisplay;
290 	vt = vde + mode->crtc_vsync_start - mode->crtc_vdisplay;
291 
292 	hpe = mode->crtc_hsync_end - mode->crtc_hsync_start;
293 	hds = mode->crtc_htotal - mode->crtc_hsync_start;
294 	hde = hds + mode->crtc_hdisplay;
295 	ht = hde + mode->crtc_hsync_start - mode->crtc_hdisplay;
296 
297 	regmap_write(priv->map, JZ_REG_LCD_VSYNC,
298 		     0 << JZ_LCD_VSYNC_VPS_OFFSET |
299 		     vpe << JZ_LCD_VSYNC_VPE_OFFSET);
300 
301 	regmap_write(priv->map, JZ_REG_LCD_HSYNC,
302 		     0 << JZ_LCD_HSYNC_HPS_OFFSET |
303 		     hpe << JZ_LCD_HSYNC_HPE_OFFSET);
304 
305 	regmap_write(priv->map, JZ_REG_LCD_VAT,
306 		     ht << JZ_LCD_VAT_HT_OFFSET |
307 		     vt << JZ_LCD_VAT_VT_OFFSET);
308 
309 	regmap_write(priv->map, JZ_REG_LCD_DAH,
310 		     hds << JZ_LCD_DAH_HDS_OFFSET |
311 		     hde << JZ_LCD_DAH_HDE_OFFSET);
312 	regmap_write(priv->map, JZ_REG_LCD_DAV,
313 		     vds << JZ_LCD_DAV_VDS_OFFSET |
314 		     vde << JZ_LCD_DAV_VDE_OFFSET);
315 
316 	if (priv->panel_is_sharp) {
317 		regmap_write(priv->map, JZ_REG_LCD_PS, hde << 16 | (hde + 1));
318 		regmap_write(priv->map, JZ_REG_LCD_CLS, hde << 16 | (hde + 1));
319 		regmap_write(priv->map, JZ_REG_LCD_SPL, hpe << 16 | (hpe + 1));
320 		regmap_write(priv->map, JZ_REG_LCD_REV, mode->htotal << 16);
321 	}
322 
323 	regmap_update_bits(priv->map, JZ_REG_LCD_CTRL,
324 			   JZ_LCD_CTRL_OFUP | JZ_LCD_CTRL_BURST_MASK,
325 			   JZ_LCD_CTRL_OFUP | priv->soc_info->max_burst);
326 
327 	/*
328 	 * IPU restart - specify how much time the LCDC will wait before
329 	 * transferring a new frame from the IPU. The value is the one
330 	 * suggested in the programming manual.
331 	 */
332 	regmap_write(priv->map, JZ_REG_LCD_IPUR, JZ_LCD_IPUR_IPUREN |
333 		     (ht * vpe / 3) << JZ_LCD_IPUR_IPUR_LSB);
334 }
335 
336 static int ingenic_drm_crtc_atomic_check(struct drm_crtc *crtc,
337 					 struct drm_atomic_state *state)
338 {
339 	struct drm_crtc_state *crtc_state = drm_atomic_get_new_crtc_state(state,
340 									  crtc);
341 	struct ingenic_drm *priv = drm_crtc_get_priv(crtc);
342 	struct drm_plane_state *f1_state, *f0_state, *ipu_state = NULL;
343 	struct ingenic_drm_private_state *priv_state;
344 
345 	if (crtc_state->gamma_lut &&
346 	    drm_color_lut_size(crtc_state->gamma_lut) != ARRAY_SIZE(priv->dma_hwdescs->palette)) {
347 		dev_dbg(priv->dev, "Invalid palette size\n");
348 		return -EINVAL;
349 	}
350 
351 	/* We will need the state in atomic_enable, so let's make sure it's part of the state */
352 	priv_state = ingenic_drm_get_priv_state(priv, state);
353 	if (IS_ERR(priv_state))
354 		return PTR_ERR(priv_state);
355 
356 	if (drm_atomic_crtc_needs_modeset(crtc_state) && priv->soc_info->has_osd) {
357 		f1_state = drm_atomic_get_plane_state(crtc_state->state,
358 						      &priv->f1);
359 		if (IS_ERR(f1_state))
360 			return PTR_ERR(f1_state);
361 
362 		f0_state = drm_atomic_get_plane_state(crtc_state->state,
363 						      &priv->f0);
364 		if (IS_ERR(f0_state))
365 			return PTR_ERR(f0_state);
366 
367 		if (IS_ENABLED(CONFIG_DRM_INGENIC_IPU) && priv->ipu_plane) {
368 			ipu_state = drm_atomic_get_plane_state(crtc_state->state,
369 							       priv->ipu_plane);
370 			if (IS_ERR(ipu_state))
371 				return PTR_ERR(ipu_state);
372 
373 			/* IPU and F1 planes cannot be enabled at the same time. */
374 			if (f1_state->fb && ipu_state->fb) {
375 				dev_dbg(priv->dev, "Cannot enable both F1 and IPU\n");
376 				return -EINVAL;
377 			}
378 		}
379 
380 		/* If all the planes are disabled, we won't get a VBLANK IRQ */
381 		priv->no_vblank = !f1_state->fb && !f0_state->fb &&
382 				  !(ipu_state && ipu_state->fb);
383 	}
384 
385 	return 0;
386 }
387 
388 static enum drm_mode_status
389 ingenic_drm_crtc_mode_valid(struct drm_crtc *crtc, const struct drm_display_mode *mode)
390 {
391 	struct ingenic_drm *priv = drm_crtc_get_priv(crtc);
392 	long rate;
393 
394 	if (mode->hdisplay > priv->soc_info->max_width)
395 		return MODE_BAD_HVALUE;
396 	if (mode->vdisplay > priv->soc_info->max_height)
397 		return MODE_BAD_VVALUE;
398 
399 	rate = clk_round_rate(priv->pix_clk, mode->clock * 1000);
400 	if (rate < 0)
401 		return MODE_CLOCK_RANGE;
402 
403 	return MODE_OK;
404 }
405 
406 static void ingenic_drm_crtc_atomic_begin(struct drm_crtc *crtc,
407 					  struct drm_atomic_state *state)
408 {
409 	struct drm_crtc_state *crtc_state = drm_atomic_get_new_crtc_state(state,
410 									  crtc);
411 	struct ingenic_drm *priv = drm_crtc_get_priv(crtc);
412 	u32 ctrl = 0;
413 
414 	if (priv->soc_info->has_osd &&
415 	    drm_atomic_crtc_needs_modeset(crtc_state)) {
416 		/*
417 		 * If IPU plane is enabled, enable IPU as source for the F1
418 		 * plane; otherwise use regular DMA.
419 		 */
420 		if (priv->ipu_plane && priv->ipu_plane->state->fb)
421 			ctrl |= JZ_LCD_OSDCTRL_IPU;
422 
423 		regmap_update_bits(priv->map, JZ_REG_LCD_OSDCTRL,
424 				   JZ_LCD_OSDCTRL_IPU, ctrl);
425 	}
426 }
427 
428 static void ingenic_drm_crtc_atomic_flush(struct drm_crtc *crtc,
429 					  struct drm_atomic_state *state)
430 {
431 	struct ingenic_drm *priv = drm_crtc_get_priv(crtc);
432 	struct drm_crtc_state *crtc_state = drm_atomic_get_new_crtc_state(state,
433 									  crtc);
434 	struct drm_pending_vblank_event *event = crtc_state->event;
435 
436 	if (drm_atomic_crtc_needs_modeset(crtc_state)) {
437 		ingenic_drm_crtc_update_timings(priv, &crtc_state->adjusted_mode);
438 		priv->update_clk_rate = true;
439 	}
440 
441 	if (priv->update_clk_rate) {
442 		mutex_lock(&priv->clk_mutex);
443 		clk_set_rate(priv->pix_clk,
444 			     crtc_state->adjusted_mode.crtc_clock * 1000);
445 		priv->update_clk_rate = false;
446 		mutex_unlock(&priv->clk_mutex);
447 	}
448 
449 	if (event) {
450 		crtc_state->event = NULL;
451 
452 		spin_lock_irq(&crtc->dev->event_lock);
453 		if (drm_crtc_vblank_get(crtc) == 0)
454 			drm_crtc_arm_vblank_event(crtc, event);
455 		else
456 			drm_crtc_send_vblank_event(crtc, event);
457 		spin_unlock_irq(&crtc->dev->event_lock);
458 	}
459 }
460 
461 static int ingenic_drm_plane_atomic_check(struct drm_plane *plane,
462 					  struct drm_atomic_state *state)
463 {
464 	struct drm_plane_state *old_plane_state = drm_atomic_get_old_plane_state(state,
465 										 plane);
466 	struct drm_plane_state *new_plane_state = drm_atomic_get_new_plane_state(state,
467 										 plane);
468 	struct ingenic_drm *priv = drm_device_get_priv(plane->dev);
469 	struct ingenic_drm_private_state *priv_state;
470 	struct drm_crtc_state *crtc_state;
471 	struct drm_crtc *crtc = new_plane_state->crtc ?: old_plane_state->crtc;
472 	int ret;
473 
474 	if (!crtc)
475 		return 0;
476 
477 	if (priv->soc_info->plane_f0_not_working && plane == &priv->f0)
478 		return -EINVAL;
479 
480 	crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
481 	if (WARN_ON(!crtc_state))
482 		return -EINVAL;
483 
484 	priv_state = ingenic_drm_get_priv_state(priv, state);
485 	if (IS_ERR(priv_state))
486 		return PTR_ERR(priv_state);
487 
488 	ret = drm_atomic_helper_check_plane_state(new_plane_state, crtc_state,
489 						  DRM_PLANE_NO_SCALING,
490 						  DRM_PLANE_NO_SCALING,
491 						  priv->soc_info->has_osd,
492 						  true);
493 	if (ret)
494 		return ret;
495 
496 	/*
497 	 * If OSD is not available, check that the width/height match.
498 	 * Note that state->src_* are in 16.16 fixed-point format.
499 	 */
500 	if (!priv->soc_info->has_osd &&
501 	    (new_plane_state->src_x != 0 ||
502 	     (new_plane_state->src_w >> 16) != new_plane_state->crtc_w ||
503 	     (new_plane_state->src_h >> 16) != new_plane_state->crtc_h))
504 		return -EINVAL;
505 
506 	priv_state->use_palette = new_plane_state->fb &&
507 		new_plane_state->fb->format->format == DRM_FORMAT_C8;
508 
509 	/*
510 	 * Require full modeset if enabling or disabling a plane, or changing
511 	 * its position, size or depth.
512 	 */
513 	if (priv->soc_info->has_osd &&
514 	    (!old_plane_state->fb || !new_plane_state->fb ||
515 	     old_plane_state->crtc_x != new_plane_state->crtc_x ||
516 	     old_plane_state->crtc_y != new_plane_state->crtc_y ||
517 	     old_plane_state->crtc_w != new_plane_state->crtc_w ||
518 	     old_plane_state->crtc_h != new_plane_state->crtc_h ||
519 	     old_plane_state->fb->format->format != new_plane_state->fb->format->format))
520 		crtc_state->mode_changed = true;
521 
522 	if (priv->soc_info->map_noncoherent)
523 		drm_atomic_helper_check_plane_damage(state, new_plane_state);
524 
525 	return 0;
526 }
527 
528 static void ingenic_drm_plane_enable(struct ingenic_drm *priv,
529 				     struct drm_plane *plane)
530 {
531 	unsigned int en_bit;
532 
533 	if (priv->soc_info->has_osd) {
534 		if (plane != &priv->f0)
535 			en_bit = JZ_LCD_OSDC_F1EN;
536 		else
537 			en_bit = JZ_LCD_OSDC_F0EN;
538 
539 		regmap_set_bits(priv->map, JZ_REG_LCD_OSDC, en_bit);
540 	}
541 }
542 
543 void ingenic_drm_plane_disable(struct device *dev, struct drm_plane *plane)
544 {
545 	struct ingenic_drm *priv = dev_get_drvdata(dev);
546 	unsigned int en_bit;
547 
548 	if (priv->soc_info->has_osd) {
549 		if (plane != &priv->f0)
550 			en_bit = JZ_LCD_OSDC_F1EN;
551 		else
552 			en_bit = JZ_LCD_OSDC_F0EN;
553 
554 		regmap_clear_bits(priv->map, JZ_REG_LCD_OSDC, en_bit);
555 	}
556 }
557 
558 static void ingenic_drm_plane_atomic_disable(struct drm_plane *plane,
559 					     struct drm_atomic_state *state)
560 {
561 	struct ingenic_drm *priv = drm_device_get_priv(plane->dev);
562 
563 	ingenic_drm_plane_disable(priv->dev, plane);
564 }
565 
566 void ingenic_drm_plane_config(struct device *dev,
567 			      struct drm_plane *plane, u32 fourcc)
568 {
569 	struct ingenic_drm *priv = dev_get_drvdata(dev);
570 	struct drm_plane_state *state = plane->state;
571 	unsigned int xy_reg, size_reg;
572 	unsigned int ctrl = 0;
573 
574 	ingenic_drm_plane_enable(priv, plane);
575 
576 	if (priv->soc_info->has_osd && plane != &priv->f0) {
577 		switch (fourcc) {
578 		case DRM_FORMAT_XRGB1555:
579 			ctrl |= JZ_LCD_OSDCTRL_RGB555;
580 			fallthrough;
581 		case DRM_FORMAT_RGB565:
582 			ctrl |= JZ_LCD_OSDCTRL_BPP_15_16;
583 			break;
584 		case DRM_FORMAT_RGB888:
585 			ctrl |= JZ_LCD_OSDCTRL_BPP_24_COMP;
586 			break;
587 		case DRM_FORMAT_XRGB8888:
588 			ctrl |= JZ_LCD_OSDCTRL_BPP_18_24;
589 			break;
590 		case DRM_FORMAT_XRGB2101010:
591 			ctrl |= JZ_LCD_OSDCTRL_BPP_30;
592 			break;
593 		}
594 
595 		regmap_update_bits(priv->map, JZ_REG_LCD_OSDCTRL,
596 				   JZ_LCD_OSDCTRL_BPP_MASK, ctrl);
597 	} else {
598 		switch (fourcc) {
599 		case DRM_FORMAT_C8:
600 			ctrl |= JZ_LCD_CTRL_BPP_8;
601 			break;
602 		case DRM_FORMAT_XRGB1555:
603 			ctrl |= JZ_LCD_CTRL_RGB555;
604 			fallthrough;
605 		case DRM_FORMAT_RGB565:
606 			ctrl |= JZ_LCD_CTRL_BPP_15_16;
607 			break;
608 		case DRM_FORMAT_RGB888:
609 			ctrl |= JZ_LCD_CTRL_BPP_24_COMP;
610 			break;
611 		case DRM_FORMAT_XRGB8888:
612 			ctrl |= JZ_LCD_CTRL_BPP_18_24;
613 			break;
614 		case DRM_FORMAT_XRGB2101010:
615 			ctrl |= JZ_LCD_CTRL_BPP_30;
616 			break;
617 		}
618 
619 		regmap_update_bits(priv->map, JZ_REG_LCD_CTRL,
620 				   JZ_LCD_CTRL_BPP_MASK, ctrl);
621 	}
622 
623 	if (priv->soc_info->has_osd) {
624 		if (plane != &priv->f0) {
625 			xy_reg = JZ_REG_LCD_XYP1;
626 			size_reg = JZ_REG_LCD_SIZE1;
627 		} else {
628 			xy_reg = JZ_REG_LCD_XYP0;
629 			size_reg = JZ_REG_LCD_SIZE0;
630 		}
631 
632 		regmap_write(priv->map, xy_reg,
633 			     state->crtc_x << JZ_LCD_XYP01_XPOS_LSB |
634 			     state->crtc_y << JZ_LCD_XYP01_YPOS_LSB);
635 		regmap_write(priv->map, size_reg,
636 			     state->crtc_w << JZ_LCD_SIZE01_WIDTH_LSB |
637 			     state->crtc_h << JZ_LCD_SIZE01_HEIGHT_LSB);
638 	}
639 }
640 
641 bool ingenic_drm_map_noncoherent(const struct device *dev)
642 {
643 	const struct ingenic_drm *priv = dev_get_drvdata(dev);
644 
645 	return priv->soc_info->map_noncoherent;
646 }
647 
648 static void ingenic_drm_update_palette(struct ingenic_drm *priv,
649 				       const struct drm_color_lut *lut)
650 {
651 	unsigned int i;
652 
653 	for (i = 0; i < ARRAY_SIZE(priv->dma_hwdescs->palette); i++) {
654 		u16 color = drm_color_lut_extract(lut[i].red, 5) << 11
655 			| drm_color_lut_extract(lut[i].green, 6) << 5
656 			| drm_color_lut_extract(lut[i].blue, 5);
657 
658 		priv->dma_hwdescs->palette[i] = color;
659 	}
660 }
661 
662 static void ingenic_drm_plane_atomic_update(struct drm_plane *plane,
663 					    struct drm_atomic_state *state)
664 {
665 	struct ingenic_drm *priv = drm_device_get_priv(plane->dev);
666 	struct drm_plane_state *newstate = drm_atomic_get_new_plane_state(state, plane);
667 	struct drm_plane_state *oldstate = drm_atomic_get_old_plane_state(state, plane);
668 	unsigned int width, height, cpp, next_id, plane_id;
669 	struct ingenic_drm_private_state *priv_state;
670 	struct drm_crtc_state *crtc_state;
671 	struct ingenic_dma_hwdesc *hwdesc;
672 	dma_addr_t addr;
673 	u32 fourcc;
674 
675 	if (newstate && newstate->fb) {
676 		if (priv->soc_info->map_noncoherent)
677 			drm_fb_dma_sync_non_coherent(&priv->drm, oldstate, newstate);
678 
679 		crtc_state = newstate->crtc->state;
680 		plane_id = !!(priv->soc_info->has_osd && plane != &priv->f0);
681 
682 		addr = drm_fb_dma_get_gem_addr(newstate->fb, newstate, 0);
683 		width = newstate->src_w >> 16;
684 		height = newstate->src_h >> 16;
685 		cpp = newstate->fb->format->cpp[0];
686 
687 		priv_state = ingenic_drm_get_new_priv_state(priv, state);
688 		next_id = (priv_state && priv_state->use_palette) ? HWDESC_PALETTE : plane_id;
689 
690 		hwdesc = &priv->dma_hwdescs->hwdesc[plane_id];
691 		hwdesc->addr = addr;
692 		hwdesc->cmd = JZ_LCD_CMD_EOF_IRQ | (width * height * cpp / 4);
693 		hwdesc->next = dma_hwdesc_addr(priv, next_id);
694 
695 		if (priv->soc_info->use_extended_hwdesc) {
696 			hwdesc->cmd |= JZ_LCD_CMD_FRM_ENABLE;
697 
698 			/* Extended 8-byte descriptor */
699 			hwdesc->cpos = 0;
700 			hwdesc->offsize = 0;
701 			hwdesc->pagewidth = 0;
702 
703 			switch (newstate->fb->format->format) {
704 			case DRM_FORMAT_XRGB1555:
705 				hwdesc->cpos |= JZ_LCD_CPOS_RGB555;
706 				fallthrough;
707 			case DRM_FORMAT_RGB565:
708 				hwdesc->cpos |= JZ_LCD_CPOS_BPP_15_16;
709 				break;
710 			case DRM_FORMAT_XRGB8888:
711 				hwdesc->cpos |= JZ_LCD_CPOS_BPP_18_24;
712 				break;
713 			}
714 			hwdesc->cpos |= (JZ_LCD_CPOS_COEFFICIENT_1 <<
715 					 JZ_LCD_CPOS_COEFFICIENT_OFFSET);
716 			hwdesc->dessize =
717 				(0xff << JZ_LCD_DESSIZE_ALPHA_OFFSET) |
718 				FIELD_PREP(JZ_LCD_DESSIZE_HEIGHT_MASK, height - 1) |
719 				FIELD_PREP(JZ_LCD_DESSIZE_WIDTH_MASK, width - 1);
720 		}
721 
722 		if (drm_atomic_crtc_needs_modeset(crtc_state)) {
723 			fourcc = newstate->fb->format->format;
724 
725 			ingenic_drm_plane_config(priv->dev, plane, fourcc);
726 
727 			crtc_state->color_mgmt_changed = fourcc == DRM_FORMAT_C8;
728 		}
729 
730 		if (crtc_state->color_mgmt_changed)
731 			ingenic_drm_update_palette(priv, crtc_state->gamma_lut->data);
732 	}
733 }
734 
735 static void ingenic_drm_encoder_atomic_mode_set(struct drm_encoder *encoder,
736 						struct drm_crtc_state *crtc_state,
737 						struct drm_connector_state *conn_state)
738 {
739 	struct ingenic_drm *priv = drm_device_get_priv(encoder->dev);
740 	struct drm_display_mode *mode = &crtc_state->adjusted_mode;
741 	struct ingenic_drm_bridge *bridge = to_ingenic_drm_bridge(encoder);
742 	unsigned int cfg, rgbcfg = 0;
743 
744 	priv->panel_is_sharp = bridge->bus_cfg.flags & DRM_BUS_FLAG_SHARP_SIGNALS;
745 
746 	if (priv->panel_is_sharp) {
747 		cfg = JZ_LCD_CFG_MODE_SPECIAL_TFT_1 | JZ_LCD_CFG_REV_POLARITY;
748 	} else {
749 		cfg = JZ_LCD_CFG_PS_DISABLE | JZ_LCD_CFG_CLS_DISABLE
750 		    | JZ_LCD_CFG_SPL_DISABLE | JZ_LCD_CFG_REV_DISABLE;
751 	}
752 
753 	if (priv->soc_info->use_extended_hwdesc)
754 		cfg |= JZ_LCD_CFG_DESCRIPTOR_8;
755 
756 	if (mode->flags & DRM_MODE_FLAG_NHSYNC)
757 		cfg |= JZ_LCD_CFG_HSYNC_ACTIVE_LOW;
758 	if (mode->flags & DRM_MODE_FLAG_NVSYNC)
759 		cfg |= JZ_LCD_CFG_VSYNC_ACTIVE_LOW;
760 	if (bridge->bus_cfg.flags & DRM_BUS_FLAG_DE_LOW)
761 		cfg |= JZ_LCD_CFG_DE_ACTIVE_LOW;
762 	if (bridge->bus_cfg.flags & DRM_BUS_FLAG_PIXDATA_DRIVE_NEGEDGE)
763 		cfg |= JZ_LCD_CFG_PCLK_FALLING_EDGE;
764 
765 	if (!priv->panel_is_sharp) {
766 		if (conn_state->connector->connector_type == DRM_MODE_CONNECTOR_TV) {
767 			if (mode->flags & DRM_MODE_FLAG_INTERLACE)
768 				cfg |= JZ_LCD_CFG_MODE_TV_OUT_I;
769 			else
770 				cfg |= JZ_LCD_CFG_MODE_TV_OUT_P;
771 		} else {
772 			switch (bridge->bus_cfg.format) {
773 			case MEDIA_BUS_FMT_RGB565_1X16:
774 				cfg |= JZ_LCD_CFG_MODE_GENERIC_16BIT;
775 				break;
776 			case MEDIA_BUS_FMT_RGB666_1X18:
777 				cfg |= JZ_LCD_CFG_MODE_GENERIC_18BIT;
778 				break;
779 			case MEDIA_BUS_FMT_RGB888_1X24:
780 				cfg |= JZ_LCD_CFG_MODE_GENERIC_24BIT;
781 				break;
782 			case MEDIA_BUS_FMT_RGB888_3X8_DELTA:
783 				rgbcfg = JZ_LCD_RGBC_EVEN_GBR | JZ_LCD_RGBC_ODD_RGB;
784 				fallthrough;
785 			case MEDIA_BUS_FMT_RGB888_3X8:
786 				cfg |= JZ_LCD_CFG_MODE_8BIT_SERIAL;
787 				break;
788 			default:
789 				break;
790 			}
791 		}
792 	}
793 
794 	regmap_write(priv->map, JZ_REG_LCD_CFG, cfg);
795 	regmap_write(priv->map, JZ_REG_LCD_RGBC, rgbcfg);
796 }
797 
798 static int ingenic_drm_bridge_attach(struct drm_bridge *bridge,
799 				     struct drm_encoder *encoder,
800 				     enum drm_bridge_attach_flags flags)
801 {
802 	struct ingenic_drm_bridge *ib = to_ingenic_drm_bridge(encoder);
803 
804 	return drm_bridge_attach(encoder, ib->next_bridge,
805 				 &ib->bridge, flags);
806 }
807 
808 static int ingenic_drm_bridge_atomic_check(struct drm_bridge *bridge,
809 					   struct drm_bridge_state *bridge_state,
810 					   struct drm_crtc_state *crtc_state,
811 					   struct drm_connector_state *conn_state)
812 {
813 	struct drm_display_mode *mode = &crtc_state->adjusted_mode;
814 	struct ingenic_drm_bridge *ib = to_ingenic_drm_bridge(bridge->encoder);
815 
816 	ib->bus_cfg = bridge_state->output_bus_cfg;
817 
818 	if (conn_state->connector->connector_type == DRM_MODE_CONNECTOR_TV)
819 		return 0;
820 
821 	switch (bridge_state->output_bus_cfg.format) {
822 	case MEDIA_BUS_FMT_RGB888_3X8:
823 	case MEDIA_BUS_FMT_RGB888_3X8_DELTA:
824 		/*
825 		 * The LCD controller expects timing values in dot-clock ticks,
826 		 * which is 3x the timing values in pixels when using a 3x8-bit
827 		 * display; but it will count the display area size in pixels
828 		 * either way. Go figure.
829 		 */
830 		mode->crtc_clock = mode->clock * 3;
831 		mode->crtc_hsync_start = mode->hsync_start * 3 - mode->hdisplay * 2;
832 		mode->crtc_hsync_end = mode->hsync_end * 3 - mode->hdisplay * 2;
833 		mode->crtc_hdisplay = mode->hdisplay;
834 		mode->crtc_htotal = mode->htotal * 3 - mode->hdisplay * 2;
835 		return 0;
836 	case MEDIA_BUS_FMT_RGB565_1X16:
837 	case MEDIA_BUS_FMT_RGB666_1X18:
838 	case MEDIA_BUS_FMT_RGB888_1X24:
839 		return 0;
840 	default:
841 		return -EINVAL;
842 	}
843 }
844 
845 static u32 *
846 ingenic_drm_bridge_atomic_get_input_bus_fmts(struct drm_bridge *bridge,
847 					     struct drm_bridge_state *bridge_state,
848 					     struct drm_crtc_state *crtc_state,
849 					     struct drm_connector_state *conn_state,
850 					     u32 output_fmt,
851 					     unsigned int *num_input_fmts)
852 {
853 	switch (output_fmt) {
854 	case MEDIA_BUS_FMT_RGB888_1X24:
855 	case MEDIA_BUS_FMT_RGB666_1X18:
856 	case MEDIA_BUS_FMT_RGB565_1X16:
857 	case MEDIA_BUS_FMT_RGB888_3X8:
858 	case MEDIA_BUS_FMT_RGB888_3X8_DELTA:
859 		break;
860 	default:
861 		*num_input_fmts = 0;
862 		return NULL;
863 	}
864 
865 	return drm_atomic_helper_bridge_propagate_bus_fmt(bridge, bridge_state,
866 							  crtc_state, conn_state,
867 							  output_fmt,
868 							  num_input_fmts);
869 }
870 
871 static irqreturn_t ingenic_drm_irq_handler(int irq, void *arg)
872 {
873 	struct ingenic_drm *priv = drm_device_get_priv(arg);
874 	unsigned int state;
875 
876 	regmap_read(priv->map, JZ_REG_LCD_STATE, &state);
877 
878 	regmap_update_bits(priv->map, JZ_REG_LCD_STATE,
879 			   JZ_LCD_STATE_EOF_IRQ, 0);
880 
881 	if (state & JZ_LCD_STATE_EOF_IRQ)
882 		drm_crtc_handle_vblank(&priv->crtc);
883 
884 	return IRQ_HANDLED;
885 }
886 
887 static int ingenic_drm_enable_vblank(struct drm_crtc *crtc)
888 {
889 	struct ingenic_drm *priv = drm_crtc_get_priv(crtc);
890 
891 	if (priv->no_vblank)
892 		return -EINVAL;
893 
894 	regmap_update_bits(priv->map, JZ_REG_LCD_CTRL,
895 			   JZ_LCD_CTRL_EOF_IRQ, JZ_LCD_CTRL_EOF_IRQ);
896 
897 	return 0;
898 }
899 
900 static void ingenic_drm_disable_vblank(struct drm_crtc *crtc)
901 {
902 	struct ingenic_drm *priv = drm_crtc_get_priv(crtc);
903 
904 	regmap_update_bits(priv->map, JZ_REG_LCD_CTRL, JZ_LCD_CTRL_EOF_IRQ, 0);
905 }
906 
907 static struct drm_framebuffer *
908 ingenic_drm_gem_fb_create(struct drm_device *drm, struct drm_file *file,
909 			  const struct drm_format_info *info,
910 			  const struct drm_mode_fb_cmd2 *mode_cmd)
911 {
912 	struct ingenic_drm *priv = drm_device_get_priv(drm);
913 
914 	if (priv->soc_info->map_noncoherent)
915 		return drm_gem_fb_create_with_dirty(drm, file, info, mode_cmd);
916 
917 	return drm_gem_fb_create(drm, file, info, mode_cmd);
918 }
919 
920 static struct drm_gem_object *
921 ingenic_drm_gem_create_object(struct drm_device *drm, size_t size)
922 {
923 	struct ingenic_drm *priv = drm_device_get_priv(drm);
924 	struct drm_gem_dma_object *obj;
925 
926 	obj = kzalloc_obj(*obj);
927 	if (!obj)
928 		return ERR_PTR(-ENOMEM);
929 
930 	obj->map_noncoherent = priv->soc_info->map_noncoherent;
931 
932 	return &obj->base;
933 }
934 
935 static struct drm_private_state *
936 ingenic_drm_duplicate_state(struct drm_private_obj *obj)
937 {
938 	struct ingenic_drm_private_state *state = to_ingenic_drm_priv_state(obj->state);
939 
940 	state = kmemdup(state, sizeof(*state), GFP_KERNEL);
941 	if (!state)
942 		return NULL;
943 
944 	__drm_atomic_helper_private_obj_duplicate_state(obj, &state->base);
945 
946 	return &state->base;
947 }
948 
949 static void ingenic_drm_destroy_state(struct drm_private_obj *obj,
950 				      struct drm_private_state *state)
951 {
952 	struct ingenic_drm_private_state *priv_state = to_ingenic_drm_priv_state(state);
953 
954 	kfree(priv_state);
955 }
956 
957 static struct drm_private_state *
958 ingenic_drm_create_state(struct drm_private_obj *obj)
959 {
960 	struct ingenic_drm_private_state *priv_state;
961 
962 	priv_state = kzalloc_obj(*priv_state);
963 	if (!priv_state)
964 		return ERR_PTR(-ENOMEM);
965 
966 	__drm_atomic_helper_private_obj_create_state(obj, &priv_state->base);
967 
968 	return &priv_state->base;
969 }
970 
971 DEFINE_DRM_GEM_DMA_FOPS(ingenic_drm_fops);
972 
973 static const struct drm_driver ingenic_drm_driver_data = {
974 	.driver_features	= DRIVER_MODESET | DRIVER_GEM | DRIVER_ATOMIC,
975 	.name			= "ingenic-drm",
976 	.desc			= "DRM module for Ingenic SoCs",
977 	.major			= 1,
978 	.minor			= 1,
979 	.patchlevel		= 0,
980 
981 	.fops			= &ingenic_drm_fops,
982 	.gem_create_object	= ingenic_drm_gem_create_object,
983 	DRM_GEM_DMA_DRIVER_OPS,
984 	DRM_FBDEV_DMA_DRIVER_OPS,
985 };
986 
987 static const struct drm_plane_funcs ingenic_drm_primary_plane_funcs = {
988 	.update_plane		= drm_atomic_helper_update_plane,
989 	.disable_plane		= drm_atomic_helper_disable_plane,
990 	.reset			= drm_atomic_helper_plane_reset,
991 	.destroy		= drm_plane_cleanup,
992 
993 	.atomic_duplicate_state	= drm_atomic_helper_plane_duplicate_state,
994 	.atomic_destroy_state	= drm_atomic_helper_plane_destroy_state,
995 };
996 
997 static const struct drm_crtc_funcs ingenic_drm_crtc_funcs = {
998 	.set_config		= drm_atomic_helper_set_config,
999 	.page_flip		= drm_atomic_helper_page_flip,
1000 	.reset			= drm_atomic_helper_crtc_reset,
1001 	.destroy		= drm_crtc_cleanup,
1002 
1003 	.atomic_duplicate_state	= drm_atomic_helper_crtc_duplicate_state,
1004 	.atomic_destroy_state	= drm_atomic_helper_crtc_destroy_state,
1005 
1006 	.enable_vblank		= ingenic_drm_enable_vblank,
1007 	.disable_vblank		= ingenic_drm_disable_vblank,
1008 };
1009 
1010 static const struct drm_plane_helper_funcs ingenic_drm_plane_helper_funcs = {
1011 	.atomic_update		= ingenic_drm_plane_atomic_update,
1012 	.atomic_check		= ingenic_drm_plane_atomic_check,
1013 	.atomic_disable		= ingenic_drm_plane_atomic_disable,
1014 };
1015 
1016 static const struct drm_crtc_helper_funcs ingenic_drm_crtc_helper_funcs = {
1017 	.atomic_enable		= ingenic_drm_crtc_atomic_enable,
1018 	.atomic_disable		= ingenic_drm_crtc_atomic_disable,
1019 	.atomic_begin		= ingenic_drm_crtc_atomic_begin,
1020 	.atomic_flush		= ingenic_drm_crtc_atomic_flush,
1021 	.atomic_check		= ingenic_drm_crtc_atomic_check,
1022 	.mode_valid		= ingenic_drm_crtc_mode_valid,
1023 };
1024 
1025 static const struct drm_encoder_helper_funcs ingenic_drm_encoder_helper_funcs = {
1026 	.atomic_mode_set        = ingenic_drm_encoder_atomic_mode_set,
1027 };
1028 
1029 static const struct drm_bridge_funcs ingenic_drm_bridge_funcs = {
1030 	.attach			= ingenic_drm_bridge_attach,
1031 	.atomic_enable		= ingenic_drm_bridge_atomic_enable,
1032 	.atomic_disable		= ingenic_drm_bridge_atomic_disable,
1033 	.atomic_check		= ingenic_drm_bridge_atomic_check,
1034 	.atomic_reset		= drm_atomic_helper_bridge_reset,
1035 	.atomic_duplicate_state	= drm_atomic_helper_bridge_duplicate_state,
1036 	.atomic_destroy_state	= drm_atomic_helper_bridge_destroy_state,
1037 	.atomic_get_input_bus_fmts = ingenic_drm_bridge_atomic_get_input_bus_fmts,
1038 };
1039 
1040 static const struct drm_mode_config_funcs ingenic_drm_mode_config_funcs = {
1041 	.fb_create		= ingenic_drm_gem_fb_create,
1042 	.atomic_check		= drm_atomic_helper_check,
1043 	.atomic_commit		= drm_atomic_helper_commit,
1044 };
1045 
1046 static struct drm_mode_config_helper_funcs ingenic_drm_mode_config_helpers = {
1047 	.atomic_commit_tail = drm_atomic_helper_commit_tail,
1048 };
1049 
1050 static const struct drm_private_state_funcs ingenic_drm_private_state_funcs = {
1051 	.atomic_create_state = ingenic_drm_create_state,
1052 	.atomic_duplicate_state = ingenic_drm_duplicate_state,
1053 	.atomic_destroy_state = ingenic_drm_destroy_state,
1054 };
1055 
1056 static void ingenic_drm_unbind_all(void *d)
1057 {
1058 	struct ingenic_drm *priv = d;
1059 
1060 	component_unbind_all(priv->dev, &priv->drm);
1061 }
1062 
1063 static void __maybe_unused ingenic_drm_release_rmem(void *d)
1064 {
1065 	of_reserved_mem_device_release(d);
1066 }
1067 
1068 static void ingenic_drm_configure_hwdesc(struct ingenic_drm *priv,
1069 					 unsigned int hwdesc,
1070 					 unsigned int next_hwdesc, u32 id)
1071 {
1072 	struct ingenic_dma_hwdesc *desc = &priv->dma_hwdescs->hwdesc[hwdesc];
1073 
1074 	desc->next = dma_hwdesc_addr(priv, next_hwdesc);
1075 	desc->id = id;
1076 }
1077 
1078 static void ingenic_drm_configure_hwdesc_palette(struct ingenic_drm *priv)
1079 {
1080 	struct ingenic_dma_hwdesc *desc;
1081 
1082 	ingenic_drm_configure_hwdesc(priv, HWDESC_PALETTE, 0, 0xc0);
1083 
1084 	desc = &priv->dma_hwdescs->hwdesc[HWDESC_PALETTE];
1085 	desc->addr = priv->dma_hwdescs_phys
1086 		+ offsetof(struct ingenic_dma_hwdescs, palette);
1087 	desc->cmd = JZ_LCD_CMD_ENABLE_PAL
1088 		| (sizeof(priv->dma_hwdescs->palette) / 4);
1089 }
1090 
1091 static void ingenic_drm_configure_hwdesc_plane(struct ingenic_drm *priv,
1092 					       unsigned int plane)
1093 {
1094 	ingenic_drm_configure_hwdesc(priv, plane, plane, 0xf0 | plane);
1095 }
1096 
1097 static void ingenic_drm_atomic_private_obj_fini(struct drm_device *drm, void *private_obj)
1098 {
1099 	drm_atomic_private_obj_fini(private_obj);
1100 }
1101 
1102 static int ingenic_drm_bind(struct device *dev, bool has_components)
1103 {
1104 	struct platform_device *pdev = to_platform_device(dev);
1105 	const struct jz_soc_info *soc_info;
1106 	struct ingenic_drm *priv;
1107 	struct clk *parent_clk;
1108 	struct drm_plane *primary;
1109 	struct drm_bridge *bridge;
1110 	struct drm_panel *panel;
1111 	struct drm_connector *connector;
1112 	struct drm_encoder *encoder;
1113 	struct ingenic_drm_bridge *ib;
1114 	struct drm_device *drm;
1115 	void __iomem *base;
1116 	struct resource *res;
1117 	struct regmap_config regmap_config;
1118 	long parent_rate;
1119 	unsigned int i, clone_mask = 0;
1120 	int ret, irq;
1121 	u32 osdc = 0;
1122 
1123 	soc_info = of_device_get_match_data(dev);
1124 	if (!soc_info) {
1125 		dev_err(dev, "Missing platform data\n");
1126 		return -EINVAL;
1127 	}
1128 
1129 	if (IS_ENABLED(CONFIG_OF_RESERVED_MEM)) {
1130 		ret = of_reserved_mem_device_init(dev);
1131 
1132 		if (ret && ret != -ENODEV)
1133 			dev_warn(dev, "Failed to get reserved memory: %d\n", ret);
1134 
1135 		if (!ret) {
1136 			ret = devm_add_action_or_reset(dev, ingenic_drm_release_rmem, dev);
1137 			if (ret)
1138 				return ret;
1139 		}
1140 	}
1141 
1142 	priv = devm_drm_dev_alloc(dev, &ingenic_drm_driver_data,
1143 				  struct ingenic_drm, drm);
1144 	if (IS_ERR(priv))
1145 		return PTR_ERR(priv);
1146 
1147 	priv->soc_info = soc_info;
1148 	priv->dev = dev;
1149 	drm = &priv->drm;
1150 
1151 	platform_set_drvdata(pdev, priv);
1152 
1153 	ret = drmm_mode_config_init(drm);
1154 	if (ret)
1155 		goto err_drvdata;
1156 
1157 	drm->mode_config.min_width = 0;
1158 	drm->mode_config.min_height = 0;
1159 	drm->mode_config.max_width = soc_info->max_width;
1160 	drm->mode_config.max_height = 4095;
1161 	drm->mode_config.funcs = &ingenic_drm_mode_config_funcs;
1162 	drm->mode_config.helper_private = &ingenic_drm_mode_config_helpers;
1163 
1164 	base = devm_platform_get_and_ioremap_resource(pdev, 0, &res);
1165 	if (IS_ERR(base)) {
1166 		dev_err(dev, "Failed to get memory resource\n");
1167 		ret = PTR_ERR(base);
1168 		goto err_drvdata;
1169 	}
1170 
1171 	regmap_config = ingenic_drm_regmap_config;
1172 	regmap_config.max_register = res->end - res->start;
1173 	priv->map = devm_regmap_init_mmio(dev, base,
1174 					  &regmap_config);
1175 	if (IS_ERR(priv->map)) {
1176 		dev_err(dev, "Failed to create regmap\n");
1177 		ret = PTR_ERR(priv->map);
1178 		goto err_drvdata;
1179 	}
1180 
1181 	irq = platform_get_irq(pdev, 0);
1182 	if (irq < 0) {
1183 		ret = irq;
1184 		goto err_drvdata;
1185 	}
1186 
1187 	if (soc_info->needs_dev_clk) {
1188 		priv->lcd_clk = devm_clk_get(dev, "lcd");
1189 		if (IS_ERR(priv->lcd_clk)) {
1190 			dev_err(dev, "Failed to get lcd clock\n");
1191 			ret = PTR_ERR(priv->lcd_clk);
1192 			goto err_drvdata;
1193 		}
1194 	}
1195 
1196 	priv->pix_clk = devm_clk_get(dev, "lcd_pclk");
1197 	if (IS_ERR(priv->pix_clk)) {
1198 		dev_err(dev, "Failed to get pixel clock\n");
1199 		ret = PTR_ERR(priv->pix_clk);
1200 		goto err_drvdata;
1201 	}
1202 
1203 	priv->dma_hwdescs = dmam_alloc_coherent(dev,
1204 						sizeof(*priv->dma_hwdescs),
1205 						&priv->dma_hwdescs_phys,
1206 						GFP_KERNEL);
1207 	if (!priv->dma_hwdescs) {
1208 		ret = -ENOMEM;
1209 		goto err_drvdata;
1210 	}
1211 
1212 	/* Configure DMA hwdesc for foreground0 plane */
1213 	ingenic_drm_configure_hwdesc_plane(priv, 0);
1214 
1215 	/* Configure DMA hwdesc for foreground1 plane */
1216 	ingenic_drm_configure_hwdesc_plane(priv, 1);
1217 
1218 	/* Configure DMA hwdesc for palette */
1219 	ingenic_drm_configure_hwdesc_palette(priv);
1220 
1221 	primary = priv->soc_info->has_osd ? &priv->f1 : &priv->f0;
1222 
1223 	drm_plane_helper_add(primary, &ingenic_drm_plane_helper_funcs);
1224 
1225 	ret = drm_universal_plane_init(drm, primary, 1,
1226 				       &ingenic_drm_primary_plane_funcs,
1227 				       priv->soc_info->formats_f1,
1228 				       priv->soc_info->num_formats_f1,
1229 				       NULL, DRM_PLANE_TYPE_PRIMARY, NULL);
1230 	if (ret) {
1231 		dev_err(dev, "Failed to register plane: %i\n", ret);
1232 		goto err_drvdata;
1233 	}
1234 
1235 	if (soc_info->map_noncoherent)
1236 		drm_plane_enable_fb_damage_clips(&priv->f1);
1237 
1238 	drm_crtc_helper_add(&priv->crtc, &ingenic_drm_crtc_helper_funcs);
1239 
1240 	ret = drm_crtc_init_with_planes(drm, &priv->crtc, primary,
1241 					NULL, &ingenic_drm_crtc_funcs, NULL);
1242 	if (ret) {
1243 		dev_err(dev, "Failed to init CRTC: %i\n", ret);
1244 		goto err_drvdata;
1245 	}
1246 
1247 	drm_crtc_enable_color_mgmt(&priv->crtc, 0, false,
1248 				   ARRAY_SIZE(priv->dma_hwdescs->palette));
1249 
1250 	if (soc_info->has_osd) {
1251 		drm_plane_helper_add(&priv->f0,
1252 				     &ingenic_drm_plane_helper_funcs);
1253 
1254 		ret = drm_universal_plane_init(drm, &priv->f0, 1,
1255 					       &ingenic_drm_primary_plane_funcs,
1256 					       priv->soc_info->formats_f0,
1257 					       priv->soc_info->num_formats_f0,
1258 					       NULL, DRM_PLANE_TYPE_OVERLAY,
1259 					       NULL);
1260 		if (ret) {
1261 			dev_err(dev, "Failed to register overlay plane: %i\n",
1262 				ret);
1263 			goto err_drvdata;
1264 		}
1265 
1266 		if (soc_info->map_noncoherent)
1267 			drm_plane_enable_fb_damage_clips(&priv->f0);
1268 
1269 		if (IS_ENABLED(CONFIG_DRM_INGENIC_IPU) && has_components) {
1270 			ret = component_bind_all(dev, drm);
1271 			if (ret) {
1272 				if (ret != -EPROBE_DEFER)
1273 					dev_err(dev, "Failed to bind components: %i\n", ret);
1274 				goto err_drvdata;
1275 			}
1276 
1277 			ret = devm_add_action_or_reset(dev, ingenic_drm_unbind_all, priv);
1278 			if (ret)
1279 				goto err_drvdata;
1280 
1281 			priv->ipu_plane = drm_plane_from_index(drm, 2);
1282 			if (!priv->ipu_plane) {
1283 				dev_err(dev, "Failed to retrieve IPU plane\n");
1284 				ret = -EINVAL;
1285 				goto err_drvdata;
1286 			}
1287 		}
1288 	}
1289 
1290 	for (i = 0; ; i++) {
1291 		ret = drm_of_find_panel_or_bridge(dev->of_node, 0, i, &panel, &bridge);
1292 		if (ret) {
1293 			if (ret == -ENODEV)
1294 				break; /* we're done */
1295 			if (ret != -EPROBE_DEFER)
1296 				dev_err(dev, "Failed to get bridge handle\n");
1297 			goto err_drvdata;
1298 		}
1299 
1300 		if (panel)
1301 			bridge = devm_drm_panel_bridge_add_typed(dev, panel,
1302 								 DRM_MODE_CONNECTOR_DPI);
1303 
1304 		ib = drmm_encoder_alloc(drm, struct ingenic_drm_bridge, encoder,
1305 					NULL, DRM_MODE_ENCODER_DPI, NULL);
1306 		if (IS_ERR(ib)) {
1307 			ret = PTR_ERR(ib);
1308 			dev_err(dev, "Failed to init encoder: %d\n", ret);
1309 			goto err_drvdata;
1310 		}
1311 
1312 		encoder = &ib->encoder;
1313 		encoder->possible_crtcs = drm_crtc_mask(&priv->crtc);
1314 
1315 		drm_encoder_helper_add(encoder, &ingenic_drm_encoder_helper_funcs);
1316 
1317 		ib->bridge.funcs = &ingenic_drm_bridge_funcs;
1318 		ib->next_bridge = bridge;
1319 
1320 		ret = drm_bridge_attach(encoder, &ib->bridge, NULL,
1321 					DRM_BRIDGE_ATTACH_NO_CONNECTOR);
1322 		if (ret) {
1323 			dev_err(dev, "Unable to attach bridge\n");
1324 			goto err_drvdata;
1325 		}
1326 
1327 		connector = drm_bridge_connector_init(drm, encoder);
1328 		if (IS_ERR(connector)) {
1329 			dev_err(dev, "Unable to init connector\n");
1330 			ret = PTR_ERR(connector);
1331 			goto err_drvdata;
1332 		}
1333 
1334 		drm_connector_attach_encoder(connector, encoder);
1335 	}
1336 
1337 	drm_for_each_encoder(encoder, drm) {
1338 		clone_mask |= BIT(drm_encoder_index(encoder));
1339 	}
1340 
1341 	drm_for_each_encoder(encoder, drm) {
1342 		encoder->possible_clones = clone_mask;
1343 	}
1344 
1345 	ret = devm_request_irq(dev, irq, ingenic_drm_irq_handler, 0, drm->driver->name, drm);
1346 	if (ret) {
1347 		dev_err(dev, "Unable to install IRQ handler\n");
1348 		goto err_drvdata;
1349 	}
1350 
1351 	ret = drm_vblank_init(drm, 1);
1352 	if (ret) {
1353 		dev_err(dev, "Failed calling drm_vblank_init()\n");
1354 		goto err_drvdata;
1355 	}
1356 
1357 	drm_mode_config_reset(drm);
1358 
1359 	ret = clk_prepare_enable(priv->pix_clk);
1360 	if (ret) {
1361 		dev_err(dev, "Unable to start pixel clock\n");
1362 		goto err_drvdata;
1363 	}
1364 
1365 	if (priv->lcd_clk) {
1366 		parent_clk = clk_get_parent(priv->lcd_clk);
1367 		parent_rate = clk_get_rate(parent_clk);
1368 
1369 		/* LCD Device clock must be 3x the pixel clock for STN panels,
1370 		 * or 1.5x the pixel clock for TFT panels. To avoid having to
1371 		 * check for the LCD device clock everytime we do a mode change,
1372 		 * we set the LCD device clock to the highest rate possible.
1373 		 */
1374 		ret = clk_set_rate(priv->lcd_clk, parent_rate);
1375 		if (ret) {
1376 			dev_err(dev, "Unable to set LCD clock rate\n");
1377 			goto err_pixclk_disable;
1378 		}
1379 
1380 		ret = clk_prepare_enable(priv->lcd_clk);
1381 		if (ret) {
1382 			dev_err(dev, "Unable to start lcd clock\n");
1383 			goto err_pixclk_disable;
1384 		}
1385 	}
1386 
1387 	/* Enable OSD if available */
1388 	if (soc_info->has_osd)
1389 		osdc |= JZ_LCD_OSDC_OSDEN;
1390 	if (soc_info->has_alpha)
1391 		osdc |= JZ_LCD_OSDC_ALPHAEN;
1392 	regmap_write(priv->map, JZ_REG_LCD_OSDC, osdc);
1393 
1394 	mutex_init(&priv->clk_mutex);
1395 	priv->clock_nb.notifier_call = ingenic_drm_update_pixclk;
1396 
1397 	parent_clk = clk_get_parent(priv->pix_clk);
1398 	ret = clk_notifier_register(parent_clk, &priv->clock_nb);
1399 	if (ret) {
1400 		dev_err(dev, "Unable to register clock notifier\n");
1401 		goto err_devclk_disable;
1402 	}
1403 
1404 	drm_atomic_private_obj_init(drm, &priv->private_obj,
1405 				    &ingenic_drm_private_state_funcs);
1406 
1407 	ret = drmm_add_action_or_reset(drm, ingenic_drm_atomic_private_obj_fini,
1408 				       &priv->private_obj);
1409 	if (ret)
1410 		goto err_clk_notifier_unregister;
1411 
1412 	ret = drm_dev_register(drm, 0);
1413 	if (ret) {
1414 		dev_err(dev, "Failed to register DRM driver\n");
1415 		goto err_clk_notifier_unregister;
1416 	}
1417 
1418 	drm_client_setup(drm, NULL);
1419 
1420 	return 0;
1421 
1422 err_clk_notifier_unregister:
1423 	clk_notifier_unregister(parent_clk, &priv->clock_nb);
1424 err_devclk_disable:
1425 	if (priv->lcd_clk)
1426 		clk_disable_unprepare(priv->lcd_clk);
1427 err_pixclk_disable:
1428 	clk_disable_unprepare(priv->pix_clk);
1429 err_drvdata:
1430 	platform_set_drvdata(pdev, NULL);
1431 	return ret;
1432 }
1433 
1434 static int ingenic_drm_bind_with_components(struct device *dev)
1435 {
1436 	return ingenic_drm_bind(dev, true);
1437 }
1438 
1439 static void ingenic_drm_unbind(struct device *dev)
1440 {
1441 	struct ingenic_drm *priv = dev_get_drvdata(dev);
1442 	struct clk *parent_clk = clk_get_parent(priv->pix_clk);
1443 
1444 	clk_notifier_unregister(parent_clk, &priv->clock_nb);
1445 	if (priv->lcd_clk)
1446 		clk_disable_unprepare(priv->lcd_clk);
1447 	clk_disable_unprepare(priv->pix_clk);
1448 
1449 	drm_dev_unregister(&priv->drm);
1450 	drm_atomic_helper_shutdown(&priv->drm);
1451 	dev_set_drvdata(dev, NULL);
1452 }
1453 
1454 static const struct component_master_ops ingenic_master_ops = {
1455 	.bind = ingenic_drm_bind_with_components,
1456 	.unbind = ingenic_drm_unbind,
1457 };
1458 
1459 static int ingenic_drm_probe(struct platform_device *pdev)
1460 {
1461 	struct device *dev = &pdev->dev;
1462 	struct component_match *match = NULL;
1463 	struct device_node *np;
1464 
1465 	if (!IS_ENABLED(CONFIG_DRM_INGENIC_IPU))
1466 		return ingenic_drm_bind(dev, false);
1467 
1468 	/* IPU is at port address 8 */
1469 	np = of_graph_get_remote_node(dev->of_node, 8, 0);
1470 	if (!np)
1471 		return ingenic_drm_bind(dev, false);
1472 
1473 	drm_of_component_match_add(dev, &match, component_compare_of, np);
1474 	of_node_put(np);
1475 
1476 	return component_master_add_with_match(dev, &ingenic_master_ops, match);
1477 }
1478 
1479 static void ingenic_drm_remove(struct platform_device *pdev)
1480 {
1481 	struct device *dev = &pdev->dev;
1482 
1483 	if (!IS_ENABLED(CONFIG_DRM_INGENIC_IPU))
1484 		ingenic_drm_unbind(dev);
1485 	else
1486 		component_master_del(dev, &ingenic_master_ops);
1487 }
1488 
1489 static void ingenic_drm_shutdown(struct platform_device *pdev)
1490 {
1491 	struct ingenic_drm *priv = platform_get_drvdata(pdev);
1492 
1493 	if (priv)
1494 		drm_atomic_helper_shutdown(&priv->drm);
1495 }
1496 
1497 static int ingenic_drm_suspend(struct device *dev)
1498 {
1499 	struct ingenic_drm *priv = dev_get_drvdata(dev);
1500 
1501 	return drm_mode_config_helper_suspend(&priv->drm);
1502 }
1503 
1504 static int ingenic_drm_resume(struct device *dev)
1505 {
1506 	struct ingenic_drm *priv = dev_get_drvdata(dev);
1507 
1508 	return drm_mode_config_helper_resume(&priv->drm);
1509 }
1510 
1511 static DEFINE_SIMPLE_DEV_PM_OPS(ingenic_drm_pm_ops,
1512 				ingenic_drm_suspend, ingenic_drm_resume);
1513 
1514 static const u32 jz4740_formats[] = {
1515 	DRM_FORMAT_XRGB1555,
1516 	DRM_FORMAT_RGB565,
1517 	DRM_FORMAT_XRGB8888,
1518 };
1519 
1520 static const u32 jz4725b_formats_f1[] = {
1521 	DRM_FORMAT_XRGB1555,
1522 	DRM_FORMAT_RGB565,
1523 	DRM_FORMAT_XRGB8888,
1524 };
1525 
1526 static const u32 jz4725b_formats_f0[] = {
1527 	DRM_FORMAT_C8,
1528 	DRM_FORMAT_XRGB1555,
1529 	DRM_FORMAT_RGB565,
1530 	DRM_FORMAT_XRGB8888,
1531 };
1532 
1533 static const u32 jz4770_formats_f1[] = {
1534 	DRM_FORMAT_XRGB1555,
1535 	DRM_FORMAT_RGB565,
1536 	DRM_FORMAT_RGB888,
1537 	DRM_FORMAT_XRGB8888,
1538 	DRM_FORMAT_XRGB2101010,
1539 };
1540 
1541 static const u32 jz4770_formats_f0[] = {
1542 	DRM_FORMAT_C8,
1543 	DRM_FORMAT_XRGB1555,
1544 	DRM_FORMAT_RGB565,
1545 	DRM_FORMAT_RGB888,
1546 	DRM_FORMAT_XRGB8888,
1547 	DRM_FORMAT_XRGB2101010,
1548 };
1549 
1550 static const struct jz_soc_info jz4740_soc_info = {
1551 	.needs_dev_clk = true,
1552 	.has_osd = false,
1553 	.map_noncoherent = false,
1554 	.max_width = 800,
1555 	.max_height = 600,
1556 	.max_burst = JZ_LCD_CTRL_BURST_16,
1557 	.formats_f1 = jz4740_formats,
1558 	.num_formats_f1 = ARRAY_SIZE(jz4740_formats),
1559 	/* JZ4740 has only one plane */
1560 };
1561 
1562 static const struct jz_soc_info jz4725b_soc_info = {
1563 	.needs_dev_clk = false,
1564 	.has_osd = true,
1565 	.map_noncoherent = false,
1566 	.max_width = 800,
1567 	.max_height = 600,
1568 	.max_burst = JZ_LCD_CTRL_BURST_16,
1569 	.formats_f1 = jz4725b_formats_f1,
1570 	.num_formats_f1 = ARRAY_SIZE(jz4725b_formats_f1),
1571 	.formats_f0 = jz4725b_formats_f0,
1572 	.num_formats_f0 = ARRAY_SIZE(jz4725b_formats_f0),
1573 };
1574 
1575 static const struct jz_soc_info jz4760_soc_info = {
1576 	.needs_dev_clk = false,
1577 	.has_osd = true,
1578 	.map_noncoherent = false,
1579 	.max_width = 1280,
1580 	.max_height = 720,
1581 	.max_burst = JZ_LCD_CTRL_BURST_32,
1582 	.formats_f1 = jz4770_formats_f1,
1583 	.num_formats_f1 = ARRAY_SIZE(jz4770_formats_f1),
1584 	.formats_f0 = jz4770_formats_f0,
1585 	.num_formats_f0 = ARRAY_SIZE(jz4770_formats_f0),
1586 };
1587 
1588 static const struct jz_soc_info jz4760b_soc_info = {
1589 	.needs_dev_clk = false,
1590 	.has_osd = true,
1591 	.map_noncoherent = false,
1592 	.max_width = 1280,
1593 	.max_height = 720,
1594 	.max_burst = JZ_LCD_CTRL_BURST_64,
1595 	.formats_f1 = jz4770_formats_f1,
1596 	.num_formats_f1 = ARRAY_SIZE(jz4770_formats_f1),
1597 	.formats_f0 = jz4770_formats_f0,
1598 	.num_formats_f0 = ARRAY_SIZE(jz4770_formats_f0),
1599 };
1600 
1601 static const struct jz_soc_info jz4770_soc_info = {
1602 	.needs_dev_clk = false,
1603 	.has_osd = true,
1604 	.map_noncoherent = true,
1605 	.max_width = 1280,
1606 	.max_height = 720,
1607 	.max_burst = JZ_LCD_CTRL_BURST_64,
1608 	.formats_f1 = jz4770_formats_f1,
1609 	.num_formats_f1 = ARRAY_SIZE(jz4770_formats_f1),
1610 	.formats_f0 = jz4770_formats_f0,
1611 	.num_formats_f0 = ARRAY_SIZE(jz4770_formats_f0),
1612 };
1613 
1614 static const struct jz_soc_info jz4780_soc_info = {
1615 	.needs_dev_clk = true,
1616 	.has_osd = true,
1617 	.has_alpha = true,
1618 	.use_extended_hwdesc = true,
1619 	.plane_f0_not_working = true,	/* REVISIT */
1620 	.max_width = 4096,
1621 	.max_height = 2048,
1622 	.max_burst = JZ_LCD_CTRL_BURST_64,
1623 	.formats_f1 = jz4770_formats_f1,
1624 	.num_formats_f1 = ARRAY_SIZE(jz4770_formats_f1),
1625 	.formats_f0 = jz4770_formats_f0,
1626 	.num_formats_f0 = ARRAY_SIZE(jz4770_formats_f0),
1627 };
1628 
1629 static const struct of_device_id ingenic_drm_of_match[] = {
1630 	{ .compatible = "ingenic,jz4740-lcd", .data = &jz4740_soc_info },
1631 	{ .compatible = "ingenic,jz4725b-lcd", .data = &jz4725b_soc_info },
1632 	{ .compatible = "ingenic,jz4760-lcd", .data = &jz4760_soc_info },
1633 	{ .compatible = "ingenic,jz4760b-lcd", .data = &jz4760b_soc_info },
1634 	{ .compatible = "ingenic,jz4770-lcd", .data = &jz4770_soc_info },
1635 	{ .compatible = "ingenic,jz4780-lcd", .data = &jz4780_soc_info },
1636 	{ /* sentinel */ },
1637 };
1638 MODULE_DEVICE_TABLE(of, ingenic_drm_of_match);
1639 
1640 static struct platform_driver ingenic_drm_driver = {
1641 	.driver = {
1642 		.name = "ingenic-drm",
1643 		.pm = pm_sleep_ptr(&ingenic_drm_pm_ops),
1644 		.of_match_table = of_match_ptr(ingenic_drm_of_match),
1645 	},
1646 	.probe = ingenic_drm_probe,
1647 	.remove = ingenic_drm_remove,
1648 	.shutdown = ingenic_drm_shutdown,
1649 };
1650 
1651 static int ingenic_drm_init(void)
1652 {
1653 	int err;
1654 
1655 	if (drm_firmware_drivers_only())
1656 		return -ENODEV;
1657 
1658 	if (IS_ENABLED(CONFIG_DRM_INGENIC_IPU)) {
1659 		err = platform_driver_register(ingenic_ipu_driver_ptr);
1660 		if (err)
1661 			return err;
1662 	}
1663 
1664 	err = platform_driver_register(&ingenic_drm_driver);
1665 	if (IS_ENABLED(CONFIG_DRM_INGENIC_IPU) && err)
1666 		platform_driver_unregister(ingenic_ipu_driver_ptr);
1667 
1668 	return err;
1669 }
1670 module_init(ingenic_drm_init);
1671 
1672 static void ingenic_drm_exit(void)
1673 {
1674 	platform_driver_unregister(&ingenic_drm_driver);
1675 
1676 	if (IS_ENABLED(CONFIG_DRM_INGENIC_IPU))
1677 		platform_driver_unregister(ingenic_ipu_driver_ptr);
1678 }
1679 module_exit(ingenic_drm_exit);
1680 
1681 MODULE_AUTHOR("Paul Cercueil <paul@crapouillou.net>");
1682 MODULE_DESCRIPTION("DRM driver for the Ingenic SoCs\n");
1683 MODULE_LICENSE("GPL");
1684