Documentation/ap-tftp.8

   1 .\"      Manpage for ap-tftp utility
   2 .\"   from Wireless Access Point Utilitess for Unix
   3 .\"
   4 .\"  Copyright (c) 2004-2005 Jan Rafaj <jr-aputils at cedric dot unob dot cz>
   5 .\"
   6 .\"  This program is free software; you can redistribute it and/or modify
   7 .\"  it under the terms of the GNU General Public License Version 2 from
   8 .\"  June 1991 as published by the Free Software Foundation.
   9 .\"
  10 .\"  This program is distributed in the hope that it will be useful, but
  11 .\"  WITHOUT ANY WARRANTY; without even the implied warranty of
  12 .\"  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 .\"  GNU General Public License for more details.
  14 .\"
  15 .\"  You should have received a copy of the GNU General Public License along
  16 .\"  with this program; if not, write to the Free Software Foundation, Inc.,
  17 .\"  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  18 .TH ap-tftp 8 "Wireless Access Point Utilites for Unix"
  19 .SH NAME
  20 ap-tftp \- TFTP client for upgrading ATMEL AT76C510 WiSOC-based APs
  21 .TP
  22 .B Please read the entire manpage prior using this utility. It may prevent you from problems arising later.
  23 .SH SYNOPSIS
  24 .B ap-tftp
  25 .B -i
  26 .IR IP
  27 .B -f
  28 .IR firmware.rom
  29 .B [-c
  30 .IR community
  31 .B ]
  32 .SH DESCRIPTION
  33 The
  34 .B ap-tftp
  35 utility is used to upgrade or downgrade firmware in Access Points based on ATMEL AT76C510 VNET-B WiSOC (Wireless System On Chip). It should work for most (if not all) models with INTERSIL radio chipset, as well as those based on RFMD radio. However, so far it has only been tested on the following hardware: WLink WEN-2021, i-Tec AP GOLD, smartBridges airPOINT PRO (all with INTERSIL radio), and Tellus A14 (RFMD radio). If you have an AP with ATMEL AT76C510 and either INTERSIL or RFMD radio chipset, there's near 100% chance it will work for you, too.
  36 .SH PREFACE: FIRMWARE TYPES
  37 Functionally, there basically exist 2 types of firmware for ATMEL-based APs: an "
  38 .B Access Point
  39 firmware (often referred to as
  40 .B AP firmware
  41 ), and
  42 .B Wireless Adapter
  43 firmware (referred to as
  44 .B WA firmware
  45 ). Many hardware vendors produce their own more or less modified firmware derivatives, but usually they keep up with the naming scheme introduced by ATMEL:
  46 .SS APs with INTERSIL radios
  47 For APs with INTERSIL radios, the AP firmware file typically uses naming scheme such as "1.4x.y.rom" (for example "1.4j.1.rom", "1.4k.2.rom", etc.), while the WA firmware files typically exist under names such as "0.01.ab.rom" (for example "0.01.09.rom", "0.01.11.rom", etc.). The values "x", "y", and "ab" indicate the firmware revision.
  48 .SS APs with RFMD radios
  49 For APs with RFMD radios, the AP firmware files are known under names like "0.2.x.yz.rom" (such as "0.2.2.11.rom", "0.2.2.18.rom", etc.), while the WA firmware uses names as "0.3.b.c.rom" (for example "0.3.2.5.rom", "0.3.2.6.rom"), or "0.4.b.c.rom" for WA+ firmware (which is a variant of WA firmware that offers limited multiple MACs transparency in client mode) - for example "0.4.2.7.rom". Again, the numbers change according to the firmware revision.
  50
  51 To descend in even greater complexity, there usually exist 2 files for each firmware revision in the ATMEL+RFMD world: one so-called
  52 .B primary firmware
  53 (the bigger file of the two; it contains base firmware as well as the embedded webserver), and a second file with so-called
  54 .B backup firmware
  55 (the smaller file of the two, it contains just the base firmware).
  56 The name of secondary firmware always uses '0' in the third number field (such as "0.2.0.18.rom").
  57 .B You'll always need to upgrade with backup firmware FIRST, unless its manufacturer states otherwise.
  58 .TP
  59 .RE 4
  60 .B WARNING!!! WARNING!!! WARNING!!! WARNING!!! WARNING!!!
  61 .RS 4
  62 .IP o 3
  63 .B WA firmwares
  64 and their derivatives
  65 .B ARE _NOT_ SUPPORTED
  66 by ap-utils!!! They may appear to partially work with ap-utils, but you
  67 can cause harm to your AP if you use ap-config with such firmware. Do not
  68 complain if you use ap-config with such firmware and it damages your AP!
  69 .IP o
  70 Since some hardware vendors keep up the bad habit of producing their own firmwares using the original ATMEL firmware naming scheme, it is easy to find firmwares from different hardware vendors for ATMEL-based APs with
  71 .B exactly the same name and sometimes even the length
  72 (for example, firmware "1.4j.1.rom" exists in many incarnations, but their content differs). They may use different structures and offsets for reading configuration data in the flash memory without content validity checks, so
  73 .B NEVER EVER USE FIRMWARE FROM ANOTHER HARDWARE VENDOR THAN THE ONE THAT IS MANUFACTURING YOUR AP, UNLESS EXPLICITLY STATED OTHERWISE! IF YOU DO SO, YOU MAY IRREVERSIBLY DAMAGE YOUR AP!
  74 .IP o
  75 BEWARE! AP boards from several vendors may contain hardware design bugs, that will totally prevent it from successfull upgrade.
  76 .B Any attempt to upgrade such device, either via TFTP or DFU utility will fail and irreversibly damage content of its flash memory! If your vendor does NOT provide ANY firmware nor tools to perform upgrade for your device, it means (unless stated otherwise), that IT IS UNSAFE TO TRY UPGRADING and YOU SHOULD NOT ATTEMPT TO UPGRADE YOUR DEVICE AT ALL!
  77 Example of such board with bug in hardware design is Tellus A13 (also sold as i-Tec AP GOLD with blue front).
  78 .IP o
  79 ATMEL AT76C510-based APs are notoriously known for their firmware upgrade design flaw: firmware validation checks and subsequent permission for upgrade are not performed by the AP itself, but in the TFTP upgrade client. This means that anyone with proper TFTP client, having access to your AP via its ethernet port, may _try_ to upload incorrect firmware (or even no-firmware file!) to your AP, causing irreversible damage to your AP. Hence:
  80 .RS 3
  81 .IP \- 3
  82 .B SECURE YOUR AP ON IP (LAYER 3) BASIS! SET UP YOUR AP (AND ITS WIRELESS CLIENTS) WITH IP FROM A DIFFERENT IP SEGMENT THAN THE ONE IT IS PHYSICALLY ON. TO ACCESS AP ON SUCH DIFFERENT SEGMENT, YOU MAY USE IP-ALIAS INTERFACE (on Linux).
  83 .IP \-
  84 .B FOR APs IN "Access Point client" MODE, USE ap-config AND IN 'Config -> Bridge' MENU, CHANGE THE VALUE OF 'Configuration-enabled port(s):' TO 'Wireless'. THIS WAY, USER BEHIND Access Point client DEVICE WONT BE ABLE TO REACH ITS MANAGEMENT IP, AND SUBSEQUENTLY (S)HE WONT BE ABLE TO CAUSE ANY DAMAGE WITH TFTP.
  85 Note that setting Conf.-enabled port to 'Wireless' may be risky if you intend to reconfigure the device through Wireless media (bad values could be written to the AP due to wireless media unreliability). You should choose what is of greater risk for you.
  86 .RE 1
  87 .RS 4
  88 .IP o 3
  89 .B Users of ATMEL+INTERSIL devices:
  90 If your AP firmware vendor extensions are auto-detected as
  91 .B SBRIDGES
  92 by ap-config, it means that your AP uses firmware made by smartBridges PTE: you will need to pass extra '-c community' to ap-tftp in order to perform actual upgrade.
  93 .B BY ALL MEANS, AVOID UPGRADE OF DEVICE THAT CONTAINS smartBridges FIRMWARE, with non-smartBridges FIRMWARE, AND VICE VERSA, even if the firmware names may look similar (see the warning above).
  94 Although there are checks in ap-tftp, that should avoid something such, be careful, and DO NOT TRY, UNDER ANY CIRCUMSTANCES, to circumvent this protection - if you do, you'd most likely end up with damaged flash content in your device. You got the warning.
  95 .TP
  96 .BR
  97 Remember: All firmware files with revision "1.4j.4" onwards are from smartBridges: unless you possess a device that is autodetected with 'SBRIDGES' vendor extension, DO NOT TRY TO UPGRADE TO smartBridges FIRMWARE!
  98 .IP o 3
  99 .B Users of ATMEL+RFMD devices:
 100 If you are running
 101 .B primary
 102 firmware < 0.2.2.20, you
 103 .B should upgrade as soon as possible! AP
 104 firmware of version 0.2.2.19 and lower contains serious 'death by reconfiguration' bug, which, if triggered, may irreversibly damage content in flash memory of your AP. The event to trigger is usually changing & writing some settings in the 'Bridge' menu. So if you run such firmware, please upgrade. You may also look into README to see whether 'Firmware available free of charge for ATMEL12350 MIB devices' (section) applies to your AP.
 105 .TP
 106 .RE 1
 107 .B GENERAL HINTS AND RECOMMENDATIONS PRIOR UPGRADING
 108 .RS 4
 109 .IP \- 3
 110 IF POSSIBLE, PLACE YOUR AP BEHIND A FIREWALL SO THAT YOU PREVENT ACCESS TO ITS MANAGEMENT IP FOR UNWANTED THIRD PARTIES
 111 .IP \-
 112 Avoid upgrading your AP via its wireless port, if possible. Due to the unreliable nature of wireless media and UDP protocol used for upgrade, anything could happen - although there is CRC-like check in the firmware, that prevents flashing of (firmware) file that has possibly been altered during transmission, upgrade process interruption might cause damage (but even this is not very likely). You may upgrade AP via its wireless port only if you're 101% sure the wireless connection to the target device is reliable.
 113 .IP \-
 114 If you experience upgrade timeout in the 'middle' of the upgrade progress, it is usually ok to wait until the utility completely times out, and repeat the command afterwards. You may also experience 'catch up' (very short network break, so utility will resume uploading firmware to your AP).
 115 .IP \-
 116 In case when firmware upgrade fails,
 117 .B ap-tftp
 118 will show an error code returned by the TFTP server in AP. Note that although RFC 1350 defines 8 TFTP error messages, the TFTP server in the AP is not compliant to this RFC and the error codes returned may NOT correspond to those messages (but ap-tftp will always display corresponding RFC-defined error message, if possible, although it may really have nothing to do with the returned error code meaning). In the case the message for error code returned is not defined in RFC 1350, just the error code alone will be displayed.
 119 .IP \-
 120 If you want to upgrade firmware in an AP on a network where no DHCP server is available, it is advisable to assign static IP address and disable DHCP option on the device, so that you can verify, whether it is alive, using 'ping' command immediately after the upgrade succeeds (generally immediately after the device boots up), and you dont have to wait until AP's attempts to contact DHCP server time out. This is also especially useful if you need to do 2-step upgrade (using 'backup' and 'primary' firmware) - see above.
 121 .IP \-
 122 Firmware of APs based on ATMEL AT76C510 provides an interresting 'arp ping' feature. After AP boot-up, it is possible to remotely and TEMPORARILY (to next AP reboot) reconfigure its IP address, provided that within certain time period (several tens of seconds after boot-up), the AP receives ICMP ECHO request with target MAC address equal to its own. To set up IP in the AP using this method, do the following:
 123 .RS 3
 124 .IP 1\. 4
 125 From the IP range your AP is connected to, pick up an unused IP you want to set on the AP using 'arp ping'.
 126 .IP 2\.
 127 Set up static ARP entry associating the MAC address of your AP with the IP you selected in paragraph 1. Typically, you need to issue (as root) something like: 'arp -s required_AP_IP AP_MAC'. Consult manpage for 'arp' utility, if your 'arp' utility uses different syntax.
 128 .IP 3\.
 129 Right after the AP boots, run 'ping required_AP_IP'. You need to wait few seconds prior seeing first AP response.
 130 .RE 1
 131 .RS 4
 132 .IP \- 3
 133 .B Users of ATMEL+RFMD devices:
 134 To
 135 .B DOWNGRADE
 136 to
 137 .B AP
 138 firmware with lower revision number than the one thats currently in the device, you'll need to temporarily 'upgrade' to any
 139 .B WA
 140 firmware available for your device (as step-in-the-middle). This will 'unlock' your device for downgrading to previous
 141 .B AP
 142 firmware version.
 143 .SH OPTIONS
 144 .TP
 145 .B -i IP
 146 IP address of the AP you want upgrade firmware in.
 147 .TP
 148 .B -f firmware.rom
 149 Full path to and name of the firmware file for your AP.
 150 .TP
 151 .B -c community
 152 To be used ONLY with APs manufactured by smartBridges PTE. The given community
 153 must match with any of three three communities currently defined in the AP
 154 configuration - firmware upgrade will be allowed only upon the match.
 155 matches
 156 .RE
 157 .SH EXAMPLES OF USE
 158 .PD 0
 159
 160 .SS Upgrading AP firmware in a device with INTERSIL radio and non-smartBridges firmware
 161 .BR
 162 .TP
 163 ap-tftp -i 192.168.0.1 -f 1.4j.3.rom
 164
 165 .SS Upgrading AP firmware in a device with INTERSIL radio and smartBridges firmware
 166 .BR
 167 .TP
 168 ap-tftp -i 192.168.0.24 -f 1.4k.5.rom -c private
 169
 170 .SS Upgrading AP firmware in a device with RFMD radio:
 171 .BR
 172 .TP
 173 ap-tftp -i 192.168.1.100 -f 0.2.0.20.rom
 174 .TP
 175 ap-tftp -i 192.168.1.100 -f 0.2.2.20.rom
 176
 177 .SS Downgrading AP firmware in a device with RFMD radio:
 178 .BR
 179 .TP
 180 ap-tftp -i 192.168.1.100 -f 0.3.0.6.rom
 181 .TP
 182 ap-tftp -i 192.168.1.100 -f 0.3.2.6.rom
 183 .TP
 184 ap-tftp -i 192.168.1.100 -f 0.2.0.19.rom
 185 .TP
 186 ap-tftp -i 192.168.1.100 -f 0.2.2.19.rom
 187
 188 .SH KNOWN BUGS
 189 This utility has not been verified on and will probably not work on big-endian architectures. Its use is discouraged in such environment.
 190
 191 .SH AUTHOR
 192 Jan Rafaj <jr-aputils at cedric dot unob dot cz>
 193 .br
 194 http://ap-utils.polesye.net
 195
 196 .SH SEE ALSO
 197 ap-config(8), ap-trapd(8), ap-auth(8), ap-mrtg(8)
 198