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

源码开发语言/平台
当前位置：首页 > 源码/资料 > 多媒体 > 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 "PlaycoreFileSysFileXfx_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. #ifndef FX_TEST_CACHE
  152. #ifdef FILEX_READ_4_SECTORS
  153. #define FX_MAX_SECTOR_CACHE 6
  154. #else
  155. #define FX_MAX_SECTOR_CACHE 1
  156. #endif
  157.     
  158. #else
  159. #define FX_MAX_SECTOR_CACHE 16
  160. #endif
  163. /* FileX API input parameters and general constants.  */
  165. #define FX_TRUE             1
  166. #define FX_FALSE            0
  167. #define FX_NULL             0
  168. #define FX_OPEN_FOR_READ    0
  169. #define FX_OPEN_FOR_WRITE   1
  171. #define FX_NO_PARTITION        0xFFFFFFFFUL
  173. #define FX_FAT_ENTRY_START  2
  174. #define FX_DIR_ENTRY_SIZE   32UL
  175. #define FX_DIR_NAME_SIZE    8
  176. #define FX_DIR_EXT_SIZE     3
  177. #define FX_DIR_RESERVED     8
  178. #define FX_DIR_ENTRY_FREE   0xE5
  179. #define FX_DIR_ENTRY_DONE   0x00
  180. #define FX_READ_ONLY        0x01
  181. #define FX_HIDDEN           0x02
  182. #define FX_SYSTEM           0x04
  183. #define FX_VOLUME           0x08
  184. #define FX_DIRECTORY        0x10
  185. #define FX_ARCHIVE          0x20
  186. #define FX_LONG_NAME        0x0f
  188. #define FX_12_BIT_FAT_SIZE  4086
  189. #define FX_16_BIT_FAT_SIZE  65525
  191. /* Define MS-DOS FAT entry values.  */
  193. #define FX_RESERVED_1           0xFFF0
  194. #define FX_LAST_CLUSTER_1       0xFFF8
  196. #define FX_RESERVED_1_32        0x0FFFFFF0UL
  197. #define FX_LAST_CLUSTER_1_32    0x0FFFFFF8UL
  200. /* Define time/date MS-DOS constants.  */
  202. #define FX_YEAR_SHIFT       9
  203. #define FX_MONTH_SHIFT      5
  204. #define FX_HOUR_SHIFT       11
  205. #define FX_MINUTE_SHIFT     5
  207. #define FX_YEAR_MASK        0x7F
  208. #define FX_MONTH_MASK       0x0F
  209. #define FX_DAY_MASK         0x1F
  210. #define FX_HOUR_MASK        0x1F
  211. #define FX_MINUTE_MASK      0x3F
  212. #define FX_SECOND_MASK      0x1F
  213. #define FX_BASE_YEAR        1980
  214. #define FX_INITIAL_DATE     0x2C61          /* 3-1-2002 */
  215. #define FX_INITIAL_TIME     0x0000          /* 12:00 am */
  217. /* FileX API return values.  */
  219. #define FX_SUCCESS          0x00
  220. #define FX_FAT_READ_ERROR   0x03
  221. #define FX_NOT_FOUND        0x04
  222. #define FX_NOT_A_FILE       0x05
  223. #define FX_ACCESS_ERROR     0x06
  224. #define FX_NOT_OPEN         0x07
  225. #define FX_FILE_CORRUPT     0x08
  226. #define FX_END_OF_FILE      0x09
  227. #define FX_INVALID_PATH     0x0D
  228. #define FX_NOT_DIRECTORY    0x0E
  229. #define FX_NO_MORE_ENTRIES  0x0F
  230. #define FX_MEDIA_NOT_OPEN   0x11
  231. #define FX_NOT_IMPLEMENTED  0x22
  232. #define FX_WRITE_PROTECT 0x23
  233. #define FX_SECTOR_INVALID   0x89
  234. #define FX_IO_ERROR         0x90
  235. //#define FX_DIRECT_SUCCESS    0xF1
  236. #define FX_GENERAL_ERROR     0xF2
  237. #define FX_READ_ONLY_ERROR   0xF3
  240. /* FileX driver interface constants.  */
  242. #define FX_DRIVER_READ                0
  243. #define FX_DRIVER_WRITE               1
  244. #define FX_DRIVER_FLUSH               2
  245. #define FX_DRIVER_ABORT               3
  246. #define FX_DRIVER_INIT                4
  247. #define FX_DRIVER_BOOT_READ           5
  248. #define FX_DRIVER_RELEASE_SECTORS     6
  249. #define FX_DRIVER_ERASE               7
  250. #define FX_DRIVER_GET_MEDIA_GEOMETRY  8
  251. #define FX_DRIVER_GET_DEVICE_GEOMETRY 9 // new - NOTICE!
  252. #define FX_DRIVER_FORMAT_DEVICE       9
  253. #define FX_DRIVER_FORMAT_PARTITION    10
  254. #define FX_DRIVER_INIT_ON_FORMAT      11
  255. #define FX_DRIVER_OPEN_BURST          12
  256. #define FX_DRIVER_WRITE_BURST         13
  257. #define FX_DRIVER_CLOSE_BURST         14
  258. #define FX_DRIVER_CHECK_WP_STATUS     15
  260. /* Define the control block definitions for all system objects.  */
  262. /* Define media geometry structure. This structure contains fields describing
  263.    the media both physically and logically. It is initialized by calling
  264.    _fx_utility_get_media_geometry for the specified media. The structure
  265.    is divided into groups of related parameters. Changing this structure
  266.    requires good understanding of its functionality. */
  268. // These are invalid values used to initialize the parameter groups of the
  269. // structure.
  271. #define FX_UNDEF_CYLINDERS           0
  272. #define FX_UNDEF_START_END           0xFFFF
  273. #define FX_UNDEF_CLUSTER_SIZE        0
  274. #define FX_UNDEF_ROOT_ENTRIES        0
  275. #define FX_UNDEF_SIZE_IN_SECTORS     0xFFFFFFFFUL
  276. #define FX_UNDEF_SECTORS_PER_FAT     0
  277. #define FX_UNDEF_HIDDEN_SECTORS      0xFFFFFFFFUL
  278. #define FX_UNDEF_FAT_TYPE            0xFF
  279. #define FX_UNDEF_PARTITION_ALIGNMENT 0
  280. #define FX_UNDEF_MBR_SECTOR          0xFFFFFFFFUL
  282. #define FX_BOOT_SECTOR_SIZE 512
  284. typedef struct FX_GEOMETRY_STRUCT {
  286.     // Available CHS. 
  287.     USHORT uwCylinders;
  288.     USHORT uwHeads;
  289.     USHORT uwSectorsPerTrack;
  291.     // Partition Start.
  292.     USHORT uwStartHead;
  293.     USHORT uwStartSector;
  294.     USHORT uwStartCylinder;
  295.     USHORT uwEndHead;
  296.     USHORT uwEndSector;
  297.     USHORT uwEndCylinder;
  298.     ULONG  ulPartitionStartSector;
  300.     // Number of sectors in a cluster.
  301.     BYTE   bySectorsPerCluster;
  303.     // Number of 32-byte entries in the root directory.
  304.     USHORT uwRootEntries;
  306.     // Total number of sectors in the media.
  307.     ULONG  ulSizeInSectors;
  309.     // Number of sectors that make up one FAT.
  310.     USHORT uwSectorsPerFAT;
  312.     // Number of sectors from beginning of media to boot sector.
  313.     ULONG  ulHiddenSectors;
  315.     // Type of FAT.
  316.     // NOTE: This does not include FAT32, but rather FAT12, FAT16, and
  317.     // a newer version of FAT16 when the number of clusters exceeds 16
  318.     // bits (that is called here BIGDOS).
  319.     BYTE   byFatType;
  321.     #define FX_FAT12                    1
  322.     #define FX_FAT16                    4
  323.     #define FX_BIGDOS                   6
  325.     // Alignment for a first sector of a partition.
  326.     ULONG  ulPartitionAlignment;
  328.     // Number of sector on device, where MBR resides.
  329.     ULONG  ulMbrSector;
  331.     // For NANDs and NORs, this is the number of sectors that each erasable
  332.     // block contains.
  333.     USHORT uwSectorsPerBlockBits;
  335.     // This parameter refers only to NANDs. It states the type of the NAND,
  336.     // according to 4 defined groups (see FCU documentation for details).
  337.     UINT   uiNandType;
  339.     // This parameter refers only to NORs. It states the type of the NOR,
  340.     // currently supporting Intel and Amd.
  341.     UINT   uiNorType;
  343.     // This parameter refers only to NORs - it specifies if there is a special
  344.     // boot block (a block which can be erased in a smaller resolution).
  345.     BOOL   bNorBlockMapKnown;
  347. // This parameter holds the speed of the specific media we are working
  348.     // with, in case it affects calls to the FCU driver.
  349.     // The different speed options are media type specific.
  350.     UINT   uiSpeed;
  352.     // This parameter defines with which type of card we are working with - 
  353.     // SD(4bit) or MMC(1bit).
  354.     UINT   uiSdProtocol;
  357. } FX_GEOMETRY, *FX_GEOMETRY_PTR;
  360. /* Define directory entry type.  Directory entries are found in the
  361.    root directory and in directory files (sub-directories).  Default
  362.    the directory name length to 13 for 8.3 compatibility (the dot and
  363.    a NULL at the end).  The user may change this on the compilation 
  364.    command line.  */
  366. #ifndef FX_MAX_LONG_NAME_LEN
  367. //#define FX_MAX_LONG_NAME_LEN 13
  368. #define FX_MAX_LONG_NAME_LEN 65
  369. #endif
  371. #ifdef FX_TEST_CACHE
  372. #define FX_MEDIA_CACHE_ADDR  FCU_FILEX_CACHE_ADDR
  373. #endif
  375. typedef struct FX_DIR_ENTRY_STRUCT
  376. {
  377.     CHAR            fx_dir_entry_name[FX_MAX_LONG_NAME_LEN];
  378.     UINT            fx_dir_long_name_present;   /* 0 (default) => not present; 1 => present*/
  379.     UCHAR           fx_dir_entry_attributes;
  380.     UINT            fx_dir_entry_time;
  381.     UINT            fx_dir_entry_date;
  382.     ULONG           fx_dir_entry_cluster;
  383.     ULONG           fx_dir_entry_file_size;
  384.     ULONG           fx_dir_entry_log_sector;
  385.     ULONG           fx_dir_entry_byte_offset;
  386. } FX_DIR_ENTRY;
  389. /* Define the path data structure.  This structure will contain
  390.    the current path and the information for performing directory
  391.    entry operations.  */
  393. typedef struct FX_PATH_STRUCT
  394. {
  395.     /* Define the path information.  */
  396.     FX_DIR_ENTRY    fx_path_directory;
  397.     CHAR            fx_path_string[FX_MAXIMUM_PATH];
  398.     ULONG           fx_path_current_entry;
  399. } FX_PATH;
  401. typedef FX_PATH FX_LOCAL_PATH;
  404. /* Define the cache control data structure.  There are FX_MAX_SECTOR_CACHE
  405.    of these structures defined inside the FX_MEDIA structure.  Each entry 
  406.    maintains a cache representation of a media sector.  */
  408. typedef struct FX_CACHED_SECTOR_STRUCT
  409. {
  411.     /* Define the buffer pointer associated with this cache entry.  */
  412.     UCHAR_PTR       fx_cached_sector_memory_buffer;
  414.     /* Define the sector number that is cached.  */
  415.     ULONG           fx_cached_sector;
  417.     /* Define the flag that indicates whether or not the cached sector
  418.        has been modified and needs to be written to the media.  */
  419.     UINT            fx_cached_sector_buffer_dirty;
  421.     /* Define the next cached sector pointer.  This is used to implement
  422.        the "last used" algorithm when looking for cache entry to swap out to
  423.        the physical media.  */
  424.     struct FX_CACHED_SECTOR_STRUCT
  425.                     *fx_cached_sector_next_used;   
  427. } FX_CACHED_SECTOR;
  430. /* Define a driver function */
  432. //typedef VOID(*FX_DRIVER)(struct FX_MEDIA_STRUCT*);
  434. /* Define the media control block.  All information about each open
  435.    media device are maintained in by the FX_MEDIA data type.  */
  437. typedef struct FX_MEDIA_STRUCT
  438. {
  440.     /* Define the media ID used for error checking.  */
  441.     ULONG           fx_media_id;
  443.     /* Define the media's name.  */
  444.     CHAR_PTR        fx_media_name;
  446.     /* Define the media's protection object, which is a ThreadX semaphore.  
  447.        Only one thread is allowed to access any media or associated files
  448.        at a time.  If FX_SINGLE_THREAD is defined, the FileX services are 
  449.        going to be called from only one thread, hence the protection is 
  450.        not needed.  */
  451. #ifndef FX_SINGLE_THREAD
  452.     OS_SEMAPHORE    fx_media_protect;
  453. #endif
  455.     /* Remember the memory buffer area.  */
  456.     UCHAR_PTR       fx_media_memory_buffer;
  457.     UCHAR_PTR       fx_media_memory_buffer_orig;
  458.     ULONG           fx_media_memory_size;
  460.     /* Define the sector cache control structures for this media.  */
  461.     struct FX_CACHED_SECTOR_STRUCT
  462.                     fx_media_sector_cache[FX_MAX_SECTOR_CACHE];
  464.     /* Define the number of sectors actually cached based on the
  465.        user supplied buffer at media open time.  */
  466.     ULONG           fx_media_sector_cache_size;
  468.     /* Define the end of the cache area.  This is used to determine
  469.        if the I/O is for the internal memory of the media.  */
  470.     UCHAR_PTR       fx_media_sector_cache_end;
  472. #ifdef FX_TEST_CACHE
  473.     struct FX_CACHED_SECTOR_STRUCT
  474.                     * fx_media_sector_cache_in_sram;
  475. #endif
  477.     /* Define the list head of the cached sector entries.  This
  478.        pointer points to the most recenty used cache sector.  */
  479.     struct FX_CACHED_SECTOR_STRUCT
  480.                     *fx_media_sector_cache_list_ptr;
  482.     /* Define the basic information about the associated media.  */
  483.     UINT            fx_media_bytes_per_sector;
  484.     UINT            fx_media_sectors_per_track;
  485.     UINT            fx_media_heads;
  487.     ULONG           fx_media_total_sectors;
  488.     ULONG           fx_media_total_clusters;
  489.     UINT            fx_media_reserved_sectors;
  490.     UINT            fx_media_root_sector_start;
  491.     UINT            fx_media_root_sectors;
  492.     UINT            fx_media_data_sector_start;
  493.     UINT            fx_media_sectors_per_cluster;
  494.     UINT            fx_media_sectors_per_FAT;
  495.     UINT            fx_media_number_of_FATs;
  496.     UINT            fx_media_12_bit_FAT;
  497.     UINT            fx_media_32_bit_FAT;
  498.     ULONG           fx_media_hidden_sectors;
  499.     ULONG           fx_media_root_clus_32;
  500.     UINT            fx_media_root_directory_entries;
  501.     ULONG           fx_media_available_clusters;
  502.     ULONG           fx_media_cluster_search_start;
  503.     UCHAR           fx_media_type;
  505.     /* Define the information pertinent to the I/O driver interface.  */
  506.     VOID            *fx_media_driver_info;
  507.     UINT            fx_media_driver_request;
  508.     UINT            fx_media_driver_status;
  509.     UCHAR_PTR       fx_media_driver_buffer;
  510.     ULONG           fx_media_driver_logical_sector;
  511.     ULONG           fx_media_driver_sectors;
  512.     ULONG           fx_media_driver_physical_sector;
  513.     UINT            fx_media_driver_physical_track;
  514.     UINT            fx_media_driver_physical_head;  
  515.     UINT            fx_media_driver_write_protect;      /* The driver sets this to FX_TRUE when media is write protected.  */
  516.     UINT            fx_media_driver_free_sector_update; /* The driver sets this to FX_TRUE when it needs to know freed clusters.  */
  518.     /* Define the driver entry point.  */
  519.     //FX_DRIVER       fx_media_driver_entry;
  520.     /* Define the driver entry point.  */
  521.     VOID            (*fx_media_driver_entry)(struct FX_MEDIA_STRUCT *);
  523.     /* Define the current directory information for the media.  */
  524.     FX_PATH         fx_media_default_path;
  526.     /* Define the head pointer for the open files of this media.  */
  527.     struct FX_FILE_STRUCT
  528.                     *fx_media_opened_file_list;
  530.     /* Define the counter for keeping track of how many open files are 
  531.        present.  */
  532.     ULONG           fx_media_opened_file_count;
  534.     /* Define the next and previous link pointers for the open media list.  */
  535.     struct FX_MEDIA_STRUCT
  536.                     *fx_media_opened_next,
  537.                     *fx_media_opened_previous;
  539.     /* Define a variable for the application's use.  */
  540.     ULONG           fx_media_reserved_for_user;
  542.     /* Media geometry structure */
  543.     FX_GEOMETRY     fx_geometry;
  545. } FX_MEDIA;
  547. typedef FX_MEDIA* FX_MEDIA_PTR;
  549. /* Define the FileX file control block.  All information about open
  550.    files are found in this data type.  */
  552. typedef struct FX_FORMAT_PARAMS_STRUCT
  553. {
  554.     // Volume ID.
  555.     ULONG ulVolumeId;
  557.     // Volume Label. Up to 11 are used, padded with ' '.
  558.     PCHAR szVolumeLabel;
  560.     // OEM name. Up to 8 are used, padded with ' '.
  561.     PCHAR szOemName;
  563.     // Specify number of FATs requested.
  564.     BYTE byNumOfFats;
  566. } FX_FORMAT_PARAMS, *FX_FORMAT_PARAMS_PTR;
  568. typedef struct FX_FILE_STRUCT
  569. {
  571.     /* Define the file ID used for error checking.  */
  572.     ULONG           fx_file_id;
  574.     /* Define the file's name.  */
  575.     CHAR_PTR        fx_file_name;
  577.     /* Define the open mode request.  */
  578.     UCHAR           fx_file_open_mode;
  580.     /* Define the file modified field.  */
  581.     UCHAR           fx_file_modified;
  583.     /* Define the complete directory entry structure.  */
  584.     FX_DIR_ENTRY    fx_file_dir_entry;
  586.     /* Define the data storage parameters.  */
  587.     ULONG           fx_file_total_clusters;
  588.     ULONG           fx_file_first_physical_cluster;
  589.     ULONG           fx_file_consecutive_cluster;
  591.     ULONG           fx_file_last_physical_cluster;
  593.     ULONG           fx_file_current_physical_cluster;
  594.     ULONG           fx_file_current_logical_sector;
  595.     ULONG           fx_file_current_logical_offset;
  596.     ULONG           fx_file_current_relative_cluster;
  597.     ULONG           fx_file_current_relative_sector;
  598.     ULONG           fx_file_current_file_offset;
  599.     ULONG           fx_file_current_file_size;
  600.     ULONG           fx_file_current_available_size;
  602.     /* Remember the media that is associated with this file. */
  603.     FX_MEDIA        *fx_file_media_ptr;
  605.     /* Define the pointers necessary to maintain the open file on 
  606.        the list of open files.  */
  607.     struct FX_FILE_STRUCT
  608.                     *fx_file_opened_next,
  609.                     *fx_file_opened_previous;
  610. } FX_FILE;
  613. /* Define the FileX API mappings based on the error checking 
  614.    selected by the user.  Note: this section is only applicable to 
  615.    application source code, hence the conditional that turns off this
  616.    stuff when the include file is processed by the FileX source. */
  618. #ifndef  FX_SOURCE_CODE
  621. /* Determine if error checking is desired.  If so, map API functions 
  622.    to the appropriate error checking front-ends.  Otherwise, map API
  623.    functions to the core functions that actually perform the work. 
  624.    Note: error checking is enabled by default.  */
  626. #ifdef FX_DISABLE_ERROR_CHECKING
  628. /* Services without error checking.  */
  630. #define fx_system_initialize            _fx_system_initialize
  631. #define fx_system_date_set              _fx_system_date_set
  632. #define fx_system_time_set              _fx_system_time_set
  633. #define fx_system_date_get              _fx_system_date_get
  634. #define fx_system_time_get              _fx_system_time_get
  636. #define fx_partition_create             _fx_partition_create
  637. #define fx_partition_format             _fx_partition_format
  639. #define fx_media_open                   _fx_media_open
  640. #define fx_media_invalidate             _fx_media_invalidate
  641. #define fx_media_close                  _fx_media_close
  642. #define fx_media_full_format            _fx_media_full_format
  643. #define fx_media_quick_format           _fx_media_quick_format
  644. #define fx_media_flush                  _fx_media_flush
  645. #define fx_media_space_available        _fx_media_space_available
  646. #define fx_media_read                   _fx_media_read
  647. #define fx_media_write                  _fx_media_write
  648. #define fx_media_erase                  _fx_media_erase
  649. #define fx_media_abort                  _fx_media_abort
  651. #define fx_directory_create             _fx_directory_create
  652. #define fx_directory_delete             _fx_directory_delete
  653. #define fx_directory_rename             _fx_directory_rename
  654. #define fx_directory_first_entry_find   _fx_directory_first_entry_find
  655. #define fx_directory_next_entry_find    _fx_directory_next_entry_find
  656. #define fx_directory_first_full_entry_find _fx_directory_first_full_entry_find
  657. #define fx_directory_next_full_entry_find  _fx_directory_next_full_entry_find
  658. #define fx_directory_name_test          _fx_directory_name_test
  659. #define fx_directory_information_get    _fx_directory_information_get
  660. #define fx_directory_default_set        _fx_directory_default_set
  661. #define fx_directory_default_get        _fx_directory_default_get
  662. #define fx_directory_local_path_clear   _fx_directory_local_path_clear
  663. #define fx_directory_local_path_get     _fx_directory_local_path_get
  664. #define fx_directory_local_path_set     _fx_directory_local_path_set
  665. #define fx_directory_local_path_restore _fx_directory_local_path_restore
  667. #define fx_file_create                  _fx_file_create
  668. #define fx_file_delete                  _fx_file_delete
  669. #define fx_file_rename                  _fx_file_rename
  670. #define fx_file_attributes_set          _fx_file_attributes_set
  671. #define fx_file_attributes_read         _fx_file_attributes_read
  672. #define fx_file_open                    _fx_file_open
  673. #define fx_file_close                   _fx_file_close
  674. #define fx_file_read                    _fx_file_read
  675. #define fx_file_write                   _fx_file_write
  676. #define fx_file_allocate                _fx_file_allocate
  677. #define fx_file_best_effort_allocate    _fx_file_best_effort_allocate
  678. #define fx_file_seek                    _fx_file_seek
  679. #define fx_file_relative_seek           _fx_file_relative_seek
  680. #define fx_file_truncate                _fx_file_truncate
  681. #define fx_file_open_by_addr            _fx_file_open_by_addr
  682. #else
  684. /* Services with error checking.  */
  686. #define fx_system_initialize            _fx_system_initialize
  687. #define fx_system_date_set              _fxe_system_date_set
  688. #define fx_system_time_set              _fxe_system_time_set
  689. #define fx_system_date_get              _fxe_system_date_get
  690. #define fx_system_time_get              _fxe_system_time_get
  692. #define fx_partition_create             _fxe_partition_create
  693. #define fx_partition_format             _fxe_partition_format
  695. #define fx_media_open                   _fxe_media_open
  696. #define fx_media_invalidate             _fxe_media_invalidate
  697. #define fx_media_close                  _fxe_media_close
  698. #define fx_media_full_format            _fxe_media_full_format
  699. #define fx_media_quick_format           _fxe_media_quick_format
  700. #define fx_media_flush                  _fxe_media_flush
  701. #define fx_media_space_available        _fxe_media_space_available
  702. #define fx_media_read                   _fxe_media_read
  703. #define fx_media_write                  _fxe_media_write
  704. #define fx_media_erase                  _fxe_media_erase
  705. #define fx_media_abort                  _fxe_media_abort
  707. #define fx_directory_create             _fxe_directory_create
  708. #define fx_directory_delete             _fxe_directory_delete
  709. #define fx_directory_rename             _fxe_directory_rename
  710. #define fx_directory_first_entry_find   _fxe_directory_first_entry_find
  711. #define fx_directory_next_entry_find    _fxe_directory_next_entry_find
  712. #define fx_directory_first_full_entry_find _fxe_directory_first_full_entry_find
  713. #define fx_directory_next_full_entry_find  _fxe_directory_next_full_entry_find
  714. #define fx_directory_name_test          _fxe_directory_name_test
  715. #define fx_directory_information_get    _fxe_directory_information_get
  716. #define fx_directory_default_set        _fxe_directory_default_set
  717. #define fx_directory_default_get        _fxe_directory_default_get
  718. #define fx_directory_local_path_clear   _fxe_directory_local_path_clear
  719. #define fx_directory_local_path_get     _fxe_directory_local_path_get
  720. #define fx_directory_local_path_set     _fxe_directory_local_path_set
  721. #define fx_directory_local_path_restore _fxe_directory_local_path_restore
  723. #define fx_file_create                  _fxe_file_create
  724. #define fx_file_delete                  _fxe_file_delete
  725. #define fx_file_rename                  _fxe_file_rename
  726. #define fx_file_attributes_set          _fxe_file_attributes_set
  727. #define fx_file_attributes_read         _fxe_file_attributes_read
  728. #define fx_file_open                    _fxe_file_open
  729. #define fx_file_close                   _fxe_file_close
  730. #define fx_file_read                    _fxe_file_read
  731. #define fx_file_write                   _fxe_file_write
  732. #define fx_file_allocate                _fxe_file_allocate
  733. #define fx_file_best_effort_allocate    _fxe_file_best_effort_allocate
  734. #define fx_file_seek                    _fxe_file_seek
  735. #define fx_file_relative_seek           _fxe_file_relative_seek
  736. #define fx_file_truncate                _fxe_file_truncate
  738. #endif
  740. /* Define prototype for utility services commonly used by FileX I/O Drivers.  This eliminates the
  741.    need to include internal FileX component files in I/O drivers.  */
  743. UINT        _fx_partition_offset_calculate( VOID  *part_sector,
  744.                                             UINT   partition,
  745.                                             ULONG *partition_start,
  746.                                             ULONG *partition_size );
  748. UINT        _fx_media_open(FX_MEDIA *media_ptr, CHAR *media_name,
  749.                  VOID (*media_driver)(FX_MEDIA *), VOID *driver_info_ptr, 
  750.                  VOID *memory_ptr, ULONG memory_size, UINT partition);
  753. #endif
  755. /* Determine if a C++ compiler is being used.  If so, complete the standard
  756.    C conditional started above.  */
  757. #ifdef   __cplusplus
  758.         }
  759. #endif
  761. #endif