1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Copyright (C) 2016 BayLibre, SAS
5 * Copyright (C) 2015 Amlogic, Inc. All rights reserved.
6 * Copyright (C) 2014 Endless Mobile
12 #include <linux/bitfield.h>
14 #include <drm/drm_atomic.h>
15 #include <drm/drm_atomic_helper.h>
16 #include <drm/drm_blend.h>
17 #include <drm/drm_device.h>
18 #include <drm/drm_fb_cma_helper.h>
19 #include <drm/drm_fourcc.h>
20 #include <drm/drm_framebuffer.h>
21 #include <drm/drm_gem_atomic_helper.h>
22 #include <drm/drm_gem_cma_helper.h>
23 #include <drm/drm_plane_helper.h>
25 #include "meson_plane.h"
26 #include "meson_registers.h"
27 #include "meson_viu.h"
28 #include "meson_osd_afbcd.h"
31 #define SCI_WH_M1_W(w) FIELD_PREP(GENMASK(28, 16), w)
32 #define SCI_WH_M1_H(h) FIELD_PREP(GENMASK(12, 0), h)
34 /* OSD_SCO_H_START_END */
35 /* OSD_SCO_V_START_END */
36 #define SCO_HV_START(start) FIELD_PREP(GENMASK(27, 16), start)
37 #define SCO_HV_END(end) FIELD_PREP(GENMASK(11, 0), end)
40 #define SC_CTRL0_PATH_EN BIT(3)
41 #define SC_CTRL0_SEL_OSD1 BIT(2)
44 #define VSC_BANK_LEN(value) FIELD_PREP(GENMASK(2, 0), value)
45 #define VSC_TOP_INI_RCV_NUM(value) FIELD_PREP(GENMASK(6, 3), value)
46 #define VSC_TOP_RPT_L0_NUM(value) FIELD_PREP(GENMASK(9, 8), value)
47 #define VSC_BOT_INI_RCV_NUM(value) FIELD_PREP(GENMASK(14, 11), value)
48 #define VSC_BOT_RPT_L0_NUM(value) FIELD_PREP(GENMASK(17, 16), value)
49 #define VSC_PROG_INTERLACE BIT(23)
50 #define VSC_VERTICAL_SCALER_EN BIT(24)
52 /* OSD_VSC_INI_PHASE */
53 #define VSC_INI_PHASE_BOT(bottom) FIELD_PREP(GENMASK(31, 16), bottom)
54 #define VSC_INI_PHASE_TOP(top) FIELD_PREP(GENMASK(15, 0), top)
57 #define HSC_BANK_LENGTH(value) FIELD_PREP(GENMASK(2, 0), value)
58 #define HSC_INI_RCV_NUM0(value) FIELD_PREP(GENMASK(6, 3), value)
59 #define HSC_RPT_P0_NUM0(value) FIELD_PREP(GENMASK(9, 8), value)
60 #define HSC_HORIZ_SCALER_EN BIT(22)
62 /* VPP_OSD_VSC_PHASE_STEP */
63 /* VPP_OSD_HSC_PHASE_STEP */
64 #define SC_PHASE_STEP(value) FIELD_PREP(GENMASK(27, 0), value)
67 struct drm_plane base;
68 struct meson_drm *priv;
71 #define to_meson_plane(x) container_of(x, struct meson_plane, base)
73 #define FRAC_16_16(mult, div) (((mult) << 16) / (div))
75 static int meson_plane_atomic_check(struct drm_plane *plane,
76 struct drm_atomic_state *state)
78 struct drm_plane_state *new_plane_state = drm_atomic_get_new_plane_state(state,
80 struct drm_crtc_state *crtc_state;
82 if (!new_plane_state->crtc)
85 crtc_state = drm_atomic_get_crtc_state(state,
86 new_plane_state->crtc);
87 if (IS_ERR(crtc_state))
88 return PTR_ERR(crtc_state);
92 * - Upscaling up to 5x, vertical and horizontal
93 * - Final coordinates must match crtc size
95 return drm_atomic_helper_check_plane_state(new_plane_state,
98 DRM_PLANE_HELPER_NO_SCALING,
102 #define MESON_MOD_AFBC_VALID_BITS (AFBC_FORMAT_MOD_BLOCK_SIZE_16x16 | \
103 AFBC_FORMAT_MOD_BLOCK_SIZE_32x8 | \
104 AFBC_FORMAT_MOD_YTR | \
105 AFBC_FORMAT_MOD_SPARSE | \
106 AFBC_FORMAT_MOD_SPLIT)
108 /* Takes a fixed 16.16 number and converts it to integer. */
109 static inline int64_t fixed16_to_int(int64_t value)
114 static u32 meson_g12a_afbcd_line_stride(struct meson_drm *priv)
118 switch (priv->afbcd.format) {
119 case DRM_FORMAT_RGB565:
120 line_stride = ((priv->viu.osd1_width << 4) + 127) >> 7;
122 case DRM_FORMAT_RGB888:
123 case DRM_FORMAT_XRGB8888:
124 case DRM_FORMAT_ARGB8888:
125 case DRM_FORMAT_XBGR8888:
126 case DRM_FORMAT_ABGR8888:
127 line_stride = ((priv->viu.osd1_width << 5) + 127) >> 7;
131 return ((line_stride + 1) >> 1) << 1;
134 static void meson_plane_atomic_update(struct drm_plane *plane,
135 struct drm_atomic_state *state)
137 struct meson_plane *meson_plane = to_meson_plane(plane);
138 struct drm_plane_state *new_state = drm_atomic_get_new_plane_state(state,
140 struct drm_rect dest = drm_plane_state_dest(new_state);
141 struct meson_drm *priv = meson_plane->priv;
142 struct drm_framebuffer *fb = new_state->fb;
143 struct drm_gem_cma_object *gem;
145 int vsc_ini_rcv_num, vsc_ini_rpt_p0_num;
146 int vsc_bot_rcv_num, vsc_bot_rpt_p0_num;
147 int hsc_ini_rcv_num, hsc_ini_rpt_p0_num;
148 int hf_phase_step, vf_phase_step;
149 int src_w, src_h, dst_w, dst_h;
161 spin_lock_irqsave(&priv->drm->event_lock, flags);
163 /* Check if AFBC decoder is required for this buffer */
164 if ((meson_vpu_is_compatible(priv, VPU_COMPATIBLE_GXM) ||
165 meson_vpu_is_compatible(priv, VPU_COMPATIBLE_G12A)) &&
166 fb->modifier & DRM_FORMAT_MOD_ARM_AFBC(MESON_MOD_AFBC_VALID_BITS))
167 priv->viu.osd1_afbcd = true;
169 priv->viu.osd1_afbcd = false;
171 /* Enable OSD and BLK0, set max global alpha */
172 priv->viu.osd1_ctrl_stat = OSD_ENABLE |
173 (0xFF << OSD_GLOBAL_ALPHA_SHIFT) |
176 priv->viu.osd1_ctrl_stat2 = readl(priv->io_base +
177 _REG(VIU_OSD1_CTRL_STAT2));
179 canvas_id_osd1 = priv->canvas_id_osd1;
181 /* Set up BLK0 to point to the right canvas */
182 priv->viu.osd1_blk0_cfg[0] = canvas_id_osd1 << OSD_CANVAS_SEL;
184 if (priv->viu.osd1_afbcd) {
185 if (meson_vpu_is_compatible(priv, VPU_COMPATIBLE_G12A)) {
186 /* This is the internal decoding memory address */
187 priv->viu.osd1_blk1_cfg4 = MESON_G12A_AFBCD_OUT_ADDR;
188 priv->viu.osd1_blk0_cfg[0] |= OSD_ENDIANNESS_BE;
189 priv->viu.osd1_ctrl_stat2 |= OSD_PENDING_STAT_CLEAN;
190 priv->viu.osd1_ctrl_stat |= VIU_OSD1_CFG_SYN_EN;
193 if (meson_vpu_is_compatible(priv, VPU_COMPATIBLE_GXM)) {
194 priv->viu.osd1_blk0_cfg[0] |= OSD_ENDIANNESS_LE;
195 priv->viu.osd1_ctrl_stat2 |= OSD_DPATH_MALI_AFBCD;
198 priv->viu.osd1_blk0_cfg[0] |= OSD_ENDIANNESS_LE;
200 if (meson_vpu_is_compatible(priv, VPU_COMPATIBLE_GXM))
201 priv->viu.osd1_ctrl_stat2 &= ~OSD_DPATH_MALI_AFBCD;
204 /* On GXBB, Use the old non-HDR RGB2YUV converter */
205 if (meson_vpu_is_compatible(priv, VPU_COMPATIBLE_GXBB))
206 priv->viu.osd1_blk0_cfg[0] |= OSD_OUTPUT_COLOR_RGB;
208 if (priv->viu.osd1_afbcd &&
209 meson_vpu_is_compatible(priv, VPU_COMPATIBLE_G12A)) {
210 priv->viu.osd1_blk0_cfg[0] |= OSD_MALI_SRC_EN |
211 priv->afbcd.ops->fmt_to_blk_mode(fb->modifier,
214 switch (fb->format->format) {
215 case DRM_FORMAT_XRGB8888:
216 case DRM_FORMAT_ARGB8888:
217 priv->viu.osd1_blk0_cfg[0] |= OSD_BLK_MODE_32 |
218 OSD_COLOR_MATRIX_32_ARGB;
220 case DRM_FORMAT_XBGR8888:
221 case DRM_FORMAT_ABGR8888:
222 priv->viu.osd1_blk0_cfg[0] |= OSD_BLK_MODE_32 |
223 OSD_COLOR_MATRIX_32_ABGR;
225 case DRM_FORMAT_RGB888:
226 priv->viu.osd1_blk0_cfg[0] |= OSD_BLK_MODE_24 |
227 OSD_COLOR_MATRIX_24_RGB;
229 case DRM_FORMAT_RGB565:
230 priv->viu.osd1_blk0_cfg[0] |= OSD_BLK_MODE_16 |
231 OSD_COLOR_MATRIX_16_RGB565;
236 switch (fb->format->format) {
237 case DRM_FORMAT_XRGB8888:
238 case DRM_FORMAT_XBGR8888:
239 /* For XRGB, replace the pixel's alpha by 0xFF */
240 priv->viu.osd1_ctrl_stat2 |= OSD_REPLACE_EN;
242 case DRM_FORMAT_ARGB8888:
243 case DRM_FORMAT_ABGR8888:
244 /* For ARGB, use the pixel's alpha */
245 priv->viu.osd1_ctrl_stat2 &= ~OSD_REPLACE_EN;
249 /* Default scaler parameters */
251 vsc_bot_rpt_p0_num = 0;
255 if (new_state->crtc->mode.flags & DRM_MODE_FLAG_INTERLACE) {
257 vsc_bot_rpt_p0_num = 2;
260 hsc_ini_rcv_num = hf_bank_len;
261 vsc_ini_rcv_num = vf_bank_len;
262 hsc_ini_rpt_p0_num = (hf_bank_len / 2) - 1;
263 vsc_ini_rpt_p0_num = (vf_bank_len / 2) - 1;
265 src_w = fixed16_to_int(new_state->src_w);
266 src_h = fixed16_to_int(new_state->src_h);
267 dst_w = new_state->crtc_w;
268 dst_h = new_state->crtc_h;
271 * When the output is interlaced, the OSD must switch between
272 * each field using the INTERLACE_SEL_ODD (0) of VIU_OSD1_BLK0_CFG_W0
274 * But the vertical scaler can provide such funtionnality if
275 * is configured for 2:1 scaling with interlace options enabled.
277 if (new_state->crtc->mode.flags & DRM_MODE_FLAG_INTERLACE) {
283 hf_phase_step = ((src_w << 18) / dst_w) << 6;
284 vf_phase_step = (src_h << 20) / dst_h;
286 if (new_state->crtc->mode.flags & DRM_MODE_FLAG_INTERLACE)
287 bot_ini_phase = ((vf_phase_step / 2) >> 4);
291 vf_phase_step = (vf_phase_step << 4);
293 /* In interlaced mode, scaler is always active */
294 if (src_h != dst_h || src_w != dst_w) {
295 priv->viu.osd_sc_i_wh_m1 = SCI_WH_M1_W(src_w - 1) |
296 SCI_WH_M1_H(src_h - 1);
297 priv->viu.osd_sc_o_h_start_end = SCO_HV_START(dest.x1) |
298 SCO_HV_END(dest.x2 - 1);
299 priv->viu.osd_sc_o_v_start_end = SCO_HV_START(dest.y1) |
300 SCO_HV_END(dest.y2 - 1);
301 /* Enable OSD Scaler */
302 priv->viu.osd_sc_ctrl0 = SC_CTRL0_PATH_EN | SC_CTRL0_SEL_OSD1;
304 priv->viu.osd_sc_i_wh_m1 = 0;
305 priv->viu.osd_sc_o_h_start_end = 0;
306 priv->viu.osd_sc_o_v_start_end = 0;
307 priv->viu.osd_sc_ctrl0 = 0;
310 /* In interlaced mode, vertical scaler is always active */
311 if (src_h != dst_h) {
312 priv->viu.osd_sc_v_ctrl0 =
313 VSC_BANK_LEN(vf_bank_len) |
314 VSC_TOP_INI_RCV_NUM(vsc_ini_rcv_num) |
315 VSC_TOP_RPT_L0_NUM(vsc_ini_rpt_p0_num) |
316 VSC_VERTICAL_SCALER_EN;
318 if (new_state->crtc->mode.flags & DRM_MODE_FLAG_INTERLACE)
319 priv->viu.osd_sc_v_ctrl0 |=
320 VSC_BOT_INI_RCV_NUM(vsc_bot_rcv_num) |
321 VSC_BOT_RPT_L0_NUM(vsc_bot_rpt_p0_num) |
324 priv->viu.osd_sc_v_phase_step = SC_PHASE_STEP(vf_phase_step);
325 priv->viu.osd_sc_v_ini_phase = VSC_INI_PHASE_BOT(bot_ini_phase);
327 priv->viu.osd_sc_v_ctrl0 = 0;
328 priv->viu.osd_sc_v_phase_step = 0;
329 priv->viu.osd_sc_v_ini_phase = 0;
332 /* Horizontal scaler is only used if width does not match */
333 if (src_w != dst_w) {
334 priv->viu.osd_sc_h_ctrl0 =
335 HSC_BANK_LENGTH(hf_bank_len) |
336 HSC_INI_RCV_NUM0(hsc_ini_rcv_num) |
337 HSC_RPT_P0_NUM0(hsc_ini_rpt_p0_num) |
339 priv->viu.osd_sc_h_phase_step = SC_PHASE_STEP(hf_phase_step);
340 priv->viu.osd_sc_h_ini_phase = 0;
342 priv->viu.osd_sc_h_ctrl0 = 0;
343 priv->viu.osd_sc_h_phase_step = 0;
344 priv->viu.osd_sc_h_ini_phase = 0;
348 * The format of these registers is (x2 << 16 | x1),
349 * where x2 is exclusive.
350 * e.g. +30x1920 would be (1919 << 16) | 30
352 priv->viu.osd1_blk0_cfg[1] =
353 ((fixed16_to_int(new_state->src.x2) - 1) << 16) |
354 fixed16_to_int(new_state->src.x1);
355 priv->viu.osd1_blk0_cfg[2] =
356 ((fixed16_to_int(new_state->src.y2) - 1) << 16) |
357 fixed16_to_int(new_state->src.y1);
358 priv->viu.osd1_blk0_cfg[3] = ((dest.x2 - 1) << 16) | dest.x1;
359 priv->viu.osd1_blk0_cfg[4] = ((dest.y2 - 1) << 16) | dest.y1;
361 if (meson_vpu_is_compatible(priv, VPU_COMPATIBLE_G12A)) {
362 priv->viu.osd_blend_din0_scope_h = ((dest.x2 - 1) << 16) | dest.x1;
363 priv->viu.osd_blend_din0_scope_v = ((dest.y2 - 1) << 16) | dest.y1;
364 priv->viu.osb_blend0_size = dst_h << 16 | dst_w;
365 priv->viu.osb_blend1_size = dst_h << 16 | dst_w;
368 /* Update Canvas with buffer address */
369 gem = drm_fb_cma_get_gem_obj(fb, 0);
371 priv->viu.osd1_addr = gem->paddr;
372 priv->viu.osd1_stride = fb->pitches[0];
373 priv->viu.osd1_height = fb->height;
374 priv->viu.osd1_width = fb->width;
376 if (priv->viu.osd1_afbcd) {
377 priv->afbcd.modifier = fb->modifier;
378 priv->afbcd.format = fb->format->format;
380 /* Calculate decoder write stride */
381 if (meson_vpu_is_compatible(priv, VPU_COMPATIBLE_G12A))
382 priv->viu.osd1_blk2_cfg4 =
383 meson_g12a_afbcd_line_stride(priv);
386 if (!meson_plane->enabled) {
387 /* Reset OSD1 before enabling it on GXL+ SoCs */
388 if (meson_vpu_is_compatible(priv, VPU_COMPATIBLE_GXM) ||
389 meson_vpu_is_compatible(priv, VPU_COMPATIBLE_GXL))
390 meson_viu_osd1_reset(priv);
392 meson_plane->enabled = true;
395 priv->viu.osd1_enabled = true;
397 spin_unlock_irqrestore(&priv->drm->event_lock, flags);
400 static void meson_plane_atomic_disable(struct drm_plane *plane,
401 struct drm_atomic_state *state)
403 struct meson_plane *meson_plane = to_meson_plane(plane);
404 struct meson_drm *priv = meson_plane->priv;
406 if (priv->afbcd.ops) {
407 priv->afbcd.ops->reset(priv);
408 priv->afbcd.ops->disable(priv);
412 if (meson_vpu_is_compatible(priv, VPU_COMPATIBLE_G12A))
413 writel_bits_relaxed(VIU_OSD1_POSTBLD_SRC_OSD1, 0,
414 priv->io_base + _REG(OSD1_BLEND_SRC_CTRL));
416 writel_bits_relaxed(VPP_OSD1_POSTBLEND, 0,
417 priv->io_base + _REG(VPP_MISC));
419 meson_plane->enabled = false;
420 priv->viu.osd1_enabled = false;
423 static const struct drm_plane_helper_funcs meson_plane_helper_funcs = {
424 .atomic_check = meson_plane_atomic_check,
425 .atomic_disable = meson_plane_atomic_disable,
426 .atomic_update = meson_plane_atomic_update,
429 static bool meson_plane_format_mod_supported(struct drm_plane *plane,
430 u32 format, u64 modifier)
432 struct meson_plane *meson_plane = to_meson_plane(plane);
433 struct meson_drm *priv = meson_plane->priv;
436 if (modifier == DRM_FORMAT_MOD_INVALID)
439 if (modifier == DRM_FORMAT_MOD_LINEAR)
442 if (!meson_vpu_is_compatible(priv, VPU_COMPATIBLE_GXM) &&
443 !meson_vpu_is_compatible(priv, VPU_COMPATIBLE_G12A))
446 if (modifier & ~DRM_FORMAT_MOD_ARM_AFBC(MESON_MOD_AFBC_VALID_BITS))
449 for (i = 0 ; i < plane->modifier_count ; ++i)
450 if (plane->modifiers[i] == modifier)
453 if (i == plane->modifier_count) {
454 DRM_DEBUG_KMS("Unsupported modifier\n");
458 if (priv->afbcd.ops && priv->afbcd.ops->supported_fmt)
459 return priv->afbcd.ops->supported_fmt(modifier, format);
461 DRM_DEBUG_KMS("AFBC Unsupported\n");
465 static const struct drm_plane_funcs meson_plane_funcs = {
466 .update_plane = drm_atomic_helper_update_plane,
467 .disable_plane = drm_atomic_helper_disable_plane,
468 .destroy = drm_plane_cleanup,
469 .reset = drm_atomic_helper_plane_reset,
470 .atomic_duplicate_state = drm_atomic_helper_plane_duplicate_state,
471 .atomic_destroy_state = drm_atomic_helper_plane_destroy_state,
472 .format_mod_supported = meson_plane_format_mod_supported,
475 static const uint32_t supported_drm_formats[] = {
484 static const uint64_t format_modifiers_afbc_gxm[] = {
485 DRM_FORMAT_MOD_ARM_AFBC(AFBC_FORMAT_MOD_BLOCK_SIZE_16x16 |
486 AFBC_FORMAT_MOD_SPARSE |
487 AFBC_FORMAT_MOD_YTR),
488 /* SPLIT mandates SPARSE, RGB modes mandates YTR */
489 DRM_FORMAT_MOD_ARM_AFBC(AFBC_FORMAT_MOD_BLOCK_SIZE_16x16 |
490 AFBC_FORMAT_MOD_YTR |
491 AFBC_FORMAT_MOD_SPARSE |
492 AFBC_FORMAT_MOD_SPLIT),
493 DRM_FORMAT_MOD_LINEAR,
494 DRM_FORMAT_MOD_INVALID,
497 static const uint64_t format_modifiers_afbc_g12a[] = {
499 * - TOFIX Support AFBC modifiers for YUV formats (16x16 + TILED)
500 * - SPLIT is mandatory for performances reasons when in 16x16
502 * - 32x8 block size + SPLIT is mandatory with 4K frame size
503 * for performances reasons
505 DRM_FORMAT_MOD_ARM_AFBC(AFBC_FORMAT_MOD_BLOCK_SIZE_16x16 |
506 AFBC_FORMAT_MOD_SPARSE |
507 AFBC_FORMAT_MOD_SPLIT),
508 DRM_FORMAT_MOD_ARM_AFBC(AFBC_FORMAT_MOD_BLOCK_SIZE_16x16 |
509 AFBC_FORMAT_MOD_YTR |
510 AFBC_FORMAT_MOD_SPARSE |
511 AFBC_FORMAT_MOD_SPLIT),
512 DRM_FORMAT_MOD_ARM_AFBC(AFBC_FORMAT_MOD_BLOCK_SIZE_32x8 |
513 AFBC_FORMAT_MOD_SPARSE),
514 DRM_FORMAT_MOD_ARM_AFBC(AFBC_FORMAT_MOD_BLOCK_SIZE_32x8 |
515 AFBC_FORMAT_MOD_YTR |
516 AFBC_FORMAT_MOD_SPARSE),
517 DRM_FORMAT_MOD_ARM_AFBC(AFBC_FORMAT_MOD_BLOCK_SIZE_32x8 |
518 AFBC_FORMAT_MOD_SPARSE |
519 AFBC_FORMAT_MOD_SPLIT),
520 DRM_FORMAT_MOD_ARM_AFBC(AFBC_FORMAT_MOD_BLOCK_SIZE_32x8 |
521 AFBC_FORMAT_MOD_YTR |
522 AFBC_FORMAT_MOD_SPARSE |
523 AFBC_FORMAT_MOD_SPLIT),
524 DRM_FORMAT_MOD_LINEAR,
525 DRM_FORMAT_MOD_INVALID,
528 static const uint64_t format_modifiers_default[] = {
529 DRM_FORMAT_MOD_LINEAR,
530 DRM_FORMAT_MOD_INVALID,
533 int meson_plane_create(struct meson_drm *priv)
535 struct meson_plane *meson_plane;
536 struct drm_plane *plane;
537 const uint64_t *format_modifiers = format_modifiers_default;
539 meson_plane = devm_kzalloc(priv->drm->dev, sizeof(*meson_plane),
544 meson_plane->priv = priv;
545 plane = &meson_plane->base;
547 if (meson_vpu_is_compatible(priv, VPU_COMPATIBLE_GXM))
548 format_modifiers = format_modifiers_afbc_gxm;
549 else if (meson_vpu_is_compatible(priv, VPU_COMPATIBLE_G12A))
550 format_modifiers = format_modifiers_afbc_g12a;
552 drm_universal_plane_init(priv->drm, plane, 0xFF,
554 supported_drm_formats,
555 ARRAY_SIZE(supported_drm_formats),
557 DRM_PLANE_TYPE_PRIMARY, "meson_primary_plane");
559 drm_plane_helper_add(plane, &meson_plane_helper_funcs);
561 /* For now, OSD Primary plane is always on the front */
562 drm_plane_create_zpos_immutable_property(plane, 1);
564 priv->primary_plane = plane;