You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
181 lines
4.9 KiB
C
181 lines
4.9 KiB
C
/*
|
|
* filesystem_hal.h
|
|
*
|
|
* Copyright 2014 Michael Zillgith
|
|
*
|
|
* This file is part of libIEC61850.
|
|
*
|
|
* libIEC61850 is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* libIEC61850 is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with libIEC61850. If not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
* See COPYING file for the complete license text.
|
|
*/
|
|
|
|
#ifndef FILESYSTEM_HAL_H_
|
|
#define FILESYSTEM_HAL_H_
|
|
|
|
#include "hal_base.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/*! \addtogroup hal
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @defgroup HAL_FILESYSTEM Interface to the native file system (optional)
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
typedef void* FileHandle;
|
|
typedef struct sDirectoryHandle* DirectoryHandle;
|
|
|
|
#ifndef CONFIG_SYSTEM_FILE_SEPARATOR
|
|
#define CONFIG_SYSTEM_FILE_SEPARATOR '/'
|
|
#endif
|
|
|
|
/**
|
|
* \brief open a file
|
|
*
|
|
* \param pathName full name (path + filename) of the file
|
|
* \param readWrite true opens the file with read and write access - false opens for read access only
|
|
*
|
|
* \return a handle for the file. Has to be used by subsequent calls to file functions to identify the file or
|
|
* NULL if opening fails
|
|
*/
|
|
PAL_API FileHandle
|
|
FileSystem_openFile(char* pathName, bool readWrite);
|
|
|
|
/**
|
|
* \brief read from an open file
|
|
*
|
|
* This function will read the next block of the file. The maximum number of bytes to read
|
|
* is given. A call to this function will move the file position by the number of bytes read.
|
|
* If the file position reaches the end of file then subsequent calls of this function shall
|
|
* return 0.
|
|
*
|
|
* \param handle the file handle to identify the file
|
|
* \param buffer the buffer to write the read data
|
|
* \param maxSize maximum number of bytes to read
|
|
*
|
|
* \return the number of bytes actually read
|
|
*/
|
|
PAL_API int
|
|
FileSystem_readFile(FileHandle handle, uint8_t* buffer, int maxSize);
|
|
|
|
/**
|
|
* \brief write to an open file
|
|
*
|
|
* \param handle the file handle to identify the file
|
|
* \param buffer the buffer with the data to write
|
|
* \param size the number of bytes to write
|
|
*
|
|
* \return the number of bytes actually written
|
|
*/
|
|
PAL_API int
|
|
FileSystem_writeFile(FileHandle handle, uint8_t* buffer, int size);
|
|
|
|
/**
|
|
* \brief close an open file
|
|
*
|
|
* \param handle the file handle to identify the file
|
|
*/
|
|
PAL_API void
|
|
FileSystem_closeFile(FileHandle handle);
|
|
|
|
/**
|
|
* \brief return attributes of the given file
|
|
*
|
|
* This function is used by the MMS layer to determine basic file attributes.
|
|
* The size of the file has to be returned in bytes. The timestamp of the last modification has
|
|
* to be returned as milliseconds since Unix epoch - or 0 if this function is not supported.
|
|
*
|
|
* \param pathName full name (path + filename) of the file
|
|
* \param fileSize a pointer where to store the file size
|
|
* \param lastModificationTimestamp is used to store the timestamp of last modification of the file
|
|
*
|
|
* \return true if file exists, false if not
|
|
*/
|
|
PAL_API bool
|
|
FileSystem_getFileInfo(char* filename, uint32_t* fileSize, uint64_t* lastModificationTimestamp);
|
|
|
|
/**
|
|
* \brief delete a file
|
|
*
|
|
* \param pathName full name (path + filename) of the file
|
|
*
|
|
* \return true on success, false on error
|
|
*/
|
|
PAL_API bool
|
|
FileSystem_deleteFile(char* filename);
|
|
|
|
/**
|
|
* \brief rename a file
|
|
*
|
|
* \param oldFileName current full name (path + filename) of the file
|
|
* \param newFileName new full name (path + filename) of the file
|
|
*
|
|
* \return true on success, false on error
|
|
*/
|
|
PAL_API bool
|
|
FileSystem_renameFile(char* oldFilename, char* newFilename);
|
|
|
|
/**
|
|
* \brief open the directoy with the specified name
|
|
*
|
|
* \param directoryName
|
|
*
|
|
* \return a handle for the opened directory to be used in subsequent calls to identify the directory
|
|
*/
|
|
PAL_API DirectoryHandle
|
|
FileSystem_openDirectory(char* directoryName);
|
|
|
|
/**
|
|
* \brief read the next directory entry
|
|
*
|
|
* This function returns the next directory entry. The entry is only a valid pointer as long as the
|
|
* FileSystem_closeDirectory or another FileSystem_readDirectory function is not called for the given
|
|
* DirectoryHandle.
|
|
*
|
|
* \param directory the handle to identify the directory
|
|
* \param isDirectory return value that indicates if the directory entry is itself a directory (true)
|
|
*
|
|
* \return the name of the directory entry
|
|
*/
|
|
PAL_API char*
|
|
FileSystem_readDirectory(DirectoryHandle directory, bool* isDirectory);
|
|
|
|
|
|
/**
|
|
* \brief close a directory
|
|
*
|
|
* \param directory the handle to identify the directory
|
|
*/
|
|
PAL_API void
|
|
FileSystem_closeDirectory(DirectoryHandle directory);
|
|
|
|
|
|
/*! @} */
|
|
|
|
/*! @} */
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* FILESYSTEM_HAL_H_ */
|