wifi.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2023 Fabian Hüßler ML!PA Consulting GmbH
3  *
4  * This file is subject to the terms and conditions of the GNU Lesser General
5  * Public License v2.1. See the file LICENSE in the top level directory for
6  * more details.
7  */
8 
9 #pragma once
10 
22 #include "net/ethernet/hdr.h"
23 #include "net/netopt.h"
24 #include "net/wifi.h"
25 #include "net/l2scan_list.h"
26 
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30 
34 typedef struct wifi_scan_request {
36  uint16_t timeout_ms_per_ch;
38 
46 #define WIFI_SCAN_REQUEST_INITIALIZER(ch, cb, ms) \
47  (wifi_scan_request_t) { \
48  .base = NETOPT_SCAN_REQUEST_INITIALIZER(ch, cb), \
49  .timeout_ms_per_ch = ms, \
50  }
51 
55 typedef struct wifi_scan_result {
59  char ssid[WIFI_SSID_LEN_MAX + 1];
61 
69 #define WIFI_SCAN_RESULT_INITIALIZER(ch, str, sec) \
70  (wifi_scan_result_t) { \
71  .base = NETOPT_SCAN_RESULT_INITIALIZER(ch, str), \
72  .sec_mode = sec, \
73  .bssid = { 0 }, \
74  .ssid = { 0 }, \
75  }
76 
81 
87 #define WIFI_SCAN_LIST_INITIALIZER(list) \
88  (wifi_scan_list_t) { \
89  .head = (list_node_t *)list, \
90  }
91 
95 typedef struct wifi_scan_list_node {
99 
103 typedef void (*wifi_on_scan_result_t) (void *netif, const wifi_scan_list_t *res);
104 
108 typedef struct wifi_connect_request {
113 
122 #define WIFI_CONNECT_REQUEST_INITIALIZER(ch, ccb, dcb, cr) \
123  (wifi_connect_request_t) { \
124  .base = NETOPT_CONNECT_REQUEST_INITIALIZER(ch, ccb, dcb), \
125  .cred = cr, \
126  .ssid = { 0 }, \
127  }
128 
132 typedef struct wifi_connect_result {
134  const char *ssid;
135  union {
142 
149 #define WIFI_CONNECT_RESULT_INITIALIZER(ch, p_ssid) \
150  (wifi_connect_result_t) { \
151  .base = NETOPT_CONNECT_RESULT_INITIALIZER(ch), \
152  .ssid = p_ssid, \
153  .credentials = { .sec = WIFI_SECURITY_MODE_OPEN }, \
154  }
155 
159 typedef void (*wifi_on_connect_result_t) (void *netif, const wifi_connect_result_t *res);
160 
164 typedef struct wifi_disconnect_request {
167 
173 #define WIFI_DISCONNECT_REQUEST_INITIALIZER(dcb) \
174  (wifi_disconnect_request_t) { \
175  .base = NETOPT_DISCONNECT_REQUEST_INITIALIZER(dcb), \
176  }
177 
181 typedef struct wifi_disconnect_result {
183  const char *ssid;
185 
192 #define WIFI_DISCONNECT_RESULT_INITIALIZER(ch, p_ssid) \
193  (wifi_disconnect_result_t) { \
194  .base = NETOPT_DISCONNECT_RESULT_INITIALIZER(ch), \
195  .ssid = p_ssid, \
196  }
197 
201 typedef void (*wifi_on_disconnect_result_t) (void *netif, const wifi_disconnect_result_t *res);
202 
203 #ifdef __cplusplus
204 }
205 #endif
206 
struct wifi_scan_list_node wifi_scan_list_node_t
Node type in a wifi scan list wifi_scan_list_t.
struct wifi_scan_result wifi_scan_result_t
A Wi-Fi scan result.
struct wifi_disconnect_result wifi_disconnect_result_t
A Wi-Fi disconnect result.
void(* wifi_on_scan_result_t)(void *netif, const wifi_scan_list_t *res)
Wi-Fi scan result callback prototype.
Definition: wifi.h:103
void(* wifi_on_connect_result_t)(void *netif, const wifi_connect_result_t *res)
Wi-Fi connect result callback prototype.
Definition: wifi.h:159
l2scan_list_t wifi_scan_list_t
A Wi-Fi scan list.
Definition: wifi.h:80
void(* wifi_on_disconnect_result_t)(void *netif, const wifi_disconnect_result_t *res)
Wi-Fi disconnect result callback prototype.
Definition: wifi.h:201
struct wifi_connect_request wifi_connect_request_t
A Wi-Fi connect request.
struct wifi_disconnect_request wifi_disconnect_request_t
A Wi-Fi disconnect request.
struct wifi_connect_result wifi_connect_result_t
A Wi-Fi connect result.
struct wifi_scan_request wifi_scan_request_t
A Wi-Fi scan request.
#define ETHERNET_ADDR_LEN
Length of an Ethernet address.
Definition: hdr.h:31
wifi_security_mode_t
Type to express a Wi-Fi security mode.
Definition: wifi.h:104
#define WIFI_SSID_LEN_MAX
Maximum length of an SSID.
Definition: wifi.h:114
L2 Scan list API.
Ethernet header definitions.
Definition of global configuration options.
Type of a Link Layer scan list.
Definition: l2scan_list.h:36
List node structure.
Definition: list.h:39
Basic network connect request.
Definition: netopt.h:1037
Basic network connect result.
Definition: netopt.h:993
Basic network disconnect request.
Definition: netopt.h:1060
Basic disconnect result.
Definition: netopt.h:1010
Basic network scan request.
Definition: netopt.h:973
Basic network scan result.
Definition: netopt.h:941
A Wi-Fi connect request.
Definition: wifi.h:108
char ssid[WIFI_SSID_LEN_MAX+1]
SSID of AP to connect to.
Definition: wifi.h:111
netopt_connect_request_t base
Basic connect request.
Definition: wifi.h:109
const wifi_security_mode_t * cred
Pointer to credentials.
Definition: wifi.h:110
A Wi-Fi connect result.
Definition: wifi.h:132
wifi_security_mode_t sec
WiFi security mode.
Definition: wifi.h:136
wifi_security_wep_psk_t wep
WEP security mode.
Definition: wifi.h:138
wifi_security_wpa_enterprise_t wpa_enterprise
WPA2 enterprise security mode.
Definition: wifi.h:139
wifi_security_wpa_psk_t wpa_psk
WPA2 PSK security mode.
Definition: wifi.h:137
union wifi_connect_result::@230 credentials
Credentials.
const char * ssid
SSID of currently connected AP.
Definition: wifi.h:134
netopt_connect_result_t base
Basic connect result.
Definition: wifi.h:133
A Wi-Fi disconnect request.
Definition: wifi.h:164
netopt_disconnect_request_t base
Basic disconnect request.
Definition: wifi.h:165
A Wi-Fi disconnect result.
Definition: wifi.h:181
const char * ssid
SSID of the AP no longer connected to.
Definition: wifi.h:183
netopt_disconnect_result_t base
Basic disconnect result.
Definition: wifi.h:182
Node type in a wifi scan list wifi_scan_list_t.
Definition: wifi.h:95
wifi_scan_result_t result
Wi-Fi scan result.
Definition: wifi.h:97
list_node_t node
Basic list node.
Definition: wifi.h:96
A Wi-Fi scan request.
Definition: wifi.h:34
uint16_t timeout_ms_per_ch
timeout for each channel to scan
Definition: wifi.h:36
netopt_scan_request_t base
Basic scan request.
Definition: wifi.h:35
A Wi-Fi scan result.
Definition: wifi.h:55
wifi_security_mode_t sec_mode
Security mode of AP.
Definition: wifi.h:57
uint8_t bssid[ETHERNET_ADDR_LEN]
BSSID of AP.
Definition: wifi.h:58
netopt_scan_result_t base
Basic scan result.
Definition: wifi.h:56
char ssid[WIFI_SSID_LEN_MAX+1]
SSID of AP.
Definition: wifi.h:59
A WEP pre-shared-key.
Definition: wifi.h:147
WPA2 Enterprise credentials.
Definition: wifi.h:155
A WPA pre-shared-key.
Definition: wifi.h:139
Definitions for Wi-Fi.