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:     airlied@linux.ie, ayaka@soulik.info, sakari.ailus@linux.intel.com,
        ezequiel@vanguardiasur.com.ar, tzimmermann@suse.de,
        linux-kernel@vger.kernel.org, laurent.pinchart@ideasonboard.com,
        mchehab@kernel.org, tfiga@chromium.org, mripard@kernel.org,
        ribalda@chromium.org, maarten.lankhorst@linux.intel.com,
        linux-media@vger.kernel.org, sebastian.hesselbarth@gmail.com,
        helen.koike@collabora.com, nicolas@ndufresne.ca,
        linux-arm-kernel@lists.infradead.org,
        "Hsia-Jun(Randy) Li" <randy.li@synaptics.com>
Subject: [PATCH v5 1/2] drm/fourcc: Add Synaptics VideoSmart tiled modifiers
Date:   Wed, 30 Nov 2022 17:21:48 +0800
Message-Id: <20221130092149.102788-2-randy.li@synaptics.com>
In-Reply-To: <20221130092149.102788-1-randy.li@synaptics.com>
References: <20221130092149.102788-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?vRX7TxGufvaPMrXFyO2ItvfJpBL4oCjLBrVhGh3U3Jhm1udLcjLMtiUXAyVg?=
 =?us-ascii?Q?sRVtg4BMEk3BM703nPS+n5AzlTCPakGRrVD+OwMJ7Hzy0C/DjG0pRo3z/mUQ?=
 =?us-ascii?Q?GRcddBs+q12SQpWNac+ZEigkpltjlyhyGdxjsPTJyYMeF+GN5VUY0pbqRPGD?=
 =?us-ascii?Q?3Z1+pCJqXIa0xd0R5q282MJ15zUXFpY6WsqWHHmNg7qBee36Bn0GeubdjqLO?=
 =?us-ascii?Q?w3ueNhtqcVuYBc1QYlwDk3YuLmytodZNPV5HXQx/wVis2Rzviy5xlD6K0UKF?=
 =?us-ascii?Q?bLi1WOkXV/sMtKW1xzCBVoc6wNvuCVXgcyf9l8NcU5U6JIplzf7ieAmup0u6?=
 =?us-ascii?Q?LoEUl/vh1YNFBkgQtwgXNLxgkKip7beB/Y3VqsxN19TS9oXqPJFoEZ/8oHHa?=
 =?us-ascii?Q?IgMo68Ol9uMHgNcQ8TC5M3ivt2YrHG55pdSlmjb/nJA3hI3amKLDUumIOpkp?=
 =?us-ascii?Q?Qiam4+RGwqMG720Y9OvRe3G1XILLIuFj5wY44xvPdA1Qeon8mfCF4HYtw8il?=
 =?us-ascii?Q?AyqprzzoejhcD9azgHcsTadeP/uwWQSMfhKE4skE2bzu2taMhafwMLAx2f4Y?=
 =?us-ascii?Q?ouMwCoTLbBqIpUIzK518fClrTeeiONqg/OBerOlNTnUD5kx10Z5AtUTUz6gJ?=
 =?us-ascii?Q?9/ryjk4drCrRhfqGlSVkU/7XET8IT3TKVaEWhd3kSXMvKyyAhnb8cYSHhfwH?=
 =?us-ascii?Q?r/2Z1FlIgrulcC0iBzRJlNkZEPyl2YdEOdY0EVtaB97UArmJy6O44qBCU27D?=
 =?us-ascii?Q?qjaRwmN8GHLKt9L5M8yI+NqKvnsOVlSirfKdtpCCXhFuOz2wciGBGa55PqM5?=
 =?us-ascii?Q?e8g5vsn0NjuM2SY6+JooHryPythm00Cia1D6/TzImJBI3kFg6ztcpnbI7T/5?=
 =?us-ascii?Q?9xMWZ5muvPD/u8HTDAX0Z30XWxgwZvr/wihX8E89mWHmdgZtqWzyJwGJWlyj?=
 =?us-ascii?Q?yIMBdBE4+YcCpiiKBtFnHr8uvGFRaGqccjgYbImFLY3vjW/3Ouij59Uxb8CZ?=
 =?us-ascii?Q?irCOK1/R/SoD8rFu54+gKoy49l0z7VU3b7VaKhKK93skbuenN/RM2ZtVHlu1?=
 =?us-ascii?Q?ler2RF+bjox8O2UzYipkAO9MFLmcjAzo8pWdyq7v78ZBq+fOnKyceGSmzoKS?=
 =?us-ascii?Q?Opt7cL3SxWQnTC8i8SZb4M5AYsUbR496q5K/BcjhXVsKfhWH4Exe94NpkXBd?=
 =?us-ascii?Q?zlCc5wgPmwyi3CmF1j6ok+KJbij9Vy10E15z2sj0oQ1HxxuVGK4zSNIBkOwX?=
 =?us-ascii?Q?2KkmNU0t0uQzJ1IoPob18fAE4bdCtY8pcnvSCKWrlRK6GB6wbZg/XwBp/WaS?=
 =?us-ascii?Q?4BUVYRF/gVNzfYoLLiZIHBdkdS2wlP0pS4J5XtBMj/ZkB5xjOntTrgkgvfQB?=
 =?us-ascii?Q?+69EGLKAF/wsIzxo2MzvdxJ0md3Q6ogBqfoHXeYpw4nf5xfZ24qPSd1XVtE6?=
 =?us-ascii?Q?qVkWtmfEQSclYJn8xxNIrn7EwE2SOZos+q7efvZGyZE7P49nyTRvDyAvPVFq?=
 =?us-ascii?Q?qxERdSPRjUsS6Wn1j9vox7e2OX5Fqq04z4xipBu68pOEjd04dorJyc1+enmF?=
 =?us-ascii?Q?uQB0N3mvmEtF4H55fa5aJD1aY24j7crUxxx87Xzc?=
X-OriginatorOrg: synaptics.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 394b1775-15f4-4219-2e59-08dad2b4686c
X-MS-Exchange-CrossTenant-AuthSource: DM6PR03MB5196.namprd03.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 30 Nov 2022 09:22:31.7193
 (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: ug4CMYPpChM8FSTGvr0C4bOvMT4Q89cV9V6jH+w0bhDSiS5/4YjM/8prc8eiOmrH5n0Q0cSpuXkc3bxzCuhM2A==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: SJ0PR03MB5422
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
        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>

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.

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

diff --git a/include/uapi/drm/drm_fourcc.h b/include/uapi/drm/drm_fourcc.h
index bc056f2d537d..e0905f573f43 100644
--- a/include/uapi/drm/drm_fourcc.h
+++ b/include/uapi/drm/drm_fourcc.h
@@ -407,6 +407,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 */
 
@@ -1507,6 +1508,81 @@ 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
+ *
+ * Tiles could be arranged in Groups of Tiles (GOTs), it is a small tile
+ * within a tile. GOT size and layout varies based on platform and
+ * performance concern.
+ *
+ * Besides, an 8 length 4 bytes arrary (32 bytes) would be need to store
+ * some compression parameters for a compression metadata plane.
+ *
+ * Further information can be found in
+ * Documentation/gpu/synaptics.rst
+ *
+ *       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.
+ *
+ * 20:20 g     GOT packing flag.
+ *
+ * 23:21 -     Reserved for future use.  Must be zero.
+ *
+ * 27:24 h     log2(horizontal) of pixels, in GOTs.
+ *
+ * 31:28 v     log2(vertical) of pixels, in GOTs.
+ *
+ * 35:32 -     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, g, h, v, c) \
+	fourcc_mod_code(SYNAPTICS, ((__u64)((f) & 0xff) | \
+				 ((__u64)((m) & 0xff) << 8) | \
+				 ((__u64)((p) & 0xf) << 16) | \
+				 ((__u64)((g) & 0x1) << 20) | \
+				 ((__u64)((h) & 0xf) << 24) | \
+				 ((__u64)((v) & 0xf) << 28) | \
+				 ((__u64)((c) & 0x1) << 36)))
+
+#define DRM_FORMAT_MOD_SYNA_V4H1 \
+	DRM_FORMAT_MOD_SYNA_MTR_LINEAR_2D(1, 1, 0, 0, 0, 0, 0)
+
+#define DRM_FORMAT_MOD_SYNA_V4H3P8 \
+	DRM_FORMAT_MOD_SYNA_MTR_LINEAR_2D(1, 3, 8, 0, 0, 0, 0)
+
+#define DRM_FORMAT_MOD_SYNA_V4H1_64L4_COMPRESSED \
+	DRM_FORMAT_MOD_SYNA_MTR_LINEAR_2D(1, 1, 0, 1, 6, 2, 1)
+
+#define DRM_FORMAT_MOD_SYNA_V4H3P8_64L4_COMPRESSED \
+	DRM_FORMAT_MOD_SYNA_MTR_LINEAR_2D(1, 3, 8, 1, 6, 2, 1)
+
+#define DRM_FORMAT_MOD_SYNA_V4H1_128L128_COMPRESSED \
+	DRM_FORMAT_MOD_SYNA_MTR_LINEAR_2D(1, 1, 0, 1, 7, 7, 1)
+
+#define DRM_FORMAT_MOD_SYNA_V4H3P8_128L128_COMPRESSED \
+	DRM_FORMAT_MOD_SYNA_MTR_LINEAR_2D(1, 3, 8, 1, 7, 7, 1)
+
 #if defined(__cplusplus)
 }
 #endif
-- 
2.37.3