Data Structures | |
| struct | _FILE_INFO |
Defines | |
| #define | FILE BYTE |
| #define | FILE_INVALID |
| #define | FILE_POS |
| #define | FILEFLAG_EOF 0x40ul |
| #define | FILEFLAG_ERROR 0x20ul |
| #define | FILEFLAG_READING 0x02ul |
| #define | FILEFLAG_RES 0x80ul |
| #define | FILEFLAG_USED 0x01ul |
| #define | FILEFLAG_WRITING 0x04ul |
| #define | fileHasError(fhandle) |
| #define | fileIsEOF(fhandle) |
| #define | fileIsOK(fhandle) |
| #define | fileIsValidHandle(fhandle) |
| #define | FSYS_NOT_AVAILABLE |
| #define | FSYS_POS |
| #define | FSYSFLAG_AVAILABLE 0x01ul |
| #define | fsysIsInUse() |
Typedefs | |
| typedef struct _FILE_INFO | FSEE_FILE_INFO |
Functions | |
| void | fileClose (FILE fhandle) |
| void | fileFlush (FILE fhandle) |
| BYTE | fileGetByte (FILE fhandle) |
| FSEE_POS | fileGetFAT (BYTE *name) |
| FILE_POS | fileGetPos (FILE fhandle) |
| FILE | fileOpen (BYTE *name, BYTE mode) |
| FILE | fileOpenFAT (FSYS_POS fatPos) |
| FILE | fileOpenImage () |
| BOOL | filePutByte (FILE fhandle, BYTE b) |
| void | fileRelease (FILE fhandle) |
| void | fileSetPos (FILE fhandle, FILE_POS put) |
| BOOL | fsysFormat (void) |
| BOOL | fsysInit (void) |
#define FSEE_IS_PRIMARY_FS
| #define FILE BYTE |
FILE handle. Each open files is assigned a file handle.
| #define FILE_INVALID |
When FILE Handle has this value, it indicates an invalid file
| #define FILE_POS |
FILE position pointer. A variable that can be used to give the offset anywhere in a file.
| #define FILEFLAG_EOF 0x40ul |
FILE flag. When set, indicates that then end of file has been reached.
| #define FILEFLAG_ERROR 0x20ul |
FILE flag. When set, indicates that an error has occured with this file.
| #define FILEFLAG_READING 0x02ul |
FILE flag. Indicates that we are currently reading from this file. For I2C devices, this means that the memory chip is in sequencial read mode and has control of the I2C bus! Before the bus can be used by any other node, it has to be released!
| #define FILEFLAG_RES 0x80ul |
FILE flag. Reserve (don't use) signed bit, is implemented differently by different compilers
| #define FILEFLAG_USED 0x01ul |
FILE flag. When set, indicates that this file is being used.
| #define FILEFLAG_WRITING 0x04ul |
FILE flag. Indicates that we are currently writing to this file. For I2C devices, this means that the memory chip is in sequencial write mode and has control of the I2C bus! Before the bus can be used by any other node, it has to be released!
| #define fileHasError | ( | fhandle | ) |
Tests if the last operation on the given file generated an error.
| #define fileIsEOF | ( | fhandle | ) |
Tests if the given file has reached it's EOF. This will happen:
| #define fileIsOK | ( | fhandle | ) |
Tests if the last operation on the given file completed without an EOF or Error. If this function returns false, use the fileIsEOF() and fileIsOK() functions to determine exact condition.
| #define fileIsValidHandle | ( | fhandle | ) |
Tests if the given FILE handle is a valid handle. A valid FILE handle is a value that could be assigned to an open file. Possible invalid FILE handles are FILE_INVALID and FSYS_NOT_AVAILABLE
| #define FSYS_NOT_AVAILABLE |
When FILE Handle has this value, it indicates that the File System is not available
| #define FSYS_POS |
File System position pointer. A variable that can be used to give the offset anywhere in the File System.
| #define FSYSFLAG_AVAILABLE 0x01ul |
File System flag. When set, indicates that the File System is available.
| #define fsysIsInUse | ( | ) |
Indicates if the File System is currently in use.
| typedef struct _FILE_INFO FSEE_FILE_INFO |
FILE structure. Each file that is opened is assigned a FILE structure by the File System.
| void fileClose | ( | FILE | fhandle | ) |
Closes the given file. Seeing that the File System can only have a limited amount of files open at any time (defined by FSEE_MAX_FILES), it is very important to call this function after finished with a file!
| fhandle | FILE handle of the file to be released |
| void fileFlush | ( | FILE | fhandle | ) |
Finishes writing any data that has not yet been written to the File System. When writing data to a file via the filePutByte() function, it is not always written straight to the File System Media, but some times to an intermediate buffer. This function will write all pending data from the buffer to the File System Media.
| BYTE fileGetByte | ( | FILE | fhandle | ) |
Reads the next byte from current open file.
Caller must call fileIsEOF() to check for end of file condition before calling this function to make sure the file has not reached it's end. If the fileIsEOF() returns true, then this function will have no affect!
Caller must call fileHasError() function after calling this function to ensure byte was read without error!
This function will place the EEPROM in sequencial read mode and take control of the I2C bus! To allow other devices to use the I2C bus while the file is open, call fileRelease() when finished reading some data. When calling fileRead() after calling fileRelease(), the EEPROM will automatically be placed in sequencial read mode again and take control of the bus.
To read multiple bytes, see ex_file_read.c example file.
| fhandle | FILE handle of the file to be released |
| FSEE_POS fileGetFAT | ( | BYTE * | name | ) |
Gets the address in the File System of the requested file's FAT entry. This address can be used as a fast way to open files in the future with the fileOpenFAT() function.
!!! IMPORTANT !!! The File System FAT entry address obtained with the fileGetFAT() function will only be valid as long as no modifications are made to the File System! If after obtaining a address with the fileGetFAT() function the File System is modified, this value might not be valid any more!
| FILE_POS fileGetPos | ( | FILE | fhandle | ) |
Get the current file pointer for the given file. This is the offset in the given file that the next read or write will be performed on. This value can be used as a parameter to the fileSetPos() function at a later stage to restore the current file position. This is NOT the file address in the file system.
Opens the given file for reading or writing, and returns a handle to the file. The file pointer (where next read or write will occur) will be positioned at the beginning of the file. To modify the file pointer use the fileSetPos() function. There is no need to call fileRelease() after calling this function, it does not reserve any resources!
| name | NULL terminate file name. | |
| mode | Currently not used. All files are opened with read and write permission. When writing to a file, no data can be appended to it! |
| FILE fileOpenFAT | ( | FSYS_POS | fatPos | ) |
Opens the given file for reading or writing, and returns a handle to the file. The file pointer (where next read or write will occur) will be positioned at the beginning of the file. To modify the file pointer use the fileSetPos() function.
!!! IMPORTANT !!! The File System FAT entry address obtained with the fileGetFAT() function will only be valid as long as no modifications are made to the File System! If after obtaining a address with the fileGetFAT() function the File System is modified, this value might not be valid any more!
| fatPos | The requested File's FAT address in the File System. This value has to be obtained from a fileGetFAT() function. |
| FILE fileOpenImage | ( | ) |
Prepares the File System to receive a new Image via following calls to filePutByte()! The given image must contain the FAT and all file data.
!!! IMPORTANT !!! This function will overwrite the entire File System! All data will be lost!
Writes a byte to the given file.
Caller must call fileIsEOF() to check for end of file condition before calling this function to make sure the file has not reached it's end. If the fileIsEOF() returns true, then this function will have no affect!
Writes a byte to the current output. Actual write may not get started until internal write page is full. To ensure that previously data gets written, caller must call fileFlush() after last call to filePutByte().
| fhandle | FILE handle to the file to be activated | |
| b | byte to be written |
| void fileRelease | ( | FILE | fhandle | ) |
Releases any resources that the given open file might be reserving. On certian File Systems, like ones that use EEPROMs on a shared I2C bus for example, the File System will take control of the bus once a file is opened. To release the bus so it can be used by other modules, the fileRelease() function has to be called. At a later stage, when the file has to be used again, the fileActive() function has to be called.
This function should be called when a file has been opened, and we don't want to close it now, but still want to use it at a later stage. In this case, we can call fileRelease() and suspend operation to the system to perform other tasks. When at a later stage we want to use this file again, fileActivate() will automatically be called by the file read and write functions.
| fhandle | FILE handle of the file to be released |
| void fileSetPos | ( | FILE | fhandle, | |
| FILE_POS | put | |||
| ) |
Set the current file pointer for the given file. This is the offset in the given file that the next read or write will be performed on.
| BOOL fsysFormat | ( | void | ) |
Deletes all files present on the File System
| BOOL fsysInit | ( | void | ) |
Initializes the Modtronix File System
1.5.8