Skip to contentSkip to conversation

gpio: ts4900: Do not set DAT and OE together

PATCH Superseded Kris Bahnsen 3 participants 4 messages Mar 8, 2022 – Mar 10, 2022 GPIO

v2 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 gpio: ts4900: Do not set DAT and OE together

From: Mark Featherston <[email protected]>

This works around an issue with the hardware where both OE and DAT are exposed in the same register. If both are updated simultaneously, the harware makes no guarantees that OE or DAT will actually change in any given order and may result in a glitch of a few ns on a GPIO pin when changing direction and value in a single write.

Setting direction to input now only affects OE bit. Setting direction to output updates DAT first, then OE.

Fixes 9c6686322d74 ("gpio: add Technologic I2C-FPGA gpio support")

---
V1 -> V2: Add Fixes tag

 drivers/gpio/gpio-ts4900.c | 25 ++++++++++++++++++++-----
 1 file changed, 20 insertions(+), 5 deletions(-)
drivers/gpio/gpio-ts4900.c +20 -5
index d885032cf814..fbabfca030c0 100644
@@ -1,7 +1,8 @@
+// SPDX-License-Identifier: GPL-2.0
 /*
  * Digital I/O driver for Technologic Systems I2C FPGA Core
  *
- * Copyright (C) 2015 Technologic Systems
+ * Copyright (C) 2015-2018 Technologic Systems
  * Copyright (C) 2016 Savoir-Faire Linux
  *
  * This program is free software; you can redistribute it and/or
@@ -55,19 +56,33 @@ static int ts4900_gpio_direction_input(struct gpio_chip *chip,
 {
 	struct ts4900_gpio_priv *priv = gpiochip_get_data(chip);
 
-	/*
-	 * This will clear the output enable bit, the other bits are
-	 * dontcare when this is cleared
+	/* Only clear the OE bit here, requires a RMW. Prevents potential issue
+	 * with OE and data getting to the physical pin at different times.
 	 */
-	return regmap_write(priv->regmap, offset, 0);
+	return regmap_update_bits(priv->regmap, offset, TS4900_GPIO_OE, 0);
 }
 
 static int ts4900_gpio_direction_output(struct gpio_chip *chip,
 					unsigned int offset, int value)
 {
 	struct ts4900_gpio_priv *priv = gpiochip_get_data(chip);
+	unsigned int reg;
 	int ret;
 
+	/* If changing from an input to an output, we need to first set the
+	 * proper data bit to what is requested and then set OE bit. This
+	 * prevents a glitch that can occur on the IO line
+	 */
+	regmap_read(priv->regmap, offset, &reg);
+	if (!(reg & TS4900_GPIO_OE)) {
+		if (value)
+			reg = TS4900_GPIO_OUT;
+		else
+			reg &= ~TS4900_GPIO_OUT;
+
+		regmap_write(priv->regmap, offset, reg);
+	}
+
 	if (value)
 		ret = regmap_write(priv->regmap, offset, TS4900_GPIO_OE |
 							 TS4900_GPIO_OUT);
Signature · 1 line
2.11.0
#1 lore raw
Quoted 28 lines · Kris Bahnsen

From: Mark Featherston <[email protected]>

This works around an issue with the hardware where both OE and DAT are exposed in the same register. If both are updated simultaneously, the harware makes no guarantees that OE or DAT will actually change in any given order and may result in a glitch of a few ns on a GPIO pin when changing direction and value in a single write.

Setting direction to input now only affects OE bit. Setting direction to output updates DAT first, then OE.

Fixes 9c6686322d74 ("gpio: add Technologic I2C-FPGA gpio support")

---
V1 -> V2: Add Fixes tag

 drivers/gpio/gpio-ts4900.c | 25 ++++++++++++++++++++-----
 1 file changed, 20 insertions(+), 5 deletions(-)
drivers/gpio/gpio-ts4900.c +0 -0
index d885032cf814..fbabfca030c0 100644

drivers/gpio/gpio-ts4900.c line 1

Quoted 1 line
drivers/gpio/gpio-ts4900.c +1 -0
@@ -1,7 +1,8 @@
+// SPDX-License-Identifier: GPL-2.0

This is not part of the fix, please send a separate patch that comes after the fix adding the SPDX identifier.

drivers/gpio/gpio-ts4900.c line 8

Quoted 8 lines
drivers/gpio/gpio-ts4900.c +1 -1
 /*
  * Digital I/O driver for Technologic Systems I2C FPGA Core
  *
- * Copyright (C) 2015 Technologic Systems
+ * Copyright (C) 2015-2018 Technologic Systems
  * Copyright (C) 2016 Savoir-Faire Linux
  *
  * This program is free software; you can redistribute it and/or

If you're adding the SPDX identifier, you can drop the license boilerplate here.

Bart

Quoted 41 lines
drivers/gpio/gpio-ts4900.c +18 -5
@@ -55,19 +56,33 @@ static int ts4900_gpio_direction_input(struct gpio_chip *chip,
 {
        struct ts4900_gpio_priv *priv = gpiochip_get_data(chip);
 
-       /*
-        * This will clear the output enable bit, the other bits are
-        * dontcare when this is cleared
+       /* Only clear the OE bit here, requires a RMW. Prevents potential issue
+        * with OE and data getting to the physical pin at different times.
         */
-       return regmap_write(priv->regmap, offset, 0);
+       return regmap_update_bits(priv->regmap, offset, TS4900_GPIO_OE, 0);
 }
 
 static int ts4900_gpio_direction_output(struct gpio_chip *chip,
                                        unsigned int offset, int value)
 {
        struct ts4900_gpio_priv *priv = gpiochip_get_data(chip);
+       unsigned int reg;
        int ret;
 
+       /* If changing from an input to an output, we need to first set the
+        * proper data bit to what is requested and then set OE bit. This
+        * prevents a glitch that can occur on the IO line
+        */
+       regmap_read(priv->regmap, offset, &reg);
+       if (!(reg & TS4900_GPIO_OE)) {
+               if (value)
+                       reg = TS4900_GPIO_OUT;
+               else
+                       reg &= ~TS4900_GPIO_OUT;
+
+               regmap_write(priv->regmap, offset, reg);
+       }
+
        if (value)
                ret = regmap_write(priv->regmap, offset, TS4900_GPIO_OE |
                                                         TS4900_GPIO_OUT);
--

2.11.0

#2 lore raw
Quoted 21 lines · Bartosz Golaszewski

drivers/gpio/gpio-ts4900.c line 1

Quoted 7 lines · Kris Bahnsen
drivers/gpio/gpio-ts4900.c +1 -0
index d885032cf814..fbabfca030c0 100644
@@ -1,7 +1,8 @@
+// SPDX-License-Identifier: GPL-2.0

This is not part of the fix, please send a separate patch that comes after the fix adding the SPDX identifier.

drivers/gpio/gpio-ts4900.c line 8

Quoted 8 lines
drivers/gpio/gpio-ts4900.c +1 -1
 /*
  * Digital I/O driver for Technologic Systems I2C FPGA Core
  *
- * Copyright (C) 2015 Technologic Systems
+ * Copyright (C) 2015-2018 Technologic Systems
  * Copyright (C) 2016 Savoir-Faire Linux
  *
  * This program is free software; you can redistribute it and/or
Quoted 4 lines

If you're adding the SPDX identifier, you can drop the license boilerplate here.

Bart

Thanks for the feedback. I'll get a v3 series out soon to address these.

Kris

#3 lore raw
In reply to Kris Bahnsen

Bart, side note: I can't see your for-current in Linux Next for a few days, is everything okay?

Quoted 6 lines · Kris Bahnsen

From: Mark Featherston <[email protected]>

This works around an issue with the hardware where both OE and DAT are exposed in the same register. If both are updated simultaneously, the harware makes no guarantees that OE or DAT

hardware

the OE

Quoted 5 lines

will actually change in any given order and may result in a glitch of a few ns on a GPIO pin when changing direction and value in a single write.

Setting direction to input now only affects OE bit. Setting

the OE bit

Quoted 5 lines

direction to output updates DAT first, then OE.

Fixes 9c6686322d74 ("gpio: add Technologic I2C-FPGA gpio support")

There must be no blank lines in the tag block.

Quoted 2 lines

...

Quoted 1 line

+ * Copyright (C) 2015-2018 Technologic Systems

Not sure it's a valid change for a simple fix.

...

drivers/gpio/gpio-ts4900.c static int ts4900_gpio_direction_input(struct gpio_chip *chip, · line 61

Quoted 6 lines
drivers/gpio/gpio-ts4900.c +2 -3
-       /*
-        * This will clear the output enable bit, the other bits are
-        * dontcare when this is cleared
+       /* Only clear the OE bit here, requires a RMW. Prevents potential issue
+        * with OE and data getting to the physical pin at different times.
         */

Keep the proper style for multi-line comments.

...

drivers/gpio/gpio-ts4900.c static int ts4900_gpio_direction_input(struct gpio_chip *chip, · line 73

Quoted 2 lines
drivers/gpio/gpio-ts4900.c +2 -0
+       /* If changing from an input to an output, we need to first set the
+        * proper data bit to what is requested and then set OE bit. This

the OE bit

drivers/gpio/gpio-ts4900.c static int ts4900_gpio_direction_input(struct gpio_chip *chip, · line 75

Quoted 2 lines
drivers/gpio/gpio-ts4900.c +2 -0
+        * prevents a glitch that can occur on the IO line
+        */

Keep the proper style.

Signature · 2 lines
With Best Regards,
Andy Shevchenko