unified VC4 and ARM runtime code (including C++ runtime), updated some minor bits
[rpi-open-firmware.git] / README.md
index 42cd22c..6849ef4 100755 (executable)
--- a/README.md
+++ b/README.md
@@ -1,37 +1,69 @@
 # Minimal Raspberry Pi VPU firmware\r
-This is a small firmware for RPi VPU (VideoCore4) versions 1/2/3 that is capable of initializing UART, VPU PLL (PLLC) and ARM itself. It's intended to be used instead of stock `bootcode.bin` on RPi's SD card. You **need** to have UART to see anything meaningful as far as output goes.\r
+This is a small firmware for RPi VPU (VideoCore4) versions 1/2/3 that is capable of initializing UART, VPU PLL (PLLC) and ARM itself. It's intended to be used instead of stock `bootcode.bin` on RPi's SD card. You **need** to have UART to see anything meaningful as far as output goes. The project additionally maintains a second-stage chainloader running on ARM capable of initializing eMMC, FAT, and the Linux kernel, as well as a shrinking set of patches to the Linux kernel.\r
 \r
-This has been tested on RPi1 Model B (Hynix PoP DDR), RPi 2 Model B and RPi 3 Model B (both Elpida DDR)\r
+This has been tested on RPi1 Model B (Hynix PoP DDR), RPi 2 Model B and RPi 3 Model B (both Elpida DDR), but it should work with minimal modifications on all of the models. Development primarily targets the RPi 2 Model B.\r
 \r
-If you want to contact me because you're interested in contributing, you can message `kristina` on Freenode, but I would suggest talking in `#raspberrypi-internals` instead.\r
+If you want to contact us because you're interested in contributing, development discussion occurs in `#raspberrypi-internals` on Freenode. Please come on IRC before randomly hacking on the codebase :-)\r
 \r
-All Broadcom headers are licensed under 3-Clause BSD License while the rest of this is under GPLv2+. See `LICENSE` for more information.\r
+All Broadcom headers are licensed under 3-Clause BSD License while our code is under GPLv2+. See `LICENSE` for more information.\r
 \r
 ## Building\r
 \r
-You need Julian Brown's VC4 toolchain to build this (https://github.com/puppeh/vc4-toolchain) as well as a arm-none-eabi-toolchain. You can tweak the paths to it in CROSS_COMPILE in `Makefile` (for VC4) and for ARM in `arm_chainloader/Makefile`, although by default it assumes they are currently in your path. Contributors should not commit their personal paths. After you've done it, run `buildall.sh` and you should have a blob in `build/bootcode.bin`. \r
+You need Julian Brown's VC4 toolchain to build this (https://github.com/puppeh/vc4-toolchain) as well as a arm-none-eabi-toolchain. You can tweak the paths to it in CROSS_COMPILE in `Makefile` (for VC4) and for ARM in `arm_chainloader/Makefile`, although by default it assumes they are currently in your path. Contributors should not commit their personal paths. Contributors should also use tabs for indentation. After you've done it, run `buildall.sh` and you should have a blob in `build/bootcode.bin`. \r
+\r
+### Building on OSX\r
+\r
+#### Dependencies:\r
+\r
++ vc4-toolchain (https://github.com/puppeh/vc4-toolchain)\r
+\r
++ arm-none-abi-toolchain (https://launchpad.net/gcc-arm-embedded/+download)\r
+    + compilation instructions for OSX in the [pdf](https://launchpadlibrarian.net/287100910/How-to-build-toolchain.pdf)\r
+\r
+#### Build instructions: \r
+Compiling for osx is similar, but be careful with OSX's built-in "gcc" (LLVM-based) and the default version of guile (2.x), which is incompatible.\r
+\r
+Install dependencies: \r
+\r
+    brew install gcc-6 guile18\r
+\r
+Install the arm toolchain.\r
+\r
+    # follow the instructions in the pdf linked above\r
+\r
+Download the source and dependencies together for vc4-toolchain:\r
+\r
+    git clone --recursive https://github.com/puppeh/vc4-toolchain.git\r
+\r
+Once it’s done, you’ll need to add file paths to your $PATH variable: \r
+\r
+    export PATH=$PATH:/path/to/gcc-arm-none-eabi-5_4-2016q3/bin:/path/to/vc4-toolchain/prefix/bin\r
+\r
+From the main instructions ("After you've done it, run buildall.sh and you should have a blob in build/bootcode.bin"):\r
+\r
+    git clone https://github.com/christinaa/rpi-open-firmware; cd rpi-open-firmware\r
+    CC=gcc-6 LIBRARY_PATH=/lib:/lib64 ./build-all.sh\r
+\r
+Note: on the last step, the library path is set as it initially had a trailing ":" which broke the build. `CC=gcc-6` is just to ensure it's using the gcc install from the first step.\r
+\r
+That's it! Your shiny new binary is sitting at rpi-open-firmware/build/bootcode.bin.\r
 \r
 ## Technical Details\r
 The firmware is split into two parts, a VC4 part and and ARM part. The VC4 part initializes PLLC and moves VPU over to it, and then brings up UART. It then performs SDRAM initialization, making SDRAM available at `0xC0000000` (uncached alias). The ARM loader will do ARM initialization and then copy the ARM bootloader that's embedded in it to the alias. It will then map it to `0x0` in ARM's memory space and start ARM. The code under `arm_chainloader` is what will run on the ARM. \r
 \r
-The current iteration of ARM chainloader (which I've still yet to commit) can actually initialize the eMMC controller and access the boot partition with a FAT driver. From here, it would be trivial to chainloaded the next stage bootloader *but* you still face the issues of missing a substantial portion of the drivers that were previously provided by the firmware.\r
-\r
-The current makefiles in the ARM part of it aim at **RPi1** (ie. ARMv6) but they can be changed to ARMv7 if you want to build it for a newer model. I tested it on all RPi models and it works without any issues as far as I can tell (ARM can access peripherals and memory just fine as AXI supervisor). However it cannot access any secure peripherals (OTP/SDRAM/etc) since they appear to be on a separate bus accessible only to VC4.\r
+The ARM chainloader then initializes the eMMC controller and access the boot partition with a FAT driver. From here, it chainloads the Linux kernel (other payloads are not tested and are not likely to work due to dependence on the firmware).\r
 \r
-## Issues/Fixes\r
- * PLL rate on ARM is slow, it's a bit annoying. Need to tweak the PLL rate later.\r
- * All SDRAM configurations (including 1GB work), however, I'm not certain whether they will be reliable or not . ARM detection works for all of the RPi models I got to test it on which was two RPi2s, 1 RPi1 and 1 RPi3.\r
- * SD card support kind of works now, can parse MBR, parse the FAT boot partition but it still needs to pull off a next stage bootloader of it (possibly u-boot/LittleKernel or maybe even just start Linux straight from bootcode.bin).\r
- * The VPU still needs some sort of a firmware since ARM can't access all registers by itself, at the moment I'm trying to figure out how the VC4 interrupt controller works and how I can wake the sleeping VPU from ARM and get it to do things via a mailbox.\r
+The current makefiles in the ARM part of it aim at **RPi1** (ie. ARMv6) but they can be changed to ARMv7 if you want to build it for a newer model. It was tested on all RPi models and it seems to work without any issues (ARM can access peripherals and memory just fine as AXI supervisor). However, it cannot access any secure peripherals (OTP/SDRAM/etc) since they appear to be on a separate bus accessible only to VC4.\r
 \r
-## Does/Will it boot Linux?\r
+## Does it boot Linux?\r
 \r
-Eventually maybe. Since `start.elf` is responsible for clock and power management (all registers in the `cpr` block), these drivers will have to be rewritten on ARM (or even on the open source VC4) to have any meaningful peripherals working properly (for example HDMI/DMA/Pixel Valve/Whatever). You can boot a very minimal version of Linux without the firmware and get it to work with UART and some USB devices, but you can expect half of the things to be broken (most importantly, video and DMA).\r
+Yes, with some conditions. You can boot a very minimal version of Linux without the firmware and get it to work with UART. Support for eMMC, some USB devices, and Ethernet are in the works, which will be sufficient for certain headless systems. Still, you can expect half of the things to be broken (most importantly, video and DMA). Additionally, since `start.elf` is responsible for clock and power management in the original firmware (all registers in the `cpr` block), these drivers will have to be rewritten on ARM or our VC4 firmware to have most of the peripherals working properly (HDMI, for example).\r
 \r
 ## Thanks To\r
- * **Herman Hermitage** for his VC4 documentation and for helping me with working out suitable ARM PLL configurations.\r
- * **Julian Brown** for reviewing my code and for his awesome VC4 toolchain.\r
- * **David Given** for his initial LLVM project which I used as the base for my LLVM toolchain before moving to GCC.\r
- * **phire** for reviewing my code.\r
- * **Broadcom** for their header release.\r
+ * **[Herman Hermitage](https://github.com/hermanhermitage)** for his VC4 documentation and for helping determine suitable ARM PLL configurations.\r
+ * **[Julian Brown](https://github.com/puppeh)** for reviewing the code and for his awesome VC4 toolchain.\r
+ * **[Alyssa Rosenzweig](https://github.com/bobbybee)** for her contributions to the firmware especially in areas of Linux bringup and early ARM side initialization, as well as fixing mailbox support.\r
+ * **[David Given](https://github.com/davidgiven)** for his initial LLVM project used as the base for the initial LLVM toolchain before moving to GCC.\r
+ * **[phire](https://github.com/phire)** for reviewing the code.\r
+ * **[Broadcom](https://github.com/broadcom)** for their header release.\r
  * Various other people not mentioned here.\r
This page took 0.034801 seconds and 4 git commands to generate.