Use longer name for Black Swift board defines, BSB doesn't say too much
[oweals/u-boot_mod.git] / READMEPL.md
1 Modyfikacja U-Boot 1.1.4 dla routerów
2 ==========
3
4 Spis treści
5 -----------
6
7 - [Wstęp](#wstęp)
8 - [Wspierane urządzenia](#wspierane-urządzenia)
9 - [Znane błędy](#znane-błędy)
10 - [Modyfikacje, zmiany](#modyfikacje-zmiany)
11         - [Serwer web](#serwer-web)
12         - [Konsola sieciowa](#konsola-sieciowa)
13         - [Inne](#inne)
14         - [Automatycznie rozpoznawane kości FLASH](#automatycznie-rozpoznawane-kości-flash)
15 - [Jak to zainstalować?](#jak-to-zainstalować)
16         - [Uwagi, kopie zapasowe](#uwagi-kopie-zapasowe)
17         - [Przy pomocy programatora FLASH](#przy-pomocy-programatora-flash)
18         - [Przy pomocy UART, konsoli U-Boot i serwera TFTP](#przy-pomocy-uart-konsoli-u-boot-i-serwera-tftp)
19                 - [Ważna informacja!](#ważna-informacja)
20                 - [Instrukcja krok po kroku](#instrukcja-krok-po-kroku)
21         - [Przy pomocy OpenWrt](#przy-pomocy-openWrt)
22         - [Przy pomocy DD-WRT](#przy-pomocy-dd-wrt)
23 - [Jak korzystać z tej modyfikacji?](#jak-korzystać-z-tej-modyfikacji)
24 - [Jak samodzielnie skompilować kod?](#jak-samodzielnie-skompilować-kod)
25 - [FAQ](#faq)
26 - [Licencja, przestarzałe źródła itd.](#licencja-przestarzałe-źródła-itd)
27 - [Podziękowania](#podziękowania)
28
29 Wstęp
30 -----
31
32 W dużym skrócie, projekt ten jest modyfikacją źródeł **U-Boot 1.1.4**, przede wszystkim z archiwum udostęþnionego przez firmę **TP-Link**. Niektóre fragmenty kodu zostały zaczerpnięte również ze źródeł innych producentów, np. **D-Link**.
33
34 Oryginalne wersje źródeł można pobrać z poniższych stron:
35
36 - [TP-Link GPL Code Center](http://www.tp-link.com/en/support/gpl/ "TP-Link GPL Code Center")
37 - [D-Link GPL Source Code Support](http://tsd.dlink.com.tw/GPL.asp "D-Link GPL Source Code Support")
38
39 Pomysł na tę modyfikację został zaczerpnięty z innego projektu, przeznaczonego dla bardzo popularnego, małego routera mobilnego **TP-Link TL-WR703N**, w którym autor umieścił tryb ratunkowy dostępny przez przeglądarkę: **[wr703n-uboot-with-web-failsafe](http://code.google.com/p/wr703n-uboot-with-web-failsafe/)**. Przez jakiś czas z powodzeniem używałem tej modyfikacji, ale postanowiłem ją ulepszyć, dodać kilka opcji i wsparcie dla innych modeli oraz wszystkich przeglądarek.
40
41 Pierwszą wersję mojej modyfikacji zaprezentowałem na forum **OpenWrt**, w [tym wątku](https://forum.openwrt.org/viewtopic.php?id=43237), pod koniec marca 2013 roku. Zawierała ona wsparcie wyłącznie dla modeli TP-Link z układem SoC **Atheros AR9331**. Obecnie, wspierane są również urządzenia innych producentów, w tym z układem SoC **Atheros AR934x** (**TP-Link TL-WDR3600**, **TL-WDR43x0**, **TL-WR841N/D v8**, **TL-WA830RE v2**), a inne (w najbliższych planach jest wsparcie dla routerów z układami z serii **Qualcomm Atheros QCA955x**) są w trakcie opracowania.
42
43 Dodatkowe informacje o niniejszej modyfikacji można znaleźć również na [moim blogu](http://www.tech-blog.pl), w [tym artykule](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/).
44
45 Jeżeli spodobał Ci się ten projekt i chciałbyś wspomóc mnie w jego dalszym rozwijaniu - [postaw mi piwo](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)!
46
47 Wspierane urządzenia
48 --------------------
49
50 Lista obecnie wspieranych urządzeń:
51
52 - **Atheros AR9331**:
53   - 8devices Carambola 2 (w wersji z płytką developerską, [zdjęcia w mojej galerii](http://galeria.tech-blog.pl/8devices_Carambola_2/))
54   - TP-Link TL-MR3020 v1 ([zdjęcia w mojej galerii](http://galeria.tech-blog.pl/TPLINK_TL-MR3020/))
55   - TP-Link TL-MR3040 v1 i v2
56   - TP-Link TL-WR703N v1, ([zdjęcia w mojej galerii](http://galeria.tech-blog.pl/TPLINK_TL-WR703N/))
57   - TP-Link TL-WR720N v3 (wersja przeznaczona na rynek chiński)
58   - TP-Link TL-WR710N v1 (wersja przeznaczona na rynek europejski, [zdjęcia w mojej galerii](http://galeria.tech-blog.pl/TP-Link_TL-WR710N-EU/))
59   - TP-Link TL-MR10U v1 ([zdjęcia w mojej galerii](http://galeria.tech-blog.pl/TP-Link_TL-MR10U/))
60   - TP-Link TL-MR13U v1
61   - TP-Link TL-WR740N v4 (i podobne, jak na przykład TL-WR741ND v4)
62   - TP-Link TL-MR3220 v2
63   - Moduł GS-Oolite/Elink EL-M150 na płytce developerskiej ([zdjęcia w mojej galerii](http://galeria.tech-blog.pl/Elink_EL-M150_Development-Board/))
64   - Dragino 2 (MS14)
65   - Village Telco Mesh Potato 2 (bazuje na Dragino MS14)
66   - GL.iNet 64xxA ([zdjęcia w mojej galerii](http://galeria.tech-blog.pl/GLiNet/))
67   - Black Swift
68
69 - **Atheros AR1311 (bliźniaczy układ AR9331)**
70   - D-Link DIR-505 H/W ver. A1 ([zdjęcia w mojej galerii](http://galeria.tech-blog.pl/D-Link_DIR-505/))
71
72 - **Atheros AR9341**:
73   - TP-Link TL-MR3420 v2
74   - TP-Link TL-WR841N/D v8
75   - TP-Link TL-WA830RE v2
76   - TP-Link TL-WA801ND v2
77
78 - **Atheros AR9344**:
79   - TP-Link TL-WDR3600 v1
80   - TP-Link TL-WDR43x0 v1
81   - TP-Link TL-WDR3500 v1
82
83 Przetestowałem swoją modyfikację na większości z wymienionych powyżej urządzeń, z obrazami OpenWrt i oficjalnym firmware producenta. Jeżeli nie jesteś pewien wersji sprzętowej swojego urządzenia, proszę skontaktuj się ze mną **zanim** dokonasz wymiany obrazu bootloadera. Zmiana na niewłaściwą wersję najprawdopodobniej doprowadzi do uszkodzenia Twojego urządzenia i jedyną możliwością jego ponownego uruchomienia będzie przeprogramowanie kości FLASH w zewnętrznym programatorze.
84
85 Dodatkowe informacje o wspieranych urządzeniach:
86
87 | Model | SoC | FLASH | RAM | Obraz U-Boot | U-Boot env |
88 |:--- | :--- | ---: | ---: | ---: | ---: |
89 | [8devices Carambola 2](http://8devices.com/carambola-2) | AR9331 | 16 MiB | 64 MiB DDR2 | 256 KiB | 64 KiB, R/W |
90 | [TP-Link TL-MR3020 v1](http://wiki.openwrt.org/toh/tp-link/tl-mr3020) | AR9331 | 4 MiB | 32 MiB DDR1 | 64 KiB, LZMA | RO |
91 | [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 |
92 | [TP-Link TL-WR703N](http://wiki.openwrt.org/toh/tp-link/tl-wr703n) | AR9331 | 4 MiB | 32 MiB DDR1 | 64 KiB, LZMA | RO |
93 | [TP-Link TL-WR720N v3](http://wiki.openwrt.org/toh/tp-link/tl-wr720n) | AR9331 | 4 MiB | 32 MiB DDR1 | 64 KiB, LZMA | RO |
94 | [TP-Link TL-WR710N v1](http://wiki.openwrt.org/toh/tp-link/tl-wr710n) | AR9331 | 8 MiB | 32 MiB DDR1 | 64 KiB, LZMA | RO |
95 | [TP-Link TL-MR10U v1](http://wiki.openwrt.org/toh/tp-link/tl-mr10u) | AR9331 | 4 MiB | 32 MiB DDR1 | 64 KiB, LZMA | RO |
96 | [TP-Link TL-MR13U v1](http://wiki.openwrt.org/toh/tp-link/tl-mr13u) | AR9331 | 4 MiB | 32 MiB DDR1 | 64 KiB, LZMA | RO |
97 | [TP-Link TL-WR740N v4](http://wiki.openwrt.org/toh/tp-link/tl-wr740n) | AR9331 | 4 MiB | 32 MiB DDR1 | 64 KiB, LZMA | RO |
98 | [TP-Link TL-MR3220 v2](http://wiki.openwrt.org/toh/tp-link/tl-mr3420) | AR9331 | 4 MiB | 32 MiB DDR1 | 64 KiB, LZMA | RO |
99 | GS-Oolite/Elink EL-M150 module | AR9331 | 4/8/16 MiB | 64 MiB DDR2 | 64 KiB, LZMA | RO |
100 | [Dragino 2 (MS14)](http://wiki.openwrt.org/toh/dragino/ms14) | AR9331 | 16 MiB | 64 MiB DDR1 | 192 KiB | R/W |
101 | Village Telco Mesh Potato 2 | AR9331 | 16 MiB | 64 MiB DDR1 | 192 KiB | R/W |
102 | [GL.iNet](http://wiki.openwrt.org/toh/gl-inet/gl-inet) | AR9331 | 8/16 MiB | 64 MiB DDR1 | 64 KiB | RO |
103 | [Black Swift](http://www.black-swift.com) | AR9331 | 16 MiB | 64 MiB DDR2 | 128 KiB, LZMA | R/W |
104 | [TP-Link TL-MR3420 v2](http://wikidevi.com/wiki/TP-LINK_TL-MR3420_v2) | AR9341 | 4 MiB | 32 MiB DDR1 | 64 KiB, LZMA | RO |
105 | [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 |
106 | [TP-Link TL-WA830RE v2](http://wikidevi.com/wiki/TP-LINK_TL-WA830RE_v2) | AR9341 | 4 MiB | 32 MiB DDR1 | 64 KiB, LZMA | RO |
107 | [TP-Link TL-WA801ND v2](http://wikidevi.com/wiki/TP-LINK_TL-WA801ND_v2) | AR9341 | 4 MiB | 32 MiB DDR1 | 64 KiB, LZMA | RO |
108 | [TP-Link TL-WDR3600 v1](http://wiki.openwrt.org/toh/tp-link/tl-wdr3600) | AR9344 | 8 MiB | 128 MiB DDR2 | 64 KiB, LZMA | RO |
109 | [TP-Link TL-WDR43x0 v1](http://wiki.openwrt.org/toh/tp-link/tl-wdr4300) | AR9344 | 8 MiB | 128 MiB DDR2 | 64 KiB, LZMA | RO |
110 | [TP-Link TL-WDR3500 v1](http://wiki.openwrt.org/toh/tp-link/tl-wdr3500) | AR9344 | 8 MiB | 128 MiB DDR2 | 64 KiB, LZMA | RO |
111 | [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 |
112
113 *(LZMA) - obraz binarny U-Boot został dodatkowo skompresowany przy pomocy LZMA.*  
114 *(R/W) - zmienne środowiskowe przechowywane są w osobnym bloku FLASH, co pozwala na ich zachowanie po odłączeniu zasilaniu.*  
115 *(RO) - zmienne środowiskowe są wbudowane w obraz binarny, można je zmieniać i dodawać nowe wyłącznie w trakcie pracy urządzenia, po ponownym uruchomieniu zostaną przywrócone domyślne wartości.*
116
117 Znane błędy
118 -----------
119
120 Dostępna obecnie wersja nie ładuje jądra Linuxa z niektórych wydań oficjalnego firmware TP-Link. Jeżeli zamierzasz używać OFW, w którymś ze wspieranych modeli tego producenta, nie używaj mojej modyfikacji. Pracuję nad rozwiązaniem tego problemu.
121
122 Modyfikacje, zmiany
123 -------------------
124
125 ### Serwer web
126
127 Najistotniejszą zmianą jest dodanie serwera web, bazującego na **[stosie TCP/IP uIP 0.9](http://www.gaisler.com/doc/net/uip-0.9/doc/html/main.html)**. Umożliwia to aktualizację obrazów **firmware**, **U-Boot** i **ART** (Atheros Radio Test) bezpośrednio z poziomu przeglądarki, bez potrzeby dostępu do konsoli szeregowej i uruchamiania serwera TFTP. Podobny tryb ratunkowy, również bazujący na stosie TCP/IP uIP 0.9, dostępny jest od dawna w routerach **D-Link**.
128
129 Serwer posiada 7 stron www:
130
131 1. index.html (aktualizacja obrazu firmware, zrzut ekranu poniżej)
132 2. uboot.html (aktualizacja obrazu U-Boot)
133 3. art.html (aktualizacja danych kalibracyjnych ART)
134 4. flashing.html
135 5. 404.html
136 6. fail.html
137 7. style.css
138
139 ![](http://www.tech-blog.pl/wordpress/wp-content/uploads/2013/08/uboot_mod_firmware_upgrade.jpg)
140
141 ### Konsola sieciowa
142
143 Drugą, równie użyteczną opcją, jest konsola sieciowa (wchodzi ona w skład oficjalnej gałęzi U-Boot, ale nie jest domyślnie dostępna w żadnym ze wspieranych urządzeń). Konsola sieciowa umożliwia komunikację z konsolą U-Boot przez sieć Ethernet, wykorzystując protokół UDP (domyślny port: 6666, adres IP routera: 192.168.1.1).
144
145 ![](http://www.tech-blog.pl/wordpress/wp-content/uploads/2013/04/u-boot_mod_for_tp-link_with_ar9331_netconsole.jpg)
146
147 ### Inne
148
149 Ponadto:
150
151 - Przyspieszony start
152 - Nieistotne informacje wyświetlane w konsoli podczas uruchamiania zostały usunięte
153 - Automatyczne rozpoznawanie zastosowanej kości FLASH na podstawie JEDEC ID
154 - MAC adres dla interfejsów sieciowych jest pobierany z FLASH, a nie ustawiany na sztywno
155 - Ładowanie firmware może być przerwane przy pomocy dowolnego klawisza
156 - Wciśnij i przytrzymaj przycisk aby uruchomić:
157   - Werwer web (min. 3 sekundy)
158   - Konsolę szeregową U-Boot (min. 5 sekundy)
159   - Konsolę sieciową U-Boot (min. 7 sekundy)
160 - Dodatkowe komendy (w odniesieniu do wersji producenta; dostępność zależy od modelu):
161   -  httpd
162   -  printmac
163   -  setmac
164   -  printmodel
165   -  printpin
166   -  startnc
167   -  startsc
168   -  eraseenv
169   -  ping
170   -  dhcp
171   -  sntp
172   -  iminfo
173 - Możliwości overclockingu i underclockingu (aktualnie tylko w modelach z SoC AR9331)
174
175 ### Automatycznie rozpoznawane kości FLASH
176
177 Automatyczna detekcja typu zastosowanej kości FLASH może być bardzo przydatna jeżeli wymieniłeś FLASH w swoim routerze. Nie musisz dokonywać zmian w oficjalnych źródłach i kompilować ich żeby mieć dostęp do całej zawartości FLASH z poziomu konsoli U-Boot.
178
179 Jeżeli wykorzystasz kość, której nie ma na poniższej liście, moja wersja U-Boot będzie traktować ją tak jakby miała rozmiar zgodny z rozmiarem domyślnie zastosowanej kości w danym modelu. W większości urządzeń nie będziesz też miał możliwości aktualizacji obrazu danych kalibracyjnych układu radiowego (ART).
180
181 Pełna lista obsługiwanych kości FLASH:
182
183 **4 MiB**:
184
185 - Spansion S25FL032P (4 MiB, JEDEC ID: 01 0215)*
186 - Atmel AT25DF321 (4 MiB, JEDEC ID: 1F 4700)
187 - EON EN25Q32 (4 MiB, JEDEC ID: 1C 3016)*
188 - EON EN25F32 (4 MiB, JEDEC ID: 1C 3116)*
189 - Micron M25P32 (4 MiB, JEDEC ID: 20 2016)
190 - Windbond W25Q32 (4 MiB, JEDEC ID: EF 4016)
191 - Macronix MX25L320 (4 MiB, JEDEC ID: C2 2016)
192
193 **8 MiB**:
194
195 - Spansion S25FL064P (8 MiB, JEDEC ID: 01 0216)
196 - Atmel AT25DF641 (8 MiB, JEDEC ID: 1F 4800)
197 - EON EN25Q64 (8 MiB, JEDEC ID: 1C 3017)*
198 - Micron M25P64 (8 MiB, JEDEC ID: 20 2017)
199 - Windbond W25Q64 (8 MiB, JEDEC ID: EF 4017)*
200 - Macronix MX25L64 (8 MiB, JEDEC ID: C2 2017, C2 2617)
201
202 **16 MiB**:
203
204 - Winbond W25Q128 (16 MB, JEDEC ID: EF 4018)*
205 - Macronix MX25L128 (16 MB, JEDEC ID: C2 2018, C2 2618)
206 - Spansion S25FL127S (16 MB, JEDEC ID: 01 2018)*
207
208 (*) przetestowane
209
210 Jeżeli na powyższej liście nie ma kostki, którą chciałbyś zastosować, lub z jakiegoś innego powodu masz co do niej wątpliwości - skontaktuj się ze mną. Ewentualnie, możesz samemu dokonać odpowiednich zmian w kodzie i przesłać mi gotową łatę lub zgłosić pull request.
211
212 Jak to zainstalować?
213 --------------------
214
215 ### Uwagi, kopie zapasowe
216
217 **Robisz to wyłącznie na własną odpowiedzialność!**   
218 **Jeżeli popełnisz jakiś błąd lub coś pójdzie nie tak w trakcie aktualizacji, w najgorszym przypadku, Twój router nie uruchomi się już ponownie!**
219
220 Wykonywanie kopii zapasowych jest dobrą praktyką, dlatego zalecam Ci skopiowanie zawartości oryginalnego obrazu/partycji U-Boot (szczególnie w przypadku routerów TP-Link), **zanim** wykonasz jakiekolwiek zmiany. Przykładowo, wykorzystując OpenWrt (na przykładzie TP-Link TL-WR703N z kością FLASH 16 MiB):
221
222 ```
223 cat /proc/mtd
224 ```
225
226 Komenda ta wyświetli listę wszystkich partycji **MTD** (Memory Technology Device):
227
228 ```
229 dev:    size   erasesize  name
230 mtd0: 00020000 00010000 "u-boot"
231 mtd1: 000eeb70 00010000 "kernel"
232 mtd2: 00ee1490 00010000 "rootfs"
233 mtd3: 00c60000 00010000 "rootfs_data"
234 mtd4: 00010000 00010000 "art"
235 mtd5: 00fd0000 00010000 "firmware"
236 ```
237
238 Jak widać powyżej, partycja o nazwie `u-boot` ma rozmiar **0x20000** (128 KiB), z kolei publikowane przeze mnie gotowe obrazy dla tego modelu mają rozmiar **0x10000** (64 KiB). Jest to bardzo istotna różnica i powinieneś o niej pamiętać, jeżeli do zmiany U-Boot zamierzasz wykorzystać narzędzie `mtd`.
239
240 W celu skopiowania zawartości partycji `u-boot` do pamięci RAM, wykonaj:
241
242 ```
243 cat /dev/mtd0 > /tmp/uboot_backup.bin
244 ```
245
246 Następnie połącz się z routerem przy pomocy `protokołu SCP` i pobierz `/tmp` na dysk lokalny plik `uboot_backup.bin`.
247
248 ### Przy pomocy programatora FLASH
249
250 Jeżeli dysponujesz programatorem kości FLASH (wszystkie wspierane urządzenia posiadają kości typu **SPI NOR FLASH**), najpewniej wiesz jak z niego korzystać. Pobierz archiwum zawierające gotowe obrazy binarne lub samodzielnie skompiluj kod źródłowy, wybierz odpowiedni plik dla swojego urządzenia i wgraj go na sam początek kości (ofset `0x00000`). Musisz pamiętać jedynie o skasowaniu bloku(ów) przed wgraniem obrazu - jeżeli wykorzystujesz gotowe oprogramowanie dla programatora, w trybie automatycznym, prawdopodobnie odpowiedni obszar zostanie automatycznie wykasowany przed wgraniem wskazanego obrazu.
251
252 Wszystkie publikowane przeze mnie gotowe obrazy binarne są dopełnione wartościami 0xFF, tak żeby ich rozmiar finalny był zawsze **wielokrotnością rozmiaru pojedynczego bloku 64 KiB** i nie przekraczał rozmiaru oryginalnej partycji z U-Boot. Przykładowo, **TP-Link** w większości swoich nowych urządzeń wykorzystuje tylko pierwszy **64 KiB** blok do przechowywania skompresowanego obrazu U-Boot. W kolejnym 64 KiB bloku umieszcza takie informacje jak adres MAC, numer i wersję modelu oraz czasami pin WPS.
253
254 Z drugiej strony, obraz U-Boot w module **8devices Carambola 2** może mieć maksymalnie **256 KiB** (4 bloki po 64 KiB każdy), ale obraz nie jest skompresowany. Zaraz za nim, w kolejnym 64 KiB bloku, znajdują się zmienne środowiskowe - partycja ta w OpenWrt, w tym konkretnym przypadku, nosi nazwę `u-boot-env`:
255
256 ```
257 dev:    size   erasesize  name
258 mtd0: 00040000 00010000 "u-boot"
259 mtd1: 00010000 00010000 "u-boot-env"
260 mtd2: 00f90000 00010000 "firmware"
261 mtd3: 00e80000 00010000 "rootfs"
262 mtd4: 00cc0000 00010000 "rootfs_data"
263 mtd5: 00010000 00010000 "nvram"
264 mtd6: 00010000 00010000 "art"
265 ```
266
267 ### Przy pomocy UART, konsoli U-Boot i serwera TFTP
268
269 Jest to prawdopodobnie najczęściej wykorzystywana metoda do wgrania firmware w przypadku problemów z uruchomieniem wersji znajdującej się w urządzeniu lub po nieudanej aktualizacji. Istotną wadą tego podejścia jest potrzeba rozebrania routera i połączenia się z nim przy pomocy interfejsu szeregowego UART (w przypadku Carambola 2 w wersji z płytką developerską sprawa jest ułatwiona, ponieważ adapter USB-UART bazujący na FTDI FT232RQ znajduje się już na PCB).
270
271 #### Ważna informacja!
272
273 Wszystkie wspierane urządzenia posiadają sprzętowy interfejs UART, zintegrowany wewnątrz układu SoC, pracujący w zakresie napięcia około 3,3 V (w istocie, wyprowadzenia GPIO mogą pracować przy takim napięciu, ale w rzeczywistości, zgodnie z dokumentacją części układów zastosowanych we wspieranych modelach, porty GPIO zasilane są z wewnętrznego stabilizatora o napięciu wyjściowym 2,62 V)!
274
275 **Nie podłączaj** bezpośrednio żadnego interfejsu RS232 pracującego przy napięciu +/- 12 V lub innego adaptera, bez odpowiedniego konwertera poziomów napięć, ponieważ może to doprowadzić do trwałego uszkodzenia Twojego routera. Najlepiej będzie jeżeli wykorzystasz dowolny adapter USB-UART, który posiada zintegrowany konwerter 3,3 V. Pamiętaj również, że w przypadku korzystania z takiego adaptera powinieneś **podłączyć wyłącznie sygnały RX, TX i GND**. **NIGDY** nie łącz razem sygnału zasilania (VCC) z routera i adaptera, chyba że wiesz co robisz! Połączenie tych sygnałów w najgorszym wypadku może spowodować uszkodzenie adaptera, a w najgorszym - również routera! Wykorzystując adapter USB-UART powinieneś zasilić go z gniazda USB w komputerze, a router z oryginalnego zasilacza sieciowego (lub z gniazda USB jeżeli urządzenie jest zasilane w taki sposób).
276
277 Od dłuższego czasu i bez żadnych problemów używam bardzo prostego i wyjątkowo taniego (w granicach 1-2 USD) adaptera bazującego na układzie **CP2102**. Po więcej informacji o interfejsie UART w routerach możesz sięgnąć do artykułu [Serial Console](http://wiki.openwrt.org/doc/hardware/port.serial) w OpenWrt Wiki.
278
279 #### Instrukcja krok po kroku
280
281 1. Zainstaluj i skonfiguruj na swoim PC dowolny **serwer TFTP** (dla systemów z rodziny Windows sugeruję [TFTP32](http://tftpd32.jounin.net)).
282
283 2. Ustaw stały adres IP na swoim PC (w poniższej instrukcji wykorzystamy **192.168.1.2** dla PC i **192.168.1.1** dla routera) i połącz go z routerem przy pomocy kabla sieciowego RJ45 (powinieneś wykorzystać w routerze jedno z gniazd LAN, ale WAN również powinien działać).
284
285 3. Podłącz do PC i skonfiguruj adapter USB-UART oraz uruchom program do komunikacji z nim, np. [PuTTY](http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html).   
286 Skonfiguruj program do używania takich ustawień:
287   * Baud rate: 115200
288   * Data bits: 8
289   * Parity control: none
290   * Stop bits: 1
291   * Handshaking: none
292 4. Uruchom router, zaczekaj na wyświetlenie się jednego z poniższych komunikatów i przerwij proces ładowania firmware:
293
294   `Autobooting in 1 seconds` (głównie routery **TP-Link**, w tym momencie powinieneś wpisać `tpl`)   
295   `Hit ESC key to stop autoboot:  1` (**8devices Carambola 2**, wciśnij klawisz `ESC`)   
296   `Hit any key to stop autoboot:  1` (**D-Link DIR-505**, wciśnij dowolny klawisz)
297
298 5. Ustaw zmienne środowiskowe `ipaddr` i `serverip`, tak jak poniżej:
299
300   ```
301   hornet> setenv ipaddr 192.168.1.1
302   hornet> setenv serverip 192.168.1.2
303   ```
304 6. Sprawdź czy zmiany zostały wprowadzone:
305
306   ```
307   hornet> printenv ipaddr
308   ipaddr=192.168.1.1
309   hornet> printenv serverip
310   serverip=192.168.1.2
311   ```
312
313 7. Pobierz z serwera TFTP i umieść w pamięci RAM urządzenia właściwy dla swojego modelu obraz U-Boot, wykorzystując polecenie `tftpboot` (na przykładzie **TP-Link TL-MR3020**):
314
315   ```
316   tftpboot 0x80800000 uboot_for_tp-link_tl-mr3020.bin
317
318   eth1 link down
319   Using eth0 device
320   TFTP from server 192.168.1.2; our IP address is 192.168.1.1
321   Filename 'uboot_for_tp-link_tl-mr3020.bin'.
322   Load address: 0x80800000
323   Loading: #############
324   done
325   Bytes transferred = 65536 (10000 hex)
326   hornet>
327   ```
328
329 8. Kolejny krok jest bardzo ryzykowny! Wykonując następne polecenia, najpierw skasujesz oryginalny obraz U-Boot z pamięci FLASH, a następnie skopiujesz w to miejsce nowy obraz, z pamięci RAM. Jeżeli w trakcie tego procesu coś pójdzie nie tak (na przykład dojdzie do awarii zasilania), Twój router najprawdopodobniej już się nie uruchomi ponownie!
330
331   Powinieneś też zwrócić uwagę na rozmiar pobieranego obrazu. Dla wspieranych modeli routerów **TP-Link** i **D-Link** będzie on miał zawsze rozmiar **0x10000** (64 KiB), z kolei w przypadku modułu Carambola 2, rozmiar obrazu jest inny: **0x40000** (256 KiB). We wszystkich przypadkach, adres początkowy pamięci FLASH i RAM to odpowiednio: **0x9F000000** i **0x80000000**. Jak mogłeś zauważyć, w poprzednim kroku, do zapisania pobranego przez sieć obrazu, nie wykorzystałem początkowego adresu pamięci RAM i również nie powinieneś tego robić.
332
333   Nie popełnij żadnych błędów w rozmiarach i adresach (ofsetach), w kolejnych krokach!
334
335 9. Skasuj odpowiedni obszar w pamięci FLASH (to polecenie usunie oryginalny obraz U-Boot!):
336
337   ```
338   hornet> erase 0x9F000000 +0x10000   
339
340   First 0x0 last 0x0 sector size 0x10000
341   0
342   Erased 1 sectors
343   ```
344
345 10. W tej chwili Twój router nie posiada żadnego bootloadera, dlatego skopiuj do FLASH z pamięci RAM pobrany wcześniej, nowy obraz:
346
347   ```
348   hornet> cp.b 0x80800000 0x9F000000 0x10000   
349
350   Copy to Flash... write addr: 9f000000
351   done
352   ```
353
354 11. Jeżeli chcesz, możesz wyświetlić w konsoli U-Boot zawartość pamięci FLASH i porównać ją z obrazem na komputerze. W tym celu należy skorzystać z komendy `md`, która spowoduje wyświetlenie 256 bajtów danych w postaci szesnastkowej i tekstowej, począwszy od podanego w argumencie adresu. Kolejne wywołanie tego samego polecenia, tym razem bez parametru, spowoduje wyświetlenie kolejnej porcji danych.
355
356   ```
357   hornet> md 0x9F000000
358
359   9f000000: 100000ff 00000000 100000fd 00000000    ................
360   9f000010: 10000222 00000000 10000220 00000000    ..."....... ....
361   9f000020: 1000021e 00000000 1000021c 00000000    ................
362   9f000030: 1000021a 00000000 10000218 00000000    ................
363   9f000040: 10000216 00000000 10000214 00000000    ................
364   9f000050: 10000212 00000000 10000210 00000000    ................
365   9f000060: 1000020e 00000000 1000020c 00000000    ................
366   9f000070: 1000020a 00000000 10000208 00000000    ................
367   9f000080: 10000206 00000000 10000204 00000000    ................
368   9f000090: 10000202 00000000 10000200 00000000    ................
369   9f0000a0: 100001fe 00000000 100001fc 00000000    ................
370   9f0000b0: 100001fa 00000000 100001f8 00000000    ................
371   9f0000c0: 100001f6 00000000 100001f4 00000000    ................
372   9f0000d0: 100001f2 00000000 100001f0 00000000    ................
373   9f0000e0: 100001ee 00000000 100001ec 00000000    ................
374   9f0000f0: 100001ea 00000000 100001e8 00000000    ................
375   ```
376
377 12. Jeżeli jesteś pewien, że wszystko przebiegło prawidłowo, możesz zrestartować urządzenie:
378
379   ```
380   hornet> reset
381   ```
382
383 ### Przy pomocy OpenWrt
384
385 [TODO]
386
387 ### Przy pomocy DD-WRT
388
389 [TODO]
390
391 ### Jak korzystać z tej modyfikacji?
392
393 [TODO]
394
395 Jak samodzielnie skompilować kod?
396 ---------------------------------
397
398 Możesz wykorzystać jeden z dostępnych, bezpłatnych i gotowych narzędzi (tzw. toolchain):
399
400 - [Sourcery CodeBench Lite Edition for MIPS GNU/Linux](https://sourcery.mentor.com/GNUToolchain/subscription3130?lite=MIPS),
401 - [OpenWrt Toolchain for AR71xx MIPS](http://downloads.openwrt.org/attitude_adjustment/12.09/ar71xx/generic/OpenWrt-Toolchain-ar71xx-for-mips_r2-gcc-4.6-linaro_uClibc-0.9.33.2.tar.bz2),
402 - [ELDK (Embedded Linux Development Kit)](ftp://ftp.denx.de/pub/eldk/),
403 - lub innych...
404
405 Do kompilacji korzystam z **Sourcery CodeBench Lite Edition for MIPS GNU/Linux**, na maszynie wirtualnej z zainstalowanym **Ubuntu 12.04 LTS** (32-bit). Wszystkie publikowane przeze mnie obrazy budowane są na tej konfiguracji.
406
407 Wszystko co musisz zrobić, po wybraniu zestawu narzędzi, to dostosowanie pliku [Makefile](Makefile) do własnej konfiguracji (czyli zmiana lub usunięcie `export MAKECMD` i ewentualnie dodanie `export PATH`). Przykładowo, w celu zbudowania obrazów przy pomocy OpenWrt Toolchain, zamiast Sourcery CodeBench Lite, pobierz odpowiednie archiwum i rozpakuj jego zawartość do folderu `toolchain`, w głównym katalogu ze źródłami, a następnie zmień początek pliku [Makefile](Makefile), jak poniżej:
408
409 ```
410 export BUILD_TOPDIR=$(PWD)
411 export STAGING_DIR=$(BUILD_TOPDIR)/tmp
412
413 export MAKECMD=make --silent ARCH=mips CROSS_COMPILE=mips-openwrt-linux-uclibc-
414 export PATH:=$(BUILD_TOPDIR)/toolchain/bin/:$(PATH)
415 ```
416
417 W celu uruchomienia kompilacji, w głównym katalogu ze źródłami wydaj polecenie `make model`, na przykład:
418
419 ```
420 make tplink_wr703n
421 ```
422
423 Powyższe polecenie rozpocznie kompilację obrazu U-Boot dla modelu **TP-Link TL-WR703N**.
424
425 FAQ
426 ---
427
428 #### 1. Moje urządzenie nie jest wspierane, ale posiada taki sam hardware jak jedno z tych na liście, mogę użyć tej modyfikacji?
429
430 *To może się źle skończyć! Oczywiście, wiele dostępnych na rynku routerów wykorzystuje praktycznie te same platformy sprzętowe - na przykład, TP-Link posiada w ofercie kilka mobilnych modeli z wbudowaną baterią: TL-MR10U, TL-MR11U (odpowiednik w Europie to TL-MR3040) TL-MR12U and TL-MR13U. Wszystkie wymienione urządzenia posiadają ten sam sprzęt: układ SoC Atheros AR9331 z 32 MiB pamięci RAM i 4 MiB pamięci SPI NOR FLASH. Ale diabeł jak zwykle tkwi w szczegółach, takich jak numery GPIO wykorzystanych do przycisków, diod LED, załączania zasilania w gnieździe USB itd., co może spowodować pewne problemy.*
431
432 *Możesz spróbować wgrać jeden z gotowych obrazów, ale pamiętaj że robisz to wyłącznie na własną odpowiedzialność!*
433
434 #### 2. Chciałbym podkręcić CPU w moim routerze, jak tego dokonać?
435
436 *W chwili obecnej, taka możliwość istnieje, ale wyłącznie dla modeli z układem Atheros AR9331 (powinieneś zapoznać się z plikiem [ap121.h](u-boot/include/configs/ap121.h), który zawiera wszelkie informacje dotyczące konfiguracji rejestrów PLL i kilka gotowych, niestandardowych ustawień zegarów dla CPU, RAM i magistrali AHB). Co więcej, wersję z podkręconymi (lub "skręconymi") zegarami będziesz musiał skompilować samodzielnie, ponieważ nie publikuję gotowych obrazów, z innymi niż domyślne, wartościami zegarów.*
437
438 *I ponownie, pamiętaj że robisz to wyłącznie na własną odpowiedzialność!*
439
440 #### 3. Czy testujesz wszystkie publikowane obrazy?
441
442 *Nie, ponieważ nie dysponuję wszystkimi wspieranymi modelami routerów/urządzeń. Testuję jedynie obrazy na wszystkich wspieranych typach układów SoC.*
443
444 #### 4. Chciałbym dodać wsparcie dla modelu X.
445
446 *Możesz to zrobić samemu, a potem przesłać mi gotową łatę lub zgłosić pull request. Jeżeli nie chcesz lub nie wiesz jak dodać wsparcie dla nowego modelu, skontaktuj się ze mną bezpośrednio, może pomogę.*
447
448 #### 5. Mój router nie uruchomił się ponownie po zmianie U-Boot!
449
450 *Ostrzegałem... bootloader, w tym przypadku U-Boot, to w praktyce najistotniejszy kawałek oprogramowania w Twoim urządzeniu. Jest on odpowiedzialny za inicjalizację sprzętu i załadowanie systemu operacyjnego (zazwyczaj jądra Linux). Dlatego, jeżeli podczas zmiany obrazu coś poszło źle, Twoje urządzenie nie uruchomi się ponownie i jedynym sposobem na jego naprawę jest zdemontowanie (wylutowanie) kości FLASH, zaprogramowanie jej poprawnym obrazem i ponowny montaż.*
451
452 Licencja, przestarzałe źródła itd.
453 ----------------------------------
454
455 Projekt **[U-Boot](http://www.denx.de/wiki/U-Boot/WebHome "U-Boot")** jest Wolnym Oprogramowaniem. Wszelkie informacje dotyczące licencji, pracujących nad nim osób itd., dostępne są folderze *u-boot* wraz z kodem źródłowym.
456
457 Powinieneś wiedzieć, że większość routerów, szczególnie tych z układami Atheros, używa bardzo starej wersji U-Boot (wersja 1.1.4 pochodzi z lat 2005/2006). Dlatego stwierdzenie, że *te źródła są zdecydowanie przestarzałe* nie jest błędne, ale dla mnie było łatwiej zmodyfikować je w tej postaci, niż przenosić zmiany wykonane przez programistów TP-Link/Atheros do aktualnej gałęzi projektu U-Boot. Co więcej, wprowadzając własne modyfikacje, usunąłem sporo niepotrzebnych elementów, fragmentów kodu i plików źródłowych, tak żeby kod był czytelniejszy dla osoby, która do tej pory nie miała do czynienia z tym projektem.
458
459 Podziękowania
460 -------------
461
462 - Dziękuję użytkownikowi *pupie* z forum OpenWrt za jego nieocenioną pomoc
463 - Dziękuję wszystkim darczyńcom i osobom wspierającym rozwój tej modyfikacji