Changes between Version 35 and Version 36 of file_system

Timestamp:

Jan 14, 2016, 3:34:00 PM (10 years ago)

Author:

alain

Comment:

--

file_system

@@ -283 +283 @@
 This debug function displays the FAT descriptor content. 
 
-=== __void '''_get_name_from_long'''( unsigned char* buffer , char* name )__ ===
+=== __unsigned int '''_get_fat_cache_buffer'''( unsigned int cluster_id , fat_cache_desc_t**  desc )__ ===
+This function returns in the <desc> argument a pointer on a buffer descriptor contained in the Fat_Cache. 
+The <cluster_id> argument is the buffer index in the FAT_Cache. 
+In case of miss, a 4 Kbytesbuffer and a buffer descriptor are allocated from the local heap, and the missing cluster is loaded in the Fat_Cache.
+It returns 0 on success. It returns 1 on error.=== __void '''_get_name_from_long'''( unsigned char* buffer , char* name )__ ===
 This function extract a (partial) name from a LFN directory entry.
 
@@ -309 +313 @@
 It returns 0 on success, It returns 1 on error.
 
-//////////////////////////////////////////////////////////////////////////////////
-// The following function introduces the inode identified by the <child> argument,
-// as a new child of the <parent> inode in the Inode-Tree.
-// All checking are supposed to be done by the caller.
-// Nor the File-Cache, neither the block device are modified.
-//////////////////////////////////////////////////////////////////////////////////
-
-static void _add_inode_in_tree( fat_inode_t*  child,
-                                fat_inode_t*  parent );
-
-//////////////////////////////////////////////////////////////////////////////////
-// The following function removes one inode identified by the <inode> argument 
-// from the Inode-Tree. All checking are supposed to be done by the caller.
-// Nor the File-Cache, neither the block device are modified.
-//////////////////////////////////////////////////////////////////////////////////
-
-static void _remove_inode_from_tree( fat_inode_t* inode );
-
-//////////////////////////////////////////////////////////////////////////////////
-// This recursive function scan one File-Cache (or Fat-Cache) from root to leaves,
-// to writes all dirty clusters to block device, and reset the dirty bits.
-// The cache is identified by the <root> an <levels> arguments.
-// The <string> argument is only used for debug : inode name or Fat.
-// It returns 0 on success.
-// It returns 1 on error.
-//////////////////////////////////////////////////////////////////////////////////
-
-static unsigned int _update_device_from_cache( unsigned int      levels,
-                                               fat_cache_node_t* root,
-                                               char*             string );
+=== __void '''_add_inode_in_tree'''( fat_inode_t*  child , fat_inode_t*  parent )__ ===
+This function introduces the inode identified by the <child> argument as a new child for the <parent> inode in the Inode-Tree.
+All checking are supposed to be done by the caller. Nor the File-Cache, neither the block device are modified.
+
+=== __void '''_remove_inode_from_tree'''( fat_inode_t* inode )__ ===
+This function removes one inode identified by the <inode> argument from the Inode-Tree. All checking are supposed to be done by the caller. Nor the File-Cache, neither the block device are modified.
+
+=== __unsigned int '''_update_device_from_cache'''( unsigned int levels , fat_cache_node_t* root , char* string )__ ===
+This recursive function scan one File-Cache (or the Fat-Cache) from root to leaves, to writes all dirty clusters to block device, and reset the dirty bits. The cache is identified by the <root> an <levels> arguments.
+The <string> argument is only used for debug.  It returns 0 on success. It returns 1 on error.
+
+
 
 //////////////////////////////////////////////////////////////////////////////////
@@ -582 +568 @@
 static unsigned int _remove_node_from_fs( fat_inode_t* inode );
 
-/////////////////////////////////////////////////////////////////////////////
-// This function return the cluster index and the size for a file 
-// identified by the "pathname" argument, scanning directly the block
-// device DATA region.
-// It is intended to be called only by the _fat_load_no_cache() function, 
-// it does not use the dynamically allocated File Caches, but uses only
-// the 4 Kbytes _fat_buffer_data. 
-// It returns 0 on success.
-// It returns 1 on error.
-/////////////////////////////////////////////////////////////////////////////
-
-static unsigned int _file_info_no_cache( char*          pathname,
-                                         unsigned int*  file_cluster,
-                                         unsigned int*  file_size );
-
-/////////////////////////////////////////////////////////////////////////////
-// This function scan directly the FAT region on the block device, 
-// and returns in the "next" argument the value stored in the fat slot 
-// identified by the "cluster" argument.
-// It is intended to be called only by the _fat_load_no_cache() function,
-// as it does not use the dynamically allocated Fat-Cache, but uses only 
-// the 4 Kbytes _fat_buffer_fat.
-// It returns 0 on success.
-// It returns 1 on error.
-/////////////////////////////////////////////////////////////////////////////
-
-static unsigned int _next_cluster_no_cache( unsigned int   cluster,
-                                            unsigned int*  next );
-
-
-//////////////////////////////////////////////////////////////////////////////////
-// The following functions return the the size (bytes) of a FAT field, 
-// identified by an (offset,length) mnemonic defined in the fat32.h file.
-//////////////////////////////////////////////////////////////////////////////////
-
-static inline int get_length( int offset , int length ) { return length; }
-
-static inline int get_offset( int offset , int length ) { return offset; }
-
-//////////////////////////////////////////////////////////////////////////////////
-// The following function returns in the <desc> argument a pointer on a buffer 
-// descriptor contained in the Fat_Cache. 
-// The <cluster_id> argument is the buffer index in the FAT_Cache. 
-// In case of miss, a 4 Kbytesbuffer and a buffer descriptor are allocated 
-// from the local heap, and the missing cluster is loaded in the Fat_Cache.
-// It returns 0 on success.
-// It returns 1 on error.
-//////////////////////////////////////////////////////////////////////////////////
-
-static unsigned int _get_fat_cache_buffer( unsigned int        cluster_id,
-                                           fat_cache_desc_t**  desc );
-
-
+
+=== __unsigned int '''_file_info_no_cache'''( char* pathname , unsigned int*  file_cluster , unsigned int*  file_size )__ ===
+This function returns in the <file_cluster> and <file_size> arguments the cluster index and the size for a file identified by the <pathname> argument, scanning directly the block device DATA region.
+It is intended to be called only by the _fat_load_no_cache() function, as it does not use the dynamically allocated File-Caches, but uses only the 4 Kbytes _fat_buffer_data. 
+It returns 0 on success. It returns 1 on error.
+
+=== __unsigned int '''_next_cluster_no_cache'''( unsigned int   cluster , unsigned int*  next )__ ===
+This function scan directly the FAT region on the block device,  and returns in the <next> argument the value stored in the fat slot  identified by the <cluster> argument. It is intended to be called only by the _fat_load_no_cache() function, as it does not use the dynamically allocated Fat-Cache, but uses only  the 4 Kbytes _fat_buffer_fat. It returns 0 on success. It returns 1 on error.
+
+=== __int '''get_length'''( int offset , int length )__ ===
+This function returns the the size (bytes) of a FAT field,  identified by an <offset,length> mnemonic defined in the fat32.h file.
+
+=== __int '''get_offset'''( int offset , int length )__ ===
+This function returns the the offset (bytes) of a FAT field,  identified by an <offset,length> mnemonic defined in the fat32.h file.