2 * This program is free software; you can redistribute it and/or modify
3 * it under the terms of the GNU General Public License as published by
4 * the Free Software Foundation; either version 2 of the License.
6 * This program is distributed in the hope that it will be useful,
7 * but WITHOUT ANY WARRANTY; without even the implied warranty of
8 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9 * GNU General Public License for more details.
11 * You should have received a copy of the GNU General Public License
12 * along with this program; if not, write to the Free Software
13 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
15 * Copyright (C) 2020 embedd.ch
16 * Copyright (C) 2020 Felix Fietkau <nbd@nbd.name>
17 * Copyright (C) 2020 John Crispin <john@phrozen.org>
23 #include <libubox/avl.h>
24 #include <libubox/blobmsg.h>
25 #include <libubox/uloop.h>
26 #include <libubox/utils.h>
27 #include <libubox/kvlist.h>
32 #define NO_SIGNAL 0xff
35 #define _STR(x) __STR(x)
37 #define APMGR_V6_MCAST_GROUP "ff02::4150"
39 #define APMGR_PORT 16720 /* AP */
40 #define APMGR_PORT_STR _STR(APMGR_PORT)
41 #define APMGR_BUFLEN (64 * 1024)
43 #define DIV_ROUND_UP(n,d) (((n) + (d) - 1) / (d))
45 enum usteer_event_type
{
52 enum usteer_node_type
{
57 enum usteer_sta_connection_state
{
58 STA_NOT_CONNECTED
= 0,
63 enum usteer_beacon_measurement_mode
{
64 BEACON_MEASUREMENT_PASSIVE
= 0,
65 BEACON_MEASUREMENT_ACTIVE
= 1,
66 BEACON_MEASUREMENT_TABLE
= 2,
70 struct usteer_local_node
;
71 struct usteer_remote_host
;
75 struct list_head sta_info
;
76 struct list_head measurements
;
78 enum usteer_node_type type
;
80 struct blob_attr
*rrm_nr
;
81 struct blob_attr
*node_info
;
102 struct usteer_scan_request
{
109 struct usteer_scan_result
{
117 struct usteer_survey_data
{
125 struct usteer_freq_data
{
132 struct usteer_node_handler
{
133 struct list_head list
;
135 void (*init_node
)(struct usteer_node
*);
136 void (*free_node
)(struct usteer_node
*);
137 void (*update_node
)(struct usteer_node
*);
138 void (*update_sta
)(struct usteer_node
*, struct sta_info
*);
139 void (*get_survey
)(struct usteer_node
*, void *,
140 void (*cb
)(void *priv
, struct usteer_survey_data
*d
));
141 void (*get_freqlist
)(struct usteer_node
*, void *,
142 void (*cb
)(void *priv
, struct usteer_freq_data
*f
));
143 int (*scan
)(struct usteer_node
*, struct usteer_scan_request
*,
144 void *, void (*cb
)(void *priv
, struct usteer_scan_result
*r
));
147 struct usteer_config
{
149 uint32_t debug_level
;
153 uint32_t sta_block_timeout
;
154 uint32_t local_sta_timeout
;
155 uint32_t local_sta_update
;
157 uint32_t max_retry_band
;
158 uint32_t seen_policy_timeout
;
159 uint32_t measurement_report_timeout
;
163 uint32_t max_neighbor_reports
;
165 uint32_t band_steering_threshold
;
166 uint32_t load_balancing_threshold
;
168 uint32_t remote_update_interval
;
169 uint32_t remote_node_timeout
;
172 uint32_t min_snr_kick_delay
;
173 int32_t min_connect_snr
;
174 uint32_t signal_diff_threshold
;
176 int32_t roam_scan_snr
;
177 uint32_t roam_process_timeout
;
179 uint32_t roam_scan_tries
;
180 uint32_t roam_scan_timeout
;
181 uint32_t roam_scan_interval
;
183 int32_t roam_trigger_snr
;
184 uint32_t roam_trigger_interval
;
186 uint32_t roam_kick_delay
;
188 uint32_t initial_connect_delay
;
190 bool load_kick_enabled
;
191 uint32_t load_kick_threshold
;
192 uint32_t load_kick_delay
;
193 uint32_t load_kick_min_clients
;
194 uint32_t load_kick_reason_code
;
196 const char *node_up_script
;
197 uint32_t event_log_mask
;
199 struct blob_attr
*ssid_list
;
202 struct usteer_bss_tm_query
{
203 struct list_head list
;
205 /* Can't use sta_info here, as the STA might already be deleted */
207 uint8_t dialog_token
;
210 struct sta_info_stats
{
212 uint32_t blocked_cur
;
213 uint32_t blocked_total
;
214 uint32_t blocked_last_time
;
217 enum roam_trigger_state
{
220 ROAM_TRIGGER_SCAN_DONE
,
221 ROAM_TRIGGER_WAIT_KICK
,
222 ROAM_TRIGGER_NOTIFY_KICK
,
227 struct list_head list
;
228 struct list_head node_list
;
230 struct usteer_node
*node
;
233 struct usteer_timeout timeout
;
235 struct sta_info_stats stats
[__EVENT_TYPE_MAX
];
238 uint64_t last_connected
;
241 enum roam_trigger_state roam_state
;
245 uint64_t roam_scan_start
;
246 uint64_t roam_scan_timeout_start
;
251 } bss_transition_response
;
255 uint32_t below_min_snr
;
257 uint8_t scan_band
: 1;
258 uint8_t connected
: 2;
263 struct list_head nodes
;
264 struct list_head measurements
;
266 uint8_t seen_2ghz
: 1;
267 uint8_t seen_5ghz
: 1;
274 struct usteer_beacon_report
{
279 struct usteer_measurement_report
{
280 struct usteer_timeout timeout
;
282 struct list_head list
;
284 struct usteer_node
*node
;
285 struct list_head node_list
;
288 struct list_head sta_list
;
292 struct usteer_beacon_report beacon_report
;
295 extern struct ubus_context
*ubus_ctx
;
296 extern struct usteer_config config
;
297 extern struct list_head node_handlers
;
298 extern struct avl_tree stations
;
299 extern struct ubus_object usteer_obj
;
300 extern uint64_t current_time
;
301 extern const char * const event_types
[__EVENT_TYPE_MAX
];
302 extern struct blob_attr
*host_info_blob
;
304 void usteer_update_time(void);
305 void usteer_init_defaults(void);
306 bool usteer_handle_sta_event(struct usteer_node
*node
, const uint8_t *addr
,
307 enum usteer_event_type type
, int freq
, int signal
);
309 int usteer_snr_to_signal(struct usteer_node
*node
, int snr
);
311 void usteer_local_nodes_init(struct ubus_context
*ctx
);
312 void usteer_local_node_kick(struct usteer_local_node
*ln
);
314 void usteer_ubus_init(struct ubus_context
*ctx
);
315 void usteer_ubus_kick_client(struct sta_info
*si
);
316 int usteer_ubus_trigger_client_scan(struct sta_info
*si
);
317 int usteer_ubus_notify_client_disassoc(struct sta_info
*si
);
318 int usteer_ubus_bss_transition_request(struct sta_info
*si
,
319 uint8_t dialog_token
,
320 bool disassoc_imminent
,
322 uint8_t validity_period
);
324 struct sta
*usteer_sta_get(const uint8_t *addr
, bool create
);
325 struct sta_info
*usteer_sta_info_get(struct sta
*sta
, struct usteer_node
*node
, bool *create
);
327 bool usteer_sta_supports_beacon_measurement_mode(struct sta
*sta
, enum usteer_beacon_measurement_mode mode
);
329 void usteer_sta_disconnected(struct sta_info
*si
);
330 void usteer_sta_info_update_timeout(struct sta_info
*si
, int timeout
);
331 void usteer_sta_info_update(struct sta_info
*si
, int signal
, bool avg
);
333 static inline const char *usteer_node_name(struct usteer_node
*node
)
335 return node
->avl
.key
;
337 void usteer_node_set_blob(struct blob_attr
**dest
, struct blob_attr
*val
);
339 struct usteer_local_node
*usteer_local_node_by_bssid(uint8_t *bssid
);
340 struct usteer_remote_node
*usteer_remote_node_by_bssid(uint8_t *bssid
);
341 struct usteer_node
*usteer_node_by_bssid(uint8_t *bssid
);
343 struct usteer_node
*usteer_node_get_next_neighbor(struct usteer_node
*current_node
, struct usteer_node
*last
);
344 bool usteer_check_request(struct sta_info
*si
, enum usteer_event_type type
);
346 void config_set_interfaces(struct blob_attr
*data
);
347 void config_get_interfaces(struct blob_buf
*buf
);
349 void config_set_node_up_script(struct blob_attr
*data
);
350 void config_get_node_up_script(struct blob_buf
*buf
);
352 void config_set_ssid_list(struct blob_attr
*data
);
353 void config_get_ssid_list(struct blob_buf
*buf
);
355 int usteer_interface_init(void);
356 void usteer_interface_add(const char *name
);
357 void usteer_sta_node_cleanup(struct usteer_node
*node
);
358 void usteer_send_sta_update(struct sta_info
*si
);
360 int usteer_lua_init(void);
361 int usteer_lua_ubus_init(void);
362 void usteer_run_hook(const char *name
, const char *arg
);
364 void usteer_dump_node(struct blob_buf
*buf
, struct usteer_node
*node
);
365 void usteer_dump_host(struct blob_buf
*buf
, struct usteer_remote_host
*host
);
367 struct usteer_measurement_report
* usteer_measurement_report_get(struct sta
*sta
, struct usteer_node
*node
, bool create
);
368 void usteer_measurement_report_node_cleanup(struct usteer_node
*node
);
369 void usteer_measurement_report_sta_cleanup(struct sta
*sta
);
370 void usteer_measurement_report_del(struct usteer_measurement_report
*mr
);
372 struct usteer_measurement_report
*
373 usteer_measurement_report_add_beacon_report(struct sta
*sta
, struct usteer_node
*node
, struct usteer_beacon_report
*br
, uint64_t timestamp
);