fullmac_helpers/
lib.rs

1// Copyright 2024 The Fuchsia Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5use fidl::endpoints::{create_endpoints, create_proxy};
6use futures::StreamExt;
7use lazy_static::lazy_static;
8use wlan_common::test_utils::fake_stas::FakeProtectionCfg;
9use wlan_common::{assert_variant, bss, fake_fidl_bss_description};
10use {
11    fidl_fuchsia_wlan_fullmac as fidl_fullmac, fidl_fuchsia_wlan_sme as fidl_sme,
12    fidl_test_wlan_testcontroller as fidl_testcontroller,
13};
14
15pub mod config;
16pub mod fake_ap;
17pub mod recorded_request_stream;
18
19// Compatible BSS descriptions are defined here.
20// "Compatible" here means that that an SME  with default configuration
21// will accept a connect request to a BSS with the returned BssDescription.
22lazy_static! {
23    pub static ref COMPATIBLE_OPEN_BSS: bss::BssDescription = fake_fidl_bss_description!(
24        protection => FakeProtectionCfg::Open,
25        channel: wlan_common::channel::Channel::new(1, wlan_common::channel::Cbw::Cbw20),
26        rates: vec![2, 4, 11],
27    )
28    .try_into()
29    .expect("Could not convert BSS description from FIDL");
30    pub static ref COMPATIBLE_WPA2_BSS: bss::BssDescription = fake_fidl_bss_description!(
31        protection => FakeProtectionCfg::Wpa2,
32        channel: wlan_common::channel::Channel::new(1, wlan_common::channel::Cbw::Cbw20),
33        rates: vec![2, 4, 11],
34    )
35    .try_into()
36    .expect("Could not convert BSS description from FIDL");
37    pub static ref COMPATIBLE_WPA3_BSS: bss::BssDescription = fake_fidl_bss_description!(
38        protection => FakeProtectionCfg::Wpa3,
39        channel: wlan_common::channel::Channel::new(1, wlan_common::channel::Cbw::Cbw20),
40        rates: vec![2, 4, 11],
41    )
42    .try_into()
43    .expect("Could not convert BSS description from FIDL");
44}
45
46/// Creates and starts fullmac driver using |testcontroller_proxy|.
47/// This handles the request to start SME through the UsmeBootstrap protocol,
48/// and the sequence of query requests that SME makes to the fullmac driver on startup.
49///
50/// After this function is called, the fullmac driver is ready to be used in the test suite.
51pub async fn create_fullmac_driver(
52    testcontroller_proxy: &fidl_testcontroller::TestControllerProxy,
53    config: &config::FullmacDriverConfig,
54) -> (
55    fidl_testcontroller::FullmacId,
56    fidl_fullmac::WlanFullmacImpl_RequestStream,
57    fidl_fullmac::WlanFullmacImplIfcProxy,
58    fidl_sme::GenericSmeProxy,
59) {
60    let (fullmac_bridge_client, fullmac_bridge_server) = create_endpoints();
61
62    let fullmac_id = testcontroller_proxy
63        .create_fullmac(fullmac_bridge_client)
64        .await
65        .expect("FIDL error on create_fullmac")
66        .expect("TestController returned an error on create fullmac");
67
68    let mut fullmac_bridge_stream = fullmac_bridge_server.into_stream();
69
70    // Fullmac MLME queries driver before starting
71    let (fullmac_ifc_proxy, generic_sme_proxy) =
72        handle_fullmac_startup(&mut fullmac_bridge_stream, config).await;
73
74    (fullmac_id, fullmac_bridge_stream, fullmac_ifc_proxy, generic_sme_proxy)
75}
76
77pub async fn handle_fullmac_startup(
78    fullmac_bridge_stream: &mut fidl_fullmac::WlanFullmacImpl_RequestStream,
79    config: &config::FullmacDriverConfig,
80) -> (fidl_fullmac::WlanFullmacImplIfcProxy, fidl_sme::GenericSmeProxy) {
81    let (usme_bootstrap_proxy, usme_bootstrap_server) =
82        create_proxy::<fidl_sme::UsmeBootstrapMarker>();
83
84    let fullmac_ifc_proxy = assert_variant!(fullmac_bridge_stream.next().await,
85        Some(Ok(fidl_fullmac::WlanFullmacImpl_Request::Init { payload, responder })) => {
86            responder
87                .send(Ok(fidl_fullmac::WlanFullmacImplInitResponse {
88                    sme_channel: Some(usme_bootstrap_server.into_channel()),
89                    ..Default::default()
90                }))
91                .expect("Failed to respond to Init");
92            let ifc = payload.ifc.expect("Init response missing ifc");
93            ifc.into_proxy()
94        }
95    );
96
97    let (generic_sme_proxy, generic_sme_server) = create_proxy::<fidl_sme::GenericSmeMarker>();
98
99    let _bootstrap_result = usme_bootstrap_proxy
100        .start(generic_sme_server, &config.sme_legacy_privacy_support)
101        .await
102        .expect("Failed to call usme_bootstrap.start");
103
104    assert_variant!(fullmac_bridge_stream.next().await,
105        Some(Ok(fidl_fullmac::WlanFullmacImpl_Request::Query { responder })) => {
106            responder
107                .send(Ok(&config.query_info))
108                .expect("Failed to respond to Query");
109        }
110    );
111
112    assert_variant!(fullmac_bridge_stream.next().await,
113        Some(Ok(fidl_fullmac::WlanFullmacImpl_Request::QuerySecuritySupport {
114            responder,
115        })) => {
116            responder
117                .send(Ok(&config.security_support))
118                .expect("Failed to respond to QuerySecuritySupport");
119        }
120    );
121
122    assert_variant!(fullmac_bridge_stream.next().await,
123        Some(Ok(fidl_fullmac::WlanFullmacImpl_Request::QuerySpectrumManagementSupport {
124                responder,
125        })) => {
126            responder
127                .send(Ok(&config.spectrum_management_support))
128                .expect("Failed to respond to QuerySpectrumManagementSupport");
129        }
130    );
131
132    assert_variant!(fullmac_bridge_stream.next().await,
133        Some(Ok(fidl_fullmac::WlanFullmacImpl_Request::Query { responder })) => {
134            responder
135                .send(Ok(&config.query_info))
136                .expect("Failed to respond to Query");
137        }
138    );
139
140    (fullmac_ifc_proxy, generic_sme_proxy)
141}
fullmac_helpers/lib.rs

fullmac_helpers/
lib.rs
