muele-marlin/Marlin/src/sd/SdBaseFile.h

505 lines
17 KiB
C
Raw Normal View History

/**
2016-03-24 18:01:20 +00:00
* Marlin 3D Printer Firmware
* Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
2011-11-18 21:17:37 +00:00
*
2016-03-24 18:01:20 +00:00
* Based on Sprinter and grbl.
* Copyright (C) 2011 Camiel Gubbels / Erik van der Zalm
2011-11-18 21:17:37 +00:00
*
2016-03-24 18:01:20 +00:00
* This program is free software: you can redistribute it and/or modify
2011-11-18 21:17:37 +00:00
* 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.
*
2016-03-24 18:01:20 +00:00
* This program is distributed in the hope that it will be useful,
2011-11-18 21:17:37 +00:00
* 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
2016-03-24 18:01:20 +00:00
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
2017-11-15 06:06:20 +00:00
/**
* \file
* \brief SdBaseFile class
*/
/**
2016-03-24 18:01:20 +00:00
* Arduino SdFat Library
* Copyright (C) 2009 by William Greiman
*
* This file is part of the Arduino Sd2Card Library
2011-11-18 21:17:37 +00:00
*/
2017-11-15 06:06:20 +00:00
#ifndef _SDBASEFILE_H_
#define _SDBASEFILE_H_
2017-09-06 11:28:32 +00:00
2011-11-18 21:17:37 +00:00
#include "SdFatConfig.h"
#include "SdVolume.h"
2017-09-06 11:28:32 +00:00
#include <stdint.h>
2011-11-18 21:17:37 +00:00
/**
2016-02-11 04:49:25 +00:00
* \struct filepos_t
2011-11-18 21:17:37 +00:00
* \brief internal type for istream
* do not use in user apps
*/
2016-02-11 04:49:25 +00:00
struct filepos_t {
2017-11-15 06:06:20 +00:00
uint32_t position; // stream byte position
uint32_t cluster; // cluster of position
2016-02-11 04:49:25 +00:00
filepos_t() : position(0), cluster(0) {}
2011-11-18 21:17:37 +00:00
};
// use the gnu style oflag in open()
2017-11-15 06:06:20 +00:00
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
2011-11-18 21:17:37 +00:00
// SdBaseFile class static and const definitions
2017-11-15 06:06:20 +00:00
2011-11-18 21:17:37 +00:00
// flags for ls()
2017-11-15 06:06:20 +00:00
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
2011-11-18 21:17:37 +00:00
// flags for timestamp
2017-11-15 06:06:20 +00:00
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
2011-11-18 21:17:37 +00:00
// values for type_
2017-11-15 06:06:20 +00:00
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
2011-11-18 21:17:37 +00:00
* \param[in] year [1980,2107]
* \param[in] month [1,12]
* \param[in] day [1,31]
*
* \return Packed date for dir_t entry.
*/
2017-11-15 06:06:20 +00:00
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
2011-11-18 21:17:37 +00:00
* \param[in] fatDate Date in packed dir format.
*
* \return Extracted year [1980,2107]
*/
2017-11-15 06:06:20 +00:00
static inline uint16_t FAT_YEAR(uint16_t fatDate) { return 1980 + (fatDate >> 9); }
/**
* month part of FAT directory date field
2011-11-18 21:17:37 +00:00
* \param[in] fatDate Date in packed dir format.
*
* \return Extracted month [1,12]
*/
2017-11-15 06:06:20 +00:00
static inline uint8_t FAT_MONTH(uint16_t fatDate) { return (fatDate >> 5) & 0XF; }
/**
* day part of FAT directory date field
2011-11-18 21:17:37 +00:00
* \param[in] fatDate Date in packed dir format.
*
* \return Extracted day [1,31]
*/
2017-11-15 06:06:20 +00:00
static inline uint8_t FAT_DAY(uint16_t fatDate) { return fatDate & 0x1F; }
/**
* time field for FAT directory entry
2011-11-18 21:17:37 +00:00
* \param[in] hour [0,23]
* \param[in] minute [0,59]
* \param[in] second [0,59]
*
* \return Packed time for dir_t entry.
*/
2017-11-15 06:06:20 +00:00
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
2011-11-18 21:17:37 +00:00
* \param[in] fatTime Time in packed dir format.
*
* \return Extracted hour [0,23]
*/
2017-11-15 06:06:20 +00:00
static inline uint8_t FAT_HOUR(uint16_t fatTime) { return fatTime >> 11; }
/**
* minute part of FAT directory time field
2011-11-18 21:17:37 +00:00
* \param[in] fatTime Time in packed dir format.
*
* \return Extracted minute [0,59]
*/
2017-11-15 06:06:20 +00:00
static inline uint8_t FAT_MINUTE(uint16_t fatTime) { return (fatTime >> 5) & 0x3F; }
/**
* second part of FAT directory time field
2011-11-18 21:17:37 +00:00
* Note second/2 is stored in packed time.
*
* \param[in] fatTime Time in packed dir format.
*
* \return Extracted second [0,58]
*/
2017-11-15 06:06:20 +00:00
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;
2017-11-15 06:06:20 +00:00
// Default time for file timestamp is 1 am
uint16_t const FAT_DEFAULT_TIME = (1 << 11);
2017-11-15 06:06:20 +00:00
2011-11-18 21:17:37 +00:00
/**
* \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);
2017-11-15 06:06:20 +00:00
~SdBaseFile() { if (isOpen()) close(); }
2011-11-18 21:17:37 +00:00
/**
* 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;
2017-11-15 06:06:20 +00:00
2011-11-18 21:17:37 +00:00
// helpers for stream classes
2017-11-15 06:06:20 +00:00
/**
* get position for streams
2011-11-18 21:17:37 +00:00
* \param[out] pos struct to receive position
*/
2016-02-11 04:49:25 +00:00
void getpos(filepos_t* pos);
2017-11-15 06:06:20 +00:00
/**
* set position for streams
2011-11-18 21:17:37 +00:00
* \param[out] pos struct with value for new position
*/
2016-02-11 04:49:25 +00:00
void setpos(filepos_t* pos);
2017-11-15 06:06:20 +00:00
2011-11-18 21:17:37 +00:00
bool close();
bool contiguousRange(uint32_t* bgnBlock, uint32_t* endBlock);
bool createContiguous(SdBaseFile* dirFile,
const char* path, uint32_t size);
2017-11-15 06:06:20 +00:00
/**
* \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
2011-11-18 21:17:37 +00:00
*
* \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;
}
2017-11-15 06:06:20 +00:00
/**
* Cancel the date/time callback function.
*/
static void dateTimeCallbackCancel() { dateTime_ = 0; }
2011-11-18 21:17:37 +00:00
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);
2017-11-15 06:06:20 +00:00
/**
* \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 getFilename(char * const name);
void ls(uint8_t flags = 0, uint8_t indent = 0);
2017-11-15 06:06:20 +00:00
2011-11-18 21:17:37 +00:00
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();
2011-11-18 21:17:37 +00:00
int16_t read();
int16_t read(void* buf, uint16_t nbyte);
2012-08-22 12:49:57 +00:00
int8_t readDir(dir_t* dir, char* longFilename);
2011-11-18 21:17:37 +00:00
static bool remove(SdBaseFile* dirFile, const char* path);
bool remove();
2017-11-15 06:06:20 +00:00
/**
* Set the file's current position to zero.
*/
void rewind() { seekSet(0); }
2011-11-18 21:17:37 +00:00
bool rename(SdBaseFile* dirFile, const char* newPath);
bool rmdir();
bool rmRfStar();
2017-11-15 06:06:20 +00:00
/**
* Set the files position to current position + \a pos. See seekSet().
2011-11-18 21:17:37 +00:00
* \param[in] offset The new position in bytes from the current position.
* \return true for success or false for failure.
*/
2017-11-15 06:06:20 +00:00
bool seekCur(const int32_t offset) { return seekSet(curPosition_ + offset); }
/**
* Set the files position to end-of-file + \a offset. See seekSet().
2011-11-18 21:17:37 +00:00
* \param[in] offset The new position in bytes from end-of-file.
* \return true for success or false for failure.
*/
2017-11-15 06:06:20 +00:00
bool seekEnd(const int32_t offset = 0) { return seekSet(fileSize_ + offset); }
bool seekSet(const uint32_t pos);
2011-11-18 21:17:37 +00:00
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);
2017-11-15 06:06:20 +00:00
/**
* Type of file. Use isFile() or isDir() instead of type() if possible.
2011-11-18 21:17:37 +00:00
*
* \return The file or directory type.
*/
2017-11-15 06:06:20 +00:00
uint8_t type() const { return type_; }
2011-11-18 21:17:37 +00:00
bool truncate(uint32_t size);
2017-11-15 06:06:20 +00:00
/**
* \return SdVolume that contains this file.
*/
SdVolume* volume() const { return vol_; }
2011-11-18 21:17:37 +00:00
int16_t write(const void* buf, uint16_t nbyte);
2017-11-15 06:06:20 +00:00
2011-11-18 21:17:37 +00:00
private:
2017-11-15 06:06:20 +00:00
friend class SdFat; // allow SdFat to set cwd_
static SdBaseFile* cwd_; // global pointer to cwd dir
2011-11-18 21:17:37 +00:00
// data time callback function
static void (*dateTime_)(uint16_t* date, uint16_t* time);
2017-11-15 06:06:20 +00:00
2011-11-18 21:17:37 +00:00
// bits defined in flags_
2017-11-15 06:06:20 +00:00
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
2011-11-18 21:17:37 +00:00
// 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
2017-11-15 06:06:20 +00:00
/**
* EXPERIMENTAL - Don't use!
*/
//bool openParent(SdBaseFile* dir);
2011-11-18 21:17:37 +00:00
// private functions
bool addCluster();
bool addDirCluster();
dir_t* cacheDirEntry(uint8_t action);
int8_t lsPrintNext(uint8_t flags, uint8_t indent);
2011-11-18 21:17:37 +00:00
static bool make83Name(const char* str, uint8_t* name, const char** ptr);
bool mkdir(SdBaseFile* parent, const uint8_t dname[11]);
bool open(SdBaseFile* dirFile, const uint8_t dname[11], uint8_t oflag);
bool openCachedEntry(uint8_t cacheIndex, uint8_t oflags);
dir_t* readDirCache();
2017-11-15 06:06:20 +00:00
// Deprecated functions
#if ALLOW_DEPRECATED_FUNCTIONS
2011-11-18 21:17:37 +00:00
public:
2017-11-15 06:06:20 +00:00
/**
* \deprecated Use:
2011-11-18 21:17:37 +00:00
* bool contiguousRange(uint32_t* bgnBlock, uint32_t* endBlock);
* \param[out] bgnBlock the first block address for the file.
* \param[out] endBlock the last block address for the file.
* \return true for success or false for failure.
*/
2017-11-15 06:06:20 +00:00
bool contiguousRange(uint32_t& bgnBlock, uint32_t& endBlock) {
2011-11-18 21:17:37 +00:00
return contiguousRange(&bgnBlock, &endBlock);
}
2017-11-15 06:06:20 +00:00
/**
* \deprecated Use:
* bool createContiguous(SdBaseFile* dirFile, const char* path, uint32_t size)
* \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 or false for failure.
*/
bool createContiguous(SdBaseFile& dirFile, const char* path, uint32_t size) {
2011-11-18 21:17:37 +00:00
return createContiguous(&dirFile, path, size);
}
2017-11-15 06:06:20 +00:00
/**
* \deprecated Use:
2011-11-18 21:17:37 +00:00
* static void dateTimeCallback(
* void (*dateTime)(uint16_t* date, uint16_t* time));
* \param[in] dateTime The user's call back function.
*/
static void dateTimeCallback(
2017-11-15 06:06:20 +00:00
void (*dateTime)(uint16_t &date, uint16_t &time)) {
2011-11-18 21:17:37 +00:00
oldDateTime_ = dateTime;
dateTime_ = dateTime ? oldToNew : 0;
}
2017-11-15 06:06:20 +00:00
/**
* \deprecated Use:
2011-11-18 21:17:37 +00:00
* bool open(SdBaseFile* dirFile, const char* path, uint8_t oflag);
* \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 the file.
* \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.
* \return true for success or false for failure.
*/
2017-11-15 06:06:20 +00:00
bool open(SdBaseFile& dirFile, const char* path, uint8_t oflag) {
2011-11-18 21:17:37 +00:00
return open(&dirFile, path, oflag);
}
2017-11-15 06:06:20 +00:00
/**
* \deprecated Do not use in new apps
2011-11-18 21:17:37 +00:00
* \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.
* \return true for success or false for failure.
*/
2017-11-15 06:06:20 +00:00
bool open(SdBaseFile& dirFile, const char* path) {
2011-11-18 21:17:37 +00:00
return open(dirFile, path, O_RDWR);
}
2017-11-15 06:06:20 +00:00
/**
* \deprecated Use:
2011-11-18 21:17:37 +00:00
* bool open(SdBaseFile* dirFile, uint16_t index, uint8_t oflag);
* \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.
* \return true for success or false for failure.
*/
2017-11-15 06:06:20 +00:00
bool open(SdBaseFile& dirFile, uint16_t index, uint8_t oflag) {
2011-11-18 21:17:37 +00:00
return open(&dirFile, index, oflag);
}
2017-11-15 06:06:20 +00:00
/**
* \deprecated Use: bool openRoot(SdVolume* vol);
2011-11-18 21:17:37 +00:00
* \param[in] vol The FAT volume containing the root directory to be opened.
* \return true for success or false for failure.
*/
2017-11-15 06:06:20 +00:00
bool openRoot(SdVolume& vol) { return openRoot(&vol); }
/**
* \deprecated Use: int8_t readDir(dir_t* dir);
2011-11-18 21:17:37 +00:00
* \param[out] dir The dir_t struct that will receive the data.
* \return bytes read for success zero for eof or -1 for failure.
*/
2017-11-15 06:06:20 +00:00
int8_t readDir(dir_t& dir, char* longFilename) {
return readDir(&dir, longFilename);
}
/**
* \deprecated Use:
2011-11-18 21:17:37 +00:00
* static uint8_t remove(SdBaseFile* dirFile, const char* path);
* \param[in] dirFile The directory that contains the file.
* \param[in] path The name of the file to be removed.
* \return true for success or false for failure.
*/
2017-11-15 06:06:20 +00:00
static bool remove(SdBaseFile& dirFile, const char* path) { return remove(&dirFile, path); }
2011-11-18 21:17:37 +00:00
private:
2017-11-15 06:06:20 +00:00
static void (*oldDateTime_)(uint16_t &date, uint16_t &time);
static void oldToNew(uint16_t * const date, uint16_t * const time) {
uint16_t d, t;
2011-11-18 21:17:37 +00:00
oldDateTime_(d, t);
*date = d;
*time = t;
}
#endif // ALLOW_DEPRECATED_FUNCTIONS
};
2017-11-15 06:06:20 +00:00
#endif // _SDBASEFILE_H_