]> git.decadent.org.uk Git - ap-utils.git/blobdiff - README
Merge commit 'upstream/1.5'
[ap-utils.git] / README
diff --git a/README b/README
index 7ed7118d4e05e06a4e65405c7d9a2523bdd45852..0752f21da2bdb32a35e51e570fbd83def9588074 100644 (file)
--- a/README
+++ b/README
@@ -73,96 +73,192 @@ and usually comes with your SNMP management utility for Windows.
 +------------------------------------------------------------------------------+
 |                              Supported Access Points                        |
 +------------------------------------------------------------------------------+
-| Manufacturer                 | Models                | Type                 |
+| Manufacturer (OEM)           | Model                 | AP MIB type          |
 +-------------------------------+-----------------------+----------------------+
-| Global Sun                   | ProWave GL2411AP      | ATMEL410             |
-| Linksys                      | WAP11 pre2 version    | ATMEL410             |
-| SMC                          | MC2655W               | ATMEL410             |
-| Netgear                      | ME102                 | ATMEL12350, ATMEL410 |
-| Eumitcom                     | WA3001A               | ATMEL410             |
-| Edimax                       | EW-7205               | ATMEL410             |
-| Target                       | WLAP 24212            | ATMEL410             |
-| Micronet                     | SP918                 | ATMEL410             |
-| Smartbridges                 | airPoint, airBridge   | ATMEL410             |
-| Belkin Components            | F5D6130               | ATMEL410             |
-| GemTek                       | TEW-210APB            | ATMEL410             |
-| GemTek                       | WX-1500               | NWN                  |
-| Intellinet                   | AP, Wireless Bridge   | ATMEL410             |
-| D-Link                       | DWL 900AP             | ATMEL410             |
-| D-Link                       | DWL 1000AP            | NWN                  |
-| WLink Syst. (D-Link subs.)   | Wen-2021              | ATMEL410             |
-| Advantek Networks             | AWN-AP128            | ATMEL410             |
-| Compex                       | WavePort WP11         | NWN                  |
-| Zoom                         | ZoomAir11AP           | NWN                  |
-| Telecom                      | T-Sinus 130X          | ATMEL410             |
-| Ovislink                     | Airlive WL-1100AP     | ATMEL410             |
-| CC&C Technologies            | Access Point          | ATMEL410             |
+| Acer                         | Warplink EJA-A        | NWN                  |
+| Advantek Networks             | AWN-AP128            | ATMEL410             |
+| Ark                          | SOHO-WLAP             | ATMEL410             |
+| Asus                         | WL-300                | ATMEL410             |
+| Belkin Components            | F5D6130               | ATMEL410             |
+| BOSSLAN                      | BOSSWAP               | ATMEL12350, ATMEL410 |
+| CC&C Technologies            | Access Point          | ATMEL410             |
+| CNet                         | CNAP-711              | ATMEL410             |
+| Cameo Communications          | WLB-2000/2001                | ATMEL410             |
 | Compaq                       | WL-400                | NWN (mostly works)   |
-| Asus                         | WL-300                | ATMEL410             |
-| Topcom                       | SkyLanR@cer 500       | ATMEL410             |
-| Fiberline                    | WL-1200AP             | ATMEL12350           |
-| CNet                         | CNAP-711              | ATMEL410             |
-| Yakumo                       | Access Point          | ATMEL410             |
-| Dynalink (Askey)             | RTW020                | ATMEL410             |
-| Acer                         | Warplink EJA-A        | NWN                  |
+| Compex                       | WavePort WP11         | NWN                  |
+| D-Link                       | DWL 900AP (rev. 1)    | ATMEL410             |
+| D-Link                       | DWL 1000AP            | NWN                  |
+| D-com                                | WX-1590 web           | ATMEL12350           |
+| Dynalink (Askey)             | RTW020                | ATMEL410             |
+| Edimax                       | EW-7205APB            | ATMEL410             |
+| Eumitcom                     | WA3001A               | ATMEL410             |
+| Fiberline                    | WL-1200AP             | ATMEL12350           |
+| GemTek                       | TEW-210APB            | ATMEL410             |
+| GemTek                       | WX-1500               | NWN                  |
+| GigaFast                     | WF711-AP              | ATMEL12350           |
+| Global Sun Technology                | ProWave GL2411AP      | ATMEL410             |
+| i-Tec                                | AP SILVER             | ATMEL410             |
+| i-Tec        (Tellus A13 OEM)        | AP GOLD (blue front)  | ATMEL410             |
+| i-Tec        (Tellus A14 OEM)        | AP GOLD (black front) | ATMEL12350           |
+| Infosmart                    | INAP88                | ATMEL410             |
+| Intellinet                   | AP, Wireless Bridge   | ATMEL410             |
+| InterEpoch                    | IWE1000A              | ATMEL410             |
+| Linksys (GL2411AP OEM)       | WAP11 pre2 version    | ATMEL410             |
+| Micronet                     | SP918                 | ATMEL410             |
+| Netgear                      | ME102                 | ATMEL12350, ATMEL410 |
+| OSBRiDGE                      | m2410                 | ATMEL12350           |
+| OSBRiDGE                      | p2410                 | ATMEL12350           |
+| OSBRiDGE                      | p2410i                | ATMEL12350           |
+| Ovislink                     | Airlive WL-1100AP     | ATMEL410             |
+| SMC                          | MC2655W               | ATMEL410             |
+| smartBridges                 | airPoint, airBridge   | ATMEL410             |
+| SparkLAN (Gemtek subs.)      | WX-1590               | ATMEL410             |
+| SparkLAN (Gemtek subs.)      | WX-1590L              | ATMEL12350           |
 | Svec                         | FD1811                | ATMEL12350, ATMEL410 |
-| Tellus Group Corp            | A14                   | ATMEL12350           |
-| Wline                         | A14                  | ATMEL12350           |
-| i-Tec                         | i-Tec AP SILVER      | ATMEL410             |
-| i-Tec                         | i-Tec AP GOLD                | ATMEL410             |
-| Infosmart                    | INAP88                | ATMEL410             |
-| Ark                          | SOHO-WLAP             | ATMEL410             |
-| Svec                          | SOHO-WLAP            | ATMEL410             |
-| GigaFast                      | WF711-AP             | ATMEL12350           |
-| Cameo Communications          | WLB-2000/2001         | ATMEL410            |
-| Wline                         | W-2000                | ATMEL410             |
+| Svec                         | SOHO-WLAP             | ATMEL410             |
+| Target                       | WLAP 24212            | ATMEL410             |
+| Telecom                      | T-Sinus 130X          | ATMEL410             |
+| Tellus Group Corp            | A14                   | ATMEL12350           |
+| Topcom                       | SkyLanR@cer 500       | ATMEL410             |
+| Wline                                | A14                   | ATMEL12350           |
+| Wline                                | W-2000                | ATMEL410             |
+| WLink Syst. (D-Link subs.)   | Wen-2021              | ATMEL410             |
+| Yakumo                       | Access Point          | ATMEL410             |
+| Zoom                         | ZoomAir11AP           | NWN                  |
 +-------------------------------+-----------------------+----------------------+
 
 Please note that although many of these devices may use the same MIB enterprise
 identification, the actual MIBs may slightly differ, depending on whether
-the manufacturer has decided upon hardware modifications.
+the manufacturer has decided upon firmware modifications.
 In ap-config, an effort has been made to only include functionality
 for features that are common to 2 or more MIBs with the same enterprise
 ID. If you have qualms, then please send us the MIB file that came
 with your device!
 
+
 WARNING 1: There actually exist two different kinds of ATMEL private MIBs,
-regardless of its enterprise ID - each with a different set of operational
-modes.
-One type the private MIB comes with is often referred to as "Access Point"
-firmware, often marked with shortcut "AP". Another one is referred to as
-"Wireless Adapter firmware", marked with shortcut "WA".
-"WA" firmware has questionable advantage that it is claimed to allow APs
-equipped with this firmware to connect with non-ATMEL-based APs of other
-manufacturers using "AP-client (Infrastructure)" mode (in reality, this is,
-unfortunately, often false), at cost of supporting no true "AP" mode
-(only Ad-Hoc and AP-client modes are available).
+regardless of its enterprise ID - each with different set of operational modes.
+The first MIB type comes with firmware referred to as 'Access Point firmware'
+('AP firmware').
+Second MIB type comes with firmware referred to as 'Wireless Adapter firmware'
+('WA firmware').
+WA firmwares have questionable advantage of being able to connect
+to WDS-equipped APs (some non-ATMEL-based APs) using "AP-Client
+(Infrastructure)" mode (in reality, this is, unfortunately, often false),
+at cost of supporting no true "AP" mode (only Ad-Hoc and AP-client modes
+are available).
 
 Whenever you can, use firmware labelled as "AP" and not "WA".
 "AP" version supports most networking modes, compared to "WA" version.
-MIBs AND FIRMWARES WITH "WA" LABEL ARE NOT SUPPORTED WITH AP-UTILS!
+!!!!!!!!! "WA" FIRMWARES ARE _NOT_ SUPPORTED BY AP-UTILS !!!!!!!!!
 They may appear to _partially_ work with ap-utils, but you
 can cause harm to your AP if you use ap-utils with such firmware.
 Do not complain if you use ap-utils with such firmware and it damages
 your AP!
 
+The only thing you may eventually use "WA" firmware for, is to downgrade
+your device to "AP" firmware with number lower than the one used previously
+- see below. This applies to devices with RFMD radio only.
+
+To understand firmware naming schemes better, it is highly recommended
+that you'll read the ap-tftp manpage.
+
+
 WARNING 2: Users of Tellus A14 and its OEM versions (Wline A14, Veriplus
-WL-A14, etc. - ATMEL12350 AP "types"): Beware. Firmwares up to (including)
-version 0.2.2.19 for these APs contain a SERIOUS BUG that may
-result in unpredictable and persistent lock-up of your AP, when configured
-over SNMP or even via its web interface. There's unfortunately no way
-of how to "resurrect" such a locked-up AP - the only option is to return
-the AP to its supplier for replacement.
+WL-A14, etc. - generally all AP types with ATMEL12350 MIB, equipped with
+web interface):
+Beware! Firmwares up to (including) version 0.2.2.19 for these APs contain
+a SERIOUS BUG that may result in unpredictable and persistent lock-up
+of your AP, when configured over SNMP or even via its web interface.
+There's unfortunately no way of how to "resurrect" such a locked-up AP
+- the only option is to return the AP to its supplier for replacement.
+
 To be on the safe side, we recommend everyone to upgrade to any firmware
-version above 0.2.2.19. At the time of this writing,
-you should be able to download firmware v. 0.2.2.21 including
-the corresponding TFTP utility for example from the following link:
+version above 0.2.2.19. More on firmware upgrade subject see next section.
+
+
+WARNING 3: Users of smartBridges equipment ("airPoint" and "airBridge"
+models): pay close attention to the WARNING 1 - only the "AP" firmware
+is supported! Do not expect "airBridge" models with their native
+firmware to work properly with ap-utils - only "airPoint" device
+firmware is supported. Future support for "airBridge" device firmware
+is very unlikely, becouse it really supports a subset of "airPoint"
+(AP) firmware functionality.
+
+All named devices use identical hardware with differences only in
+in connector types used, casing and use of industrial-grade components.
+This also means that the firmware for "airPoint" and "airBridge" models
+could be used interchangeably among these kinds of devices, however,
+loading of airPoint firmware into airBridge device has not been verified
+yet, so unless this warning disappears or states otherwise, flashing
+your (airBridge) device with AP firmware for different (airPoint)
+model (in order to gain ap-utils support) is discouraged.
+
+
+Firmware available free of charge for ATMEL12350 MIB devices:
+-------------------------------------------------------------
+If you own device that is detected as 'ATMEL12350 MIB' by ap-utils, chances
+are that free-of-charge EZYNET-enhanced firmware upgrade is eligible for you!
+Upgrading firmware in your AP may have following advantages for you:
+
+- supporting more options; apparently the richest set of them available
+  for ATMEL+RFMD devices to day
+
+- preventing 'death by reconfiguration bug' present in older firmwares.
+
+- RSSI diagnostics in both AP and client modes at no cost!
+
+Your device will qualify for free-of-charge firmware upgrade in case
+it would satisfy the following (SATISFYING ALL POINTS IS MANDATORY!):
+
+1. It is detected as 'ATMEL12350' MIB and 'GEMTEK' vendor MIB extension
+   by ap-utils.
+
+2. It has second SRAM chip. The sign of second SRAM chip availability
+   is presence of (poor, locky) web management interface.
+
+3. it runs firmware 0.2.x.x except 0.2.1.1
+
+Should it satisfy all three points above, you may now perform upgrading.
+
+0. READ ENTIRE MANPAGE FOR ap-tftp !!!
+
+1. download the AP firmware (*.rom files) by EZYNET from one of the following
+   URLs:
+
+   ftp://ftp.unob.cz/pub/firmware/wlan/atmel+rfmd/
+
+   http://www.e-zy.net/  (descend through sections: Support -> AT510 based
+   units -> Firmware -> AP)
+
+2. perform AP upgrade either by original windows-based ATMEL tftp client,
+   or by 'ap-tftp' utility supplied with ap-utils:
+
+   First, upgrade with 0.2.0.20.rom image. This one is so-called 'backup'
+   firmware. It lacks (needless) web, and is activated only if so-called
+   'primary' firmware fails for some reason.
+
+   Second, upgrade with 0.2.2.20.rom image. This is the 'primary' firmware
+   with web interface (which you apparently wont use at all).
+
+3. You now have device with ATMEL12350 MIB & EZYNET extensions !!!
+
+Should you observe that the device suddenly switched to 0.2.0.20 firmware
+after some time, it means that the 'primary' firmware has been damaged
+in flash by some odd circumstances, and you should repeat step 2. above
+to fix it.
+[Note: this may only happen under _extremely_ rare circumstances, when,
+for example, lightning stroke appears too close to the AP, or when AP
+power supply voltage suddenly drops below sane level and returns back]
 
-http://www.sparklan.com/download.htm
+Should you need firmware downgrade for any reason, it is possible, provided
+that you have the original firmware *.rom file(s) for your devices.
+If your firmware was 0.2.2.19 or lower, you'll also need to temporarily
+upgrade to the following WA firmware, which will allow you to subsequently
+downgrade to AP firmware release with lower number than (EZYNET's) 0.2.2.20:
 
-or send your AP to its supplier for firmware replacement in case
-he's able to supply you with customarily enhanced firmware version
-above 0.2.2.19.
+http://www.sparklan.com/Downloads/11b/AP/WX-1590_Client-Mode/Firmware/
+Client_Mode_firmware_WX-1590_v0.3.2.6.zip
 
 Frequently Asked Questions
 --------------------------
@@ -178,7 +274,7 @@ Windows-based setup utility.
 Try to install the accompanying Windows SNMP setup utility, and
 browse the directory to which you have got it installed.
 If you find the mentioned file, send this file via e-mail
-to <aputils-wmibs at cedric dot vabo dot cz> or <roma at polesye dot net>.
+to <jr-aputils at cedric dot vabo dot cz> or <roma at polesye dot net>.
 Chances are, that this file matches more or less the MIBs
 of other devices already being supported by ap-utils, and thus the
 utility code can be tailored accordingly to support your AP
@@ -186,10 +282,16 @@ in as broad number of its features as possible.
 
 Where to get more information
 -----------------------------
-You can find info about utils from this README and from man pages
-for utilites; as well as in INSTALL and TODO files at toplevel directory.
+You can find info about utilities from this README and from respective
+man pages (see Documentation directory), as well as from INSTALL and TODO
+files in the toplevel directory.
+Documentation/FAQ file may be of some interrest to you too.
 Additional info and useful links may be found in the Documentation
 directory of this package and on our web page http://ap-utils.polesye.net/ .
+Note, however, that informations on the web may somewhat lag behind this
+source.
+You may also peek into ChangeLog file if you are more of a technical person,
+for a list of changes and developer notes.
 We also run maillist to discuss any related topics - for more info please
 visit http://ap-utils.polesye.net/ .
 
@@ -198,8 +300,8 @@ Contributing & reporting problems
 Any help in developing, bugfixing and testing is welcome. Also any
 additional documentation, free hardware to support this project and job offers
 are greatly welcome.
-Please send your comments, if any, to my email -
-roma at polesye.net or to the maillist.
+Please send your comments, if any, to my email - roma at polesye.net
+or to the maillist.
 
 Before sending bugreports please be sure to read docs (firstly, README and FAQ)
 and upgrade to the latest version of ap-utils. If problem still exists, then