README

   1 Copyright (c) 2003, 2008 the ACX100 driver project.
   2
   3 The contents of this archive are subject to the GPL version 2. See the LICENSE
   4 file for details.
   5
   6 [note: the original README file said that this file was licensed under the MPL,
   7 but allowed for removal of the MPL clause, so I did -- fg]
   8
   9 Word of caution
  10 ---------------
  11
  12 This driver is unfortunately NOT a cleanroom design. The original authors (two
  13 are mentioned below, they were five total) reverse engineered the firmware by
  14 themselves AND wrote the code. A cleanroom design requires that the two tasks be
  15 done by different groups.
  16
  17 The maintainer of this tree is ready to start from scratch. He's no RE person
  18 however. If you want to help, contact fgaliegue@gmail.com.
  19
  20 A little history
  21 ----------------
  22
  23 * driver originally written Andreas Mohr and Denis Vlasenko;
  24 * initial mac80211 support by Jeff Williams;
  25 * modifications by other individuals (FIXME, I don't know their names).
  26
  27 The maintainer of this particular tree is Francis Galiegue.
  28
  29 Status
  30 ------
  31
  32 This driver is VERY experimental. It is known to kind of work on UP machines.
  33 SMP support is flaky/nonexistent. Use at your OWN RISK.
  34
  35 You MUST use a kernel >= 2.6.25 and the mac80211 stack. Note that
  36 compat-wireless support is not there yet, this driver is for now only worked on
  37 with stable kernel trees. What's more, the mac80211 stack evolves quickly.
  38
  39 The driver is known to compile. The USB version is UNTESTED. The VLYNQ version
  40 (used in some NetGear APs with OpenWRT firmware) kind of works. Many problems
  41 remain.
  42
  43 Firmware
  44 --------
  45
  46 This driver needs additional firmware: see
  47 http://acx100.sourceforge.net/wiki/Firmware for links to existing images.
  48
  49 Build instructions
  50 ------------------
  51
  52 The bundled Makefile (thanks to David Planella, david.planella@googlemail.com)
  53 allows for in-kernel tree of out-of-kernel tree compile.
  54
  55 The maintainer has only tested out-of-kernel tree compile however. This is easy
  56 enough:
  57
  58 make
  59
  60 HOWEVER, this Makefile doesn't seem to work with OpenWRT :(
  61
  62 As root, modprobe mac80211 (unless you have built it into the kernel itself) and
  63 insmos acx-mac80211.ko.
  64
  65 USB snooping
  66 ------------
  67
  68 If you are an USB driver developer and need to see USB traffic,
  69 http://benoit.papillault.free.fr/usbsnoop/ may be useful.
  70
  71 Another very good way to snoop the USB frames is under Linux if your
  72 driver happens to run under ndiswrapper (which is often the case),
  73 either by savage printk's, or by using the USB snooping facilities from
  74 Pete Zaitcev.
  75