inc/IP_FS.h (STemWin)

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

/********************************************************************* * SEGGER Microcontroller GmbH & Co. KG * * Solutions for real time microcontroller applications * ********************************************************************** * * * (c) 1996 - 2017 SEGGER Microcontroller GmbH & Co. KG * * * * Internet: www.segger.com Support: support@segger.com * * * ********************************************************************** ** emWin V5.44 - Graphical user interface for embedded applications ** All Intellectual Property rights in the Software belongs to SEGGER. emWin is protected by international copyright laws. Knowledge of the source code may not be used to write a similar product. This file may only be used in accordance with the following terms: The software has been licensed to STMicroelectronics International N.V. a Dutch company with a Swiss branch and its headquarters in Plan- les-Ouates, Geneva, 39 Chemin du Champ des Filles, Switzerland for the purposes of creating libraries for ARM Cortex-M-based 32-bit microcon_ troller products commercialized by Licensee only, sublicensed and dis_ tributed under the terms and conditions of the End User License Agree_ ment supplied by STMicroelectronics International N.V. Full source code is available at: www.segger.com We appreciate your understanding and fairness. ---------------------------------------------------------------------- ****************************************************************************** * @attention * * <h2><center>© Copyright (c) 2018 STMicroelectronics. * All rights reserved.</center></h2> * * This software component is licensed by ST under Ultimate Liberty license SLA0044, * the "License"; You may not use this file except in compliance with the License. * You may obtain a copy of the License at: * http://www.st.com/SLA0044 * ****************************************************************************** -------------------------- END-OF-HEADER ----------------------------- File : IP_FS.h Purpose : Header file for file system abstraction layer. */ #ifndef IP_FS_H // Avoid multiple inclusion. #define IP_FS_H #include "SEGGER.h" #if defined(__cplusplus) extern "C" { // Make sure we have C-declarations in C++ programs. #endif /********************************************************************* * * Types * ********************************************************************** */ typedef struct { // // Read only file operations. These have to be present on ANY file system, even the simplest one. // void* (*pfOpenFile) (const char* sFilename); int (*pfCloseFile) (void* hFile); int (*pfReadAt) (void* hFile, void* pBuffer, U32 Pos, U32 NumBytes); long (*pfGetLen) (void* hFile); // // Directory query operations. // void (*pfForEachDirEntry) (void* pContext, const char* sDir, void (*pf)(void*, void*)); void (*pfGetDirEntryFileName) (void* pFileEntry, char* sFileName, U32 SizeOfBuffer); U32 (*pfGetDirEntryFileSize) (void* pFileEntry, U32* pFileSizeHigh); U32 (*pfGetDirEntryFileTime) (void* pFileEntry); int (*pfGetDirEntryAttributes)(void* pFileEntry); // // Write file operations. // void* (*pfCreate) (const char* sFileName); void* (*pfDeleteFile) (const char* sFilename); int (*pfRenameFile) (const char* sOldFilename, const char* sNewFilename); int (*pfWriteAt) (void* hFile, void* pBuffer, U32 Pos, U32 NumBytes); // // Additional directory operations // int (*pfMKDir) (const char* sDirName); int (*pfRMDir) (const char* sDirName); // // Additional operations // int (*pfIsFolder) (const char* sPath); int (*pfMove) (const char* sOldFilename, const char* sNewFilename); } IP_FS_API; typedef struct { const char* sPath; const unsigned char* pData; unsigned int FileSize; } IP_FS_READ_ONLY_FILE_ENTRY; typedef struct IP_FS_READ_ONLY_FILE_HOOK_STRUCT IP_FS_READ_ONLY_FILE_HOOK; struct IP_FS_READ_ONLY_FILE_HOOK_STRUCT { IP_FS_READ_ONLY_FILE_HOOK* pNext; IP_FS_READ_ONLY_FILE_ENTRY FileEntry; }; /********************************************************************* * * API functions * ********************************************************************** */ #define IP_FS_FS IP_FS_emFile #define IP_FS_FS_AllowHiddenAccess IP_FS_emFile_AllowHiddenAccess #define IP_FS_FS_DenyHiddenAccess IP_FS_emFile_DenyHiddenAccess extern const IP_FS_API IP_FS_ReadOnly; // Read-only file system, typically located in flash memory. extern const IP_FS_API IP_FS_Win32; // File system interface for Win32. extern const IP_FS_API IP_FS_Linux; // File system interface for Linux extern const IP_FS_API IP_FS_emFile; // Target file system (emFile), shows and allows access to hidden files. extern const IP_FS_API IP_FS_emFile_AllowHiddenAccess; // Target file system (emFile), does not show hidden files but allows access to them. extern const IP_FS_API IP_FS_emFile_DenyHiddenAccess; // Target file system (emFile), does not show hidden files and does not allow access to them. // // Helper functions for Read Only file system layer. // void IP_FS_READ_ONLY_ClrFileHooks(void); void IP_FS_READ_ONLY_AddFileHook (IP_FS_READ_ONLY_FILE_HOOK* pHook, const char* sPath, const unsigned char* pData, unsigned int FileSize); // // Helper functions for Win32 file system layer. // void IP_FS_WIN32_ConfigBaseDir(const char* sDir); #if defined(__cplusplus) } // Make sure we have C-declarations in C++ programs. #endif #endif // Avoid multiple inclusion. /*************************** End of file ****************************/