Hack on the loader
[rpi-open-firmware.git] / README.md
index 5199b5d..3f4c302 100755 (executable)
--- a/README.md
+++ b/README.md
@@ -9,7 +9,44 @@ All Broadcom headers are licensed under 3-Clause BSD License while the rest of t
 \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 basically the same; you just have to be careful of OSX's built-in gcc (it's actually llvm) and the default version of guile (2.x and totally not compatible with older syntax). \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, i set the library path here because mine initially had a trailing “:” and something in the build chain didn’t like that. 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
@@ -18,8 +55,6 @@ The current iteration of ARM chainloader (which I've still yet to commit) can ac
 \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
 \r
-**Beware:** This doesn't handle SMP at the moment so if you run this on RPi2 and above, all ARM cores will start executing the ARM bootloader code at the start which could cause problems. I will fix this soon.\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
@@ -36,4 +71,5 @@ Eventually maybe. Since `start.elf` is responsible for clock and power managemen
  * **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
+ * **alyssa** for her contributions to the firmware especially in areas of Linux bringup and early ARM side initialization, as well as fixing mailbox support.\r
  * Various other people not mentioned here.\r
This page took 0.024397 seconds and 4 git commands to generate.