MOXA linux-2.6.x / linux-2.6.9-uc0 from sdlinux-moxaart.tgz
[linux-2.6.9-moxart.git] / drivers / net / wireless / rtlink / Module / iwpriv_usage.txt
blobd9ff0e7a00f7c9c0c758ada596a40c23b76a89b2
1 iwpriv\r
2 =================\r
3 This is detailed explanation of each parameters for iwpriv.\r
4 Before reading this document, make sure you already read README.\r
5 \r
6 -------------------------------------------------------------------------------------------------------\r
7 USAGE:\r
8         iwpriv ra0 set [parameters]=[val]\r
9 \r
10 where\r
12 [parameters]          [val] range                          explaination\r
13 -----------------   -----------------------              ---------------------------------------------\r
14 CountryRegion       {0~7}                                  Set country region \r
15                                                            0: use 1 ~ 11 Channel\r
16                                                            1: use 1 ~ 11 Channel\r
17                                                            2: use 1 ~ 13 Channel\r
18                                                            3: use 10, 11 Channel\r
19                                                            4: use 10 ~ 13 Channel\r
20                                                            5: use 14 Channel\r
21                                                            6: use 1 ~ 14 Channel\r
22                                                            7: use 3 ~ 9 Channel\r
23                                                            \r
24 SSID                {0~z, less than 32 characters}         Set SoftAP SSID\r
26 WirelessMode        {0~2}                                  Set Wireless Mode \r
27                                                            0:11b/g mixed, 1:11B only\r
29 TxRate              {0~12}                                 Set TxRate \r
30                                                            0:Auto, 1:1Mbps, 2:2Mbps, 3:5.5Mbps, 4:11Mbps, \r
31                                                            5:6Mbps, 6:9Mbps, 7:12Mbps, 8:18Mbps, 9:24Mbps, \r
32                                                            10:36Mbps, 11:48Mbps, 12:54Mbps\r
33                                                            \r
34 Channel             {1~14} depends on country region       Set Channel\r
36 BGProtection        {0~2}                                  Set 11B/11G Protection\r
37                                                            0:Auto, 1:Always on, 2:Always off\r
39 TxPreamble          {0~2}                                  Set TxPreamble\r
40                                                            0:Preamble Long, 1:Preamble Short, 2:Auto\r
42 RTSThreshold        {1~2347}                               Set RTS Threshold                                                           \r
43                                                            \r
44 FragThreshold       {256~2346}                             Set Fragment Threshold\r
46 TxBurst             {0,1}                                  Set TxBurst Enable or Disable\r
47                                                            0:Disable, 1:Enable\r
49 TurboRate           {0,1}                                  Set TurboRate Enable or Disable\r
50                                                            0:Disable, 1:Enable\r
52 AdhocModeRate       {0, 1}                                 Set Adhoc mode tx rate\r
53                                                            0: adhere WIFI spec., 1: violate WIFI spec.\r
54                                                            (802.11g WIFI spec disallow OFDM rates in 802.11g ADHOC mode)\r
56 NetworkType         {Infra,Adhoc}                          Set Network type\r
57                                                                                                                                                                                                                   \r
58 AuthMode            {OPEN,SHARED,WPAPSK}                   Set Authentication mode\r
60 EncrypType          {NONE,WEP,TKIP,AES}                    Set Encryption Type\r
62 DefaultKeyID        {1~4}                                  Set Default Key ID\r
64 Key1                 {5 ascii characters or                 Set Key1 String\r
65                      10 hex number or \r
66                      13 ascii characters or \r
67                      26 hex numbers}                                                                                                                        \r
69 Key2                 {5 ascii characters or                 Set Key2 String\r
70                      10 hex number or \r
71                      13 ascii characters or \r
72                      26 hex numbers}                                                                                                                        \r
74 Key3                 {5 ascii characters or                 Set Key3 String\r
75                      10 hex number or \r
76                      13 ascii characters or \r
77                      26 hex numbers}                                                                                                                        \r
79 Key4                 {5 ascii characters or                 Set Key4 String\r
80                      10 hex number or \r
81                      13 ascii characters or \r
82                      26 hex numbers}                                                                                                                        \r
84                                                           \r
85 WPAPSK              {8~63 ASCII or 64 HEX characters}       WPA Pre-Shared Key \r
87 ApClient            {0,1}                                   Set ApClient mode\r
88                                                             0:Disable, 1:Enable\r
91 Examples\r
92 ===================================================================\r
93 -------------------------------------------------------------------------------------------------------\r
94 Example I: Config STA to link with AP which is OPEN/NONE(Authentication/Encryption)\r
95         1. iwpriv ra0 set NetworkType=Infra\r
96         2. iwpriv ra0 set AuthMode=OPEN\r
97         3. iwpriv ra0 set EncrypType=NONE\r
98         4. iwpriv ra0 set SSID="AP's SSID"\r
99         \r
100 Example II: Config STA to link with AP which is SHARED/WEP(Authentication/Encryption)\r
101         1. iwpriv ra0 set NetworkType=Infra\r
102         2. iwpriv ra0 set AuthMode=SHARED\r
103         3. iwpriv ra0 set EncrypType=WEP\r
104         4. iwpriv ra0 set Key1="AP's wep key"\r
105         5. iwpriv ra0 set DefaultKeyID=1\r
106         6. iwpriv ra0 set SSID="AP's SSID"\r
107         \r
108 Example III: Config STA to link with AP which is WPAPSK/TKIP(Authentication/Encryption)\r
109         1. iwpriv ra0 set NetworkType=Infra\r
110         2. iwpriv ra0 set AuthMode=WPAPSK\r
111         3. iwpriv ra0 set EncrypType=TKIP\r
112         4. iwpriv ra0 set SSID="AP's SSID"\r
113         5. iwpriv ra0 set WPAPSK="AP's wpa-preshared key"\r
114         6. iwpriv ra0 set SSID="AP's SSID"\r
115         \r
116 Example IV: Config STA to link with AP which is WPAPSK/AES(Authentication/Encryption)\r
117         1. iwpriv ra0 set NetworkType=Infra\r
118         2. iwpriv ra0 set AuthMode=WPAPSK\r
119         3. iwpriv ra0 set EncrypType=AES\r
120         4. iwpriv ra0 set SSID="AP's SSID"\r
121         5. iwpriv ra0 set WPAPSK="AP's wpa-preshared key"\r
122         6. iwpriv ra0 set SSID="AP's SSID"\r
123         \r
124 Example V: Config STA to create/link as adhoc mode\r
125         1. iwpriv ra0 set NetworkType=Adhoc\r
126         2. iwpriv ra0 set AuthMode=OPEN\r
127         3. iwpriv ra0 set EncrypType=NONE\r
128         4. iwpriv ra0 set SSID="Adhoc's SSID"\r
132 iwlist\r
133 =================\r
134 This is detailed explanation of each parameters for iwlist.\r
136 -------------------------------------------------------------------------------------------------------\r
138 iwlist ra0 scanning             ; list the result after scanning(site survey)\r