Tunables for ra8_fs_format() (the on-disk geometry of a fresh volume). More...

#include <ra8_fs_types.h>

Data Fields
ra8_fs_type_t	type
	FAT variant to lay down (12/16/32).
const char *	label
	0..11 char volume label, or NULL.
uint8_t	sectors_per_cluster
	Cluster size; 0 = auto-select.

Detailed Description

Tunables for ra8_fs_format() (the on-disk geometry of a fresh volume).

Open/Closed seam for the formatter: callers select the FAT variant and label, and may optionally pin the cluster size. Zero-initialise the struct (= {}) for sane defaults – a zero sectors_per_cluster asks the formatter to pick the smallest power-of-two that lands the cluster count inside the range valid for type on the backend's capacity.

Invariant: type is one of k_ra8_fs_type_fat12, _fat16, _fat32, or _exfat (every type ra8_fs can write – see ra8_fs_format()).; sectors_per_cluster, when non-zero, is a power of two in the closed range 1..128.

Example:: ra8_fs_format_opts_t opts = {};

opts.type = k_ra8_fs_type_fat32;

opts.label = "DATA";

ra8_err_t e = ra8_fs_format(&backend, &opts); // auto cluster size

ra8_err_t
ra8_err_codes_t ra8_err_t
Canonical error-return type used by every ra8-firmware API.
Definition ra8_err.h:546

ra8_fs_format
ra8_err_t ra8_fs_format(const ra8_fs_backend_t *backend, const ra8_fs_format_opts_t *opts)
Format a block device as a fresh, empty FAT12/FAT16/FAT32/exFAT volume.
Definition ra8_fs_fat_mount.c:744

k_ra8_fs_type_fat32
@ k_ra8_fs_type_fat32
count_of_clusters >= 65525.
Definition ra8_fs_types.h:119

ra8_fs_format_opts_t
Tunables for ra8_fs_format() (the on-disk geometry of a fresh volume).
Definition ra8_fs_types.h:224

ra8_fs_format_opts_t::type
ra8_fs_type_t type
FAT variant to lay down (12/16/32).
Definition ra8_fs_types.h:225

ra8_fs_format_opts_t::label
const char * label
0..11 char volume label, or NULL.
Definition ra8_fs_types.h:226

See also: ra8_fs_format()

Since: 0.1.0

Definition at line 224 of file ra8_fs_types.h.

Field Documentation

◆ label

const char* ra8_fs_format_opts_t::label

0..11 char volume label, or NULL.

Definition at line 226 of file ra8_fs_types.h.

Referenced by demo_fs_format_mount(), demo_fs_format_or_panic(), eoh_mount_or_halt(), etoc_mount_or_halt(), fs_fmt_run_exfat(), fs_fmt_run_one_type(), internal_demo_mount(), internal_demo_mount(), internal_demo_probe_fat(), internal_pc_mount_or_halt(), internal_ra8_io_roundtrip_format_mount(), internal_swap_run_one(), ra8_io_roundtrip_mount(), and sdhi_demo_mount_via_io().

◆ sectors_per_cluster

uint8_t ra8_fs_format_opts_t::sectors_per_cluster

Cluster size; 0 = auto-select.

Definition at line 227 of file ra8_fs_types.h.

◆ type

ra8_fs_type_t ra8_fs_format_opts_t::type

FAT variant to lay down (12/16/32).

Definition at line 225 of file ra8_fs_types.h.