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
;
77 enum usteer_node_type type
;
79 struct blob_attr
*rrm_nr
;
80 struct blob_attr
*node_info
;
101 struct usteer_scan_request
{
108 struct usteer_scan_result
{
116 struct usteer_survey_data
{
124 struct usteer_freq_data
{
131 struct usteer_node_handler
{
132 struct list_head list
;
134 void (*init_node
)(struct usteer_node
*);
135 void (*free_node
)(struct usteer_node
*);
136 void (*update_node
)(struct usteer_node
*);
137 void (*update_sta
)(struct usteer_node
*, struct sta_info
*);
138 void (*get_survey
)(struct usteer_node
*, void *,
139 void (*cb
)(void *priv
, struct usteer_survey_data
*d
));
140 void (*get_freqlist
)(struct usteer_node
*, void *,
141 void (*cb
)(void *priv
, struct usteer_freq_data
*f
));
142 int (*scan
)(struct usteer_node
*, struct usteer_scan_request
*,
143 void *, void (*cb
)(void *priv
, struct usteer_scan_result
*r
));
146 struct usteer_config
{
148 uint32_t debug_level
;
152 uint32_t sta_block_timeout
;
153 uint32_t local_sta_timeout
;
154 uint32_t local_sta_update
;
156 uint32_t max_retry_band
;
157 uint32_t seen_policy_timeout
;
161 uint32_t max_neighbor_reports
;
163 uint32_t band_steering_threshold
;
164 uint32_t load_balancing_threshold
;
166 uint32_t remote_update_interval
;
167 uint32_t remote_node_timeout
;
170 uint32_t min_snr_kick_delay
;
171 int32_t min_connect_snr
;
172 uint32_t signal_diff_threshold
;
174 int32_t roam_scan_snr
;
175 uint32_t roam_process_timeout
;
177 uint32_t roam_scan_tries
;
178 uint32_t roam_scan_timeout
;
179 uint32_t roam_scan_interval
;
181 int32_t roam_trigger_snr
;
182 uint32_t roam_trigger_interval
;
184 uint32_t roam_kick_delay
;
186 uint32_t initial_connect_delay
;
188 bool load_kick_enabled
;
189 uint32_t load_kick_threshold
;
190 uint32_t load_kick_delay
;
191 uint32_t load_kick_min_clients
;
192 uint32_t load_kick_reason_code
;
194 const char *node_up_script
;
195 uint32_t event_log_mask
;
197 struct blob_attr
*ssid_list
;
200 struct usteer_bss_tm_query
{
201 struct list_head list
;
203 /* Can't use sta_info here, as the STA might already be deleted */
205 uint8_t dialog_token
;
208 struct sta_info_stats
{
210 uint32_t blocked_cur
;
211 uint32_t blocked_total
;
212 uint32_t blocked_last_time
;
215 enum roam_trigger_state
{
218 ROAM_TRIGGER_SCAN_DONE
,
219 ROAM_TRIGGER_WAIT_KICK
,
220 ROAM_TRIGGER_NOTIFY_KICK
,
225 struct list_head list
;
226 struct list_head node_list
;
228 struct usteer_node
*node
;
231 struct usteer_timeout timeout
;
233 struct sta_info_stats stats
[__EVENT_TYPE_MAX
];
236 uint64_t last_connected
;
239 enum roam_trigger_state roam_state
;
243 uint64_t roam_scan_start
;
244 uint64_t roam_scan_timeout_start
;
248 uint32_t below_min_snr
;
250 uint8_t scan_band
: 1;
251 uint8_t connected
: 2;
256 struct list_head nodes
;
258 uint8_t seen_2ghz
: 1;
259 uint8_t seen_5ghz
: 1;
266 extern struct ubus_context
*ubus_ctx
;
267 extern struct usteer_config config
;
268 extern struct list_head node_handlers
;
269 extern struct avl_tree stations
;
270 extern struct ubus_object usteer_obj
;
271 extern uint64_t current_time
;
272 extern const char * const event_types
[__EVENT_TYPE_MAX
];
273 extern struct blob_attr
*host_info_blob
;
275 void usteer_update_time(void);
276 void usteer_init_defaults(void);
277 bool usteer_handle_sta_event(struct usteer_node
*node
, const uint8_t *addr
,
278 enum usteer_event_type type
, int freq
, int signal
);
280 int usteer_snr_to_signal(struct usteer_node
*node
, int snr
);
282 void usteer_local_nodes_init(struct ubus_context
*ctx
);
283 void usteer_local_node_kick(struct usteer_local_node
*ln
);
285 void usteer_ubus_init(struct ubus_context
*ctx
);
286 void usteer_ubus_kick_client(struct sta_info
*si
);
287 int usteer_ubus_trigger_client_scan(struct sta_info
*si
);
288 int usteer_ubus_notify_client_disassoc(struct sta_info
*si
);
289 int usteer_ubus_bss_transition_request(struct sta_info
*si
,
290 uint8_t dialog_token
,
291 bool disassoc_imminent
,
293 uint8_t validity_period
);
295 struct sta
*usteer_sta_get(const uint8_t *addr
, bool create
);
296 struct sta_info
*usteer_sta_info_get(struct sta
*sta
, struct usteer_node
*node
, bool *create
);
298 bool usteer_sta_supports_beacon_measurement_mode(struct sta
*sta
, enum usteer_beacon_measurement_mode mode
);
300 void usteer_sta_disconnected(struct sta_info
*si
);
301 void usteer_sta_info_update_timeout(struct sta_info
*si
, int timeout
);
302 void usteer_sta_info_update(struct sta_info
*si
, int signal
, bool avg
);
304 static inline const char *usteer_node_name(struct usteer_node
*node
)
306 return node
->avl
.key
;
308 void usteer_node_set_blob(struct blob_attr
**dest
, struct blob_attr
*val
);
310 struct usteer_local_node
*usteer_local_node_by_bssid(uint8_t *bssid
);
311 struct usteer_remote_node
*usteer_remote_node_by_bssid(uint8_t *bssid
);
312 struct usteer_node
*usteer_node_by_bssid(uint8_t *bssid
);
314 struct usteer_node
*usteer_node_get_next_neighbor(struct usteer_node
*current_node
, struct usteer_node
*last
);
315 bool usteer_check_request(struct sta_info
*si
, enum usteer_event_type type
);
317 void config_set_interfaces(struct blob_attr
*data
);
318 void config_get_interfaces(struct blob_buf
*buf
);
320 void config_set_node_up_script(struct blob_attr
*data
);
321 void config_get_node_up_script(struct blob_buf
*buf
);
323 void config_set_ssid_list(struct blob_attr
*data
);
324 void config_get_ssid_list(struct blob_buf
*buf
);
326 int usteer_interface_init(void);
327 void usteer_interface_add(const char *name
);
328 void usteer_sta_node_cleanup(struct usteer_node
*node
);
329 void usteer_send_sta_update(struct sta_info
*si
);
331 int usteer_lua_init(void);
332 int usteer_lua_ubus_init(void);
333 void usteer_run_hook(const char *name
, const char *arg
);
335 void usteer_dump_node(struct blob_buf
*buf
, struct usteer_node
*node
);
336 void usteer_dump_host(struct blob_buf
*buf
, struct usteer_remote_host
*host
);