navigation.c File Reference

FAT 12/16/32 Services. More...

#include <ctype.h>
#include "conf_explorer.h"
#include "navigation.h"
#include "file.h"
#include <LIB_CTRLACCESS>

Include dependency graph for navigation.c:

Go to the source code of this file.

Defines
#define	SIZE_OF_SPLIT_COPY   ((1*1024*1024L)/512L)
Functions
void	nav_string_unicode (void)
	This function selects the UNICODE mode for all routines with FS_STRING parameter.
void	nav_string_ascii (void)
	This function selects the ASCII mode for all routines with FS_STRING parameter.
void	nav_string_length_enable (void)
	This function selects the LENGTH string mode for all routines with FS_STRING parameter.
void	nav_string_length_disable (void)
	This function deselects the LENGTH string mode for all routines with FS_STRING parameter.
void	nav_checkdisk_disable (void)
	This function disables the disk check before each actions on disk.
void	nav_checkdisk_enable (void)
	This function enables the disk check before each actions on disk.
void	nav_reset (void)
	This function resets ALL navigations to init file system core.
void	nav_exit (void)
	This function flush ALL navigations before exit of file system core.
Bool	nav_select (U8 u8_idnav)
	This function selects the navigation to use.
U8	nav_get (void)
	This function returns the navigation identifier used.
Bool	nav_copy (U8 u8_idnav)
	This function copys the navigator information to another navigator.
U8	nav_drive_nb (void)
	This function returns the number of devices availabled.
Bool	nav_drive_set (U8 u8_number)
	This function selects a drive in navigator but don't mount the disk partition.
U8	nav_drive_get (void)
	This function returns the selected drive number.
U8	nav_drive_getname (void)
	This function returns the selected drive letter.
U8	nav_partition_nb (void)
	This function returns the number of partitions present on drive.
Bool	nav_partition_set (U8 partition_number)
	This function selects a partition on drive.
Bool	nav_partition_mount (void)
	This function mounts the selected partition.
U8	nav_partition_type (void)
	This function gives the partition type.
Bool	nav_partition_serialnumber (Bool b_action, U8 _MEM_TYPE_SLOW_ *a_u8_sn)
	This function reads or writes the serial number on the selected partition.
Bool	nav_partition_label (Bool b_action, FS_STRING sz_label)
	This function reads or writes the label of selected partition.
U32	nav_partition_space (void)
	This function returns partition total space.
U8	nav_partition_cluster_size (void)
	This function returns the partition cluster size.
U32	nav_partition_freespace (void)
	This function returns the partition free space.
U8	nav_partition_freespace_percent (void)
	This function returns the partition space free in percent.
Bool	nav_filelist_single_enable (Bool b_type)
	To display in File List only the files OR directories.
Bool	nav_filelist_single_disable (void)
	To display in File List the directories AND files.
Bool	nav_filelist_reset (void)
	This function resets the selection pointer, so "no file selected" in file list.
Bool	nav_filelist_validpos (void)
	This function checks if a file is selected.
Bool	nav_filelist_fileisnotopen (void)
	This function checks if no file is open.
Bool	nav_filelist_set (U16 u16_nb, Bool b_direction)
	This function moves the selection pointer in file list.
U16	nav_filelist_get (void)
	This function returns the position of selected file in file list.
Bool	nav_filelist_goto (U16 u16_newpos)
	This function goes at a position in file list.
Bool	nav_filelist_findname (const FS_STRING sz_name, Bool b_match_case)
	This function searchs a file name in file list.
Bool	nav_filelist_eol (void)
	This function checks the end of file list.
Bool	nav_filelist_bol (void)
	This function checks the beginning of file list.
Bool	nav_filelist_exist (Bool b_type)
	This function checks the presence of files or directories in file list.
U16	nav_filelist_nb (Bool b_type)
	This function computes the number of files or directories in file list.
Bool	nav_filelist_first (Bool b_type)
	This function goes to at the first file or directory in file list.
Bool	nav_filelist_last (Bool b_type)
	This function goes to at the last file or directory in file list.
Fs_index	nav_getindex (void)
	This function returns a small index on the selected file.
Bool	nav_gotoindex (const Fs_index _MEM_TYPE_SLOW_ *index)
	This function selects a file in the navigator via a file index.
Bool	nav_dir_root (void)
	This function initializes the file list on the root directory.
Bool	nav_dir_is_root (void)
	This function check the current directory.
Bool	nav_dir_cd (void)
	This function enters in the selected directory in file list.
Bool	nav_dir_gotoparent (void)
	This function goes to the parent directory.
Bool	nav_dir_name (FS_STRING sz_path, U8 u8_size_max)
	This function returns the directory name corresponding at the file list.
Bool	nav_getcwd (FS_STRING sz_path, U8 u8_size_path, Bool b_view_file_select)
	This function returns the full path of the selection.
Bool	nav_setcwd (FS_STRING sz_path, Bool b_match_case, Bool b_create)
	This function selects a disk position via a path.
Bool	nav_file_getname (FS_STRING sz_name, U8 u8_size_max)
	This function returns the name of selected file.
Bool	nav_file_name (FS_STRING sz_name, U8 u8_size_max, Bool b_mode, Bool b_match_case)
	This function returns the name of selected file or checks the string with the name of selected file.
U32	nav_file_lgt (void)
	This function returns the size of selected file (unit byte).
U16	nav_file_lgtsector (void)
	This function returns the size of selected file (unit sector).
Bool	nav_file_isreadonly (void)
	This function checks the write protection of disk and the attribut "read only" of selected file.
Bool	nav_file_isdir (void)
	This function returns the type of selected file.
Bool	nav_file_checkext (const FS_STRING sz_filterext)
	This function checks the extension of selected file.
Bool	nav_file_dateget (FS_STRING sz_date, Bool type_date)
	This function returns the date of selected file.
U8	nav_file_attributget (void)
	This function returns the attribut of selected file.

---

Detailed Description

FAT 12/16/32 Services.

This file defines a useful set of functions for file navigation.

Author:

Atmel Corporation: http://www.atmel.com
Support and FAQ: http://support.atmel.no/

Definition in file navigation.c.

---

Define Documentation

#define SIZE_OF_SPLIT_COPY   ((1*1024*1024L)/512L)

Definition at line 69 of file navigation.c.

---

Function Documentation

void nav_string_unicode

(

void

)

This function selects the UNICODE mode for all routines with FS_STRING parameter.

//! If you have enabled the FS_ASCII AND FS_UNICODE define
//! then FS_STRING parameter can be a ASCII or UNICODE string.
//! 

Definition at line 84 of file navigation.c.

{
   g_b_unicode = TRUE;
}

void nav_string_ascii

(

void

)

This function selects the ASCII mode for all routines with FS_STRING parameter.

//! If you have enabled the FS_ASCII AND FS_UNICODE define
//! then FS_STRING parameter can be a ASCII or UNICODE string.
//! 

Definition at line 95 of file navigation.c.

{
   g_b_unicode = FALSE;
}

void nav_string_length_enable

(

void

)

This function selects the LENGTH string mode for all routines with FS_STRING parameter.

//! In LENGTH string mode when you call a routine with FS_STRING parameter
//! only the size (16bits, unit ASCII or UNICODE) is returned in the first 16bits of string array.
//! 

Definition at line 108 of file navigation.c.

{
   g_b_string_length = TRUE;
}

void nav_string_length_disable

(

void

)

This function deselects the LENGTH string mode for all routines with FS_STRING parameter.

//! In LENGTH string mode when you call a routine with FS_STRING parameter
//! only the size (16bits, unit ASCII or UNICODE) is returned in the first 16bits of string array.
//! 

Definition at line 119 of file navigation.c.

{
   g_b_string_length = FALSE;
}

void nav_checkdisk_disable

(

void

)

This function disables the disk check before each actions on disk.

//! By default, between each read/write access a check disk (test unit ready) is sended at device.
//! This check can reduce the speed access on specific disk.
//! 

Definition at line 134 of file navigation.c.

{
   g_b_no_check_disk = TRUE;
}

void nav_checkdisk_enable

(

void

)

This function enables the disk check before each actions on disk.

//! By default, between each read/write access a check disk (test unit ready) is sended at device.
//! This check can reduce the speed access on specific disk.
//! 

Definition at line 146 of file navigation.c.

{
   g_b_no_check_disk = FALSE;
}

void nav_reset

(

void

)

This function resets ALL navigations to init file system core.

//! Call this at the program startup or before a new session (e.g. USB Device exit)
//! 

Definition at line 162 of file navigation.c.

Referenced by ushell_task().

{
#if ( (FS_ASCII   == ENABLED) && (FS_UNICODE == ENABLED))
   g_b_unicode = TRUE;
#endif
   g_b_string_length = FALSE;
   g_b_no_check_disk = FALSE;

   fat_cache_reset();
   fat_cache_clusterlist_reset();

#if (FS_NB_NAVIGATOR > 1)
   {
   U8 i;
   // Reset variables of each navigators
   for( i=0 ; i!=FS_NB_NAVIGATOR ; i++ )
   {
      nav_select(i);
      fs_g_nav_fast.u8_type_fat = FS_TYPE_FAT_UNM; // By default the fat isn't mounted
      fs_g_nav.u8_lun = 0xFF;                      // By default don't select a drive
#if (FS_MULTI_PARTITION  ==  ENABLED)
      fs_g_nav.u8_partition=0;                     // By default select the first partition
#endif
      Fat_file_close();                            // By default no file is opened
      fs_g_nav.b_mode_nav_single = FALSE;          // By default display files and directories
   }
   // By default select the navigator 0
   fs_g_u8_nav_selected = 0;
   }
#else
   fs_g_nav_fast.u8_type_fat = FS_TYPE_FAT_UNM;    // By default the fat isn't mounted
   fs_g_nav.u8_lun = 0xFF;                         // By default don't select a drive
#  if (FS_MULTI_PARTITION  ==  ENABLED)
   fs_g_nav.u8_partition=0;                        // By default select the first partition
#  endif
   Fat_file_close();                               // By default no file is opened
#endif // (FS_NB_NAVIGATOR > 1)
}

Here is the caller graph for this function:

void nav_exit

(

void

)

This function flush ALL navigations before exit of file system core.

//! Call this at the program exit or before a USB Device session
//! 

Definition at line 208 of file navigation.c.

Referenced by ushell_task().

{
   // If you have opened files then close them
#if (FS_NB_NAVIGATOR > 1)
   U8 u8_i;
   for( u8_i=0; u8_i<FS_NB_NAVIGATOR; u8_i++)
   {
      nav_select(u8_i);
      file_close();
   }
#else
   nav_select(0);
   file_close();
#endif
   // Flush data eventually present in FAT cache
   fat_cache_flush();
}

Here is the caller graph for this function:

Bool nav_select

(

U8

u8_idnav

)

This function selects the navigation to use.

Parameters:

u8_idnav

navigator identifier to select (0 to FS_NB_NAVIGATOR-1)

Returns:

FALSE if ID navigator don't exist

TRUE otherwise

Definition at line 234 of file navigation.c.

Referenced by copy_dir(), nav_exit(), nav_reset(), ushell_cmd_perform(), ushell_cmd_sync(), and ushell_task().

{
   if( FS_NB_NAVIGATOR <= u8_idnav )
   {
      fs_g_status = FS_ERR_BAD_NAV;             // The navigator doesn't exist
      return FALSE;
   }
#if (FS_NB_NAVIGATOR > 1)
   if( fs_g_u8_nav_selected != u8_idnav )
   {
      fat_invert_nav( fs_g_u8_nav_selected );   // Deselect previous navigator = Select default navigator
      fat_invert_nav( u8_idnav );               // Select new navigator
      fs_g_u8_nav_selected = u8_idnav;
   }
#endif
   return TRUE;
}

Here is the caller graph for this function:

U8 nav_get

(

void

)

This function returns the navigation identifier used.

Returns:

u8_idnav navigator identifier selected

Definition at line 257 of file navigation.c.

{
#if (FS_NB_NAVIGATOR > 1)
   return fs_g_u8_nav_selected;
#else
   return 0;
#endif
}

Bool nav_copy

(

U8

u8_idnav

)

This function copys the navigator information to another navigator.

Parameters:

u8_idnav

navigator identifier where the main navigator will be copied

Returns:

FALSE in case of error, see global value "fs_g_status" for more detail

TRUE otherwise

//! Use this routine to select quickly the same file in another navigator
//! 

Definition at line 278 of file navigation.c.

{
#if (FS_NB_NAVIGATOR > 1)
   if( fs_g_u8_nav_selected == u8_idnav )
      return FALSE;                    // It is the source and destination is the same navigator
   if( 0 == u8_idnav )
      u8_idnav = fs_g_u8_nav_selected; // the default navigator is invert with the current navigator
   if( 0 == u8_idnav)
      return FALSE;                    // It is the source and destination is the same navigator
   fat_copy_nav( u8_idnav );
   return TRUE;
#else
   u8_idnav++;
   return FALSE;                       // Copy impossible because only one navigator is available
#endif
}

U8 nav_drive_nb

(

void

)

This function returns the number of devices availabled.

Returns:

number of devices, 0 = NO DEVICE AVAILABLED

//! This value may be dynamic because it depends of memory drivers (e.g. Mass Storage disk on USB host mode)
//! 

Definition at line 308 of file navigation.c.

Referenced by firm_upgrade_searchfile(), ushell_cmd_free_space(), ushell_cmd_mount(), and ushell_cmd_nb_drive().

{
   return get_nb_lun(); // Number of devices = Number of lun
}

Here is the caller graph for this function:

Bool nav_drive_set

(

U8

u8_number

)

This function selects a drive in navigator but don't mount the disk partition.

Parameters:

u8_number

device number (0 to nav_drive_nb()-1 )

Returns:

FALSE in case of error, see global value "fs_g_status" for more detail

TRUE otherwise

Definition at line 321 of file navigation.c.

Referenced by firm_upgrade_searchfile(), nav_gotoindex(), nav_setcwd(), ushell_cmd_format(), ushell_cmd_free_space(), ushell_cmd_mount(), and ushell_cmd_perform_alloc().

{
   if ( !fat_check_noopen() )
      return FALSE;

   if (u8_number >= get_nb_lun() )
   {
      fs_g_status = FS_ERR_END_OF_DRIVE;   // The drive number is bad
      return FALSE;
   }

   if ( fs_g_nav.u8_lun == u8_number)
      return TRUE;   // It is the same drive number

   // Go to the device
   fs_g_nav.u8_lun = u8_number;
   fs_g_nav_fast.u8_type_fat = FS_TYPE_FAT_UNM;
#if (FS_MULTI_PARTITION  ==  ENABLED)
   fs_g_nav.u8_partition=0;   // by default select the first partition
#endif
   return TRUE;
}

Here is the caller graph for this function:

U8 nav_drive_get

(

void

)

This function returns the selected drive number.

Returns:

0 to nav_drive_nb()-1

0xFF in case of no drive selected

Definition at line 350 of file navigation.c.

Referenced by ushell_cmd_ls(), and ushell_cmd_space().

{
#if (FS_MULTI_PARTITION  ==  ENABLED)
   if(0xFF == fs_g_nav.u8_lun)
      return 0xFF;
   return ((fs_g_nav.u8_lun*4) + fs_g_nav.u8_partition); // Maximum 4 partitions per device
#else
   return (fs_g_nav.u8_lun);
#endif
}

Here is the caller graph for this function:

U8 nav_drive_getname

(

void

)

This function returns the selected drive letter.

Returns:

'A','B',...

'X', in case of no drive selected

Definition at line 367 of file navigation.c.

Referenced by nav_dir_name(), and nav_getcwd().

{
   if(0xFF == fs_g_nav.u8_lun)
      return 'X';
#if (FS_MULTI_PARTITION  ==  ENABLED)
   return ('A' + (fs_g_nav.u8_lun*4) + fs_g_nav.u8_partition); // Maximum 4 partitions per device
#else
   return ('A' + fs_g_nav.u8_lun);
#endif
}

Here is the caller graph for this function:

U8 nav_partition_nb

(

void

)

This function returns the number of partitions present on drive.

Returns:

u8_number number of partitions

Definition at line 418 of file navigation.c.

{
   return fat_get_nbpartition();
}

Bool nav_partition_set

(

U8

partition_number

)

This function selects a partition on drive.

Parameters:

partition_number

partition number (0 to 3)

Returns:

FALSE in case of error, see global value "fs_g_status" for more detail

TRUE otherwise

Definition at line 431 of file navigation.c.

Referenced by nav_gotoindex().

{
   if ( fs_g_nav.u8_partition == partition_number)
      return TRUE;   // It is the same

   if ( !fat_check_noopen() )
      return FALSE;

   // Go to partition
   fs_g_nav.u8_partition = partition_number;
   fs_g_nav_fast.u8_type_fat = FS_TYPE_FAT_UNM;
   return TRUE;
}

Here is the caller graph for this function:

Bool nav_partition_mount

(

void

)

This function mounts the selected partition.

Returns:

FALSE in case of error, see global value "fs_g_status" for more detail

TRUE otherwise

//! If the FS_MULTI_PARTITION option is disabled
//! then the mount routine selects the first partition supported by file system. <br>
//! After mount, the file list contains files and directories of ROOT directory
//! 

Definition at line 458 of file navigation.c.

Referenced by firm_upgrade_searchfile(), nav_dir_root(), nav_gotoindex(), nav_partition_type(), nav_setcwd(), ushell_cmd_free_space(), ushell_cmd_mount(), and ushell_cmd_perform_alloc().

{
   if ( !fat_check_noopen() )
      return FALSE;

   if( FS_TYPE_FAT_UNM != fs_g_nav_fast.u8_type_fat)
   {
      // Already mounted
      // Go to root directory
      fs_g_nav.u32_cluster_sel_dir   = 0;
      // No file is selected by default
      fat_clear_entry_info_and_ptr();
      return TRUE;
   }

   return fat_mount();
}

Here is the caller graph for this function:

U8 nav_partition_type

(

void

)

This function gives the partition type.

Returns:

partition type: FS_TYPE_FAT_12, FS_TYPE_FAT_16, FS_TYPE_FAT_32

FS_TYPE_FAT_UNM, in case of error or unknow format

Definition at line 482 of file navigation.c.

Referenced by ushell_cmd_ls().

{
   fat_check_device();
   if( FS_TYPE_FAT_UNM == fs_g_nav_fast.u8_type_fat)
   {
      nav_partition_mount();
   }
   return fs_g_nav_fast.u8_type_fat;
}

Here is the caller graph for this function:

Bool nav_partition_serialnumber	(	Bool	b_action,
		U8 _MEM_TYPE_SLOW_ *	a_u8_sn
	)

This function reads or writes the serial number on the selected partition.

Parameters:

	b_action	to select the action FS_SN_READ to read serial number FS_SN_WRITE to write serial number
	a_u8_sn	pointer on an array (4 bytes) if FS_SN_READ, then the array is used to store the serial number if FS_SN_WRITE, then the array is used to give the new serial number

Returns:

FALSE in case of error, see global value "fs_g_status" for more detail

TRUE otherwise

Definition at line 505 of file navigation.c.

{
   if( !fat_check_mount())
      return FALSE;

   return fat_serialnumber( b_action , a_u8_sn );
}

Bool nav_partition_label	(	Bool	b_action,
		FS_STRING	sz_label
	)

This function reads or writes the label of selected partition.

Parameters:

	b_action	to select the action FS_LABEL_READ to read label FS_LABEL_WRITE to write label
	sz_label	pointer on a ASCII string (11 chars + NULL terminator =12 bytes) if FS_LABEL_READ, then the string is used to store label if FS_LABEL_WRITE, then the string is used to give the new label

Returns:

FALSE in case of error, see global value "fs_g_status" for more detail

TRUE otherwise

Definition at line 526 of file navigation.c.

{
   _MEM_TYPE_SLOW_   Fs_index index;
   Bool status = TRUE;

   index = nav_getindex();    // Save current position

   // Go to root dir
   if( nav_dir_root())
   {
      // Find field label
      fs_g_nav_fast.u16_entry_pos_sel_file = 0; // Go to first entry
      while( 1 )
      {
         if ( !fat_read_dir())
         {
            status = FALSE;
            break;               // error
         }
         if( fat_entry_label( FS_LABEL_READ , NULL ) )
            break;
         if( FS_ERR_ENTRY_EMPTY == fs_g_status )
            break;
         fs_g_nav_fast.u16_entry_pos_sel_file++;
      }
      if( TRUE == status )
      {
         // Find OK
         if( FS_LABEL_READ == b_action )
         {
            // Read field label
            if( !fat_entry_label( FS_LABEL_READ , sz_label ) )
               sz_label[0]=0;    // empty name
         }else{
            // Change field label
            status = fat_entry_label( FS_LABEL_WRITE , sz_label );
         }
      }
   }
   nav_gotoindex( &index );   // Restore the position
   return status;
}

U32 nav_partition_space

(

void

)

This function returns partition total space.

Returns:

number of sectors

0, in case of error

//! You shall mounted the partition before call this routine
//! 

Definition at line 579 of file navigation.c.

Referenced by ushell_cmd_free_space(), and ushell_cmd_space().

{
   fat_check_device();
   if (FS_TYPE_FAT_UNM == fs_g_nav_fast.u8_type_fat)
      return 0;
   return (fs_g_nav.u32_CountofCluster * fs_g_nav.u8_BPB_SecPerClus);
}

Here is the caller graph for this function:

U8 nav_partition_cluster_size

(

void

)

This function returns the partition cluster size.

Returns:

cluster size (unit sector)

Definition at line 592 of file navigation.c.

{
   return fs_g_nav.u8_BPB_SecPerClus;
}

U32 nav_partition_freespace

(

void

)

This function returns the partition free space.

Returns:

number of free sectors

0 in case of error or full partition

//! You shall mounted the partition before call this routine
//! 

Definition at line 606 of file navigation.c.

Referenced by ushell_cmd_free_space().

{
   fat_check_device();
   if (FS_TYPE_FAT_UNM == fs_g_nav_fast.u8_type_fat)
      return 0;
   return fat_getfreespace();
}

Here is the caller graph for this function:

U8 nav_partition_freespace_percent

(

void

)

This function returns the partition space free in percent.

Returns:

percent of free space (0% to 100%)

0% in case of error or full partition

//! To speed up the compute, the resultat have an error delta of 1%
//! 

Definition at line 624 of file navigation.c.

Referenced by ushell_cmd_free_space().

{
   fat_check_device();
   if (FS_TYPE_FAT_UNM == fs_g_nav_fast.u8_type_fat)
      return 0;
   return fat_getfreespace_percent();
}

Here is the caller graph for this function:

Bool nav_filelist_single_enable

(

Bool

b_type

)

To display in File List only the files OR directories.

Parameters:

b_type

FS_DIR to display only directories presence FS_FILE to dispaly only files presence

Returns:

FALSE in case of error, see global value "fs_g_status" for more detail

TRUE otherwise

Definition at line 645 of file navigation.c.

{
   if ( !nav_filelist_reset())
      return FALSE;

   fs_g_nav.b_mode_nav_single = TRUE;
   fs_g_nav.b_mode_nav        = b_type;
   return TRUE;
}

Bool nav_filelist_single_disable

(

void

)

To display in File List the directories AND files.

Returns:

FALSE in case of error, see global value "fs_g_status" for more detail

TRUE otherwise

Definition at line 661 of file navigation.c.

{
   fs_g_nav.b_mode_nav_single = FALSE;
   return nav_filelist_reset();
}

Bool nav_filelist_reset

(

void

)

This function resets the selection pointer, so "no file selected" in file list.

Returns:

FALSE in case of error, see global value "fs_g_status" for more detail

TRUE otherwise

Definition at line 673 of file navigation.c.

Referenced by copy_dir(), nav_dir_cd(), nav_dir_gotoparent(), nav_filelist_exist(), nav_filelist_first(), nav_filelist_goto(), nav_filelist_nb(), nav_filelist_single_disable(), nav_filelist_single_enable(), nav_gotoindex(), nav_setcwd(), ushell_cmd_ls(), and ushell_cmd_sync().

{
   if ( !fat_check_mount_noopen())
      return FALSE;

   // No file selected and reset navigation
   fat_clear_entry_info_and_ptr();
   return TRUE;
}

Here is the caller graph for this function:

Bool nav_filelist_validpos

(

void

)

This function checks if a file is selected.

Returns:

TRUE if a file is selected

FALSE if no file is selected

Definition at line 689 of file navigation.c.

{
   return fat_check_mount_select_noopen();
}

Bool nav_filelist_fileisnotopen

(

void

)

This function checks if no file is open.

Returns:

TRUE if no file is open

FALSE if a file is open

Definition at line 700 of file navigation.c.

{
   return fat_check_noopen();
}

Bool nav_filelist_set	(	U16	u16_nb,
		Bool	b_direction
	)

This function moves the selection pointer in file list.

Parameters:

	u16_nb	numbers of file to jump before stopping action 0, stop at the first file found 1, stop at the second file found
	b_direction	search direction FS_FIND_NEXT, move to next file or directory FS_FIND_PREV, move to previous file or directory

Returns:

FALSE in case of error, see global value "fs_g_status" for more detail

TRUE otherwise

//! Note: if no file is selected then nav_filelist_set( 0 , FS_NEXT ) goes to the first entry of the file list.
//! 

Definition at line 723 of file navigation.c.

Referenced by copy_dir(), nav_dir_gotoparent(), nav_filelist_bol(), nav_filelist_eol(), nav_filelist_exist(), nav_filelist_findname(), nav_filelist_first(), nav_filelist_goto(), nav_filelist_last(), nav_filelist_nb(), nav_gotoindex(), ushell_cmd_ls(), and ushell_cmd_sync().

{
   U16   u16_ptr_save_entry;
   U16   u16_save_pos_sel_file;
   Bool  b_save_entry_type;
   Bool  b_find_last_entry = FALSE;

   if ( !fat_check_mount_noopen())
      return FALSE;

   // Save the current selection
   u16_ptr_save_entry      = fs_g_nav_fast.u16_entry_pos_sel_file;
   u16_save_pos_sel_file   = fs_g_nav.u16_pos_sel_file;
   b_save_entry_type       = fs_g_nav.b_mode_nav;

   // Loop in directory
   while( 1 )
   {
      if(( FS_FIND_NEXT == b_direction )
      || ( b_find_last_entry ) )
      {
         if ( FS_END_FIND == fs_g_nav_fast.u16_entry_pos_sel_file )
         {
            // Too many files in directory (case impossible)
            fs_g_status = FS_ERR_FS;
            break;
         }
         fs_g_nav_fast.u16_entry_pos_sel_file++;      // Update entry position
      }
      else
      {
         if ( FS_NO_SEL == fs_g_nav_fast.u16_entry_pos_sel_file )
         {
            // No selected file then previous action impossible
            fs_g_status = FS_ERR_NO_FIND;
            break;
         }
         if ( 0 == fs_g_nav_fast.u16_entry_pos_sel_file )
         {
            // beginning of directory
            if ( (FS_DIR == fs_g_nav.b_mode_nav ) || fs_g_nav.b_mode_nav_single )
            {
               // End of directory scan, then no previous action possible
               fs_g_status = FS_ERR_NO_FIND;
               break;
            }
            // End of file scan, then find last directory
            b_find_last_entry = TRUE;
         }else{
            fs_g_nav_fast.u16_entry_pos_sel_file--;   // Update entry position
         }
      }

      if( !fat_read_dir())
      {
         if( FS_ERR_OUT_LIST != fs_g_status )
            break; // Error
      }else{
         if ( fat_entry_check( fs_g_nav.b_mode_nav ) )
         {
           // HERE, the file entry match with the type seached

           if( b_find_last_entry )
             continue;  // The search of last directory is on going then continue the search

           // Update position in directory
           if ( FS_FIND_NEXT == b_direction )
              fs_g_nav.u16_pos_sel_file++;
           else
              fs_g_nav.u16_pos_sel_file--;

           if (0 == u16_nb)
           {
              // It is the end of move then update file information
              fat_get_entry_info();
              return TRUE;         // NB FILE FIND
           }
           u16_nb--;
           continue;
         }
      }

      // Here error, check type of error
      if(( FS_ERR_ENTRY_EMPTY == fs_g_status )
      || ( FS_ERR_OUT_LIST    == fs_g_status ) )
      {
         // Here, end of the directory
         if( b_find_last_entry )
         {
            // Re enable the previous command at the end of directory to find the last directory entry
            b_find_last_entry = FALSE;
            fs_g_nav.b_mode_nav = FS_DIR;
            continue;
         }
         // Here, a next action is on going
         if ( (FS_FILE == fs_g_nav.b_mode_nav) || fs_g_nav.b_mode_nav_single )
         {
            // End of next file action then end of next action
            fs_g_status = FS_ERR_NO_FIND; // No file found
            break;                        // end of search
         }else{
            // End of next dir action then starts the next file action at the beginning of directory
            fs_g_nav_fast.u16_entry_pos_sel_file = 0xFFFF;
            fs_g_nav.b_mode_nav = FS_FILE;
         }
      }
   }  // end of loop while(1)

   fs_g_nav.b_mode_nav                    = b_save_entry_type;
   fs_g_nav_fast.u16_entry_pos_sel_file   = u16_ptr_save_entry;
   fs_g_nav.u16_pos_sel_file              = u16_save_pos_sel_file;
   return FALSE;
}

Here is the caller graph for this function:

U16 nav_filelist_get

(

void

)

This function returns the position of selected file in file list.

Returns:

position of selected file (0 is the first position)

FS_NO_SEL, in case of no file selected

Definition at line 843 of file navigation.c.

Referenced by nav_filelist_goto().

{
   return fs_g_nav.u16_pos_sel_file;
}

Here is the caller graph for this function:

Bool nav_filelist_goto

(

U16

u16_newpos

)

This function goes at a position in file list.

Parameters:

u16_newpos

new position to select (0 is the first position)

Returns:

FALSE in case of error, see global value "fs_g_status" for more detail

TRUE otherwise

Definition at line 856 of file navigation.c.

{
   U16 u16_current_pos;

   if( FS_NO_SEL == u16_newpos )
      return nav_filelist_reset();

   u16_current_pos = nav_filelist_get();
   if( u16_newpos < (u16_current_pos/2) )
   {
      // Restart at the beginning of list to accelerate the search
      if( !nav_filelist_reset() )
         return FALSE;
      u16_current_pos = FS_NO_SEL;
   }
   if (FS_NO_SEL == u16_current_pos)
   {
      return nav_filelist_set( u16_newpos, FS_FIND_NEXT );
   }
   else
   {
      if (u16_newpos < u16_current_pos)
      {
         return nav_filelist_set( u16_current_pos -u16_newpos -1 , FS_FIND_PREV );
      }
      if (u16_newpos > u16_current_pos)
      {
         return nav_filelist_set( u16_newpos -u16_current_pos - 1 , FS_FIND_NEXT );
      }
   }
   return TRUE;
}

Bool nav_filelist_findname	(	const FS_STRING	sz_name,
		Bool	b_match_case
	)

This function searchs a file name in file list.

Parameters:

	sz_name	name to search (UNICODE or ASCII) It must be terminate by NULL or '*' value
	b_match_case	FALSE to ignore the case

Returns:

FALSE in case of error, see global value "fs_g_status" for more detail

TRUE otherwise

//! This function starts a search at the next position of the current in file list
//! 

Definition at line 903 of file navigation.c.

Referenced by nav_setcwd().

{
   while( 1 )
   {
      if ( !nav_filelist_set( 0, FS_FIND_NEXT ))
         return FALSE;
      if ( nav_file_name( sz_name , 0 , FS_NAME_CHECK , b_match_case ))
         return TRUE;
   }
}

Here is the caller graph for this function:

Bool nav_filelist_eol

(

void

)

This function checks the end of file list.

Returns:

FALSE, NO end of file list

TRUE, in case of end of list or error

Definition at line 920 of file navigation.c.

{
   if( FALSE == nav_filelist_set( 0 , FS_FIND_NEXT ) )
      return TRUE;   // End of list or error (remark: the position haven't changed)

   if( 0 != fs_g_nav.u16_pos_sel_file )
   {
      // Go to previous position
      nav_filelist_set( 0 , FS_FIND_PREV );
   }else{
      // No select file before, then reset position
      fs_g_nav_fast.u16_entry_pos_sel_file= FS_NO_SEL;
      fs_g_nav.u16_pos_sel_file           = FS_NO_SEL;
      fs_g_nav.b_mode_nav                 = FS_DIR;
   }
   return FALSE;
}

Bool nav_filelist_bol

(

void

)

This function checks the beginning of file list.

Returns:

FALSE, it is not the beginning of file list

TRUE, in case of the file selected is the first file, or in case of error

Definition at line 944 of file navigation.c.

{
   if( FALSE == nav_filelist_set( 0 , FS_FIND_PREV ) )
      return TRUE;   // End of list or error (remark: the position haven't changed)
   // Go to previous position
   nav_filelist_set( 0 , FS_FIND_NEXT );
   return FALSE;
}

Bool nav_filelist_exist

(

Bool

b_type

)

This function checks the presence of files or directories in file list.

Parameters:

b_type

FS_DIR to check the directory presence FS_FILE to check the file presence

Returns:

TRUE, in case of a file or a directory exists

FALSE, in case of no file or no directory exists, or error

Definition at line 962 of file navigation.c.

{
   Bool status;
   U16   u16_save_position;

   // Save current position
   u16_save_position = fs_g_nav.u16_pos_sel_file;
   // Go to first file or directory
   status = nav_filelist_first( b_type );
   // Restore previous position
   nav_filelist_reset();
   if ( u16_save_position != FS_NO_SEL )
   {
      nav_filelist_set( u16_save_position , FS_FIND_NEXT );
   }
   return status;
}

U16 nav_filelist_nb

(

Bool

b_type

)

This function computes the number of files or directories in file list.

Parameters:

b_type

FS_DIR to compute the number of directories FS_FILE to compute the number of files

Returns:

number of files or directories in file list

Definition at line 988 of file navigation.c.

Referenced by nav_filelist_last().

{
   U16   u16_save_position;
   U16   u16_save_number_dir;
   U16   u16_save_number_file;

   // Save current position
   u16_save_position = fs_g_nav.u16_pos_sel_file;
   // Reset position
   if ( !nav_filelist_reset())
      return 0;
   // Scan all directory
   u16_save_number_dir  = 0;
   u16_save_number_file = 0;
   while( nav_filelist_set( 0 , FS_FIND_NEXT ) )
   {
      if( FS_FILE == fs_g_nav.b_mode_nav )
         u16_save_number_file++;    // It is a file
      else
         u16_save_number_dir++;     // It is a directory
   }
   // Restore previous position
   nav_filelist_reset();
   if ( u16_save_position != FS_NO_SEL )
   {
      nav_filelist_set( u16_save_position , FS_FIND_NEXT );
   }
   // Return the value asked
   if( FS_FILE == b_type )
      return u16_save_number_file;
   else
      return u16_save_number_dir;
}

Here is the caller graph for this function:

Bool nav_filelist_first

(

Bool

b_type

)

This function goes to at the first file or directory in file list.

Parameters:

b_type

FS_DIR to go at the first directory FS_FILE to go at the first file

Returns:

FALSE in case of error, see global value "fs_g_status" for more detail

TRUE otherwise

Definition at line 1031 of file navigation.c.

Referenced by nav_filelist_exist(), and nav_filelist_last().

{
   // Reset position
   if ( !nav_filelist_reset())
      return FALSE;
   // Find the first file or directory
   while( nav_filelist_set( 0 , FS_FIND_NEXT ) )
   {
      if( b_type == fs_g_nav.b_mode_nav )
         return TRUE;   // First file or directory found
   }
   fs_g_status = FS_ERR_NO_FIND;
   return FALSE;
}

Here is the caller graph for this function:

Bool nav_filelist_last

(

Bool

b_type

)

This function goes to at the last file or directory in file list.

Parameters:

b_type

FS_DIR to go at the last directory FS_FILE to go at the last file

Returns:

FALSE in case of error, see global value "fs_g_status" for more detail

TRUE otherwise

Definition at line 1055 of file navigation.c.

{
   U16 u16_nb;

   // Get number of file or directory
   u16_nb = nav_filelist_nb( b_type  );
   if( 0 == u16_nb )
   {
      fs_g_status = FS_ERR_NO_FIND;
      return FALSE;  // NO FILE FOUND
   }
   // Go to the first file or directory
   if ( !nav_filelist_first( b_type ))
      return FALSE;
   // If there are more one file or directory, then go to at the last of list
   if( 1 == u16_nb )
      return TRUE;
   u16_nb -= 2;
   return nav_filelist_set( u16_nb , FS_FIND_NEXT );
}

Fs_index nav_getindex

(

void

)

This function returns a small index on the selected file.

Returns:

It is a small index structure with information on selected file (disk, partition, dir, file/dir selected)

//! This routine is interresting to save a file position in small variable.
//! This pointer allow to reinit a navigator quickly with nav_gotoindex() routine.
//! 

Definition at line 1090 of file navigation.c.

Referenced by copy_dir(), firm_upgrade_run(), nav_getcwd(), nav_partition_label(), nav_setcwd(), ushell_cmd_copy(), ushell_cmd_free_space(), ushell_cmd_mount(), ushell_cmd_perform(), ushell_cmd_rm(), ushell_cmd_sync(), and ushell_task().

{
   Fs_index index;

   // Fill index structure
   index.u8_lun                  = fs_g_nav.u8_lun;
#if (FS_MULTI_PARTITION  ==  ENABLED)
   index.u8_partition            = fs_g_nav.u8_partition;
#endif
   index.u32_cluster_sel_dir     = fs_g_nav.u32_cluster_sel_dir;
   index.u16_entry_pos_sel_file  = fs_g_nav_fast.u16_entry_pos_sel_file;
   return index;
}

Here is the caller graph for this function:

Bool nav_gotoindex

(

const Fs_index _MEM_TYPE_SLOW_ *

index

)

This function selects a file in the navigator via a file index.

Parameters:

index

structure with information about file to select (disk, partition, dir, file/dir selected )

Returns:

FALSE in case of error, see global value "fs_g_status" for more detail

TRUE otherwise

//! This routine allow to reinit a navigator quickly via a file index (disk, partition, dir, file/dir selected )
//! To get a file index, you shall used the routine nav_getindex().
//! 

Definition at line 1117 of file navigation.c.

Referenced by copy_dir(), firm_upgrade_run(), nav_getcwd(), nav_partition_label(), nav_setcwd(), ushell_cmd_copy(), ushell_cmd_free_space(), ushell_cmd_mount(), ushell_cmd_perform(), ushell_cmd_rm(), ushell_cmd_sync(), and ushell_task().

{
   // Select the drive and partition corresponding at file index
   if( !nav_drive_set( index->u8_lun ))
      return FALSE;
#if (FS_MULTI_PARTITION  ==  ENABLED)
   if( !nav_partition_set(index->u8_partition))
      return FALSE;
#endif
   if( !nav_partition_mount())
      return FALSE;

   // Select the directory corresponding at file index
   fs_g_nav.u32_cluster_sel_dir   = index->u32_cluster_sel_dir;

   // Search the file position corresponding at file index
   if ( !nav_filelist_reset())
      return FALSE;
   while( fs_g_nav_fast.u16_entry_pos_sel_file != index->u16_entry_pos_sel_file )
   {
      if( !nav_filelist_set( 0 , FS_FIND_NEXT ) )
      {
         nav_filelist_reset();
         return FALSE;
      }
   }
   return TRUE;
}

Here is the caller graph for this function:

Bool nav_dir_root

(

void

)

This function initializes the file list on the root directory.

Returns:

FALSE in case of error, see global value "fs_g_status" for more detail

TRUE otherwise

Definition at line 1156 of file navigation.c.

Referenced by nav_partition_label(), and nav_setcwd().

{
   return nav_partition_mount();
}

Here is the caller graph for this function:

Bool nav_dir_is_root

(

void

)

This function check the current directory.

Returns:

FALSE the current directory selected is not the root directory

TRUE the current directory selected is the root directory

Definition at line 1167 of file navigation.c.

{
   if (!fat_check_mount_noopen())
      return FALSE;

   return (0 == fs_g_nav.u32_cluster_sel_dir);
}

Bool nav_dir_cd

(

void

)

This function enters in the selected directory in file list.

Returns:

FALSE in case of error, see global value "fs_g_status" for more detail

TRUE otherwise

//! After this routine the file list changes and contains the files and directories of the new directory.
//! By default no file is selected.
//! 

Definition at line 1186 of file navigation.c.

Referenced by copy_dir(), nav_setcwd(), and ushell_cmd_sync().

{
   if ( !fat_check_mount_select_noopen())
      return FALSE;

   // The current selection, is it a directory ?
   if ( !fat_entry_is_dir())
      return FALSE;

   // Select the current directory
   fs_g_nav.u16_entry_pos_sel_dir = fs_g_nav_fast.u16_entry_pos_sel_file;
   fs_g_nav.u32_cluster_sel_dir = fs_g_nav_entry.u32_cluster;

   // Reset file list
   if( FALSE == nav_filelist_reset())
      return FALSE;
   return TRUE;
}

Here is the caller graph for this function:

Bool nav_dir_gotoparent

(

void

)

This function goes to the parent directory.

Returns:

FALSE in case of error, see global value "fs_g_status" for more detail

TRUE otherwise

//! After, the file list changes and contains the files and directories of the new directory.
//! By default, the file selected in file list is the previous (children) directory.
//! 

Definition at line 1216 of file navigation.c.

Referenced by copy_dir(), nav_dir_name(), nav_getcwd(), nav_setcwd(), ushell_cmd_gotoparent(), and ushell_cmd_sync().

{
   U32 u32_cluster_old_dir;

   if (!fat_check_mount_noopen())
      return FALSE;

   if (0 == fs_g_nav.u32_cluster_sel_dir)
   {
      fs_g_status = FS_ERR_IS_ROOT;        // There aren't parent
      return FALSE;
   }

   // Select and read information about directory ".."
   fs_g_nav_fast.u16_entry_pos_sel_file = 1;
   if ( !fat_read_dir())
      return FALSE;
   fat_get_entry_info();
   // Save the children directory cluster
   u32_cluster_old_dir = fs_g_nav.u32_cluster_sel_dir;

   // Select the parent directory via information present in the current directory ".."
   fs_g_nav.u32_cluster_sel_dir = fs_g_nav_entry.u32_cluster;

   // Select the children directory in new directory (=parent directory)
   if( FALSE == nav_filelist_reset())
      return FALSE;
   if( fs_g_nav.b_mode_nav_single && (FS_DIR != fs_g_nav.b_mode_nav) )
      return TRUE;
   
   while( nav_filelist_set( 0 , FS_FIND_NEXT ) )
   {
      if (fs_g_nav_entry.u32_cluster == u32_cluster_old_dir)
         return TRUE;         // It is the children directory
   }
   fs_g_status = FS_ERR_FS;
   return FALSE;
}

Here is the caller graph for this function:

Bool nav_dir_name	(	FS_STRING	sz_path,
		U8	u8_size_max
	)

This function returns the directory name corresponding at the file list.

Parameters:

	sz_path	string to store the name (ASCII or UNICODE )
	u8_size_max	string size (unit ASCII or UNICODE )

Returns:

FALSE in case of error, see global value "fs_g_status" for more detail

TRUE otherwise

Definition at line 1264 of file navigation.c.

Referenced by ushell_cmd_ls().

{
   U8 u8_i, u8_character;
   Bool status = FALSE;
   U16 save_u16_entry_pos_sel_file;
   U32 save_u32_cluster_sel_dir;
   U8  save_u8_attr          ;
   U32 save_u32_cluster      ;
   U32 save_u32_size         ;
   Bool b_mode_nav_single_save;
   Bool b_mode_nav_mode_save;

   if ( !fat_check_mount_noopen())
      return FALSE;

   if (0 != fs_g_nav.u32_cluster_sel_dir)
   {
      // Save context
      save_u16_entry_pos_sel_file= fs_g_nav_fast.u16_entry_pos_sel_file;
      save_u32_cluster_sel_dir   = fs_g_nav.u32_cluster_sel_dir        ;
      save_u8_attr               = fs_g_nav_entry.u8_attr              ;
      save_u32_cluster           = fs_g_nav_entry.u32_cluster          ;
      save_u32_size              = fs_g_nav_entry.u32_size             ;
      b_mode_nav_single_save = fs_g_nav.b_mode_nav_single;
      b_mode_nav_mode_save   = fs_g_nav.b_mode_nav;
      fs_g_nav.b_mode_nav_single = TRUE;
      fs_g_nav.b_mode_nav = FS_FILE;
      // Go to parent directory and select the children directory
      if( !nav_dir_gotoparent() )
      {
         fs_g_nav.b_mode_nav_single = b_mode_nav_single_save;
         fs_g_nav.b_mode_nav = b_mode_nav_mode_save;
         return FALSE;
      }
      fs_g_nav.b_mode_nav_single = b_mode_nav_single_save ;
      fs_g_nav.b_mode_nav = b_mode_nav_mode_save;
      // Go to directory name position
      fs_g_nav_fast.u16_entry_pos_sel_file = fs_g_nav.u16_entry_pos_sel_dir;
      status = nav_file_name( sz_path  , u8_size_max , FS_NAME_GET , FALSE  );
      // Restore previous context
      fs_g_nav_fast.u16_entry_pos_sel_file= save_u16_entry_pos_sel_file;
      fs_g_nav.u32_cluster_sel_dir        = save_u32_cluster_sel_dir   ;
      fs_g_nav_entry.u8_attr              = save_u8_attr               ;
      fs_g_nav_entry.u32_cluster          = save_u32_cluster           ;
      fs_g_nav_entry.u32_size             = save_u32_size              ;
   }
   else
   {
      // No parent directory, then it is the root directory
      if( g_b_string_length )
      {
         ((FS_STR_UNICODE)sz_path )[0] = 3;  // 3 chars for path "x:"
         status = TRUE;
      }else

      // Create a device name
      for( u8_i = 0 ; u8_i<3 ; u8_i++ )
      {
         switch( u8_i )
         {
            case 0:
            u8_character = nav_drive_getname();    // Letter
            break;
            case 1:
            u8_character = ':';                     // ":"
            break;
            case 2:
            default:
            u8_character = 0;                       // end of string
            break;
         }
         if( Is_unicode )
         {
            ((FS_STR_UNICODE)sz_path )[0] = u8_character;
         }else{
            sz_path [0] = u8_character;
         }
         sz_path  += (Is_unicode? 2 : 1 );
      }
      status = TRUE;

   }
   return status;
}

Here is the caller graph for this function:

Bool nav_getcwd	(	FS_STRING	sz_path,
		U8	u8_size_path,
		Bool	b_view_file_select
	)

This function returns the full path of the selection.

Parameters:

	sz_path	string to store the path (ASCII or UNICODE )
	u8_size_path	string size (unit ASCII or UNICODE )
	b_view_file_select	TRUE, to include in path the selected file name

Returns:

FALSE in case of error, see global value "fs_g_status" for more detail

TRUE otherwise

Definition at line 1408 of file navigation.c.

{
   _MEM_TYPE_SLOW_   Fs_index index;
   _MEM_TYPE_SLOW_   U16 u16_lgt=0;    // Only used if LENGTH string mode enabled
   U8 u8_save_size_path=0, u8_i;
   Bool status = FALSE;                // Error by default

   if ( !fat_check_mount_noopen())
      return FALSE;

   index = nav_getindex();             // Save current position

   if( g_b_string_length )
   {
      u16_lgt = 1;   // 1 for NULL terminate
   }
   else
   {
      u8_save_size_path = u8_size_path;
      // Set NULL terminator at the end of path
      u8_size_path--;
      if( Is_unicode )
      {
         ((FS_STR_UNICODE)sz_path )[u8_size_path] = 0;
      }else{
         sz_path [u8_size_path]   = 0;
      }
   }

   // For each directory of path
   while( 1 )
   {
      if( b_view_file_select )
      {
         // Write the selected file or directory in path
         b_view_file_select = FALSE;
         if( !fat_check_select() )
            continue;   // No selected file or directory, then restart loop to go at the first directory of path
      }
      else
      {
         // Go to parent directory and selects the children directory
         if( !nav_dir_gotoparent() )
            break;
      }

      // Read name of selected file or directory
      if( !nav_file_name( sz_path  , u8_size_path , FS_NAME_GET, FALSE  ))
         break;

      if( g_b_string_length )
      {
         // Update total length
         u16_lgt += ((FS_STR_UNICODE)sz_path )[0]; // 0 = -1 to remove NULL terminated and +1 for '\\'
         continue;
      }

      // Compute the size of name
      u8_i = 0;
      while( 1 )
      {
         if( Is_unicode )
         {
            if( 0 == ((FS_STR_UNICODE)sz_path )[u8_i])
               break;
         }else{
            if( 0 == sz_path [u8_i])
               break;
         }
         u8_i++;
      }

      // Check the string size
      if( (u8_i+1) == u8_size_path )
      {
         fs_g_status = FS_ERR_BUFFER_FULL;   // The path string is full
         break;
      }

      // Move the name at the end of path
      while( 0 != u8_i )
      {
         u8_i--;
         u8_size_path--;
         if( Is_unicode )
         {
            ((FS_STR_UNICODE)sz_path )[u8_size_path] = ((FS_STR_UNICODE)sz_path )[u8_i];
         }else{
            sz_path [u8_size_path]   = sz_path [u8_i];
         }
      }
      // Set '\' char before the name
      u8_size_path--;
      if( Is_unicode )
      {
         ((FS_STR_UNICODE)sz_path )[u8_size_path] = '\\';
      }else{
         sz_path [u8_size_path]   = '\\';
      }
   }

   if ( FS_ERR_IS_ROOT == fs_g_status )
   {
      if( g_b_string_length )
      {
         // Update and write total length
         ((FS_STR_UNICODE)sz_path )[0] = u16_lgt +2 ; //+2 for "x:"
         status = TRUE;
      }
      else
      {
         // End of path then add device name
         if( 2 > u8_size_path )
         {
            fs_g_status = FS_ERR_BUFFER_FULL;   // The path string is full
         }
         else
         {
            // Create a device name
            if( Is_unicode )
            {
               ((FS_STR_UNICODE)sz_path )[0] = nav_drive_getname();    // Letter
               ((FS_STR_UNICODE)sz_path )[1] = ':';                   // ":"
            }else{
               sz_path [0] = nav_drive_getname();    // Letter
               sz_path [1] = ':';                      // ":"
            }

            // The path is stored at the end, then move the path at the beginning
            u8_i = 2;
            while( u8_save_size_path != u8_size_path )
            {
               if( Is_unicode )
               {
                  ((FS_STR_UNICODE)sz_path )[u8_i] = ((FS_STR_UNICODE)sz_path )[u8_size_path];
               }else{
                  sz_path [u8_i] = sz_path [u8_size_path];
               }
               u8_i++;
               u8_size_path++;
            }
            status = TRUE;
         }
      }
   } // else Error system

   nav_gotoindex( &index );   // Restore the position
   return status;
}

Bool nav_setcwd	(	FS_STRING	sz_path,
		Bool	b_match_case,
		Bool	b_create
	)

This function selects a disk position via a path.

Parameters:

	sz_path	path string (ASCII or UNICODE )
	b_match_case	FALSE to ignore the case
	b_create	TRUE, if path no exists then create it FALSE, no create path

Returns:

FALSE in case of error, see global value "fs_g_status" for more detail

TRUE otherwise

//! The syntact "./../../file_name" is supported.
//! With syntact "./dir_parent/directory_name"  the file list corresponding at "dir_parent" and "directory_name" is selected.
//! With syntact "./dir_parent/directory_name/" the file list corresponding at "directory_name" and no file is selected.
//! 

Definition at line 1575 of file navigation.c.

Referenced by firm_upgrade_searchfile(), goto_code_name(), ushell_cmd_append_file(), ushell_cmd_cat(), ushell_cmd_cd(), ushell_cmd_copy(), ushell_cmd_rename(), ushell_cmd_rm(), ushell_cmd_sync(), and ushell_cmddfu_load().

{
   _MEM_TYPE_SLOW_   Fs_index index;
#if (FSFEATURE_WRITE == (FS_LEVEL_FEATURES & FSFEATURE_WRITE)) ||              \
    (FSFEATURE_WRITE_COMPLET == (FS_LEVEL_FEATURES & FSFEATURE_WRITE_COMPLET))
   FS_STRING sz_save_path = 0;
#endif
   Bool b_create_name = FALSE;

   if ( !fat_check_noopen())
      return FALSE;

   index = nav_getindex();             // Save current position

   // Check syntact "\path..."
   if( (( Is_unicode) && (('\\'  == ((FS_STR_UNICODE)sz_path )[0]) || ('/'  == ((FS_STR_UNICODE)sz_path )[0])) )
   ||  ((!Is_unicode) && (('\\'  == sz_path [0]) || ('/'  == sz_path [0])) ) )
   {
      // Go to the root of current drive
      if( !nav_dir_root())
         goto nav_setcwd_fail;
      sz_path  += (Is_unicode? 2 : 1 );
   }else

   // Check syntact "x:\path..."
   if( (( Is_unicode) && (( ':'  == ((FS_STR_UNICODE)sz_path )[1] ) && (('\\'  == ((FS_STR_UNICODE)sz_path )[2] ) || ('/'  == ((FS_STR_UNICODE)sz_path )[2]))) )
   ||  ((!Is_unicode) && (( ':'  == sz_path [1] ) && (('\\'  == sz_path [2] ) || ('/'  == sz_path [2]))) ) )
   {
      // Go to the drive
      if( Is_unicode )
      {
         if( !nav_drive_set( toupper(((FS_STR_UNICODE)sz_path )[0])-'A' ) )
            goto nav_setcwd_fail;
      }else{
         if( !nav_drive_set( toupper(sz_path [0])-'A' ) )
            goto nav_setcwd_fail;
      }
      if( !nav_partition_mount())
         goto nav_setcwd_fail;
      sz_path  += 3*(Is_unicode? 2 : 1 );
   }else

   // Check syntact ".\path..."
   if( (( Is_unicode) && (( '.'  == ((FS_STR_UNICODE)sz_path )[0] ) && (('\\'  == ((FS_STR_UNICODE)sz_path )[1] ) || ('/'  == ((FS_STR_UNICODE)sz_path )[1] ))) )
   ||  ((!Is_unicode) && (( '.'  == sz_path [0] ) && (('\\'  == sz_path [1] ) || ('/'  == sz_path [1] ))) ) )
   {
      // Search in current directory
      sz_path  += 2*(Is_unicode? 2 : 1 );
   }else

   {
      // Check syntact "..\..\path..."
      if( Is_unicode )
      {
         while(( '.'  == ((FS_STR_UNICODE)sz_path )[0] )
         &&    ( '.'  == ((FS_STR_UNICODE)sz_path )[1] )
         &&    (('\\'  == ((FS_STR_UNICODE)sz_path )[2]) || ('/'  == ((FS_STR_UNICODE)sz_path )[2]) || (0  == ((FS_STR_UNICODE)sz_path )[2])) )
         {
            // Go to parent directory
            if( !nav_dir_gotoparent() )
               goto nav_setcwd_fail;
            sz_path  += (2*2); // jump ".."
            if( 0 != ((FS_STR_UNICODE)sz_path )[0])
               sz_path  += (2*1); // jump "/"
         }
      }else{
         while(( '.'  == sz_path [0] )
         &&    ( '.'  == sz_path [1] )
         &&    (('\\'  == sz_path [2]) || ('/'  == sz_path [2]) || (0  == sz_path [2])) )
         {
         // Go to parent directory
         if( !nav_dir_gotoparent() )
            goto nav_setcwd_fail;
            sz_path  += 2; // jump ".."
            if( 0 != sz_path [0])
               sz_path  +=1; // jump "/"
         }
      }
   }

   // Reset list to start the search at the beginning
   if( !nav_filelist_reset())
      goto nav_setcwd_fail;

   while( 1 )
   {
      if( (( Is_unicode) && ( 0 == ((FS_STR_UNICODE)sz_path )[0] ) )
      ||  ((!Is_unicode) && ( 0 == sz_path [0] ) ) )
      {
         return TRUE;   // path (without file) is found or create
      }
      if( !nav_filelist_findname( sz_path  , b_match_case  ))
      {
         // The file or directory is not found
         if( !b_create )
            goto nav_setcwd_fail;   // don't creat the directory then exit
         // Set flag to create the directory
         b_create_name = TRUE;
#if (FSFEATURE_WRITE == (FS_LEVEL_FEATURES & FSFEATURE_WRITE)) ||              \
    (FSFEATURE_WRITE_COMPLET == (FS_LEVEL_FEATURES & FSFEATURE_WRITE_COMPLET))
         sz_save_path = sz_path;
#endif
      }

      while( 1 )
      {
         sz_path  += (Is_unicode? 2 : 1 );
         if( (( Is_unicode) && ( 0 == ((FS_STR_UNICODE)sz_path )[0] ) )
         ||  ((!Is_unicode) && ( 0 == sz_path [0] ) ) )
         {
            // Is it the last name of path and it is a file
            if( b_create_name )
            {
#if (FSFEATURE_WRITE == (FS_LEVEL_FEATURES & FSFEATURE_WRITE))
               // The file must be created
               if( !nav_file_create( sz_save_path ) )
                  goto nav_setcwd_fail;
#else
               goto nav_setcwd_fail;
#endif
            }
            break;   // The file include in path is found or created, then end of set_cwd
         }

         if( (( Is_unicode) && (('\\' == ((FS_STR_UNICODE)sz_path )[0] ) || ('/' == ((FS_STR_UNICODE)sz_path )[0] )) )
         ||  ((!Is_unicode) && (('\\' == sz_path [0] ) || ('/' == sz_path [0] )) ) )
         {
            // Is it a folder name
            if( b_create_name )
            {
#if (FSFEATURE_WRITE_COMPLET == (FS_LEVEL_FEATURES & FSFEATURE_WRITE_COMPLET))
               // The folder doesn't exist and it must be created
               if( !nav_dir_make( sz_save_path ))
                  goto nav_setcwd_fail;
#else
               goto nav_setcwd_fail;
#endif
            }
            if( !fat_entry_is_dir() )
               goto nav_setcwd_fail;
            // jump '\'
            sz_path  += (Is_unicode? 2 : 1 );
            if( !nav_dir_cd())
               goto nav_setcwd_fail;
            break;
         }
      }

   }

nav_setcwd_fail:
   nav_gotoindex( &index );   // Restore the position
   return FALSE;
}

Here is the caller graph for this function:

Bool nav_file_getname	(	FS_STRING	sz_name,
		U8	u8_size_max
	)

This function returns the name of selected file.

Parameters:

	sz_name	string to store the name file (ASCII or UNICODE )
	u8_size_max	string size (unit ASCII or UNICODE )

Returns:

FALSE in case of error, see global value "fs_g_status" for more detail

TRUE otherwise

Definition at line 1745 of file navigation.c.

Referenced by firm_upgrade_run().

{
   return nav_file_name( sz_name, u8_size_max, FS_NAME_GET, FALSE );
}

Here is the caller graph for this function:

Bool nav_file_name	(	FS_STRING	sz_name,
		U8	u8_size_max,
		Bool	b_mode,
		Bool	b_match_case
	)

This function returns the name of selected file or checks the string with the name of selected file.

Parameters:

	b_mode	action mode: FS_NAME_GET to get the name of selected file FS_NAME_CHECK to check the name of selected file
	sz_name	if FS_NAME_GET then string to store the file name (ASCII or UNICODE ) if FS_NAME_CHECK then string to match with file name (ASCII or UNICODE), it must be terminated by NULL or '*' value
	b_match_case	FALSE, ignore the case (only used in "FS_NAME_CHECK" action)
	u8_size_max	string size (unit ASCII or UNICODE ), only used in "FS_NAME_GET" action

Returns:

FALSE in case of error, see global value "fs_g_status" for more detail

TRUE otherwise

Definition at line 1766 of file navigation.c.

Referenced by copy_dir(), nav_dir_name(), nav_file_getname(), nav_filelist_findname(), nav_getcwd(), ushell_cmd_copy(), ushell_cmd_ls(), and ushell_cmd_sync().

{
   _MEM_TYPE_SLOW_   U16 u16_lgt;   // Only used if LENGTH string mode enabled
   U16  u16_ptr_save_entry;
   Bool  b_readshortname = FALSE;

   if ( !fat_check_mount_select())
      return FALSE;

   // Check if the string size is not 0
   if( (FS_NAME_GET == b_mode)
   &&  (0 == u8_size_max) )
   {
      return TRUE;
   }

   // Save the current entry position
   u16_ptr_save_entry = fs_g_nav_fast.u16_entry_pos_sel_file;
   // if it is the beginning of the directory
   if ( 0 == fs_g_nav_fast.u16_entry_pos_sel_file )
   {
      b_readshortname = TRUE;                   // It isn't possibled to have a long name
   }
   else
   {
      fs_g_nav_fast.u16_entry_pos_sel_file--;   // Initialize entry position to search the first long name entry
   }

   // Loop in directory entry
   u16_lgt = 0;
   while( 1 )
   {
      if ( !fat_read_dir())
         break; // error

      if ( b_readshortname )
      {
         // No long name present then read short name
         return fat_entry_shortname( sz_name , u8_size_max , b_mode  );
      }

      // Check or read the part of long file name in this entry
      if ( fat_entry_longname( sz_name , u8_size_max , b_mode , b_match_case  ))
      {
         if( g_b_string_length )
         {
            ((FS_STR_UNICODE)sz_name )[0] += u16_lgt;
         }
         fs_g_nav_fast.u16_entry_pos_sel_file = u16_ptr_save_entry;
         return TRUE;
      }

      if ( FS_NO_LAST_LFN_ENTRY != fs_g_status )
      {
         // Go to the main entry file (=short name entry)
         fs_g_nav_fast.u16_entry_pos_sel_file = u16_ptr_save_entry;

         if ( FS_ERR_ENTRY_BAD == fs_g_status )
         {
            // It isn't a long name entry then there aren't long file name
            b_readshortname = TRUE;   // It is mandatory to use the short name
            continue;                 // restart the loop
         }
         // here, it is a error system or the string don't match with the file name
         break;
      }
      if( g_b_string_length )
      {
         u16_lgt += FS_SIZE_LFN_ENTRY;
      }
      else
      {
         // Increment the string to store the next part of file name
         sz_name += FS_SIZE_LFN_ENTRY * (Is_unicode? 2 : 1 );
         u8_size_max -= FS_SIZE_LFN_ENTRY;
      }
      fs_g_nav_fast.u16_entry_pos_sel_file--;   // Go to the next part of long file name

   }  // end of loop while(1)
   return FALSE;
}

Here is the caller graph for this function:

U32 nav_file_lgt

(

void

)

This function returns the size of selected file (unit byte).

Returns:

Size of selected file (unit byte)

Definition at line 1853 of file navigation.c.

Referenced by ushell_cmd_ls().

{
   return fs_g_nav_entry.u32_size;
}

Here is the caller graph for this function:

U16 nav_file_lgtsector

(

void

)

This function returns the size of selected file (unit sector).

Returns:

Size of selected file (unit 512B)

Definition at line 1863 of file navigation.c.

{
   return (fs_g_nav_entry.u32_size >> FS_512B_SHIFT_BIT);
}

Bool nav_file_isreadonly

(

void

)

This function checks the write protection of disk and the attribut "read only" of selected file.

Returns:

FALSE, it is possible to modify the selected file

TRUE, in other case

Definition at line 1874 of file navigation.c.

{
   if( !fat_check_mount_select() )
      return TRUE;   // No file selected
   if( mem_wr_protect( fs_g_nav.u8_lun ) )
      return TRUE;   // Disk protected
   return (0!=(FS_ATTR_READ_ONLY & fs_g_nav_entry.u8_attr));   // Check attribut "read only"
}

Bool nav_file_isdir

(

void

)

This function returns the type of selected file.

Returns:

TRUE, it is a directory

FALSE, in other case

Definition at line 1889 of file navigation.c.

Referenced by copy_dir(), ushell_cmd_ls(), and ushell_cmd_sync().

{
   return fat_entry_is_dir();
}

Here is the caller graph for this function:

Bool nav_file_checkext

(

const FS_STRING

sz_filterext

)

This function checks the extension of selected file.

Parameters:

sz_filterext

extension filter (ASCII format, e.g.: "txt" or "txt,d*,wk" )

Returns:

TRUE, the file extension match with extension filter

FALSE, in other case

Definition at line 1902 of file navigation.c.

Referenced by ushell_cmd_ls().

{
   if ( fat_check_mount_select() )
   {
      // Read selected entry (=short name entry) in directory
      if ( fat_read_dir())
      {
         // Check the extension with filter
         if ( fat_entry_checkext( (FS_STRING) sz_filterext ) )
            return TRUE;
      }
   }
   return FALSE;
}

Here is the caller graph for this function:

Bool nav_file_dateget	(	FS_STRING	sz_date,
		Bool	type_date
	)

This function returns the date of selected file.

Parameters:

	type_date	FS_DATE_LAST_WRITE, to get the date of last write access FS_DATE_CREATION, to get the date of file creation
	sz_date	ASCCI string (>17B) to store the information about date "YYYYMMDDHHMMSSMS" = year, month, day, hour, minute, seconde, miliseconde

Returns:

FALSE in case of error, see global value "fs_g_status" for more detail

TRUE otherwise

Definition at line 1928 of file navigation.c.

{
   if ( !fat_check_mount_select())
      return FALSE;

   // Read selected entry in directory
   if ( !fat_read_dir())
      return FALSE;
   fat_get_date( sz_date , type_date );
   return TRUE;
}

U8 nav_file_attributget

(

void

)

This function returns the attribut of selected file.

Returns:

attribut of selected file, see masks "FS_ATTR_" in fs_com.h file.

Definition at line 1945 of file navigation.c.

{
   return fs_g_nav_entry.u8_attr;
}

---