i2c: gpio: Enable working over slow can_sleep GPIOs

"Slow" GPIOs (usually those connected over an SPI or an I2C bus) are,
well, slow in their operation. It is generally a good idea to avoid
using them for time-critical operation, but sometimes the hardware just
sucks, and the software has to cope. In addition to that, the I2C bus
itself does not actually define any strict timing limits; the bus is
free to go all the way down to DC. The timeouts (and therefore the
slowest acceptable frequency) are present only in SMBus.

The `can_sleep` is IMHO a wrong concept to use here. My SPI-to-quad-UART
chip (MAX14830) is connected via a 26MHz SPI bus, and it happily drives
SCL at 200kHz (5µs pulses) during my benchmarks. That's faster than the
maximal allowed speed of the traditional I2C.

The previous version of this code did not really block operation over
slow GPIO pins, anyway. Instead, it just resorted to printing a warning
with a backtrace each time a GPIO pin was accessed, thereby slowing
things down even more.

Finally, it's not just me. A similar patch was originally submitted in
2015 [1].

[1] https://patchwork.ozlabs.org/patch/450956/

Signed-off-by: Jan Kundrát <jan.kundrat@cesnet.cz>
Acked-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
Signed-off-by: Wolfram Sang <wsa@the-dreams.de>

diff --git a/drivers/i2c/busses/i2c-gpio.c b/drivers/i2c/busses/i2c-gpio.c
index 3312ef981cb784c4628ba06194c9276fa1b3c414..58abb3eced58cd39c2940632c366fb14dfd37ccf 100644 (file)
--- a/drivers/i2c/busses/i2c-gpio.c
+++ b/drivers/i2c/busses/i2c-gpio.c
@@ -39,7 +39,7 @@ static void i2c_gpio_setsda_val(void *data, int state)
 {
        struct i2c_gpio_private_data *priv = data;
 
-       gpiod_set_value(priv->sda, state);
+       gpiod_set_value_cansleep(priv->sda, state);
 }
 
 /*
@@ -52,21 +52,21 @@ static void i2c_gpio_setscl_val(void *data, int state)
 {
        struct i2c_gpio_private_data *priv = data;
 
-       gpiod_set_value(priv->scl, state);
+       gpiod_set_value_cansleep(priv->scl, state);
 }
 
 static int i2c_gpio_getsda(void *data)
 {
        struct i2c_gpio_private_data *priv = data;
 
-       return gpiod_get_value(priv->sda);
+       return gpiod_get_value_cansleep(priv->sda);
 }
 
 static int i2c_gpio_getscl(void *data)
 {
        struct i2c_gpio_private_data *priv = data;
 
-       return gpiod_get_value(priv->scl);
+       return gpiod_get_value_cansleep(priv->scl);
 }
 
 #ifdef CONFIG_I2C_GPIO_FAULT_INJECTOR
@@ -286,6 +286,9 @@ static int i2c_gpio_probe(struct platform_device *pdev)
        if (IS_ERR(priv->scl))
                return PTR_ERR(priv->scl);
 
+       if (gpiod_cansleep(priv->sda) || gpiod_cansleep(priv->scl))
+               dev_warn(dev, "Slow GPIO pins might wreak havoc into I2C/SMBus bus timing");
+
        bit_data->setsda = i2c_gpio_setsda_val;
        bit_data->setscl = i2c_gpio_setscl_val;