navigation.h

Go to the documentation of this file.

/*This file has been prepared for Doxygen automatic documentation generation.*/
/* Copyright (C) 2006-2008, Atmel Corporation All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. The name of ATMEL may not be used to endorse or promote products derived
 * from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY ATMEL ``AS IS'' AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE EXPRESSLY AND
 * SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT,
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _NAVIGATION_H_
#define _NAVIGATION_H_

#include "fs_com.h"
#include "fat.h"

#define  FS_FIND_NEXT      TRUE     
#define  FS_FIND_PREV      FALSE    



//**********************************************************************
//************************ String format select ************************

void  nav_string_unicode( void );

void  nav_string_ascii( void );

void  nav_string_length_enable( void );

void  nav_string_length_disable( void );

//**********************************************************************
//********************** To optimize speed access **********************

void  nav_checkdisk_disable( void );

void  nav_checkdisk_enable( void );


//**********************************************************************
//************** Initialise or Stop navigation module ****************** 


void  nav_reset( void );

void  nav_exit( void );

Bool  nav_select( U8 u8_idnav );

U8    nav_get( void );

Bool  nav_copy( U8 u8_idnav );


//**********************************************************************
//********************* Drive navigation functions *********************


U8    nav_drive_nb( void );

Bool  nav_drive_set( U8 u8_number );

U8    nav_drive_get( void );

U8    nav_drive_getname( void );

Bool  nav_drive_format( U8 u8_fat_type );


//**********************************************************************
//******************* Partition navigation functions ******************* 


U8    nav_partition_nb( void );

Bool  nav_partition_set( U8 partition_number );

Bool  nav_partition_mount( void );

U8    nav_partition_type( void );

Bool  nav_partition_serialnumber( Bool b_action , U8 _MEM_TYPE_SLOW_ *a_u8_sn );

Bool  nav_partition_label( Bool b_action , FS_STRING sz_label );

U32   nav_partition_space( void );

U8    nav_partition_cluster_size( void );

U32   nav_partition_freespace( void );

U8    nav_partition_freespace_percent( void );


//**********************************************************************
//****************** File list navigation functions ******************** 

Bool  nav_filelist_single_enable( Bool b_type );

Bool  nav_filelist_single_disable( void );

Bool  nav_filelist_reset( void );

Bool  nav_filelist_validpos( void );

Bool  nav_filelist_fileisnotopen( void );

Bool  nav_filelist_set( U16 u16_nb , Bool b_direction );

U16   nav_filelist_get( void );

Bool  nav_filelist_goto( U16 u16_newpos );

Bool  nav_filelist_findname( const FS_STRING sz_name , Bool b_match_case );

Bool  nav_filelist_eol( void );

Bool  nav_filelist_bol( void );

Bool  nav_filelist_exist( Bool b_type );

U16   nav_filelist_nb( Bool b_type );

Bool  nav_filelist_first( Bool b_type );

Bool  nav_filelist_last( Bool b_type );

//**********************************************************************
//************************ Index functions *****************************


Fs_index nav_getindex( void );

Bool  nav_gotoindex( const Fs_index _MEM_TYPE_SLOW_ *index );

//**********************************************************************
//************************ Directory functions *************************


Bool  nav_dir_root( void );

Bool  nav_dir_is_root( void );

Bool  nav_dir_cd( void );

Bool  nav_dir_gotoparent( void );

Bool  nav_dir_name( FS_STRING sz_path  , U8 u8_size_max  );

Bool  nav_dir_make( const FS_STRING sz_name  );

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

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


//**********************************************************************
//*********************** File control functions ***********************


Bool nav_file_getname( FS_STRING sz_name, U8 u8_size_max );

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

U32   nav_file_lgt( void );

U16   nav_file_lgtsector( void );

Bool  nav_file_isreadonly( void );

Bool  nav_file_isdir( void );

Bool  nav_file_checkext( const FS_STRING sz_filterext );

Bool  nav_file_dateget( FS_STRING sz_date , Bool type_date );

U8    nav_file_attributget( void );

Bool  nav_file_dateset( const FS_STRING sz_date , Bool type_date );

Bool  nav_file_attributset( U8 u8_attribut );

Bool  nav_file_del( Bool b_only_empty );
  
Bool  nav_file_rename( const FS_STRING sz_name  );

Bool  nav_file_create( const FS_STRING sz_name  );

Bool  nav_file_copy( void );

Bool  nav_file_paste_start( const FS_STRING sz_name  );

U8    nav_file_paste_state( Bool b_stop );

#endif  // _NAVIGATION_H_

---