Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
From:   Liu Ying <victor.liu@nxp.com>
To:     dri-devel@lists.freedesktop.org, linux-kernel@vger.kernel.org,
        linux-phy@lists.infradead.org,
        linux-arm-kernel@lists.infradead.org,
        linux-amlogic@lists.infradead.org,
        linux-rockchip@lists.infradead.org
Cc:     linux-imx@nxp.com, Andrzej Hajda <andrzej.hajda@intel.com>,
        Neil Armstrong <narmstrong@baylibre.com>,
        Robert Foss <robert.foss@linaro.org>,
        Laurent Pinchart <Laurent.pinchart@ideasonboard.com>,
        Jonas Karlman <jonas@kwiboo.se>,
        Jernej Skrabec <jernej.skrabec@gmail.com>,
        David Airlie <airlied@linux.ie>,
        Daniel Vetter <daniel@ffwll.ch>,
        Kishon Vijay Abraham I <kishon@ti.com>,
        Vinod Koul <vkoul@kernel.org>,
        Kevin Hilman <khilman@baylibre.com>,
        Jerome Brunet <jbrunet@baylibre.com>,
        Martin Blumenstingl <martin.blumenstingl@googlemail.com>,
        Heiko Stuebner <heiko@sntech.de>,
        Maxime Ripard <mripard@kernel.org>,
        =?UTF-8?q?Guido=20G=C3=BCnther?= <agx@sigxcpu.org>
Subject: [PATCH v2] phy: dphy: Correct clk_pre parameter
Date:   Wed, 19 Jan 2022 10:37:14 +0800
Message-Id: <20220119023714.1498508-1-victor.liu@nxp.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?Kzd3aGdkZHVNbUMzSzd1RGZsQk1HdzdNZVJuMThqTjJSanBJeURncFpCdklB?=
 =?utf-8?B?WGpMbjhuTTI5NVV2NlNWNTIzVkJUMUZQQ2pmeWczakRRaTdabURSakloSnZF?=
 =?utf-8?B?VkUxMVpubFlhU2ZjN2RXaFNDNUd1OEprVHlhMm5tc2xEanFFMWhHRzJSbmhi?=
 =?utf-8?B?Y1JwMTFYRS9PSUFOMW9wN0ZDS3RnWlQzLzlSbXBDKys2OFZkL1ZZK0RQcmUz?=
 =?utf-8?B?MjV6dEpPK05SenFZVmRJejBtZ3JLcGdSamRMMGU4cENOV1hIUXBWSjJJc3BG?=
 =?utf-8?B?Z1A2RmFsZlZXa0h3SVJzMllzVWM5cW5naWhUWTIzUCtxUVVMemNydFZVdVFE?=
 =?utf-8?B?QnAwbmNwSVEvaVVFQnZTRnJtdXAwclZVWlpid3NaRzRXTDluTlAxcW9oRUpv?=
 =?utf-8?B?dGxIUWNzdUJjbmhLZVRCNE5KdlBVYjRwLzNZVnRqN3ZkMC9hRmM1U09YeGox?=
 =?utf-8?B?Ty94VXAvSnVkTWY2bnVDUXFEYU1kejBUQm9RL0VtSFhSLzByc2pmRS9vVmV1?=
 =?utf-8?B?S3FleUhqTS9WOHUzUU5KSkg3ZFVZYmJVSEdxK2pQNDNrQjF6clJUeDhubWlZ?=
 =?utf-8?B?N2xIZ1FFRW1VVCtURlNveUF4U2l1WE55RDdqS0h5UVRRVFlzRk5EMHlrblFQ?=
 =?utf-8?B?dlB0RkxTKzBzaVFBYU02ZEVld1d3ZWR6SS82N2c5SlVsekl5U281enJCMTRI?=
 =?utf-8?B?QkpURXpwdmpmN3JhaTJjN1l0R3l5L1FIWWpLdDVjTmVxSU4wWldpQjdSRmxv?=
 =?utf-8?B?Z2pnUjd2cTZDYTcyUXkyWWcwdFJSUG1FQUhySXdUNVptZlYxZXZGTnd2L1ZI?=
 =?utf-8?B?eU1WYklxTlVUUEh6Nkw0RFhpcnRzK0FERVEyVm5vZ3lnbXRmZ1A3Z1hNRThq?=
 =?utf-8?B?VVNmNnhkeFBQSEE2RTk0aVExWkpJMWNYWEp5c3RKdVlFdVNwdUZ2eVA4UmxI?=
 =?utf-8?B?a1NhNWJzWC9nNlNUWEI0QmtHS0xRcElObSt4Y1BqVkhSMzUzZE5CRXRIQ3Zv?=
 =?utf-8?B?N0ZvbkpwZnFxb01kbTZ0N0lIZnVkcVZwWSt6VndLbm9vcnBoeHdzbjFyVXBF?=
 =?utf-8?B?UU1aRW9EazBmelJkUy92Snc3d2dQK2NLclFaK0cvTUVEOElTblppLzZmS2Iz?=
 =?utf-8?B?cVdhNDVoWkNabUFmQVdHU3NyQngwdHkvcSt5c3ZxRy9hREZvMFl6MlJlWmlO?=
 =?utf-8?B?a05IM2F1T004ZXhpcGlib1ZSdExJVGM3YVcvd0JKbm1QUG45YlA5TlpnbDBE?=
 =?utf-8?B?MHFjN2grMUg4aHZTMUZodGlWTzNROEJybW50QWVKdFRwaTBCeXA4N3NxUDVn?=
 =?utf-8?B?bVRHNUpESVlaOXFZaTZPVnJIekM1UVR3bjlTZnE5RHN5WHB5R2M1QnNBQnBl?=
 =?utf-8?B?YmtSTitUeWwyZkVRWm84QmFzV3lLOWJpN0dtNXNSZmNpalN1Z0s4N3prT1RB?=
 =?utf-8?B?Wlo1bFIzWXl4S2ZxRFFxZVVqVE5QeGw4aDh4Z2cxTWM3MjdhNXZLWmdEcUZo?=
 =?utf-8?B?Yng2MndtL0FiWTJhNFlrRVlYNktTcWZVdU02RlphVk4xV2hFMHJ5VkpsUTlC?=
 =?utf-8?B?Q2ljN1hVQVphNWhuK2F3TkdqdkxldXdNR2JOUnVPM1RzM3JCbU1WQnFJZGZG?=
 =?utf-8?B?dk5EK2xHTWIzL1VEaU9Qdy9mS3VnRk5sQTBqc3A3RVJiTTN2NVZpM1NrM1BP?=
 =?utf-8?B?ZGkwT1BhOElkaWFqS0Nkamp2K1JuSmF5TkkvRnRvQ0ltMVlyTzFkemVMY1di?=
 =?utf-8?B?NFNOQmNjRFFZd1VuUmZOQ1kyRXFjYWd1K2EraFZkUTV5SzFwQ1JNVnFwYUpx?=
 =?utf-8?B?U21xUkxadTRwWDFTTWo1Mkg3NDFRNUpzdjZJU2FiUkJnb3I3VnA0L0k4Z0xJ?=
 =?utf-8?B?ZlA2MFEzd3NBdklydExWVisxaUhraWVpRmJuTndXTFlRVUtxQVBRWkVrUnJU?=
 =?utf-8?B?ZUxER2EvTmNoUzN0MnloRWR4ZVcwRkVZd05EWU5oYXZSVFRWbG1lQnROSGJK?=
 =?utf-8?B?RDZ5WjQ0ZFJDV1pEVHRrSy94eEFuNW11eHdUdXdoMzlYRklnUVdhTTB4di9i?=
 =?utf-8?B?cUJFU2N5UWdYNzhDTHJwa0F4N3FUTmtwb2RPZzBST01EUDBnREQwcVAyN3Y1?=
 =?utf-8?B?czZCWWpiZVVsdVBzaDZyYVFNUFNhWXN4R3B4TmN0eE81eXU5WEhpU2FVempF?=
 =?utf-8?Q?JLS3wQ9+HeDfX45OA3oIVCw=3D?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 5bb769a4-2ab6-4f02-ebee-08d9daf4ba81
X-MS-Exchange-CrossTenant-AuthSource: AM7PR04MB7046.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 19 Jan 2022 02:38:08.8868
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 686ea1d3-bc2b-4c6f-a92c-d99c5c301635
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: stLubDZYpPueqJF6FzsG4jPwFnyBBjeKvxv40o50IKLdq5mjE9K4tB6cLmRfQr2MROlhm9RxfjuuDRRvjxG0bQ==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: AM6PR04MB5543
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

The D-PHY specification (v1.2) explicitly mentions that the T-CLK-PRE
parameter's unit is Unit Interval(UI) and the minimum value is 8.  Also,
kernel doc of the 'clk_pre' member of struct phy_configure_opts_mipi_dphy
mentions that it should be in UI.  However, the dphy core driver wrongly
sets 'clk_pre' to 8000, which seems to hint that it's in picoseconds.
And, the kernel doc of the 'clk_pre' member wrongly says the minimum value
is '8 UI', instead of 8.

So, let's fix both the dphy core driver and the kernel doc of the 'clk_pre'
member to correctly reflect the T-CLK-PRE parameter's unit and the minimum
value according to the D-PHY specification.

I'm assuming that all impacted custom drivers shall program values in
TxByteClkHS cycles into hardware for the T-CLK-PRE parameter.  The D-PHY
specification mentions that the frequency of TxByteClkHS is exactly 1/8
the High-Speed(HS) bit rate(each HS bit consumes one UI).  So, relevant
custom driver code is changed to program those values as
DIV_ROUND_UP(cfg->clk_pre, BITS_PER_BYTE), then.

Note that I've only tested the patch with RM67191 DSI panel on i.MX8mq EVK.
Help is needed to test with other i.MX8mq, Meson and Rockchip platforms,
as I don't have the hardwares.

Fixes: 2ed869990e14 ("phy: Add MIPI D-PHY configuration options")
Cc: Andrzej Hajda <andrzej.hajda@intel.com>
Cc: Neil Armstrong <narmstrong@baylibre.com>
Cc: Robert Foss <robert.foss@linaro.org>
Cc: Laurent Pinchart <Laurent.pinchart@ideasonboard.com>
Cc: Jonas Karlman <jonas@kwiboo.se>
Cc: Jernej Skrabec <jernej.skrabec@gmail.com>
Cc: David Airlie <airlied@linux.ie>
Cc: Daniel Vetter <daniel@ffwll.ch>
Cc: Kishon Vijay Abraham I <kishon@ti.com>
Cc: Vinod Koul <vkoul@kernel.org>
Cc: Kevin Hilman <khilman@baylibre.com>
Cc: Jerome Brunet <jbrunet@baylibre.com>
Cc: Martin Blumenstingl <martin.blumenstingl@googlemail.com>
Cc: Heiko Stuebner <heiko@sntech.de>
Cc: Maxime Ripard <mripard@kernel.org>
Cc: Guido Günther <agx@sigxcpu.org>
Tested-by: Liu Ying <victor.liu@nxp.com> # RM67191 DSI panel on i.MX8mq EVK
Signed-off-by: Liu Ying <victor.liu@nxp.com>
---
v1->v2:
* Use BITS_PER_BYTE macro. (Andrzej)
* Drop dsi argument from ui2bc() in nwl-dsi.c.

 drivers/gpu/drm/bridge/nwl-dsi.c                 | 12 +++++-------
 drivers/phy/amlogic/phy-meson-axg-mipi-dphy.c    |  3 ++-
 drivers/phy/phy-core-mipi-dphy.c                 |  4 ++--
 drivers/phy/rockchip/phy-rockchip-inno-dsidphy.c |  3 ++-
 include/linux/phy/phy-mipi-dphy.h                |  2 +-
 5 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/drivers/gpu/drm/bridge/nwl-dsi.c b/drivers/gpu/drm/bridge/nwl-dsi.c
index a7389a0facfb..af07eeb47ca0 100644
--- a/drivers/gpu/drm/bridge/nwl-dsi.c
+++ b/drivers/gpu/drm/bridge/nwl-dsi.c
@@ -7,6 +7,7 @@
  */
 
 #include <linux/bitfield.h>
+#include <linux/bits.h>
 #include <linux/clk.h>
 #include <linux/irq.h>
 #include <linux/math64.h>
@@ -196,12 +197,9 @@ static u32 ps2bc(struct nwl_dsi *dsi, unsigned long long ps)
 /*
  * ui2bc - UI time periods to byte clock cycles
  */
-static u32 ui2bc(struct nwl_dsi *dsi, unsigned long long ui)
+static u32 ui2bc(unsigned int ui)
 {
-	u32 bpp = mipi_dsi_pixel_format_to_bpp(dsi->format);
-
-	return DIV64_U64_ROUND_UP(ui * dsi->lanes,
-				  dsi->mode.clock * 1000 * bpp);
+	return DIV_ROUND_UP(ui, BITS_PER_BYTE);
 }
 
 /*
@@ -232,12 +230,12 @@ static int nwl_dsi_config_host(struct nwl_dsi *dsi)
 	}
 
 	/* values in byte clock cycles */
-	cycles = ui2bc(dsi, cfg->clk_pre);
+	cycles = ui2bc(cfg->clk_pre);
 	DRM_DEV_DEBUG_DRIVER(dsi->dev, "cfg_t_pre: 0x%x\n", cycles);
 	nwl_dsi_write(dsi, NWL_DSI_CFG_T_PRE, cycles);
 	cycles = ps2bc(dsi, cfg->lpx + cfg->clk_prepare + cfg->clk_zero);
 	DRM_DEV_DEBUG_DRIVER(dsi->dev, "cfg_tx_gap (pre): 0x%x\n", cycles);
-	cycles += ui2bc(dsi, cfg->clk_pre);
+	cycles += ui2bc(cfg->clk_pre);
 	DRM_DEV_DEBUG_DRIVER(dsi->dev, "cfg_t_post: 0x%x\n", cycles);
 	nwl_dsi_write(dsi, NWL_DSI_CFG_T_POST, cycles);
 	cycles = ps2bc(dsi, cfg->hs_exit);
diff --git a/drivers/phy/amlogic/phy-meson-axg-mipi-dphy.c b/drivers/phy/amlogic/phy-meson-axg-mipi-dphy.c
index cd2332bf0e31..fdbd64c03e12 100644
--- a/drivers/phy/amlogic/phy-meson-axg-mipi-dphy.c
+++ b/drivers/phy/amlogic/phy-meson-axg-mipi-dphy.c
@@ -9,6 +9,7 @@
 
 #include <linux/bitfield.h>
 #include <linux/bitops.h>
+#include <linux/bits.h>
 #include <linux/clk.h>
 #include <linux/delay.h>
 #include <linux/io.h>
@@ -250,7 +251,7 @@ static int phy_meson_axg_mipi_dphy_power_on(struct phy *phy)
 		     (DIV_ROUND_UP(priv->config.clk_zero, temp) << 16) |
 		     (DIV_ROUND_UP(priv->config.clk_prepare, temp) << 24));
 	regmap_write(priv->regmap, MIPI_DSI_CLK_TIM1,
-		     DIV_ROUND_UP(priv->config.clk_pre, temp));
+		     DIV_ROUND_UP(priv->config.clk_pre, BITS_PER_BYTE));
 
 	regmap_write(priv->regmap, MIPI_DSI_HS_TIM,
 		     DIV_ROUND_UP(priv->config.hs_exit, temp) |
diff --git a/drivers/phy/phy-core-mipi-dphy.c b/drivers/phy/phy-core-mipi-dphy.c
index 288c9c67aa74..ccb4045685cd 100644
--- a/drivers/phy/phy-core-mipi-dphy.c
+++ b/drivers/phy/phy-core-mipi-dphy.c
@@ -36,7 +36,7 @@ int phy_mipi_dphy_get_default_config(unsigned long pixel_clock,
 
 	cfg->clk_miss = 0;
 	cfg->clk_post = 60000 + 52 * ui;
-	cfg->clk_pre = 8000;
+	cfg->clk_pre = 8;
 	cfg->clk_prepare = 38000;
 	cfg->clk_settle = 95000;
 	cfg->clk_term_en = 0;
@@ -97,7 +97,7 @@ int phy_mipi_dphy_config_validate(struct phy_configure_opts_mipi_dphy *cfg)
 	if (cfg->clk_post < (60000 + 52 * ui))
 		return -EINVAL;
 
-	if (cfg->clk_pre < 8000)
+	if (cfg->clk_pre < 8)
 		return -EINVAL;
 
 	if (cfg->clk_prepare < 38000 || cfg->clk_prepare > 95000)
diff --git a/drivers/phy/rockchip/phy-rockchip-inno-dsidphy.c b/drivers/phy/rockchip/phy-rockchip-inno-dsidphy.c
index 347dc79a18c1..630e01b5c19b 100644
--- a/drivers/phy/rockchip/phy-rockchip-inno-dsidphy.c
+++ b/drivers/phy/rockchip/phy-rockchip-inno-dsidphy.c
@@ -5,6 +5,7 @@
  * Author: Wyon Bi <bivvy.bi@rock-chips.com>
  */
 
+#include <linux/bits.h>
 #include <linux/kernel.h>
 #include <linux/clk.h>
 #include <linux/iopoll.h>
@@ -364,7 +365,7 @@ static void inno_dsidphy_mipi_mode_enable(struct inno_dsidphy *inno)
 	 * The value of counter for HS Tclk-pre
 	 * Tclk-pre = Tpin_txbyteclkhs * value
 	 */
-	clk_pre = DIV_ROUND_UP(cfg->clk_pre, t_txbyteclkhs);
+	clk_pre = DIV_ROUND_UP(cfg->clk_pre, BITS_PER_BYTE);
 
 	/*
 	 * The value of counter for HS Tlpx Time
diff --git a/include/linux/phy/phy-mipi-dphy.h b/include/linux/phy/phy-mipi-dphy.h
index a877ffee845d..59a5e77ab409 100644
--- a/include/linux/phy/phy-mipi-dphy.h
+++ b/include/linux/phy/phy-mipi-dphy.h
@@ -42,7 +42,7 @@ struct phy_configure_opts_mipi_dphy {
 	 * the transmitter prior to any associated Data Lane beginning
 	 * the transition from LP to HS mode.
 	 *
-	 * Minimum value: 8 UI
+	 * Minimum value: 8
 	 */
 	unsigned int		clk_pre;
 
-- 
2.25.1