-
Notifications
You must be signed in to change notification settings - Fork 7
/
Copy pathREADME_UAP
executable file
·2866 lines (2278 loc) · 105 KB
/
README_UAP
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
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
===============================================================================
U S E R M A N U A L
Copyright 2009-2021 NXP
1) FOR DRIVER BUILD
Goto source code directory wlan_src.
make [clean] build
The driver binaries can be found in ../bin_xxxx directory.
The driver code supports Linux kernel from 2.6.32 to 5.15.
2) FOR DRIVER INSTALL
a) Copy sd8786_uapsta.bin | sd8787_uapsta.bin | ... to /lib/firmware/nxp/ directory,
create the directory if it doesn't exist.
b) Install uAP driver,
There are drv_mode, max_sta_bss, max_uap_bss etc. module parameters.
The bit settings of drv_mode are,
Bit 0 : STA
Bit 1 : uAP
Bit 2 : WIFIDIRECT
The default drv_mode is 7.
Bit 4 : NAN
max_uap_bss: Maximum number of uAP BSS (default 1, max 2)
uap_name: Name of the uAP interface (default: "uap")
For example, to install SD8887 driver,
To load driver in uAP only mode,
insmod mlan.ko
insmod sd8887.ko drv_mode=2 [fw_name=nxp/sd8887_uapsta.bin]
To switch mode between STA only, uAP only and uAPSTA in run time,
echo drv_mode=1 > /proc/mwlan/adapterX/config // STA mode
echo drv_mode=2 > /proc/mwlan/adapterX/config // uAP mode
echo drv_mode=3 > /proc/mwlan/adapterX/config // uAPSTA mode
c) Uninstall uAP driver,
ifconfig uapX down
rmmod sdxxx
rmmod mlan
To load driver with MFG firmware file, use mfg_mode=1 when insmod WLAN driver and
specify MFG firmware name if needed.
There are some other parameters for debugging purpose etc. Use modinfo to check details.
drvdbg=<bit mask of driver debug message control>
dev_cap_mask=<Bit mask of the device capability>
mac_addr=xx:xx:xx:xx:xx:xx <override the MAC address (in hex)>
auto_ds=0|1|2 <use MLAN default | enable auto deepsleep | disable auto deepsleep>
ps_mode=0|1|2 <use MLAN default | enable IEEE PS mode | disable IEEE PS mode>
max_tx_buf=2048|4096|8192 <maximum AMSDU Tx buffer size>
pm_keep_power=1|0 <PM keep power in suspend (default) | PM no power in suspend>
shutdown_hs=1|0 <Enable HS when shutdown | No HS when shutdown (default)>
cfg_11d=0|1|2 <use MLAN default | enable 11d | disable 11d>
dts_enable=0|1 <Disable DTS | Enable DTS (default)>
fw_name = <FW file name>
e.g. copy pcieuart9098_combo_v1.bin to firmware directory, fw_name=nxp/pcieuart9098_combo_v1.bin
hw_test=0|1 <Disable hardware test (default) | Enable hardware test>
fw_serial=0|1 <support parallel download FW | support serial download FW (default)>
req_fw_nowait=0|1 <use request_firmware API (default) | use request_firmware_nowait API>
slew_rate: Slew Rate Control value = 0|1|2|3 (0 is the slowest slew rate and 03 has the highest slew rate (default))
init_cfg=<init config (MAC addresses, registers etc.) file name>
e.g. copy init_cfg.conf to firmware directory, init_cfg=nxp/init_cfg.conf
cal_data_cfg=<CAL data config file name>
e.g. copy cal_data.conf to firmware directory, cal_data_cfg=nxp/cal_data.conf
txpwrlimit_cfg=<Tx power limit config file name>
e.g. copy txpwrlimit_cfg_set.conf to firmware directory, txpwrlimit_cfg=nxp/txpwrlimit_cfg_set.conf
cntry_txpwr=<Enable setting tx power table of country | Disable setting tx power table of country (default)>
init_hostcmd_cfg=<init hostcmd config file name>
e.g. copy init_hostcmd_cfg.conf to firmware directory, init_hostcmd_cfg=nxp/init_hostcmd_cfg.conf
sdio_rx_aggr=1|0 <Enable SDIO rx aggr (default) | Disable SDIO rx aggr>
cfg80211_wext=<bit mask of CFG80211 and WEXT control>
Bit 0: STA WEXT
Bit 1: uAP WEXT
Bit 2: STA CFG80211
Bit 3: uAP CFG80211
wq_sched_prio: Priority for work queue
wq_sched_policy: Scheduling policy for work queue
(0: SCHED_NORMAL, 1: SCHED_FIFO, 2: SCHED_RR, 3: SCHED_BATCH, 5: SCHED_IDLE)
Please note that, both wq_sched_prio and wq_sched_policy should be provided
as module parameters. If wq_sched_policy is (0, 3 or 5), then wq_sched_prio
must be 0. wq_sched_prio should be 1 to 99 otherwise.
rx_work=0|1|2 <default | Enable rx_work_queue | Disable rx_work_queue>
low_power_mode_enable=0|1 <disable low power mode (default)| enable low power mode>
When low power mode is enabled, the output power will be clipped at ~+10dBm and the
expected PA current is expected to be in the 80-90 mA range for b/g/n modes
max_wfd_bss: Maximum number of WIFIDIRECT BSS (default 1, max 1)
wfd_name: Name of the WIFIDIRECT interface (default: "wfd")
max_vir_bss: Number of Virtual interfaces (default 0)
nan_name: Name of the NAN interface (default: "nan")
max_nan_bss: Number of NAN interfaces (default 1)
max_11p_bss = <Max number of 802_11P interfaces (default 1)>
start_11ai_scan: Enable/disable 11ai bgscan (default 0, to enable:1, to disable:0)
dpd_data_cfg=<DPD data config file name>
e.g. copy dpd_data.conf to firmware directory, dpd_data_cfg=nxp/dpd_data.conf
pcie_int_mode=0 <Legacy mode(default)>
wakelock_timeout=<set wakelock_timeout value (ms)>
pmic=0|1 <No pmic configure cmd sent to firmware | Send pmic configure cmd to firmware>
indication_gpio=0xXY <GPIO to indicate wakeup source and its level; high four bits X:
level(0/1) for normal wakeup; low four bits Y: GPIO pin number. This parameter
only works with specific board and firmware.>
hs_wake_interval=<Host sleep wakeup interval,it will round to nearest multiple dtim*beacon_period in fw>
disconnect_on_suspend=0|1 <Disable disconnect wifi on suspend (default) | Enable disconnect wifi on suspend>
fixed_beacon_buffer=0|1 <allocate default buffer size (default) | allocate max buffer size>
GoAgeoutTime=0|x <use default ageout time (default) | set Go age out time xTU(TU 100ms)>
multi_dtim=0|x <use default DTIM interval(default) | set x*beacon_period as DTIM interval>
inact_tmo=0|x <use default IEEE ps inactivity timout value (default) | use IEEE ps inactivity timeout value x ms>
drcs_chantime_mode=0|x <channel time and mode for DRCS, use default value (default) | use setting value>
Bit31~Bit24:Channel time for channel index0;
Bit23~Bit16:mode for channel index0; 0|1 <PM1 | Null2Self>
Bit15~Bit8:Channel time for channel index1;
Bit7~Bit0:mode for channel index1; 0|1 <PM1 | Null2Self>
uap_max_sta: Maximum number of STA for UAP/GO (default 0, max 10)
host_mlme=0|1 <Disable Host MLME support (default)| Enable Host MLME support>
country_ie_ignore=0|1 <Follow countryIE from AP and beacon hint enable (default) | Ignore countryIE from AP and beacon hint disable>
beacon_hints=0|1 <enable beacon hints(default) | disable beacon hints>
wacp_mode=0|1|2 <disable WACP default | WACP mode 1 | WACP mode 2>
Note: On some platforms (e.g. PXA910/920) double quotation marks ("") need to used
for module parameters.
insmod sdxxx.ko "<para1> <para2> ..."
3) FOR DRIVER PROC & DEBUG
The following info are provided in /proc/mwlan/adapterX/uapY/info.
driver_name = "uap"
driver_version = <driver version>
InterfaceName= "uapX"
State= "Disconnected" | "Connected"
MACAddress= <6-byte adapter MAC address>
MCCount= <multicast address count>
num_tx_bytes = <number of bytes sent to device>
num_rx_bytes = <number of bytes received from device and sent to kernel>
num_tx_pkts = <number of packets sent to device>
num_rx_pkts = <number of packets received from device and sent to kernel>
num_tx_pkts_dropped = <number of tx packets dropped by driver>
num_rx_pkts_dropped = <number of rx packets dropped by driver>
num_tx_pkts_err = <number of tx packets failed to send to device>
num_rx_pkts_err = <number of rx packets failed to receive from device>
num_tx_timeout = <number of tx timeout>
carrier "on" | "off"
tx queue "stopped" | "started"
The following debug info are provided in /proc/mwlan/adapterX/uapY/debug.
drvdbg = <bit masks of driver debug message control>
bit 0: MMSG PRINTM(MMSG,...)
bit 1: MFATAL PRINTM(MFATAL,...)
bit 2: MERROR PRINTM(MERROR,...)
bit 3: MDATA PRINTM(MDATA,...)
bit 4: MCMND PRINTM(MCMND,...)
bit 5: MEVENT PRINTM(MEVENT,...)
bit 6: MINTR PRINTM(MINTR,...)
bit 7: MIOCTL PRINTM(MIOCTL,...)
...
bit 16: MDAT_D PRINTM(MDAT_D,...), DBG_HEXDUMP(MDAT_D,...)
bit 17: MCMD_D PRINTM(MCMD_D,...), DBG_HEXDUMP(MCMD_D,...)
bit 18: MEVT_D PRINTM(MEVT_D,...), DBG_HEXDUMP(MEVT_D,...)
bit 19: MFW_D PRINTM(MFW_D,...), DBG_HEXDUMP(MFW_D,...)
bit 20: MIF_D PRINTM(MIF_D,...), DBG_HEXDUMP(MIF_D,...)
...
bit 28: MENTRY PRINTM(MENTRY,...), ENTER(), LEAVE()
bit 29: MWARN PRINTM(MWARN,...)
bit 30: MINFO PRINTM(MINFO,...)
wmm_ac_vo = <number of packets sent to device from WMM AcVo queue>
wmm_ac_vi = <number of packets sent to device from WMM AcVi queue>
wmm_ac_be = <number of packets sent to device from WMM AcBE queue>
wmm_ac_bk = <number of packets sent to device from WMM AcBK queue>
max_tx_buf_size = <maximum Tx buffer size>
tx_buf_size = <current Tx buffer size>
curr_tx_buf_size = <current Tx buffer size in FW>
ps_mode = <0/1, CAM mode/PS mode>
ps_state = <0/1/2/3, awake state/pre-sleep state/sleep-confirm state/sleep state>
wakeup_dev_req = <0/1, wakeup device not required/required>
wakeup_tries = <wakeup device count, cleared when device awake>
hs_configured = <0/1, host sleep not configured/configured>
hs_activated = <0/1, extended host sleep not activated/activated>
tx_pkts_queued = <number of Tx packets queued>
num_bridge_pkts = <number of bridged packets>
num_drop_pkts = <number of dropped packets>
num_tx_timeout = <number of Tx timeout>
num_cmd_timeout = <number of timeout commands>
timeout_cmd_id = <command id of the last timeout command>
timeout_cmd_act = <command action of the last timeout command>
last_cmd_id = <command id of the last several commands sent to device>
last_cmd_act = <command action of the last several commands sent to device>
last_cmd_index = <0 based last command index>
last_cmd_resp_id = <command id of the last several command responses received from device>
last_cmd_resp_index = <0 based last command response index>
last_event = <event id of the last several events received from device>
last_event_index = <0 based last event index>
num_cmd_h2c_fail = <number of commands failed to send to device>
num_cmd_sleep_cfm_fail = <number of sleep confirm failed to send to device>
num_tx_h2c_fail = <number of data packets failed to send to device>
num_cmdevt_c2h_fail = <number of commands/events failed to receive from device>
num_rx_c2h_fail = <number of data packets failed to receive from device>
num_int_read_fail = <number of interrupt read failures>
last_int_status = <last interrupt status>
cmd_sent = <0/1, send command resources available/sending command to device>
data_sent = <0/1, send data resources available/sending data to device>
mp_rd_bitmap = <SDIO multi-port read bitmap>
curr_rd_port = <SDIO multi-port current read port>
mp_wr_bitmap = <SDIO multi-port write bitmap>
curr_wr_port = <SDIO multi-port current write port>
cmd_resp_received = <0/1, no cmd response to process/response received and yet to process>
event_received = <0/1, no event to process/event received and yet to process>
ioctl_pending = <number of ioctl pending>
tx_pending = <number of Tx packet pending>
rx_pending = <number of Rx packet pending>
lock_count = <number of lock used>
malloc_count = <number of malloc done>
mbufalloc_count = <number of mlan_buffer allocated>
main_state = <current state of the main process>
sdiocmd53w = <SDIO Cmd53 write status>
sdiocmd53r = <SDIO Cmd52 read status>
hs_skip_count = <number of skipped suspends>
hs_force_count = <number of forced suspends>
Example:
echo "drvdbg=0x7" > /proc/mwlan/adapterX/uapY/debug #enable MMSG,MFATAL,MERROR messages
Use dmesg or cat /var/log/debug to check driver debug messages.
To log driver debug messages to file,
a) Edit /etc/rsyslog.conf, add one line "*.debug /var/log/debug"
b) touch /var/log/debug (if the file doesn't exist)
c) service rsyslog restart
4) SOFT_RESET command
This command is used to perform a "soft reset" on the module.
The FW code will disable hardware and jump to boot code.
Host software will then need to re-download firmware if required.
Usage:
echo "soft_reset=1" > /proc/mwlan/adapterX/config
===============================================================================
U S E R M A N U A L F O R UAPUTL
NAME
uaputl.exe [options] <command> [command parameters]]
Options:
--help Display help
-v Display version
-i <interface>
-d <debug_level=0|1|2>
Example:
./uaputl.exe --help
"display help for uaputl"
./uaputl.exe sys_config --help
"display help for sys_config command"
This tool can be used to set/get uAP's settings. To change AP settings, you might
need to issue "bss_stop" command to stop AP before making change and issue "bss_start"
command to restart the AP after making change.
------------------
Supported Commands
------------------
version
debug_level
sys_config [CONFIG_FILE_NAME]
bss_config [CONFIG_FILE_NAME]
sys_info
sys_reset
bss_start
bss_stop
sta_list
sta_deauth <STA_MAC_ADDRESS>
sta_deauth_ext <STA_MAC_ADDRESS> <REASON_CODE>
radioctrl [0|1]
txratecfg [l] [m] [n] [o]
pscfg [MODE] [CTRL INACTTO MIN_SLEEP MAX_SLEEP MIN_AWAKE MAX_AWAKE]
mic_err <STA_MAC_ADDRESS>
key_material <MAC_ADDRESS> <KEY> [KEY_ID]
sys_cfg_custom_ie [INDEX] [MASK] [IEBuffer]
coex_config [CONFIG_FILE_NAME]
hscfg [condition [[GPIO# [gap]]]]
hssetpara condition [[GPIO# [gap]]]
sys_cfg_wmm [qosinfo=<qosinfo>]
[AC_BE AIFSN ECW_MAX ECW_MIN TX_OP]
[AC_BK AIFSN ECW_MAX ECW_MIN TX_OP]
[AC_VI AIFSN ECW_MAX ECW_MIN TX_OP]
[AC_VO AIFSN ECW_MAX ECW_MIN TX_OP]
sys_cfg_ap_wmm [0]
[AC_BE AIFSN ECW_MAX ECW_MIN TX_OP]
[AC_BK AIFSN ECW_MAX ECW_MIN TX_OP]
[AC_VI AIFSN ECW_MAX ECW_MIN TX_OP]
[AC_VO AIFSN ECW_MAX ECW_MIN TX_OP]
sys_cfg_11n [ENABLE] [HTCAP] [AMPDU] [TXBFCAP] [HT_MCS_MAP]
addbapara [timeout txwinsize rxwinsize txamsdu rxamsdu]
aggrpriotbl <m0> <n0> <m1> <n1> ... <m7> <n7>
addbareject <m0> <m1> ... <m7>
httxbfcfg <ACTION> [ACT_DATA]
httxcfg [<m>]
deepsleep [MODE] [IDLE_TIME]
sdcmd52rw <FN no.> <address> [data]
hostcmd <txpwrlimit_cfg.conf> txpwrlimit_cfg_get
hostcmd <txpwrlimit_cfg.conf> txpwrlimit_2g_cfg_set
hostcmd <txpwrlimit_cfg.conf> txpwrlimit_5g_cfg_set
tx_data_pause [ENABLE][TX_BUF_CNT]
vhtcfg <j> <k> [l] [m] [n] [o]
dfstesting [<user_cac_pd> <user_nop_pd> <no_chan_change> <fixed_chan_num><cac_restart>]
cscount [<channel_switch_count>]
mgmtframectrl [MASK]
-------------------------------------------------------------------
The following commands can be issued individually for debug purpose
-------------------------------------------------------------------
sys_cfg_ap_mac_address [AP_MAC_ADDRESS]
sys_cfg_ssid [SSID]
sys_cfg_beacon_period [BEACON_PERIOD]
sys_cfg_dtim_period [DTIM_PERIOD]
sys_cfg_channel [CHANNEL] [MODE]
sys_cfg_channel_ext [CHANNEL] [BAND] [MODE]
sys_cfg_scan_channels [CHANNEL[.BAND]]
sys_cfg_rates [RATES]
sys_cfg_rates_ext [rates RATES] [mbrate RATE]
sys_cfg_tx_power [TX_POWER]
sys_cfg_bcast_ssid_ctl [0|1|2]
sys_cfg_preamble_ctl
sys_cfg_bss_status
sys_cfg_antenna_ctl <ANTENNA> [MODE]
sys_cfg_rts_threshold [RTS_THRESHOLD]
sys_cfg_frag_threshold [FRAG_THRESHOLD]
sys_cfg_rsn_replay_prot [1|0]
sys_cfg_tx_beacon_rate [TX_BEACON_RATE]
sys_cfg_mcbc_data_rate [MCBC_DATA_RATE]
sys_cfg_pkt_fwd_ctl [PKT_FWD_CTRL]
sys_cfg_sta_ageout_timer [STA_AGEOUT_TIMER]
sys_cfg_ps_sta_ageout_timer [PS_STA_AGEOUT_TIMER]
sys_cfg_auth [AUTH_MODE]
sys_cfg_protocol [PROTOCOL] [AKM_SUITE]
sys_cfg_pmf [MFPC] [MFPR]
sys_cfg_wep_key [INDEX ISDEFAULT KEY] (use of WEP/TKIP is not recommended anymore)
sys_cfg_cipher [PAIRWISE_CIPHER GROUP_CIPHER]
sys_cfg_pwk_cipher [<PROTOCOL>] [PAIRWISE_CIPHER]
sys_cfg_gwk_cipher [GROUP_CIPHER]
sys_cfg_group_rekey_timer [GROUP_REKEY_TIMER]
sys_cfg_wpa_passphrase [PASSPHRASE]
sys_cfg_max_sta_num [STA_NUM]
sys_cfg_retry_limit [RETRY_LIMIT]
sys_cfg_sticky_tim_config [ENABLE] [<DURATION> <STICKY_BIT_MASK>]
sys_cfg_sticky_tim_sta_mac_addr [CONTROL] [STA_MAC_ADDRESS]
sys_cfg_2040_coex [ENABLE]
sys_cfg_eapol_pwk_hsk [<TIMEOUT> <RETRIES>]
sys_cfg_eapol_gwk_hsk [<TIMEOUT> <RETRIES>]
sta_filter_table <FILTERMODE> <MACADDRESS_LIST>
regrdwr <TYPE> <OFFSET> [value]
memaccess <ADDR> [value]
rdeeprom <offset> <byteCount>
cfg_data <type> [*.conf]
sys_cfg_80211d [state STATE] [country COUNTRY]
uap_stats
sys_cfg_restrict_client_mode [<ENABLE> [MODE_CONFIG]]
sys_cfg_wacp_mode [Mode]
-------------------
Details of Commands
-------------------
version
-------
"./uaputl.exe -v"
This command prints the uAP utility version information.
debug_level
-----------
"./uaputl.exe -d <debug_level>"
The supported debug_level are:
0 - no debug
1 - enable MSG_DEBUG
2 - enable all the debug
This command use to control the debug level of uaputl.exe.
Example:
./uaputl.exe -d 2 sys_config
Enable all the debug in uaputl.exe
sys_config
----------
"./uaputl.exe sys_config [CONFIG_FILE]"
This command is used to set or get the current settings of the Micro AP.
The supported options are:
CONFIG_FILE is file contain all the Micro AP settings.
empty - Get current Micro AP settings
Example:
./uaputl.exe sys_config
Get current settings of the Micro AP.
./uaputl.exe sys_config config/uaputl.conf
Load Micro AP's settings from uaputl.conf file and set.
bss_config
----------
"./uaputl.exe bss_config [CONFIG_FILE]"
This command is used to set or get the current settings of the BSS.
The supported options are:
CONFIG_FILE is file contain all the BSS settings.
empty - Get current BSS settings
Example:
./uaputl.exe bss_config
Get current settings of the BSS.
./uaputl.exe bss_config config/uaputl.conf
Load BSS settings from uaputl.conf file and set.
sys_info
--------
"./uaputl.exe sys_info"
This command returns system information such as firmware version number
and HW information.
sys_reset
---------
"./uaputl.exe sys_reset"
This command is used to reset the Micro AP back to its initial state.
For example, this can be used to recover from a serious error, or before
creating a new BSS.
This command has the following effects:
1. The WLAN hardware MAC is reset.
2. All MIB variables are initialized to their respective default
values.
3. The firmware internal variables are reset to their respective
default values.
4. The firmware state machines are reset to their respective initial
states.
bss_start
---------
"./uaputl.exe bss_start"
This command starts the BSS.
There is no error for redundant bss_start command.
bss_stop
--------
"./uaputl.exe bss_stop"
This command stops the BSS. The command causes the firmware to:
1. Deauthenticate all associated client stations.
2. Turn off the radio (hence stopping beaconing).
There is no error for redundant bss_stop command.
sta_list
--------
"./uaputl.exe sta_list"
This command returns the list of client stations that are currently
associated with the AP.
The output is formatted as shown below, for each STA:
"STA <STA_NUM> information:
==========================
MAC Address: <STA MAC address>
Power Mgmt status: active|power save
Rssi: <RSSI_VALUE>"
sta_deauth
----------
"./uaputl.exe sta_deauth <STA_MAC_ADDRESS>"
This command is used to de-authentciate a client station for any reason.
radioctrl
----------
"./uaputl.exe radioctrl [0|1]"
This command is used to set or get the radio settings.
The supported options are:
1 - Turn radio on
0 - Turn radio off
empty - Get current radio setting
txratecfg
----------
"./uaputl.exe txratecfg [l] [m] [n] [o]"
This command is used to set/get the transmit data rate.
Note:
1) Parameter [o] is optional. If [o] is not given, it will be set as 0xffff.
Where
[l] is <format>
<format> - This parameter specifies the data rate format used in this command
0: LG
1: HT
2: VHT
0xff: Auto
[m] is <index>
<index> - This parameter specifies the rate or MCS index
If <format> is 0 (LG),
0 1 Mbps
1 2 Mbps
2 5.5 Mbps
3 11 Mbps
4 6 Mbps
5 9 Mbps
6 12 Mbps
7 18 Mbps
8 24 Mbps
9 36 Mbps
10 48 Mbps
11 54 Mbps
If <format> is 1 (HT),
0 MCS0
1 MCS1
2 MCS2
3 MCS3
4 MCS4
5 MCS5
6 MCS6
7 MCS7
32 MCS32
If <format> is 2 (VHT),
0 MCS0
1 MCS1
2 MCS2
3 MCS3
4 MCS4
5 MCS5
6 MCS6
7 MCS7
8 MCS8
9 MCS9
[n] is <nss>
<nss> - This parameter specifies the NSS. It is valid only for VHT
If <format> is 2 (VHT),
1 NSS1
2 NSS2
[o] is <rate setting, only support 9098/9097/9xxx chips>
Bit0 - 1: indicate preambleType
For legacy 11b: preemble type
00 = long
01 = short
10/11 = reserved
For legacy 11g: reserved
For 11n: Green field PPDU indicator
00 = HT-mix
01 = HT-GF
10/11 = reserved.
For 11ac: reserved.
For 11ax:
00 = HE-SU
10 = HE-EXT-SU
Others are reserved
Bit 2 - 4 : indicate BW:
For HE ER:
0 = 242-tone RU
1 = upper frequency 106-tone RU within the primary 20 MHz
Otherwise:
0 = 20 MHz
1 = 40 MHz
2 = 80 MHz
3 = 160 MHz
Bit 5 -6: indicate LTF + GI size
For HT:
0 = normal
1 = Short GI
For VHT:
01 = Short GI
11 = Short GI and Nsym mod 10=9
00 = otherwise
For HE:
0 = 1xHELTF + GI0.8us
1 = 2xHELTF + GI0.8us
2 = 2xHELTF + GI1.6us
3 = 4xHELTF + GI0.8us if DCM = 0 and STBC = 0
4xHELTF + GI3.2us, otherwise.
Bit 7: Indicate STBC:
0 = no STBC
1 = STBC
Bit 8: indicate DCM:
0 = no DCM
1 = DCM
Bit 9: indicate coding:
0 = BCC
1 = LDPC
Bit 10 - 11: reserved.
Bit 12 - 13: Indicate maxPE
Max packet extension
0 - 9 usec
1 - 8 usec
2 - 16 usec.
Bit 14 - 15: reserved.
0xffff: Auto
Examples:
./uaputl.exe txratecfg 0 3 : Set fixed Tx rate to 11 Mbps
./uaputl.exe txratecfg 0 11 : Set fixed Tx rate to 54 Mbps
./uaputl.exe txratecfg 1 3 : Set fixed Tx rate to MCS3
./uaputl.exe txratecfg 2 3 2 : Set fixed Tx rate to MCS3 for NSS2
./uaputl.exe txratecfg 3 5 2 0x2282 : Set 11AX fixed Tx rate to MCS5 for NSS2, and Preamble type is 2, BW is 0, LTF + GI size 0
STBC is 1, DMC is 0, Coding is 1, maxPE is 2.
./uaputl.exe txratecfg 0xff : Disable fixed rate and uses auto rate
./uaputl.exe txratecfg : Read the current data rate setting
sys_cfg_ap_mac_address
----------------------
"./uaputl.exe sys_cfg_ap_mac_address [AP_MAC_ADDRESS]"
This command is used to set or get the AP MAC address.
If no arguments are given, this command returns the current AP MAC
address.
Otherwise, this MAC address becomes the BSSID of the infrastructure
network created by the AP.
Example:
./uaputl.exe sys_cfg_ap_mac_address 00:50:43:20:aa:bb
Set AP MAC address to 00:50:43:20:aa:bb
./uaputl.exe sys_cfg_ap_mac_address
Get AP MAC address"
sys_cfg_ssid
------------
"./uaputl.exe sys_cfg_ssid [SSID]"
This command is used to set or get the AP SSID.
If no arguments are given, this command returns the current AP SSID.
While setting, the maximum length of the SSID can be 32 characters.
Example:
./uaputl.exe sys_cfg_ssid microap
Set AP ssid to "microap"
./uaputl.exe sys_cfg_ssid
Get AP ssid
sys_cfg_beacon_period
---------------------
"./uaputl.exe sys_cfg_beacon_period [BEACON_PERIOD]"
This command is used to set or get the AP beacon period.
If no arguments are given, this command returns the current AP beacon
period.
Beacon period is represented in milliseconds.
Example:
./uaputl.exe sys_cfg_beacon_period 100
Set AP beacon period to 100 TU
./uaputl.exe sys_cfg_beacon_period
Get AP beacon period
sys_cfg_dtim_period
-------------------
"./uaputl.exe sys_cfg_dtim_period [DTIM_PERIOD]
This command is used to set or get the AP DTIM period.
If no arguments are given, this command returns the current AP DTIM
period.
Example:
./uaputl.exe sys_cfg_dtim_period 3
Set AP DTIM period to 3
./uaputl.exe sys_cfg_dtim_period
Get AP DTIM period
sys_cfg_scan_channels
---------------------
"./uaputl.exe sys_cfg_scan_channels [CHANNEL[.BAND]]"
This command is used to set or get the AP's scan channel list.
If no arguments are given, this command returns the scan channel list.
If BAND is 0, channel is set in 2.4 GHz band and if BAND is 1, channel is set to 5GHz.
Channels from only one of the bands should be specified.
Each CHANNEL.BAND pair must be separated by a space. BAND parameter is optional.
Example:
./uaputl.exe sys_cfg_scan_channels 1 11 6
Set AP scan channel list to 1 11 6
./uaputl.exe sys_cfg_scan_channels 11.0 6.0
Set AP scan channel list to 11 6
./uaputl.exe sys_cfg_scan_channels
Get AP scan channel list
./uaputl.exe sys_cfg_scan_channels 8.1 16.1 34
Set AP scan channel list to 8 16 and 34 in 5GHz band.
sys_cfg_channel
---------------
"./uaputl.exe sys_cfg_channel [CHANNEL] [MODE]"
This command is used to set or get the AP radio channel.
If no arguments are given, this command returns the current AP radio
channel.
MODE: band config mode.
Bit 0: automatic channel selection (ACS) enable/disable
Bit 1: secondary channel is above primary channel enable/disable(only allow for channel 1-7)
Bit 2: secondary channel is below primary channel enable/disable(only allow for channel 5-11)
For 'a' band channel:
Bit 1: secondary channel is above primary channel enable/disable
Bit 2: secondary channel is below primary channel enable/disable
Only following pairs of channels are valid for secondary channel setting in 5GHz band.
36, 40
44, 48
52, 56
60, 64
100, 104
108, 112
116, 120
124, 128
132, 136
149, 153
157, 161
Example:
./uaputl.exe sys_cfg_channel 6
Set AP radio channel to 6, and no secondary channel.
./uaputl.exe sys_cfg_channel 11 0
Set AP radio channel to 11 with Manual Channel Select.
./uaputl.exe sys_cfg_channel 0 1
Set AP to ACS.
./uaputl.exe sys_cfg_channel
Get AP radio channel
./uaputl.exe sys_cfg_channel 6 2
Set AP primary radio channel to 6, and secondary channel is above.
./uaputl.exe sys_cfg_channel 6 4
Set AP primary radio channel to 6, and secondary channel is below
./uaputl.exe sys_cfg_channel 0 3
Set AP to ACS mode, and secondary channel is above.
./uaputl.exe sys_cfg_channel 0 5
Set AP to ACS mode, and secondary channel is below.
./uaputl.exe sys_cfg_channel 36 2
Set AP primary radio channel to 36, and secondary channel is above.
./uaputl.exe sys_cfg_channel 40 4
Set AP primary radio channel to 40, and secondary channel is below.
sys_cfg_channel_ext
---------------
"./uaputl.exe sys_cfg_channel_ext [CHANNEL] [BAND] [MODE]"
This command is used to set or get the AP radio channel.
If no arguments are given, this command returns the current AP radio
channel.
BAND: 0 : 2.4GHz operation
1 : 5GHz operation
MODE: band config mode.
Bit 0: automatic channel selection (ACS) enable/disable
Bit 1: secondary channel is above primary channel enable/disable(only allow for channel 1-7)
Bit 2: secondary channel is below primary channel enable/disable(only allow for channel 5-11)
For 'a' band channel:
Bit 1: secondary channel is above primary channel enable/disable
Bit 2: secondary channel is below primary channel enable/disable
Only following pairs of channels are valid for secondary channel setting in 5GHz band.
36, 40
44, 48
52, 56
60, 64
100, 104
108, 112
116, 120
124, 128
132, 136
149, 153
157, 161
Example:
./uaputl.exe sys_cfg_channel_ext 6
Set AP radio channel to 6, and no secondary channel.
./uaputl.exe sys_cfg_channel_ext 11 0 0
Set AP radio channel to 11 in 2.4GHz band with Manual Channel Select.
./uaputl.exe sys_cfg_channel_ext 0 0 1
Set AP to ACS mode and 2.4GHz band.
./uaputl.exe sys_cfg_channel_ext 8 0
Set AP to channel 8 and 2.4GHz band.
./uaputl.exe sys_cfg_channel_ext 8 1
Set AP to channel 8 and 5GHz band.
./uaputl.exe sys_cfg_channel_ext 36 1
Set AP to channel 36 and 5GHZ band.
./uaputl.exe sys_cfg_channel_ext
Get AP radio channel, band and mode.
./uaputl.exe sys_cfg_channel_ext 6 0 2
Set AP primary radio channel to 6, band to 2.4GHz and secondary channel is above.
./uaputl.exe sys_cfg_channel_ext 6 0 4
Set AP primary radio channel to 6, band to 2.4GHz and secondary channel is below
./uaputl.exe sys_cfg_channel_ext 0 0 3
Set AP to ACS mode, band to 2.4GHz and secondary channel is above.
./uaputl.exe sys_cfg_channel_ext 0 0 5
Set AP to ACS mode, band to 2.4GHz and secondary channel is below.
./uaputl.exe sys_cfg_channel_ext 36 1 2
Set AP primary radio channel to 36, band to 5GHz and secondary channel is above.
./uaputl.exe sys_cfg_channel_ext 40 1 4
Set AP primary radio channel to 40, band to 5GHz and secondary channel is below.
sys_cfg_rates
-------------
"./uaputl.exe sys_cfg_rates [RATES]"
If 'Rate' provided, a 'set' is performed else a 'get' is performed
RATES is provided as a set of data rates, in unit of 500 kilobits
A rate with MSB bit is basic rate, i.e 0x82 is basic rate.
'set' will not allowed after bss start.
Valid rates: 2, 4, 11, 22, 12, 18, 24, 36, 48, 72, 96, 108
Non-Basic rates: 0x02, 0x04, 0x0b, 0x16, 0x0C, 0x12, 0x18, 0x24, 0x30, 0x48, 0x60, 0x6c
Basic rates: 0x82, 0x84, 0x8b, 0x96, 0x8C, 0x92, 0x98, 0xA4, 0xB0, 0xC8, 0xE0, 0xEc
Each rate must be separated by a space.
Example:
./uaputl.exe sys_cfg_rates 0x82 0x84 0x96 0x0c 0x12 0x18
./uaputl.exe sys_cfg_rates
sys_cfg_rates_ext
-----------------
"./uaputl.exe sys_cfg_rates_ext [rates RATES] [mbrate RATE]"
If 'Rate' provided, a 'set' is performed else a 'get' is performed.
RATES is provided as a set of data rates, in unit of 500 kilobits
A rate with MSB bit is basic rate, i.e 0x82 is basic rate.
If only operational rates is provided, MCBC rate and unicast rate will be set to auto.
Valid rates: 2, 4, 11, 13, 22, 12, 18, 24, 36, 48, 72, 96, 108
Non-Basic rates: 0x02, 0x04, 0x0b, 0x0d, 0x16, 0x0C, 0x12, 0x18, 0x24, 0x30, 0x48, 0x60, 0x6c
Basic rates: 0x82, 0x84, 0x8b, 0x96, 0x8C, 0x92, 0x98, 0xA4, 0xB0, 0xC8, 0xE0, 0xEc
Rates 2, 4, 11 and 22 (in units of 500 Kbps) must be present in either of
basic or non-basic rates. If OFDM rates are enabled then 12, 24 and 48 (in
units of 500 Kbps) must be present in either basic or non-basic rates.
Each rate must be separated by a space.
rates followed by RATES for setting operational rates.
mbrate followed by RATE for setting multicast and broadcast rate.
operational rates only allow to set before bss start.
Example:
./uaputl.exe sys_cfg_rates_ext rates 0x82 0x04 11 0x96 12 24 48 mbrate 0x16
Set AP operation rates to 0x82,0x04,11,0x96,12,24,48, multicast rate to 0x16
./uaputl.exe sys_cfg_rates_ext rates 0x82 0x04 11 0x96 12 24 48
Set AP operation rates to 0x82,0x04,11,0x96,12,24,48.
sys_cfg_tx_power
----------------
"./uaputl.exe sys_cfg_tx_power [TX_POWER]"
This command is used to set or get the AP Tx power.
If no arguments are given, this command returns the current AP Tx power.
Tx power level is represented in dBm.
Example:
./uaputl.exe sys_cfg_tx_power 13
Set AP Tx power to 13 dBm
./uaputl.exe sys_cfg_tx_power
Get AP Tx power
sys_cfg_bcast_ssid_ctl
----------------------
"./uaputl.exe sys_cfg_bcast_ssid_ctl [0|1|2]"
This command is used to set or get the SSID broadcast feature setting.
The supported options are:
0 - Disable SSID broadcast, send empty SSID (length=0) in beacon.
1 - Enable SSID broadcast
2 - Disable SSID broadcast, clear SSID (ACSII 0) in beacon, but keep the original length
empty - Get current SSID broadcast setting
When broadcast SSID is enabled, the AP responds to probe requests from
client stations that contain null SSID.
When broadcast SSID is disabled (sys_cfg_bcast_ssid_ctl = 0/2), the AP:
1. Does not respond to probe requests that contain null SSID.
2. when sys_cfg_bcast_ssid_ctl = 0, generates beacons that contain null SSID (length=0).
3. when sys_cfg_bcast_ssid_ctl = 2, clear SSID (ACSII 0) in beacon and keep the original length
Example:
./uaputl.exe sys_cfg_bcast_ssid_ctl 0
Disable SSID broadcast, send empty SSID (length=0) in beacon.
./uaputl.exe sys_cfg_bcast_ssid_ctl 1
Enable SSID broadcast
./uaputl.exe sys_cfg_bcast_ssid_ctl 2
Disable SSID broadcast, clear SSID (ACSII 0) in beacon, but keep the original length
./uaputl.exe sys_cfg_bcast_ssid_ctl
Get SSID broadcast setting
sys_cfg_preamble_ctl
--------------------
"./uaputl.exe sys_cfg_preamble_ctl"
This command is used to set/get type of preamble.
The supported options are:
Preamble: 0 - Auto/Default
1 - Short Preamble
2 - Long Preamble
Example:
./uaputl.exe sys_cfg_preamble_ctl
Get AP preamble setting
./uaputl.exe sys_cfg_premable_ctl 2
Set AP preamble setting to Long premable
sys_cfg_bss_status
--------------------
"./uaputl.exe sys_cfg_bss_status"
This command is used to get current BSS status.
Example:
./uaputl.exe sys_cfg_bss_status
Get current BSS status
sys_cfg_antenna_ctl
-------------------
"./uaputl.exe sys_cfg_antenna_ctl <ANTENNA> [MODE]"
This command is used to set or get the antenna settings.
The supported options are:
ANTENNA : 0 - Rx antenna
1 - Tx antenna
MODE : 0 - Antenna A
1 - Antenna B
empty - Get current antenna settings
Example:
./uaputl.exe sys_cfg_antenna_ctl 0 1
Set AP Rx antenna to Antenna B
./uaputl.exe sys_cfg_antenna_ctl 1
Get AP Tx antenna
sys_cfg_rts_threshold
---------------------
"./uaputl.exe sys_cfg_rts_threshold [RTS_THRESHOLD]"
This command is used to set or get the RTS threshold value.
If no arguments are given, this command returns the current RTS threshold
value.
Example:
./uaputl.exe sys_cfg_rts_threshold 2347
Set AP RTS threshold to 2347
./uaputl.exe sys_cfg_rts_threshold
Get AP RTS threshold
sys_cfg_frag_threshold