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

The IPv4 configuration an ra8_wifi_ip_bind_fn obtained. More...

#include <ra8_wifi.h>

Data Fields

uint32_t ip
 Leased station address, or zero if unbound.
uint32_t mask
 Subnet mask from the lease.
uint32_t gateway
 Default gateway from the lease.
uint32_t dhcp_server
 Address of the DHCP server that answered.
bool bound
 A usable lease is held.

Detailed Description

The IPv4 configuration an ra8_wifi_ip_bind_fn obtained.

Filled by ra8_wifi_wait_ip from the caller-supplied IP provider and cached on the handle for ra8_wifi_get_ip. Every address is host byte order.

Invariant
bound is true exactly when ip is a usable, non-zero address.
When bound is false every address field is zero.
Example:
ra8_wifi_lease_t lease = {};
if (ra8_wifi_wait_ip(&wifi, &lease) == k_ra8_ok) { use(lease.ip); }
@ k_ra8_ok
Success – operation completed with all postconditions satisfied.
Definition ra8_err.h:119
struct ra8_wifi_lease ra8_wifi_lease_t
ra8_err_t ra8_wifi_wait_ip(ra8_wifi_t *wifi, ra8_wifi_lease_t *out)
Obtain an IP address for the associated station, blocking until bound.
Definition ra8_wifi.c:353
uint32_t ip
Leased station address, or zero if unbound.
Definition ra8_wifi.h:234
See also
ra8_wifi_wait_ip
Since
0.1.0

Definition at line 233 of file ra8_wifi.h.

Field Documentation

◆ bound

bool ra8_wifi_lease::bound

A usable lease is held.

Definition at line 238 of file ra8_wifi.h.

Referenced by ra8_wifi_wait_ip(), and wifi_hal_ip_bind().

◆ dhcp_server

uint32_t ra8_wifi_lease::dhcp_server

Address of the DHCP server that answered.

Definition at line 237 of file ra8_wifi.h.

Referenced by priv_net_dhcp(), and wifi_hal_print_lease().

◆ gateway

uint32_t ra8_wifi_lease::gateway

Default gateway from the lease.

Definition at line 236 of file ra8_wifi.h.

Referenced by priv_net_dhcp(), and wifi_hal_print_lease().

◆ ip

uint32_t ra8_wifi_lease::ip

Leased station address, or zero if unbound.

Definition at line 234 of file ra8_wifi.h.

Referenced by priv_net_dhcp(), ra8_wifi_wait_ip(), wifi_hal_ip_bind(), and wifi_hal_print_lease().

◆ mask

uint32_t ra8_wifi_lease::mask

Subnet mask from the lease.

Definition at line 235 of file ra8_wifi.h.

Referenced by priv_net_dhcp(), and wifi_hal_print_lease().


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