@database "prism2.device Manual"
@$VER: "prism2.device Manual" 1.7 (10.2.2008)
@author "Neil Cafferkey"
@(c) "Neil Cafferkey"

Copyright (C) 2005-2008 Neil Cafferkey

This manual is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This manual is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this manual; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston,
MA 02111-1307, USA.


@node "main" "prism2.device Manual"

  @{b}@{u}prism2.device 1.7@{uu}@{ub} - A wireless Ethernet driver


    @{"Introduction" link "intro"}

    @{"Installation and Usage" link "install"}

    @{"Author and Legal Information" link "author-legal"}

    @{"History" link "history"}

@endnode


@node "intro" "Introduction"

@{u}@{b}Introduction@{ub}@{uu}

prism2.device is a SANA-II network driver for 11Mbps wireless Ethernet cards
based on the Prism II chipset and variants. It supports PCMCIA cards in the
A1200/A600 and PCI cards in AmigaOnes, Prometheus-equipped Amigas and PCs
running Amithlon. @{b}N.B.:@{ub} When using a Prometheus bridgeboard, only a PCMCIA
card in combination with a Prism II-specific PCMCIA-to-PCI adapter can be
used.

The table below shows compatibility information for prism2.device with a
variety of wireless cards. @{b}For cards not listed below, see Absolute Value
System's directory of wireless chipsets at
http://www.linux-wlan.org/docs/wlan_adapters.html.gz@{ub}

If a card's chipset is listed at the AVS site as Orinoco, Agere or Prism
(except the SSF version) @{u}and@{uu} its bus type is PCMCIA or PCI, it is likely to
work. Note that a few otherwise-compatible PCMCIA cards are 3.3V-only and
therefore incompatible with the A1200/A600. If the card is listed there but
doesn't match these requirements, it will definitely @{u}not@{uu} work.

Please send me compatibility information about cards you've tried so I can
extend this list.


@{b}@{u}Company/Brand@{uu}	@{u}Model@{uu}				@{u}Bus@{uu}	@{u}Works@{uu}	@{u}FCC ID@{uu}@{ub}

@{b}3Com@{ub}		AirConnect			PCMCIA	No
		3CRDW696			PCI	Yes	MXF-C910729

@{b}Allied Telesyn@{ub}	AT-WCL452			PCMCIA	Yes	O6M-WE300

@{b}Apple@{ub}		AirPort				PCMCIA	No

@{b}Archtek@{ub}		see @{b}SmartLink@{ub}

@{b}Artem@{ub}		CC-PC-b-H2-STD			PCMCIA	Yes

@{b}AT&T@{ub}		see @{b}Lucent@{ub}

@{b}Avaya@{ub}		World Card			PCMCIA	Maybe

@{b}Buffalo@{ub}		WLI-PCM-S11			PCMCIA	Maybe
		WLI-PCM-L11			PCMCIA	Yes	IMRWLPCE24H
		WLI-PCM-L11G			PCMCIA	Yes

@{b}Cabletron@{ub}	RoamAbout 802.11 DS		PCMCIA	Maybe

@{b}Compaq@{ub}		WL100				PCMCIA	No	E2XSWL-2000N
		WL110				PCMCIA	Yes

@{b}Compex@{ub}		WL11B+				PCMCIA	Yes	IXMPCBAG

@{b}D-Link@{ub}		DWL-520 (HW rev. B2 or earlier)	PCI	Yes
		DWL-520 (all other HW rev.)	PCI	No

@{b}Elsa@{ub}		MC-11				PCMCIA	Yes

@{b}Funkwerk@{ub}	see @{b}Artem@{ub}

@{b}IBM@{ub}		26P8030/26P8087			PCMCIA	Yes

@{b}Intel@{ub}		PRO/Wireless 2011		PCMCIA	No

@{b}Longshine@{ub}	GL2411V1-A			PCMCIA	Yes	O7J-GL2411V1A

@{b}Lucent Tech.@{ub}	WaveLAN version 2.0		PCMCIA	No
		Orinoco	Bronze			PCMCIA	Yes
		Orinoco	Gold			PCMCIA	Yes
		Orinoco	Silver			PCMCIA	Yes
		Orinoco WaveLAN/IEEE 802.11(b)	PCMCIA	Yes

@{b}Melco@{ub}		see @{b}Buffalo@{ub}

@{b}Microsoft@{ub}	MN-520				PCMCIA	Yes	HEDACC3501D68

@{b}NCR@{ub}		see @{b}Lucent@{ub}

@{b}Netgear@{ub}		MA301				PCI	Yes
		MA311				PCI	Yes	M4Y-06260
		MA401				PCMCIA	Yes

@{b}Proxim@{ub}		8420-WD				PCMCIA	Yes	IMRPC2411B

@{b}Samsung@{ub}		SWL-2000N			PCMCIA	No	E2XSWL-2000N

@{b}SmartLink@{ub}	WE300-IF			PCMCIA	Yes	O6M-WE300

@{b}SMC@{ub}		SMC2632W			PCMCIA	Yes	LLM002SMC2632W
		SMC2632W			PCMCIA	Maybe	LLM002WL11000-1
		SMC2632W V.2			PCMCIA	No	HEDACC2632WV2
		SMC2632W V.3			CardBus	No
		SMC2632W-B			PCMCIA	Maybe	M4Y-0325H

@{b}Sony@{ub}		Vaio PCWA-C100			PCMCIA	Yes
		Vaio PCWA-C150S			PCMCIA	Yes	AK8PCWAC150S

@{b}Thomson@{ub}		SpeedTouch 110			PCMCIA	Yes

@{b}Unex@{ub}		NexAir MR011-001		PCMCIA	Yes

@endnode


@node "install" "Installation and Usage"

@{u}@{b}Hardware requirements@{ub}@{uu}

One of the following systems is required:
 - An A600 or A1200.
 - An AmigaOne SE or XE, or Micro AmigaOne.
 - An Amiga with a Prometheus PCI bridgeboard.
 - A PC running Amithlon.

@{u}@{b}Software requirements@{ub}@{uu}

prism2.device needs AmigaOS 3.0 or greater, or MorphOS.

@{u}@{b}Installation@{ub}@{uu}

To install prism2.device, run the 'Install' script. In your networking
software, set the SANA-II device name to @{b}networks/prism2.device@{ub}
and the unit number to @{b}0@{ub}.

@{u}@{b}Wireless parameters@{ub}@{uu}

By default, the driver attempts to connect to any advertised, unencrypted
access point within range. If you need other options, you'll need to run the
@{b}SetPrism2Defaults@{ub} shell command before starting your TCP/IP stack. You can
call it from your S:User-Startup file to use the same options every time you
boot. If using AmigaOS 4, make sure SetPrism2Defaults is called before
AddNetInterface (this may involve calling SetPrism2Defaults from
S:Startup-Sequence instead).

SetPrism2Defaults takes the following parameters:

   @{b}SSID@{ub} - the name of the network to connect to (or to create in the
      case of ad-hoc mode).
   @{b}KEY@{ub} - a WEP key to use for encryption, entered as a string of hexadecimal
      digits. The key must be either 10 or 26 digits long.
   @{b}TEXTKEY@{ub} - same as KEY, except that the key is entered as a textual
      string. The key must be either 5 or 13 characters long. Note that this
      is not the same as the passphrase-generated keys available on some
      other systems.
   @{b}NOKEY@{ub} - turn off WEP encryption.
   @{b}MANAGED@{ub} - use a network that has an access point. This is the default.
   @{b}ADHOC@{ub} - use an ad-hoc (peer-to-peer) network instead of a managed one (an
      ad-hoc network can be twice as fast as a managed network when
      transferring data between two computers in your wireless network).
   @{b}CHANNEL@{ub} - Channel number to use when creating an ad-hoc network (1 to 14,
      depending on country).

Examples:

   SetPrism2Defaults SSID wlan1 KEY 1234-abcd-89
   SetPrism2Defaults SSID wlan2 TEXTKEY asecreTwePkeY
   SetPrism2Defaults SSID mynet ADHOC CHANNEL 11

N.B.: The options set by SetPrism2Defaults are only examined by
prism2.device when it's starting up, so you'll probably have to quit and
restart your TCP/IP stack (or any other software that uses the device)
before any changes will take effect.

@{u}@{b}A1200 hardware bug@{ub}@{uu}

The A1200 (but not the A600) has a hardware bug which prevents a PCMCIA card
being reset except on insertion or removal. There are both hardware and
software remedies for this problem. The software solution is CardReset
(util/boot/CardReset.lha on Aminet). There are several different types of
hardware fixes, both DIY and commercial.

@{u}@{b}Problems@{ub}@{uu}

Miami will cause the system to hang if a PCMCIA card is removed while
online. Re-insertion won't help.

@endnode


@node "author-legal" "Author and Legal Information"

@{u}@{b}Author and Legal Information@{ub}@{uu}

prism2.device was written by Neil Cafferkey.

Please send bug reports, suggestions, and any other correspondence to one of
the following addresses.

E-mail: caffer@cs.ucc.ie

Post: Neil Cafferkey,
      30, Upper Kensington,
      Rochestown,
      Cork,
      Ireland.

prism2.device, SetPrism2Defaults and pccard.library are released under the
terms of the @{"GNU General Public Licence" link "GPL/MAIN"}. See the individual source files for
copyright information.

The full pccard.library archive, which includes the source code and
developer files, is available on Aminet as "util/libs/pccard.lha".

All trademarks are owned by their owners.


The @{b}Hermes II firmware file@{ub} is subject to the following terms:

  COPYRIGHT © 1994 - 1995 by AT&T.                All Rights Reserved
  COPYRIGHT © 1996 - 2000 by Lucent Technologies. All Rights Reserved
  COPYRIGHT © 2001 - 2004 by Agere Systems Inc.   All Rights Reserved
  All rights reserved.

  Redistribution and use in source or binary forms, with or without
  modifications, are permitted provided that the following conditions are
  met:

  . Redistributions of source code must retain the above copyright notice,
     this list of conditions and the following Disclaimer as comments in the
     code as well as in the documentation and/or other materials provided
     with the distribution.

  . Redistributions in binary form must reproduce the above copyright
     notice, this list of conditions and the following Disclaimer in the
     documentation and/or other materials provided with the distribution.

  . Neither the name of Agere Systems Inc. nor the names of the contributors
     may be used to endorse or promote products derived from this software
     without specific prior written permission.

  Disclaimer

  THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  INCLUDING, BUT NOT LIMITED TO, INFRINGEMENT AND THE IMPLIED WARRANTIES OF
  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  ANY
  USE, MODIFICATION OR DISTRIBUTION OF THIS SOFTWARE IS SOLELY AT THE USERS
  OWN RISK. IN NO EVENT SHALL AGERE SYSTEMS INC. OR CONTRIBUTORS BE LIABLE
  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  CAUSED AND ON ANY THEORY OF LIABILITY, INCLUDING, BUT NOT LIMITED TO,
  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  POSSIBILITY OF SUCH DAMAGE.

@endnode


@node "history" "History"

@{u}@{b}History@{ub}@{uu}

@{b}V1.7 (February 2008)@{ub}

  - Prism II cards transmitted at 2 Mbps instead of 11 Mbps. Fixed.
  - PCI-to-PCMCIA adapters work under AmigaOS 4 again.
  - Pegasos no longer supported because of unresolvable speed problems.

@{b}V1.6 (June 2006)@{ub}

  - Added a command to retrieve current signal quality.
  - Fixed an alignment bug that prevented use of Hermes II cards in an A600.

@{b}V1.5 (March 2006)@{ub}

  - Added support for Hermes II cards.
  - Added a missing card ID.

@{b}V1.4 (December 2005)@{ub}

  - Added a reset handler for AmigaOS 4. This allows the system to restart
    if a soft reset occurs while the card is in use.

@{b}V1.3 (August 2005)@{ub}

  - Fixed an alignment bug that made it impossible to use WEP on an A600
    (without a CPU upgrade). If you install the new driver version, it's
    important that you install the new SetPrism2Defaults command too, as the
    old command is incompatible with the new driver.

@{b}V1.2 (June 2005)@{ub}

  - Now works with AmigaOS 4.0 Prerelease Update 3. The presence of a
    work-around in the prism2.device for a software interrupt bug in
    previous OS 4 prereleases caused it to fail with Update 3. This
    work-around has now been removed. This also means that the device will
    no longer work with older OS 4 prereleases.
  - Added Micro AmigaOne to list of compatible hardware.

@{b}V1.1 (May 2005)@{ub}

  - First release.

@endnode