aboutsummaryrefslogtreecommitdiff
path: root/fs/exfat/exfat.h
blob: a37f4b154066d1f6862c6ca8108b7c4a710225a4 (plain)
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
/*
 *  Copyright (C) 2012-2013 Samsung Electronics Co., Ltd.
 *
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU General Public License
 *  as published by the Free Software Foundation; either version 2
 *  of the License, or (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

/************************************************************************/
/*                                                                      */
/*  PROJECT : exFAT & FAT12/16/32 File System                           */
/*  FILE    : exfat.h                                                   */
/*  PURPOSE : Header File for exFAT File Manager                        */
/*                                                                      */
/*----------------------------------------------------------------------*/
/*  NOTES                                                               */
/*                                                                      */
/*----------------------------------------------------------------------*/
/*  REVISION HISTORY (Ver 0.9)                                          */
/*                                                                      */
/*  - 2010.11.15 [Joosun Hahn] : first writing                          */
/*                                                                      */
/************************************************************************/

#ifndef _EXFAT_H
#define _EXFAT_H

#include "exfat_config.h"
#include "exfat_global.h"
#include "exfat_data.h"
#include "exfat_oal.h"

#include "exfat_blkdev.h"
#include "exfat_cache.h"
#include "exfat_nls.h"
#include "exfat_api.h"
#include "exfat_cache.h"

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

#if EXFAT_CONFIG_KERNEL_DEBUG
  /* For Debugging Purpose */
	/* IOCTL code 'f' used by
	 *   - file systems typically #0~0x1F
	 *   - embedded terminal devices #128~
	 *   - exts for debugging purpose #99
	 * number 100 and 101 is availble now but has possible conflicts
	 */
#define EXFAT_IOC_GET_DEBUGFLAGS       _IOR('f', 100, long)
#define EXFAT_IOC_SET_DEBUGFLAGS       _IOW('f', 101, long)

#define EXFAT_DEBUGFLAGS_INVALID_UMOUNT        0x01
#define EXFAT_DEBUGFLAGS_ERROR_RW              0x02
#endif /* EXFAT_CONFIG_KERNEL_DEBUG */

	/*----------------------------------------------------------------------*/
	/*  Constant & Macro Definitions                                        */
	/*----------------------------------------------------------------------*/

#define MAX_VOLUME              4           // max num of volumes per device

#define DENTRY_SIZE             32          // dir entry size
#define DENTRY_SIZE_BITS        5

	/* PBR entries */
#define PBR_SIGNATURE           0xAA55
#define EXT_SIGNATURE           0xAA550000
#define VOL_LABEL               "NO NAME    " // size should be 11
#define OEM_NAME                "MSWIN4.1"  // size should be 8
#define STR_FAT12               "FAT12   "  // size should be 8
#define STR_FAT16               "FAT16   "  // size should be 8
#define STR_FAT32               "FAT32   "  // size should be 8
#define STR_EXFAT               "EXFAT   "  // size should be 8
#define VOL_CLEAN               0x0000
#define VOL_DIRTY               0x0002

	/* max number of clusters */
#define FAT12_THRESHOLD         4087        // 2^12 - 1 + 2 (clu 0 & 1)
#define FAT16_THRESHOLD         65527       // 2^16 - 1 + 2
#define FAT32_THRESHOLD         268435457   // 2^28 - 1 + 2
#define EXFAT_THRESHOLD         268435457   // 2^28 - 1 + 2

	/* file types */
#define TYPE_UNUSED             0x0000
#define TYPE_DELETED            0x0001
#define TYPE_INVALID            0x0002
#define TYPE_CRITICAL_PRI       0x0100
#define TYPE_BITMAP             0x0101
#define TYPE_UPCASE             0x0102
#define TYPE_VOLUME             0x0103
#define TYPE_DIR                0x0104
#define TYPE_FILE               0x011F
#define TYPE_SYMLINK            0x015F
#define TYPE_CRITICAL_SEC       0x0200
#define TYPE_STREAM             0x0201
#define TYPE_EXTEND             0x0202
#define TYPE_ACL                0x0203
#define TYPE_BENIGN_PRI         0x0400
#define TYPE_GUID               0x0401
#define TYPE_PADDING            0x0402
#define TYPE_ACLTAB             0x0403
#define TYPE_BENIGN_SEC         0x0800
#define TYPE_ALL                0x0FFF

	/* time modes */
#define TM_CREATE               0
#define TM_MODIFY               1
#define TM_ACCESS               2

	/* checksum types */
#define CS_DIR_ENTRY            0
#define CS_PBR_SECTOR           1
#define CS_DEFAULT              2

#define CLUSTER_16(x)           ((UINT16)(x))
#define CLUSTER_32(x)           ((UINT32)(x))

#define START_SECTOR(x) \
        ( (((x)-2) << p_fs->sectors_per_clu_bits) + p_fs->data_start_sector )

#define IS_LAST_SECTOR_IN_CLUSTER(sec) \
		( (((sec) -  p_fs->data_start_sector + 1) & ((1 <<  p_fs->sectors_per_clu_bits) -1)) == 0)

#define GET_CLUSTER_FROM_SECTOR(sec)			\
		((((sec) -  p_fs->data_start_sector) >> p_fs->sectors_per_clu_bits) +2)

#define GET16(p_src) \
        ( ((UINT16)(p_src)[0]) | (((UINT16)(p_src)[1]) << 8) )
#define GET32(p_src) \
        ( ((UINT32)(p_src)[0]) | (((UINT32)(p_src)[1]) << 8) | \
         (((UINT32)(p_src)[2]) << 16) | (((UINT32)(p_src)[3]) << 24) )
#define GET64(p_src) \
        ( ((UINT64)(p_src)[0]) | (((UINT64)(p_src)[1]) << 8) | \
         (((UINT64)(p_src)[2]) << 16) | (((UINT64)(p_src)[3]) << 24) | \
         (((UINT64)(p_src)[4]) << 32) | (((UINT64)(p_src)[5]) << 40) | \
         (((UINT64)(p_src)[6]) << 48) | (((UINT64)(p_src)[7]) << 56) )


#define SET16(p_dst,src)                                  \
        do {                                              \
            (p_dst)[0]=(UINT8)(src);                      \
            (p_dst)[1]=(UINT8)(((UINT16)(src)) >> 8);     \
        } while (0)
#define SET32(p_dst,src)                                  \
        do {                                              \
            (p_dst)[0]=(UINT8)(src);                      \
            (p_dst)[1]=(UINT8)(((UINT32)(src)) >> 8);     \
            (p_dst)[2]=(UINT8)(((UINT32)(src)) >> 16);    \
            (p_dst)[3]=(UINT8)(((UINT32)(src)) >> 24);    \
        } while (0)
#define SET64(p_dst,src)                                  \
        do {                                              \
            (p_dst)[0]=(UINT8)(src);                      \
            (p_dst)[1]=(UINT8)(((UINT64)(src)) >> 8);     \
            (p_dst)[2]=(UINT8)(((UINT64)(src)) >> 16);    \
            (p_dst)[3]=(UINT8)(((UINT64)(src)) >> 24);    \
            (p_dst)[4]=(UINT8)(((UINT64)(src)) >> 32);    \
            (p_dst)[5]=(UINT8)(((UINT64)(src)) >> 40);    \
            (p_dst)[6]=(UINT8)(((UINT64)(src)) >> 48);    \
            (p_dst)[7]=(UINT8)(((UINT64)(src)) >> 56);    \
        } while (0)

#ifdef __LITTLE_ENDIAN
#define GET16_A(p_src)          (*((UINT16 *)(p_src)))
#define GET32_A(p_src)          (*((UINT32 *)(p_src)))
#define GET64_A(p_src)          (*((UINT64 *)(p_src)))
#define SET16_A(p_dst,src)      *((UINT16 *)(p_dst)) = (UINT16)(src)
#define SET32_A(p_dst,src)      *((UINT32 *)(p_dst)) = (UINT32)(src)
#define SET64_A(p_dst,src)      *((UINT64 *)(p_dst)) = (UINT64)(src)
#else
#define GET16_A(p_src)          GET16(p_src)
#define GET32_A(p_src)          GET32(p_src)
#define GET64_A(p_src)          GET64(p_src)
#define SET16_A(p_dst,src)      SET16(p_dst, src)
#define SET32_A(p_dst,src)      SET32(p_dst, src)
#define SET64_A(p_dst,src)      SET64(p_dst, src)
#endif

	/* Upcase tabel mecro */
#define HIGH_INDEX_BIT (8)
#define HIGH_INDEX_MASK (0xFF00)
#define LOW_INDEX_BIT (16-HIGH_INDEX_BIT)
#define UTBL_ROW_COUNT (1<<LOW_INDEX_BIT)
#define UTBL_COL_COUNT (1<<HIGH_INDEX_BIT)

	static inline UINT16 get_col_index(UINT16 i)
	{
		return i >> LOW_INDEX_BIT;
	}
	static inline UINT16 get_row_index(UINT16 i)
	{
		return i & ~HIGH_INDEX_MASK;
	}
	/*----------------------------------------------------------------------*/
	/*  Type Definitions                                                    */
	/*----------------------------------------------------------------------*/

	/* MS_DOS FAT partition boot record (512 bytes) */
	typedef struct {
		UINT8       jmp_boot[3];
		UINT8       oem_name[8];
		UINT8       bpb[109];
		UINT8       boot_code[390];
		UINT8       signature[2];
	} PBR_SECTOR_T;

	/* MS-DOS FAT12/16 BIOS parameter block (51 bytes) */
	typedef struct {
		UINT8       sector_size[2];
		UINT8       sectors_per_clu;
		UINT8       num_reserved[2];
		UINT8       num_fats;
		UINT8       num_root_entries[2];
		UINT8       num_sectors[2];
		UINT8       media_type;
		UINT8       num_fat_sectors[2];
		UINT8       sectors_in_track[2];
		UINT8       num_heads[2];
		UINT8       num_hid_sectors[4];
		UINT8       num_huge_sectors[4];

		UINT8       phy_drv_no;
		UINT8       reserved;
		UINT8       ext_signature;
		UINT8       vol_serial[4];
		UINT8       vol_label[11];
		UINT8       vol_type[8];
	} BPB16_T;

	/* MS-DOS FAT32 BIOS parameter block (79 bytes) */
	typedef struct {
		UINT8       sector_size[2];
		UINT8       sectors_per_clu;
		UINT8       num_reserved[2];
		UINT8       num_fats;
		UINT8       num_root_entries[2];
		UINT8       num_sectors[2];
		UINT8       media_type;
		UINT8       num_fat_sectors[2];
		UINT8       sectors_in_track[2];
		UINT8       num_heads[2];
		UINT8       num_hid_sectors[4];
		UINT8       num_huge_sectors[4];
		UINT8       num_fat32_sectors[4];
		UINT8       ext_flags[2];
		UINT8       fs_version[2];
		UINT8       root_cluster[4];
		UINT8       fsinfo_sector[2];
		UINT8       backup_sector[2];
		UINT8       reserved[12];

		UINT8       phy_drv_no;
		UINT8       ext_reserved;
		UINT8       ext_signature;
		UINT8       vol_serial[4];
		UINT8       vol_label[11];
		UINT8       vol_type[8];
	} BPB32_T;

	/* MS-DOS EXFAT BIOS parameter block (109 bytes) */
	typedef struct {
		UINT8       reserved1[53];
		UINT8       vol_offset[8];
		UINT8       vol_length[8];
		UINT8       fat_offset[4];
		UINT8       fat_length[4];
		UINT8       clu_offset[4];
		UINT8       clu_count[4];
		UINT8       root_cluster[4];
		UINT8       vol_serial[4];
		UINT8       fs_version[2];
		UINT8       vol_flags[2];
		UINT8       sector_size_bits;
		UINT8       sectors_per_clu_bits;
		UINT8       num_fats;
		UINT8       phy_drv_no;
		UINT8       perc_in_use;
		UINT8       reserved2[7];
	} BPBEX_T;

	/* MS-DOS FAT file system information sector (512 bytes) */
	typedef struct {
		UINT8       signature1[4];              // aligned
		UINT8       reserved1[480];
		UINT8       signature2[4];              // aligned
		UINT8       free_cluster[4];            // aligned
		UINT8       next_cluster[4];            // aligned
		UINT8       reserved2[14];
		UINT8       signature3[2];
	} FSI_SECTOR_T;

	/* MS-DOS FAT directory entry (32 bytes) */
	typedef struct {
		UINT8       dummy[32];
	} DENTRY_T;

	typedef struct {
		UINT8       name[DOS_NAME_LENGTH];
		UINT8       attr;
		UINT8       lcase;
		UINT8       create_time_ms;
		UINT8       create_time[2];             // aligned
		UINT8       create_date[2];             // aligned
		UINT8       access_date[2];             // aligned
		UINT8       start_clu_hi[2];            // aligned
		UINT8       modify_time[2];             // aligned
		UINT8       modify_date[2];             // aligned
		UINT8       start_clu_lo[2];            // aligned
		UINT8       size[4];                    // aligned
	} DOS_DENTRY_T;

	/* MS-DOS FAT extended directory entry (32 bytes) */
	typedef struct {
		UINT8       order;
		UINT8       unicode_0_4[10];
		UINT8       attr;
		UINT8       sysid;
		UINT8       checksum;
		UINT8       unicode_5_10[12];           // aligned
		UINT8       start_clu[2];               // aligned
		UINT8       unicode_11_12[4];           // aligned
	} EXT_DENTRY_T;

	/* MS-DOS EXFAT file directory entry (32 bytes) */
	typedef struct {
		UINT8       type;
		UINT8       num_ext;
		UINT8       checksum[2];                // aligned
		UINT8       attr[2];                    // aligned
		UINT8       reserved1[2];
		UINT8       create_time[2];             // aligned
		UINT8       create_date[2];             // aligned
		UINT8       modify_time[2];             // aligned
		UINT8       modify_date[2];             // aligned
		UINT8       access_time[2];             // aligned
		UINT8       access_date[2];             // aligned
		UINT8       create_time_ms;
		UINT8       modify_time_ms;
		UINT8       access_time_ms;
		UINT8       reserved2[9];
	} FILE_DENTRY_T;

	/* MS-DOS EXFAT stream extension directory entry (32 bytes) */
	typedef struct {
		UINT8       type;
		UINT8       flags;
		UINT8       reserved1;
		UINT8       name_len;
		UINT8       name_hash[2];               // aligned
		UINT8       reserved2[2];
		UINT8       valid_size[8];              // aligned
		UINT8       reserved3[4];               // aligned
		UINT8       start_clu[4];               // aligned
		UINT8       size[8];                    // aligned
	} STRM_DENTRY_T;

	/* MS-DOS EXFAT file name directory entry (32 bytes) */
	typedef struct {
		UINT8       type;
		UINT8       flags;
		UINT8       unicode_0_14[30];           // aligned
	} NAME_DENTRY_T;

	/* MS-DOS EXFAT allocation bitmap directory entry (32 bytes) */
	typedef struct {
		UINT8       type;
		UINT8       flags;
		UINT8       reserved[18];
		UINT8       start_clu[4];               // aligned
		UINT8       size[8];                    // aligned
	} BMAP_DENTRY_T;

	/* MS-DOS EXFAT up-case table directory entry (32 bytes) */
	typedef struct {
		UINT8       type;
		UINT8       reserved1[3];
		UINT8       checksum[4];                // aligned
		UINT8       reserved2[12];
		UINT8       start_clu[4];               // aligned
		UINT8       size[8];                    // aligned
	} CASE_DENTRY_T;

	/* MS-DOS EXFAT volume label directory entry (32 bytes) */
	typedef struct {
		UINT8       type;
		UINT8       label_len;
		UINT8       unicode_0_10[22];           // aligned
		UINT8       reserved[8];
	} VOLM_DENTRY_T;

	/* unused entry hint information */
	typedef struct {
		UINT32      dir;
		INT32       entry;
		CHAIN_T     clu;
	} UENTRY_T;

	/* file system volume information structure */
	typedef struct __FS_STRUCT_T {
		UINT32      mounted;
		struct super_block *sb;
		struct semaphore v_sem;
	} FS_STRUCT_T;

	typedef struct {
		INT32       (*alloc_cluster)(struct super_block *sb, INT32 num_alloc, CHAIN_T *p_chain);
		void        (*free_cluster)(struct super_block *sb, CHAIN_T *p_chain, INT32 do_relse);
		INT32       (*count_used_clusters)(struct super_block *sb);

		INT32      (*init_dir_entry)(struct super_block *sb, CHAIN_T *p_dir, INT32 entry, UINT32 type,
									 UINT32 start_clu, UINT64 size);
		INT32      (*init_ext_entry)(struct super_block *sb, CHAIN_T *p_dir, INT32 entry, INT32 num_entries,
									 UNI_NAME_T *p_uniname, DOS_NAME_T *p_dosname);
		INT32       (*find_dir_entry)(struct super_block *sb, CHAIN_T *p_dir, UNI_NAME_T *p_uniname, INT32 num_entries, DOS_NAME_T *p_dosname, UINT32 type);
		void        (*delete_dir_entry)(struct super_block *sb, CHAIN_T *p_dir, INT32 entry, INT32 offset, INT32 num_entries);
		void        (*get_uni_name_from_ext_entry)(struct super_block *sb, CHAIN_T *p_dir, INT32 entry, UINT16 *uniname);
		INT32       (*count_ext_entries)(struct super_block *sb, CHAIN_T *p_dir, INT32 entry, DENTRY_T *p_entry);
		INT32       (*calc_num_entries)(UNI_NAME_T *p_uniname);

		UINT32      (*get_entry_type)(DENTRY_T *p_entry);
		void        (*set_entry_type)(DENTRY_T *p_entry, UINT32 type);
		UINT32      (*get_entry_attr)(DENTRY_T *p_entry);
		void        (*set_entry_attr)(DENTRY_T *p_entry, UINT32 attr);
		UINT8       (*get_entry_flag)(DENTRY_T *p_entry);
		void        (*set_entry_flag)(DENTRY_T *p_entry, UINT8 flag);
		UINT32      (*get_entry_clu0)(DENTRY_T *p_entry);
		void        (*set_entry_clu0)(DENTRY_T *p_entry, UINT32 clu0);
		UINT64      (*get_entry_size)(DENTRY_T *p_entry);
		void        (*set_entry_size)(DENTRY_T *p_entry, UINT64 size);
		void        (*get_entry_time)(DENTRY_T *p_entry, TIMESTAMP_T *tp, UINT8 mode);
		void        (*set_entry_time)(DENTRY_T *p_entry, TIMESTAMP_T *tp, UINT8 mode);
	} FS_FUNC_T;

	typedef struct __FS_INFO_T {
		UINT32      drv;                    // drive ID
		UINT32      vol_type;               // volume FAT type
		UINT32      vol_id;                 // volume serial number

		UINT32      num_sectors;            // num of sectors in volume
		UINT32      num_clusters;           // num of clusters in volume
		UINT32      cluster_size;           // cluster size in bytes
		UINT32      cluster_size_bits;
		UINT32      sectors_per_clu;        // cluster size in sectors
		UINT32      sectors_per_clu_bits;

		UINT32      PBR_sector;             // PBR sector
		UINT32      FAT1_start_sector;      // FAT1 start sector
		UINT32      FAT2_start_sector;      // FAT2 start sector
		UINT32      root_start_sector;      // root dir start sector
		UINT32      data_start_sector;      // data area start sector
		UINT32      num_FAT_sectors;        // num of FAT sectors

		UINT32      root_dir;               // root dir cluster
		UINT32      dentries_in_root;       // num of dentries in root dir
		UINT32      dentries_per_clu;       // num of dentries per cluster

		UINT32      vol_flag;               // volume dirty flag
		struct buffer_head *pbr_bh;         // PBR sector

		UINT32      map_clu;                // allocation bitmap start cluster
		UINT32      map_sectors;            // num of allocation bitmap sectors
		struct buffer_head **vol_amap;      // allocation bitmap

		UINT16      **vol_utbl;               // upcase table

		UINT32      clu_srch_ptr;           // cluster search pointer
		UINT32      used_clusters;          // number of used clusters
		UENTRY_T    hint_uentry;            // unused entry hint information

		UINT32      dev_ejected;            // block device operation error flag

		FS_FUNC_T	*fs_func;

		/* FAT cache */
		BUF_CACHE_T FAT_cache_array[FAT_CACHE_SIZE];
		BUF_CACHE_T FAT_cache_lru_list;
		BUF_CACHE_T FAT_cache_hash_list[FAT_CACHE_HASH_SIZE];

		/* buf cache */
		BUF_CACHE_T buf_cache_array[BUF_CACHE_SIZE];
		BUF_CACHE_T buf_cache_lru_list;
		BUF_CACHE_T buf_cache_hash_list[BUF_CACHE_HASH_SIZE];
	} FS_INFO_T;

#define ES_2_ENTRIES		2
#define ES_3_ENTRIES		3
#define ES_ALL_ENTRIES	0

	typedef struct {
		UINT32	sector;		// sector number that contains file_entry
		INT32	offset;		// byte offset in the sector
		INT32	alloc_flag;	// flag in stream entry. 01 for cluster chain, 03 for contig. clusteres.
		UINT32 num_entries;

		// __buf should be the last member
		void *__buf;
	} ENTRY_SET_CACHE_T;

	/*----------------------------------------------------------------------*/
	/*  External Function Declarations                                      */
	/*----------------------------------------------------------------------*/

	/* file system initialization & shutdown functions */
	INT32 ffsInit(void);
	INT32 ffsShutdown(void);

	/* volume management functions */
	INT32 ffsMountVol(struct super_block *sb, INT32 drv);
	INT32 ffsUmountVol(struct super_block *sb);
	INT32 ffsCheckVol(struct super_block *sb);
	INT32 ffsGetVolInfo(struct super_block *sb, VOL_INFO_T *info);
	INT32 ffsSyncVol(struct super_block *sb, INT32 do_sync);

	/* file management functions */
	INT32 ffsLookupFile(struct inode *inode, UINT8 *path, FILE_ID_T *fid);
	INT32 ffsCreateFile(struct inode *inode, UINT8 *path, UINT8 mode, FILE_ID_T *fid);
	INT32 ffsReadFile(struct inode *inode, FILE_ID_T *fid, void *buffer, UINT64 count, UINT64 *rcount);
	INT32 ffsWriteFile(struct inode *inode, FILE_ID_T *fid, void *buffer, UINT64 count, UINT64 *wcount);
	INT32 ffsTruncateFile(struct inode *inode, UINT64 old_size, UINT64 new_size);
	INT32 ffsMoveFile(struct inode *old_parent_inode, FILE_ID_T *fid, struct inode *new_parent_inode, struct dentry *new_dentry);
	INT32 ffsRemoveFile(struct inode *inode, FILE_ID_T *fid);
	INT32 ffsSetAttr(struct inode *inode, UINT32 attr);
	INT32 ffsGetStat(struct inode *inode, DIR_ENTRY_T *info);
	INT32 ffsSetStat(struct inode *inode, DIR_ENTRY_T *info);
	INT32 ffsMapCluster(struct inode *inode, INT32 clu_offset, UINT32 *clu);

	/* directory management functions */
	INT32 ffsCreateDir(struct inode *inode, UINT8 *path, FILE_ID_T *fid);
	INT32 ffsReadDir(struct inode *inode, DIR_ENTRY_T *dir_ent);
	INT32 ffsRemoveDir(struct inode *inode, FILE_ID_T *fid);

	/*----------------------------------------------------------------------*/
	/*  External Function Declarations (NOT TO UPPER LAYER)                 */
	/*----------------------------------------------------------------------*/

	/* fs management functions */
	INT32  fs_init(void);
	INT32  fs_shutdown(void);
	void   fs_set_vol_flags(struct super_block *sb, UINT32 new_flag);
	void   fs_sync(struct super_block *sb, INT32 do_sync);
	void   fs_error(struct super_block *sb);

	/* cluster management functions */
	INT32   clear_cluster(struct super_block *sb, UINT32 clu);
	INT32  fat_alloc_cluster(struct super_block *sb, INT32 num_alloc, CHAIN_T *p_chain);
	INT32  exfat_alloc_cluster(struct super_block *sb, INT32 num_alloc, CHAIN_T *p_chain);
	void   fat_free_cluster(struct super_block *sb, CHAIN_T *p_chain, INT32 do_relse);
	void   exfat_free_cluster(struct super_block *sb, CHAIN_T *p_chain, INT32 do_relse);
	UINT32 find_last_cluster(struct super_block *sb, CHAIN_T *p_chain);
	INT32  count_num_clusters(struct super_block *sb, CHAIN_T *dir);
	INT32  fat_count_used_clusters(struct super_block *sb);
	INT32  exfat_count_used_clusters(struct super_block *sb);
	void   exfat_chain_cont_cluster(struct super_block *sb, UINT32 chain, INT32 len);

	/* allocation bitmap management functions */
	INT32  load_alloc_bitmap(struct super_block *sb);
	void   free_alloc_bitmap(struct super_block *sb);
	INT32   set_alloc_bitmap(struct super_block *sb, UINT32 clu);
	INT32   clr_alloc_bitmap(struct super_block *sb, UINT32 clu);
	UINT32 test_alloc_bitmap(struct super_block *sb, UINT32 clu);
	void   sync_alloc_bitmap(struct super_block *sb);

	/* upcase table management functions */
	INT32  load_upcase_table(struct super_block *sb);
	void   free_upcase_table(struct super_block *sb);

	/* dir entry management functions */
	UINT32 fat_get_entry_type(DENTRY_T *p_entry);
	UINT32 exfat_get_entry_type(DENTRY_T *p_entry);
	void   fat_set_entry_type(DENTRY_T *p_entry, UINT32 type);
	void   exfat_set_entry_type(DENTRY_T *p_entry, UINT32 type);
	UINT32 fat_get_entry_attr(DENTRY_T *p_entry);
	UINT32 exfat_get_entry_attr(DENTRY_T *p_entry);
	void   fat_set_entry_attr(DENTRY_T *p_entry, UINT32 attr);
	void   exfat_set_entry_attr(DENTRY_T *p_entry, UINT32 attr);
	UINT8  fat_get_entry_flag(DENTRY_T *p_entry);
	UINT8  exfat_get_entry_flag(DENTRY_T *p_entry);
	void   fat_set_entry_flag(DENTRY_T *p_entry, UINT8 flag);
	void   exfat_set_entry_flag(DENTRY_T *p_entry, UINT8 flag);
	UINT32 fat_get_entry_clu0(DENTRY_T *p_entry);
	UINT32 exfat_get_entry_clu0(DENTRY_T *p_entry);
	void   fat_set_entry_clu0(DENTRY_T *p_entry, UINT32 start_clu);
	void   exfat_set_entry_clu0(DENTRY_T *p_entry, UINT32 start_clu);
	UINT64 fat_get_entry_size(DENTRY_T *p_entry);
	UINT64 exfat_get_entry_size(DENTRY_T *p_entry);
	void   fat_set_entry_size(DENTRY_T *p_entry, UINT64 size);
	void   exfat_set_entry_size(DENTRY_T *p_entry, UINT64 size);
	void   fat_get_entry_time(DENTRY_T *p_entry, TIMESTAMP_T *tp, UINT8 mode);
	void   exfat_get_entry_time(DENTRY_T *p_entry, TIMESTAMP_T *tp, UINT8 mode);
	void   fat_set_entry_time(DENTRY_T *p_entry, TIMESTAMP_T *tp, UINT8 mode);
	void   exfat_set_entry_time(DENTRY_T *p_entry, TIMESTAMP_T *tp, UINT8 mode);
	INT32   fat_init_dir_entry(struct super_block *sb, CHAIN_T *p_dir, INT32 entry, UINT32 type, UINT32 start_clu, UINT64 size);
	INT32   exfat_init_dir_entry(struct super_block *sb, CHAIN_T *p_dir, INT32 entry, UINT32 type, UINT32 start_clu, UINT64 size);
	INT32   fat_init_ext_dir_entry(struct super_block *sb, CHAIN_T *p_dir, INT32 entry, INT32 num_entries, UNI_NAME_T *p_uniname, DOS_NAME_T *p_dosname);
	INT32   exfat_init_ext_dir_entry(struct super_block *sb, CHAIN_T *p_dir, INT32 entry, INT32 num_entries, UNI_NAME_T *p_uniname, DOS_NAME_T *p_dosname);
	void   init_dos_entry(DOS_DENTRY_T *ep, UINT32 type, UINT32 start_clu);
	void   init_ext_entry(EXT_DENTRY_T *ep, INT32 order, UINT8 chksum, UINT16 *uniname);
	void   init_file_entry(FILE_DENTRY_T *ep, UINT32 type);
	void   init_strm_entry(STRM_DENTRY_T *ep, UINT8 flags, UINT32 start_clu, UINT64 size);
	void   init_name_entry(NAME_DENTRY_T *ep, UINT16 *uniname);
	void   fat_delete_dir_entry(struct super_block *sb, CHAIN_T *p_dir, INT32 entry, INT32 order, INT32 num_entries);
	void   exfat_delete_dir_entry(struct super_block *sb, CHAIN_T *p_dir, INT32 entry, INT32 order, INT32 num_entries);

	INT32   find_location(struct super_block *sb, CHAIN_T *p_dir, INT32 entry, UINT32 *sector, INT32 *offset);
	DENTRY_T *get_entry_with_sector(struct super_block *sb, UINT32 sector, INT32 offset);
	DENTRY_T *get_entry_in_dir(struct super_block *sb, CHAIN_T *p_dir, INT32 entry, UINT32 *sector);
	ENTRY_SET_CACHE_T *get_entry_set_in_dir (struct super_block *sb, CHAIN_T *p_dir, INT32 entry, UINT32 type, DENTRY_T **file_ep);
	void release_entry_set (ENTRY_SET_CACHE_T *es);
	INT32 write_whole_entry_set (struct super_block *sb, ENTRY_SET_CACHE_T *es);
	INT32 write_partial_entries_in_entry_set (struct super_block *sb, ENTRY_SET_CACHE_T *es, DENTRY_T *ep, UINT32 count);
	INT32  search_deleted_or_unused_entry(struct super_block *sb, CHAIN_T *p_dir, INT32 num_entries);
	INT32  find_empty_entry(struct inode *inode, CHAIN_T *p_dir, INT32 num_entries);
	INT32  fat_find_dir_entry(struct super_block *sb, CHAIN_T *p_dir, UNI_NAME_T *p_uniname, INT32 num_entries, DOS_NAME_T *p_dosname, UINT32 type);
	INT32  exfat_find_dir_entry(struct super_block *sb, CHAIN_T *p_dir, UNI_NAME_T *p_uniname, INT32 num_entries, DOS_NAME_T *p_dosname, UINT32 type);
	INT32  fat_count_ext_entries(struct super_block *sb, CHAIN_T *p_dir, INT32 entry, DENTRY_T *p_entry);
	INT32  exfat_count_ext_entries(struct super_block *sb, CHAIN_T *p_dir, INT32 entry, DENTRY_T *p_entry);
	INT32  count_dos_name_entries(struct super_block *sb, CHAIN_T *p_dir, UINT32 type);
	void   update_dir_checksum(struct super_block *sb, CHAIN_T *p_dir, INT32 entry);
	void update_dir_checksum_with_entry_set (struct super_block *sb, ENTRY_SET_CACHE_T *es);
	BOOL   is_dir_empty(struct super_block *sb, CHAIN_T *p_dir);

	/* name conversion functions */
	INT32  get_num_entries_and_dos_name(struct super_block *sb, CHAIN_T *p_dir, UNI_NAME_T *p_uniname, INT32 *entries, DOS_NAME_T *p_dosname);
	void   get_uni_name_from_dos_entry(struct super_block *sb, DOS_DENTRY_T *ep, UNI_NAME_T *p_uniname, UINT8 mode);
	void   fat_get_uni_name_from_ext_entry(struct super_block *sb, CHAIN_T *p_dir, INT32 entry, UINT16 *uniname);
	void   exfat_get_uni_name_from_ext_entry(struct super_block *sb, CHAIN_T *p_dir, INT32 entry, UINT16 *uniname);
	INT32  extract_uni_name_from_ext_entry(EXT_DENTRY_T *ep, UINT16 *uniname, INT32 order);
	INT32  extract_uni_name_from_name_entry(NAME_DENTRY_T *ep, UINT16 *uniname, INT32 order);
	INT32  fat_generate_dos_name(struct super_block *sb, CHAIN_T *p_dir, DOS_NAME_T *p_dosname);
	void   fat_attach_count_to_dos_name(UINT8 *dosname, INT32 count);
	INT32  fat_calc_num_entries(UNI_NAME_T *p_uniname);
	INT32  exfat_calc_num_entries(UNI_NAME_T *p_uniname);
	UINT8  calc_checksum_1byte(void *data, INT32 len, UINT8 chksum);
	UINT16 calc_checksum_2byte(void *data, INT32 len, UINT16 chksum, INT32 type);
	UINT32 calc_checksum_4byte(void *data, INT32 len, UINT32 chksum, INT32 type);

	/* name resolution functions */
	INT32  resolve_path(struct inode *inode, UINT8 *path, CHAIN_T *p_dir, UNI_NAME_T *p_uniname);
	INT32  resolve_name(UINT8 *name, UINT8 **arg);

	/* file operation functions */
	INT32  fat16_mount(struct super_block *sb, PBR_SECTOR_T *p_pbr);
	INT32  fat32_mount(struct super_block *sb, PBR_SECTOR_T *p_pbr);
	INT32  exfat_mount(struct super_block *sb, PBR_SECTOR_T *p_pbr);
	INT32  create_dir(struct inode *inode, CHAIN_T *p_dir, UNI_NAME_T *p_uniname, FILE_ID_T *fid);
	INT32  create_file(struct inode *inode, CHAIN_T *p_dir, UNI_NAME_T *p_uniname, UINT8 mode, FILE_ID_T *fid);
	void   remove_file(struct inode *inode, CHAIN_T *p_dir, INT32 entry);
	INT32  rename_file(struct inode *inode, CHAIN_T *p_dir, INT32 old_entry, UNI_NAME_T *p_uniname, FILE_ID_T *fid);
	INT32  move_file(struct inode *inode, CHAIN_T *p_olddir, INT32 oldentry, CHAIN_T *p_newdir, UNI_NAME_T *p_uniname, FILE_ID_T *fid);

	/* sector read/write functions */
	INT32   sector_read(struct super_block *sb, UINT32 sec, struct buffer_head **bh, INT32 read);
	INT32   sector_write(struct super_block *sb, UINT32 sec, struct buffer_head *bh, INT32 sync);
	INT32   multi_sector_read(struct super_block *sb, UINT32 sec, struct buffer_head **bh, INT32 num_secs, INT32 read);
	INT32   multi_sector_write(struct super_block *sb, UINT32 sec, struct buffer_head *bh, INT32 num_secs, INT32 sync);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* _EXFAT_H */

/* end of exfat.h */