fix: fix compilation warning in common.c
[acx-mac80211.git] / README
blob92c4855851d7a74d051eef6bd5b06921fbe34d2b
1 /****************  claimer ******************
2 ** Copyright (C) 2003  ACX100 Open Source Project
3 **
4 ** The contents of this file are subject to the Mozilla Public
5 ** License Version 1.1 (the "License"); you may not use this file
6 ** except in compliance with the License. You may obtain a copy of
7 ** the License at http://www.mozilla.org/MPL/
8 **
9 ** Software distributed under the License is distributed on an "AS
10 ** IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
11 ** implied. See the License for the specific language governing
12 ** rights and limitations under the License.
14 ** Alternatively, the contents of this file may be used under the
15 ** terms of the GNU Public License version 2 (the "GPL"), in which
16 ** case the provisions of the GPL are applicable instead of the
17 ** above.  If you wish to allow the use of your version of this file
18 ** only under the terms of the GPL and not to allow others to use
19 ** your version of this file under the MPL, indicate your decision
20 ** by deleting the provisions above and replace them with the notice
21 ** and other provisions required by the GPL.  If you do not delete
22 ** the provisions above, a recipient may use your version of this
23 ** file under either the MPL or the GPL.
24 ** ------------------------------------------------------------------
25 ** Inquiries regarding the ACX100 Open Source Project can be
26 ** made directly to:
28 ** http://sourceforge.net/forum/forum.php?forum_id=257272
29 ** 
30 ** http://acx100.sourceforge.net/wiki
31 ** ------------------------------------------------------------------
34 This tarball is targeted at 2.6 inclusion only.
35 Not designed to work or even compile with 2.4.
36 dscape wifi stack is mandatory 
38 dscape Wifi stack isn't yet part of the standard kernel, 
40 Contact:
41 netdev@vger.kernel.org
42 acx100-devel@lists.sourceforge.net
43 acx100-users@lists.sourceforge.net
45 Bug reports:
47 Visit http://www.catb.org/~esr/faqs/smart-questions.html
49 Please describe your wireless setup, manufacturer and type
50 (acx100/acx100usb/acx111?) of your hardware. Which firmware image(s)
51 are you using? If problem is reproducible, #define ACX_DEBUG 2
52 in acx_config.h and modprobe driver with debug=0xffff.
53 Post resulting kernel log (bzipped). It is large but very useful
54 for bug hunting. Try older versions of the driver.
56 Firmware images:
58 You should not supply firmware_dir= parameter anymore. Driver will try
59 to load the following images via hotplug (not from /usr/share/acx
60 directory as older driver did, hotplug firmware directory location
61 varies for different distros, try /lib/firmware or
62 /usr/lib/hotplug/firmware):
64 PCI driver:
65 'tiacxNNNcMM' (NNN=100/111, MM=radio module ID (in uppercase hex)):
66 combined firmware for specified chipset and radio.
67 Failing that, it will try to load images named 'tiacxNNN'
68 (main firmware for specified chipset) and 'tiacxNNNrMM' (corresponding
69 radio module). For example, my firmware is in file named 'tiacx111c16'.
70 Alternatively, I may remove it and use pair of files 'tiacx111' and
71 'tiacx111r16' instead.
72 USB driver:
73 image is named 'tiacxNNNusbcMM'
75 Build instructions:
77 * Create drivers/net/wireless/acx subdirectory inside
78   your kernel tree.
79 * BTW, if your kernel has drivers/net/wireless/tiacx directory,
80   you already may have acx driver (some different version).
81   Decide which one do you want.
82 * Unpack tarball into drivers/net/wireless/acx directory.
83 * Add a line to drivers/net/wireless/Makefile:
84         obj-m += acx/
85 * Build your modules as usual (perhaps "make modules modules_install").
87 This will create acx module.
89 Remove "acx-obj-y += usb.o" line in Makefile
90 and "#define CONFIG_ACX_USB 1" line in acx_config.h
91 if you want PCI-only driver. Ditto for USB-only one.
93 USB snooping:
95 If you are an USB driver developer and need to see USB traffic,
96 http://benoit.papillault.free.fr/usbsnoop/ may be useful.
97 Another very good way to snoop the USB frames is under Linux if your
98 driver happens to run under ndiswrapper (which is often the case),
99 either by savage printk's, or by using the USB snooping facilities from
100 Pete Zaitcev.
103 From: Per Bjornsson <perbj@stanford.edu>
104 To: ACX100 user mailing list <acx100-users@lists.sourceforge.net>
105 Date: Fri, 08 Jul 2005 13:44:26 -0700
109 Just a note for those who, like me, prefer not to bother recompiling
110 their whole kernel: It's not at all difficult to compile Denis's
111 snapshots out of tree, despite what the readme file says! At least in
112 somewhat recent 2.6.x kernels, there's a special syntax for compiling
113 modules in a particular directory (as noted in the kernel docs in
114 Documentation/kbuild/modules.txt):
116       * Unpack Denis's tarball in a new directory (note that the
117         tarballs currently don't contain a root directory, just the
118         files, so you want to do the untarring in an empty directory)
119       * If you're building for the currently running kernel, build the
120         modules with the command
121         make -C /lib/modules/`uname -r`/build M=`pwd`
122       * Install the modules (must be root for this step, so use
123         'su' if that's your preferred method of doing root stuff) with
124         make -C /lib/modules/`uname -r`/build M=`pwd` modules_install
126 I figured that the snapshots might get more testing if more people know
127 that they don't have to muck around with the whole kernel source in
128 order to build this. I tested this on Fedora Core 4; sane distributions
129 should be using this setup for accessing the kernel build files (if they
130 listened to Linus's suggestions anyways). The one trick is that you
131 might need a special "kernel development files" package; on Fedora Core,
132 the files are included in the regular kernel package for FC2 and 3 but
133 you need the 'kernel-devel' package for FC4.
135 And finally, the kernel won't figure out that the module has been
136 installed until you run 'depmod -ae' as root. You can check that
137 something useful got picked up with 'modinfo'. (Both of these commands
138 are likely installed in /sbin so you might need the full path unless
139 you're fully logged in as root.)
141 The latest snapshot (acx-20050708.tar.bz2) generally seems to work well
142 for me, except that it's somewhat noisy and reports a lot of DUPs in the
143 system log. However, it appears to associate more consistently with my
144 access point that the old versions (when I had those modprobed on boot
145 and brought up by the system network scripts, the card would often just
146 sit and scan around and never actually associate until I manually
147 restarted the connection) - admittedly I've only tried a couple of times
148 yet so I don't know just how consistent this is. My hardware is a
149 Netgear WG311v2, using the firmware from the latest Netgear Windows
150 driver. (Can't check the details right now since I'm not at that
151 computer, sorry - it got too late when I was mucking with this and other
152 stuff yesterday for me to get a message sent...)
154 Cheers,
157 Per Bjornsson <perbj@stanford.edu>
158 Ph.D. Candidate, Department of Applied Physics, Stanford University