ra8-firmware 0.1.0
Bare-metal firmware for the Renesas RA8 family (RA8D2 / RA8P1)
Loading...
Searching...
No Matches
ra8_board_ek_ra8d2_console_stream.h File Reference
Board support & sensors

EK-RA8D2 debug console as an ra8_io_stream byte sink. More...

#include "ra8_err.h"
#include "ra8_io_stream.h"
Include dependency graph for ra8_board_ek_ra8d2_console_stream.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

ra8_err_t ra8_board_console_stream (ra8_io_stream_t *out)
 Bind the J-Link OB VCOM console into a caller-owned stream handle.

Detailed Description

EK-RA8D2 debug console as an ra8_io_stream byte sink.

Tag
[Ring 5 / BSP] {World: S}

ra8_board_uart_console_write() is the right primitive – bytes and a length – but it is the ONLY thing the board console offers, so an application that wants to print a number writes its own adapter first. Meanwhile ra8_io_stream already carries puts / putc / put_u32 / put_u64 / put_hex and cannot be aimed at the console without knowing that it is SCI8 and repeating its PD02 / PD03 pin routing. ra8_board_console_stream closes that gap in one call, so the whole stream API becomes reachable from an application that knows only "the board has a console".

OPT-IN, DELIBERATELY. This header is NOT pulled in by the ra8_board_ek_ra8d2.h umbrella, and the translation unit behind it is compiled into an application only when that application declares ra8_io in its LIBS. The rest of the BSP depends solely on libraries every app already compiles; the stream binding is the one part that does not, so an application that never asks for a stream pays neither the include path nor the object code. Mirrors how ra8_compress.h is kept out of the ra8_io.h umbrella for the same reason.

ra8_io_stream_t con = {};
(void)ra8_board_uart_console_init(115200U);
if (ra8_board_console_stream(&con) == k_ra8_ok) {
(void)ra8_io_stream_puts(&con, "dtc: copied ");
(void)ra8_io_stream_put_u32(&con, copied);
(void)ra8_io_stream_puts(&con, "B err=");
(void)ra8_io_stream_puts(&con, ra8_err_to_str(err));
(void)ra8_io_stream_putc(&con, '\n');
}
ra8_board_console_stream
ra8_err_t ra8_board_console_stream(ra8_io_stream_t *out)
Bind the J-Link OB VCOM console into a caller-owned stream handle.
Definition ra8_board_ek_ra8d2_console_stream.c:59
ra8_board_uart_console_init
ra8_err_t ra8_board_uart_console_init(uint32_t baud)
Configure SCI8 + PD02/PD03 as the debug-console UART.
Definition ra8_board_ek_ra8d2_comms.c:240
k_ra8_ok
@ k_ra8_ok
Success – operation completed with all postconditions satisfied.
Definition ra8_err.h:119
ra8_err_to_str
const char * ra8_err_to_str(ra8_err_t err)
Human-readable string for an error code.
Definition ra8_log.c:737
ra8_io_stream_puts
ra8_err_t ra8_io_stream_puts(ra8_io_stream_t *s, const char *str)
Write a NUL-terminated string (without the NUL) to the bound sink.
Definition ra8_io_stream.c:138
ra8_io_stream_put_u32
ra8_err_t ra8_io_stream_put_u32(ra8_io_stream_t *s, uint32_t value)
Write value as unsigned decimal ASCII (no leading zeros).
Definition ra8_io_stream.c:155
ra8_io_stream_putc
ra8_err_t ra8_io_stream_putc(ra8_io_stream_t *s, char c)
Write a single byte to the bound sink.
Definition ra8_io_stream.c:128
ra8_io_stream_t
Caller-allocated byte-stream handle binding a sink to its context.
Definition ra8_io_stream.h:78
Copyright
Copyright (c) 2026 Brighton Sikarskie SPDX-License-Identifier: MIT
Since
0.1.0

Definition in file ra8_board_ek_ra8d2_console_stream.h.

Function Documentation

◆ ra8_board_console_stream()

ra8_err_t ra8_board_console_stream ( ra8_io_stream_t * out)
nodiscard

Bind the J-Link OB VCOM console into a caller-owned stream handle.

Hands back an ra8_io_stream_t whose sink is the board's debug console, so every ra8_io_stream_* writer lands on the same UART that ra8_board_uart_console_write() drives. The board supplies the two facts the application would otherwise have to know: that the console is SCI channel k_ra8_board_uart_console_sci_channel, and that ra8_board_uart_console_init() has already routed PD02 / PD03 and programmed the bit-rate register for the live PCLKA.

The sink state lives in this module (the console is a board singleton, so there is exactly one), which is why the caller supplies only the handle. Binding twice is harmless and yields two handles onto the same console.

Parameters
[out]outCaller-owned stream handle to bind; zero-initialise (= {}) before the call. On success it writes to the console.
Returns
ra8_err_t Error code.
Return values
k_ra8_okout is bound and usable.
k_ra8_err_null_ptrout was null.
k_ra8_err_not_initializedra8_board_uart_console_init() has not succeeded, so there is no console to bind.
Precondition
ra8_board_uart_console_init() returned k_ra8_ok.
out out-lives every write made through it.
Postcondition
On success out carries a sink aimed at the board console.
On any non-ok return out is left exactly as the caller passed it.
Note
Not thread-safe with respect to the console; one writer at a time.
Warning
Bytes written through the returned stream reach the SCI channel directly. Interleaving them with ra8_board_uart_console_write() from an interrupt would interleave on the wire.
See also
ra8_board_uart_console_init Brings the console up; call it first.
ra8_io_stream_puts One of the writers this unlocks.
Since
0.1.0

Definition at line 59 of file ra8_board_ek_ra8d2_console_stream.c.

References k_ra8_board_uart_console_sci_channel, k_ra8_err_not_initialized, priv_ra8_board_uart_console_is_up(), RA8_CHECK_NULL_PTR, ra8_io_stream_uart_init(), s_console_sink, and s_tag.

Referenced by internal_demo_setup_or_halt().