Outline ![]()
Files ![]()
loading...
SourceVu![]()
ESP-IDF Framework and Examples![]()
iperf sample![]()
managed_components/esp-qa__wifi-cmd/src/wifi_proto_cbw_cmd.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
/*
* SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
*
* SPDX-License-Identifier: Apache-2.0
*/
#include <string.h>
#include <ctype.h>
#include <stdlib.h>
#include "esp_wifi.h"
#include "esp_wifi_types.h"
#include "esp_netif_ip_addr.h"
#include "esp_log.h"
#include "esp_console.h"
#include "argtable3/argtable3.h"
#include "wifi_cmd.h"
#include "esp_system.h"
#ifndef APP_TAG
#define APP_TAG "WIFI"
#endif
typedef struct {
struct arg_str *proto_basic;
struct arg_str *proto_2ghz;
struct arg_str *proto_5ghz;
struct arg_str *interface;
struct arg_end *end;
} wifi_protocol_args_t;
static wifi_protocol_args_t wifi_protocol_args;
typedef struct {
struct arg_int *cbw_basic;
struct arg_int *cbw_2ghz;
struct arg_int *cbw_5ghz;
struct arg_str *interface;
struct arg_end *end;
} wifi_bandwidth_args_t;
static wifi_bandwidth_args_t wifi_bandwidth_args;
typedef struct {
char *protocol;
uint32_t bitmap;
} app_wifi_protocol_t;
static const app_wifi_protocol_t s_wifi_protocol_map[] = {
{"lr", WIFI_PROTOCOL_LR},
{"b", WIFI_PROTOCOL_11B},
{"g", WIFI_PROTOCOL_11G},
{"n", WIFI_PROTOCOL_11N},
{"lr/b", WIFI_PROTOCOL_LR | WIFI_PROTOCOL_11B},
{"b/g", WIFI_PROTOCOL_11B | WIFI_PROTOCOL_11G},
{"lr/b/g", WIFI_PROTOCOL_LR | WIFI_PROTOCOL_11B | WIFI_PROTOCOL_11G},
{"b/g/n", WIFI_PROTOCOL_11B | WIFI_PROTOCOL_11G | WIFI_PROTOCOL_11N},
{"lr/b/g/n", WIFI_PROTOCOL_LR | WIFI_PROTOCOL_11B | WIFI_PROTOCOL_11G | WIFI_PROTOCOL_11N},
#if CONFIG_SOC_WIFI_HE_SUPPORT
{"ax", WIFI_PROTOCOL_11AX},
{"b/g/n/ax", WIFI_PROTOCOL_11B | WIFI_PROTOCOL_11G | WIFI_PROTOCOL_11N | WIFI_PROTOCOL_11AX},
{"lr/b/g/n/ax", WIFI_PROTOCOL_LR | WIFI_PROTOCOL_11B | WIFI_PROTOCOL_11G | WIFI_PROTOCOL_11N | WIFI_PROTOCOL_11AX},
#endif
#if CONFIG_SOC_WIFI_SUPPORT_5G || CONFIG_SOC_WIFI_HE_SUPPORT_5G
{"a", WIFI_PROTOCOL_11A},
{"ac", WIFI_PROTOCOL_11AC},
{"a/n", WIFI_PROTOCOL_11A | WIFI_PROTOCOL_11N},
{"a/n/ac", WIFI_PROTOCOL_11A | WIFI_PROTOCOL_11N | WIFI_PROTOCOL_11AC},
{"a/n/ac/ax", WIFI_PROTOCOL_11A | WIFI_PROTOCOL_11N | WIFI_PROTOCOL_11AC | WIFI_PROTOCOL_11AX},
#endif
};
#define WIFI_PROTOCOL_NUM (sizeof(s_wifi_protocol_map) / sizeof(app_wifi_protocol_t))
#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 1, 0)
#define INVALID_WIFI_PROTO WIFI_PROTOCOL_11AX << 1
#else
#define INVALID_WIFI_PROTO WIFI_PROTOCOL_LR << 1
#endif
static uint8_t is_hex_string(const char *str)
{
if (str == NULL) {
return 0;
}
if (str[0] != '0' || str[1] != 'x') {
return 0; // Must start with 0x
}
str += 2; // Skip '0x'
while (*str) {
if (!isxdigit((unsigned char) * str)) {
return 0;
}
str++;
}
return 1;
}
uint32_t app_wifi_protocol_str2bitmap(const char *config)
{
// parse wifi protocol is bitmap(decimal)
if (is_hex_string(config)) {
return (uint32_t)strtoul(config, NULL, 16);
}
// parse if proto str start with lr
bool has_lr = (strncmp(config, "lr/", 3) == 0);
const char *sub_proto = has_lr ? config + 3 : config;
for (size_t i = 0; i < WIFI_PROTOCOL_NUM; i++) {
if (strcmp(sub_proto, s_wifi_protocol_map[i].protocol) == 0) {
return has_lr ? (WIFI_PROTOCOL_LR | s_wifi_protocol_map[i].bitmap) : s_wifi_protocol_map[i].bitmap;
}
}
// return invalid bitmap if not match any item
return INVALID_WIFI_PROTO;
}
const char *app_wifi_protocol_bitmap2str(const uint32_t bitmap)
{
char *protocol_str = NULL;
int i = 0;
for (i = 0; i < WIFI_PROTOCOL_NUM; i++) {
if (s_wifi_protocol_map[i].bitmap == bitmap) {
protocol_str = s_wifi_protocol_map[i].protocol;
break;
}
}
if (i == WIFI_PROTOCOL_NUM) {
ESP_LOGE(APP_TAG, "Can not convert bitmap 0x%x to protocol string.", bitmap);
/* Do not abort */
return "unknown";
}
return protocol_str;
}
static int cmd_do_wifi_protocol(int argc, char **argv)
{
int nerrors = arg_parse(argc, argv, (void **) &wifi_protocol_args);
if (nerrors != 0) {
arg_print_errors(stderr, wifi_protocol_args.end, argv[0]);
return 1;
}
if ((wifi_protocol_args.proto_basic->count > 0 && wifi_protocol_args.proto_2ghz->count > 0)
|| (wifi_protocol_args.proto_basic->count > 0 && wifi_protocol_args.proto_5ghz->count > 0)) {
ESP_LOGE(APP_TAG, "Cannot call esp_wifi_set_protocol and esp_wifi_set_protocols at same time");
return 1;
}
esp_err_t err = ESP_FAIL;
const char *interface = NULL;
if (wifi_protocol_args.interface->count == 0) {
interface = "sta";
} else {
interface = wifi_protocol_args.interface->sval[0];
}
wifi_interface_t ifx = app_wifi_interface_str2ifx(interface);
if (wifi_protocol_args.proto_basic->count == 0
&& wifi_protocol_args.proto_2ghz->count == 0
&& wifi_protocol_args.proto_5ghz->count == 0) {
#if CONFIG_SOC_WIFI_SUPPORT_5G || CONFIG_SOC_WIFI_HE_SUPPORT_5G
wifi_protocols_t proto_config = {0, };
err = esp_wifi_get_protocols(ifx, &proto_config);
if (err == ESP_OK) {
ESP_LOGI(APP_TAG, "(%s)GET_WIFI_PROTO:%s, GET_WIFI_PROTO_5G:%s",
interface,
app_wifi_protocol_bitmap2str((uint32_t)proto_config.ghz_2g),
app_wifi_protocol_bitmap2str((uint32_t)proto_config.ghz_5g));
} else {
ESP_LOGE(APP_TAG, "GET_WIFI_PROTO:FAIL,%d,%s", err, esp_err_to_name(err));
}
#else
uint8_t protocol = 0;
err = esp_wifi_get_protocol(ifx, &protocol);
if (err == ESP_OK) {
ESP_LOGI(APP_TAG, "(%s)GET_WIFI_PROTO:%s", interface, app_wifi_protocol_bitmap2str((uint32_t)protocol));
} else {
ESP_LOGE(APP_TAG, "GET_WIFI_PROTO:FAIL,%d,%s", err, esp_err_to_name(err));
}
#endif /* CONFIG_SOC_WIFI_SUPPORT_5G or CONFIG_SOC_WIFI_HE_SUPPORT_5G */
return 0;
}
if (wifi_protocol_args.proto_basic->count > 0) {
uint32_t protocol = app_wifi_protocol_str2bitmap(wifi_protocol_args.proto_basic->sval[0]);
err = esp_wifi_set_protocol(ifx, protocol);
LOG_WIFI_CMD_DONE(err, "SET_WIFI_PROTOCOL");
return 0;
}
if (wifi_protocol_args.proto_2ghz->count > 0 || wifi_protocol_args.proto_5ghz->count > 0) {
#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 4, 0)
wifi_protocols_t proto_config = {0, };
if (wifi_protocol_args.proto_2ghz->count > 0) {
proto_config.ghz_2g = app_wifi_protocol_str2bitmap(wifi_protocol_args.proto_2ghz->sval[0]);
} else {
proto_config.ghz_2g = 0;
}
if (wifi_protocol_args.proto_5ghz->count > 0) {
proto_config.ghz_5g = app_wifi_protocol_str2bitmap(wifi_protocol_args.proto_5ghz->sval[0]);
} else {
proto_config.ghz_5g = 0;
}
ESP_LOGD(APP_TAG, "WiFi 2g protocol: %x, WiFi 5g protocol: %x, interface: %s", proto_config.ghz_2g, proto_config.ghz_5g, interface);
err = esp_wifi_set_protocols(ifx, &proto_config);
LOG_WIFI_CMD_DONE(err, "SET_WIFI_PROTOCOL");
#else
ESP_LOGW(APP_TAG, "Not support 'esp_wifi_set_protocols' api before IDF version 5.4.0");
#endif /* ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 4, 0) */
}
return 0;
}
void wifi_cmd_register_wifi_protocol(void)
{
wifi_protocol_args.proto_basic = arg_str0(NULL, NULL, "<protocol>",
"api: esp_wifi_set_protocol.\n"
"protocol: use `/` to split protocols.\n"
"must input complete protocol bitmap config.\n"
"eg: 'b', 'b/g','b/g/n', g/n is invalid.");
wifi_protocol_args.proto_2ghz = arg_str0(NULL, "2g", "<2g_proto>",
"api: esp_wifi_set_protocols.\n"
"2g protocol\n"
"protocol string: 'lr', 'b', 'g', 'n', 'ax'\n"
"combine wiht lr mode: 'lr/b', 'lr/g', etc\n"
"protocol bitmap value: raw bitmap value with hex, eg: 0x40");
wifi_protocol_args.proto_5ghz = arg_str0(NULL, "5g", "<5g_proto>", "Same as <2g_proto>");
wifi_protocol_args.interface = arg_str0("i", "interface", "<interface>", "interface, 'ap', 'sta'. Default: sta");
wifi_protocol_args.end = arg_end(2);
const esp_console_cmd_t wifi_protocol_cmd = {
.command = "wifi_protocol",
.help = "Set Wifi Protocol <esp_wifi_set_protocol[s]>\n"
"Cannot call esp_wifi_set_protocol and esp_wifi_set_protocols at same time\n"
"If not given any config params will query current wifi protocol config",
.hint = NULL,
.func = &cmd_do_wifi_protocol,
.argtable = &wifi_protocol_args
};
ESP_ERROR_CHECK(esp_console_cmd_register(&wifi_protocol_cmd));
}
static int cmd_do_wifi_bandwidth(int argc, char **argv)
{
int nerrors = arg_parse(argc, argv, (void **) &wifi_bandwidth_args);
if (nerrors != 0) {
arg_print_errors(stderr, wifi_bandwidth_args.end, argv[0]);
return 1;
}
if ((wifi_bandwidth_args.cbw_basic->count > 0 && wifi_bandwidth_args.cbw_2ghz->count > 0)
|| (wifi_bandwidth_args.cbw_basic->count > 0 && wifi_bandwidth_args.cbw_5ghz->count > 0)) {
ESP_LOGE(APP_TAG, "Cannot call esp_wifi_set_bandwidht and esp_wifi_set_bandwidhts at same time");
return 1;
}
const char *interface = NULL;
esp_err_t err = ESP_FAIL;
if (wifi_bandwidth_args.interface->count == 0) {
interface = "sta";
} else {
interface = wifi_bandwidth_args.interface->sval[0];
}
wifi_interface_t ifx = app_wifi_interface_str2ifx(interface);
if (wifi_bandwidth_args.cbw_basic->count == 0
&& wifi_bandwidth_args.cbw_2ghz->count == 0
&& wifi_bandwidth_args.cbw_5ghz->count == 0) {
#if CONFIG_SOC_WIFI_SUPPORT_5G || CONFIG_SOC_WIFI_HE_SUPPORT_5G
wifi_bandwidths_t cbw_config = {0, };
err = esp_wifi_get_bandwidths(ifx, &cbw_config);
if (err == ESP_OK) {
ESP_LOGI(APP_TAG, "(%s)GET_WIFI_CBW:%dMHz, SET_WIFI_CBW_5G:%dMHz",
interface,
cbw_config.ghz_2g == WIFI_BW40 ? 40 : 20,
cbw_config.ghz_5g == WIFI_BW40 ? 40 : 20);
} else {
ESP_LOGE(APP_TAG, "GET_WIFI_CBW:FAIL,%d,%s", err, esp_err_to_name(err));
}
#else
wifi_bandwidth_t cbw = 0;
err = esp_wifi_get_bandwidth(ifx, &cbw);
if (err == ESP_OK) {
ESP_LOGI(APP_TAG, "(%s)GET_WIFI_CBW:%dMHz", interface, cbw == WIFI_BW_HT40 ? 40 : 20);
} else {
ESP_LOGE(APP_TAG, "GET_WIFI_CBW:FAIL,%d,%s", err, esp_err_to_name(err));
}
#endif /* CONFIG_SOC_WIFI_SUPPORT_5G or CONFIG_SOC_WIFI_HE_SUPPORT_5G */
return 0;
}
if (wifi_bandwidth_args.cbw_basic->count > 0) {
const int bandwidth = wifi_bandwidth_args.cbw_basic->ival[0];
if (bandwidth == 20) {
err = esp_wifi_set_bandwidth(ifx, WIFI_BW_HT20);
} else if (bandwidth == 40) {
err = esp_wifi_set_bandwidth(ifx, WIFI_BW_HT40);
}
LOG_WIFI_CMD_DONE(err, "SET_WIFI_BANDWIDTH");
return 0;
}
if (wifi_bandwidth_args.cbw_2ghz->count > 0 || wifi_bandwidth_args.cbw_5ghz->count > 0) {
#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 4, 0)
wifi_bandwidths_t cbw_config = {0};
if (wifi_bandwidth_args.cbw_2ghz->count > 0) {
if (wifi_bandwidth_args.cbw_2ghz->ival[0] == 20) {
cbw_config.ghz_2g = WIFI_BW20;
} else if (wifi_bandwidth_args.cbw_2ghz->ival[0] == 40) {
cbw_config.ghz_2g = WIFI_BW40;
}
}
if (wifi_bandwidth_args.cbw_5ghz->count > 0) {
if (wifi_bandwidth_args.cbw_5ghz->ival[0] == 20) {
cbw_config.ghz_5g = WIFI_BW20;
} else if (wifi_bandwidth_args.cbw_5ghz->ival[0] == 40) {
cbw_config.ghz_5g = WIFI_BW40;
}
}
err = esp_wifi_set_bandwidths(ifx, &cbw_config);
LOG_WIFI_CMD_DONE(err, "SET_WIFI_BANDWIDTH");
#else
ESP_LOGW(APP_TAG, "Not support 'esp_wifi_set_bandwidths' api before IDF version 5.4.0");
#endif /* ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 4, 0) */
}
return 0;
}
void wifi_cmd_register_wifi_bandwidth(void)
{
wifi_bandwidth_args.cbw_basic = arg_int0(NULL, NULL, "<cbw>", "20 or 40, cbw config with 'esp_wifi_set_bandwidth()'");
wifi_bandwidth_args.cbw_2ghz = arg_int0(NULL, "2g", "<2g_cbw>", "20 or 40, 2g cbw config with 'esp_wifi_set_bandwidths()'");
wifi_bandwidth_args.cbw_5ghz = arg_int0(NULL, "5g", "<5g_cbw>", "20 or 40, 5g cbw config with 'esp_wifi_set_bandwidths()'");
wifi_bandwidth_args.interface = arg_str0("i", "interface", "<interface>", "interface, 'ap', 'sta'. Default: sta");
wifi_bandwidth_args.end = arg_end(2);
const esp_console_cmd_t wifi_bandwidth_cmd = {
.command = "wifi_bandwidth",
.help = "Set Wifi bandwidth <esp_wifi_set_bandwidth[s]>\n"
"Cannot call esp_wifi_set_bandwidht and esp_wifi_set_bandwidhts at same time\n"
"If not given config any params will query current wifi cbw config",
.hint = NULL,
.func = &cmd_do_wifi_bandwidth,
.argtable = &wifi_bandwidth_args
};
ESP_ERROR_CHECK(esp_console_cmd_register(&wifi_bandwidth_cmd));
}
Details ![]()
Show: from Types: Columns: ![]( "Show Project Names")
![]( "Show Locations")
![]( "Show Referring Symbols")
![]( "Show Scope")
This file uses the notable symbols shown below. Click anywhere in the file to view more details.