file.h File Reference

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

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

Include dependency graph for file.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	Fs_file_segment
Defines
options for file_seek() routine
#define	FS_SEEK_SET   0x00
	start at the beginning
#define	FS_SEEK_END   0x01
	start at the end of file and rewind
#define	FS_SEEK_CUR_RE   0x02
	start at the current position and rewind
#define	FS_SEEK_CUR_FW   0x03
	start at the current position and foward
Functions
Bool	file_ispresent (void)
	This function checks if a file is selected.
Bool	file_open (U8 fopen_mode)
	This function opens the selected file.
Bool	file_read (Fs_file_segment _MEM_TYPE_SLOW_ *segment)
	This function returns a segment (position & size) in a physical memory corresponding at the file.
U16	file_read_buf (U8 _MEM_TYPE_SLOW_ *buffer, U16 u16_buf_size)
	This function copys in a buffer the file data corresponding at the current position.
U16	file_getc (void)
	This function returns the next byte of file.
Bool	file_write (Fs_file_segment _MEM_TYPE_SLOW_ *segment)
	This function allocs and returns a segment (position & size) in a physical memory corresponding at the file.
Bool	file_set_eof (void)
	This function sets the end of file at the current position.
U16	file_write_buf (U8 _MEM_TYPE_SLOW_ *buffer, U16 u16_buf_size)
	This function transfer a buffer to a file at the current file position.
Bool	file_putc (U8 u8_byte)
	This function writes a byte in the file.
U32	file_getpos (void)
	This function returns the position in the file.
Bool	file_seek (U32 u32_pos, U8 u8_whence)
	This function changes the position in the file.
U8	file_bof (void)
	This function checks the beginning of file.
U8	file_eof (void)
	This function checks the end of file.
void	file_flush (void)
	This function flushs the internal cache (file datas and file information).
void	file_close (void)
	This function closes the file.

---

Detailed Description

FAT 12/16/32 Services.

This file defines a useful set of functions for the file accesses on AVR32 devices.

Author:

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

Definition in file file.h.

---

Define Documentation

#define FS_SEEK_SET   0x00

start at the beginning

Definition at line 51 of file file.h.

Referenced by file_seek(), and firm_upgrade_run().

#define FS_SEEK_END   0x01

start at the end of file and rewind

Definition at line 52 of file file.h.

Referenced by file_seek().

#define FS_SEEK_CUR_RE   0x02

start at the current position and rewind

Definition at line 53 of file file.h.

Referenced by file_seek().

#define FS_SEEK_CUR_FW   0x03

start at the current position and foward

Definition at line 54 of file file.h.

Referenced by file_seek().

---

Function Documentation

Bool file_ispresent

(

void

)

This function checks if a file is selected.

Returns:

TRUE, a file is selected

FALSE, otherwise

Definition at line 69 of file file.c.

References FALSE, fat_check_is_file(), and fat_check_mount_select().

{
   if( !fat_check_mount_select() )
      return FALSE;
   return fat_check_is_file();
}

Here is the call graph for this function:

Bool file_open

(

U8

fopen_mode

)

This function opens the selected file.

Parameters:

fopen_mode

option to open the file : FOPEN_MODE_R R access, flux pointer = 0, size not modify FOPEN_MODE_R_PLUS R/W access, flux pointer = 0, size not modify FOPEN_MODE_W W access, flux pointer = 0, size = 0 FOPEN_MODE_W_PLUS R/W access, flux pointer = 0, size = 0 FOPEN_MODE_APPEND W access, flux pointer = at the end, size not modify

Returns:

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

TRUE otherwise

Definition at line 89 of file file.c.

References FALSE, fat_check_is_file(), fat_check_mount_select_noopen(), fat_check_nav_access_file, FOPEN_CLEAR_PTR, FOPEN_CLEAR_SIZE, FOPEN_WRITE_ACCESS, FS_ATTR_READ_ONLY, FS_ERR_MODE_NOAVIALABLE, FS_ERR_READ_ONLY, fs_g_nav, fs_g_nav_entry, fs_g_status, FS_LUN_WP, mem_wr_protect(), TRUE, Fs_management_entry::u32_pos_in_file, Fs_management_entry::u32_size, Fs_management_entry::u8_attr, Fs_management::u8_lun, and Fs_management_entry::u8_open_mode.

{
   if( !fat_check_mount_select_noopen())
      return FALSE;

   if( !fat_check_is_file())
      return FALSE;

   if(FOPEN_WRITE_ACCESS & fopen_mode)
   {
      if( !fat_check_nav_access_file( TRUE ) )
         return FALSE;
#if (FSFEATURE_WRITE == (FS_LEVEL_FEATURES & FSFEATURE_WRITE))
      if (FS_ATTR_READ_ONLY & fs_g_nav_entry.u8_attr)
      {
         fs_g_status = FS_ERR_READ_ONLY;  // File is read only
         return FALSE;
      }
      if( mem_wr_protect( fs_g_nav.u8_lun  ))
      {
         fs_g_status = FS_LUN_WP;  // Disk read only
         return FALSE;
      }
#else
      fs_g_status = FS_ERR_MODE_NOAVIALABLE;
      return FALSE;
#endif  // FS_LEVEL_FEATURES
   }
   else
   {
      if( !fat_check_nav_access_file( FALSE ) )
         return FALSE;
   }

   if(FOPEN_CLEAR_SIZE & fopen_mode)
   {
      fs_g_nav_entry.u32_size    = 0;     // The size is null
   }
   if(FOPEN_CLEAR_PTR & fopen_mode)
   {
      fs_g_nav_entry.u32_pos_in_file = 0;
   }
   else
   {  // Go to at the end of file
      fs_g_nav_entry.u32_pos_in_file = fs_g_nav_entry.u32_size;
   }
   fs_g_nav_entry.u8_open_mode = fopen_mode;
   return TRUE;
}

Here is the call graph for this function:

Bool file_read

(

Fs_file_segment _MEM_TYPE_SLOW_ *

segment

)

This function returns a segment (position & size) in a physical memory corresponding at the file.

Parameters:

segment

Pointer on the segment structure: ->u32_size_or_pos IN, shall contains maximum number of sector to read in file (0 = unlimited) ->u32_size_or_pos OUT, containt the segment size (unit sector) ->other IN, ignored ->other OUT, contains the segment position

Returns:

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

TRUE otherwise

//! This routine is interesting to read a file via a DMA and avoid the file system decode
//! because this routine returns a physical memory segment without File System information.
//! Note: the file can be fragmented and you must call file_read() for each fragments.
//! 

Definition at line 169 of file file.c.

References FALSE, fat_check_mount_select_open(), fat_read_file(), file_eof(), file_load_segment_value(), FOPEN_READ_ACCESS, FS_512B, FS_512B_MASK, FS_512B_SHIFT_BIT, FS_CLUST_ACT_SEG, FS_ERR_EOF, FS_ERR_OUT_LIST, FS_ERR_WRITE_ONLY, fs_g_nav, fs_g_nav_entry, fs_g_seg, fs_g_status, LSB1, TRUE, Fs_management_entry::u32_pos_in_file, Fs_management_entry::u32_size, Fs_segment::u32_size_or_pos, Fs_management::u8_BPB_SecPerClus, and Fs_management_entry::u8_open_mode.

{
   U8 u8_nb_sector_truncated;

   if( !fat_check_mount_select_open())
      return FALSE;

   if(!(FOPEN_READ_ACCESS & fs_g_nav_entry.u8_open_mode))
   {
      fs_g_status = FS_ERR_WRITE_ONLY;
      return FALSE;
   }

   if ( file_eof() )
   {
      // End of the file
      fs_g_status = FS_ERR_EOF;
      return FALSE;
   }

   if( !fat_read_file(FS_CLUST_ACT_SEG))
   {
      if( FS_ERR_OUT_LIST == fs_g_status )
         fs_g_status = FS_ERR_EOF;  // translate the error
      return FALSE;
   }
   // If the segment is too large then truncate it
   if( (segment->u16_size != 0)                          // if no limit then no truncate
   &&  (segment->u16_size < fs_g_seg.u32_size_or_pos) )
   {
      u8_nb_sector_truncated   = fs_g_seg.u32_size_or_pos - segment->u16_size;
      fs_g_seg.u32_size_or_pos = segment->u16_size ;
   }else{
      u8_nb_sector_truncated = 0;
   }

   // Update file position
   fs_g_nav_entry.u32_pos_in_file += (U32)fs_g_seg.u32_size_or_pos * FS_512B;
   if( fs_g_nav_entry.u32_size < fs_g_nav_entry.u32_pos_in_file )
   {
      // The segment is more larger then file
      // case possible: if the file don't use all cluster space
      // then compute sectors not used in last cluster of file cluster list
      U8 u8_nb_sector_not_used;

      // Compute the number of sector used in last cluster
      // remark: also the two first bytes of size is used, because the cluster size can't be more larger then 64KB
      u8_nb_sector_not_used = LSB1( fs_g_nav_entry.u32_size ) >> (FS_512B_SHIFT_BIT-8);
      if( 0 != (fs_g_nav_entry.u32_size & FS_512B_MASK) )
      {  // last sector of file isn't full, but it must been read
         u8_nb_sector_not_used++;
      }

      // Compute the number of sector not used in last cluster
      u8_nb_sector_not_used = fs_g_nav.u8_BPB_SecPerClus - (u8_nb_sector_not_used % fs_g_nav.u8_BPB_SecPerClus);
      // if all space of cluster isn't used, then it is wrong
      if( u8_nb_sector_not_used == fs_g_nav.u8_BPB_SecPerClus )
         u8_nb_sector_not_used = 0; // The file uses all last cluster space

      // Subtract this value a the file position and segment size
      u8_nb_sector_not_used -= u8_nb_sector_truncated;
      fs_g_seg.u32_size_or_pos -= u8_nb_sector_not_used;                                     // unit sector
      fs_g_nav_entry.u32_pos_in_file -= ((U16)u8_nb_sector_not_used) << FS_512B_SHIFT_BIT;   // unit byte
   }
   file_load_segment_value( segment );
   return TRUE;
}

Here is the call graph for this function:

U16 file_read_buf	(	U8 _MEM_TYPE_SLOW_ *	buffer,
		U16	u16_buf_size
	)

This function copys in a buffer the file data corresponding at the current position.

Parameters:

	buffer	buffer to fill
	u16_buf_size	buffer size

Returns:

number of byte read

0, in case of error

Definition at line 246 of file file.c.

References _MEM_TYPE_FAST_, CTRL_GOOD, FALSE, fat_check_mount_select_open(), fat_read_file(), file_eof(), FOPEN_READ_ACCESS, FS_512B, FS_CLUST_ACT_ONE, FS_CLUST_ACT_SEG, FS_ERR_EOF, FS_ERR_HW, FS_ERR_OUT_LIST, FS_ERR_WRITE_ONLY, fs_g_nav, fs_g_nav_entry, fs_g_seg, fs_g_status, memcpy_ram2ram, memory_2_ram(), Fs_segment::u32_addr, Fs_management_entry::u32_pos_in_file, Fs_management_entry::u32_size, Fs_segment::u32_size_or_pos, Fs_management::u8_lun, and Fs_management_entry::u8_open_mode.

{
   _MEM_TYPE_FAST_ U16 u16_nb_read_tmp;
   _MEM_TYPE_FAST_ U16 u16_nb_read;
   _MEM_TYPE_FAST_ U16 u16_pos_in_sector;
   _MEM_TYPE_FAST_ U32 u32_byte_remaining;

   if( !fat_check_mount_select_open())
      return FALSE;

   if(!(FOPEN_READ_ACCESS & fs_g_nav_entry.u8_open_mode))
   {
      fs_g_status = FS_ERR_WRITE_ONLY;
      return FALSE;
   }

   u16_nb_read = 0;

   while( 0 != u16_buf_size )
   {
      if ( file_eof() )
      {
         fs_g_status = FS_ERR_EOF;
         return u16_nb_read;     // End of the file
      }
      u32_byte_remaining = fs_g_nav_entry.u32_size-fs_g_nav_entry.u32_pos_in_file;
      u16_pos_in_sector = fs_g_nav_entry.u32_pos_in_file % FS_512B;

      if( (0== u16_pos_in_sector)
      &&  (FS_512B <= u32_byte_remaining)
      &&  (FS_512B <= u16_buf_size)
#if __GNUC__ && __AVR32__ || __ICCAVR32__
      &&  (Test_align((U32)buffer, sizeof(U32)))
#endif
      )
      {
         // The file data sector can been directly transfer from memory to buffer (don't use internal cache)
         if( u16_buf_size <= u32_byte_remaining)
         {
            u16_nb_read_tmp = u16_buf_size;
         }else{
            u16_nb_read_tmp = u32_byte_remaining;
         }
         u16_nb_read_tmp = u16_nb_read_tmp / FS_512B;  // read a modulo sector size

         // Get following sector segment of file
         if( !fat_read_file(FS_CLUST_ACT_SEG))
         {
            if( FS_ERR_OUT_LIST == fs_g_status )
               fs_g_status = FS_ERR_EOF;  // translate the error
            return u16_nb_read;
         }
         // Truncate the segment size found if more larger than asked size
         if( u16_nb_read_tmp > fs_g_seg.u32_size_or_pos )
         {
            u16_nb_read_tmp = fs_g_seg.u32_size_or_pos;
         }else{
            fs_g_seg.u32_size_or_pos = u16_nb_read_tmp;
         }

         // Directly data tranfert from memory to buffer
         while( 0 != fs_g_seg.u32_size_or_pos )
         {
            if( CTRL_GOOD != memory_2_ram( fs_g_nav.u8_lun  , fs_g_seg.u32_addr, buffer))
            {
               fs_g_status = FS_ERR_HW;
               return u16_nb_read;
            }
            fs_g_seg.u32_size_or_pos--;
            fs_g_seg.u32_addr++;
            buffer += FS_512B;
         }
         // Translate from sector unit to byte unit
         u16_nb_read_tmp *= FS_512B;
      }
      else
      {
         // The file data can't been directly transfer from memory to buffer, the internal cache must be used

         // Tranfer data from memory to internal cache
         if( !fat_read_file( FS_CLUST_ACT_ONE ))
         {
            if( FS_ERR_OUT_LIST == fs_g_status )
            {  // Translate the error
               fs_g_status = FS_ERR_EOF;   // End of file
            }
            return u16_nb_read;
         }

         // Compute the number of data to transfer
         u16_nb_read_tmp = FS_512B - u16_pos_in_sector;  // The number is limited at sector size
         if( u16_nb_read_tmp > u32_byte_remaining )
            u16_nb_read_tmp = u32_byte_remaining;
         if( u16_nb_read_tmp > u16_buf_size )
            u16_nb_read_tmp = u16_buf_size;

         // Tranfer data from internal cache to buffer
         memcpy_ram2ram( buffer , &fs_g_sector[ u16_pos_in_sector ], u16_nb_read_tmp );
         buffer += u16_nb_read_tmp;
      }
      // Update positions
      fs_g_nav_entry.u32_pos_in_file   += u16_nb_read_tmp;
      u16_nb_read                      += u16_nb_read_tmp;
      u16_buf_size                     -= u16_nb_read_tmp;
   }
   return u16_nb_read;  // Buffer is full
}

Here is the call graph for this function:

U16 file_getc

(

void

)

This function returns the next byte of file.

Returns:

The byte readed

EOF, in case of error or end of file

Definition at line 360 of file file.c.

References fat_read_file(), FOPEN_READ_ACCESS, FS_512B_MASK, FS_CLUST_ACT_ONE, FS_EOF, FS_ERR_EOF, FS_ERR_OUT_LIST, FS_ERR_WRITE_ONLY, fs_g_nav_entry, fs_g_status, Fs_management_entry::u32_pos_in_file, Fs_management_entry::u32_size, and Fs_management_entry::u8_open_mode.

{
   U16   u16_byte;

   while(1)
   {
      if(!(FOPEN_READ_ACCESS & fs_g_nav_entry.u8_open_mode))
      {
         fs_g_status = FS_ERR_WRITE_ONLY;
         break;
      }
      if( fs_g_nav_entry.u32_size <= fs_g_nav_entry.u32_pos_in_file )
      {
         fs_g_status = FS_ERR_EOF;
         break;
      }

      if( !fat_read_file( FS_CLUST_ACT_ONE ))
      {
         if( FS_ERR_OUT_LIST == fs_g_status )
         {  // Translate the error
            fs_g_status = FS_ERR_EOF;   // End of file
         }
         break;
      }

      u16_byte = fs_g_sector[ fs_g_nav_entry.u32_pos_in_file & FS_512B_MASK ];
      fs_g_nav_entry.u32_pos_in_file++;
      return u16_byte;
   }
   return FS_EOF;   // No data readed
}

Here is the call graph for this function:

Bool file_write

(

Fs_file_segment _MEM_TYPE_SLOW_ *

segment

)

This function allocs and returns a segment (position & size) in a physical memory corresponding at the file.

Parameters:

segment

Pointer on the segment structure: ->u32_size_or_pos IN, shall contains the maximum number of sector to write in file ->u32_size_or_pos OUT, contains the segment size (unit sector) ->other IN, ignored ->other OUT, contains the segment position

Returns:

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

TRUE otherwise

//! This routine is interesting to write a file via a DMA and avoid the file system decode
//! because this routine returns a physical memory segment without File System information.
//! Note: the file can be fragmented and you must call file_write() for each fragments.
//! 

Referenced by ushell_cmd_perform_alloc().

Here is the caller graph for this function:

Bool file_set_eof

(

void

)

This function sets the end of file at the current position.

Returns:

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

TRUE otherwise

//! This routine is usualy used after the last file_write() call.
//! The file_write() routine uses the sector unit (512B),
//! and you can set a specific byte size with a file_seek() call and fiel_set_eof() call.
//! 

U16 file_write_buf	(	U8 _MEM_TYPE_SLOW_ *	buffer,
		U16	u16_buf_size
	)

This function transfer a buffer to a file at the current file position.

Parameters:

	buffer	data buffer
	u16_buf_size	data size

Returns:

number of byte write

0, in case of error

Referenced by firm_upgrade_status().

Here is the caller graph for this function:

Bool file_putc

(

U8

u8_byte

)

This function writes a byte in the file.

Parameters:

u8_byte

byte to write

Returns:

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

TRUE otherwise

Referenced by ushell_cmd_append_file().

Here is the caller graph for this function:

U32 file_getpos

(

void

)

This function returns the position in the file.

Returns:

Position in file

Definition at line 629 of file file.c.

References fat_check_mount_select_open(), fs_g_nav_entry, and Fs_management_entry::u32_pos_in_file.

{
   if( !fat_check_mount_select_open() )
      return 0;

   return fs_g_nav_entry.u32_pos_in_file;
}

Here is the call graph for this function:

Bool file_seek	(	U32	u32_pos,
		U8	u8_whence
	)

This function changes the position in the file.

Parameters:

	u32_pos	number of byte to seek
	u8_whence	direction of seek FS_SEEK_SET , start at the beginning and foward FS_SEEK_END , start at the end of file and rewind FS_SEEK_CUR_RE, start at the current position and rewind FS_SEEK_CUR_FW, start at the current position and foward

Returns:

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

TRUE otherwise

Definition at line 650 of file file.c.

References FALSE, fat_check_mount_select_open(), FS_ERR_BAD_POS, fs_g_nav_entry, fs_g_status, FS_SEEK_CUR_FW, FS_SEEK_CUR_RE, FS_SEEK_END, FS_SEEK_SET, TRUE, Fs_management_entry::u32_pos_in_file, and Fs_management_entry::u32_size.

{
   if( !fat_check_mount_select_open())
      return FALSE;

   switch(u8_whence)
   {
      case FS_SEEK_CUR_RE:
      if( fs_g_nav_entry.u32_pos_in_file < u32_pos )
      {  // Out of the limit
         fs_g_status = FS_ERR_BAD_POS;
         return FALSE;
      }
      // update the position
      fs_g_nav_entry.u32_pos_in_file -= u32_pos;
      break;

      case FS_SEEK_SET:
      if( fs_g_nav_entry.u32_size < u32_pos )
      {  // Out of the limit
         fs_g_status = FS_ERR_BAD_POS;
         return FALSE;
      }
      // update the position
      fs_g_nav_entry.u32_pos_in_file = u32_pos;
      break;

      case FS_SEEK_END:
      if( fs_g_nav_entry.u32_size < u32_pos )
      {  // Out of the limit
         fs_g_status = FS_ERR_BAD_POS;
         return FALSE;
      }
      // update the position
      fs_g_nav_entry.u32_pos_in_file = fs_g_nav_entry.u32_size - u32_pos;
      break;

      case FS_SEEK_CUR_FW:
      u32_pos += fs_g_nav_entry.u32_pos_in_file;
      if( fs_g_nav_entry.u32_size < u32_pos )
      {  // Out of the limit
         fs_g_status = FS_ERR_BAD_POS;
         return FALSE;
      }
      // update the position
      fs_g_nav_entry.u32_pos_in_file = u32_pos;
      break;
   }
   return TRUE;
}

Here is the call graph for this function:

U8 file_bof

(

void

)

This function checks the beginning of file.

Returns:

1 the position is at the beginning of file

0 the position isn't at the beginning of file

FFh error

Definition at line 708 of file file.c.

References fat_check_mount_select_open(), fs_g_nav_entry, and Fs_management_entry::u32_pos_in_file.

{
   if( !fat_check_mount_select_open() )
      return 0xFF;

   return (0 == fs_g_nav_entry.u32_pos_in_file );
}

Here is the call graph for this function:

U8 file_eof

(

void

)

This function checks the end of file.

Returns:

1 the position is at the end of file

0 the position isn't at the end of file

FFh error

Definition at line 723 of file file.c.

References fat_check_mount_select_open(), fs_g_nav_entry, Fs_management_entry::u32_pos_in_file, and Fs_management_entry::u32_size.

{
   if( !fat_check_mount_select_open() )
      return 0xFF;
   return (fs_g_nav_entry.u32_size <= fs_g_nav_entry.u32_pos_in_file );
}

Here is the call graph for this function:

void file_flush

(

void

)

This function flushs the internal cache (file datas and file information).

Definition at line 733 of file file.c.

References file_close(), fs_g_nav_entry, and Fs_management_entry::u8_open_mode.

{
   U8 save_open_mode;
   save_open_mode = fs_g_nav_entry.u8_open_mode;
   file_close();
   fs_g_nav_entry.u8_open_mode = save_open_mode;
}

Here is the call graph for this function:

void file_close

(

void

)

This function closes the file.

Definition at line 744 of file file.c.

References fat_cache_flush(), fat_check_mount_select_open(), Fat_file_close, fat_read_dir(), fat_write_entry_file(), FOPEN_WRITE_ACCESS, fs_g_nav_entry, and Fs_management_entry::u8_open_mode.

{
   // If a file is opened, then close this one
   if( fat_check_mount_select_open() )
   {

#if (FSFEATURE_WRITE == (FS_LEVEL_FEATURES & FSFEATURE_WRITE))
      if( FOPEN_WRITE_ACCESS & fs_g_nav_entry.u8_open_mode )
      {
         // Write file information
         if( !fat_read_dir() )
            return;           // error
         fat_write_entry_file();
         fat_cache_flush();   // In case of error during writing data, flush the data before exit function
      }
#endif  // FS_LEVEL_FEATURES
      Fat_file_close();
   }
}

Here is the call graph for this function:

---