Library Members

Microchip MDD File System Interface

MDDFS Interface Library Help

Library Members

The following functions, variables, structures, and macros are public, but are intended only to be accessed by the library itself. Applications should generally not call these functions or modify these variables.

Enumerations

	Name	Description
	CETYPE	An enumeration used for various error codes.
	_CETYPE	An enumeration used for various error codes.
	SEARCH_TYPE	Indicates how to search for file entries in the FILEfind function

Functions

	Name	Description
	ReadByte	Read a byte from a buffer
	ReadDWord	Read a 32-bit double word from a buffer
	ReadWord	Read a 16-bit word from a buffer
	MDD_WriteProtectState	Function pointer that points to a physical layer's MDD_xxxxx_WriteProtectState function

Macros

	Name	Description
	ATTR_LONG_NAME	A macro for the attributes for a long-file name entry
	BSI_BOOTSIG	A macro for the boot sector boot signature offset
	BSI_BPS	A macro for the boot sector bytes per sector value offset
	BSI_FAT32_BOOTSIG	A macro for the FAT32 boot sector boot signature offset
	BSI_FAT32_FSTYPE	A macro for the FAT32 boot sector file system type string offset
	BSI_FATCOUNT	A macro for the boot sector FAT count value offset
	BSI_FATSZ32	A macro for the boot sector 32-bit sector per FAT value offset
	BSI_FSTYPE	A macro for the boot sector file system type string offset
	BSI_RESRVSEC	A macro for the boot sector reserved sector count value offset
	BSI_ROOTCLUS	A macro for the boot sector start cluster of root directory value offset
	BSI_ROOTDIRENTS	A macro for the boot sector root directory entry count value offset
	BSI_SPC	A macro for the boot sector sector per cluster value offset
	BSI_SPF	A macro for the boot sector sectors per FAT value offset
	BSI_TOTSEC16	A macro for the boot sector 16-bit total sector count value offset
	BSI_TOTSEC32	A macro for the boot sector 32-bit total sector count value offset
	CE_EOF	Error that indicates that the end of the file has been reached
	CE_FAT_EOF	Error that indicates an attempt to read FAT entries beyond the end of the file
	CLUSTER_EMPTY	A macro to indicate an empty FAT entry
	CLUSTER_FAIL_FAT16	A macro to indicate the failure of the ReadFAT function
	CLUSTER_FAIL_FAT32	A macro to indicate the failure of the ReadFAT function
	DIR_DEL	A macro for a deleted dir entry marker.
	DIR_EMPTY	A macro for the last dir entry marker.
	DIR_EXTENSION	A macro used to indicate the length of an 8.3 file extension
	DIR_NAMECOMP	A macro used to indicate the length of an 8.3 file name and extension
	DIR_NAMESIZE	A macro used to indicate the length of an 8.3 file name
	END_CLUSTER_FAT12	A macro to indicate the last allocatable cluster for FAT12
	END_CLUSTER_FAT16	A macro to indicate the last allocatable cluster for FAT16
	END_CLUSTER_FAT32	A macro to indicate the last allocatable cluster for FAT32
	FAT_GOOD_SIGN_0	A macro for the first boot sector/MBR signature byte
	FAT_GOOD_SIGN_1	A macro for the second boot sector/MBR signature byte
	FAT12	A macro indicating the device is formatted with FAT12
	FAT16	A macro indicating the device is formatted with FAT16
	FAT32	A macro indicating the device is formatted with FAT32
	FILE_NAME_SIZE	MAcro indicating the length of an 8.3 file name in a directory entry
	FO_MBR	A macro indicating the offset for the master boot record
	FOUND	A macro indicating a dir entry was found
	GetInstructionClock	Instruction clock frequency
	GetPeripheralClock	Peripheral clock frequency
	GetSystemClock	System clock frequency (Hz)
	INPUT	A macro used to set TRIS register bits to input
	LAST_CLUSTER_FAT12	A macro to indicate the last cluster value for FAT12
	LAST_CLUSTER_FAT16	A macro to indicate the last cluster value for FAT16
	LAST_CLUSTER_FAT32	A macro to indicate the last cluster value for FAT32
	MASK_MAX_FILE_ENTRY_LIMIT_BITS	A mask that indicates the limit of directory entries in a sector
	MDD_InitIO	Function pointer to the I/O Initialization Physical Layer function
	MDD_MediaInitialize	Function pointer to the Media Initialize Physical Layer function
	MDD_ReadCapacity	Function pointer to the Read Capacity Physical Layer function
	MDD_ReadSectorSize	Function pointer to the Read Sector Size Physical Layer Function
	MDD_SectorRead	Function pointer to the Sector Read Physical Layer function
	MDD_SectorWrite	Function pointer to the Sector Write Physical Layer function
	MDD_ShutdownMedia	Function pointer to the Media Shutdown Physical Layer function
	NO_MORE	A macro indicating that no more files were found
	NOT_FOUND	A macro indicating no dir entry was found
	NUMBER_OF_BYTES_IN_DIR_ENTRY	A macro indicating the number of bytes in a directory entry.
	OUTPUT	A macro used to set TRIS register bits to output
	RAMread	A macro to read a byte from RAM
	RAMreadD	A macro to read a 32-bit word from RAM
	RAMreadW	A macro to read a 16-bit word from RAM
	RAMwrite	A macro to write a byte to RAM
	TOTAL_FILE_SIZE	Macro indicating the length of a 8.3 file name
	VALUE_BASED_ON_ENTRIES_PER_CLUSTER	Value used for shift operations to calculate the sector offset in a directory
	VALUE_DOTDOT_CLUSTER_VALUE_FOR_ROOT	A value that will indicate that a dotdot directory entry points to the root.

Structures

	Name	Description
	_BootSec	A structure of the organization of a boot sector.
	_BPB_FAT12	A structure containing the bios parameter block for a FAT12 file system (in the boot sector)
	_BPB_FAT16	A structure containing the bios parameter block for a FAT16 file system (in the boot sector)
	_BPB_FAT32	A structure containing the bios parameter block for a FAT32 file system (in the boot sector)
	_PT_MBR	A structure of the organization of a master boot record.
	DISK	A structure containing information about the device.
	FILEFLAGS	Indicates flag conditions for a file object
	PTE_MBR	A partition table entry structure.
	SWORD	A 24-bit data type

Types

	Name	Description
	BootSec	A pointer to a _BootSec structure
	PT_MBR	A pointer to a _PT_MBR structure
	SALLOC	The segment header data type

APIs > File Manipulation Layer (FSIO) > Library Members

Contents | Index | Home

previous page start next page