Internal Members

Microchip MDD File System Interface

previous page next page

MDDFS Interface Library Help

Internal Members

The following functions, variables, structures, and macros are designated as internal to the library.

Functions

	Name	Description
	_SRAMmerge	This function tries to merge adjacent segments that have not been allocated. The largest possible segment is merged if possible.
	Cache_File_Entry	Load a file entry
	CacheTime	Automatically store timestamp information from the RTCC
	chdirhelper	Helper function for FSchdir
	Cluster2Sector	Convert a cluster number to the corresponding sector
	CreateDIR	FSmkdir helper function to create a directory
	CreateFileEntry	Create a new file entry
	CreateFirstCluster	Create the first cluster for a file
	DISKmount	Initialies the device and loads MBR and boot sector information
	EraseCluster	Erase a cluster
	FAT_erase_cluster_chain	Erase a chain of clusters
	FATfindEmptyCluster	Find the next available cluster on the device
	FILEallocate_new_cluster	This function will find an empty cluster on the device using the FATfindEmptyCluster function. It will then mark it as the last cluster in the file in the FAT chain, and link the current last cluster of the passed file to the new cluster. If the new cluster is a directory cluster, it will be erased (so there are no extraneous directory entries). If it's allocated to a non-directory file, it doesn't need to be erased; extraneous data in the cluster will be unviewable because of the file size parameter.
	FILECreateHeadCluster	Create the first cluster of a file
	FILEerase	Erase a file
	FILEfind	Finds a file on the device
	FILEget_next_cluster	Step through a chain of clusters
	FileObjectCopy	Copy a file object
	FILEopen	Loads file information from the device
	eraseDir	FSrmdir helper function to erase dirs
	Fill_File_Object	Fill a file object with specified dir entry data
	FindEmptyEntries	Find an empty dir entry
	flushData	Flush unwritten data to a file
	FormatDirName	Format a dir name into dir entry format
	FormatFileName	Format a file name into dir entry format
	FSputc	FSfprintf helper function to write a char
	FSvfprintf	Helper function for FSfprintf
	GetFullClusterNumber	Gets the cluster number from a directory entry
	GetPreviousEntry	Get the file entry info for the parent dir of the specified dir
	IncrementTimeStamp	Automatically set the timestamp to "don't care" data
	LoadBootSector	Load the boot sector and extract the necessary information
	LoadDirAttrib	Load file information from a directory entry and cache the entry
	LoadMBR	Loads the MBR and extracts necessary information
	mkdirhelper	Helper function for FSmkdir
	PopulateEntries	Populate a dir entry with data
	ReadFAT	Read the next entry from the FAT
	rmdirhelper	Helper function for FSrmdir
	SRAMInitHeap	This function initializes the dynamic heap. It inserts segment headers to maximize segment space.
	str_put_n_chars	FSfprintf helper function to write a char multiple times
	ValidateChars	Validate the characters in a given file name
	Write_File_Entry	Write dir entry info into a specified entry
	writeDotEntries	Create dot and dotdot entries in a non-root directory

Macros

	Name	Description
	_FLAG_MINUS	FSfprintf minus flag indicator
	_FLAG_OCTO	FSfprintf octothorpe (hash mark) flag indicator
	_FLAG_PLUS	FSfprintf plus flag indicator
	_FLAG_SIGNED	FSfprintf signed flag indicator
	_FLAG_SPACE	FSfprintf space flag indicator
	_FLAG_ZERO	FSfprintf zero flag indicator
	_FMT_BYTE	FSfprintf 8-bit argument size flag
	_FMT_LONG	FSfprintf 32-bit argument size flag
	_FMT_LONGLONG	FSfprintf 64-bit argument size flag
	_FMT_SHRTLONG	FSfprintf 24-bit argument size flag
	_FMT_UNSPECIFIED	FSfprintf unspecified argument size flag
	_MAX_HEAP_SIZE	A macro used to determine the heap initialization size.
	_MAX_SEGMENT_SIZE	A macro used to determine the maximum size of a dynamic memory segment.
	DIRECTORY	Value indicating that the CreateFileEntry function will be creating a directory
	DIRENTRIES_PER_SECTOR	The number of directory entries in a sector
	NEAR	A macro used to specify the near-model action

Structures

	Name	Description
	_DIRENTRY	Directory entry structure

Types

	Name	Description
	DIRENTRY	A pointer to a directory entry structure
	FILEOBJ	Pointer to an FSFILE object

Variables

	Name	Description
	_uDynamicHeap	The PIC18 dynamic memory heap
	cwd	Global current working directory
	cwdptr	Pointer to the current working directory
	defaultArray	This string is used by FSgetcwd to return the cwd name if the path passed into the function is NULL
	defaultString	This string is used by dir functions to hold dir names temporarily
	dirCleared	Global variable used by the "recursive" FSrmdir function to indicate that all subdirectories and files have been deleted from the target directory.
	FatRootDirClusterValue	Global variable containing the cluster number of the root dir (0 for FAT12/16)
	FSerrno	Global error variable. Set to one of many error codes after each function call.
	gBufferOwner	Global variable indicating which file is using the data buffer
	gBufferZeroed	Global variable indicating that the data buffer contains all zeros
	gDataBuffer	The global data sector buffer
	gDiskData	Global structure containing device information.
	gFATBuffer	The global FAT sector buffer
	gFileArray	Array that contains file information (static allocation)
	gFileSlotOpen	Array that indicates which elements of gFileArray are available for use
	gFileTemp	Global variable used for file operations.
	gLastDataSectorRead	Global variable indicating which data sector was read last
	gLastFATSectorRead	Global variable indicating which FAT sector was read last
	gNeedDataWrite	Global variable indicating that there is information that needs to be written to the data section
	gNeedFATWrite	Global variable indicating that there is information that needs to be written to the FAT
	gTimeAccDate	Global time variable (for timestamps) used to indicate last access date
	gTimeCrtDate	Global time variable (for timestamps) used to indicate create date
	gTimeCrtMS	Global time variable (for timestamps) used to indicate create time (milliseconds)
	gTimeCrtTime	Global time variable (for timestamps) used to indicate create time
	gTimeWrtDate	Global time variable (for timestamps) used to indicate last update date
	gTimeWrtTime	Global time variable (for timestamps) used to indicate last update time
	nextClusterIsLast	Global variable indicating that the entries in a directory align with a cluster boundary
	recache	Global variable used by the "recursive" FSrmdir function to indicate that additional cache reads are needed.
	s_digits	FSfprintf table of conversion digits
	tempArray	This array is used to prevent a stack frame error
	TempClusterCalc	Global variable used to store the calculated value of the cluster of a specified sector.
	tempCWDobj	Global variable used to preserve the current working directory information.

APIs > File Manipulation Layer (FSIO) > Internal Members

Contents | Index | Home

previous page start next page