Lines Matching full:system
21 * @brief File System APIs
22 * @defgroup file_system_api File System APIs
40 /** @brief Enumeration to uniquely identify file system types.
43 * requires a unique identifier used to register the file system
44 * implementation and to associate a mount point with the file system
51 * identifiers are unique if multiple file system implementations are
55 /** Identifier for in-tree FatFS file system. */
58 /** Identifier for in-tree LittleFS file system. */
61 /** Identifier for in-tree Ext2 file system. */
68 /** Flag prevents formatting device if requested file system not found */
70 /** Flag makes mounted file system read-only */
78 /** Flag requests file system driver to use Disk Access API. When the flag is
79 * set to the fs_mount_t.flags prior to fs_mount call, a file system
81 * should return -ENOSUP; when the flag is not set the file system driver
83 * When file system will use Disk Access API and the flag is not set, the mount
84 * callback for the file system should set the flag on success.
89 * @brief File system mount info structure
94 /** File system type */
98 /** Pointer to file system specific data */
102 /* The following fields are filled by file system core */
105 /** Pointer to File system interface of the mount point */
287 * create a file on a system that has been mounted with the
290 * @retval -ENOTSUP when not implemented by underlying file system driver;
292 * @retval <0 an other negative errno code, depending on a file system back-end.
304 * @retval -ENOTSUP when not implemented by underlying file system driver;
318 * @retval -EROFS if file is read-only, or when file system has been mounted
320 * @retval -ENOTSUP when not implemented by underlying file system driver;
345 * @retval -EROFS if file is read-only, or when file system has been mounted
347 * @retval -ENOTSUP when not implemented by underlying file system driver;
365 * @retval -ENOTSUP when not implemented by underlying file system driver;
386 * @retval -ENOTSUP when not implemented by underlying file system driver;
406 * @retval -ENOTSUP if not supported by underlying file system driver;
420 * @retval -ENOTSUP if not supported by underlying file system driver;
444 * @retval -ENOTSUP when not implemented by underlying file system driver;
462 * @retval -ENOTSUP when not implemented by underlying file system driver;
477 * file system has been mounted with the FS_MOUNT_FLAG_READ_ONLY flag;
478 * @retval -ENOTSUP when not implemented by underlying file system driver;
494 * @retval -ENOTSUP when not implemented by underlying file system driver;
515 * @retval -ENOTSUP when not implemented by underlying file system driver;
528 * @retval -ENOTSUP when not implemented by underlying file system driver;
536 * Perform steps needed for mounting a file system like
537 * calling the file system specific mount function and adding
538 * the mount point to mounted file system list.
552 * @retval -ENOENT when file system type has not been registered;
553 * @retval -ENOTSUP when not supported by underlying file system driver;
556 * @retval -EROFS if system requires formatting but @c FS_MOUNT_FLAG_READ_ONLY
565 * Perform steps needed to unmount a file system like
566 * calling the file system specific unmount function and removing
567 * the mount point from mounted file system list.
572 * @retval -EINVAL if no system has been mounted at given mount point;
573 * @retval -ENOTSUP when not supported by underlying file system driver;
608 * @retval -ENOTSUP when not supported by underlying file system driver;
614 * @brief Retrieves statistics of the file system volume
616 * Returns the total and available space in the file system volume.
624 * @retval -ENOTSUP when not implemented by underlying file system driver;
630 * @brief Create fresh file system
632 * @param fs_type Type of file system to create.
635 * @param flags Additional flags for file system implementation.
643 * @brief Register a file system
645 * Register file system with virtual file system.
646 * Number of allowed file system types to be registered is controlled with the
649 * @param type Type of file system (ex: @c FS_FATFS)
650 * @param fs Pointer to File system
653 * @retval -EALREADY when a file system of a given type has already been registered;
654 * @retval -ENOSCP when there is no space left, in file system registry, to add
655 * this file system type.
660 * @brief Unregister a file system
662 * Unregister file system from virtual file system.
664 * @param type Type of file system (ex: @c FS_FATFS)
665 * @param fs Pointer to File system
668 * @retval -EINVAL when file system of a given type has not been registered.