Skip to contentSkip to conversation

spi: bugfix spi_add_device() with duplicate chipselects

PATCH In review David Brownell 2 participants 3 messages Aug 14, 2008 2 messages not in the archive SPI

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 spi: bugfix spi_add_device() with duplicate chipselects

From: David Brownell <[email protected]>

When reviewing a recent patch I noticed a potential trouble spot in the registration of new SPI devices. The SPI master driver is told to set the device up before adding it to the driver model, so that it's always properly set up when probe() is called. (This is important, because in the case of inverted chipselects, this device can make the bus misbehave until it's properly deselected. It's got to be set up even if no driver binds to the device.)

The trouble spot is that it doesn't first verify that no other device has been added using that chipselect. If such a device has been added, its configuration gets trashed. (Fortunately this has not been a common error!)

The fix here adds an explicit check, and a mutex to protect the relevant critical region.

---
 drivers/spi/spi.c |   41 ++++++++++++++++++++++++++++++-----------
 1 file changed, 30 insertions(+), 11 deletions(-)
drivers/spi/spi.c +30 -11
@@ -219,6 +219,8 @@ struct spi_device *spi_alloc_device(stru
 }
 EXPORT_SYMBOL_GPL(spi_alloc_device);
 
+static DEFINE_MUTEX(spi_add_lock);
+
 /**
  * spi_add_device - Add spi_device allocated with spi_alloc_device
  * @spi: spi_device to register
@@ -226,7 +228,7 @@ EXPORT_SYMBOL_GPL(spi_alloc_device);
  * Companion function to spi_alloc_device.  Devices allocated with
  * spi_alloc_device can be added onto the spi bus with this function.
  *
- * Returns 0 on success; non-zero on failure
+ * Returns 0 on success; negative errno on failure
  */
 int spi_add_device(struct spi_device *spi)
 {
@@ -246,26 +248,43 @@ int spi_add_device(struct spi_device *sp
 			"%s.%u", spi->master->dev.bus_id,
 			spi->chip_select);
 
-	/* drivers may modify this initial i/o setup */
+
+	/* We need to make sure there's no other device with this
+	 * chipselect **BEFORE** we call setup(), else we'll trash
+	 * its configuration.  Lock against concurrent add() calls.
+	 */
+	mutex_lock(&spi_add_lock);
+
+	if (bus_find_device_by_name(&spi_bus_type, NULL, spi->dev.bus_id)
+			!= NULL) {
+		dev_err(dev, "chipselect %d already in use\n",
+				spi->chip_select);
+		status = -EBUSY;
+		goto done;
+	}
+
+	/* Drivers may modify this initial i/o setup, but will
+	 * normally rely on the device being setup.  Devices
+	 * using SPI_CS_HIGH can't coexist well otherwise...
+	 */
 	status = spi->master->setup(spi);
 	if (status < 0) {
 		dev_err(dev, "can't %s %s, status %d\n",
 				"setup", spi->dev.bus_id, status);
-		return status;
+		goto done;
 	}
 
-	/* driver core catches callers that misbehave by defining
-	 * devices that already exist.
-	 */
+	/* Device may be bound to an active driver when this returns */
 	status = device_add(&spi->dev);
-	if (status < 0) {
+	if (status < 0)
 		dev_err(dev, "can't %s %s, status %d\n",
 				"add", spi->dev.bus_id, status);
-		return status;
-	}
+	else
+		dev_dbg(dev, "registered child %s\n", spi->dev.bus_id);
 
-	dev_dbg(dev, "registered child %s\n", spi->dev.bus_id);
-	return 0;
+done:
+	mutex_unlock(&spi_add_lock);
+	return status;
 }
 EXPORT_SYMBOL_GPL(spi_add_device);
 

-------------------------------------------------------------------------
This SF.Net email is sponsored by the Moblin Your Move Developer's challenge Build the coolest Linux based applications with Moblin SDK & win great prizes Grand prize is a trip for two to an Open Source event anywhere in the world
http://moblin-contest.org/redirect.php?banner_id=100&url=/

#2 lore raw
In reply to a message not in the archive
Quoted 36 lines · On Thu, 14 Aug 2008 02:15:13 -0700 David Brownell…

From: David Brownell <[email protected]>

When reviewing a recent patch I noticed a potential trouble spot in the registration of new SPI devices. The SPI master driver is told to set the device up before adding it to the driver model, so that it's always properly set up when probe() is called. (This is important, because in the case of inverted chipselects, this device can make the bus misbehave until it's properly deselected. It's got to be set up even if no driver binds to the device.)

The trouble spot is that it doesn't first verify that no other device has been added using that chipselect. If such a device has been added, its configuration gets trashed. (Fortunately this has not been a common error!)

The fix here adds an explicit check, and a mutex to protect the relevant critical region.

...

(quoted diff) +3 -1
+static DEFINE_MUTEX(spi_add_lock);
+
 /**
  * spi_add_device - Add spi_device allocated with spi_alloc_device
  * @spi: spi_device to register
@@ -226,7 +228,7 @@ EXPORT_SYMBOL_GPL(spi_alloc_device);
  * Companion function to spi_alloc_device.  Devices allocated with
  * spi_alloc_device can be added onto the spi bus with this function.
  *
- * Returns 0 on success; non-zero on failure
+ * Returns 0 on success; negative errno on failure
  */
 int spi_add_device(struct spi_device *spi)
 {
@@ -246,26 +248,43 @@ int spi_add_device(struct spi_device *sp
 			"%s.%u", spi->master->dev.bus_id,

Review int spi_add_device(struct spi_device *sp · line 257

Quoted 10 lines
(quoted diff) +6 -1
 			spi->chip_select);
 
-	/* drivers may modify this initial i/o setup */
+
+	/* We need to make sure there's no other device with this
+	 * chipselect **BEFORE** we call setup(), else we'll trash
+	 * its configuration.  Lock against concurrent add() calls.
+	 */
+	mutex_lock(&spi_add_lock);
 

It's neater to restrict the scope as much as possible.

drivers/spi/spi.c renamed from drivers/spi/spi.c~spi-bugfix-spi_add_device-with-duplicate-chipselects-cleanup +1 -2
@@ -219,8 +219,6 @@ struct spi_device *spi_alloc_device(stru
 }
 EXPORT_SYMBOL_GPL(spi_alloc_device);
 
-static DEFINE_MUTEX(spi_add_lock);
-
 /**
  * spi_add_device - Add spi_device allocated with spi_alloc_device
  * @spi: spi_device to register
@@ -232,6 +230,7 @@ static DEFINE_MUTEX(spi_add_lock);
  */
 int spi_add_device(struct spi_device *spi)
 {
+	static DEFINE_MUTEX(spi_add_lock);
 	struct device *dev = spi->master->dev.parent;
 	int status;
 

_

OK?

-------------------------------------------------------------------------
This SF.Net email is sponsored by the Moblin Your Move Developer's challenge Build the coolest Linux based applications with Moblin SDK & win great prizes Grand prize is a trip for two to an Open Source event anywhere in the world
http://moblin-contest.org/redirect.php?banner_id=100&url=/

#4 lore raw
In reply to a message not in the archive
Quoted 20 lines · Andrew Morton
drivers/spi/spi.c renamed from drivers/spi/spi.c~spi-bugfix-spi_add_device-with-duplicate-chipselects-cleanup +0 -0
@@ -219,8 +219,6 @@ struct spi_device *spi_alloc_device(stru
  }
  EXPORT_SYMBOL_GPL(spi_alloc_device);

drivers/spi/spi.c renamed from drivers/spi/spi.c~spi-bugfix-spi_add_device-with-duplicate-chipselects-cleanup +0 -2
-static DEFINE_MUTEX(spi_add_lock);
-

 /**
  * spi_add_device - Add spi_device allocated with spi_alloc_device
  * @spi: spi_device to register

drivers/spi/spi.c renamed from drivers/spi/spi.c~spi-bugfix-spi_add_device-with-duplicate-chipselects-cleanup +1 -0
@@ -232,6 +230,7 @@ static DEFINE_MUTEX(spi_add_lock);
   */
  int spi_add_device(struct spi_device *spi)
  {
+       static DEFINE_MUTEX(spi_add_lock);
         struct device *dev = spi->master->dev.parent;
         int status;


_

Quoted 1 line

OK?

Sure. You're right, that is indeed neater. Plus, if no Linux FAQ currently says so, minimizing lock scope is a Very Good Thing.

- Dave

-------------------------------------------------------------------------
This SF.Net email is sponsored by the Moblin Your Move Developer's challenge Build the coolest Linux based applications with Moblin SDK & win great prizes Grand prize is a trip for two to an Open Source event anywhere in the world
http://moblin-contest.org/redirect.php?banner_id=100&url=/