-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathAPI.txt
More file actions
1755 lines (847 loc) · 38.2 KB
/
API.txt
File metadata and controls
1755 lines (847 loc) · 38.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
-
f_initvolume
Initialize the volume. Acquire the disk interface that corresponds
to the volume. N.b. that the disk interface could be owned
currently by some other module, like a USB MSD module. This
function does not access hardware, nor does it mount a volume.
SYNOPSIS
int f_initvolume(void)
PARAMETERS
none.
RETURNS
F_NO_ERROR Success.
F_ERR_INITFUNC Could not acquire disk interface.
F_ERR_BUSY Timeout on acquiring mutex/semaphore.
F_ERR_OS Unspecified internal RTOS error.
SEE ALSO
f_delvolume().
-
f_delvolume
Close all open files, unmount the volume, release the disk
interface and reset volume internaldata structures. This allows
passing control of the disk interface to another module.
A call to f_delvolume() may not be needed if all outstanding operations
had been completed, and all files had been closed.
SYNOPSIS
int f_delvolume(void)
PARAMETERS
none.
RETURNS
F_NO_ERROR Success.
F_ERR_INITFUNC Volume was not initialized.
F_ERR_CARDREMOVED SDCARD has been removed.
F_ERR_BUSY Timeout on acquiring mutex/semaphore.
F_ERR_OS Unspecified internal RTOS error.
F_ERR_UNUSABLE Volume is unusable.
SEE ALSO
f_initvolume().
-
f_format
Close all open files, unmount the volume, and perform a soft
format. Keep Master Boot Record and BIOS Parameter Block in place,
just reinitialize the FAT and the root directory. This essentially
cleans a SDCARD without losing the internal alignment.
SYNOPSIS
int f_format(int fattype)
PARAMETERS
int fattype Ignored, only present for API compatibility.
RETURNS
F_NO_ERROR Success.
F_ERR_INITFUNC Volume was not initialized.
F_ERR_CARDREMOVED SDCARD has been removed.
F_ERR_BUSY Timeout on acquiring mutex/semaphore.
F_ERR_WRITEPROTECT Volume is read only.
F_ERR_OS Unspecified internal RTOS error.
F_ERR_UNUSABLE Volume is unusable.
SEE ALSO
f_hardformat()
.-
f_hardformat
Close all open files, unmount the volume, and perform a hard
format. Layout a new file system with the proper alignment for
the SDCARD, create a new Master Boot Record and a new BIOS
Parameter Block. Innitialize the FAT and the root directory. This
will fully initialize a corrupted SDCARD.
The selection of FAT12/FAT16/FAT32 is only dependent soley on the
SDCARD's size, hence fattype is ignored. The same is true for the
cluster selection.
SYNOPSIS
int f_hardformat(int fattype)
PARAMETERS
int fattype Ignored, only present for API compatibility.
RETURNS
F_NO_ERROR Success.
F_ERR_INITFUNC Volume was not initialized.
F_ERR_CARDREMOVED SDCARD has been removed.
F_ERR_BUSY Timeout on acquiring mutex/semaphore.
F_ERR_WRITEPROTECT Volume is read only.
F_ERR_MEDIATOOSMALL Required FAT12 support missing.
F_ERR_MEDIATOOLARGE SDXC card, which requires exFAT.
F_ERR_OS Unspecified internal RTOS error.
F_ERR_UNUSABLE Volume is unusable.
SEE ALSO
f_format().
-
f_getfreespace
Compute the number of total, free and used bytes. The F_SPACE
struct contains an entry for bad clusters, which however will
always read 0, as an SDCARD does internal bad block remapping.
SYNOPSIS
int f_getfreespace(F_SPACE *p_space)
PARAMETERS
F_SPACE *p_space Struct to return volume information.
RETURNS
F_NO_ERROR Success.
F_ERR_NOTFORMATTED No MBR or BPB found.
F_ERR_INITFUNC Volume was not initialized.
F_ERR_CARDREMOVED SDCARD has been removed.
F_ERR_INVALIDMEDIA Not a FAT file system.
F_ERR_BUSY Timeout on acquiring mutex/semaphore.
F_ERR_NOTSUPPSECTORSIZE Sector size other than 512 bytes.
F_ERR_OS Unspecified internal RTOS error.
F_ERR_UNUSABLE Volume is unusable.
SEE ALSO
-
f_getserial
Get the volume's serial number from the BIOS Barameter Block. RFAT
will fill this in a f_hardformat() time with the SDCARD's serial
number.
SYNOPSIS
int f_getserial(unsigned long *p_serial)
PARAMETERS
unsigned long *p_serial Volume serial.
RETURNS
F_NO_ERROR Success.
F_ERR_NOTFORMATTED No MBR or BPB found.
F_ERR_INITFUNC Volume was not initialized.
F_ERR_CARDREMOVED SDCARD has been removed.
F_ERR_INVALIDMEDIA Not a FAT file system.
F_ERR_BUSY Timeout on acquiring mutex/semaphore.
F_ERR_NOTSUPPSECTORSIZE Sector size other than 512 bytes.
F_ERR_OS Unspecified internal RTOS error.
F_ERR_UNUSABLE Volume is unusable.
SEE ALSO
f_getlabel(), f_setlabel()
-
f_setlabel
Create or modify the volume's label in a special volume label entry in the
root directory.
SYNOPSIS
int f_setlabel(const char *volname)
PARAMETERS
const char *volname Volume name.
RETURNS
F_NO_ERROR Success.
F_ERR_NOTFORMATTED No MBR or BPB found.
F_ERR_NOMOREENTRY No more available directory entries.
F_ERR_EOF Damaged cluster chain.
F_ERR_INITFUNC Volume was not initialized.
F_ERR_CARDREMOVED SDCARD has been removed.
F_ERR_INVALIDMEDIA Not a FAT file system.
F_ERR_BUSY Timeout on acquiring mutex/semaphore.
F_ERR_WRITEPROTECT Volume is read only.
F_ERR_NOTSUPPSECTORSIZE Sector size other than 512 bytes.
F_ERR_OS Unspecified internal RTOS error.
F_ERR_UNUSABLE Volume is unusable.
SEE ALSO
f_getserial(), f_getlabel()
-
f_getlabel
Get the volume's label either from a special volume label directory entry
in the root directory or from the BIOS Barameter Block.
SYNOPSIS
int f_getlabel(char *volname, int length)
PARAMETERS
char *volname Volume name.
int length Maximum length.
RETURNS
F_NO_ERROR Success.
F_ERR_NOTFORMATTED No MBR or BPB found.
F_ERR_INITFUNC Volume was not initialized.
F_ERR_EOF Damaged cluster chain.
F_ERR_CARDREMOVED SDCARD has been removed.
F_ERR_INVALIDMEDIA Not a FAT file system.
F_ERR_BUSY Timeout on acquiring mutex/semaphore.
F_ERR_NOTSUPPSECTORSIZE Sector size other than 512 bytes.
F_ERR_OS Unspecified internal RTOS error.
F_ERR_TOOLONGNAME Too small buffer for volume name.
F_ERR_UNUSABLE Volume is unusable.
SEE ALSO
f_getserial(), f_setlabel()
-
f_mkdir
Create the specified directory.
SYNOPSIS
int f_mkdir(const char *dirname)
PARAMETERS
const char *dirname Directory name.
RETURNS
F_NO_ERROR Success.
F_ERR_NOTFORMATTED No MBR or BPB found.
F_ERR_INVALIDDIR Directory path is invalid.
F_ERR_INVALIDNAME Directory name is invalid.
F_ERR_NOTFOUND Directory name is "." or "..".
F_ERR_DUPLICATED Directory already exists.
F_ERR_NOMOREENTRY No more available directory entries.
F_ERR_EOF Damaged cluster chain.
F_ERR_INITFUNC Volume was not initialized.
F_ERR_CARDREMOVED SDCARD has been removed.
F_ERR_INVALIDMEDIA Not a FAT file system.
F_ERR_BUSY Timeout on acquiring mutex/semaphore.
F_ERR_WRITEPROTECT Volume is read only.
F_ERR_NOTSUPPSECTORSIZE Sector size other than 512 bytes.
F_ERR_OS Unspecified internal RTOS error.
F_ERR_UNUSABLE Volume is unusable.
SEE ALSO
f_rmdir()
-
f_rmdir
Remove the specified directory.
SYNOPSIS
int f_rmdir(const char *dirname)
PARAMETERS
const char *dirname Directory name.
RETURNS
F_NO_ERROR Success.
F_ERR_NOTFORMATTED No MBR or BPB found.
F_ERR_INVALIDDIR Directory path is invalid.
F_ERR_INVALIDNAME Directory name is invalid.
F_ERR_NOTFOUND Directory not found.
F_ERR_EOF Damaged cluster chain.
F_ERR_NOTEMPTY Directory is not empty.
F_ERR_INITFUNC Volume was not initialized.
F_ERR_CARDREMOVED SDCARD has been removed.
F_ERR_INVALIDMEDIA Not a FAT file system.
F_ERR_BUSY Timeout on acquiring mutex/semaphore.
F_ERR_WRITEPROTECT Volume is read only.
F_ERR_NOTSUPPSECTORSIZE Sector size other than 512 bytes.
F_ERR_OS Unspecified internal RTOS error.
F_ERR_UNUSABLE Volume is unusable.
SEE ALSO
f_mkdir()
-
f_chdir
Change the current directory to the specified directory.
SYNOPSIS
int f_chdir(const char *dirname)
PARAMETERS
const char *dirname Directory name.
RETURNS
F_NO_ERROR Success.
F_ERR_NOTFORMATTED No MBR or BPB found.
F_ERR_INVALIDDIR Directory path is invalid.
F_ERR_INVALIDNAME Directory name is invalid.
F_ERR_NOTFOUND Directory not found.
F_ERR_EOF Damaged cluster chain.
F_ERR_INITFUNC Volume was not initialized.
F_ERR_CARDREMOVED SDCARD has been removed.
F_ERR_INVALIDMEDIA Not a FAT file system.
F_ERR_BUSY Timeout on acquiring mutex/semaphore.
F_ERR_NOTSUPPSECTORSIZE Sector size other than 512 bytes.
F_ERR_OS Unspecified internal RTOS error.
F_ERR_UNUSABLE Volume is unusable.
SEE ALSO
f_getcwd()
-
f_getcwd
Return the full path name (starting from the root directory) of the current
directory.
SYNOPSIS
int f_getcwd(char *dirname, int length)
PARAMETERS
char *dirname Directory name.
int length Maximum length.
RETURNS
F_NO_ERROR Success.
F_ERR_NOTFORMATTED No MBR or BPB found.
F_ERR_NOTFOUND Damaged directory tree.
F_ERR_EOF Damaged cluster chain.
F_ERR_INITFUNC Volume was not initialized.
F_ERR_CARDREMOVED SDCARD has been removed.
F_ERR_INVALIDMEDIA Not a FAT file system.
F_ERR_BUSY Timeout on acquiring mutex/semaphore.
F_ERR_NOTSUPPSECTORSIZE Sector size other than 512 bytes.
F_ERR_OS Unspecified internal RTOS error.
F_ERR_TOOLONGNAME Too small buffer for directory name.
F_ERR_UNUSABLE Volume is unusable.
SEE ALSO
f_chdir()
-
f_rename
Rename the specified file or directory. The new name does not include
a full path, which implies that a file or diectory cannot be moved across
directories. A file that is open cannot be renamed. A file or directory
that is read only cannot be renamed.
SYNOPSIS
int f_rename(const char *filename, const char *newname)
PARAMETERS
const char *filename Original file name.
const char *newname New file name.
RETURNS
F_NO_ERROR Success.
F_ERR_NOTFORMATTED No MBR or BPB found.
F_ERR_INVALIDDIR File/directory path is invalid.
F_ERR_INVALIDNAME File/directory name is invalid.
F_ERR_NOTFOUND File/directory not found.
F_ERR_DUPLICATED File/directory already exists.
F_ERR_NOMOREENTRY No more available directory entries.
F_ERR_EOF Damaged cluster chain.
F_ERR_INITFUNC Volume was not initialized.
F_ERR_LOCKED File is currently open.
F_ERR_ACCESSDENIED File/directory is read only.
F_ERR_CARDREMOVED SDCARD has been removed.
F_ERR_INVALIDMEDIA Not a FAT file system.
F_ERR_BUSY Timeout on acquiring mutex/semaphore.
F_ERR_WRITEPROTECT Volume is read only.
F_ERR_NOTSUPPSECTORSIZE Sector size other than 512 bytes.
F_ERR_OS Unspecified internal RTOS error.
F_ERR_UNUSABLE Volume is unusable.
SEE ALSO
f_delete(), f_open()
-
f_delete
Delete the specified file. A file that is open cannot be deleted. A file
that is read only cannot be deleted.
SYNOPSIS
int f_delete(const char *filename)
PARAMETERS
const char *filename File name.
RETURNS
F_NO_ERROR Success.
F_ERR_NOTFORMATTED No MBR or BPB found.
F_ERR_INVALIDDIR File path is invalid.
F_ERR_INVALIDNAME File name is invalid.
F_ERR_NOTFOUND File not found.
F_ERR_EOF Damaged cluster chain.
F_ERR_INITFUNC Volume was not initialized.
F_ERR_LOCKED File is currently open.
F_ERR_ACCESSDENIED File is read only.
F_ERR_CARDREMOVED SDCARD has been removed.
F_ERR_INVALIDMEDIA Not a FAT file system.
F_ERR_BUSY Timeout on acquiring mutex/semaphore.
F_ERR_WRITEPROTECT Volume is read only.
F_ERR_NOTSUPPSECTORSIZE Sector size other than 512 bytes.
F_ERR_OS Unspecified internal RTOS error.
F_ERR_UNUSABLE Volume is unusable.
SEE ALSO
f_open(), f_rename()
-
f_filelength
Return the length of the specified file. If a file is open for writing only
the information that has been written out to the SDCARD is used.
SYNOPSIS
long f_filelength(const char *filename)
PARAMETERS
const char *filename File name.
RETURNS
Length of the file , or 0 if the file did not exist, or the was another error.
SEE ALSO
f_open, f_rename()
-
f_findfirst
Find the first file or directory that matches the file name specification
within a directory.
The file name may contain wildcards:
* Matches zero or more characters until encountering and matching
the final '.' in the name.
? Matches a single character or, upon encountering a '.' or end of
name string, advances the expression to the end of the set of
contiguous '?'.
. Matches either a '.' or zero characters beyond the name string.
The find.filename returned is the proper formatted "name.ext" string that
can be used directly as input for other APIs. The find.name/find.ext
elements always contain the padded 8.3 name representation. If VFAT
support is enabled this maps to the corresponding short file name.
FAT12/FAT16 record a composite create/modify time/date. FAT32 records
separate time/date stamps for create and modify. The returned
find.ctime/find.cdate correspond to the last modification time/date, not
the create time/date.
SYNOPSIS
int f_findfirst(const char *filename, F_FIND *find)
PARAMETERS
const char *filename Name specification.
F_FIND *find Find information.
RETURNS
find.filename Full filename.
find.name Name portion of 8.3 file name.
find.ext Ext portion of 8.3 file name.
find.attr File/directory attributes.
find.ctime File/directory last modification time.
find.cdate File/directory last modification date.
find.filesize File length.
F_NO_ERROR Success.
F_ERR_NOTFORMATTED No MBR or BPB found.
F_ERR_INVALIDDIR File/directory path is invalid.
F_ERR_INVALIDNAME File/directory name is invalid.
F_ERR_NOTFOUND File/directory not found.
F_ERR_EOF Damaged cluster chain.
F_ERR_INITFUNC Volume was not initialized.
F_ERR_CARDREMOVED SDCARD has been removed.
F_ERR_INVALIDMEDIA Not a FAT file system.
F_ERR_BUSY Timeout on acquiring mutex/semaphore.
F_ERR_NOTSUPPSECTORSIZE Sector size other than 512 bytes.
F_ERR_OS Unspecified internal RTOS error.
F_ERR_UNUSABLE Volume is unusable.
SEE ALSO
f_findnext()
-
f_findnext
Find the next file or directory that matches the file information setup by
a previous f_findfirst() call.
SYNOPSIS
int f_findnext(F_FIND *find)
PARAMETERS
F_FIND *find Find information.
RETURNS
find.filename Full filename.
find.name Name portion of 8.3 file name.
find.ext Ext portion of 8.3 file name.
find.attr File/directory attributes.
find.ctime File/directory last modification time.
find.cdate File/directory last modification date.
find.filesize File length.
F_NO_ERROR Success.
F_ERR_NOTFORMATTED No MBR or BPB found.
F_ERR_INVALIDDIR File/directory path is invalid.
F_ERR_INVALIDNAME File/directory name is invalid.
F_ERR_NOTFOUND File/directory not found.
F_ERR_EOF Damaged cluster chain.
F_ERR_INITFUNC Volume was not initialized.
F_ERR_CARDREMOVED SDCARD has been removed.
F_ERR_INVALIDMEDIA Not a FAT file system.
F_ERR_BUSY Timeout on acquiring mutex/semaphore.
F_ERR_NOTSUPPSECTORSIZE Sector size other than 512 bytes.
F_ERR_OS Unspecified internal RTOS error.
F_ERR_UNUSABLE Volume is unusable.
SEE ALSO
f_findfirst()
-
f_settimedate
Set the last modification time of a file or directory.
SYNOPSIS
int f_settimedate(const char *filename, unsigned short ctime, unsigned short cdate)
PARAMETERS
const char *filename File name.
unsigned short ctime Last modification time.
unsigned short cdate Last modification date.
RETURNS
F_NO_ERROR Success.
F_ERR_NOTFORMATTED No MBR or BPB found.
F_ERR_INVALIDDIR File/directory path is invalid.
F_ERR_INVALIDNAME File/directory name is invalid.
F_ERR_NOTFOUND File/directory not found.
F_ERR_INITFUNC Volume was not initialized.
F_ERR_CARDREMOVED SDCARD has been removed.
F_ERR_INVALIDMEDIA Not a FAT file system.
F_ERR_BUSY Timeout on acquiring mutex/semaphore.
F_ERR_WRITEPROTECT Volume is read only.
F_ERR_NOTSUPPSECTORSIZE Sector size other than 512 bytes.
F_ERR_OS Unspecified internal RTOS error.
F_ERR_UNUSABLE Volume is unusable.
SEE ALSO
f_gettimedate()
-
f_gettimedate
Get the last modification time of a file or directory.
SYNOPSIS
int f_gettimedate(const char *filename, unsigned short *p_ctime, unsigned short *p_cdate)
PARAMETERS
const char *filename File name.
unsigned short *p_ctime Last modification time.
unsigned short *p_cdate Last modification date.
RETURNS
F_NO_ERROR Success.
F_ERR_NOTFORMATTED No MBR or BPB found.
F_ERR_INVALIDDIR File/directory path is invalid.
F_ERR_INVALIDNAME File/directory name is invalid.
F_ERR_NOTFOUND File/directory not found.
F_ERR_INITFUNC Volume was not initialized.
F_ERR_CARDREMOVED SDCARD has been removed.
F_ERR_INVALIDMEDIA Not a FAT file system.
F_ERR_BUSY Timeout on acquiring mutex/semaphore.
F_ERR_NOTSUPPSECTORSIZE Sector size other than 512 bytes.
F_ERR_OS Unspecified internal RTOS error.
F_ERR_UNUSABLE Volume is unusable.
SEE ALSO
f_settimedate()
-
f_setattr
Set the directory entry attributes a file or directory. Only F_ATTR_ARC,
F_ATTR_SYSTEM, F_ATTR_HIDDEN and F_ATTR_READONLY can be changed.