SdBaseFile.cpp 53 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792
  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. #ifdef 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) != 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[13];
  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 directory entry from a directory file.
  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) {
  1021. int16_t n;
  1022. // if not a directory file or miss-positioned return an error
  1023. if (!isDir() || (0X1F & curPosition_)) return -1;
  1024. while (1) {
  1025. n = read(dir, sizeof(dir_t));
  1026. if (n != sizeof(dir_t)) return n == 0 ? 0 : -1;
  1027. // last entry if DIR_NAME_FREE
  1028. if (dir->name[0] == DIR_NAME_FREE) return 0;
  1029. // skip empty entries and entry for . and ..
  1030. if (dir->name[0] == DIR_NAME_DELETED || dir->name[0] == '.') continue;
  1031. // return if normal file or subdirectory
  1032. if (DIR_IS_FILE_OR_SUBDIR(dir)) return n;
  1033. }
  1034. }
  1035. //------------------------------------------------------------------------------
  1036. // Read next directory entry into the cache
  1037. // Assumes file is correctly positioned
  1038. dir_t* SdBaseFile::readDirCache() {
  1039. uint8_t i;
  1040. // error if not directory
  1041. if (!isDir()) goto fail;
  1042. // index of entry in cache
  1043. i = (curPosition_ >> 5) & 0XF;
  1044. // use read to locate and cache block
  1045. if (read() < 0) goto fail;
  1046. // advance to next entry
  1047. curPosition_ += 31;
  1048. // return pointer to entry
  1049. return vol_->cache()->dir + i;
  1050. fail:
  1051. return 0;
  1052. }
  1053. //------------------------------------------------------------------------------
  1054. /** Remove a file.
  1055. *
  1056. * The directory entry and all data for the file are deleted.
  1057. *
  1058. * \note This function should not be used to delete the 8.3 version of a
  1059. * file that has a long name. For example if a file has the long name
  1060. * "New Text Document.txt" you should not delete the 8.3 name "NEWTEX~1.TXT".
  1061. *
  1062. * \return The value one, true, is returned for success and
  1063. * the value zero, false, is returned for failure.
  1064. * Reasons for failure include the file read-only, is a directory,
  1065. * or an I/O error occurred.
  1066. */
  1067. bool SdBaseFile::remove() {
  1068. dir_t* d;
  1069. // free any clusters - will fail if read-only or directory
  1070. if (!truncate(0)) goto fail;
  1071. // cache directory entry
  1072. d = cacheDirEntry(SdVolume::CACHE_FOR_WRITE);
  1073. if (!d) goto fail;
  1074. // mark entry deleted
  1075. d->name[0] = DIR_NAME_DELETED;
  1076. // set this file closed
  1077. type_ = FAT_FILE_TYPE_CLOSED;
  1078. // write entry to SD
  1079. return vol_->cacheFlush();
  1080. return true;
  1081. fail:
  1082. return false;
  1083. }
  1084. //------------------------------------------------------------------------------
  1085. /** Remove a file.
  1086. *
  1087. * The directory entry and all data for the file are deleted.
  1088. *
  1089. * \param[in] dirFile The directory that contains the file.
  1090. * \param[in] path Path for the file to be removed.
  1091. *
  1092. * \note This function should not be used to delete the 8.3 version of a
  1093. * file that has a long name. For example if a file has the long name
  1094. * "New Text Document.txt" you should not delete the 8.3 name "NEWTEX~1.TXT".
  1095. *
  1096. * \return The value one, true, is returned for success and
  1097. * the value zero, false, is returned for failure.
  1098. * Reasons for failure include the file is a directory, is read only,
  1099. * \a dirFile is not a directory, \a path is not found
  1100. * or an I/O error occurred.
  1101. */
  1102. bool SdBaseFile::remove(SdBaseFile* dirFile, const char* path) {
  1103. SdBaseFile file;
  1104. if (!file.open(dirFile, path, O_WRITE)) goto fail;
  1105. return file.remove();
  1106. fail:
  1107. // can't set iostate - static function
  1108. return false;
  1109. }
  1110. //------------------------------------------------------------------------------
  1111. /** Rename a file or subdirectory.
  1112. *
  1113. * \param[in] dirFile Directory for the new path.
  1114. * \param[in] newPath New path name for the file/directory.
  1115. *
  1116. * \return The value one, true, is returned for success and
  1117. * the value zero, false, is returned for failure.
  1118. * Reasons for failure include \a dirFile is not open or is not a directory
  1119. * file, newPath is invalid or already exists, or an I/O error occurs.
  1120. */
  1121. bool SdBaseFile::rename(SdBaseFile* dirFile, const char* newPath) {
  1122. dir_t entry;
  1123. uint32_t dirCluster = 0;
  1124. SdBaseFile file;
  1125. dir_t* d;
  1126. // must be an open file or subdirectory
  1127. if (!(isFile() || isSubDir())) goto fail;
  1128. // can't move file
  1129. if (vol_ != dirFile->vol_) goto fail;
  1130. // sync() and cache directory entry
  1131. sync();
  1132. d = cacheDirEntry(SdVolume::CACHE_FOR_WRITE);
  1133. if (!d) goto fail;
  1134. // save directory entry
  1135. memcpy(&entry, d, sizeof(entry));
  1136. // mark entry deleted
  1137. d->name[0] = DIR_NAME_DELETED;
  1138. // make directory entry for new path
  1139. if (isFile()) {
  1140. if (!file.open(dirFile, newPath, O_CREAT | O_EXCL | O_WRITE)) {
  1141. goto restore;
  1142. }
  1143. } else {
  1144. // don't create missing path prefix components
  1145. if (!file.mkdir(dirFile, newPath, false)) {
  1146. goto restore;
  1147. }
  1148. // save cluster containing new dot dot
  1149. dirCluster = file.firstCluster_;
  1150. }
  1151. // change to new directory entry
  1152. dirBlock_ = file.dirBlock_;
  1153. dirIndex_ = file.dirIndex_;
  1154. // mark closed to avoid possible destructor close call
  1155. file.type_ = FAT_FILE_TYPE_CLOSED;
  1156. // cache new directory entry
  1157. d = cacheDirEntry(SdVolume::CACHE_FOR_WRITE);
  1158. if (!d) goto fail;
  1159. // copy all but name field to new directory entry
  1160. memcpy(&d->attributes, &entry.attributes, sizeof(entry) - sizeof(d->name));
  1161. // update dot dot if directory
  1162. if (dirCluster) {
  1163. // get new dot dot
  1164. uint32_t block = vol_->clusterStartBlock(dirCluster);
  1165. if (!vol_->cacheRawBlock(block, SdVolume::CACHE_FOR_READ)) goto fail;
  1166. memcpy(&entry, &vol_->cache()->dir[1], sizeof(entry));
  1167. // free unused cluster
  1168. if (!vol_->freeChain(dirCluster)) goto fail;
  1169. // store new dot dot
  1170. block = vol_->clusterStartBlock(firstCluster_);
  1171. if (!vol_->cacheRawBlock(block, SdVolume::CACHE_FOR_WRITE)) goto fail;
  1172. memcpy(&vol_->cache()->dir[1], &entry, sizeof(entry));
  1173. }
  1174. return vol_->cacheFlush();
  1175. restore:
  1176. d = cacheDirEntry(SdVolume::CACHE_FOR_WRITE);
  1177. if (!d) goto fail;
  1178. // restore entry
  1179. d->name[0] = entry.name[0];
  1180. vol_->cacheFlush();
  1181. fail:
  1182. return false;
  1183. }
  1184. //------------------------------------------------------------------------------
  1185. /** Remove a directory file.
  1186. *
  1187. * The directory file will be removed only if it is empty and is not the
  1188. * root directory. rmdir() follows DOS and Windows and ignores the
  1189. * read-only attribute for the directory.
  1190. *
  1191. * \note This function should not be used to delete the 8.3 version of a
  1192. * directory that has a long name. For example if a directory has the
  1193. * long name "New folder" you should not delete the 8.3 name "NEWFOL~1".
  1194. *
  1195. * \return The value one, true, is returned for success and
  1196. * the value zero, false, is returned for failure.
  1197. * Reasons for failure include the file is not a directory, is the root
  1198. * directory, is not empty, or an I/O error occurred.
  1199. */
  1200. bool SdBaseFile::rmdir() {
  1201. // must be open subdirectory
  1202. if (!isSubDir()) goto fail;
  1203. rewind();
  1204. // make sure directory is empty
  1205. while (curPosition_ < fileSize_) {
  1206. dir_t* p = readDirCache();
  1207. if (!p) goto fail;
  1208. // done if past last used entry
  1209. if (p->name[0] == DIR_NAME_FREE) break;
  1210. // skip empty slot, '.' or '..'
  1211. if (p->name[0] == DIR_NAME_DELETED || p->name[0] == '.') continue;
  1212. // error not empty
  1213. if (DIR_IS_FILE_OR_SUBDIR(p)) goto fail;
  1214. }
  1215. // convert empty directory to normal file for remove
  1216. type_ = FAT_FILE_TYPE_NORMAL;
  1217. flags_ |= O_WRITE;
  1218. return remove();
  1219. fail:
  1220. return false;
  1221. }
  1222. //------------------------------------------------------------------------------
  1223. /** Recursively delete a directory and all contained files.
  1224. *
  1225. * This is like the Unix/Linux 'rm -rf *' if called with the root directory
  1226. * hence the name.
  1227. *
  1228. * Warning - This will remove all contents of the directory including
  1229. * subdirectories. The directory will then be removed if it is not root.
  1230. * The read-only attribute for files will be ignored.
  1231. *
  1232. * \note This function should not be used to delete the 8.3 version of
  1233. * a directory that has a long name. See remove() and rmdir().
  1234. *
  1235. * \return The value one, true, is returned for success and
  1236. * the value zero, false, is returned for failure.
  1237. */
  1238. bool SdBaseFile::rmRfStar() {
  1239. uint16_t index;
  1240. SdBaseFile f;
  1241. rewind();
  1242. while (curPosition_ < fileSize_) {
  1243. // remember position
  1244. index = curPosition_/32;
  1245. dir_t* p = readDirCache();
  1246. if (!p) goto fail;
  1247. // done if past last entry
  1248. if (p->name[0] == DIR_NAME_FREE) break;
  1249. // skip empty slot or '.' or '..'
  1250. if (p->name[0] == DIR_NAME_DELETED || p->name[0] == '.') continue;
  1251. // skip if part of long file name or volume label in root
  1252. if (!DIR_IS_FILE_OR_SUBDIR(p)) continue;
  1253. if (!f.open(this, index, O_READ)) goto fail;
  1254. if (f.isSubDir()) {
  1255. // recursively delete
  1256. if (!f.rmRfStar()) goto fail;
  1257. } else {
  1258. // ignore read-only
  1259. f.flags_ |= O_WRITE;
  1260. if (!f.remove()) goto fail;
  1261. }
  1262. // position to next entry if required
  1263. if (curPosition_ != (32*(index + 1))) {
  1264. if (!seekSet(32*(index + 1))) goto fail;
  1265. }
  1266. }
  1267. // don't try to delete root
  1268. if (!isRoot()) {
  1269. if (!rmdir()) goto fail;
  1270. }
  1271. return true;
  1272. fail:
  1273. return false;
  1274. }
  1275. //------------------------------------------------------------------------------
  1276. /** Create a file object and open it in the current working directory.
  1277. *
  1278. * \param[in] path A path with a valid 8.3 DOS name for a file to be opened.
  1279. *
  1280. * \param[in] oflag Values for \a oflag are constructed by a bitwise-inclusive
  1281. * OR of open flags. see SdBaseFile::open(SdBaseFile*, const char*, uint8_t).
  1282. */
  1283. SdBaseFile::SdBaseFile(const char* path, uint8_t oflag) {
  1284. type_ = FAT_FILE_TYPE_CLOSED;
  1285. writeError = false;
  1286. open(path, oflag);
  1287. }
  1288. //------------------------------------------------------------------------------
  1289. /** Sets a file's position.
  1290. *
  1291. * \param[in] pos The new position in bytes from the beginning of the file.
  1292. *
  1293. * \return The value one, true, is returned for success and
  1294. * the value zero, false, is returned for failure.
  1295. */
  1296. bool SdBaseFile::seekSet(uint32_t pos) {
  1297. uint32_t nCur;
  1298. uint32_t nNew;
  1299. // error if file not open or seek past end of file
  1300. if (!isOpen() || pos > fileSize_) goto fail;
  1301. if (type_ == FAT_FILE_TYPE_ROOT_FIXED) {
  1302. curPosition_ = pos;
  1303. goto done;
  1304. }
  1305. if (pos == 0) {
  1306. // set position to start of file
  1307. curCluster_ = 0;
  1308. curPosition_ = 0;
  1309. goto done;
  1310. }
  1311. // calculate cluster index for cur and new position
  1312. nCur = (curPosition_ - 1) >> (vol_->clusterSizeShift_ + 9);
  1313. nNew = (pos - 1) >> (vol_->clusterSizeShift_ + 9);
  1314. if (nNew < nCur || curPosition_ == 0) {
  1315. // must follow chain from first cluster
  1316. curCluster_ = firstCluster_;
  1317. } else {
  1318. // advance from curPosition
  1319. nNew -= nCur;
  1320. }
  1321. while (nNew--) {
  1322. if (!vol_->fatGet(curCluster_, &curCluster_)) goto fail;
  1323. }
  1324. curPosition_ = pos;
  1325. done:
  1326. return true;
  1327. fail:
  1328. return false;
  1329. }
  1330. //------------------------------------------------------------------------------
  1331. void SdBaseFile::setpos(fpos_t* pos) {
  1332. curPosition_ = pos->position;
  1333. curCluster_ = pos->cluster;
  1334. }
  1335. //------------------------------------------------------------------------------
  1336. /** The sync() call causes all modified data and directory fields
  1337. * to be written to the storage device.
  1338. *
  1339. * \return The value one, true, is returned for success and
  1340. * the value zero, false, is returned for failure.
  1341. * Reasons for failure include a call to sync() before a file has been
  1342. * opened or an I/O error.
  1343. */
  1344. bool SdBaseFile::sync() {
  1345. // only allow open files and directories
  1346. if (!isOpen()) goto fail;
  1347. if (flags_ & F_FILE_DIR_DIRTY) {
  1348. dir_t* d = cacheDirEntry(SdVolume::CACHE_FOR_WRITE);
  1349. // check for deleted by another open file object
  1350. if (!d || d->name[0] == DIR_NAME_DELETED) goto fail;
  1351. // do not set filesize for dir files
  1352. if (!isDir()) d->fileSize = fileSize_;
  1353. // update first cluster fields
  1354. d->firstClusterLow = firstCluster_ & 0XFFFF;
  1355. d->firstClusterHigh = firstCluster_ >> 16;
  1356. // set modify time if user supplied a callback date/time function
  1357. if (dateTime_) {
  1358. dateTime_(&d->lastWriteDate, &d->lastWriteTime);
  1359. d->lastAccessDate = d->lastWriteDate;
  1360. }
  1361. // clear directory dirty
  1362. flags_ &= ~F_FILE_DIR_DIRTY;
  1363. }
  1364. return vol_->cacheFlush();
  1365. fail:
  1366. writeError = true;
  1367. return false;
  1368. }
  1369. //------------------------------------------------------------------------------
  1370. /** Copy a file's timestamps
  1371. *
  1372. * \param[in] file File to copy timestamps from.
  1373. *
  1374. * \note
  1375. * Modify and access timestamps may be overwritten if a date time callback
  1376. * function has been set by dateTimeCallback().
  1377. *
  1378. * \return The value one, true, is returned for success and
  1379. * the value zero, false, is returned for failure.
  1380. */
  1381. bool SdBaseFile::timestamp(SdBaseFile* file) {
  1382. dir_t* d;
  1383. dir_t dir;
  1384. // get timestamps
  1385. if (!file->dirEntry(&dir)) goto fail;
  1386. // update directory fields
  1387. if (!sync()) goto fail;
  1388. d = cacheDirEntry(SdVolume::CACHE_FOR_WRITE);
  1389. if (!d) goto fail;
  1390. // copy timestamps
  1391. d->lastAccessDate = dir.lastAccessDate;
  1392. d->creationDate = dir.creationDate;
  1393. d->creationTime = dir.creationTime;
  1394. d->creationTimeTenths = dir.creationTimeTenths;
  1395. d->lastWriteDate = dir.lastWriteDate;
  1396. d->lastWriteTime = dir.lastWriteTime;
  1397. // write back entry
  1398. return vol_->cacheFlush();
  1399. fail:
  1400. return false;
  1401. }
  1402. //------------------------------------------------------------------------------
  1403. /** Set a file's timestamps in its directory entry.
  1404. *
  1405. * \param[in] flags Values for \a flags are constructed by a bitwise-inclusive
  1406. * OR of flags from the following list
  1407. *
  1408. * T_ACCESS - Set the file's last access date.
  1409. *
  1410. * T_CREATE - Set the file's creation date and time.
  1411. *
  1412. * T_WRITE - Set the file's last write/modification date and time.
  1413. *
  1414. * \param[in] year Valid range 1980 - 2107 inclusive.
  1415. *
  1416. * \param[in] month Valid range 1 - 12 inclusive.
  1417. *
  1418. * \param[in] day Valid range 1 - 31 inclusive.
  1419. *
  1420. * \param[in] hour Valid range 0 - 23 inclusive.
  1421. *
  1422. * \param[in] minute Valid range 0 - 59 inclusive.
  1423. *
  1424. * \param[in] second Valid range 0 - 59 inclusive
  1425. *
  1426. * \note It is possible to set an invalid date since there is no check for
  1427. * the number of days in a month.
  1428. *
  1429. * \note
  1430. * Modify and access timestamps may be overwritten if a date time callback
  1431. * function has been set by dateTimeCallback().
  1432. *
  1433. * \return The value one, true, is returned for success and
  1434. * the value zero, false, is returned for failure.
  1435. */
  1436. bool SdBaseFile::timestamp(uint8_t flags, uint16_t year, uint8_t month,
  1437. uint8_t day, uint8_t hour, uint8_t minute, uint8_t second) {
  1438. uint16_t dirDate;
  1439. uint16_t dirTime;
  1440. dir_t* d;
  1441. if (!isOpen()
  1442. || year < 1980
  1443. || year > 2107
  1444. || month < 1
  1445. || month > 12
  1446. || day < 1
  1447. || day > 31
  1448. || hour > 23
  1449. || minute > 59
  1450. || second > 59) {
  1451. goto fail;
  1452. }
  1453. // update directory entry
  1454. if (!sync()) goto fail;
  1455. d = cacheDirEntry(SdVolume::CACHE_FOR_WRITE);
  1456. if (!d) goto fail;
  1457. dirDate = FAT_DATE(year, month, day);
  1458. dirTime = FAT_TIME(hour, minute, second);
  1459. if (flags & T_ACCESS) {
  1460. d->lastAccessDate = dirDate;
  1461. }
  1462. if (flags & T_CREATE) {
  1463. d->creationDate = dirDate;
  1464. d->creationTime = dirTime;
  1465. // seems to be units of 1/100 second not 1/10 as Microsoft states
  1466. d->creationTimeTenths = second & 1 ? 100 : 0;
  1467. }
  1468. if (flags & T_WRITE) {
  1469. d->lastWriteDate = dirDate;
  1470. d->lastWriteTime = dirTime;
  1471. }
  1472. return vol_->cacheFlush();
  1473. fail:
  1474. return false;
  1475. }
  1476. //------------------------------------------------------------------------------
  1477. /** Truncate a file to a specified length. The current file position
  1478. * will be maintained if it is less than or equal to \a length otherwise
  1479. * it will be set to end of file.
  1480. *
  1481. * \param[in] length The desired length for the file.
  1482. *
  1483. * \return The value one, true, is returned for success and
  1484. * the value zero, false, is returned for failure.
  1485. * Reasons for failure include file is read only, file is a directory,
  1486. * \a length is greater than the current file size or an I/O error occurs.
  1487. */
  1488. bool SdBaseFile::truncate(uint32_t length) {
  1489. uint32_t newPos;
  1490. // error if not a normal file or read-only
  1491. if (!isFile() || !(flags_ & O_WRITE)) goto fail;
  1492. // error if length is greater than current size
  1493. if (length > fileSize_) goto fail;
  1494. // fileSize and length are zero - nothing to do
  1495. if (fileSize_ == 0) return true;
  1496. // remember position for seek after truncation
  1497. newPos = curPosition_ > length ? length : curPosition_;
  1498. // position to last cluster in truncated file
  1499. if (!seekSet(length)) goto fail;
  1500. if (length == 0) {
  1501. // free all clusters
  1502. if (!vol_->freeChain(firstCluster_)) goto fail;
  1503. firstCluster_ = 0;
  1504. } else {
  1505. uint32_t toFree;
  1506. if (!vol_->fatGet(curCluster_, &toFree)) goto fail;
  1507. if (!vol_->isEOC(toFree)) {
  1508. // free extra clusters
  1509. if (!vol_->freeChain(toFree)) goto fail;
  1510. // current cluster is end of chain
  1511. if (!vol_->fatPutEOC(curCluster_)) goto fail;
  1512. }
  1513. }
  1514. fileSize_ = length;
  1515. // need to update directory entry
  1516. flags_ |= F_FILE_DIR_DIRTY;
  1517. if (!sync()) goto fail;
  1518. // set file to correct position
  1519. return seekSet(newPos);
  1520. fail:
  1521. return false;
  1522. }
  1523. //------------------------------------------------------------------------------
  1524. /** Write data to an open file.
  1525. *
  1526. * \note Data is moved to the cache but may not be written to the
  1527. * storage device until sync() is called.
  1528. *
  1529. * \param[in] buf Pointer to the location of the data to be written.
  1530. *
  1531. * \param[in] nbyte Number of bytes to write.
  1532. *
  1533. * \return For success write() returns the number of bytes written, always
  1534. * \a nbyte. If an error occurs, write() returns -1. Possible errors
  1535. * include write() is called before a file has been opened, write is called
  1536. * for a read-only file, device is full, a corrupt file system or an I/O error.
  1537. *
  1538. */
  1539. int16_t SdBaseFile::write(const void* buf, uint16_t nbyte) {
  1540. // convert void* to uint8_t* - must be before goto statements
  1541. const uint8_t* src = reinterpret_cast<const uint8_t*>(buf);
  1542. // number of bytes left to write - must be before goto statements
  1543. uint16_t nToWrite = nbyte;
  1544. // error if not a normal file or is read-only
  1545. if (!isFile() || !(flags_ & O_WRITE)) goto fail;
  1546. // seek to end of file if append flag
  1547. if ((flags_ & O_APPEND) && curPosition_ != fileSize_) {
  1548. if (!seekEnd()) goto fail;
  1549. }
  1550. while (nToWrite > 0) {
  1551. uint8_t blockOfCluster = vol_->blockOfCluster(curPosition_);
  1552. uint16_t blockOffset = curPosition_ & 0X1FF;
  1553. if (blockOfCluster == 0 && blockOffset == 0) {
  1554. // start of new cluster
  1555. if (curCluster_ == 0) {
  1556. if (firstCluster_ == 0) {
  1557. // allocate first cluster of file
  1558. if (!addCluster()) goto fail;
  1559. } else {
  1560. curCluster_ = firstCluster_;
  1561. }
  1562. } else {
  1563. uint32_t next;
  1564. if (!vol_->fatGet(curCluster_, &next)) goto fail;
  1565. if (vol_->isEOC(next)) {
  1566. // add cluster if at end of chain
  1567. if (!addCluster()) goto fail;
  1568. } else {
  1569. curCluster_ = next;
  1570. }
  1571. }
  1572. }
  1573. // max space in block
  1574. uint16_t n = 512 - blockOffset;
  1575. // lesser of space and amount to write
  1576. if (n > nToWrite) n = nToWrite;
  1577. // block for data write
  1578. uint32_t block = vol_->clusterStartBlock(curCluster_) + blockOfCluster;
  1579. if (n == 512) {
  1580. // full block - don't need to use cache
  1581. if (vol_->cacheBlockNumber() == block) {
  1582. // invalidate cache if block is in cache
  1583. vol_->cacheSetBlockNumber(0XFFFFFFFF, false);
  1584. }
  1585. if (!vol_->writeBlock(block, src)) goto fail;
  1586. } else {
  1587. if (blockOffset == 0 && curPosition_ >= fileSize_) {
  1588. // start of new block don't need to read into cache
  1589. if (!vol_->cacheFlush()) goto fail;
  1590. // set cache dirty and SD address of block
  1591. vol_->cacheSetBlockNumber(block, true);
  1592. } else {
  1593. // rewrite part of block
  1594. if (!vol_->cacheRawBlock(block, SdVolume::CACHE_FOR_WRITE)) goto fail;
  1595. }
  1596. uint8_t* dst = vol_->cache()->data + blockOffset;
  1597. memcpy(dst, src, n);
  1598. }
  1599. curPosition_ += n;
  1600. src += n;
  1601. nToWrite -= n;
  1602. }
  1603. if (curPosition_ > fileSize_) {
  1604. // update fileSize and insure sync will update dir entry
  1605. fileSize_ = curPosition_;
  1606. flags_ |= F_FILE_DIR_DIRTY;
  1607. } else if (dateTime_ && nbyte) {
  1608. // insure sync will update modified date and time
  1609. flags_ |= F_FILE_DIR_DIRTY;
  1610. }
  1611. if (flags_ & O_SYNC) {
  1612. if (!sync()) goto fail;
  1613. }
  1614. return nbyte;
  1615. fail:
  1616. // return for write error
  1617. writeError = true;
  1618. return -1;
  1619. }
  1620. //------------------------------------------------------------------------------
  1621. // suppress cpplint warnings with NOLINT comment
  1622. #if ALLOW_DEPRECATED_FUNCTIONS && !defined(DOXYGEN)
  1623. void (*SdBaseFile::oldDateTime_)(uint16_t& date, uint16_t& time) = 0; // NOLINT
  1624. #endif // ALLOW_DEPRECATED_FUNCTIONS
  1625. #endif