My Marlin configs for Fabrikator Mini and CTC i3 Pro B
您最多选择25个主题 主题必须以字母或数字开头,可以包含连字符 (-),并且长度不得超过35个字符

SdBaseFile.cpp 55KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814
  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. #include "Marlin.h"
  21. #if ENABLED(SDSUPPORT)
  22. #include "SdBaseFile.h"
  23. //------------------------------------------------------------------------------
  24. // pointer to cwd directory
  25. SdBaseFile* SdBaseFile::cwd_ = 0;
  26. // callback function for date/time
  27. void (*SdBaseFile::dateTime_)(uint16_t* date, uint16_t* time) = 0;
  28. //------------------------------------------------------------------------------
  29. // add a cluster to a file
  30. bool SdBaseFile::addCluster() {
  31. if (!vol_->allocContiguous(1, &curCluster_)) goto fail;
  32. // if first cluster of file link to directory entry
  33. if (firstCluster_ == 0) {
  34. firstCluster_ = curCluster_;
  35. flags_ |= F_FILE_DIR_DIRTY;
  36. }
  37. return true;
  38. fail:
  39. return false;
  40. }
  41. //------------------------------------------------------------------------------
  42. // Add a cluster to a directory file and zero the cluster.
  43. // return with first block of cluster in the cache
  44. bool SdBaseFile::addDirCluster() {
  45. uint32_t block;
  46. // max folder size
  47. if (fileSize_/sizeof(dir_t) >= 0XFFFF) goto fail;
  48. if (!addCluster()) goto fail;
  49. if (!vol_->cacheFlush()) goto fail;
  50. block = vol_->clusterStartBlock(curCluster_);
  51. // set cache to first block of cluster
  52. vol_->cacheSetBlockNumber(block, true);
  53. // zero first block of cluster
  54. memset(vol_->cacheBuffer_.data, 0, 512);
  55. // zero rest of cluster
  56. for (uint8_t i = 1; i < vol_->blocksPerCluster_; i++) {
  57. if (!vol_->writeBlock(block + i, vol_->cacheBuffer_.data)) goto fail;
  58. }
  59. // Increase directory file size by cluster size
  60. fileSize_ += 512UL << vol_->clusterSizeShift_;
  61. return true;
  62. fail:
  63. return false;
  64. }
  65. //------------------------------------------------------------------------------
  66. // cache a file's directory entry
  67. // return pointer to cached entry or null for failure
  68. dir_t* SdBaseFile::cacheDirEntry(uint8_t action) {
  69. if (!vol_->cacheRawBlock(dirBlock_, action)) goto fail;
  70. return vol_->cache()->dir + dirIndex_;
  71. fail:
  72. return 0;
  73. }
  74. //------------------------------------------------------------------------------
  75. /** Close a file and force cached data and directory information
  76. * to be written to the storage device.
  77. *
  78. * \return The value one, true, is returned for success and
  79. * the value zero, false, is returned for failure.
  80. * Reasons for failure include no file is open or an I/O error.
  81. */
  82. bool SdBaseFile::close() {
  83. bool rtn = sync();
  84. type_ = FAT_FILE_TYPE_CLOSED;
  85. return rtn;
  86. }
  87. //------------------------------------------------------------------------------
  88. /** Check for contiguous file and return its raw block range.
  89. *
  90. * \param[out] bgnBlock the first block address for the file.
  91. * \param[out] endBlock the last block address for the file.
  92. *
  93. * \return The value one, true, is returned for success and
  94. * the value zero, false, is returned for failure.
  95. * Reasons for failure include file is not contiguous, file has zero length
  96. * or an I/O error occurred.
  97. */
  98. bool SdBaseFile::contiguousRange(uint32_t* bgnBlock, uint32_t* endBlock) {
  99. // error if no blocks
  100. if (firstCluster_ == 0) goto fail;
  101. for (uint32_t c = firstCluster_; ; c++) {
  102. uint32_t next;
  103. if (!vol_->fatGet(c, &next)) goto fail;
  104. // check for contiguous
  105. if (next != (c + 1)) {
  106. // error if not end of chain
  107. if (!vol_->isEOC(next)) goto fail;
  108. *bgnBlock = vol_->clusterStartBlock(firstCluster_);
  109. *endBlock = vol_->clusterStartBlock(c)
  110. + vol_->blocksPerCluster_ - 1;
  111. return true;
  112. }
  113. }
  114. fail:
  115. return false;
  116. }
  117. //------------------------------------------------------------------------------
  118. /** Create and open a new contiguous file of a specified size.
  119. *
  120. * \note This function only supports short DOS 8.3 names.
  121. * See open() for more information.
  122. *
  123. * \param[in] dirFile The directory where the file will be created.
  124. * \param[in] path A path with a valid DOS 8.3 file name.
  125. * \param[in] size The desired file size.
  126. *
  127. * \return The value one, true, is returned for success and
  128. * the value zero, false, is returned for failure.
  129. * Reasons for failure include \a path contains
  130. * an invalid DOS 8.3 file name, the FAT volume has not been initialized,
  131. * a file is already open, the file already exists, the root
  132. * directory is full or an I/O error.
  133. *
  134. */
  135. bool SdBaseFile::createContiguous(SdBaseFile* dirFile,
  136. const char* path, uint32_t size) {
  137. uint32_t count;
  138. // don't allow zero length file
  139. if (size == 0) goto fail;
  140. if (!open(dirFile, path, O_CREAT | O_EXCL | O_RDWR)) goto fail;
  141. // calculate number of clusters needed
  142. count = ((size - 1) >> (vol_->clusterSizeShift_ + 9)) + 1;
  143. // allocate clusters
  144. if (!vol_->allocContiguous(count, &firstCluster_)) {
  145. remove();
  146. goto fail;
  147. }
  148. fileSize_ = size;
  149. // insure sync() will update dir entry
  150. flags_ |= F_FILE_DIR_DIRTY;
  151. return sync();
  152. fail:
  153. return false;
  154. }
  155. //------------------------------------------------------------------------------
  156. /** Return a file's directory entry.
  157. *
  158. * \param[out] dir Location for return of the file's directory entry.
  159. *
  160. * \return The value one, true, is returned for success and
  161. * the value zero, false, is returned for failure.
  162. */
  163. bool SdBaseFile::dirEntry(dir_t* dir) {
  164. dir_t* p;
  165. // make sure fields on SD are correct
  166. if (!sync()) goto fail;
  167. // read entry
  168. p = cacheDirEntry(SdVolume::CACHE_FOR_READ);
  169. if (!p) goto fail;
  170. // copy to caller's struct
  171. memcpy(dir, p, sizeof(dir_t));
  172. return true;
  173. fail:
  174. return false;
  175. }
  176. //------------------------------------------------------------------------------
  177. /** Format the name field of \a dir into the 13 byte array
  178. * \a name in standard 8.3 short name format.
  179. *
  180. * \param[in] dir The directory structure containing the name.
  181. * \param[out] name A 13 byte char array for the formatted name.
  182. */
  183. void SdBaseFile::dirName(const dir_t& dir, char* name) {
  184. uint8_t j = 0;
  185. for (uint8_t i = 0; i < 11; i++) {
  186. if (dir.name[i] == ' ')continue;
  187. if (i == 8) name[j++] = '.';
  188. name[j++] = dir.name[i];
  189. }
  190. name[j] = 0;
  191. }
  192. //------------------------------------------------------------------------------
  193. /** Test for the existence of a file in a directory
  194. *
  195. * \param[in] name Name of the file to be tested for.
  196. *
  197. * The calling instance must be an open directory file.
  198. *
  199. * dirFile.exists("TOFIND.TXT") searches for "TOFIND.TXT" in the directory
  200. * dirFile.
  201. *
  202. * \return true if the file exists else false.
  203. */
  204. bool SdBaseFile::exists(const char* name) {
  205. SdBaseFile file;
  206. return file.open(this, name, O_READ);
  207. }
  208. //------------------------------------------------------------------------------
  209. /**
  210. * Get a string from a file.
  211. *
  212. * fgets() reads bytes from a file into the array pointed to by \a str, until
  213. * \a num - 1 bytes are read, or a delimiter is read and transferred to \a str,
  214. * or end-of-file is encountered. The string is then terminated
  215. * with a null byte.
  216. *
  217. * fgets() deletes CR, '\\r', from the string. This insures only a '\\n'
  218. * terminates the string for Windows text files which use CRLF for newline.
  219. *
  220. * \param[out] str Pointer to the array where the string is stored.
  221. * \param[in] num Maximum number of characters to be read
  222. * (including the final null byte). Usually the length
  223. * of the array \a str is used.
  224. * \param[in] delim Optional set of delimiters. The default is "\n".
  225. *
  226. * \return For success fgets() returns the length of the string in \a str.
  227. * If no data is read, fgets() returns zero for EOF or -1 if an error occurred.
  228. **/
  229. int16_t SdBaseFile::fgets(char* str, int16_t num, char* delim) {
  230. char ch;
  231. int16_t n = 0;
  232. int16_t r = -1;
  233. while ((n + 1) < num && (r = read(&ch, 1)) == 1) {
  234. // delete CR
  235. if (ch == '\r') continue;
  236. str[n++] = ch;
  237. if (!delim) {
  238. if (ch == '\n') break;
  239. } else {
  240. if (strchr(delim, ch)) break;
  241. }
  242. }
  243. if (r < 0) {
  244. // read error
  245. return -1;
  246. }
  247. str[n] = '\0';
  248. return n;
  249. }
  250. //------------------------------------------------------------------------------
  251. /** Get a file's name
  252. *
  253. * \param[out] name An array of 13 characters for the file's name.
  254. *
  255. * \return The value one, true, is returned for success and
  256. * the value zero, false, is returned for failure.
  257. */
  258. bool SdBaseFile::getFilename(char* name) {
  259. if (!isOpen()) return false;
  260. if (isRoot()) {
  261. name[0] = '/';
  262. name[1] = '\0';
  263. return true;
  264. }
  265. // cache entry
  266. dir_t* p = cacheDirEntry(SdVolume::CACHE_FOR_READ);
  267. if (!p) return false;
  268. // format name
  269. dirName(*p, name);
  270. return true;
  271. }
  272. //------------------------------------------------------------------------------
  273. void SdBaseFile::getpos(fpos_t* pos) {
  274. pos->position = curPosition_;
  275. pos->cluster = curCluster_;
  276. }
  277. //------------------------------------------------------------------------------
  278. /** List directory contents.
  279. *
  280. * \param[in] pr Print stream for list.
  281. *
  282. * \param[in] flags The inclusive OR of
  283. *
  284. * LS_DATE - %Print file modification date
  285. *
  286. * LS_SIZE - %Print file size.
  287. *
  288. * LS_R - Recursive list of subdirectories.
  289. *
  290. * \param[in] indent Amount of space before file name. Used for recursive
  291. * list to indicate subdirectory level.
  292. */
  293. void SdBaseFile::ls(uint8_t flags, uint8_t indent) {
  294. rewind();
  295. int8_t status;
  296. while ((status = lsPrintNext( flags, indent))) {
  297. if (status > 1 && (flags & LS_R)) {
  298. uint16_t index = curPosition()/32 - 1;
  299. SdBaseFile s;
  300. if (s.open(this, index, O_READ)) s.ls( flags, indent + 2);
  301. seekSet(32 * (index + 1));
  302. }
  303. }
  304. }
  305. //------------------------------------------------------------------------------
  306. // saves 32 bytes on stack for ls recursion
  307. // return 0 - EOF, 1 - normal file, or 2 - directory
  308. int8_t SdBaseFile::lsPrintNext( uint8_t flags, uint8_t indent) {
  309. dir_t dir;
  310. uint8_t w = 0;
  311. while (1) {
  312. if (read(&dir, sizeof(dir)) != sizeof(dir)) return 0;
  313. if (dir.name[0] == DIR_NAME_FREE) return 0;
  314. // skip deleted entry and entries for . and ..
  315. if (dir.name[0] != DIR_NAME_DELETED && dir.name[0] != '.'
  316. && DIR_IS_FILE_OR_SUBDIR(&dir)) break;
  317. }
  318. // indent for dir level
  319. for (uint8_t i = 0; i < indent; i++) MYSERIAL.write(' ');
  320. // print name
  321. for (uint8_t i = 0; i < 11; i++) {
  322. if (dir.name[i] == ' ')continue;
  323. if (i == 8) {
  324. MYSERIAL.write('.');
  325. w++;
  326. }
  327. MYSERIAL.write(dir.name[i]);
  328. w++;
  329. }
  330. if (DIR_IS_SUBDIR(&dir)) {
  331. MYSERIAL.write('/');
  332. w++;
  333. }
  334. if (flags & (LS_DATE | LS_SIZE)) {
  335. while (w++ < 14) MYSERIAL.write(' ');
  336. }
  337. // print modify date/time if requested
  338. if (flags & LS_DATE) {
  339. MYSERIAL.write(' ');
  340. printFatDate( dir.lastWriteDate);
  341. MYSERIAL.write(' ');
  342. printFatTime( dir.lastWriteTime);
  343. }
  344. // print size if requested
  345. if (!DIR_IS_SUBDIR(&dir) && (flags & LS_SIZE)) {
  346. MYSERIAL.write(' ');
  347. MYSERIAL.print(dir.fileSize);
  348. }
  349. MYSERIAL.println();
  350. return DIR_IS_FILE(&dir) ? 1 : 2;
  351. }
  352. //------------------------------------------------------------------------------
  353. // format directory name field from a 8.3 name string
  354. bool SdBaseFile::make83Name(const char* str, uint8_t* name, const char** ptr) {
  355. uint8_t c;
  356. uint8_t n = 7; // max index for part before dot
  357. uint8_t i = 0;
  358. // blank fill name and extension
  359. while (i < 11) name[i++] = ' ';
  360. i = 0;
  361. while (*str != '\0' && *str != '/') {
  362. c = *str++;
  363. if (c == '.') {
  364. if (n == 10) goto fail; // only one dot allowed
  365. n = 10; // max index for full 8.3 name
  366. i = 8; // place for extension
  367. } else {
  368. // illegal FAT characters
  369. PGM_P p = PSTR("|<>^+=?/[];,*\"\\");
  370. uint8_t b;
  371. while ((b = pgm_read_byte(p++))) if (b == c) goto fail;
  372. // check size and only allow ASCII printable characters
  373. if (i > n || c < 0X21 || c > 0X7E)goto fail;
  374. // only upper case allowed in 8.3 names - convert lower to upper
  375. name[i++] = (c < 'a' || c > 'z') ? (c) : (c + ('A' - 'a'));
  376. }
  377. }
  378. *ptr = str;
  379. // must have a file name, extension is optional
  380. return name[0] != ' ';
  381. fail:
  382. return false;
  383. }
  384. //------------------------------------------------------------------------------
  385. /** Make a new directory.
  386. *
  387. * \param[in] parent An open SdFat instance for the directory that will contain
  388. * the new directory.
  389. *
  390. * \param[in] path A path with a valid 8.3 DOS name for the new directory.
  391. *
  392. * \param[in] pFlag Create missing parent directories if true.
  393. *
  394. * \return The value one, true, is returned for success and
  395. * the value zero, false, is returned for failure.
  396. * Reasons for failure include this file is already open, \a parent is not a
  397. * directory, \a path is invalid or already exists in \a parent.
  398. */
  399. bool SdBaseFile::mkdir(SdBaseFile* parent, const char* path, bool pFlag) {
  400. uint8_t dname[11];
  401. SdBaseFile dir1, dir2;
  402. SdBaseFile* sub = &dir1;
  403. SdBaseFile* start = parent;
  404. if (!parent || isOpen()) goto fail;
  405. if (*path == '/') {
  406. while (*path == '/') path++;
  407. if (!parent->isRoot()) {
  408. if (!dir2.openRoot(parent->vol_)) goto fail;
  409. parent = &dir2;
  410. }
  411. }
  412. while (1) {
  413. if (!make83Name(path, dname, &path)) goto fail;
  414. while (*path == '/') path++;
  415. if (!*path) break;
  416. if (!sub->open(parent, dname, O_READ)) {
  417. if (!pFlag || !sub->mkdir(parent, dname)) {
  418. goto fail;
  419. }
  420. }
  421. if (parent != start) parent->close();
  422. parent = sub;
  423. sub = parent != &dir1 ? &dir1 : &dir2;
  424. }
  425. return mkdir(parent, dname);
  426. fail:
  427. return false;
  428. }
  429. //------------------------------------------------------------------------------
  430. bool SdBaseFile::mkdir(SdBaseFile* parent, const uint8_t dname[11]) {
  431. uint32_t block;
  432. dir_t d;
  433. dir_t* p;
  434. if (!parent->isDir()) goto fail;
  435. // create a normal file
  436. if (!open(parent, dname, O_CREAT | O_EXCL | O_RDWR)) goto fail;
  437. // convert file to directory
  438. flags_ = O_READ;
  439. type_ = FAT_FILE_TYPE_SUBDIR;
  440. // allocate and zero first cluster
  441. if (!addDirCluster())goto fail;
  442. // force entry to SD
  443. if (!sync()) goto fail;
  444. // cache entry - should already be in cache due to sync() call
  445. p = cacheDirEntry(SdVolume::CACHE_FOR_WRITE);
  446. if (!p) goto fail;
  447. // change directory entry attribute
  448. p->attributes = DIR_ATT_DIRECTORY;
  449. // make entry for '.'
  450. memcpy(&d, p, sizeof(d));
  451. d.name[0] = '.';
  452. for (uint8_t i = 1; i < 11; i++) d.name[i] = ' ';
  453. // cache block for '.' and '..'
  454. block = vol_->clusterStartBlock(firstCluster_);
  455. if (!vol_->cacheRawBlock(block, SdVolume::CACHE_FOR_WRITE)) goto fail;
  456. // copy '.' to block
  457. memcpy(&vol_->cache()->dir[0], &d, sizeof(d));
  458. // make entry for '..'
  459. d.name[1] = '.';
  460. if (parent->isRoot()) {
  461. d.firstClusterLow = 0;
  462. d.firstClusterHigh = 0;
  463. } else {
  464. d.firstClusterLow = parent->firstCluster_ & 0XFFFF;
  465. d.firstClusterHigh = parent->firstCluster_ >> 16;
  466. }
  467. // copy '..' to block
  468. memcpy(&vol_->cache()->dir[1], &d, sizeof(d));
  469. // write first block
  470. return vol_->cacheFlush();
  471. fail:
  472. return false;
  473. }
  474. //------------------------------------------------------------------------------
  475. /** Open a file in the current working directory.
  476. *
  477. * \param[in] path A path with a valid 8.3 DOS name for a file to be opened.
  478. *
  479. * \param[in] oflag Values for \a oflag are constructed by a bitwise-inclusive
  480. * OR of open flags. see SdBaseFile::open(SdBaseFile*, const char*, uint8_t).
  481. *
  482. * \return The value one, true, is returned for success and
  483. * the value zero, false, is returned for failure.
  484. */
  485. bool SdBaseFile::open(const char* path, uint8_t oflag) {
  486. return open(cwd_, path, oflag);
  487. }
  488. //------------------------------------------------------------------------------
  489. /** Open a file or directory by name.
  490. *
  491. * \param[in] dirFile An open SdFat instance for the directory containing the
  492. * file to be opened.
  493. *
  494. * \param[in] path A path with a valid 8.3 DOS name for a file to be opened.
  495. *
  496. * \param[in] oflag Values for \a oflag are constructed by a bitwise-inclusive
  497. * OR of flags from the following list
  498. *
  499. * O_READ - Open for reading.
  500. *
  501. * O_RDONLY - Same as O_READ.
  502. *
  503. * O_WRITE - Open for writing.
  504. *
  505. * O_WRONLY - Same as O_WRITE.
  506. *
  507. * O_RDWR - Open for reading and writing.
  508. *
  509. * O_APPEND - If set, the file offset shall be set to the end of the
  510. * file prior to each write.
  511. *
  512. * O_AT_END - Set the initial position at the end of the file.
  513. *
  514. * O_CREAT - If the file exists, this flag has no effect except as noted
  515. * under O_EXCL below. Otherwise, the file shall be created
  516. *
  517. * O_EXCL - If O_CREAT and O_EXCL are set, open() shall fail if the file exists.
  518. *
  519. * O_SYNC - Call sync() after each write. This flag should not be used with
  520. * write(uint8_t), write_P(PGM_P), writeln_P(PGM_P), or the Arduino Print class.
  521. * These functions do character at a time writes so sync() will be called
  522. * after each byte.
  523. *
  524. * O_TRUNC - If the file exists and is a regular file, and the file is
  525. * successfully opened and is not read only, its length shall be truncated to 0.
  526. *
  527. * WARNING: A given file must not be opened by more than one SdBaseFile object
  528. * of file corruption may occur.
  529. *
  530. * \note Directory files must be opened read only. Write and truncation is
  531. * not allowed for directory files.
  532. *
  533. * \return The value one, true, is returned for success and
  534. * the value zero, false, is returned for failure.
  535. * Reasons for failure include this file is already open, \a dirFile is not
  536. * a directory, \a path is invalid, the file does not exist
  537. * or can't be opened in the access mode specified by oflag.
  538. */
  539. bool SdBaseFile::open(SdBaseFile* dirFile, const char* path, uint8_t oflag) {
  540. uint8_t dname[11];
  541. SdBaseFile dir1, dir2;
  542. SdBaseFile *parent = dirFile;
  543. SdBaseFile *sub = &dir1;
  544. if (!dirFile) goto fail;
  545. // error if already open
  546. if (isOpen()) goto fail;
  547. if (*path == '/') {
  548. while (*path == '/') path++;
  549. if (!dirFile->isRoot()) {
  550. if (!dir2.openRoot(dirFile->vol_)) goto fail;
  551. parent = &dir2;
  552. }
  553. }
  554. while (1) {
  555. if (!make83Name(path, dname, &path)) goto fail;
  556. while (*path == '/') path++;
  557. if (!*path) break;
  558. if (!sub->open(parent, dname, O_READ)) goto fail;
  559. if (parent != dirFile) parent->close();
  560. parent = sub;
  561. sub = parent != &dir1 ? &dir1 : &dir2;
  562. }
  563. return open(parent, dname, oflag);
  564. fail:
  565. return false;
  566. }
  567. //------------------------------------------------------------------------------
  568. // open with filename in dname
  569. bool SdBaseFile::open(SdBaseFile* dirFile,
  570. const uint8_t dname[11], uint8_t oflag) {
  571. bool emptyFound = false;
  572. bool fileFound = false;
  573. uint8_t index;
  574. dir_t* p;
  575. vol_ = dirFile->vol_;
  576. dirFile->rewind();
  577. // search for file
  578. while (dirFile->curPosition_ < dirFile->fileSize_) {
  579. index = 0XF & (dirFile->curPosition_ >> 5);
  580. p = dirFile->readDirCache();
  581. if (!p) goto fail;
  582. if (p->name[0] == DIR_NAME_FREE || p->name[0] == DIR_NAME_DELETED) {
  583. // remember first empty slot
  584. if (!emptyFound) {
  585. dirBlock_ = dirFile->vol_->cacheBlockNumber();
  586. dirIndex_ = index;
  587. emptyFound = true;
  588. }
  589. // done if no entries follow
  590. if (p->name[0] == DIR_NAME_FREE) break;
  591. } else if (!memcmp(dname, p->name, 11)) {
  592. fileFound = true;
  593. break;
  594. }
  595. }
  596. if (fileFound) {
  597. // don't open existing file if O_EXCL
  598. if (oflag & O_EXCL) goto fail;
  599. } else {
  600. // don't create unless O_CREAT and O_WRITE
  601. if (!(oflag & O_CREAT) || !(oflag & O_WRITE)) goto fail;
  602. if (emptyFound) {
  603. index = dirIndex_;
  604. p = cacheDirEntry(SdVolume::CACHE_FOR_WRITE);
  605. if (!p) goto fail;
  606. } else {
  607. if (dirFile->type_ == FAT_FILE_TYPE_ROOT_FIXED) goto fail;
  608. // add and zero cluster for dirFile - first cluster is in cache for write
  609. if (!dirFile->addDirCluster()) goto fail;
  610. // use first entry in cluster
  611. p = dirFile->vol_->cache()->dir;
  612. index = 0;
  613. }
  614. // initialize as empty file
  615. memset(p, 0, sizeof(dir_t));
  616. memcpy(p->name, dname, 11);
  617. // set timestamps
  618. if (dateTime_) {
  619. // call user date/time function
  620. dateTime_(&p->creationDate, &p->creationTime);
  621. } else {
  622. // use default date/time
  623. p->creationDate = FAT_DEFAULT_DATE;
  624. p->creationTime = FAT_DEFAULT_TIME;
  625. }
  626. p->lastAccessDate = p->creationDate;
  627. p->lastWriteDate = p->creationDate;
  628. p->lastWriteTime = p->creationTime;
  629. // write entry to SD
  630. if (!dirFile->vol_->cacheFlush()) goto fail;
  631. }
  632. // open entry in cache
  633. return openCachedEntry(index, oflag);
  634. fail:
  635. return false;
  636. }
  637. //------------------------------------------------------------------------------
  638. /** Open a file by index.
  639. *
  640. * \param[in] dirFile An open SdFat instance for the directory.
  641. *
  642. * \param[in] index The \a index of the directory entry for the file to be
  643. * opened. The value for \a index is (directory file position)/32.
  644. *
  645. * \param[in] oflag Values for \a oflag are constructed by a bitwise-inclusive
  646. * OR of flags O_READ, O_WRITE, O_TRUNC, and O_SYNC.
  647. *
  648. * See open() by path for definition of flags.
  649. * \return true for success or false for failure.
  650. */
  651. bool SdBaseFile::open(SdBaseFile* dirFile, uint16_t index, uint8_t oflag) {
  652. dir_t* p;
  653. vol_ = dirFile->vol_;
  654. // error if already open
  655. if (isOpen() || !dirFile) goto fail;
  656. // don't open existing file if O_EXCL - user call error
  657. if (oflag & O_EXCL) goto fail;
  658. // seek to location of entry
  659. if (!dirFile->seekSet(32 * index)) goto fail;
  660. // read entry into cache
  661. p = dirFile->readDirCache();
  662. if (!p) goto fail;
  663. // error if empty slot or '.' or '..'
  664. if (p->name[0] == DIR_NAME_FREE ||
  665. p->name[0] == DIR_NAME_DELETED || p->name[0] == '.') {
  666. goto fail;
  667. }
  668. // open cached entry
  669. return openCachedEntry(index & 0XF, oflag);
  670. fail:
  671. return false;
  672. }
  673. //------------------------------------------------------------------------------
  674. // open a cached directory entry. Assumes vol_ is initialized
  675. bool SdBaseFile::openCachedEntry(uint8_t dirIndex, uint8_t oflag) {
  676. // location of entry in cache
  677. dir_t* p = &vol_->cache()->dir[dirIndex];
  678. // write or truncate is an error for a directory or read-only file
  679. if (p->attributes & (DIR_ATT_READ_ONLY | DIR_ATT_DIRECTORY)) {
  680. if (oflag & (O_WRITE | O_TRUNC)) goto fail;
  681. }
  682. // remember location of directory entry on SD
  683. dirBlock_ = vol_->cacheBlockNumber();
  684. dirIndex_ = dirIndex;
  685. // copy first cluster number for directory fields
  686. firstCluster_ = (uint32_t)p->firstClusterHigh << 16;
  687. firstCluster_ |= p->firstClusterLow;
  688. // make sure it is a normal file or subdirectory
  689. if (DIR_IS_FILE(p)) {
  690. fileSize_ = p->fileSize;
  691. type_ = FAT_FILE_TYPE_NORMAL;
  692. } else if (DIR_IS_SUBDIR(p)) {
  693. if (!vol_->chainSize(firstCluster_, &fileSize_)) goto fail;
  694. type_ = FAT_FILE_TYPE_SUBDIR;
  695. } else {
  696. goto fail;
  697. }
  698. // save open flags for read/write
  699. flags_ = oflag & F_OFLAG;
  700. // set to start of file
  701. curCluster_ = 0;
  702. curPosition_ = 0;
  703. if ((oflag & O_TRUNC) && !truncate(0)) return false;
  704. return oflag & O_AT_END ? seekEnd(0) : true;
  705. fail:
  706. type_ = FAT_FILE_TYPE_CLOSED;
  707. return false;
  708. }
  709. //------------------------------------------------------------------------------
  710. /** Open the next file or subdirectory in a directory.
  711. *
  712. * \param[in] dirFile An open SdFat instance for the directory containing the
  713. * file to be opened.
  714. *
  715. * \param[in] oflag Values for \a oflag are constructed by a bitwise-inclusive
  716. * OR of flags O_READ, O_WRITE, O_TRUNC, and O_SYNC.
  717. *
  718. * See open() by path for definition of flags.
  719. * \return true for success or false for failure.
  720. */
  721. bool SdBaseFile::openNext(SdBaseFile* dirFile, uint8_t oflag) {
  722. dir_t* p;
  723. uint8_t index;
  724. if (!dirFile) goto fail;
  725. // error if already open
  726. if (isOpen()) goto fail;
  727. vol_ = dirFile->vol_;
  728. while (1) {
  729. index = 0XF & (dirFile->curPosition_ >> 5);
  730. // read entry into cache
  731. p = dirFile->readDirCache();
  732. if (!p) goto fail;
  733. // done if last entry
  734. if (p->name[0] == DIR_NAME_FREE) goto fail;
  735. // skip empty slot or '.' or '..'
  736. if (p->name[0] == DIR_NAME_DELETED || p->name[0] == '.') {
  737. continue;
  738. }
  739. // must be file or dir
  740. if (DIR_IS_FILE_OR_SUBDIR(p)) {
  741. return openCachedEntry(index, oflag);
  742. }
  743. }
  744. fail:
  745. return false;
  746. }
  747. //------------------------------------------------------------------------------
  748. /** Open a directory's parent directory.
  749. *
  750. * \param[in] dir Parent of this directory will be opened. Must not be root.
  751. *
  752. * \return The value one, true, is returned for success and
  753. * the value zero, false, is returned for failure.
  754. */
  755. bool SdBaseFile::openParent(SdBaseFile* dir) {
  756. dir_t entry;
  757. dir_t* p;
  758. SdBaseFile file;
  759. uint32_t c;
  760. uint32_t cluster;
  761. uint32_t lbn;
  762. // error if already open or dir is root or dir is not a directory
  763. if (isOpen() || !dir || dir->isRoot() || !dir->isDir()) goto fail;
  764. vol_ = dir->vol_;
  765. // position to '..'
  766. if (!dir->seekSet(32)) goto fail;
  767. // read '..' entry
  768. if (dir->read(&entry, sizeof(entry)) != 32) goto fail;
  769. // verify it is '..'
  770. if (entry.name[0] != '.' || entry.name[1] != '.') goto fail;
  771. // start cluster for '..'
  772. cluster = entry.firstClusterLow;
  773. cluster |= (uint32_t)entry.firstClusterHigh << 16;
  774. if (cluster == 0) return openRoot(vol_);
  775. // start block for '..'
  776. lbn = vol_->clusterStartBlock(cluster);
  777. // first block of parent dir
  778. if (!vol_->cacheRawBlock(lbn, SdVolume::CACHE_FOR_READ)) {
  779. goto fail;
  780. }
  781. p = &vol_->cacheBuffer_.dir[1];
  782. // verify name for '../..'
  783. if (p->name[0] != '.' || p->name[1] != '.') goto fail;
  784. // '..' is pointer to first cluster of parent. open '../..' to find parent
  785. if (p->firstClusterHigh == 0 && p->firstClusterLow == 0) {
  786. if (!file.openRoot(dir->volume())) goto fail;
  787. } else {
  788. if (!file.openCachedEntry(1, O_READ)) goto fail;
  789. }
  790. // search for parent in '../..'
  791. do {
  792. if (file.readDir(&entry, NULL) != 32) goto fail;
  793. c = entry.firstClusterLow;
  794. c |= (uint32_t)entry.firstClusterHigh << 16;
  795. } while (c != cluster);
  796. // open parent
  797. return open(&file, file.curPosition()/32 - 1, O_READ);
  798. fail:
  799. return false;
  800. }
  801. //------------------------------------------------------------------------------
  802. /** Open a volume's root directory.
  803. *
  804. * \param[in] vol The FAT volume containing the root directory to be opened.
  805. *
  806. * \return The value one, true, is returned for success and
  807. * the value zero, false, is returned for failure.
  808. * Reasons for failure include the file is already open, the FAT volume has
  809. * not been initialized or it a FAT12 volume.
  810. */
  811. bool SdBaseFile::openRoot(SdVolume* vol) {
  812. // error if file is already open
  813. if (isOpen()) goto fail;
  814. if (vol->fatType() == 16 || (FAT12_SUPPORT && vol->fatType() == 12)) {
  815. type_ = FAT_FILE_TYPE_ROOT_FIXED;
  816. firstCluster_ = 0;
  817. fileSize_ = 32 * vol->rootDirEntryCount();
  818. } else if (vol->fatType() == 32) {
  819. type_ = FAT_FILE_TYPE_ROOT32;
  820. firstCluster_ = vol->rootDirStart();
  821. if (!vol->chainSize(firstCluster_, &fileSize_)) goto fail;
  822. } else {
  823. // volume is not initialized, invalid, or FAT12 without support
  824. return false;
  825. }
  826. vol_ = vol;
  827. // read only
  828. flags_ = O_READ;
  829. // set to start of file
  830. curCluster_ = 0;
  831. curPosition_ = 0;
  832. // root has no directory entry
  833. dirBlock_ = 0;
  834. dirIndex_ = 0;
  835. return true;
  836. fail:
  837. return false;
  838. }
  839. //------------------------------------------------------------------------------
  840. /** Return the next available byte without consuming it.
  841. *
  842. * \return The byte if no error and not at eof else -1;
  843. */
  844. int SdBaseFile::peek() {
  845. fpos_t pos;
  846. getpos(&pos);
  847. int c = read();
  848. if (c >= 0) setpos(&pos);
  849. return c;
  850. }
  851. //------------------------------------------------------------------------------
  852. /** %Print the name field of a directory entry in 8.3 format.
  853. * \param[in] pr Print stream for output.
  854. * \param[in] dir The directory structure containing the name.
  855. * \param[in] width Blank fill name if length is less than \a width.
  856. * \param[in] printSlash Print '/' after directory names if true.
  857. */
  858. void SdBaseFile::printDirName(const dir_t& dir,
  859. uint8_t width, bool printSlash) {
  860. uint8_t w = 0;
  861. for (uint8_t i = 0; i < 11; i++) {
  862. if (dir.name[i] == ' ')continue;
  863. if (i == 8) {
  864. MYSERIAL.write('.');
  865. w++;
  866. }
  867. MYSERIAL.write(dir.name[i]);
  868. w++;
  869. }
  870. if (DIR_IS_SUBDIR(&dir) && printSlash) {
  871. MYSERIAL.write('/');
  872. w++;
  873. }
  874. while (w < width) {
  875. MYSERIAL.write(' ');
  876. w++;
  877. }
  878. }
  879. //------------------------------------------------------------------------------
  880. // print uint8_t with width 2
  881. static void print2u( uint8_t v) {
  882. if (v < 10) MYSERIAL.write('0');
  883. MYSERIAL.print(v, DEC);
  884. }
  885. //------------------------------------------------------------------------------
  886. /** %Print a directory date field to Serial.
  887. *
  888. * Format is yyyy-mm-dd.
  889. *
  890. * \param[in] fatDate The date field from a directory entry.
  891. */
  892. //------------------------------------------------------------------------------
  893. /** %Print a directory date field.
  894. *
  895. * Format is yyyy-mm-dd.
  896. *
  897. * \param[in] pr Print stream for output.
  898. * \param[in] fatDate The date field from a directory entry.
  899. */
  900. void SdBaseFile::printFatDate(uint16_t fatDate) {
  901. MYSERIAL.print(FAT_YEAR(fatDate));
  902. MYSERIAL.write('-');
  903. print2u( FAT_MONTH(fatDate));
  904. MYSERIAL.write('-');
  905. print2u( FAT_DAY(fatDate));
  906. }
  907. //------------------------------------------------------------------------------
  908. /** %Print a directory time field.
  909. *
  910. * Format is hh:mm:ss.
  911. *
  912. * \param[in] pr Print stream for output.
  913. * \param[in] fatTime The time field from a directory entry.
  914. */
  915. void SdBaseFile::printFatTime( uint16_t fatTime) {
  916. print2u( FAT_HOUR(fatTime));
  917. MYSERIAL.write(':');
  918. print2u( FAT_MINUTE(fatTime));
  919. MYSERIAL.write(':');
  920. print2u( FAT_SECOND(fatTime));
  921. }
  922. //------------------------------------------------------------------------------
  923. /** Print a file's name to Serial
  924. *
  925. * \return The value one, true, is returned for success and
  926. * the value zero, false, is returned for failure.
  927. */
  928. bool SdBaseFile::printName() {
  929. char name[FILENAME_LENGTH];
  930. if (!getFilename(name)) return false;
  931. MYSERIAL.print(name);
  932. return true;
  933. }
  934. //------------------------------------------------------------------------------
  935. /** Read the next byte from a file.
  936. *
  937. * \return For success read returns the next byte in the file as an int.
  938. * If an error occurs or end of file is reached -1 is returned.
  939. */
  940. int16_t SdBaseFile::read() {
  941. uint8_t b;
  942. return read(&b, 1) == 1 ? b : -1;
  943. }
  944. //------------------------------------------------------------------------------
  945. /** Read data from a file starting at the current position.
  946. *
  947. * \param[out] buf Pointer to the location that will receive the data.
  948. *
  949. * \param[in] nbyte Maximum number of bytes to read.
  950. *
  951. * \return For success read() returns the number of bytes read.
  952. * A value less than \a nbyte, including zero, will be returned
  953. * if end of file is reached.
  954. * If an error occurs, read() returns -1. Possible errors include
  955. * read() called before a file has been opened, corrupt file system
  956. * or an I/O error occurred.
  957. */
  958. int16_t SdBaseFile::read(void* buf, uint16_t nbyte) {
  959. uint8_t* dst = reinterpret_cast<uint8_t*>(buf);
  960. uint16_t offset;
  961. uint16_t toRead;
  962. uint32_t block; // raw device block number
  963. // error if not open or write only
  964. if (!isOpen() || !(flags_ & O_READ)) goto fail;
  965. // max bytes left in file
  966. if (nbyte >= (fileSize_ - curPosition_)) {
  967. nbyte = fileSize_ - curPosition_;
  968. }
  969. // amount left to read
  970. toRead = nbyte;
  971. while (toRead > 0) {
  972. offset = curPosition_ & 0X1FF; // offset in block
  973. if (type_ == FAT_FILE_TYPE_ROOT_FIXED) {
  974. block = vol_->rootDirStart() + (curPosition_ >> 9);
  975. } else {
  976. uint8_t blockOfCluster = vol_->blockOfCluster(curPosition_);
  977. if (offset == 0 && blockOfCluster == 0) {
  978. // start of new cluster
  979. if (curPosition_ == 0) {
  980. // use first cluster in file
  981. curCluster_ = firstCluster_;
  982. } else {
  983. // get next cluster from FAT
  984. if (!vol_->fatGet(curCluster_, &curCluster_)) goto fail;
  985. }
  986. }
  987. block = vol_->clusterStartBlock(curCluster_) + blockOfCluster;
  988. }
  989. uint16_t n = toRead;
  990. // amount to be read from current block
  991. if (n > (512 - offset)) n = 512 - offset;
  992. // no buffering needed if n == 512
  993. if (n == 512 && block != vol_->cacheBlockNumber()) {
  994. if (!vol_->readBlock(block, dst)) goto fail;
  995. } else {
  996. // read block to cache and copy data to caller
  997. if (!vol_->cacheRawBlock(block, SdVolume::CACHE_FOR_READ)) goto fail;
  998. uint8_t* src = vol_->cache()->data + offset;
  999. memcpy(dst, src, n);
  1000. }
  1001. dst += n;
  1002. curPosition_ += n;
  1003. toRead -= n;
  1004. }
  1005. return nbyte;
  1006. fail:
  1007. return -1;
  1008. }
  1009. /**
  1010. * Read the next entry in a directory.
  1011. *
  1012. * \param[out] dir The dir_t struct that will receive the data.
  1013. *
  1014. * \return For success readDir() returns the number of bytes read.
  1015. * A value of zero will be returned if end of file is reached.
  1016. * If an error occurs, readDir() returns -1. Possible errors include
  1017. * readDir() called before a directory has been opened, this is not
  1018. * a directory file or an I/O error occurred.
  1019. */
  1020. int8_t SdBaseFile::readDir(dir_t* dir, char* longFilename) {
  1021. int16_t n;
  1022. // if not a directory file or miss-positioned return an error
  1023. if (!isDir() || (0X1F & curPosition_)) return -1;
  1024. //If we have a longFilename buffer, mark it as invalid. If we find a long filename it will be filled automaticly.
  1025. if (longFilename != NULL) longFilename[0] = '\0';
  1026. while (1) {
  1027. n = read(dir, sizeof(dir_t));
  1028. if (n != sizeof(dir_t)) return n == 0 ? 0 : -1;
  1029. // last entry if DIR_NAME_FREE
  1030. if (dir->name[0] == DIR_NAME_FREE) return 0;
  1031. // skip empty entries and entry for . and ..
  1032. if (dir->name[0] == DIR_NAME_DELETED || dir->name[0] == '.') continue;
  1033. // Fill the long filename if we have a long filename entry.
  1034. // Long filename entries are stored before the short filename.
  1035. if (longFilename != NULL && DIR_IS_LONG_NAME(dir)) {
  1036. vfat_t *VFAT = (vfat_t*)dir;
  1037. // Sanity-check the VFAT entry. The first cluster is always set to zero. And the sequence number should be higher than 0
  1038. if (VFAT->firstClusterLow == 0 && (VFAT->sequenceNumber & 0x1F) > 0 && (VFAT->sequenceNumber & 0x1F) <= MAX_VFAT_ENTRIES) {
  1039. // TODO: Store the filename checksum to verify if a none-long filename aware system modified the file table.
  1040. n = ((VFAT->sequenceNumber & 0x1F) - 1) * FILENAME_LENGTH;
  1041. for (uint8_t i=0; i<FILENAME_LENGTH; i++)
  1042. longFilename[n+i] = (i < 5) ? VFAT->name1[i] : (i < 11) ? VFAT->name2[i-5] : VFAT->name3[i-11];
  1043. // If this VFAT entry is the last one, add a NUL terminator at the end of the string
  1044. if (VFAT->sequenceNumber & 0x40) longFilename[n+FILENAME_LENGTH] = '\0';
  1045. }
  1046. }
  1047. // Return if normal file or subdirectory
  1048. if (DIR_IS_FILE_OR_SUBDIR(dir)) return n;
  1049. }
  1050. }
  1051. //------------------------------------------------------------------------------
  1052. // Read next directory entry into the cache
  1053. // Assumes file is correctly positioned
  1054. dir_t* SdBaseFile::readDirCache() {
  1055. uint8_t i;
  1056. // error if not directory
  1057. if (!isDir()) goto fail;
  1058. // index of entry in cache
  1059. i = (curPosition_ >> 5) & 0XF;
  1060. // use read to locate and cache block
  1061. if (read() < 0) goto fail;
  1062. // advance to next entry
  1063. curPosition_ += 31;
  1064. // return pointer to entry
  1065. return vol_->cache()->dir + i;
  1066. fail:
  1067. return 0;
  1068. }
  1069. //------------------------------------------------------------------------------
  1070. /** Remove a file.
  1071. *
  1072. * The directory entry and all data for the file are deleted.
  1073. *
  1074. * \note This function should not be used to delete the 8.3 version of a
  1075. * file that has a long name. For example if a file has the long name
  1076. * "New Text Document.txt" you should not delete the 8.3 name "NEWTEX~1.TXT".
  1077. *
  1078. * \return The value one, true, is returned for success and
  1079. * the value zero, false, is returned for failure.
  1080. * Reasons for failure include the file read-only, is a directory,
  1081. * or an I/O error occurred.
  1082. */
  1083. bool SdBaseFile::remove() {
  1084. dir_t* d;
  1085. // free any clusters - will fail if read-only or directory
  1086. if (!truncate(0)) goto fail;
  1087. // cache directory entry
  1088. d = cacheDirEntry(SdVolume::CACHE_FOR_WRITE);
  1089. if (!d) goto fail;
  1090. // mark entry deleted
  1091. d->name[0] = DIR_NAME_DELETED;
  1092. // set this file closed
  1093. type_ = FAT_FILE_TYPE_CLOSED;
  1094. // write entry to SD
  1095. return vol_->cacheFlush();
  1096. return true;
  1097. fail:
  1098. return false;
  1099. }
  1100. //------------------------------------------------------------------------------
  1101. /** Remove a file.
  1102. *
  1103. * The directory entry and all data for the file are deleted.
  1104. *
  1105. * \param[in] dirFile The directory that contains the file.
  1106. * \param[in] path Path for the file to be removed.
  1107. *
  1108. * \note This function should not be used to delete the 8.3 version of a
  1109. * file that has a long name. For example if a file has the long name
  1110. * "New Text Document.txt" you should not delete the 8.3 name "NEWTEX~1.TXT".
  1111. *
  1112. * \return The value one, true, is returned for success and
  1113. * the value zero, false, is returned for failure.
  1114. * Reasons for failure include the file is a directory, is read only,
  1115. * \a dirFile is not a directory, \a path is not found
  1116. * or an I/O error occurred.
  1117. */
  1118. bool SdBaseFile::remove(SdBaseFile* dirFile, const char* path) {
  1119. SdBaseFile file;
  1120. if (!file.open(dirFile, path, O_WRITE)) goto fail;
  1121. return file.remove();
  1122. fail:
  1123. // can't set iostate - static function
  1124. return false;
  1125. }
  1126. //------------------------------------------------------------------------------
  1127. /** Rename a file or subdirectory.
  1128. *
  1129. * \param[in] dirFile Directory for the new path.
  1130. * \param[in] newPath New path name for the file/directory.
  1131. *
  1132. * \return The value one, true, is returned for success and
  1133. * the value zero, false, is returned for failure.
  1134. * Reasons for failure include \a dirFile is not open or is not a directory
  1135. * file, newPath is invalid or already exists, or an I/O error occurs.
  1136. */
  1137. bool SdBaseFile::rename(SdBaseFile* dirFile, const char* newPath) {
  1138. dir_t entry;
  1139. uint32_t dirCluster = 0;
  1140. SdBaseFile file;
  1141. dir_t* d;
  1142. // must be an open file or subdirectory
  1143. if (!(isFile() || isSubDir())) goto fail;
  1144. // can't move file
  1145. if (vol_ != dirFile->vol_) goto fail;
  1146. // sync() and cache directory entry
  1147. sync();
  1148. d = cacheDirEntry(SdVolume::CACHE_FOR_WRITE);
  1149. if (!d) goto fail;
  1150. // save directory entry
  1151. memcpy(&entry, d, sizeof(entry));
  1152. // mark entry deleted
  1153. d->name[0] = DIR_NAME_DELETED;
  1154. // make directory entry for new path
  1155. if (isFile()) {
  1156. if (!file.open(dirFile, newPath, O_CREAT | O_EXCL | O_WRITE)) {
  1157. goto restore;
  1158. }
  1159. } else {
  1160. // don't create missing path prefix components
  1161. if (!file.mkdir(dirFile, newPath, false)) {
  1162. goto restore;
  1163. }
  1164. // save cluster containing new dot dot
  1165. dirCluster = file.firstCluster_;
  1166. }
  1167. // change to new directory entry
  1168. dirBlock_ = file.dirBlock_;
  1169. dirIndex_ = file.dirIndex_;
  1170. // mark closed to avoid possible destructor close call
  1171. file.type_ = FAT_FILE_TYPE_CLOSED;
  1172. // cache new directory entry
  1173. d = cacheDirEntry(SdVolume::CACHE_FOR_WRITE);
  1174. if (!d) goto fail;
  1175. // copy all but name field to new directory entry
  1176. memcpy(&d->attributes, &entry.attributes, sizeof(entry) - sizeof(d->name));
  1177. // update dot dot if directory
  1178. if (dirCluster) {
  1179. // get new dot dot
  1180. uint32_t block = vol_->clusterStartBlock(dirCluster);
  1181. if (!vol_->cacheRawBlock(block, SdVolume::CACHE_FOR_READ)) goto fail;
  1182. memcpy(&entry, &vol_->cache()->dir[1], sizeof(entry));
  1183. // free unused cluster
  1184. if (!vol_->freeChain(dirCluster)) goto fail;
  1185. // store new dot dot
  1186. block = vol_->clusterStartBlock(firstCluster_);
  1187. if (!vol_->cacheRawBlock(block, SdVolume::CACHE_FOR_WRITE)) goto fail;
  1188. memcpy(&vol_->cache()->dir[1], &entry, sizeof(entry));
  1189. }
  1190. return vol_->cacheFlush();
  1191. restore:
  1192. d = cacheDirEntry(SdVolume::CACHE_FOR_WRITE);
  1193. if (!d) goto fail;
  1194. // restore entry
  1195. d->name[0] = entry.name[0];
  1196. vol_->cacheFlush();
  1197. fail:
  1198. return false;
  1199. }
  1200. //------------------------------------------------------------------------------
  1201. /** Remove a directory file.
  1202. *
  1203. * The directory file will be removed only if it is empty and is not the
  1204. * root directory. rmdir() follows DOS and Windows and ignores the
  1205. * read-only attribute for the directory.
  1206. *
  1207. * \note This function should not be used to delete the 8.3 version of a
  1208. * directory that has a long name. For example if a directory has the
  1209. * long name "New folder" you should not delete the 8.3 name "NEWFOL~1".
  1210. *
  1211. * \return The value one, true, is returned for success and
  1212. * the value zero, false, is returned for failure.
  1213. * Reasons for failure include the file is not a directory, is the root
  1214. * directory, is not empty, or an I/O error occurred.
  1215. */
  1216. bool SdBaseFile::rmdir() {
  1217. // must be open subdirectory
  1218. if (!isSubDir()) goto fail;
  1219. rewind();
  1220. // make sure directory is empty
  1221. while (curPosition_ < fileSize_) {
  1222. dir_t* p = readDirCache();
  1223. if (!p) goto fail;
  1224. // done if past last used entry
  1225. if (p->name[0] == DIR_NAME_FREE) break;
  1226. // skip empty slot, '.' or '..'
  1227. if (p->name[0] == DIR_NAME_DELETED || p->name[0] == '.') continue;
  1228. // error not empty
  1229. if (DIR_IS_FILE_OR_SUBDIR(p)) goto fail;
  1230. }
  1231. // convert empty directory to normal file for remove
  1232. type_ = FAT_FILE_TYPE_NORMAL;
  1233. flags_ |= O_WRITE;
  1234. return remove();
  1235. fail:
  1236. return false;
  1237. }
  1238. //------------------------------------------------------------------------------
  1239. /** Recursively delete a directory and all contained files.
  1240. *
  1241. * This is like the Unix/Linux 'rm -rf *' if called with the root directory
  1242. * hence the name.
  1243. *
  1244. * Warning - This will remove all contents of the directory including
  1245. * subdirectories. The directory will then be removed if it is not root.
  1246. * The read-only attribute for files will be ignored.
  1247. *
  1248. * \note This function should not be used to delete the 8.3 version of
  1249. * a directory that has a long name. See remove() and rmdir().
  1250. *
  1251. * \return The value one, true, is returned for success and
  1252. * the value zero, false, is returned for failure.
  1253. */
  1254. bool SdBaseFile::rmRfStar() {
  1255. uint16_t index;
  1256. SdBaseFile f;
  1257. rewind();
  1258. while (curPosition_ < fileSize_) {
  1259. // remember position
  1260. index = curPosition_/32;
  1261. dir_t* p = readDirCache();
  1262. if (!p) goto fail;
  1263. // done if past last entry
  1264. if (p->name[0] == DIR_NAME_FREE) break;
  1265. // skip empty slot or '.' or '..'
  1266. if (p->name[0] == DIR_NAME_DELETED || p->name[0] == '.') continue;
  1267. // skip if part of long file name or volume label in root
  1268. if (!DIR_IS_FILE_OR_SUBDIR(p)) continue;
  1269. if (!f.open(this, index, O_READ)) goto fail;
  1270. if (f.isSubDir()) {
  1271. // recursively delete
  1272. if (!f.rmRfStar()) goto fail;
  1273. } else {
  1274. // ignore read-only
  1275. f.flags_ |= O_WRITE;
  1276. if (!f.remove()) goto fail;
  1277. }
  1278. // position to next entry if required
  1279. if (curPosition_ != (32*(index + 1))) {
  1280. if (!seekSet(32*(index + 1))) goto fail;
  1281. }
  1282. }
  1283. // don't try to delete root
  1284. if (!isRoot()) {
  1285. if (!rmdir()) goto fail;
  1286. }
  1287. return true;
  1288. fail:
  1289. return false;
  1290. }
  1291. //------------------------------------------------------------------------------
  1292. /** Create a file object and open it in the current working directory.
  1293. *
  1294. * \param[in] path A path with a valid 8.3 DOS name for a file to be opened.
  1295. *
  1296. * \param[in] oflag Values for \a oflag are constructed by a bitwise-inclusive
  1297. * OR of open flags. see SdBaseFile::open(SdBaseFile*, const char*, uint8_t).
  1298. */
  1299. SdBaseFile::SdBaseFile(const char* path, uint8_t oflag) {
  1300. type_ = FAT_FILE_TYPE_CLOSED;
  1301. writeError = false;
  1302. open(path, oflag);
  1303. }
  1304. //------------------------------------------------------------------------------
  1305. /** Sets a file's position.
  1306. *
  1307. * \param[in] pos The new position in bytes from the beginning of the file.
  1308. *
  1309. * \return The value one, true, is returned for success and
  1310. * the value zero, false, is returned for failure.
  1311. */
  1312. bool SdBaseFile::seekSet(uint32_t pos) {
  1313. uint32_t nCur;
  1314. uint32_t nNew;
  1315. // error if file not open or seek past end of file
  1316. if (!isOpen() || pos > fileSize_) goto fail;
  1317. if (type_ == FAT_FILE_TYPE_ROOT_FIXED) {
  1318. curPosition_ = pos;
  1319. goto done;
  1320. }
  1321. if (pos == 0) {
  1322. // set position to start of file
  1323. curCluster_ = 0;
  1324. curPosition_ = 0;
  1325. goto done;
  1326. }
  1327. // calculate cluster index for cur and new position
  1328. nCur = (curPosition_ - 1) >> (vol_->clusterSizeShift_ + 9);
  1329. nNew = (pos - 1) >> (vol_->clusterSizeShift_ + 9);
  1330. if (nNew < nCur || curPosition_ == 0) {
  1331. // must follow chain from first cluster
  1332. curCluster_ = firstCluster_;
  1333. } else {
  1334. // advance from curPosition
  1335. nNew -= nCur;
  1336. }
  1337. while (nNew--) {
  1338. if (!vol_->fatGet(curCluster_, &curCluster_)) goto fail;
  1339. }
  1340. curPosition_ = pos;
  1341. done:
  1342. return true;
  1343. fail:
  1344. return false;
  1345. }
  1346. //------------------------------------------------------------------------------
  1347. void SdBaseFile::setpos(fpos_t* pos) {
  1348. curPosition_ = pos->position;
  1349. curCluster_ = pos->cluster;
  1350. }
  1351. //------------------------------------------------------------------------------
  1352. /** The sync() call causes all modified data and directory fields
  1353. * to be written to the storage device.
  1354. *
  1355. * \return The value one, true, is returned for success and
  1356. * the value zero, false, is returned for failure.
  1357. * Reasons for failure include a call to sync() before a file has been
  1358. * opened or an I/O error.
  1359. */
  1360. bool SdBaseFile::sync() {
  1361. // only allow open files and directories
  1362. if (!isOpen()) goto fail;
  1363. if (flags_ & F_FILE_DIR_DIRTY) {
  1364. dir_t* d = cacheDirEntry(SdVolume::CACHE_FOR_WRITE);
  1365. // check for deleted by another open file object
  1366. if (!d || d->name[0] == DIR_NAME_DELETED) goto fail;
  1367. // do not set filesize for dir files
  1368. if (!isDir()) d->fileSize = fileSize_;
  1369. // update first cluster fields
  1370. d->firstClusterLow = firstCluster_ & 0XFFFF;
  1371. d->firstClusterHigh = firstCluster_ >> 16;
  1372. // set modify time if user supplied a callback date/time function
  1373. if (dateTime_) {
  1374. dateTime_(&d->lastWriteDate, &d->lastWriteTime);
  1375. d->lastAccessDate = d->lastWriteDate;
  1376. }
  1377. // clear directory dirty
  1378. flags_ &= ~F_FILE_DIR_DIRTY;
  1379. }
  1380. return vol_->cacheFlush();
  1381. fail:
  1382. writeError = true;
  1383. return false;
  1384. }
  1385. //------------------------------------------------------------------------------
  1386. /** Copy a file's timestamps
  1387. *
  1388. * \param[in] file File to copy timestamps from.
  1389. *
  1390. * \note
  1391. * Modify and access timestamps may be overwritten if a date time callback
  1392. * function has been set by dateTimeCallback().
  1393. *
  1394. * \return The value one, true, is returned for success and
  1395. * the value zero, false, is returned for failure.
  1396. */
  1397. bool SdBaseFile::timestamp(SdBaseFile* file) {
  1398. dir_t* d;
  1399. dir_t dir;
  1400. // get timestamps
  1401. if (!file->dirEntry(&dir)) goto fail;
  1402. // update directory fields
  1403. if (!sync()) goto fail;
  1404. d = cacheDirEntry(SdVolume::CACHE_FOR_WRITE);
  1405. if (!d) goto fail;
  1406. // copy timestamps
  1407. d->lastAccessDate = dir.lastAccessDate;
  1408. d->creationDate = dir.creationDate;
  1409. d->creationTime = dir.creationTime;
  1410. d->creationTimeTenths = dir.creationTimeTenths;
  1411. d->lastWriteDate = dir.lastWriteDate;
  1412. d->lastWriteTime = dir.lastWriteTime;
  1413. // write back entry
  1414. return vol_->cacheFlush();
  1415. fail:
  1416. return false;
  1417. }
  1418. //------------------------------------------------------------------------------
  1419. /** Set a file's timestamps in its directory entry.
  1420. *
  1421. * \param[in] flags Values for \a flags are constructed by a bitwise-inclusive
  1422. * OR of flags from the following list
  1423. *
  1424. * T_ACCESS - Set the file's last access date.
  1425. *
  1426. * T_CREATE - Set the file's creation date and time.
  1427. *
  1428. * T_WRITE - Set the file's last write/modification date and time.
  1429. *
  1430. * \param[in] year Valid range 1980 - 2107 inclusive.
  1431. *
  1432. * \param[in] month Valid range 1 - 12 inclusive.
  1433. *
  1434. * \param[in] day Valid range 1 - 31 inclusive.
  1435. *
  1436. * \param[in] hour Valid range 0 - 23 inclusive.
  1437. *
  1438. * \param[in] minute Valid range 0 - 59 inclusive.
  1439. *
  1440. * \param[in] second Valid range 0 - 59 inclusive
  1441. *
  1442. * \note It is possible to set an invalid date since there is no check for
  1443. * the number of days in a month.
  1444. *
  1445. * \note
  1446. * Modify and access timestamps may be overwritten if a date time callback
  1447. * function has been set by dateTimeCallback().
  1448. *
  1449. * \return The value one, true, is returned for success and
  1450. * the value zero, false, is returned for failure.
  1451. */
  1452. bool SdBaseFile::timestamp(uint8_t flags, uint16_t year, uint8_t month,
  1453. uint8_t day, uint8_t hour, uint8_t minute, uint8_t second) {
  1454. uint16_t dirDate;
  1455. uint16_t dirTime;
  1456. dir_t* d;
  1457. if (!isOpen()
  1458. || year < 1980
  1459. || year > 2107
  1460. || month < 1
  1461. || month > 12
  1462. || day < 1
  1463. || day > 31
  1464. || hour > 23
  1465. || minute > 59
  1466. || second > 59) {
  1467. goto fail;
  1468. }
  1469. // update directory entry
  1470. if (!sync()) goto fail;
  1471. d = cacheDirEntry(SdVolume::CACHE_FOR_WRITE);
  1472. if (!d) goto fail;
  1473. dirDate = FAT_DATE(year, month, day);
  1474. dirTime = FAT_TIME(hour, minute, second);
  1475. if (flags & T_ACCESS) {
  1476. d->lastAccessDate = dirDate;
  1477. }
  1478. if (flags & T_CREATE) {
  1479. d->creationDate = dirDate;
  1480. d->creationTime = dirTime;
  1481. // seems to be units of 1/100 second not 1/10 as Microsoft states
  1482. d->creationTimeTenths = second & 1 ? 100 : 0;
  1483. }
  1484. if (flags & T_WRITE) {
  1485. d->lastWriteDate = dirDate;
  1486. d->lastWriteTime = dirTime;
  1487. }
  1488. return vol_->cacheFlush();
  1489. fail:
  1490. return false;
  1491. }
  1492. //------------------------------------------------------------------------------
  1493. /** Truncate a file to a specified length. The current file position
  1494. * will be maintained if it is less than or equal to \a length otherwise
  1495. * it will be set to end of file.
  1496. *
  1497. * \param[in] length The desired length for the file.
  1498. *
  1499. * \return The value one, true, is returned for success and
  1500. * the value zero, false, is returned for failure.
  1501. * Reasons for failure include file is read only, file is a directory,
  1502. * \a length is greater than the current file size or an I/O error occurs.
  1503. */
  1504. bool SdBaseFile::truncate(uint32_t length) {
  1505. uint32_t newPos;
  1506. // error if not a normal file or read-only
  1507. if (!isFile() || !(flags_ & O_WRITE)) goto fail;
  1508. // error if length is greater than current size
  1509. if (length > fileSize_) goto fail;
  1510. // fileSize and length are zero - nothing to do
  1511. if (fileSize_ == 0) return true;
  1512. // remember position for seek after truncation
  1513. newPos = curPosition_ > length ? length : curPosition_;
  1514. // position to last cluster in truncated file
  1515. if (!seekSet(length)) goto fail;
  1516. if (length == 0) {
  1517. // free all clusters
  1518. if (!vol_->freeChain(firstCluster_)) goto fail;
  1519. firstCluster_ = 0;
  1520. } else {
  1521. uint32_t toFree;
  1522. if (!vol_->fatGet(curCluster_, &toFree)) goto fail;
  1523. if (!vol_->isEOC(toFree)) {
  1524. // free extra clusters
  1525. if (!vol_->freeChain(toFree)) goto fail;
  1526. // current cluster is end of chain
  1527. if (!vol_->fatPutEOC(curCluster_)) goto fail;
  1528. }
  1529. }
  1530. fileSize_ = length;
  1531. // need to update directory entry
  1532. flags_ |= F_FILE_DIR_DIRTY;
  1533. if (!sync()) goto fail;
  1534. // set file to correct position
  1535. return seekSet(newPos);
  1536. fail:
  1537. return false;
  1538. }
  1539. //------------------------------------------------------------------------------
  1540. /** Write data to an open file.
  1541. *
  1542. * \note Data is moved to the cache but may not be written to the
  1543. * storage device until sync() is called.
  1544. *
  1545. * \param[in] buf Pointer to the location of the data to be written.
  1546. *
  1547. * \param[in] nbyte Number of bytes to write.
  1548. *
  1549. * \return For success write() returns the number of bytes written, always
  1550. * \a nbyte. If an error occurs, write() returns -1. Possible errors
  1551. * include write() is called before a file has been opened, write is called
  1552. * for a read-only file, device is full, a corrupt file system or an I/O error.
  1553. *
  1554. */
  1555. int16_t SdBaseFile::write(const void* buf, uint16_t nbyte) {
  1556. // convert void* to uint8_t* - must be before goto statements
  1557. const uint8_t* src = reinterpret_cast<const uint8_t*>(buf);
  1558. // number of bytes left to write - must be before goto statements
  1559. uint16_t nToWrite = nbyte;
  1560. // error if not a normal file or is read-only
  1561. if (!isFile() || !(flags_ & O_WRITE)) goto fail;
  1562. // seek to end of file if append flag
  1563. if ((flags_ & O_APPEND) && curPosition_ != fileSize_) {
  1564. if (!seekEnd()) goto fail;
  1565. }
  1566. while (nToWrite > 0) {
  1567. uint8_t blockOfCluster = vol_->blockOfCluster(curPosition_);
  1568. uint16_t blockOffset = curPosition_ & 0X1FF;
  1569. if (blockOfCluster == 0 && blockOffset == 0) {
  1570. // start of new cluster
  1571. if (curCluster_ == 0) {
  1572. if (firstCluster_ == 0) {
  1573. // allocate first cluster of file
  1574. if (!addCluster()) goto fail;
  1575. } else {
  1576. curCluster_ = firstCluster_;
  1577. }
  1578. } else {
  1579. uint32_t next;
  1580. if (!vol_->fatGet(curCluster_, &next)) goto fail;
  1581. if (vol_->isEOC(next)) {
  1582. // add cluster if at end of chain
  1583. if (!addCluster()) goto fail;
  1584. } else {
  1585. curCluster_ = next;
  1586. }
  1587. }
  1588. }
  1589. // max space in block
  1590. uint16_t n = 512 - blockOffset;
  1591. // lesser of space and amount to write
  1592. if (n > nToWrite) n = nToWrite;
  1593. // block for data write
  1594. uint32_t block = vol_->clusterStartBlock(curCluster_) + blockOfCluster;
  1595. if (n == 512) {
  1596. // full block - don't need to use cache
  1597. if (vol_->cacheBlockNumber() == block) {
  1598. // invalidate cache if block is in cache
  1599. vol_->cacheSetBlockNumber(0XFFFFFFFF, false);
  1600. }
  1601. if (!vol_->writeBlock(block, src)) goto fail;
  1602. } else {
  1603. if (blockOffset == 0 && curPosition_ >= fileSize_) {
  1604. // start of new block don't need to read into cache
  1605. if (!vol_->cacheFlush()) goto fail;
  1606. // set cache dirty and SD address of block
  1607. vol_->cacheSetBlockNumber(block, true);
  1608. } else {
  1609. // rewrite part of block
  1610. if (!vol_->cacheRawBlock(block, SdVolume::CACHE_FOR_WRITE)) goto fail;
  1611. }
  1612. uint8_t* dst = vol_->cache()->data + blockOffset;
  1613. memcpy(dst, src, n);
  1614. }
  1615. curPosition_ += n;
  1616. src += n;
  1617. nToWrite -= n;
  1618. }
  1619. if (curPosition_ > fileSize_) {
  1620. // update fileSize and insure sync will update dir entry
  1621. fileSize_ = curPosition_;
  1622. flags_ |= F_FILE_DIR_DIRTY;
  1623. } else if (dateTime_ && nbyte) {
  1624. // insure sync will update modified date and time
  1625. flags_ |= F_FILE_DIR_DIRTY;
  1626. }
  1627. if (flags_ & O_SYNC) {
  1628. if (!sync()) goto fail;
  1629. }
  1630. return nbyte;
  1631. fail:
  1632. // return for write error
  1633. writeError = true;
  1634. return -1;
  1635. }
  1636. //------------------------------------------------------------------------------
  1637. // suppress cpplint warnings with NOLINT comment
  1638. #if ALLOW_DEPRECATED_FUNCTIONS && !defined(DOXYGEN)
  1639. void (*SdBaseFile::oldDateTime_)(uint16_t& date, uint16_t& time) = 0; // NOLINT
  1640. #endif // ALLOW_DEPRECATED_FUNCTIONS
  1641. #endif