🧑‍💻 Clarify some SD / FD build flags

thinkyhead · thinkyhead · commit d16667838fdb · 2025-04-23T19:48:24.000-05:00
diff --git a/Marlin/src/gcode/sd/M21_M22.cpp b/Marlin/src/gcode/sd/M21_M22.cpp
@@ -38,9 +38,9 @@ void GcodeSuite::M21() {
   #if HAS_MULTI_VOLUME
     const int8_t vol = parser.intval('P', -1);
     if (vol == 0 || parser.seen_test('S'))       // "S" for SD Card
-      card.changeMedia(&card.media_driver_sdcard);
+      card.selectMediaSDCard();
     else if (vol == 1 || parser.seen_test('U'))  // "U" for USB
-      card.changeMedia(&card.media_driver_usbFlash);
+      card.selectMediaFlashDrive();
   #endif
   card.mount();
 }
diff --git a/Marlin/src/inc/Conditionals-4-adv.h b/Marlin/src/inc/Conditionals-4-adv.h
@@ -1248,10 +1248,17 @@
 
 #if ENABLED(MULTI_VOLUME)
   #define HAS_MULTI_VOLUME 1
+  #define SV_SD_ONBOARD      101
+  #define SV_USB_FLASH_DRIVE 102
+  #define _VOLUME_ID(N) _CAT(SV_, N)
+  #define SHARED_VOLUME_IS(N) (DEFAULT_SHARED_VOLUME == _VOLUME_ID(N))
+#else
+  #define SHARED_VOLUME_IS(...) 0
 #endif
-#if ENABLED(USB_FLASH_DRIVE_SUPPORT)
+
+#if ANY(USB_FLASH_DRIVE_SUPPORT, VOLUME_USB_FLASH_DRIVE)
   #define HAS_USB_FLASH_DRIVE 1
-  #if NONE(USE_OTG_USB_HOST, USE_UHS3_USB)
+  #if NONE(USE_OTG_USB_HOST, USE_UHS2_USB, USE_UHS3_USB)
     #define USE_UHS2_USB
   #endif
 #endif
diff --git a/Marlin/src/inc/Conditionals-5-post.h b/Marlin/src/inc/Conditionals-5-post.h
@@ -550,7 +550,9 @@
     #endif
   #endif
 
+  // Tests indicating a single or multi-volume SD Card
   #if !HAS_USB_FLASH_DRIVE || ALL(HAS_MULTI_VOLUME, VOLUME_SD_ONBOARD)
+    #define HAS_SDCARD 1
     #if ENABLED(ONBOARD_SDIO)
       #define NEED_SD2CARD_SDIO 1
     #else
diff --git a/Marlin/src/inc/SanityCheck.h b/Marlin/src/inc/SanityCheck.h
@@ -3943,7 +3943,7 @@ static_assert(_PLUS_TEST(3), "DEFAULT_MAX_ACCELERATION values must be positive."
 
 #if HAS_USB_FLASH_DRIVE && DISABLED(USE_OTG_USB_HOST) && !PINS_EXIST(USB_CS, USB_INTR)
   #error "USB_CS_PIN and USB_INTR_PIN (or USE_OTG_USB_HOST) are required for USB_FLASH_DRIVE_SUPPORT."
-#elif ENABLED(USE_OTG_USB_HOST) && !defined(HAS_OTG_USB_HOST_SUPPORT)
+#elif ENABLED(USE_OTG_USB_HOST) && DISABLED(HAS_OTG_USB_HOST_SUPPORT)
   #error "The current board does not support USE_OTG_USB_HOST."
 #endif
 
diff --git a/Marlin/src/lcd/extui/mks_ui/draw_media_select.cpp b/Marlin/src/lcd/extui/mks_ui/draw_media_select.cpp
@@ -46,8 +46,8 @@ static void event_handler(lv_obj_t *obj, lv_event_t event) {
   if (event != LV_EVENT_RELEASED) return;
   lv_clear_media_select();
   switch (obj->mks_obj_id) {
-    case ID_T_USB_DISK: card.changeMedia(&card.media_driver_usbFlash); break;
-    case ID_T_SD_DISK:  card.changeMedia(&card.media_driver_sdcard); break;
+    case ID_T_USB_DISK: card.selectMediaFlashDrive(); break;
+    case ID_T_SD_DISK:  card.selectMediaSDCard(); break;
     case ID_T_RETURN:
       TERN_(MKS_TEST, current_disp_ui = 1);
       lv_draw_ready_print();
diff --git a/Marlin/src/lcd/extui/mks_ui/tft_lvgl_configuration.cpp b/Marlin/src/lcd/extui/mks_ui/tft_lvgl_configuration.cpp
@@ -135,18 +135,19 @@ void tft_lvgl_init() {
   hal.watchdog_refresh();     // LVGL init takes time
 
   #if HAS_USB_FLASH_DRIVE
-    uint16_t usb_flash_loop = 1000;
     #if HAS_MULTI_VOLUME && !HAS_SD_HOST_DRIVE
       if (IS_SD_INSERTED())
-        card.changeMedia(&card.media_driver_sdcard);
+        card.selectMediaSDCard();
       else
-        card.changeMedia(&card.media_driver_usbFlash);
+        card.selectMediaFlashDrive();
     #endif
-    do {
-      card.media_driver_usbFlash.idle();
+    // Wait up to two seconds for USB Drive to mount
+    for (uint16_t usb_flash_loop = 500; --usb_flash_loop;) {
       hal.watchdog_refresh();
-      delay(2);
-    } while (!card.media_driver_usbFlash.isInserted() && usb_flash_loop--);
+      card.media_driver_usbFlash.idle();
+      delay(4);
+      if (card.media_driver_usbFlash.isInserted()) break;
+    }
     card.mount();
   #elif HAS_LOGO_IN_FLASH
     delay(1000);
diff --git a/Marlin/src/lcd/marlinui.cpp b/Marlin/src/lcd/marlinui.cpp
@@ -1114,7 +1114,7 @@ void MarlinUI::init() {
       #if MARLINUI_SCROLL_NAME
         // If scrolling of long file names is enabled and we are in the sd card menu,
         // cause a refresh to occur until all the text has scrolled into view.
-        if (currentScreen == menu_media_filelist && filename_scroll_max && !lcd_status_update_delay--) {
+        if (currentScreen == menu_file_selector && filename_scroll_max && !lcd_status_update_delay--) {
           lcd_status_update_delay = ++filename_scroll_pos >= filename_scroll_max ? 12 : 4; // Long delay at end and start
           if (filename_scroll_pos > filename_scroll_max) filename_scroll_pos = 0;
           refresh(LCDVIEW_REDRAW_NOW);
diff --git a/Marlin/src/lcd/menu/menu.h b/Marlin/src/lcd/menu/menu.h
@@ -211,7 +211,7 @@ void menu_main();
 void menu_move();
 
 #if HAS_MEDIA
-  void menu_media_filelist();
+  void menu_file_selector();
   void menu_media();
 #endif
 
diff --git a/Marlin/src/lcd/menu/menu_media.cpp b/Marlin/src/lcd/menu/menu_media.cpp
@@ -45,7 +45,7 @@ void lcd_sd_updir() {
 
   void MarlinUI::reselect_last_file() {
     if (sd_encoder_position == 0xFFFF) return;
-    goto_screen(menu_media_filelist, sd_encoder_position, sd_top_line, sd_items);
+    goto_screen(menu_file_selector, sd_encoder_position, sd_top_line, sd_items);
     sd_encoder_position = 0xFFFF;
     defer_status_screen();
   }
@@ -105,26 +105,26 @@ class MenuItem_sdfolder : public MenuItem_sdbase {
   void menu_media_select() {
     START_MENU();
     BACK_ITEM_F(TERN1(BROWSE_MEDIA_ON_INSERT, screen_history_depth) ? GET_TEXT_F(MSG_MAIN_MENU) : GET_TEXT_F(MSG_BACK));
-    #if ENABLED(VOLUME_SD_ONBOARD)
-      ACTION_ITEM(MSG_SD_CARD, []{ card.changeMedia(&card.media_driver_sdcard); card.mount(); ui.goto_screen(menu_media_filelist); });
+    #if HAS_SDCARD
+      ACTION_ITEM(MSG_SD_CARD,  []{ card.selectMediaSDCard();     card.mount(); ui.goto_screen(menu_file_selector); });
     #endif
-    #if ENABLED(VOLUME_USB_FLASH_DRIVE)
-      ACTION_ITEM(MSG_USB_DISK, []{ card.changeMedia(&card.media_driver_usbFlash); card.mount(); ui.goto_screen(menu_media_filelist); });
+    #if HAS_USB_FLASH_DRIVE
+      ACTION_ITEM(MSG_USB_DISK, []{ card.selectMediaFlashDrive(); card.mount(); ui.goto_screen(menu_file_selector); });
     #endif
     END_MENU();
   }
 #endif
 
 /**
  * "Select From Media" menu item. Depending on single or multiple drives:
- *   - menu_media_filelist - List files on the current media
- *   - menu_media_select   - Select one of the attached drives, then go to the file list
+ *   - menu_file_selector - List files on the current media
+ *   - menu_media_select  - Select one of the attached drives, then go to the file list
  */
 void menu_media() {
-  ui.goto_screen(TERN(HAS_MULTI_VOLUME, menu_media_select, menu_media_filelist));
+  ui.goto_screen(TERN(HAS_MULTI_VOLUME, menu_media_select, menu_file_selector));
 }
 
-void menu_media_filelist() {
+void menu_file_selector() {
   ui.encoder_direction_menus();
 
   #if HAS_MARLINUI_U8GLIB
diff --git a/Marlin/src/sd/cardreader.cpp b/Marlin/src/sd/cardreader.cpp
@@ -28,6 +28,10 @@
 
 #if HAS_MEDIA
 
+#if HAS_MULTI_VOLUME && !SHARED_VOLUME_IS(SD_ONBOARD) && !SHARED_VOLUME_IS(USB_FLASH_DRIVE)
+  #error "DEFAULT_SHARED_VOLUME must be either SV_SD_ONBOARD or SV_USB_FLASH_DRIVE."
+#endif
+
 //#define DEBUG_CARDREADER
 
 #include "cardreader.h"
@@ -132,12 +136,12 @@ int16_t CardReader::nrItems = -1;
 
 #endif // SDCARD_SORT_ALPHA
 
-#if HAS_USB_FLASH_DRIVE
-  DiskIODriver_USBFlash CardReader::media_driver_usbFlash;
+#if HAS_SDCARD
+  CardReader::sdcard_driver_t CardReader::media_driver_sdcard;
 #endif
 
-#if NEED_SD2CARD_SDIO || NEED_SD2CARD_SPI
-  CardReader::sdcard_driver_t CardReader::media_driver_sdcard;
+#if HAS_USB_FLASH_DRIVE
+  DiskIODriver_USBFlash CardReader::media_driver_usbFlash;
 #endif
 
 DiskIODriver* CardReader::driver = nullptr;
@@ -153,13 +157,11 @@ MediaFile CardReader::file;
 uint32_t CardReader::filesize, CardReader::sdpos;
 
 CardReader::CardReader() {
-  changeMedia(&
-    #if HAS_USB_FLASH_DRIVE && !SHARED_VOLUME_IS(SD_ONBOARD)
-      media_driver_usbFlash
-    #else
-      media_driver_sdcard
-    #endif
-  );
+  #if HAS_USB_FLASH_DRIVE && !SHARED_VOLUME_IS(SD_ONBOARD)
+    selectMediaFlashDrive();
+  #else
+    selectMediaSDCard();
+  #endif
 
   #if ENABLED(SDCARD_SORT_ALPHA)
     sort_count = 0;
diff --git a/Marlin/src/sd/cardreader.h b/Marlin/src/sd/cardreader.h
@@ -60,18 +60,6 @@ extern const char M23_STR[], M24_STR[];
   #include "Sd2Card.h"
 #endif
 
-#if HAS_MULTI_VOLUME
-  #define SV_SD_ONBOARD      1
-  #define SV_USB_FLASH_DRIVE 2
-  #define _VOLUME_ID(N) _CAT(SV_, N)
-  #define SHARED_VOLUME_IS(N) (DEFAULT_SHARED_VOLUME == _VOLUME_ID(N))
-  #if !SHARED_VOLUME_IS(SD_ONBOARD) && !SHARED_VOLUME_IS(USB_FLASH_DRIVE)
-    #error "DEFAULT_SHARED_VOLUME must be either SD_ONBOARD or USB_FLASH_DRIVE."
-  #endif
-#else
-  #define SHARED_VOLUME_IS(...) 0
-#endif
-
 typedef struct {
   bool saving:1,                // Receiving a G-code file or logging commands during a print
        logging:1,               // Log enqueued commands to the open file. See GCodeQueue::advance()
@@ -114,15 +102,76 @@ class CardReader {
 
   CardReader();
 
+  /**
+   * Media Selection - Only one drive may be active at a time,
+   * so switching drives (currently) returns to the root folder.
+   * TODO: Save the last-used path for each device and cd <oldpath> on mount.
+   */
   static void changeMedia(DiskIODriver *_driver) { driver = _driver; }
 
-  static MediaFile getroot() { return root; }
+  static DiskIODriver* diskIODriver() { return driver; }
+
+  #if HAS_SDCARD
+    typedef TERN(NEED_SD2CARD_SDIO, DiskIODriver_SDIO, DiskIODriver_SPI_SD) sdcard_driver_t;
+    static sdcard_driver_t media_driver_sdcard;
+  #endif
+
+  #if HAS_USB_FLASH_DRIVE
+    static DiskIODriver_USBFlash media_driver_usbFlash;
+  #endif
+
+  static void selectMediaSDCard() {
+    #if HAS_SDCARD
+      changeMedia(&media_driver_sdcard);
+    #endif
+  }
+
+  static void selectMediaFlashDrive() {
+    #if HAS_USB_FLASH_DRIVE
+      changeMedia(&media_driver_usbFlash);
+    #endif
+  }
+
+  static bool isSDCardSelected() {
+    return TERN0(HAS_SDCARD, TERN1(HAS_MULTI_VOLUME, driver == &media_driver_sdcard));
+  }
+  static bool isFlashDriveSelected() {
+    return TERN0(HAS_USB_FLASH_DRIVE, TERN1(HAS_MULTI_VOLUME, driver == &media_driver_usbFlash));
+  }
+  static bool isMediaSelected() {
+    return isSDCardSelected() || isFlashDriveSelected();
+  }
+
+  /**
+   * Media Detection - Inserted, Mounted, Job Running, Job Paused, etc.
+   *
+   * Marlin 2.1.x supports up to two drives, either an SD Card or USB-FD
+   * Onboard SD may have SPI or SDIO interface. USB FD may use MSC.
+   */
+
+  // No card detect line? Assume the card is inserted.
+  static bool isSDCardInserted() {
+    return (
+      #if HAS_SD_DETECT
+        READ(SD_DETECT_PIN) == SD_DETECT_STATE
+      #else
+        ENABLED(HAS_SDCARD)
+      #endif
+    );
+  }
+
+  // Use the isInserted state from the driver
+  static bool isFlashDriveInserted() { return TERN0(HAS_USB_FLASH_DRIVE, DiskIODriver_USBFlash::isInserted()); }
 
+  // NOTE: If the SD Card has no DETECT line this always returns true
+  static bool isInserted() { return isFlashDriveInserted() || isSDCardInserted(); }
+
+  // Mount and release physical media
   static void mount();
   static void release();
   static bool isMounted() { return flag.mounted; }
 
-  // Handle media insert/remove
+  // Handle media insert/remove (including mounting on boot-up)
   static void manage_media();
 
   // SD Card Logging
@@ -142,6 +191,9 @@ class CardReader {
     static bool selectNewestFile();
   #endif
 
+  // The root directory of the current mounted drive
+  static MediaFile getroot() { return root; }
+
   // Basic file ops
   static void openFileRead(const char * const path, const uint8_t subcall=0);
   static void openFileWrite(const char * const path);
@@ -232,7 +284,7 @@ class CardReader {
 
   // Current Working Dir - Set by cd, cdup, cdroot, and diveToFile(true, ...)
   static char* getWorkDirName()  { workDir.getDosName(filename); return filename; }
-  static MediaFile& getWorkDir()    { return workDir.isOpen() ? workDir : root; }
+  static MediaFile& getWorkDir() { return workDir.isOpen() ? workDir : root; }
 
   // Print File stats
   static uint32_t getFileSize()  { return filesize; }
@@ -246,9 +298,6 @@ class CardReader {
   static int16_t write(void *buf, uint16_t nbyte) { return file.isOpen() ? file.write(buf, nbyte) : -1; }
   static void setIndex(const uint32_t index)      { file.seekSet((sdpos = index)); }
 
-  // TODO: rename to diskIODriver()
-  static DiskIODriver* diskIODriver() { return driver; }
-
   #if ENABLED(AUTO_REPORT_SD_STATUS)
     //
     // SD Auto Reporting
@@ -257,17 +306,17 @@ class CardReader {
     static AutoReporter<AutoReportSD> auto_reporter;
   #endif
 
-  #if SHARED_VOLUME_IS(USB_FLASH_DRIVE) || HAS_USB_FLASH_DRIVE
-    #define HAS_USB_FLASH_DRIVE 1
-    static DiskIODriver_USBFlash media_driver_usbFlash;
-  #endif
+private:
+  //
+  // Driver, volume, and temporary file
+  //
+  static DiskIODriver *driver;
+  static MarlinVolume volume;
 
-  #if NEED_SD2CARD_SDIO || NEED_SD2CARD_SPI
-    typedef TERN(NEED_SD2CARD_SDIO, DiskIODriver_SDIO, DiskIODriver_SPI_SD) sdcard_driver_t;
-    static sdcard_driver_t media_driver_sdcard;
-  #endif
+  static MediaFile file;
+  static uint32_t filesize, // Total size of the current file, in bytes
+                  sdpos;    // Index most recently read (one behind file.getPos)
 
-private:
   //
   // Working directory and parents
   //
@@ -330,13 +379,6 @@ class CardReader {
 
   #endif // SDCARD_SORT_ALPHA
 
-  static DiskIODriver *driver;
-  static MarlinVolume volume;
-  static MediaFile file;
-
-  static uint32_t filesize, // Total size of the current file, in bytes
-                  sdpos;    // Index most recently read (one behind file.getPos)
-
   //
   // Procedure calls to other files
   //
diff --git a/Marlin/src/sd/usb_flashdrive/Sd2Card_FlashDrive.cpp b/Marlin/src/sd/usb_flashdrive/Sd2Card_FlashDrive.cpp
