README.md

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