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

What the DHCP bring-up learned, for the verdict and the console. More...

#include <c6_join.h>

Data Fields

uint32_t ip
 Leased station address, or zero on failure.
uint32_t mask
 Subnet mask from the lease.
uint32_t gateway
 Default gateway from the lease; the ping target.
uint32_t dhcp_server
 Address of the DHCP server that answered.
bool ping_ok
 A gateway ICMP echo reply was received.

Detailed Description

What the DHCP bring-up learned, for the verdict and the console.

Filled by c6_join_net_up. Every address is a NetX packed IPv4 ULONG (host order), so c6_join_put_ip prints it directly.

Invariant
ip is non-zero exactly when a lease was obtained.
ping_ok is only meaningful when ip is non-zero.
Example:
c6_join_lease_t lease = {};
if (c6_join_net_up(&link, &mac, &lease) == k_ra8_ok) { use(lease.ip); }
ra8_err_t c6_join_net_up(ra8_c6link_t *link, const ra8_c6link_mac_t *mac, c6_join_lease_t *out)
Bring the IP layer up over the associated C6 link and prove traffic.
struct c6_join_lease c6_join_lease_t
@ k_ra8_ok
Success – operation completed with all postconditions satisfied.
Definition ra8_err.h:119
uint32_t ip
Leased station address, or zero on failure.
Definition c6_join.h:163
See also
c6_join_net_up
Since
0.1.0

Definition at line 162 of file c6_join.h.

Field Documentation

◆ dhcp_server

uint32_t c6_join_lease::dhcp_server

Address of the DHCP server that answered.

Definition at line 166 of file c6_join.h.

Referenced by c6_join_phase_ip(), and priv_net_dhcp().

◆ gateway

uint32_t c6_join_lease::gateway

Default gateway from the lease; the ping target.

Definition at line 165 of file c6_join.h.

Referenced by c6_join_net_up(), c6_join_phase_ip(), and priv_net_dhcp().

◆ ip

uint32_t c6_join_lease::ip

Leased station address, or zero on failure.

Definition at line 163 of file c6_join.h.

Referenced by c6_join_phase_ip(), and priv_net_dhcp().

◆ mask

uint32_t c6_join_lease::mask

Subnet mask from the lease.

Definition at line 164 of file c6_join.h.

Referenced by c6_join_phase_ip(), and priv_net_dhcp().

◆ ping_ok

bool c6_join_lease::ping_ok

A gateway ICMP echo reply was received.

Definition at line 167 of file c6_join.h.

Referenced by c6_join_net_up(), and c6_join_phase_ip().


The documentation for this struct was generated from the following file:
  • examples/ek_ra8d2/hw_validated/c6/c6_wifi_join/inc/c6_join.h