1 #include "../../../lvgl.h"
2 #if LV_USE_FS_LITTLEFS
3
4 #include "lfs.h"
5 #include "../../core/lv_global.h"
6
7 #if !LV_FS_IS_VALID_LETTER(LV_FS_LITTLEFS_LETTER)
8 #error "Invalid drive letter"
9 #endif
10
11 typedef struct LittleFile {
12 lfs_file_t file;
13 } LittleFile;
14
15 typedef struct LittleDirectory {
16 lfs_dir_t dir;
17 } LittleDirectory;
18
19 /**********************
20 * STATIC PROTOTYPES
21 **********************/
22 static void * fs_open(lv_fs_drv_t * drv, const char * path, lv_fs_mode_t mode);
23 static lv_fs_res_t fs_close(lv_fs_drv_t * drv, void * file_p);
24 static lv_fs_res_t fs_read(lv_fs_drv_t * drv, void * file_p, void * buf, uint32_t btr, uint32_t * br);
25 static lv_fs_res_t fs_write(lv_fs_drv_t * drv, void * file_p, const void * buf, uint32_t btw, uint32_t * bw);
26 static lv_fs_res_t fs_seek(lv_fs_drv_t * drv, void * file_p, uint32_t pos, lv_fs_whence_t whence);
27 static lv_fs_res_t fs_tell(lv_fs_drv_t * drv, void * file_p, uint32_t * pos_p);
28 static void * fs_dir_open(lv_fs_drv_t * drv, const char * path);
29 static lv_fs_res_t fs_dir_close(lv_fs_drv_t * drv, void * dir_p);
30 static lv_fs_res_t fs_dir_read(lv_fs_drv_t * drv, void * dir_p, char * fn, uint32_t fn_len);
31
lv_littlefs_set_handler(lfs_t * lfs)32 void lv_littlefs_set_handler(lfs_t * lfs)
33 {
34 lv_fs_drv_t * drv = lv_fs_get_drv(LV_FS_LITTLEFS_LETTER);
35 drv->user_data = lfs;
36 }
37
38 /**
39 * Register a driver for the LittleFS File System interface
40 */
lv_fs_littlefs_init(void)41 void lv_fs_littlefs_init(void)
42 {
43 lv_fs_drv_t * fs_drv = &(LV_GLOBAL_DEFAULT()->littlefs_fs_drv);
44 lv_fs_drv_init(fs_drv);
45
46 fs_drv->letter = LV_FS_LITTLEFS_LETTER;
47 fs_drv->open_cb = fs_open;
48 fs_drv->close_cb = fs_close;
49 fs_drv->read_cb = fs_read;
50 fs_drv->write_cb = fs_write;
51 fs_drv->seek_cb = fs_seek;
52 fs_drv->tell_cb = fs_tell;
53
54 fs_drv->dir_open_cb = fs_dir_open;
55 fs_drv->dir_close_cb = fs_dir_close;
56 fs_drv->dir_read_cb = fs_dir_read;
57
58 lv_fs_drv_register(fs_drv);
59 }
60
61 /**********************
62 * STATIC FUNCTIONS
63 **********************/
64
65 /**
66 * Open a file
67 * @param drv pointer to a driver where this function belongs
68 * @param path path to the file beginning with the driver letter (e.g. S:/folder/file.txt)
69 * @param mode read: FS_MODE_RD, write: FS_MODE_WR, both: FS_MODE_RD | FS_MODE_WR
70 * @return a file descriptor or NULL on error
71 */
fs_open(lv_fs_drv_t * drv,const char * path,lv_fs_mode_t mode)72 static void * fs_open(lv_fs_drv_t * drv, const char * path, lv_fs_mode_t mode)
73 {
74 int flags = 0;
75 if(mode == LV_FS_MODE_WR)
76 flags = LFS_O_WRONLY;
77 else if(mode == LV_FS_MODE_RD)
78 flags = LFS_O_RDONLY;
79 else if(mode == (LV_FS_MODE_WR | LV_FS_MODE_RD))
80 flags = LFS_O_RDWR;
81
82 LittleFile * lf = lv_malloc(sizeof(LittleFile));
83 LV_ASSERT_MALLOC(lf);
84
85 char buf[LV_FS_MAX_PATH_LEN];
86 lv_snprintf(buf, sizeof(buf), LV_FS_LITTLEFS_PATH "%s", path);
87
88 lfs_t * lfs = drv->user_data;
89 int err = lfs_file_open(lfs, &lf->file, buf, flags);
90 if(err) {
91 return NULL;
92 }
93
94 return (void *)lf;
95 }
96
97 /**
98 * Close an opened file
99 * @param drv pointer to a driver where this function belongs
100 * @param file_p pointer to a file_t variable. (opened with fs_open)
101 * @return LV_FS_RES_OK: no error or any error from @lv_fs_res_t enum
102 */
fs_close(lv_fs_drv_t * drv,void * file_p)103 static lv_fs_res_t fs_close(lv_fs_drv_t * drv, void * file_p)
104 {
105 LittleFile * lf = file_p;
106
107 lfs_t * lfs = drv->user_data;
108 lfs_file_close(lfs, &lf->file);
109 lv_free(lf);
110
111 return LV_FS_RES_OK;
112 }
113
114 /**
115 * Read data from an opened file
116 * @param drv pointer to a driver where this function belongs
117 * @param file_p pointer to a file_t variable.
118 * @param buf pointer to a memory block where to store the read data
119 * @param btr number of Bytes To Read
120 * @param br the real number of read bytes (Byte Read)
121 * @return LV_FS_RES_OK: no error or any error from @lv_fs_res_t enum
122 */
fs_read(lv_fs_drv_t * drv,void * file_p,void * buf,uint32_t btr,uint32_t * br)123 static lv_fs_res_t fs_read(lv_fs_drv_t * drv, void * file_p, void * buf, uint32_t btr, uint32_t * br)
124 {
125 LittleFile * lf = file_p;
126
127 lfs_t * lfs = drv->user_data;
128 *br = lfs_file_read(lfs, &lf->file, (uint8_t *)buf, btr);
129
130 return (int32_t)(*br) < 0 ? LV_FS_RES_UNKNOWN : LV_FS_RES_OK;
131 }
132
133 /**
134 * Write into a file
135 * @param drv pointer to a driver where this function belongs
136 * @param file_p pointer to a file_t variable
137 * @param buf pointer to a buffer with the bytes to write
138 * @param btw Bytes To Write
139 * @param bw the number of real written bytes (Bytes Written)
140 * @return LV_FS_RES_OK: no error or any error from @lv_fs_res_t enum
141 */
fs_write(lv_fs_drv_t * drv,void * file_p,const void * buf,uint32_t btw,uint32_t * bw)142 static lv_fs_res_t fs_write(lv_fs_drv_t * drv, void * file_p, const void * buf, uint32_t btw, uint32_t * bw)
143 {
144 LittleFile * lf = file_p;
145
146 lfs_t * lfs = drv->user_data;
147 *bw = lfs_file_write(lfs, &lf->file, (uint8_t *)buf, btw);
148
149 return (int32_t)(*bw) < 0 ? LV_FS_RES_UNKNOWN : LV_FS_RES_OK;
150 }
151
152 /**
153 * Set the read write pointer. Also expand the file size if necessary.
154 * @param drv pointer to a driver where this function belongs
155 * @param file_p pointer to a file_t variable. (opened with fs_open)
156 * @param pos the new position of read write pointer
157 * @param whence tells from where to interpret the `pos`. See @lv_fs_whence_t
158 * @return LV_FS_RES_OK: no error or any error from @lv_fs_res_t enum
159 */
fs_seek(lv_fs_drv_t * drv,void * file_p,uint32_t pos,lv_fs_whence_t whence)160 static lv_fs_res_t fs_seek(lv_fs_drv_t * drv, void * file_p, uint32_t pos, lv_fs_whence_t whence)
161 {
162 int mode = 0;
163 if(whence == LV_FS_SEEK_SET)
164 mode = LFS_SEEK_SET;
165 else if(whence == LV_FS_SEEK_CUR)
166 mode = LFS_SEEK_CUR;
167 else if(whence == LV_FS_SEEK_END)
168 mode = LFS_SEEK_END;
169
170 LittleFile * lf = file_p;
171
172 lfs_t * lfs = drv->user_data;
173 int rc = lfs_file_seek(lfs, &lf->file, pos, mode);
174
175 return rc < 0 ? LV_FS_RES_UNKNOWN : LV_FS_RES_OK;
176 }
177
178 /**
179 * Give the position of the read write pointer
180 * @param drv pointer to a driver where this function belongs
181 * @param file_p pointer to a file_p variable
182 * @param pos_p pointer to store the result
183 * @return LV_FS_RES_OK: no error or any error from @lv_fs_res_t enum
184 */
fs_tell(lv_fs_drv_t * drv,void * file_p,uint32_t * pos_p)185 static lv_fs_res_t fs_tell(lv_fs_drv_t * drv, void * file_p, uint32_t * pos_p)
186 {
187 LittleFile * lf = file_p;
188
189 lfs_t * lfs = drv->user_data;
190 *pos_p = lfs_file_tell(lfs, &lf->file);
191
192 return (int32_t)(*pos_p) < 0 ? LV_FS_RES_UNKNOWN : LV_FS_RES_OK;
193 }
194
195 /**
196 * Open a directory
197 * @param drv pointer to a driver where this function belongs
198 * @param path path to the directory beginning with the driver letter (e.g. S:/folder)
199 * @return a directory descriptor or NULL on error
200 */
fs_dir_open(lv_fs_drv_t * drv,const char * path)201 static void * fs_dir_open(lv_fs_drv_t * drv, const char * path)
202 {
203 LittleDirectory * ld = lv_malloc(sizeof(LittleDirectory));
204 LV_ASSERT_MALLOC(ld);
205
206 char buf[LV_FS_MAX_PATH_LEN];
207 lv_snprintf(buf, sizeof(buf), LV_FS_LITTLEFS_PATH "%s", path);
208
209 lfs_t * lfs = drv->user_data;
210 int err = lfs_dir_open(lfs, &ld->dir, buf);
211 if(err != LFS_ERR_OK) {
212 lv_free(ld);
213 return NULL;
214 }
215
216 return (void *)ld;
217 }
218
219 /**
220 * Close an opened directory
221 * @param drv pointer to a driver where this function belongs
222 * @param dir_p pointer to a dir_p variable. (opened with fs_dir_open)
223 * @return LV_FS_RES_OK: no error or any error from @lv_fs_res_t enum
224 */
fs_dir_close(lv_fs_drv_t * drv,void * dir_p)225 static lv_fs_res_t fs_dir_close(lv_fs_drv_t * drv, void * dir_p)
226 {
227 LittleDirectory * ld = dir_p;
228
229 lfs_t * lfs = drv->user_data;
230 int rc = lfs_dir_close(lfs, &ld->dir);
231
232 if(rc < 0) return LV_FS_RES_UNKNOWN;
233 lv_free(ld);
234
235 return LV_FS_RES_OK;
236 }
237
238 /**
239 * Read data from an opened directory
240 * @param drv pointer to a driver where this function belongs
241 * @param dir_p pointer to a file_t variable.
242 * @param fn pointer to a buffer to store the filename
243 * @param fn_len length of the buffer to store the filename
244 * @return LV_FS_RES_OK: no error or any error from @lv_fs_res_t enum
245 */
fs_dir_read(lv_fs_drv_t * drv,void * dir_p,char * fn,uint32_t fn_len)246 static lv_fs_res_t fs_dir_read(lv_fs_drv_t * drv, void * dir_p, char * fn, uint32_t fn_len)
247 {
248 if(fn_len == 0) return LV_FS_RES_INV_PARAM;
249
250 LittleDirectory * lf = dir_p;
251
252 lfs_t * lfs = drv->user_data;
253
254 fn[0] = '\0';
255 do {
256 struct lfs_info info;
257 int res = lfs_dir_read(lfs, &lf->dir, &info);
258
259 if(res < 0) return LV_FS_RES_UNKNOWN;
260 if(res == 0) { /* End of the directory */
261 fn[0] = '\0';
262 break;
263 }
264
265 if(info.type != LFS_TYPE_DIR) {
266 lv_strlcpy(fn, info.name, fn_len);
267 }
268 else {
269 lv_snprintf(fn, fn_len, "/%s", info.name);
270 }
271
272 } while(lv_strcmp(fn, "/.") == 0 || lv_strcmp(fn, "/..") == 0);
273
274 return LV_FS_RES_OK;
275 }
276
277 #else /*LV_USE_FS_LITTLEFS == 0*/
278
279 #if defined(LV_FS_LITTLEFS_LETTER) && LV_FS_LITTLEFS_LETTER != '\0'
280 #warning "LV_USE_FS_LITTLEFS is not enabled but LV_FS_LITTLEFS_LETTER is set"
281 #endif
282
283 #endif /*LV_USE_FS_LITTLEFS*/
284
