[PATCH 8/9] MIPS: tplink-mr3020: add documentation

[Antony Pavlov]

Signed-off-by: Antony Pavlov <antonynpavlov at gmail.com>
---
 Documentation/boards.dox                         |  1 +
 arch/mips/boards/tplink-mr3020/tplink-mr3020.dox | 64 ++++++++++++++++++++++++
 2 files changed, 65 insertions(+)

diff --git a/Documentation/boards.dox b/Documentation/boards.dox
index 42bc5e6..8d4fabb 100644
--- a/Documentation/boards.dox
+++ b/Documentation/boards.dox
@@ -60,6 +60,7 @@ MIPS type:
 @li @subpage loongson_ls1b
 @li @subpage qemu_malta
 @li @subpage ritmix-rzx50
+ at li @subpage tplink-mr3020
 
 */
 
diff --git a/arch/mips/boards/tplink-mr3020/tplink-mr3020.dox b/arch/mips/boards/tplink-mr3020/tplink-mr3020.dox
new file mode 100644
index 0000000..16fe465
--- /dev/null
+++ b/arch/mips/boards/tplink-mr3020/tplink-mr3020.dox
@@ -0,0 +1,64 @@
+/** @page tplink-mr3020 TP-LINK MR3020 wireless router
+
+The router has
+ at li Atheros ar9331 SoC;
+ at li 32 MiB SDRAM;
+ at li 4 MiB NOR type SPI Flash Memory;
+ at li RS232 serial interface (LV-TTL levels on board!);
+ at li 1 USB interface;
+ at li 1 Ethernet interfaces;
+ at li 802.11b/g/n (WiFi) interface;
+ at li LEDs & buttons.
+
+The router uses U-Boot 1.1.4 as firmware.
+
+Barebox can be started from U-Boot using tftp.
+But you have to encode barebox image in a very special way.
+
+First obtain 'lzma' and 'mktplinkfw' utilities.
+
+The 'lzma' utility can be obtained in Debian/Ubuntu
+distro by installing lzma package.
+
+The 'mktplinkfw' utility can be obtained from openwrt, e.g.:
+
+ at verbatim
+$ OWRTPREF=https://raw.githubusercontent.com/mirrors/openwrt/master
+$ curl -OL $OWRTPREF/tools/firmware-utils/src/mktplinkfw.c \
+        -OL $OWRTPREF/tools/firmware-utils/src/md5.c \
+        -OL $OWRTPREF/tools/firmware-utils/src/md5.h
+$ cc -o mktplinkfw mktplinkfw.c md5.c
+ at endverbatim
+
+To convert your barebox.bin to U-Boot-loadable image (6F01A8C0.img)
+use this command sequence:
+
+ at verbatim
+$ lzma -c -k barebox.bin > barebox.lzma
+$ ./FW/mktplinkfw -c -H 0x07200103 -W 1 -N TL-WR720N-v3 \
+    -s -F 4Mlzma -k barebox.lzma -o 6F01A8C0.img
+ at endverbatim
+
+You must setup tftp-server on host 192.168.0.1.
+Put your 6F01A8C0.img to tftp-server directory
+(usual /tftpboot or /srv/tftp).
+Connect your board to your tftp-server network via Ethernet.
+
+Next, setup network on MR3020 and run 6F01A8C0.img, e.g.:
+ at verbatim
+hornet> set ipaddr 192.168.0.2
+hornet> set serverip 192.168.0.1
+hornet> tftpboot 0x81000000 6F01A8C0.img
+hornet> bootm 0x81000000
+ at endverbatim
+
+TP-LINK MR3020 links:
+ at li http://www.tp-link.com/en/products/details/?model=TL-MR3020
+ at li http://wiki.openwrt.org/toh/tp-link/tl-mr3020
+ at li https://wikidevi.com/wiki/TP-LINK_TL-MR3020
+
+See also:
+ at li http://www.eeboard.com/wp-content/uploads/downloads/2013/08/AR9331.pdf
+ at li http://squonk42.github.io/TL-WR703N/
+
+*/
-- 
1.9.0