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:   Vladimir Oltean <vladimir.oltean@nxp.com>
To:     linux-spi@vger.kernel.org
Cc:     Vladimir Oltean <olteanv@gmail.com>,
        Mark Brown <broonie@kernel.org>, linux-kernel@vger.kernel.org,
        Lisa Chen <minjie.chen@geekplus.com>
Subject: [PATCH] spi: fsl-dspi: avoid SCK glitches with continuous transfers
Date:   Tue, 30 May 2023 01:34:02 +0300
Message-Id: <20230529223402.1199503-1-vladimir.oltean@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?UTlHckVXd05kUm80S0pLSHArcTRGb2c0QVRWSEhHUSt1N2hyR2FkcE1taDJL?=
 =?utf-8?B?SUsxRHh5NWM5UVJxTUM2SlJaSFgxMG9NSkxBL085amVFV1NZbTNGRzNxYllz?=
 =?utf-8?B?OTd2N0x5cWVIbmkxK1orclYxZjNtaCtWam4xZUR4WWJUWnMwdkZWMXZob2NO?=
 =?utf-8?B?ckE4eU5DRkNCVjAzMldvaWduQUxseFRsL3ZsWmMyN1didDBSanhXQnZNRXdC?=
 =?utf-8?B?VE5XK0J5NmZFZ0JLcWJkNTh2b0dTVHhMK1AvWTEzbnJocTZGcUM5WnhjNmlW?=
 =?utf-8?B?cUNRdmZNT2RRZ1FxQmhLTFc3K281MXNIK0o2Yyt6Z3VrbnVTdVZUcUNKaWxI?=
 =?utf-8?B?ZDFqZmh3L3BOUTdRcmNOM1pWc1lGR3FsVURxVWUwT01zSlU5ckJvdW9aU2xK?=
 =?utf-8?B?MUFFTFMyQ2tjYWtaOWhMc0F1QlFlM0RUTTNmaVltZlFLeEZKUHlHRW42S244?=
 =?utf-8?B?eVRtYzVnU3AyNXdWdUNJdXhzbFEwYlVZZEc1Q09VYXNOMXE5N3FaelJxQVVL?=
 =?utf-8?B?TmMvUkZha3ZuVmMzbnRVUlkxVUVjMnIzMGptc0RjemExc2plR2EwZDBkMEFB?=
 =?utf-8?B?dGxoY2FMWjZCbVRlanN6eUhVZnBJWndrRDAxOFdtd0E0NHlHSWRXcFNIVEg1?=
 =?utf-8?B?N1BvY1BMMHFWRGtwRzUzcERCZ0N6dFErRnIySzNYbHh5dHg0UkxpaFFWWHNR?=
 =?utf-8?B?UzdZMmpnR3FpR2JjSGJ3eHVhbzVEMVJtdElFeDB2eXo2Rk1UdHJaR2hFUmsv?=
 =?utf-8?B?SHpOZk5BUGhlcjBjeW9ML2t2aGp5WWpOVm9XSzNybk5WSnk5WTExV3V6SEtz?=
 =?utf-8?B?bnhoL3ZzRXAzV3dnR2VsNE13TFFQbWNuZC9DWGpnYnN3VkV1bTBYbUhPd25I?=
 =?utf-8?B?NytLN0JiY3BnOTlMb1FCL0NtNWxveE5jdFdhakJ6R2xsSENFOU1OY2JQMlAw?=
 =?utf-8?B?RnlWdXNBZmR6UktCMDh4OC9vTWI4NjZ3UG95emlqd2swS3RwRk9JVlF3NE0w?=
 =?utf-8?B?KzJjdXg2ajh6enBHeEEwUG1PSjE5aElmRlUxaXhkR2I3dUx2emNpSWJZa1I0?=
 =?utf-8?B?a0k4TjlLTnZDUytuREVIUEF6L24vSFJ1MkVHL1A3bEVKeUZ2UTFFdnlUaFlV?=
 =?utf-8?B?U2FmMlcxd3BKWFdDdElaLzFubkdhUFlZZUNkQ2lhYzNodE9DOVFHZm5BVkRm?=
 =?utf-8?B?dGMzVGN4ME1CREFzRlJ5R0ZHTlNudWJiVG1lMWNMNmdnVnBqWHJkNk9XKzF6?=
 =?utf-8?B?ZjJMK01GNjRMT2pkKzJnODhhSDhQaHFVWUQ0dkFibnVROVR6OFpWUW9FUEFD?=
 =?utf-8?B?VkVwZUJIdEU3Um0xemZqeWpkRytyeDJNbkVuQmR3NHBhRGh0YVo5OHU4WVBm?=
 =?utf-8?B?K051enlUb2crNzhZOVo3Z3V4VXY5bjVSaS8rdmxGS0hWZXV3RHBjb1FadWto?=
 =?utf-8?B?YmlySUo1ekRXSkJGRnFlV3JaKzRscGdXNVZ5eXJLd1RUa0hOZVVhZDZXSVll?=
 =?utf-8?B?dXNKLytsNmROMkFjcm9TNXhwZy9mdHk2OUh0WW53UzNmTWs2Zm1DNW5GanhM?=
 =?utf-8?B?cnIxSThVWFdmeHV1ZzRYZlJwRy91WEpaalFzcjJ3b0Vaenk3ejZlKzVNdGpL?=
 =?utf-8?B?WTBScHlxcFR5Qkl1MnBvSVViRjhrY3BRS1ExMVI2VVJkL0F3d2pKT21EMEgw?=
 =?utf-8?B?M2J4MXZIL1FyTHkyMG9KK3hDc1ZwSEVhNHJhM3M1Z3pVdDFWNzdYM3hwZXlF?=
 =?utf-8?B?SUs1ZlQ3L2JLOXBlUG41WjRBam1TSnpma09rbEdFQnZLOEtaMlgrNFFBM1dY?=
 =?utf-8?B?ejNwejB3TW9qU1JwM1BrRW9WcFRmc216WndWNXZBV1ZxLy9NTU5JVzhFZyto?=
 =?utf-8?B?amZVb1dlS1o3ZGlSK1haMjQyS3kvbkJ5MGkrRDZLWm9aMUt2cTNSendNUit1?=
 =?utf-8?B?TW40dUd3SitwakhSUEVYakU4cC9GZ0NEM2w1Z2VoYzExVGQ4QXZrKzJqZlBm?=
 =?utf-8?B?M204UFhpckt3Y0g2WFJhMlB4NnhUY2pBdDNwakF5aTJoL1lmendadDdXL01S?=
 =?utf-8?B?c0dRbHNIQ252dXQ5SXc0YmtxalNiNEYvbmV5N0ZuT0tKU04rQWJkcTVUOGJF?=
 =?utf-8?B?NHBMN1FobzFxUGhmSm1KUi9uaFBhd1huZ0JUZngvTHdlZXNkVjNpTnJmWGli?=
 =?utf-8?B?Ymc9PQ==?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 6ca219f3-6025-4b86-f576-08db6094d8c2
X-MS-Exchange-CrossTenant-AuthSource: AM0PR04MB6452.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 29 May 2023 22:34:21.3431
 (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: 4Lx+eb0S3PemfRc2LGILX+3mCS2qYes0fvaFBZ47IJ6s8Y2CqNHIrMbtZhgSYzyldE426lIo8EasrBgpry8KUg==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DBBPR04MB7802
X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,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

The DSPI controller has configurable timing for

(a) tCSC: the interval between the assertion of the chip select and the
    first clock edge

(b) tASC: the interval between the last clock edge and the deassertion
    of the chip select

What is a bit surprising, but is documented in the figure "Example of
continuous transfer (CPHA=1, CONT=1)" in the datasheet, is that when the
chip select stays asserted between multiple TX FIFO writes, the tCSC and
tASC times still apply. With CONT=1, chip select remains asserted, but
SCK takes a break and goes to the idle state for tASC + tCSC ns.

In other words, the default values (of 0 and 0 ns) result in SCK
glitches where the SCK transition to the idle state, as well as the SCK
transition from the idle state, will have no delay in between, and it
may appear that a SCK cycle has simply gone missing. The resulting
timing violation might cause data corruption in many peripherals, as
their chip select is asserted.

The driver has device tree bindings for tCSC ("fsl,spi-cs-sck-delay")
and tASC ("fsl,spi-sck-cs-delay"), but these are only specified to apply
when the chip select toggles in the first place, and this timing
characteristic depends on each peripheral. Many peripherals do not have
explicit timing requirements, so many device trees do not have these
properties present at all.

Nonetheless, the lack of SCK glitches is a common sense requirement, and
since the SCK stays in the idle state during transfers for tCSC+tASC ns,
and that in itself should look like half a cycle, then let's ensure that
tCSC and tASC are at least a quarter of a SCK period, such that their
sum is at least half of one.

Fixes: 95bf15f38641 ("spi: fsl-dspi: Add ~50ns delay between cs and sck")
Reported-by: Lisa Chen (陈敏捷) <minjie.chen@geekplus.com>
Debugged-by: Lisa Chen (陈敏捷) <minjie.chen@geekplus.com>
Tested-by: Lisa Chen (陈敏捷) <minjie.chen@geekplus.com>
Signed-off-by: Vladimir Oltean <vladimir.oltean@nxp.com>
---
 drivers/spi/spi-fsl-dspi.c | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/drivers/spi/spi-fsl-dspi.c b/drivers/spi/spi-fsl-dspi.c
index 4339485d202c..674cfe05f411 100644
--- a/drivers/spi/spi-fsl-dspi.c
+++ b/drivers/spi/spi-fsl-dspi.c
@@ -1002,7 +1002,9 @@ static int dspi_transfer_one_message(struct spi_controller *ctlr,
 static int dspi_setup(struct spi_device *spi)
 {
 	struct fsl_dspi *dspi = spi_controller_get_devdata(spi->controller);
+	u32 period_ns = DIV_ROUND_UP(NSEC_PER_SEC, spi->max_speed_hz);
 	unsigned char br = 0, pbr = 0, pcssck = 0, cssck = 0;
+	u32 quarter_period_ns = DIV_ROUND_UP(period_ns, 4);
 	u32 cs_sck_delay = 0, sck_cs_delay = 0;
 	struct fsl_dspi_platform_data *pdata;
 	unsigned char pasc = 0, asc = 0;
@@ -1031,6 +1033,19 @@ static int dspi_setup(struct spi_device *spi)
 		sck_cs_delay = pdata->sck_cs_delay;
 	}
 
+	/* Since tCSC and tASC apply to continuous transfers too, avoid SCK
+	 * glitches of half a cycle by never allowing tCSC + tASC to go below
+	 * half a SCK period.
+	 */
+	if (cs_sck_delay < quarter_period_ns)
+		cs_sck_delay = quarter_period_ns;
+	if (sck_cs_delay < quarter_period_ns)
+		sck_cs_delay = quarter_period_ns;
+
+	dev_dbg(&spi->dev,
+		"DSPI controller timing params: CS-to-SCK delay %u ns, SCK-to-CS delay %u ns\n",
+		cs_sck_delay, sck_cs_delay);
+
 	clkrate = clk_get_rate(dspi->clk);
 	hz_to_spi_baud(&pbr, &br, spi->max_speed_hz, clkrate);
 
-- 
2.34.1