README.md

   1 nmrpflash - Netgear Unbrick Utility
   2 ====================================
   3
   4 This program 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. This utility has been
   6 successfully used on a Netgear EX2700 and DNG3700v2, but is likely to work
   7 with many other Netgear routers as well.
   8
   9 Prebuilt binaries for Linux, ~OS X~ macOS 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 (-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: ip 10.164.183.252, mask 255.255.255.0.
  57 Received upload request: filename 'firmware'.
  58 Uploading EX2700-V1.0.1.8.img ... OK
  59 Waiting for remote to respond.
  60 Remote finished. Closing connection.
  61 Reboot your device now.
  62 ```
  63
  64 ### Common issues
  65
  66 In any case, run `nmrpflash` with `-vvv` before filing a bug report. Also,
  67 try connecting your Netgear router *directly* to the computer running
  68 `nmrpflash`.
  69
  70 ###### "Error while loading shared libraries: ..." (Linux)
  71
  72 You must install your Linux distribution's `libpcap` and `libnl-3`
  73 packages (exact names will vary depending on your distribution).
  74
  75 ###### "The program can't start because wpcap.dll is missing" (Windows)
  76
  77 Install [WinPcap](https://www.winpcap.org/install/default.htm).
  78
  79 ###### "No suitable network interfaces found."
  80
  81 Make sure the network interface is up (wireless interfaces are not supported).
  82 On Windows, try restarting the WinPcap service (commands must be run as
  83 administrator):
  84
  85 ```
  86 C:\> net stop npf
  87 C:\> net start npf
  88 ```
  89
  90 ###### "No response after 60 seconds. Bailing out."
  91
  92 The router did not respond. Try rebooting the device and run `nmrpflash` again.
  93 You could also try running `nmrpflash` with `-m` and specify your router's
  94 MAC address. It's also possible that your device does not support the NMRP protocol.
  95
  96 ###### "Timeout while waiting for initial reply."
  97
  98 The device did not respond to `nmrpflash`'s TFTP upload request. By default,
  99 `nmrpflash` will assign `10.164.183.252` to the target device, while adding `10.164.183.253`
 100 to the network interface specified by the `-i` flag. You can use `-a` to change the IP
 101 address assigned to the target (e.g. if your network is `192.168.1.0/24`, specify a *free*
 102 IP address, such as `-a 192.168.1.252`), and `-A` to change the IP address used for the
 103 network interface.
 104
 105 This error message could also indicate a bug in the TFTP code; try using an external tftp
 106 client (busybox in this example), by specifying the `-c` flag instead of the `-f` flag:
 107
 108 `# nmrpflash -i eth0 -c 'busybox tftp -p -l EX2700-V1.0.1.8.img $IP'`
 109
 110 The environment variable `IP` is set by `nmrpflash` (other environment variables
 111 are: `MAC`, `PORT`, `NETMASK`).
 112
 113 ###### "Timeout while waiting for CLOSE_REQ."
 114
 115 After a successful file upload, `nmrpflash` waits for up to 5 minutes for an
 116 answer from your device. You can increase this by specifying a longer timeout
 117 using `-T` switch (argument is in seconds).
 118
 119 It's entirely possible that the image was flashed successfully, but the
 120 operation took longer than 5 minutes.
 121
 122 ###### "Address X/Y cannot be used on interface Z."
 123
 124 `nmrpflash` refuses to use an IP address / subnet mask combination that would
 125 make the remote device unreachable from the device running `nmrpflash`. For
 126 example, if the IP address of your computer is 192.168.0.1/255.255.255.0, assigning
 127 192.168.2.1/255.255.255.0 to the router makes no sense, because the TFTP upload will
 128 fail.
 129
 130 ###### "IP address of X has changed. Please assign a static IP to the interface."
 131
 132 This can happen if the network interface in question automatically detects that
 133 the network cable has been connected, and your computer tries to reconfigure that
 134 interface (NetworkManager on Linux does this for example) - this can usually be
 135 disabled.
 136
 137 An alternative would be to add `-c 'ifconfig <interface> <ip>'` to the command line,
 138 for example:
 139
 140 `# nmrpflash -i eth0 -a 192.168.1.1 -f firmware.bin -c 'ifconfig eth0 192.168.1.2'`
 141
 142 This will execute the command specified by `-c` prior to starting the TFTP upload (in
 143 this case setting the IP address to 192.168.1.2).
 144
 145 ### Building and installing
 146 ###### Linux, Mac OS X, BSDs
 147
 148 ```
 149 $ make && sudo make install
 150 ```
 151
 152 ###### Windows
 153
 154 The repository includes a
 155 [DevCpp](http://sourceforge.net/projects/orwelldevcpp/)
 156 project file (`nmrpflash.dev`). Download the latest
 157 [WinPcap Developer Pack](https://www.winpcap.org/devel.htm)
 158 and extract it into the root folder of the nmrpflash sources.
 159
 160
 161