path: root/iwpriv_usage.txt (plain)
blob: 940d646c927492f1e3b8fd5d960cf483d2973dd8

1	iwpriv
2	=================
3	This is detailed explanation of each parameters for iwpriv.
4	Before reading this document, make sure you already read README.
5
6	-------------------------------------------------------------------------------------------------------
7	USAGE:
8	iwpriv ra0 commands val
9
10	NOTE:
11	Wireless Extension Private Handlers
12
13	where
14	[commands] [val]
15	{range}
16	----------------- -------------------------------------------------
17	wsc_conf_mode {0, 1, 2}
18	::Set WPS conf mode
19	0: WPS Disabled
20	1: Enrollee
21	2: Registrar
22
23	wsc_mode {1, 2}
24	::PIN or PBC
25	1: PIN
26	2: PBC
27
28	wsc_pin {00000000 ~ 99999999}
29	::Set Enrollee's PIN Code
30
31	wsc_ssid {0~z, 1~32 ascii characters}
32	::Set WPS AP SSID
33
34	wsc_start NULL
35	::Trigger RT2860 STA driver to do WPS process
36
37	wsc_stop NULL
38	::Stop WPS process
39
40	wsc_gen_pincode NULL
41	::Generate new PIN code
42
43	wsc_cred_count {1 ~ 8}
44	::Set count of WPS credential
45
46	wsc_cred_ssid {"idx ssid_str"}
47	::Set SSID into credtentail[idx]
48	idx: 0 ~ 7
49	ssid_str: 0~z, 1~32 ascii characters
50
51	wsc_cred_auth {"idx auth_str"}
52	::Set AuthMode into credtentail[idx]
53	idx: 0 ~ 7
54	auth_str: OPEN, WPAPSK, WPA2PSK, SHARED, WPA, WPA2
55
56	wsc_cred_encr {"idx encr_str"}
57	::Set EncrypType into credtentail[idx]
58	idx: 0 ~ 7
59	encr_str: NONE, WEP, TKIP, AES
60
61	wsc_cred_keyIdx {"idx key_index"}
62	::Set Key Index into credtentail[idx]
63	idx: 0 ~ 7
64	key_index: 1 ~ 4
65
66	wsc_cred_key {"idx key"}
67	::Set Key into credtentail[idx]
68	idx: 0 ~ 7
69	key: ASCII string (wep_key_len(=5,13), passphrase_len(=8~63))
70	OR
71	Hex string (wep_key_len(=10,26), passphrase_len(=64))
72
73	wsc_cred_mac {"idx mac_str"}
74	::Set AP's MAC into credtentail[idx]
75	idx: 0 ~ 7
76	mac_str: xx:xx:xx:xx:xx:xx
77
78	wsc_conn_by_idx {0 ~ 7}
79	::Connect AP by credential index
80
81	wsc_auto_conn {0, 1}
82	::Set driver to re-connecting to AP or not after registration.
83	0: Disabled, driver won't re-connect to AP with new configurations.
84	1: Enabled, driver will re-connect to AP with new configurations.
85
86	wsc_ap_band {0, 1, 2}
87	::Set prefer band to do WPS with dual band WPS AP
88	0 : prefer 2.4G
89	1 : prefer 5G
90	2 : auto
91	Default value is auto (2)
92
93	-------------------------------------------------------------------------------------------------------
94	USAGE:
95	iwpriv ra0 set [parameters]=[val]
96
97	NOTE:
98	Execute one iwpriv/set command simultaneously.
99
100	where
101	[parameters] [val]
102	{range}
103	----------------- -------------------------------------------------
104	CountryRegion {0~7}
105	::Set country region
106	0: 1 ~ 11 ch
107	1: 1 ~ 13 ch
108	2: 10, 11 ch
109	3: 10 ~ 13 ch
110	4: 14 ch
111	5: 1 ~ 14 ch
112	6: 3 ~ 9 ch
113	7: 5 ~ 13 ch
114	31: 1 ~ 14 ch (ch1-11:active scan, ch12-14 passive scan)
115
116	CountryRegionABand {0~11}
117	::Set country region for A band
118	0: 36, 40, 44, 48, 52, 56, 60, 64, 149, 153, 157, 161, 165 ch
119	1: 36, 40, 44, 48, 52, 56, 60, 64, 100, 104, 108, 112, 116, 120, 124, 128, 132, 136, 140 ch
120	2: 36, 40, 44, 48, 52, 56, 60, 64 ch
121	3: 52, 56, 60, 64, 149, 153, 157, 161 ch
122	4: 149, 153, 157, 161, 165 ch
123	5: 149, 153, 157, 161 ch
124	6: 36, 40, 44, 48 ch
125	7: 36, 40, 44, 48, 52, 56, 60, 64, 100, 104, 108, 112, 116, 120, 124, 128, 132, 136, 140, 149, 153, 157, 161, 165 ch
126	8: 52, 56, 60, 64 ch
127	9: 36, 40, 44, 48, 52, 56, 60, 64, 100, 104, 108, 112, 116, 132, 136, 140, 149, 153, 157, 161, 165 ch
128	10: 36, 40, 44, 48, 149, 153, 157, 161, 165 ch
129	11: 36, 40, 44, 48, 52, 56, 60, 64, 100, 104, 108, 112, 116, 120, 149, 153, 157, 161 ch
130
131	SSID {0~z, 1~32 ascii characters}
132	::Set AP SSID
133
134	WirelessMode {0~10}
135	::Set Wireless Mode
136	0: legacy 11b/g mixed
137	1: legacy 11B only
138	2: legacy 11A only
139	3: legacy 11a/b/g mixed
140	4: legacy 11G only
141	5: 11ABGN mixed
142	6: 11N only
143	7: 11GN mixed
144	8: 11AN mixed
145	9: 11BGN mixed
146	10: 11AGN mixed
147
148	Channel depends on CountryRegion or CountryRegionForABand
149	::Set Channel
150
151	BGProtection {0~2}
152	::Set 11B/11G Protection
153	0:Auto,
154	1:Always on,
155	2:Always off
156
157	TxPreamble {0~2}
158	::Set TxPreamble
159	0:Preamble Long,
160	1:Preamble Short,
161	2:Auto
162
163	RTSThreshold {1~2347}
164	::Set RTS Threshold
165
166	FragThreshold {256~2346}
167	::Set Fragment Threshold
168
169	TxBurst {0,1}
170	::Set TxBurst Enable or Disable
171	0:Disable,
172	1:Enable
173
174	NetworkType {Infra,Adhoc}
175	::Set Network type
176
177	AuthMode {OPEN,SHARED,WEPAUTO,WPAPSK,WPA2PSK,WPANONE}
178	::Set Authentication Mode
179
180	EncrypType {NONE,WEP,TKIP,AES}
181	::Set Encryption Type
182
183	DefaultKeyID {1~4}
184	::Set Default Key ID
185
186
187	Key1 {5 ascii characters or 10 hex number or
188	13 ascii characters or 26 hex numbers}
189	::Set Key1 String
190
191	Key2 {5 ascii characters or 10 hex number or
192	13 ascii characters or 26 hex numbers}
193	::Set Key2 String
194
195	Key3 {5 ascii characters or 10 hex number or
196	13 ascii characters or 26 hex numbers}
197	::Set Key3 String
198
199	Key4 {5 ascii characters or 10 hex number or
200	13 ascii characters or 26 hex numbers}
201	::Set Key4 String
202
203	WPAPSK {8~63 ascii or 64 hex characters}
204	::WPA Pre-Shared Key
205
206	WmmCapable {0,1}
207	::Set WMM Capable
208	0:Disable WMM,
209	1:Enable WMM
210
211	PSMode {CAM, MAX_PSP, FAST_PSP}
212	::Set Power Saving Mode
213
214	HtBw {0,1}
215	::Set BandWidth
216	0: 20Hz
217	1: 40Hz
218
219	HtMcs {0 ~ 15, 33}
220	::Set MCS
221	33: Auto Rate
222
223	HtGi {0,1}
224	::Set Guard Interval(GI)
225	0: long GI
226	1: short GI
227
228	HtOpMode {0,1}
229	::Set HT Operation Mode
230	0: HT mixed format
231	1: HT greenfield format
232
233	HtExtcha {0,1}
234	::Set Extended Channel Switch Announcement
235	0: Below
236	1: Above
237
238	HtMpduDensity {0 ~ 7}
239	::Set The Minimum Time Between MPDUs within an AMPDU
240
241	HtBaWinSize {1 ~ 64}
242	::Set BA WinSize
243
244	HtRdg {0,1}
245	::Set RDG Capable
246	0: Disabled
247	1: Enabled
248
249	HtAmsdu {0,1}
250	::Set AMSDU Capable
251	0: Disabled
252	1: Enabled
253
254	HtAutoBa {0,1}
255	::Set Auto BA Capable
256	0: Disabled
257	1: Enabled
258
259	HtBaDecline {0,1}
260	::Reject BA request from AP
261	0: Disabled
262	1: Enabled
263
264	HtProtect {0,1}
265	::Set HT Protect Capable
266	0: Disabled
267	1: Enabled
268
269	FixedTxMode {CCK, OFDM}
270	:: Set Fixed Tx Mode for fixed rate setting
271	Mode = CCK
272	MCS = 0 => 1Mbps
273	= 1 => 2Mbps
274	= 2 => 5.5 Mbps
275	= 3 => 11 Mbps
276	Mode = OFDM
277	MCS = 0 => 6Mbps
278	= 1 => 9Mbps
279	= 2 => 12Mbps
280	= 3 => 18Mbps
281	= 4 => 24Mbps
282	= 5 => 36Mbps
283	= 6 => 48Mbps
284	= 7 => 54Mbps
285
286	==> Build Ethernet Convert function. Please set 'HAS_ETH_CONVERT_SUPPORT=y' in os/linux/config.mk
287	EthConvertMode {dongle, clone, hybrid}
288	::Set Ethernet Convert Mode
289
290	EthCloneMac {xx:xx:xx:xx:xx:xx}
291	:: Set Clone MAC
292
293	LongRetry {0,255}
294	:: Set Tx Long Retry Limit
295
296	ShortRetry {0,255}
297	:: Set Tx Short Retry Limit
298
299	MeshId {Length 1~32 ascii characters}
300	:: Set Mesh ID
301
302	MeshHostName {Length 1~32 ascii characters}
303	:: Set Mesh Host Name
304
305	MeshAutoLink {1,0}
306	:: Set Mesh Auto Link Capable
307	0: Disabled
308	1: Enabled
309
310	MeshAddLink {xx:xx:xx:xx:xx:xx}
311	:: Add Mesh Link
312
313	MeshDelLink {xx:xx:xx:xx:xx:xx}
314	:: Delete Mesh Link
315
316	MeshMultiCastAgeOut {20 ~ 65535 seconds}
317	:: Set AgeOut time for Mesh MultiCast
318
319	MeshAuthMode {OPEN, WPANONE}
320	:: Set Mesh Authentication Mode
321
322	MeshEncrypType {NONE, WEP, TKIP, AES}
323	:: Set Mesh Encryption Type
324
325	MeshDefaultkey {1 ~ 4}
326	:: Set Mesh Default Key ID
327
328	MeshWEPKEY {5 ascii characters or 10 hex number or
329	13 ascii characters or 26 hex numbers}
330	:: Set Mesh WEP Key String
331
332	MeshWPAKEY {8~63 ascii or 64 hex characters}
333	:: Set Mesh WPA Pre-Shared Key
334
335	Examples
336	===================================================================
337	-------------------------------------------------------------------------------------------------------
338	a> Config STA to link with AP which is OPEN/NONE(Authentication/Encryption)
339	1. iwpriv ra0 set NetworkType=Infra
340	2. iwpriv ra0 set AuthMode=OPEN
341	3. iwpriv ra0 set EncrypType=NONE
342	4. iwpriv ra0 set SSID="AP's SSID"
343
344	b> Config STA to link with AP which is SHARED/WEP(Authentication/Encryption)
345	1. iwpriv ra0 set NetworkType=Infra
346	2. iwpriv ra0 set AuthMode=SHARED
347	3. iwpriv ra0 set EncrypType=WEP
348	4. iwpriv ra0 set DefaultKeyID=1
349	5. iwpriv ra0 set Key1="AP's wep key"
350	6. iwpriv ra0 set SSID="AP's SSID"
351
352	c> Config STA to link with AP which is WPAPSK/TKIP(Authentication/Encryption)
353	1. iwpriv ra0 set NetworkType=Infra
354	2. iwpriv ra0 set AuthMode=WPAPSK
355	3. iwpriv ra0 set EncrypType=TKIP
356	4. iwpriv ra0 set SSID="AP's SSID"
357	5. iwpriv ra0 set WPAPSK="AP's wpa-preshared key"
358	6. iwpriv ra0 set SSID="AP's SSID"
359
360	d> Config STA to link with AP which is WPAPSK/AES(Authentication/Encryption)
361	1. iwpriv ra0 set NetworkType=Infra
362	2. iwpriv ra0 set AuthMode=WPAPSK
363	3. iwpriv ra0 set EncrypType=AES
364	4. iwpriv ra0 set SSID="AP's SSID"
365	5. iwpriv ra0 set WPAPSK="AP's wpa-preshared key"
366	6. iwpriv ra0 set SSID="AP's SSID"
367
368	e> Config STA to link with AP which is WPA2PSK/TKIP(Authentication/Encryption)
369	1. iwpriv ra0 set NetworkType=Infra
370	2. iwpriv ra0 set AuthMode=WPA2PSK
371	3. iwpriv ra0 set EncrypType=TKIP
372	4. iwpriv ra0 set SSID="AP's SSID"
373	5. iwpriv ra0 set WPAPSK=12345678
374	6. iwpriv ra0 set SSID="AP's SSID"
375
376	f> Config STA to create/link as adhoc mode, which is OPEN/NONE(Authentication/Encryption)
377	1. iwpriv ra0 set NetworkType=Adhoc
378	2. iwpriv ra0 set AuthMode=OPEN
379	3. iwpriv ra0 set EncrypType=NONE
380	4. iwpriv ra0 set SSID="Adhoc's SSID"
381
382	g> Config STA to create/link as adhoc mode, which is WPANONE/TKIP(Authentication/Encryption)
383	1. iwpriv ra0 set NetworkType=Adhoc
384	2. iwpriv ra0 set AuthMode=WPANONE
385	3. iwpriv ra0 set EncrypType=TKIP
386	4. iwpriv ra0 set SSID="AP's SSID"
387	5. iwpriv ra0 set WPAPSK=12345678
388	6. iwpriv ra0 set SSID="AP's SSID"
389
390	h> Get site survey
391	usage: iwpriv ra0 get_site_survey
392
393	i> Get Statistics
394	usage: iwpriv ra0 stat ; read statistic counter
395	iwpriv ra0 set ResetCounter=0 ; reset statistic counter
396
397	j> Link with an AP which is the largest strength ; set ANY SSID (ssidLen=0)
398	usage: iwconfig ra0 essid ""
399	or
400	usage: iwpriv ra0 set SSID=""
401
402	k> Config STA to link as dongle mode with STA own MAC
403	usage: iwpriv ra0 set EthConvertMode=dongle
404
405	l> Config STA to link as clone mode
406	usage: iwpriv ra0 set EthConvertMode=clone
407	iwpriv ra0 set EthCloneMac="Desired MAC" ;; 00:00:00:00:00:00 means using STA own MAC
408	;; FF:FF:FF:FF:FF:FF means using source MAC of first packet coming from wired device
409
410	m> Config STA to link as hybrid(dongle+clone) mode
411	usage: iwpriv ra0 set EthConvertMode=hybrid
412	iwpriv ra0 set EthCloneMac="Desired MAC" ;; 00:00:00:00:00:00 means using STA own MAC
413	;; FF:FF:FF:FF:FF:FF means using source MAC of first packet coming from wired device
414
415	===================================================================
416
417	iwlist
418	=================
419	This is detailed explanation of each parameters for iwlist.
420
421	-------------------------------------------------------------------------------------------------------
422	iwlist ra0 scanning ; list the results after scanning(manual rescan)
423
424
425
426	=======================================================================================================
427
428	iwconfig
429	=================
430	The following are our support in standard configuration - iwconfig
431
432	-------------------------------------------------------------------------------------------------------
433	iwconfig ra0 essid {NN|on|off} ; set essid
434	iwconfig ra0 mode {managed|ad-hoc|...} ; set wireless mode
435	>> rt2860sta driver support monitor mode with linux kernel > 2.4.20.
436	>> Note: For using monitor mode => if mesh interface is ON, please down the mesh interface first.
437	iwconfig ra0 freq N.NNNN[k|M|G]] ; set frequency
438	iwconfig ra0 channel N ; set channel
439	iwconfig ra0 ap {N|off|auto} ; set AP address
440	iwconfig ra0 nick N ; set nickname
441	iwconfig ra0 rate {N|auto|fixed} ; set rate (only support legacy rate setting)
442	iwconfig ra0 rts {N|auto|fixed|off} ; set RTS threshold
443	iwconfig ra0 frag {N|auto|fixed|off} ; set Fragment threshold
444	iwconfig ra0 enc {NNNN-NNNN|off} ; set encryption type
445	iwconfig ra0 power {period N|timeout N} ; set power management modes
446
447	*** Wireless extension usage please refer to man page of 'iwconfig', 'iwlist' and 'iwpriv'. ***
448