fs_com.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 AND FITNESS FOR A PARTICULAR PURPOSE 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 _FAT_COM_H_
#define _FAT_COM_H_

#include "conf_explorer.h"

#undef _GLOBEXT_
#if (defined _fat_c_)
#  define _GLOBEXT_
#else
#  define _GLOBEXT_ extern
#endif


//------- Check configuration defined in conf_explorer.h

#ifndef  FS_FAT_12
#  error FS_FAT_12 must be defined with ENABLED or DISABLED in conf_explorer.h
#endif
#ifndef  FS_FAT_16
#  error FS_FAT_16 must be defined with ENABLED or DISABLED in conf_explorer.h
#endif
#ifndef  FS_FAT_32
#  error FS_FAT_32 must be defined with ENABLED or DISABLED in conf_explorer.h
#endif

#ifndef  FS_MULTI_PARTITION
#  error FS_MULTI_PARTITION must be defined with ENABLED or DISABLED in conf_explorer.h
#endif
#ifndef  FS_NB_NAVIGATOR
#  error FS_NB_NAVIGATOR must be defined in conf_explorer.h
#endif


//_____ D E F I N I T I O N S ______________________________________________


//**** Defines used in function parameters

#define  FS_NAME_GET          TRUE
#define  FS_NAME_CHECK        FALSE

#define  FS_SN_READ           TRUE
#define  FS_SN_WRITE          FALSE

#define  FS_LABEL_READ        TRUE
#define  FS_LABEL_WRITE       FALSE

#define  COPY_BUSY            0x00
#define  COPY_FAIL            0x01
#define  COPY_FINISH          0x02

#define  FS_DATE_CREATION     TRUE
#define  FS_DATE_LAST_WRITE   FALSE

#define  FS_FILE              TRUE
#define  FS_DIR               FALSE

#define  FS_ID_DIR_EMPTY      0xFFFFFFFF     // ID no directory = bad cluster
#define  FS_ID_DIR_ROOT       0              // ID of the root directory is always the cluster 0

#define  FS_ATTR_FILE         ((Byte)0x00)   // Normal File attribute
#define  FS_ATTR_READ_ONLY    ((Byte)0x01)   // Read Only File attribute
#define  FS_ATTR_HIDDEN       ((Byte)0x02)   // Hidden File attribute
#define  FS_ATTR_SYSTEM       ((Byte)0x04)   // System File attribute
#define  FS_ATTR_VOLUME_ID    ((Byte)0x08)   // Volume id attribute
#define  FS_ATTR_DIRECTORY    ((Byte)0x10)   // Directory attribute
#define  FS_ATTR_ARCHIVE      ((Byte)0x20)   // Archive attribute
#define  FS_ATTR_LFN_ENTRY    ((Byte)0x0F)   // LFN entry attribute
#define  Fat_is_not_a_file    ((FS_ATTR_DIRECTORY & fs_g_nav_entry.u8_attr) || (FS_ATTR_VOLUME_ID & fs_g_nav_entry.u8_attr))

#define  FOPEN_READ_ACCESS    0x01                                                                    // autorize the read access
#define  FOPEN_WRITE_ACCESS   0x02                                                                    // autorize the write access
#define  FOPEN_CLEAR_SIZE     0x04                                                                    // reset size
#define  FOPEN_CLEAR_PTR      0x08                                                                    // reset flux pointer
#define  FOPEN_MODE_R         (FOPEN_READ_ACCESS|FOPEN_CLEAR_PTR)                                     
#define  FOPEN_MODE_R_PLUS    (FOPEN_READ_ACCESS|FOPEN_WRITE_ACCESS|FOPEN_CLEAR_PTR)                  
#define  FOPEN_MODE_W         (FOPEN_WRITE_ACCESS|FOPEN_CLEAR_PTR|FOPEN_CLEAR_SIZE)                   
#define  FOPEN_MODE_W_PLUS    (FOPEN_READ_ACCESS|FOPEN_WRITE_ACCESS|FOPEN_CLEAR_PTR|FOPEN_CLEAR_SIZE) 
#define  FOPEN_MODE_APPEND    (FOPEN_WRITE_ACCESS)                                                    


#define  FS_EOF               0xFFFF

#define  FS_FORMAT_DEFAULT       0x01     
#define  FS_FORMAT_FAT           0x02     
#define  FS_FORMAT_FAT32         0x03     
#define  FS_FORMAT_NOMBR_FLAG    0x80     
#define  FS_FORMAT_DEFAULT_NOMBR (FS_FORMAT_NOMBR_FLAG | FS_FORMAT_DEFAULT)  
#define  FS_FORMAT_FAT_NOMBR     (FS_FORMAT_NOMBR_FLAG | FS_FORMAT_FAT)
#define  FS_FORMAT_FAT32_NOMBR   (FS_FORMAT_NOMBR_FLAG | FS_FORMAT_FAT32)


//**** communication STRUCTURES

typedef U16 UNICODE;
typedef char      _MEM_TYPE_SLOW_ * FS_STRING;
typedef UNICODE   _MEM_TYPE_SLOW_ * FS_STR_UNICODE;

typedef struct {
   U8    u8_lun;                       
#if (FS_MULTI_PARTITION == ENABLED)
   U8    u8_partition;                 
#endif
   U32   u32_cluster_sel_dir;          
   U16   u16_entry_pos_sel_file;       
} Fs_index;


//**** ERROR CODE

#define  FS_ERR_HW               (FAIL+0)    
#define  FS_ERR_NO_FORMAT        (FAIL+1)    
#define  FS_ERR_NO_PART          (FAIL+2)    
#define  FS_ERR_NO_SUPPORT_PART  (FAIL+3)    
#define  FS_ERR_TOO_FILE_OPEN    (FAIL+4)    
#define  FS_ERR_END_OF_DRIVE     (FAIL+5)    
#define  FS_ERR_BAD_POS          (FAIL+6)    
#define  FS_ERR_FS               (FAIL+7)    
#define  FS_ERR_NO_FIND          (FAIL+8)    
#define  FS_ERR_ENTRY_EMPTY      (FAIL+9)    
#define  FS_ERR_ENTRY_BAD        (FAIL+10)   
#define  FS_ERR_ENTRY_BADTYPE    (FAIL+11)   
#define  FS_ERR_NO_DIR           (FAIL+12)   
#define  FS_ERR_NO_MOUNT         (FAIL+13)   
#define  FS_ERR_NO_FILE_SEL      (FAIL+14)   
#define  FS_NO_LAST_LFN_ENTRY    (FAIL+15)   

#define  FS_ERR_ID_FILE          (FAIL+17)   
#define  FS_ERR_NO_FILE          (FAIL+18)   
#define  FS_LUN_WP               (FAIL+19)   
#define  FS_ERR_READ_ONLY        (FAIL+20)   
#define  FS_ERR_NAME_INCORRECT   (FAIL+21)   
#define  FS_ERR_FILE_NO_OPEN     (FAIL+22)   
#define  FS_ERR_HW_NO_PRESENT    (FAIL+23)   
#define  FS_ERR_IS_ROOT          (FAIL+24)   
#define  FS_ERR_OUT_LIST         (FAIL+25)   
#define  FS_ERR_NO_FREE_SPACE    (FAIL+26)   
#define  FS_ERR_INCORRECT_NAME   (FAIL+27)   
#define  FS_ERR_DIR_NOT_EMPTY    (FAIL+28)   
#define  FS_ERR_WRITE_ONLY       (FAIL+29)   
#define  FS_ERR_MODE_NOAVIALABLE (FAIL+30)   
#define  FS_ERR_EOF              (FAIL+31)   
#define  FS_ERR_BAD_SIZE_FAT     (FAIL+32)   
#define  FS_ERR_COMMAND          (FAIL+33)   
#define  FS_ERR_BUFFER_FULL      (FAIL+34)   
#define  FS_ERR_COPY_DIR         (FAIL+35)   
#define  FS_ERR_COPY_RUNNING     (FAIL+36)   
#define  FS_ERR_COPY_IMPOSSIBLE  (FAIL+37)   
#define  FS_ERR_BAD_NAV          (FAIL+38)   
#define  FS_ERR_FILE_OPEN        (FAIL+39)   
#define  FS_ERR_FILE_OPEN_WR     (FAIL+40)   
#define  FS_ERR_FILE_EXIST       (FAIL+41)   
#define  FS_ERR_NAME_TOO_LARGE   (FAIL+42)   

#define  FS_ERR_PL_NOT_OPEN      (FAIL+50)   
#define  FS_ERR_PL_ALREADY_OPEN  (FAIL+51)   
#define  FS_ERR_PL_LST_END       (FAIL+52)   
#define  FS_ERR_PL_LST_BEG       (FAIL+53)   
#define  FS_ERR_PL_OUT_LST       (FAIL+54)   
#define  FS_ERR_PL_READ_ONLY     (FAIL+55)   



#define  FSFEATURE_READ                0x00  
#define  FSFEATURE_WRITE               0x02  
#define  FSFEATURE_WRITE_COMPLET       0x06  
#define  FSFEATURE_ALL                 0xFF  



typedef  U8                   Fs_status;
_GLOBEXT_ _MEM_TYPE_SLOW_ Fs_status fs_g_status;

#endif  // _FAT_COM_H_

---