1 /*
2  * Copyright (C) 2014 Traphandler
3  * Copyright (C) 2014 Free Electrons
4  *
5  * Author: Jean-Jacques Hiblot <jjhiblot@traphandler.com>
6  * Author: Boris BREZILLON <boris.brezillon@free-electrons.com>
7  *
8  * This program is free software; you can redistribute it and/or modify it
9  * under the terms of the GNU General Public License version 2 as published by
10  * the Free Software Foundation.
11  *
12  * This program is distributed in the hope that it will be useful, but WITHOUT
13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
15  * more details.
16  *
17  * You should have received a copy of the GNU General Public License along with
18  * this program.  If not, see <http://www.gnu.org/licenses/>.
19  */
20 
21 #include <linux/clk.h>
22 #include <linux/pm.h>
23 #include <linux/pm_runtime.h>
24 #include <linux/pinctrl/consumer.h>
25 
26 #include <drm/drm_crtc.h>
27 #include <drm/drm_crtc_helper.h>
28 #include <drm/drmP.h>
29 
30 #include <video/videomode.h>
31 
32 #include "atmel_hlcdc_dc.h"
33 
34 /**
35  * Atmel HLCDC CRTC state structure
36  *
37  * @base: base CRTC state
38  * @output_mode: RGBXXX output mode
39  */
40 struct atmel_hlcdc_crtc_state {
41 	struct drm_crtc_state base;
42 	unsigned int output_mode;
43 };
44 
45 static inline struct atmel_hlcdc_crtc_state *
46 drm_crtc_state_to_atmel_hlcdc_crtc_state(struct drm_crtc_state *state)
47 {
48 	return container_of(state, struct atmel_hlcdc_crtc_state, base);
49 }
50 
51 /**
52  * Atmel HLCDC CRTC structure
53  *
54  * @base: base DRM CRTC structure
55  * @hlcdc: pointer to the atmel_hlcdc structure provided by the MFD device
56  * @event: pointer to the current page flip event
57  * @id: CRTC id (returned by drm_crtc_index)
58  */
59 struct atmel_hlcdc_crtc {
60 	struct drm_crtc base;
61 	struct atmel_hlcdc_dc *dc;
62 	struct drm_pending_vblank_event *event;
63 	int id;
64 };
65 
66 static inline struct atmel_hlcdc_crtc *
67 drm_crtc_to_atmel_hlcdc_crtc(struct drm_crtc *crtc)
68 {
69 	return container_of(crtc, struct atmel_hlcdc_crtc, base);
70 }
71 
72 static void atmel_hlcdc_crtc_mode_set_nofb(struct drm_crtc *c)
73 {
74 	struct atmel_hlcdc_crtc *crtc = drm_crtc_to_atmel_hlcdc_crtc(c);
75 	struct regmap *regmap = crtc->dc->hlcdc->regmap;
76 	struct drm_display_mode *adj = &c->state->adjusted_mode;
77 	struct atmel_hlcdc_crtc_state *state;
78 	unsigned long mode_rate;
79 	struct videomode vm;
80 	unsigned long prate;
81 	unsigned int cfg;
82 	int div;
83 
84 	vm.vfront_porch = adj->crtc_vsync_start - adj->crtc_vdisplay;
85 	vm.vback_porch = adj->crtc_vtotal - adj->crtc_vsync_end;
86 	vm.vsync_len = adj->crtc_vsync_end - adj->crtc_vsync_start;
87 	vm.hfront_porch = adj->crtc_hsync_start - adj->crtc_hdisplay;
88 	vm.hback_porch = adj->crtc_htotal - adj->crtc_hsync_end;
89 	vm.hsync_len = adj->crtc_hsync_end - adj->crtc_hsync_start;
90 
91 	regmap_write(regmap, ATMEL_HLCDC_CFG(1),
92 		     (vm.hsync_len - 1) | ((vm.vsync_len - 1) << 16));
93 
94 	regmap_write(regmap, ATMEL_HLCDC_CFG(2),
95 		     (vm.vfront_porch - 1) | (vm.vback_porch << 16));
96 
97 	regmap_write(regmap, ATMEL_HLCDC_CFG(3),
98 		     (vm.hfront_porch - 1) | ((vm.hback_porch - 1) << 16));
99 
100 	regmap_write(regmap, ATMEL_HLCDC_CFG(4),
101 		     (adj->crtc_hdisplay - 1) |
102 		     ((adj->crtc_vdisplay - 1) << 16));
103 
104 	cfg = ATMEL_HLCDC_CLKSEL;
105 
106 	prate = 2 * clk_get_rate(crtc->dc->hlcdc->sys_clk);
107 	mode_rate = adj->crtc_clock * 1000;
108 
109 	div = DIV_ROUND_UP(prate, mode_rate);
110 	if (div < 2) {
111 		div = 2;
112 	} else if (ATMEL_HLCDC_CLKDIV(div) & ~ATMEL_HLCDC_CLKDIV_MASK) {
113 		/* The divider ended up too big, try a lower base rate. */
114 		cfg &= ~ATMEL_HLCDC_CLKSEL;
115 		prate /= 2;
116 		div = DIV_ROUND_UP(prate, mode_rate);
117 		if (ATMEL_HLCDC_CLKDIV(div) & ~ATMEL_HLCDC_CLKDIV_MASK)
118 			div = ATMEL_HLCDC_CLKDIV_MASK;
119 	} else {
120 		int div_low = prate / mode_rate;
121 
122 		if (div_low >= 2 &&
123 		    ((prate / div_low - mode_rate) <
124 		     10 * (mode_rate - prate / div)))
125 			/*
126 			 * At least 10 times better when using a higher
127 			 * frequency than requested, instead of a lower.
128 			 * So, go with that.
129 			 */
130 			div = div_low;
131 	}
132 
133 	cfg |= ATMEL_HLCDC_CLKDIV(div);
134 
135 	regmap_update_bits(regmap, ATMEL_HLCDC_CFG(0),
136 			   ATMEL_HLCDC_CLKSEL | ATMEL_HLCDC_CLKDIV_MASK |
137 			   ATMEL_HLCDC_CLKPOL, cfg);
138 
139 	cfg = 0;
140 
141 	if (adj->flags & DRM_MODE_FLAG_NVSYNC)
142 		cfg |= ATMEL_HLCDC_VSPOL;
143 
144 	if (adj->flags & DRM_MODE_FLAG_NHSYNC)
145 		cfg |= ATMEL_HLCDC_HSPOL;
146 
147 	state = drm_crtc_state_to_atmel_hlcdc_crtc_state(c->state);
148 	cfg |= state->output_mode << 8;
149 
150 	regmap_update_bits(regmap, ATMEL_HLCDC_CFG(5),
151 			   ATMEL_HLCDC_HSPOL | ATMEL_HLCDC_VSPOL |
152 			   ATMEL_HLCDC_VSPDLYS | ATMEL_HLCDC_VSPDLYE |
153 			   ATMEL_HLCDC_DISPPOL | ATMEL_HLCDC_DISPDLY |
154 			   ATMEL_HLCDC_VSPSU | ATMEL_HLCDC_VSPHO |
155 			   ATMEL_HLCDC_GUARDTIME_MASK | ATMEL_HLCDC_MODE_MASK,
156 			   cfg);
157 }
158 
159 static enum drm_mode_status
160 atmel_hlcdc_crtc_mode_valid(struct drm_crtc *c,
161 			    const struct drm_display_mode *mode)
162 {
163 	struct atmel_hlcdc_crtc *crtc = drm_crtc_to_atmel_hlcdc_crtc(c);
164 
165 	return atmel_hlcdc_dc_mode_valid(crtc->dc, mode);
166 }
167 
168 static void atmel_hlcdc_crtc_atomic_disable(struct drm_crtc *c,
169 					    struct drm_crtc_state *old_state)
170 {
171 	struct drm_device *dev = c->dev;
172 	struct atmel_hlcdc_crtc *crtc = drm_crtc_to_atmel_hlcdc_crtc(c);
173 	struct regmap *regmap = crtc->dc->hlcdc->regmap;
174 	unsigned int status;
175 
176 	drm_crtc_vblank_off(c);
177 
178 	pm_runtime_get_sync(dev->dev);
179 
180 	regmap_write(regmap, ATMEL_HLCDC_DIS, ATMEL_HLCDC_DISP);
181 	while (!regmap_read(regmap, ATMEL_HLCDC_SR, &status) &&
182 	       (status & ATMEL_HLCDC_DISP))
183 		cpu_relax();
184 
185 	regmap_write(regmap, ATMEL_HLCDC_DIS, ATMEL_HLCDC_SYNC);
186 	while (!regmap_read(regmap, ATMEL_HLCDC_SR, &status) &&
187 	       (status & ATMEL_HLCDC_SYNC))
188 		cpu_relax();
189 
190 	regmap_write(regmap, ATMEL_HLCDC_DIS, ATMEL_HLCDC_PIXEL_CLK);
191 	while (!regmap_read(regmap, ATMEL_HLCDC_SR, &status) &&
192 	       (status & ATMEL_HLCDC_PIXEL_CLK))
193 		cpu_relax();
194 
195 	clk_disable_unprepare(crtc->dc->hlcdc->sys_clk);
196 	pinctrl_pm_select_sleep_state(dev->dev);
197 
198 	pm_runtime_allow(dev->dev);
199 
200 	pm_runtime_put_sync(dev->dev);
201 }
202 
203 static void atmel_hlcdc_crtc_atomic_enable(struct drm_crtc *c,
204 					   struct drm_crtc_state *old_state)
205 {
206 	struct drm_device *dev = c->dev;
207 	struct atmel_hlcdc_crtc *crtc = drm_crtc_to_atmel_hlcdc_crtc(c);
208 	struct regmap *regmap = crtc->dc->hlcdc->regmap;
209 	unsigned int status;
210 
211 	pm_runtime_get_sync(dev->dev);
212 
213 	pm_runtime_forbid(dev->dev);
214 
215 	pinctrl_pm_select_default_state(dev->dev);
216 	clk_prepare_enable(crtc->dc->hlcdc->sys_clk);
217 
218 	regmap_write(regmap, ATMEL_HLCDC_EN, ATMEL_HLCDC_PIXEL_CLK);
219 	while (!regmap_read(regmap, ATMEL_HLCDC_SR, &status) &&
220 	       !(status & ATMEL_HLCDC_PIXEL_CLK))
221 		cpu_relax();
222 
223 
224 	regmap_write(regmap, ATMEL_HLCDC_EN, ATMEL_HLCDC_SYNC);
225 	while (!regmap_read(regmap, ATMEL_HLCDC_SR, &status) &&
226 	       !(status & ATMEL_HLCDC_SYNC))
227 		cpu_relax();
228 
229 	regmap_write(regmap, ATMEL_HLCDC_EN, ATMEL_HLCDC_DISP);
230 	while (!regmap_read(regmap, ATMEL_HLCDC_SR, &status) &&
231 	       !(status & ATMEL_HLCDC_DISP))
232 		cpu_relax();
233 
234 	pm_runtime_put_sync(dev->dev);
235 
236 	drm_crtc_vblank_on(c);
237 }
238 
239 #define ATMEL_HLCDC_RGB444_OUTPUT	BIT(0)
240 #define ATMEL_HLCDC_RGB565_OUTPUT	BIT(1)
241 #define ATMEL_HLCDC_RGB666_OUTPUT	BIT(2)
242 #define ATMEL_HLCDC_RGB888_OUTPUT	BIT(3)
243 #define ATMEL_HLCDC_OUTPUT_MODE_MASK	GENMASK(3, 0)
244 
245 static int atmel_hlcdc_crtc_select_output_mode(struct drm_crtc_state *state)
246 {
247 	unsigned int output_fmts = ATMEL_HLCDC_OUTPUT_MODE_MASK;
248 	struct atmel_hlcdc_crtc_state *hstate;
249 	struct drm_connector_state *cstate;
250 	struct drm_connector *connector;
251 	struct atmel_hlcdc_crtc *crtc;
252 	int i;
253 
254 	crtc = drm_crtc_to_atmel_hlcdc_crtc(state->crtc);
255 
256 	for_each_new_connector_in_state(state->state, connector, cstate, i) {
257 		struct drm_display_info *info = &connector->display_info;
258 		unsigned int supported_fmts = 0;
259 		int j;
260 
261 		if (!cstate->crtc)
262 			continue;
263 
264 		for (j = 0; j < info->num_bus_formats; j++) {
265 			switch (info->bus_formats[j]) {
266 			case MEDIA_BUS_FMT_RGB444_1X12:
267 				supported_fmts |= ATMEL_HLCDC_RGB444_OUTPUT;
268 				break;
269 			case MEDIA_BUS_FMT_RGB565_1X16:
270 				supported_fmts |= ATMEL_HLCDC_RGB565_OUTPUT;
271 				break;
272 			case MEDIA_BUS_FMT_RGB666_1X18:
273 				supported_fmts |= ATMEL_HLCDC_RGB666_OUTPUT;
274 				break;
275 			case MEDIA_BUS_FMT_RGB888_1X24:
276 				supported_fmts |= ATMEL_HLCDC_RGB888_OUTPUT;
277 				break;
278 			default:
279 				break;
280 			}
281 		}
282 
283 		if (crtc->dc->desc->conflicting_output_formats)
284 			output_fmts &= supported_fmts;
285 		else
286 			output_fmts |= supported_fmts;
287 	}
288 
289 	if (!output_fmts)
290 		return -EINVAL;
291 
292 	hstate = drm_crtc_state_to_atmel_hlcdc_crtc_state(state);
293 	hstate->output_mode = fls(output_fmts) - 1;
294 
295 	return 0;
296 }
297 
298 static int atmel_hlcdc_crtc_atomic_check(struct drm_crtc *c,
299 					 struct drm_crtc_state *s)
300 {
301 	int ret;
302 
303 	ret = atmel_hlcdc_crtc_select_output_mode(s);
304 	if (ret)
305 		return ret;
306 
307 	ret = atmel_hlcdc_plane_prepare_disc_area(s);
308 	if (ret)
309 		return ret;
310 
311 	return atmel_hlcdc_plane_prepare_ahb_routing(s);
312 }
313 
314 static void atmel_hlcdc_crtc_atomic_begin(struct drm_crtc *c,
315 					  struct drm_crtc_state *old_s)
316 {
317 	struct atmel_hlcdc_crtc *crtc = drm_crtc_to_atmel_hlcdc_crtc(c);
318 
319 	if (c->state->event) {
320 		c->state->event->pipe = drm_crtc_index(c);
321 
322 		WARN_ON(drm_crtc_vblank_get(c) != 0);
323 
324 		crtc->event = c->state->event;
325 		c->state->event = NULL;
326 	}
327 }
328 
329 static void atmel_hlcdc_crtc_atomic_flush(struct drm_crtc *crtc,
330 					  struct drm_crtc_state *old_s)
331 {
332 	/* TODO: write common plane control register if available */
333 }
334 
335 static const struct drm_crtc_helper_funcs lcdc_crtc_helper_funcs = {
336 	.mode_valid = atmel_hlcdc_crtc_mode_valid,
337 	.mode_set = drm_helper_crtc_mode_set,
338 	.mode_set_nofb = atmel_hlcdc_crtc_mode_set_nofb,
339 	.mode_set_base = drm_helper_crtc_mode_set_base,
340 	.atomic_check = atmel_hlcdc_crtc_atomic_check,
341 	.atomic_begin = atmel_hlcdc_crtc_atomic_begin,
342 	.atomic_flush = atmel_hlcdc_crtc_atomic_flush,
343 	.atomic_enable = atmel_hlcdc_crtc_atomic_enable,
344 	.atomic_disable = atmel_hlcdc_crtc_atomic_disable,
345 };
346 
347 static void atmel_hlcdc_crtc_destroy(struct drm_crtc *c)
348 {
349 	struct atmel_hlcdc_crtc *crtc = drm_crtc_to_atmel_hlcdc_crtc(c);
350 
351 	drm_crtc_cleanup(c);
352 	kfree(crtc);
353 }
354 
355 static void atmel_hlcdc_crtc_finish_page_flip(struct atmel_hlcdc_crtc *crtc)
356 {
357 	struct drm_device *dev = crtc->base.dev;
358 	unsigned long flags;
359 
360 	spin_lock_irqsave(&dev->event_lock, flags);
361 	if (crtc->event) {
362 		drm_crtc_send_vblank_event(&crtc->base, crtc->event);
363 		drm_crtc_vblank_put(&crtc->base);
364 		crtc->event = NULL;
365 	}
366 	spin_unlock_irqrestore(&dev->event_lock, flags);
367 }
368 
369 void atmel_hlcdc_crtc_irq(struct drm_crtc *c)
370 {
371 	drm_crtc_handle_vblank(c);
372 	atmel_hlcdc_crtc_finish_page_flip(drm_crtc_to_atmel_hlcdc_crtc(c));
373 }
374 
375 static void atmel_hlcdc_crtc_reset(struct drm_crtc *crtc)
376 {
377 	struct atmel_hlcdc_crtc_state *state;
378 
379 	if (crtc->state) {
380 		__drm_atomic_helper_crtc_destroy_state(crtc->state);
381 		state = drm_crtc_state_to_atmel_hlcdc_crtc_state(crtc->state);
382 		kfree(state);
383 		crtc->state = NULL;
384 	}
385 
386 	state = kzalloc(sizeof(*state), GFP_KERNEL);
387 	if (state) {
388 		crtc->state = &state->base;
389 		crtc->state->crtc = crtc;
390 	}
391 }
392 
393 static struct drm_crtc_state *
394 atmel_hlcdc_crtc_duplicate_state(struct drm_crtc *crtc)
395 {
396 	struct atmel_hlcdc_crtc_state *state, *cur;
397 
398 	if (WARN_ON(!crtc->state))
399 		return NULL;
400 
401 	state = kmalloc(sizeof(*state), GFP_KERNEL);
402 	if (!state)
403 		return NULL;
404 	__drm_atomic_helper_crtc_duplicate_state(crtc, &state->base);
405 
406 	cur = drm_crtc_state_to_atmel_hlcdc_crtc_state(crtc->state);
407 	state->output_mode = cur->output_mode;
408 
409 	return &state->base;
410 }
411 
412 static void atmel_hlcdc_crtc_destroy_state(struct drm_crtc *crtc,
413 					   struct drm_crtc_state *s)
414 {
415 	struct atmel_hlcdc_crtc_state *state;
416 
417 	state = drm_crtc_state_to_atmel_hlcdc_crtc_state(s);
418 	__drm_atomic_helper_crtc_destroy_state(s);
419 	kfree(state);
420 }
421 
422 static int atmel_hlcdc_crtc_enable_vblank(struct drm_crtc *c)
423 {
424 	struct atmel_hlcdc_crtc *crtc = drm_crtc_to_atmel_hlcdc_crtc(c);
425 	struct regmap *regmap = crtc->dc->hlcdc->regmap;
426 
427 	/* Enable SOF (Start Of Frame) interrupt for vblank counting */
428 	regmap_write(regmap, ATMEL_HLCDC_IER, ATMEL_HLCDC_SOF);
429 
430 	return 0;
431 }
432 
433 static void atmel_hlcdc_crtc_disable_vblank(struct drm_crtc *c)
434 {
435 	struct atmel_hlcdc_crtc *crtc = drm_crtc_to_atmel_hlcdc_crtc(c);
436 	struct regmap *regmap = crtc->dc->hlcdc->regmap;
437 
438 	regmap_write(regmap, ATMEL_HLCDC_IDR, ATMEL_HLCDC_SOF);
439 }
440 
441 static const struct drm_crtc_funcs atmel_hlcdc_crtc_funcs = {
442 	.page_flip = drm_atomic_helper_page_flip,
443 	.set_config = drm_atomic_helper_set_config,
444 	.destroy = atmel_hlcdc_crtc_destroy,
445 	.reset = atmel_hlcdc_crtc_reset,
446 	.atomic_duplicate_state =  atmel_hlcdc_crtc_duplicate_state,
447 	.atomic_destroy_state = atmel_hlcdc_crtc_destroy_state,
448 	.enable_vblank = atmel_hlcdc_crtc_enable_vblank,
449 	.disable_vblank = atmel_hlcdc_crtc_disable_vblank,
450 	.gamma_set = drm_atomic_helper_legacy_gamma_set,
451 };
452 
453 int atmel_hlcdc_crtc_create(struct drm_device *dev)
454 {
455 	struct atmel_hlcdc_plane *primary = NULL, *cursor = NULL;
456 	struct atmel_hlcdc_dc *dc = dev->dev_private;
457 	struct atmel_hlcdc_crtc *crtc;
458 	int ret;
459 	int i;
460 
461 	crtc = kzalloc(sizeof(*crtc), GFP_KERNEL);
462 	if (!crtc)
463 		return -ENOMEM;
464 
465 	crtc->dc = dc;
466 
467 	for (i = 0; i < ATMEL_HLCDC_MAX_LAYERS; i++) {
468 		if (!dc->layers[i])
469 			continue;
470 
471 		switch (dc->layers[i]->desc->type) {
472 		case ATMEL_HLCDC_BASE_LAYER:
473 			primary = atmel_hlcdc_layer_to_plane(dc->layers[i]);
474 			break;
475 
476 		case ATMEL_HLCDC_CURSOR_LAYER:
477 			cursor = atmel_hlcdc_layer_to_plane(dc->layers[i]);
478 			break;
479 
480 		default:
481 			break;
482 		}
483 	}
484 
485 	ret = drm_crtc_init_with_planes(dev, &crtc->base, &primary->base,
486 					&cursor->base, &atmel_hlcdc_crtc_funcs,
487 					NULL);
488 	if (ret < 0)
489 		goto fail;
490 
491 	crtc->id = drm_crtc_index(&crtc->base);
492 
493 	for (i = 0; i < ATMEL_HLCDC_MAX_LAYERS; i++) {
494 		struct atmel_hlcdc_plane *overlay;
495 
496 		if (dc->layers[i] &&
497 		    dc->layers[i]->desc->type == ATMEL_HLCDC_OVERLAY_LAYER) {
498 			overlay = atmel_hlcdc_layer_to_plane(dc->layers[i]);
499 			overlay->base.possible_crtcs = 1 << crtc->id;
500 		}
501 	}
502 
503 	drm_crtc_helper_add(&crtc->base, &lcdc_crtc_helper_funcs);
504 	drm_crtc_vblank_reset(&crtc->base);
505 
506 	drm_mode_crtc_set_gamma_size(&crtc->base, ATMEL_HLCDC_CLUT_SIZE);
507 	drm_crtc_enable_color_mgmt(&crtc->base, 0, false,
508 				   ATMEL_HLCDC_CLUT_SIZE);
509 
510 	dc->crtc = &crtc->base;
511 
512 	return 0;
513 
514 fail:
515 	atmel_hlcdc_crtc_destroy(&crtc->base);
516 	return ret;
517 }
518