svn-1273
[orinoco_usb.git] / drivers / net / wireless / README
blobb228a7fdbd0c92015dae31645afc913cda84dbc4
1 Orinoco, Spectrum24 Trilogy and Prism 2/2.5/3 wireless card driver
2 ==================================================================
4 This document is concerned only with the issues specific to the
5 standalone distribution of the Orinoco driver.  For documentation about
6 the driver itself and about the project, see README.orinoco.
9 Compatibility
10 -------------
12 Due to constant changes to the Linux kernel, the driver is meant to be
13 compatible with the kernels released approximately in the same timeframe
14 as the standalone release.  Older or newer kernels may or may not work. 
15 If the standalone driver is several months old, you are much better off
16 using the driver included with the kernel, as it would likely include
17 all the features present in this distribution.
19 At the time of this writing, the oldest supported kernel is 2.6.12. 
20 Don't even try compiling the driver against older kernels - it won't
21 work properly due to incompatibility of the build system.
24 Compiling
25 ---------
27 To compile the standalone driver, you need configured kernel sources or
28 a certain subset of it (build system, headers and .config file) for the
29 actual kernel.  Modern GNU/Linux distributions provide the necessary
30 files if you install the kernel development package.
32 Use the same compiler as the one used to compile the kernel.  At least
33 make sure that the major and the minor versions of gcc are the same.
35 CONFIG_HERMES in .config should not be set to "y" (i.e. compile into the
36 kernel), so that the standalone driver doesn't conflict with the one
37 from the kernel.  It's possible to compile the driver against a kernel
38 with CONFIG_HERMES set to "m".  In this case, the modules compiled from
39 these sources will overwrite the modules originally compiled for the
40 kernel.
42 Run "make" to compile the standalone driver.  The build system tries to
43 find the sources of the currently running kernel.  Use KERNEL_PATH
44 variable on the make command line to override this:
46   make KERNEL_PATH=/usr/local/src/linux
48 To force using a different compiler, use e.g.
50   make CC=gcc34
52 As a general rule, whatever flags are used on the "make" command line
53 should be used with "make install" as well.
56 Troubleshooting
57 ---------------
59 Due to the kernel API changes, some of the drivers may not compile for
60 your kernel.  Although the build system tries to do the right thing, you
61 may still need to edit the Kbuild file or override some of the variables
62 in it to suppress building of problematic drivers.
64 In particular, PCMCIA support is quite prone to API changes.  If you
65 have problems compiling PCMCIA drivers, but you don't actually need
66 them, add "CONFIG_PCMCIA=n" to the make command line.
69 Installation
70 ------------
72 Run "make install" as root to install the standalone driver.  Use
73 modprobe to load the driver for your hardware if it's not loaded
74 automatically.  If another Orinoco driver is loaded, use "modprobe -r"
75 to remove corresponding modules.  If you are not sure how to remove the
76 old modules, reboot the system.