ra8-firmware 0.1.0
Bare-metal firmware for the Renesas RA8 family (RA8D2 / RA8P1)
Loading...
Searching...
No Matches
fw_fs_namespace_iface Struct Reference

Namespace backend operations. More...

#include <fw_if_fs_backend.h>

Data Fields

ra8_err_t(* stat )(void *ctx, const char *path, fw_fs_stat_t *out)
 Query one path without following a symbolic-link leaf.
ra8_err_t(* listdir )(void *ctx, const char *path, uint32_t max_entries, fw_fs_list_fn_t callback, void *callback_ctx, uint32_t *out_count, bool *out_complete)
 Enumerate at most the requested number of directory entries.
ra8_err_t(* dir_open )(void *ctx, const char *path, void *directory_state, uint32_t state_bytes)
 Open a directory cursor in caller-supplied workspace.
ra8_err_t(* dir_next )(void *ctx, void *directory_state, fw_fs_dirent_value_t *out, bool *out_entry)
 Copy the next visible entry or report clean end-of-directory.
ra8_err_t(* dir_close )(void *ctx, void *directory_state)
 Close a directory cursor and consume its backend state.
ra8_err_t(* mkdir )(void *ctx, const char *path)
 Create one directory leaf.
ra8_err_t(* unlink )(void *ctx, const char *path)
 Remove one regular-file leaf.
ra8_err_t(* rmdir )(void *ctx, const char *path)
 Remove one empty directory leaf.
ra8_err_t(* rename )(void *ctx, const char *old_path, const char *new_path, bool replace)
 Rename one leaf within the backend volume.
ra8_err_t(* space )(void *ctx, fw_fs_space_t *out)
 Query the volume capacity and available byte count.

Detailed Description

Namespace backend operations.

space may be NULL only when k_fw_fs_cap_space_query is absent. A successful stat must report a coherent node kind/existence pair, and a successful listdir must not report more than its bound.

Definition at line 34 of file fw_if_fs_backend.h.

Field Documentation

◆ dir_close

ra8_err_t(* fw_fs_namespace_iface::dir_close) (void *ctx, void *directory_state)

Close a directory cursor and consume its backend state.

Definition at line 53 of file fw_if_fs_backend.h.

Referenced by fw_fs_dir_close(), and internal_interfaces().

◆ dir_next

ra8_err_t(* fw_fs_namespace_iface::dir_next) (void *ctx, void *directory_state, fw_fs_dirent_value_t *out, bool *out_entry)

Copy the next visible entry or report clean end-of-directory.

Definition at line 48 of file fw_if_fs_backend.h.

Referenced by fw_fs_dir_next(), and internal_interfaces().

◆ dir_open

ra8_err_t(* fw_fs_namespace_iface::dir_open) (void *ctx, const char *path, void *directory_state, uint32_t state_bytes)

Open a directory cursor in caller-supplied workspace.

Definition at line 46 of file fw_if_fs_backend.h.

Referenced by fw_fs_dir_open(), and internal_interfaces().

◆ listdir

ra8_err_t(* fw_fs_namespace_iface::listdir) (void *ctx, const char *path, uint32_t max_entries, fw_fs_list_fn_t callback, void *callback_ctx, uint32_t *out_count, bool *out_complete)

Enumerate at most the requested number of directory entries.

Definition at line 38 of file fw_if_fs_backend.h.

Referenced by fw_fs_listdir(), and internal_interfaces().

◆ mkdir

ra8_err_t(* fw_fs_namespace_iface::mkdir) (void *ctx, const char *path)

Create one directory leaf.

Definition at line 55 of file fw_if_fs_backend.h.

Referenced by fw_fs_mkdir(), and internal_interfaces().

◆ rename

ra8_err_t(* fw_fs_namespace_iface::rename) (void *ctx, const char *old_path, const char *new_path, bool replace)

Rename one leaf within the backend volume.

Definition at line 61 of file fw_if_fs_backend.h.

Referenced by fw_fs_rename(), and internal_interfaces().

◆ rmdir

ra8_err_t(* fw_fs_namespace_iface::rmdir) (void *ctx, const char *path)

Remove one empty directory leaf.

Definition at line 59 of file fw_if_fs_backend.h.

Referenced by fw_fs_rmdir(), and internal_interfaces().

◆ space

ra8_err_t(* fw_fs_namespace_iface::space) (void *ctx, fw_fs_space_t *out)

Query the volume capacity and available byte count.

Definition at line 63 of file fw_if_fs_backend.h.

Referenced by fw_fs_space(), and internal_fw_fs_caps_validate().

◆ stat

ra8_err_t(* fw_fs_namespace_iface::stat) (void *ctx, const char *path, fw_fs_stat_t *out)

Query one path without following a symbolic-link leaf.

Definition at line 36 of file fw_if_fs_backend.h.

Referenced by fw_fs_stat(), and internal_interfaces().

◆ unlink

ra8_err_t(* fw_fs_namespace_iface::unlink) (void *ctx, const char *path)

Remove one regular-file leaf.

Definition at line 57 of file fw_if_fs_backend.h.

Referenced by fw_fs_unlink(), and internal_interfaces().


The documentation for this struct was generated from the following file: