ra8-firmware/ra8__wifi__backend_8h_source.html

#pragma once


#ifdef __cplusplus

extern "C" {

#endif


#include <stdint.h>


#include "ra8_err.h"

#include "ra8_wifi.h"


struct ra8_wifi_backend {

  ra8_err_t (*open)(void* ctx);


  ra8_err_t (*close)(void* ctx);


  ra8_err_t (*radio_up)(void* ctx);


  ra8_err_t (*radio_down)(void* ctx);


  ra8_err_t (*join)(void* ctx, const char* ssid, const char* psk);


  ra8_err_t (*leave)(void* ctx);


  ra8_err_t (*service)(void* ctx, ra8_wifi_link_t* out_link);


  ra8_err_t (*get_mac)(void* ctx, ra8_wifi_mac_t* out);


  ra8_err_t (*get_ap)(void* ctx, ra8_wifi_ap_t* out);


  void (*idle)(void* ctx, uint16_t ms);

};


#ifdef __cplusplus

}

#endif

ra8_err.h
Error Code Definitions for ra8-firmware.

ra8_err_t
ra8_err_codes_t ra8_err_t
Canonical error-return type used by every ra8-firmware API.
Definition ra8_err.h:546

ra8_wifi.h
A small, uniform Wi-Fi facade: init, connect, get an IP, disconnect.

ra8_wifi_ap_t
struct ra8_wifi_ap ra8_wifi_ap_t

ra8_wifi_mac_t
struct ra8_wifi_mac ra8_wifi_mac_t

ra8_wifi_link_t
ra8_wifi_link_t
The instantaneous association state a backend reports.
Definition ra8_wifi.h:182

ra8_wifi_backend
One vtable per radio.
Definition ra8_wifi_backend.h:71

ra8_wifi_backend::open
ra8_err_t(* open)(void *ctx)
Bring the radio's link up and prove it answers.
Definition ra8_wifi_backend.h:79

ra8_wifi_backend::radio_up
ra8_err_t(* radio_up)(void *ctx)
Start the radio in station mode.
Definition ra8_wifi_backend.h:94

ra8_wifi_backend::get_mac
ra8_err_t(* get_mac)(void *ctx, ra8_wifi_mac_t *out)
Read the station's own MAC address.
Definition ra8_wifi_backend.h:137

ra8_wifi_backend::get_ap
ra8_err_t(* get_ap)(void *ctx, ra8_wifi_ap_t *out)
Read what the radio knows about the associated AP.
Definition ra8_wifi_backend.h:145

ra8_wifi_backend::join
ra8_err_t(* join)(void *ctx, const char *ssid, const char *psk)
Ask the station to associate with a network.
Definition ra8_wifi_backend.h:112

ra8_wifi_backend::close
ra8_err_t(* close)(void *ctx)
Release the link the backend opened.
Definition ra8_wifi_backend.h:87

ra8_wifi_backend::service
ra8_err_t(* service)(void *ctx, ra8_wifi_link_t *out_link)
Service the link once and report the association state.
Definition ra8_wifi_backend.h:129

ra8_wifi_backend::idle
void(* idle)(void *ctx, uint16_t ms)
Idle for ms milliseconds, pacing a bounded wait.
Definition ra8_wifi_backend.h:161

ra8_wifi_backend::radio_down
ra8_err_t(* radio_down)(void *ctx)
Stop the radio and release its resources.
Definition ra8_wifi_backend.h:101

ra8_wifi_backend::leave
ra8_err_t(* leave)(void *ctx)
Disassociate the station from its network.
Definition ra8_wifi_backend.h:119