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 / readme
blob8093ec71d5a8f53ac842038af69756134169af4b
1 * README\r
2 *\r
3 * Ralink Tech Inc.\r
4 *\r
5 * http://www.ralinktech.com\r
6 *\r
7 \r
8 =======================================================================\r
9 ModelName:\r
10 ===========\r
11 RT2500\r
14 =======================================================================\r
15 Supporting Kernel:\r
16 ===================\r
17 linux kernel 2.4 and 2.6 series.\r
18 Tested in Redhat 7.3 or later, Fedora Core 1, Suse 8.0,8.1,9.0, Mandrake 9.0->10.0, Slackware 9.0,9.1\r
22 =======================================================================\r
23 Description:\r
24 =============\r
25 This is a linux device driver for Ralink RT2500 b/g WLAN Card.\r
29 =======================================================================\r
30 Contents:\r
31 =============\r
32 ./2.4.x                 : Makefile for kernel 2.4 series\r
33 ./2.6.x                 : Makefile for kernel 2.6 series\r
34 *.c                     : c files\r
35 *.h                     : header files\r
36 Makefile.BigEndian      : Makefile for big endian platform\r
40 =======================================================================\r
41 Features:\r
42 ==========\r
43    This driver implements basic IEEE802.11. Infrastructure and adhoc mode with open or shared or WPA\r
44    authentication method. WEP-40 and WEP-104 TKIP and AES encryption,\r
48 =======================================================================\r
49 Build Instructions:\r
50 ====================\r
51 For 2.4 series kernel:\r
52 a. $tar -xvzf RT2500-Linux-STA-x.x.x.x.tar.gz\r
53     go to "./RT2500-Linux-STA-x.x.x.x/Module" directory.\r
55 b. Use 'chmod 755' command to change access right of following script files :\r
56    'load', 'unload', 'Configure'\r
58 c. run 'cp ./2.4.x/Makefile .' and 'cp ./2.4.x/load .'\r
60 d. $make config         # config build linux os version\r
62 e. $make all            # compile driver source code\r
64 f. $load                # load/insmod module(rt2500.o)\r
66 Note: Script functionality:\r
67 load            load module to kernel\r
68 unload          unload module from kernel\r
69 Configure       retrieve linux version\r
72 For 2.6 series kernel:\r
73 a.  run 'cd STA/Module'\r
74         'cp ./2.6.x/Makefile .'\r
75         'cp ./2.6.x/load .'\r
77 b.  $make -C /path/to/source SUBDIRS=$PWD modules\r
78     Where /path/to/source is the path to the source directory for the (configured and built) target kernel.\r
80 c.  run '/sbin/insmod rt2500.ko'  (as root)\r
81         '/sbin/ifconfig ra0 inet YOUR_IP up'\r
84 For big endian platform:\r
85 a.  replace Makefile with Makefile.BigEndian\r
89 =======================================================================\r
90 To BUILD UTILITY\r
91 ====================\r
93 a.  go to the "./Utility" directory\r
95 b.  run 'qmake -o Makefile raconfig2500.pro'\r
96     If qmake command is not found in your system, you can download the QT tool\r
97     'qt-x11-free-3.2.1' or later at\r
98     http://www.trolltech.com/\r
100     (qmake comes with RedHat 7.3 or later QT Package)\r
102 c.  run 'make" to compile the utility source code.\r
104 d.  After all, an execution file would be generated "RaConfig2500"\r
105     run "RaConfig2500" to config the driver as you want\r
109 =======================================================================\r
110 CONFIGURATION:\r
111 ====================\r
112 RT2500 driver can be configured via following interfaces,\r
113 i.e. (i)"iwconfig" command, (ii)"iwpriv" command, (iii) configuration file, (iv) RaConfig2500\r
115 i)  iwconfig comes with kernel.\r
116 ii) iwpriv usage, please refer to file "iwpriv_usage.txt" for details.\r
117 iii)copy configuration file "RT2500STA.dat" to /etc/Wireless/RT2500STA/RT2500STA.dat.\r
118     Please refer to 3.1) for details.\r
119 iv) RT2500 provides API : RaConfig2500, please go to directory ./Utility and refer to how-to-compile.txt\r
122 Configuration File : RT2500STA.dat\r
124 # Copy this file to /etc/Wireless/RT2500STA/RT2500STA.dat\r
125 # This file is a binary file and will be read on loading rt2500.o module.\r
127 # Use "vi -b RT2500STA.dat" to modify settings according to your need.\r
129 # 1.) set NetworkType to "Adhoc" for using Adhoc-mode, otherwise using as Infrastructure-mode\r
130 # 2.) set Channel to "0" for auto-select on Infrastructure mode\r
131 # 3.) set SSID for connecting to your Accss-point.\r
132 # 4.) AuthMode can be "OPEN", "SHARED", "AUTO", "WPAPSK", "WPANONE"\r
133 # 5.) EncrypType can be "NONE", "WEP", "TKIP", "AES"\r
134 # for more information refer to the Readme file.\r
136 [Default]\r
137 CountryRegion=0\r
138 WirelessMode=0\r
139 SSID=AP350\r
140 NetworkType=Infra\r
141 Channel=0\r
142 AuthMode=OPEN\r
143 EncrypType=NONE\r
144 DefaultKeyID=1\r
145 Key1Type=0\r
146 Key1Str=0123456789\r
147 Key2Type=0\r
148 Key2Str=\r
149 Key3Type=0\r
150 Key3Str=\r
151 Key4Type=0\r
152 Key4Str=\r
153 WPAPSK=abcdefghijklmnopqrstuvwxyz\r
154 TXBurst=0\r
155 TurboRate=0\r
156 BGProtection=0\r
157 ShortSlot=0\r
158 TxRate=0\r
159 RTSThreshold=2312\r
160 FragThreshold=2312\r
161 PSMode=CAM\r
162 -----------------------------------------------\r
163 syntax is 'Param'='Value' and describes below.\r
165 1. CountryRegion=value\r
166    value\r
167         0:      for use channel 1-11\r
168         1:      for use channel 1-11\r
169         2:      for use channel 1-13\r
170         3:      for use channel 10-11\r
171         4:      for use channel 10-13\r
172         5:      for use channel 14\r
173         6:      for use channel 1-14\r
174         7:      for use channel 3-9\r
175 2. WirelessMode=value\r
176    value\r
177         0:      802.11 B/G mixed\r
178         1:      802.11 B only\r
179 3. SSID=value\r
180    value\r
181          1~32 ascii characters.\r
182 4. NetworkType=Infra\r
183    value\r
184        Infra : infrastructure mode\r
185        Adhoc : adhoc mode\r
186 5. Channel=value\r
187     value\r
188         1~14 depends on  CountryRegion\r
189 6. AuthMode=value\r
190     value\r
191         OPEN      For Open System\r
192         SHARED    For Shared key system\r
193         AUTO\r
194         WPAPSK\r
195 7. EncrypType=value\r
196     value\r
197         NONE      :For AuthMode=OPEN\r
198         WEP       :For AuthMode=OPEN or AuthMode=SHARED\r
199         TKIP      :For AuthMode=WPAPSK\r
200         AES       :For AuthMode=WPAPSK\r
201 8. DefaultKeyID=value\r
202     value\r
203         1 ~ 4\r
204 9. Key1Type=value\r
205     value\r
206         0:        Hexadecimal\r
207         1:        Ascii\r
208 10. Key1Str=value\r
209     value\r
210         10 or 26 hexadecimal characters eg: 012345678\r
211         5 or 13 ascii characters eg: passd\r
212 11. Key2Type=value\r
213     value\r
214         0:        Hexadecimal\r
215         1:        Ascii\r
216 12. Key2Str=value\r
217     value\r
218         10 or 26 hexadecimal characters eg: 012345678\r
219         5 or 13 ascii characters eg: passd\r
220 13. Key3Type=value\r
221     value\r
222         0:        Hexadecimal\r
223         1:        Ascii\r
224 14. Key3Str=value\r
225     value\r
226         10 or 26 hexadecimal characters eg: 012345678\r
227         5 or 13 ascii characters eg: passd\r
228 15. Key4Type=value\r
229     value\r
230         0:        Hexadecimal\r
231         1:        Ascii\r
232 16. Key4Str=value\r
233     value\r
234         10 or 26 hexadecimal characters eg: 012345678\r
235         5 or 13 ascii characters eg: passd\r
236 17. WPAPSK=value\r
237     value\r
238         8 ~ 63 characters\r
239           or\r
240         64 hexadecimal characters\r
241 18. TxBurst=value\r
242     value\r
243         0:        Disable\r
244         1:        Enable\r
245 19. TurboRate=value\r
246     value\r
247         0:        Disable\r
248         1:        Enable\r
249 20. BGProtection=value\r
250    value\r
251         0:        Auto\r
252         1:        Always On\r
253         2:        Always Off\r
254 21. ShortSlot=value\r
255     value\r
256         0:        Disable\r
257         1:        Enable\r
258 22. TxRate=value\r
259    value\r
260          0:     Auto\r
261          1:     1 Mbps\r
262          2:     2 Mbps\r
263          3:     5.5 Mbps\r
264          4:     11 Mbps\r
265          5:     6  Mbps  //WirelessMode must be 0\r
266          6:     9  Mbps  //WirelessMode must be 0\r
267          7:     12 Mbps  //WirelessMode must be 0\r
268          8:     18 Mbps  //WirelessMode must be 0\r
269          9:     24 Mbps  //WirelessMode must be 0\r
270         10:     36 Mbps  //WirelessMode must be 0\r
271         11:     48 Mbps  //WirelessMode must be 0\r
272         12:     54 Mbps  //WirelessMode must be 0\r
273 23. RTSThreshold=value\r
274     value\r
275         1 ~ 2312\r
276 24. FragThreshold=value\r
277     value\r
278         256 ~ 2312\r
279 25. PSMode=value\r
280     value\r
281     MAX_PSP   Power Saving Mode\r
282     CAM   CAM (Constantly Awake Mode)\r
284 26. AdhocOfdm=value\r
285     value\r
286     0:          Adhere WIFI spec, the Tx MAX rate will be 11Mbps in Adhoc mode\r
287     1:          Violate WIFI spec, the Tx MAX rate will be 54Mbps in Adhoc mode\r
289 27. StaWithEtherBridge=value\r
290     value\r
291     0:          Disable sta with ethernet to wireless bridge\r
292     1:          Enable sta with ethernet to wireless bridge\r
295 MORE INFORMATION\r
296 =================================================================================\r
297 If you want for rt2500 driver to auto-load at boot time:\r
298 A) choose ra0 for first RT2500 WLAN card, ra1 for second RT2500 WLAN card, etc.\r
300 B) create(edit) 'ifcfg-ra0' file in /etc/sysconfig/network-scripts/,\r
301    edit( or add the line) in /etc/modules.conf:\r
302        alias ra0 rt2500\r
304 C) edit(create) the file /etc/sysconfig/network-scripts/ifcfg-ra0\r
305    DEVICE='ra0'\r
306    ONBOOT='yes'\r
309 NOTE:\r
310    if you use dhcp, add this line too .\r
311     BOOTPROTO='dhcp'\r
313 *D) To ease the Default Gateway setting,\r
314     add the line\r
315     GATEWAY=x.x.x.x\r
316     in /etc/sysconfig/network\r
319 ==================================================================================\r
320 = To install a device driver for Ralink RT2500 b/g WLAN card in AMD64 SUSE Linux =\r
321 ==================================================================================\r
322 A.\r
323 1.Edit(or add the line) in /etc/modules.conf\r
324    alias ra0 rt2500\r
325 2.Create and edit 'ifcfg-ra0' file in /etc/sysconfig/network/\r
326    DEVICE='ra0'\r
327    ONBOOT='yes'\r
328    BOOTPROTO='dhcp'\r
330 B. $tar -xvzf RT2500--Linux-STA-x.x.x.x.tar.gz\r
331    Go to "./RT2500-Linux-STA-x.x.x.x/Module" directory\r
333 1.Copy ./Module/2.6.x/Makefile to "./Module" directory\r
334 2.$make -C /usr/src/linux-2.6.8-gentoo-r3 SUBDIRS=$PWD modules\r
335         where linux-2.6.8-gentoo-r3 is your 2.6 kernel name\r
336 3.$insmod rt2500.ko\r
337 4.$ifconfig ra0 up\r
338 5.$iwconfig ra0 essid any\r
339 6.$dhcpcd ra0&\r
340 7.$dhcpcd ra0\r
342 Now it should be functional - type\r
343 $iwconfig\r
344 to confirm setting\r
346 C.Activate it on startup with a script.\r
347 1.Input your script file 'wlancfg' in /etc/init.d/\r
348 2.Start applicaiton YaST in System, choose system -> runlevel editor\r
349 3.In expert mode, enable 'wlancfg' in runlevel 5.\r