/* SD.h - A thin shim for Arduino ESP8266 Filesystems Copyright (c) 2019 Earle F. Philhower, III. All rights reserved. This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library 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 Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */ #ifndef __SD_H__ #define __SD_H__ #include #include #include #undef FILE_READ #define FILE_READ sdfat::O_READ #undef FILE_WRITE #define FILE_WRITE (sdfat::O_READ | sdfat::O_WRITE | sdfat::O_CREAT | sdfat::O_APPEND) class SDClass { public: boolean begin(uint8_t csPin, SPISettings cfg = SPI_HALF_SPEED) { SDFS.setConfig(SDFSConfig(csPin, cfg)); return (boolean)SDFS.begin(); } void end(bool endSPI = true) { SDFS.end(); if (endSPI) { SPI.end(); } } File open(const char *filename, uint8_t mode = FILE_READ) { return SDFS.open(filename, getMode(mode)); } File open(const char *filename, const char *mode) { return SDFS.open(filename, mode); } File open(const String &filename, uint8_t mode = FILE_READ) { return open(filename.c_str(), mode); } File open(const String &filename, const char *mode) { return open(filename.c_str(), mode); } boolean exists(const char *filepath) { return (boolean)SDFS.exists(filepath); } boolean exists(const String &filepath) { return (boolean)SDFS.exists(filepath.c_str()); } boolean mkdir(const char *filepath) { return (boolean)SDFS.mkdir(filepath); } boolean mkdir(const String &filepath) { return (boolean)SDFS.mkdir(filepath.c_str()); } boolean remove(const char *filepath) { return (boolean)SDFS.remove(filepath); } boolean remove(const String &filepath) { return remove(filepath.c_str()); } boolean rmdir(const char *filepath) { return (boolean)SDFS.rmdir(filepath); } boolean rmdir(const String &filepath) { return rmdir(filepath.c_str()); } uint8_t type() { sdfs::SDFSImpl* sd = static_cast(SDFS.getImpl().get()); return sd->type(); } uint8_t fatType() { sdfs::SDFSImpl* sd = static_cast(SDFS.getImpl().get()); return sd->fatType(); } size_t blocksPerCluster() { sdfs::SDFSImpl* sd = static_cast(SDFS.getImpl().get()); return sd->blocksPerCluster(); } size_t totalClusters() { sdfs::SDFSImpl* sd = static_cast(SDFS.getImpl().get()); return sd->totalClusters(); } size_t blockSize() { return 512; } size_t totalBlocks() { return (totalClusters() / blocksPerCluster()); } size_t clusterSize() { return blocksPerCluster() * blockSize(); } size_t size() { uint64_t sz = size64(); #ifdef DEBUG_ESP_PORT if (sz > (uint64_t)SIZE_MAX) { DEBUG_ESP_PORT.printf_P(PSTR("WARNING: SD card size overflow (%lld>= 4GB). Please update source to use size64().\n"), sz); } #endif return (size_t)sz; } uint64_t size64() { return ((uint64_t)clusterSize() * (uint64_t)totalClusters()); } void setTimeCallback(time_t (*cb)(void)) { SDFS.setTimeCallback(cb); } // Wrapper to allow obsolete datetimecallback use, silently convert to time_t in wrappertimecb void dateTimeCallback(void (*cb)(uint16_t*, uint16_t*)) { extern void (*__SD__userDateTimeCB)(uint16_t*, uint16_t*); __SD__userDateTimeCB = cb; SDFS.setTimeCallback(wrapperTimeCB); } private: const char *getMode(uint8_t mode) { bool read = (mode & sdfat::O_READ) ? true : false; bool write = (mode & sdfat::O_WRITE) ? true : false; bool append = (mode & sdfat::O_APPEND) ? true : false; if ( read & !write ) { return "r"; } else if ( !read & write & !append ) { return "w+"; } else if ( !read & write & append ) { return "a"; } else if ( read & write & !append ) { return "w+"; } // may be a bug in FS::mode interpretation, "r+" seems proper else if ( read & write & append ) { return "a+"; } else { return "r"; } } static time_t wrapperTimeCB(void) { extern void (*__SD__userDateTimeCB)(uint16_t*, uint16_t*); if (__SD__userDateTimeCB) { uint16_t d, t; __SD__userDateTimeCB(&d, &t); return sdfs::SDFSImpl::FatToTimeT(d, t); } return time(nullptr); } }; // Expose FatStructs.h helpers for MSDOS date/time for use with dateTimeCallback static inline uint16_t FAT_DATE(uint16_t year, uint8_t month, uint8_t day) { return (year - 1980) << 9 | month << 5 | day; } static inline uint16_t FAT_YEAR(uint16_t fatDate) { return 1980 + (fatDate >> 9); } static inline uint8_t FAT_MONTH(uint16_t fatDate) { return (fatDate >> 5) & 0XF; } static inline uint8_t FAT_DAY(uint16_t fatDate) { return fatDate & 0X1F; } static inline uint16_t FAT_TIME(uint8_t hour, uint8_t minute, uint8_t second) { return hour << 11 | minute << 5 | second >> 1; } static inline uint8_t FAT_HOUR(uint16_t fatTime) { return fatTime >> 11; } static inline uint8_t FAT_MINUTE(uint16_t fatTime) { return (fatTime >> 5) & 0X3F; } static inline uint8_t FAT_SECOND(uint16_t fatTime) { return 2*(fatTime & 0X1F); } #if !defined(NO_GLOBAL_INSTANCES) && !defined(NO_GLOBAL_SD) extern SDClass SD; #endif #endif