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 tested with a Netgear EX2700, but is likely to work on many others as well.
   8
   9 Prebuilt binaries for Linux, OS X and Windows are available
  10 [here](https://github.com/jclehner/nmrpflash/releases)
  11 ([WinPcap](https://www.winpcap.org/install/default.htm) is required on Windows).
  12
  13 ```
  14 Usage: nmrpflash [OPTIONS...]
  15
  16 Options (-a, -i and -f and/or -c are mandatory):
  17  -a <ipaddr>     IP address to assign to target device
  18  -c <command>    Command to run before (or instead of) TFTP upload
  19  -f <firmware>   Firmware file
  20  -F <filename>   Remote filename to use during TFTP upload
  21  -i <interface>  Network interface directly connected to device
  22  -m <mac>        MAC address of target device (xx:xx:xx:xx:xx:xx)
  23  -M <netmask>    Subnet mask to assign to target device
  24  -t <timeout>    Timeout (in milliseconds) for regular messages
  25  -T <timeout>    Time (seconds) to wait after successfull TFTP upload
  26  -p <port>       Port to use for TFTP upload
  27  -R <region>     Set device region (NA, WW, GR, PR, RU, BZ, IN, KO, JP)
  28  -v              Be verbose
  29  -V              Print version and exit
  30  -L              List network interfaces
  31  -h              Show this screen
  32 ```
  33
  34 ### Using nmrpflash
  35
  36 Connect your Netgear router to your computer using a network cable.
  37 Assign a static IP address to the network adapter that's plugged into
  38 the Netgear router.
  39
  40 For this example, we'll assume that your network interface is `eth0`.
  41 First, we have to assign a static IP address to our network interface.
  42 In this example, we'll use `192.168.1.2`. All available network interfaces
  43 can be listed using
  44
  45 ```
  46 $ nmrpflash -L
  47 eth0      192.168.1.2  f2:11:a1:02:03:b1
  48 ```
  49
  50 Now we can `nmrpflash`. The argument for the `-a` option needs
  51 to be a *free* IP address from the same subnet as the one used by your
  52 network interface. We'll use `192.168.1.254`. Firmware images can usually
  53 be downloaded directly from netgear. For details on how to do this, see
  54 [here](#obtaining-firmware-images). Power on your device immediately
  55 after starting `nmrpflash`.
  56
  57 ```
  58 $ nmrpflash -i eth0 -a 192.168.1.254 -f EX2700-V1.0.1.8.img
  59 Advertising NMRP server on eth0 ... /
  60 Received configuration request from a4:2b:8c:00:00:01.
  61 Sending configuration: ip 192.168.1.254, mask 255.255.255.0.
  62 Received upload request: filename 'firmware'.
  63 Uploading EX2700-V1.0.1.8.img ... OK
  64 Waiting for remote to respond.
  65 Remote finished. Closing connection.
  66 Reboot your device now.
  67 ```
  68
  69 ### Common issues
  70 ###### "No suitable network interfaces found."
  71
  72 If you're *not* on Windows, rerun `nmrpflash -L` using `sudo`. In any case,
  73 use `-vvvL` to see more detailed messages, and file a bug report if applicable.
  74
  75 ###### "No response after 60 seconds. Bailing out."
  76
  77 The router did not respond. Try rebooting the device and run `nmrpflash` again.
  78 You could also try running `nmrpflash` with `-m` and specify your router's
  79 MAC address. It's also possible that your device does not support the NMRP protocol.
  80
  81 ###### "Timeout while waiting for initial reply."
  82
  83 The device did not respond to `nmrpflash`'s TFTP upload request. This could indicate a bug
  84 in the TFTP code; try using an external tftp client (busybox in this example), by specifying
  85 the `-c` flag instead of the `-f` flag:
  86
  87 `$ nmrpflash -i eth0 -a 192.168.1.254 -c "busybox tftp -p -l EX2700-V1.0.1.8.img 192.168.1.254"`
  88
  89 If the upload still fails, and you're on Windows, try executing the following command before
  90 running `nmrpflash`:
  91
  92 `C:\> netsh interface ip add neighbors <interface> <ip> <mac>`
  93
  94 where `<interface>` is the pretty interface name (e.g. "Local Area Connection"; as displayed by
  95 `nmrpflash -L`), `<ip>` is the same IP address you'd use for `nmrpflash`'s `-a` flag, and `<mac>`
  96 is the target device's mac address.
  97
  98 Cheers to @ntadmin for this info!
  99
 100 ###### "Timeout while waiting for CLOSE_REQ."
 101
 102 After a successful file upload, `nmrpflash` waits for up to 120 seconds for an
 103 answer from your device. You can increase this by specifying a longer timeout
 104 using `-T` switch (argument is in seconds).
 105
 106 It's entirely possible that the image was flashed successfully, but the
 107 operation took longer than 120 seconds.
 108
 109 ###### "Address X/Y cannot be used on interface Z."
 110
 111 `nmrpflash` refuses to use an IP address / subnet mask combination that would
 112 make the remote device unreachable from the device running `nmrpflash`. For
 113 example, if the IP address of your computer is 192.168.0.1/255.255.255.0, assigning
 114 192.168.2.1/255.255.255.0 to the router makes no sense, because the TFTP upload will
 115 fail.
 116
 117 ###### "IP address of X has changed. Please assign a static IP to the interface."
 118
 119 This can happen if the network interface in question automatically detects that
 120 the network cable has been connected, and your computer tries to reconfigure that
 121 interface (NetworkManager on Linux does this for example) - this can usually be
 122 disabled.
 123
 124 An alternative would be to add `-c 'ifconfig <interface> <ip>'` to the command line,
 125 for example:
 126
 127 `nmrpflash -i eth0 -a 192.168.1.1 -f firmware.bin -c 'ifconfig eth0 192.168.1.2'`
 128
 129 This will execute the command specified by `-c` prior to starting the TFTP upload (in
 130 this case setting the IP address to 192.168.1.2).
 131
 132 ### Building and installing
 133 ###### Linux, Mac OS X, BSDs
 134
 135 ```
 136 $ make && sudo make install
 137 ```
 138
 139 ###### Windows
 140
 141 The repository includes a
 142 [DevCpp](http://sourceforge.net/projects/orwelldevcpp/)
 143 project file (`nmrpflash.dev`). Download the latest
 144 [WinPcap Developer Pack](https://www.winpcap.org/devel.htm)
 145 and extract it into the root folder of the nmrpflash sources.
 146
 147 ### Obtaining firmware images
 148
 149 Firmware images can be downloaded directly from Netgear's FTP servers.
 150 For the Netgear EX2700 for example, download
 151 ftp://updates1.netgear.com/ex2700/ww/fileinfo.txt. At the top there
 152 should be an entry like this:
 153
 154 ```
 155 [Major1]
 156 file=EX2700-V1.0.1.8.img
 157 ...
 158 ```
 159
 160 The download link for the latest firmware image for this device is thus:
 161 ftp://updates1.netgear.com/ex2700/ww/EX2700-V1.0.1.8.img. Substitute
 162 `ex2700` for your device (`wndr4300`, `wndr3700`, `r6100`, etc.). If
 163 neccessary, substitute `ww` (world-wide) for a specific region.
 164