2016-03-25 06:19:46 +00:00
/**
2016-03-24 18:01:20 +00:00
* Marlin 3 D Printer Firmware
2019-02-12 21:06:53 +00:00
* Copyright ( C ) 2019 MarlinFirmware [ https : //github.com/MarlinFirmware/Marlin]
2016-03-24 18:01:20 +00:00
*
* Based on Sprinter and grbl .
* Copyright ( C ) 2011 Camiel Gubbels / Erik van der Zalm
*
* This program is free software : you can redistribute it and / or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation , either version 3 of the License , or
* ( at your option ) any later version .
*
* This program is distributed in the hope that it will be useful ,
* but WITHOUT ANY WARRANTY ; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE . See the
* GNU General Public License for more details .
*
* You should have received a copy of the GNU General Public License
* along with this program . If not , see < http : //www.gnu.org/licenses/>.
*
*/
2018-11-01 20:03:45 +00:00
# pragma once
2011-11-06 20:39:53 +00:00
2018-03-07 07:42:11 +00:00
# include "../inc/MarlinConfig.h"
# if ENABLED(SDSUPPORT)
# define SD_RESORT ENABLED(SDCARD_SORT_ALPHA) && ENABLED(SDSORT_DYNAMIC_RAM)
2018-11-17 04:39:16 +00:00
# define MAX_DIR_DEPTH 10 // Maximum folder depth
# define MAXDIRNAMELENGTH 8 // DOS folder name size
# define MAXPATHNAMELENGTH (1 + (MAXDIRNAMELENGTH + 1) * (MAX_DIR_DEPTH) + 1 + FILENAME_LENGTH) // "/" + N * ("ADIRNAME/") + "filename.ext"
2013-05-04 11:18:02 +00:00
2011-11-19 12:13:34 +00:00
# include "SdFile.h"
2016-08-03 02:36:58 +00:00
2018-10-01 10:19:35 +00:00
enum LsAction : uint8_t { LS_SerialPrint , LS_Count , LS_GetFilename } ;
2018-11-17 04:39:16 +00:00
typedef struct {
bool saving : 1 ,
logging : 1 ,
sdprinting : 1 ,
2019-01-12 02:42:11 +00:00
detected : 1 ,
2018-11-17 04:39:16 +00:00
filenameIsDir : 1 ,
abort_sd_printing : 1
2019-02-28 01:57:48 +00:00
# if ENABLED(BINARY_FILE_TRANSFER)
2018-11-17 04:39:16 +00:00
, binary_mode : 1
# endif
;
} card_flags_t ;
2015-03-02 15:06:01 +00:00
class CardReader {
2011-11-06 20:39:53 +00:00
public :
CardReader ( ) ;
2015-03-02 15:06:01 +00:00
2018-11-17 04:39:16 +00:00
static void initsd ( ) ;
static void write_command ( char * buf ) ;
2011-11-06 20:39:53 +00:00
2018-11-17 04:39:16 +00:00
static void beginautostart ( ) ;
static void checkautostart ( ) ;
2018-05-01 06:01:02 +00:00
2018-11-17 04:39:16 +00:00
static void openFile ( char * const path , const bool read , const bool subcall = false ) ;
static void openLogFile ( char * const path ) ;
static void removeFile ( const char * const name ) ;
static void closefile ( const bool store_location = false ) ;
static void release ( ) ;
static void openAndPrintFile ( const char * name ) ;
static void startFileprint ( ) ;
static void stopSDPrint (
2018-03-07 07:42:11 +00:00
# if SD_RESORT
const bool re_sort = false
# endif
) ;
2019-02-24 04:53:01 +00:00
static void report_status ( ) ;
2018-11-17 04:39:16 +00:00
static void printingHasFinished ( ) ;
2019-02-24 04:53:01 +00:00
static void printFilename ( ) ;
2011-11-19 19:18:54 +00:00
2015-07-31 05:21:18 +00:00
# if ENABLED(LONG_FILENAME_HOST_SUPPORT)
2019-02-24 04:53:01 +00:00
static void printLongPath ( char * path ) ;
2015-05-18 00:36:32 +00:00
# endif
2018-11-17 04:39:16 +00:00
static void getfilename ( uint16_t nr , const char * const match = NULL ) ;
static uint16_t getnrfilenames ( ) ;
2015-03-02 15:06:01 +00:00
2018-11-17 04:39:16 +00:00
static void getAbsFilename ( char * t ) ;
2011-11-06 21:48:15 +00:00
2019-02-24 04:53:01 +00:00
static void ls ( ) ;
2018-11-17 04:39:16 +00:00
static void chdir ( const char * relpath ) ;
static int8_t updir ( ) ;
static void setroot ( ) ;
2011-12-26 08:20:33 +00:00
2018-11-17 04:39:16 +00:00
static const char * diveToFile ( SdFile * & curDir , const char * const path , const bool echo ) ;
2018-05-24 06:18:56 +00:00
2018-11-17 04:39:16 +00:00
static uint16_t get_num_Files ( ) ;
2017-09-06 11:28:32 +00:00
2017-02-09 13:02:25 +00:00
# if ENABLED(SDCARD_SORT_ALPHA)
2018-11-17 04:39:16 +00:00
static void presort ( ) ;
static void getfilename_sorted ( const uint16_t nr ) ;
2017-02-09 13:02:25 +00:00
# if ENABLED(SDSORT_GCODE)
2018-11-17 04:39:16 +00:00
FORCE_INLINE static void setSortOn ( bool b ) { sort_alpha = b ; presort ( ) ; }
FORCE_INLINE static void setSortFolders ( int i ) { sort_folders = i ; presort ( ) ; }
//FORCE_INLINE static void setSortReverse(bool b) { sort_reverse = b; }
2017-02-09 13:02:25 +00:00
# endif
2018-10-29 18:54:04 +00:00
# else
2018-11-17 04:39:16 +00:00
FORCE_INLINE static void getfilename_sorted ( const uint16_t nr ) { getfilename ( nr ) ; }
2017-02-09 13:02:25 +00:00
# endif
2018-04-22 00:41:26 +00:00
# if ENABLED(POWER_LOSS_RECOVERY)
2018-11-17 04:39:16 +00:00
static bool jobRecoverFileExists ( ) ;
static void openJobRecoveryFile ( const bool read ) ;
static void removeJobRecoveryFile ( ) ;
2018-04-22 00:41:26 +00:00
# endif
2018-11-17 04:39:16 +00:00
static inline void pauseSDPrint ( ) { flag . sdprinting = false ; }
2019-01-12 02:42:11 +00:00
static inline bool isDetected ( ) { return flag . detected ; }
static inline bool isFileOpen ( ) { return isDetected ( ) & & file . isOpen ( ) ; }
static inline bool isPaused ( ) { return isFileOpen ( ) & & ! flag . sdprinting ; }
static inline bool isPrinting ( ) { return flag . sdprinting ; }
2018-11-17 04:39:16 +00:00
static inline bool eof ( ) { return sdpos > = filesize ; }
static inline int16_t get ( ) { sdpos = file . curPosition ( ) ; return ( int16_t ) file . read ( ) ; }
static inline void setIndex ( const uint32_t index ) { sdpos = index ; file . seekSet ( index ) ; }
static inline uint32_t getIndex ( ) { return sdpos ; }
static inline uint8_t percentDone ( ) { return ( isFileOpen ( ) & & filesize ) ? sdpos / ( ( filesize + 99 ) / 100 ) : 0 ; }
static inline char * getWorkDirName ( ) { workDir . getFilename ( filename ) ; return filename ; }
static inline int16_t read ( void * buf , uint16_t nbyte ) { return file . isOpen ( ) ? file . read ( buf , nbyte ) : - 1 ; }
static inline int16_t write ( void * buf , uint16_t nbyte ) { return file . isOpen ( ) ? file . write ( buf , nbyte ) : - 1 ; }
2018-07-07 03:32:15 +00:00
2018-11-17 04:39:16 +00:00
static Sd2Card & getSd2Card ( ) { return sd2card ; }
2018-02-26 21:38:27 +00:00
# if ENABLED(AUTO_REPORT_SD_STATUS)
2018-11-17 04:39:16 +00:00
static void auto_report_sd_status ( void ) ;
2019-02-24 04:53:01 +00:00
static inline void set_auto_report_interval ( const uint8_t v ) {
2018-02-26 21:38:27 +00:00
# if NUM_SERIAL > 1
2019-02-24 04:53:01 +00:00
auto_report_port = serial_port_index ;
2018-02-26 21:38:27 +00:00
# endif
NOMORE ( v , 60 ) ;
auto_report_sd_interval = v ;
next_sd_report_ms = millis ( ) + 1000UL * v ;
}
# endif
2018-11-17 04:39:16 +00:00
static inline char * longest_filename ( ) { return longFilename [ 0 ] ? longFilename : filename ; }
2018-07-13 06:44:27 +00:00
2011-11-06 20:39:53 +00:00
public :
2018-11-17 04:39:16 +00:00
static card_flags_t flag ;
2018-11-20 11:36:19 +00:00
static char filename [ FILENAME_LENGTH ] , longFilename [ LONG_FILENAME_LENGTH ] ;
2018-11-17 04:39:16 +00:00
static int8_t autostart_index ;
2018-10-31 00:44:12 +00:00
2019-02-28 01:57:48 +00:00
# if ENABLED(BINARY_FILE_TRANSFER)
2018-10-31 00:44:12 +00:00
# if NUM_SERIAL > 1
2019-02-24 04:53:01 +00:00
static int8_t transfer_port ;
2018-10-31 00:44:12 +00:00
# else
2019-02-28 01:57:48 +00:00
static constexpr int8_t transfer_port = 0 ;
2018-10-31 00:44:12 +00:00
# endif
# endif
2011-11-06 21:48:15 +00:00
private :
2018-11-17 04:39:16 +00:00
static SdFile root , workDir , workDirParents [ MAX_DIR_DEPTH ] ;
static uint8_t workDirDepth ;
2017-02-09 13:02:25 +00:00
// Sort files and folders alphabetically.
# if ENABLED(SDCARD_SORT_ALPHA)
2018-11-17 04:39:16 +00:00
static uint16_t sort_count ; // Count of sorted items in the current directory
2017-02-09 13:02:25 +00:00
# if ENABLED(SDSORT_GCODE)
2018-11-17 04:39:16 +00:00
static bool sort_alpha ; // Flag to enable / disable the feature
static int sort_folders ; // Folder sorting before/none/after
//static bool sort_reverse; // Flag to enable / disable reverse sorting
2017-02-09 13:02:25 +00:00
# endif
2017-02-09 13:05:34 +00:00
// By default the sort index is static
# if ENABLED(SDSORT_DYNAMIC_RAM)
2018-11-17 04:39:16 +00:00
static uint8_t * sort_order ;
2017-02-09 13:05:34 +00:00
# else
2018-11-17 04:39:16 +00:00
static uint8_t sort_order [ SDSORT_LIMIT ] ;
2017-02-09 13:05:34 +00:00
# endif
2017-02-09 13:02:25 +00:00
2017-10-19 03:18:51 +00:00
# if ENABLED(SDSORT_USES_RAM) && ENABLED(SDSORT_CACHE_NAMES) && DISABLED(SDSORT_DYNAMIC_RAM)
# define SORTED_LONGNAME_MAXLEN ((SDSORT_CACHE_VFATS) * (FILENAME_LENGTH) + 1)
# else
# define SORTED_LONGNAME_MAXLEN LONG_FILENAME_LENGTH
# endif
2017-02-09 13:02:25 +00:00
// Cache filenames to speed up SD menus.
# if ENABLED(SDSORT_USES_RAM)
// If using dynamic ram for names, allocate on the heap.
# if ENABLED(SDSORT_CACHE_NAMES)
2017-02-09 13:05:34 +00:00
# if ENABLED(SDSORT_DYNAMIC_RAM)
2018-11-17 04:39:16 +00:00
static char * * sortshort , * * sortnames ;
2017-02-09 13:05:34 +00:00
# else
2018-11-20 11:36:19 +00:00
static char sortshort [ SDSORT_LIMIT ] [ FILENAME_LENGTH ] ;
static char sortnames [ SDSORT_LIMIT ] [ SORTED_LONGNAME_MAXLEN ] ;
2017-02-09 13:05:34 +00:00
# endif
2017-02-09 13:02:25 +00:00
# elif DISABLED(SDSORT_USES_STACK)
2018-11-20 11:36:19 +00:00
static char sortnames [ SDSORT_LIMIT ] [ SORTED_LONGNAME_MAXLEN ] ;
2017-02-09 13:02:25 +00:00
# endif
// Folder sorting uses an isDir array when caching items.
2017-02-09 13:05:34 +00:00
# if HAS_FOLDER_SORTING
# if ENABLED(SDSORT_DYNAMIC_RAM)
2018-11-17 04:39:16 +00:00
static uint8_t * isDir ;
2017-02-09 13:05:34 +00:00
# elif ENABLED(SDSORT_CACHE_NAMES) || DISABLED(SDSORT_USES_STACK)
2018-11-17 04:39:16 +00:00
static uint8_t isDir [ ( SDSORT_LIMIT + 7 ) > > 3 ] ;
2017-02-09 13:05:34 +00:00
# endif
2017-02-09 13:02:25 +00:00
# endif
# endif // SDSORT_USES_RAM
# endif // SDCARD_SORT_ALPHA
2018-11-17 04:39:16 +00:00
static Sd2Card sd2card ;
static SdVolume volume ;
static SdFile file ;
# ifndef SD_PROCEDURE_DEPTH
# define SD_PROCEDURE_DEPTH 1
# endif
static uint8_t file_subcall_ctr ;
static uint32_t filespos [ SD_PROCEDURE_DEPTH ] ;
2018-11-20 11:36:19 +00:00
static char proc_filenames [ SD_PROCEDURE_DEPTH ] [ MAXPATHNAMELENGTH ] ;
2018-11-17 04:39:16 +00:00
static uint32_t filesize , sdpos ;
static LsAction lsAction ; //stored for recursion.
static uint16_t nrFiles ; //counter for the files in the current directory and recycled as position counter for getting the nrFiles'th name in the directory.
static char * diveDirName ;
2019-02-24 04:53:01 +00:00
static void lsDive ( const char * prepend , SdFile parent , const char * const match = NULL ) ;
2017-02-09 13:02:25 +00:00
# if ENABLED(SDCARD_SORT_ALPHA)
2018-11-17 04:39:16 +00:00
static void flush_presort ( ) ;
2017-02-09 13:02:25 +00:00
# endif
2018-02-26 21:38:27 +00:00
# if ENABLED(AUTO_REPORT_SD_STATUS)
static uint8_t auto_report_sd_interval ;
static millis_t next_sd_report_ms ;
# if NUM_SERIAL > 1
2019-02-24 04:53:01 +00:00
static int8_t auto_report_port ;
2018-02-26 21:38:27 +00:00
# endif
# endif
2011-11-06 20:39:53 +00:00
} ;
2015-03-02 15:06:01 +00:00
2018-07-02 15:06:17 +00:00
# if ENABLED(USB_FLASH_DRIVE_SUPPORT)
2018-10-19 18:52:44 +00:00
# define IS_SD_INSERTED() Sd2Card::isInserted()
2018-07-02 15:06:17 +00:00
# elif PIN_EXISTS(SD_DETECT)
2015-07-31 23:40:50 +00:00
# if ENABLED(SD_DETECT_INVERTED)
2018-10-19 18:59:50 +00:00
# define IS_SD_INSERTED() READ(SD_DETECT_PIN)
2015-03-02 15:06:01 +00:00
# else
2018-10-19 18:59:50 +00:00
# define IS_SD_INSERTED() !READ(SD_DETECT_PIN)
2015-03-02 15:06:01 +00:00
# endif
2012-12-03 11:52:00 +00:00
# else
2018-03-07 07:42:11 +00:00
// No card detect line? Assume the card is inserted.
2018-10-19 18:52:44 +00:00
# define IS_SD_INSERTED() true
2012-12-03 11:52:00 +00:00
# endif
2018-11-17 04:39:16 +00:00
# define IS_SD_PRINTING() card.flag.sdprinting
2018-11-01 20:03:45 +00:00
# define IS_SD_FILE_OPEN() card.isFileOpen()
2018-03-07 07:42:11 +00:00
extern CardReader card ;
2018-11-01 20:03:45 +00:00
# else // !SDSUPPORT
2018-03-07 07:42:11 +00:00
2018-11-01 20:03:45 +00:00
# define IS_SD_PRINTING() false
# define IS_SD_FILE_OPEN() false
2011-11-19 19:18:54 +00:00
2018-11-01 20:03:45 +00:00
# endif // !SDSUPPORT