source: soft/giet_vm/giet_fat32/fat32.h @ 588

Last change on this file since 588 was 587, checked in by alain, 9 years ago

Major evolution of the FAT32 library: i
Introduce a distributed File-Caches architecture,
a distributed FAT-Cache, and a distributed Inodes-Tree structure.
Provide Posix-like system calls.
  • Property svn:executable set to *
File size: 12.9 KB
Line 
1////////////////////////////////////////////////////////////////////////////////
2// File     : fat32.h
3// Date     : 01/09/2013
4// Author   : Alain Greiner / Marco Jankovic
5// Copyright (c) UPMC-LIP6
6////////////////////////////////////////////////////////////////////////////////
7
8#ifndef _FAT32_H
9#define _FAT32_H
10
11#include "giet_config.h"
12#include "kernel_locks.h"
13
14/*************** Partition Boot Sector Format **********************************/
15//                                     offset |  length
16#define BS_JMPBOOT                          0 ,  3
17#define BS_OEMNAME                          3 ,  8
18#define BPB_BYTSPERSEC                     11 ,  2
19#define BPB_SECPERCLUS                     13 ,  1
20#define BPB_RSVDSECCNT                     14 ,  2
21#define BPB_NUMFATS                        16 ,  1
22#define BPB_ROOTENTCNT                     17 ,  2
23#define BPB_TOTSEC16                       19 ,  2
24#define BPB_MEDIA                          21 ,  1
25#define BPB_FATSZ16                        22 ,  2
26#define BPB_SECPERTRK                      24 ,  2
27#define BPB_NUMHEADS                       26 ,  2
28#define BPB_HIDDSEC                        28 ,  4
29#define BPB_TOTSEC32                       32 ,  4
30#define BPB_PARTITION_TABLE               446 , 64
31
32// FAT 32
33#define BPB_FAT32_FATSZ32                  36 ,  4
34#define BPB_FAT32_EXTFLAGS                 40 ,  2
35#define BPB_FAT32_FSVER                    42 ,  2
36#define BPB_FAT32_ROOTCLUS                 44 ,  4
37#define BPB_FAT32_FSINFO                   48 ,  2
38#define BPB_FAT32_BKBOOTSEC                50 ,  2
39#define BS_FAT32_DRVNUM                    64 ,  1
40#define BS_FAT32_BOOTSIG                   66 ,  1
41#define BS_FAT32_VOLID                     67 ,  4
42#define BS_FAT32_VOLLAB                    71 , 11
43#define BS_FAT32_FILSYSTYPE                82 ,  8
44
45// Partitions
46#define FIRST_PARTITION_ACTIVE            446 ,  8
47#define FIRST_PARTITION_BEGIN_LBA         454 ,  4
48#define FIRST_PARTITION_SIZE              458 ,  4
49#define SECOND_PARTITION_ACTIVE           462 ,  8
50#define SECOND_PARTITION_BEGIN_LBA        470 ,  4
51#define SECOND_PARTITION_SIZE             474 ,  4
52#define THIRD_PARTITION_ACTIVE            478 ,  8
53#define THIRD_PARTITION_BEGIN_LBA         486 ,  4
54#define THIRD_PARTITION_SIZE              490 ,  4
55#define FOURTH_PARTITION_ACTIVE           494 ,  8
56#define FOURTH_PARTITION_BEGIN_LBA        502 ,  4
57#define FOURTH_PARTITION_SIZE             506 ,  4   
58/*******************************************************************************/
59
60#define MBR_SIGNATURE_POSITION            510 , 2
61#define MBR_SIGNATURE_VALUE               0xAA55 
62
63/************** FAT_FS_INFO SECTOR  ********************************************/
64#define FS_SIGNATURE_VALUE_1              0x52526141
65#define FS_SIGNATURE_VALUE_2              0x72724161
66#define FS_SIGNATURE_VALUE_3              0x000055AA 
67#define FS_SIGNATURE_POSITION_1           0   , 4 
68#define FS_SIGNATURE_POSITION_2           484 , 4
69#define FS_SIGNATURE_POSITION_3           508 , 4 
70#define FS_FREE_CLUSTERS                  488 , 4
71#define FS_FREE_CLUSTER_HINT              492 , 4
72/*******************************************************************************/
73
74#define DIR_ENTRY_SIZE          32
75                   
76#define NAME_MAX_SIZE           31
77
78/******* Directory Entry Structure (32 bytes) **********************************/
79//                            offset | length
80#define DIR_NAME                   0 , 11   // dir_entry name
81#define DIR_ATTR                  11 ,  1   // attributes
82#define DIR_NTRES                 12 ,  1   // reserved for the OS       
83#define DIR_CRT_TIMES_TENTH       13 ,  1
84#define DIR_FST_CLUS_HI           20 ,  2   // cluster index 16 MSB bits
85#define DIR_WRT_TIME              22 ,  2   // time of last write
86#define DIR_WRT_DATE              24 ,  2   // date of last write
87#define DIR_FST_CLUS_LO           26 ,  2   // cluster index 16 LSB bit
88#define DIR_FILE_SIZE             28 ,  4   // file size (up to 4 giga bytes)
89/*******************************************************************************/
90
91/******* LFN Directory Entry Structure  (32 bytes) *****************************/
92//                            offset | length
93#define LDIR_ORD                   0 ,  1   // Sequence number (from 0x01 to 0x0f)   
94#define LDIR_NAME_1                1 , 10   // name broken into 3 parts
95#define LDIR_ATTR                 11 ,  1   // attributes (must be 0x0F)
96#define LDIR_TYPE                 12 ,  1   // directory type (must be 0x00)
97#define LDIR_CHKSUM               13 ,  1   // checksum of name in short dir 
98#define LDIR_NAME_2               14 , 12
99#define LDIR_RSVD                 26 ,  2   // artifact of previous fat (must be 0)
100#define LDIR_NAME_3               28 ,  4   
101/*******************************************************************************/
102
103/***********************  DIR_ATTR values  (attributes) ************************/
104#define ATTR_READ_ONLY            0x01
105#define ATTR_HIDDEN               0x02
106#define ATTR_SYSTEM               0x04
107#define ATTR_VOLUME_ID            0x08
108#define ATTR_DIRECTORY            0x10
109#define ATTR_ARCHIVE              0x20
110#define ATTR_LONG_NAME_MASK       0x0f      // READ_ONLY|HIDDEN|SYSTEM|VOLUME_ID
111/*******************************************************************************/
112
113/********************* DIR_ORD special values **********************************/
114#define FREE_ENTRY                0xE5     // this entry is free in the directory
115#define NO_MORE_ENTRY             0x00     // no more entry in the directory
116/*******************************************************************************/
117
118/******************** CLuster Index Special Values *****************************/
119#define FREE_CLUSTER              0x00000000
120#define RESERVED_CLUSTER          0x00000001
121#define BAD_CLUSTER               0x0FFFFFF7
122#define END_OF_CHAIN_CLUSTER_MIN  0x0ffffff8
123#define END_OF_CHAIN_CLUSTER_MAX  0x0fffffff
124/*******************************************************************************/
125
126
127#define SEEK_SET                0
128#define SEEK_CUR                1
129
130#define FAT_INITIALISED         0xBABEF00D
131
132#define O_RDONLY                0x01
133#define O_CREATE                0x20
134
135/********************************************************************************
136  This struct defines a non terminal node in a 64-tree implementing a File-Cache
137  associated to an open file, or the Fat-Cache, associated to the FAT itself.
138  Each node has 64 children, and we use the void* type, because the children
139  can be non-terminal (fat_cache_node_t) or terminal (fat_cache_cluster_t).
140********************************************************************************/
141
142typedef struct fat_cache_node_s
143{
144    void*              children[64];           // pointers on the 64 children
145}   fat_cache_node_t;
146
147
148/********************************************************************************
149  This struct defines a cluster descriptor, that is a leaf cell in a 64-tree.
150  Each cluster descriptor contains a pointer on a 4K bytes buffer, and the
151  lba on block device.
152********************************************************************************/
153
154typedef struct fat_cache_desc_s
155{
156    unsigned int       lba;                      // cluster lba on block device
157    unsigned int       dirty;                    // modified if non zero
158    unsigned char*     buffer;                   // pointer on the 4 Kbytes buffer
159}   fat_cache_desc_t;
160
161
162/********************************************************************************
163  This struct defines a file/directory inode / size = 64 bytes
164********************************************************************************/
165
166typedef struct fat_inode_s
167{
168    struct fat_inode_s*  parent;                 // parent directory inode
169    struct fat_inode_s*  next;                   // next inode in same directory
170    struct fat_inode_s*  child;                  // first children inode (dir only)
171    fat_cache_node_t*    cache;                  // pointer on the file_cache root
172    unsigned int         cluster;                // first cluster index in FAT
173    unsigned int         size;                   // number of bytes (file only)
174    unsigned int         count;                  // number open if file / 0 if dir
175    unsigned short       dentry;                 // directory entry index in parent
176    unsigned char        levels;                 // number of levels in file_cache
177    unsigned char        is_dir;                 // directory if non zero
178    char                 name[32];               // file  directory name
179}   fat_inode_t;
180
181/********************************************************************************
182  This struct defines a file descriptor (handler) / size = 16 bytes
183********************************************************************************/
184
185typedef struct fat_file_desc_s
186{
187    unsigned int         seek;                   // current offset value (bytes)
188    fat_inode_t*         inode;                  // pointer on inode
189    char                 allocated;              // file descriptor allocated
190    char                 read_only;              // write protected
191    char                 reserved[6];            // reserved
192}   fat_file_desc_t;
193
194/********************************************************************************
195  This struct defines a FAT32 File system descriptor
196 *******************************************************************************/
197
198typedef struct fat_desc_s
199{
200    unsigned char       block_buffer[512];       // one block buffer (for FS_INFO)
201    fat_file_desc_t     fd[GIET_OPEN_FILES_MAX]; // file descriptors array
202    spin_lock_t         fat_lock;                // global lock protecting FAT
203    fat_inode_t*        inode_tree_root;         // Inode-Tree root pointer
204    fat_cache_node_t*   fat_cache_root;          // Fat_Cache root pointer
205    unsigned int        fat_cache_levels;        // number of levels in Fat-Cache
206    unsigned int        block_buffer_lba;        // lba of block in block_buffer
207    unsigned int        initialised;             // 0xBABEF00D when FAT initialised
208    unsigned int        sector_size;             // must be 512
209    unsigned int        cluster_size;            // must be 4096
210    unsigned int        fat_lba;                 // lba of first FAT sector
211    unsigned int        fat_sectors;             // number of sectors in FAT region
212    unsigned int        data_lba;                // lba of first DATA sector 
213    unsigned int        data_sectors;            // number of sectors inf DATA region
214    unsigned int        fs_info_lba;             // lba of fs_info
215    unsigned int        first_free_cluster;      // free cluster with smallest index
216    unsigned int        free_clusters_number;    // total number of free clusters
217}   fat_desc_t;
218
219
220/*********************** Extern Functions  *************************************/
221
222extern int _fat_init();         
223
224extern int _fat_open( char*        pathname,               // path from root
225                      unsigned int flags );                // O_CREATE/O_RDONLY
226
227extern int _fat_close( unsigned int fd_id );               // file descriptor
228
229extern int _fat_file_info( unsigned int  fd_id,            // file descriptor
230                           unsigned int* size,             // file size
231                           unsigned int* offset );         // current offset
232
233extern int _fat_read( unsigned int fd_id,                  // file descriptor 
234                      void*        buffer,                 // destination buffer
235                      unsigned int count );                // number of bytes
236
237extern int _fat_write( unsigned int fd_id,                 // file descriptor
238                       void*        buffer,                        // source buffer
239                       unsigned int count );               // number of bytes
240
241extern int _fat_lseek( unsigned int fd_id,                 // file descriptor
242                       unsigned int offset,                // new offset value
243                       unsigned int whence );              // command type
244
245extern int _fat_remove( char*        pathname,             // path from root
246                        unsigned int should_be_dir );      // for checking
247
248extern int _fat_rename( char*  old_path,                   // path from root
249                        char*  new_path );                 // path from root
250
251extern int _fat_mkdir( char* pathname );                   // path from root
252
253extern int _fat_list( char* pathname );                    // path from root
254
255extern int _fat_load_no_cache( char*        pathname,      // path from root
256                               unsigned int buffer_vbase,  // buffer base
257                               unsigned int buffer_size ); // buffer size
258
259/*******************************************************************************/
260
261
262#endif
263
264
265// Local Variables:
266// tab-width: 4
267// c-basic-offset: 4
268// c-file-offsets:((innamespace . 0)(inline-open . 0))
269// indent-tabs-mode: nil
270// End:
271// vim: filetype=c:expandtab:shiftwidth=4:tabstop=4:softtabstop=4
272
Note: See TracBrowser for help on using the repository browser.