开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > 多媒体 > DVD > 查看源码
fx_api.h
资源名称：tb_i86_wr_1019_1102.　[点击查看]
上传用户：super_houu
上传日期：2008-09-21
资源大小：4099k
文件大小：31k
源码类别：

DVD

开发平台：

Others

fx_api.h：源码内容
  1. /**************************************************************************/ 
  2. /*                                                                        */ 
  3. /*            Copyright (c) 1996-2002 by Express Logic Inc.               */ 
  4. /*                                                                        */ 
  5. /*  This software is copyrighted by and is the sole property of Express   */ 
  6. /*  Logic, Inc.  All rights, title, ownership, or other interests         */ 
  7. /*  in the software remain the property of Express Logic, Inc.  This      */ 
  8. /*  software may only be used in accordance with the corresponding        */ 
  9. /*  license agreement.  Any unauthorized use, duplication, transmission,  */ 
  10. /*  distribution, or disclosure of this software is expressly forbidden.  */ 
  11. /*                                                                        */
  12. /*  This Copyright notice may not be removed or modified without prior    */ 
  13. /*  written consent of Express Logic, Inc.                                */ 
  14. /*                                                                        */ 
  15. /*  Express Logic, Inc. reserves the right to modify this software        */ 
  16. /*  without notice.                                                       */ 
  17. /*                                                                        */ 
  18. /*  Express Logic, Inc.                     info@expresslogic.com         */
  19. /*  11423 West Bernardo Court               http://www.expresslogic.com   */
  20. /*  San Diego, CA  92127                                                  */
  21. /*                                                                        */
  22. /**************************************************************************/
  25. /**************************************************************************/
  26. /**************************************************************************/
  27. /**                                                                       */ 
  28. /** FileX Component                                                       */
  29. /**                                                                       */
  30. /**   Application Interface (API)                                         */
  31. /**                                                                       */
  32. /**************************************************************************/
  33. /**************************************************************************/
  36. /**************************************************************************/ 
  37. /*                                                                        */ 
  38. /*  APPLICATION INTERFACE DEFINITION                       RELEASE        */ 
  39. /*                                                                        */ 
  40. /*    fx_api.h                                            PORTABLE C      */ 
  41. /*                                                           3.0          */ 
  42. /*  AUTHOR                                                                */ 
  43. /*                                                                        */ 
  44. /*    William E. Lamie, Express Logic, Inc.                               */ 
  45. /*                                                                        */ 
  46. /*  DESCRIPTION                                                           */ 
  47. /*                                                                        */ 
  48. /*    This file defines the basic Application Interface (API) to the      */ 
  49. /*    high-performance FileX MS-DOS compatible embedded file system.      */ 
  50. /*    All service prototypes and data structure definitions are defined   */ 
  51. /*    in this file.                                                       */ 
  52. /*                                                                        */ 
  53. /*  RELEASE HISTORY                                                       */ 
  54. /*                                                                        */ 
  55. /*    DATE              NAME                      DESCRIPTION             */ 
  56. /*                                                                        */ 
  57. /*  01-01-1999     William E. Lamie         Initial Version 1.0           */ 
  58. /*  03-01-2000     William E. Lamie         Modified comment(s), added    */ 
  59. /*                                            FX_MAXIMUM_PATH constant,   */ 
  60. /*                                            added current path string,  */ 
  61. /*                                            added prototype for the     */ 
  62. /*                                            fx_system_time_get call,    */ 
  63. /*                                            and added prototypes for    */ 
  64. /*                                            utilities used by drivers,  */ 
  65. /*                                            resulting in version 1.0b.  */ 
  66. /*  01-28-2001     William E. Lamie         Modified comment(s), added    */ 
  67. /*                                            new constants, function     */ 
  68. /*                                            prototypes, local path      */ 
  69. /*                                            logic, smart FAT searching, */ 
  70. /*                                            and support for logical     */ 
  71. /*                                            sector caching, resulting   */ 
  72. /*                                            in version 2.0.             */ 
  73. /*  03-01-2002     Mohammad N. Minhaz       Modified comment(s),          */ 
  74. /*                                            added FAT32 constants and   */ 
  75. /*                                            structure fields, changed   */ 
  76. /*                                            directory name size for     */ 
  77. /*                                            long file name support,     */ 
  78. /*                                            added write protect flag,   */ 
  79. /*                                            and added support for       */ 
  80. /*                                            notification of drive when  */ 
  81. /*                                            clusters are freed,         */ 
  82. /*                                            resulting in version 3.0.   */ 
  83. /*                                                                        */
  84. /**************************************************************************/ 
  86. #ifndef  FX_API
  87. #define  FX_API
  89. #define _fx_utility_16_unsigned_read(source_ptr) 
  90.     (((((UINT) *((source_ptr) + 1)) & 0xFF) << 8) | 
  91.        ((UINT) *(source_ptr) & 0xFF))
  93. #define _fx_utility_16_unsigned_write(dest_ptr, value) 
  94.    {*((dest_ptr)) =       (UCHAR) ((value) & 0xFF);
  95.     *((dest_ptr) + 1) =   (UCHAR) (((value) >> 8) & 0xFF);}
  97. #define  _fx_utility_32_unsigned_read(source_ptr) 
  98.       (((((ULONG) *((source_ptr)+3)) & 0xFF) << 24) | 
  99.              ((((ULONG) *((source_ptr)+2)) & 0xFF) << 16) | 
  100.              ((((ULONG) *((source_ptr)+1)) & 0xFF) << 8)  | 
  101.               (((ULONG) *(source_ptr)) & 0xFF))
  103. #define _fx_utility_32_unsigned_write(dest_ptr,value) 
  104.    {*((UCHAR_PTR)(dest_ptr)) =       (UCHAR)  (((ULONG)(value)) & 0xFF);
  105.     *(((UCHAR_PTR)(dest_ptr)) + 1) =   (UCHAR) ((((ULONG)(value)) >> 8) & 0xFF);
  106.     *(((UCHAR_PTR)(dest_ptr)) + 2) =   (UCHAR) ((((ULONG)(value)) >> 16) & 0xFF);
  107.     *(((UCHAR_PTR)(dest_ptr)) + 3) =   (UCHAR) ((((ULONG)(value)) >> 24) & 0xFF);}
  110. /* Determine if a C++ compiler is being used.  If so, ensure that standard
  111.    C is used to process the API information.  */
  113. #ifdef   __cplusplus
  115. /* Yes, C++ compiler is present.  Use standard C.  */
  116. extern   "C" {
  118. #endif
  120. // Remove checking
  121. #define FX_DISABLE_ERROR_CHECKING
  123. // Added by Ofir in order to avoid semaphores and timers
  124. #define FX_NO_TIMER
  125. #define FX_NO_LOCAL_PATH
  126. #define FX_SINGLE_THREAD
  127. #define TX_NO_LOCAL_PATH
  129. /* Include the FileX port-specific file.  */
  131. #include "PlaycoreFileSysFileXHeaderfx_port.h"
  133. /* Define basic constants for FileX.  */
  135. #define FX_MEDIA_ID           0x4D454449UL
  136. #define FX_MEDIA_DIRECT_ID    0x4D454448UL
  137. #define FX_MEDIA_CLOSED_ID    0x4D454443UL
  138. #define FX_MEDIA_ABORTED_ID   0x4D454441UL
  139. #define FX_DIRECT_SUCCESS   0x91
  140. #define FX_MEDIA_INVALID    0x02
  141. #define FX_BUFFER_ERROR     0x21
  142. #define FX_FREE_CLUSTER         0x0000
  144. #define FX_FILE_ID            0x46494C45UL
  145. #define FX_FILE_CLOSED_ID     0x46494C43UL
  146. #define FX_FILE_ABORTED_ID    0x46494C41UL
  148. #define FX_MAXIMUM_PATH     255
  150. #ifdef V882_FLASH_CARD
  151. #ifdef FILEX_READ_4_SECTORS
  152. #define FX_MAX_SECTOR_CACHE 2
  153. #else
  154. #define FX_MAX_SECTOR_CACHE 2
  155. #endif
  156. #else
  157. #ifdef FILEX_READ_4_SECTORS
  158. #define FX_MAX_SECTOR_CACHE 6
  159. #else
  160. #define FX_MAX_SECTOR_CACHE 1
  161. #endif
  162. #endif
  165. /* FileX API input parameters and general constants.  */
  167. #define FX_FAIL             2          //XD_FAST_LOADING
  168. #define FX_TRUE             1
  169. #define FX_FALSE            0
  170. #define FX_NULL             0
  171. #define FX_OPEN_FOR_READ    0
  172. #define FX_OPEN_FOR_WRITE   1
  174. #define FX_NO_PARTITION        0xFFFFFFFFUL
  176. #define FX_FAT_ENTRY_START  2
  177. #define FX_DIR_ENTRY_SIZE   32UL
  178. #define FX_DIR_NAME_SIZE    8
  179. #define FX_DIR_EXT_SIZE     3
  180. #define FX_DIR_RESERVED     8
  181. #define FX_DIR_ENTRY_FREE   0xE5
  182. #define FX_DIR_ENTRY_DONE   0x00
  183. #define FX_READ_ONLY        0x01
  184. #define FX_HIDDEN           0x02
  185. #define FX_SYSTEM           0x04
  186. #define FX_VOLUME           0x08
  187. #define FX_DIRECTORY        0x10
  188. #define FX_ARCHIVE          0x20
  189. #define FX_LONG_NAME        0x0f
  191. #define FX_12_BIT_FAT_SIZE  4086
  192. #define FX_16_BIT_FAT_SIZE  65525
  194. /* Define MS-DOS FAT entry values.  */
  196. #define FX_RESERVED_1           0xFFF0
  197. #define FX_LAST_CLUSTER_1       0xFFF8
  199. #define FX_RESERVED_1_32        0x0FFFFFF0UL
  200. #define FX_LAST_CLUSTER_1_32    0x0FFFFFF8UL
  203. /* Define time/date MS-DOS constants.  */
  205. #define FX_YEAR_SHIFT       9
  206. #define FX_MONTH_SHIFT      5
  207. #define FX_HOUR_SHIFT       11
  208. #define FX_MINUTE_SHIFT     5
  210. #define FX_YEAR_MASK        0x7F
  211. #define FX_MONTH_MASK       0x0F
  212. #define FX_DAY_MASK         0x1F
  213. #define FX_HOUR_MASK        0x1F
  214. #define FX_MINUTE_MASK      0x3F
  215. #define FX_SECOND_MASK      0x1F
  216. #define FX_BASE_YEAR        1980
  217. #define FX_INITIAL_DATE     0x2C61          /* 3-1-2002 */
  218. #define FX_INITIAL_TIME     0x0000          /* 12:00 am */
  220. /* FileX API return values.  */
  222. #define FX_SUCCESS          0x00
  223. #define FX_FAT_READ_ERROR   0x03
  224. #define FX_NOT_FOUND        0x04
  225. #define FX_NOT_A_FILE       0x05
  226. #define FX_ACCESS_ERROR     0x06
  227. #define FX_NOT_OPEN         0x07
  228. #define FX_FILE_CORRUPT     0x08
  229. #define FX_END_OF_FILE      0x09
  230. #define FX_INVALID_PATH     0x0D
  231. #define FX_NOT_DIRECTORY    0x0E
  232. #define FX_NO_MORE_ENTRIES  0x0F
  233. #define FX_MEDIA_NOT_OPEN   0x11
  234. #define FX_NOT_IMPLEMENTED  0x22
  235. #define FX_WRITE_PROTECT 0x23
  236. #define FX_SECTOR_INVALID   0x89
  237. #define FX_IO_ERROR         0x90
  238. //#define FX_DIRECT_SUCCESS    0xF1
  239. #define FX_GENERAL_ERROR     0xF2
  240. #define FX_READ_ONLY_ERROR   0xF3
  243. /* FileX driver interface constants.  */
  245. #define FX_DRIVER_READ                0
  246. #define FX_DRIVER_WRITE               1
  247. #define FX_DRIVER_FLUSH               2
  248. #define FX_DRIVER_ABORT               3
  249. #define FX_DRIVER_INIT                4
  250. #define FX_DRIVER_BOOT_READ           5
  251. #define FX_DRIVER_RELEASE_SECTORS     6
  252. #define FX_DRIVER_ERASE               7
  253. #define FX_DRIVER_GET_MEDIA_GEOMETRY  8
  254. #define FX_DRIVER_GET_DEVICE_GEOMETRY 19 // new - NOTICE!
  255. #define FX_DRIVER_FORMAT_DEVICE       9
  256. #define FX_DRIVER_FORMAT_PARTITION    10
  257. #define FX_DRIVER_INIT_ON_FORMAT      11
  258. #define FX_DRIVER_OPEN_BURST          12
  259. #define FX_DRIVER_WRITE_BURST         13
  260. #define FX_DRIVER_CLOSE_BURST         14
  261. #define FX_DRIVER_CHECK_WP_STATUS     15
  263. /* Define the control block definitions for all system objects.  */
  265. /* Define media geometry structure. This structure contains fields describing
  266.    the media both physically and logically. It is initialized by calling
  267.    _fx_utility_get_media_geometry for the specified media. The structure
  268.    is divided into groups of related parameters. Changing this structure
  269.    requires good understanding of its functionality. */
  271. // These are invalid values used to initialize the parameter groups of the
  272. // structure.
  274. #define FX_UNDEF_CYLINDERS           0
  275. #define FX_UNDEF_START_END           0xFFFF
  276. #define FX_UNDEF_CLUSTER_SIZE        0
  277. #define FX_UNDEF_ROOT_ENTRIES        0
  278. #define FX_UNDEF_SIZE_IN_SECTORS     0xFFFFFFFFUL
  279. #define FX_UNDEF_SECTORS_PER_FAT     0
  280. #define FX_UNDEF_HIDDEN_SECTORS      0xFFFFFFFFUL
  281. #define FX_UNDEF_FAT_TYPE            0xFF
  282. #define FX_UNDEF_PARTITION_ALIGNMENT 0
  283. #define FX_UNDEF_MBR_SECTOR          0xFFFFFFFFUL
  285. #define FX_BOOT_SECTOR_SIZE 512
  287. typedef struct FX_GEOMETRY_STRUCT {
  289.     // Available CHS. 
  290.     USHORT uwCylinders;
  291.     USHORT uwHeads;
  292.     USHORT uwSectorsPerTrack;
  294.     // Partition Start.
  295.     USHORT uwStartHead;
  296.     USHORT uwStartSector;
  297.     USHORT uwStartCylinder;
  298.     USHORT uwEndHead;
  299.     USHORT uwEndSector;
  300.     USHORT uwEndCylinder;
  301.     ULONG  ulPartitionStartSector;
  303.     // Number of sectors in a cluster.
  304.     BYTE   bySectorsPerCluster;
  306.     // Number of 32-byte entries in the root directory.
  307.     USHORT uwRootEntries;
  309.     // Total number of sectors in the media.
  310.     ULONG  ulSizeInSectors;
  312.     // Number of sectors that make up one FAT.
  313.     USHORT uwSectorsPerFAT;
  315.     // Number of sectors from beginning of media to boot sector.
  316.     ULONG  ulHiddenSectors;
  318.     // Type of FAT.
  319.     // NOTE: This does not include FAT32, but rather FAT12, FAT16, and
  320.     // a newer version of FAT16 when the number of clusters exceeds 16
  321.     // bits (that is called here BIGDOS).
  322.     BYTE   byFatType;
  324.     #define FX_FAT12                    1
  325.     #define FX_FAT16                    4
  326.     #define FX_BIGDOS                   6
  328.     // Alignment for a first sector of a partition.
  329.     ULONG  ulPartitionAlignment;
  331.     // Number of sector on device, where MBR resides.
  332.     ULONG  ulMbrSector;
  334.     // For NANDs and NORs, this is the number of sectors that each erasable
  335.     // block contains.
  336.     USHORT uwSectorsPerBlockBits;
  338.     // This parameter refers only to NANDs. It states the type of the NAND,
  339.     // according to 4 defined groups (see FCU documentation for details).
  340.     UINT   uiNandType;
  342.     // This parameter refers only to NORs. It states the type of the NOR,
  343.     // currently supporting Intel and Amd.
  344.     UINT   uiNorType;
  346.     // This parameter refers only to NORs - it specifies if there is a special
  347.     // boot block (a block which can be erased in a smaller resolution).
  348.     BOOL   bNorBlockMapKnown;
  350. // This parameter holds the speed of the specific media we are working
  351.     // with, in case it affects calls to the FCU driver.
  352.     // The different speed options are media type specific.
  353.     UINT   uiSpeed;
  355.     // This parameter defines with which type of card we are working with - 
  356.     // SD(4bit) or MMC(1bit).
  357.     UINT   uiSdProtocol;
  360. } FX_GEOMETRY, *FX_GEOMETRY_PTR;
  363. /* Define directory entry type.  Directory entries are found in the
  364.    root directory and in directory files (sub-directories).  Default
  365.    the directory name length to 13 for 8.3 compatibility (the dot and
  366.    a NULL at the end).  The user may change this on the compilation 
  367.    command line.  */
  369. #ifndef FX_MAX_LONG_NAME_LEN
  370. //#define FX_MAX_LONG_NAME_LEN 13
  371. #define FX_MAX_LONG_NAME_LEN 65
  372. #endif
  374. typedef struct FX_DIR_ENTRY_STRUCT
  375. {
  376.     CHAR            fx_dir_entry_name[FX_MAX_LONG_NAME_LEN];
  377.     UINT            fx_dir_long_name_present;   /* 0 (default) => not present; 1 => present*/
  378.     UCHAR           fx_dir_entry_attributes;
  379.     UINT            fx_dir_entry_time;
  380.     UINT            fx_dir_entry_date;
  381.     ULONG           fx_dir_entry_cluster;
  382.     ULONG           fx_dir_entry_file_size;
  383.     ULONG           fx_dir_entry_log_sector;
  384.     ULONG           fx_dir_entry_byte_offset;
  385. } FX_DIR_ENTRY;
  388. /* Define the path data structure.  This structure will contain
  389.    the current path and the information for performing directory
  390.    entry operations.  */
  392. typedef struct FX_PATH_STRUCT
  393. {
  394.     /* Define the path information.  */
  395.     FX_DIR_ENTRY    fx_path_directory;
  396.     CHAR            fx_path_string[FX_MAXIMUM_PATH];
  397.     ULONG           fx_path_current_entry;
  398. } FX_PATH;
  400. typedef FX_PATH FX_LOCAL_PATH;
  403. /* Define the cache control data structure.  There are FX_MAX_SECTOR_CACHE
  404.    of these structures defined inside the FX_MEDIA structure.  Each entry 
  405.    maintains a cache representation of a media sector.  */
  407. typedef struct FX_CACHED_SECTOR_STRUCT
  408. {
  410.     /* Define the buffer pointer associated with this cache entry.  */
  411.     UCHAR_PTR       fx_cached_sector_memory_buffer;
  413.     /* Define the sector number that is cached.  */
  414.     ULONG           fx_cached_sector;
  416.     /* Define the flag that indicates whether or not the cached sector
  417.        has been modified and needs to be written to the media.  */
  418.     UINT            fx_cached_sector_buffer_dirty;
  420.     /* Define the next cached sector pointer.  This is used to implement
  421.        the "last used" algorithm when looking for cache entry to swap out to
  422.        the physical media.  */
  423.     struct FX_CACHED_SECTOR_STRUCT
  424.                     *fx_cached_sector_next_used;   
  426. } FX_CACHED_SECTOR;
  429. /* Define a driver function */
  431. //typedef VOID(*FX_DRIVER)(struct FX_MEDIA_STRUCT*);
  433. /* Define the media control block.  All information about each open
  434.    media device are maintained in by the FX_MEDIA data type.  */
  436. typedef struct FX_MEDIA_STRUCT
  437. {
  439.     /* Define the media ID used for error checking.  */
  440.     ULONG           fx_media_id;
  442.     /* Define the media's name.  */
  443.     CHAR_PTR        fx_media_name;
  445.     /* Define the media's protection object, which is a ThreadX semaphore.  
  446.        Only one thread is allowed to access any media or associated files
  447.        at a time.  If FX_SINGLE_THREAD is defined, the FileX services are 
  448.        going to be called from only one thread, hence the protection is 
  449.        not needed.  */
  450. #ifndef FX_SINGLE_THREAD
  451.     OS_SEMAPHORE    fx_media_protect;
  452. #endif
  454.     /* Remember the memory buffer area.  */
  455.     UCHAR_PTR       fx_media_memory_buffer;
  456.     UCHAR_PTR       fx_media_memory_buffer_orig;
  457.     ULONG           fx_media_memory_size;
  459.     /* Define the sector cache control structures for this media.  */
  460.     struct FX_CACHED_SECTOR_STRUCT
  461.                     fx_media_sector_cache[FX_MAX_SECTOR_CACHE];
  463.     /* Define the number of sectors actually cached based on the
  464.        user supplied buffer at media open time.  */
  465.     ULONG           fx_media_sector_cache_size;
  467.     /* Define the end of the cache area.  This is used to determine
  468.        if the I/O is for the internal memory of the media.  */
  469.     UCHAR_PTR       fx_media_sector_cache_end;
  471.     /* Define the list head of the cached sector entries.  This
  472.        pointer points to the most recenty used cache sector.  */
  473.     struct FX_CACHED_SECTOR_STRUCT
  474.                     *fx_media_sector_cache_list_ptr;
  476.     /* Define the basic information about the associated media.  */
  477.     UINT            fx_media_bytes_per_sector;
  478.     UINT            fx_media_sectors_per_track;
  479.     UINT            fx_media_heads;
  481.     ULONG           fx_media_total_sectors;
  482.     ULONG           fx_media_total_clusters;
  483.     UINT            fx_media_reserved_sectors;
  484.     UINT            fx_media_root_sector_start;
  485.     UINT            fx_media_root_sectors;
  486.     UINT            fx_media_data_sector_start;
  487.     UINT            fx_media_sectors_per_cluster;
  488.     UINT            fx_media_sectors_per_FAT;
  489.     UINT            fx_media_number_of_FATs;
  490.     UINT            fx_media_12_bit_FAT;
  491.     UINT            fx_media_32_bit_FAT;
  492.     ULONG           fx_media_hidden_sectors;
  493.     ULONG           fx_media_root_clus_32;
  494.     UINT            fx_media_root_directory_entries;
  495.     ULONG           fx_media_available_clusters;
  496.     ULONG           fx_media_cluster_search_start;
  497.     UCHAR           fx_media_type;
  499.     /* Define the information pertinent to the I/O driver interface.  */
  500.     VOID            *fx_media_driver_info;
  501.     UINT            fx_media_driver_request;
  502.     UINT            fx_media_driver_status;
  503.     UCHAR_PTR       fx_media_driver_buffer;
  504.     ULONG           fx_media_driver_logical_sector;
  505.     ULONG           fx_media_driver_sectors;
  506.     ULONG           fx_media_driver_physical_sector;
  507.     UINT            fx_media_driver_physical_track;
  508.     UINT            fx_media_driver_physical_head;  
  509.     UINT            fx_media_driver_write_protect;      /* The driver sets this to FX_TRUE when media is write protected.  */
  510.     UINT            fx_media_driver_free_sector_update; /* The driver sets this to FX_TRUE when it needs to know freed clusters.  */
  512.     /* Define the driver entry point.  */
  513.     //FX_DRIVER       fx_media_driver_entry;
  514.     /* Define the driver entry point.  */
  515.     VOID            (*fx_media_driver_entry)(struct FX_MEDIA_STRUCT *);
  517.     /* Define the current directory information for the media.  */
  518.     FX_PATH         fx_media_default_path;
  520.     /* Define the head pointer for the open files of this media.  */
  521.     struct FX_FILE_STRUCT
  522.                     *fx_media_opened_file_list;
  524.     /* Define the counter for keeping track of how many open files are 
  525.        present.  */
  526.     ULONG           fx_media_opened_file_count;
  528.     /* Define the next and previous link pointers for the open media list.  */
  529.     struct FX_MEDIA_STRUCT
  530.                     *fx_media_opened_next,
  531.                     *fx_media_opened_previous;
  533.     /* Define a variable for the application's use.  */
  534.     ULONG           fx_media_reserved_for_user;
  536.     /* Media geometry structure */
  537.     FX_GEOMETRY     fx_geometry;
  539. #ifdef FILEX_READ_4_SECTORS //JERRYC_2005AUG9
  540.  BYTE  fx_2nd_cache_entry;
  541. #endif
  542. } FX_MEDIA;
  544. typedef FX_MEDIA* FX_MEDIA_PTR;
  546. /* Define the FileX file control block.  All information about open
  547.    files are found in this data type.  */
  549. typedef struct FX_FORMAT_PARAMS_STRUCT
  550. {
  551.     // Volume ID.
  552.     ULONG ulVolumeId;
  554.     // Volume Label. Up to 11 are used, padded with ' '.
  555.     PCHAR szVolumeLabel;
  557.     // OEM name. Up to 8 are used, padded with ' '.
  558.     PCHAR szOemName;
  560.     // Specify number of FATs requested.
  561.     BYTE byNumOfFats;
  563. } FX_FORMAT_PARAMS, *FX_FORMAT_PARAMS_PTR;
  565. typedef struct FX_FILE_STRUCT
  566. {
  568.     /* Define the file ID used for error checking.  */
  569.     ULONG           fx_file_id;
  571.     /* Define the file's name.  */
  572.     CHAR_PTR        fx_file_name;
  574.     /* Define the open mode request.  */
  575.     UCHAR           fx_file_open_mode;
  577.     /* Define the file modified field.  */
  578.     UCHAR           fx_file_modified;
  580.     /* Define the complete directory entry structure.  */
  581.     FX_DIR_ENTRY    fx_file_dir_entry;
  583.     /* Define the data storage parameters.  */
  584.     ULONG           fx_file_total_clusters;
  585.     ULONG           fx_file_first_physical_cluster;
  586.     ULONG           fx_file_consecutive_cluster;
  588.     ULONG           fx_file_last_physical_cluster;
  590.     ULONG           fx_file_current_physical_cluster;
  591.     ULONG           fx_file_current_logical_sector;
  592.     ULONG           fx_file_current_logical_offset;
  593.     ULONG           fx_file_current_relative_cluster;
  594.     ULONG           fx_file_current_relative_sector;
  595.     ULONG           fx_file_current_file_offset;
  596.     ULONG           fx_file_current_file_size;
  597.     ULONG           fx_file_current_available_size;
  599.     /* Remember the media that is associated with this file. */
  600.     FX_MEDIA        *fx_file_media_ptr;
  602.     /* Define the pointers necessary to maintain the open file on 
  603.        the list of open files.  */
  604.     struct FX_FILE_STRUCT
  605.                     *fx_file_opened_next,
  606.                     *fx_file_opened_previous;
  607. } FX_FILE;
  610. /* Define the FileX API mappings based on the error checking 
  611.    selected by the user.  Note: this section is only applicable to 
  612.    application source code, hence the conditional that turns off this
  613.    stuff when the include file is processed by the FileX source. */
  615. #ifndef  FX_SOURCE_CODE
  618. /* Determine if error checking is desired.  If so, map API functions 
  619.    to the appropriate error checking front-ends.  Otherwise, map API
  620.    functions to the core functions that actually perform the work. 
  621.    Note: error checking is enabled by default.  */
  623. #ifdef FX_DISABLE_ERROR_CHECKING
  625. /* Services without error checking.  */
  627. #define fx_system_initialize            _fx_system_initialize
  628. #define fx_system_date_set              _fx_system_date_set
  629. #define fx_system_time_set              _fx_system_time_set
  630. #define fx_system_date_get              _fx_system_date_get
  631. #define fx_system_time_get              _fx_system_time_get
  633. #define fx_partition_create             _fx_partition_create
  634. #define fx_partition_format             _fx_partition_format
  636. #define fx_media_open                   _fx_media_open
  637. #define fx_media_invalidate             _fx_media_invalidate
  638. #define fx_media_close                  _fx_media_close
  639. #define fx_media_full_format            _fx_media_full_format
  640. #define fx_media_quick_format           _fx_media_quick_format
  641. #define fx_media_flush                  _fx_media_flush
  642. #define fx_media_space_available        _fx_media_space_available
  643. #define fx_media_read                   _fx_media_read
  644. #define fx_media_write                  _fx_media_write
  645. #define fx_media_erase                  _fx_media_erase
  646. #define fx_media_abort                  _fx_media_abort
  648. #define fx_directory_create             _fx_directory_create
  649. #define fx_directory_delete             _fx_directory_delete
  650. #define fx_directory_rename             _fx_directory_rename
  651. #define fx_directory_first_entry_find   _fx_directory_first_entry_find
  652. #define fx_directory_next_entry_find    _fx_directory_next_entry_find
  653. #define fx_directory_first_full_entry_find _fx_directory_first_full_entry_find
  654. #define fx_directory_next_full_entry_find  _fx_directory_next_full_entry_find
  655. #define fx_directory_name_test          _fx_directory_name_test
  656. #define fx_directory_information_get    _fx_directory_information_get
  657. #define fx_directory_default_set        _fx_directory_default_set
  658. #define fx_directory_default_get        _fx_directory_default_get
  659. #define fx_directory_local_path_clear   _fx_directory_local_path_clear
  660. #define fx_directory_local_path_get     _fx_directory_local_path_get
  661. #define fx_directory_local_path_set     _fx_directory_local_path_set
  662. #define fx_directory_local_path_restore _fx_directory_local_path_restore
  664. #define fx_file_create                  _fx_file_create
  665. #define fx_file_delete                  _fx_file_delete
  666. #define fx_file_rename                  _fx_file_rename
  667. #define fx_file_attributes_set          _fx_file_attributes_set
  668. #define fx_file_attributes_read         _fx_file_attributes_read
  669. #define fx_file_open                    _fx_file_open
  670. #define fx_file_close                   _fx_file_close
  671. #define fx_file_read                    _fx_file_read
  672. #define fx_file_write                   _fx_file_write
  673. #define fx_file_allocate                _fx_file_allocate
  674. #define fx_file_best_effort_allocate    _fx_file_best_effort_allocate
  675. #define fx_file_seek                    _fx_file_seek
  676. #define fx_file_relative_seek           _fx_file_relative_seek
  677. #define fx_file_truncate                _fx_file_truncate
  678. #define fx_file_open_by_addr            _fx_file_open_by_addr
  679. #else
  681. /* Services with error checking.  */
  683. #define fx_system_initialize            _fx_system_initialize
  684. #define fx_system_date_set              _fxe_system_date_set
  685. #define fx_system_time_set              _fxe_system_time_set
  686. #define fx_system_date_get              _fxe_system_date_get
  687. #define fx_system_time_get              _fxe_system_time_get
  689. #define fx_partition_create             _fxe_partition_create
  690. #define fx_partition_format             _fxe_partition_format
  692. #define fx_media_open                   _fxe_media_open
  693. #define fx_media_invalidate             _fxe_media_invalidate
  694. #define fx_media_close                  _fxe_media_close
  695. #define fx_media_full_format            _fxe_media_full_format
  696. #define fx_media_quick_format           _fxe_media_quick_format
  697. #define fx_media_flush                  _fxe_media_flush
  698. #define fx_media_space_available        _fxe_media_space_available
  699. #define fx_media_read                   _fxe_media_read
  700. #define fx_media_write                  _fxe_media_write
  701. #define fx_media_erase                  _fxe_media_erase
  702. #define fx_media_abort                  _fxe_media_abort
  704. #define fx_directory_create             _fxe_directory_create
  705. #define fx_directory_delete             _fxe_directory_delete
  706. #define fx_directory_rename             _fxe_directory_rename
  707. #define fx_directory_first_entry_find   _fxe_directory_first_entry_find
  708. #define fx_directory_next_entry_find    _fxe_directory_next_entry_find
  709. #define fx_directory_first_full_entry_find _fxe_directory_first_full_entry_find
  710. #define fx_directory_next_full_entry_find  _fxe_directory_next_full_entry_find
  711. #define fx_directory_name_test          _fxe_directory_name_test
  712. #define fx_directory_information_get    _fxe_directory_information_get
  713. #define fx_directory_default_set        _fxe_directory_default_set
  714. #define fx_directory_default_get        _fxe_directory_default_get
  715. #define fx_directory_local_path_clear   _fxe_directory_local_path_clear
  716. #define fx_directory_local_path_get     _fxe_directory_local_path_get
  717. #define fx_directory_local_path_set     _fxe_directory_local_path_set
  718. #define fx_directory_local_path_restore _fxe_directory_local_path_restore
  720. #define fx_file_create                  _fxe_file_create
  721. #define fx_file_delete                  _fxe_file_delete
  722. #define fx_file_rename                  _fxe_file_rename
  723. #define fx_file_attributes_set          _fxe_file_attributes_set
  724. #define fx_file_attributes_read         _fxe_file_attributes_read
  725. #define fx_file_open                    _fxe_file_open
  726. #define fx_file_close                   _fxe_file_close
  727. #define fx_file_read                    _fxe_file_read
  728. #define fx_file_write                   _fxe_file_write
  729. #define fx_file_allocate                _fxe_file_allocate
  730. #define fx_file_best_effort_allocate    _fxe_file_best_effort_allocate
  731. #define fx_file_seek                    _fxe_file_seek
  732. #define fx_file_relative_seek           _fxe_file_relative_seek
  733. #define fx_file_truncate                _fxe_file_truncate
  735. #endif
  737. /* Define prototype for utility services commonly used by FileX I/O Drivers.  This eliminates the
  738.    need to include internal FileX component files in I/O drivers.  */
  740. UINT        _fx_partition_offset_calculate( VOID  *part_sector,
  741.                                             UINT   partition,
  742.                                             ULONG *partition_start,
  743.                                             ULONG *partition_size );
  745. UINT        _fx_media_open(FX_MEDIA *media_ptr, CHAR *media_name,
  746.                  VOID (*media_driver)(FX_MEDIA *), VOID *driver_info_ptr, 
  747.                  VOID *memory_ptr, ULONG memory_size, UINT partition);
  750. #endif
  752. /* Determine if a C++ compiler is being used.  If so, complete the standard
  753.    C conditional started above.  */
  754. #ifdef   __cplusplus
  755.         }
  756. #endif
  758. #endif