1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * Hisilicon Hi6220 SoC ADE(Advanced Display Engine)'s crtc&plane driver
4  *
5  * Copyright (c) 2016 Linaro Limited.
6  * Copyright (c) 2014-2016 Hisilicon Limited.
7  *
8  * Author:
9  *	Xinliang Liu <z.liuxinliang@hisilicon.com>
10  *	Xinliang Liu <xinliang.liu@linaro.org>
11  *	Xinwei Kong <kong.kongxinwei@hisilicon.com>
12  */
13 
14 #include <linux/bitops.h>
15 #include <linux/clk.h>
16 #include <linux/mfd/syscon.h>
17 #include <linux/platform_device.h>
18 #include <linux/regmap.h>
19 #include <linux/reset.h>
20 
21 #include <video/display_timing.h>
22 
23 #include <drm/drm_atomic.h>
24 #include <drm/drm_atomic_helper.h>
25 #include <drm/drm_crtc.h>
26 #include <drm/drm_drv.h>
27 #include <drm/drm_fb_cma_helper.h>
28 #include <drm/drm_fourcc.h>
29 #include <drm/drm_gem_cma_helper.h>
30 #include <drm/drm_plane_helper.h>
31 #include <drm/drm_probe_helper.h>
32 #include <drm/drm_vblank.h>
33 #include <drm/drm_gem_framebuffer_helper.h>
34 
35 #include "kirin_drm_drv.h"
36 #include "kirin_ade_reg.h"
37 
38 #define OUT_OVLY	ADE_OVLY2 /* output overlay compositor */
39 #define ADE_DEBUG	1
40 
41 
42 struct ade_hw_ctx {
43 	void __iomem  *base;
44 	struct regmap *noc_regmap;
45 	struct clk *ade_core_clk;
46 	struct clk *media_noc_clk;
47 	struct clk *ade_pix_clk;
48 	struct reset_control *reset;
49 	bool power_on;
50 	int irq;
51 
52 	struct drm_crtc *crtc;
53 };
54 
55 static const struct kirin_format ade_formats[] = {
56 	/* 16bpp RGB: */
57 	{ DRM_FORMAT_RGB565, ADE_RGB_565 },
58 	{ DRM_FORMAT_BGR565, ADE_BGR_565 },
59 	/* 24bpp RGB: */
60 	{ DRM_FORMAT_RGB888, ADE_RGB_888 },
61 	{ DRM_FORMAT_BGR888, ADE_BGR_888 },
62 	/* 32bpp [A]RGB: */
63 	{ DRM_FORMAT_XRGB8888, ADE_XRGB_8888 },
64 	{ DRM_FORMAT_XBGR8888, ADE_XBGR_8888 },
65 	{ DRM_FORMAT_RGBA8888, ADE_RGBA_8888 },
66 	{ DRM_FORMAT_BGRA8888, ADE_BGRA_8888 },
67 	{ DRM_FORMAT_ARGB8888, ADE_ARGB_8888 },
68 	{ DRM_FORMAT_ABGR8888, ADE_ABGR_8888 },
69 };
70 
71 static const u32 channel_formats[] = {
72 	/* channel 1,2,3,4 */
73 	DRM_FORMAT_RGB565, DRM_FORMAT_BGR565, DRM_FORMAT_RGB888,
74 	DRM_FORMAT_BGR888, DRM_FORMAT_XRGB8888, DRM_FORMAT_XBGR8888,
75 	DRM_FORMAT_RGBA8888, DRM_FORMAT_BGRA8888, DRM_FORMAT_ARGB8888,
76 	DRM_FORMAT_ABGR8888
77 };
78 
79 /* convert from fourcc format to ade format */
80 static u32 ade_get_format(u32 pixel_format)
81 {
82 	int i;
83 
84 	for (i = 0; i < ARRAY_SIZE(ade_formats); i++)
85 		if (ade_formats[i].pixel_format == pixel_format)
86 			return ade_formats[i].hw_format;
87 
88 	/* not found */
89 	DRM_ERROR("Not found pixel format!!fourcc_format= %d\n",
90 		  pixel_format);
91 	return ADE_FORMAT_UNSUPPORT;
92 }
93 
94 static void ade_update_reload_bit(void __iomem *base, u32 bit_num, u32 val)
95 {
96 	u32 bit_ofst, reg_num;
97 
98 	bit_ofst = bit_num % 32;
99 	reg_num = bit_num / 32;
100 
101 	ade_update_bits(base + ADE_RELOAD_DIS(reg_num), bit_ofst,
102 			MASK(1), !!val);
103 }
104 
105 static u32 ade_read_reload_bit(void __iomem *base, u32 bit_num)
106 {
107 	u32 tmp, bit_ofst, reg_num;
108 
109 	bit_ofst = bit_num % 32;
110 	reg_num = bit_num / 32;
111 
112 	tmp = readl(base + ADE_RELOAD_DIS(reg_num));
113 	return !!(BIT(bit_ofst) & tmp);
114 }
115 
116 static void ade_init(struct ade_hw_ctx *ctx)
117 {
118 	void __iomem *base = ctx->base;
119 
120 	/* enable clk gate */
121 	ade_update_bits(base + ADE_CTRL1, AUTO_CLK_GATE_EN_OFST,
122 			AUTO_CLK_GATE_EN, ADE_ENABLE);
123 	/* clear overlay */
124 	writel(0, base + ADE_OVLY1_TRANS_CFG);
125 	writel(0, base + ADE_OVLY_CTL);
126 	writel(0, base + ADE_OVLYX_CTL(OUT_OVLY));
127 	/* clear reset and reload regs */
128 	writel(MASK(32), base + ADE_SOFT_RST_SEL(0));
129 	writel(MASK(32), base + ADE_SOFT_RST_SEL(1));
130 	writel(MASK(32), base + ADE_RELOAD_DIS(0));
131 	writel(MASK(32), base + ADE_RELOAD_DIS(1));
132 	/*
133 	 * for video mode, all the ade registers should
134 	 * become effective at frame end.
135 	 */
136 	ade_update_bits(base + ADE_CTRL, FRM_END_START_OFST,
137 			FRM_END_START_MASK, REG_EFFECTIVE_IN_ADEEN_FRMEND);
138 }
139 
140 static bool ade_crtc_mode_fixup(struct drm_crtc *crtc,
141 				const struct drm_display_mode *mode,
142 				struct drm_display_mode *adjusted_mode)
143 {
144 	struct kirin_crtc *kcrtc = to_kirin_crtc(crtc);
145 	struct ade_hw_ctx *ctx = kcrtc->hw_ctx;
146 
147 	adjusted_mode->clock =
148 		clk_round_rate(ctx->ade_pix_clk, mode->clock * 1000) / 1000;
149 	return true;
150 }
151 
152 
153 static void ade_set_pix_clk(struct ade_hw_ctx *ctx,
154 			    struct drm_display_mode *mode,
155 			    struct drm_display_mode *adj_mode)
156 {
157 	u32 clk_Hz = mode->clock * 1000;
158 	int ret;
159 
160 	/*
161 	 * Success should be guaranteed in mode_valid call back,
162 	 * so failure shouldn't happen here
163 	 */
164 	ret = clk_set_rate(ctx->ade_pix_clk, clk_Hz);
165 	if (ret)
166 		DRM_ERROR("failed to set pixel clk %dHz (%d)\n", clk_Hz, ret);
167 	adj_mode->clock = clk_get_rate(ctx->ade_pix_clk) / 1000;
168 }
169 
170 static void ade_ldi_set_mode(struct ade_hw_ctx *ctx,
171 			     struct drm_display_mode *mode,
172 			     struct drm_display_mode *adj_mode)
173 {
174 	void __iomem *base = ctx->base;
175 	u32 width = mode->hdisplay;
176 	u32 height = mode->vdisplay;
177 	u32 hfp, hbp, hsw, vfp, vbp, vsw;
178 	u32 plr_flags;
179 
180 	plr_flags = (mode->flags & DRM_MODE_FLAG_NVSYNC) ? FLAG_NVSYNC : 0;
181 	plr_flags |= (mode->flags & DRM_MODE_FLAG_NHSYNC) ? FLAG_NHSYNC : 0;
182 	hfp = mode->hsync_start - mode->hdisplay;
183 	hbp = mode->htotal - mode->hsync_end;
184 	hsw = mode->hsync_end - mode->hsync_start;
185 	vfp = mode->vsync_start - mode->vdisplay;
186 	vbp = mode->vtotal - mode->vsync_end;
187 	vsw = mode->vsync_end - mode->vsync_start;
188 	if (vsw > 15) {
189 		DRM_DEBUG_DRIVER("vsw exceeded 15\n");
190 		vsw = 15;
191 	}
192 
193 	writel((hbp << HBP_OFST) | hfp, base + LDI_HRZ_CTRL0);
194 	 /* the configured value is actual value - 1 */
195 	writel(hsw - 1, base + LDI_HRZ_CTRL1);
196 	writel((vbp << VBP_OFST) | vfp, base + LDI_VRT_CTRL0);
197 	 /* the configured value is actual value - 1 */
198 	writel(vsw - 1, base + LDI_VRT_CTRL1);
199 	 /* the configured value is actual value - 1 */
200 	writel(((height - 1) << VSIZE_OFST) | (width - 1),
201 	       base + LDI_DSP_SIZE);
202 	writel(plr_flags, base + LDI_PLR_CTRL);
203 
204 	/* set overlay compositor output size */
205 	writel(((width - 1) << OUTPUT_XSIZE_OFST) | (height - 1),
206 	       base + ADE_OVLY_OUTPUT_SIZE(OUT_OVLY));
207 
208 	/* ctran6 setting */
209 	writel(CTRAN_BYPASS_ON, base + ADE_CTRAN_DIS(ADE_CTRAN6));
210 	 /* the configured value is actual value - 1 */
211 	writel(width * height - 1, base + ADE_CTRAN_IMAGE_SIZE(ADE_CTRAN6));
212 	ade_update_reload_bit(base, CTRAN_OFST + ADE_CTRAN6, 0);
213 
214 	ade_set_pix_clk(ctx, mode, adj_mode);
215 
216 	DRM_DEBUG_DRIVER("set mode: %dx%d\n", width, height);
217 }
218 
219 static int ade_power_up(struct ade_hw_ctx *ctx)
220 {
221 	int ret;
222 
223 	ret = clk_prepare_enable(ctx->media_noc_clk);
224 	if (ret) {
225 		DRM_ERROR("failed to enable media_noc_clk (%d)\n", ret);
226 		return ret;
227 	}
228 
229 	ret = reset_control_deassert(ctx->reset);
230 	if (ret) {
231 		DRM_ERROR("failed to deassert reset\n");
232 		return ret;
233 	}
234 
235 	ret = clk_prepare_enable(ctx->ade_core_clk);
236 	if (ret) {
237 		DRM_ERROR("failed to enable ade_core_clk (%d)\n", ret);
238 		return ret;
239 	}
240 
241 	ade_init(ctx);
242 	ctx->power_on = true;
243 	return 0;
244 }
245 
246 static void ade_power_down(struct ade_hw_ctx *ctx)
247 {
248 	void __iomem *base = ctx->base;
249 
250 	writel(ADE_DISABLE, base + LDI_CTRL);
251 	/* dsi pixel off */
252 	writel(DSI_PCLK_OFF, base + LDI_HDMI_DSI_GT);
253 
254 	clk_disable_unprepare(ctx->ade_core_clk);
255 	reset_control_assert(ctx->reset);
256 	clk_disable_unprepare(ctx->media_noc_clk);
257 	ctx->power_on = false;
258 }
259 
260 static void ade_set_medianoc_qos(struct ade_hw_ctx *ctx)
261 {
262 	struct regmap *map = ctx->noc_regmap;
263 
264 	regmap_update_bits(map, ADE0_QOSGENERATOR_MODE,
265 			   QOSGENERATOR_MODE_MASK, BYPASS_MODE);
266 	regmap_update_bits(map, ADE0_QOSGENERATOR_EXTCONTROL,
267 			   SOCKET_QOS_EN, SOCKET_QOS_EN);
268 
269 	regmap_update_bits(map, ADE1_QOSGENERATOR_MODE,
270 			   QOSGENERATOR_MODE_MASK, BYPASS_MODE);
271 	regmap_update_bits(map, ADE1_QOSGENERATOR_EXTCONTROL,
272 			   SOCKET_QOS_EN, SOCKET_QOS_EN);
273 }
274 
275 static int ade_crtc_enable_vblank(struct drm_crtc *crtc)
276 {
277 	struct kirin_crtc *kcrtc = to_kirin_crtc(crtc);
278 	struct ade_hw_ctx *ctx = kcrtc->hw_ctx;
279 	void __iomem *base = ctx->base;
280 
281 	if (!ctx->power_on)
282 		(void)ade_power_up(ctx);
283 
284 	ade_update_bits(base + LDI_INT_EN, FRAME_END_INT_EN_OFST,
285 			MASK(1), 1);
286 
287 	return 0;
288 }
289 
290 static void ade_crtc_disable_vblank(struct drm_crtc *crtc)
291 {
292 	struct kirin_crtc *kcrtc = to_kirin_crtc(crtc);
293 	struct ade_hw_ctx *ctx = kcrtc->hw_ctx;
294 	void __iomem *base = ctx->base;
295 
296 	if (!ctx->power_on) {
297 		DRM_ERROR("power is down! vblank disable fail\n");
298 		return;
299 	}
300 
301 	ade_update_bits(base + LDI_INT_EN, FRAME_END_INT_EN_OFST,
302 			MASK(1), 0);
303 }
304 
305 static irqreturn_t ade_irq_handler(int irq, void *data)
306 {
307 	struct ade_hw_ctx *ctx = data;
308 	struct drm_crtc *crtc = ctx->crtc;
309 	void __iomem *base = ctx->base;
310 	u32 status;
311 
312 	status = readl(base + LDI_MSK_INT);
313 	DRM_DEBUG_VBL("LDI IRQ: status=0x%X\n", status);
314 
315 	/* vblank irq */
316 	if (status & BIT(FRAME_END_INT_EN_OFST)) {
317 		ade_update_bits(base + LDI_INT_CLR, FRAME_END_INT_EN_OFST,
318 				MASK(1), 1);
319 		drm_crtc_handle_vblank(crtc);
320 	}
321 
322 	return IRQ_HANDLED;
323 }
324 
325 static void ade_display_enable(struct ade_hw_ctx *ctx)
326 {
327 	void __iomem *base = ctx->base;
328 	u32 out_fmt = LDI_OUT_RGB_888;
329 
330 	/* enable output overlay compositor */
331 	writel(ADE_ENABLE, base + ADE_OVLYX_CTL(OUT_OVLY));
332 	ade_update_reload_bit(base, OVLY_OFST + OUT_OVLY, 0);
333 
334 	/* display source setting */
335 	writel(DISP_SRC_OVLY2, base + ADE_DISP_SRC_CFG);
336 
337 	/* enable ade */
338 	writel(ADE_ENABLE, base + ADE_EN);
339 	/* enable ldi */
340 	writel(NORMAL_MODE, base + LDI_WORK_MODE);
341 	writel((out_fmt << BPP_OFST) | DATA_GATE_EN | LDI_EN,
342 	       base + LDI_CTRL);
343 	/* dsi pixel on */
344 	writel(DSI_PCLK_ON, base + LDI_HDMI_DSI_GT);
345 }
346 
347 #if ADE_DEBUG
348 static void ade_rdma_dump_regs(void __iomem *base, u32 ch)
349 {
350 	u32 reg_ctrl, reg_addr, reg_size, reg_stride, reg_space, reg_en;
351 	u32 val;
352 
353 	reg_ctrl = RD_CH_CTRL(ch);
354 	reg_addr = RD_CH_ADDR(ch);
355 	reg_size = RD_CH_SIZE(ch);
356 	reg_stride = RD_CH_STRIDE(ch);
357 	reg_space = RD_CH_SPACE(ch);
358 	reg_en = RD_CH_EN(ch);
359 
360 	val = ade_read_reload_bit(base, RDMA_OFST + ch);
361 	DRM_DEBUG_DRIVER("[rdma%d]: reload(%d)\n", ch + 1, val);
362 	val = readl(base + reg_ctrl);
363 	DRM_DEBUG_DRIVER("[rdma%d]: reg_ctrl(0x%08x)\n", ch + 1, val);
364 	val = readl(base + reg_addr);
365 	DRM_DEBUG_DRIVER("[rdma%d]: reg_addr(0x%08x)\n", ch + 1, val);
366 	val = readl(base + reg_size);
367 	DRM_DEBUG_DRIVER("[rdma%d]: reg_size(0x%08x)\n", ch + 1, val);
368 	val = readl(base + reg_stride);
369 	DRM_DEBUG_DRIVER("[rdma%d]: reg_stride(0x%08x)\n", ch + 1, val);
370 	val = readl(base + reg_space);
371 	DRM_DEBUG_DRIVER("[rdma%d]: reg_space(0x%08x)\n", ch + 1, val);
372 	val = readl(base + reg_en);
373 	DRM_DEBUG_DRIVER("[rdma%d]: reg_en(0x%08x)\n", ch + 1, val);
374 }
375 
376 static void ade_clip_dump_regs(void __iomem *base, u32 ch)
377 {
378 	u32 val;
379 
380 	val = ade_read_reload_bit(base, CLIP_OFST + ch);
381 	DRM_DEBUG_DRIVER("[clip%d]: reload(%d)\n", ch + 1, val);
382 	val = readl(base + ADE_CLIP_DISABLE(ch));
383 	DRM_DEBUG_DRIVER("[clip%d]: reg_clip_disable(0x%08x)\n", ch + 1, val);
384 	val = readl(base + ADE_CLIP_SIZE0(ch));
385 	DRM_DEBUG_DRIVER("[clip%d]: reg_clip_size0(0x%08x)\n", ch + 1, val);
386 	val = readl(base + ADE_CLIP_SIZE1(ch));
387 	DRM_DEBUG_DRIVER("[clip%d]: reg_clip_size1(0x%08x)\n", ch + 1, val);
388 }
389 
390 static void ade_compositor_routing_dump_regs(void __iomem *base, u32 ch)
391 {
392 	u8 ovly_ch = 0; /* TODO: Only primary plane now */
393 	u32 val;
394 
395 	val = readl(base + ADE_OVLY_CH_XY0(ovly_ch));
396 	DRM_DEBUG_DRIVER("[overlay ch%d]: reg_ch_xy0(0x%08x)\n", ovly_ch, val);
397 	val = readl(base + ADE_OVLY_CH_XY1(ovly_ch));
398 	DRM_DEBUG_DRIVER("[overlay ch%d]: reg_ch_xy1(0x%08x)\n", ovly_ch, val);
399 	val = readl(base + ADE_OVLY_CH_CTL(ovly_ch));
400 	DRM_DEBUG_DRIVER("[overlay ch%d]: reg_ch_ctl(0x%08x)\n", ovly_ch, val);
401 }
402 
403 static void ade_dump_overlay_compositor_regs(void __iomem *base, u32 comp)
404 {
405 	u32 val;
406 
407 	val = ade_read_reload_bit(base, OVLY_OFST + comp);
408 	DRM_DEBUG_DRIVER("[overlay%d]: reload(%d)\n", comp + 1, val);
409 	writel(ADE_ENABLE, base + ADE_OVLYX_CTL(comp));
410 	DRM_DEBUG_DRIVER("[overlay%d]: reg_ctl(0x%08x)\n", comp + 1, val);
411 	val = readl(base + ADE_OVLY_CTL);
412 	DRM_DEBUG_DRIVER("ovly_ctl(0x%08x)\n", val);
413 }
414 
415 static void ade_dump_regs(void __iomem *base)
416 {
417 	u32 i;
418 
419 	/* dump channel regs */
420 	for (i = 0; i < ADE_CH_NUM; i++) {
421 		/* dump rdma regs */
422 		ade_rdma_dump_regs(base, i);
423 
424 		/* dump clip regs */
425 		ade_clip_dump_regs(base, i);
426 
427 		/* dump compositor routing regs */
428 		ade_compositor_routing_dump_regs(base, i);
429 	}
430 
431 	/* dump overlay compositor regs */
432 	ade_dump_overlay_compositor_regs(base, OUT_OVLY);
433 }
434 #else
435 static void ade_dump_regs(void __iomem *base) { }
436 #endif
437 
438 static void ade_crtc_atomic_enable(struct drm_crtc *crtc,
439 				   struct drm_crtc_state *old_state)
440 {
441 	struct kirin_crtc *kcrtc = to_kirin_crtc(crtc);
442 	struct ade_hw_ctx *ctx = kcrtc->hw_ctx;
443 	int ret;
444 
445 	if (kcrtc->enable)
446 		return;
447 
448 	if (!ctx->power_on) {
449 		ret = ade_power_up(ctx);
450 		if (ret)
451 			return;
452 	}
453 
454 	ade_set_medianoc_qos(ctx);
455 	ade_display_enable(ctx);
456 	ade_dump_regs(ctx->base);
457 	drm_crtc_vblank_on(crtc);
458 	kcrtc->enable = true;
459 }
460 
461 static void ade_crtc_atomic_disable(struct drm_crtc *crtc,
462 				    struct drm_crtc_state *old_state)
463 {
464 	struct kirin_crtc *kcrtc = to_kirin_crtc(crtc);
465 	struct ade_hw_ctx *ctx = kcrtc->hw_ctx;
466 
467 	if (!kcrtc->enable)
468 		return;
469 
470 	drm_crtc_vblank_off(crtc);
471 	ade_power_down(ctx);
472 	kcrtc->enable = false;
473 }
474 
475 static void ade_crtc_mode_set_nofb(struct drm_crtc *crtc)
476 {
477 	struct kirin_crtc *kcrtc = to_kirin_crtc(crtc);
478 	struct ade_hw_ctx *ctx = kcrtc->hw_ctx;
479 	struct drm_display_mode *mode = &crtc->state->mode;
480 	struct drm_display_mode *adj_mode = &crtc->state->adjusted_mode;
481 
482 	if (!ctx->power_on)
483 		(void)ade_power_up(ctx);
484 	ade_ldi_set_mode(ctx, mode, adj_mode);
485 }
486 
487 static void ade_crtc_atomic_begin(struct drm_crtc *crtc,
488 				  struct drm_crtc_state *old_state)
489 {
490 	struct kirin_crtc *kcrtc = to_kirin_crtc(crtc);
491 	struct ade_hw_ctx *ctx = kcrtc->hw_ctx;
492 	struct drm_display_mode *mode = &crtc->state->mode;
493 	struct drm_display_mode *adj_mode = &crtc->state->adjusted_mode;
494 
495 	if (!ctx->power_on)
496 		(void)ade_power_up(ctx);
497 	ade_ldi_set_mode(ctx, mode, adj_mode);
498 }
499 
500 static void ade_crtc_atomic_flush(struct drm_crtc *crtc,
501 				  struct drm_crtc_state *old_state)
502 
503 {
504 	struct kirin_crtc *kcrtc = to_kirin_crtc(crtc);
505 	struct ade_hw_ctx *ctx = kcrtc->hw_ctx;
506 	struct drm_pending_vblank_event *event = crtc->state->event;
507 	void __iomem *base = ctx->base;
508 
509 	/* only crtc is enabled regs take effect */
510 	if (kcrtc->enable) {
511 		ade_dump_regs(base);
512 		/* flush ade registers */
513 		writel(ADE_ENABLE, base + ADE_EN);
514 	}
515 
516 	if (event) {
517 		crtc->state->event = NULL;
518 
519 		spin_lock_irq(&crtc->dev->event_lock);
520 		if (drm_crtc_vblank_get(crtc) == 0)
521 			drm_crtc_arm_vblank_event(crtc, event);
522 		else
523 			drm_crtc_send_vblank_event(crtc, event);
524 		spin_unlock_irq(&crtc->dev->event_lock);
525 	}
526 }
527 
528 static const struct drm_crtc_helper_funcs ade_crtc_helper_funcs = {
529 	.mode_fixup	= ade_crtc_mode_fixup,
530 	.mode_set_nofb	= ade_crtc_mode_set_nofb,
531 	.atomic_begin	= ade_crtc_atomic_begin,
532 	.atomic_flush	= ade_crtc_atomic_flush,
533 	.atomic_enable	= ade_crtc_atomic_enable,
534 	.atomic_disable	= ade_crtc_atomic_disable,
535 };
536 
537 static const struct drm_crtc_funcs ade_crtc_funcs = {
538 	.destroy	= drm_crtc_cleanup,
539 	.set_config	= drm_atomic_helper_set_config,
540 	.page_flip	= drm_atomic_helper_page_flip,
541 	.reset		= drm_atomic_helper_crtc_reset,
542 	.atomic_duplicate_state	= drm_atomic_helper_crtc_duplicate_state,
543 	.atomic_destroy_state	= drm_atomic_helper_crtc_destroy_state,
544 	.enable_vblank	= ade_crtc_enable_vblank,
545 	.disable_vblank	= ade_crtc_disable_vblank,
546 };
547 
548 static void ade_rdma_set(void __iomem *base, struct drm_framebuffer *fb,
549 			 u32 ch, u32 y, u32 in_h, u32 fmt)
550 {
551 	struct drm_gem_cma_object *obj = drm_fb_cma_get_gem_obj(fb, 0);
552 	struct drm_format_name_buf format_name;
553 	u32 reg_ctrl, reg_addr, reg_size, reg_stride, reg_space, reg_en;
554 	u32 stride = fb->pitches[0];
555 	u32 addr = (u32)obj->paddr + y * stride;
556 
557 	DRM_DEBUG_DRIVER("rdma%d: (y=%d, height=%d), stride=%d, paddr=0x%x\n",
558 			 ch + 1, y, in_h, stride, (u32)obj->paddr);
559 	DRM_DEBUG_DRIVER("addr=0x%x, fb:%dx%d, pixel_format=%d(%s)\n",
560 			 addr, fb->width, fb->height, fmt,
561 			 drm_get_format_name(fb->format->format, &format_name));
562 
563 	/* get reg offset */
564 	reg_ctrl = RD_CH_CTRL(ch);
565 	reg_addr = RD_CH_ADDR(ch);
566 	reg_size = RD_CH_SIZE(ch);
567 	reg_stride = RD_CH_STRIDE(ch);
568 	reg_space = RD_CH_SPACE(ch);
569 	reg_en = RD_CH_EN(ch);
570 
571 	/*
572 	 * TODO: set rotation
573 	 */
574 	writel((fmt << 16) & 0x1f0000, base + reg_ctrl);
575 	writel(addr, base + reg_addr);
576 	writel((in_h << 16) | stride, base + reg_size);
577 	writel(stride, base + reg_stride);
578 	writel(in_h * stride, base + reg_space);
579 	writel(ADE_ENABLE, base + reg_en);
580 	ade_update_reload_bit(base, RDMA_OFST + ch, 0);
581 }
582 
583 static void ade_rdma_disable(void __iomem *base, u32 ch)
584 {
585 	u32 reg_en;
586 
587 	/* get reg offset */
588 	reg_en = RD_CH_EN(ch);
589 	writel(0, base + reg_en);
590 	ade_update_reload_bit(base, RDMA_OFST + ch, 1);
591 }
592 
593 static void ade_clip_set(void __iomem *base, u32 ch, u32 fb_w, u32 x,
594 			 u32 in_w, u32 in_h)
595 {
596 	u32 disable_val;
597 	u32 clip_left;
598 	u32 clip_right;
599 
600 	/*
601 	 * clip width, no need to clip height
602 	 */
603 	if (fb_w == in_w) { /* bypass */
604 		disable_val = 1;
605 		clip_left = 0;
606 		clip_right = 0;
607 	} else {
608 		disable_val = 0;
609 		clip_left = x;
610 		clip_right = fb_w - (x + in_w) - 1;
611 	}
612 
613 	DRM_DEBUG_DRIVER("clip%d: clip_left=%d, clip_right=%d\n",
614 			 ch + 1, clip_left, clip_right);
615 
616 	writel(disable_val, base + ADE_CLIP_DISABLE(ch));
617 	writel((fb_w - 1) << 16 | (in_h - 1), base + ADE_CLIP_SIZE0(ch));
618 	writel(clip_left << 16 | clip_right, base + ADE_CLIP_SIZE1(ch));
619 	ade_update_reload_bit(base, CLIP_OFST + ch, 0);
620 }
621 
622 static void ade_clip_disable(void __iomem *base, u32 ch)
623 {
624 	writel(1, base + ADE_CLIP_DISABLE(ch));
625 	ade_update_reload_bit(base, CLIP_OFST + ch, 1);
626 }
627 
628 static bool has_Alpha_channel(int format)
629 {
630 	switch (format) {
631 	case ADE_ARGB_8888:
632 	case ADE_ABGR_8888:
633 	case ADE_RGBA_8888:
634 	case ADE_BGRA_8888:
635 		return true;
636 	default:
637 		return false;
638 	}
639 }
640 
641 static void ade_get_blending_params(u32 fmt, u8 glb_alpha, u8 *alp_mode,
642 				    u8 *alp_sel, u8 *under_alp_sel)
643 {
644 	bool has_alpha = has_Alpha_channel(fmt);
645 
646 	/*
647 	 * get alp_mode
648 	 */
649 	if (has_alpha && glb_alpha < 255)
650 		*alp_mode = ADE_ALP_PIXEL_AND_GLB;
651 	else if (has_alpha)
652 		*alp_mode = ADE_ALP_PIXEL;
653 	else
654 		*alp_mode = ADE_ALP_GLOBAL;
655 
656 	/*
657 	 * get alp sel
658 	 */
659 	*alp_sel = ADE_ALP_MUL_COEFF_3; /* 1 */
660 	*under_alp_sel = ADE_ALP_MUL_COEFF_2; /* 0 */
661 }
662 
663 static void ade_compositor_routing_set(void __iomem *base, u8 ch,
664 				       u32 x0, u32 y0,
665 				       u32 in_w, u32 in_h, u32 fmt)
666 {
667 	u8 ovly_ch = 0; /* TODO: This is the zpos, only one plane now */
668 	u8 glb_alpha = 255;
669 	u32 x1 = x0 + in_w - 1;
670 	u32 y1 = y0 + in_h - 1;
671 	u32 val;
672 	u8 alp_sel;
673 	u8 under_alp_sel;
674 	u8 alp_mode;
675 
676 	ade_get_blending_params(fmt, glb_alpha, &alp_mode, &alp_sel,
677 				&under_alp_sel);
678 
679 	/* overlay routing setting
680 	 */
681 	writel(x0 << 16 | y0, base + ADE_OVLY_CH_XY0(ovly_ch));
682 	writel(x1 << 16 | y1, base + ADE_OVLY_CH_XY1(ovly_ch));
683 	val = (ch + 1) << CH_SEL_OFST | BIT(CH_EN_OFST) |
684 		alp_sel << CH_ALP_SEL_OFST |
685 		under_alp_sel << CH_UNDER_ALP_SEL_OFST |
686 		glb_alpha << CH_ALP_GBL_OFST |
687 		alp_mode << CH_ALP_MODE_OFST;
688 	writel(val, base + ADE_OVLY_CH_CTL(ovly_ch));
689 	/* connect this plane/channel to overlay2 compositor */
690 	ade_update_bits(base + ADE_OVLY_CTL, CH_OVLY_SEL_OFST(ovly_ch),
691 			CH_OVLY_SEL_MASK, CH_OVLY_SEL_VAL(OUT_OVLY));
692 }
693 
694 static void ade_compositor_routing_disable(void __iomem *base, u32 ch)
695 {
696 	u8 ovly_ch = 0; /* TODO: Only primary plane now */
697 
698 	/* disable this plane/channel */
699 	ade_update_bits(base + ADE_OVLY_CH_CTL(ovly_ch), CH_EN_OFST,
700 			MASK(1), 0);
701 	/* dis-connect this plane/channel of overlay2 compositor */
702 	ade_update_bits(base + ADE_OVLY_CTL, CH_OVLY_SEL_OFST(ovly_ch),
703 			CH_OVLY_SEL_MASK, 0);
704 }
705 
706 /*
707  * Typicaly, a channel looks like: DMA-->clip-->scale-->ctrans-->compositor
708  */
709 static void ade_update_channel(struct kirin_plane *kplane,
710 			       struct drm_framebuffer *fb, int crtc_x,
711 			       int crtc_y, unsigned int crtc_w,
712 			       unsigned int crtc_h, u32 src_x,
713 			       u32 src_y, u32 src_w, u32 src_h)
714 {
715 	struct ade_hw_ctx *ctx = kplane->hw_ctx;
716 	void __iomem *base = ctx->base;
717 	u32 fmt = ade_get_format(fb->format->format);
718 	u32 ch = kplane->ch;
719 	u32 in_w;
720 	u32 in_h;
721 
722 	DRM_DEBUG_DRIVER("channel%d: src:(%d, %d)-%dx%d, crtc:(%d, %d)-%dx%d",
723 			 ch + 1, src_x, src_y, src_w, src_h,
724 			 crtc_x, crtc_y, crtc_w, crtc_h);
725 
726 	/* 1) DMA setting */
727 	in_w = src_w;
728 	in_h = src_h;
729 	ade_rdma_set(base, fb, ch, src_y, in_h, fmt);
730 
731 	/* 2) clip setting */
732 	ade_clip_set(base, ch, fb->width, src_x, in_w, in_h);
733 
734 	/* 3) TODO: scale setting for overlay planes */
735 
736 	/* 4) TODO: ctran/csc setting for overlay planes */
737 
738 	/* 5) compositor routing setting */
739 	ade_compositor_routing_set(base, ch, crtc_x, crtc_y, in_w, in_h, fmt);
740 }
741 
742 static void ade_disable_channel(struct kirin_plane *kplane)
743 {
744 	struct ade_hw_ctx *ctx = kplane->hw_ctx;
745 	void __iomem *base = ctx->base;
746 	u32 ch = kplane->ch;
747 
748 	DRM_DEBUG_DRIVER("disable channel%d\n", ch + 1);
749 
750 	/* disable read DMA */
751 	ade_rdma_disable(base, ch);
752 
753 	/* disable clip */
754 	ade_clip_disable(base, ch);
755 
756 	/* disable compositor routing */
757 	ade_compositor_routing_disable(base, ch);
758 }
759 
760 static int ade_plane_atomic_check(struct drm_plane *plane,
761 				  struct drm_plane_state *state)
762 {
763 	struct drm_framebuffer *fb = state->fb;
764 	struct drm_crtc *crtc = state->crtc;
765 	struct drm_crtc_state *crtc_state;
766 	u32 src_x = state->src_x >> 16;
767 	u32 src_y = state->src_y >> 16;
768 	u32 src_w = state->src_w >> 16;
769 	u32 src_h = state->src_h >> 16;
770 	int crtc_x = state->crtc_x;
771 	int crtc_y = state->crtc_y;
772 	u32 crtc_w = state->crtc_w;
773 	u32 crtc_h = state->crtc_h;
774 	u32 fmt;
775 
776 	if (!crtc || !fb)
777 		return 0;
778 
779 	fmt = ade_get_format(fb->format->format);
780 	if (fmt == ADE_FORMAT_UNSUPPORT)
781 		return -EINVAL;
782 
783 	crtc_state = drm_atomic_get_crtc_state(state->state, crtc);
784 	if (IS_ERR(crtc_state))
785 		return PTR_ERR(crtc_state);
786 
787 	if (src_w != crtc_w || src_h != crtc_h) {
788 		return -EINVAL;
789 	}
790 
791 	if (src_x + src_w > fb->width ||
792 	    src_y + src_h > fb->height)
793 		return -EINVAL;
794 
795 	if (crtc_x < 0 || crtc_y < 0)
796 		return -EINVAL;
797 
798 	if (crtc_x + crtc_w > crtc_state->adjusted_mode.hdisplay ||
799 	    crtc_y + crtc_h > crtc_state->adjusted_mode.vdisplay)
800 		return -EINVAL;
801 
802 	return 0;
803 }
804 
805 static void ade_plane_atomic_update(struct drm_plane *plane,
806 				    struct drm_plane_state *old_state)
807 {
808 	struct drm_plane_state *state = plane->state;
809 	struct kirin_plane *kplane = to_kirin_plane(plane);
810 
811 	ade_update_channel(kplane, state->fb, state->crtc_x, state->crtc_y,
812 			   state->crtc_w, state->crtc_h,
813 			   state->src_x >> 16, state->src_y >> 16,
814 			   state->src_w >> 16, state->src_h >> 16);
815 }
816 
817 static void ade_plane_atomic_disable(struct drm_plane *plane,
818 				     struct drm_plane_state *old_state)
819 {
820 	struct kirin_plane *kplane = to_kirin_plane(plane);
821 
822 	ade_disable_channel(kplane);
823 }
824 
825 static const struct drm_plane_helper_funcs ade_plane_helper_funcs = {
826 	.atomic_check = ade_plane_atomic_check,
827 	.atomic_update = ade_plane_atomic_update,
828 	.atomic_disable = ade_plane_atomic_disable,
829 };
830 
831 static struct drm_plane_funcs ade_plane_funcs = {
832 	.update_plane	= drm_atomic_helper_update_plane,
833 	.disable_plane	= drm_atomic_helper_disable_plane,
834 	.destroy = drm_plane_cleanup,
835 	.reset = drm_atomic_helper_plane_reset,
836 	.atomic_duplicate_state = drm_atomic_helper_plane_duplicate_state,
837 	.atomic_destroy_state = drm_atomic_helper_plane_destroy_state,
838 };
839 
840 static void *ade_hw_ctx_alloc(struct platform_device *pdev,
841 			      struct drm_crtc *crtc)
842 {
843 	struct resource *res;
844 	struct device *dev = &pdev->dev;
845 	struct device_node *np = pdev->dev.of_node;
846 	struct ade_hw_ctx *ctx = NULL;
847 	int ret;
848 
849 	ctx = devm_kzalloc(dev, sizeof(*ctx), GFP_KERNEL);
850 	if (!ctx) {
851 		DRM_ERROR("failed to alloc ade_hw_ctx\n");
852 		return ERR_PTR(-ENOMEM);
853 	}
854 
855 	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
856 	ctx->base = devm_ioremap_resource(dev, res);
857 	if (IS_ERR(ctx->base)) {
858 		DRM_ERROR("failed to remap ade io base\n");
859 		return ERR_PTR(-EIO);
860 	}
861 
862 	ctx->reset = devm_reset_control_get(dev, NULL);
863 	if (IS_ERR(ctx->reset))
864 		return ERR_PTR(-ENODEV);
865 
866 	ctx->noc_regmap =
867 		syscon_regmap_lookup_by_phandle(np, "hisilicon,noc-syscon");
868 	if (IS_ERR(ctx->noc_regmap)) {
869 		DRM_ERROR("failed to get noc regmap\n");
870 		return ERR_PTR(-ENODEV);
871 	}
872 
873 	ctx->irq = platform_get_irq(pdev, 0);
874 	if (ctx->irq < 0) {
875 		DRM_ERROR("failed to get irq\n");
876 		return ERR_PTR(-ENODEV);
877 	}
878 
879 	ctx->ade_core_clk = devm_clk_get(dev, "clk_ade_core");
880 	if (IS_ERR(ctx->ade_core_clk)) {
881 		DRM_ERROR("failed to parse clk ADE_CORE\n");
882 		return ERR_PTR(-ENODEV);
883 	}
884 
885 	ctx->media_noc_clk = devm_clk_get(dev, "clk_codec_jpeg");
886 	if (IS_ERR(ctx->media_noc_clk)) {
887 		DRM_ERROR("failed to parse clk CODEC_JPEG\n");
888 		return ERR_PTR(-ENODEV);
889 	}
890 
891 	ctx->ade_pix_clk = devm_clk_get(dev, "clk_ade_pix");
892 	if (IS_ERR(ctx->ade_pix_clk)) {
893 		DRM_ERROR("failed to parse clk ADE_PIX\n");
894 		return ERR_PTR(-ENODEV);
895 	}
896 
897 	/* vblank irq init */
898 	ret = devm_request_irq(dev, ctx->irq, ade_irq_handler,
899 			       IRQF_SHARED, dev->driver->name, ctx);
900 	if (ret)
901 		return ERR_PTR(-EIO);
902 
903 	ctx->crtc = crtc;
904 
905 	return ctx;
906 }
907 
908 static void ade_hw_ctx_cleanup(void *hw_ctx)
909 {
910 }
911 
912 static const struct drm_mode_config_funcs ade_mode_config_funcs = {
913 	.fb_create = drm_gem_fb_create,
914 	.atomic_check = drm_atomic_helper_check,
915 	.atomic_commit = drm_atomic_helper_commit,
916 
917 };
918 
919 DEFINE_DRM_GEM_CMA_FOPS(ade_fops);
920 
921 static struct drm_driver ade_driver = {
922 	.driver_features = DRIVER_GEM | DRIVER_MODESET | DRIVER_ATOMIC,
923 	.fops = &ade_fops,
924 	DRM_GEM_CMA_DRIVER_OPS,
925 	.name = "kirin",
926 	.desc = "Hisilicon Kirin620 SoC DRM Driver",
927 	.date = "20150718",
928 	.major = 1,
929 	.minor = 0,
930 };
931 
932 struct kirin_drm_data ade_driver_data = {
933 	.num_planes = ADE_CH_NUM,
934 	.prim_plane = ADE_CH1,
935 	.channel_formats = channel_formats,
936 	.channel_formats_cnt = ARRAY_SIZE(channel_formats),
937 	.config_max_width = 2048,
938 	.config_max_height = 2048,
939 	.driver = &ade_driver,
940 	.crtc_helper_funcs = &ade_crtc_helper_funcs,
941 	.crtc_funcs = &ade_crtc_funcs,
942 	.plane_helper_funcs = &ade_plane_helper_funcs,
943 	.plane_funcs = &ade_plane_funcs,
944 	.mode_config_funcs = &ade_mode_config_funcs,
945 
946 	.alloc_hw_ctx = ade_hw_ctx_alloc,
947 	.cleanup_hw_ctx = ade_hw_ctx_cleanup,
948 };
949