From 0fb7dbb7c845f2462196901abdd8bdfc22167b54 Mon Sep 17 00:00:00 2001 From: Matt Jenkins Date: Wed, 9 Apr 2014 14:29:01 +0100 Subject: [PATCH] Renamed readme --- .cproject | 96 +++++++++++++++++++++++++++++++++++++++ README | 130 ----------------------------------------------------- README.md | 132 ++++++++++++++++++++++++++++++++++++++++++++++++++++-- 3 files changed, 225 insertions(+), 133 deletions(-) create mode 100644 .cproject delete mode 100644 README diff --git a/.cproject b/.cproject new file mode 100644 index 0000000..140e502 --- /dev/null +++ b/.cproject @@ -0,0 +1,96 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/README b/README deleted file mode 100644 index 7c4de43..0000000 --- a/README +++ /dev/null @@ -1,130 +0,0 @@ -This is the RetroBSD source directory. - - -Source Roadmap -~~~~~~~~~~~~~~ - bin User commands. - etc Template files for /etc. - include System include files. - lib System libraries. - libexec System binaries. - sbin System administration commands. - share Shared resources. - sys Kernel sources. - tools Build tools and simulators. - - -Supported hardware -~~~~~~~~~~~~~~~~~~ - * chipKIT Max32 board. - * Sparkfun UBW32 board. - * Maximite and Colour Maximite computers. - * Microchip Explorer 16 board, with PIC32 CAN-USB plug-in module and SD & MMC pictail. - * Microchip PIC32 USB or Ethernet Starter Kit, with I/O Expansion board and SD & MMC pictail. - * Olimex Duinomite, Duinomite-Mini and Duinomite-Mega boards. - * Olimex Pinguino-Micro board with PIC32MX795F512H microcontroller. - * eflightworks DIP board. - - -Build -~~~~~ -By default, the system is configured for the Max32 board. -To select another target board, edit a top-level Makefile -and change a TARGET value under section "Select target board": - - TARGET = $(UBW32) # for the UBW32 board with USB console - TARGET = $(UBW32UART) # for the UBW32 board with UART console - TARGET = $(MAXIMITE) # for the Maximite board - TARGET = $(MAXCOLOR) # for the Colour Maximite board - TARGET = $(EXPLORER16) # for the Explorer 16 board - TARGET = $(STARTERKIT) # for the PIC32 USB or Ethernet Starter Kit - TARGET = $(MAX32) # default - TARGET = $(DUINOMITE) # for the Duinomite board - TARGET = $(PINGUINO) # for the Pinguino-Micro board - TARGET = $(DIP) # for the DIP board - -You can also change a desired filesystem size and swap area size, -as required. Default is: - - FS_KBYTES = 16384 - SWAP_KBYTES = 2048 - -To compile the kernel and build a filesystem image, run: - - make - -A resulting root filesystem image is in file `filesys.img`. -A kernel is in file `unix.hex` in your target board subdirectory. - - -Filesystem image -~~~~~~~~~~~~~~~~ -You need to put a filesystem image on a SD card. On Windows, use -Win32DiskImager utility (https://launchpad.net/win32-image-writer/+download). -On Linux, run: - - sudo dd if=filesys.img of=/dev/XYZ - -Here `XYZ` is a device name of SD card, as recognized by Linux (sdb in my case). - - -Install kernel -~~~~~~~~~~~~~~ -Kernel image should be written to PIC32 flash memory. The procedure depends -on a board used. - -Max32 board: - cd sys/pic32/ubw32 - AVRTOOLS=/Applications/Mpide.app/Contents/Resources/Java/hardware/tools - $AVRTOOLS/bin/avrdude -C$AVRTOOLS/etc/avrdude.conf -c stk500v2 -p pic32 \ - -P /dev/tty.usbserial-* -b 115200 -v -U flash:w:unix.hex:i - - Here you need to change AVRTOOLS path and tty name according to your system. - -UBW32 board: - Use a pic32prog utility (http://code.google.com/p/pic32prog/) - and a USB cable to install a kernel: - - pic32prog sys/pic32/ubw32/unix.hex - -Maximite: - Use the bootload program for Windows, available for download by link: - http://geoffg.net/Downloads/Maximite/Maximite_Update_V2.7B.zip - -Explorer 16 board: - There is an auxiliary PIC18 chip on the Explorer 16 board, which can be - used as a built-in programmer device. You will need a PICkit 2 adapter - to install a needed firmware, as described in article: - http://www.paintyourdragon.com/?p=51 - (section "Hack #2: Lose the PICkit 2, Save $35"). - This should be done only once. - - Then, you can use a pic32prog utility (http://code.google.com/p/pic32prog/) - and a USB cable to install a kernel: - - pic32prog sys/pic32/explorer16/unix.hex - -PIC32 Starter Kit: - Use PICkit 2 adapter and software to install a boot loader from - file `sys/pic32/starter-kit/boot.hex`. This should be done only once. - - Then, you can use a pic32prog utility (http://code.google.com/p/pic32prog/) - and a USB cable to install a kernel: - - pic32prog sys/pic32/starter-kit/unix.hex - - -Simulator -~~~~~~~~~ -You can use a MIPS32 simulator to develop a debug a RetroBSD software, -without a need for hardware board. By default, a simulator is configured -to imitate a Max32 board. To build it: - - cd tools/virtualmips - make - -Run it: - - ./pic32 - -Configuration of simulated board is stored in file `pic32_max32.conf`. diff --git a/README.md b/README.md index f2cee8a..7c4de43 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,130 @@ -retrobsd -======== +This is the RetroBSD source directory. -Main RetroBSD Operating System + +Source Roadmap +~~~~~~~~~~~~~~ + bin User commands. + etc Template files for /etc. + include System include files. + lib System libraries. + libexec System binaries. + sbin System administration commands. + share Shared resources. + sys Kernel sources. + tools Build tools and simulators. + + +Supported hardware +~~~~~~~~~~~~~~~~~~ + * chipKIT Max32 board. + * Sparkfun UBW32 board. + * Maximite and Colour Maximite computers. + * Microchip Explorer 16 board, with PIC32 CAN-USB plug-in module and SD & MMC pictail. + * Microchip PIC32 USB or Ethernet Starter Kit, with I/O Expansion board and SD & MMC pictail. + * Olimex Duinomite, Duinomite-Mini and Duinomite-Mega boards. + * Olimex Pinguino-Micro board with PIC32MX795F512H microcontroller. + * eflightworks DIP board. + + +Build +~~~~~ +By default, the system is configured for the Max32 board. +To select another target board, edit a top-level Makefile +and change a TARGET value under section "Select target board": + + TARGET = $(UBW32) # for the UBW32 board with USB console + TARGET = $(UBW32UART) # for the UBW32 board with UART console + TARGET = $(MAXIMITE) # for the Maximite board + TARGET = $(MAXCOLOR) # for the Colour Maximite board + TARGET = $(EXPLORER16) # for the Explorer 16 board + TARGET = $(STARTERKIT) # for the PIC32 USB or Ethernet Starter Kit + TARGET = $(MAX32) # default + TARGET = $(DUINOMITE) # for the Duinomite board + TARGET = $(PINGUINO) # for the Pinguino-Micro board + TARGET = $(DIP) # for the DIP board + +You can also change a desired filesystem size and swap area size, +as required. Default is: + + FS_KBYTES = 16384 + SWAP_KBYTES = 2048 + +To compile the kernel and build a filesystem image, run: + + make + +A resulting root filesystem image is in file `filesys.img`. +A kernel is in file `unix.hex` in your target board subdirectory. + + +Filesystem image +~~~~~~~~~~~~~~~~ +You need to put a filesystem image on a SD card. On Windows, use +Win32DiskImager utility (https://launchpad.net/win32-image-writer/+download). +On Linux, run: + + sudo dd if=filesys.img of=/dev/XYZ + +Here `XYZ` is a device name of SD card, as recognized by Linux (sdb in my case). + + +Install kernel +~~~~~~~~~~~~~~ +Kernel image should be written to PIC32 flash memory. The procedure depends +on a board used. + +Max32 board: + cd sys/pic32/ubw32 + AVRTOOLS=/Applications/Mpide.app/Contents/Resources/Java/hardware/tools + $AVRTOOLS/bin/avrdude -C$AVRTOOLS/etc/avrdude.conf -c stk500v2 -p pic32 \ + -P /dev/tty.usbserial-* -b 115200 -v -U flash:w:unix.hex:i + + Here you need to change AVRTOOLS path and tty name according to your system. + +UBW32 board: + Use a pic32prog utility (http://code.google.com/p/pic32prog/) + and a USB cable to install a kernel: + + pic32prog sys/pic32/ubw32/unix.hex + +Maximite: + Use the bootload program for Windows, available for download by link: + http://geoffg.net/Downloads/Maximite/Maximite_Update_V2.7B.zip + +Explorer 16 board: + There is an auxiliary PIC18 chip on the Explorer 16 board, which can be + used as a built-in programmer device. You will need a PICkit 2 adapter + to install a needed firmware, as described in article: + http://www.paintyourdragon.com/?p=51 + (section "Hack #2: Lose the PICkit 2, Save $35"). + This should be done only once. + + Then, you can use a pic32prog utility (http://code.google.com/p/pic32prog/) + and a USB cable to install a kernel: + + pic32prog sys/pic32/explorer16/unix.hex + +PIC32 Starter Kit: + Use PICkit 2 adapter and software to install a boot loader from + file `sys/pic32/starter-kit/boot.hex`. This should be done only once. + + Then, you can use a pic32prog utility (http://code.google.com/p/pic32prog/) + and a USB cable to install a kernel: + + pic32prog sys/pic32/starter-kit/unix.hex + + +Simulator +~~~~~~~~~ +You can use a MIPS32 simulator to develop a debug a RetroBSD software, +without a need for hardware board. By default, a simulator is configured +to imitate a Max32 board. To build it: + + cd tools/virtualmips + make + +Run it: + + ./pic32 + +Configuration of simulated board is stored in file `pic32_max32.conf`.