drm: apple: Move plane bits out of apple_drv/iomfb_flush

Now that dcp may use multiple planes with more complex paramters move
this out of iomfb_flush and use the appropriate KMS atomic plane helper
functions.
Also move most plane handling functions from apple_drv.c to its own
file.

Signed-off-by: Janne Grunau <[email protected]>

Author: jannau

drivers/gpu/drm/apple/Makefile

@@ -11,6 +11,7 @@ appledrm-y += ibootep.o
 appledrm-y += iomfb_v12_3.o
 appledrm-y += iomfb_v13_3.o
 appledrm-y += epic/dpavservep.o
+appledrm-y += plane.o
 
 
 appledrm-$(CONFIG_TRACING) += trace.o

drivers/gpu/drm/apple/apple_drv.c

@@ -26,7 +26,6 @@
 #include <drm/drm_drv.h>
 #include <drm/drm_fb_helper.h>
 #include <drm/drm_fbdev_dma.h>
-#include <drm/drm_fourcc.h>
 #include <drm/drm_fb_dma_helper.h>
 #include <drm/drm_gem_dma_helper.h>
 #include <drm/drm_gem_framebuffer_helper.h>
@@ -40,12 +39,11 @@
 #include <drm/drm_fixed.h>
 
 #include "dcp.h"
+#include "plane.h"
 
 #define DRIVER_NAME     "apple"
 #define DRIVER_DESC     "Apple display controller DRM driver"
 
-#define FRAC_16_16(mult, div)    (((mult) << 16) / (div))
-
 #define MAX_COPROCESSORS 3
 
 struct apple_drm_private {
@@ -77,172 +75,6 @@ static const struct drm_driver apple_drm_driver = {
 	.fops			= &apple_fops,
 };
 
-static int apple_plane_atomic_check(struct drm_plane *plane,
-				    struct drm_atomic_state *state)
-{
-	struct drm_plane_state *new_plane_state;
-	struct drm_crtc_state *crtc_state;
-	struct drm_rect *dst;
-	int ret;
-
-	new_plane_state = drm_atomic_get_new_plane_state(state, plane);
-
-	if (!new_plane_state->crtc)
-		return 0;
-
-	crtc_state = drm_atomic_get_crtc_state(state, new_plane_state->crtc);
-	if (IS_ERR(crtc_state))
-		return PTR_ERR(crtc_state);
-
-	/*
-	 * DCP limits downscaling to 2x and upscaling to 4x. Attempting to
-	 * scale outside these bounds errors out when swapping.
-	 *
-	 * This function also takes care of clipping the src/dest rectangles,
-	 * which is required for correct operation. Partially off-screen
-	 * surfaces may appear corrupted.
-	 *
-	 * DCP does not distinguish plane types in the hardware, so we set
-	 * can_position. If the primary plane does not fill the screen, the
-	 * hardware will fill in zeroes (black).
-	 */
-	ret = drm_atomic_helper_check_plane_state(new_plane_state, crtc_state,
-						  FRAC_16_16(1, 2),
-						  FRAC_16_16(4, 1),
-						  true, true);
-	if (ret < 0)
-		return ret;
-
-	if (!new_plane_state->visible)
-		return 0;
-
-	/*
-	 * DCP does not allow a surface to clip off the screen, and will crash
-	 * if any blended surface is smaller than 32x32. Reject the atomic op
-	 * if the plane will crash DCP.
-	 *
-	 * This is most pertinent to cursors. Userspace should fall back to
-	 * software cursors if the plane check is rejected.
-	 */
-	dst = &new_plane_state->dst;
-	if (drm_rect_width(dst) < 32 || drm_rect_height(dst) < 32) {
-		dev_err_once(state->dev->dev,
-			"Plane operation would have crashed DCP! Rejected!\n\
-			DCP requires 32x32 of every plane to be within screen space.\n\
-			Your compositor asked to overlay [%dx%d, %dx%d] on %dx%d.\n\
-			This is not supported, and your compositor should have\n\
-			switched to software compositing when this operation failed.\n\
-			You should not have noticed this at all. If your screen\n\
-			froze/hitched, or your compositor crashed, please report\n\
-			this to the your compositor's developers. We will not\n\
-			throw this error again until you next reboot.\n",
-			dst->x1, dst->y1, dst->x2, dst->y2,
-			crtc_state->mode.hdisplay, crtc_state->mode.vdisplay);
-		return -EINVAL;
-	}
-
-	return 0;
-}
-
-static void apple_plane_atomic_update(struct drm_plane *plane,
-				      struct drm_atomic_state *state)
-{
-	/* Handled in atomic_flush */
-}
-
-static const struct drm_plane_helper_funcs apple_primary_plane_helper_funcs = {
-	.atomic_check	= apple_plane_atomic_check,
-	.atomic_update	= apple_plane_atomic_update,
-	.get_scanout_buffer = drm_fb_dma_get_scanout_buffer,
-};
-
-static const struct drm_plane_helper_funcs apple_plane_helper_funcs = {
-	.atomic_check	= apple_plane_atomic_check,
-	.atomic_update	= apple_plane_atomic_update,
-};
-
-static void apple_plane_cleanup(struct drm_plane *plane)
-{
-	drm_plane_cleanup(plane);
-	kfree(plane);
-}
-
-static const struct drm_plane_funcs apple_plane_funcs = {
-	.update_plane		= drm_atomic_helper_update_plane,
-	.disable_plane		= drm_atomic_helper_disable_plane,
-	.destroy		= apple_plane_cleanup,
-	.reset			= drm_atomic_helper_plane_reset,
-	.atomic_duplicate_state = drm_atomic_helper_plane_duplicate_state,
-	.atomic_destroy_state	= drm_atomic_helper_plane_destroy_state,
-};
-
-/*
- * Table of supported formats, mapping from DRM fourccs to DCP fourccs.
- *
- * For future work, DCP supports more formats not listed, including YUV
- * formats, an extra RGBA format, and a biplanar RGB10_A8 format (fourcc b3a8)
- * used for HDR.
- *
- * Note: we don't have non-alpha formats but userspace breaks without XRGB. It
- * doesn't matter for the primary plane, but cursors/overlays must not
- * advertise formats without alpha.
- */
-static const u32 dcp_primary_formats[] = {
-	DRM_FORMAT_XRGB2101010,
-	DRM_FORMAT_XRGB8888,
-	DRM_FORMAT_ARGB8888,
-	DRM_FORMAT_XBGR8888,
-	DRM_FORMAT_ABGR8888,
-};
-
-static const u32 dcp_overlay_formats[] = {
-	DRM_FORMAT_ARGB8888,
-	DRM_FORMAT_ABGR8888,
-};
-
-u64 apple_format_modifiers[] = {
-	DRM_FORMAT_MOD_LINEAR,
-	DRM_FORMAT_MOD_INVALID
-};
-
-static struct drm_plane *apple_plane_init(struct drm_device *dev,
-					  unsigned long possible_crtcs,
-					  enum drm_plane_type type)
-{
-	int ret;
-	struct drm_plane *plane;
-
-	plane = kzalloc(sizeof(*plane), GFP_KERNEL);
-
-	switch (type) {
-	case DRM_PLANE_TYPE_PRIMARY:
-		ret = drm_universal_plane_init(dev, plane, possible_crtcs,
-				       &apple_plane_funcs,
-				       dcp_primary_formats, ARRAY_SIZE(dcp_primary_formats),
-				       apple_format_modifiers, type, NULL);
-		break;
-	case DRM_PLANE_TYPE_OVERLAY:
-	case DRM_PLANE_TYPE_CURSOR:
-		ret = drm_universal_plane_init(dev, plane, possible_crtcs,
-				       &apple_plane_funcs,
-				       dcp_overlay_formats, ARRAY_SIZE(dcp_overlay_formats),
-				       apple_format_modifiers, type, NULL);
-		break;
-	default:
-		return NULL;
-	}
-
-	if (ret)
-		return ERR_PTR(ret);
-
-	if (type == DRM_PLANE_TYPE_PRIMARY)
-		drm_plane_helper_add(plane, &apple_primary_plane_helper_funcs);
-	else
-		drm_plane_helper_add(plane, &apple_plane_helper_funcs);
-
-	return plane;
-}
-
 static enum drm_connector_status
 apple_connector_detect(struct drm_connector *connector, bool force)
 {

drivers/gpu/drm/apple/iomfb.c

@@ -356,25 +356,6 @@ struct dcp_rect drm_to_dcp_rect(struct drm_rect *rect)
 				  .h = drm_rect_height(rect) };
 }
 
-u32 drm_format_to_dcp(u32 drm)
-{
-	switch (drm) {
-	case DRM_FORMAT_XRGB8888:
-	case DRM_FORMAT_ARGB8888:
-		return fourcc_code('A', 'R', 'G', 'B');
-
-	case DRM_FORMAT_XBGR8888:
-	case DRM_FORMAT_ABGR8888:
-		return fourcc_code('A', 'B', 'G', 'R');
-
-	case DRM_FORMAT_XRGB2101010:
-		return fourcc_code('r', '0', '3', 'w');
-	}
-
-	pr_warn("DRM format %X not supported in DCP\n", drm);
-	return 0;
-}
-
 int dcp_get_modes(struct drm_connector *connector)
 {
 	struct apple_connector *apple_connector = to_apple_connector(connector);

drivers/gpu/drm/apple/iomfb.h

@@ -79,7 +79,6 @@ enum iomfb_property_id {
 #define SWAP_SURFACES 4
 /* We have 4 surfaces, but we can only ever blend two */
 #define MAX_BLEND_SURFACES 2
-#define MAX_PLANES 3
 
 enum dcp_colorspace {
 	DCP_COLORSPACE_BG_SRGB = 0,
@@ -113,25 +112,6 @@ struct dcp_rect {
  */
 #define IOMFB_SET_BACKGROUND	BIT(31)
 
-/* Information describing a plane of a planar compressed surface */
-struct dcp_plane_info {
-	u32 width;
-	u32 height;
-	u32 base;
-	u32 offset;
-	u32 stride;
-	u32 size;
-	u16 tile_size;
-	u8 tile_w;
-	u8 tile_h;
-	u32 unk[13];
-} __packed;
-
-struct dcp_component_types {
-	u8 count;
-	u8 types[7];
-} __packed;
-
 struct dcp_allocate_bandwidth_req {
 	u64 unk1;
 	u64 unk2;

drivers/gpu/drm/apple/iomfb_internal.h

@@ -116,8 +116,6 @@ void dcp_ack(struct apple_dcp *dcp, enum dcp_context_id context);
  */
 struct dcp_rect drm_to_dcp_rect(struct drm_rect *rect);
 
-u32 drm_format_to_dcp(u32 drm);
-
 /* The user may own drm_display_mode, so we need to search for our copy */
 struct dcp_display_mode *lookup_mode(struct apple_dcp *dcp,
 					    const struct drm_display_mode *mode);

drivers/gpu/drm/apple/iomfb_plane.h

@@ -0,0 +1,64 @@
+// SPDX-License-Identifier: GPL-2.0-only OR MIT
+/*
+ * Copyright (C) The Asahi Linux Contributors
+ */
+
+
+#ifndef __APPLE_IOMFB_PLANE_H__
+#define __APPLE_IOMFB_PLANE_H__
+
+#include <linux/types.h>
+
+#define DCP_SURF_MAX_PLANES 3
+
+/* Information describing a plane of a planar compressed surface */
+struct dcp_plane_info {
+	u32 width;
+	u32 height;
+	u32 base;
+	u32 offset;
+	u32 stride;
+	u32 size;
+	u16 tile_size;
+	u8 tile_w;
+	u8 tile_h;
+	u32 unk[13];
+} __packed;
+
+struct dcp_component_types {
+	u8 count;
+	u8 types[7];
+} __packed;
+
+/* Information describing a surface */
+struct dcp_surface {
+	u8 is_tiled;
+	u8 is_tearing_allowed;
+	u8 is_premultiplied;
+	u32 plane_cnt;
+	u32 plane_cnt2;
+	u32 format; /* DCP fourcc */
+	u32 ycbcr_matrix;
+	u8 xfer_func;
+	u8 colorspace;
+	u32 stride;
+	u16 pix_size;
+	u8 pel_w;
+	u8 pel_h;
+	u32 offset;
+	u32 width;
+	u32 height;
+	u32 buf_size;
+	u64 protection_opts;
+	u32 surface_id;
+	struct dcp_component_types comp_types[DCP_SURF_MAX_PLANES];
+	u64 has_comp;
+	struct dcp_plane_info planes[DCP_SURF_MAX_PLANES];
+	u64 has_planes;
+	u32 compression_info[DCP_SURF_MAX_PLANES][13];
+	u64 has_compr_info;
+	u32 unk_num;
+	u32 unk_denom;
+} __packed;
+
+#endif /* __APPLE_IOMFB_PLANE_H__ */

drivers/gpu/drm/apple/iomfb_template.c

@@ -1305,10 +1305,10 @@ void DCP_FW_NAME(iomfb_flush)(struct apple_dcp *dcp, struct drm_crtc *crtc, stru
 	}
 
 	for_each_oldnew_plane_in_state(state, plane, old_state, new_state, plane_idx) {
+		struct apple_plane_state *apple_state = to_apple_plane_state(new_state);
 		struct drm_framebuffer *fb = new_state->fb;
 		struct drm_gem_dma_object *obj;
 		struct drm_rect src_rect;
-		bool is_premultiplied = false;
 
 		/* skip planes not for this crtc */
 		if (old_state->crtc != crtc && new_state->crtc != crtc)
@@ -1357,15 +1357,6 @@ void DCP_FW_NAME(iomfb_flush)(struct apple_dcp *dcp, struct drm_crtc *crtc, stru
 		req->surf_null[l] = false;
 		has_surface = 1;
 
-		/*
-		 * DCP doesn't support XBGR8 / XRGB8 natively. Blending as
-		 * pre-multiplied alpha with a black background can be used as
-		 * workaround for the bottommost plane.
-		 */
-		if (fb->format->format == DRM_FORMAT_XRGB8888 ||
-		    fb->format->format == DRM_FORMAT_XBGR8888)
-		    is_premultiplied = true;
-
 		drm_rect_fp_to_int(&src_rect, &new_state->src);
 
 		req->swap.src_rect[l] = drm_to_dcp_rect(&src_rect);
@@ -1382,24 +1373,7 @@ void DCP_FW_NAME(iomfb_flush)(struct apple_dcp *dcp, struct drm_crtc *crtc, stru
 		if (obj)
 			req->surf_iova[l] = obj->dma_addr + fb->offsets[0];
 
-		req->surf[l] = (struct DCP_FW_NAME(dcp_surface)){
-			.is_premultiplied = is_premultiplied,
-			.format = drm_format_to_dcp(fb->format->format),
-			.xfer_func = DCP_XFER_FUNC_SDR,
-			.colorspace = DCP_COLORSPACE_NATIVE,
-			.stride = fb->pitches[0],
-			.width = fb->width,
-			.height = fb->height,
-			.buf_size = fb->height * fb->pitches[0],
-			.surface_id = req->swap.surf_ids[l],
-
-			/* Only used for compressed or multiplanar surfaces */
-			.pix_size = 1,
-			.pel_w = 1,
-			.pel_h = 1,
-			.has_comp = 1,
-			.has_planes = 1,
-		};
+		req->surf[l].base = apple_state->surf;
 
 	}