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,
        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,
        laurent.pinchart@ideasonboard.com, nicolas@ndufresne.ca,
        helen.koike@collabora.com, Randy Li <ayaka@soulik.info>
Subject: [PATCH v2 2/2] media: docs: Add Synpatics tile modifiers
Date:   Mon, 31 Oct 2022 01:18:07 +0800
Message-Id: <20221030171807.55837-3-randy.li@synaptics.com>
In-Reply-To: <20221030171807.55837-1-randy.li@synaptics.com>
References: <20221030171807.55837-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?gVEt4Rnk4hGRDg0RE1+hHOBWfwb7nqsWMMtNOHjA8rqnE6pUnT+1m7m8k2pb?=
 =?us-ascii?Q?0rMI45vbt/Ug6CQ2aAXHy1HTUD0On8Me1FaYKuGuwGxRQqsK1hvPg3rmSLjU?=
 =?us-ascii?Q?Ecd2mCcZdINXzqSmjAqoVmQmUm8d9vuxwuezTTWvvQROOGbnljF9+LEW1YeE?=
 =?us-ascii?Q?dbv2usRficgRepJ98GTAEsyVahUXL/WxT58MhaJ21k7FiOixYDZaZM2zFhIs?=
 =?us-ascii?Q?+ts6nZE1SM7pRmJczxoLpKn+AWTu7HWgq9MNBZ5ycrI2NNNZArShRFCszqK6?=
 =?us-ascii?Q?jXGh3abtLAJHhJ7WYPaVFtHB3dxoO9D8rubWqVl70pnZyszAeuelBYd4Jbfp?=
 =?us-ascii?Q?KDHS7lh2JkBy6bLgnglTe3hM6SrzVKBwMoofE8ATdk21sYTy8KW5Voi1tJmI?=
 =?us-ascii?Q?vluoBIwBBuaQkd2pwYz7WM7ZP6EBYn5/OXR/7Eu44ykSEuZJX5er31TMaN12?=
 =?us-ascii?Q?kBC3RHTb5iPPehu1C+ZNrV3c3gkxe08QxbJEaH+tb/sQfBA1olklDI0EBrXe?=
 =?us-ascii?Q?ofAZ6Qx9XyCPbdgcSmIsMFeNipNvhhGu/Q2xE6xI+qEbFzFERsPzfxbWgTfr?=
 =?us-ascii?Q?rAklObgNTMqoYFOg6X34owdahXhc121NHXI2bC8fScPtlLI8NUonHNZVl0yo?=
 =?us-ascii?Q?hEcKftJ+wVUGP6Ir6m/oizW0/sBLbvWMDXC8O4Oe954MtoIQXpmQyYwLUOLH?=
 =?us-ascii?Q?qa8/C7upRVySLWtwHbiakFVIDpeU2xr6eat1UeI2fCW8Ziq8q71RzD3+BV39?=
 =?us-ascii?Q?J0Lp6jOoiE3XCfCFl2Qtu3HJrhFM/UJcEnBwVhlvPxY2w3Whs+WnpDqzuET/?=
 =?us-ascii?Q?UfFWKXtXUSU7Gcd9lj2KmjDRRH9lXgIohrvcRT8gtP81Zta4gsRS4GGmjjhg?=
 =?us-ascii?Q?00p2+vHyNiQfWDarjA9VC0feEPUuTTPu7LMcrw+zUF9PqPhGNxr26WTrPwJt?=
 =?us-ascii?Q?tBYWA2K/yZMRygN/dZkO36SvZzx0Jm/2OBrk3JtYQuu3IFLbOwcgXPQeLzvr?=
 =?us-ascii?Q?JkW+jMYGnbvxL9t+uww4DYJDOO2xgdzKgBTlNllWL+V0fOoaMNktxslHs6Gq?=
 =?us-ascii?Q?ainZpWtE1ZXkGsNHGp7YhhXPK8AXIBqYEDFZrpz5bNszxQHmqh7xVETYtWnY?=
 =?us-ascii?Q?7KmwrWv4ZgeGM2dfP98vCxP6cjigLaazgzErQCqjD2f4NDjI6+nYmrFaHRde?=
 =?us-ascii?Q?j9pPsJpcnmhmIJzSotJ7Zmoaydycs2bXCGM6CgoQKTrLuyjGMEu4wPrswWQI?=
 =?us-ascii?Q?wTYTR/aZFHjz7QrQ10Xm8mjnjEUtvS5wNz/e7Ayhwj+n+URnJTKYOo+Zj5ve?=
 =?us-ascii?Q?MaxFRjF/8KXaM01sJuKG3LeruVZUF6rySotFN3oEwbnA0Kj9BbaVpxX95iEk?=
 =?us-ascii?Q?x5EjIZsQizQDg/Hfrlow7ICqDyrYXswyNVzcd+ZDAhsv2//UkxtdMhbzKiIe?=
 =?us-ascii?Q?7dliSCGDTg9/ii5IQTpsNYPUKXHU3Iup6+gXj3wxfzqtthFIvogvNisxvVdA?=
 =?us-ascii?Q?cXL71bfwDr0qlfHDn8elMomkexVOaeC6TPCDd2m1YrBgBH56t4vE+UarhItE?=
 =?us-ascii?Q?EFgjciyTlQDCZVLKJH0+Ntf8kET6gOqvI54m4XOh?=
X-OriginatorOrg: synaptics.com
X-MS-Exchange-CrossTenant-Network-Message-Id: e04e6ce0-e267-4ee3-e85f-08daba9af014
X-MS-Exchange-CrossTenant-AuthSource: DM6PR03MB5196.namprd03.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 30 Oct 2022 17:19:44.5716
 (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: eqM+jJzXE3fI+SiFAnEnYC4xInLeTJcGZ34/DoRLjdKjUMQHCBfkhrwaOU/wI0VsV9KJ/7/CgIT1zBq9w7O9HQ==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: CH0PR03MB6113
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: Randy Li <ayaka@soulik.info>

The pixel formats used in Synpatics video smart platform
are too many. It is impossible to store them in fourcc
namespace.

Signed-off-by: Randy Li <ayaka@soulik.info>
---
 .../media/v4l/pixfmt-synaptics.rst            | 80 +++++++++++++++++++
 .../userspace-api/media/v4l/pixfmt.rst        |  1 +
 2 files changed, 81 insertions(+)
 create mode 100644 Documentation/userspace-api/media/v4l/pixfmt-synaptics.rst

diff --git a/Documentation/userspace-api/media/v4l/pixfmt-synaptics.rst b/Documentation/userspace-api/media/v4l/pixfmt-synaptics.rst
new file mode 100644
index 000000000000..bc86737febb7
--- /dev/null
+++ b/Documentation/userspace-api/media/v4l/pixfmt-synaptics.rst
@@ -0,0 +1,80 @@
+.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
+
+.. _pixfmt-synaptics:
+
+***************************
+Synaptics Pixel Format Modifiers
+***************************
+
+The tiled pixel formats in synpatics video smart platform have
+many variants. Here just list the most widely pixel format modifiers
+here. The value here should be the same as the one defined in the
+``drm_fourcc.h`` file.
+
+.. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.5cm}|
+
+.. raw:: latex
+
+	\small
+
+.. _reserved-formats:
+
+.. flat-table:: Synpatics Image Format Modifiers
+	:header-rows:  1
+	:stub-columns: 0
+	:widths:	   3 1 4
+
+	* - Identifier
+	  - Code
+	  - Details
+	* .. _V4L2-PIX-FMT-MOD-SYNA-V4H1:
+
+	  - ``V4L2_PIX_FMT_MOD_SYNA_V4H1``
+	  - '0x0b00000000000101'
+	  - The plain uncompressed 8bits tile format. It sounds similar to
+	Intel's Y-tile. but it won't take any pixel from the next X direction
+	in a tile group. The line stride and image height must be aligned to
+	a multiple of 16. The height of chrominance plane would plus 8.
+	This modifier current would be in conjunction with ``V4L2_PIX_FMT_NV12``
+	or ``V4L2_PIX_FMT_NV12M``.
+	* .. _V4L2-PIX-FMT-MOD-SYNA-V4H3P8:
+
+	  - ``V4L2_PIX_FMT_MOD_SYNA_V4H3P8``
+	  - '0x0b00000000080301'
+	  - The plain uncompressed 10bits tile format. It stores pixel in 2D
+	3x4 tiles with a 8bits padding to each of tiles. Then tile is in a
+	128 bytes cache line. This modifier would be in conjunction with
+	``V4L2_PIX_FMT_NV15``.
+	* .. _V4L2-PIX-FMT-MOD-SYNA-V4H1-64L4C:
+
+	  - ``V4L2_PIX_FMT_MOD_SYNA_V4H1_64L4C``
+	  - '0x0b00000026010101'
+	  - Compressed ``V4L2_PIX_FMT_MOD_SYNA_V4H1``. It stores 64x4 pixels
+	in 1x4 tiles. Each plane would request a meta plane (MTR plane) for
+	decompression. A MTR plane would have a 32 bytes parameters set.
+	* .. _V4L2-PIX-FMT-MOD-SYNA-V4H3P8-64L4C:
+
+	  - ``V4L2_PIX_FMT_MOD_SYNA_V4H3P8_64L4C``
+	  - '0x0b00000026090301'
+	  - Compressed ``V4L2_PIX_FMT_MOD_SYNA_V4H3``. It stores 64x4 pixels
+	in tiles. Each plane would request a meta plane (MTR plane) for
+	decompression. A MTR plane would have a 32 bytes parameters set.
+
+	* .. _V4L2-PIX-FMT-MOD-SYNA-V4H1-128L128C:
+
+	  - ``V4L2_PIX_FMT_MOD_SYNA_V4H1_128L128C``
+	  - '0x0b00000077010101'
+	  - Compressed ``V4L2_PIX_FMT_MOD_SYNA_V4H1``. It stores 128x128 pixels
+	in 1x4 tiles. Each plane would request a meta plane (MTR plane) for
+	decompression. A MTR plane would have a 32 bytes parameters set.
+	* .. _V4L2-PIX-FMT-MOD-SYNA-V4H3P8-128L128C:
+
+	  - ``V4L2_PIX_FMT_MOD_SYNA_V4H3P8_128L128C``
+	  - '0x0b00000077090301'
+	  - Compressed ``V4L2_PIX_FMT_MOD_SYNA_V4H3``. It stores 128x128 pixels
+	in tiles. Each plane would request a meta plane (MTR plane) for
+	decompression. A MTR plane would have a 32 bytes parameters set.
+
+.. raw:: latex
+
+	\normalsize
diff --git a/Documentation/userspace-api/media/v4l/pixfmt.rst b/Documentation/userspace-api/media/v4l/pixfmt.rst
index 11dab4a90630..bfe4fdb52b6b 100644
--- a/Documentation/userspace-api/media/v4l/pixfmt.rst
+++ b/Documentation/userspace-api/media/v4l/pixfmt.rst
@@ -36,3 +36,4 @@ see also :ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>`.)
     colorspaces
     colorspaces-defs
     colorspaces-details
+	pixfmt-synaptics 
-- 
2.17.1