grblHAL core  20250320
vfs.h
Go to the documentation of this file.
1 /*
2  vfs.h - An embedded CNC Controller with rs274/ngc (g-code) support
3 
4  Virtual File System handler
5 
6  Part of grblHAL
7 
8  Copyright (c) 2022-2025 Terje Io
9 
10  grblHAL is free software: you can redistribute it and/or modify
11  it under the terms of the GNU General Public License as published by
12  the Free Software Foundation, either version 3 of the License, or
13  (at your option) any later version.
14 
15  grblHAL is distributed in the hope that it will be useful,
16  but WITHOUT ANY WARRANTY; without even the implied warranty of
17  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  GNU General Public License for more details.
19 
20  You should have received a copy of the GNU General Public License
21  along with grblHAL. If not, see <http://www.gnu.org/licenses/>.
22 */
23 
24 #ifndef INCLUDE_VFS_H
25 #define INCLUDE_VFS_H
26 
27 #define GRBL_VFS
28 
29 #include <stdbool.h>
30 #include <stddef.h>
31 #include <stdlib.h>
32 #include <string.h>
33 #include <time.h>
34 
35 #define vfs_load_plugin(x)
36 
37 #ifndef bcopy
38 #define bcopy(src, dest, len) memmove(dest, src, len)
39 #endif
40 
41 #if !(defined(__time_t_defined) || defined(_TIME_H_) || defined(__MSP432P401R__) || defined(PART_TM4C123GH6PM))
42 typedef struct {
43  short date;
44  short time;
45 } time_t;
46 
47 struct tm {
48  int tm_year;
49  int tm_mon;
50  int tm_mday;
51  int tm_hour;
52  int tm_min;
53  int tm_sec;
54 };
55 #endif // __time_t_defined
56 
57 typedef union
58 {
59  uint8_t mode;
60  struct {
61  uint8_t read_only :1,
62  hidden :1,
63  system :1,
64  unused :1,
66  archive :1;
67  };
69 
70 typedef struct {
71  size_t st_size;
73 #ifdef ESP_PLATFORM // some versions of ESP-IDF/Compiler combos are fcked up
74  time_t st_mtim;
75 #else
77 #endif
78 } vfs_stat_t;
79 
80 typedef struct {
81  const void *fs;
82  size_t size;
83  bool update;
84  uint8_t handle __attribute__ ((aligned (4))); // first byte of file handle structure
85 } vfs_file_t;
86 
87 struct vfs_dir;
88 typedef struct vfs_dir vfs_dir_t;
89 
90 typedef struct {
91  char name[255];
92  size_t size;
94 } vfs_dirent_t;
95 
96 typedef struct {
97  uint64_t size;
98  uint64_t used;
99 } vfs_free_t;
100 
101 typedef struct {
102  const char *name;
103  size_t size;
105  const uint8_t data[];
107 
108 typedef vfs_file_t *(*vfs_open_ptr)(const char *filename, const char *mode);
109 typedef char *(*vfs_getcwd_ptr)(char *buf, size_t size);
110 typedef size_t (*vfs_read_ptr)(void *buffer, size_t size, size_t count, vfs_file_t *file);
111 typedef size_t (*vfs_write_ptr)(const void *buffer, size_t size, size_t count, vfs_file_t *file);
112 typedef void (*vfs_close_ptr)(vfs_file_t *file);
113 typedef size_t (*vfs_ftell_ptr)(vfs_file_t *file);
114 typedef int (*vfs_fseek_ptr)(vfs_file_t *file, size_t offset);
115 typedef bool (*vfs_eof_ptr)(vfs_file_t *file);
116 typedef int (*vfs_rename_ptr)(const char *from, const char *to);
117 typedef int (*vfs_unlink_ptr)(const char *filename);
118 
119 typedef int (*vfs_mkdir_ptr)(const char *path);
120 typedef int (*vfs_chdir_ptr)(const char *path);
121 typedef int (*vfs_rmdir_ptr)(const char *path);
122 typedef vfs_dir_t *(*vfs_opendir_ptr)(const char *path);
123 typedef char *(*vfs_readdir_ptr)(vfs_dir_t *dir, vfs_dirent_t *dirent);
124 typedef void (*vfs_closedir_ptr)(vfs_dir_t *dir);
125 typedef int (*vfs_chmod_ptr)(const char *filename, vfs_st_mode_t attr, vfs_st_mode_t mask);
126 typedef int (*vfs_stat_ptr)(const char *filename, vfs_stat_t *st);
127 typedef int (*vfs_utime_ptr)(const char *filename, struct tm *modified);
128 
129 typedef bool (*vfs_getfree_ptr)(vfs_free_t *free);
130 typedef int (*vfs_format_ptr)(void);
131 
132 typedef struct
133 {
134  const char *fs_name;
135  bool removable;
157 } vfs_t;
158 
159 typedef void (*on_vfs_changed_ptr)(const vfs_t *fs);
160 typedef void (*on_vfs_mount_ptr)(const char *path, const vfs_t *fs, vfs_st_mode_t mode);
161 typedef void (*on_vfs_unmount_ptr)(const char *path);
162 
163 typedef struct {
167 } vfs_events_t;
168 
169 typedef struct vfs_mount
170 {
171  char path[64];
172  const vfs_t *vfs;
174 #ifdef ESP_PLATFORM // some versions of ESP-IDF/Compiler combos are fcked up
175  time_t st_mtim;
176 #else
178 #endif
179  struct vfs_mount *next;
181 
182 typedef struct vfs_mount_ll_entry
183 {
187 
188 typedef struct {
190 } vfs_drives_t;
191 
192 typedef struct {
193  const char *name;
194  const char *path;
195  bool removable;
197  const void *fs;
198 } vfs_drive_t;
199 
200 struct vfs_dir {
201  const void *fs;
203  uint8_t handle __attribute__ ((aligned (4))); // must be last!
204 };
205 
206 extern volatile int vfs_errno;
207 extern vfs_events_t vfs;
208 
209 char *vfs_fixpath (char *path);
210 
211 bool vfs_mount (const char *path, const vfs_t *fs, vfs_st_mode_t mode);
212 bool vfs_unmount (const char *path);
213 vfs_file_t *vfs_open (const char *filename, const char *mode);
214 void vfs_close (vfs_file_t *file);
215 size_t vfs_read (void *buffer, size_t size, size_t count, vfs_file_t *file);
216 size_t vfs_write (const void *buffer, size_t size, size_t count, vfs_file_t *file);
217 int vfs_puts (const char *s, vfs_file_t *file);
218 size_t vfs_tell (vfs_file_t *file);
219 int vfs_seek (vfs_file_t *file, size_t offset);
220 bool vfs_eof (vfs_file_t *file);
221 int vfs_rename (const char *from, const char *to);
222 int vfs_unlink (const char *filename);
223 int vfs_mkdir (const char *path);
224 int vfs_rmdir (const char *path);
225 int vfs_chdir (const char *path);
226 vfs_dir_t *vfs_opendir (const char *path);
228 void vfs_closedir (vfs_dir_t *dir);
229 char *vfs_getcwd (char *buf, size_t len);
230 int vfs_chmod (const char *filename, vfs_st_mode_t attr, vfs_st_mode_t mask);
231 int vfs_stat (const char *filename, vfs_stat_t *st);
232 int vfs_utime (const char *filename, struct tm *modified);
233 vfs_free_t *vfs_fgetfree (const char *path);
234 
236 vfs_drive_t *vfs_drives_read (vfs_drives_t *handle, bool add_hidden);
237 void vfs_drives_close (vfs_drives_t *handle);
239 int vfs_drive_format (vfs_drive_t *drive);
240 vfs_drive_t *vfs_get_drive (const char *path);
241 
242 #endif // INCLUDE_VFS_H
Definition: vfs.h:101
vfs_st_mode_t st_mode
Definition: vfs.h:104
size_t size
Definition: vfs.h:103
const char * name
Definition: vfs.h:102
Definition: vfs.h:42
short time
Definition: vfs.h:44
short date
Definition: vfs.h:43
Definition: vfs.h:47
int tm_mday
Definition: vfs.h:50
int tm_sec
Definition: vfs.h:53
int tm_hour
Definition: vfs.h:51
int tm_min
Definition: vfs.h:52
int tm_year
Definition: vfs.h:48
int tm_mon
Definition: vfs.h:49
Definition: vfs.h:200
uint8_t handle
Definition: vfs.h:203
const void * fs
Definition: vfs.h:201
vfs_mount_ll_entry_t * mounts
Definition: vfs.h:202
Definition: vfs.h:90
vfs_st_mode_t st_mode
Definition: vfs.h:93
size_t size
Definition: vfs.h:92
Definition: vfs.h:192
bool removable
Definition: vfs.h:195
const void * fs
Definition: vfs.h:197
const char * path
Definition: vfs.h:194
const char * name
Definition: vfs.h:193
vfs_st_mode_t mode
Definition: vfs.h:196
Definition: vfs.h:188
vfs_mount_t * mount
Definition: vfs.h:189
Definition: vfs.h:163
on_vfs_unmount_ptr on_unmount
Called when a file system is unmounted.
Definition: vfs.h:165
on_vfs_changed_ptr on_fs_changed
Called when file system content is changed.
Definition: vfs.h:166
on_vfs_mount_ptr on_mount
Called when a file system is mounted.
Definition: vfs.h:164
Definition: vfs.h:80
const void * fs
Definition: vfs.h:81
size_t size
Definition: vfs.h:82
bool update
Definition: vfs.h:83
Definition: vfs.h:96
uint64_t used
Definition: vfs.h:98
uint64_t size
Definition: vfs.h:97
Definition: vfs.h:183
struct vfs_mount_ll_entry * next
Definition: vfs.h:185
vfs_mount_t * mount
Definition: vfs.h:184
Definition: vfs.h:170
struct vfs_mount * next
Definition: vfs.h:179
const vfs_t * vfs
Definition: vfs.h:172
vfs_st_mode_t mode
Definition: vfs.h:173
time_t st_mtime
Definition: vfs.h:177
char path[64]
Definition: vfs.h:171
Definition: vfs.h:70
vfs_st_mode_t st_mode
Definition: vfs.h:72
size_t st_size
Definition: vfs.h:71
time_t st_mtime
Definition: vfs.h:76
Definition: vfs.h:133
vfs_open_ptr fopen
Definition: vfs.h:136
vfs_getfree_ptr fgetfree
Definition: vfs.h:155
bool removable
Definition: vfs.h:135
vfs_chmod_ptr fchmod
Definition: vfs.h:151
vfs_format_ptr format
Definition: vfs.h:156
vfs_chdir_ptr fchdir
Definition: vfs.h:146
vfs_write_ptr fwrite
Definition: vfs.h:139
vfs_stat_ptr fstat
Definition: vfs.h:152
vfs_eof_ptr feof
Definition: vfs.h:142
vfs_mkdir_ptr fmkdir
Definition: vfs.h:145
const char * fs_name
Definition: vfs.h:134
vfs_close_ptr fclose
Definition: vfs.h:137
vfs_getcwd_ptr fgetcwd
Definition: vfs.h:154
vfs_fseek_ptr fseek
Definition: vfs.h:141
vfs_readdir_ptr readdir
Definition: vfs.h:149
vfs_unlink_ptr funlink
Definition: vfs.h:144
vfs_rename_ptr frename
Definition: vfs.h:143
vfs_opendir_ptr fopendir
Definition: vfs.h:148
vfs_read_ptr fread
Definition: vfs.h:138
vfs_ftell_ptr ftell
Definition: vfs.h:140
vfs_utime_ptr futime
Definition: vfs.h:153
vfs_rmdir_ptr frmdir
Definition: vfs.h:147
vfs_closedir_ptr fclosedir
Definition: vfs.h:150
Definition: vfs.h:58
uint8_t directory
Definition: vfs.h:65
uint8_t system
Definition: vfs.h:63
uint8_t mode
Definition: vfs.h:59
uint8_t hidden
Definition: vfs.h:62
uint8_t read_only
Definition: vfs.h:61
uint8_t archive
Definition: vfs.h:66
uint8_t unused
Definition: vfs.h:64
int(* vfs_chmod_ptr)(const char *filename, vfs_st_mode_t attr, vfs_st_mode_t mask)
Definition: vfs.h:125
vfs_free_t * vfs_drive_getfree(vfs_drive_t *drive)
Definition: vfs.c:711
struct vfs_mount vfs_mount_t
void(* vfs_closedir_ptr)(vfs_dir_t *dir)
Definition: vfs.h:124
int vfs_rename(const char *from, const char *to)
Definition: vfs.c:329
void(* on_vfs_mount_ptr)(const char *path, const vfs_t *fs, vfs_st_mode_t mode)
Definition: vfs.h:160
void(* on_vfs_unmount_ptr)(const char *path)
Definition: vfs.h:161
size_t(* vfs_read_ptr)(void *buffer, size_t size, size_t count, vfs_file_t *file)
Definition: vfs.h:110
vfs_free_t * vfs_fgetfree(const char *path)
Definition: vfs.c:547
int(* vfs_rename_ptr)(const char *from, const char *to)
Definition: vfs.h:116
int(* vfs_mkdir_ptr)(const char *path)
Definition: vfs.h:119
volatile int vfs_errno
Definition: vfs.c:207
vfs_dir_t *(* vfs_opendir_ptr)(const char *path)
Definition: vfs.h:122
int vfs_puts(const char *s, vfs_file_t *file)
Definition: vfs.c:296
void vfs_closedir(vfs_dir_t *dir)
Definition: vfs.c:477
bool vfs_eof(vfs_file_t *file)
Definition: vfs.c:322
vfs_dir_t * vfs_opendir(const char *path)
Definition: vfs.c:421
vfs_drive_t * vfs_drives_read(vfs_drives_t *handle, bool add_hidden)
Definition: vfs.c:681
size_t vfs_read(void *buffer, size_t size, size_t count, vfs_file_t *file)
Definition: vfs.c:282
char * vfs_fixpath(char *path)
Definition: vfs.c:216
bool(* vfs_getfree_ptr)(vfs_free_t *free)
Definition: vfs.h:129
vfs_drive_t * vfs_get_drive(const char *path)
Definition: vfs.c:643
int(* vfs_unlink_ptr)(const char *filename)
Definition: vfs.h:117
char *(* vfs_readdir_ptr)(vfs_dir_t *dir, vfs_dirent_t *dirent)
Definition: vfs.h:123
int vfs_rmdir(const char *path)
Definition: vfs.c:369
size_t(* vfs_ftell_ptr)(vfs_file_t *file)
Definition: vfs.h:113
int vfs_stat(const char *filename, vfs_stat_t *st)
Definition: vfs.c:512
int vfs_mkdir(const char *path)
Definition: vfs.c:357
vfs_drives_t * vfs_drives_open(void)
Definition: vfs.c:657
int vfs_drive_format(vfs_drive_t *drive)
Definition: vfs.c:720
struct vfs_mount_ll_entry vfs_mount_ll_entry_t
bool(* vfs_eof_ptr)(vfs_file_t *file)
Definition: vfs.h:115
int vfs_seek(vfs_file_t *file, size_t offset)
Definition: vfs.c:315
int(* vfs_rmdir_ptr)(const char *path)
Definition: vfs.h:121
char *(* vfs_getcwd_ptr)(char *buf, size_t size)
Definition: vfs.h:109
int(* vfs_chdir_ptr)(const char *path)
Definition: vfs.h:120
bool vfs_mount(const char *path, const vfs_t *fs, vfs_st_mode_t mode)
Definition: vfs.c:570
int(* vfs_stat_ptr)(const char *filename, vfs_stat_t *st)
Definition: vfs.h:126
void vfs_close(vfs_file_t *file)
Definition: vfs.c:272
int(* vfs_fseek_ptr)(vfs_file_t *file, size_t offset)
Definition: vfs.h:114
vfs_events_t vfs
Definition: vfs.c:208
void(* vfs_close_ptr)(vfs_file_t *file)
Definition: vfs.h:112
int vfs_chmod(const char *filename, vfs_st_mode_t attr, vfs_st_mode_t mask)
Definition: vfs.c:505
char * vfs_getcwd(char *buf, size_t len)
Definition: vfs.c:490
size_t(* vfs_write_ptr)(const void *buffer, size_t size, size_t count, vfs_file_t *file)
Definition: vfs.h:111
int vfs_utime(const char *filename, struct tm *modified)
Definition: vfs.c:540
int vfs_chdir(const char *path)
Definition: vfs.c:381
bool vfs_unmount(const char *path)
Definition: vfs.c:613
vfs_file_t *(* vfs_open_ptr)(const char *filename, const char *mode)
Definition: vfs.h:108
vfs_file_t * vfs_open(const char *filename, const char *mode)
Definition: vfs.c:259
void(* on_vfs_changed_ptr)(const vfs_t *fs)
Definition: vfs.h:159
void vfs_drives_close(vfs_drives_t *handle)
Definition: vfs.c:706
int(* vfs_utime_ptr)(const char *filename, struct tm *modified)
Definition: vfs.h:127
int(* vfs_format_ptr)(void)
Definition: vfs.h:130
int vfs_unlink(const char *filename)
Definition: vfs.c:345
vfs_dirent_t * vfs_readdir(vfs_dir_t *dir)
Definition: vfs.c:451
size_t vfs_write(const void *buffer, size_t size, size_t count, vfs_file_t *file)
Definition: vfs.c:289
size_t vfs_tell(vfs_file_t *file)
Definition: vfs.c:308