diff --git a/Marlin/src/sd/SdBaseFile.cpp b/Marlin/src/sd/SdBaseFile.cpp
new file mode 100644
index 000000000000..e3f95623acbc
--- /dev/null
+++ b/Marlin/src/sd/SdBaseFile.cpp
@@ -0,0 +1,2258 @@
+/**
+ * Marlin 3D Printer Firmware
+ * Copyright (c) 2020 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
+ *
+ * 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 .
+ *
+ */
+
+#if __GNUC__ > 8
+ #pragma GCC diagnostic ignored "-Waddress-of-packed-member"
+#endif
+
+/**
+ * sd/SdBaseFile.cpp
+ *
+ * Arduino SdFat Library
+ * Copyright (c) 2009 by William Greiman
+ *
+ * This file is part of the Arduino Sd2Card Library
+ */
+
+#include "../inc/MarlinConfig.h"
+
+#if ENABLED(SDSUPPORT)
+
+#include "SdBaseFile.h"
+
+#include "../MarlinCore.h"
+SdBaseFile *SdBaseFile::cwd_ = 0; // Pointer to Current Working Directory
+
+// callback function for date/time
+void (*SdBaseFile::dateTime_)(uint16_t *date, uint16_t *time) = 0;
+
+// add a cluster to a file
+bool SdBaseFile::addCluster() {
+ if (ENABLED(SDCARD_READONLY)) return false;
+
+ if (!vol_->allocContiguous(1, &curCluster_)) return false;
+
+ // if first cluster of file link to directory entry
+ if (firstCluster_ == 0) {
+ firstCluster_ = curCluster_;
+ flags_ |= F_FILE_DIR_DIRTY;
+ }
+ return true;
+}
+
+// Add a cluster to a directory file and zero the cluster.
+// return with first block of cluster in the cache
+bool SdBaseFile::addDirCluster() {
+ if (ENABLED(SDCARD_READONLY)) return false;
+
+ uint32_t block;
+ // max folder size
+ if (fileSize_ / sizeof(dir_t) >= 0xFFFF) return false;
+
+ if (!addCluster()) return false;
+ if (!vol_->cacheFlush()) return false;
+
+ block = vol_->clusterStartBlock(curCluster_);
+
+ // set cache to first block of cluster
+ vol_->cacheSetBlockNumber(block, true);
+
+ // zero first block of cluster
+ memset(vol_->cacheBuffer_.data, 0, 512);
+
+ // zero rest of cluster
+ for (uint8_t i = 1; i < vol_->blocksPerCluster_; i++) {
+ if (!vol_->writeBlock(block + i, vol_->cacheBuffer_.data)) return false;
+ }
+ // Increase directory file size by cluster size
+ fileSize_ += 512UL << vol_->clusterSizeShift_;
+ return true;
+}
+
+// cache a file's directory entry
+// cache the current "dirBlock_" and return the entry at index "dirIndex_"
+// return pointer to cached entry or null for failure
+dir_t* SdBaseFile::cacheDirEntry(uint8_t action) {
+ if (!vol_->cacheRawBlock(dirBlock_, action)) return nullptr;
+ return vol_->cache()->dir + dirIndex_;
+}
+
+/**
+ * Close a file and force cached data and directory information
+ * to be written to the storage device.
+ *
+ * \return true for success, false for failure.
+ * Reasons for failure include no file is open or an I/O error.
+ */
+bool SdBaseFile::close() {
+ bool rtn = sync();
+ type_ = FAT_FILE_TYPE_CLOSED;
+ return rtn;
+}
+
+/**
+ * Check for contiguous file and return its raw block range.
+ *
+ * \param[out] bgnBlock the first block address for the file.
+ * \param[out] endBlock the last block address for the file.
+ *
+ * \return true for success, false for failure.
+ * Reasons for failure include file is not contiguous, file has zero length
+ * or an I/O error occurred.
+ */
+bool SdBaseFile::contiguousRange(uint32_t *bgnBlock, uint32_t *endBlock) {
+ // error if no blocks
+ if (firstCluster_ == 0) return false;
+
+ for (uint32_t c = firstCluster_; ; c++) {
+ uint32_t next;
+ if (!vol_->fatGet(c, &next)) return false;
+
+ // check for contiguous
+ if (next != (c + 1)) {
+ // error if not end of chain
+ if (!vol_->isEOC(next)) return false;
+ *bgnBlock = vol_->clusterStartBlock(firstCluster_);
+ *endBlock = vol_->clusterStartBlock(c)
+ + vol_->blocksPerCluster_ - 1;
+ return true;
+ }
+ }
+ return false;
+}
+
+/**
+ * Create and open a new contiguous file of a specified size.
+ *
+ * \note This function only supports short DOS 8.3 names.
+ * See open() for more information.
+ *
+ * \param[in] dirFile The directory where the file will be created.
+ * \param[in] path A path with a valid DOS 8.3 file name.
+ * \param[in] size The desired file size.
+ *
+ * \return true for success, false for failure.
+ * Reasons for failure include \a path contains
+ * an invalid DOS 8.3 file name, the FAT volume has not been initialized,
+ * a file is already open, the file already exists, the root
+ * directory is full or an I/O error.
+ */
+bool SdBaseFile::createContiguous(SdBaseFile *dirFile, const char *path, uint32_t size) {
+ if (ENABLED(SDCARD_READONLY)) return false;
+
+ uint32_t count;
+ // don't allow zero length file
+ if (size == 0) return false;
+ if (!open(dirFile, path, O_CREAT | O_EXCL | O_RDWR)) return false;
+
+ // calculate number of clusters needed
+ count = ((size - 1) >> (vol_->clusterSizeShift_ + 9)) + 1;
+
+ // allocate clusters
+ if (!vol_->allocContiguous(count, &firstCluster_)) {
+ remove();
+ return false;
+ }
+ fileSize_ = size;
+
+ // insure sync() will update dir entry
+ flags_ |= F_FILE_DIR_DIRTY;
+
+ return sync();
+}
+
+/**
+ * Return a file's directory entry.
+ *
+ * \param[out] dir Location for return of the file's directory entry.
+ *
+ * \return true for success, false for failure.
+ */
+bool SdBaseFile::dirEntry(dir_t *dir) {
+ // make sure fields on SD are correct
+ if (!sync()) return false;
+
+ // read entry
+ dir_t *p = cacheDirEntry(SdVolume::CACHE_FOR_READ);
+ if (!p) return false;
+
+ // copy to caller's struct
+ memcpy(dir, p, sizeof(dir_t));
+ return true;
+}
+
+/**
+ * Format the name field of \a dir into the 13 byte array
+ * \a name in standard 8.3 short name format.
+ *
+ * \param[in] dir The directory structure containing the name.
+ * \param[out] name A 13 byte char array for the formatted name.
+ */
+void SdBaseFile::dirName(const dir_t &dir, char *name) {
+ uint8_t j = 0;
+ LOOP_L_N(i, 11) {
+ if (dir.name[i] == ' ')continue;
+ if (i == 8) name[j++] = '.';
+ name[j++] = dir.name[i];
+ }
+ name[j] = 0;
+}
+
+/**
+ * Test for the existence of a file in a directory
+ *
+ * \param[in] name Name of the file to be tested for.
+ *
+ * The calling instance must be an open directory file.
+ *
+ * dirFile.exists("TOFIND.TXT") searches for "TOFIND.TXT" in the directory
+ * dirFile.
+ *
+ * \return true if the file exists else false.
+ */
+bool SdBaseFile::exists(const char *name) {
+ SdBaseFile file;
+ return file.open(this, name, O_READ);
+}
+
+/**
+ * Get a string from a file.
+ *
+ * fgets() reads bytes from a file into the array pointed to by \a str, until
+ * \a num - 1 bytes are read, or a delimiter is read and transferred to \a str,
+ * or end-of-file is encountered. The string is then terminated
+ * with a null byte.
+ *
+ * fgets() deletes CR, '\\r', from the string. This insures only a '\\n'
+ * terminates the string for Windows text files which use CRLF for newline.
+ *
+ * \param[out] str Pointer to the array where the string is stored.
+ * \param[in] num Maximum number of characters to be read
+ * (including the final null byte). Usually the length
+ * of the array \a str is used.
+ * \param[in] delim Optional set of delimiters. The default is "\n".
+ *
+ * \return For success fgets() returns the length of the string in \a str.
+ * If no data is read, fgets() returns zero for EOF or -1 if an error occurred.
+ **/
+int16_t SdBaseFile::fgets(char *str, int16_t num, char *delim) {
+ char ch;
+ int16_t n = 0;
+ int16_t r = -1;
+ while ((n + 1) < num && (r = read(&ch, 1)) == 1) {
+ // delete CR
+ if (ch == '\r') continue;
+ str[n++] = ch;
+ if (!delim) {
+ if (ch == '\n') break;
+ }
+ else {
+ if (strchr(delim, ch)) break;
+ }
+ }
+ if (r < 0) {
+ // read error
+ return -1;
+ }
+ str[n] = '\0';
+ return n;
+}
+
+/**
+ * Get a file's name
+ *
+ * \param[out] name An array of 13 characters for the file's name.
+ *
+ * \return true for success, false for failure.
+ */
+bool SdBaseFile::getDosName(char * const name) {
+ if (!isOpen()) return false;
+
+ if (isRoot()) {
+ name[0] = '/';
+ name[1] = '\0';
+ return true;
+ }
+ // cache entry
+ dir_t *p = cacheDirEntry(SdVolume::CACHE_FOR_READ);
+ if (!p) return false;
+
+ // format name
+ dirName(*p, name);
+ return true;
+}
+
+void SdBaseFile::getpos(filepos_t *pos) {
+ pos->position = curPosition_;
+ pos->cluster = curCluster_;
+}
+
+/**
+ * List directory contents.
+ *
+ * \param[in] pr Print stream for list.
+ *
+ * \param[in] flags The inclusive OR of
+ *
+ * LS_DATE - %Print file modification date
+ *
+ * LS_SIZE - %Print file size.
+ *
+ * LS_R - Recursive list of subdirectories.
+ *
+ * \param[in] indent Amount of space before file name. Used for recursive
+ * list to indicate subdirectory level.
+ */
+void SdBaseFile::ls(uint8_t flags, uint8_t indent) {
+ rewind();
+ int8_t status;
+ while ((status = lsPrintNext(flags, indent))) {
+ if (status > 1 && (flags & LS_R)) {
+ uint16_t index = curPosition() / 32 - 1;
+ SdBaseFile s;
+ if (s.open(this, index, O_READ)) s.ls(flags, indent + 2);
+ seekSet(32 * (index + 1));
+ }
+ }
+}
+
+// saves 32 bytes on stack for ls recursion
+// return 0 - EOF, 1 - normal file, or 2 - directory
+int8_t SdBaseFile::lsPrintNext(uint8_t flags, uint8_t indent) {
+ dir_t dir;
+ uint8_t w = 0;
+
+ while (1) {
+ if (read(&dir, sizeof(dir)) != sizeof(dir)) return 0;
+ if (dir.name[0] == DIR_NAME_FREE) return 0;
+
+ // skip deleted entry and entries for . and ..
+ if (dir.name[0] != DIR_NAME_DELETED && dir.name[0] != '.'
+ && DIR_IS_FILE_OR_SUBDIR(&dir)) break;
+ }
+ // indent for dir level
+ LOOP_L_N(i, indent) SERIAL_CHAR(' ');
+
+ // print name
+ LOOP_L_N(i, 11) {
+ if (dir.name[i] == ' ')continue;
+ if (i == 8) {
+ SERIAL_CHAR('.');
+ w++;
+ }
+ SERIAL_CHAR(dir.name[i]);
+ w++;
+ }
+ if (DIR_IS_SUBDIR(&dir)) {
+ SERIAL_CHAR('/');
+ w++;
+ }
+ if (flags & (LS_DATE | LS_SIZE)) {
+ while (w++ < 14) SERIAL_CHAR(' ');
+ }
+ // print modify date/time if requested
+ if (flags & LS_DATE) {
+ SERIAL_CHAR(' ');
+ printFatDate(dir.lastWriteDate);
+ SERIAL_CHAR(' ');
+ printFatTime(dir.lastWriteTime);
+ }
+ // print size if requested
+ if (!DIR_IS_SUBDIR(&dir) && (flags & LS_SIZE)) {
+ SERIAL_CHAR(' ');
+ SERIAL_ECHO(dir.fileSize);
+ }
+ SERIAL_EOL();
+ return DIR_IS_FILE(&dir) ? 1 : 2;
+}
+
+/**
+ * Calculate a checksum for an 8.3 filename
+ *
+ * \param name The 8.3 file name to calculate
+ *
+ * \return The checksum byte
+ */
+uint8_t lfn_checksum(const uint8_t *name) {
+ uint8_t sum = 0;
+ for (uint8_t i = 11; i; i--)
+ sum = ((sum & 1) << 7) + (sum >> 1) + *name++;
+ return sum;
+}
+
+// Format directory name field from a 8.3 name string
+bool SdBaseFile::make83Name(const char *str, uint8_t *name, const char **ptr) {
+ uint8_t n = 7, // Max index until a dot is found
+ i = 11;
+ while (i) name[--i] = ' '; // Set whole FILENAME.EXT to spaces
+ while (*str && *str != '/') { // For each character, until nul or '/'
+ uint8_t c = *str++; // Get char and advance
+ if (c == '.') { // For a dot...
+ if (n == 10) return false; // Already moved the max index? fail!
+ n = 10; // Move the max index for full 8.3 name
+ i = 8; // Move up to the extension place
+ }
+ else {
+ // Fail for illegal characters
+ PGM_P p = PSTR("|<>^+=?/[];,*\"\\");
+ while (uint8_t b = pgm_read_byte(p++)) if (b == c) return false;
+ if (i > n || c < 0x21 || c == 0x7F) return false; // Check size, non-printable characters
+ name[i++] = c + (WITHIN(c, 'a', 'z') ? 'A' - 'a' : 0); // Uppercase required for 8.3 name
+ }
+ }
+ *ptr = str; // Set passed pointer to the end
+ return name[0] != ' '; // Return true if any name was set
+}
+
+/**
+ * Make a new directory.
+ *
+ * \param[in] parent An open SdFat instance for the directory that will contain
+ * the new directory.
+ *
+ * \param[in] path A path with a valid 8.3 DOS name for the new directory.
+ *
+ * \param[in] pFlag Create missing parent directories if true.
+ *
+ * \return true for success, false for failure.
+ * Reasons for failure include this file is already open, \a parent is not a
+ * directory, \a path is invalid or already exists in \a parent.
+ */
+bool SdBaseFile::mkdir(SdBaseFile *parent, const char *path, bool pFlag) {
+ if (ENABLED(SDCARD_READONLY)) return false;
+
+ uint8_t dname[11];
+ SdBaseFile dir1, dir2;
+ SdBaseFile *sub = &dir1;
+ SdBaseFile *start = parent;
+
+ #if ENABLED(LONG_FILENAME_WRITE_SUPPORT)
+ uint8_t dlname[LONG_FILENAME_LENGTH];
+ #endif
+
+ if (!parent || isOpen()) return false;
+
+ if (*path == '/') {
+ while (*path == '/') path++;
+ if (!parent->isRoot()) {
+ if (!dir2.openRoot(parent->vol_)) return false;
+ parent = &dir2;
+ }
+ }
+
+ for (;;) {
+ if (!TERN(LONG_FILENAME_WRITE_SUPPORT, parsePath(path, dname, dlname, &path), make83Name(path, dname, &path))) return false;
+ while (*path == '/') path++;
+ if (!*path) break;
+ if (!sub->open(parent, dname OPTARG(LONG_FILENAME_WRITE_SUPPORT, dlname), O_READ)) {
+ if (!pFlag || !sub->mkdir(parent, dname OPTARG(LONG_FILENAME_WRITE_SUPPORT, dlname)))
+ return false;
+ }
+ if (parent != start) parent->close();
+ parent = sub;
+ sub = parent != &dir1 ? &dir1 : &dir2;
+ }
+ return mkdir(parent, dname OPTARG(LONG_FILENAME_WRITE_SUPPORT, dlname));
+}
+
+bool SdBaseFile::mkdir(SdBaseFile *parent, const uint8_t dname[11]
+ OPTARG(LONG_FILENAME_WRITE_SUPPORT, const uint8_t dlname[LONG_FILENAME_LENGTH])
+) {
+ if (ENABLED(SDCARD_READONLY)) return false;
+
+ if (!parent->isDir()) return false;
+
+ // create a normal file
+ if (!open(parent, dname OPTARG(LONG_FILENAME_WRITE_SUPPORT, dlname), O_CREAT | O_EXCL | O_RDWR)) return false;
+
+ // convert file to directory
+ flags_ = O_READ;
+ type_ = FAT_FILE_TYPE_SUBDIR;
+
+ // allocate and zero first cluster
+ if (!addDirCluster()) return false;
+
+ // force entry to SD
+ if (!sync()) return false;
+
+ // cache entry - should already be in cache due to sync() call
+ dir_t *p = cacheDirEntry(SdVolume::CACHE_FOR_WRITE);
+ if (!p) return false;
+
+ // change directory entry attribute
+ p->attributes = DIR_ATT_DIRECTORY;
+
+ // make entry for '.'
+ dir_t d;
+ memcpy(&d, p, sizeof(d));
+ d.name[0] = '.';
+ LOOP_S_L_N(i, 1, 11) d.name[i] = ' ';
+
+ // cache block for '.' and '..'
+ uint32_t block = vol_->clusterStartBlock(firstCluster_);
+ if (!vol_->cacheRawBlock(block, SdVolume::CACHE_FOR_WRITE)) return false;
+
+ // copy '.' to block
+ memcpy(&vol_->cache()->dir[0], &d, sizeof(d));
+
+ // make entry for '..'
+ d.name[1] = '.';
+ if (parent->isRoot()) {
+ d.firstClusterLow = 0;
+ d.firstClusterHigh = 0;
+ }
+ else {
+ d.firstClusterLow = parent->firstCluster_ & 0xFFFF;
+ d.firstClusterHigh = parent->firstCluster_ >> 16;
+ }
+ // copy '..' to block
+ memcpy(&vol_->cache()->dir[1], &d, sizeof(d));
+
+ // write first block
+ return vol_->cacheFlush();
+}
+
+/**
+ * Open a file in the current working directory.
+ *
+ * \param[in] path A path with a valid 8.3 DOS name for a file to be opened.
+ *
+ * \param[in] oflag Values for \a oflag are constructed by a bitwise-inclusive
+ * OR of open flags. see SdBaseFile::open(SdBaseFile*, const char*, uint8_t).
+ *
+ * \return true for success, false for failure.
+ */
+bool SdBaseFile::open(const char *path, uint8_t oflag) {
+ return open(cwd_, path, oflag);
+}
+
+/**
+ * Open a file or directory by name.
+ *
+ * \param[in] dirFile An open SdFat instance for the directory containing the
+ * file to be opened.
+ *
+ * \param[in] path A path with a valid 8.3 DOS name for a file to be opened.
+ *
+ * \param[in] oflag Values for \a oflag are constructed by a bitwise-inclusive
+ * OR of flags from the following list
+ *
+ * O_READ - Open for reading.
+ *
+ * O_RDONLY - Same as O_READ.
+ *
+ * O_WRITE - Open for writing.
+ *
+ * O_WRONLY - Same as O_WRITE.
+ *
+ * O_RDWR - Open for reading and writing.
+ *
+ * O_APPEND - If set, the file offset shall be set to the end of the
+ * file prior to each write.
+ *
+ * O_AT_END - Set the initial position at the end of the file.
+ *
+ * O_CREAT - If the file exists, this flag has no effect except as noted
+ * under O_EXCL below. Otherwise, the file shall be created
+ *
+ * O_EXCL - If O_CREAT and O_EXCL are set, open() shall fail if the file exists.
+ *
+ * O_SYNC - Call sync() after each write. This flag should not be used with
+ * write(uint8_t), write_P(PGM_P), writeln_P(PGM_P), or the Arduino Print class.
+ * These functions do character at a time writes so sync() will be called
+ * after each byte.
+ *
+ * O_TRUNC - If the file exists and is a regular file, and the file is
+ * successfully opened and is not read only, its length shall be truncated to 0.
+ *
+ * WARNING: A given file must not be opened by more than one SdBaseFile object
+ * of file corruption may occur.
+ *
+ * \note Directory files must be opened read only. Write and truncation is
+ * not allowed for directory files.
+ *
+ * \return true for success, false for failure.
+ * Reasons for failure include this file is already open, \a dirFile is not
+ * a directory, \a path is invalid, the file does not exist
+ * or can't be opened in the access mode specified by oflag.
+ */
+bool SdBaseFile::open(SdBaseFile *dirFile, const char *path, uint8_t oflag) {
+ uint8_t dname[11];
+ SdBaseFile dir1, dir2;
+ SdBaseFile *parent = dirFile, *sub = &dir1;
+
+ #if ENABLED(LONG_FILENAME_WRITE_SUPPORT)
+ uint8_t dlname[LONG_FILENAME_LENGTH];
+ #endif
+
+ if (!dirFile || isOpen()) return false;
+
+ if (*path == '/') { // Path starts with '/'
+ if (!dirFile->isRoot()) { // Is the passed dirFile the root?
+ if (!dir2.openRoot(dirFile->vol_)) return false; // Get the root in dir2, if possible
+ parent = &dir2; // Change 'parent' to point at the root dir
+ }
+ while (*path == '/') path++; // Skip all leading slashes
+ }
+
+ for (;;) {
+ if (!TERN(LONG_FILENAME_WRITE_SUPPORT, parsePath(path, dname, dlname, &path), make83Name(path, dname, &path))) return false;
+ while (*path == '/') path++;
+ if (!*path) break;
+ if (TERN0(LONG_FILENAME_WRITE_SUPPORT, !sub->open(parent, dname, dlname, O_READ))) return false;
+ if (parent != dirFile) parent->close();
+ parent = sub;
+ sub = parent != &dir1 ? &dir1 : &dir2;
+ }
+ return open(parent, dname OPTARG(LONG_FILENAME_WRITE_SUPPORT, dlname), oflag);
+}
+
+// open with filename in dname and long filename in dlname
+bool SdBaseFile::open(SdBaseFile *dirFile, const uint8_t dname[11]
+ OPTARG(LONG_FILENAME_WRITE_SUPPORT, const uint8_t dlname[LONG_FILENAME_LENGTH])
+ , uint8_t oflag
+) {
+ bool emptyFound = false, fileFound = false;
+ uint8_t index = 0;
+ dir_t *p;
+
+ #if ENABLED(LONG_FILENAME_WRITE_SUPPORT)
+ // LFN - Long File Name support
+ const bool useLFN = dlname[0] != 0;
+ bool lfnFileFound = false;
+ vfat_t *pvFat;
+ uint8_t emptyCount = 0,
+ emptyIndex = 0,
+ reqEntriesNum = useLFN ? getLFNEntriesNum((char*)dlname) + 1 : 1,
+ lfnNameLength = useLFN ? strlen((char*)dlname) : 0,
+ lfnName[LONG_FILENAME_LENGTH],
+ lfnSequenceNumber = 0,
+ lfnChecksum = 0;
+ #endif
+
+ // Rewind this dir
+ vol_ = dirFile->vol_;
+ dirFile->rewind();
+
+ // search for file
+ while (dirFile->curPosition_ < dirFile->fileSize_) {
+ // Get absolute index position
+ index = (dirFile->curPosition_ >> 5) IF_DISABLED(LONG_FILENAME_WRITE_SUPPORT, & 0x0F);
+
+ // Get next entry
+ if (!(p = dirFile->readDirCache())) return false;
+
+ // Check empty status: Is entry empty?
+ if (p->name[0] == DIR_NAME_FREE || p->name[0] == DIR_NAME_DELETED) {
+ // Count the contiguous available entries in which (eventually) fit the new dir entry, if it's a write operation
+ if (!emptyFound) {
+ #if ENABLED(LONG_FILENAME_WRITE_SUPPORT)
+ if (emptyCount == 0) emptyIndex = index;
+ // Incr empty entries counter
+ // If found the required empty entries, mark it
+ if (++emptyCount == reqEntriesNum) {
+ dirBlock_ = dirFile->vol_->cacheBlockNumber();
+ dirIndex_ = index & 0xF;
+ emptyFound = true;
+ }
+ #else
+ dirBlock_ = dirFile->vol_->cacheBlockNumber();
+ dirIndex_ = index;
+ emptyFound = true;
+ #endif
+ }
+ // Done if no entries follow
+ if (p->name[0] == DIR_NAME_FREE) break;
+ }
+ else { // Entry not empty
+ #if ENABLED(LONG_FILENAME_WRITE_SUPPORT)
+ // Reset empty counter
+ if (!emptyFound) emptyCount = 0;
+ // Search for SFN or LFN?
+ if (!useLFN) {
+ // Check using SFN: file found?
+ if (!memcmp(dname, p->name, 11)) {
+ fileFound = true;
+ break;
+ }
+ }
+ else {
+ // Check using LFN: LFN not found? continue search for LFN
+ if (!lfnFileFound) {
+ // Is this dir a LFN?
+ if (isDirLFN(p)) {
+ // Get VFat dir entry
+ pvFat = (vfat_t *) p;
+ // Get checksum from the last entry of the sequence
+ if (pvFat->sequenceNumber & 0x40) lfnChecksum = pvFat->checksum;
+ // Get LFN sequence number
+ lfnSequenceNumber = pvFat->sequenceNumber & 0x1F;
+ if WITHIN(lfnSequenceNumber, 1, reqEntriesNum) {
+ // Check checksum for all other entries with the starting checksum fetched before
+ if (lfnChecksum == pvFat->checksum) {
+ // Set chunk of LFN from VFAT entry into lfnName
+ getLFNName(pvFat, (char *)lfnName, lfnSequenceNumber);
+ // LFN found?
+ if (!strncasecmp((char*)dlname, (char*)lfnName, lfnNameLength)) lfnFileFound = true;
+ }
+ }
+ }
+ }
+ else { // Complete LFN found, check for related SFN
+ // Check if only the SFN checksum match because the filename may be different due to different truncation methods
+ if (!isDirLFN(p) && (lfnChecksum == lfn_checksum(p->name))) {
+ fileFound = true;
+ break;
+ }
+ else lfnFileFound = false; // SFN not valid for the LFN found, reset LFN FileFound
+ }
+ }
+ #else
+
+ if (!memcmp(dname, p->name, 11)) {
+ fileFound = true;
+ break;
+ }
+
+ #endif // LONG_FILENAME_WRITE_SUPPORT
+ }
+ }
+
+ if (fileFound) {
+ // don't open existing file if O_EXCL
+ if (oflag & O_EXCL) return false;
+ TERN_(LONG_FILENAME_WRITE_SUPPORT, index &= 0xF);
+ }
+ else {
+ // don't create unless O_CREAT and O_WRITE
+ if ((oflag & (O_CREAT | O_WRITE)) != (O_CREAT | O_WRITE)) return false;
+
+ #if ENABLED(LONG_FILENAME_WRITE_SUPPORT)
+
+ // Use bookmark index if found empty entries
+ if (emptyFound) index = emptyIndex;
+
+ // Make room for needed entries
+ while (emptyCount < reqEntriesNum) {
+ p = dirFile->readDirCache();
+ if (!p) break;
+ emptyCount++;
+ }
+ while (emptyCount < reqEntriesNum) {
+ if (dirFile->type_ == FAT_FILE_TYPE_ROOT_FIXED) return false;
+ // add and zero cluster for dirFile - first cluster is in cache for write
+ if (!dirFile->addDirCluster()) return false;
+ emptyCount += dirFile->vol_->blocksPerCluster() * 16;
+ }
+
+ // Move to 1st entry to write
+ if (!dirFile->seekSet(32 * index)) return false;
+
+ // Dir entries write loop: [LFN] + SFN(1)
+ LOOP_L_N(dirWriteIdx, reqEntriesNum) {
+ index = (dirFile->curPosition_ / 32) & 0xF;
+ p = dirFile->readDirCache();
+ // LFN or SFN Entry?
+ if (dirWriteIdx < reqEntriesNum - 1) {
+ // Write LFN Entries
+ pvFat = (vfat_t *) p;
+ // initialize as empty file
+ memset(pvFat, 0, sizeof(*pvFat));
+ lfnSequenceNumber = (reqEntriesNum - dirWriteIdx - 1) & 0x1F;
+ pvFat->attributes = DIR_ATT_LONG_NAME;
+ pvFat->checksum = lfn_checksum(dname);
+ // Set sequence number and mark as last LFN entry if it's the 1st loop
+ pvFat->sequenceNumber = lfnSequenceNumber | (dirWriteIdx == 0 ? 0x40 : 0);
+ // Set LFN name block
+ setLFNName(pvFat, (char*)dlname, lfnSequenceNumber);
+ }
+ else {
+ // Write SFN Entry
+ // initialize as empty file
+ memset(p, 0, sizeof(*p));
+ memcpy(p->name, dname, 11);
+
+ // set timestamps
+ if (dateTime_) {
+ // call user date/time function
+ dateTime_(&p->creationDate, &p->creationTime);
+ }
+ else {
+ // use default date/time
+ p->creationDate = FAT_DEFAULT_DATE;
+ p->creationTime = FAT_DEFAULT_TIME;
+ }
+ p->lastAccessDate = p->creationDate;
+ p->lastWriteDate = p->creationDate;
+ p->lastWriteTime = p->creationTime;
+ }
+
+ // write entry to SD
+ dirFile->vol_->cacheSetDirty();
+ if (!dirFile->vol_->cacheFlush()) return false;
+ }
+
+ #else // !LONG_FILENAME_WRITE_SUPPORT
+
+ if (emptyFound) {
+ index = dirIndex_;
+ p = cacheDirEntry(SdVolume::CACHE_FOR_WRITE);
+ if (!p) return false;
+ }
+ else {
+ if (dirFile->type_ == FAT_FILE_TYPE_ROOT_FIXED) return false;
+
+ // add and zero cluster for dirFile - first cluster is in cache for write
+ if (!dirFile->addDirCluster()) return false;
+
+ // use first entry in cluster
+ p = dirFile->vol_->cache()->dir;
+ index = 0;
+ }
+
+ // initialize as empty file
+ memset(p, 0, sizeof(*p));
+ memcpy(p->name, dname, 11);
+
+ // set timestamps
+ if (dateTime_) {
+ // call user date/time function
+ dateTime_(&p->creationDate, &p->creationTime);
+ }
+ else {
+ // use default date/time
+ p->creationDate = FAT_DEFAULT_DATE;
+ p->creationTime = FAT_DEFAULT_TIME;
+ }
+
+ p->lastAccessDate = p->creationDate;
+ p->lastWriteDate = p->creationDate;
+ p->lastWriteTime = p->creationTime;
+
+ // write entry to SD
+ if (!dirFile->vol_->cacheFlush()) return false;
+
+ #endif // !LONG_FILENAME_WRITE_SUPPORT
+
+ }
+ // open entry in cache
+ return openCachedEntry(index, oflag);
+}
+
+/**
+ * Open a file by index.
+ *
+ * \param[in] dirFile An open SdFat instance for the directory.
+ *
+ * \param[in] index The \a index of the directory entry for the file to be
+ * opened. The value for \a index is (directory file position)/32.
+ *
+ * \param[in] oflag Values for \a oflag are constructed by a bitwise-inclusive
+ * OR of flags O_READ, O_WRITE, O_TRUNC, and O_SYNC.
+ *
+ * See open() by path for definition of flags.
+ * \return true for success or false for failure.
+ */
+bool SdBaseFile::open(SdBaseFile *dirFile, uint16_t index, uint8_t oflag) {
+ vol_ = dirFile->vol_;
+
+ // error if already open
+ if (isOpen() || !dirFile) return false;
+
+ // don't open existing file if O_EXCL - user call error
+ if (oflag & O_EXCL) return false;
+
+ // seek to location of entry
+ if (!dirFile->seekSet(32 * index)) return false;
+
+ // read entry into cache
+ dir_t *p = dirFile->readDirCache();
+ if (!p) return false;
+
+ // error if empty slot or '.' or '..'
+ if (p->name[0] == DIR_NAME_FREE ||
+ p->name[0] == DIR_NAME_DELETED || p->name[0] == '.') {
+ return false;
+ }
+ // open cached entry
+ return openCachedEntry(index & 0xF, oflag);
+}
+
+// open a cached directory entry. Assumes vol_ is initialized
+bool SdBaseFile::openCachedEntry(uint8_t dirIndex, uint8_t oflag) {
+ dir_t *p;
+
+ #if ENABLED(SDCARD_READONLY)
+ if (oflag & (O_WRITE | O_CREAT | O_TRUNC)) goto FAIL;
+ #endif
+
+ // location of entry in cache
+ p = &vol_->cache()->dir[dirIndex];
+
+ // write or truncate is an error for a directory or read-only file
+ if (p->attributes & (DIR_ATT_READ_ONLY | DIR_ATT_DIRECTORY)) {
+ if (oflag & (O_WRITE | O_TRUNC)) goto FAIL;
+ }
+ // remember location of directory entry on SD
+ dirBlock_ = vol_->cacheBlockNumber();
+ dirIndex_ = dirIndex;
+
+ // copy first cluster number for directory fields
+ firstCluster_ = (uint32_t)p->firstClusterHigh << 16;
+ firstCluster_ |= p->firstClusterLow;
+
+ // make sure it is a normal file or subdirectory
+ if (DIR_IS_FILE(p)) {
+ fileSize_ = p->fileSize;
+ type_ = FAT_FILE_TYPE_NORMAL;
+ }
+ else if (DIR_IS_SUBDIR(p)) {
+ if (!vol_->chainSize(firstCluster_, &fileSize_)) goto FAIL;
+ type_ = FAT_FILE_TYPE_SUBDIR;
+ }
+ else
+ goto FAIL;
+
+ // save open flags for read/write
+ flags_ = oflag & F_OFLAG;
+
+ // set to start of file
+ curCluster_ = 0;
+ curPosition_ = 0;
+ if ((oflag & O_TRUNC) && !truncate(0)) return false;
+ return oflag & O_AT_END ? seekEnd(0) : true;
+
+ FAIL:
+ type_ = FAT_FILE_TYPE_CLOSED;
+ return false;
+}
+
+/**
+ * Open the next file or subdirectory in a directory.
+ *
+ * \param[in] dirFile An open SdFat instance for the directory containing the
+ * file to be opened.
+ *
+ * \param[in] oflag Values for \a oflag are constructed by a bitwise-inclusive
+ * OR of flags O_READ, O_WRITE, O_TRUNC, and O_SYNC.
+ *
+ * See open() by path for definition of flags.
+ * \return true for success or false for failure.
+ */
+bool SdBaseFile::openNext(SdBaseFile *dirFile, uint8_t oflag) {
+ if (!dirFile) return false;
+
+ // error if already open
+ if (isOpen()) return false;
+
+ vol_ = dirFile->vol_;
+
+ while (1) {
+ uint8_t index = 0xF & (dirFile->curPosition_ >> 5);
+
+ // read entry into cache
+ dir_t *p = dirFile->readDirCache();
+ if (!p) return false;
+
+ // done if last entry
+ if (p->name[0] == DIR_NAME_FREE) return false;
+
+ // skip empty slot or '.' or '..'
+ if (p->name[0] == DIR_NAME_DELETED || p->name[0] == '.') {
+ continue;
+ }
+ // must be file or dir
+ if (DIR_IS_FILE_OR_SUBDIR(p)) {
+ return openCachedEntry(index, oflag);
+ }
+ }
+ return false;
+}
+
+#if ENABLED(LONG_FILENAME_WRITE_SUPPORT)
+
+ /**
+ * Check if dir is a long file name entry (LFN)
+ *
+ * \param[in] dir Parent of this directory will be opened. Must not be root.
+ * \return true if the dir is a long file name entry (LFN)
+ */
+ bool SdBaseFile::isDirLFN(const dir_t* dir) {
+ if (DIR_IS_LONG_NAME(dir)) {
+ vfat_t *VFAT = (vfat_t*)dir;
+ // Sanity-check the VFAT entry. The first cluster is always set to zero. And the sequence number should be higher than 0
+ if ((VFAT->firstClusterLow == 0) && WITHIN((VFAT->sequenceNumber & 0x1F), 1, MAX_VFAT_ENTRIES)) return true;
+ }
+ return false;
+ }
+
+ /**
+ * Check if dirname string is a long file name (LFN)
+ *
+ * \param[in] dirname The string to check
+ * \return true if the dirname is a long file name (LFN)
+ * \return false if the dirname is a short file name 8.3 (SFN)
+ */
+ bool SdBaseFile::isDirNameLFN(const char *dirname) {
+ uint8_t length = strlen(dirname);
+ uint8_t idx = length;
+ bool dotFound = false;
+ if (idx > 12) return true; // LFN due to filename length > 12 ("filename.ext")
+ // Check dot(s) position
+ while (idx) {
+ if (dirname[--idx] == '.') {
+ if (!dotFound) {
+ // Last dot (extension) is allowed only
+ // in position [1..8] from start or [0..3] from end for SFN else it's a LFN
+ // A filename starting with "." is a LFN (eg. ".file" ->in SFN-> "file~1 ")
+ // A filename ending with "." is a SFN (if length <= 9) (eg. "file." ->in SFN-> "file ")
+ if (idx > 8 || idx == 0 || (length - idx - 1) > 3) return true; // LFN due to dot extension position
+ dotFound = true;
+ }
+ else {
+ // Found another dot, is a LFN
+ return true;
+ }
+ }
+ }
+ // If no dots found, the filename must be of max 8 characters
+ if ((!dotFound) && length > 8) return true; // LFN due to max filename (without extension) length
+ return false;
+ }
+
+ /**
+ * Parse path and return 8.3 format and LFN filenames (if the parsed path is a LFN)
+ * The SFN is without dot ("FILENAMEEXT")
+ * The LFN is complete ("Filename.ext")
+ */
+ bool SdBaseFile::parsePath(const char *path, uint8_t *name, uint8_t *lname, const char **ptrNextPath) {
+ // Init randomizer for SFN generation
+ randomSeed(millis());
+ // Parse the LFN
+ uint8_t ilfn = 0;
+ bool lastDotFound = false;
+ const char *pLastDot = 0;
+ const char *lfnpath = path;
+ uint8_t c;
+
+ while (*lfnpath && *lfnpath != '/') {
+ if (ilfn == LONG_FILENAME_LENGTH - 1) return false; // Name too long
+ c = *lfnpath++; // Get char and advance
+ // Fail for illegal characters
+ PGM_P p = PSTR("|<>^+=?/[];:,*\"\\");
+ while (uint8_t b = pgm_read_byte(p++)) if (b == c) return false; // Check reserved characters
+ if (c < 0x20 || c == 0x7F) return false; // Check non-printable characters
+ if (c == '.' && (lfnpath - 1) > path) { // Skip dot '.' check in 1st position
+ // Save last dot pointer (skip if starts with '.')
+ pLastDot = lfnpath - 1;
+ lastDotFound = true;
+ }
+ lname[ilfn++] = c; // Set LFN character
+ }
+ // Terminate LFN
+ lname[ilfn] = 0;
+
+ // Parse/generate 8.3 SFN. Will take
+ // until 8 characters for the filename part
+ // until 3 characters for the extension part (if exists)
+ // Add 4 more characters if name part < 3
+ // Add '~cnt' characters if it's a LFN
+ const bool isLFN = isDirNameLFN((char*)lname);
+
+ uint8_t n = isLFN ? 5 : 7, // Max index for each component of the file:
+ // starting with 7 or 5 (if LFN)
+ // switch to 10 for extension if the last dot is found
+ i = 11;
+ while (i) name[--i] = ' '; // Set whole FILENAMEEXT to spaces
+ while (*path && *path != '/') {
+ c = *path++; // Get char and advance
+ // Skip spaces and dots (if it's not the last dot)
+ if (c == ' ') continue;
+ if (c == '.' && (!lastDotFound || (lastDotFound && path < pLastDot))) continue;
+ // Fail for illegal characters
+ PGM_P p = PSTR("|<>^+=?/[];:,*\"\\");
+ while (uint8_t b = pgm_read_byte(p++)) if (b == c) return false; // Check reserved characters
+ if (c < 0x21 || c == 0x7F) return false; // Check non-printable characters
+ // Is last dot?
+ if (c == '.') {
+ // Switch to extension part
+ n = 10;
+ i = 8;
+ }
+ // If in valid range add the character
+ else if (i <= n) // Check size for 8.3 format
+ name[i++] = c + (WITHIN(c, 'a', 'z') ? 'A' - 'a' : 0); // Uppercase required for 8.3 name
+ }
+ // If it's a LFN then the SFN always need:
+ // - A minimal of 3 characters (otherwise 4 chars are added)
+ // - The '~cnt' at the end
+ if (isLFN) {
+ // Get the 1st free character
+ uint8_t iFree = 0;
+ while (1) if (name[iFree++] == ' ' || iFree == 11) break;
+ iFree--;
+ // Check minimal length
+ if (iFree < 3) {
+ // Append 4 extra characters
+ name[iFree++] = random(0,24) + 'A'; name[iFree++] = random(0,24) + 'A';
+ name[iFree++] = random(0,24) + 'A'; name[iFree++] = random(0,24) + 'A';
+ }
+ // Append '~cnt' characters
+ if (iFree > 5) iFree = 5; // Force the append in the last 3 characters of name part
+ name[iFree++] = '~';
+ name[iFree++] = random(1,9) + '0';
+ name[iFree++] = random(1,9) + '0';
+ }
+
+ // Check if LFN is needed
+ if (!isLFN) lname[0] = 0; // Zero LFN
+ *ptrNextPath = path; // Set passed pointer to the end
+ return name[0] != ' '; // Return true if any name was set
+ }
+
+ /**
+ * Get the LFN filename block from a dir. Get the block in lname at startOffset
+ */
+ void SdBaseFile::getLFNName(vfat_t *pFatDir, char *lname, uint8_t sequenceNumber) {
+ uint8_t startOffset = (sequenceNumber - 1) * FILENAME_LENGTH;
+ LOOP_L_N(i, FILENAME_LENGTH) {
+ const uint16_t utf16_ch = (i >= 11) ? pFatDir->name3[i - 11] : (i >= 5) ? pFatDir->name2[i - 5] : pFatDir->name1[i];
+ #if ENABLED(UTF_FILENAME_SUPPORT)
+ // We can't reconvert to UTF-8 here as UTF-8 is variable-size encoding, but joining LFN blocks
+ // needs static bytes addressing. So here just store full UTF-16LE words to re-convert later.
+ uint16_t idx = (startOffset + i) * 2; // This is fixed as FAT LFN always contain UTF-16LE encoding
+ lname[idx] = utf16_ch & 0xFF;
+ lname[idx + 1] = (utf16_ch >> 8) & 0xFF;
+ #else
+ // Replace all multibyte characters to '_'
+ lname[startOffset + i] = (utf16_ch > 0xFF) ? '_' : (utf16_ch & 0xFF);
+ #endif
+ }
+ }
+
+ /**
+ * Set the LFN filename block lname to a dir. Put the block based on sequence number
+ */
+ void SdBaseFile::setLFNName(vfat_t *pFatDir, char *lname, uint8_t sequenceNumber) {
+ uint8_t startOffset = (sequenceNumber - 1) * FILENAME_LENGTH;
+ uint8_t nameLength = strlen(lname);
+ LOOP_L_N(i, FILENAME_LENGTH) {
+ uint16_t ch = 0;
+ if ((startOffset + i) < nameLength)
+ ch = lname[startOffset + i];
+ else if ((startOffset + i) > nameLength)
+ ch = 0xFFFF;
+ // Set char
+ if (i < 5)
+ pFatDir->name1[i] = ch;
+ else if (i < 11)
+ pFatDir->name2[i - 5] = ch;
+ else
+ pFatDir->name3[i - 11] = ch;
+ }
+ }
+
+#endif // LONG_FILENAME_WRITE_SUPPORT
+
+#if 0
+/**
+ * Open a directory's parent directory.
+ *
+ * \param[in] dir Parent of this directory will be opened. Must not be root.
+ *
+ * \return true for success, false for failure.
+ */
+bool SdBaseFile::openParent(SdBaseFile *dir) {
+ dir_t entry;
+ SdBaseFile file;
+ uint32_t c;
+ uint32_t cluster;
+ uint32_t lbn;
+ // error if already open or dir is root or dir is not a directory
+ if (isOpen() || !dir || dir->isRoot() || !dir->isDir()) return false;
+ vol_ = dir->vol_;
+ // position to '..'
+ if (!dir->seekSet(32)) return false;
+ // read '..' entry
+ if (dir->read(&entry, sizeof(entry)) != 32) return false;
+ // verify it is '..'
+ if (entry.name[0] != '.' || entry.name[1] != '.') return false;
+ // start cluster for '..'
+ cluster = entry.firstClusterLow;
+ cluster |= (uint32_t)entry.firstClusterHigh << 16;
+ if (cluster == 0) return openRoot(vol_);
+ // start block for '..'
+ lbn = vol_->clusterStartBlock(cluster);
+ // first block of parent dir
+ if (!vol_->cacheRawBlock(lbn, SdVolume::CACHE_FOR_READ)) return false;
+
+ dir_t *p = &vol_->cacheBuffer_.dir[1];
+ // verify name for '../..'
+ if (p->name[0] != '.' || p->name[1] != '.') return false;
+ // '..' is pointer to first cluster of parent. open '../..' to find parent
+ if (p->firstClusterHigh == 0 && p->firstClusterLow == 0) {
+ if (!file.openRoot(dir->volume())) return false;
+ }
+ else if (!file.openCachedEntry(1, O_READ))
+ return false;
+
+ // search for parent in '../..'
+ do {
+ if (file.readDir(&entry, nullptr) != 32) return false;
+ c = entry.firstClusterLow;
+ c |= (uint32_t)entry.firstClusterHigh << 16;
+ } while (c != cluster);
+
+ // open parent
+ return open(&file, file.curPosition() / 32 - 1, O_READ);
+}
+#endif
+
+/**
+ * Open a volume's root directory.
+ *
+ * \param[in] vol The FAT volume containing the root directory to be opened.
+ *
+ * \return true for success, false for failure.
+ * Reasons for failure include the file is already open, the FAT volume has
+ * not been initialized or it a FAT12 volume.
+ */
+bool SdBaseFile::openRoot(SdVolume *vol) {
+ // error if file is already open
+ if (isOpen()) return false;
+
+ if (vol->fatType() == 16 || (FAT12_SUPPORT && vol->fatType() == 12)) {
+ type_ = FAT_FILE_TYPE_ROOT_FIXED;
+ firstCluster_ = 0;
+ fileSize_ = 32 * vol->rootDirEntryCount();
+ }
+ else if (vol->fatType() == 32) {
+ type_ = FAT_FILE_TYPE_ROOT32;
+ firstCluster_ = vol->rootDirStart();
+ if (!vol->chainSize(firstCluster_, &fileSize_)) return false;
+ }
+ else // volume is not initialized, invalid, or FAT12 without support
+ return false;
+
+ vol_ = vol;
+ // read only
+ flags_ = O_READ;
+
+ // set to start of file
+ curCluster_ = curPosition_ = 0;
+
+ // root has no directory entry
+ dirBlock_ = dirIndex_ = 0;
+ return true;
+}
+
+/**
+ * Return the next available byte without consuming it.
+ *
+ * \return The byte if no error and not at eof else -1;
+ */
+int SdBaseFile::peek() {
+ filepos_t pos;
+ getpos(&pos);
+ int c = read();
+ if (c >= 0) setpos(&pos);
+ return c;
+}
+
+// print uint8_t with width 2
+static void print2u(const uint8_t v) {
+ if (v < 10) SERIAL_CHAR('0');
+ SERIAL_ECHO(v);
+}
+
+/**
+ * %Print a directory date field to Serial.
+ *
+ * Format is yyyy-mm-dd.
+ *
+ * \param[in] fatDate The date field from a directory entry.
+ */
+
+
+/**
+ * %Print a directory date field.
+ *
+ * Format is yyyy-mm-dd.
+ *
+ * \param[in] pr Print stream for output.
+ * \param[in] fatDate The date field from a directory entry.
+ */
+void SdBaseFile::printFatDate(uint16_t fatDate) {
+ SERIAL_ECHO(FAT_YEAR(fatDate));
+ SERIAL_CHAR('-');
+ print2u(FAT_MONTH(fatDate));
+ SERIAL_CHAR('-');
+ print2u(FAT_DAY(fatDate));
+}
+
+
+/**
+ * %Print a directory time field.
+ *
+ * Format is hh:mm:ss.
+ *
+ * \param[in] pr Print stream for output.
+ * \param[in] fatTime The time field from a directory entry.
+ */
+void SdBaseFile::printFatTime(uint16_t fatTime) {
+ print2u(FAT_HOUR(fatTime));
+ SERIAL_CHAR(':');
+ print2u(FAT_MINUTE(fatTime));
+ SERIAL_CHAR(':');
+ print2u(FAT_SECOND(fatTime));
+}
+
+/**
+ * Print a file's name to Serial
+ *
+ * \return true for success, false for failure.
+ */
+bool SdBaseFile::printName() {
+ char name[FILENAME_LENGTH];
+ if (!getDosName(name)) return false;
+ SERIAL_ECHO(name);
+ return true;
+}
+
+/**
+ * Read the next byte from a file.
+ *
+ * \return For success read returns the next byte in the file as an int.
+ * If an error occurs or end of file is reached -1 is returned.
+ */
+int16_t SdBaseFile::read() {
+ uint8_t b;
+ return read(&b, 1) == 1 ? b : -1;
+}
+
+/**
+ * Read data from a file starting at the current position.
+ *
+ * \param[out] buf Pointer to the location that will receive the data.
+ *
+ * \param[in] nbyte Maximum number of bytes to read.
+ *
+ * \return For success read() returns the number of bytes read.
+ * A value less than \a nbyte, including zero, will be returned
+ * if end of file is reached.
+ * If an error occurs, read() returns -1. Possible errors include
+ * read() called before a file has been opened, corrupt file system
+ * or an I/O error occurred.
+ */
+int16_t SdBaseFile::read(void *buf, uint16_t nbyte) {
+ uint8_t *dst = reinterpret_cast(buf);
+ uint16_t offset, toRead;
+ uint32_t block; // raw device block number
+
+ // error if not open or write only
+ if (!isOpen() || !(flags_ & O_READ)) return -1;
+
+ // max bytes left in file
+ NOMORE(nbyte, fileSize_ - curPosition_);
+
+ // amount left to read
+ toRead = nbyte;
+ while (toRead > 0) {
+ offset = curPosition_ & 0x1FF; // offset in block
+ if (type_ == FAT_FILE_TYPE_ROOT_FIXED) {
+ block = vol_->rootDirStart() + (curPosition_ >> 9);
+ }
+ else {
+ uint8_t blockOfCluster = vol_->blockOfCluster(curPosition_);
+ if (offset == 0 && blockOfCluster == 0) {
+ // start of new cluster
+ if (curPosition_ == 0)
+ curCluster_ = firstCluster_; // use first cluster in file
+ else if (!vol_->fatGet(curCluster_, &curCluster_)) // get next cluster from FAT
+ return -1;
+ }
+ block = vol_->clusterStartBlock(curCluster_) + blockOfCluster;
+ }
+ uint16_t n = toRead;
+
+ // amount to be read from current block
+ NOMORE(n, 512 - offset);
+
+ // no buffering needed if n == 512
+ if (n == 512 && block != vol_->cacheBlockNumber()) {
+ if (!vol_->readBlock(block, dst)) return -1;
+ }
+ else {
+ // read block to cache and copy data to caller
+ if (!vol_->cacheRawBlock(block, SdVolume::CACHE_FOR_READ)) return -1;
+ uint8_t *src = vol_->cache()->data + offset;
+ memcpy(dst, src, n);
+ }
+ dst += n;
+ curPosition_ += n;
+ toRead -= n;
+ }
+ return nbyte;
+}
+
+/**
+ * Read the next entry in a directory.
+ *
+ * \param[out] dir The dir_t struct that will receive the data.
+ *
+ * \return For success readDir() returns the number of bytes read.
+ * A value of zero will be returned if end of file is reached.
+ * If an error occurs, readDir() returns -1. Possible errors include
+ * readDir() called before a directory has been opened, this is not
+ * a directory file or an I/O error occurred.
+ */
+int8_t SdBaseFile::readDir(dir_t *dir, char *longFilename) {
+ int16_t n;
+ // if not a directory file or miss-positioned return an error
+ if (!isDir() || (0x1F & curPosition_)) return -1;
+
+ #define INVALIDATE_LONGNAME() (longFilename[0] = longFilename[1] = '\0')
+
+ // If we have a longFilename buffer, mark it as invalid.
+ // If a long filename is found it will be filled automatically.
+ if (longFilename) INVALIDATE_LONGNAME();
+
+ uint8_t checksum_error = 0xFF, checksum = 0;
+
+ while (1) {
+
+ n = read(dir, sizeof(dir_t));
+ if (n != sizeof(dir_t)) return n ? -1 : 0;
+
+ // Last entry if DIR_NAME_FREE
+ if (dir->name[0] == DIR_NAME_FREE) return 0;
+
+ // Skip deleted entry and entry for . and ..
+ if (dir->name[0] == DIR_NAME_DELETED || dir->name[0] == '.') {
+ if (longFilename) INVALIDATE_LONGNAME(); // Invalidate erased file long name, if any
+ continue;
+ }
+
+ if (longFilename) {
+ // Fill the long filename if we have a long filename entry.
+ // Long filename entries are stored before the short filename.
+ if (DIR_IS_LONG_NAME(dir)) {
+ vfat_t *VFAT = (vfat_t*)dir;
+ // Sanity-check the VFAT entry. The first cluster is always set to zero. And the sequence number should be higher than 0
+ if (VFAT->firstClusterLow == 0) {
+ const uint8_t seq = VFAT->sequenceNumber & 0x1F;
+ if (WITHIN(seq, 1, MAX_VFAT_ENTRIES)) {
+ if (seq == 1) {
+ checksum = VFAT->checksum;
+ checksum_error = 0;
+ }
+ else if (checksum != VFAT->checksum) // orphan detected
+ checksum_error = 1;
+
+ #if ENABLED(LONG_FILENAME_WRITE_SUPPORT)
+
+ getLFNName(VFAT, longFilename, seq); // Get chunk of LFN from VFAT entry
+
+ #else // !LONG_FILENAME_WRITE_SUPPORT
+
+ n = (seq - 1) * (FILENAME_LENGTH);
+
+ LOOP_L_N(i, FILENAME_LENGTH) {
+ const uint16_t utf16_ch = (i >= 11) ? VFAT->name3[i - 11] : (i >= 5) ? VFAT->name2[i - 5] : VFAT->name1[i];
+ #if ENABLED(UTF_FILENAME_SUPPORT)
+ // We can't reconvert to UTF-8 here as UTF-8 is variable-size encoding, but joining LFN blocks
+ // needs static bytes addressing. So here just store full UTF-16LE words to re-convert later.
+ uint16_t idx = (n + i) * 2; // This is fixed as FAT LFN always contain UTF-16LE encoding
+ longFilename[idx] = utf16_ch & 0xFF;
+ longFilename[idx + 1] = (utf16_ch >> 8) & 0xFF;
+ #else
+ // Replace all multibyte characters to '_'
+ longFilename[n + i] = (utf16_ch > 0xFF) ? '_' : (utf16_ch & 0xFF);
+ #endif
+ }
+
+ #endif // !LONG_FILENAME_WRITE_SUPPORT
+
+ // If this VFAT entry is the last one, add a NUL terminator at the end of the string
+ if (VFAT->sequenceNumber & 0x40)
+ longFilename[LONG_FILENAME_CHARSIZE * TERN(LONG_FILENAME_WRITE_SUPPORT, seq * FILENAME_LENGTH, (n + FILENAME_LENGTH))] = '\0';
+ }
+ }
+ }
+ else {
+ if (!checksum_error && lfn_checksum(dir->name) != checksum) checksum_error = 1; // orphan detected
+ if (checksum_error) INVALIDATE_LONGNAME();
+ }
+ }
+
+ // Post-process normal file or subdirectory longname, if any
+ if (DIR_IS_FILE_OR_SUBDIR(dir)) {
+ #if ENABLED(UTF_FILENAME_SUPPORT)
+ #if LONG_FILENAME_CHARSIZE > 2
+ // Add warning for developers for currently not supported 3-byte cases (Conversion series of 2-byte
+ // codepoints to 3-byte in-place will break the rest of filename)
+ #error "Currently filename re-encoding is done in-place. It may break the remaining chars to use 3-byte codepoints."
+ #endif
+
+ // Is there a long filename to decode?
+ if (longFilename) {
+ // Reset n to the start of the long name
+ n = 0;
+ for (uint16_t idx = 0; idx < (LONG_FILENAME_LENGTH) / 2; idx += 2) { // idx is fixed since FAT LFN always contains UTF-16LE encoding
+ const uint16_t utf16_ch = longFilename[idx] | (longFilename[idx + 1] << 8);
+ if (0xD800 == (utf16_ch & 0xF800)) // Surrogate pair - encode as '_'
+ longFilename[n++] = '_';
+ else if (0 == (utf16_ch & 0xFF80)) // Encode as 1-byte UTF-8 char
+ longFilename[n++] = utf16_ch & 0x007F;
+ else if (0 == (utf16_ch & 0xF800)) { // Encode as 2-byte UTF-8 char
+ longFilename[n++] = 0xC0 | ((utf16_ch >> 6) & 0x1F);
+ longFilename[n++] = 0x80 | ( utf16_ch & 0x3F);
+ }
+ else {
+ #if LONG_FILENAME_CHARSIZE > 2 // Encode as 3-byte UTF-8 char
+ longFilename[n++] = 0xE0 | ((utf16_ch >> 12) & 0x0F);
+ longFilename[n++] = 0xC0 | ((utf16_ch >> 6) & 0x3F);
+ longFilename[n++] = 0xC0 | ( utf16_ch & 0x3F);
+ #else // Encode as '_'
+ longFilename[n++] = '_';
+ #endif
+ }
+ if (0 == utf16_ch) break; // End of filename
+ } // idx
+ } // longFilename
+ #endif
+ return n;
+ } // DIR_IS_FILE_OR_SUBDIR
+ }
+}
+
+// Read next directory entry into the cache
+// Assumes file is correctly positioned
+dir_t* SdBaseFile::readDirCache() {
+ uint8_t i;
+ // error if not directory
+ if (!isDir()) return 0;
+
+ // index of entry in cache
+ i = (curPosition_ >> 5) & 0xF;
+
+ // use read to locate and cache block
+ if (read() < 0) return 0;
+
+ // advance to next entry
+ curPosition_ += 31;
+
+ // return pointer to entry
+ return vol_->cache()->dir + i;
+}
+
+/**
+ * Remove a file.
+ *
+ * The directory entry and all data for the file are deleted.
+ *
+ * \note This function should not be used to delete the 8.3 version of a
+ * file that has a long name. For example if a file has the long name
+ * "New Text Document.txt" you should not delete the 8.3 name "NEWTEX~1.TXT".
+ *
+ * \return true for success, false for failure.
+ * Reasons for failure include the file read-only, is a directory,
+ * or an I/O error occurred.
+ */
+bool SdBaseFile::remove() {
+ if (ENABLED(SDCARD_READONLY)) return false;
+
+ // free any clusters - will fail if read-only or directory
+ if (!truncate(0)) return false;
+
+ // cache directory entry
+ dir_t *d = cacheDirEntry(SdVolume::CACHE_FOR_WRITE);
+ if (!d) return false;
+
+ #if ENABLED(LONG_FILENAME_WRITE_SUPPORT)
+ // get SFN checksum before name rewrite (needed for LFN deletion)
+ const uint8_t sfn_checksum = lfn_checksum(d->name);
+ #endif
+
+ // mark entry deleted
+ d->name[0] = DIR_NAME_DELETED;
+
+ // set this file closed
+ type_ = FAT_FILE_TYPE_CLOSED;
+
+ // write entry to SD
+ #if DISABLED(LONG_FILENAME_WRITE_SUPPORT)
+
+ return vol_->cacheFlush();
+
+ #else // LONG_FILENAME_WRITE_SUPPORT
+
+ flags_ = 0;
+
+ if (!vol_->cacheFlush()) return false;
+
+ // Check if the entry has a LFN
+ bool lastEntry = false;
+ // loop back to search for any LFN entries related to this file
+ LOOP_S_LE_N(sequenceNumber, 1, MAX_VFAT_ENTRIES) {
+ dirIndex_ = (dirIndex_ - 1) & 0xF;
+ if (dirBlock_ == 0) break;
+ if (dirIndex_ == 0xF) dirBlock_--;
+ dir_t *dir = cacheDirEntry(SdVolume::CACHE_FOR_WRITE);
+ if (!dir) return false;
+
+ // check for valid LFN: not deleted, not top dirs (".", ".."), must be a LFN
+ if (dir->name[0] == DIR_NAME_DELETED || dir->name[0] == '.' || !isDirLFN(dir)) break;
+ // check coherent LFN: checksum and sequenceNumber must match
+ vfat_t* dirlfn = (vfat_t*) dir;
+ if (dirlfn->checksum != sfn_checksum || (dirlfn->sequenceNumber & 0x1F) != sequenceNumber) break; // orphan entry
+ // is last entry of LFN ?
+ lastEntry = (dirlfn->sequenceNumber & 0x40);
+ // mark as deleted
+ dirlfn->sequenceNumber = DIR_NAME_DELETED;
+ // Flush to SD
+ if (!vol_->cacheFlush()) return false;
+ // exit on last entry of LFN deleted
+ if (lastEntry) break;
+ }
+
+ // Restore current index
+ //if (!seekSet(32UL * dirIndex_)) return false;
+ //dirIndex_ += prevDirIndex;
+
+ return true;
+
+ #endif // LONG_FILENAME_WRITE_SUPPORT
+}
+
+/**
+ * Remove a file.
+ *
+ * The directory entry and all data for the file are deleted.
+ *
+ * \param[in] dirFile The directory that contains the file.
+ * \param[in] path Path for the file to be removed.
+ *
+ * \note This function should not be used to delete the 8.3 version of a
+ * file that has a long name. For example if a file has the long name
+ * "New Text Document.txt" you should not delete the 8.3 name "NEWTEX~1.TXT".
+ *
+ * \return true for success, false for failure.
+ * Reasons for failure include the file is a directory, is read only,
+ * \a dirFile is not a directory, \a path is not found
+ * or an I/O error occurred.
+ */
+bool SdBaseFile::remove(SdBaseFile *dirFile, const char *path) {
+ if (ENABLED(SDCARD_READONLY)) return false;
+
+ SdBaseFile file;
+ return file.open(dirFile, path, O_WRITE) ? file.remove() : false;
+}
+
+bool SdBaseFile::hide(const bool hidden) {
+ if (ENABLED(SDCARD_READONLY)) return false;
+ // must be an open file or subdirectory
+ if (!(isFile() || isSubDir())) return false;
+ // sync() and cache directory entry
+ sync();
+ dir_t *d = cacheDirEntry(SdVolume::CACHE_FOR_WRITE);
+ if (!d) return false;
+ uint8_t a = d->attributes;
+ if (hidden)
+ a |= DIR_ATT_HIDDEN;
+ else
+ a &= ~DIR_ATT_HIDDEN;
+
+ if (a != d->attributes) {
+ d->attributes = a;
+ return vol_->cacheFlush();
+ }
+
+ return true;
+}
+
+/**
+ * Rename a file or subdirectory.
+ *
+ * \param[in] dirFile Directory for the new path.
+ * \param[in] newPath New path name for the file/directory.
+ *
+ * \return true for success, false for failure.
+ * Reasons for failure include \a dirFile is not open or is not a directory
+ * file, newPath is invalid or already exists, or an I/O error occurs.
+ */
+bool SdBaseFile::rename(SdBaseFile *dirFile, const char *newPath) {
+ if (ENABLED(SDCARD_READONLY)) return false;
+
+ uint32_t dirCluster = 0;
+
+ // must be an open file or subdirectory
+ if (!(isFile() || isSubDir())) return false;
+
+ // can't move file
+ if (vol_ != dirFile->vol_) return false;
+
+ // sync() and cache directory entry
+ sync();
+ dir_t *d = cacheDirEntry(SdVolume::CACHE_FOR_WRITE);
+ if (!d) return false;
+
+ // save directory entry
+ dir_t entry;
+ memcpy(&entry, d, sizeof(entry));
+
+ // mark entry deleted
+ d->name[0] = DIR_NAME_DELETED;
+
+ // make directory entry for new path
+ SdBaseFile file;
+ if (isFile()) {
+ if (!file.open(dirFile, newPath, O_CREAT | O_EXCL | O_WRITE)) {
+ goto restore;
+ }
+ }
+ else {
+ // don't create missing path prefix components
+ if (!file.mkdir(dirFile, newPath, false)) {
+ goto restore;
+ }
+ // save cluster containing new dot dot
+ dirCluster = file.firstCluster_;
+ }
+ // change to new directory entry
+ dirBlock_ = file.dirBlock_;
+ dirIndex_ = file.dirIndex_;
+
+ // mark closed to avoid possible destructor close call
+ file.type_ = FAT_FILE_TYPE_CLOSED;
+
+ // cache new directory entry
+ d = cacheDirEntry(SdVolume::CACHE_FOR_WRITE);
+ if (!d) return false;
+
+ // copy all but name field to new directory entry
+ memcpy(&d->attributes, &entry.attributes, sizeof(entry) - sizeof(d->name));
+
+ // update dot dot if directory
+ if (dirCluster) {
+ // get new dot dot
+ uint32_t block = vol_->clusterStartBlock(dirCluster);
+ if (!vol_->cacheRawBlock(block, SdVolume::CACHE_FOR_READ)) return false;
+ memcpy(&entry, &vol_->cache()->dir[1], sizeof(entry));
+
+ // free unused cluster
+ if (!vol_->freeChain(dirCluster)) return false;
+
+ // store new dot dot
+ block = vol_->clusterStartBlock(firstCluster_);
+ if (!vol_->cacheRawBlock(block, SdVolume::CACHE_FOR_WRITE)) return false;
+ memcpy(&vol_->cache()->dir[1], &entry, sizeof(entry));
+ }
+ return vol_->cacheFlush();
+
+restore:
+ if ((d = cacheDirEntry(SdVolume::CACHE_FOR_WRITE))) {
+ // restore entry
+ d->name[0] = entry.name[0];
+ vol_->cacheFlush();
+ }
+ return false;
+}
+
+/**
+ * Remove a directory file.
+ *
+ * The directory file will be removed only if it is empty and is not the
+ * root directory. rmdir() follows DOS and Windows and ignores the
+ * read-only attribute for the directory.
+ *
+ * \note This function should not be used to delete the 8.3 version of a
+ * directory that has a long name. For example if a directory has the
+ * long name "New folder" you should not delete the 8.3 name "NEWFOL~1".
+ *
+ * \return true for success, false for failure.
+ * Reasons for failure include the file is not a directory, is the root
+ * directory, is not empty, or an I/O error occurred.
+ */
+bool SdBaseFile::rmdir() {
+ if (ENABLED(SDCARD_READONLY)) return false;
+
+ // must be open subdirectory
+ if (!isSubDir()) return false;
+
+ rewind();
+
+ // make sure directory is empty
+ while (curPosition_ < fileSize_) {
+ dir_t *p = readDirCache();
+ if (!p) return false;
+ // done if past last used entry
+ if (p->name[0] == DIR_NAME_FREE) break;
+ // skip empty slot, '.' or '..'
+ if (p->name[0] == DIR_NAME_DELETED || p->name[0] == '.') continue;
+ // error not empty
+ if (DIR_IS_FILE_OR_SUBDIR(p)) return false;
+ }
+ // convert empty directory to normal file for remove
+ type_ = FAT_FILE_TYPE_NORMAL;
+ flags_ |= O_WRITE;
+ return remove();
+}
+
+/**
+ * Recursively delete a directory and all contained files.
+ *
+ * This is like the Unix/Linux 'rm -rf *' if called with the root directory
+ * hence the name.
+ *
+ * Warning - This will remove all contents of the directory including
+ * subdirectories. The directory will then be removed if it is not root.
+ * The read-only attribute for files will be ignored.
+ *
+ * \note This function should not be used to delete the 8.3 version of
+ * a directory that has a long name. See remove() and rmdir().
+ *
+ * \return true for success, false for failure.
+ */
+bool SdBaseFile::rmRfStar() {
+ if (ENABLED(SDCARD_READONLY)) return false;
+
+ uint32_t index;
+ SdBaseFile f;
+ rewind();
+ while (curPosition_ < fileSize_) {
+ // remember position
+ index = curPosition_ / 32;
+
+ dir_t *p = readDirCache();
+ if (!p) return false;
+
+ // done if past last entry
+ if (p->name[0] == DIR_NAME_FREE) break;
+
+ // skip empty slot or '.' or '..'
+ if (p->name[0] == DIR_NAME_DELETED || p->name[0] == '.') continue;
+
+ // skip if part of long file name or volume label in root
+ if (!DIR_IS_FILE_OR_SUBDIR(p)) continue;
+
+ if (!f.open(this, index, O_READ)) return false;
+ if (f.isSubDir()) {
+ // recursively delete
+ if (!f.rmRfStar()) return false;
+ }
+ else {
+ // ignore read-only
+ f.flags_ |= O_WRITE;
+ if (!f.remove()) return false;
+ }
+ // position to next entry if required
+ if (curPosition_ != (32 * (index + 1))) {
+ if (!seekSet(32 * (index + 1))) return false;
+ }
+ }
+ // don't try to delete root
+ if (!isRoot()) {
+ if (!rmdir()) return false;
+ }
+ return true;
+}
+
+/**
+ * Create a file object and open it in the current working directory.
+ *
+ * \param[in] path A path with a valid 8.3 DOS name for a file to be opened.
+ *
+ * \param[in] oflag Values for \a oflag are constructed by a bitwise-inclusive
+ * OR of open flags. see SdBaseFile::open(SdBaseFile*, const char*, uint8_t).
+ */
+SdBaseFile::SdBaseFile(const char *path, uint8_t oflag) {
+ type_ = FAT_FILE_TYPE_CLOSED;
+ writeError = false;
+ open(path, oflag);
+}
+
+/**
+ * Sets a file's position.
+ *
+ * \param[in] pos The new position in bytes from the beginning of the file.
+ *
+ * \return true for success, false for failure.
+ */
+bool SdBaseFile::seekSet(const uint32_t pos) {
+ uint32_t nCur, nNew;
+ // error if file not open or seek past end of file
+ if (!isOpen() || pos > fileSize_) return false;
+
+ if (type_ == FAT_FILE_TYPE_ROOT_FIXED) {
+ curPosition_ = pos;
+ return true;
+ }
+ if (pos == 0) {
+ curCluster_ = curPosition_ = 0; // set position to start of file
+ return true;
+ }
+
+ // calculate cluster index for cur and new position
+ nCur = (curPosition_ - 1) >> (vol_->clusterSizeShift_ + 9);
+ nNew = (pos - 1) >> (vol_->clusterSizeShift_ + 9);
+
+ if (nNew < nCur || curPosition_ == 0)
+ curCluster_ = firstCluster_; // must follow chain from first cluster
+ else
+ nNew -= nCur; // advance from curPosition
+
+ while (nNew--)
+ if (!vol_->fatGet(curCluster_, &curCluster_)) return false;
+
+ curPosition_ = pos;
+ return true;
+}
+
+void SdBaseFile::setpos(filepos_t *pos) {
+ curPosition_ = pos->position;
+ curCluster_ = pos->cluster;
+}
+
+/**
+ * The sync() call causes all modified data and directory fields
+ * to be written to the storage device.
+ *
+ * \return true for success, false for failure.
+ * Reasons for failure include a call to sync() before a file has been
+ * opened or an I/O error.
+ */
+bool SdBaseFile::sync() {
+ // only allow open files and directories
+ if (ENABLED(SDCARD_READONLY) || !isOpen()) goto FAIL;
+
+ if (flags_ & F_FILE_DIR_DIRTY) {
+ dir_t *d = cacheDirEntry(SdVolume::CACHE_FOR_WRITE);
+ // check for deleted by another open file object
+ if (!d || d->name[0] == DIR_NAME_DELETED) goto FAIL;
+
+ // do not set filesize for dir files
+ if (!isDir()) d->fileSize = fileSize_;
+
+ // update first cluster fields
+ d->firstClusterLow = firstCluster_ & 0xFFFF;
+ d->firstClusterHigh = firstCluster_ >> 16;
+
+ // set modify time if user supplied a callback date/time function
+ if (dateTime_) {
+ dateTime_(&d->lastWriteDate, &d->lastWriteTime);
+ d->lastAccessDate = d->lastWriteDate;
+ }
+ // clear directory dirty
+ flags_ &= ~F_FILE_DIR_DIRTY;
+ }
+ return vol_->cacheFlush();
+
+ FAIL:
+ writeError = true;
+ return false;
+}
+
+/**
+ * Copy a file's timestamps
+ *
+ * \param[in] file File to copy timestamps from.
+ *
+ * \note
+ * Modify and access timestamps may be overwritten if a date time callback
+ * function has been set by dateTimeCallback().
+ *
+ * \return true for success, false for failure.
+ */
+bool SdBaseFile::timestamp(SdBaseFile *file) {
+ dir_t dir;
+
+ // get timestamps
+ if (!file->dirEntry(&dir)) return false;
+
+ // update directory fields
+ if (!sync()) return false;
+
+ dir_t *d = cacheDirEntry(SdVolume::CACHE_FOR_WRITE);
+ if (!d) return false;
+
+ // copy timestamps
+ d->lastAccessDate = dir.lastAccessDate;
+ d->creationDate = dir.creationDate;
+ d->creationTime = dir.creationTime;
+ d->creationTimeTenths = dir.creationTimeTenths;
+ d->lastWriteDate = dir.lastWriteDate;
+ d->lastWriteTime = dir.lastWriteTime;
+
+ // write back entry
+ return vol_->cacheFlush();
+}
+
+/**
+ * Set a file's timestamps in its directory entry.
+ *
+ * \param[in] flags Values for \a flags are constructed by a bitwise-inclusive
+ * OR of flags from the following list
+ *
+ * T_ACCESS - Set the file's last access date.
+ *
+ * T_CREATE - Set the file's creation date and time.
+ *
+ * T_WRITE - Set the file's last write/modification date and time.
+ *
+ * \param[in] year Valid range 1980 - 2107 inclusive.
+ *
+ * \param[in] month Valid range 1 - 12 inclusive.
+ *
+ * \param[in] day Valid range 1 - 31 inclusive.
+ *
+ * \param[in] hour Valid range 0 - 23 inclusive.
+ *
+ * \param[in] minute Valid range 0 - 59 inclusive.
+ *
+ * \param[in] second Valid range 0 - 59 inclusive
+ *
+ * \note It is possible to set an invalid date since there is no check for
+ * the number of days in a month.
+ *
+ * \note
+ * Modify and access timestamps may be overwritten if a date time callback
+ * function has been set by dateTimeCallback().
+ *
+ * \return true for success, false for failure.
+ */
+bool SdBaseFile::timestamp(uint8_t flags, uint16_t year, uint8_t month,
+ uint8_t day, uint8_t hour, uint8_t minute, uint8_t second) {
+ if (ENABLED(SDCARD_READONLY)) return false;
+
+ uint16_t dirDate, dirTime;
+
+ if (!isOpen()
+ || year < 1980
+ || year > 2107
+ || month < 1
+ || month > 12
+ || day < 1
+ || day > 31
+ || hour > 23
+ || minute > 59
+ || second > 59) {
+ return false;
+ }
+ // update directory entry
+ if (!sync()) return false;
+
+ dir_t *d = cacheDirEntry(SdVolume::CACHE_FOR_WRITE);
+ if (!d) return false;
+
+ dirDate = FAT_DATE(year, month, day);
+ dirTime = FAT_TIME(hour, minute, second);
+ if (flags & T_ACCESS) {
+ d->lastAccessDate = dirDate;
+ }
+ if (flags & T_CREATE) {
+ d->creationDate = dirDate;
+ d->creationTime = dirTime;
+ // seems to be units of 1/100 second not 1/10 as Microsoft states
+ d->creationTimeTenths = second & 1 ? 100 : 0;
+ }
+ if (flags & T_WRITE) {
+ d->lastWriteDate = dirDate;
+ d->lastWriteTime = dirTime;
+ }
+ return vol_->cacheFlush();
+}
+
+/**
+ * Truncate a file to a specified length. The current file position
+ * will be maintained if it is less than or equal to \a length otherwise
+ * it will be set to end of file.
+ *
+ * \param[in] length The desired length for the file.
+ *
+ * \return true for success, false for failure.
+ * Reasons for failure include file is read only, file is a directory,
+ * \a length is greater than the current file size or an I/O error occurs.
+ */
+bool SdBaseFile::truncate(uint32_t length) {
+ if (ENABLED(SDCARD_READONLY)) return false;
+
+ uint32_t newPos;
+ // error if not a normal file or read-only
+ if (!isFile() || !(flags_ & O_WRITE)) return false;
+
+ // error if length is greater than current size
+ if (length > fileSize_) return false;
+
+ // fileSize and length are zero - nothing to do
+ if (fileSize_ == 0) return true;
+
+ // remember position for seek after truncation
+ newPos = curPosition_ > length ? length : curPosition_;
+
+ // position to last cluster in truncated file
+ if (!seekSet(length)) return false;
+
+ if (length == 0) {
+ // free all clusters
+ if (!vol_->freeChain(firstCluster_)) return false;
+ firstCluster_ = 0;
+ }
+ else {
+ uint32_t toFree;
+ if (!vol_->fatGet(curCluster_, &toFree)) return false;
+
+ if (!vol_->isEOC(toFree)) {
+ // free extra clusters
+ if (!vol_->freeChain(toFree)) return false;
+
+ // current cluster is end of chain
+ if (!vol_->fatPutEOC(curCluster_)) return false;
+ }
+ }
+ fileSize_ = length;
+
+ // need to update directory entry
+ flags_ |= F_FILE_DIR_DIRTY;
+
+ if (!sync()) return false;
+
+ // set file to correct position
+ return seekSet(newPos);
+}
+
+/**
+ * Write data to an open file.
+ *
+ * \note Data is moved to the cache but may not be written to the
+ * storage device until sync() is called.
+ *
+ * \param[in] buf Pointer to the location of the data to be written.
+ *
+ * \param[in] nbyte Number of bytes to write.
+ *
+ * \return For success write() returns the number of bytes written, always
+ * \a nbyte. If an error occurs, write() returns -1. Possible errors
+ * include write() is called before a file has been opened, write is called
+ * for a read-only file, device is full, a corrupt file system or an I/O error.
+ */
+int16_t SdBaseFile::write(const void *buf, uint16_t nbyte) {
+ #if ENABLED(SDCARD_READONLY)
+ writeError = true; return -1;
+ #endif
+
+ // convert void* to uint8_t* - must be before goto statements
+ const uint8_t *src = reinterpret_cast(buf);
+
+ // number of bytes left to write - must be before goto statements
+ uint16_t nToWrite = nbyte;
+
+ // error if not a normal file or is read-only
+ if (!isFile() || !(flags_ & O_WRITE)) goto FAIL;
+
+ // seek to end of file if append flag
+ if ((flags_ & O_APPEND) && curPosition_ != fileSize_) {
+ if (!seekEnd()) goto FAIL;
+ }
+
+ while (nToWrite > 0) {
+ uint8_t blockOfCluster = vol_->blockOfCluster(curPosition_);
+ uint16_t blockOffset = curPosition_ & 0x1FF;
+ if (blockOfCluster == 0 && blockOffset == 0) {
+ // start of new cluster
+ if (curCluster_ == 0) {
+ if (firstCluster_ == 0) {
+ // allocate first cluster of file
+ if (!addCluster()) goto FAIL;
+ }
+ else {
+ curCluster_ = firstCluster_;
+ }
+ }
+ else {
+ uint32_t next;
+ if (!vol_->fatGet(curCluster_, &next)) goto FAIL;
+ if (vol_->isEOC(next)) {
+ // add cluster if at end of chain
+ if (!addCluster()) goto FAIL;
+ }
+ else {
+ curCluster_ = next;
+ }
+ }
+ }
+ // max space in block
+ uint16_t n = 512 - blockOffset;
+
+ // lesser of space and amount to write
+ NOMORE(n, nToWrite);
+
+ // block for data write
+ uint32_t block = vol_->clusterStartBlock(curCluster_) + blockOfCluster;
+ if (n == 512) {
+ // full block - don't need to use cache
+ if (vol_->cacheBlockNumber() == block) {
+ // invalidate cache if block is in cache
+ vol_->cacheSetBlockNumber(0xFFFFFFFF, false);
+ }
+ if (!vol_->writeBlock(block, src)) goto FAIL;
+ }
+ else {
+ if (blockOffset == 0 && curPosition_ >= fileSize_) {
+ // start of new block don't need to read into cache
+ if (!vol_->cacheFlush()) goto FAIL;
+ // set cache dirty and SD address of block
+ vol_->cacheSetBlockNumber(block, true);
+ }
+ else {
+ // rewrite part of block
+ if (!vol_->cacheRawBlock(block, SdVolume::CACHE_FOR_WRITE)) goto FAIL;
+ }
+ uint8_t *dst = vol_->cache()->data + blockOffset;
+ memcpy(dst, src, n);
+ }
+ curPosition_ += n;
+ src += n;
+ nToWrite -= n;
+ }
+ if (curPosition_ > fileSize_) {
+ // update fileSize and insure sync will update dir entry
+ fileSize_ = curPosition_;
+ flags_ |= F_FILE_DIR_DIRTY;
+ }
+ else if (dateTime_ && nbyte) {
+ // insure sync will update modified date and time
+ flags_ |= F_FILE_DIR_DIRTY;
+ }
+
+ if (flags_ & O_SYNC) {
+ if (!sync()) goto FAIL;
+ }
+ return nbyte;
+
+ FAIL:
+ // return for write error
+ writeError = true;
+ return -1;
+}
+
+#endif // SDSUPPORT
diff --git a/Marlin/src/sd/SdBaseFile.h b/Marlin/src/sd/SdBaseFile.h
new file mode 100644
index 000000000000..dd8e2aff4bd4
--- /dev/null
+++ b/Marlin/src/sd/SdBaseFile.h
@@ -0,0 +1,407 @@
+/**
+ * Marlin 3D Printer Firmware
+ * Copyright (c) 2020 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
+ *
+ * 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 .
+ *
+ */
+#pragma once
+
+/**
+ * sd/SdBaseFile.h
+ *
+ * Arduino SdFat Library
+ * Copyright (c) 2009 by William Greiman
+ *
+ * This file is part of the Arduino Sd2Card Library
+ */
+
+#include "SdFatConfig.h"
+#include "SdVolume.h"
+
+#include
+
+/**
+ * \struct filepos_t
+ * \brief internal type for istream
+ * do not use in user apps
+ */
+struct filepos_t {
+ uint32_t position; // stream byte position
+ uint32_t cluster; // cluster of position
+ filepos_t() : position(0), cluster(0) {}
+};
+
+// use the gnu style oflag in open()
+uint8_t const O_READ = 0x01, // open() oflag for reading
+ O_RDONLY = O_READ, // open() oflag - same as O_IN
+ O_WRITE = 0x02, // open() oflag for write
+ O_WRONLY = O_WRITE, // open() oflag - same as O_WRITE
+ O_RDWR = (O_READ | O_WRITE), // open() oflag for reading and writing
+ O_ACCMODE = (O_READ | O_WRITE), // open() oflag mask for access modes
+ O_APPEND = 0x04, // The file offset shall be set to the end of the file prior to each write.
+ O_SYNC = 0x08, // Synchronous writes - call sync() after each write
+ O_TRUNC = 0x10, // Truncate the file to zero length
+ O_AT_END = 0x20, // Set the initial position at the end of the file
+ O_CREAT = 0x40, // Create the file if nonexistent
+ O_EXCL = 0x80; // If O_CREAT and O_EXCL are set, open() shall fail if the file exists
+
+// SdBaseFile class static and const definitions
+
+// flags for ls()
+uint8_t const LS_DATE = 1, // ls() flag to print modify date
+ LS_SIZE = 2, // ls() flag to print file size
+ LS_R = 4; // ls() flag for recursive list of subdirectories
+
+
+// flags for timestamp
+uint8_t const T_ACCESS = 1, // Set the file's last access date
+ T_CREATE = 2, // Set the file's creation date and time
+ T_WRITE = 4; // Set the file's write date and time
+
+// values for type_
+uint8_t const FAT_FILE_TYPE_CLOSED = 0, // This file has not been opened.
+ FAT_FILE_TYPE_NORMAL = 1, // A normal file
+ FAT_FILE_TYPE_ROOT_FIXED = 2, // A FAT12 or FAT16 root directory
+ FAT_FILE_TYPE_ROOT32 = 3, // A FAT32 root directory
+ FAT_FILE_TYPE_SUBDIR = 4, // A subdirectory file
+ FAT_FILE_TYPE_MIN_DIR = FAT_FILE_TYPE_ROOT_FIXED; // Test value for directory type
+
+/**
+ * date field for FAT directory entry
+ * \param[in] year [1980,2107]
+ * \param[in] month [1,12]
+ * \param[in] day [1,31]
+ *
+ * \return Packed date for dir_t entry.
+ */
+static inline uint16_t FAT_DATE(uint16_t year, uint8_t month, uint8_t day) { return (year - 1980) << 9 | month << 5 | day; }
+
+/**
+ * year part of FAT directory date field
+ * \param[in] fatDate Date in packed dir format.
+ *
+ * \return Extracted year [1980,2107]
+ */
+static inline uint16_t FAT_YEAR(uint16_t fatDate) { return 1980 + (fatDate >> 9); }
+
+/**
+ * month part of FAT directory date field
+ * \param[in] fatDate Date in packed dir format.
+ *
+ * \return Extracted month [1,12]
+ */
+static inline uint8_t FAT_MONTH(uint16_t fatDate) { return (fatDate >> 5) & 0xF; }
+
+/**
+ * day part of FAT directory date field
+ * \param[in] fatDate Date in packed dir format.
+ *
+ * \return Extracted day [1,31]
+ */
+static inline uint8_t FAT_DAY(uint16_t fatDate) { return fatDate & 0x1F; }
+
+/**
+ * time field for FAT directory entry
+ * \param[in] hour [0,23]
+ * \param[in] minute [0,59]
+ * \param[in] second [0,59]
+ *
+ * \return Packed time for dir_t entry.
+ */
+static inline uint16_t FAT_TIME(uint8_t hour, uint8_t minute, uint8_t second) { return hour << 11 | minute << 5 | second >> 1; }
+
+/**
+ * hour part of FAT directory time field
+ * \param[in] fatTime Time in packed dir format.
+ *
+ * \return Extracted hour [0,23]
+ */
+static inline uint8_t FAT_HOUR(uint16_t fatTime) { return fatTime >> 11; }
+
+/**
+ * minute part of FAT directory time field
+ * \param[in] fatTime Time in packed dir format.
+ *
+ * \return Extracted minute [0,59]
+ */
+static inline uint8_t FAT_MINUTE(uint16_t fatTime) { return (fatTime >> 5) & 0x3F; }
+
+/**
+ * second part of FAT directory time field
+ * Note second/2 is stored in packed time.
+ *
+ * \param[in] fatTime Time in packed dir format.
+ *
+ * \return Extracted second [0,58]
+ */
+static inline uint8_t FAT_SECOND(uint16_t fatTime) { return 2 * (fatTime & 0x1F); }
+
+// Default date for file timestamps is 1 Jan 2000
+uint16_t const FAT_DEFAULT_DATE = ((2000 - 1980) << 9) | (1 << 5) | 1;
+// Default time for file timestamp is 1 am
+uint16_t const FAT_DEFAULT_TIME = (1 << 11);
+
+/**
+ * \class SdBaseFile
+ * \brief Base class for SdFile with Print and C++ streams.
+ */
+class SdBaseFile {
+ public:
+ SdBaseFile() : writeError(false), type_(FAT_FILE_TYPE_CLOSED) {}
+ SdBaseFile(const char *path, uint8_t oflag);
+ ~SdBaseFile() { if (isOpen()) close(); }
+
+ /**
+ * writeError is set to true if an error occurs during a write().
+ * Set writeError to false before calling print() and/or write() and check
+ * for true after calls to print() and/or write().
+ */
+ bool writeError;
+
+ // helpers for stream classes
+
+ /**
+ * get position for streams
+ * \param[out] pos struct to receive position
+ */
+ void getpos(filepos_t *pos);
+
+ /**
+ * set position for streams
+ * \param[out] pos struct with value for new position
+ */
+ void setpos(filepos_t *pos);
+
+ bool close();
+ bool contiguousRange(uint32_t *bgnBlock, uint32_t *endBlock);
+ bool createContiguous(SdBaseFile *dirFile,
+ const char *path, uint32_t size);
+ /**
+ * \return The current cluster number for a file or directory.
+ */
+ uint32_t curCluster() const { return curCluster_; }
+
+ /**
+ * \return The current position for a file or directory.
+ */
+ uint32_t curPosition() const { return curPosition_; }
+
+ /**
+ * \return Current working directory
+ */
+ static SdBaseFile *cwd() { return cwd_; }
+
+ /**
+ * Set the date/time callback function
+ *
+ * \param[in] dateTime The user's call back function. The callback
+ * function is of the form:
+ *
+ * \code
+ * void dateTime(uint16_t *date, uint16_t *time) {
+ * uint16_t year;
+ * uint8_t month, day, hour, minute, second;
+ *
+ * // User gets date and time from GPS or real-time clock here
+ *
+ * // return date using FAT_DATE macro to format fields
+ * *date = FAT_DATE(year, month, day);
+ *
+ * // return time using FAT_TIME macro to format fields
+ * *time = FAT_TIME(hour, minute, second);
+ * }
+ * \endcode
+ *
+ * Sets the function that is called when a file is created or when
+ * a file's directory entry is modified by sync(). All timestamps,
+ * access, creation, and modify, are set when a file is created.
+ * sync() maintains the last access date and last modify date/time.
+ *
+ * See the timestamp() function.
+ */
+ static void dateTimeCallback(
+ void (*dateTime)(uint16_t *date, uint16_t *time)) {
+ dateTime_ = dateTime;
+ }
+
+ /**
+ * Cancel the date/time callback function.
+ */
+ static void dateTimeCallbackCancel() { dateTime_ = 0; }
+ bool dirEntry(dir_t *dir);
+ static void dirName(const dir_t& dir, char *name);
+ bool exists(const char *name);
+ int16_t fgets(char *str, int16_t num, char *delim = 0);
+
+ /**
+ * \return The total number of bytes in a file or directory.
+ */
+ uint32_t fileSize() const { return fileSize_; }
+
+ /**
+ * \return The first cluster number for a file or directory.
+ */
+ uint32_t firstCluster() const { return firstCluster_; }
+
+ /**
+ * \return True if this is a directory else false.
+ */
+ bool isDir() const { return type_ >= FAT_FILE_TYPE_MIN_DIR; }
+
+ /**
+ * \return True if this is a normal file else false.
+ */
+ bool isFile() const { return type_ == FAT_FILE_TYPE_NORMAL; }
+
+ /**
+ * \return True if this is an open file/directory else false.
+ */
+ bool isOpen() const { return type_ != FAT_FILE_TYPE_CLOSED; }
+
+ /**
+ * \return True if this is a subdirectory else false.
+ */
+ bool isSubDir() const { return type_ == FAT_FILE_TYPE_SUBDIR; }
+
+ /**
+ * \return True if this is the root directory.
+ */
+ bool isRoot() const { return type_ == FAT_FILE_TYPE_ROOT_FIXED || type_ == FAT_FILE_TYPE_ROOT32; }
+
+ bool getDosName(char * const name);
+ void ls(uint8_t flags = 0, uint8_t indent = 0);
+
+ bool mkdir(SdBaseFile *dir, const char *path, bool pFlag = true);
+ bool open(SdBaseFile *dirFile, uint16_t index, uint8_t oflag);
+ bool open(SdBaseFile *dirFile, const char *path, uint8_t oflag);
+ bool open(const char *path, uint8_t oflag = O_READ);
+ bool openNext(SdBaseFile *dirFile, uint8_t oflag);
+ bool openRoot(SdVolume *vol);
+ int peek();
+ static void printFatDate(uint16_t fatDate);
+ static void printFatTime(uint16_t fatTime);
+ bool printName();
+ int16_t read();
+ int16_t read(void *buf, uint16_t nbyte);
+ int8_t readDir(dir_t *dir, char *longFilename);
+ static bool remove(SdBaseFile *dirFile, const char *path);
+ bool remove();
+
+ /**
+ * Set the file's current position to zero.
+ */
+ void rewind() { seekSet(0); }
+ bool rename(SdBaseFile *dirFile, const char *newPath);
+ bool rmdir();
+ bool rmRfStar();
+
+ /**
+ * Set or clear DIR_ATT_HIDDEN attribute for directory entry
+ */
+ bool hide(const bool hidden);
+
+ /**
+ * Set the files position to current position + \a pos. See seekSet().
+ * \param[in] offset The new position in bytes from the current position.
+ * \return true for success or false for failure.
+ */
+ bool seekCur(const int32_t offset) { return seekSet(curPosition_ + offset); }
+
+ /**
+ * Set the files position to end-of-file + \a offset. See seekSet().
+ * \param[in] offset The new position in bytes from end-of-file.
+ * \return true for success or false for failure.
+ */
+ bool seekEnd(const int32_t offset = 0) { return seekSet(fileSize_ + offset); }
+ bool seekSet(const uint32_t pos);
+ bool sync();
+ bool timestamp(SdBaseFile *file);
+ bool timestamp(uint8_t flag, uint16_t year, uint8_t month, uint8_t day,
+ uint8_t hour, uint8_t minute, uint8_t second);
+
+ /**
+ * Type of file. Use isFile() or isDir() instead of type() if possible.
+ *
+ * \return The file or directory type.
+ */
+ uint8_t type() const { return type_; }
+ bool truncate(uint32_t size);
+
+ /**
+ * \return SdVolume that contains this file.
+ */
+ SdVolume* volume() const { return vol_; }
+ int16_t write(const void *buf, uint16_t nbyte);
+
+ private:
+ friend class SdFat; // allow SdFat to set cwd_
+ static SdBaseFile *cwd_; // global pointer to cwd dir
+
+ // data time callback function
+ static void (*dateTime_)(uint16_t *date, uint16_t *time);
+
+ // bits defined in flags_
+ static uint8_t const F_OFLAG = (O_ACCMODE | O_APPEND | O_SYNC), // should be 0x0F
+ F_FILE_DIR_DIRTY = 0x80; // sync of directory entry required
+
+ // private data
+ uint8_t flags_; // See above for definition of flags_ bits
+ uint8_t fstate_; // error and eof indicator
+ uint8_t type_; // type of file see above for values
+ uint32_t curCluster_; // cluster for current file position
+ uint32_t curPosition_; // current file position in bytes from beginning
+ uint32_t dirBlock_; // block for this files directory entry
+ uint8_t dirIndex_; // index of directory entry in dirBlock
+ uint32_t fileSize_; // file size in bytes
+ uint32_t firstCluster_; // first cluster of file
+ SdVolume *vol_; // volume where file is located
+
+ /**
+ * EXPERIMENTAL - Don't use!
+ */
+ //bool openParent(SdBaseFile *dir);
+
+ // private functions
+ bool addCluster();
+ bool addDirCluster();
+ dir_t* cacheDirEntry(uint8_t action);
+ int8_t lsPrintNext(uint8_t flags, uint8_t indent);
+ static bool make83Name(const char *str, uint8_t *name, const char **ptr);
+ bool mkdir(SdBaseFile *parent, const uint8_t dname[11]
+ OPTARG(LONG_FILENAME_WRITE_SUPPORT, const uint8_t dlname[LONG_FILENAME_LENGTH])
+ );
+ bool open(SdBaseFile *dirFile, const uint8_t dname[11]
+ OPTARG(LONG_FILENAME_WRITE_SUPPORT, const uint8_t dlname[LONG_FILENAME_LENGTH])
+ , uint8_t oflag
+ );
+ bool openCachedEntry(uint8_t cacheIndex, uint8_t oflags);
+ dir_t* readDirCache();
+
+ // Long Filename create/write support
+ #if ENABLED(LONG_FILENAME_WRITE_SUPPORT)
+ static bool isDirLFN(const dir_t* dir);
+ static bool isDirNameLFN(const char *dirname);
+ static bool parsePath(const char *str, uint8_t *name, uint8_t *lname, const char **ptr);
+ /**
+ * Return the number of entries needed in the FAT for this LFN
+ */
+ static inline uint8_t getLFNEntriesNum(const char *lname) { return (strlen(lname) + 12) / 13; }
+ static void getLFNName(vfat_t *vFatDir, char *lname, uint8_t startOffset);
+ static void setLFNName(vfat_t *vFatDir, char *lname, uint8_t lfnSequenceNumber);
+ #endif
+};