Simplify README a great deal
authorAlyssa Rosenzweig <alyssa@rosenzweig.io>
Tue, 17 Jan 2017 02:53:57 +0000 (18:53 -0800)
committerAlyssa Rosenzweig <alyssa@rosenzweig.io>
Tue, 17 Jan 2017 02:53:57 +0000 (18:53 -0800)
README.md

index 6849ef4..8830f0a 100755 (executable)
--- a/README.md
+++ b/README.md
@@ -1,69 +1,35 @@
 # 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. 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), but it should work with minimal modifications on all of the models. Development primarily targets the RPi 2 Model B.\r
+This is a small firmware for RPi VPU (VideoCore4), capable of initializing UART, VPU PLL (PLLC) and ARM itself. It's intended as a libre replacement of the stock `bootcode.bin` on RPi's SD card. You **need** to setup UART to see anything meaningful at the moment. 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
-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
+Linux is confirmed booting on the RPi 2 Model B and RPi 3 Model B. It should work with minimal modifications on all of the models. \r
 \r
-All Broadcom headers are licensed under 3-Clause BSD License while our code is under GPLv2+. See `LICENSE` for more information.\r
+If you want to contact us because you're interested in contributing, development discussion occurs in `#raspberrypi-internals` on [Freenode](http://webchat.freenode.net/?channels=#raspberrypi-internals). Please come on IRC before randomly hacking on the codebase :-)\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. 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
+All Broadcom headers are licensed under 3-Clause BSD License while our code is under GPLv2+. See `LICENSE` for more information. Various external projects are mirrored under a mix of GPL-compatible licenses.\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
+## Building\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
+As a prerequisite, Julian Brown's [VC4 toolchain](https://github.com/puppeh/vc4-toolchain) is necessary as well as a `arm-none-eabi-` toolchain (Debian package `gcc-arm-none-eabi`). You can tweak the VC4 toolchain path in `CROSS_COMPILE` in `Makefile` and the ARM path in `arm_chainloader/Makefile` if necessary. Contributors should not commit their personal paths. Contributors should also use tabs for indentation. After you've configured the build, run `buildall.sh` and you should have a blob in `build/bootcode.bin`, ready to be copied to an SD card.\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
+### Building on macOS\r
 \r
-That's it! Your shiny new binary is sitting at rpi-open-firmware/build/bootcode.bin.\r
+macOS compilation is similar to GNU/Linux. Instructions for building the ARM toolchain can be found [here](https://launchpadlibrarian.net/287100910/How-to-build-toolchain.pdf). GCC must be installed manually, as Apple's default compiler is LLVM-based. Additionally, an older version of guile is necessary (homebrew packages `gcc-6` and `guile18`, respectively). Finally, set the environment variable `LIBRARY_PATH` to `/lib:/lib64` when running `buildall.sh` to workaround a platform bug.\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 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
+The firmware is split into two parts, one running on the VC4 and the other on ARM. 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 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
+The ARM chainloader initializes the eMMC controller and accesses the boot partition with a small 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
 ## Does it boot Linux?\r
 \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
+Yes, with some conditions. You can boot a very minimal version of Linux without the firmware and get it to work with UART and eMMC. Support for USB, DMA, and Ethernet are in the works, which will be sufficient for certain headless systems. Still, many other peripherals require bringup, such as video. Additionally, drivers for clock and power management need to written.\r
 \r
 ## Thanks To\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
+ * **[Sccott Mansell](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.027496 seconds and 4 git commands to generate.