README

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