Skip to contentSkip to conversation

SPI core CS delay fixes and additions

PATCH In review Hector Martin 4 participants 10 messages Jan 13, 2023 – Feb 16, 2023

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

v2 cover SPI core CS delay fixes and additions

Commits f6c911f3308c ("spi: dt-bindings: Introduce spi-cs-setup-ns property") and 33a2fde5f77b ("spi: Introduce spi-cs-setup-ns property") introduced a new property to represent the CS setup delay in the device tree, but they have some issues:

- The property is only parsed as a 16-bit integer number of nanoseconds, which limits the maximum value to ~65us. This is not a reasonable upper limit, as some devices might need a lot more.
- The property name is inconsistent with other delay properties, which use a "*-delay-ns" naming scheme.
- Only the setup delay is introduced, but not the related hold and inactive delay times.

This series fixes the issues and adds support for the two missing properties. Please pull in the first 3 patches as fixes for 6.2, to avoid introducing a problematic DT API in this release. The last two patches can wait until 6.3, though are probably harmless to throw in as fixes too, since they're trivial.

v2: Removed a stray variable declaration that was triggering a warning, and dropped the first two patches which have already been applied.

Janne Grunau (3):
spi: Use a 32-bit DT property for spi-cs-setup-delay-ns
spi: dt-bindings: Add hold/inactive CS delay peripheral properties
spi: Parse hold/inactive CS delay values from the DT

 .../bindings/spi/spi-peripheral-props.yaml    | 10 ++++++++
 drivers/spi/spi.c                             | 25 +++++++++++++++----
 2 files changed, 30 insertions(+), 5 deletions(-)

--
2.35.1

#1 lore raw

PATCH v2 1/3 spi: Use a 32-bit DT property for spi-cs-setup-delay-ns

From: Janne Grunau <[email protected]>

65us is not a reasonable maximum for this property, as some devices might need a much longer setup time (e.g. those driven by firmware on the other end). Plus, device tree property values are in 32-bit cells and smaller widths should not be used without good reason.

Also move the logic to a helper function, since this will later be used to parse other CS delay properties too.

Fixes 33a2fde5f77b ("spi: Introduce spi-cs-setup-ns property")
---
 drivers/spi/spi.c | 23 ++++++++++++++++++-----
 1 file changed, 18 insertions(+), 5 deletions(-)
drivers/spi/spi.c +18 -5
index 15f174f4e056..3f33934f5429 100644
@@ -2220,11 +2220,26 @@ void spi_flush_queue(struct spi_controller *ctlr)
 /*-------------------------------------------------------------------------*/
 
 #if defined(CONFIG_OF)
+static void of_spi_parse_dt_cs_delay(struct device_node *nc,
+				     struct spi_delay *delay, const char *prop)
+{
+	u32 value;
+
+	if (!of_property_read_u32(nc, prop, &value)) {
+		if (value > U16_MAX) {
+			delay->value = DIV_ROUND_UP(value, 1000);
+			delay->unit = SPI_DELAY_UNIT_USECS;
+		} else {
+			delay->value = value;
+			delay->unit = SPI_DELAY_UNIT_NSECS;
+		}
+	}
+}
+
 static int of_spi_parse_dt(struct spi_controller *ctlr, struct spi_device *spi,
 			   struct device_node *nc)
 {
 	u32 value;
-	u16 cs_setup;
 	int rc;
 
 	/* Mode (clock phase/polarity/etc.) */
@@ -2310,10 +2325,8 @@ static int of_spi_parse_dt(struct spi_controller *ctlr, struct spi_device *spi,
 	if (!of_property_read_u32(nc, "spi-max-frequency", &value))
 		spi->max_speed_hz = value;
 
-	if (!of_property_read_u16(nc, "spi-cs-setup-delay-ns", &cs_setup)) {
-		spi->cs_setup.value = cs_setup;
-		spi->cs_setup.unit = SPI_DELAY_UNIT_NSECS;
-	}
+	/* Device CS delays */
+	of_spi_parse_dt_cs_delay(nc, &spi->cs_setup, "spi-cs-setup-delay-ns");
 
 	return 0;
 }
Signature · 1 line
2.35.1
#2 lore raw

PATCH v2 2/3 spi: dt-bindings: Add hold/inactive CS delay peripheral properties

In reply to Hector Martin

From: Janne Grunau <[email protected]>

These two properties complete the bindings for the Linux spi_device cs model, which includes cs_setup, cs_hold and cs_inactive delay values.

---
 .../devicetree/bindings/spi/spi-peripheral-props.yaml  | 10 ++++++++++
 1 file changed, 10 insertions(+)
Documentation/devicetree/bindings/spi/spi-peripheral-props.yaml +10 -0
index 9a60c0664bbe..782a014b63a7 100644
@@ -49,6 +49,16 @@ properties:
       Delay in nanoseconds to be introduced by the controller after CS is
       asserted.
 
+  spi-cs-hold-delay-ns:
+    description:
+      Delay in nanoseconds to be introduced by the controller before CS is
+      de-asserted.
+
+  spi-cs-inactive-delay-ns:
+    description:
+      Delay in nanoseconds to be introduced by the controller after CS is
+      de-asserted.
+
   spi-rx-bus-width:
     description:
       Bus width to the SPI bus used for read transfers.
Signature · 1 line
2.35.1
#3 lore raw

PATCH v2 3/3 spi: Parse hold/inactive CS delay values from the DT

In reply to Hector Martin

From: Janne Grunau <[email protected]>

Now that we support parsing the setup time from the Device Tree, we can also easily support the remaining hold and inactive time delay values.

---
 drivers/spi/spi.c | 2 ++
 1 file changed, 2 insertions(+)
drivers/spi/spi.c +2 -0
index 3f33934f5429..fc4f6308efd8 100644
@@ -2327,6 +2327,8 @@ static int of_spi_parse_dt(struct spi_controller *ctlr, struct spi_device *spi,
 
 	/* Device CS delays */
 	of_spi_parse_dt_cs_delay(nc, &spi->cs_setup, "spi-cs-setup-delay-ns");
+	of_spi_parse_dt_cs_delay(nc, &spi->cs_hold, "spi-cs-hold-delay-ns");
+	of_spi_parse_dt_cs_delay(nc, &spi->cs_inactive, "spi-cs-inactive-delay-ns");
 
 	return 0;
 }
Signature · 1 line
2.35.1
maintainer
#4 lore raw
In reply to Hector Martin
Quoted 13 lines · Hector Martin

Commits f6c911f3308c ("spi: dt-bindings: Introduce spi-cs-setup-ns property") and 33a2fde5f77b ("spi: Introduce spi-cs-setup-ns property") introduced a new property to represent the CS setup delay in the device tree, but they have some issues:

- The property is only parsed as a 16-bit integer number of nanoseconds, which limits the maximum value to ~65us. This is not a reasonable upper limit, as some devices might need a lot more.
- The property name is inconsistent with other delay properties, which use a "*-delay-ns" naming scheme.
- Only the setup delay is introduced, but not the related hold and inactive delay times.

Quoted 1 line

[...]

Applied to

https://git.kernel.org/pub/scm/linux/kernel/git/broonie/spi.git for-next

Thanks!

[1/3] spi: Use a 32-bit DT property for spi-cs-setup-delay-ns

      commit: f276aacf5d2f7fb57e400db44c807ea3b9525fd6
[2/3] spi: dt-bindings: Add hold/inactive CS delay peripheral properties
      commit: 34f89f238c545d4fd0166e37c201d96c10443953
[3/3] spi: Parse hold/inactive CS delay values from the DT
      commit: 5827b31d858e399e0ba9fbd33da7a39b31769e11

All being well this means that it will be integrated into the linux-next tree (usually sometime in the next 24 hours) and sent to Linus during the next merge window (or sooner if it is a bug fix), however if problems are discovered then the patch may be dropped or reverted.

You may get further e-mails resulting from automated or manual testing and review of the tree, please engage with people reporting problems and send followup patches addressing any issues that are reported if needed.

If any updates are required or you are submitting further changes they should be sent as incremental updates against current git, existing patches will not be replaced.

Please add any relevant lists and maintainers to the CCs when replying to this mail.

Thanks,
Mark

#5 lore raw
Quoted 16 lines · Mark Brown
Quoted 13 lines · Hector Martin

Commits f6c911f3308c ("spi: dt-bindings: Introduce spi-cs-setup-ns property") and 33a2fde5f77b ("spi: Introduce spi-cs-setup-ns property") introduced a new property to represent the CS setup delay in the device tree, but they have some issues:

- The property is only parsed as a 16-bit integer number of nanoseconds, which limits the maximum value to ~65us. This is not a reasonable upper limit, as some devices might need a lot more.
- The property name is inconsistent with other delay properties, which use a "*-delay-ns" naming scheme.
- Only the setup delay is introduced, but not the related hold and inactive delay times.

Quoted 1 line

[...]

Quoted 8 lines

Applied to

https://git.kernel.org/pub/scm/linux/kernel/git/broonie/spi.git for-next

Thanks!

[1/3] spi: Use a 32-bit DT property for spi-cs-setup-delay-ns

      commit: f276aacf5d2f7fb57e400db44c807ea3b9525fd6

Hi,

Shouldn't this be sent to 6.2 before the property becomes a stable ABI?

Thanks,
Kazuki

Quoted 1 line
#6 lore raw

Hej Mark,

Quoted 19 lines · Kazuki
Quoted 18 lines · Mark Brown
Quoted 13 lines · Hector Martin

Commits f6c911f3308c ("spi: dt-bindings: Introduce spi-cs-setup-ns property") and 33a2fde5f77b ("spi: Introduce spi-cs-setup-ns property") introduced a new property to represent the CS setup delay in the device tree, but they have some issues:

- The property is only parsed as a 16-bit integer number of nanoseconds, which limits the maximum value to ~65us. This is not a reasonable upper limit, as some devices might need a lot more.
- The property name is inconsistent with other delay properties, which use a "*-delay-ns" naming scheme.
- Only the setup delay is introduced, but not the related hold and inactive delay times.

Quoted 1 line

[...]

Applied to

Quoted 8 lines
Quoted 6 lines

https://git.kernel.org/pub/scm/linux/kernel/git/broonie/spi.git for-next

Thanks!

[1/3] spi: Use a 32-bit DT property for spi-cs-setup-delay-ns

      commit: f276aacf5d2f7fb57e400db44c807ea3b9525fd6

Shouldn't this be sent to 6.2 before the property becomes a stable ABI?

can we still get "spi: Use a 32-bit DT property for spi-cs-setup-delay-ns" into 6.2?

If not I can send a single line patch which switches of_property_read_u16() to of_property_read_u32() to avoid defining "spi-cs-setup-delay-ns" to u16 as stable devicetree ABI.

sorry this comes so late before 6.2, we missed to track the patches.

Thanks,
Janne

maintainer
#7 lore raw
Quoted 2 lines · Janne Grunau

can we still get "spi: Use a 32-bit DT property for spi-cs-setup-delay-ns" into 6.2?

I think I sent a pull request for this already.

#8 lore raw
Quoted 6 lines · Mark Brown
Quoted 2 lines · Janne Grunau

can we still get "spi: Use a 32-bit DT property for spi-cs-setup-delay-ns" into 6.2?

I think I sent a pull request for this already.

I see today's "[GIT PULL] SPI updates for v6.2-rc8-abi"
https://lore.kernel.org/lkml/[email protected]/

but it was neither in "SPI fixes for v6.2-rc3" or "SPI fixes for v6.2-rc7" or in Linus' tree as of today.

I think something went wrong with "[GIT PULL] SPI updates for v6.2-rc8-abi". The message reads is if you intended to just send "spi: Use a 32-bit DT property for spi-cs-setup-delay-ns" and not 62 commits.

Janne

maintainer
#9 lore raw
Quoted 4 lines · Janne Grunau

I think something went wrong with "[GIT PULL] SPI updates for v6.2-rc8-abi". The message reads is if you intended to just send "spi: Use a 32-bit DT property for spi-cs-setup-delay-ns" and not 62 commits.

You're right, thanks for noticing.