Avoid crashing when display components are deinitialized

jepler · jepler · commit 19e5cf3d8f74 · 2024-08-28T09:44:02.000-05:00
Now, try_lock (SPI & I2C) & begin_transaction (display bus core) will check that the related objects are still valid first; if they are not, the lock/begin transaction will fail by returning false, rather than "other things" such as raising a Python exception where it is not permitted, accessing invalid memory, etc. Closes #8278 and Closes #9426
diff --git a/ports/atmel-samd/common-hal/busio/I2C.c b/ports/atmel-samd/common-hal/busio/I2C.c
@@ -147,6 +147,9 @@ bool common_hal_busio_i2c_probe(busio_i2c_obj_t *self, uint8_t addr) {
 }
 
 bool common_hal_busio_i2c_try_lock(busio_i2c_obj_t *self) {
+    if (common_hal_busio_i2c_deinited(self)) {
+        return false;
+    }
     bool grabbed_lock = false;
     CRITICAL_SECTION_ENTER()
     if (!self->has_lock) {
diff --git a/ports/atmel-samd/common-hal/busio/SPI.c b/ports/atmel-samd/common-hal/busio/SPI.c
@@ -222,6 +222,9 @@ bool common_hal_busio_spi_configure(busio_spi_obj_t *self,
 }
 
 bool common_hal_busio_spi_try_lock(busio_spi_obj_t *self) {
+    if (common_hal_busio_spi_deinited(self)) {
+        return false;
+    }
     bool grabbed_lock = false;
     CRITICAL_SECTION_ENTER()
     if (!self->has_lock) {
diff --git a/ports/broadcom/common-hal/busio/I2C.c b/ports/broadcom/common-hal/busio/I2C.c
@@ -109,6 +109,9 @@ bool common_hal_busio_i2c_probe(busio_i2c_obj_t *self, uint8_t addr) {
 }
 
 bool common_hal_busio_i2c_try_lock(busio_i2c_obj_t *self) {
+    if (common_hal_busio_i2c_deinited(self)) {
+        return false;
+    }
     bool grabbed_lock = false;
     if (!self->has_lock) {
         grabbed_lock = true;
diff --git a/ports/broadcom/common-hal/busio/SPI.c b/ports/broadcom/common-hal/busio/SPI.c
@@ -200,6 +200,9 @@ bool common_hal_busio_spi_configure(busio_spi_obj_t *self,
 }
 
 bool common_hal_busio_spi_try_lock(busio_spi_obj_t *self) {
+    if (common_hal_busio_spi_deinited(self)) {
+        return false;
+    }
     bool grabbed_lock = false;
     if (!self->has_lock) {
         grabbed_lock = true;
diff --git a/ports/cxd56/common-hal/busio/I2C.c b/ports/cxd56/common-hal/busio/I2C.c
@@ -51,6 +51,9 @@ bool common_hal_busio_i2c_deinited(busio_i2c_obj_t *self) {
 }
 
 bool common_hal_busio_i2c_try_lock(busio_i2c_obj_t *self) {
+    if (common_hal_busio_i2c_deinited(self)) {
+        return false;
+    }
     bool grabbed_lock = false;
     if (!self->has_lock) {
         grabbed_lock = true;
diff --git a/ports/cxd56/common-hal/busio/SPI.c b/ports/cxd56/common-hal/busio/SPI.c
@@ -96,6 +96,9 @@ bool common_hal_busio_spi_configure(busio_spi_obj_t *self, uint32_t baudrate, ui
 }
 
 bool common_hal_busio_spi_try_lock(busio_spi_obj_t *self) {
+    if (common_hal_busio_spi_deinited(self)) {
+        return false;
+    }
     bool grabbed_lock = false;
     if (!self->has_lock) {
         grabbed_lock = true;
diff --git a/ports/espressif/common-hal/busio/I2C.c b/ports/espressif/common-hal/busio/I2C.c
@@ -141,6 +141,9 @@ bool common_hal_busio_i2c_probe(busio_i2c_obj_t *self, uint8_t addr) {
 }
 
 bool common_hal_busio_i2c_try_lock(busio_i2c_obj_t *self) {
+    if (common_hal_busio_i2c_deinited(self)) {
+        return false;
+    }
     if (self->has_lock) {
         return false;
     }
diff --git a/ports/mimxrt10xx/common-hal/busio/I2C.c b/ports/mimxrt10xx/common-hal/busio/I2C.c
@@ -187,6 +187,9 @@ bool common_hal_busio_i2c_probe(busio_i2c_obj_t *self, uint8_t addr) {
 }
 
 bool common_hal_busio_i2c_try_lock(busio_i2c_obj_t *self) {
+    if (common_hal_busio_i2c_deinited(self)) {
+        return false;
+    }
     bool grabbed_lock = false;
 //    CRITICAL_SECTION_ENTER()
     if (!self->has_lock) {
diff --git a/ports/mimxrt10xx/common-hal/busio/SPI.c b/ports/mimxrt10xx/common-hal/busio/SPI.c
@@ -272,6 +272,9 @@ bool common_hal_busio_spi_configure(busio_spi_obj_t *self,
 }
 
 bool common_hal_busio_spi_try_lock(busio_spi_obj_t *self) {
+    if (common_hal_busio_spi_deinited(self)) {
+        return false;
+    }
     bool grabbed_lock = false;
 //    CRITICAL_SECTION_ENTER()
     if (!self->has_lock) {
diff --git a/ports/nordic/common-hal/busio/I2C.c b/ports/nordic/common-hal/busio/I2C.c
@@ -216,6 +216,9 @@ bool common_hal_busio_i2c_probe(busio_i2c_obj_t *self, uint8_t addr) {
 }
 
 bool common_hal_busio_i2c_try_lock(busio_i2c_obj_t *self) {
+    if (common_hal_busio_i2c_deinited(self)) {
+        return false;
+    }
     bool grabbed_lock = false;
     // NRFX_CRITICAL_SECTION_ENTER();
     if (!self->has_lock) {
diff --git a/ports/nordic/common-hal/busio/SPI.c b/ports/nordic/common-hal/busio/SPI.c
@@ -213,6 +213,9 @@ bool common_hal_busio_spi_configure(busio_spi_obj_t *self, uint32_t baudrate, ui
 }
 
 bool common_hal_busio_spi_try_lock(busio_spi_obj_t *self) {
+    if (common_hal_busio_spi_deinited(self)) {
+        return false;
+    }
     bool grabbed_lock = false;
     // NRFX_CRITICAL_SECTION_ENTER();
     if (!self->has_lock) {
diff --git a/ports/raspberrypi/common-hal/busio/I2C.c b/ports/raspberrypi/common-hal/busio/I2C.c
@@ -130,6 +130,9 @@ bool common_hal_busio_i2c_probe(busio_i2c_obj_t *self, uint8_t addr) {
 }
 
 bool common_hal_busio_i2c_try_lock(busio_i2c_obj_t *self) {
+    if (common_hal_busio_i2c_deinited(self)) {
+        return false;
+    }
     bool grabbed_lock = false;
     if (!self->has_lock) {
         grabbed_lock = true;
diff --git a/ports/raspberrypi/common-hal/busio/SPI.c b/ports/raspberrypi/common-hal/busio/SPI.c
@@ -150,6 +150,9 @@ bool common_hal_busio_spi_configure(busio_spi_obj_t *self,
 }
 
 bool common_hal_busio_spi_try_lock(busio_spi_obj_t *self) {
+    if (common_hal_busio_spi_deinited(self)) {
+        return false;
+    }
     bool grabbed_lock = false;
     if (!self->has_lock) {
         grabbed_lock = true;
diff --git a/ports/renode/common-hal/busio/I2C.c b/ports/renode/common-hal/busio/I2C.c
@@ -31,6 +31,9 @@ bool common_hal_busio_i2c_probe(busio_i2c_obj_t *self, uint8_t addr) {
 }
 
 bool common_hal_busio_i2c_try_lock(busio_i2c_obj_t *self) {
+    if (common_hal_busio_i2c_deinited(self)) {
+        return false;
+    }
     return false;
 }
 
diff --git a/ports/renode/common-hal/busio/SPI.c b/ports/renode/common-hal/busio/SPI.c
@@ -33,6 +33,9 @@ bool common_hal_busio_spi_configure(busio_spi_obj_t *self,
 }
 
 bool common_hal_busio_spi_try_lock(busio_spi_obj_t *self) {
+    if (common_hal_busio_spi_deinited(self)) {
+        return false;
+    }
     return false;
 }
 
diff --git a/ports/silabs/common-hal/busio/I2C.c b/ports/silabs/common-hal/busio/I2C.c
@@ -125,6 +125,9 @@ bool common_hal_busio_i2c_probe(busio_i2c_obj_t *self, uint8_t addr) {
 
 // Lock I2C bus
 bool common_hal_busio_i2c_try_lock(busio_i2c_obj_t *self) {
+    if (common_hal_busio_i2c_deinited(self)) {
+        return false;
+    }
     bool grabbed_lock = false;
 
     if (!self->has_lock) {
diff --git a/ports/silabs/common-hal/busio/SPI.c b/ports/silabs/common-hal/busio/SPI.c
@@ -186,6 +186,9 @@ bool common_hal_busio_spi_configure(busio_spi_obj_t *self,
 
 // Lock SPI bus
 bool common_hal_busio_spi_try_lock(busio_spi_obj_t *self) {
+    if (common_hal_busio_spi_deinited(self)) {
+        return false;
+    }
     bool grabbed_lock = false;
     if (!self->has_lock) {
         grabbed_lock = true;
diff --git a/ports/stm/common-hal/busio/I2C.c b/ports/stm/common-hal/busio/I2C.c
@@ -198,6 +198,9 @@ bool common_hal_busio_i2c_probe(busio_i2c_obj_t *self, uint8_t addr) {
 }
 
 bool common_hal_busio_i2c_try_lock(busio_i2c_obj_t *self) {
+    if (common_hal_busio_i2c_deinited(self)) {
+        return false;
+    }
     bool grabbed_lock = false;
 
     // Critical section code that may be required at some point.
diff --git a/ports/stm/common-hal/busio/SPI.c b/ports/stm/common-hal/busio/SPI.c
@@ -297,6 +297,9 @@ bool common_hal_busio_spi_configure(busio_spi_obj_t *self,
 }
 
 bool common_hal_busio_spi_try_lock(busio_spi_obj_t *self) {
+    if (common_hal_busio_spi_deinited(self)) {
+        return false;
+    }
     bool grabbed_lock = false;
 
     // Critical section code that may be required at some point.
diff --git a/shared-module/displayio/bus_core.c b/shared-module/displayio/bus_core.c
@@ -90,6 +90,10 @@ bool displayio_display_bus_is_free(displayio_display_bus_t *self) {
 }
 
 bool displayio_display_bus_begin_transaction(displayio_display_bus_t *self) {
+    mp_obj_base_t *bus_base = MP_OBJ_TO_PTR(self->bus);
+    if (bus_base->type == &mp_type_NoneType) {
+        return false;
+    }
     return self->begin_transaction(self->bus);
 }
 

Original file line number	Diff line number	Diff line change
`@@ -147,6 +147,9 @@ bool common_hal_busio_i2c_probe(busio_i2c_obj_t *self, uint8_t addr) {`
`147`	`147`	`}`
`148`	`148`
`149`	`149`	`bool common_hal_busio_i2c_try_lock(busio_i2c_obj_t *self) {`
	`150`	`+ if (common_hal_busio_i2c_deinited(self)) {`
	`151`	`+ return false;`
	`152`	`+ }`
`150`	`153`	`bool grabbed_lock = false;`
`151`	`154`	`CRITICAL_SECTION_ENTER()`
`152`	`155`	`if (!self->has_lock) {`
Original file line number	Diff line number	Diff line change
`@@ -222,6 +222,9 @@ bool common_hal_busio_spi_configure(busio_spi_obj_t *self,`
`222`	`222`	`}`
`223`	`223`
`224`	`224`	`bool common_hal_busio_spi_try_lock(busio_spi_obj_t *self) {`
	`225`	`+ if (common_hal_busio_spi_deinited(self)) {`
	`226`	`+ return false;`
	`227`	`+ }`
`225`	`228`	`bool grabbed_lock = false;`
`226`	`229`	`CRITICAL_SECTION_ENTER()`
`227`	`230`	`if (!self->has_lock) {`
Original file line number	Diff line number	Diff line change
`@@ -109,6 +109,9 @@ bool common_hal_busio_i2c_probe(busio_i2c_obj_t *self, uint8_t addr) {`
`109`	`109`	`}`
`110`	`110`
`111`	`111`	`bool common_hal_busio_i2c_try_lock(busio_i2c_obj_t *self) {`
	`112`	`+ if (common_hal_busio_i2c_deinited(self)) {`
	`113`	`+ return false;`
	`114`	`+ }`
`112`	`115`	`bool grabbed_lock = false;`
`113`	`116`	`if (!self->has_lock) {`
`114`	`117`	`grabbed_lock = true;`
Original file line number	Diff line number	Diff line change
`@@ -200,6 +200,9 @@ bool common_hal_busio_spi_configure(busio_spi_obj_t *self,`
`200`	`200`	`}`
`201`	`201`
`202`	`202`	`bool common_hal_busio_spi_try_lock(busio_spi_obj_t *self) {`
	`203`	`+ if (common_hal_busio_spi_deinited(self)) {`
	`204`	`+ return false;`
	`205`	`+ }`
`203`	`206`	`bool grabbed_lock = false;`
`204`	`207`	`if (!self->has_lock) {`
`205`	`208`	`grabbed_lock = true;`
Original file line number	Diff line number	Diff line change
`@@ -51,6 +51,9 @@ bool common_hal_busio_i2c_deinited(busio_i2c_obj_t *self) {`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`bool common_hal_busio_i2c_try_lock(busio_i2c_obj_t *self) {`
	`54`	`+ if (common_hal_busio_i2c_deinited(self)) {`
	`55`	`+ return false;`
	`56`	`+ }`
`54`	`57`	`bool grabbed_lock = false;`
`55`	`58`	`if (!self->has_lock) {`
`56`	`59`	`grabbed_lock = true;`
Original file line number	Diff line number	Diff line change
`@@ -96,6 +96,9 @@ bool common_hal_busio_spi_configure(busio_spi_obj_t *self, uint32_t baudrate, ui`
`96`	`96`	`}`
`97`	`97`
`98`	`98`	`bool common_hal_busio_spi_try_lock(busio_spi_obj_t *self) {`
	`99`	`+ if (common_hal_busio_spi_deinited(self)) {`
	`100`	`+ return false;`
	`101`	`+ }`
`99`	`102`	`bool grabbed_lock = false;`
`100`	`103`	`if (!self->has_lock) {`
`101`	`104`	`grabbed_lock = true;`
Original file line number	Diff line number	Diff line change
`@@ -141,6 +141,9 @@ bool common_hal_busio_i2c_probe(busio_i2c_obj_t *self, uint8_t addr) {`
`141`	`141`	`}`
`142`	`142`
`143`	`143`	`bool common_hal_busio_i2c_try_lock(busio_i2c_obj_t *self) {`
	`144`	`+ if (common_hal_busio_i2c_deinited(self)) {`
	`145`	`+ return false;`
	`146`	`+ }`
`144`	`147`	`if (self->has_lock) {`
`145`	`148`	`return false;`
`146`	`149`	`}`
Original file line number	Diff line number	Diff line change
`@@ -187,6 +187,9 @@ bool common_hal_busio_i2c_probe(busio_i2c_obj_t *self, uint8_t addr) {`
`187`	`187`	`}`
`188`	`188`
`189`	`189`	`bool common_hal_busio_i2c_try_lock(busio_i2c_obj_t *self) {`
	`190`	`+ if (common_hal_busio_i2c_deinited(self)) {`
	`191`	`+ return false;`
	`192`	`+ }`
`190`	`193`	`bool grabbed_lock = false;`
`191`	`194`	`// CRITICAL_SECTION_ENTER()`
`192`	`195`	`if (!self->has_lock) {`
Original file line number	Diff line number	Diff line change
`@@ -272,6 +272,9 @@ bool common_hal_busio_spi_configure(busio_spi_obj_t *self,`
`272`	`272`	`}`
`273`	`273`
`274`	`274`	`bool common_hal_busio_spi_try_lock(busio_spi_obj_t *self) {`
	`275`	`+ if (common_hal_busio_spi_deinited(self)) {`
	`276`	`+ return false;`
	`277`	`+ }`
`275`	`278`	`bool grabbed_lock = false;`
`276`	`279`	`// CRITICAL_SECTION_ENTER()`
`277`	`280`	`if (!self->has_lock) {`
Original file line number	Diff line number	Diff line change
`@@ -216,6 +216,9 @@ bool common_hal_busio_i2c_probe(busio_i2c_obj_t *self, uint8_t addr) {`
`216`	`216`	`}`
`217`	`217`
`218`	`218`	`bool common_hal_busio_i2c_try_lock(busio_i2c_obj_t *self) {`
	`219`	`+ if (common_hal_busio_i2c_deinited(self)) {`
	`220`	`+ return false;`
	`221`	`+ }`
`219`	`222`	`bool grabbed_lock = false;`
`220`	`223`	`// NRFX_CRITICAL_SECTION_ENTER();`
`221`	`224`	`if (!self->has_lock) {`