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_device.h>
17 #include <drm/drm_fb_cma_helper.h>
18 #include <drm/drm_fourcc.h>
19 #include <drm/drm_gem_atomic_helper.h>
20 #include <drm/drm_gem_cma_helper.h>
21 #include <drm/drm_plane_helper.h>
23 #include "meson_plane.h"
24 #include "meson_registers.h"
25 #include "meson_viu.h"
26 #include "meson_osd_afbcd.h"
29 #define SCI_WH_M1_W(w) FIELD_PREP(GENMASK(28, 16), w)
30 #define SCI_WH_M1_H(h) FIELD_PREP(GENMASK(12, 0), h)
32 /* OSD_SCO_H_START_END */
33 /* OSD_SCO_V_START_END */
34 #define SCO_HV_START(start) FIELD_PREP(GENMASK(27, 16), start)
35 #define SCO_HV_END(end) FIELD_PREP(GENMASK(11, 0), end)
38 #define SC_CTRL0_PATH_EN BIT(3)
39 #define SC_CTRL0_SEL_OSD1 BIT(2)
42 #define VSC_BANK_LEN(value) FIELD_PREP(GENMASK(2, 0), value)
43 #define VSC_TOP_INI_RCV_NUM(value) FIELD_PREP(GENMASK(6, 3), value)
44 #define VSC_TOP_RPT_L0_NUM(value) FIELD_PREP(GENMASK(9, 8), value)
45 #define VSC_BOT_INI_RCV_NUM(value) FIELD_PREP(GENMASK(14, 11), value)
46 #define VSC_BOT_RPT_L0_NUM(value) FIELD_PREP(GENMASK(17, 16), value)
47 #define VSC_PROG_INTERLACE BIT(23)
48 #define VSC_VERTICAL_SCALER_EN BIT(24)
50 /* OSD_VSC_INI_PHASE */
51 #define VSC_INI_PHASE_BOT(bottom) FIELD_PREP(GENMASK(31, 16), bottom)
52 #define VSC_INI_PHASE_TOP(top) FIELD_PREP(GENMASK(15, 0), top)
55 #define HSC_BANK_LENGTH(value) FIELD_PREP(GENMASK(2, 0), value)
56 #define HSC_INI_RCV_NUM0(value) FIELD_PREP(GENMASK(6, 3), value)
57 #define HSC_RPT_P0_NUM0(value) FIELD_PREP(GENMASK(9, 8), value)
58 #define HSC_HORIZ_SCALER_EN BIT(22)
60 /* VPP_OSD_VSC_PHASE_STEP */
61 /* VPP_OSD_HSC_PHASE_STEP */
62 #define SC_PHASE_STEP(value) FIELD_PREP(GENMASK(27, 0), value)
65 struct drm_plane base;
66 struct meson_drm *priv;
69 #define to_meson_plane(x) container_of(x, struct meson_plane, base)
71 #define FRAC_16_16(mult, div) (((mult) << 16) / (div))
73 static int meson_plane_atomic_check(struct drm_plane *plane,
74 struct drm_atomic_state *state)
76 struct drm_plane_state *new_plane_state = drm_atomic_get_new_plane_state(state,
78 struct drm_crtc_state *crtc_state;
80 if (!new_plane_state->crtc)
83 crtc_state = drm_atomic_get_crtc_state(state,
84 new_plane_state->crtc);
85 if (IS_ERR(crtc_state))
86 return PTR_ERR(crtc_state);
90 * - Upscaling up to 5x, vertical and horizontal
91 * - Final coordinates must match crtc size
93 return drm_atomic_helper_check_plane_state(new_plane_state,
96 DRM_PLANE_HELPER_NO_SCALING,
100 #define MESON_MOD_AFBC_VALID_BITS (AFBC_FORMAT_MOD_BLOCK_SIZE_16x16 | \
101 AFBC_FORMAT_MOD_BLOCK_SIZE_32x8 | \
102 AFBC_FORMAT_MOD_YTR | \
103 AFBC_FORMAT_MOD_SPARSE | \
104 AFBC_FORMAT_MOD_SPLIT)
106 /* Takes a fixed 16.16 number and converts it to integer. */
107 static inline int64_t fixed16_to_int(int64_t value)
112 static u32 meson_g12a_afbcd_line_stride(struct meson_drm *priv)
116 switch (priv->afbcd.format) {
117 case DRM_FORMAT_RGB565:
118 line_stride = ((priv->viu.osd1_width << 4) + 127) >> 7;
120 case DRM_FORMAT_RGB888:
121 case DRM_FORMAT_XRGB8888:
122 case DRM_FORMAT_ARGB8888:
123 case DRM_FORMAT_XBGR8888:
124 case DRM_FORMAT_ABGR8888:
125 line_stride = ((priv->viu.osd1_width << 5) + 127) >> 7;
129 return ((line_stride + 1) >> 1) << 1;
132 static void meson_plane_atomic_update(struct drm_plane *plane,
133 struct drm_atomic_state *state)
135 struct meson_plane *meson_plane = to_meson_plane(plane);
136 struct drm_plane_state *new_state = drm_atomic_get_new_plane_state(state,
138 struct drm_rect dest = drm_plane_state_dest(new_state);
139 struct meson_drm *priv = meson_plane->priv;
140 struct drm_framebuffer *fb = new_state->fb;
141 struct drm_gem_cma_object *gem;
143 int vsc_ini_rcv_num, vsc_ini_rpt_p0_num;
144 int vsc_bot_rcv_num, vsc_bot_rpt_p0_num;
145 int hsc_ini_rcv_num, hsc_ini_rpt_p0_num;
146 int hf_phase_step, vf_phase_step;
147 int src_w, src_h, dst_w, dst_h;
159 spin_lock_irqsave(&priv->drm->event_lock, flags);
161 /* Check if AFBC decoder is required for this buffer */
162 if ((meson_vpu_is_compatible(priv, VPU_COMPATIBLE_GXM) ||
163 meson_vpu_is_compatible(priv, VPU_COMPATIBLE_G12A)) &&
164 fb->modifier & DRM_FORMAT_MOD_ARM_AFBC(MESON_MOD_AFBC_VALID_BITS))
165 priv->viu.osd1_afbcd = true;
167 priv->viu.osd1_afbcd = false;
169 /* Enable OSD and BLK0, set max global alpha */
170 priv->viu.osd1_ctrl_stat = OSD_ENABLE |
171 (0xFF << OSD_GLOBAL_ALPHA_SHIFT) |
174 priv->viu.osd1_ctrl_stat2 = readl(priv->io_base +
175 _REG(VIU_OSD1_CTRL_STAT2));
177 canvas_id_osd1 = priv->canvas_id_osd1;
179 /* Set up BLK0 to point to the right canvas */
180 priv->viu.osd1_blk0_cfg[0] = canvas_id_osd1 << OSD_CANVAS_SEL;
182 if (priv->viu.osd1_afbcd) {
183 if (meson_vpu_is_compatible(priv, VPU_COMPATIBLE_G12A)) {
184 /* This is the internal decoding memory address */
185 priv->viu.osd1_blk1_cfg4 = MESON_G12A_AFBCD_OUT_ADDR;
186 priv->viu.osd1_blk0_cfg[0] |= OSD_ENDIANNESS_BE;
187 priv->viu.osd1_ctrl_stat2 |= OSD_PENDING_STAT_CLEAN;
188 priv->viu.osd1_ctrl_stat |= VIU_OSD1_CFG_SYN_EN;
191 if (meson_vpu_is_compatible(priv, VPU_COMPATIBLE_GXM)) {
192 priv->viu.osd1_blk0_cfg[0] |= OSD_ENDIANNESS_LE;
193 priv->viu.osd1_ctrl_stat2 |= OSD_DPATH_MALI_AFBCD;
196 priv->viu.osd1_blk0_cfg[0] |= OSD_ENDIANNESS_LE;
198 if (meson_vpu_is_compatible(priv, VPU_COMPATIBLE_GXM))
199 priv->viu.osd1_ctrl_stat2 &= ~OSD_DPATH_MALI_AFBCD;
202 /* On GXBB, Use the old non-HDR RGB2YUV converter */
203 if (meson_vpu_is_compatible(priv, VPU_COMPATIBLE_GXBB))
204 priv->viu.osd1_blk0_cfg[0] |= OSD_OUTPUT_COLOR_RGB;
206 if (priv->viu.osd1_afbcd &&
207 meson_vpu_is_compatible(priv, VPU_COMPATIBLE_G12A)) {
208 priv->viu.osd1_blk0_cfg[0] |= OSD_MALI_SRC_EN |
209 priv->afbcd.ops->fmt_to_blk_mode(fb->modifier,
212 switch (fb->format->format) {
213 case DRM_FORMAT_XRGB8888:
214 case DRM_FORMAT_ARGB8888:
215 priv->viu.osd1_blk0_cfg[0] |= OSD_BLK_MODE_32 |
216 OSD_COLOR_MATRIX_32_ARGB;
218 case DRM_FORMAT_XBGR8888:
219 case DRM_FORMAT_ABGR8888:
220 priv->viu.osd1_blk0_cfg[0] |= OSD_BLK_MODE_32 |
221 OSD_COLOR_MATRIX_32_ABGR;
223 case DRM_FORMAT_RGB888:
224 priv->viu.osd1_blk0_cfg[0] |= OSD_BLK_MODE_24 |
225 OSD_COLOR_MATRIX_24_RGB;
227 case DRM_FORMAT_RGB565:
228 priv->viu.osd1_blk0_cfg[0] |= OSD_BLK_MODE_16 |
229 OSD_COLOR_MATRIX_16_RGB565;
234 switch (fb->format->format) {
235 case DRM_FORMAT_XRGB8888:
236 case DRM_FORMAT_XBGR8888:
237 /* For XRGB, replace the pixel's alpha by 0xFF */
238 priv->viu.osd1_ctrl_stat2 |= OSD_REPLACE_EN;
240 case DRM_FORMAT_ARGB8888:
241 case DRM_FORMAT_ABGR8888:
242 /* For ARGB, use the pixel's alpha */
243 priv->viu.osd1_ctrl_stat2 &= ~OSD_REPLACE_EN;
247 /* Default scaler parameters */
249 vsc_bot_rpt_p0_num = 0;
253 if (new_state->crtc->mode.flags & DRM_MODE_FLAG_INTERLACE) {
255 vsc_bot_rpt_p0_num = 2;
258 hsc_ini_rcv_num = hf_bank_len;
259 vsc_ini_rcv_num = vf_bank_len;
260 hsc_ini_rpt_p0_num = (hf_bank_len / 2) - 1;
261 vsc_ini_rpt_p0_num = (vf_bank_len / 2) - 1;
263 src_w = fixed16_to_int(new_state->src_w);
264 src_h = fixed16_to_int(new_state->src_h);
265 dst_w = new_state->crtc_w;
266 dst_h = new_state->crtc_h;
269 * When the output is interlaced, the OSD must switch between
270 * each field using the INTERLACE_SEL_ODD (0) of VIU_OSD1_BLK0_CFG_W0
272 * But the vertical scaler can provide such funtionnality if
273 * is configured for 2:1 scaling with interlace options enabled.
275 if (new_state->crtc->mode.flags & DRM_MODE_FLAG_INTERLACE) {
281 hf_phase_step = ((src_w << 18) / dst_w) << 6;
282 vf_phase_step = (src_h << 20) / dst_h;
284 if (new_state->crtc->mode.flags & DRM_MODE_FLAG_INTERLACE)
285 bot_ini_phase = ((vf_phase_step / 2) >> 4);
289 vf_phase_step = (vf_phase_step << 4);
291 /* In interlaced mode, scaler is always active */
292 if (src_h != dst_h || src_w != dst_w) {
293 priv->viu.osd_sc_i_wh_m1 = SCI_WH_M1_W(src_w - 1) |
294 SCI_WH_M1_H(src_h - 1);
295 priv->viu.osd_sc_o_h_start_end = SCO_HV_START(dest.x1) |
296 SCO_HV_END(dest.x2 - 1);
297 priv->viu.osd_sc_o_v_start_end = SCO_HV_START(dest.y1) |
298 SCO_HV_END(dest.y2 - 1);
299 /* Enable OSD Scaler */
300 priv->viu.osd_sc_ctrl0 = SC_CTRL0_PATH_EN | SC_CTRL0_SEL_OSD1;
302 priv->viu.osd_sc_i_wh_m1 = 0;
303 priv->viu.osd_sc_o_h_start_end = 0;
304 priv->viu.osd_sc_o_v_start_end = 0;
305 priv->viu.osd_sc_ctrl0 = 0;
308 /* In interlaced mode, vertical scaler is always active */
309 if (src_h != dst_h) {
310 priv->viu.osd_sc_v_ctrl0 =
311 VSC_BANK_LEN(vf_bank_len) |
312 VSC_TOP_INI_RCV_NUM(vsc_ini_rcv_num) |
313 VSC_TOP_RPT_L0_NUM(vsc_ini_rpt_p0_num) |
314 VSC_VERTICAL_SCALER_EN;
316 if (new_state->crtc->mode.flags & DRM_MODE_FLAG_INTERLACE)
317 priv->viu.osd_sc_v_ctrl0 |=
318 VSC_BOT_INI_RCV_NUM(vsc_bot_rcv_num) |
319 VSC_BOT_RPT_L0_NUM(vsc_bot_rpt_p0_num) |
322 priv->viu.osd_sc_v_phase_step = SC_PHASE_STEP(vf_phase_step);
323 priv->viu.osd_sc_v_ini_phase = VSC_INI_PHASE_BOT(bot_ini_phase);
325 priv->viu.osd_sc_v_ctrl0 = 0;
326 priv->viu.osd_sc_v_phase_step = 0;
327 priv->viu.osd_sc_v_ini_phase = 0;
330 /* Horizontal scaler is only used if width does not match */
331 if (src_w != dst_w) {
332 priv->viu.osd_sc_h_ctrl0 =
333 HSC_BANK_LENGTH(hf_bank_len) |
334 HSC_INI_RCV_NUM0(hsc_ini_rcv_num) |
335 HSC_RPT_P0_NUM0(hsc_ini_rpt_p0_num) |
337 priv->viu.osd_sc_h_phase_step = SC_PHASE_STEP(hf_phase_step);
338 priv->viu.osd_sc_h_ini_phase = 0;
340 priv->viu.osd_sc_h_ctrl0 = 0;
341 priv->viu.osd_sc_h_phase_step = 0;
342 priv->viu.osd_sc_h_ini_phase = 0;
346 * The format of these registers is (x2 << 16 | x1),
347 * where x2 is exclusive.
348 * e.g. +30x1920 would be (1919 << 16) | 30
350 priv->viu.osd1_blk0_cfg[1] =
351 ((fixed16_to_int(new_state->src.x2) - 1) << 16) |
352 fixed16_to_int(new_state->src.x1);
353 priv->viu.osd1_blk0_cfg[2] =
354 ((fixed16_to_int(new_state->src.y2) - 1) << 16) |
355 fixed16_to_int(new_state->src.y1);
356 priv->viu.osd1_blk0_cfg[3] = ((dest.x2 - 1) << 16) | dest.x1;
357 priv->viu.osd1_blk0_cfg[4] = ((dest.y2 - 1) << 16) | dest.y1;
359 if (meson_vpu_is_compatible(priv, VPU_COMPATIBLE_G12A)) {
360 priv->viu.osd_blend_din0_scope_h = ((dest.x2 - 1) << 16) | dest.x1;
361 priv->viu.osd_blend_din0_scope_v = ((dest.y2 - 1) << 16) | dest.y1;
362 priv->viu.osb_blend0_size = dst_h << 16 | dst_w;
363 priv->viu.osb_blend1_size = dst_h << 16 | dst_w;
366 /* Update Canvas with buffer address */
367 gem = drm_fb_cma_get_gem_obj(fb, 0);
369 priv->viu.osd1_addr = gem->paddr;
370 priv->viu.osd1_stride = fb->pitches[0];
371 priv->viu.osd1_height = fb->height;
372 priv->viu.osd1_width = fb->width;
374 if (priv->viu.osd1_afbcd) {
375 priv->afbcd.modifier = fb->modifier;
376 priv->afbcd.format = fb->format->format;
378 /* Calculate decoder write stride */
379 if (meson_vpu_is_compatible(priv, VPU_COMPATIBLE_G12A))
380 priv->viu.osd1_blk2_cfg4 =
381 meson_g12a_afbcd_line_stride(priv);
384 if (!meson_plane->enabled) {
385 /* Reset OSD1 before enabling it on GXL+ SoCs */
386 if (meson_vpu_is_compatible(priv, VPU_COMPATIBLE_GXM) ||
387 meson_vpu_is_compatible(priv, VPU_COMPATIBLE_GXL))
388 meson_viu_osd1_reset(priv);
390 meson_plane->enabled = true;
393 priv->viu.osd1_enabled = true;
395 spin_unlock_irqrestore(&priv->drm->event_lock, flags);
398 static void meson_plane_atomic_disable(struct drm_plane *plane,
399 struct drm_atomic_state *state)
401 struct meson_plane *meson_plane = to_meson_plane(plane);
402 struct meson_drm *priv = meson_plane->priv;
404 if (priv->afbcd.ops) {
405 priv->afbcd.ops->reset(priv);
406 priv->afbcd.ops->disable(priv);
410 if (meson_vpu_is_compatible(priv, VPU_COMPATIBLE_G12A))
411 writel_bits_relaxed(VIU_OSD1_POSTBLD_SRC_OSD1, 0,
412 priv->io_base + _REG(OSD1_BLEND_SRC_CTRL));
414 writel_bits_relaxed(VPP_OSD1_POSTBLEND, 0,
415 priv->io_base + _REG(VPP_MISC));
417 meson_plane->enabled = false;
418 priv->viu.osd1_enabled = false;
421 static const struct drm_plane_helper_funcs meson_plane_helper_funcs = {
422 .atomic_check = meson_plane_atomic_check,
423 .atomic_disable = meson_plane_atomic_disable,
424 .atomic_update = meson_plane_atomic_update,
425 .prepare_fb = drm_gem_plane_helper_prepare_fb,
428 static bool meson_plane_format_mod_supported(struct drm_plane *plane,
429 u32 format, u64 modifier)
431 struct meson_plane *meson_plane = to_meson_plane(plane);
432 struct meson_drm *priv = meson_plane->priv;
435 if (modifier == DRM_FORMAT_MOD_INVALID)
438 if (modifier == DRM_FORMAT_MOD_LINEAR)
441 if (!meson_vpu_is_compatible(priv, VPU_COMPATIBLE_GXM) &&
442 !meson_vpu_is_compatible(priv, VPU_COMPATIBLE_G12A))
445 if (modifier & ~DRM_FORMAT_MOD_ARM_AFBC(MESON_MOD_AFBC_VALID_BITS))
448 for (i = 0 ; i < plane->modifier_count ; ++i)
449 if (plane->modifiers[i] == modifier)
452 if (i == plane->modifier_count) {
453 DRM_DEBUG_KMS("Unsupported modifier\n");
457 if (priv->afbcd.ops && priv->afbcd.ops->supported_fmt)
458 return priv->afbcd.ops->supported_fmt(modifier, format);
460 DRM_DEBUG_KMS("AFBC Unsupported\n");
464 static const struct drm_plane_funcs meson_plane_funcs = {
465 .update_plane = drm_atomic_helper_update_plane,
466 .disable_plane = drm_atomic_helper_disable_plane,
467 .destroy = drm_plane_cleanup,
468 .reset = drm_atomic_helper_plane_reset,
469 .atomic_duplicate_state = drm_atomic_helper_plane_duplicate_state,
470 .atomic_destroy_state = drm_atomic_helper_plane_destroy_state,
471 .format_mod_supported = meson_plane_format_mod_supported,
474 static const uint32_t supported_drm_formats[] = {
483 static const uint64_t format_modifiers_afbc_gxm[] = {
484 DRM_FORMAT_MOD_ARM_AFBC(AFBC_FORMAT_MOD_BLOCK_SIZE_16x16 |
485 AFBC_FORMAT_MOD_SPARSE |
486 AFBC_FORMAT_MOD_YTR),
487 /* SPLIT mandates SPARSE, RGB modes mandates YTR */
488 DRM_FORMAT_MOD_ARM_AFBC(AFBC_FORMAT_MOD_BLOCK_SIZE_16x16 |
489 AFBC_FORMAT_MOD_YTR |
490 AFBC_FORMAT_MOD_SPARSE |
491 AFBC_FORMAT_MOD_SPLIT),
492 DRM_FORMAT_MOD_LINEAR,
493 DRM_FORMAT_MOD_INVALID,
496 static const uint64_t format_modifiers_afbc_g12a[] = {
498 * - TOFIX Support AFBC modifiers for YUV formats (16x16 + TILED)
499 * - SPLIT is mandatory for performances reasons when in 16x16
501 * - 32x8 block size + SPLIT is mandatory with 4K frame size
502 * for performances reasons
504 DRM_FORMAT_MOD_ARM_AFBC(AFBC_FORMAT_MOD_BLOCK_SIZE_16x16 |
505 AFBC_FORMAT_MOD_SPARSE |
506 AFBC_FORMAT_MOD_SPLIT),
507 DRM_FORMAT_MOD_ARM_AFBC(AFBC_FORMAT_MOD_BLOCK_SIZE_16x16 |
508 AFBC_FORMAT_MOD_YTR |
509 AFBC_FORMAT_MOD_SPARSE |
510 AFBC_FORMAT_MOD_SPLIT),
511 DRM_FORMAT_MOD_ARM_AFBC(AFBC_FORMAT_MOD_BLOCK_SIZE_32x8 |
512 AFBC_FORMAT_MOD_SPARSE),
513 DRM_FORMAT_MOD_ARM_AFBC(AFBC_FORMAT_MOD_BLOCK_SIZE_32x8 |
514 AFBC_FORMAT_MOD_YTR |
515 AFBC_FORMAT_MOD_SPARSE),
516 DRM_FORMAT_MOD_ARM_AFBC(AFBC_FORMAT_MOD_BLOCK_SIZE_32x8 |
517 AFBC_FORMAT_MOD_SPARSE |
518 AFBC_FORMAT_MOD_SPLIT),
519 DRM_FORMAT_MOD_ARM_AFBC(AFBC_FORMAT_MOD_BLOCK_SIZE_32x8 |
520 AFBC_FORMAT_MOD_YTR |
521 AFBC_FORMAT_MOD_SPARSE |
522 AFBC_FORMAT_MOD_SPLIT),
523 DRM_FORMAT_MOD_LINEAR,
524 DRM_FORMAT_MOD_INVALID,
527 static const uint64_t format_modifiers_default[] = {
528 DRM_FORMAT_MOD_LINEAR,
529 DRM_FORMAT_MOD_INVALID,
532 int meson_plane_create(struct meson_drm *priv)
534 struct meson_plane *meson_plane;
535 struct drm_plane *plane;
536 const uint64_t *format_modifiers = format_modifiers_default;
538 meson_plane = devm_kzalloc(priv->drm->dev, sizeof(*meson_plane),
543 meson_plane->priv = priv;
544 plane = &meson_plane->base;
546 if (meson_vpu_is_compatible(priv, VPU_COMPATIBLE_GXM))
547 format_modifiers = format_modifiers_afbc_gxm;
548 else if (meson_vpu_is_compatible(priv, VPU_COMPATIBLE_G12A))
549 format_modifiers = format_modifiers_afbc_g12a;
551 drm_universal_plane_init(priv->drm, plane, 0xFF,
553 supported_drm_formats,
554 ARRAY_SIZE(supported_drm_formats),
556 DRM_PLANE_TYPE_PRIMARY, "meson_primary_plane");
558 drm_plane_helper_add(plane, &meson_plane_helper_funcs);
560 /* For now, OSD Primary plane is always on the front */
561 drm_plane_create_zpos_immutable_property(plane, 1);
563 priv->primary_plane = plane;