Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   Hsia-Jun Li <randy.li@synaptics.com>
To:     dri-devel@lists.freedesktop.org
Cc:     maarten.lankhorst@linux.intel.com, mripard@kernel.org,
        tzimmermann@suse.de, airlied@linux.ie, daniel@ffwll.ch,
        mchehab@kernel.org, hverkuil-cisco@xs4all.nl,
        laurent.pinchart@ideasonboard.com, ezequiel@vanguardiasur.com.ar,
        sakari.ailus@linux.intel.com, ribalda@chromium.org,
        linux-media@vger.kernel.org, linux-kernel@vger.kernel.org,
        tfiga@chromium.org, sebastian.hesselbarth@gmail.com,
        jszhang@kernel.org, linux-arm-kernel@lists.infradead.org,
        "Hsia-Jun(Randy) Li" <randy.li@synaptics.com>
Subject: [PATCH 1/2] drm/fourcc: Add Synaptics VideoSmart tiled modifiers
Date:   Tue,  9 Aug 2022 00:27:49 +0800
Message-Id: <20220808162750.828001-2-randy.li@synaptics.com>
In-Reply-To: <20220808162750.828001-1-randy.li@synaptics.com>
References: <20220808162750.828001-1-randy.li@synaptics.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?U2cqyR5ebcI3OgO1/pWRI9G0ZKasxinWYhCC4uMj8zPWGCcKmvU4qBRpXCLm?=
 =?us-ascii?Q?Sw6U1yIdmK99tI9IcYv+zJNd+hKoMLLgV3dQLpoC2/r3sQYAFLzODqd/3SMh?=
 =?us-ascii?Q?HPQXKYy/I8ffYysihS9E8jnsqnBf5Oy+7gBaT0xkKhFRK3DX4fV2q0R2Pk7Z?=
 =?us-ascii?Q?h1c7gW7lWIg3zPBlWVQ5LtzC5QrFWNv6ri5uNuw3Jwt6N7oYDwzulkPXb+CR?=
 =?us-ascii?Q?EdusXS+F0H+haXjliJFHFQp/pCh0EtfOyWSxgzxEzunyHcOFus9RKt7alQ8k?=
 =?us-ascii?Q?QpPBAbpfWWzEVxwdmoYupDUsoylSf9LdhltIYAvaBQ+J4JkyD4Xv9PRaEN6L?=
 =?us-ascii?Q?hhdGn8fmXs0TuMEHs/OxM7LMksRO1gxK5EaTvlrXIRqwWlZCRWxm2OrCrO4V?=
 =?us-ascii?Q?8bR1QhBlF9oB2Rtj0nvAnUxxS3EXAeEeBG1UC7QyAuVIJ6pN6HDq6AQkwsFI?=
 =?us-ascii?Q?UTuXQeTuPP9ktVEb3KtIkYbxEIs33JBovMd78vevbx6ZB2MCBSKPz6JwYWPU?=
 =?us-ascii?Q?ajueAq7OXPtVtuvGbqKtbSIZm7TUihvwSILyWhF3g7SwDjoyiNNPVLMjUKre?=
 =?us-ascii?Q?2EWZdNW62OgLirlM8Q4IRB2anZhy1jtlF8yX0wpduLBmRgDCiSmvmGGcwtDP?=
 =?us-ascii?Q?VYZF7R7n4dTC2xBPNlGGDe2iq3cgSVYkcwHi9hjhqY6mzNS24k+1bhpffYdQ?=
 =?us-ascii?Q?vcb98hsOrHfx7G8J4vH+kIzlIMZ4RefUKU+Fe4vINw+H5ZhkdSxgLx5ngcAx?=
 =?us-ascii?Q?ZUAfjoyK+jfojASh0qUA0OFmRzMHXhNoEkfocLOmzY2+r6HK/JqspICt7OE/?=
 =?us-ascii?Q?h61duKSzApXqgqkgf/aE3czETqdfmGdS0UIbDu8K/KS+ktrquk40uxy5bmXK?=
 =?us-ascii?Q?iVEonrTMogLzT/UyEIubEd7mqNNKEQGEI7drQAhUR3BJOo/rQ3CSiPnOc2ND?=
 =?us-ascii?Q?hHsawJLCyq4VkuMrY4b4k/4WlcmRlpkFTs3xWB5gTI2sU0kD+jtsXKe20t+6?=
 =?us-ascii?Q?doh3QNXe8pcFJE0iwRHNw8bVyXYlxG3ma2fEqXEoCj2+bpgzWRULoL8qEpSe?=
 =?us-ascii?Q?iS8ZAJQwgZ1KI52BEdYeIumdcgB6+FLwFBKHVdmiBlNvHDlsKwfWJbEZcZ8g?=
 =?us-ascii?Q?mkWy6N2VjqvZIOjx6VTtSOsYUWJ45N+u1YOlXmvk0EHJtxmf0ZJYOxyv6of7?=
 =?us-ascii?Q?Exu8W+PDKCVhvOviSy80IYrIWco/EP3cf47VG5RTX26FB/wmqxK3HVZCVUPT?=
 =?us-ascii?Q?q2uC710EEiWedN4c9hi6ZQOSoE+HuGCeEF6GKpJQfLc+BfG4hTRuf0PWf3xS?=
 =?us-ascii?Q?Osr3rLi7e36xCrkdCYyDXCzEs9XAuYyWeDxLw4AJEblI003Dno7A4B6ET6+h?=
 =?us-ascii?Q?SfuCH5UXBLenYR3Qh5NNs8cZnmuGLle4JiAyCUiqSuzpGFPxnR0rPAiOmZZw?=
 =?us-ascii?Q?s6tq8QBx/YNI82PYgg9mWFO2lO+ouTD22Ta9GJgXvj7sV0hvitGjBkbxvpoc?=
 =?us-ascii?Q?ah1iK7FZG1yuqKFKtX7S6d8LtVWnFucb/Fn87iE4JHuai+8/keFpqGUvjSDh?=
 =?us-ascii?Q?bDue/Vp69GesIgkB2G8qesZ7+EEGbvwbmyicy6iN?=
X-OriginatorOrg: synaptics.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 3a0827cf-1a81-4329-446e-08da795b0ab4
X-MS-Exchange-CrossTenant-AuthSource: DM6PR03MB5196.namprd03.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 08 Aug 2022 16:28:36.0223
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 335d1fbc-2124-4173-9863-17e7051a2a0e
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: dX/O/oY+M0HCMv+gv6T9KL8+I1oLXh1m5exmJop+2fhBaA+lg/Lhgue1cbajrq9pmTN/hncZ73UdZq5D9Ik1Vw==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: BY5PR03MB5153
X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,SPF_PASS,
        T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

From: "Hsia-Jun(Randy) Li" <randy.li@synaptics.com>

Memory Traffic Reduction(MTR) is a module in Synaptics
VideoSmart platform could process lossless compression image
and cache the tile memory line.

Those modifiers only record the parameters would effort pixel
layout or memory layout. Whether physical memory page mapping
is used is not a part of format.

We would allocate the same size of memory for uncompressed
and compressed luma and chroma data, while the compressed buffer
would request two extra planes holding the metadata for
the decompression.

The reason why we need to allocate the same size of memory for
the compressed frame:
1. The compression ratio is not fixed and differnt platforms could
use a different compression protocol. These protocols are complete
vendor proprietaries, the other device won't be able to use them.
It is not necessary to define the version of them here.

2. Video codec could discard the compression attribute when the
intra block copy applied to this frame. It would waste lots of
time on re-allocation.

I am wondering if it is better to add an addtional plane property to
describe whether the current framebuffer is compressed?
While the compression flag is still a part of format modifier,
because it would have two extra meta data planes in the compression
version.

Signed-off-by: Hsia-Jun(Randy) Li <randy.li@synaptics.com>
---
 include/uapi/drm/drm_fourcc.h | 49 +++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)

diff --git a/include/uapi/drm/drm_fourcc.h b/include/uapi/drm/drm_fourcc.h
index 0206f812c569..b67884e8bc69 100644
--- a/include/uapi/drm/drm_fourcc.h
+++ b/include/uapi/drm/drm_fourcc.h
@@ -381,6 +381,7 @@ extern "C" {
 #define DRM_FORMAT_MOD_VENDOR_ARM     0x08
 #define DRM_FORMAT_MOD_VENDOR_ALLWINNER 0x09
 #define DRM_FORMAT_MOD_VENDOR_AMLOGIC 0x0a
+#define DRM_FORMAT_MOD_VENDOR_SYNAPTICS 0x0b
 
 /* add more to the end as needed */
 
@@ -1452,6 +1453,54 @@ drm_fourcc_canonicalize_nvidia_format_mod(__u64 modifier)
 #define AMD_FMT_MOD_CLEAR(field) \
 	(~((__u64)AMD_FMT_MOD_##field##_MASK << AMD_FMT_MOD_##field##_SHIFT))
 
+/*
+ * Synaptics VideoSmart modifiers
+ *
+ *       Macro
+ * Bits  Param Description
+ * ----  ----- -----------------------------------------------------------------
+ *
+ *  7:0  f     Scan direction description.
+ *
+ *               0 = Invalid
+ *               1 = V4, the scan would always start from vertical for 4 pixel
+ *                   then move back to the start pixel of the next horizontal
+ *                   direction.
+ *               2 = Reserved for future use.
+ *
+ * 15:8  m     The times of pattern repeat in the right angle direction from
+ *             the first scan direction.
+ *
+ * 19:16 p     The padding bits after the whole scan, could be zero.
+ *
+ * 35:20 -     Reserved for future use.  Must be zero.
+ *
+ * 36:36 c     Compression flag.
+ *
+ * 55:37 -     Reserved for future use.  Must be zero.
+ *
+ */
+
+#define DRM_FORMAT_MOD_SYNA_V4_TILED		fourcc_mod_code(SYNAPTICS, 1)
+
+#define DRM_FORMAT_MOD_SYNA_MTR_LINEAR_2D(f, m, p, c) \
+	fourcc_mod_code(SYNAPTICS, (((f) & 0xff) | \
+				 (((m) & 0xff) << 8) | \
+				 (((p) & 0xf) << 16) | \
+				 (((c) & 0x1) << 36)))
+
+#define DRM_FORMAT_MOD_SYNA_V4H1 \
+	DRM_FORMAT_MOD_SYNA_MTR_LINEAR_2D(1, 1, 0, 0)
+
+#define DRM_FORMAT_MOD_SYNA_V4H3P8 \
+	DRM_FORMAT_MOD_SYNA_MTR_LINEAR_2D(1, 3, 8, 0)
+
+#define DRM_FORMAT_MOD_SYNA_V4H1_COMPRESSED \
+	DRM_FORMAT_MOD_SYNA_MTR_LINEAR_2D(1, 1, 0, 1)
+
+#define DRM_FORMAT_MOD_SYNA_V4H3P8_COMPRESSED \
+	DRM_FORMAT_MOD_SYNA_MTR_LINEAR_2D(1, 3, 8, 1)
+
 #if defined(__cplusplus)
 }
 #endif
-- 
2.17.1