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:     ayaka@soulik.info, maarten.lankhorst@linux.intel.com,
        mripard@kernel.org, tzimmermann@suse.de, airlied@gmail.com,
        daniel@ffwll.ch, linux-kernel@vger.kernel.org, tfiga@chromium.org,
        nicolas@ndufresne.ca, laurent.pinchart@ideasonboard.com,
        ribalda@chromium.org, "Hsia-Jun(Randy) Li" <randy.li@synaptics.com>
Subject: [PATCH v6 1/2] drm/fourcc: Add Synaptics VideoSmart tiled modifiers
Date:   Wed, 22 Mar 2023 16:29:09 +0800
Message-Id: <20230322082910.115371-2-randy.li@synaptics.com>
In-Reply-To: <20230322082910.115371-1-randy.li@synaptics.com>
References: <20230322082910.115371-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?xSmhGIadcT3eTNU3hzGsiO9krGlsFg84oxn7zu7hIGoidXmT+RsntWiVAven?=
 =?us-ascii?Q?t48sTujNnPMBWicx1hbplbv3TiOxZCK6hJ1RuVWbJIIgT777nJFT8RiikQhb?=
 =?us-ascii?Q?BnSdH3UceOqyQsWil8GEnXePo2f/1+XiGDjk8hA1gd/a1z41NY0xf7UPYsK4?=
 =?us-ascii?Q?Zh7dCplsVoC9Yf9cR9MKe5ksghxPKX42mmEnxS0m6fNhQM1CWoUvG9aFrRK/?=
 =?us-ascii?Q?9SD6D11Y2gu0Jvv0q/npD8kAW/cNqfq5sTQCmCNmGXD9Besrh0gk5HhX7jwI?=
 =?us-ascii?Q?01g7DEirCXRvlQdF9WFIfowzDAgKIFw0jXJ30VlrkHvp3zaOiBzd9DlSuExj?=
 =?us-ascii?Q?sE7+VAL6jkFXOGseXQyoeBrXsZuCGWoSfdQRZw6WeI4ZsfUX5mdg9CUCXIGl?=
 =?us-ascii?Q?dUVWu0C6XwCIT12T1+KSrNVPMqRW2aK1smWToAfJuyzr7AH9EyYLTZuGS0FO?=
 =?us-ascii?Q?p4gJpv5chQ673gd0n4m2cE/Uva4P6NcuJ1JNPlKQjhnc8voo3Vm60HxxX7wP?=
 =?us-ascii?Q?c/nx3ol+rnqVFTlUsJG642H2pXyosQgu6qpUOltl60lAcov7aiEP/UnkO580?=
 =?us-ascii?Q?ppTEPlFRg56acIB8q069c41s1wnoo0VXyniWMz7hTsa3jXbZD+9k5L8iJ8xs?=
 =?us-ascii?Q?sFtnKVghhWgPbCyg+AGn9VW80ifOXtM5Yrcl8hrEyeh6rFPM+Aub61krXz/s?=
 =?us-ascii?Q?MAVVsg2UMaUu8lzrt421al2ojozu1qL4h2UQ6lSJ7wDKd8ZMsRojKD+TsQdZ?=
 =?us-ascii?Q?GKZJOvODPYfxVZ2SZ+R+BZEqZKguxif1FOmeQ2CUsrFoLNqfbQBUKY19SefX?=
 =?us-ascii?Q?OxHnhCMmlXXU0bitSlpaWxBZH0tdEPHpPYTLMtnDhFMw6Q7HRnJkZZzlOEbk?=
 =?us-ascii?Q?jD4zN3pc3eHC0hSc0C5uYkNu1meKrhfQaVz74PjPIenOLBlfVIlK0ZZqb5im?=
 =?us-ascii?Q?2wlQUd6oJmeE63mskdkL4A1AfFWroq+09vjHmRo1d/XW3GPlBc8ETRLt+O3H?=
 =?us-ascii?Q?AijgvnEUz8pZd+ydgTvf8xY787AeeZt4pvg+Boi64OqEFmYSnUTZiEnS3eVs?=
 =?us-ascii?Q?3/tn2hQkoXZ9tRFa6dJ+aafNERxuNoUzqIVyxLNIjNA4Vu5aiP+eszYMpKKY?=
 =?us-ascii?Q?l/jGSZlhv6WnEUF5gdXAQ7BpAhV5aPeZ6qo+CVIff3zhF5vymZVowKNseEEs?=
 =?us-ascii?Q?giuQicmmrHOcuQ9xdelROM2OJfdpzQsiiUrjaWZ1/8wdcvZZ88F39lewt+aM?=
 =?us-ascii?Q?T3E+6T9OqdXuUyE8oMn1rziewgb9m07c+EnW5nY+bRNVBeL7UkMmXWjTYk4I?=
 =?us-ascii?Q?mSomT6qFrVSzsJ5CDC9fVrXre0Xg0w2/SootPbfXqE1rp2dS1VRMGWfx6qY9?=
 =?us-ascii?Q?rDlBAMxARTydC6s/NMIkKSpqP5xygpFucnccKclCAOUVcbZ16Tebl8x2CDKJ?=
 =?us-ascii?Q?RgGcUFBuHjXeJ6JFcw4y/NBjw+659weUOSyGtfSNuRcyTBBQ2F/kRHtUfSvI?=
 =?us-ascii?Q?D+gMMAeQsz8EPznPrD5DBurAVRTHA7LQkYSYpWLXzmI0UbqpztGU/XyyUP42?=
 =?us-ascii?Q?h5jvxQ7kEwFCnbSucKSMUO8CzQOFTvYDg8T3E4QJ?=
X-OriginatorOrg: synaptics.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 3e43ef6e-b139-4f65-1641-08db2aafba79
X-MS-Exchange-CrossTenant-AuthSource: DM6PR03MB5196.namprd03.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 22 Mar 2023 08:30:44.2479
 (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: IirZHa3GicWTSSbnC+y39mBB8GwPnXck3eqmKOSlQYFr7mjlo4HisWiGs8IWu6qpFaLW/AS8QjW/lEn4Pbk8jw==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: MN2PR03MB4944
X-Spam-Status: No, score=-0.0 required=5.0 tests=DKIM_SIGNED,DKIM_VALID,
        SPF_HELO_PASS,SPF_PASS autolearn=unavailable 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 | 75 +++++++++++++++++++++++++++++++++++
 1 file changed, 75 insertions(+)

diff --git a/include/uapi/drm/drm_fourcc.h b/include/uapi/drm/drm_fourcc.h
index de703c6be969..ee13250f06f4 100644
--- a/include/uapi/drm/drm_fourcc.h
+++ b/include/uapi/drm/drm_fourcc.h
@@ -419,6 +419,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 */
 
@@ -1519,6 +1520,80 @@ 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. When the compression is applied, it is possible
+ * that we would have two tile type in the GOT, these parameters can't
+ * tell the secondary tile type.
+ *
+ * Besides, an 8 size 4 bytes arrary (32 bytes) would be need to store
+ * some compression parameters for a compression meta data plane.
+ *
+ *       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 bytes, in GOTs.
+ *
+ * 31:28 v     log2(vertical) of bytes, 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.17.1