Diff: source/daplink/drag-n-drop/vfs_manager.h

Revision:

0:01f31e923fe2

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/source/daplink/drag-n-drop/vfs_manager.h	Tue Apr 07 12:55:42 2020 +0200
@@ -0,0 +1,79 @@
+/**
+ * @file    vfs_manager.h
+ * @brief   Methods that build and manipulate a virtual file system
+ *
+ * DAPLink Interface Firmware
+ * Copyright (c) 2009-2016, ARM Limited, All Rights Reserved
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef VFS_MANAGER_USER_H
+#define VFS_MANAGER_USER_H
+
+#include <stdint.h>
+#include <stdbool.h>
+
+#include "virtual_fs.h"
+#include "error.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+
+extern const vfs_filename_t daplink_mode_file_name;
+
+/* Callable from anywhere */
+
+// Enable or disable the virtual filesystem
+void vfs_mngr_fs_enable(bool enabled);
+
+// Remount the virtual filesystem
+void vfs_mngr_fs_remount(void);
+
+
+/* Callable only from the thread running the virtual fs */
+
+// Initialize the VFS manager
+// Must be called after USB has been initialized (usbd_init())
+// Notes: Must only be called from the thread runnning USB
+void vfs_mngr_init(bool enabled);
+
+// Run the vfs manager state machine
+// Notes: Must only be called from the thread runnning USB
+void vfs_mngr_periodic(uint32_t elapsed_ms);
+
+// Return the status of the last transfer or ERROR_SUCCESS
+// if none have been performed yet
+error_t vfs_mngr_get_transfer_status(void);
+
+
+/* Use functions */
+
+// Build the filesystem by calling vfs_init and then adding files with vfs_create_file
+void vfs_user_build_filesystem(void);
+
+// Called when a file on the filesystem changes
+void vfs_user_file_change_handler(const vfs_filename_t filename, vfs_file_change_t change, vfs_file_t file, vfs_file_t new_file_data);
+
+// Called when VFS is disconnecting
+void vfs_user_disconnecting(void);
+
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif