README.md

   1 U-Boot 1.1.4 modification for routers
   2 ==========
   3
   4 Table of contents
   5 -----------------
   6
   7 [README w języku polskim/README in Polish language](https://github.com/pepe2k/u-boot_mod/blob/master/READMEPL.md)
   8
   9 - [Introduction](#introduction)
  10 - [Supported devices](#supported-devices)
  11 - [Known issues](#known-issues)
  12 - [Modifications, changes](#modifications-changes)
  13         - [Web server](#web-server)
  14         - [Network Console](#network-console)
  15         - [Writable environment variables](#writable-environment-variables)
  16         - [Other](#other)
  17         - [Supported FLASH chips](#supported-flash-chips)
  18 - [How to install it?](#how-to-install-it)
  19         - [Cautions, backups](#cautions-backups)
  20         - [Using external programmer](#using-external-programmer)
  21         - [Using UART, U-Boot console and TFTP server](#using-uart-u-boot-console-and-tftp-server)
  22                 - [Important notice!](#important-notice)
  23                 - [Step by step instructions](#step-by-step-instructions)
  24         - [Using OpenWrt](#using-openwrt)
  25         - [Using DD-WRT](#using-dd-wrt)
  26 - [How to use it?](#how-to-use-it)
  27 - [How to compile the code?](#how-to-compile-the-code)
  28 - [FAQ](#faq)
  29 - [License, outdated sources etc.](#license-outdated-sources-etc)
  30 - [Credits](#credits)
  31
  32 Introduction
  33 ------------
  34
  35 In short, this project is a deep modification of **U-Boot 1.1.4** sources, mostly from **TP-Link**, but some code fragments were taken also from **D-Link**, **Netgear**, **ZyXEL** and **Belkin**. All these companies are using SDK from Qualcomm/Atheros which includes modified version of **U-Boot 1.1.4**.
  36
  37 You can download original sources from the following pages:
  38
  39 - [TP-Link GPL Code Center](http://www.tp-link.com/en/support/gpl/ "TP-Link GPL Code Center")
  40 - [D-Link GPL Source Code Support](http://tsd.dlink.com.tw/GPL.asp "D-Link GPL Source Code Support")
  41 - [NETGEAR Open Source Code for Programmers (GPL)](http://kb.netgear.com/app/answers/detail/a_id/2649/~/netgear-open-source-code-for-programmers-%28gpl%29 "NETGEAR Open Source Code for Programmers (GPL)")
  42 - [ZyXEL GPL-OSS](http://www.zyxel.com/us/en/form/gpl_oss_form.shtml "ZyXEL GPL-OSS")
  43 - [Belkin Open Source Code Center](http://www.belkin.com/us/support-article?articleNum=51238 "Belkin Open Source Code Center")
  44
  45 The concept for this project came from another U-Boot modification, dedicated to a small and very popular TP-Link router - model **TL-WR703N**, which includes web fail safe mode: **[wr703n-uboot-with-web-failsafe](http://code.google.com/p/wr703n-uboot-with-web-failsafe/)**. I was using it and decided to make my own version, which could have some improvements, additional capabilities, support for different models and work with all modern web browsers.
  46
  47 First version of this modification was introduced on **OpenWrt** forum in [this thread](https://forum.openwrt.org/viewtopic.php?id=43237), at the end of March 2013 and was dedicated only for TP-Link routers with **Atheros AR9331** SoC. Now, it supports also models from different manufacturers, devices with **Atheros AR934x**, **Qualcomm Atheros QCA953x**, **Qualcomm Atheros QCA955x** and other (in the near future **Qualcomm Atheros QCA956x** and **MediaTek MT762x**) are under development.
  48
  49 You can find some information about previous versions of this project also on my [blog](http://www.tech-blog.pl), in [this article](http://www.tech-blog.pl/2013/03/29/zmodyfikowany-u-boot-dla-routerow-tp-link-z-atheros-ar9331-z-trybem-aktualizacji-oprogramowania-przez-www-i-konsola-sieciowa-netconsole/). It is in Polish, but [Google Translator](http://translate.google.com/translate?hl=pl&sl=pl&tl=en&u=http%3A%2F%2Fwww.tech-blog.pl%2F2013%2F03%2F29%2Fzmodyfikowany-u-boot-dla-routerow-tp-link-z-atheros-ar9331-z-trybem-aktualizacji-oprogramowania-przez-www-i-konsola-sieciowa-netconsole%2F&sandbox=1) will help you to understand it.
  50
  51 If you like this project, you may [buy me a beer](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=FN3XW36YHSY2S&lc=US&item_name=For%20a%20great%20job%21&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donate_LG%2egif%3aNonHosted)!
  52
  53 Supported devices
  54 -----------------
  55
  56 Currently supported devices:
  57
  58 - **Atheros AR9331**:
  59   - 8devices Carambola 2 (for version with development board, [photos in my gallery](http://galeria.tech-blog.pl/8devices_Carambola_2/))
  60   - TP-Link TL-MR3020 v1 ([photos in my gallery](http://galeria.tech-blog.pl/TPLINK_TL-MR3020/))
  61   - TP-Link TL-MR3040 v1 and v2
  62   - TP-Link TL-WR703N v1, ([photos in my gallery](http://galeria.tech-blog.pl/TPLINK_TL-WR703N/))
  63   - TP-Link TL-WR720N v3 (version for Chinese market)
  64   - TP-Link TL-WR710N v1 (version for European market, [photos in my gallery](http://galeria.tech-blog.pl/TP-Link_TL-WR710N-EU/))
  65   - TP-Link TL-MR10U v1 ([photos in my gallery](http://galeria.tech-blog.pl/TP-Link_TL-MR10U/))
  66   - TP-Link TL-MR13U v1
  67   - TP-Link TL-WR740N v4 (and similar, like TL-WR741ND v4)
  68   - TP-Link TL-MR3220 v2
  69   - GS-Oolite/Elink EL-M150 module with dev board ([photos in my gallery](http://galeria.tech-blog.pl/Elink_EL-M150_Development-Board/))
  70   - Dragino 2 (MS14)
  71   - Village Telco Mesh Potato 2 (based on Dragino MS14)
  72   - GL.iNet 64xxA ([photos in my gallery](http://galeria.tech-blog.pl/GLiNet/))
  73   - Black Swift
  74
  75 - **Atheros AR1311 (similar to AR9331)**
  76   - D-Link DIR-505 H/W ver. A1 ([photos in my gallery](http://galeria.tech-blog.pl/D-Link_DIR-505/))
  77
  78 - **Atheros AR9341**:
  79   - TP-Link TL-MR3420 v2
  80   - TP-Link TL-WR841N/D v8
  81   - TP-Link TL-WA830RE v2
  82   - TP-Link TL-WA801ND v2
  83
  84 - **Atheros AR9344**:
  85   - TP-Link TL-WDR3600 v1
  86   - TP-Link TL-WDR43x0 v1
  87   - TP-Link TL-WDR3500 v1
  88
  89 - **Qualcomm Atheros QCA953x**:
  90   - TP-Link TL-WR841N/D v9
  91   - TP-Link TL-WR820N (version for Chinese market)
  92   - TP-Link TL-WR802N
  93
  94 I tested this modification on most of these devices, with OpenWrt and OFW firmware. If you are not sure about the version of your device, please contact with me **before** you try to make an upgrade. Changing bootloader to a wrong version will probably damage your router and you will need special hardware to fix it, so please, **be very careful**.
  95
  96 More information about supported devices:
  97
  98 | Model | SoC | FLASH | RAM | U-Boot image | U-Boot env |
  99 |:--- | :--- | ---: | ---: | ---: | ---: |
 100 | [8devices Carambola 2](http://8devices.com/carambola-2) | AR9331 | 16 MiB | 64 MiB DDR2 | 256 KiB | 64 KiB, R/W |
 101 | [TP-Link TL-MR3020 v1](http://wiki.openwrt.org/toh/tp-link/tl-mr3020) | AR9331 | 4 MiB | 32 MiB DDR1 | 64 KiB, LZMA | RO |
 102 | [TP-Link TL-MR3040 v1/2](http://wiki.openwrt.org/toh/tp-link/tl-mr3040) | AR9331 | 4 MiB | 32 MiB DDR1 | 64 KiB, LZMA | RO |
 103 | [TP-Link TL-WR703N](http://wiki.openwrt.org/toh/tp-link/tl-wr703n) | AR9331 | 4 MiB | 32 MiB DDR1 | 64 KiB, LZMA | RO |
 104 | [TP-Link TL-WR720N v3](http://wiki.openwrt.org/toh/tp-link/tl-wr720n) | AR9331 | 4 MiB | 32 MiB DDR1 | 64 KiB, LZMA | RO |
 105 | [TP-Link TL-WR710N v1](http://wiki.openwrt.org/toh/tp-link/tl-wr710n) | AR9331 | 8 MiB | 32 MiB DDR1 | 64 KiB, LZMA | RO |
 106 | [TP-Link TL-MR10U v1](http://wiki.openwrt.org/toh/tp-link/tl-mr10u) | AR9331 | 4 MiB | 32 MiB DDR1 | 64 KiB, LZMA | RO |
 107 | [TP-Link TL-MR13U v1](http://wiki.openwrt.org/toh/tp-link/tl-mr13u) | AR9331 | 4 MiB | 32 MiB DDR1 | 64 KiB, LZMA | RO |
 108 | [TP-Link TL-WR740N v4](http://wiki.openwrt.org/toh/tp-link/tl-wr740n) | AR9331 | 4 MiB | 32 MiB DDR1 | 64 KiB, LZMA | RO |
 109 | [TP-Link TL-MR3220 v2](http://wiki.openwrt.org/toh/tp-link/tl-mr3420) | AR9331 | 4 MiB | 32 MiB DDR1 | 64 KiB, LZMA | RO |
 110 | GS-Oolite/Elink EL-M150 module | AR9331 | 4/8/16 MiB | 64 MiB DDR2 | 64 KiB, LZMA | RO |
 111 | [Dragino 2 (MS14)](http://wiki.openwrt.org/toh/dragino/ms14) | AR9331 | 16 MiB | 64 MiB DDR1 | 192 KiB | R/W |
 112 | Village Telco Mesh Potato 2 | AR9331 | 16 MiB | 64 MiB DDR1 | 192 KiB | R/W |
 113 | [GL.iNet](http://wiki.openwrt.org/toh/gl-inet/gl-inet) | AR9331 | 8/16 MiB | 64 MiB DDR1 | 64 KiB | RO |
 114 | [Black Swift](http://www.black-swift.com) | AR9331 | 16 MiB | 64 MiB DDR2 | 128 KiB, LZMA | R/W |
 115 | [TP-Link TL-MR3420 v2](http://wikidevi.com/wiki/TP-LINK_TL-MR3420_v2) | AR9341 | 4 MiB | 32 MiB DDR1 | 64 KiB, LZMA | RO |
 116 | [TP-Link TL-WR841N/D v8](http://wiki.openwrt.org/toh/tp-link/tl-wr841nd) | AR9341 | 4 MiB | 32 MiB DDR1 | 64 KiB, LZMA | RO |
 117 | [TP-Link TL-WA830RE v2](http://wikidevi.com/wiki/TP-LINK_TL-WA830RE_v2) | AR9341 | 4 MiB | 32 MiB DDR1 | 64 KiB, LZMA | RO |
 118 | [TP-Link TL-WA801ND v2](http://wikidevi.com/wiki/TP-LINK_TL-WA801ND_v2) | AR9341 | 4 MiB | 32 MiB DDR1 | 64 KiB, LZMA | RO |
 119 | [TP-Link TL-WDR3600 v1](http://wiki.openwrt.org/toh/tp-link/tl-wdr3600) | AR9344 | 8 MiB | 128 MiB DDR2 | 64 KiB, LZMA | RO |
 120 | [TP-Link TL-WDR43x0 v1](http://wiki.openwrt.org/toh/tp-link/tl-wdr4300) | AR9344 | 8 MiB | 128 MiB DDR2 | 64 KiB, LZMA | RO |
 121 | [TP-Link TL-WDR3500 v1](http://wiki.openwrt.org/toh/tp-link/tl-wdr3500) | AR9344 | 8 MiB | 128 MiB DDR2 | 64 KiB, LZMA | RO |
 122 | [D-Link DIR-505 H/W ver. A1](http://wiki.openwrt.org/toh/d-link/dir-505) | AR1311 | 8 MiB | 64 MiB DDR2 | 64 KiB, LZMA | RO |
 123 | [TP-Link TL-WR841N/D v9](https://wiki.openwrt.org/toh/tp-link/tl-wr841nd) | QCA9533 | 4 MiB | 32 MiB DDR1 | 64 KiB, LZMA | RO |
 124 | [TP-Link TL-WR820N](https://wiki.openwrt.org/toh/tp-link/tl-wr820n) | QCA9531 | 4 MiB | 64 MiB DDR2 | 64 KiB, LZMA | RO |
 125 | [TP-Link TL-WR802N](https://wikidevi.com/wiki/TP-LINK_TL-WR802N_v1.0) | QCA9533 | 4 MiB | 32 MiB DDR1 | 64 KiB, LZMA | RO |
 126
 127 *(LZMA) - U-Boot binary image is compressed with LZMA.*
 128 *(R/W) - environment exists in separate FLASH block which allows you to save it and keep after power down.*
 129 *(RO) - environment is read only, you can change and add new variables only during runtime.*
 130
 131 Known issues
 132 ------------
 133
 134 Current release is not loading kernel from some versions of TP-Link's official firmware. If you want to use the so-called OFW in any of supported TP-Link's router, do not use this modification. I am working on a solution for this issue.
 135
 136 Modifications, changes
 137 ----------------------
 138
 139 ### Web server
 140
 141 The most important change is an inclusion of a web server, based on **[uIP 0.9 TCP/IP stack](https://github.com/adamdunkels/uip/tags)**. It allows to upgrade **firmware**, **U-Boot** and **ART** (Atheros Radio Test) images, directly from your web browser, without need to access serial console and running a TFTP server. You can find similar firmware recovery mode, also based on uIP 0.9 TCP/IP stack, in **D-Link** routers.
 142
 143 Web server contains 7 pages:
 144
 145 1. index.html (allows to upgrade firmware image, screenshot below)
 146 2. uboot.html (allows to upgrade U-Boot image)
 147 3. art.html (allows to upgrade ART image)
 148 4. flashing.html
 149 5. 404.html
 150 6. fail.html
 151 7. style.css
 152
 153 ![](http://www.tech-blog.pl/wordpress/wp-content/uploads/2015/11/uboot_mod_firmware_upgrade.jpg)
 154
 155 ![](http://www.tech-blog.pl/wordpress/wp-content/uploads/2015/11/uboot_mod_firmware_upgrade_progress.jpg)
 156
 157 ![](http://www.tech-blog.pl/wordpress/wp-content/uploads/2015/11/uboot_mod_uboot_upgrade.jpg)
 158
 159
 160 ### Network Console
 161
 162 Second, very useful modification is a network console (it is a part of original U-Boot sources, but none of the manufacturers included it). It allows you to communicate with U-Boot console over the Ethernet, using UDP protocol (default UDP port: 6666, router IP: 192.168.1.1).
 163
 164 ![](http://www.tech-blog.pl/wordpress/wp-content/uploads/2013/04/u-boot_mod_for_tp-link_with_ar9331_netconsole.jpg)
 165
 166 You could also use netcat instead of Hercules utility on Mac/Linux:
 167 ```
 168 # nc -u -p 6666 192.168.1.1 6666
 169 ```
 170
 171 ### Writable environment variables
 172
 173 U-Boot uses special "**environment variables**" which are used for storing values of many different settings, like IP addresses of device and remote server for TFTP transaction, serial console baud rate, boot command, etc. Environment is usually stored in separate FLASH sector or its part, so all changes can be saved permanently.
 174
 175 None of the popular manufacturers provides this feature and use so called "**read-only environment**" (embedded in U-Boot image), which means that all changes made during a runtime will be lost after device restart and there is no way to store them in FLASH.
 176
 177 This modification uses writable environment variables in almost all supported devices, so you can do for example:
 178
 179 ```
 180 uboot> setenv ipaddr 192.168.1.100
 181 uboot> saveenv
 182 Saving environment to FLASH...
 183
 184 Erase FLASH from 0x9F010000 to 0x9F01FFFF in bank #1
 185 Erasing: #
 186
 187 Erased sectors: 1
 188
 189 Writting at address: 0x9F010000
 190
 191 uboot> reset
 192 ```
 193
 194 Which will change device IP address and save updated environment variables in FLASH. From next power up, the device will use new value for its IP address.
 195
 196 Using command **run** and writable environment variables you are able to write custom, small scripts like below example, used for firmware upgrade using TFTP method:
 197
 198 ```
 199 uboot> printenv
 200 [...]
 201 firmware_addr=0x9F020000
 202 firmware_name=firmware.bin
 203 firmware_upg=if ping $serverip; then tftp $loadaddr $firmware_name && erase $firmware_addr +$filesize && cp.b $loadaddr $firmware_addr $filesize && echo OK!; else echo ERROR! Server not reachable!; fi
 204 [...]
 205
 206 uboot> run firmware_upg
 207 Ethernet mode (duplex/speed): 1/100 Mbps
 208 Using eth0 device
 209
 210 Ping OK, host 192.168.1.2 is alive!
 211
 212
 213 TFTP from IP: 192.168.1.2
 214       Our IP: 192.168.1.1
 215     Filename: 'firmware.bin'
 216 Load address: 0x80800000
 217        Using: eth0
 218
 219      Loading: ########################################
 220               ########################################
 221               ########################################
 222               ########################################
 223               ########################################
 224               ########################################
 225               ########################################
 226               ########################################
 227               ########################################
 228               ########################################
 229               ########################################
 230               ########################################
 231               ########################################
 232               ########################################
 233               ########################################
 234               ########################################
 235               ########################################
 236               ########################################
 237               ########################################
 238               #########
 239
 240 TFTP transfer complete!
 241
 242 Bytes transferred: 3932160 (0x3c0000)
 243 Erase FLASH from 0x9F020000 to 0x9F3DFFFF in bank #1
 244 Erasing: #######################################
 245          #####################
 246
 247 Erased sectors: 60
 248
 249 Copying to FLASH...
 250 Writting at address: 0x9F020000
 251
 252 Done!
 253
 254 OK!
 255 uboot>
 256 ```
 257
 258 ### Other
 259
 260 Moreover:
 261
 262 - Faster boot up
 263 - Unnecessary information from boot up sequence were removed
 264 - FLASH chip is automatically recognized (using JEDEC ID)
 265 - Ethernet MAC is set from FLASH (no more "No valid address in FLASH. Using fixed address")
 266 - Automatic kernel booting can be interrupted using any key
 267 - Better UART serial console driver with support for different baud rates
 268 - Press and hold reset button to run:
 269   - Web server (min. 3 seconds)
 270   - U-Boot serial console (min. 5 seconds)
 271   - U-Boot network console (min. 7 seconds)
 272 - Additional commands (in comparison to the default version; availability depends on router model):
 273   -  defenv
 274   -  httpd
 275   -  itest
 276   -  loadb
 277   -  loady
 278   -  printmac
 279   -  setmac
 280   -  printmodel
 281   -  printpin
 282   -  startnc
 283   -  startsc
 284   -  ping
 285   -  dhcp
 286   -  sntp
 287   -  iminfo
 288 - Overclocking and underclocking possibilities (for now, only routers with AR9331)
 289
 290 ### Supported FLASH chips
 291
 292 FLASH type detection may be very useful for people who has exchanged the FLASH chip in their routers. You will not need to recompile U-Boot sources, to have access to overall FLASH space in U-Boot console.
 293
 294 If you use FLASH type which is not listed below, this version of U-Boot will try to get information about the chip using **Serial Flash Discoverable Parameter** (**SFDP**, more information: https://www.jedec.org/standards-documents/docs/jesd216b) standard. If your chip does not support SFDP, it will use default size for your router and, in most supported models, updating the ART image will not be available.
 295
 296 Currently supported FLASH types:
 297
 298 **4 MiB**:
 299
 300 - Spansion S25FL032P (4 MiB, JEDEC ID: 01 0215)*
 301 - Atmel AT25DF321 (4 MiB, JEDEC ID: 1F 4700)
 302 - EON EN25Q32 (4 MiB, JEDEC ID: 1C 3016)*
 303 - EON EN25F32 (4 MiB, JEDEC ID: 1C 3116)*
 304 - Micron M25P32 (4 MiB, JEDEC ID: 20 2016)
 305 - Windbond W25Q32 (4 MiB, JEDEC ID: EF 4016)
 306 - Macronix MX25L320 (4 MiB, JEDEC ID: C2 2016)
 307
 308 **8 MiB**:
 309
 310 - Spansion S25FL064P (8 MiB, JEDEC ID: 01 0216)
 311 - Atmel AT25DF641 (8 MiB, JEDEC ID: 1F 4800)
 312 - EON EN25Q64 (8 MiB, JEDEC ID: 1C 3017)*
 313 - Micron M25P64 (8 MiB, JEDEC ID: 20 2017)
 314 - Windbond W25Q64 (8 MiB, JEDEC ID: EF 4017)*
 315 - Macronix MX25L64 (8 MiB, JEDEC ID: C2 2017, C2 2617)
 316
 317 **16 MiB**:
 318
 319 - Winbond W25Q128 (16 MB, JEDEC ID: EF 4018)*
 320 - Macronix MX25L128 (16 MB, JEDEC ID: C2 2018, C2 2618)
 321 - Spansion S25FL127S (16 MB, JEDEC ID: 01 2018)*
 322 - Micron N25Q128 (16 MB, JEDEC ID: 20 BA18)
 323
 324 (*) tested
 325
 326 If you want to use other type, please contact with me or make changes in the code, test them and send a pull request or a patch.
 327
 328 How to install it?
 329 ------------------
 330
 331 ### Cautions, backups
 332
 333 **You do so at your own risk!**
 334 **If you make any mistake or something goes wrong during upgrade, in worst case, your router will not boot again!**
 335
 336 It is a good practice to backup your original U-Boot image/partition (especially for TP-Link devices) **before** you make any changes. For example, using OpenWrt (TP-Link TL-WR703N with 16 MiB FLASH):
 337
 338 ```
 339 cat /proc/mtd
 340 ```
 341
 342 This command will show you all **MTD** (Memory Technology Device) partitions:
 343
 344 ```
 345 dev:    size   erasesize  name
 346 mtd0: 00020000 00010000 "u-boot"
 347 mtd1: 000eeb70 00010000 "kernel"
 348 mtd2: 00ee1490 00010000 "rootfs"
 349 mtd3: 00c60000 00010000 "rootfs_data"
 350 mtd4: 00010000 00010000 "art"
 351 mtd5: 00fd0000 00010000 "firmware"
 352 ```
 353
 354 As you can see, `u-boot` partition size is **0x20000** (128 KiB) and my image for this model has smaller size: **0x1EC00** (123 KiB) - it is a very important difference! You should remember about this if you want to use `mtd` utility or serial console and U-Boot command line, to change the bootloader.
 355
 356 To backup `u-boot` partition in RAM, run:
 357
 358 ```
 359 cat /dev/mtd0 > /tmp/uboot_backup.bin
 360 ```
 361
 362 And then connect to your router using `SCP protocol` and download from `/tmp` the `uboot_backup.bin` file.
 363
 364 ### Using external programmer
 365
 366 If you have an external FLASH programmer (all supported devices have **SPI NOR FLASH** chips), you probably know how to use it. Download package with prebuilt images or compile the code, choose right file for your device and put it on FLASH at the beginning (offset `0x00000`). Remember to first erase block(s) - with high probability, if you use some kind of automatic mode, the programmer will do it for you.
 367
 368 All prebuilt images are padded with 0xFF and since change "**![Extend maximum U-Boot image size up to 123 KB](https://github.com/pepe2k/u-boot_mod/commit/7829f50c0e92024fde613cb01e65cbdeae1f126b)**", in most supported devices, **their size is no longer a multiple of 64 KiB block**. For example, **TP-Link** uses only first **64 KiB** block to store compressed U-Boot image (in most of their modern devices). In the second 64 KiB block they store additional information like MAC address, model number and WPS pin number. This modification will use both sectors for U-Boot image and also other data, including small block for writable environment variables.
 369
 370 Below image with beginning part of FLASH memory map for TP-Link TL-MR3020 shows differences between stock version and this modification.
 371
 372 ![](http://www.tech-blog.pl/wordpress/wp-content/uploads/2016/03/mr3020_u-boot-modification_flash-map_comparison.png)
 373
 374 On the other hand, U-Boot image in **Carambola 2** from **8devices** may have up to **256 KiB** (4x 64 KiB block), they use uncompressed version and environment stored in FLASH. Immediately after the Carambola 2 U-Boot partition is an area which contains U-Boot environment variables (1x 64 KiB block), called `u-boot-env`:
 375
 376 ```
 377 dev:    size   erasesize  name
 378 mtd0: 00040000 00010000 "u-boot"
 379 mtd1: 00010000 00010000 "u-boot-env"
 380 mtd2: 00f90000 00010000 "firmware"
 381 mtd3: 00e80000 00010000 "rootfs"
 382 mtd4: 00cc0000 00010000 "rootfs_data"
 383 mtd5: 00010000 00010000 "nvram"
 384 mtd6: 00010000 00010000 "art"
 385 ```
 386
 387 ### Using UART, U-Boot console and TFTP server
 388
 389 **WARNING! This method is highly not recommended!**
 390
 391 It is probably the most common method to change firmware in case of any problems. Main disadvantage of this approach is the need to connect with device using a serial port (this does not apply to Carambola 2 with development board, which already has a built-in USB-UART adapter, based on FTDI FT232RQ).
 392
 393 #### Important notice!
 394
 395 All these devices have an UART interface integrated inside the SoC, which operates at TTL 3.3 V (in fact, GPIO pins can work at this voltage, but their real range is < 3 V)!
 396
 397 Please, **do not** connect any RS232 +/- 12 V cable or any adapter without logic level converter, because it may damage your device. It would be the best if you use any USB to UART adapter with integrated 3.3 V logic level converter. And please, remember that **you should connect only RX, TX and GND signals**. **DO NOT** connect together 3.3 V signals from router and from adapter if you do not know what are you doing, because you may burn out your adapter and/or router! Connect the adapter using USB port in your PC and router with original power supply.
 398
 399 For a long time I have been using without any problems a small and very cheap (about 1-2 USD) **CP2102** based adapter. Go to [Serial Console article in OpenWrt Wiki](http://wiki.openwrt.org/doc/hardware/port.serial) for more, detailed information.
 400
 401 #### Step by step instructions
 402
 403 1. Install and configure any **TFTP server** on your PC (on Windows, you can use [TFTP32](http://tftpd32.jounin.net)).
 404
 405 2. Set a fixed IP address on your PC (in this tutorial we will use **192.168.1.2** for the PC and **192.168.1.1** for the router) and connect it to the router, using RJ45 network cable (in most case you will need to use one of the available LAN ports, but WAN port should also work).
 406
 407 3. Connect USB to UART adapter to the router and start any application to communicate with it, like [PuTTY](http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html).
 408 Configure adapter to use the following settings:
 409   * Baud rate: 115200
 410   * Data bits: 8
 411   * Parity control: none
 412   * Stop bits: 1
 413   * Handshaking: none
 414 4. Power on the router, wait for a line like one of the following and interrupt the process of loading a kernel:
 415
 416   `Autobooting in 1 seconds` (for most **TP-Link** routers, you should enter `tpl` at this point)
 417   `Hit ESC key to stop autoboot:  1` (for **8devices Carambola 2**, use `ESC` key)
 418   `Hit any key to stop autoboot:  1` (for **D-Link DIR-505**, use any key)
 419
 420 5. Set `ipaddr` and `serverip` environment variables:
 421
 422   ```
 423   hornet> setenv ipaddr 192.168.1.1
 424   hornet> setenv serverip 192.168.1.2
 425   ```
 426 6. Check the changes:
 427
 428   ```
 429   hornet> printenv ipaddr
 430   ipaddr=192.168.1.1
 431   hornet> printenv serverip
 432   serverip=192.168.1.2
 433   ```
 434
 435 7. Due to differences in FLASH memory map and sizes of original and modified version of U-Boot, you must first make a backup of the partition with original version in RAM. **If you skip this step or make a mistake, your device will be probably broken!**
 436
 437   This step is different between supported models, so you should pay attention to the size of image with modified version of U-Boot, **round it to the nearest multiple of 64 KiB** and use this value in all next steps.
 438
 439   For example, if image of the modified version is **123 KiB** (**0x1EC00**) you must first make a backup of **128 KiB** (**0x20000**) in RAM, at the same address where you are going to download the image:
 440
 441   ```
 442   hornet> cp.b 0x9F000000 0x80800000 0x20000
 443   ```
 444
 445   Using the same offset address in RAM for backup and new image will end up with combination of both images and preserve additional data like MAC address, model number and PIN.
 446
 447 8. Download and store in RAM proper image for your router, using `tftpboot` command in U-Boot console (in this example, for **TP-Link TL-MR3020**):
 448
 449   ```
 450   hornet> tftpboot 0x80800000 uboot_for_tp-link_tl-mr3020.bin
 451   eth1 link down
 452   Using eth0 device
 453   TFTP from server 192.168.1.2; our IP address is 192.168.1.1
 454   Filename 'uboot_for_tp-link_tl-mr3020.bin'.
 455   Load address: 0x80800000
 456   Loading: #########################
 457   done
 458   Bytes transferred = 125952 (1ec00 hex)
 459
 460   hornet>
 461   ```
 462
 463 9. Next step is very risky! You are going to delete existing U-Boot image from FLASH in your device and copy from RAM the new one. If something goes wrong (for example, a power failure), your router, without bootloader, will not boot again!
 464
 465   You should also note the size of image and use value from step 7. In all cases, the start address of FLASH is **0x9F000000** and for RAM: **0x80000000** (as you may noticed, I did not use start address of RAM to store image and you should follow this approach).
 466
 467   Please, do not make any mistake with offsets and sizes during next steps!
 468
 469 10. Erase appropriate FLASH space for new U-Boot image (this command will remove default U-Boot image!):
 470
 471   ```
 472   hornet> erase 0x9F000000 +0x20000
 473
 474   First 0x0 last 0x1 sector size 0x10000
 475   Erased 2 sectors
 476   hornet>
 477   ```
 478
 479 11. Now your router does not have U-Boot, so do not wait and copy to FLASH the new one, stored earlier in RAM:
 480
 481   ```
 482   hornet> cp.b 0x80800000 0x9F000000 0x20000
 483
 484   Copy to Flash... write addr: 9f000000
 485   done
 486   ```
 487
 488 12. If you want, you can check content of the newly written FLASH and compare it to the image on your PC (or better also do such a "legit memory content" comparison prior to writing!), using `md` command in U-Boot console, which prints indicated memory area (press only ENTER after first execution of this command to move further in memory):
 489
 490   ```
 491   hornet> md 0x9F000000
 492
 493   9f000000: 100000ff 00000000 100000fd 00000000    ................
 494   9f000010: 10000222 00000000 10000220 00000000    ..."....... ....
 495   9f000020: 1000021e 00000000 1000021c 00000000    ................
 496   9f000030: 1000021a 00000000 10000218 00000000    ................
 497   9f000040: 10000216 00000000 10000214 00000000    ................
 498   9f000050: 10000212 00000000 10000210 00000000    ................
 499   9f000060: 1000020e 00000000 1000020c 00000000    ................
 500   9f000070: 1000020a 00000000 10000208 00000000    ................
 501   9f000080: 10000206 00000000 10000204 00000000    ................
 502   9f000090: 10000202 00000000 10000200 00000000    ................
 503   9f0000a0: 100001fe 00000000 100001fc 00000000    ................
 504   9f0000b0: 100001fa 00000000 100001f8 00000000    ................
 505   9f0000c0: 100001f6 00000000 100001f4 00000000    ................
 506   9f0000d0: 100001f2 00000000 100001f0 00000000    ................
 507   9f0000e0: 100001ee 00000000 100001ec 00000000    ................
 508   9f0000f0: 100001ea 00000000 100001e8 00000000    ................
 509   ```
 510
 511 12. If you are sure that everything went OK, you may reset the board using below command or just reset power:
 512
 513   ```
 514   hornet> reset
 515   ```
 516
 517 ### Using OpenWrt
 518
 519 **This method is recommended!**
 520
 521 Starting from official release "**[2014-11-19](https://github.com/pepe2k/u-boot_mod/releases/tag/2014-11-19)**", you will find ready **OpenWrt** images, with unlocked `u-boot` partition, embedded U-Boot image and dedicated small script for easy update process inside release tarball. All you need to do is download last release, select proper OpenWrt image for your device, install it and invoke one command: `u-boot-upgrade`:
 522
 523 ```
 524 root@OpenWrt:/# u-boot-upgrade
 525
 526 =================================================================
 527      DISCLAIMER: you are using this script at your own risk!
 528
 529      The author of U-Boot modification and this script takes
 530      no responsibility for any of the results of using them.
 531
 532           Updating U-Boot is a very dangerous operation
 533         and may damage your device! You have been warned!
 534 =================================================================
 535    Are you sure you want to continue (type 'yes' or 'no')? yes
 536 =================================================================
 537
 538 [ ok ] Found U-Boot image file: uboot_for_tp-link_tl-mr3020.bin
 539        Do you want to use this file (type 'yes' or 'no')? yes
 540 [ ok ] MD5 checksum of new U-Boot image file is correct
 541 [ ok ] Backup of /dev/mtd0 successfully created
 542        Do you want to store backup in /etc/u-boot_mod/backup/ (recommended, type 'yes' or 'no')? no
 543 [ ok ] New U-Boot image successfully combined with backup file
 544 [info] New U-Boot image is ready to be written into FLASH
 545        Are you sure you want to continue (type 'yes' or 'no')? yes
 546 [ ok ] New U-Boot image successfully written info FLASH
 547 [ ok ] MD5 checksum of mtd0 and new U-Boot image are equal
 548 [info] Done!
 549 ```
 550
 551 ### Using DD-WRT
 552
 553 **WARNING! This method is not recommended!**
 554
 555 1. Login into the router using telnet or SSH and find out which of the mtd partitions is the first one. In DD-WRT it is usally called `RedBoot`:
 556
 557   ```
 558   root@DD-WRT:~# cat /proc/mtd
 559   dev:    size   erasesize  name
 560   mtd0: 00020000 00010000 "RedBoot"
 561   mtd1: 003c0000 00010000 "linux"
 562   mtd2: 002c0000 00010000 "rootfs"
 563   mtd3: 00010000 00010000 "ddwrt"
 564   mtd4: 00010000 00010000 "nvram"
 565   mtd5: 00010000 00010000 "board_config"
 566   mtd6: 00400000 00010000 "fullflash"
 567   mtd7: 00020000 00010000 "fullboot"
 568   ```
 569
 570   In this case, for **TP-Link TL-MR3020**, the `RedBoot` partition is the one, which contains U-Boot and additional data (MAC address, model number, PIN).
 571
 572   **Warning!** If size of the first partition is smaller than the size of the modified U-Boot image, you should not continue!
 573
 574 2. Using SCP or other method, transfer the new U-Boot image and corresponding MD5 file to the `/tmp` folder in device.
 575
 576   ```
 577   root@DD-WRT:/tmp# ls -la
 578   [...]
 579   -rw-r--r--    1 root     root        125952 Nov  5  2015 uboot_for_tp-link_tl-mr3020.bin
 580   -rw-r--r--    1 root     root            66 Nov  5  2015 uboot_for_tp-link_tl-mr3020.md5
 581   [...]
 582   ```
 583
 584 3. Verify the MD5 sum of the image:
 585
 586   ```
 587   root@DD-WRT:/tmp# md5sum uboot_for_tp-link_tl-mr3020.bin
 588   aaae0f772ce007f7d1542b9233dd765b  uboot_for_tp-link_tl-mr3020.bin
 589
 590   root@DD-WRT:/tmp# cat uboot_for_tp-link_tl-mr3020.md5
 591   aaae0f772ce007f7d1542b9233dd765b *uboot_for_tp-link_tl-mr3020.bin
 592   ```
 593
 594 4. Make a backup of the current `RedBoot` partition (`mtd0`):
 595
 596   ```
 597   root@DD-WRT:/tmp# dd if=/dev/mtd0 of=uboot_factory.bin
 598   256+0 records in
 599   256+0 records out
 600   ```
 601
 602 5. Using SCP or other method, transfer backuped `RedBoot` original partition to some safe place (I highly recommended you to save backup somewhere!).
 603
 604 6. You need to combine together original image and the one with U-Boot modification, but it seems that `dd` from DD-WRT does not support `conv=notrunc`, so we will use different approach:
 605
 606   ```
 607   root@DD-WRT:/tmp# dd if=uboot_factory.bin of=uboot_rest.bin bs=1 skip=$(wc -c < uboot_for_tp-link_tl-mr3020.bin)
 608   5120+0 records in
 609   5120+0 records out
 610
 611   root@DD-WRT:/tmp# cat uboot_for_tp-link_tl-mr3020.bin uboot_rest.bin > uboot_new.bin
 612   ```
 613
 614 7. **Danger**: This is the point of no return, if you have any errors or problems, please revert the original image at any time using:
 615
 616   ```
 617   root@DD-WRT:/tmp# mtd write uboot_factory.bin "RedBoot"
 618   Unlocking RedBoot ...
 619   Writing from uboot_orig.bin to RedBoot ...
 620   ```
 621
 622 8. Now, to actually flash the new image, run:
 623
 624   ```
 625   root@DD-WRT:/tmp# mtd write uboot_new.bin "RedBoot"
 626   Unlocking RedBoot ...
 627   Writing from uboot_new.bin to RedBoot ...
 628   ```
 629
 630 9. If you are sure that everything went OK, you may reboot the device:
 631
 632   ```
 633   root@DD-WRT:/tmp# reboot
 634   ```
 635
 636 How to use it?
 637 --------------
 638
 639 [TODO]
 640
 641 How to compile the code?
 642 ------------------------
 643
 644 You can use one of the free toolchains:
 645
 646 - [OpenWrt Toolchain for AR71xx MIPS](https://downloads.openwrt.org/snapshots/trunk/ar71xx/generic/OpenWrt-Toolchain-ar71xx-generic_gcc-5.3.0_musl-1.1.14.Linux-x86_64.tar.bz2),
 647 - ~~[Sourcery CodeBench Lite Edition for MIPS GNU/Linux](https://sourcery.mentor.com/GNUToolchain/subscription3130?lite=MIPS)~~,
 648 - [ELDK (Embedded Linux Development Kit)](ftp://ftp.denx.de/pub/eldk/),
 649 - or any others...
 650
 651 I am using **OpenWrt Toolchain for AR71xx MIPS** (32-bit, virtual machine) and all released binary images were/will be built using this set.
 652
 653 All you need to do, after choosing a toolchain, is to modify [Makefile](Makefile) - change or remove `export MAKECMD` and if needed add `export PATH`. For example, to use OpenWrt Toolchain instead of Sourcery CodeBench Lite, download it and extract into `toolchain` folder, inside the top dir and change first lines in [Makefile](Makefile):
 654
 655 ```
 656 export BUILD_TOPDIR=$(PWD)
 657 export STAGING_DIR=$(BUILD_TOPDIR)/tmp
 658
 659 export MAKECMD=make --silent ARCH=mips CROSS_COMPILE=mips-openwrt-linux-uclibc-
 660 export PATH:=$(BUILD_TOPDIR)/toolchain/bin/:$(PATH)
 661 ```
 662
 663 To build image, run `make model` inside top dir, for example, command:
 664
 665 ```
 666 make tplink_wr703n
 667 ```
 668
 669 will start building U-Boot image for **TP-Link TL-WR703N**.
 670
 671 FAQ
 672 ---
 673
 674 #### 1. My device is not supported, but has the same hardware as one in the list, can I use this modification?
 675
 676 *It could be dangerous! I know that a lot of routers uses the same hardware - for example, TP-Link has a battery powered routers set, which contains: TL-MR10U, TL-MR11U (TL-MR3040 in Europe) TL-MR12U and TL-MR13U. All of them has the same platform: Atheros AR9331 with 32 MiB of DDR RAM and 4 MiB of SPI NOR FLASH. But, there may exist a slight difference, like GPIO pin number for reset button or LED(s), that may cause problems.*
 677
 678 *You can try, but remember that you are doing this only at your own risk!*
 679
 680 #### 2. I want to overclock my router, how can I do this?
 681
 682 *Currently, this option is available only for routers with Atheros AR9331 (please, look at [ap121.h](u-boot/include/configs/ap121.h) file which contains all information about PLL register configuration and an untypical clocks for CPU, RAM and AHB). What more, you will need to compile the code yourself, because I will not publish images with non-default clocks.*
 683
 684 *And again, remember that you are doing this only at your own risk!*
 685
 686 #### 3. Do you test all prebuilt images before you publish them?
 687
 688 *No, because I do not have all supported devices, only few of them. But, I make tests for every supported SoC types.*
 689
 690 #### 4. I would like you to add support for device X.
 691
 692 *You can do it yourself and send me a pull request or a patch. If you do not want to, or do not know how to do it, please contact with me directly.*
 693
 694 #### 5. My device does not boot after upgrade!
 695
 696 *I told you... bootloader, in this case U-Boot, is the most important piece of code inside your device. It is responsible for hardware initialization and booting an OS (kernel in this case), i.e. it is the bridge head for delegating to / flashing kernel and rootfs images. So, if during the upgrade something went wrong, your device will not boot any more. The only way to recover from such a situation in a mild way is via a JTAG adapter connection. In case of a lack of JTAG connection, you would even need to remove the FLASH chip, load proper image using an external programmer and solder it back.*
 697
 698 License, outdated sources etc.
 699 ------------------------------
 700
 701 **[U-Boot](http://www.denx.de/wiki/U-Boot/WebHome "U-Boot")** project is Free Software, licensed under version 2 of the **GNU General Public License**. All information about license, contributors etc., are included with sources, inside *u-boot* folder.
 702
 703 You should know, that most routers, especially those based on Atheros SoCs, uses very old versions of U-Boot (1.1.4 is from 2005/2006). So, *these sources are definitely outdated* (do not even try to merge them with official release), but it was easier for me to modify them, than move TP-Link/Atheros changes to the current version. Moreover, lot of unnecessary code fragments and source files were removed for ease of understanding the code.
 704
 705 Credits
 706 -------
 707
 708 - Thanks to M-K O'Connell for donating a router with QCA9563
 709 - Thanks to Krzysztof M. for donating a TL-WDR3600 router
 710 - Thanks to *pupie* from OpenWrt forum for his great help
 711 - Thanks for all donators and for users who contributed in code development