Everything the port needs that is not fixed by the board. More...

#include <ra8_esp_hosted_port.h>

Data Fields
uint32_t	pclk_hz
	PCLKA rate in hertz; the SCI baud clock source.
uint32_t	sck_hz
	Requested SPI bit rate in hertz.
uint16_t	edge_poll_ms
	Sampling period for pins with no ICU channel.
uint8_t	sci_channel
	SCI channel carrying Simple-SPI; 0..9.

Detailed Description

Everything the port needs that is not fixed by the board.

The pin assignment is deliberately absent: it is a board fact and lives once in ra8_esp_hosted_pins.h. What remains is the clocking, which an application knows and the port cannot discover, plus the poll period for any side-band pin the package cannot route to the ICU.

Invariant: pclk_hz is the live PCLKA rate; a stale value silently mis-programs the SCI bit-rate divider.; sck_hz is non-zero and within what the divider can reach from pclk_hz.; edge_poll_ms is non-zero, or the software edge detector would arm a zero-tick timer, which ThreadX rejects.

Example:: ra8_esp_hosted_port_cfg_t cfg = {};

(void)ra8_cgc_get_clock_hz(k_ra8_clock_id_pclka, &cfg.pclk_hz);

cfg.sck_hz = 5000000U;

cfg.edge_poll_ms = 2U;

(void)ra8_esp_hosted_port_init(&cfg);

ra8_cgc_get_clock_hz
ra8_err_t ra8_cgc_get_clock_hz(ra8_clock_id_t id, uint32_t *out_hz)
Query the current frequency of a clock-tree domain.
Definition ra8_cgc.c:132

k_ra8_clock_id_pclka
@ k_ra8_clock_id_pclka
PCLKA.
Definition ra8_cgc.h:73

ra8_esp_hosted_port_cfg_t
struct ra8_esp_hosted_port_cfg ra8_esp_hosted_port_cfg_t

ra8_esp_hosted_port_init
ra8_err_t ra8_esp_hosted_port_init(const ra8_esp_hosted_port_cfg_t *cfg)
Bring the esp-hosted port up and publish the OS-abstraction vtable.
Definition ra8_esp_hosted_port.c:331

ra8_esp_hosted_port_cfg::edge_poll_ms
uint16_t edge_poll_ms
Sampling period for pins with no ICU channel.
Definition ra8_esp_hosted_port.h:139

ra8_esp_hosted_port_cfg::pclk_hz
uint32_t pclk_hz
PCLKA rate in hertz; the SCI baud clock source.
Definition ra8_esp_hosted_port.h:137

ra8_esp_hosted_port_cfg::sck_hz
uint32_t sck_hz
Requested SPI bit rate in hertz.
Definition ra8_esp_hosted_port.h:138