Lines Matching +full:mount +full:- +full:point
3 * Copyright (c) 2020-2024 Nordic Semiconductor ASA
5 * SPDX-License-Identifier: Apache-2.0
42 * Zephyr supports in-tree file systems and external ones. Each
44 * implementation and to associate a mount point with the file system
46 * in-tree file systems.
55 /** Identifier for in-tree FatFS file system. */
58 /** Identifier for in-tree LittleFS file system. */
61 /** Identifier for in-tree Ext2 file system. */
70 /** Flag makes mounted file system read-only */
72 /** Flag used in pre-defined mount structures that are to be mounted
75 * This flag has no impact in user-defined mount structures.
80 * needs to use the Disk Access API, otherwise mount callback for the driver
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
89 * @brief File system mount info structure
96 /** Mount point directory name (ex: "/fatfs") */
103 /** Length of Mount point string */
105 /** Pointer to File system interface of the mount point */
107 /** Mount flags */
154 /** Open for read-write flag combination */
196 * @brief Get the common mount flags for an fstab entry.
210 * @brief The name under which a zephyr,fstab entry mount structure is
239 zfp->filep = NULL; in fs_file_t_init()
240 zfp->mp = NULL; in fs_file_t_init()
241 zfp->flags = 0; in fs_file_t_init()
255 zdp->dirp = NULL; in fs_dir_t_init()
256 zdp->mp = NULL; in fs_dir_t_init()
269 * - @c FS_O_READ open for read
270 * - @c FS_O_WRITE open for write
271 * - @c FS_O_RDWR open for read/write (<tt>FS_O_READ | FS_O_WRITE</tt>)
272 * - @c FS_O_CREATE create file if it does not exist
273 * - @c FS_O_APPEND move to end of file before each write
274 * - @c FS_O_TRUNC truncate the file
284 * @retval -EBUSY when zfp is already used;
285 * @retval -EINVAL when a bad file name is given;
286 * @retval -EROFS when opening read-only file for write, or attempting to
289 * @retval -ENOENT when the file does not exist at the path;
290 * @retval -ENOTSUP when not implemented by underlying file system driver;
291 * @retval -EACCES when trying to truncate a file without opening it for write.
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;
317 * @retval -EINVAL when a bad file name is given;
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;
336 * @note Current implementation does not allow moving files between mount
343 * @retval -EINVAL when a bad file name is given, or when rename would cause move
344 * between mount points;
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;
364 * @retval -EBADF when invoked on zfp that represents unopened/closed file;
365 * @retval -ENOTSUP when not implemented by underlying file system driver;
376 * If the function returns a non-negative number that is lower than @p size,
385 * @retval -EBADF when invoked on zfp that represents unopened/closed file;
386 * @retval -ENOTSUP when not implemented by underlying file system driver;
400 * - @c FS_SEEK_SET for the beginning of the file;
401 * - @c FS_SEEK_CUR for the current position;
402 * - @c FS_SEEK_END for the end of the file.
405 * @retval -EBADF when invoked on zfp that represents unopened/closed file;
406 * @retval -ENOTSUP if not supported by underlying file system driver;
419 * @retval -EBADF when invoked on zfp that represents unopened/closed file;
420 * @retval -ENOTSUP if not supported by underlying file system driver;
443 * @retval -EBADF when invoked on zfp that represents unopened/closed file;
444 * @retval -ENOTSUP when not implemented by underlying file system driver;
461 * @retval -EBADF when invoked on zfp that represents unopened/closed file;
462 * @retval -ENOTSUP when not implemented by underlying file system driver;
475 * @retval -EEXIST if entry of given name exists;
476 * @retval -EROFS if @p path is within read-only directory, or when
478 * @retval -ENOTSUP when not implemented by underlying file system driver;
492 * @retval -EINVAL when a bad directory path is given;
493 * @retval -EBUSY when zdp is already used;
494 * @retval -ENOTSUP when not implemented by underlying file system driver;
502 * Reads directory entries of an open directory. In end-of-dir condition,
503 * the function will return 0 and set the <tt>entry->name[0]</tt> to 0.
513 * @retval 0 on success or end-of-dir;
514 * @retval -ENOENT when no such directory found;
515 * @retval -ENOTSUP when not implemented by underlying file system driver;
528 * @retval -ENOTSUP when not implemented by underlying file system driver;
534 * @brief Mount filesystem
537 * calling the file system specific mount function and adding
538 * the mount point to mounted file system list.
540 * @note Current implementation of ELM FAT driver allows only following mount
542 * or mount points that consist of single digit, e.g: "/0:", "/1:" and so forth.
545 * is not changed if the mount operation failed.
547 * mount operation succeeds, and the application must not
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
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;
579 * @brief Get path of mount point at index
581 * This function iterates through the list of mount points and returns
582 * the directory name of the mount point at the given @p index.
583 * On success @p index is incremented and @p name is set to the mount directory
584 * name. If a mount point with the given @p index does not exist, @p name will
587 * @param index Pointer to mount point index
591 * @retval -ENOENT if there is no mount point with given index.
606 * @retval -EINVAL when a bad directory or file name is given;
607 * @retval -ENOENT when no such directory or file is found;
608 * @retval -ENOTSUP when not supported by underlying file system driver;
623 * @retval -EINVAL when a bad path to a directory, or a file, is given;
624 * @retval -ENOTSUP when not implemented by underlying file system driver;
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
668 * @retval -EINVAL when file system of a given type has not been registered.