ra8_io_roundtrip_params_t Struct Reference

Per-demo knobs for the shared ra8_io round-trip. More...

#include <ra8_io_roundtrip.h>

Data Fields
const char *	vfs_prefix
	VFS volume name, e.g.
ra8_fs_type_t	fat_type
	FAT variant laid down by the format step.
const char *	volume_label
	11-char-max FAT volume label literal.
const char *	log_tag
	ra8_log tag used on every step failure.
const char *	root_file
	Root file name for the whole-file write.
const char *	root_path
	Full VFS path of the root file for read-back.
uint32_t	root_bytes
	Deterministic payload length at the root.
const char *	subdir_path
	Full VFS path of the directory to create.
const char *	subdir_file
	Full VFS path of the nested file.
uint32_t	subdir_bytes
	Deterministic payload length in the subdir.

Detailed Description

Per-demo knobs for the shared ra8_io round-trip.

Carries everything that differs between the four FAT demos so the round-trip logic itself can be identical. All string members are caller-owned NUL-terminated literals that out-live every call; the helpers neither copy nor free them.

Invariant

vfs_prefix is a non-empty volume name with no ':' or '/'.

fat_type is one of k_ra8_fs_type_fat12, _fat16, or _fat32.

Example:

const ra8_io_roundtrip_params_t p = {
  .vfs_prefix    = "ram",
  .fat_type      = k_ra8_fs_type_fat12,
  .volume_label  = "RAIO",
  .root_file     = "HELLO.TXT",
  .root_path     = "ram:/HELLO.TXT",
  .root_bytes    = 128U,
  .subdir_path   = "ram:/SUB",
  .subdir_file   = "ram:/SUB/NOTE.TXT",
  .subdir_bytes  = 64U,
};

See also

ra8_io_roundtrip_mount

ra8_io_roundtrip_root_file

ra8_io_roundtrip_subdir_file

Definition at line 69 of file ra8_io_roundtrip.h.

Field Documentation

fat_type

ra8_fs_type_t ra8_io_roundtrip_params_t::fat_type

FAT variant laid down by the format step.

Definition at line 71 of file ra8_io_roundtrip.h.

Referenced by internal_ra8_io_roundtrip_format_mount(), and ra8_io_roundtrip_mount().

log_tag

const char * ra8_io_roundtrip_params_t::log_tag

ra8_log tag used on every step failure.

Definition at line 73 of file ra8_io_roundtrip.h.

Referenced by internal_ra8_io_roundtrip_format_mount(), internal_ra8_io_roundtrip_write_subdir(), ra8_io_roundtrip_mount(), ra8_io_roundtrip_root_file(), and ra8_io_roundtrip_subdir_file().

root_bytes

uint32_t ra8_io_roundtrip_params_t::root_bytes

Deterministic payload length at the root.

Definition at line 76 of file ra8_io_roundtrip.h.

Referenced by ra8_io_roundtrip_root_file().

root_file

const char * ra8_io_roundtrip_params_t::root_file

Root file name for the whole-file write.

Definition at line 74 of file ra8_io_roundtrip.h.

Referenced by ra8_io_roundtrip_root_file().

root_path

const char * ra8_io_roundtrip_params_t::root_path

Full VFS path of the root file for read-back.

Definition at line 75 of file ra8_io_roundtrip.h.

Referenced by ra8_io_roundtrip_root_file().

subdir_bytes

uint32_t ra8_io_roundtrip_params_t::subdir_bytes

Deterministic payload length in the subdir.

Definition at line 79 of file ra8_io_roundtrip.h.

Referenced by internal_ra8_io_roundtrip_write_subdir(), and ra8_io_roundtrip_subdir_file().

subdir_file

const char * ra8_io_roundtrip_params_t::subdir_file

Full VFS path of the nested file.

Definition at line 78 of file ra8_io_roundtrip.h.

Referenced by internal_ra8_io_roundtrip_write_subdir(), and ra8_io_roundtrip_subdir_file().

subdir_path

const char * ra8_io_roundtrip_params_t::subdir_path

Full VFS path of the directory to create.

Definition at line 77 of file ra8_io_roundtrip.h.

Referenced by ra8_io_roundtrip_subdir_file().

vfs_prefix

const char * ra8_io_roundtrip_params_t::vfs_prefix

VFS volume name, e.g.

"ram" (no ':' / '/').

Definition at line 70 of file ra8_io_roundtrip.h.

Referenced by internal_ra8_io_roundtrip_format_mount(), and ra8_io_roundtrip_mount().

volume_label

const char * ra8_io_roundtrip_params_t::volume_label

11-char-max FAT volume label literal.

Definition at line 72 of file ra8_io_roundtrip.h.

Referenced by internal_ra8_io_roundtrip_format_mount(), and ra8_io_roundtrip_mount().

---

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

• examples/ek_ra8d2/hil_needs_revalidation/ra8_io_demo/inc/ra8_io_roundtrip.h
• examples/ek_ra8d2/hil_needs_revalidation/ra8_io_sd_demo/inc/ra8_io_roundtrip.h
• examples/ek_ra8d2/hil_needs_revalidation/ra8_io_sdram_demo/inc/ra8_io_roundtrip.h
• examples/ek_ra8d2/hil_needs_revalidation/ra8_io_xspi_demo/inc/ra8_io_roundtrip.h