My Marlin configs for Fabrikator Mini and CTC i3 Pro B
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

SdBaseFile.h 18KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479
  1. /* Arduino SdFat Library
  2. * Copyright (C) 2009 by William Greiman
  3. *
  4. * This file is part of the Arduino SdFat Library
  5. *
  6. * This Library is free software: you can redistribute it and/or modify
  7. * it under the terms of the GNU General Public License as published by
  8. * the Free Software Foundation, either version 3 of the License, or
  9. * (at your option) any later version.
  10. *
  11. * This Library is distributed in the hope that it will be useful,
  12. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. * GNU General Public License for more details.
  15. *
  16. * You should have received a copy of the GNU General Public License
  17. * along with the Arduino SdFat Library. If not, see
  18. * <http://www.gnu.org/licenses/>.
  19. */
  20. #ifndef SdBaseFile_h
  21. #define SdBaseFile_h
  22. /**
  23. * \file
  24. * \brief SdBaseFile class
  25. */
  26. #include "Marlin.h"
  27. #include "SdFatConfig.h"
  28. #include "SdVolume.h"
  29. //------------------------------------------------------------------------------
  30. /**
  31. * \struct fpos_t
  32. * \brief internal type for istream
  33. * do not use in user apps
  34. */
  35. struct fpos_t {
  36. /** stream position */
  37. uint32_t position;
  38. /** cluster for position */
  39. uint32_t cluster;
  40. fpos_t() : position(0), cluster(0) {}
  41. };
  42. // use the gnu style oflag in open()
  43. /** open() oflag for reading */
  44. uint8_t const O_READ = 0X01;
  45. /** open() oflag - same as O_IN */
  46. uint8_t const O_RDONLY = O_READ;
  47. /** open() oflag for write */
  48. uint8_t const O_WRITE = 0X02;
  49. /** open() oflag - same as O_WRITE */
  50. uint8_t const O_WRONLY = O_WRITE;
  51. /** open() oflag for reading and writing */
  52. uint8_t const O_RDWR = (O_READ | O_WRITE);
  53. /** open() oflag mask for access modes */
  54. uint8_t const O_ACCMODE = (O_READ | O_WRITE);
  55. /** The file offset shall be set to the end of the file prior to each write. */
  56. uint8_t const O_APPEND = 0X04;
  57. /** synchronous writes - call sync() after each write */
  58. uint8_t const O_SYNC = 0X08;
  59. /** truncate the file to zero length */
  60. uint8_t const O_TRUNC = 0X10;
  61. /** set the initial position at the end of the file */
  62. uint8_t const O_AT_END = 0X20;
  63. /** create the file if nonexistent */
  64. uint8_t const O_CREAT = 0X40;
  65. /** If O_CREAT and O_EXCL are set, open() shall fail if the file exists */
  66. uint8_t const O_EXCL = 0X80;
  67. // SdBaseFile class static and const definitions
  68. // flags for ls()
  69. /** ls() flag to print modify date */
  70. uint8_t const LS_DATE = 1;
  71. /** ls() flag to print file size */
  72. uint8_t const LS_SIZE = 2;
  73. /** ls() flag for recursive list of subdirectories */
  74. uint8_t const LS_R = 4;
  75. // flags for timestamp
  76. /** set the file's last access date */
  77. uint8_t const T_ACCESS = 1;
  78. /** set the file's creation date and time */
  79. uint8_t const T_CREATE = 2;
  80. /** Set the file's write date and time */
  81. uint8_t const T_WRITE = 4;
  82. // values for type_
  83. /** This file has not been opened. */
  84. uint8_t const FAT_FILE_TYPE_CLOSED = 0;
  85. /** A normal file */
  86. uint8_t const FAT_FILE_TYPE_NORMAL = 1;
  87. /** A FAT12 or FAT16 root directory */
  88. uint8_t const FAT_FILE_TYPE_ROOT_FIXED = 2;
  89. /** A FAT32 root directory */
  90. uint8_t const FAT_FILE_TYPE_ROOT32 = 3;
  91. /** A subdirectory file*/
  92. uint8_t const FAT_FILE_TYPE_SUBDIR = 4;
  93. /** Test value for directory type */
  94. uint8_t const FAT_FILE_TYPE_MIN_DIR = FAT_FILE_TYPE_ROOT_FIXED;
  95. /** date field for FAT directory entry
  96. * \param[in] year [1980,2107]
  97. * \param[in] month [1,12]
  98. * \param[in] day [1,31]
  99. *
  100. * \return Packed date for dir_t entry.
  101. */
  102. static inline uint16_t FAT_DATE(uint16_t year, uint8_t month, uint8_t day) {
  103. return (year - 1980) << 9 | month << 5 | day;
  104. }
  105. /** year part of FAT directory date field
  106. * \param[in] fatDate Date in packed dir format.
  107. *
  108. * \return Extracted year [1980,2107]
  109. */
  110. static inline uint16_t FAT_YEAR(uint16_t fatDate) {
  111. return 1980 + (fatDate >> 9);
  112. }
  113. /** month part of FAT directory date field
  114. * \param[in] fatDate Date in packed dir format.
  115. *
  116. * \return Extracted month [1,12]
  117. */
  118. static inline uint8_t FAT_MONTH(uint16_t fatDate) {
  119. return (fatDate >> 5) & 0XF;
  120. }
  121. /** day part of FAT directory date field
  122. * \param[in] fatDate Date in packed dir format.
  123. *
  124. * \return Extracted day [1,31]
  125. */
  126. static inline uint8_t FAT_DAY(uint16_t fatDate) {
  127. return fatDate & 0X1F;
  128. }
  129. /** time field for FAT directory entry
  130. * \param[in] hour [0,23]
  131. * \param[in] minute [0,59]
  132. * \param[in] second [0,59]
  133. *
  134. * \return Packed time for dir_t entry.
  135. */
  136. static inline uint16_t FAT_TIME(uint8_t hour, uint8_t minute, uint8_t second) {
  137. return hour << 11 | minute << 5 | second >> 1;
  138. }
  139. /** hour part of FAT directory time field
  140. * \param[in] fatTime Time in packed dir format.
  141. *
  142. * \return Extracted hour [0,23]
  143. */
  144. static inline uint8_t FAT_HOUR(uint16_t fatTime) {
  145. return fatTime >> 11;
  146. }
  147. /** minute part of FAT directory time field
  148. * \param[in] fatTime Time in packed dir format.
  149. *
  150. * \return Extracted minute [0,59]
  151. */
  152. static inline uint8_t FAT_MINUTE(uint16_t fatTime) {
  153. return(fatTime >> 5) & 0X3F;
  154. }
  155. /** second part of FAT directory time field
  156. * Note second/2 is stored in packed time.
  157. *
  158. * \param[in] fatTime Time in packed dir format.
  159. *
  160. * \return Extracted second [0,58]
  161. */
  162. static inline uint8_t FAT_SECOND(uint16_t fatTime) {
  163. return 2*(fatTime & 0X1F);
  164. }
  165. /** Default date for file timestamps is 1 Jan 2000 */
  166. uint16_t const FAT_DEFAULT_DATE = ((2000 - 1980) << 9) | (1 << 5) | 1;
  167. /** Default time for file timestamp is 1 am */
  168. uint16_t const FAT_DEFAULT_TIME = (1 << 11);
  169. //------------------------------------------------------------------------------
  170. /**
  171. * \class SdBaseFile
  172. * \brief Base class for SdFile with Print and C++ streams.
  173. */
  174. class SdBaseFile {
  175. public:
  176. /** Create an instance. */
  177. SdBaseFile() : writeError(false), type_(FAT_FILE_TYPE_CLOSED) {}
  178. SdBaseFile(const char* path, uint8_t oflag);
  179. ~SdBaseFile() {if(isOpen()) close();}
  180. /**
  181. * writeError is set to true if an error occurs during a write().
  182. * Set writeError to false before calling print() and/or write() and check
  183. * for true after calls to print() and/or write().
  184. */
  185. bool writeError;
  186. //----------------------------------------------------------------------------
  187. // helpers for stream classes
  188. /** get position for streams
  189. * \param[out] pos struct to receive position
  190. */
  191. void getpos(fpos_t* pos);
  192. /** set position for streams
  193. * \param[out] pos struct with value for new position
  194. */
  195. void setpos(fpos_t* pos);
  196. //----------------------------------------------------------------------------
  197. bool close();
  198. bool contiguousRange(uint32_t* bgnBlock, uint32_t* endBlock);
  199. bool createContiguous(SdBaseFile* dirFile,
  200. const char* path, uint32_t size);
  201. /** \return The current cluster number for a file or directory. */
  202. uint32_t curCluster() const {return curCluster_;}
  203. /** \return The current position for a file or directory. */
  204. uint32_t curPosition() const {return curPosition_;}
  205. /** \return Current working directory */
  206. static SdBaseFile* cwd() {return cwd_;}
  207. /** Set the date/time callback function
  208. *
  209. * \param[in] dateTime The user's call back function. The callback
  210. * function is of the form:
  211. *
  212. * \code
  213. * void dateTime(uint16_t* date, uint16_t* time) {
  214. * uint16_t year;
  215. * uint8_t month, day, hour, minute, second;
  216. *
  217. * // User gets date and time from GPS or real-time clock here
  218. *
  219. * // return date using FAT_DATE macro to format fields
  220. * *date = FAT_DATE(year, month, day);
  221. *
  222. * // return time using FAT_TIME macro to format fields
  223. * *time = FAT_TIME(hour, minute, second);
  224. * }
  225. * \endcode
  226. *
  227. * Sets the function that is called when a file is created or when
  228. * a file's directory entry is modified by sync(). All timestamps,
  229. * access, creation, and modify, are set when a file is created.
  230. * sync() maintains the last access date and last modify date/time.
  231. *
  232. * See the timestamp() function.
  233. */
  234. static void dateTimeCallback(
  235. void (*dateTime)(uint16_t* date, uint16_t* time)) {
  236. dateTime_ = dateTime;
  237. }
  238. /** Cancel the date/time callback function. */
  239. static void dateTimeCallbackCancel() {dateTime_ = 0;}
  240. bool dirEntry(dir_t* dir);
  241. static void dirName(const dir_t& dir, char* name);
  242. bool exists(const char* name);
  243. int16_t fgets(char* str, int16_t num, char* delim = 0);
  244. /** \return The total number of bytes in a file or directory. */
  245. uint32_t fileSize() const {return fileSize_;}
  246. /** \return The first cluster number for a file or directory. */
  247. uint32_t firstCluster() const {return firstCluster_;}
  248. bool getFilename(char* name);
  249. /** \return True if this is a directory else false. */
  250. bool isDir() const {return type_ >= FAT_FILE_TYPE_MIN_DIR;}
  251. /** \return True if this is a normal file else false. */
  252. bool isFile() const {return type_ == FAT_FILE_TYPE_NORMAL;}
  253. /** \return True if this is an open file/directory else false. */
  254. bool isOpen() const {return type_ != FAT_FILE_TYPE_CLOSED;}
  255. /** \return True if this is a subdirectory else false. */
  256. bool isSubDir() const {return type_ == FAT_FILE_TYPE_SUBDIR;}
  257. /** \return True if this is the root directory. */
  258. bool isRoot() const {
  259. return type_ == FAT_FILE_TYPE_ROOT_FIXED || type_ == FAT_FILE_TYPE_ROOT32;
  260. }
  261. void ls( uint8_t flags = 0, uint8_t indent = 0);
  262. bool mkdir(SdBaseFile* dir, const char* path, bool pFlag = true);
  263. // alias for backward compactability
  264. bool makeDir(SdBaseFile* dir, const char* path) {
  265. return mkdir(dir, path, false);
  266. }
  267. bool open(SdBaseFile* dirFile, uint16_t index, uint8_t oflag);
  268. bool open(SdBaseFile* dirFile, const char* path, uint8_t oflag);
  269. bool open(const char* path, uint8_t oflag = O_READ);
  270. bool openNext(SdBaseFile* dirFile, uint8_t oflag);
  271. bool openRoot(SdVolume* vol);
  272. int peek();
  273. static void printFatDate(uint16_t fatDate);
  274. static void printFatTime( uint16_t fatTime);
  275. bool printName();
  276. int16_t read();
  277. int16_t read(void* buf, uint16_t nbyte);
  278. int8_t readDir(dir_t* dir);
  279. static bool remove(SdBaseFile* dirFile, const char* path);
  280. bool remove();
  281. /** Set the file's current position to zero. */
  282. void rewind() {seekSet(0);}
  283. bool rename(SdBaseFile* dirFile, const char* newPath);
  284. bool rmdir();
  285. // for backward compatibility
  286. bool rmDir() {return rmdir();}
  287. bool rmRfStar();
  288. /** Set the files position to current position + \a pos. See seekSet().
  289. * \param[in] offset The new position in bytes from the current position.
  290. * \return true for success or false for failure.
  291. */
  292. bool seekCur(int32_t offset) {
  293. return seekSet(curPosition_ + offset);
  294. }
  295. /** Set the files position to end-of-file + \a offset. See seekSet().
  296. * \param[in] offset The new position in bytes from end-of-file.
  297. * \return true for success or false for failure.
  298. */
  299. bool seekEnd(int32_t offset = 0) {return seekSet(fileSize_ + offset);}
  300. bool seekSet(uint32_t pos);
  301. bool sync();
  302. bool timestamp(SdBaseFile* file);
  303. bool timestamp(uint8_t flag, uint16_t year, uint8_t month, uint8_t day,
  304. uint8_t hour, uint8_t minute, uint8_t second);
  305. /** Type of file. You should use isFile() or isDir() instead of type()
  306. * if possible.
  307. *
  308. * \return The file or directory type.
  309. */
  310. uint8_t type() const {return type_;}
  311. bool truncate(uint32_t size);
  312. /** \return SdVolume that contains this file. */
  313. SdVolume* volume() const {return vol_;}
  314. int16_t write(const void* buf, uint16_t nbyte);
  315. //------------------------------------------------------------------------------
  316. private:
  317. // allow SdFat to set cwd_
  318. friend class SdFat;
  319. // global pointer to cwd dir
  320. static SdBaseFile* cwd_;
  321. // data time callback function
  322. static void (*dateTime_)(uint16_t* date, uint16_t* time);
  323. // bits defined in flags_
  324. // should be 0X0F
  325. static uint8_t const F_OFLAG = (O_ACCMODE | O_APPEND | O_SYNC);
  326. // sync of directory entry required
  327. static uint8_t const F_FILE_DIR_DIRTY = 0X80;
  328. // private data
  329. uint8_t flags_; // See above for definition of flags_ bits
  330. uint8_t fstate_; // error and eof indicator
  331. uint8_t type_; // type of file see above for values
  332. uint32_t curCluster_; // cluster for current file position
  333. uint32_t curPosition_; // current file position in bytes from beginning
  334. uint32_t dirBlock_; // block for this files directory entry
  335. uint8_t dirIndex_; // index of directory entry in dirBlock
  336. uint32_t fileSize_; // file size in bytes
  337. uint32_t firstCluster_; // first cluster of file
  338. SdVolume* vol_; // volume where file is located
  339. /** experimental don't use */
  340. bool openParent(SdBaseFile* dir);
  341. // private functions
  342. bool addCluster();
  343. bool addDirCluster();
  344. dir_t* cacheDirEntry(uint8_t action);
  345. int8_t lsPrintNext( uint8_t flags, uint8_t indent);
  346. static bool make83Name(const char* str, uint8_t* name, const char** ptr);
  347. bool mkdir(SdBaseFile* parent, const uint8_t dname[11]);
  348. bool open(SdBaseFile* dirFile, const uint8_t dname[11], uint8_t oflag);
  349. bool openCachedEntry(uint8_t cacheIndex, uint8_t oflags);
  350. dir_t* readDirCache();
  351. //------------------------------------------------------------------------------
  352. // to be deleted
  353. static void printDirName( const dir_t& dir,
  354. uint8_t width, bool printSlash);
  355. //------------------------------------------------------------------------------
  356. // Deprecated functions - suppress cpplint warnings with NOLINT comment
  357. #if ALLOW_DEPRECATED_FUNCTIONS && !defined(DOXYGEN)
  358. public:
  359. /** \deprecated Use:
  360. * bool contiguousRange(uint32_t* bgnBlock, uint32_t* endBlock);
  361. * \param[out] bgnBlock the first block address for the file.
  362. * \param[out] endBlock the last block address for the file.
  363. * \return true for success or false for failure.
  364. */
  365. bool contiguousRange(uint32_t& bgnBlock, uint32_t& endBlock) { // NOLINT
  366. return contiguousRange(&bgnBlock, &endBlock);
  367. }
  368. /** \deprecated Use:
  369. * bool createContiguous(SdBaseFile* dirFile,
  370. * const char* path, uint32_t size)
  371. * \param[in] dirFile The directory where the file will be created.
  372. * \param[in] path A path with a valid DOS 8.3 file name.
  373. * \param[in] size The desired file size.
  374. * \return true for success or false for failure.
  375. */
  376. bool createContiguous(SdBaseFile& dirFile, // NOLINT
  377. const char* path, uint32_t size) {
  378. return createContiguous(&dirFile, path, size);
  379. }
  380. /** \deprecated Use:
  381. * static void dateTimeCallback(
  382. * void (*dateTime)(uint16_t* date, uint16_t* time));
  383. * \param[in] dateTime The user's call back function.
  384. */
  385. static void dateTimeCallback(
  386. void (*dateTime)(uint16_t& date, uint16_t& time)) { // NOLINT
  387. oldDateTime_ = dateTime;
  388. dateTime_ = dateTime ? oldToNew : 0;
  389. }
  390. /** \deprecated Use: bool dirEntry(dir_t* dir);
  391. * \param[out] dir Location for return of the file's directory entry.
  392. * \return true for success or false for failure.
  393. */
  394. bool dirEntry(dir_t& dir) {return dirEntry(&dir);} // NOLINT
  395. /** \deprecated Use:
  396. * bool mkdir(SdBaseFile* dir, const char* path);
  397. * \param[in] dir An open SdFat instance for the directory that will contain
  398. * the new directory.
  399. * \param[in] path A path with a valid 8.3 DOS name for the new directory.
  400. * \return true for success or false for failure.
  401. */
  402. bool mkdir(SdBaseFile& dir, const char* path) { // NOLINT
  403. return mkdir(&dir, path);
  404. }
  405. /** \deprecated Use:
  406. * bool open(SdBaseFile* dirFile, const char* path, uint8_t oflag);
  407. * \param[in] dirFile An open SdFat instance for the directory containing the
  408. * file to be opened.
  409. * \param[in] path A path with a valid 8.3 DOS name for the file.
  410. * \param[in] oflag Values for \a oflag are constructed by a bitwise-inclusive
  411. * OR of flags O_READ, O_WRITE, O_TRUNC, and O_SYNC.
  412. * \return true for success or false for failure.
  413. */
  414. bool open(SdBaseFile& dirFile, // NOLINT
  415. const char* path, uint8_t oflag) {
  416. return open(&dirFile, path, oflag);
  417. }
  418. /** \deprecated Do not use in new apps
  419. * \param[in] dirFile An open SdFat instance for the directory containing the
  420. * file to be opened.
  421. * \param[in] path A path with a valid 8.3 DOS name for a file to be opened.
  422. * \return true for success or false for failure.
  423. */
  424. bool open(SdBaseFile& dirFile, const char* path) { // NOLINT
  425. return open(dirFile, path, O_RDWR);
  426. }
  427. /** \deprecated Use:
  428. * bool open(SdBaseFile* dirFile, uint16_t index, uint8_t oflag);
  429. * \param[in] dirFile An open SdFat instance for the directory.
  430. * \param[in] index The \a index of the directory entry for the file to be
  431. * opened. The value for \a index is (directory file position)/32.
  432. * \param[in] oflag Values for \a oflag are constructed by a bitwise-inclusive
  433. * OR of flags O_READ, O_WRITE, O_TRUNC, and O_SYNC.
  434. * \return true for success or false for failure.
  435. */
  436. bool open(SdBaseFile& dirFile, uint16_t index, uint8_t oflag) { // NOLINT
  437. return open(&dirFile, index, oflag);
  438. }
  439. /** \deprecated Use: bool openRoot(SdVolume* vol);
  440. * \param[in] vol The FAT volume containing the root directory to be opened.
  441. * \return true for success or false for failure.
  442. */
  443. bool openRoot(SdVolume& vol) {return openRoot(&vol);} // NOLINT
  444. /** \deprecated Use: int8_t readDir(dir_t* dir);
  445. * \param[out] dir The dir_t struct that will receive the data.
  446. * \return bytes read for success zero for eof or -1 for failure.
  447. */
  448. int8_t readDir(dir_t& dir) {return readDir(&dir);} // NOLINT
  449. /** \deprecated Use:
  450. * static uint8_t remove(SdBaseFile* dirFile, const char* path);
  451. * \param[in] dirFile The directory that contains the file.
  452. * \param[in] path The name of the file to be removed.
  453. * \return true for success or false for failure.
  454. */
  455. static bool remove(SdBaseFile& dirFile, const char* path) { // NOLINT
  456. return remove(&dirFile, path);
  457. }
  458. //------------------------------------------------------------------------------
  459. // rest are private
  460. private:
  461. static void (*oldDateTime_)(uint16_t& date, uint16_t& time); // NOLINT
  462. static void oldToNew(uint16_t* date, uint16_t* time) {
  463. uint16_t d;
  464. uint16_t t;
  465. oldDateTime_(d, t);
  466. *date = d;
  467. *time = t;
  468. }
  469. #endif // ALLOW_DEPRECATED_FUNCTIONS
  470. };
  471. #endif // SdBaseFile_h