1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (c) 2015 MediaTek Inc.
6 #include <drm/drm_fourcc.h>
9 #include <linux/component.h>
10 #include <linux/module.h>
11 #include <linux/of_device.h>
12 #include <linux/of_irq.h>
13 #include <linux/platform_device.h>
14 #include <linux/pm_runtime.h>
15 #include <linux/soc/mediatek/mtk-cmdq.h>
17 #include "mtk_disp_drv.h"
18 #include "mtk_drm_crtc.h"
19 #include "mtk_drm_ddp_comp.h"
21 #define DISP_REG_OVL_INTEN 0x0004
22 #define OVL_FME_CPL_INT BIT(1)
23 #define DISP_REG_OVL_INTSTA 0x0008
24 #define DISP_REG_OVL_EN 0x000c
25 #define DISP_REG_OVL_RST 0x0014
26 #define DISP_REG_OVL_ROI_SIZE 0x0020
27 #define DISP_REG_OVL_DATAPATH_CON 0x0024
28 #define OVL_LAYER_SMI_ID_EN BIT(0)
29 #define OVL_BGCLR_SEL_IN BIT(2)
30 #define DISP_REG_OVL_ROI_BGCLR 0x0028
31 #define DISP_REG_OVL_SRC_CON 0x002c
32 #define DISP_REG_OVL_CON(n) (0x0030 + 0x20 * (n))
33 #define DISP_REG_OVL_SRC_SIZE(n) (0x0038 + 0x20 * (n))
34 #define DISP_REG_OVL_OFFSET(n) (0x003c + 0x20 * (n))
35 #define DISP_REG_OVL_PITCH(n) (0x0044 + 0x20 * (n))
36 #define DISP_REG_OVL_RDMA_CTRL(n) (0x00c0 + 0x20 * (n))
37 #define DISP_REG_OVL_RDMA_GMC(n) (0x00c8 + 0x20 * (n))
38 #define DISP_REG_OVL_ADDR_MT2701 0x0040
39 #define DISP_REG_OVL_ADDR_MT8173 0x0f40
40 #define DISP_REG_OVL_ADDR(ovl, n) ((ovl)->data->addr + 0x20 * (n))
42 #define GMC_THRESHOLD_BITS 16
43 #define GMC_THRESHOLD_HIGH ((1 << GMC_THRESHOLD_BITS) / 4)
44 #define GMC_THRESHOLD_LOW ((1 << GMC_THRESHOLD_BITS) / 8)
46 #define OVL_CON_BYTE_SWAP BIT(24)
47 #define OVL_CON_MTX_YUV_TO_RGB (6 << 16)
48 #define OVL_CON_CLRFMT_RGB (1 << 12)
49 #define OVL_CON_CLRFMT_RGBA8888 (2 << 12)
50 #define OVL_CON_CLRFMT_ARGB8888 (3 << 12)
51 #define OVL_CON_CLRFMT_UYVY (4 << 12)
52 #define OVL_CON_CLRFMT_YUYV (5 << 12)
53 #define OVL_CON_CLRFMT_RGB565(ovl) ((ovl)->data->fmt_rgb565_is_0 ? \
54 0 : OVL_CON_CLRFMT_RGB)
55 #define OVL_CON_CLRFMT_RGB888(ovl) ((ovl)->data->fmt_rgb565_is_0 ? \
56 OVL_CON_CLRFMT_RGB : 0)
57 #define OVL_CON_AEN BIT(8)
58 #define OVL_CON_ALPHA 0xff
59 #define OVL_CON_VIRT_FLIP BIT(9)
60 #define OVL_CON_HORZ_FLIP BIT(10)
62 struct mtk_disp_ovl_data {
64 unsigned int gmc_bits;
65 unsigned int layer_nr;
71 * struct mtk_disp_ovl - DISP_OVL driver structure
72 * @crtc: associated crtc to report vblank events to
73 * @data: platform data
76 struct drm_crtc *crtc;
79 struct cmdq_client_reg cmdq_reg;
80 const struct mtk_disp_ovl_data *data;
81 void (*vblank_cb)(void *data);
85 static irqreturn_t mtk_disp_ovl_irq_handler(int irq, void *dev_id)
87 struct mtk_disp_ovl *priv = dev_id;
89 /* Clear frame completion interrupt */
90 writel(0x0, priv->regs + DISP_REG_OVL_INTSTA);
95 priv->vblank_cb(priv->vblank_cb_data);
100 void mtk_ovl_register_vblank_cb(struct device *dev,
101 void (*vblank_cb)(void *),
102 void *vblank_cb_data)
104 struct mtk_disp_ovl *ovl = dev_get_drvdata(dev);
106 ovl->vblank_cb = vblank_cb;
107 ovl->vblank_cb_data = vblank_cb_data;
110 void mtk_ovl_unregister_vblank_cb(struct device *dev)
112 struct mtk_disp_ovl *ovl = dev_get_drvdata(dev);
114 ovl->vblank_cb = NULL;
115 ovl->vblank_cb_data = NULL;
118 void mtk_ovl_enable_vblank(struct device *dev)
120 struct mtk_disp_ovl *ovl = dev_get_drvdata(dev);
122 writel(0x0, ovl->regs + DISP_REG_OVL_INTSTA);
123 writel_relaxed(OVL_FME_CPL_INT, ovl->regs + DISP_REG_OVL_INTEN);
126 void mtk_ovl_disable_vblank(struct device *dev)
128 struct mtk_disp_ovl *ovl = dev_get_drvdata(dev);
130 writel_relaxed(0x0, ovl->regs + DISP_REG_OVL_INTEN);
133 int mtk_ovl_clk_enable(struct device *dev)
135 struct mtk_disp_ovl *ovl = dev_get_drvdata(dev);
137 return clk_prepare_enable(ovl->clk);
140 void mtk_ovl_clk_disable(struct device *dev)
142 struct mtk_disp_ovl *ovl = dev_get_drvdata(dev);
144 clk_disable_unprepare(ovl->clk);
147 void mtk_ovl_start(struct device *dev)
149 struct mtk_disp_ovl *ovl = dev_get_drvdata(dev);
151 if (ovl->data->smi_id_en) {
154 reg = readl(ovl->regs + DISP_REG_OVL_DATAPATH_CON);
155 reg = reg | OVL_LAYER_SMI_ID_EN;
156 writel_relaxed(reg, ovl->regs + DISP_REG_OVL_DATAPATH_CON);
158 writel_relaxed(0x1, ovl->regs + DISP_REG_OVL_EN);
161 void mtk_ovl_stop(struct device *dev)
163 struct mtk_disp_ovl *ovl = dev_get_drvdata(dev);
165 writel_relaxed(0x0, ovl->regs + DISP_REG_OVL_EN);
166 if (ovl->data->smi_id_en) {
169 reg = readl(ovl->regs + DISP_REG_OVL_DATAPATH_CON);
170 reg = reg & ~OVL_LAYER_SMI_ID_EN;
171 writel_relaxed(reg, ovl->regs + DISP_REG_OVL_DATAPATH_CON);
176 void mtk_ovl_config(struct device *dev, unsigned int w,
177 unsigned int h, unsigned int vrefresh,
178 unsigned int bpc, struct cmdq_pkt *cmdq_pkt)
180 struct mtk_disp_ovl *ovl = dev_get_drvdata(dev);
182 if (w != 0 && h != 0)
183 mtk_ddp_write_relaxed(cmdq_pkt, h << 16 | w, &ovl->cmdq_reg, ovl->regs,
184 DISP_REG_OVL_ROI_SIZE);
185 mtk_ddp_write_relaxed(cmdq_pkt, 0x0, &ovl->cmdq_reg, ovl->regs, DISP_REG_OVL_ROI_BGCLR);
187 mtk_ddp_write(cmdq_pkt, 0x1, &ovl->cmdq_reg, ovl->regs, DISP_REG_OVL_RST);
188 mtk_ddp_write(cmdq_pkt, 0x0, &ovl->cmdq_reg, ovl->regs, DISP_REG_OVL_RST);
191 unsigned int mtk_ovl_layer_nr(struct device *dev)
193 struct mtk_disp_ovl *ovl = dev_get_drvdata(dev);
195 return ovl->data->layer_nr;
198 unsigned int mtk_ovl_supported_rotations(struct device *dev)
200 return DRM_MODE_ROTATE_0 | DRM_MODE_ROTATE_180 |
201 DRM_MODE_REFLECT_X | DRM_MODE_REFLECT_Y;
204 int mtk_ovl_layer_check(struct device *dev, unsigned int idx,
205 struct mtk_plane_state *mtk_state)
207 struct drm_plane_state *state = &mtk_state->base;
208 unsigned int rotation = 0;
210 rotation = drm_rotation_simplify(state->rotation,
214 rotation &= ~DRM_MODE_ROTATE_0;
216 /* We can only do reflection, not rotation */
217 if ((rotation & DRM_MODE_ROTATE_MASK) != 0)
221 * TODO: Rotating/reflecting YUV buffers is not supported at this time.
222 * Only RGB[AX] variants are supported.
224 if (state->fb->format->is_yuv && rotation != 0)
227 state->rotation = rotation;
232 void mtk_ovl_layer_on(struct device *dev, unsigned int idx,
233 struct cmdq_pkt *cmdq_pkt)
235 unsigned int gmc_thrshd_l;
236 unsigned int gmc_thrshd_h;
237 unsigned int gmc_value;
238 struct mtk_disp_ovl *ovl = dev_get_drvdata(dev);
240 mtk_ddp_write(cmdq_pkt, 0x1, &ovl->cmdq_reg, ovl->regs,
241 DISP_REG_OVL_RDMA_CTRL(idx));
242 gmc_thrshd_l = GMC_THRESHOLD_LOW >>
243 (GMC_THRESHOLD_BITS - ovl->data->gmc_bits);
244 gmc_thrshd_h = GMC_THRESHOLD_HIGH >>
245 (GMC_THRESHOLD_BITS - ovl->data->gmc_bits);
246 if (ovl->data->gmc_bits == 10)
247 gmc_value = gmc_thrshd_h | gmc_thrshd_h << 16;
249 gmc_value = gmc_thrshd_l | gmc_thrshd_l << 8 |
250 gmc_thrshd_h << 16 | gmc_thrshd_h << 24;
251 mtk_ddp_write(cmdq_pkt, gmc_value,
252 &ovl->cmdq_reg, ovl->regs, DISP_REG_OVL_RDMA_GMC(idx));
253 mtk_ddp_write_mask(cmdq_pkt, BIT(idx), &ovl->cmdq_reg, ovl->regs,
254 DISP_REG_OVL_SRC_CON, BIT(idx));
257 void mtk_ovl_layer_off(struct device *dev, unsigned int idx,
258 struct cmdq_pkt *cmdq_pkt)
260 struct mtk_disp_ovl *ovl = dev_get_drvdata(dev);
262 mtk_ddp_write_mask(cmdq_pkt, 0, &ovl->cmdq_reg, ovl->regs,
263 DISP_REG_OVL_SRC_CON, BIT(idx));
264 mtk_ddp_write(cmdq_pkt, 0, &ovl->cmdq_reg, ovl->regs,
265 DISP_REG_OVL_RDMA_CTRL(idx));
268 static unsigned int ovl_fmt_convert(struct mtk_disp_ovl *ovl, unsigned int fmt)
270 /* The return value in switch "MEM_MODE_INPUT_FORMAT_XXX"
271 * is defined in mediatek HW data sheet.
272 * The alphabet order in XXX is no relation to data
273 * arrangement in memory.
277 case DRM_FORMAT_RGB565:
278 return OVL_CON_CLRFMT_RGB565(ovl);
279 case DRM_FORMAT_BGR565:
280 return OVL_CON_CLRFMT_RGB565(ovl) | OVL_CON_BYTE_SWAP;
281 case DRM_FORMAT_RGB888:
282 return OVL_CON_CLRFMT_RGB888(ovl);
283 case DRM_FORMAT_BGR888:
284 return OVL_CON_CLRFMT_RGB888(ovl) | OVL_CON_BYTE_SWAP;
285 case DRM_FORMAT_RGBX8888:
286 case DRM_FORMAT_RGBA8888:
287 return OVL_CON_CLRFMT_ARGB8888;
288 case DRM_FORMAT_BGRX8888:
289 case DRM_FORMAT_BGRA8888:
290 return OVL_CON_CLRFMT_ARGB8888 | OVL_CON_BYTE_SWAP;
291 case DRM_FORMAT_XRGB8888:
292 case DRM_FORMAT_ARGB8888:
293 return OVL_CON_CLRFMT_RGBA8888;
294 case DRM_FORMAT_XBGR8888:
295 case DRM_FORMAT_ABGR8888:
296 return OVL_CON_CLRFMT_RGBA8888 | OVL_CON_BYTE_SWAP;
297 case DRM_FORMAT_UYVY:
298 return OVL_CON_CLRFMT_UYVY | OVL_CON_MTX_YUV_TO_RGB;
299 case DRM_FORMAT_YUYV:
300 return OVL_CON_CLRFMT_YUYV | OVL_CON_MTX_YUV_TO_RGB;
304 void mtk_ovl_layer_config(struct device *dev, unsigned int idx,
305 struct mtk_plane_state *state,
306 struct cmdq_pkt *cmdq_pkt)
308 struct mtk_disp_ovl *ovl = dev_get_drvdata(dev);
309 struct mtk_plane_pending_state *pending = &state->pending;
310 unsigned int addr = pending->addr;
311 unsigned int pitch = pending->pitch & 0xffff;
312 unsigned int fmt = pending->format;
313 unsigned int offset = (pending->y << 16) | pending->x;
314 unsigned int src_size = (pending->height << 16) | pending->width;
317 if (!pending->enable) {
318 mtk_ovl_layer_off(dev, idx, cmdq_pkt);
322 con = ovl_fmt_convert(ovl, fmt);
323 if (state->base.fb && state->base.fb->format->has_alpha)
324 con |= OVL_CON_AEN | OVL_CON_ALPHA;
326 if (pending->rotation & DRM_MODE_REFLECT_Y) {
327 con |= OVL_CON_VIRT_FLIP;
328 addr += (pending->height - 1) * pending->pitch;
331 if (pending->rotation & DRM_MODE_REFLECT_X) {
332 con |= OVL_CON_HORZ_FLIP;
333 addr += pending->pitch - 1;
336 mtk_ddp_write_relaxed(cmdq_pkt, con, &ovl->cmdq_reg, ovl->regs,
337 DISP_REG_OVL_CON(idx));
338 mtk_ddp_write_relaxed(cmdq_pkt, pitch, &ovl->cmdq_reg, ovl->regs,
339 DISP_REG_OVL_PITCH(idx));
340 mtk_ddp_write_relaxed(cmdq_pkt, src_size, &ovl->cmdq_reg, ovl->regs,
341 DISP_REG_OVL_SRC_SIZE(idx));
342 mtk_ddp_write_relaxed(cmdq_pkt, offset, &ovl->cmdq_reg, ovl->regs,
343 DISP_REG_OVL_OFFSET(idx));
344 mtk_ddp_write_relaxed(cmdq_pkt, addr, &ovl->cmdq_reg, ovl->regs,
345 DISP_REG_OVL_ADDR(ovl, idx));
347 mtk_ovl_layer_on(dev, idx, cmdq_pkt);
350 void mtk_ovl_bgclr_in_on(struct device *dev)
352 struct mtk_disp_ovl *ovl = dev_get_drvdata(dev);
355 reg = readl(ovl->regs + DISP_REG_OVL_DATAPATH_CON);
356 reg = reg | OVL_BGCLR_SEL_IN;
357 writel(reg, ovl->regs + DISP_REG_OVL_DATAPATH_CON);
360 void mtk_ovl_bgclr_in_off(struct device *dev)
362 struct mtk_disp_ovl *ovl = dev_get_drvdata(dev);
365 reg = readl(ovl->regs + DISP_REG_OVL_DATAPATH_CON);
366 reg = reg & ~OVL_BGCLR_SEL_IN;
367 writel(reg, ovl->regs + DISP_REG_OVL_DATAPATH_CON);
370 static int mtk_disp_ovl_bind(struct device *dev, struct device *master,
376 static void mtk_disp_ovl_unbind(struct device *dev, struct device *master,
381 static const struct component_ops mtk_disp_ovl_component_ops = {
382 .bind = mtk_disp_ovl_bind,
383 .unbind = mtk_disp_ovl_unbind,
386 static int mtk_disp_ovl_probe(struct platform_device *pdev)
388 struct device *dev = &pdev->dev;
389 struct mtk_disp_ovl *priv;
390 struct resource *res;
394 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
398 irq = platform_get_irq(pdev, 0);
402 priv->clk = devm_clk_get(dev, NULL);
403 if (IS_ERR(priv->clk)) {
404 dev_err(dev, "failed to get ovl clk\n");
405 return PTR_ERR(priv->clk);
408 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
409 priv->regs = devm_ioremap_resource(dev, res);
410 if (IS_ERR(priv->regs)) {
411 dev_err(dev, "failed to ioremap ovl\n");
412 return PTR_ERR(priv->regs);
414 #if IS_REACHABLE(CONFIG_MTK_CMDQ)
415 ret = cmdq_dev_get_client_reg(dev, &priv->cmdq_reg, 0);
417 dev_dbg(dev, "get mediatek,gce-client-reg fail!\n");
420 priv->data = of_device_get_match_data(dev);
421 platform_set_drvdata(pdev, priv);
423 ret = devm_request_irq(dev, irq, mtk_disp_ovl_irq_handler,
424 IRQF_TRIGGER_NONE, dev_name(dev), priv);
426 dev_err(dev, "Failed to request irq %d: %d\n", irq, ret);
430 pm_runtime_enable(dev);
432 ret = component_add(dev, &mtk_disp_ovl_component_ops);
434 pm_runtime_disable(dev);
435 dev_err(dev, "Failed to add component: %d\n", ret);
441 static int mtk_disp_ovl_remove(struct platform_device *pdev)
443 component_del(&pdev->dev, &mtk_disp_ovl_component_ops);
444 pm_runtime_disable(&pdev->dev);
449 static const struct mtk_disp_ovl_data mt2701_ovl_driver_data = {
450 .addr = DISP_REG_OVL_ADDR_MT2701,
453 .fmt_rgb565_is_0 = false,
456 static const struct mtk_disp_ovl_data mt8173_ovl_driver_data = {
457 .addr = DISP_REG_OVL_ADDR_MT8173,
460 .fmt_rgb565_is_0 = true,
463 static const struct mtk_disp_ovl_data mt8183_ovl_driver_data = {
464 .addr = DISP_REG_OVL_ADDR_MT8173,
467 .fmt_rgb565_is_0 = true,
470 static const struct mtk_disp_ovl_data mt8183_ovl_2l_driver_data = {
471 .addr = DISP_REG_OVL_ADDR_MT8173,
474 .fmt_rgb565_is_0 = true,
477 static const struct mtk_disp_ovl_data mt8192_ovl_driver_data = {
478 .addr = DISP_REG_OVL_ADDR_MT8173,
481 .fmt_rgb565_is_0 = true,
485 static const struct mtk_disp_ovl_data mt8192_ovl_2l_driver_data = {
486 .addr = DISP_REG_OVL_ADDR_MT8173,
489 .fmt_rgb565_is_0 = true,
493 static const struct of_device_id mtk_disp_ovl_driver_dt_match[] = {
494 { .compatible = "mediatek,mt2701-disp-ovl",
495 .data = &mt2701_ovl_driver_data},
496 { .compatible = "mediatek,mt8173-disp-ovl",
497 .data = &mt8173_ovl_driver_data},
498 { .compatible = "mediatek,mt8183-disp-ovl",
499 .data = &mt8183_ovl_driver_data},
500 { .compatible = "mediatek,mt8183-disp-ovl-2l",
501 .data = &mt8183_ovl_2l_driver_data},
502 { .compatible = "mediatek,mt8192-disp-ovl",
503 .data = &mt8192_ovl_driver_data},
504 { .compatible = "mediatek,mt8192-disp-ovl-2l",
505 .data = &mt8192_ovl_2l_driver_data},
508 MODULE_DEVICE_TABLE(of, mtk_disp_ovl_driver_dt_match);
510 struct platform_driver mtk_disp_ovl_driver = {
511 .probe = mtk_disp_ovl_probe,
512 .remove = mtk_disp_ovl_remove,
514 .name = "mediatek-disp-ovl",
515 .owner = THIS_MODULE,
516 .of_match_table = mtk_disp_ovl_driver_dt_match,