AllSpiceMirrors/Frequency_Inverter
0
Fork 0
mirror of https://github.com/Indemsys/Frequency_Inverter.git synced 2026-05-01 12:13:01 +00:00
Files Issues Projects Releases
Files
main
Frequency_Inverter/Firmware/Inverter_firmware/mfs/source/include/mfs.h
Indemsys db9ab280ef Initial commit
2022-01-04 12:22:53 +02:00

451 lines
17 KiB
C
Raw Permalink Blame History

#ifndef __mfs_h__
#define __mfs_h__
/**HEADER********************************************************************
*
* Copyright (c) 2008 Freescale Semiconductor;
* All Rights Reserved
*
* Copyright (c) 2004-2008 Embedded Access Inc.;
* All Rights Reserved
*
* Copyright (c) 1989-2008 ARC International;
* All Rights Reserved
*
***************************************************************************
*
* THIS SOFTWARE IS PROVIDED BY FREESCALE "AS IS" AND ANY EXPRESSED OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL FREESCALE OR ITS CONTRIBUTORS 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.
*
**************************************************************************
*
* $FileName: mfs.h$
* $Version : 3.8.24.0$
* $Date : Jul-25-2012$
*
* Comments:
*
* This file contains the structure definitions and constants for a
* user who will be compiling programs that will use the Embedded MS-DOS
* File System (MFS)
*
*END************************************************************************/
#include <mqx.h>
#include <bsp.h>
#include "mfs_rev.h"
#include "mfs_cnfg.h"
#include "ioctl.h"
/*
** Defines specific to MFS
*/
#define MFS_VERSION (0x00030000 | MFS_REVISION)
/* search attributes */
#define MFS_SEARCH_NORMAL 0x00
#define MFS_SEARCH_READ_ONLY 0x01
#define MFS_SEARCH_HIDDEN 0x02
#define MFS_SEARCH_SYSTEM 0x04
#define MFS_SEARCH_VOLUME 0x08
#define MFS_SEARCH_SUBDIR 0x10
#define MFS_SEARCH_ARCHIVE 0x20
#define MFS_SEARCH_EXCLUSIVE 0x40
#define MFS_SEARCH_ANY 0x80
/* file open access modes */
#define MFS_ACCESS_READ_ONLY 0x00
#define MFS_ACCESS_WRITE_ONLY 0x01
#define MFS_ACCESS_READ_WRITE 0x02
/* file entry attributes */
#define MFS_ATTR_READ_ONLY 0x01
#define MFS_ATTR_HIDDEN_FILE 0x02
#define MFS_ATTR_SYSTEM_FILE 0x04
#define MFS_ATTR_VOLUME_NAME 0x08
#define MFS_ATTR_DIR_NAME 0x10
#define MFS_ATTR_ARCHIVE 0x20
#define MFS_ATTR_LFN 0x0F
/* mask values for the date and time as recorded in the
** file entries
*/
#define MFS_MASK_DAY 0x001F
#define MFS_MASK_MONTH 0x01E0
#define MFS_MASK_YEAR 0xFE00
#define MFS_MASK_SECONDS 0x001F
#define MFS_MASK_MINUTES 0x07E0
#define MFS_MASK_HOURS 0xF800
/*
** shift for the above date and time masks
*/
#define MFS_SHIFT_DAY 0
#define MFS_SHIFT_MONTH 5
#define MFS_SHIFT_YEAR 9
#define MFS_SHIFT_SECONDS 0
#define MFS_SHIFT_MINUTES 5
#define MFS_SHIFT_HOURS 11
/*
** control for the write cache
*/
#define MFS_WRCACHE_OFF 0
#define MFS_WRCACHE_ON 1
#define MFS_WRCACHE_FLUSH 2
#define MFS_DEFAULT_SECTOR_SIZE 512
/*
** Sector boundries that determine the cluster size, the root dir size
** and the FAT type
*/
#define SECTOR_BOUND1 2048 /* TYPE: FAT12, Root dir: 7 * 32 root entries, CLUSTER SIZE: 1 sector */
#define SECTOR_BOUND2 4096 /* TYPE: FAT12, Root dir: 14 * 32 root entries, CLUSTER SIZE: 1 sector */
#define SECTOR_BOUND3 8192 /* TYPE: FAT12, Root dir: 32 * 32 root entries, CLUSTER SIZE: 2 sectors */
#define SECTOR_BOUND4 16384 /* TYPE: FAT12, Root dir: 32 * 32 root entries, CLUSTER SIZE: 4 sectors */
#define SECTOR_BOUND5 32768 /* TYPE: FAT12, Root dir: 32 * 32 root entries, CLUSTER SIZE: 2 sectors */
#define SECTOR_BOUND6 524288 /* TYPE: FAT16, Root dir: 32 * 32 root entries, CLUSTER SIZE: 8 sectors */
#define SECTOR_BOUND7 1048576 /* TYPE: FAT16, Root dir: 32 * 32 root entries, CLUSTER SIZE: 16 sectors */
#define SECTOR_BOUND8 16777216 /* TYPE: FAT32, Root dir: 64k entries, CLUSTER SIZE: 8 sectors */
#define SECTOR_BOUND9 33554432 /* TYPE: FAT32, Root dir: 64k entries, CLUSTER SIZE: 16 sectors */
#define SECTOR_BOUND10 67108864 /* TYPE: FAT32, Root dir: 64k entries, CLUSTER SIZE: 32 sectors */
#define SECTOR_BOUND11 2097152 /* TYPE: FAT16, Root dir: 32 * 32 root entries, CLUSTER SIZE: 32 sectors */
#define MFS_FAT12 0x01
#define MFS_FAT16 0x06
#define MFS_FAT32 0x0C
/*
** FILENAME LENGTH CONSTANTS
*/
#define PATHNAME_SIZE 260
#define FILENAME_SIZE 255
#define SFILENAME_SIZE 12
/*
** error codes
*/
#define MFS_NO_ERROR FS_NO_ERROR
#define MFS_INVALID_FUNCTION_CODE FS_INVALID_FUNCTION_CODE
#define MFS_FILE_NOT_FOUND FS_FILE_NOT_FOUND
#define MFS_PATH_NOT_FOUND FS_PATH_NOT_FOUND
#define MFS_ACCESS_DENIED FS_ACCESS_DENIED
#define MFS_INVALID_HANDLE FS_INVALID_HANDLE
#define MFS_INSUFFICIENT_MEMORY FS_INSUFFICIENT_MEMORY
#define MFS_INVALID_MEMORY_BLOCK_ADDRESS FS_INVALID_MEMORY_BLOCK_ADDRESS
#define MFS_ATTEMPT_TO_REMOVE_CURRENT_DIR FS_ATTEMPT_TO_REMOVE_CURRENT_DIR
#define MFS_DISK_IS_WRITE_PROTECTED FS_DISK_IS_WRITE_PROTECTED
#define MFS_BAD_DISK_UNIT FS_BAD_DISK_UNIT
#define MFS_INVALID_LENGTH_IN_DISK_OPERATION FS_INVALID_LENGTH_IN_DISK_OPERATION
#define MFS_NOT_A_DOS_DISK FS_NOT_A_DOS_DISK
#define MFS_SECTOR_NOT_FOUND FS_SECTOR_NOT_FOUND
#define MFS_WRITE_FAULT FS_WRITE_FAULT
#define MFS_READ_FAULT FS_READ_FAULT
#define MFS_SHARING_VIOLATION FS_SHARING_VIOLATION
#define MFS_FILE_EXISTS FS_FILE_EXISTS
#define MFS_ALREADY_ASSIGNED FS_ALREADY_ASSIGNED
#define MFS_INVALID_PARAMETER FS_INVALID_PARAMETER
#define MFS_DISK_FULL FS_DISK_FULL
#define MFS_ROOT_DIR_FULL FS_ROOT_DIR_FULL
#define MFS_EOF FS_EOF
#define MFS_CANNOT_CREATE_DIRECTORY FS_CANNOT_CREATE_DIRECTORY
#define MFS_NOT_INITIALIZED FS_NOT_INITIALIZED
#define MFS_OPERATION_NOT_ALLOWED FS_OPERATION_NOT_ALLOWED
#define MFS_ERROR_INVALID_DRIVE_HANDLE FS_ERROR_INVALID_DRIVE_HANDLE
#define MFS_ERROR_INVALID_FILE_HANDLE FS_ERROR_INVALID_FILE_HANDLE
#define MFS_ERROR_UNKNOWN_FS_VERSION FS_ERROR_UNKNOWN_FS_VERSION
#define MFS_LOST_CHAIN FS_LOST_CHAIN
#define MFS_INVALID_DEVICE FS_INVALID_DEVICE
#define MFS_INVALID_CLUSTER_NUMBER FS_INVALID_CLUSTER_NUMBER
#define MFS_FAILED_TO_DELETE_LFN FS_FAILED_TO_DELETE_LFN
#define MFS_BAD_LFN_ENTRY FS_BAD_LFN_ENTRY
#define PMGR_INVALID_PARTITION FS_PMGR_INVALID_PARTITION
#define PMGR_INSUF_MEMORY FS_PMGR_INSUF_MEMORY
#define PMGR_UNKNOWN_PARTITION FS_PMGR_UNKNOWN_PARTITION
#define PMGR_INVALID_PARTTABLE FS_PMGR_INVALID_PARTTABLE
/*
** Extra IO_IOCTL codes
*/
#define IO_IOCTL_DELETE_FILE _IO(IO_TYPE_MFS,0x02)
#define IO_IOCTL_BAD_CLUSTERS _IO(IO_TYPE_MFS,0x03)
#define IO_IOCTL_FREE_SPACE _IO(IO_TYPE_MFS,0x04)
#define IO_IOCTL_TEST_UNUSED_CLUSTERS _IO(IO_TYPE_MFS,0x05)
#define IO_IOCTL_CREATE_SUBDIR _IO(IO_TYPE_MFS,0x06)
#define IO_IOCTL_REMOVE_SUBDIR _IO(IO_TYPE_MFS,0x07)
#define IO_IOCTL_GET_CURRENT_DIR _IO(IO_TYPE_MFS,0x08)
#define IO_IOCTL_CHANGE_CURRENT_DIR _IO(IO_TYPE_MFS,0x09)
#define IO_IOCTL_WRITE_CACHE_ON _IO(IO_TYPE_MFS,0x0A)
#define IO_IOCTL_WRITE_CACHE_OFF _IO(IO_TYPE_MFS,0x0B)
#define IO_IOCTL_FORMAT _IO(IO_TYPE_MFS,0x0C)
#define IO_IOCTL_FORMAT_TEST _IO(IO_TYPE_MFS,0x0D)
#define IO_IOCTL_FIND_FIRST_FILE _IO(IO_TYPE_MFS,0x0E)
#define IO_IOCTL_FIND_NEXT_FILE _IO(IO_TYPE_MFS,0x0F)
#define IO_IOCTL_RENAME_FILE _IO(IO_TYPE_MFS,0x10)
#define IO_IOCTL_GET_FILE_ATTR _IO(IO_TYPE_MFS,0x11)
#define IO_IOCTL_SET_FILE_ATTR _IO(IO_TYPE_MFS,0x12)
#define IO_IOCTL_GET_DATE_TIME _IO(IO_TYPE_MFS,0x13)
#define IO_IOCTL_SET_DATE_TIME _IO(IO_TYPE_MFS,0x14)
#define IO_IOCTL_FLUSH_FAT _IO(IO_TYPE_MFS,0x15)
#define IO_IOCTL_FAT_CACHE_ON _IO(IO_TYPE_MFS,0x16)
#define IO_IOCTL_FAT_CACHE_OFF _IO(IO_TYPE_MFS,0x17)
#define IO_IOCTL_SET_VOLUME _IO(IO_TYPE_MFS,0x18)
#define IO_IOCTL_GET_VOLUME _IO(IO_TYPE_MFS,0x19)
#define IO_IOCTL_GET_LFN _IO(IO_TYPE_MFS,0x1A)
#define IO_IOCTL_FREE_CLUSTERS _IO(IO_TYPE_MFS,0x1B)
#define IO_IOCTL_GET_CLUSTER_SIZE _IO(IO_TYPE_MFS,0x1C)
#define IO_IOCTL_LAST_CLUSTER _IO(IO_TYPE_MFS,0x20)
#define IO_IOCTL_SEL_PART _IO(IO_TYPE_MFS,0x21)
#define IO_IOCTL_USE_PARTITION _IO(IO_TYPE_MFS,0x22)
#define IO_IOCTL_VAL_PART _IO(IO_TYPE_MFS,0x23)
#define IO_IOCTL_SET_PARTITION _IO(IO_TYPE_MFS,0x24)
#define IO_IOCTL_GET_PARTITION _IO(IO_TYPE_MFS,0x25)
#define IO_IOCTL_CLEAR_PARTITION _IO(IO_TYPE_MFS,0x26)
#define IO_IOCTL_GET_DEVICE_HANDLE _IO(IO_TYPE_MFS,0x27)
#define IO_IOCTL_GET_FAT_CACHE_MODE _IO(IO_TYPE_MFS,0x28)
#define IO_IOCTL_SET_FAT_CACHE_MODE _IO(IO_TYPE_MFS,0x29)
#define IO_IOCTL_GET_WRITE_CACHE_MODE _IO(IO_TYPE_MFS,0x30)
#define IO_IOCTL_SET_WRITE_CACHE_MODE _IO(IO_TYPE_MFS,0x31)
#define IO_IOCTL_DEFAULT_FORMAT _IO(IO_TYPE_MFS,0x32)
#define IO_IOCTL_VERIFY_WRITES _IO(IO_TYPE_MFS,0x33)
#define IO_IOCTL_CHECK_DIR_EXIST _IO(IO_TYPE_MFS,0x34)
/*
Following IOCTL codes are obsolete.
No device locking is necessary anymore as partition manager may be open multiple times to allow for concurrent access to multiple partitions.
#define IO_IOCTL_DEV_LOCK
#define IO_IOCTL_DEV_UNLOCK
*/
#define MFS_MEM_TYPE_BASE ( (IO_MFS_COMPONENT) << (MEM_TYPE_COMPONENT_SHIFT))
#define MEM_TYPE_MFS_DRIVE_STRUCT (MFS_MEM_TYPE_BASE+1)
#define MEM_TYPE_MFS_DIR_STRUCT (MFS_MEM_TYPE_BASE+2)
#define MEM_TYPE_MFS_DATA_SECTOR (MFS_MEM_TYPE_BASE+3)
#define MEM_TYPE_MFS_DIRECTORY_SECTOR (MFS_MEM_TYPE_BASE+4)
#define MEM_TYPE_MFS_FAT_BUFFER (MFS_MEM_TYPE_BASE+5)
#define MEM_TYPE_MFS_FILESYSTEM_INFO_DISK (MFS_MEM_TYPE_BASE+6)
#define MEM_TYPE_MFS_CLUSTER (MFS_MEM_TYPE_BASE+7)
#define MEM_TYPE_MFS_PATHNAME (MFS_MEM_TYPE_BASE+8)
#define MEM_TYPE_PART_MGR_STRUCT (MFS_MEM_TYPE_BASE+9)
#define MEM_TYPE_PART_MGR_SECTOR (MFS_MEM_TYPE_BASE+10)
/*
** INDEX_TO_OFFSET converts a directory index to the offset within the right
** sector.
*/
#define INDEX_TO_OFFSET(x) ((x) & (drive_ptr->ENTRIES_PER_SECTOR-1))
#define PACK_TIME(x) ((x.HOUR << MFS_SHIFT_HOURS) |\
(x.MINUTE << MFS_SHIFT_MINUTES) |\
(clk_time.SECOND >>1))
#define PACK_DATE(x) (((x.YEAR -1980)<< MFS_SHIFT_YEAR) |\
(x.MONTH << MFS_SHIFT_MONTH) |\
(x.DAY << MFS_SHIFT_DAY))
#define CAPITALIZE(c) (c&((c>='a'&&c<='z')?(~0x20):~0))
/*
** Data Structures specific to MFS
*/
typedef uint_32 _mfs_error;
typedef uint_32_ptr _mfs_error_ptr;
typedef enum {
MFS_WRITE_THROUGH_CACHE=0, // No write caching (only read caching)
MFS_MIXED_MODE_CACHE=1, // Write Caching allowed on file write only
MFS_WRITE_BACK_CACHE=2 // Write Caching fully enabled
} _mfs_cache_policy;
/*
** Information required for high-level format
*/
typedef struct mfs_format_data
{
uchar PHYSICAL_DRIVE;
uchar MEDIA_DESCRIPTOR;
uint_16 BYTES_PER_SECTOR;
uint_16 SECTORS_PER_TRACK;
uint_16 NUMBER_OF_HEADS;
uint_32 NUMBER_OF_SECTORS;
uint_32 HIDDEN_SECTORS;
uint_16 RESERVED_SECTORS;
} MFS_FORMAT_DATA, _PTR_ MFS_FORMAT_DATA_PTR;
/*
** Format information for ioctl calls involving format operations
*/
typedef struct mfs_ioctl_format
{
MFS_FORMAT_DATA_PTR FORMAT_PTR;
uint_32_ptr COUNT_PTR; /* To count the bad clusters */
} MFS_IOCTL_FORMAT_PARAM, _PTR_ MFS_IOCTL_FORMAT_PARAM_PTR;
typedef struct mfs_internal_search
{
char_ptr FULLNAME; // 0..3
char_ptr SRC_PTR; // 4..7
char FILENAME[8]; // 8..15
char EXTENSION[3]; // 16..18
char ATTRIBUTE; // 19
uint_32 CURRENT_CLUSTER; // 20..23
uint_32 DIR_ENTRY_INDEX; // 24..27
uint_32 PREV_CLUSTER; // 28..31
} MFS_INTERNAL_SEARCH, _PTR_ MFS_INTERNAL_SEARCH_PTR;
/*
** search data block, used for Find_first and Find_next
*/
typedef struct mfs_search_data
{
pointer DRIVE_PTR;
MFS_INTERNAL_SEARCH INTERNAL_SEARCH_DATA;
uchar ATTRIBUTE;
char _UNUSED[3];
uint_16 TIME;
uint_16 DATE;
uint_16 RESERVED2;
uint_32 FILE_SIZE;
char NAME[13];
} MFS_SEARCH_DATA, _PTR_ MFS_SEARCH_DATA_PTR;
/*
** Search information for ioctl find file first search calls
*/
typedef struct mfs_search_param
{
uchar ATTRIBUTE;
uchar RESERVED[3];
char_ptr WILDCARD;
MFS_SEARCH_DATA_PTR SEARCH_DATA_PTR;
} MFS_SEARCH_PARAM, _PTR_ MFS_SEARCH_PARAM_PTR;
/*
** Pathname information for the rename_file ioctl call
*/
typedef struct mfs_rename_param
{
char_ptr OLD_PATHNAME;
char_ptr NEW_PATHNAME;
} MFS_RENAME_PARAM, _PTR_ MFS_RENAME_PARAM_PTR;
/*
** Paramater information for get and set file attribute ioctl calls
*/
typedef struct mfs_file_attr_param
{
char_ptr PATHNAME;
uchar_ptr ATTRIBUTE_PTR;
} MFS_FILE_ATTR_PARAM, _PTR_ MFS_FILE_ATTR_PARAM_PTR;
typedef struct mfs_get_lfn_struct
{
char_ptr PATHNAME;
char_ptr LONG_FILENAME;
MFS_SEARCH_DATA_PTR SEARCH_DATA_PTR;
} MFS_GET_LFN_STRUCT, _PTR_ MFS_GET_LFN_STRUCT_PTR;
/*
** Parameter information for get/set date time ioctl calls
*/
typedef struct mfs_date_time_param
{
uint_16_ptr DATE_PTR;
uint_16_ptr TIME_PTR;
} MFS_DATE_TIME_PARAM, _PTR_ MFS_DATE_TIME_PARAM_PTR;
/*
** Data Structures specific to MFS
*/
/* structure of entries in the file system directory */
typedef struct mfs_dir_entry
{
char NAME[8];
char TYPE[3];
uchar ATTRIBUTE[1];
char RESERVED[8];
uchar HFIRST_CLUSTER[2];
uchar TIME[2];
uchar DATE[2];
uchar LFIRST_CLUSTER[2];
uchar FILE_SIZE[4];
} MFS_DIR_ENTRY, _PTR_ MFS_DIR_ENTRY_PTR;
/*
** file handle as defined by MFS
*/
typedef struct mfs_handle
{
QUEUE_ELEMENT_STRUCT HEADER_PTR;
uint_32 VALID;
MFS_DIR_ENTRY DIR_ENTRY;
uint_16 ACCESS;
uint_16 TOUCHED;
uint_32 CURRENT_CLUSTER;
uint_32 PREVIOUS_CLUSTER;
uint_32 SAVED_POSITION;
uint_32 DIR_CLUSTER;
uint_32 DIR_INDEX;
} MFS_HANDLE, _PTR_ MFS_HANDLE_PTR;
/*
** extern statements for MFS
*/
extern _mem_pool_id _MFS_pool_id;
extern uint_32 _MFS_handle_pool_init;
extern uint_32 _MFS_handle_pool_grow;
extern uint_32 _MFS_handle_pool_max;
#ifdef __cplusplus
extern "C" {
#endif
extern uint_32 _io_mfs_install(MQX_FILE_PTR dev_fd,char_ptr identifier, uint_32 part_num);
extern uint_32 _io_mfs_uninstall(char_ptr identifier);
extern int_32 _io_mfs_open(MQX_FILE_PTR fd_ptr,char_ptr, char_ptr flags_str);
extern int_32 _io_mfs_close(MQX_FILE_PTR fd_ptr);
extern int_32 _io_mfs_read(MQX_FILE_PTR file_ptr,char_ptr data_ptr,int_32 num);
extern int_32 _io_mfs_write(MQX_FILE_PTR file_ptr,char_ptr data_ptr,int_32 num);
extern int_32 _io_mfs_ioctl(MQX_FILE_PTR file_ptr,uint_32 cmd,uint_32_ptr param_ptr);
extern pointer _io_mfs_dir_open(MQX_FILE_PTR fs_ptr, char_ptr wildcard_ptr, char_ptr mode_ptr);
extern int_32 _io_mfs_dir_read(pointer dir, char_ptr buffer, uint_32 size);
extern int_32 _io_mfs_dir_close(pointer dir);
extern boolean MFS_is_autogenerated_name(char_ptr s_fname);
extern char_ptr MFS_Error_text(uint_32 error_code);
extern pointer MFS_mem_alloc(_mem_size size);
extern pointer MFS_mem_alloc_zero(_mem_size size);
extern pointer MFS_mem_alloc_system(_mem_size size);
extern pointer MFS_mem_alloc_system_zero(_mem_size size);
extern _mfs_error MFS_alloc_path(char_ptr * path_ptr_ptr);
extern _mfs_error MFS_alloc_2paths(char_ptr * path1_ptr_ptr,char_ptr * path2_ptr_ptr);
extern boolean MFS_free_path(char_ptr path_ptr);
#ifdef __cplusplus
}
#endif
#if (MFSCFG_NUM_OF_FATS == 0)
#error "Illegal number of FATS"
#endif
#endif
/* EOF */
Reference in New Issue View Git Blame Copy Permalink