|
ra8-firmware 0.1.0
Bare-metal firmware for the Renesas RA8 family (RA8D2 / RA8P1)
|
Clock Frequency Accuracy Measurement (CAC) demo for the EK-RA8D2. More...
#include <stdint.h>#include "ra8_attributes.h"#include "ra8_board_ek_ra8d2.h"#include "ra8_boot_entry.h"#include "ra8_cac.h"#include "ra8_cac_regs.h"#include "ra8_cgc.h"#include "ra8_check.h"#include "ra8_err.h"#include "ra8_isr.h"#include "ra8_mstp.h"#include "ra8_time.h"Go to the source code of this file.
Enumerations | |
| enum | cac_demo_config_t : uint32_t { k_cac_demo_baud = 115200U , k_cac_demo_period_ms = 1000U } |
| Compile-time settings. More... | |
| enum | cac_demo_calc_t : uint32_t { k_cac_demo_main_hz = 24000000U , k_cac_demo_loco_hz = 32768U , k_cac_demo_ref_div = 32U , k_cac_demo_tol_shift = 4U } |
| Clock-pair arithmetic for the expected count + window. More... | |
| enum | cac_demo_cacr_t : uint8_t { k_cac_demo_cacr1_main = 0x00U , k_cac_demo_cacr2_loco = 0x09U } |
| Direct CACR1 / CACR2 values selecting the MAIN-vs-LOCO clock pair. More... | |
Functions | |
| static void | internal_panic_halt (void) |
| Park forever after a fatal CAC initialization failure. | |
| static uint32_t | internal_expected (void) |
| Calculate the expected MAIN-vs-LOCO/32 edge count. | |
| static void | internal_setup_or_halt (void) |
| Bring CGC, SysTick, SCI8, LEDs, and MSTP up. | |
| static ra8_err_t | internal_configure (void) |
| Programme CAC limits + the MAIN-vs-LOCO clock pair. | |
| static ra8_err_t | internal_sample (uint8_t *out_ok) |
| Run one measurement and fold the result into the verdict. | |
| void | main (void) |
| The application entry point Reset_Handler hands control to. | |
Variables | |
| static const char * | s_tag = "cac_demo" |
| Diagnostic / log tag. | |
| static const uint8_t | s_cac_demo_ok_msg [] = "cac: meas=ok ferr=0 ovf=0 ok=Y\r\n" |
| Output line tags. | |
| static const uint8_t | s_cac_demo_bad_msg [] = "cac: meas=TIMEOUT-or-err ok=N\r\n" |
| volatile uint32_t | g_cac_count = 0U |
| Raw CACNTBR count captured on the last successful measurement. | |
| volatile uint32_t | g_cac_ok = 0U |
| 1 when the last measurement completed inside the window. | |
| volatile uint32_t | g_cac_status = 0U |
| Last CASTR snapshot (FERRF | MENDF | OVFF bits). | |
| volatile uint32_t | g_cac_heartbeat = 0U |
| Bumps once per main-loop pass – liveness for headless probes. | |
Clock Frequency Accuracy Measurement (CAC) demo for the EK-RA8D2.
The CAC counts edges of a measurement target clock during one period of a divided reference clock and raises a frequency-error flag if the count falls outside a programmed window. This demo measures the 24 MHz main oscillator (CACMCLK) against the LOCO low-speed on-chip oscillator (CACLCLK) divided by 32, i.e. a 1024 Hz reference window:
expected count = f_MAIN / (f_LOCO / 32) = 24e6 / 1024 = 23437
The allowable window is set to that expected value +/- ~6 %, so a healthy 24 MHz crystal passes (FERRF clear) while a stopped or grossly detuned oscillator trips the frequency-error flag.
Bring-up: CGC + SysTick + SCI8 + LEDs. After ra8_cac_init programs the limits, the demo writes CACR1 (target = MAIN) and CACR2 (reference = LOCO /32, internal) directly, then once a second performs a measurement and reports "cac: meas=ok ferr=0 ovf=0 ok=Y\r\n" on the J-Link OB CDC channel. The raw count lands in g_cac_count for SWD probing.
LED1 toggles on a healthy measurement; LED2 toggles on timeout / error.
Bare EK-RA8D2 only – no shields or external transceivers. Requires the LOCO to be running (it is the default low-speed clock and feeds IWDT / RTC); if the LOCO is stopped the reference never ticks and the measurement times out.
Definition in file main.c.
| enum cac_demo_cacr_t : uint8_t |
Direct CACR1 / CACR2 values selecting the MAIN-vs-LOCO clock pair.
ra8_cac_init leaves CACR1/CACR2 = 0; these must be written while CACR0.CFME = 0 (HUM Ch 10.2.2 p 421 / 10.2.3 p 422 notes).
| Enumerator | |
|---|---|
| k_cac_demo_cacr1_main | Target = main osc, /1, rising. |
| k_cac_demo_cacr2_loco | Reference = LOCO /32, internal. |
| enum cac_demo_calc_t : uint32_t |
Clock-pair arithmetic for the expected count + window.
f_MAIN = 24 MHz main XTAL (HUM Ch 9 "CGC", USBCKCR note p 365); f_LOCO = 32768 Hz; the reference is LOCO divided by 32 (CACR2.RCDS = 00). expected = f_MAIN * 32 / f_LOCO. The window is +/- (expected >> 4) (~6.25 %).
| enum cac_demo_config_t : uint32_t |
|
staticnodiscard |
Programme CAC limits + the MAIN-vs-LOCO clock pair.
ra8_cac_init enables the CAC clock, clears CACR0.CFME, and loads the +/-6% window; the demo then selects the clock pair by writing CACR1 + CACR2 directly (the HAL keeps them at 0). Both writes are valid only while CFME = 0, which ra8_cac_init guarantees on return.
| k_ra8_ok | CAC accepted the limits and clock pair was selected. |
| (other) | CAC initialization failed before direct clock selection. |
Definition at line 235 of file main.c.
References r_cac_regs_t::CACR1, r_cac_regs_t::CACR2, internal_expected(), k_cac_demo_cacr1_main, k_cac_demo_cacr2_loco, k_cac_demo_tol_shift, k_ra8_ok, ra8_cac(), ra8_cac_init(), and RA8_INTERNAL.
Referenced by main().
|
static |
Calculate the expected MAIN-vs-LOCO/32 edge count.
Applies the fixed target frequency and reference-divider ratio with unsigned integer arithmetic.
| 0..UINT32_MAX | Deterministic quotient from the compile-time constants. |
Definition at line 169 of file main.c.
References k_cac_demo_loco_hz, k_cac_demo_main_hz, k_cac_demo_ref_div, and RA8_INTERNAL.
Referenced by internal_configure().
|
static |
Park forever after a fatal CAC initialization failure.
Repeatedly executes WFI, preserving measurement state for debug.
Definition at line 149 of file main.c.
References RA8_INTERNAL.
|
staticnodiscard |
Run one measurement and fold the result into the verdict.
| [out] | out_ok | 1 when the measurement completed inside the window. |
Healthy iff ra8_cac_measure returned k_ra8_ok (MENDF inside the poll budget) AND neither the frequency-error (FERRF) nor the overflow (OVFF) status bit is set.
| k_ra8_err_null_ptr | out_ok was NULL. |
Definition at line 279 of file main.c.
References g_cac_count, g_cac_status, k_ra8_cac_status_ferrf, k_ra8_cac_status_ovff, k_ra8_ok, ra8_cac_get_status(), ra8_cac_measure(), RA8_CHECK_NULL_PTR, RA8_INTERNAL, and s_tag.
Referenced by main().
|
static |
Bring CGC, SysTick, SCI8, LEDs, and MSTP up.
Initializes foreground-loop dependencies in order and parks on the first failed HAL operation.
Definition at line 186 of file main.c.
References internal_panic_halt(), k_cac_demo_baud, k_ra8_board_led1, k_ra8_board_led2, k_ra8_clock_id_cpuclk0, k_ra8_ok, ra8_board_led_init(), ra8_board_uart_console_init(), ra8_cgc_get_clock_hz(), ra8_cgc_init(), RA8_INTERNAL, ra8_mstp_init(), and ra8_time_init().
| void main | ( | void | ) |
The application entry point Reset_Handler hands control to.
Returns void, not int. This is a freestanding image: there is no hosted C environment, no process and nothing to report an exit status to. ISO C fixes main at int only for a hosted implementation; for a freestanding one (C23 5.1.2.1) the startup function's name and type are implementation-defined, and this is that definition. Reset_Handler discards no value because there is none to discard, and if main ever does return, startup halts the CPU rather than resuming anything.
The firmware lane is compiled -ffreestanding (see cmake/ra8_add_app.cmake) and the flag and this signature travel together: without it both GCC and clang reject a non-int main (-Wmain / -Wmain-return-type). Do not remove one without the other.
That coupling is why the declaration sits behind __STDC_HOSTED__ == 0, which -ffreestanding sets and a hosted build does not. The guard is not defensive dressing: this header is reachable from host builds (the unit tests compile ra8_core natively), and an unguarded void main(void); makes every hosted translation unit that includes it fail with conflicting types for 'main' against its own ISO int main. The declaration therefore exists exactly where its contract does.
Hosted first-party code – everything under tests/ and tools/ – uses the ISO int main(...) contract instead, because it genuinely does run under an OS that reads the exit status. scripts/checks/check_entry_points.py holds each domain to its own contract (#707).
Declared here, once, for the same reason SystemInit is: every vector_table.c used to restate it as a local extern int32_t main(void);, sixteen copies that no compiler ever compared against the definition – and roughly thirty of them had silently drifted out of agreement with the main they called.
The application entry point Reset_Handler hands control to.
Brings up CGC + BSP audio then plays blocks.
The application entry point Reset_Handler hands control to.
Brings up CGC + GPT triple, runs sweep.
The application entry point Reset_Handler hands control to.
Brings up clocks + UART + RMII pins, then ThreadX.
The application entry point Reset_Handler hands control to.
Brings up clocks + UART, then enters ThreadX.
The application entry point Reset_Handler hands control to.
Brings up LED, console, SDHI pins, then ThreadX.
The application entry point Reset_Handler hands control to.
Brings up CGC + USB-FS + UAC1, then enters the iso-IN feed loop forever.
The application entry point Reset_Handler hands control to.
The application entry point Reset_Handler hands control to.
See file header.
The application entry point Reset_Handler hands control to.
The application entry point Reset_Handler hands control to.
The application entry point Reset_Handler hands control to.
The application entry point Reset_Handler hands control to.
The application entry point Reset_Handler hands control to.
The application entry point Reset_Handler hands control to.
The application entry point Reset_Handler hands control to.
Profiles power modes once a second.
The application entry point Reset_Handler hands control to.
The application entry point Reset_Handler hands control to.
Brings up the clocks, console, SPI, and SD card, then runs the shared ra8_io VFS round-trip over the SD-over-SPI block device. On success it prints the exact PASS banner the HIL runner and ra8_emulator smoke gate scrape for; on any failure it prints FAIL and parks the core.
The application entry point Reset_Handler hands control to.
Initialises logging and the console, brings up the OSPI NOR volume, runs the erase-before-write round-trip, and prints a single PASS/FAIL verdict line over SCI8 before parking in an infinite loop.
The application entry point Reset_Handler hands control to.
The application entry point Reset_Handler hands control to.
The application entry point Reset_Handler hands control to.
The application entry point Reset_Handler hands control to.
Both USB controllers' clocks and pins come up before the kernel so the workers only deal with stack bring-up.
The application entry point Reset_Handler hands control to.
Brings up logging and the clock tree, releases the Cortex-M33 (which then blinks LED1 via ra8_pcntr_set_output()), and idles. See the file header.
The application entry point Reset_Handler hands control to.
The application entry point Reset_Handler hands control to.
Brings up logging, the clock tree, and the VCOM console, runs the cacheable-SRAM round-trip with the D-cache that SystemInit() enabled through ra8_cache_dcache_enable(), emits the matching PASS / FAIL banner over the console and ra8_log, then parks in WFI. Every byte the self-test touches runs with the L1 caches + MPU enabled by the shared boot (RA8_BOOT_ENABLE_CACHE_MPU + RA8_BOOT_CACHE_VIA_HAL).
The application entry point Reset_Handler hands control to.
Publishes the mailbox, releases the Cortex-M33 into the emitter, yields until it signals done, validates the blob the M33 built, then logs the PASS/FAIL verdict and the chapter count read back from the blob. See the file header for the offload narrative.
The application entry point Reset_Handler hands control to.
The application entry point Reset_Handler hands control to.
The application entry point Reset_Handler hands control to.
The application entry point Reset_Handler hands control to.
The application entry point Reset_Handler hands control to.
The application entry point Reset_Handler hands control to.
Publishes the mailbox, arms the IPC0 wake and configures the LPM block, releases the Cortex-M33 into the reader, waits for the first held page, logs the page-0 verdict, then runs the #150 mode-switch cycle – parking in low-power WFI and waking on the M33's page-turn pokes – before logging the handoff verdict and parking for good. See the file header for the narrative.
The application entry point Reset_Handler hands control to.
The application entry point Reset_Handler hands control to.
Brings up the timebase then measures forever.
The application entry point Reset_Handler hands control to.
Arms the RIIC1 target and polls the dispatcher.
The application entry point Reset_Handler hands control to.
The application entry point Reset_Handler hands control to.
The application entry point Reset_Handler hands control to.
Brings up the LIN commander then drives frames.
The application entry point Reset_Handler hands control to.
Brings up logging, "renders" page 0 into the shared mailbox, releases the Cortex-M33 into its hold loop, and parks the M85 in low-power WFI sleep. See the file header for the power-saving narrative.
The application entry point Reset_Handler hands control to.
The USB clock, pins, console, and the SD card all come up before the kernel so the worker only deals with USB stack bring-up.
The application entry point Reset_Handler hands control to.
The application entry point Reset_Handler hands control to.
The application entry point Reset_Handler hands control to.
The application entry point Reset_Handler hands control to.
Brings up logging, the clock tree, and the VCOM console, runs the three-step self-test (MPU enabled, canonical boot map, Device MMIO), emits the matching PASS / FAIL banner over the console and ra8_log, then parks in WFI.
The application entry point Reset_Handler hands control to.
The application entry point Reset_Handler hands control to.
Initialises logging + console, brings up the MRAM volume, runs the wear-levelling + power-cycle-survival flow, and prints a single PASS/FAIL verdict.
The application entry point Reset_Handler hands control to.
Initialises logging + console, brings up the MRAM volume, runs the program/erase round-trip, and prints a single PASS/FAIL verdict.
The application entry point Reset_Handler hands control to.
Brings up the clocks, console, and SDHI bus pins, runs the native SD card identification, fills the payload, then runs the full ra8_io VFS round-trip over the native-SDHI block device. On success it prints the exact PASS banner the HIL runner and ra8_emulator smoke gate scrape for; on any failure it prints FAIL and parks the core.
The application entry point Reset_Handler hands control to.
Brings up the console and both stdio sinks, retargets the engine's stdio to the in-RAM capture sink, runs the two-backend swap, replays the RAM capture out of the UART, and prints a single PASS/FAIL verdict per abstraction before parking in an infinite loop.
The application entry point Reset_Handler hands control to.
Brings up the clocks, console, and SDHI bus pins, runs the native SD card identification, fills the payload, then writes + reads + compares one raw 512-byte block straight against ra8_sdcard. On success it prints the exact PASS banner; on any failure it prints FAIL and parks the core.
The application entry point Reset_Handler hands control to.
The application entry point Reset_Handler hands control to.
Brings up clocks + UART + RMII + RSIP, then ThreadX.
The application entry point Reset_Handler hands control to.
The application entry point Reset_Handler hands control to.
The application entry point Reset_Handler hands control to.
The application entry point Reset_Handler hands control to.
The application entry point Reset_Handler hands control to.
The application entry point Reset_Handler hands control to.
Initializes and arms ADC_B, formats each successful channel sample without variadic I/O, emits the verdict, toggles LED1, and delays.
The application entry point Reset_Handler hands control to.
The application entry point Reset_Handler hands control to.
Brings up logging, releases the Cortex-M33 (which then blinks LED1), and idles. See the file header for the teaching narrative.
The application entry point Reset_Handler hands control to.
Definition at line 302 of file main.c.
References g_cac_heartbeat, g_cac_ok, internal_configure(), internal_panic_halt(), internal_sample(), internal_setup_or_halt(), k_cac_demo_period_ms, k_ra8_board_led1, k_ra8_board_led2, k_ra8_ok, ra8_board_led_toggle(), ra8_board_uart_console_write(), ra8_delay_ms(), ra8_isr_globals_enable(), s_cac_demo_bad_msg, and s_cac_demo_ok_msg.
| volatile uint32_t g_cac_count = 0U |
Raw CACNTBR count captured on the last successful measurement.
Definition at line 113 of file main.c.
Referenced by internal_sample().
| volatile uint32_t g_cac_heartbeat = 0U |
| volatile uint32_t g_cac_ok = 0U |
| volatile uint32_t g_cac_status = 0U |
Last CASTR snapshot (FERRF | MENDF | OVFF bits).
Definition at line 129 of file main.c.
Referenced by internal_sample().
|
static |
|
static |