-
Notifications
You must be signed in to change notification settings - Fork 5
/
rfat_core.h
705 lines (620 loc) · 33 KB
/
rfat_core.h
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
/*
* Copyright (c) 2014 Thomas Roell. All rights reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to
* deal with the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
* sell copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimers.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimers in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of Thomas Roell, nor the names of its contributors
* may be used to endorse or promote products derived from this Software
* without specific prior written permission.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
* WITH THE SOFTWARE.
*/
#if !defined(_RFAT_CORE_H)
#define _RFAT_CORE_H
#include "rfat_disk.h"
typedef union _rfat_boot_t rfat_boot_t;
typedef struct _rfat_fsinfo_t rfat_fsinfo_t;
typedef struct _rfat_dir_t rfat_dir_t;
typedef struct _rfat_ldir_t rfat_ldir_t;
typedef struct _rfat_file_t rfat_file_t;
typedef struct _rfat_cache_entry_t rfat_cache_entry_t;
typedef struct _rfat_cluster_entry_t rfat_cluster_entry_t;
typedef struct _rfat_volume_t rfat_volume_t;
#if (RFAT_CONFIG_VFAT_SUPPORTED == 0)
typedef int (*rfat_find_callback_t)(rfat_volume_t *volume, void *private, rfat_dir_t *dir);
#else /* (RFAT_CONFIG_VFAT_SUPPORTED == 0) */
#define RFAT_LDIR_SEQUENCE_MISMATCH 0x80
#define RFAT_LDIR_SEQUENCE_FIRST 0x40
#define RFAT_LDIR_SEQUENCE_LAST 0x20
#define RFAT_LDIR_SEQUENCE_INDEX 0x1f
typedef int (*rfat_find_callback_t)(rfat_volume_t *volume, void *private, rfat_dir_t *dir, unsigned sequence);
#if (RFAT_CONFIG_UTF8_SUPPORTED == 0)
typedef uint8_t rfat_unicode_t;
#else /* (RFAT_CONFIG_UTF8_SUPPORTED == 0) */
typedef uint16_t rfat_unicode_t;
#endif /* (RFAT_CONFIG_UTF8_SUPPORTED == 0) */
#endif /* (RFAT_CONFIG_VFAT_SUPPORTED == 0) */
#define FALSE 0
#define TRUE 1
#if !defined(NULL)
#define NULL ((void*)0)
#endif
#define RFAT_CT_ASSERT(_c) ((void)sizeof(char[1-(2*!(_c))]))
#define RFAT_CLSNO_NONE 0x00000000u
#define RFAT_CLSNO_FREE 0x00000000u
#define RFAT_CLSNO_FREE_RESERVED 0x00000001u
#define RFAT_CLSNO_LAST 0x0ffffff8u
#define RFAT_CLSNO_END_OF_CHAIN 0x0fffffffu
#define RFAT_CLSNO_RESERVED12 0x00000ff6u
#define RFAT_CLSNO_RESERVED16 0x0000fff6u
#define RFAT_CLSNO_RESERVED32 0x0ffffff6u
#define RFAT_FILE_SIZE_MAX 0xffffffffu
#define RFAT_DIR_SIZE 32
#define RFAT_DIR_MASK 31
#define RFAT_DIR_SHIFT 5
#define RFAT_BLKNO_RESERVED 0xfffffffe /* internal only, will fail to read/write */
#define RFAT_BLKNO_INVALID 0xffffffff /* internal only, will fail to read/write */
#define RFAT_HTOFS(_data) (_data)
#define RFAT_HTOFL(_data) (_data)
#define RFAT_FTOHS(_data) (_data)
#define RFAT_FTOHL(_data) (_data)
#define RFAT_DIR_ATTR_READ_ONLY 0x01
#define RFAT_DIR_ATTR_HIDDEN 0x02
#define RFAT_DIR_ATTR_SYSTEM 0x04
#define RFAT_DIR_ATTR_VOLUME_ID 0x08
#define RFAT_DIR_ATTR_DIRECTORY 0x10
#define RFAT_DIR_ATTR_ARCHIVE 0x20
#define RFAT_DIR_ATTR_LONG_NAME 0x0f
#define RFAT_DIR_ATTR_LONG_NAME_MASK 0x3f
#define RFAT_DIR_TYPE_LOSSY 0x01 /* internal only */
#define RFAT_DIR_TYPE_UCASE_NAME 0x02 /* internal only */
#define RFAT_DIR_TYPE_UCASE_EXT 0x04 /* internal only */
#define RFAT_DIR_TYPE_LCASE_NAME 0x08
#define RFAT_DIR_TYPE_LCASE_EXT 0x10
struct _rfat_dir_t {
uint8_t dir_name[11];
uint8_t dir_attr;
uint8_t dir_nt_reserved;
uint8_t dir_crt_time_tenth;
uint16_t dir_crt_time;
uint16_t dir_crt_date;
uint16_t dir_acc_date;
uint16_t dir_clsno_hi;
uint16_t dir_wrt_time;
uint16_t dir_wrt_date;
uint16_t dir_clsno_lo;
uint32_t dir_file_size;
};
/* The spec says that a valid entry need to have ldir_ord valid,
* and unused bits set to 0x00 ((ldir_ord & 0xa0) == 0x00).
* It states furthermore that ldor_type needs to be 0x00, and
* that other values are reserved for future use. Also it
* states that for compatibility reasons ldir_clsno_lo needs
* to be 0x0000. The ldir entries need to be in reverse sequences,
* from 31 to 1, whereby the first entry has 0x40 set to indicate
* the start of a sequence. ldir_chksum needs to be identical for
* all entries, and need to match the computed value for the
* dir->dir_name.
*/
#define RFAT_LAST_LONG_ENTRY 0x40
#define RFAT_LONG_ENTRY_MASK 0x1f
#define RFAT_LONG_ENTRY_TYPE 0x00
struct _rfat_ldir_t {
uint8_t ldir_ord;
uint8_t ldir_name_1[10];
uint8_t ldir_attr;
uint8_t ldir_type;
uint8_t ldir_chksum;
uint8_t ldir_name_2[12];
uint16_t ldir_clsno_lo;
uint8_t ldir_name_3[4];
};
union _rfat_boot_t {
struct __attribute__((packed)) {
uint8_t bs_reserved_1[510];
uint16_t bs_trail_sig; /* 0xaa55 */
} bs;
struct __attribute__((packed)) {
uint8_t bs_reserved_1[446];
struct __attribute__((packed)) {
uint8_t mbr_boot_ind;
uint8_t mbr_start_chs[3];
uint8_t mbr_sys_id;
uint8_t mbr_end_chs[3];
uint32_t mbr_rel_sec;
uint32_t mbr_tot_sec;
} mbr_par_table[4];
uint16_t bs_trail_sig; /* 0xaa55 */
} mbr;
struct __attribute__((packed)) {
uint8_t bs_jmp_boot[3];
uint8_t bs_oem_name[8];
uint16_t bpb_byts_per_sec;
uint8_t bpb_sec_per_clus;
uint16_t bpb_rsvd_sec_cnt;
uint8_t bpb_num_fats;
uint16_t bpb_root_ent_cnt;
uint16_t bpb_tot_sec_16;
uint8_t bpb_media;
uint16_t bpb_fat_sz_16;
uint16_t bpb_sec_per_trk;
uint16_t bpb_num_heads;
uint32_t bpb_hidd_sec_16;
uint8_t bs_reserved_1[478];
uint16_t bs_trail_sig; /* 0xaa55 */
} bpb;
struct __attribute__((packed)) {
uint8_t bs_jmp_boot[3];
uint8_t bs_oem_name[8];
uint16_t bpb_byts_per_sec;
uint8_t bpb_sec_per_clus;
uint16_t bpb_rsvd_sec_cnt;
uint8_t bpb_num_fats;
uint16_t bpb_root_ent_cnt;
uint16_t bpb_tot_sec_16;
uint8_t bpb_media;
uint16_t bpb_fat_sz_16;
uint16_t bpb_sec_per_trk;
uint16_t bpb_num_heads;
uint32_t bpb_hidd_sec_32;
uint32_t bpb_tot_sec_32;
uint8_t bs_drv_num;
uint8_t bs_nt_reserved;
uint8_t bs_boot_sig;
uint32_t bs_vol_id;
uint8_t bs_vol_lab[11];
uint8_t bs_fil_sys_type[8];
uint8_t bs_reserved_1[448];
uint16_t bs_trail_sig; /* 0xaa55 */
} bpb40;
struct __attribute__((packed)) {
uint8_t bs_jmp_boot[3];
uint8_t bs_oem_name[8];
uint16_t bpb_byts_per_sec;
uint8_t bpb_sec_per_clus;
uint16_t bpb_rsvd_sec_cnt;
uint8_t bpb_num_fats;
uint16_t bpb_root_ent_cnt;
uint16_t bpb_tot_sec_16;
uint8_t bpb_media;
uint16_t bpb_fat_sz_16;
uint16_t bpb_sec_per_trk;
uint16_t bpb_num_heads;
uint32_t bpb_hidd_sec_32;
uint32_t bpb_tot_sec_32;
uint32_t bpb_fat_sz_32;
uint16_t bpb_ext_flags;
uint16_t bpb_fs_ver;
uint32_t bpb_root_clus;
uint16_t bpb_fsinfo;
uint16_t bpb_bkboot;
uint8_t bs_reserved_1[12];
uint8_t bs_drv_num;
uint8_t bs_nt_reserved;
uint8_t bs_boot_sig;
uint32_t bs_vol_id;
uint8_t bs_vol_lab[11];
uint8_t bs_fil_sys_type[8];
uint8_t bs_reserved_2[420];
uint16_t bs_trail_sig; /* 0xaa55 */
} bpb71;
struct __attribute__((packed)) {
uint8_t bs_jmp_boot[3];
uint8_t bs_oem_name[8];
uint8_t bs_reserved_1[79];
uint8_t log_map_flags;
uint8_t log_map_entries;
uint32_t log_map_table[16]; /* hardcoded, uint32_t for FAT12/FAT16 map */
uint32_t log_map_blkno;
uint32_t log_lead_sig; /* 0x52444154 ("RFAT") */
uint32_t log_free_clscnt;
uint32_t log_next_clsno;
rfat_dir_t log_dir;
uint8_t log_dir_flags;
uint8_t log_dir_entries;
uint16_t log_dir_index;
uint32_t log_dir_clsno;
uint32_t log_dot_clsno;
uint32_t log_struct_sig; /* 0x45563031 ("EV01") */
uint32_t log_del_clsno;
uint16_t log_del_index;
uint8_t log_del_entries;
uint8_t log_lfn_count;
uint32_t log_lfn_blkno;
uint8_t log_lfn_name[256];
uint8_t bs_reserved_2[22];
uint16_t bs_trail_sig; /* 0xaa55 */
} bpblog;
uint32_t __align__[128];
};
struct _rfat_fsinfo_t {
uint32_t fsi_lead_sig; /* 0x41615252 */
uint8_t fsi_reserved_1[480];
uint32_t fsi_struc_sig; /* 0x61417272 */
uint32_t fsi_free_count;
uint32_t fsi_nxt_free;
uint8_t fsi_reserved_2[12];
uint32_t fsi_trail_sig; /* 0xaa550000 */
};
struct _rfat_cache_entry_t {
uint32_t blkno;
uint8_t *data;
};
#if (RFAT_CONFIG_TRANSACTION_SAFE_SUPPORTED == 1)
#define RFAT_MAP_FLAG_MAP_0_CHANGED 0x01
#define RFAT_MAP_FLAG_MAP_1_CHANGED 0x02
#define RFAT_MAP_FLAG_MAP_CHANGED 0x03
#define RFAT_MAP_FLAG_MAP_DIRTY 0x04
#define RFAT_MAP_FLAG_MAP_FSINFO 0x08
#define RFAT_MAP_TABLE_ENTRIES 32
#define RFAT_MAP_TABLE_OVERFLOW 255
#define RFAT_DIR_FLAG_SYNC_ENTRY 0x01
#define RFAT_DIR_FLAG_ACCESS_ENTRY 0x02
#define RFAT_DIR_FLAG_MODIFY_ENTRY 0x04
#define RFAT_DIR_FLAG_DESTROY_ENTRY 0x08
#define RFAT_DIR_FLAG_CREATE_ENTRY 0x10
#define RFAT_LOG_LEAD_SIG 0x52444154 /* "RFAT" */
#define RFAT_LOG_STRUCT_SIG 0x45563031 /* "EV01" */
#endif /* (RFAT_CONFIG_TRANSACTION_SAFE_SUPPORTED == 1) */
#define RFAT_FILE_MODE_READ 0x01
#define RFAT_FILE_MODE_WRITE 0x02
#define RFAT_FILE_MODE_APPEND 0x04
#define RFAT_FILE_MODE_CREATE 0x08
#define RFAT_FILE_MODE_TRUNCATE 0x10
#define RFAT_FILE_MODE_COMMIT 0x20
#define RFAT_FILE_MODE_SEQUENTIAL 0x40
#define RFAT_FILE_MODE_RANDOM 0x80
#if (RFAT_CONFIG_FILE_DATA_CACHE == 1)
#if (RFAT_CONFIG_DATA_CACHE_ENTRIES != 0)
#define RFAT_FILE_FLAG_DATA_DIRTY 0x01
#endif /* (RFAT_CONFIG_DATA_CACHE_ENTRIES != 0) */
#endif /* (RFAT_CONFIG_FILE_DATA_CACHE == 1) */
#define RFAT_FILE_FLAG_DATA_MODIFIED 0x02
#define RFAT_FILE_FLAG_DIR_MODIFIED 0x04
#if (RFAT_CONFIG_CONTIGUOUS_SUPPORTED == 1)
#define RFAT_FILE_FLAG_CONTIGUOUS 0x40 /* contiguous cluster range to file->total_clscnt */
#endif /* (RFAT_CONFIG_CONTIGUOUS_SUPPORTED == 1) */
#define RFAT_FILE_FLAG_END_OF_CHAIN 0x80 /* END_OF_CHAIN seen */
struct _rfat_file_t {
uint8_t mode;
uint8_t flags;
volatile uint8_t status;
uint8_t reserved[3]; /* unused for now */
uint16_t dir_index; /* index within directory where primary dir entry resides */
uint32_t dir_clsno; /* clsno where primary dir entry resides */
uint32_t first_clsno; /* dir_clsno_hi/dir_clsno_lo from dir entry */
uint32_t last_clsno; /* clsno corresponding to file->length */
#if (RFAT_CONFIG_CONTIGUOUS_SUPPORTED == 1)
uint32_t size; /* size of reserved area */
#endif /* (RFAT_CONFIG_CONTIGUOUS_SUPPORTED == 1) */
uint32_t length; /* dir_file_size from dir entry */
uint32_t position;
uint32_t clsno;
uint32_t blkno;
uint32_t blkno_e; /* exclusive */
#if (RFAT_CONFIG_FILE_DATA_CACHE == 1)
#if (RFAT_CONFIG_DATA_CACHE_ENTRIES != 0)
rfat_cache_entry_t data_cache;
#endif /* (RFAT_CONFIG_DATA_CACHE_ENTRIES != 0) */
#endif /* (RFAT_CONFIG_FILE_DATA_CACHE == 1) */
};
#if (RFAT_CONFIG_CLUSTER_CACHE_ENTRIES != 0)
struct _rfat_cluster_entry_t {
uint32_t clsno;
uint32_t clsdata;
};
#endif /* (RFAT_CONFIG_CLUSTER_CACHE_ENTRIES != 0) */
#define RFAT_VOLUME_STATE_NONE 0
#define RFAT_VOLUME_STATE_INITIALIZED 1
#define RFAT_VOLUME_STATE_CARDREMOVED 2
#define RFAT_VOLUME_STATE_MOUNTED 3
#define RFAT_VOLUME_STATE_UNUSABLE 4
#define RFAT_VOLUME_TYPE_FAT12 0
#define RFAT_VOLUME_TYPE_FAT16 1
#define RFAT_VOLUME_TYPE_FAT32 2
#if (RFAT_CONFIG_FAT_CACHE_ENTRIES > 1)
#define RFAT_VOLUME_FLAG_FAT_INDEX_CURRENT 0x0001
#define RFAT_VOLUME_FLAG_FAT_0_CURRENT 0x0000
#define RFAT_VOLUME_FLAG_FAT_1_CURRENT 0x0001
#define RFAT_VOLUME_FLAG_FAT_0_DIRTY 0x0002
#define RFAT_VOLUME_FLAG_FAT_1_DIRTY 0x0004
#else /* (RFAT_CONFIG_FAT_CACHE_ENTRIES > 1) */
#define RFAT_VOLUME_FLAG_FAT_DIRTY 0x0002
#endif /* (RFAT_CONFIG_FAT_CACHE_ENTRIES > 1) */
#if (RFAT_CONFIG_FSINFO_SUPPORTED == 1)
#define RFAT_VOLUME_FLAG_FSINFO_DIRTY 0x0008
#define RFAT_VOLUME_FLAG_FSINFO_VALID 0x0010
#endif /* (RFAT_CONFIG_FSINFO_SUPPORTED == 1) */
#define RFAT_VOLUME_FLAG_VOLUME_DIRTY 0x0020
#define RFAT_VOLUME_FLAG_MEDIA_FAILURE 0x0040
#if (RFAT_CONFIG_VOLUME_DIRTY_SUPPORTED == 1)
#define RFAT_VOLUME_FLAG_MOUNTED_DIRTY 0x0080
#endif /* (RFAT_CONFIG_VOLUME_DIRTY_SUPPORTED == 1) */
#define RFAT_VOLUME_FLAG_WRITE_PROTECTED 0x0100
struct _rfat_volume_t {
uint8_t state;
uint8_t type;
uint16_t flags;
uint32_t product; /* product serial number */
uint32_t serial; /* volume serial number */
uint32_t boot_blkno;
uint16_t bkboot_blkofs;
uint16_t fsinfo_blkofs;
uint32_t fat_blkcnt;
uint32_t fat1_blkno; /* FAT to read/write from/to */
uint32_t fat2_blkno;
uint32_t root_clsno; /* FAT12/FAT16: 0, FAT32: root_clus */
uint32_t root_blkno; /* FAT32: root_clus mapped to blkno */
uint32_t root_blkcnt; /* FAT32: cluster size mapped to blkcnt */
uint32_t last_clsno; /* last valid cluster */
uint32_t cls_size; /* (1 << cls_shift) */
uint32_t cls_mask; /* (1 << cls_shift) -1 */
uint8_t cls_shift; /* shift to get the byte offset for a clsno (0x10 max) */
uint8_t cls_blk_shift; /* shift to get the blkno for a clsno (0x07 max)*/
uint8_t cls_blk_mask; /* (1 << cls_blk_shift) -1 (0x7f max) */
uint8_t cls_blk_size; /* (1 << cls_blk_shift) (0x80 max) */
int32_t cls_blk_offset; /* offset to get the blkno for a clsno */
rfat_cache_entry_t dir_cache;
#if (RFAT_CONFIG_TRANSACTION_SAFE_SUPPORTED == 1)
rfat_cache_entry_t map_cache;
#endif /* (RFAT_CONFIG_TRANSACTION_SAFE_SUPPORTED == 1) */
#if (RFAT_CONFIG_FAT_CACHE_ENTRIES != 0)
#if (RFAT_CONFIG_FAT_CACHE_ENTRIES == 1)
rfat_cache_entry_t fat_cache;
#else /* (RFAT_CONFIG_FAT_CACHE_ENTRIES == 1) */
rfat_cache_entry_t fat_cache[RFAT_CONFIG_FAT_CACHE_ENTRIES];
#endif /* (RFAT_CONFIG_FAT_CACHE_ENTRIES == 1) */
#endif /* (RFAT_CONFIG_FAT_CACHE_ENTRIES != 0) */
#if (RFAT_CONFIG_FILE_DATA_CACHE == 0)
rfat_file_t *data_file;
#if (RFAT_CONFIG_DATA_CACHE_ENTRIES != 0)
rfat_cache_entry_t data_cache;
#endif /* (RFAT_CONFIG_DATA_CACHE_ENTRIES != 0) */
#endif /* (RFAT_CONFIG_FILE_DATA_CACHE == 0) */
#if (RFAT_CONFIG_CLUSTER_CACHE_ENTRIES != 0)
rfat_cluster_entry_t cluster_cache[RFAT_CONFIG_CLUSTER_CACHE_ENTRIES];
#endif /* (RFAT_CONFIG_CLUSTER_CACHE_ENTRIES != 0) */
/* WORK AREA BELOW */
uint32_t cwd_clsno; /* put this first of the work area to align the rest */
#if (RFAT_CONFIG_SEQUENTIAL_SUPPORTED == 1) || (RFAT_CONFIG_CONTIGUOUS_SUPPORTED == 1)
uint32_t blk_unit_size; /* size to align a clsno to an AU */
uint32_t start_clsno; /* first valid cluster for sequential/contiguous allocation */
uint32_t end_clsno; /* last valid cluster for sequential/contiguous allocation */
#if (RFAT_CONFIG_SEQUENTIAL_SUPPORTED == 1)
uint32_t base_clsno; /* bottom clsno for next_clsno allocation unit (inclusive) */
uint32_t limit_clsno; /* top clsno for next_clsno allocation unit (exclusive) */
uint32_t free_clsno; /* first free clsno */
#endif /* (RFAT_CONFIG_SEQUENTIAL_SUPPORTED == 1) */
#endif /* (RFAT_CONFIG_SEQUENTIAL_SUPPORTED == 1) || (RFAT_CONFIG_CONTIGUOUS_SUPPORTED == 1) */
#if (RFAT_CONFIG_TRANSACTION_SAFE_SUPPORTED == 1)
uint8_t bs_data[90];
uint8_t map_flags;
uint8_t map_entries;
uint16_t map_table[RFAT_MAP_TABLE_ENTRIES];
uint32_t map_blkno;
uint32_t log_lead_sig; /* 0x52444154 ("RFAT") */
uint32_t free_clscnt;
uint32_t next_clsno;
rfat_dir_t dir;
uint8_t dir_flags;
uint8_t dir_entries;
uint16_t dir_index;
uint32_t dir_clsno;
uint32_t dot_clsno; /* reserved for f_move() */
uint32_t log_struct_sig; /* 0x45563031 ("EV01") */
uint32_t del_clsno;
uint16_t del_index;
uint8_t del_entries;
#if (RFAT_CONFIG_VFAT_SUPPORTED == 1)
uint8_t lfn_count;
uint32_t lfn_blkno;
#if (RFAT_CONFIG_UTF8_SUPPORTED == 0)
rfat_unicode_t lfn_name[256];
uint8_t bs_reserved_2[22];
uint16_t bs_trail_sig;
#else /* (RFAT_CONFIG_UTF8_SUPPORTED == 0) */
rfat_unicode_t lfn_name[255];
uint16_t bs_trail_sig;
#endif /* (RFAT_CONFIG_UTF8_SUPPORTED == 0) */
#else /* (RFAT_CONFIG_VFAT_SUPPORTED == 1) */
uint8_t bs_reserved_2[283];
uint16_t bs_trail_sig;
#endif /* (RFAT_CONFIG_VFAT_SUPPORTED == 1) */
#else /* (RFAT_CONFIG_TRANSACTION_SAFE_SUPPORTED == 1) */
#if (RFAT_CONFIG_VOLUME_DIRTY_SUPPORTED == 1)
uint8_t bs_data[90];
#endif /* (RFAT_CONFIG_VOLUME_DIRTY_SUPPORTED == 1) */
#if (RFAT_CONFIG_FSINFO_SUPPORTED == 1)
uint32_t free_clscnt;
#endif /* (RFAT_CONFIG_FSINFO_SUPPORTED == 1) */
uint32_t next_clsno;
rfat_dir_t dir;
#if (RFAT_CONFIG_VFAT_SUPPORTED == 1)
uint8_t dir_entries;
uint8_t lfn_count;
#if (RFAT_CONFIG_UTF8_SUPPORTED == 0)
rfat_unicode_t lfn_name[255];
#else /* (RFAT_CONFIG_UTF8_SUPPORTED == 0) */
rfat_unicode_t lfn_name[255];
#endif /* (RFAT_CONFIG_UTF8_SUPPORTED == 0) */
#endif /* (RFAT_CONFIG_VFAT_SUPPORTED == 1) */
#endif /* (RFAT_CONFIG_TRANSACTION_SAFE_SUPPORTED == 1) */
/* WORK AREA ABOVE */
rfat_disk_t *disk;
rfat_file_t file_table[RFAT_CONFIG_MAX_FILES];
#if (RFAT_CONFIG_STATISTICS == 1)
struct {
uint32_t fat_cache_hit;
uint32_t fat_cache_miss;
uint32_t fat_cache_read;
uint32_t fat_cache_write;
uint32_t fat_cache_flush;
uint32_t dir_cache_hit;
uint32_t dir_cache_miss;
uint32_t dir_cache_zero;
uint32_t dir_cache_read;
uint32_t dir_cache_write;
uint32_t data_cache_hit;
uint32_t data_cache_miss;
uint32_t data_cache_zero;
uint32_t data_cache_read;
uint32_t data_cache_write;
uint32_t data_cache_flush;
uint32_t data_cache_invalidate;
uint32_t cluster_cache_hit;
uint32_t cluster_cache_miss;
} statistics;
#endif /* (RFAT_CONFIG_STATISTICS == 1) */
};
/* The conversion from a linear offset/size to a clscnt is somewhat tricky.
* An offset is rounded down, while a size is rounded up. But rouding up
* a size close to RFAT_FILE_SIZE_MAX will overflow 32bit arithmatic. Hence
* the macro splits up away the bytes within a cluster and rounds them up
* separately.
*/
#define RFAT_OFFSET_TO_CLSCNT(_offset) ((_offset) >> volume->cls_shift)
#define RFAT_SIZE_TO_CLSCNT(_size) (((_size) >> volume->cls_shift) + ((((_size) & volume->cls_mask) + volume->cls_mask) >> volume->cls_shift))
/* Convert a clsno to a blkno
*/
#define RFAT_CLSNO_TO_BLKNO(_clsno) (volume->cls_blk_offset + ((_clsno) << volume->cls_blk_shift))
#define RFAT_CLSNO_TO_BLKNO_NEXT(_clsno) (RFAT_CLSNO_TO_BLKNO((_clsno)) + volume->cls_blk_size)
/* Convert a file offset to a blkcnt realtive to the start of a cluster.
*/
#define RFAT_OFFSET_TO_BLKCNT(_offset) (((_offset) >> RFAT_BLK_SHIFT) & volume->cls_blk_mask)
/* Convert a directory index to a blkcnt realtive to the start of a cluster.
*/
#define RFAT_INDEX_TO_BLKCNT(_index) (((_index) >> (RFAT_BLK_SHIFT - RFAT_DIR_SHIFT)) & volume->cls_blk_mask)
#define RFAT_INDEX_TO_BLKCNT_ROOT(_index) ((_index) >> (RFAT_BLK_SHIFT - RFAT_DIR_SHIFT))
/* Convert a directory index to a offset realtive to the start of a block.
*/
#define RFAT_INDEX_TO_BLKOFS(_index) (((_index) << RFAT_DIR_SHIFT) & RFAT_BLK_MASK)
#define RFAT_DEFAULT_VOLUME() (&rfat_volume)
#define RFAT_PATH_VOLUME(_path) (&rfat_volume)
#define RFAT_FIND_VOLUME(_find) (&rfat_volume)
#define RFAT_FILE_VOLUME(_file) (&rfat_volume)
#if (RFAT_CONFIG_STATISTICS == 1)
#define RFAT_VOLUME_STATISTICS_COUNT(_name) { volume->statistics._name += 1; }
#define RFAT_VOLUME_STATISTICS_COUNT_N(_name,_n) { volume->statistics._name += (_n); }
#else /* (RFAT_CONFIG_STATISTICS == 1) */
#define RFAT_VOLUME_STATISTICS_COUNT(_name) /**/
#define RFAT_VOLUME_STATISTICS_COUNT_N(_name,_n) /**/
#endif /* (RFAT_CONFIG_STATISTICS == 1) */
static int rfat_volume_init(rfat_volume_t *volume);
static int rfat_volume_mount(rfat_volume_t *volume);
static int rfat_volume_unmount(rfat_volume_t *volume);
static int rfat_volume_lock(rfat_volume_t *volume);
static int rfat_volume_lock_noinit(rfat_volume_t *volume);
static int rfat_volume_lock_nomount(rfat_volume_t *volume);
static int rfat_volume_unlock(rfat_volume_t *volume, int status);
static int rfat_volume_read(rfat_volume_t *volume, uint32_t address, uint8_t *data);
static int rfat_volume_write(rfat_volume_t *volume, uint32_t address, const uint8_t *data);
static int rfat_volume_zero(rfat_volume_t *volume, uint32_t address, uint32_t length, volatile uint8_t *p_status);
#if (RFAT_CONFIG_FSINFO_SUPPORTED == 1)
static int rfat_volume_fsinfo(rfat_volume_t *volume, uint32_t free_clscnt, uint32_t next_clsno);
#endif /* (RFAT_CONFIG_FSINFO_SUPPORTED == 1) */
#if (RFAT_CONFIG_TRANSACTION_SAFE_SUPPORTED == 0)
static int rfat_volume_dirty(rfat_volume_t *volume);
static int rfat_volume_clean(rfat_volume_t *volume, int status_o);
#else /* (RFAT_CONFIG_TRANSACTION_SAFE_SUPPORTED == 0) */
static int rfat_volume_record(rfat_volume_t *volume);
static int rfat_volume_commit(rfat_volume_t *volume);
#endif /* (RFAT_CONFIG_TRANSACTION_SAFE_SUPPORTED == 0) */
static int rfat_volume_format(rfat_volume_t *volume);
static int rfat_volume_erase(rfat_volume_t *volume);
static int rfat_dir_cache_write(rfat_volume_t *volume);
static int rfat_dir_cache_fill(rfat_volume_t *volume, uint32_t blkno, int zero);
static int rfat_dir_cache_read(rfat_volume_t *volume, uint32_t blkno, rfat_cache_entry_t **p_entry);
static int rfat_dir_cache_zero(rfat_volume_t *volume, uint32_t blkno, rfat_cache_entry_t **p_entry);
static int rfat_dir_cache_flush(rfat_volume_t *volume);
#if (RFAT_CONFIG_TRANSACTION_SAFE_SUPPORTED == 1)
static int rfat_map_cache_fill(rfat_volume_t *volume, uint32_t page);
static int rfat_map_cache_write(rfat_volume_t *volume, uint32_t blkno, const uint8_t *data);
static int rfat_map_cache_read(rfat_volume_t *volume, uint32_t blkno, uint8_t *data);
static int rfat_map_cache_flush(rfat_volume_t *volume);
static int rfat_map_cache_resolve(rfat_volume_t *volume);
#endif /* (RFAT_CONFIG_TRANSACTION_SAFE_SUPPORTED == 1) */
static int rfat_fat_cache_write(rfat_volume_t *volume, rfat_cache_entry_t *entry);
static int rfat_fat_cache_fill(rfat_volume_t *volume, uint32_t blkno, rfat_cache_entry_t **p_entry);
static int rfat_fat_cache_read(rfat_volume_t *volume, uint32_t blkno, rfat_cache_entry_t **p_entry);
static void rfat_fat_cache_modify(rfat_volume_t *volume, rfat_cache_entry_t *entry);
static int rfat_fat_cache_flush(rfat_volume_t *volume);
static int rfat_data_cache_write(rfat_volume_t *volume, rfat_file_t *file);
static int rfat_data_cache_fill(rfat_volume_t *volume, rfat_file_t *file, uint32_t blkno, int zero);
static int rfat_data_cache_read(rfat_volume_t *volume, rfat_file_t *file, uint32_t blkno, rfat_cache_entry_t ** p_entry);
static int rfat_data_cache_zero(rfat_volume_t *volume, rfat_file_t *file, uint32_t blkno, rfat_cache_entry_t ** p_entry);
static void rfat_data_cache_modify(rfat_volume_t *volume, rfat_file_t *file);
static int rfat_data_cache_flush(rfat_volume_t *volume, rfat_file_t *file);
static int rfat_cluster_read_uncached(rfat_volume_t *volume, uint32_t clsno, uint32_t *p_clsdata);
static int rfat_cluster_read(rfat_volume_t *volume, uint32_t clsno, uint32_t *p_clsdata);
static int rfat_cluster_write(rfat_volume_t *volume, uint32_t clsno, uint32_t clsdata, int allocate);
static int rfat_cluster_chain_seek(rfat_volume_t *volume, uint32_t clsno, uint32_t clscnt, uint32_t *p_clsno);
static int rfat_cluster_chain_create(rfat_volume_t *volume, uint32_t clsno, uint32_t clscnt, uint32_t *p_clsno_a, uint32_t *p_clsno_l);
#if (RFAT_CONFIG_SEQUENTIAL_SUPPORTED == 1)
static int rfat_cluster_chain_create_sequential(rfat_volume_t *volume, uint32_t clsno, uint32_t clscnt, uint32_t *p_clsno_a, uint32_t *p_clsno_l);
#endif /* (RFAT_CONFIG_SEQUENTIAL_SUPPORTED == 1) */
#if (RFAT_CONFIG_CONTIGUOUS_SUPPORTED == 1)
static int rfat_cluster_chain_create_contiguous(rfat_volume_t *volume, uint32_t clscnt, uint32_t *p_clsno_a);
#endif /* (RFAT_CONFIG_CONTIGUOUS_SUPPORTED == 1) */
static int rfat_cluster_chain_destroy(rfat_volume_t *volume, uint32_t clsno, uint32_t clsdata);
static unsigned int rfat_name_ascii_upcase(unsigned int cc);
#if (RFAT_CONFIG_VFAT_SUPPORTED == 0)
static const char *rfat_name_cstring_to_dosname(const char *cstring, uint8_t *dosname);
static const char *rfat_name_cstring_to_pattern(const char *cstring, char *pattern);
#endif /* (RFAT_CONFIG_VFAT_SUPPORTED == 0) */
static const char *rfat_name_cstring_to_label(const char *cstring, uint8_t *label);
static char *rfat_name_dosname_to_cstring(const uint8_t *dosname, unsigned int doscase, char *cstring, char *cstring_e);
static char *rfat_name_label_to_cstring(const uint8_t *label, char *cstring, char *cstring_e);
#if (RFAT_CONFIG_VFAT_SUPPORTED == 1)
#if (RFAT_CONFIG_UTF8_SUPPORTED == 1)
static unsigned int rfat_name_cstring_to_unicode(const char *cstring, const char **p_cstring);
static char * rfat_name_unicode_to_cstring(unsigned int cc, char *cstring, char *cstring_e);
static unsigned int rfat_name_unicode_upcase(unsigned int cc);
#endif /* (RFAT_CONFIG_UTF8_SUPPORTED == 1) */
static const char *rfat_name_cstring_to_uniname(const char *cstring, rfat_unicode_t *uniname, uint8_t *p_unicount, uint8_t *dosname, uint8_t *p_doscase);
static char *rfat_name_uniname_to_cstring(const rfat_unicode_t *uniname, unsigned int unicount, char *cstring, char *cstring_e);
static void rfat_name_uniname_to_dosname(const rfat_unicode_t *uniname, unsigned int unicount, uint8_t *dosname, unsigned int *p_dosprefix);
static uint8_t rfat_name_checksum_dosname(const uint8_t *dosname);
static uint16_t rfat_name_checksum_uniname(const rfat_unicode_t *uniname, unsigned int unicount);
#endif /* (RFAT_CONFIG_VFAT_SUPPORTED == 1) */
static int rfat_path_convert_filename(rfat_volume_t *volume, const char *filename, const char **p_filename);
static int rfat_path_find_entry(rfat_volume_t *volume, uint32_t clsno, uint32_t index, uint32_t count, rfat_find_callback_t callback, void *private, uint32_t *p_clsno, uint32_t *p_index, rfat_dir_t **p_dir);
static int rfat_path_find_directory(rfat_volume_t *volume, const char *filename, const char **p_filename, uint32_t *p_clsno);
static int rfat_path_find_file(rfat_volume_t *volume, const char *filename, uint32_t *p_clsno, uint32_t *p_index, rfat_dir_t **p_dir);
static int rfat_path_find_next(rfat_volume_t *volume, F_FIND *find);
static void rfat_path_setup_entry(rfat_volume_t *volume, const char *dosname, uint8_t attr, uint32_t first_clsno, uint16_t ctime, uint16_t cdate, rfat_dir_t *dir);
static int rfat_path_create_entry(rfat_volume_t *volume, uint32_t clsno_d, uint32_t clsno, uint32_t index, const char *dosname, uint8_t attr, uint32_t first_clsno, uint16_t ctime, uint16_t cdate);
#if (RFAT_CONFIG_VFAT_SUPPORTED == 1)
static int rfat_path_destroy_entry(rfat_volume_t *volume, uint32_t clsno, uint32_t index, uint32_t entries, uint32_t first_clsno);
#else /* (RFAT_CONFIG_VFAT_SUPPORTED == 1) */
static int rfat_path_destroy_entry(rfat_volume_t *volume, uint32_t clsno, uint32_t index, uint32_t first_clsno);
#endif /* (RFAT_CONFIG_VFAT_SUPPORTED == 1) */
static rfat_file_t *rfat_file_enumerate(rfat_volume_t *volume, rfat_file_t *file, uint32_t clsno, uint32_t index);
static int rfat_file_sync(rfat_volume_t *volume, rfat_file_t *file, int access, int modify, uint32_t first_clsno, uint32_t length);
static int rfat_file_flush(rfat_volume_t *volume, rfat_file_t *file, int close);
static int rfat_file_seek(rfat_volume_t *volume, rfat_file_t *file, uint32_t position);
static int rfat_file_shrink(rfat_volume_t *volume, rfat_file_t *file);
static int rfat_file_extend(rfat_volume_t *volume, rfat_file_t *file, uint32_t length);
#if (RFAT_CONFIG_CONTIGUOUS_SUPPORTED == 1)
static int rfat_file_reserve(rfat_volume_t *volume, rfat_file_t *file, uint32_t size);
#endif /* (RFAT_CONFIG_CONTIGUOUS_SUPPORTED == 1) */
static int rfat_file_open(rfat_volume_t *volume, const char *filename, uint32_t mode, uint32_t size, rfat_file_t **p_file);
static int rfat_file_close(rfat_volume_t *volume, rfat_file_t *file);
static int rfat_file_read(rfat_volume_t *volume, rfat_file_t *file, uint8_t *data, uint32_t count, uint32_t *p_count);
static int rfat_file_write(rfat_volume_t *volume, rfat_file_t *file, const uint8_t *data, uint32_t count, uint32_t *p_count);
#endif /* _RFAT_CORE_H */