FST: Add the Fast Session Transfer (FST) module
Fast Session Transfer (FST) is the transfer of a session from a channel
to another channel in a different frequency band. The term "session"
refers to non-physical layer state information kept by a pair of
stations (STAs) that communicate directly (i.e., excludes forwarding).
The FST is implemented in accordance with IEEE Std 802.11ad-2012.
Definitions
* FST interface - an interface for which FST functionality is enabled
* FST group - a bunch of FST interfaces representing single
multi-band STA
* FST peer - a multi-band capable STA connected
* FST module - multi-band operation functionality implemented in
accordance with IEEE Std 802.11ad-2012 (see 10.32
Multi-band operation) as a part of hostapd/wpa_supplicant
* FST manager - an external application that implements custom FST
related logic, using the FST module's interfaces
accessible via CLI or D-Bus
This commit introduces only the FST module. Integration of the FST
module into the hostapd/wpa_supplicant and corresponding CLI/D-Bus
interfaces and FST related tests are covered in separate commits.
FST manager application is out of scope of these commits.
As FST aggregates a few interfaces into FST group, the FST module uses
global CLI for both commands and notifications. It also exposes
alternative non-interface based D-Bus subtree for this purposes.
Configuration and Initialization
* FST functionality can enabled by compilation flag (CONFIG_FST)
* hostapd/wpa_supplicant controlling multiple interfaces are used for
FST
* once enabled by compilation, the FST can be enabled for specific
interfaces in the configuration files
* FST interfaces are aggregated in FST groups (fst_group_id config file
entry), where each FST group:
- represents one multi-band device
- should have two or more FST interfaces in it
* priority (fst_priority config file entry) must be configured for each
FST interface. FST interface with higher priority is the interface FST
will always try to switch to. Thus, for example, for the maximal
throughput, it should be the fastest FST interface in the FST setup.
* default Link Loss Timeout (LLT) value can be configured for each FST
interface (fst_llt config file entry). It represents LLT to be used
by FST when this interface is active.
* FST interfaces advertise the Multi-band capability by including the
Multi-band element in the corresponding frames
FST CLI commands:
* fst list_groups - list FST groups configured.
* fst list_ifaces - list FST interfaces which belong to specific group
* fst iface_peers - list Multi-Band STAs connected to specific interface
* fst list_sessions - list existing FST sessions
* fst session_get - get FST session info
* fst session_add - create FST session object
* fst session_set - set FST session parameters (old_iface, new_iface,
peer_addr, llt)
* fst session_initiate - initiate FST setup
* fst session_respond - respond to FST setup establishemnt attempt by
counterpart
* fst session_transfer - initiate FST switch
* fst session_teardown - tear down FST Setup but leave the session object
for reuse
* fst session_remove - remove FST session object
FST CLI notifications:
* FST-EVENT-PEER - peer state changed (CONNECT/DISCONNECT)
* FST-EVENT-SESSION - FST session level notification with following
sub-events:
- EVENT_FST_SESSION_STATE - FST session state changed
- EVENT_FST_ESTABLISHED - previously initiated FST session became
established
- EVENT_FST_SETUP - new FST session object created due to FST session
negotiation attempt by counterpart
All the FST CLI commands and notifications are also implemented on D-Bus
for wpa_supplicant.
IEEE 802.11 standard compliance
FST module implements FST setup statemachine in compliance with IEEE
802.11ad (P802.11-REVmc/D3.3), as it described in 10.32 Multi-band
operation (see also Figure 10-34 - States of the FST setup protocol).
Thus, for example, the FST module initiates FST switch automatically
when FST setup becomes established with LLT=0 in accordance with
10.32.2.2 Transitioning between states.
At the moment, FST module only supports non-transparent STA-based FST
(see 10.32.1 General).
Signed-off-by: Jouni Malinen <jouni@qca.qualcomm.com>
2015-02-18 15:59:21 +01:00
|
|
|
/*
|
|
|
|
* FST module - FST Session related definitions
|
|
|
|
* Copyright (c) 2014, Qualcomm Atheros, Inc.
|
|
|
|
*
|
|
|
|
* This software may be distributed under the terms of the BSD license.
|
|
|
|
* See README for more details.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef FST_SESSION_H
|
|
|
|
#define FST_SESSION_H
|
|
|
|
|
|
|
|
#define FST_DEFAULT_SESSION_TIMEOUT_TU 255 /* u8 */
|
|
|
|
|
|
|
|
struct fst_iface;
|
|
|
|
struct fst_group;
|
|
|
|
struct fst_session;
|
|
|
|
enum fst_session_state;
|
|
|
|
|
|
|
|
int fst_session_global_init(void);
|
|
|
|
void fst_session_global_deinit(void);
|
|
|
|
void fst_session_global_on_iface_detached(struct fst_iface *iface);
|
|
|
|
struct fst_session *
|
|
|
|
fst_session_global_get_first_by_group(struct fst_group *g);
|
|
|
|
|
|
|
|
struct fst_session * fst_session_create(struct fst_group *g);
|
|
|
|
void fst_session_set_iface(struct fst_session *s, struct fst_iface *iface,
|
|
|
|
Boolean is_old);
|
|
|
|
void fst_session_set_llt(struct fst_session *s, u32 llt);
|
|
|
|
void fst_session_set_peer_addr(struct fst_session *s, const u8 *addr,
|
|
|
|
Boolean is_old);
|
|
|
|
int fst_session_initiate_setup(struct fst_session *s);
|
|
|
|
int fst_session_respond(struct fst_session *s, u8 status_code);
|
|
|
|
int fst_session_initiate_switch(struct fst_session *s);
|
|
|
|
void fst_session_handle_action(struct fst_session *s, struct fst_iface *iface,
|
|
|
|
const struct ieee80211_mgmt *mgmt,
|
|
|
|
size_t frame_len);
|
|
|
|
int fst_session_tear_down_setup(struct fst_session *s);
|
|
|
|
void fst_session_reset(struct fst_session *s);
|
|
|
|
void fst_session_delete(struct fst_session *s);
|
|
|
|
|
|
|
|
struct fst_group * fst_session_get_group(struct fst_session *s);
|
|
|
|
struct fst_iface * fst_session_get_iface(struct fst_session *s, Boolean is_old);
|
|
|
|
const u8 * fst_session_get_peer_addr(struct fst_session *s, Boolean is_old);
|
|
|
|
u32 fst_session_get_id(struct fst_session *s);
|
|
|
|
u32 fst_session_get_llt(struct fst_session *s);
|
|
|
|
enum fst_session_state fst_session_get_state(struct fst_session *s);
|
|
|
|
|
|
|
|
struct fst_session *fst_session_get_by_id(u32 id);
|
|
|
|
|
|
|
|
typedef void (*fst_session_enum_clb)(struct fst_group *g, struct fst_session *s,
|
|
|
|
void *ctx);
|
|
|
|
|
|
|
|
void fst_session_enum(struct fst_group *g, fst_session_enum_clb clb, void *ctx);
|
|
|
|
|
|
|
|
void fst_session_on_action_rx(struct fst_iface *iface,
|
|
|
|
const struct ieee80211_mgmt *mgmt, size_t len);
|
|
|
|
|
|
|
|
|
|
|
|
int fst_session_set_str_ifname(struct fst_session *s, const char *ifname,
|
|
|
|
Boolean is_old);
|
|
|
|
int fst_session_set_str_peer_addr(struct fst_session *s, const char *mac,
|
|
|
|
Boolean is_old);
|
|
|
|
int fst_session_set_str_llt(struct fst_session *s, const char *llt_str);
|
|
|
|
|
2014-12-04 18:20:56 +01:00
|
|
|
#ifdef CONFIG_FST_TEST
|
|
|
|
|
|
|
|
#define FST_FSTS_ID_NOT_FOUND ((u32) -1)
|
|
|
|
|
|
|
|
int fst_test_req_send_fst_request(const char *params);
|
|
|
|
int fst_test_req_send_fst_response(const char *params);
|
|
|
|
int fst_test_req_send_ack_request(const char *params);
|
|
|
|
int fst_test_req_send_ack_response(const char *params);
|
|
|
|
int fst_test_req_send_tear_down(const char *params);
|
|
|
|
u32 fst_test_req_get_fsts_id(const char *params);
|
|
|
|
int fst_test_req_get_local_mbies(const char *request, char *buf,
|
|
|
|
size_t buflen);
|
|
|
|
|
|
|
|
#endif /* CONFIG_FST_TEST */
|
|
|
|
|
FST: Add the Fast Session Transfer (FST) module
Fast Session Transfer (FST) is the transfer of a session from a channel
to another channel in a different frequency band. The term "session"
refers to non-physical layer state information kept by a pair of
stations (STAs) that communicate directly (i.e., excludes forwarding).
The FST is implemented in accordance with IEEE Std 802.11ad-2012.
Definitions
* FST interface - an interface for which FST functionality is enabled
* FST group - a bunch of FST interfaces representing single
multi-band STA
* FST peer - a multi-band capable STA connected
* FST module - multi-band operation functionality implemented in
accordance with IEEE Std 802.11ad-2012 (see 10.32
Multi-band operation) as a part of hostapd/wpa_supplicant
* FST manager - an external application that implements custom FST
related logic, using the FST module's interfaces
accessible via CLI or D-Bus
This commit introduces only the FST module. Integration of the FST
module into the hostapd/wpa_supplicant and corresponding CLI/D-Bus
interfaces and FST related tests are covered in separate commits.
FST manager application is out of scope of these commits.
As FST aggregates a few interfaces into FST group, the FST module uses
global CLI for both commands and notifications. It also exposes
alternative non-interface based D-Bus subtree for this purposes.
Configuration and Initialization
* FST functionality can enabled by compilation flag (CONFIG_FST)
* hostapd/wpa_supplicant controlling multiple interfaces are used for
FST
* once enabled by compilation, the FST can be enabled for specific
interfaces in the configuration files
* FST interfaces are aggregated in FST groups (fst_group_id config file
entry), where each FST group:
- represents one multi-band device
- should have two or more FST interfaces in it
* priority (fst_priority config file entry) must be configured for each
FST interface. FST interface with higher priority is the interface FST
will always try to switch to. Thus, for example, for the maximal
throughput, it should be the fastest FST interface in the FST setup.
* default Link Loss Timeout (LLT) value can be configured for each FST
interface (fst_llt config file entry). It represents LLT to be used
by FST when this interface is active.
* FST interfaces advertise the Multi-band capability by including the
Multi-band element in the corresponding frames
FST CLI commands:
* fst list_groups - list FST groups configured.
* fst list_ifaces - list FST interfaces which belong to specific group
* fst iface_peers - list Multi-Band STAs connected to specific interface
* fst list_sessions - list existing FST sessions
* fst session_get - get FST session info
* fst session_add - create FST session object
* fst session_set - set FST session parameters (old_iface, new_iface,
peer_addr, llt)
* fst session_initiate - initiate FST setup
* fst session_respond - respond to FST setup establishemnt attempt by
counterpart
* fst session_transfer - initiate FST switch
* fst session_teardown - tear down FST Setup but leave the session object
for reuse
* fst session_remove - remove FST session object
FST CLI notifications:
* FST-EVENT-PEER - peer state changed (CONNECT/DISCONNECT)
* FST-EVENT-SESSION - FST session level notification with following
sub-events:
- EVENT_FST_SESSION_STATE - FST session state changed
- EVENT_FST_ESTABLISHED - previously initiated FST session became
established
- EVENT_FST_SETUP - new FST session object created due to FST session
negotiation attempt by counterpart
All the FST CLI commands and notifications are also implemented on D-Bus
for wpa_supplicant.
IEEE 802.11 standard compliance
FST module implements FST setup statemachine in compliance with IEEE
802.11ad (P802.11-REVmc/D3.3), as it described in 10.32 Multi-band
operation (see also Figure 10-34 - States of the FST setup protocol).
Thus, for example, the FST module initiates FST switch automatically
when FST setup becomes established with LLT=0 in accordance with
10.32.2.2 Transitioning between states.
At the moment, FST module only supports non-transparent STA-based FST
(see 10.32.1 General).
Signed-off-by: Jouni Malinen <jouni@qca.qualcomm.com>
2015-02-18 15:59:21 +01:00
|
|
|
#endif /* FST_SESSION_H */
|