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

USB self-loop endurance soak + throughput benchmark (board-only). More...

#include <stdint.h>
#include <string.h>
#include "ra8_board_ek_ra8d2.h"
#include "ra8_boot_entry.h"
#include "ra8_cgc.h"
#include "ra8_err.h"
#include "ra8_fs.h"
#include "ra8_gpio_constants.h"
#include "ra8_isr.h"
#include "ra8_port_constants.h"
#include "ra8_port_utils.h"
#include "ra8_time.h"
#include "ra8_usb.h"
#include "ra8_usb_hmsc.h"
#include "usb_selftest_common.h"
#include "usb_selftest_console.h"
#include "usb_selftest_device.h"
#include "usb_selftest_host.h"
#include "tx_api.h"
#include "ux_api.h"
#include "ux_dcd_ra8_usb.h"
#include "ux_device_class_storage.h"
#include "ux_device_stack.h"
Include dependency graph for main.c:

Go to the source code of this file.

Functions

void _tx_timer_interrupt (void)
void SysTick_Handler (void)
 Service the SysTick exception selected by the linked application.
static VOID selftest_host_worker (ULONG arg)
 Host-side worker: retry the full pass until it succeeds.
VOID tx_application_define (VOID *first_unused_memory)
 ThreadX application-define hook.
static void selftest_panic_halt (void)
 Halt forever in WFI – panic stop on init failure.
static void selftest_route_usb_or_halt (void)
 Route both ports' pins: FS as device, HS as host.
static void selftest_setup_or_halt (void)
 Bring CGC + both USB clocks + SysTick + SCI8 + LEDs + pins up.
void main (void)
 Application entry: bring the board up, then hand off to ThreadX.

Variables

static volatile bool s_tx_kernel_up = false
 Set in tx_application_define; gates ThreadX tick delivery.
static const ra8_port_pin_t k_selftest_pin_fs_vbus = (ra8_port_pin_t)k_ra8_board_usbfs_pin_vbus
 USBFS VBUS sense pin (P4_07, PSEL = 0x13).
static const ra8_port_pin_t k_selftest_pin_fs_vbusen = (ra8_port_pin_t)k_ra8_board_usbfs_pin_vbusen
 USBFS VBUSEN (P5_00) – GPIO LOW for the device role.
static const ra8_port_pin_t k_selftest_pin_fs_dp = (ra8_port_pin_t)k_ra8_board_usbfs_pin_dp
 USBFS D+ (P8_14).
static const ra8_port_pin_t k_selftest_pin_fs_dm = (ra8_port_pin_t)k_ra8_board_usbfs_pin_dm
 USBFS D- (P8_15).
static const ra8_port_pin_t k_selftest_pin_hs_vbus = (ra8_port_pin_t)k_ra8_board_usbhs_pin_vbus
 USBHS_VBUS sense pin (P4_08, PSEL = 0x14).
static const ra8_port_pin_t k_selftest_pin_hs_pwr = (ra8_port_pin_t)k_ra8_board_usbhs_pin_pwr
 J7 host-power switch (PD07): HIGH = U18 supplies VBUS (UM 6.2).
static TX_THREAD s_device_thread
 ThreadX TCB for the USBX device-side worker thread.
static UCHAR s_device_stack [k_selftest_thread_stack]
 Stack backing storage for s_device_thread.
static TX_THREAD s_host_thread
 ThreadX TCB for the polled host-side worker thread.
static UCHAR s_host_stack [k_selftest_host_stack]
 Stack backing storage for s_host_thread (ra8_fs walks live here).

Detailed Description

USB self-loop endurance soak + throughput benchmark (board-only).

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

The robustness/benchmark member of the self-loop matrix: same dual-stack image as config A (HS host + FS device on the J7<->J11 cable), but the host worker REPEATS the 1 MiB MRAM integrity sweep k_selftest_soak_iters times back to back instead of once. Every 4 KiB READ(10) burst is still memcmp'd against the real MRAM window, so a single corrupted or dropped transfer anywhere in the soak fails the run – this is the endurance proof that the USB transport stays byte-perfect under sustained load. The aggregate volume and elapsed time are summed across all iterations for a stable throughput benchmark (more representative than a single short sweep), then the RO write-rejection is confirmed once.

  • USBFS (J11) = DEVICE: the USBX MSC class exposing the 1 MiB MRAM window at 0x02000000 as a read-only synthesized FAT16 volume (MRAM.BIN).
  • USBHS (J7) = HOST: the polled first-party host stack (ra8_usb_hmsc + ra8_fs) on a low-priority ThreadX thread.

Entirely on-chip: no Mac/PC host – the board both hosts and devices itself, so the soak runs anywhere the loop cable is fitted. Verdicts stream over SCI8 (J-Link OB CDC, 115200); s_dbg_pass_count mirrors the completed-iteration count for a J-Link readout of soak progress.

Pinout

FS device: P4_07 VBUS sense, P5_00 VBUSEN as GPIO LOW (device role), P8_14 D+, P8_15 D- (PSEL usb_fs). HS host: SW4-8 to Host via the U15 expander, PD07 HIGH (U18 supplies J7 VBUS), P4_08 USBHS_VBUS (PSEL usb_hs). Console: PD_02/PD_03 SCI8 (PSEL sci_async).

Author
Brighton Sikarskie
Date
2026-06-12
Since
0.1.0

Definition in file main.c.

Function Documentation

◆ _tx_timer_interrupt()

void _tx_timer_interrupt ( void )
extern

◆ main()

void main ( void )

Application entry: bring the board up, then hand off to ThreadX.

The application entry point Reset_Handler hands control to.

Both USB controllers' clocks and pins come up before the kernel so the two workers only deal with stack bring-up.

Precondition
Reset_Handler has copied .data and zeroed .bss.
SystemInit has set VTOR, FPU, and priority grouping.
Postcondition
On clean entry the CPU stays in tx_kernel_enter forever.
On any HAL init failure the function halts in WFI.
Note
Single entry point; not re-entrant.
Since
0.1.0

Definition at line 370 of file main.c.

References ra8_isr_globals_enable(), selftest_panic_halt(), and selftest_setup_or_halt().

◆ selftest_host_worker()

VOID selftest_host_worker ( ULONG arg)
static

Host-side worker: retry the full pass until it succeeds.

Waits for the device side to attach, then loops selftest_host_pass with a retry pause until the whole config A ladder passes; afterwards parks so the verdict stays on the wire.

Parameters
[in]argThreadX entry argument (unused).
Precondition
tx_application_define created this thread (lower priority than the USBX device-side threads).
The HS host pins, expander switch, and PLL are up (main).
Postcondition
On success the pass counter and LED2 are latched.
Retries forever otherwise; each failure prints its step.
Note
Polled host stack: blocking calls, ms timeouts via ra8_time.
Since
0.1.0

Definition at line 178 of file main.c.

References k_ra8_ok, k_selftest_boot_wait_ticks, k_selftest_idle_ticks, k_selftest_retry_ticks, selftest_host_pass(), and tx_thread_sleep.

◆ selftest_panic_halt()

void selftest_panic_halt ( void )
static

Halt forever in WFI – panic stop on init failure.

Last-resort stop; only a debugger or reset recovers.

Precondition
Called only after a fatal error in boot.
Interrupts may be in any state.
Postcondition
CPU is parked.
No further code runs.
Note
Not reachable post-boot.
Since
0.1.0

Definition at line 257 of file main.c.

◆ selftest_route_usb_or_halt()

void selftest_route_usb_or_halt ( void )
static

Route both ports' pins: FS as device, HS as host.

FS device: P4_07 VBUS sense (PSEL), P5_00 VBUSEN held LOW as GPIO (peripheral routing would force host-style VBUSEN HIGH and block device enumeration), P8_14/P8_15 data. HS host: SW4-8 to Host via the U15 expander, PD07 HIGH (U18 supplies J7), P4_08 VBUS sense.

Precondition
IOPORT and the U15 expander are reachable.
Called once from selftest_setup_or_halt.
Postcondition
FS pins carry the device role, HS pins the host role.
PD07 is HIGH (J7 powered).
Note
Panic-halts on any routing failure.
Since
0.1.0

Definition at line 280 of file main.c.

References k_ra8_level_high, k_ra8_level_low, k_ra8_ok, k_ra8_psel_usb_fs, k_ra8_psel_usb_hs, k_selftest_pin_fs_dm, k_selftest_pin_fs_dp, k_selftest_pin_fs_vbus, k_selftest_pin_fs_vbusen, k_selftest_pin_hs_pwr, k_selftest_pin_hs_vbus, ra8_board_io_expander_set_usbhs_host_mode(), ra8_gpio_output_init(), ra8_pfs_route_peripheral(), and selftest_panic_halt().

◆ selftest_setup_or_halt()

void selftest_setup_or_halt ( void )
static

Bring CGC + both USB clocks + SysTick + SCI8 + LEDs + pins up.

USBFS needs the 48 MHz PLL2 reference before MSTPB11 is released; USBHS needs its 60 MHz UTMI PLL. SCI8 is the J-Link OB CDC console at 115200.

Precondition
Reset_Handler has finished C runtime init.
SystemInit has run.
Postcondition
Console prints work; both USB ports' pins and clocks are live.
LED1/LED2 are initialized.
Note
Panic-halts on any failure; called exactly once from main.
Since
0.1.0

Definition at line 326 of file main.c.

References k_ra8_board_led1, k_ra8_board_led2, k_ra8_clock_id_cpuclk0, k_ra8_ok, k_selftest_baud, ra8_board_led_init(), ra8_board_uart_console_init(), ra8_cgc_get_clock_hz(), ra8_cgc_init(), ra8_cgc_usbfs_clock_enable(), ra8_cgc_usbhs_pll_enable(), ra8_time_init(), selftest_panic_halt(), and selftest_route_usb_or_halt().

◆ SysTick_Handler()

void SysTick_Handler ( void )

Service the SysTick exception selected by the linked application.

Service one SysTick event for the core timebase.

Service one SysTick event for the core timebase.

Resolves to the weak core timebase handler unless a strong RTOS or application handler overrides it. The vector table references the selected implementation without owning its subsystem policy.

Precondition
Entered for a SysTick exception with a valid exception frame.
The selected handler's timebase or scheduler state is initialised.
Postcondition
The selected implementation has processed one SysTick event.
The vector table itself remains unchanged.
Note
Runs in handler mode; thread-safety follows the selected implementation.
Since
0.1.0

The weak firmware implementation advances the millisecond counter, then services linked ThreadX and USB hooks when their weak symbols and readiness state permit. The host-test implementation advances only the counter. An application may replace either weak definition with a strong handler.

Precondition
The handler is entered for one SysTick event or a host-test equivalent.
On target, ra8_time_init() configured the SysTick period.
Postcondition
s_tick_ms has advanced by exactly one.
Optional subsystem hooks run only when linked and ready.
Note
IRQ-safe; the weak symbol may be overridden by an application handler.
Since
0.1.0

Service the SysTick exception selected by the linked application.

The weak firmware implementation advances the millisecond counter, then services linked ThreadX and USB hooks when their weak symbols and readiness state permit. The host-test implementation advances only the counter. An application may replace either weak definition with a strong handler.

Precondition
The handler is entered for one SysTick event or a host-test equivalent.
On target, ra8_time_init() configured the SysTick period.
Postcondition
s_tick_ms has advanced by exactly one.
Optional subsystem hooks run only when linked and ready.
Note
IRQ-safe; the weak symbol may be overridden by an application handler.
Since
0.1.0

Service the SysTick exception selected by the linked application.

Precondition
Called from exception context (IPSR == 15).
_tx_initialize_low_level has programmed SysTick.
Postcondition
One ThreadX tick elapsed; PendSV may be pending.

Definition at line 92 of file main.c.

References _tx_timer_interrupt(), ra8_time_on_tick(), s_tx_kernel_up, and ux_dcd_ra8_usb_irq_reenable().

◆ tx_application_define()

VOID tx_application_define ( VOID * first_unused_memory)

ThreadX application-define hook.

Spawns both workers.

Device worker at priority 8 (above USBX class threads' default), host worker at 16 so the polled host loop can never starve the IRQ-driven device side.

Parameters
[in]first_unused_memorySentinel (unused; static stacks).
Precondition
Called from tx_kernel_enter after scheduler init.
Postcondition
Two auto-start worker threads are queued.
Note
Called once at boot; not thread-safe.
Since
0.1.0

Definition at line 210 of file main.c.

References k_selftest_dev_priority, k_selftest_host_priority, k_selftest_host_stack, k_selftest_thread_stack, s_device_stack, s_device_thread, s_device_thread_name, s_host_stack, s_host_thread, s_host_thread_name, s_tx_kernel_up, selftest_device_worker(), selftest_host_worker(), TX_AUTO_START, TX_NO_TIME_SLICE, and tx_thread_create.

Variable Documentation

◆ k_selftest_pin_fs_dm

const ra8_port_pin_t k_selftest_pin_fs_dm = (ra8_port_pin_t)k_ra8_board_usbfs_pin_dm
static

USBFS D- (P8_15).

Definition at line 116 of file main.c.

◆ k_selftest_pin_fs_dp

const ra8_port_pin_t k_selftest_pin_fs_dp = (ra8_port_pin_t)k_ra8_board_usbfs_pin_dp
static

USBFS D+ (P8_14).

Definition at line 113 of file main.c.

◆ k_selftest_pin_fs_vbus

const ra8_port_pin_t k_selftest_pin_fs_vbus = (ra8_port_pin_t)k_ra8_board_usbfs_pin_vbus
static

USBFS VBUS sense pin (P4_07, PSEL = 0x13).

Definition at line 107 of file main.c.

◆ k_selftest_pin_fs_vbusen

const ra8_port_pin_t k_selftest_pin_fs_vbusen = (ra8_port_pin_t)k_ra8_board_usbfs_pin_vbusen
static

USBFS VBUSEN (P5_00) – GPIO LOW for the device role.

Definition at line 110 of file main.c.

◆ k_selftest_pin_hs_pwr

const ra8_port_pin_t k_selftest_pin_hs_pwr = (ra8_port_pin_t)k_ra8_board_usbhs_pin_pwr
static

J7 host-power switch (PD07): HIGH = U18 supplies VBUS (UM 6.2).

Definition at line 122 of file main.c.

◆ k_selftest_pin_hs_vbus

const ra8_port_pin_t k_selftest_pin_hs_vbus = (ra8_port_pin_t)k_ra8_board_usbhs_pin_vbus
static

USBHS_VBUS sense pin (P4_08, PSEL = 0x14).

Definition at line 119 of file main.c.

◆ s_device_stack

UCHAR s_device_stack[k_selftest_thread_stack]
static

Stack backing storage for s_device_thread.

Since
0.1.0

Definition at line 143 of file main.c.

◆ s_device_thread

TX_THREAD s_device_thread
static

ThreadX TCB for the USBX device-side worker thread.

Note
Single-writer (worker only).
Since
0.1.0

Definition at line 136 of file main.c.

◆ s_host_stack

UCHAR s_host_stack[k_selftest_host_stack]
static

Stack backing storage for s_host_thread (ra8_fs walks live here).

Since
0.1.0

Definition at line 158 of file main.c.

◆ s_host_thread

TX_THREAD s_host_thread
static

ThreadX TCB for the polled host-side worker thread.

Note
Single-writer (worker only).
Since
0.1.0

Definition at line 151 of file main.c.

◆ s_tx_kernel_up

volatile bool s_tx_kernel_up = false
static

Set in tx_application_define; gates ThreadX tick delivery.

main() starts SysTick (ra8_time_init) BEFORE tx_kernel_enter, and this app's setup window is long (the U15 expander I2C transaction blocks for milliseconds), so the tick WILL fire pre-kernel. Feeding _tx_timer_interrupt into ThreadX's still-zeroed timer state walks a bogus expiration list and bus-faults (observed: IMPRECISERR HardFault from SysTick).

Since
0.1.0

Definition at line 89 of file main.c.