Initial commit: TXW82x FPV v2.7.0.7-42229 SDK + project sources

sdk/lib/VFS/vfs.h

@@ -0,0 +1,128 @@
+/*
+ * Copyright 2024, Hiroyuki OYAMA
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+#ifndef VFS_H
+#define VFS_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+//#include <fcntl.h>
+//#include <sys/types.h>
+#include "osal/string.h"
+#include "filesystem.h"
+#include "blockdevice.h"
+
+#define VFS_malloc  os_malloc
+#define VFS_calloc  os_calloc
+#define VFS_free    os_free
+#define VFS_memset  hw_memset
+#define VFS_memcpy  hw_memcpy
+#define VFS_strcpy  os_strcpy
+#define VFS_strdup  os_strdup
+#define VFS_strncpy  os_strncpy
+
+
+
+/*! \brief Enable predefined file systems
+ * \ingroup filesystem
+ *
+ * This default function defines the block device and file system, formats it if necessary and then mounts it on `/` to make it available.
+ * The `pico_enable_filesystem` function in CMakeLists.txt provides a default or user-defined fs_init function.
+ *
+ * \retval true Init succeeded.
+ * \retval false Init failed.
+ */
+bool fs_init(void);
+
+/*! \brief Format block device with specify file system
+ * \ingroup filesystem
+ *
+ * Block devices can be formatted and made available as a file system.
+ *
+ * \param fs File system object. Format the block device according to the specified file system.
+ * \param device Block device used in the file system.
+ * \retval 0 Format succeeded.
+ * \retval -1 Format failed. Error codes are indicated by errno.
+ */
+int fs_format(filesystem_t *fs, blockdevice_t *device);
+
+/*! \brief Mount a file system
+ * \ingroup filesystem
+ *
+ * Mounts a file system with block devices at the specified path.
+ *
+ * \param path Directory path of the mount point. Specify a string beginning with a slash.
+ * \param fs File system object.
+ * \param device Block device used in the file system. Block devices must be formatted with a file system.
+ * \retval 0 Mount succeeded.
+ * \retval -1 Mount failed. Error codes are indicated by errno.
+ */
+int fs_mount(const char *path, filesystem_t *fs, blockdevice_t *device);
+
+/*! \brief Dismount a file system
+ * \ingroup filesystem
+ *
+ * Dismount a file system.
+ *
+ * \param path Directory path of the mount point. Must be the same as the path specified for the mount.
+ * \retval 0 Dismount succeeded.
+ * \retval -1 Dismount failed. Error codes are indicated by errno.
+ */
+int fs_unmount(const char *path);
+
+/*! \brief Reformat the mounted file system
+ * \ingroup filesystem
+ *
+ * Reformat a file system mounted at the specified path.
+ *
+ * \param path Directory path of the mount point. Must be the same as the path specified for the mount.
+ * \retval 0 Reformat suceeded.
+ * \retval -1 Reformat failed. Error codes are indicated by errno.
+ */
+int fs_reformat(const char *path);
+
+/*! \brief Lookup filesystem and blockdevice objects from a mount point
+ * \ingroup filesystem
+ *
+ * \param path Directory path of the mount point. Must be the same as the path specified for the mount.
+ * \param fs Pointer references to filesystem objects
+ * \param device Pinter references to blockdevice objects
+ * \retval 0 Lookup succeeded
+ * \retval -1 Lookup failed. Error codes are indicated by errno.
+ */
+int fs_info(const char *path, filesystem_t **fs, blockdevice_t **device);
+
+/*! \brief File system error message
+ * \ingroup filesystem
+ *
+ * Convert the error code reported in the negative integer into a string.
+ *
+ * \param error Negative error code returned by the file system.
+ * \return Pointer to the corresponding message string.
+ */
+char *fs_strerror(int error);
+
+ssize_t VFS_read(int fildes, void *buf, size_t nbyte);
+ssize_t VFS_write(int fildes, const void *buf, size_t nbyte);
+int VFS_close(int fildes);
+int VFS_open(const char *path, int oflags, ...);
+int32_t VFS_seek(int fildes, int32_t offset, int whence);
+int32_t VFS_fsize(int fildes);
+int VFS_stat(const char *path, struct VFS_stat *st);
+int VFS_ftruncate(int fildes, int32_t length);
+int VFS_mkdir(const char *path, mode_t mode) ;
+fs_dir_t *VFS_opendir(const char *path);
+struct dirent *VFS_readdir(fs_dir_t *dir);
+int VFS_closedir(fs_dir_t *dir);
+int VFS_rmdir(const char *path);
+int VFS_rename(const char *old, const char *new);
+int VFS_unlink(const char *path);
+
+#ifdef __cplusplus
+}
+#endif
+#endif