Bounded console formatters for the esp-hosted RPC round-trip app. More...

#include <stddef.h>
#include <stdint.h>
#include "c6_fwver.h"
#include "esp_hosted_transport.h"
#include "port_esp_hosted_host_os.h"
#include "ra8_board_ek_ra8d2.h"

Include dependency graph for c6_fwver_console.c:

Enumerations
enum	c6_fwver_ascii_t : uint8_t { k_c6_fwver_ascii_low = 0x20U , k_c6_fwver_ascii_high = 0x7EU , k_c6_fwver_ascii_sub = '.' }
	Printable-ASCII window used to sanitise co-processor text. More...

Functions
void	c6_fwver_puts (const char *text)
	Write a NUL-terminated string to the board console.
void	c6_fwver_put_u32 (uint32_t value)
	Implementation of c6_fwver_put_u32() – reversed division loop.
void	c6_fwver_put_i32 (int32_t value)
	Implementation of c6_fwver_put_i32() – two's-complement magnitude.
void	c6_fwver_put_hex (uint32_t value, uint8_t digits)
	Emit a value as a fixed-width lower-case hexadecimal field.
void	c6_fwver_put_text (const uint8_t *text, size_t len)
	Implementation of c6_fwver_put_text() – truncate, then sanitise.
void	c6_fwver_print_banner (uint32_t cpuclk_hz, uint32_t pclka_hz)
	Print the banner: identity, clocks and SPI parameters.
void	c6_fwver_print_pump (const char label, const c6_fwver_pump_stats_t stats)
	Print what one pump did, as one console line.

Detailed Description

Bounded console formatters for the esp-hosted RPC round-trip app.

Tag: [Ring 6 / APP] {World: S}

Five tiny serialisers – string, unsigned decimal, signed decimal, hexadecimal and untrusted text – plus the banner and the pump-statistics line. They exist so the application can narrate itself without dragging newlib's printf (and its heap and reentrancy machinery) into a bare-metal image that has no heap at all.

Every loop here is bounded by a constant from c6_fwver.h, which is what satisfies NASA Power of 10 Rule 2. c6_fwver_put_text is the one that matters for more than that: the bytes it prints come off the wire from the co-processor, so it sanitises rather than trusts.

Copyright: Copyright (c) 2026 Brighton Sikarskie SPDX-License-Identifier: MIT

Since: 0.1.0

Definition in file c6_fwver_console.c.

Enumeration Type Documentation

◆ c6_fwver_ascii_t

enum c6_fwver_ascii_t : uint8_t

Printable-ASCII window used to sanitise co-processor text.

A protocol field is evidence; evidence that can reprogram a terminal is not evidence. Anything outside this window is replaced.

Invariant: k_c6_fwver_ascii_low is the first printable code point and k_c6_fwver_ascii_high the last, so the test is a range test.

Example:: const bool ok = (b >= k_c6_fwver_ascii_low) && (b <= k_c6_fwver_ascii_high);

k_c6_fwver_ascii_low
@ k_c6_fwver_ascii_low
Space: lowest printable code point.
Definition c6_fwver_console.c:48

k_c6_fwver_ascii_high
@ k_c6_fwver_ascii_high
Tilde: highest printable code point.
Definition c6_fwver_console.c:49

See also: c6_fwver_put_text

Since: 0.1.0

Enumerator
k_c6_fwver_ascii_low	Space: lowest printable code point.
k_c6_fwver_ascii_high	Tilde: highest printable code point.
k_c6_fwver_ascii_sub	Substitute for anything else.

Definition at line 47 of file c6_fwver_console.c.

Function Documentation

◆ c6_fwver_print_banner()

void c6_fwver_print_banner	(	uint32_t	cpuclk_hz,
		uint32_t	pclka_hz )

Print the banner: identity, clocks and SPI parameters.

Parameters

[in]	cpuclk_hz	Live CPUCLK0 rate in hertz.
[in]	pclka_hz	Live PCLKA rate in hertz, the SCI baud-clock source.

Returns: Nothing.

Precondition: The console is up.; Both rates were read from the CGC rather than assumed.

Postcondition: Three banner lines were emitted.; No application state is modified.

Note: The SPI mode printed is the co-processor's: the C6 image in coprocessor/esp32c6/ is built with CONFIG_ESP_SPI_MODE=3 and the port opens the bus to match.

See also: c6_fwver_link_pump

Since: 0.1.0

Definition at line 128 of file c6_fwver_console.c.

References c6_fwver_put_u32(), c6_fwver_puts(), k_c6_fwver_frame_bytes, k_c6_fwver_sck_hz, k_ra8_board_pmod1_sci_channel, and MAX_PAYLOAD_SIZE.

Referenced by main().

◆ c6_fwver_print_pump()

void c6_fwver_print_pump	(	const char *	label,
		const c6_fwver_pump_stats_t *	stats )

Print what one pump did, as one console line.

Parameters

[in]	label	Field name printed before the counters; null prints nothing at all rather than being dereferenced.
[in]	stats	Counters filled in by c6_fwver_link_pump; null prints nothing.

Returns: Nothing.

Precondition: The console is up.; stats came from a completed pump.

Postcondition: Exactly one line was emitted, or none on a null argument.; No application state is modified.

Note: Every counter is printed, including the zero ones: a zero bad_checksum beside a non-zero transfers is itself the evidence that the link is clean.

See also: c6_fwver_pump_stats

Since: 0.1.0

Definition at line 147 of file c6_fwver_console.c.

References c6_fwver_pump_stats::bad_checksum, c6_fwver_pump_stats::bus_error, c6_fwver_put_u32(), c6_fwver_puts(), c6_fwver_pump_stats::frames, c6_fwver_pump_stats::hs_timeouts, c6_fwver_pump_stats::idle, c6_fwver_pump_stats::ifnum_defect, c6_fwver_pump_stats::malformed, c6_fwver_pump_stats::sink_stopped, and c6_fwver_pump_stats::transfers.

Referenced by c6_fwver_phase_caps(), and c6_fwver_phase_request().

◆ c6_fwver_put_hex()

void c6_fwver_put_hex	(	uint32_t	value,
		uint8_t	digits )

Emit a value as a fixed-width lower-case hexadecimal field.

Parameters

[in]	value	Value to print.
[in]	digits	Field width, 1..k_c6_fwver_hex_digits; an out-of-range width prints nothing rather than overrunning the output array.