Skip to contentSkip to conversation

spi-gpio: Sanitize MISO bitvalue

PATCH In review Michael Buesch 3 participants 5 messages Feb 15, 2009 – Feb 19, 2009 SPI

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 spi-gpio: Sanitize MISO bitvalue

gpio_get_value() returns 0 or nonzero, but getmiso() expects 0 or 1. Sanitize the value to a 0/1 boolean.

---

Well, we could also change the bitbang helpers in linux/spi/spi_bitbang.h or change the way the gpio_get_value API is defined, but I personally think this patch is pretty good as is.
In any case, it fixes a real bug on platforms like the bcm47xx which return 0 or nonzero for gpio_get_value.

drivers/spi/spi_gpio.c +1 -1
Index: linux-2.6/drivers/spi/spi_gpio.c
===================================================================
@@ -114,7 +114,7 @@ static inline void setmosi(const struct 
 
 static inline int getmiso(const struct spi_device *spi)
 {
-	return gpio_get_value(SPI_MISO_GPIO);
+	return !!gpio_get_value(SPI_MISO_GPIO);
 }
 
 #undef pdata
Signature · 1 line
Greetings, Michael.
Acked-by on v1 1/1
#1 lore raw
Quoted 4 lines · Michael Buesch

gpio_get_value() returns 0 or nonzero, but getmiso() expects 0 or 1. Sanitize the value to a 0/1 boolean.

Quoted 3 lines

---

Well, we could also change the bitbang helpers in linux/spi/spi_bitbang.h

That would be the main alternate fix to consider, and it's worth updating the docs there to specify that getmiso() needs to return 0/1 ...

Quoted 1 line

or change the way the gpio_get_value API is defined,

Not an option. The more instructions thrown in these inner loops, the harder it is to get even inlined code to clock over 1 MHz.

Quoted 23 lines

but I personally think
this patch is pretty good as is.
In any case, it fixes a real bug on platforms like the bcm47xx which return 0 or nonzero for gpio_get_value.

Index: linux-2.6/drivers/spi/spi_gpio.c
===================================================================

drivers/spi/spi_gpio.c +1 -1
@@ -114,7 +114,7 @@ static inline void setmosi(const struct 
 
 static inline int getmiso(const struct spi_device *spi)
 {
-	return gpio_get_value(SPI_MISO_GPIO);
+	return !!gpio_get_value(SPI_MISO_GPIO);
 }
 
 #undef pdata
Signature · 2 lines
-- 
Greetings, Michael.
#2 lore raw
In reply to Michael Buesch
Quoted 19 lines · On Sun, 15 Feb 2009 16:30:41 +0100 Michael Buesch <[email protected]> wrote:

gpio_get_value() returns 0 or nonzero, but getmiso() expects 0 or 1. Sanitize the value to a 0/1 boolean.

---

Well, we could also change the bitbang helpers in linux/spi/spi_bitbang.h or change the way the gpio_get_value API is defined, but I personally think this patch is pretty good as is.
In any case, it fixes a real bug on platforms like the bcm47xx which return 0 or nonzero for gpio_get_value.

Index: linux-2.6/drivers/spi/spi_gpio.c
===================================================================

drivers/spi/spi_gpio.c static inline void setmosi(const struct · line 120

Quoted 8 lines
drivers/spi/spi_gpio.c +1 -1
@@ -114,7 +114,7 @@ static inline void setmosi(const struct 
 
 static inline int getmiso(const struct spi_device *spi)
 {
-	return gpio_get_value(SPI_MISO_GPIO);
+	return !!gpio_get_value(SPI_MISO_GPIO);
 }
 
 #undef pdata

Seems somewhat pointless, really. It's a very common C idiom to treat any non-zero value as true, and the above just adds a couple more instructions which we didn't need to execute.

If this function is speed-critical (which is what David's comment implies) then perhaps this should be "fixed" by tightening up the (presently apparently undocumented) interface? And then speeding up all the other getmiso() implementations?

#3 lore raw
Quoted 28 lines · On Wednesday 18 February 2009 22:04:26 Andrew Morton wrote:
Quoted 25 lines · On Sun, 15 Feb 2009 16:30:41 +0100 Michael Buesch <[email protected]> wrote:

gpio_get_value() returns 0 or nonzero, but getmiso() expects 0 or 1. Sanitize the value to a 0/1 boolean.

---

Well, we could also change the bitbang helpers in linux/spi/spi_bitbang.h or change the way the gpio_get_value API is defined, but I personally think this patch is pretty good as is.
In any case, it fixes a real bug on platforms like the bcm47xx which return 0 or nonzero for gpio_get_value.

Index: linux-2.6/drivers/spi/spi_gpio.c
===================================================================

drivers/spi/spi_gpio.c +1 -1
@@ -114,7 +114,7 @@ static inline void setmosi(const struct 
 
 static inline int getmiso(const struct spi_device *spi)
 {
-	return gpio_get_value(SPI_MISO_GPIO);
+	return !!gpio_get_value(SPI_MISO_GPIO);
 }
 
Quoted 6 lines

drivers/spi/spi_gpio.c static inline void setmosi(const struct · line 120

Quoted 2 lines
drivers/spi/spi_gpio.c +0 -0
 #undef pdata

Seems somewhat pointless, really. It's a very common C idiom to treat any non-zero value as true, and the above just adds a couple more instructions which we didn't need to execute.

No you must look at the user of getmiso().
It does something like this:

	for (bitnr = 0; bitnr < x; bitnr++) {
		foo = getmiso() << bitnr;
		...
	}
Quoted 4 lines

If this function is speed-critical (which is what David's comment implies) then perhaps this should be "fixed" by tightening up the (presently apparently undocumented) interface? And then speeding up all the other getmiso() implementations?

He was talking about gpio_get_value() and my (silly) suggestion to change it to return 0 or 1. I knew that he would reject that, because we already talked about this in the past. So changing getmiso() _is_ the way to go. It is the cheapest way to do this, in fact. Doing it _inside_ of getmiso() would mean that it could possibly be redundant, if upper layers already did it.

David suggested documenting the fact that getmiso() expects 0/1. He can easily do that in yet another patch if he likes this.

My patch is just supposed to fix a real-world bug, which isn't in a released kernel, yet. So if we hurry up, we can still get it into .29.

The documentation change can still go in later.

Signature · 1 line
Greetings, Michael.
#4 lore raw
In reply to Andrew Morton
Quoted 4 lines · Andrew Morton

If this function is speed-critical (which is what David's comment implies) then perhaps this should be "fixed" by tightening up the (presently apparently undocumented) interface?  And then speeding up all the other getmiso() implementations?

All the per-bit GPIO functions can be speed-critical, which is why they use the zero/nonzero convention instead of demanding extra instructions to switch to the zero/one convention.

This particular function needs the zero/one convention; in that respect it's unusual.