espressif/esp-protocols
1
0
Fork 1
mirror of https://github.com/espressif/esp-protocols.git synced 2025-07-29 10:17:30 +02:00
Code Issues Packages Projects Releases Wiki Activity

feat(wifi_remote): Move to esp-protocols

Browse Source
This commit is contained in:
Yogesh Mantri
2024-01-02 17:09:37 +08:00
committed by David Cermak
parent 943b683d38
commit edc3c2dee0
16 changed files with 577 additions and 214 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
components/esp_wifi_remote/CMakeLists.txt Normal file
View File

@ -0,0 +1,8 @@
if(NOT CONFIG_ESP_WIFI_ENABLED)
set(src_wifi_is_remote esp_wifi_remote.c)
endif()
idf_component_register(INCLUDE_DIRS include
SRCS wifi_remote_rpc.c wifi_remote_net.c wifi_remote_init.c ${src_wifi_is_remote}
REQUIRES esp_event esp_netif
PRIV_REQUIRES esp_wifi esp_hosted)

144
components/esp_wifi_remote/Kconfig Normal file
View File

@ -0,0 +1,144 @@
menu "Wi-Fi Remote"
config ESP_WIFI_REMOTE_ENABLED
bool
default y
config ESP_WIFI_REMOTE_STATIC_RX_BUFFER_NUM
int "Max number of WiFi static RX buffers"
range 0 128
default 0
config ESP_WIFI_REMOTE_DYNAMIC_RX_BUFFER_NUM
int "Max number of WiFi dynamic RX buffers"
range 0 1024
default 0
choice ESP_WIFI_REMOTE_TX_BUFFER
prompt "Type of WiFi TX buffers"
default ESP_WIFI_REMOTE_DYNAMIC_TX_BUFFER
config ESP_WIFI_REMOTE_STATIC_TX_BUFFER
bool "Static"
config ESP_WIFI_REMOTE_DYNAMIC_TX_BUFFER
bool "Dynamic"
endchoice
config ESP_WIFI_REMOTE_TX_BUFFER_TYPE
int
default 0 if ESP_WIFI_REMOTE_STATIC_TX_BUFFER
default 1 if ESP_WIFI_REMOTE_DYNAMIC_TX_BUFFER
config ESP_WIFI_REMOTE_STATIC_TX_BUFFER_NUM
int "Max number of WiFi static TX buffers"
depends on ESP_WIFI_REMOTE_STATIC_TX_BUFFER
range 0 64
default 0
choice ESP_WIFI_REMOTE_MGMT_RX_BUFFER
prompt "Type of WiFi RX MGMT buffers"
default ESP_WIFI_REMOTE_STATIC_RX_MGMT_BUFFER
config ESP_WIFI_REMOTE_STATIC_RX_MGMT_BUFFER
bool "Static"
config ESP_WIFI_REMOTE_DYNAMIC_RX_MGMT_BUFFER
bool "Dynamic"
endchoice
config ESP_WIFI_REMOTE_DYNAMIC_RX_MGMT_BUF
int
default 0 if ESP_WIFI_REMOTE_STATIC_RX_MGMT_BUFFER
default 1 if ESP_WIFI_REMOTE_DYNAMIC_RX_MGMT_BUFFER
config ESP_WIFI_REMOTE_RX_MGMT_BUF_NUM_DEF
int "Max number of WiFi RX MGMT buffers"
range 0 10
default 0
config ESP_WIFI_REMOTE_CSI_ENABLED
bool "WiFi CSI(Channel State Information)"
depends on SOC_WIFI_REMOTE_CSI_SUPPORT
default n
config ESP_WIFI_REMOTE_AMPDU_TX_ENABLED
bool "WiFi AMPDU TX"
default y
config ESP_WIFI_REMOTE_TX_BA_WIN
int "WiFi AMPDU TX BA window size"
depends on ESP_WIFI_REMOTE_AMPDU_TX_ENABLED
range 0 64 if SOC_WIFI_REMOTE_HE_SUPPORT
default 0
config ESP_WIFI_REMOTE_AMPDU_RX_ENABLED
bool "WiFi AMPDU RX"
default y
config ESP_REMOTE_WIFI_RX_BA_WIN
int "WiFi AMPDU RX BA window size"
depends on ESP_WIFI_REMOTE_AMPDU_RX_ENABLED
range 0 64
default 0
config ESP_WIFI_REMOTE_ESPNOW_MAX_ENCRYPT_NUM
int "Maximum espnow encrypt peers number"
range 0 17
default 0
if !ESP_WIFI_ENABLED
config ESP_WIFI_STATIC_RX_BUFFER_NUM
int
default ESP_WIFI_REMOTE_STATIC_RX_BUFFER_NUM
config ESP_WIFI_DYNAMIC_RX_BUFFER_NUM
int
default ESP_WIFI_REMOTE_DYNAMIC_RX_BUFFER_NUM
config ESP_WIFI_TX_BUFFER_TYPE
int
default ESP_WIFI_REMOTE_TX_BUFFER_TYPE
config ESP_WIFI_STATIC_TX_BUFFER_NUM
int
depends on ESP_WIFI_REMOTE_STATIC_TX_BUFFER
default ESP_WIFI_REMOTE_STATIC_TX_BUFFER_NUM
config ESP_WIFI_DYNAMIC_RX_MGMT_BUF
int
default ESP_WIFI_REMOTE_DYNAMIC_RX_MGMT_BUF
config ESP_WIFI_RX_MGMT_BUF_NUM_DEF
int
default ESP_WIFI_REMOTE_RX_MGMT_BUF_NUM_DEF
config ESP_WIFI_CSI_ENABLED
bool
default ESP_WIFI_REMOTE_CSI_ENABLED
config ESP_WIFI_AMPDU_TX_ENABLED
bool
default ESP_WIFI_REMOTE_AMPDU_TX_ENABLED
config ESP_WIFI_TX_BA_WIN
int
default ESP_WIFI_REMOTE_TX_BA_WIN
config ESP_WIFI_AMPDU_RX_ENABLED
bool
default ESP_WIFI_REMOTE_AMPDU_RX_ENABLED
config ESP_WIFI_RX_BA_WIN
int
default ESP_REMOTE_WIFI_RX_BA_WIN
config ESP_WIFI_ESPNOW_MAX_ENCRYPT_NUM
int
default ESP_WIFI_REMOTE_ESPNOW_MAX_ENCRYPT_NUM
endif #!ESP_WIFI_ENABLED
endmenu # Wi-Fi remote

202
components/esp_wifi_remote/LICENSE Normal file
View File

@ -0,0 +1,202 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

215
components/esp_wifi_remote/esp_wifi_remote.c Normal file
View File

@ -0,0 +1,215 @@
/*
* SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
*
* SPDX-License-Identifier: Apache-2.0
*/
#include "esp_wifi.h"
#include "esp_log.h"
#include "esp_wifi_remote.h"
#define WEAK __attribute__((weak))
WEAK ESP_EVENT_DEFINE_BASE(WIFI_EVENT);
WEAK wifi_osi_funcs_t g_wifi_osi_funcs;
WEAK const wpa_crypto_funcs_t g_wifi_default_wpa_crypto_funcs;
WEAK uint64_t g_wifi_feature_caps =
#if CONFIG_ESP32_WIFI_ENABLE_WPA3_SAE
CONFIG_FEATURE_WPA3_SAE_BIT |
#endif
#if CONFIG_SPIRAM
CONFIG_FEATURE_CACHE_TX_BUF_BIT |
#endif
#if CONFIG_ESP_WIFI_FTM_INITIATOR_SUPPORT
CONFIG_FEATURE_FTM_INITIATOR_BIT |
#endif
#if CONFIG_ESP_WIFI_FTM_RESPONDER_SUPPORT
CONFIG_FEATURE_FTM_RESPONDER_BIT |
#endif
0;
WEAK esp_err_t esp_wifi_connect(void)
{
return remote_esp_wifi_connect();
}
WEAK esp_err_t esp_wifi_disconnect(void)
{
return remote_esp_wifi_disconnect();
}
WEAK esp_err_t esp_wifi_init(const wifi_init_config_t *config)
{
return remote_esp_wifi_init(config);
}
WEAK esp_err_t esp_wifi_deinit(void)
{
return remote_esp_wifi_deinit();
}
WEAK esp_err_t esp_wifi_set_mode(wifi_mode_t mode)
{
return remote_esp_wifi_set_mode(mode);
}
WEAK esp_err_t esp_wifi_get_mode(wifi_mode_t *mode)
{
return remote_esp_wifi_get_mode(mode);
}
WEAK esp_err_t esp_wifi_set_config(wifi_interface_t interface, wifi_config_t *conf)
{
return remote_esp_wifi_set_config(interface, conf);
}
WEAK esp_err_t esp_wifi_get_config(wifi_interface_t interface, wifi_config_t *conf)
{
return remote_esp_wifi_get_config(interface, conf);
}
WEAK esp_err_t esp_wifi_start(void)
{
return remote_esp_wifi_start();
}
WEAK esp_err_t esp_wifi_stop(void)
{
return remote_esp_wifi_stop();
}
WEAK esp_err_t esp_wifi_get_mac(wifi_interface_t ifx, uint8_t mac[6])
{
return remote_esp_wifi_get_mac(ifx, mac);
}
WEAK esp_err_t esp_wifi_set_mac(wifi_interface_t ifx, const uint8_t mac[6])
{
return remote_esp_wifi_set_mac(ifx, mac);
}
WEAK esp_err_t esp_wifi_scan_start(const wifi_scan_config_t *config, bool block)
{
return remote_esp_wifi_scan_start(config, block);
}
WEAK esp_err_t esp_wifi_scan_stop(void)
{
return remote_esp_wifi_scan_stop();
}
WEAK esp_err_t esp_wifi_scan_get_ap_num(uint16_t *number)
{
return remote_esp_wifi_scan_get_ap_num(number);
}
WEAK esp_err_t esp_wifi_scan_get_ap_records(uint16_t *number, wifi_ap_record_t *ap_records)
{
return remote_esp_wifi_scan_get_ap_records(number, ap_records);
}
WEAK esp_err_t esp_wifi_clear_ap_list(void)
{
return remote_esp_wifi_clear_ap_list();
}
WEAK esp_err_t esp_wifi_restore(void)
{
return remote_esp_wifi_restore();
}
WEAK esp_err_t esp_wifi_clear_fast_connect(void)
{
return remote_esp_wifi_clear_fast_connect();
}
WEAK esp_err_t esp_wifi_deauth_sta(uint16_t aid)
{
return remote_esp_wifi_deauth_sta(aid);
}
WEAK esp_err_t esp_wifi_sta_get_ap_info(wifi_ap_record_t *ap_info)
{
return remote_esp_wifi_sta_get_ap_info(ap_info);
}
WEAK esp_err_t esp_wifi_set_ps(wifi_ps_type_t type)
{
return remote_esp_wifi_set_ps(type);
}
WEAK esp_err_t esp_wifi_get_ps(wifi_ps_type_t *type)
{
return remote_esp_wifi_get_ps(type);
}
WEAK esp_err_t esp_wifi_set_storage(wifi_storage_t storage)
{
return remote_esp_wifi_set_storage(storage);
}
WEAK esp_err_t esp_wifi_set_bandwidth(wifi_interface_t ifx, wifi_bandwidth_t bw)
{
return remote_esp_wifi_set_bandwidth(ifx, bw);
}
WEAK esp_err_t esp_wifi_get_bandwidth(wifi_interface_t ifx, wifi_bandwidth_t *bw)
{
return remote_esp_wifi_get_bandwidth(ifx, bw);
}
WEAK esp_err_t esp_wifi_set_channel(uint8_t primary, wifi_second_chan_t second)
{
return remote_esp_wifi_set_channel(primary, second);
}
WEAK esp_err_t esp_wifi_get_channel(uint8_t *primary, wifi_second_chan_t *second)
{
return remote_esp_wifi_get_channel(primary, second);
}
WEAK esp_err_t esp_wifi_set_country_code(const char *country, bool ieee80211d_enabled)
{
return remote_esp_wifi_set_country_code(country, ieee80211d_enabled);
}
WEAK esp_err_t esp_wifi_get_country_code(char *country)
{
return remote_esp_wifi_get_country_code(country);
}
WEAK esp_err_t esp_wifi_set_country(const wifi_country_t *country)
{
return remote_esp_wifi_set_country(country);
}
WEAK esp_err_t esp_wifi_get_country(wifi_country_t *country)
{
return remote_esp_wifi_get_country(country);
}
WEAK esp_err_t esp_wifi_ap_get_sta_list(wifi_sta_list_t *sta)
{
return remote_esp_wifi_ap_get_sta_list(sta);
}
WEAK esp_err_t esp_wifi_ap_get_sta_aid(const uint8_t mac[6], uint16_t *aid)
{
return remote_esp_wifi_ap_get_sta_aid(mac, aid);
}
WEAK esp_err_t esp_wifi_sta_get_rssi(int *rssi)
{
return remote_esp_wifi_sta_get_rssi(rssi);
}
WEAK esp_err_t esp_wifi_set_protocol(wifi_interface_t ifx, uint8_t protocol_bitmap)
{
return remote_esp_wifi_set_protocol(ifx, protocol_bitmap);
}
WEAK esp_err_t esp_wifi_get_protocol(wifi_interface_t ifx, uint8_t *protocol_bitmap)
{
return remote_esp_wifi_get_protocol(ifx, protocol_bitmap);
}

1
components/esp_wifi_remote/idf_component.yml Normal file
View File

@ -0,0 +1 @@
version: "1.0.0"

16
components/esp_wifi_remote/include/esp_wifi_native.h Normal file
View File

@ -0,0 +1,16 @@
/*
* SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD
*
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#define ESP_WIFI_MAX_CONN_NUM (15) /**< max number of stations which can connect to ESP32/ESP32S3/ESP32S2 soft-AP */
/** @brief List of stations associated with the Soft-AP */
typedef struct wifi_sta_list_t {
wifi_sta_info_t sta[ESP_WIFI_MAX_CONN_NUM]; /**< station list */
int num; /**< number of stations in the list (other entries are invalid) */
} wifi_sta_list_t;

63
components/esp_wifi_remote/include/esp_wifi_remote.h Normal file
View File

@ -0,0 +1,63 @@
/*
* SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
*
* SPDX-License-Identifier: Apache-2.0
*/
#pragma once
#include "esp_wifi.h"
typedef esp_err_t (*esp_remote_channel_rx_fn_t)(void *h, void *buffer, void *buff_to_free, size_t len);
typedef esp_err_t (*esp_remote_channel_tx_fn_t)(void *h, void *buffer, size_t len);
typedef struct esp_remote_channel *esp_remote_channel_t;
typedef struct esp_remote_channel_config *esp_remote_channel_config_t;
// Public API
esp_err_t remote_esp_wifi_connect(void);
esp_err_t remote_esp_wifi_disconnect(void);
esp_err_t remote_esp_wifi_init(const wifi_init_config_t *config);
esp_err_t remote_esp_wifi_deinit(void);
esp_err_t remote_esp_wifi_set_mode(wifi_mode_t mode);
esp_err_t remote_esp_wifi_get_mode(wifi_mode_t *mode);
esp_err_t remote_esp_wifi_set_config(wifi_interface_t ifx, wifi_config_t *conf);
esp_err_t remote_esp_wifi_get_config(wifi_interface_t interface, wifi_config_t *conf);
esp_err_t remote_esp_wifi_start(void);
esp_err_t remote_esp_wifi_stop(void);
esp_err_t remote_esp_wifi_get_mac(wifi_interface_t ifx, uint8_t mac[6]);
esp_err_t remote_esp_wifi_set_mac(wifi_interface_t ifx, const uint8_t mac[6]);
esp_err_t remote_esp_wifi_scan_start(const wifi_scan_config_t *config, bool block);
esp_err_t remote_esp_wifi_scan_stop(void);
esp_err_t remote_esp_wifi_scan_get_ap_num(uint16_t *number);
esp_err_t remote_esp_wifi_scan_get_ap_records(uint16_t *number, wifi_ap_record_t *ap_records);
esp_err_t remote_esp_wifi_clear_ap_list(void);
esp_err_t remote_esp_wifi_restore(void);
esp_err_t remote_esp_wifi_clear_fast_connect(void);
esp_err_t remote_esp_wifi_deauth_sta(uint16_t aid);
esp_err_t remote_esp_wifi_sta_get_ap_info(wifi_ap_record_t *ap_info);
esp_err_t remote_esp_wifi_set_ps(wifi_ps_type_t type);
esp_err_t remote_esp_wifi_get_ps(wifi_ps_type_t *type);
esp_err_t remote_esp_wifi_set_storage(wifi_storage_t storage);
esp_err_t remote_esp_wifi_set_bandwidth(wifi_interface_t ifx, wifi_bandwidth_t bw);
esp_err_t remote_esp_wifi_get_bandwidth(wifi_interface_t ifx, wifi_bandwidth_t *bw);
esp_err_t remote_esp_wifi_set_channel(uint8_t primary, wifi_second_chan_t second);
esp_err_t remote_esp_wifi_get_channel(uint8_t *primary, wifi_second_chan_t *second);
esp_err_t remote_esp_wifi_set_country_code(const char *country, bool ieee80211d_enabled);
esp_err_t remote_esp_wifi_get_country_code(char *country);
esp_err_t remote_esp_wifi_set_country(const wifi_country_t *country);
esp_err_t remote_esp_wifi_get_country(wifi_country_t *country);
esp_err_t remote_esp_wifi_ap_get_sta_list(wifi_sta_list_t *sta);
esp_err_t remote_esp_wifi_ap_get_sta_aid(const uint8_t mac[6], uint16_t *aid);
esp_err_t remote_esp_wifi_sta_get_rssi(int *rssi);
esp_err_t remote_esp_wifi_set_protocol(wifi_interface_t ifx, uint8_t protocol_bitmap);
esp_err_t remote_esp_wifi_get_protocol(wifi_interface_t ifx, uint8_t *protocol_bitmap);
// TODO: Move this to private include
// Private API
esp_err_t remote_esp_wifi_init_slave(void);
// handling channels
esp_err_t esp_wifi_remote_channel_rx(void *h, void *buffer, void *buff_to_free, size_t len);
esp_err_t esp_wifi_remote_channel_set(wifi_interface_t ifx, void *h, esp_remote_channel_tx_fn_t tx_cb);
esp_err_t esp_wifi_remote_rpc_channel_rx(void *h, void *buffer, size_t len);
esp_err_t esp_wifi_remote_rpc_channel_set(void *h, esp_remote_channel_tx_fn_t tx_cb);

44
components/esp_wifi_remote/wifi_remote_init.c Normal file
View File

@ -0,0 +1,44 @@
/*
* SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
*
* SPDX-License-Identifier: Apache-2.0
*/
#include "esp_err.h"
#include "esp_log.h"
#include "esp_hosted_api.h"
#include "esp_wifi_remote.h"
const char *TAG = "esp_remote_wifi_init";
esp_err_t remote_esp_wifi_init_slave(void)
{
ESP_LOGI(TAG, "** %s **", __func__);
#if 0
if (esp_hosted_setup() != ESP_OK) {
return ESP_FAIL;
}
#endif
esp_remote_channel_tx_fn_t tx_cb;
esp_remote_channel_t ch;
// Add an RPC channel with default config (i.e. secure=true)
struct esp_remote_channel_config config = ESP_HOSTED_CHANNEL_CONFIG_DEFAULT();
config.if_type = ESP_SERIAL_IF;
//TODO: add rpc channel from here
//ch = esp_hosted_add_channel(&config, &tx_cb, esp_wifi_remote_rpc_channel_rx);
// esp_wifi_remote_rpc_channel_set(ch, tx_cb);
// Add two other channels for the two WiFi interfaces (STA, softAP) in plain text
config.secure = false;
config.if_type = ESP_STA_IF;
ch = esp_hosted_add_channel(&config, &tx_cb, esp_wifi_remote_channel_rx);
esp_wifi_remote_channel_set(WIFI_IF_STA, ch, tx_cb);
config.secure = false;
config.if_type = ESP_AP_IF;
ch = esp_hosted_add_channel(&config, &tx_cb, esp_wifi_remote_channel_rx);
esp_wifi_remote_channel_set(WIFI_IF_AP, ch, tx_cb);
return ESP_OK;
}

90
components/esp_wifi_remote/wifi_remote_net.c Normal file
View File

@ -0,0 +1,90 @@
/*
* SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
*
* SPDX-License-Identifier: Apache-2.0
*/
#include <esp_private/wifi.h>
#include "esp_err.h"
#include "esp_wifi_remote.h"
#include "esp_log.h"
#define CHANNELS 2
static esp_remote_channel_tx_fn_t s_tx_cb[CHANNELS];
static esp_remote_channel_t s_channel[CHANNELS];
static wifi_rxcb_t s_rx_fn[CHANNELS];
esp_err_t esp_wifi_remote_channel_rx(void *h, void *buffer, void *buff_to_free, size_t len)
{
assert(h);
if (h == s_channel[0]) {
assert(s_rx_fn[0]);
return s_rx_fn[0](buffer, len, buff_to_free);
}
if (h == s_channel[1]) {
assert(s_rx_fn[1]);
return s_rx_fn[1](buffer, len, buff_to_free);
}
return ESP_FAIL;
}
esp_err_t esp_wifi_remote_channel_set(wifi_interface_t ifx, void *h, esp_remote_channel_tx_fn_t tx_cb)
{
if (ifx == WIFI_IF_STA) {
s_channel[0] = h;
s_tx_cb[0] = tx_cb;
return ESP_OK;
}
if (ifx == WIFI_IF_AP) {
s_channel[1] = h;
s_tx_cb[1] = tx_cb;
return ESP_OK;
}
return ESP_FAIL;
}
esp_err_t esp_wifi_internal_set_sta_ip(void)
{
return ESP_OK;
}
esp_err_t esp_wifi_internal_reg_netstack_buf_cb(wifi_netstack_buf_ref_cb_t ref, wifi_netstack_buf_free_cb_t free)
{
return ESP_OK;
}
void esp_wifi_internal_free_rx_buffer(void *buffer)
{
if (buffer) {
free(buffer);
}
}
int esp_wifi_internal_tx(wifi_interface_t ifx, void *buffer, uint16_t len)
{
if (ifx == WIFI_IF_STA) {
/* TODO: If not needed, remove arg3 */
return s_tx_cb[0](s_channel[0], buffer, len);
}
if (ifx == WIFI_IF_AP) {
return s_tx_cb[1](s_channel[1], buffer, len);
}
return -1;
}
esp_err_t esp_wifi_internal_reg_rxcb(wifi_interface_t ifx, wifi_rxcb_t fn)
{
if (ifx == WIFI_IF_STA) {
ESP_LOGI("esp_wifi_remote", "%s: sta: %p", __func__, fn);
s_rx_fn[0] = fn;
return ESP_OK;
}
if (ifx == WIFI_IF_AP) {
s_rx_fn[1] = fn;
return ESP_OK;
}
return ESP_FAIL;
}

232
components/esp_wifi_remote/wifi_remote_rpc.c Normal file
View File

@ -0,0 +1,232 @@
/*
* SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
*
* SPDX-License-Identifier: Apache-2.0
*/
#include <string.h>
#include "esp_log.h"
#include "esp_err.h"
#include "esp_wifi.h"
#include "esp_wifi_remote.h"
#include "esp_hosted_api.h"
static esp_remote_channel_t s_params_channel;
static esp_remote_channel_tx_fn_t s_params_tx;
static wifi_config_t s_last_wifi_conf;
esp_err_t esp_wifi_remote_rpc_channel_rx(void *h, void *buffer, size_t len)
{
if (h == s_params_channel && len == sizeof(s_last_wifi_conf)) {
memcpy(&s_last_wifi_conf, buffer, len); // TODO: use queue
return ESP_OK;
}
return ESP_FAIL;
}
esp_err_t esp_wifi_remote_rpc_channel_set(void *h, esp_err_t (*tx_cb)(void *, void *, size_t))
{
s_params_channel = h;
s_params_tx = tx_cb;
return ESP_OK;
}
esp_err_t remote_esp_wifi_connect(void)
{
return esp_hosted_wifi_connect();
}
esp_err_t remote_esp_wifi_disconnect(void)
{
return esp_hosted_wifi_disconnect();
}
esp_err_t remote_esp_wifi_init(const wifi_init_config_t *config)
{
if (remote_esp_wifi_init_slave() != ESP_OK) {
return ESP_FAIL;
}
return esp_hosted_wifi_init(config);
}
esp_err_t remote_esp_wifi_deinit(void)
{
return esp_hosted_wifi_deinit();
}
esp_err_t remote_esp_wifi_set_mode(wifi_mode_t mode)
{
return esp_hosted_wifi_set_mode(mode);
}
esp_err_t remote_esp_wifi_get_mode(wifi_mode_t *mode)
{
return esp_hosted_wifi_get_mode(mode);
}
esp_err_t remote_esp_wifi_set_config(wifi_interface_t interface, wifi_config_t *conf)
{
#if 0
uint8_t *param = (uint8_t *)conf;
uint32_t checksum = 0; // TODO: generate a random number and add it to both
for (int i = 0; i < sizeof(wifi_config_t); ++i) {
checksum += param[i];
}
// transmit the sensitive parameters over a secure channel
// s_params_tx(s_params_channel, param, sizeof(wifi_config_t));
// add only a checksum to the RPC
return esp_hosted_wifi_set_config(interface, checksum);
#endif
return esp_hosted_wifi_set_config(interface, conf);
}
esp_err_t remote_esp_wifi_get_config(wifi_interface_t interface, wifi_config_t *conf)
{
return esp_hosted_wifi_get_config(interface, conf);
}
esp_err_t remote_esp_wifi_start(void)
{
return esp_hosted_wifi_start();
}
esp_err_t remote_esp_wifi_stop(void)
{
return esp_hosted_wifi_stop();
}
esp_err_t remote_esp_wifi_get_mac(wifi_interface_t ifx, uint8_t mac[6])
{
return esp_hosted_wifi_get_mac(ifx, mac);
}
esp_err_t remote_esp_wifi_set_mac(wifi_interface_t ifx, const uint8_t mac[6])
{
return esp_hosted_wifi_set_mac(ifx, mac);
}
esp_err_t remote_esp_wifi_scan_start(const wifi_scan_config_t *config, bool block)
{
return esp_hosted_wifi_scan_start(config, block);
}
esp_err_t remote_esp_wifi_scan_stop(void)
{
return esp_hosted_wifi_scan_stop();
}
esp_err_t remote_esp_wifi_scan_get_ap_num(uint16_t *number)
{
return esp_hosted_wifi_scan_get_ap_num(number);
}
esp_err_t remote_esp_wifi_scan_get_ap_records(uint16_t *number, wifi_ap_record_t *ap_records)
{
return esp_hosted_wifi_scan_get_ap_records(number, ap_records);
}
esp_err_t remote_esp_wifi_clear_ap_list(void)
{
return esp_hosted_wifi_clear_ap_list();
}
esp_err_t remote_esp_wifi_restore(void)
{
return esp_hosted_wifi_restore();
}
esp_err_t remote_esp_wifi_clear_fast_connect(void)
{
return esp_hosted_wifi_clear_fast_connect();
}
esp_err_t remote_esp_wifi_deauth_sta(uint16_t aid)
{
return esp_hosted_wifi_deauth_sta(aid);
}
esp_err_t remote_esp_wifi_sta_get_ap_info(wifi_ap_record_t *ap_info)
{
return esp_hosted_wifi_sta_get_ap_info(ap_info);
}
esp_err_t remote_esp_wifi_set_ps(wifi_ps_type_t type)
{
return esp_hosted_wifi_set_ps(type);
}
esp_err_t remote_esp_wifi_get_ps(wifi_ps_type_t *type)
{
return esp_hosted_wifi_get_ps(type);
}
esp_err_t remote_esp_wifi_set_storage(wifi_storage_t storage)
{
return esp_hosted_wifi_set_storage(storage);
}
esp_err_t remote_esp_wifi_set_bandwidth(wifi_interface_t ifx, wifi_bandwidth_t bw)
{
return esp_hosted_wifi_set_bandwidth(ifx, bw);
}
esp_err_t remote_esp_wifi_get_bandwidth(wifi_interface_t ifx, wifi_bandwidth_t *bw)
{
return esp_hosted_wifi_get_bandwidth(ifx, bw);
}
esp_err_t remote_esp_wifi_set_channel(uint8_t primary, wifi_second_chan_t second)
{
return esp_hosted_wifi_set_channel(primary, second);
}
esp_err_t remote_esp_wifi_get_channel(uint8_t *primary, wifi_second_chan_t *second)
{
return esp_hosted_wifi_get_channel(primary, second);
}
esp_err_t remote_esp_wifi_set_country_code(const char *country, bool ieee80211d_enabled)
{
return esp_hosted_wifi_set_country_code(country, ieee80211d_enabled);
}
esp_err_t remote_esp_wifi_get_country_code(char *country)
{
return esp_hosted_wifi_get_country_code(country);
}
esp_err_t remote_esp_wifi_set_country(const wifi_country_t *country)
{
return esp_hosted_wifi_set_country(country);
}
esp_err_t remote_esp_wifi_get_country(wifi_country_t *country)
{
return esp_hosted_wifi_get_country(country);
}
esp_err_t remote_esp_wifi_ap_get_sta_list(wifi_sta_list_t *sta)
{
return esp_hosted_wifi_ap_get_sta_list(sta);
}
esp_err_t remote_esp_wifi_ap_get_sta_aid(const uint8_t mac[6], uint16_t *aid)
{
return esp_hosted_wifi_ap_get_sta_aid(mac, aid);
}
esp_err_t remote_esp_wifi_sta_get_rssi(int *rssi)
{
return esp_hosted_wifi_sta_get_rssi(rssi);
}
esp_err_t remote_esp_wifi_set_protocol(wifi_interface_t ifx, uint8_t protocol_bitmap)
{
return esp_hosted_wifi_set_protocol(ifx, protocol_bitmap);
}
esp_err_t remote_esp_wifi_get_protocol(wifi_interface_t ifx, uint8_t *protocol_bitmap)
{
return esp_hosted_wifi_get_protocol(ifx, protocol_bitmap);
}