Merge pull request #10645 from dhalbert/sd-card-usb-presentation-fixes

Sd card usb presentation fixes

Author: dhalbert

docs/workflows.md

@@ -44,6 +44,12 @@ A few boards have SD card automounting. (This is based on the ``DEFAULT_SD`` set
 ``mpconfigboard.h``.) The card is writable from CircuitPython by default and read-only to the host.
 `storage.remount()` can be used to remount the drive to the host as read-write.
 
+On most other boards, except for ``atmel-samd`` boards, an SD card mounted in user code
+at ``/sd`` will become visible after a few seconds on the attached host computer, as an
+additional drive besides CIRCUITPY and (if present) CPSAVES. It will present with the volume
+label on the SD card. Depending on the host operating system settings, the drive may or may not be
+auto-mounted on the host. Host writes to drives mounted by user code will not trigger a reload.
+
 ### CDC serial
 CircuitPython exposes one CDC USB interface for CircuitPython serial. This is a standard serial
 USB interface.

main.c

@@ -214,7 +214,7 @@ static void stop_mp(void) {
     mp_vfs_mount_t *vfs = MP_STATE_VM(vfs_mount_table);
 
     // Unmount all heap allocated vfs mounts.
-    while (gc_nbytes(vfs) > 0) {
+    while (gc_ptr_on_heap(vfs)) {
         vfs = vfs->next;
     }
     MP_STATE_VM(vfs_mount_table) = vfs;

ports/atmel-samd/mpconfigport.h

@@ -11,6 +11,9 @@
 
 // Definitions that control circuitpy_mpconfig.h:
 
+// On SAMD, presenting the SD card as a second LUN causes USB disconnect. This needs to be fixed eventually.
+#define CIRCUITPY_SDCARD_USB (0)
+
 ////////////////////////////////////////////////////////////////////////////////////////////////////
 
 #ifdef SAMD21

ports/cxd56/mpconfigport.h

@@ -8,6 +8,9 @@
 
 #define MICROPY_PY_SYS_PLATFORM                 "CXD56"
 
+// SD card socket on board is configured for sdioio, which is not supported for automatic USB presentation.
+#define CIRCUITPY_SDCARD_USB (0)
+
 // 64kiB stack
 #define CIRCUITPY_DEFAULT_STACK_SIZE            (0x10000)
 

ports/espressif/common-hal/_bleio/Characteristic.c

@@ -120,7 +120,7 @@ void common_hal_bleio_characteristic_deinit(bleio_characteristic_obj_t *self) {
         return;
     }
     if (self->current_value != NULL) {
-        if (gc_nbytes(self->current_value) > 0) {
+        if (gc_ptr_on_heap(self->current_value)) {
             m_free(self->current_value);
         } else {
             port_free(self->current_value);

ports/nordic/common-hal/_bleio/Characteristic.c

@@ -80,7 +80,7 @@ void common_hal_bleio_characteristic_construct(bleio_characteristic_obj_t *self,
         // to allocate.
         self->initial_value_len = initial_value_bufinfo->len;
         if (gc_alloc_possible()) {
-            if (gc_nbytes(initial_value_bufinfo->buf) > 0) {
+            if (gc_ptr_on_heap(initial_value_bufinfo->buf)) {
                 uint8_t *initial_value = m_malloc_without_collect(self->initial_value_len);
                 memcpy(initial_value, initial_value_bufinfo->buf, self->initial_value_len);
                 self->initial_value = initial_value;

ports/nordic/common-hal/_bleio/Service.c

@@ -131,7 +131,7 @@ void common_hal_bleio_service_add_characteristic(bleio_service_obj_t *self,
         BLE_GAP_CONN_SEC_MODE_SET_OPEN(&user_desc_md.read_perm);
         // If the description is on the Python heap, then have the SD copy it. If not, assume it's
         // static and will live for longer than the SD.
-        user_desc_md.vloc = gc_nbytes(user_description) > 0 ? BLE_GATTS_VLOC_STACK : BLE_GATTS_VLOC_USER;
+        user_desc_md.vloc = gc_ptr_on_heap(user_description) ? BLE_GATTS_VLOC_STACK : BLE_GATTS_VLOC_USER;
         char_md.p_user_desc_md = &user_desc_md;
         char_md.p_char_user_desc = (const uint8_t *)user_description;
         char_md.char_user_desc_max_size = strlen(user_description);

ports/nordic/common-hal/busio/UART.c

@@ -122,7 +122,7 @@ void uart_reset(void) {
 
 void common_hal_busio_uart_never_reset(busio_uart_obj_t *self) {
     // Don't never reset objects on the heap.
-    if (gc_alloc_possible() && gc_nbytes(self) > 0) {
+    if (gc_alloc_possible() && gc_ptr_on_heap(self)) {
         return;
     }
     for (size_t i = 0; i < MP_ARRAY_SIZE(nrfx_uartes); i++) {
@@ -346,7 +346,7 @@ size_t common_hal_busio_uart_write(busio_uart_obj_t *self, const uint8_t *data,
         RUN_BACKGROUND_TASKS;
     }
 
-    if (!nrfx_is_in_ram(data) && gc_alloc_possible() && gc_nbytes(tx_buf) > 0) {
+    if (!nrfx_is_in_ram(data) && gc_alloc_possible() && gc_ptr_on_heap(tx_buf)) {
         gc_free(tx_buf);
     }
 

py/circuitpy_mpconfig.h

@@ -514,6 +514,18 @@ void background_callback_run_all(void);
 
 // USB settings
 
+#ifndef CIRCUITPY_SDCARD_USB
+#if CIRCUITPY_USB_DEVICE
+#define CIRCUITPY_SDCARD_USB (CIRCUITPY_SDCARDIO && CIRCUITPY_USB_MSC)
+#else
+#define CIRCUITPY_SDCARD_USB (0)
+#endif
+#endif
+
+#if CIRCUITPY_SDCARD_USB && !(CIRCUITPY_SDCARDIO)
+#error CIRCUITPY_SDCARD_USB requires CIRCUITPY_SDCARDIO
+#endif
+
 // Debug level for TinyUSB. Only outputs over debug UART so it doesn't cause
 // additional USB logging.
 #ifndef CIRCUITPY_DEBUG_TINYUSB

py/gc.c

@@ -446,7 +446,7 @@ bool gc_is_locked(void) {
 }
 
 // CIRCUITPY-CHANGE: additional function
-bool gc_ptr_on_heap(void *ptr) {
+bool gc_ptr_on_heap(const void *ptr) {
     for (mp_state_mem_area_t *area = &MP_STATE_MEM(area); area != NULL; area = NEXT_AREA(area)) {
         if (ptr >= (void *)area->gc_pool_start   // must be above start of pool
             && ptr < (void *)area->gc_pool_end) {   // must be below end of pool