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

The observable outcome of one wifi_hal_join_run, for the banner and the host test. More...

#include <wifi_hal_join.h>

Collaboration diagram for wifi_hal_result:

Data Fields

bool init_ok
 The facade initialised.
bool associated
 The station joined the network.
bool ip_bound
 A DHCP lease was obtained.
bool passed
 The whole journey completed.
ra8_err_t init_err
 What ra8_wifi_init returned.
ra8_err_t connect_err
 What ra8_wifi_connect returned.
ra8_err_t ip_err
 What ra8_wifi_wait_ip returned.
ra8_wifi_mac_t mac
 Station MAC, once associated.
ra8_wifi_ap_t ap
 AP record, once associated.
ra8_wifi_lease_t lease
 The DHCP lease, once bound.

Detailed Description

The observable outcome of one wifi_hal_join_run, for the banner and the host test.

Populated by the core. main.c prints these fields; the host test asserts them. Every field is a fact the run established, not a formatting artifact.

Invariant
passed is true exactly when ip_bound is, i.e. the whole journey completed.
associated is set before ip_bound can be.
Each *_err is the verdict of the call it names, or k_ra8_err_not_initialized where the run stopped before that call was reached – so a failure always names a step and a reason rather than only "init=fail".
Example:
wifi_hal_result_t res = {};
(void)wifi_hal_join_run(&cfg, &res);
wifi_hal_join_run
bool wifi_hal_join_run(const wifi_hal_run_cfg_t *cfg, wifi_hal_result_t *out)
The example's whole network journey, hardware-free: init, join, DHCP.
Definition wifi_hal_core.c:71
wifi_hal_result_t
struct wifi_hal_result wifi_hal_result_t
See also
wifi_hal_join_run
Since
0.1.0

Definition at line 182 of file wifi_hal_join.h.

Field Documentation

◆ ap

ra8_wifi_ap_t wifi_hal_result::ap

AP record, once associated.

Definition at line 191 of file wifi_hal_join.h.

Referenced by wifi_hal_join_run(), and wifi_hal_report().

◆ associated

bool wifi_hal_result::associated

The station joined the network.

Definition at line 184 of file wifi_hal_join.h.

Referenced by wifi_hal_join_run(), and wifi_hal_report().

◆ connect_err

ra8_err_t wifi_hal_result::connect_err

What ra8_wifi_connect returned.

Definition at line 188 of file wifi_hal_join.h.

Referenced by wifi_hal_join_run(), and wifi_hal_report().

◆ init_err

ra8_err_t wifi_hal_result::init_err

What ra8_wifi_init returned.

Definition at line 187 of file wifi_hal_join.h.

Referenced by wifi_hal_join_run(), and wifi_hal_report().

◆ init_ok

bool wifi_hal_result::init_ok

The facade initialised.

Definition at line 183 of file wifi_hal_join.h.

Referenced by wifi_hal_join_run(), and wifi_hal_report().

◆ ip_bound

bool wifi_hal_result::ip_bound

A DHCP lease was obtained.

Definition at line 185 of file wifi_hal_join.h.

Referenced by wifi_hal_join_run(), and wifi_hal_report().

◆ ip_err

ra8_err_t wifi_hal_result::ip_err

What ra8_wifi_wait_ip returned.

Definition at line 189 of file wifi_hal_join.h.

Referenced by wifi_hal_join_run(), and wifi_hal_report().

◆ lease

ra8_wifi_lease_t wifi_hal_result::lease

The DHCP lease, once bound.

Definition at line 192 of file wifi_hal_join.h.

Referenced by wifi_hal_join_run(), and wifi_hal_report().

◆ mac

ra8_wifi_mac_t wifi_hal_result::mac

Station MAC, once associated.

Definition at line 190 of file wifi_hal_join.h.

Referenced by wifi_hal_join_run(), and wifi_hal_report().

◆ passed

bool wifi_hal_result::passed

The whole journey completed.

Definition at line 186 of file wifi_hal_join.h.

Referenced by wifi_hal_join_run().

The documentation for this struct was generated from the following file: