2 * (C) COPYRIGHT 2012-2013 ARM Limited. All rights reserved.
4 * Parts of this file were based on sources as follows:
6 * Copyright (c) 2006-2008 Intel Corporation
7 * Copyright (c) 2007 Dave Airlie <airlied@linux.ie>
8 * Copyright (C) 2011 Texas Instruments
10 * This program is free software and is provided to you under the terms of the
11 * GNU General Public License version 2 as published by the Free Software
12 * Foundation, and any use by you of this program is subject to the terms of
17 #include <linux/amba/clcd-regs.h>
18 #include <linux/clk.h>
19 #include <linux/version.h>
20 #include <linux/dma-buf.h>
21 #include <linux/of_graph.h>
24 #include <drm/drm_gem_cma_helper.h>
25 #include <drm/drm_gem_framebuffer_helper.h>
26 #include <drm/drm_fb_cma_helper.h>
28 #include "pl111_drm.h"
30 irqreturn_t pl111_irq(int irq, void *data)
32 struct pl111_drm_dev_private *priv = data;
34 irqreturn_t status = IRQ_NONE;
36 irq_stat = readl(priv->regs + CLCD_PL111_MIS);
41 if (irq_stat & CLCD_IRQ_NEXTBASE_UPDATE) {
42 drm_crtc_handle_vblank(&priv->pipe.crtc);
47 /* Clear the interrupt once done */
48 writel(irq_stat, priv->regs + CLCD_PL111_ICR);
53 static int pl111_display_check(struct drm_simple_display_pipe *pipe,
54 struct drm_plane_state *pstate,
55 struct drm_crtc_state *cstate)
57 const struct drm_display_mode *mode = &cstate->mode;
58 struct drm_framebuffer *old_fb = pipe->plane.state->fb;
59 struct drm_framebuffer *fb = pstate->fb;
61 if (mode->hdisplay % 16)
65 u32 offset = drm_fb_cma_get_gem_addr(fb, pstate, 0);
67 /* FB base address must be dword aligned. */
71 /* There's no pitch register -- the mode's hdisplay
74 if (fb->pitches[0] != mode->hdisplay * fb->format->cpp[0])
77 /* We can't change the FB format in a flicker-free
78 * manner (and only update it during CRTC enable).
80 if (old_fb && old_fb->format != fb->format)
81 cstate->mode_changed = true;
87 static void pl111_display_enable(struct drm_simple_display_pipe *pipe,
88 struct drm_crtc_state *cstate)
90 struct drm_crtc *crtc = &pipe->crtc;
91 struct drm_plane *plane = &pipe->plane;
92 struct drm_device *drm = crtc->dev;
93 struct pl111_drm_dev_private *priv = drm->dev_private;
94 const struct drm_display_mode *mode = &cstate->mode;
95 struct drm_framebuffer *fb = plane->state->fb;
96 struct drm_connector *connector = priv->connector;
97 struct drm_bridge *bridge = priv->bridge;
99 u32 ppl, hsw, hfp, hbp;
100 u32 lpp, vsw, vfp, vbp;
104 ret = clk_set_rate(priv->clk, mode->clock * 1000);
107 "Failed to set pixel clock rate to %d: %d\n",
108 mode->clock * 1000, ret);
111 clk_prepare_enable(priv->clk);
113 ppl = (mode->hdisplay / 16) - 1;
114 hsw = mode->hsync_end - mode->hsync_start - 1;
115 hfp = mode->hsync_start - mode->hdisplay - 1;
116 hbp = mode->htotal - mode->hsync_end - 1;
118 lpp = mode->vdisplay - 1;
119 vsw = mode->vsync_end - mode->vsync_start - 1;
120 vfp = mode->vsync_start - mode->vdisplay;
121 vbp = mode->vtotal - mode->vsync_end;
123 cpl = mode->hdisplay - 1;
129 priv->regs + CLCD_TIM0);
134 priv->regs + CLCD_TIM1);
136 spin_lock(&priv->tim2_lock);
138 tim2 = readl(priv->regs + CLCD_TIM2);
139 tim2 &= (TIM2_BCD | TIM2_PCD_LO_MASK | TIM2_PCD_HI_MASK);
141 if (priv->variant->broken_clockdivider)
144 if (mode->flags & DRM_MODE_FLAG_NHSYNC)
147 if (mode->flags & DRM_MODE_FLAG_NVSYNC)
151 if (connector->display_info.bus_flags & DRM_BUS_FLAG_DE_LOW)
154 if (connector->display_info.bus_flags &
155 DRM_BUS_FLAG_PIXDATA_NEGEDGE)
160 const struct drm_bridge_timings *btimings = bridge->timings;
163 * Here is when things get really fun. Sometimes the bridge
164 * timings are such that the signal out from PL11x is not
165 * stable before the receiving bridge (such as a dumb VGA DAC
166 * or similar) samples it. If that happens, we compensate by
167 * the only method we have: output the data on the opposite
168 * edge of the clock so it is for sure stable when it gets
171 * The PL111 manual does not contain proper timining diagrams
172 * or data for these details, but we know from experiments
173 * that the setup time is more than 3000 picoseconds (3 ns).
174 * If we have a bridge that requires the signal to be stable
175 * earlier than 3000 ps before the clock pulse, we have to
176 * output the data on the opposite edge to avoid flicker.
178 if (btimings && btimings->setup_time_ps >= 3000)
183 writel(tim2, priv->regs + CLCD_TIM2);
184 spin_unlock(&priv->tim2_lock);
186 writel(0, priv->regs + CLCD_TIM3);
188 /* Hard-code TFT panel */
189 cntl = CNTL_LCDEN | CNTL_LCDTFT | CNTL_LCDVCOMP(1);
191 /* Note that the the hardware's format reader takes 'r' from
192 * the low bit, while DRM formats list channels from high bit
193 * to low bit as you read left to right.
195 switch (fb->format->format) {
196 case DRM_FORMAT_ABGR8888:
197 case DRM_FORMAT_XBGR8888:
198 cntl |= CNTL_LCDBPP24;
200 case DRM_FORMAT_ARGB8888:
201 case DRM_FORMAT_XRGB8888:
202 cntl |= CNTL_LCDBPP24 | CNTL_BGR;
204 case DRM_FORMAT_BGR565:
205 if (priv->variant->is_pl110)
206 cntl |= CNTL_LCDBPP16;
208 cntl |= CNTL_LCDBPP16_565;
210 case DRM_FORMAT_RGB565:
211 if (priv->variant->is_pl110)
212 cntl |= CNTL_LCDBPP16;
214 cntl |= CNTL_LCDBPP16_565;
217 case DRM_FORMAT_ABGR1555:
218 case DRM_FORMAT_XBGR1555:
219 cntl |= CNTL_LCDBPP16;
221 case DRM_FORMAT_ARGB1555:
222 case DRM_FORMAT_XRGB1555:
223 cntl |= CNTL_LCDBPP16 | CNTL_BGR;
225 case DRM_FORMAT_ABGR4444:
226 case DRM_FORMAT_XBGR4444:
227 cntl |= CNTL_LCDBPP16_444;
229 case DRM_FORMAT_ARGB4444:
230 case DRM_FORMAT_XRGB4444:
231 cntl |= CNTL_LCDBPP16_444 | CNTL_BGR;
234 WARN_ONCE(true, "Unknown FB format 0x%08x\n",
239 /* The PL110 in Integrator/Versatile does the BGR routing externally */
240 if (priv->variant->external_bgr)
243 /* Power sequence: first enable and chill */
244 writel(cntl, priv->regs + priv->ctrl);
247 * We expect this delay to stabilize the contrast
248 * voltage Vee as stipulated by the manual
252 if (priv->variant_display_enable)
253 priv->variant_display_enable(drm, fb->format->format);
257 writel(cntl, priv->regs + priv->ctrl);
259 if (!priv->variant->broken_vblank)
260 drm_crtc_vblank_on(crtc);
263 void pl111_display_disable(struct drm_simple_display_pipe *pipe)
265 struct drm_crtc *crtc = &pipe->crtc;
266 struct drm_device *drm = crtc->dev;
267 struct pl111_drm_dev_private *priv = drm->dev_private;
270 if (!priv->variant->broken_vblank)
271 drm_crtc_vblank_off(crtc);
274 cntl = readl(priv->regs + priv->ctrl);
275 if (cntl & CNTL_LCDPWR) {
276 cntl &= ~CNTL_LCDPWR;
277 writel(cntl, priv->regs + priv->ctrl);
281 * We expect this delay to stabilize the contrast voltage Vee as
282 * stipulated by the manual
286 if (priv->variant_display_disable)
287 priv->variant_display_disable(drm);
290 writel(0, priv->regs + priv->ctrl);
292 clk_disable_unprepare(priv->clk);
295 static void pl111_display_update(struct drm_simple_display_pipe *pipe,
296 struct drm_plane_state *old_pstate)
298 struct drm_crtc *crtc = &pipe->crtc;
299 struct drm_device *drm = crtc->dev;
300 struct pl111_drm_dev_private *priv = drm->dev_private;
301 struct drm_pending_vblank_event *event = crtc->state->event;
302 struct drm_plane *plane = &pipe->plane;
303 struct drm_plane_state *pstate = plane->state;
304 struct drm_framebuffer *fb = pstate->fb;
307 u32 addr = drm_fb_cma_get_gem_addr(fb, pstate, 0);
309 writel(addr, priv->regs + CLCD_UBAS);
313 crtc->state->event = NULL;
315 spin_lock_irq(&crtc->dev->event_lock);
316 if (crtc->state->active && drm_crtc_vblank_get(crtc) == 0)
317 drm_crtc_arm_vblank_event(crtc, event);
319 drm_crtc_send_vblank_event(crtc, event);
320 spin_unlock_irq(&crtc->dev->event_lock);
324 static int pl111_display_enable_vblank(struct drm_simple_display_pipe *pipe)
326 struct drm_crtc *crtc = &pipe->crtc;
327 struct drm_device *drm = crtc->dev;
328 struct pl111_drm_dev_private *priv = drm->dev_private;
330 writel(CLCD_IRQ_NEXTBASE_UPDATE, priv->regs + priv->ienb);
335 static void pl111_display_disable_vblank(struct drm_simple_display_pipe *pipe)
337 struct drm_crtc *crtc = &pipe->crtc;
338 struct drm_device *drm = crtc->dev;
339 struct pl111_drm_dev_private *priv = drm->dev_private;
341 writel(0, priv->regs + priv->ienb);
344 static int pl111_display_prepare_fb(struct drm_simple_display_pipe *pipe,
345 struct drm_plane_state *plane_state)
347 return drm_gem_fb_prepare_fb(&pipe->plane, plane_state);
350 static struct drm_simple_display_pipe_funcs pl111_display_funcs = {
351 .check = pl111_display_check,
352 .enable = pl111_display_enable,
353 .disable = pl111_display_disable,
354 .update = pl111_display_update,
355 .prepare_fb = pl111_display_prepare_fb,
358 static int pl111_clk_div_choose_div(struct clk_hw *hw, unsigned long rate,
359 unsigned long *prate, bool set_parent)
361 int best_div = 1, div;
362 struct clk_hw *parent = clk_hw_get_parent(hw);
363 unsigned long best_prate = 0;
364 unsigned long best_diff = ~0ul;
365 int max_div = (1 << (TIM2_PCD_LO_BITS + TIM2_PCD_HI_BITS)) - 1;
367 for (div = 1; div < max_div; div++) {
368 unsigned long this_prate, div_rate, diff;
371 this_prate = clk_hw_round_rate(parent, rate * div);
374 div_rate = DIV_ROUND_UP_ULL(this_prate, div);
375 diff = abs(rate - div_rate);
377 if (diff < best_diff) {
380 best_prate = this_prate;
388 static long pl111_clk_div_round_rate(struct clk_hw *hw, unsigned long rate,
389 unsigned long *prate)
391 int div = pl111_clk_div_choose_div(hw, rate, prate, true);
393 return DIV_ROUND_UP_ULL(*prate, div);
396 static unsigned long pl111_clk_div_recalc_rate(struct clk_hw *hw,
399 struct pl111_drm_dev_private *priv =
400 container_of(hw, struct pl111_drm_dev_private, clk_div);
401 u32 tim2 = readl(priv->regs + CLCD_TIM2);
407 div = tim2 & TIM2_PCD_LO_MASK;
408 div |= (tim2 & TIM2_PCD_HI_MASK) >>
409 (TIM2_PCD_HI_SHIFT - TIM2_PCD_LO_BITS);
412 return DIV_ROUND_UP_ULL(prate, div);
415 static int pl111_clk_div_set_rate(struct clk_hw *hw, unsigned long rate,
418 struct pl111_drm_dev_private *priv =
419 container_of(hw, struct pl111_drm_dev_private, clk_div);
420 int div = pl111_clk_div_choose_div(hw, rate, &prate, false);
423 spin_lock(&priv->tim2_lock);
424 tim2 = readl(priv->regs + CLCD_TIM2);
425 tim2 &= ~(TIM2_BCD | TIM2_PCD_LO_MASK | TIM2_PCD_HI_MASK);
431 tim2 |= div & TIM2_PCD_LO_MASK;
432 tim2 |= (div >> TIM2_PCD_LO_BITS) << TIM2_PCD_HI_SHIFT;
435 writel(tim2, priv->regs + CLCD_TIM2);
436 spin_unlock(&priv->tim2_lock);
441 static const struct clk_ops pl111_clk_div_ops = {
442 .recalc_rate = pl111_clk_div_recalc_rate,
443 .round_rate = pl111_clk_div_round_rate,
444 .set_rate = pl111_clk_div_set_rate,
448 pl111_init_clock_divider(struct drm_device *drm)
450 struct pl111_drm_dev_private *priv = drm->dev_private;
451 struct clk *parent = devm_clk_get(drm->dev, "clcdclk");
452 struct clk_hw *div = &priv->clk_div;
453 const char *parent_name;
454 struct clk_init_data init = {
456 .ops = &pl111_clk_div_ops,
457 .parent_names = &parent_name,
459 .flags = CLK_SET_RATE_PARENT,
463 if (IS_ERR(parent)) {
464 dev_err(drm->dev, "CLCD: unable to get clcdclk.\n");
465 return PTR_ERR(parent);
467 /* If the clock divider is broken, use the parent directly */
468 if (priv->variant->broken_clockdivider) {
472 parent_name = __clk_get_name(parent);
474 spin_lock_init(&priv->tim2_lock);
477 ret = devm_clk_hw_register(drm->dev, div);
479 priv->clk = div->clk;
483 int pl111_display_init(struct drm_device *drm)
485 struct pl111_drm_dev_private *priv = drm->dev_private;
486 struct device *dev = drm->dev;
487 struct device_node *endpoint;
491 endpoint = of_graph_get_next_endpoint(dev->of_node, NULL);
495 if (of_property_read_u32_array(endpoint,
496 "arm,pl11x,tft-r0g0b0-pads",
498 ARRAY_SIZE(tft_r0b0g0)) != 0) {
499 dev_err(dev, "arm,pl11x,tft-r0g0b0-pads should be 3 ints\n");
500 of_node_put(endpoint);
503 of_node_put(endpoint);
505 ret = pl111_init_clock_divider(drm);
509 if (!priv->variant->broken_vblank) {
510 pl111_display_funcs.enable_vblank = pl111_display_enable_vblank;
511 pl111_display_funcs.disable_vblank = pl111_display_disable_vblank;
514 ret = drm_simple_display_pipe_init(drm, &priv->pipe,
515 &pl111_display_funcs,
516 priv->variant->formats,
517 priv->variant->nformats,