1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
|
/*
* This file is subject to the terms of the GFX License. If a copy of
* the license was not distributed with this file, you can obtain one at:
*
* http://ugfx.org/license.html
*/
/**
* @file src/gfile/gfile_options.h
* @brief GFILE - File IO options header file.
*
* @addtogroup GFILE
* @{
*/
#ifndef _GFILE_OPTIONS_H
#define _GFILE_OPTIONS_H
/**
* @name GFILE Functionality to be included
* @{
*/
/**
* @brief Should the filesystem not be mounted automatically
* @details The filesystem is normally mounted automatically if the
* user does not do it manually. This option turns that off
* so the user must manually mount the file-system first.
* @details Defaults to FALSE
*/
#ifndef GFILE_NEED_NOAUTOMOUNT
#define GFILE_NEED_NOAUTOMOUNT FALSE
#endif
/**
* @brief Should the filesystem be synced automatically
* @details The filesystem will automatically be synced after an open() or
* write() call unless this feature is disabled.
* @details If this feature is disabled, the user should sync the filesystem
* himself using @p gfileSync()
* @details Not all filesystems implement the syncing feature. This feature will
* have no effect in such a case.
* @details Defaults to FALSE
*/
#ifndef GFILE_NEED_NOAUTOSYNC
#define GFILE_NEED_NOAUTOSYNC FALSE
#endif
/**
* @brief Include printg, fprintg etc functions
* @details Defaults to FALSE
* @pre To get the string sprintg functions you also need to define @p GFILE_NEED_STRINGS
*/
#ifndef GFILE_NEED_PRINTG
#define GFILE_NEED_PRINTG FALSE
#endif
/**
* @brief Include scang, fscang etc functions
* @details Defaults to FALSE
* @pre To get the string sscang functions you also need to define @p GFILE_NEED_STRINGS
*/
#ifndef GFILE_NEED_SCANG
#define GFILE_NEED_SCANG FALSE
#endif
/**
* @brief Include the string based file functions
* @details Defaults to FALSE
*/
#ifndef GFILE_NEED_STRINGS
#define GFILE_NEED_STRINGS FALSE
#endif
/**
* @brief Map many stdio functions to their GFILE equivalent
* @details Defaults to FALSE
* @note This replaces the functions in stdio.h with equivalents
* - Do not include stdio.h as it has different conflicting definitions.
*/
#ifndef GFILE_NEED_STDIO
#define GFILE_NEED_STDIO FALSE
#endif
/**
* @brief Include the USER file system
* @details Defaults to FALSE
* @note The User FS vmt strcture 'FsUSERVMT' must be defined and implemented in the user's project.
* @note If GFILE_ALLOW_DEVICESPECIFIC is on then you can ensure that you are
* opening a file on the USER file system by prefixing
* its name with "U|" (the letter 'U', followed by a vertical bar).
* The letter 'U' as described above should be replaced by the actual
* device specifier letter in the user's FsUSERVMT structure. It is suggested
* that it is actually the letter 'U' that is used and it is important that the letter
* used is not one used by the other file systems.
*/
#ifndef GFILE_NEED_USERFS
#define GFILE_NEED_USERFS FALSE
#endif
/**
* @brief Include the ROM file system
* @details Defaults to FALSE
* @note If GFILE_ALLOW_DEVICESPECIFIC is on then you can ensure that you are
* opening a file on the ROM file system by prefixing
* its name with "S|" (the letter 'S', followed by a vertical bar).
* @note This requires a file called romfs_files.h to be in the
* users project include path. This file should include all the files
* converted to .h files using the file2c utility (using flags "-dbcs").
*/
#ifndef GFILE_NEED_ROMFS
#define GFILE_NEED_ROMFS FALSE
#endif
/**
* @brief Include the RAM file system
* @details Defaults to FALSE
* @note If GFILE_ALLOW_DEVICESPECIFIC is on then you can ensure that you are
* opening a file on the RAM file system by prefixing
* its name with "R|" (the letter 'R', followed by a vertical bar).
* @note You must also define GFILE_RAMFS_SIZE with the size of the file system
* to be allocated in RAM.
*/
#ifndef GFILE_NEED_RAMFS
#define GFILE_NEED_RAMFS FALSE
#endif
/**
* @brief Include the FAT file system driver based on the FATFS library
* @details Defaults to FALSE
* @note If GFILE_ALLOW_DEVICESPECIFIC is on then you can ensure that you are
* opening a file on the FAT file system by prefixing
* its name with "F|" (the letter 'F', followed by a vertical bar).
* @note FATFS and PETITFS offer the same FAT file system support. They just use
* different constraints. PETITFS is smaller but has less features. Only
* one can be used at a time. The block interfaces are also different.
*/
#ifndef GFILE_NEED_FATFS
#define GFILE_NEED_FATFS FALSE
#endif
/**
* @brief Include the FAT file system driver based on the PETITFS library
* @details Defaults to FALSE
* @note If GFILE_ALLOW_DEVICESPECIFIC is on then you can ensure that you are
* opening a file on the FAT file system by prefixing
* its name with "F|" (the letter 'F', followed by a vertical bar).
* @note FATFS and PETITFS offer the same FAT file system support. They just use
* different constraints. PETITFS is smaller but has less features. Only
* one can be used at a time. The block interfaces are also different.
* @note Due to the restrictions on the PETITFS library on writing, we do not implement
* writing.
* @note PETITFS can only have one file open at a time.
*/
#ifndef GFILE_NEED_PETITFS
#define GFILE_NEED_PETITFS FALSE
#endif
/**
* @brief Include the operating system's native file system
* @details Defaults to FALSE
* @note If GFILE_ALLOW_DEVICESPECIFIC is on then you can ensure that you are
* opening a file on the native file system by prefixing
* its name with "N|" (the letter 'N', followed by a vertical bar).
* @note If defined then the gfileStdOut and gfileStdErr handles
* use the operating system equivalent stdio and stderr.
* If it is not defined the gfileStdOut and gfileStdErr io is discarded.
*/
#ifndef GFILE_NEED_NATIVEFS
#define GFILE_NEED_NATIVEFS FALSE
#endif
/**
* @brief Include ChibiOS BaseFileStream support
* @details Defaults to FALSE
* @pre This is only relevant on the ChibiOS operating system.
* @note Use the @p gfileOpenBaseFileStream() call to open a GFILE based on a
* BaseFileStream. The BaseFileStream must already be open.
* @note A GFile of this type cannot be opened by filename. The BaseFileStream
* must be pre-opened using the operating system.
*/
#ifndef GFILE_NEED_CHIBIOSFS
#define GFILE_NEED_CHIBIOSFS FALSE
#endif
/**
* @brief Include raw memory pointer support
* @details Defaults to FALSE
* @note Use the @p gfileOpenMemory() call to open a GFILE based on a
* memory pointer. The GFILE opened appears to be of unlimited size.
* @note A GFile of this type cannot be opened by filename.
*/
#ifndef GFILE_NEED_MEMFS
#define GFILE_NEED_MEMFS FALSE
#endif
/**
* @brief Include support for file list functions
* @details Defaults to FALSE
* @note Adds support for @p gfileOpenFileList(), @p gfileReadFileList() and @p gfileCloseFileList().
*/
#ifndef GFILE_NEED_FILELISTS
#define GFILE_NEED_FILELISTS FALSE
#endif
/**
* @}
*
* @name GFILE Optional Parameters
* @{
*/
/**
* @brief Add floating point support to printg/scang etc.
*/
#ifndef GFILE_ALLOW_FLOATS
#define GFILE_ALLOW_FLOATS FALSE
#endif
/**
* @brief Can the device be specified as part of the file name.
* @note If this is on then a device letter and a vertical bar can be
* prefixed on a file name to specify that it must be on a
* specific device.
*/
#ifndef GFILE_ALLOW_DEVICESPECIFIC
#define GFILE_ALLOW_DEVICESPECIFIC FALSE
#endif
/**
* @brief The maximum number of open files
* @note This count excludes gfileStdIn, gfileStdOut and gfileStdErr
* (if open by default).
*/
#ifndef GFILE_MAX_GFILES
#define GFILE_MAX_GFILES 3
#endif
/**
* @brief TUse an external FATFS library instead of the uGFX inbuilt one
* @note This is applicable when GFILE_NEED_FATFS is specified. It allows
* the programmer to use their own FATFS implementation provided the
* api matches the fatfs-0.10b API.
* @note The users ffconf.h file still needs to be reachable when compiling uGFX.
* @note If ffconf.h contains _FS_REENTRANT as true then the user provided simpleton
* routines must be compatible with uGFX threading.
* @note If ffconf.h contains _USE_LFN == 3 then the user provided simpleton routines must
* be compatible with uGFX memory management.
*/
#ifndef GFILE_FATFS_EXTERNAL_LIB
#define GFILE_FATFS_EXTERNAL_LIB FALSE
#endif
/**
* @brief TUse an external PETITFS library instead of the uGFX inbuilt one
* @note This is applicable when GFILE_NEED_PETITFS is specified. It allows
* the programmer to use their own FATFS implementation provided the
* api matches the petitfs-0.03 API.
* @note The users pffconf.h file still needs to be reachable when compiling uGFX.
*/
#ifndef GFILE_PETITFS_EXTERNAL_LIB
#define GFILE_PETITFS_EXTERNAL_LIB FALSE
#endif
/** @} */
#endif /* _GFILE_OPTIONS_H */
/** @} */
|
