Lines Matching full:system
21 * @brief File System APIs
22 * @defgroup file_system_api File System APIs
38 /** @brief Enumeration to uniquely identify file system types.
41 * requires a unique identifier used to register the file system
42 * implementation and to associate a mount point with the file system
49 * identifiers are unique if multiple file system implementations are
53 /** Identifier for in-tree FatFS file system. */
56 /** Identifier for in-tree LittleFS file system. */
59 /** Identifier for in-tree Ext2 file system. */
66 /** Flag prevents formatting device if requested file system not found */
68 /** Flag makes mounted file system read-only */
76 /** Flag requests file system driver to use Disk Access API. When the flag is
77 * set to the fs_mount_t.flags prior to fs_mount call, a file system
79 * should return -ENOSUP; when the flag is not set the file system driver
81 * When file system will use Disk Access API and the flag is not set, the mount
82 * callback for the file system should set the flag on success.
87 * @brief File system mount info structure
92 /** File system type */
96 /** Pointer to file system specific data */
100 /* The following fields are filled by file system core */
103 /** Pointer to File system interface of the mount point */
278 * create a file on a system that has been mounted with the
281 * @retval -ENOTSUP when not implemented by underlying file system driver;
282 * @retval <0 an other negative errno code, depending on a file system back-end.
294 * @retval -ENOTSUP when not implemented by underlying file system driver;
308 * @retval -EROFS if file is read-only, or when file system has been mounted
310 * @retval -ENOTSUP when not implemented by underlying file system driver;
335 * @retval -EROFS if file is read-only, or when file system has been mounted
337 * @retval -ENOTSUP when not implemented by underlying file system driver;
355 * @retval -ENOTSUP when not implemented by underlying file system driver;
376 * @retval -ENOTSUP when not implemented by underlying file system driver;
396 * @retval -ENOTSUP if not supported by underlying file system driver;
410 * @retval -ENOTSUP if not supported by underlying file system driver;
434 * @retval -ENOTSUP when not implemented by underlying file system driver;
452 * @retval -ENOTSUP when not implemented by underlying file system driver;
467 * file system has been mounted with the FS_MOUNT_FLAG_READ_ONLY flag;
468 * @retval -ENOTSUP when not implemented by underlying file system driver;
484 * @retval -ENOTSUP when not implemented by underlying file system driver;
505 * @retval -ENOTSUP when not implemented by underlying file system driver;
518 * @retval -ENOTSUP when not implemented by underlying file system driver;
526 * Perform steps needed for mounting a file system like
527 * calling the file system specific mount function and adding
528 * the mount point to mounted file system list.
542 * @retval -ENOENT when file system type has not been registered;
543 * @retval -ENOTSUP when not supported by underlying file system driver;
546 * @retval -EROFS if system requires formatting but @c FS_MOUNT_FLAG_READ_ONLY
555 * Perform steps needed to unmount a file system like
556 * calling the file system specific unmount function and removing
557 * the mount point from mounted file system list.
562 * @retval -EINVAL if no system has been mounted at given mount point;
563 * @retval -ENOTSUP when not supported by underlying file system driver;
598 * @retval -ENOTSUP when not supported by underlying file system driver;
604 * @brief Retrieves statistics of the file system volume
606 * Returns the total and available space in the file system volume.
614 * @retval -ENOTSUP when not implemented by underlying file system driver;
620 * @brief Create fresh file system
622 * @param fs_type Type of file system to create.
625 * @param flags Additional flags for file system implementation.
633 * @brief Register a file system
635 * Register file system with virtual file system.
636 * Number of allowed file system types to be registered is controlled with the
639 * @param type Type of file system (ex: @c FS_FATFS)
640 * @param fs Pointer to File system
643 * @retval -EALREADY when a file system of a given type has already been registered;
644 * @retval -ENOSCP when there is no space left, in file system registry, to add
645 * this file system type.
650 * @brief Unregister a file system
652 * Unregister file system from virtual file system.
654 * @param type Type of file system (ex: @c FS_FATFS)
655 * @param fs Pointer to File system
658 * @retval -EINVAL when file system of a given type has not been registered.