README.md

   1 nmrpflash - Netgear Unbrick Utility
   2 ====================================
   3
   4 This program uses Netgear's [NMRP protocol]
   5 (http://www.chubb.wattle.id.au/PeterChubb/nmrp.html)
   6 to flash a new firmware image to a compatible device. This utility has been
   7 successfully used on a Netgear EX2700 and DNG3700v2, but is likely to work
   8 with many other Netgear routers as well.
   9
  10 Prebuilt binaries for Linux, OS X and Windows are available
  11 [here](https://github.com/jclehner/nmrpflash/releases)
  12 ([WinPcap](https://www.winpcap.org/install/default.htm) is required on Windows).
  13
  14 ```
  15 Usage: nmrpflash [OPTIONS...]
  16
  17 Options (-i and -f and/or -c are mandatory):
  18  -a <ipaddr>     IP address to assign to target device
  19  -A <ipaddr>     IP address to assign to interface
  20  -c <command>    Command to run before (or instead of) TFTP upload
  21  -f <firmware>   Firmware file
  22  -F <filename>   Remote filename to use during TFTP upload
  23  -i <interface>  Network interface directly connected to device
  24  -m <mac>        MAC address of target device (xx:xx:xx:xx:xx:xx)
  25  -M <netmask>    Subnet mask to assign to target device
  26  -t <timeout>    Timeout (in milliseconds) for regular messages
  27  -T <timeout>    Time (seconds) to wait after successfull TFTP upload
  28  -p <port>       Port to use for TFTP upload
  29  -R <region>     Set device region (NA, WW, GR, PR, RU, BZ, IN, KO, JP)
  30  -v              Be verbose
  31  -V              Print version and exit
  32  -L              List network interfaces
  33  -h              Show this screen
  34 ```
  35
  36 ### Using nmrpflash
  37
  38 Your Netgear router must be connected to your network using an
  39 Ethernet cable. The device running `nmrpflash` must be connected
  40 to the same network, using either Wi-Fi or Ethernet.
  41
  42 All available network interfaces can be listed using
  43
  44 ```
  45 # nmrpflash -L
  46 eth0      192.168.1.2  f2:11:a1:02:03:b1
  47 ```
  48
  49 Once you've determined the interface to use, we can flash the image. Firmware
  50 images can usually be downloaded directly from Netgear. For details on how to
  51 do this, see [here](#obtaining-firmware-images). Power on your device immediately
  52 after starting `nmrpflash`.
  53
  54 ```
  55 # nmrpflash -i eth0 -f EX2700-V1.0.1.8.img
  56 Advertising NMRP server on eth0 ... /
  57 Received configuration request from a4:2b:8c:00:00:01.
  58 Sending configuration: ip 10.164.183.252, mask 255.255.255.0.
  59 Received upload request: filename 'firmware'.
  60 Uploading EX2700-V1.0.1.8.img ... OK
  61 Waiting for remote to respond.
  62 Remote finished. Closing connection.
  63 Reboot your device now.
  64 ```
  65
  66 ### Common issues
  67
  68 In any case, run `nmrpflash` with `-vvv` before filing a bug report. Also,
  69 try connecting your Netgear router *directly* to the computer running
  70 `nmrpflash`.
  71
  72 ###### "Error while loading shared libraries: ..." (Linux)
  73
  74 You must install your Linux distribution's `libpcap` and `libnl-3`
  75 packages (exact names will vary depending on your distribution).
  76
  77 ###### "The program can't start because wpcap.dll is missing" (Windows)
  78
  79 Install [WinPcap](https://www.winpcap.org/install/default.htm).
  80
  81 ###### "No suitable network interfaces found."
  82
  83 Make sure the network interface is up (wireless interfaces are not supported).
  84 On Windows, try restarting the WinPcap service (commands must be run as
  85 administrator):
  86
  87 ```
  88 C:\> net stop npf
  89 C:\> net start npf
  90 ```
  91
  92 ###### "No response after 60 seconds. Bailing out."
  93
  94 The router did not respond. Try rebooting the device and run `nmrpflash` again.
  95 You could also try running `nmrpflash` with `-m` and specify your router's
  96 MAC address. It's also possible that your device does not support the NMRP protocol.
  97
  98 ###### "Timeout while waiting for initial reply."
  99
 100 The device did not respond to `nmrpflash`'s TFTP upload request. By default,
 101 `nmrpflash` will assign `10.164.183.252` to the target device, while adding `10.164.183.253`
 102 to the network interface specified by the `-i` flag. You can use `-a` to change the IP
 103 address assigned to the target (e.g. if your network is `192.168.1.0/24`, specify a *free*
 104 IP address, such as `-a 192.168.1.252`), and `-A` to change the IP address used for the
 105 network interface.
 106
 107 This error message could also indicate a bug in the TFTP code; try using an external tftp
 108 client (busybox in this example), by specifying the `-c` flag instead of the `-f` flag:
 109
 110 `# nmrpflash -i eth0 -c 'busybox tftp -p -l EX2700-V1.0.1.8.img $IP'`
 111
 112 The environment variable `IP` is set by `nmrpflash` (other environment variables
 113 are: `MAC`, `PORT`, `NETMASK`).
 114
 115 ###### "Timeout while waiting for CLOSE_REQ."
 116
 117 After a successful file upload, `nmrpflash` waits for up to 5 minutes for an
 118 answer from your device. You can increase this by specifying a longer timeout
 119 using `-T` switch (argument is in seconds).
 120
 121 It's entirely possible that the image was flashed successfully, but the
 122 operation took longer than 5 minutes.
 123
 124 ###### "Address X/Y cannot be used on interface Z."
 125
 126 `nmrpflash` refuses to use an IP address / subnet mask combination that would
 127 make the remote device unreachable from the device running `nmrpflash`. For
 128 example, if the IP address of your computer is 192.168.0.1/255.255.255.0, assigning
 129 192.168.2.1/255.255.255.0 to the router makes no sense, because the TFTP upload will
 130 fail.
 131
 132 ###### "IP address of X has changed. Please assign a static IP to the interface."
 133
 134 This can happen if the network interface in question automatically detects that
 135 the network cable has been connected, and your computer tries to reconfigure that
 136 interface (NetworkManager on Linux does this for example) - this can usually be
 137 disabled.
 138
 139 An alternative would be to add `-c 'ifconfig <interface> <ip>'` to the command line,
 140 for example:
 141
 142 `# nmrpflash -i eth0 -a 192.168.1.1 -f firmware.bin -c 'ifconfig eth0 192.168.1.2'`
 143
 144 This will execute the command specified by `-c` prior to starting the TFTP upload (in
 145 this case setting the IP address to 192.168.1.2).
 146
 147 ### Building and installing
 148 ###### Linux, Mac OS X, BSDs
 149
 150 ```
 151 $ make && sudo make install
 152 ```
 153
 154 ###### Windows
 155
 156 The repository includes a
 157 [DevCpp](http://sourceforge.net/projects/orwelldevcpp/)
 158 project file (`nmrpflash.dev`). Download the latest
 159 [WinPcap Developer Pack](https://www.winpcap.org/devel.htm)
 160 and extract it into the root folder of the nmrpflash sources.
 161
 162 ### Obtaining firmware images
 163
 164 Firmware images can be downloaded directly from Netgear's FTP servers.
 165 For the Netgear EX2700 for example, download
 166 ftp://updates1.netgear.com/ex2700/ww/fileinfo.txt. At the top there
 167 should be an entry like this:
 168
 169 ```
 170 [Major1]
 171 file=EX2700-V1.0.1.8.img
 172 ...
 173 ```
 174
 175 The download link for the latest firmware image for this device is thus:
 176 ftp://updates1.netgear.com/ex2700/ww/EX2700-V1.0.1.8.img. Substitute
 177 `ex2700` for your device (`wndr4300`, `wndr3700`, `r6100`, etc.). If
 178 neccessary, substitute `ww` (world-wide) for a specific region.
 179