diff options
author | Sascha Hauer <s.hauer@pengutronix.de> | 2014-06-17 10:27:03 +0200 |
---|---|---|
committer | Sascha Hauer <s.hauer@pengutronix.de> | 2014-06-26 10:09:52 +0200 |
commit | 98360be0fefd58bf27df03c47d887dd676a31d73 (patch) | |
tree | 76447f0ee3d99f3864bdfb9952178affb5dc9f76 /arch/mips | |
parent | 7b82f548580fb52023ed2116784632fd996a51fc (diff) | |
download | barebox-98360be0fefd58bf27df03c47d887dd676a31d73.tar.gz barebox-98360be0fefd58bf27df03c47d887dd676a31d73.tar.xz |
Documentation: remove doxygen documentation
The doxygen documentation is long outdated. Remove it. It will
be replaced with sphinx based documentation later.
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
Diffstat (limited to 'arch/mips')
-rw-r--r-- | arch/mips/boards/dlink-dir-320/dlink-dir-320.dox | 38 | ||||
-rw-r--r-- | arch/mips/boards/loongson-ls1b/loongson_ls1b.dox | 47 | ||||
-rw-r--r-- | arch/mips/boards/qemu-malta/qemu-malta.dox | 20 | ||||
-rw-r--r-- | arch/mips/boards/ritmix-rzx50/ritmix-rzx50.dox | 46 | ||||
-rw-r--r-- | arch/mips/boards/tplink-mr3020/tplink-mr3020.dox | 64 | ||||
-rw-r--r-- | arch/mips/mach-bcm47xx/mach-bcm47xx.dox | 7 | ||||
-rw-r--r-- | arch/mips/mach-loongson/mach-loongson.dox | 7 | ||||
-rw-r--r-- | arch/mips/mach-malta/mach-malta.dox | 7 | ||||
-rw-r--r-- | arch/mips/mach-mips.dox | 69 | ||||
-rw-r--r-- | arch/mips/mach-xburst/mach-xburst.dox | 7 |
10 files changed, 0 insertions, 312 deletions
diff --git a/arch/mips/boards/dlink-dir-320/dlink-dir-320.dox b/arch/mips/boards/dlink-dir-320/dlink-dir-320.dox deleted file mode 100644 index d0f5869340..0000000000 --- a/arch/mips/boards/dlink-dir-320/dlink-dir-320.dox +++ /dev/null @@ -1,38 +0,0 @@ -/** @page dlink_dir_320 D-Link DIR-320 wireless router - -The router has -@li BCM5354 SoC; -@li 32 MiB SDRAM; -@li 4 MiB NOR type Flash Memory; -@li RS232 serial interface (LV-TTL levels on board!); -@li 1xUSB interface; -@li 4 + 1 ethernet interfaces; -@li 802.11b/g (WiFi) interface; -@li JTAG interface; -@li 5 LEDs; -@li 2 buttons. - -The router uses CFE as firmware. - -Barebox can be started from CFE using tftp. -You must setup tftp-server on host 192.168.0.1. -Put your barebox.bin to tftp-server directory -(usual /tftpboot or /srv/tftp). -Connect your DIR-320 to your tftp-server network via -one of four <LAN> sockets. - -Next, setup network on DIR-320 and run barebox.bin, e.g.: -@verbatim -CFE> ifconfig eth0 -addr=192.168.0.99 -CFE> boot -tftp -addr=a0800000 -raw 192.168.0.1:barebox.bin -@endverbatim - -DIR-320 links: -@li http://www.dlink.com.au/products/?pid=768 -@li http://wiki.openwrt.org/toh/d-link/dir-320 - -CFE links: -@li http://www.broadcom.com/support/communications_processors/downloads.php#cfe -@li http://www.linux-mips.org/wiki/CFE - -*/ diff --git a/arch/mips/boards/loongson-ls1b/loongson_ls1b.dox b/arch/mips/boards/loongson-ls1b/loongson_ls1b.dox deleted file mode 100644 index f96a3f88d1..0000000000 --- a/arch/mips/boards/loongson-ls1b/loongson_ls1b.dox +++ /dev/null @@ -1,47 +0,0 @@ -/** @page loongson_ls1b Loongson LS1B demo board - -The LS1B is a development board made by Loongson Technology Corp. Ltd. - -The board has -@li Loongson LS1B SoC 250 MHz; -@li 64 MiB SDRAM; -@li 512 KiB SPI boot ROM; -@li 128M x 8 Bit NAND Flash Memory; -@li 2 x RS232 serial interfaces (DB9 connectors); -@li 2 x Ethernet interfaces; -@li 4 x USB interfaces; -@li microSD card slot; -@li LCD display (480x272); -@li audio controller; -@li beeper; -@li buttons; -@li EJTAG 10-pin connector. - -The board uses PMON2000 as bootloader. - -Barebox mini-howto: - -1. Connect to the boards's UART2; - -2. Turn board's power on; - -3. Wait 'Press <Enter> to execute loading image' prompt and press the space key. - -4. Upload zbarebox.bin via Ymodem -@verbatim - PMON> ymodem base=0xa0200000 -@endverbatim - -5. Run barebox -@verbatim - PMON> g -e 0xa0200000 -@endverbatim - -Loongson links: -@li http://en.wikipedia.org/wiki/Loongson -@li http://www.linux-mips.org/wiki/Loongson -@li https://github.com/loongson-gz -@li http://www.linux-mips.org/wiki/PMON_2000 -@li http://www.opsycon.se/PMON2000/Main - -*/ diff --git a/arch/mips/boards/qemu-malta/qemu-malta.dox b/arch/mips/boards/qemu-malta/qemu-malta.dox deleted file mode 100644 index bf10244585..0000000000 --- a/arch/mips/boards/qemu-malta/qemu-malta.dox +++ /dev/null @@ -1,20 +0,0 @@ -/** @page qemu_malta QEmu malta emulated board - -Specific to this emulated board is, it does not require any setup code to bring the SDRAM and RS232 up. - -Emulator run string: -@verbatim -qemu-system-mips -nodefaults -M malta -m 256 -nographic -serial stdio -monitor null -bios barebox-flash-image -@endverbatim - -Also you can use GXemul: -@verbatim -gxemul -Q -x -e maltabe -M 256 0xbfc00000:barebox-flash-image -@endverbatim - -Links: -@li http://www.linux-mips.org/wiki/Mips_Malta -@li http://www.qemu.org/ -@li http://gxemul.sourceforge.net/ - -*/ diff --git a/arch/mips/boards/ritmix-rzx50/ritmix-rzx50.dox b/arch/mips/boards/ritmix-rzx50/ritmix-rzx50.dox deleted file mode 100644 index 5ec819462b..0000000000 --- a/arch/mips/boards/ritmix-rzx50/ritmix-rzx50.dox +++ /dev/null @@ -1,46 +0,0 @@ -/** @page ritmix-rzx50 Ritmix RZX-50 game console - -Ritmix RZX-50 is a portable game console for the Russian market. - -The portable game console has -@li Ingenic JZ4755 SoC; -@li 64 MiB SDRAM; -@li 4 GiB microSDHC card / 4 GiB NAND type Flash Memory; -@li RS232 serial interface (LV-TTL levels on the board!); -@li LCD display (480x272); -@li Video out interface; -@li 1xUSB interface; -@li buttons. - -The game console uses U-Boot 1.1.6 as bootloader. - -barebox-rzx50 mini-howto: - -1. Connect to the game console's UART (see. http://a320.emulate.su/2012/01/19/uart-na-ritmix-rzx-50/); - -2. Unblock U-Boot console (see. http://a320.emulate.su/2012/01/25/rzx-50-dostup-k-konsoli-u-boot/); Please note that U-Boot's Zmodem support does not work; - -3. Boot Ritmix linux and login; - -4. Upload barebox.bin via Zmodem -@verbatim - # cd /tmp - # rz -@endverbatim - -5. Write barebox to onboard flash -@verbatim - # dd if=barebox.bin of=/dev/mmcblk0 seek=1048576 bs=1 count=262144 -@endverbatim - -6. Reboot RZX-50, next in U-Boot console start barebox: -@verbatim - CETUS # msc read 0xa0800000 0x100000 0x40000; g a0800000 -@endverbatim - -Ritmix RZX-50 links: -@li http://www.ritmixrussia.ru/products/252/entertainment/game/rzx-50 -@li ftp://ftp.ingenic.cn/2soc/4755/JZ4755_ds.pdf -@li ftp://ftp.ingenic.cn/3sw/01linux/01loader/u-boot/u-boot-1.1.6-jz-20110719-r1728-add-jz4770.patch.bz2 - -*/ diff --git a/arch/mips/boards/tplink-mr3020/tplink-mr3020.dox b/arch/mips/boards/tplink-mr3020/tplink-mr3020.dox deleted file mode 100644 index 16fe4653d8..0000000000 --- a/arch/mips/boards/tplink-mr3020/tplink-mr3020.dox +++ /dev/null @@ -1,64 +0,0 @@ -/** @page tplink-mr3020 TP-LINK MR3020 wireless router - -The router has -@li Atheros ar9331 SoC; -@li 32 MiB SDRAM; -@li 4 MiB NOR type SPI Flash Memory; -@li RS232 serial interface (LV-TTL levels on board!); -@li 1 USB interface; -@li 1 Ethernet interfaces; -@li 802.11b/g/n (WiFi) interface; -@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.: - -@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 -@endverbatim - -To convert your barebox.bin to U-Boot-loadable image (6F01A8C0.img) -use this command sequence: - -@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 -@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.: -@verbatim -hornet> set ipaddr 192.168.0.2 -hornet> set serverip 192.168.0.1 -hornet> tftpboot 0x81000000 6F01A8C0.img -hornet> bootm 0x81000000 -@endverbatim - -TP-LINK MR3020 links: -@li http://www.tp-link.com/en/products/details/?model=TL-MR3020 -@li http://wiki.openwrt.org/toh/tp-link/tl-mr3020 -@li https://wikidevi.com/wiki/TP-LINK_TL-MR3020 - -See also: -@li http://www.eeboard.com/wp-content/uploads/downloads/2013/08/AR9331.pdf -@li http://squonk42.github.io/TL-WR703N/ - -*/ diff --git a/arch/mips/mach-bcm47xx/mach-bcm47xx.dox b/arch/mips/mach-bcm47xx/mach-bcm47xx.dox deleted file mode 100644 index 04ccf03fcb..0000000000 --- a/arch/mips/mach-bcm47xx/mach-bcm47xx.dox +++ /dev/null @@ -1,7 +0,0 @@ -/** @page dev_bcm47xx_mach BCM47xx in barebox - -@section bcm47xx_boards BCM47xx-based boards - -@li @subpage dlink_dir_320 - -*/ diff --git a/arch/mips/mach-loongson/mach-loongson.dox b/arch/mips/mach-loongson/mach-loongson.dox deleted file mode 100644 index 7838ce5a85..0000000000 --- a/arch/mips/mach-loongson/mach-loongson.dox +++ /dev/null @@ -1,7 +0,0 @@ -/** @page dev_loongson_mach Loongson in barebox - -@section loongson_boards Loongson-based boards - -@li @subpage loongson_ls1b - -*/ diff --git a/arch/mips/mach-malta/mach-malta.dox b/arch/mips/mach-malta/mach-malta.dox deleted file mode 100644 index 85351e10b7..0000000000 --- a/arch/mips/mach-malta/mach-malta.dox +++ /dev/null @@ -1,7 +0,0 @@ -/** @page dev_malta_mach MIPS Malta in barebox - -@section malta_boards MIPS Malta boards - -@li @subpage qemu_malta - -*/ diff --git a/arch/mips/mach-mips.dox b/arch/mips/mach-mips.dox deleted file mode 100644 index 1002b16e9e..0000000000 --- a/arch/mips/mach-mips.dox +++ /dev/null @@ -1,69 +0,0 @@ -/* This document is intended to provide the developer with information - * how to integrate a new CPU (MACH) into this part of the barebox tree - */ - -/** @page dev_mips_mach MIPS based CPU (MACH) into the tree - -@section mach_mips_reset What's happens when the reset signal is gone - -Barebox normally must be linked to RAM region, cached region KSEG0 is preferred. -This make possible to run fast (because cache used) and skip MMU support. - -After reset MIPS CPU starting to fetch instructions from 0xBFC00000. - -@note Code running immediately after reset runs at an address it is not linked - to: "runtime address != link address". You should only use branches and - do not refer to fixed data. This implies the use of assembler code only. - After MIPS CPU reset cache and MMU are in random state. They are unusable. - -barebox MIPS initialisation sequence: - - * set the CP0 STATUS register to some known and sensible state. -Now you can load and store reliably in uncached space. - - * call a function \<mach_init_lowlevel\> (if not disabled). -do some special things required only on specific CPU - (e. g. init RAM controller, disable watchdog) - - * call a function \<board_init_lowlevel\> (if not disable). -do some special things required only on specific board - (e. g. setup GPIO to required state). - - ** It is desirable to have some debug code to make some contact - with the outside world from assembler code -(e.g. debug_ll-like functions to write to rs232 console). - - * check integrity of barebox RAM execute location; - * copy barebox to RAM execute location; - - * configure cache; - - * setup stack; - - ** after this point you can call a standard C routine. - - * setup exception vectors in RAM; - * setup CP0 STATUS to switch exception vector address to RAM; - - * call start_barebox() - -Further reading: - * Dominic Sweetman, See MIPS Run, Morgan Kaufmann, 2nd edition, 2006 -ISBN-13: 978-0120884216 - -@subsection mach_mips_malta_info Malta boards - -@li @subpage dev_malta_mach - -@subsection mach_bcm47xx_info BCM47xx-based boards - -@li @subpage dev_bcm47xx_mach - -@subsection mach_loongson_info Loongson-based boards - -@li @subpage dev_loongson_mach - -@subsection mach_xburst_info XBurst-based boards - -@li @subpage dev_xburst_mach -*/ diff --git a/arch/mips/mach-xburst/mach-xburst.dox b/arch/mips/mach-xburst/mach-xburst.dox deleted file mode 100644 index 052c05e7ae..0000000000 --- a/arch/mips/mach-xburst/mach-xburst.dox +++ /dev/null @@ -1,7 +0,0 @@ -/** @page dev_xburst_mach XBurst in barebox - -@section xburst_boards XBurst-based boards - -@li @subpage ritmix-rzx50 - -*/ |