Arrow / Mbed OS DAPLink Reset
Embed: (wiki syntax)

« Back to documentation index

vfs_user.h File Reference

vfs_user.h File Reference

VFS user files header. More...

Go to the source code of this file.

Functions

bool vfs_user_file_change_handler_hook (const vfs_filename_t filename, vfs_file_change_t change, vfs_file_t file, vfs_file_t new_file_data)
 Hook for file changes in root directory.
bool vfs_user_magic_file_hook (const vfs_filename_t filename, bool *do_remount)
 Hook for magic files.

Detailed Description

VFS user files header.

DAPLink Interface Firmware Copyright (c) 2020, 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.

Definition in file vfs_user.h.


Function Documentation

bool vfs_user_file_change_handler_hook ( const vfs_filename_t  filename,
vfs_file_change_t  change,
vfs_file_t  file,
vfs_file_t  new_file_data 
)

Hook for file changes in root directory.

Parameters:
filenameName of the file that has changed.
changeType of change.
file
new_file_dataData being written to the file if _change_ is VFS_FILE_CHANGED.
Return values:
trueThe hook handled the change notification, the caller should do nothing else.
falseThe hook did nothing, continue with normal behaviour.

Definition at line 179 of file vfs_user.c.

bool vfs_user_magic_file_hook ( const vfs_filename_t  filename,
bool *  do_remount 
)

Hook for magic files.

This hook is intended to simplify checking for magic files. In addition to allowing support for new magic files, you can also change the behaviour of or disable standard magic files.

Parameters:
filenameName of the file that was created.
[out]do_remountWhether the caller should remount the MSD volume. Only applies if true is returned. The default is true, so if the hook does not modify this parameter and returns true, a remount is performed.
Return values:
trueThe hook handled the specified file. A remount will be performed if requested, but otherwise no other standard behaviour is applied.
falseThe hook did not handle the file; continue with canonical behaviour.

Definition at line 186 of file vfs_user.c.