Handle missing Makefile correctly in clean rule

[ap-utils.git] / README

About
-----
Wireless Access Point Utilites for Unix - it's a set of utilites to configure
and monitor Wireless Access Points in Unix using SNMP protocol. Utilites
are known to compile and run under Linux, FreeBSD, NetBSD, MacOS-X, AIX,
QNX and OpenBSD.

The software was initially written by Roman Festchook
(ÕËÒÁ§ÎÓØËÏÀ òÏÍÁÎ æÅÝÕË) without any help from manufacturers
and released under the terms GNU General Public License version 2.0.
A copy of the license file is included with this distribution package.

The project also has a number of contributions, thanks to whose this
software has grown significantly; for a list of them, see files "THANKS"
and "ChangeLog".

As for version 1.2 Wireless Access Point Utilites for Unix include three utils:

ap-config: config and get stats from AP:
            setting bridging, wireless and ip options, WEP encryption,
                mac authorization, radio signal power, and communities to
                restrict access to AP, enabling/disabling antennas,
                hiding ESSID in broadcast messages;
            device test mode;
            getting info about AP sofware and hardware, dynamically updated
                ethernet and wireless ports statistics, list of associated
                stations and visible APs (option to save mac addresses of
                current associated stations to file);
            executing commands on AP;
        config and get stats from devices that support 
            MIB-II, IEEE 802.11 MIB and NWN DOT11EXT MIB:
            setting bridging and wireless options, WEP encryption,
                mac authorization, communities to restrict access to AP,
                enabling/disabling antennas;
            getting info about AP sofware and hardware, dynamically updated 
                wireless port statistics, information about latest events
                and errors, list of current associated stations with info
                about signal quality and station activity (option to save
                mac addresses of associated stations to file);
        search for connected APs;
        nice and portable ncurses-based user interface with context-help
                navigation menus, floating drop-down menus to choose from
                options list, options file to store connect options and
                subshell.
        
ap-mrtg: to get stat from AP (ATMEL based) and return it in MRTG parseable format:
        getting ethernet statistics in bytes, wireless statistics in packets,
                associated stations number and Link Quality/Signal Strenght
                stats from AP in client mode.
        
ap-trapd: to receive, parse and log trap messages from AP (ATMEL based):
        log data using standart syslogd;
        running by not privileged user;
        listening on the specified interface (only on Linux).

Supported Hardware
------------------
ap-utils support Atmel chipset based Access Points with ATMEL private MIB
with enterprises ID 410 (ATMEL410), Access Points with newer ATMEL private
MIB with enterprises ID 12350 (ATMEL12350) such as Netgear ME102 and Tellus
A14, and No Wires Needed APs with IEEE 802.11 MIB and NWN DOT11EXT MIB
(NWN).
You can find Known/Reported-to-work hardware in the table below.
If you have had success with ap-utils working with a hardware thats
not in the table below, please report.
Please, if possible, include informations from the ap-config's "sysinfo"
screen in your report.
Also, if possible, please send the MIB file that comes with your device.
This may result in supporting more options in ap-config in the future!
The file may look like 'AT76C510.mib' (in case of ATMEL-based APs),
and usually comes with your SNMP management utility for Windows.

+------------------------------------------------------------------------------+
|                               Supported Access Points                        |
+------------------------------------------------------------------------------+
| Manufacturer (OEM)            | Model                 | AP MIB type          |
+-------------------------------+-----------------------+----------------------+
| 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)   |
| 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 |
| 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 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 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.
!!!!!!!!! "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. - 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. 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]

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:

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
--------------------------

I got an AP and I would like ap-utils to support it (it is not on the
---------------------------------------------------------------------
list above)
-----------
The device has to be either ATMEL- or NWN-based. The first good sign
of a chance it could be supported by the ap-utils, is the presence
of file 'AT76C510.mib', that gets installed along with the original
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 <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
in as broad number of its features as possible.

Where to get more information
-----------------------------
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/ .

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.

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
please send a detailed description of your problem to the maillist.
Include the version of the program, the operating system that you are
using, the compiler and compiler flags used to compile the program (if
you know them), what kind of distribution you are using (in case of a GNU/Linux
system).
If the program crashed and produces a core dump, please provide a
stack trace of the program.
You can do this by running dbx or gdb like this:
    gdb <utility_name> core
    (gdb) where