Massive move of files to fit new website structure

This commit will most likely break many links, relative and
rendered. Fix and cleanup will happen over the next few days.

Signed-off-by: Robert Wolff <robert.wolff@linaro.org>
This commit is contained in:
Robert Wolff 2016-12-08 11:06:17 -08:00
parent 18f8097b87
commit dc79d6369d
274 changed files with 26636 additions and 6 deletions

View file

@ -0,0 +1,37 @@
h4. Building AOSP from source
Additional AOSP repositories are hosted at:
* https://github.com/96boards/android_hardware_ti_wpan
* https://github.com/96boards/android_device_linaro_hikey
* https://github.com/96boards/android_manifest
* https://github.com/96boards/linux (branch android-hikey-linaro-4.1)
*Build setup:*
Please setup the host machine by following the instructions here: "http://source.android.com/source/initializing.html":http://source.android.com/source/initializing.html
NOTE: The build tries to mount a loop device as fat partition to create the boot-fat.uefi.img filesystem image. Please make sure your user is allowed to run those commands in sudo without password by running "visudo" and appending the following lines (replacing "<USER>" with your username):
bc. <USER> ALL= NOPASSWD: /bin/mount
<USER> ALL= NOPASSWD: /bin/umount
<USER> ALL= NOPASSWD: /sbin/mkfs.fat
<USER> ALL= NOPASSWD: /bin/cp
*Download the code:*
bc. mkdir android/
cd android/
Download and extract the Mali vendor binaries in the above directory: "http://builds.96boards.org/snapshots/hikey/linaro/binaries/20150706/vendor.tar.bz2":http://builds.96boards.org/snapshots/hikey/linaro/binaries/20150706/vendor.tar.bz2
*Build the image:*
bc. repo init -u https://android.googlesource.com/platform/manifest -b android-6.0.1_r16 -g "default,-device,-non-default,hikey"
cd .repo/
git clone https://github.com/96boards/android_manifest -b android-6.0 local_manifests
cd -
repo sync -j8
source build/envsetup.sh
lunch hikey-userdebug
make droidcore -j8
cd out/target/product/hikey

View file

@ -0,0 +1,53 @@
h3. Boot Loader
Please see "https://github.com/96boards/documentation/wiki/Reference-Bootloader-Hikey#building-from-source":https://github.com/96boards/documentation/wiki/Reference-Bootloader-Hikey#building-from-source for instructions on how to built the boot loader from source.
h3. How to get and customize the kernel source code
h4. Building the Linux kernel from source
The Linux kernel used in this release is available via tags in the git "repository":https://github.com/rsalveti/linux
bc. git: https://github.com/rsalveti/linux
tag: 96boards-rpb-debian-15.12-hikey
defconfig: arch/arm64/defconfig kernel/configs/distro.config
The kernel image (@Image@) is located in the @/boot@ directory from the system partition (rootfs), with the modules also installed in the root file system. It is possible for a user to rebuild the kernel and run a custom kernel image instead of the released kernel. You can build the kernel using any recent GCC release using the git tree, tag and defconfig mentioned above. This release only supports booting with device tree, as such both the device tree blobs need to be built as well.
The HiKey is an ARMv8 platform, and the kernel is compiled for the Aarch64 target. Even though it is possible to build natively, on the target board, It is recommended to build the Linux kernel on a PC development host. In which case you need to install a cross compiler for the ARM architecture. It is recommended to download the "Linaro GCC cross compiler (Aarch64 little-endian)":http://releases.linaro.org/14.11/components/toolchain/binaries/aarch64-linux-gnu/gcc-linaro-4.9-2014.11-x86_64_aarch64-linux-gnu.tar.xz.
To build the Linux kernel, you can use the following instructions:
bc. git clone -n https://github.com/rsalveti/linux.git
cd linux
git checkout -b kernel-rpb-15.12 96boards-rpb-debian-15.12-hikey
export ARCH=arm64
export CROSS_COMPILE=<path to your GCC cross compiler>/aarch64-linux-gnu-
make defconfig distro.config
make -j4 Image dtbs KERNELRELEASE=4.3.0-your-custom-release
To boot using your own kernel, simply copy the kernel, modules and device tree to the root file system (similar to desktops), and create your own grub entry at @/boot/grub/grub.cfg@.
h4. How to get and customize Debian packages source code
This release is based on Debian 8.2 "Jessie".
Since all packages installed in Linaro Debian-based images are maintained either in Debian archives or in Linaro repositories, it is possible for users to update their environment with commands such as:
bc. sudo apt-get update
sudo apt-get upgrade
All user space software is packaged using Debian packaging process. As such you can find extensive information about using, patching and building packages in The Debian New Maintainers Guide. If you quickly want to rebuild any package, you can run the following commands to fetch the package source code and install all build dependencies:
bc. sudo apt-get update
sudo apt-get build-dep <pkg>
apt-get source <pkg>
Then you can rebuild the package locally with:
bc. cd <pkg-version>
dpkg-buildpackage -b -us -uc
h4. TODO
* Explain how to build the rootfs from source

View file

@ -0,0 +1,112 @@
h2. Install Instructions - CE AOSP RPB 15.12 - HiKey
This guide describes how to get started with the CE AOSP Reference Platform Build, release 15.12, for HiKey.
For more information about the HiKey development board, please check "https://www.96boards.org/products/ce/hikey/":https://www.96boards.org/products/ce/hikey/
h3. Image Components
The CE AOSP RPB 15.12 - HiKey build is composed of the following artifacts:
* Bootloader:
** ARM Trusted Firmware, EDK2/UEFI and Grub2
** For more information about the reference bootloader used by HiKey, please check "Reference-Bootloader-Hikey":https://github.com/96boards/documentation/wiki/Reference-Bootloader-Hikey
** Pre-built files: "http://builds.96boards.org/releases/reference-platform/aosp/hikey/15.12/bootloader":http://builds.96boards.org/releases/reference-platform/aosp/hikey/15.12/bootloader
* Linux Kernel:
** Derived from Linux 4.1 kernel
** Git: "https://github.com/96boards/linux.git":https://github.com/96boards/linux.git
** Branch: *android-hikey-linaro-4.1*
* AOSP Android Marshmallow 6.0
h4. Closed source binaries
The following components requires a closed source binary for better hardware support:
* TI wlan firmware (@wl18xx@)
** Git: "http://git.ti.com/wilink8-wlan/wl18xx_fw":http://git.ti.com/wilink8-wlan/wl18xx_fw
** Branch: *R8.5*
* Extra firmware files available from firmware-linux
* Mali (requires EULA)
h3. Downloading the pre-built binaries
The build is composed by the traditional Android image files (@boot@, @cache@, @system@ and @userdata@), but to avoid incompatibilities issues with older bootloaders, or different partition tables, it's also recommended to flash the bootloader.
*Bootloader files:*
bc. wget http://builds.96boards.org/releases/reference-platform/aosp/hikey/15.12/bootloader/l-loader.bin
wget http://builds.96boards.org/releases/reference-platform/aosp/hikey/15.12/bootloader/nvme.img
wget http://builds.96boards.org/releases/reference-platform/aosp/hikey/15.12/bootloader/fip.bin
wget http://builds.96boards.org/releases/reference-platform/aosp/hikey/15.12/bootloader/ptable-aosp-4g.img
wget http://builds.96boards.org/releases/reference-platform/aosp/hikey/15.12/bootloader/ptable-aosp-8g.img
wget http://builds.96boards.org/releases/reference-platform/aosp/hikey/15.12/bootloader/hisi-idt.py
*CE AOSP RPB image:*
bc. wget http://builds.96boards.org/releases/reference-platform/aosp/hikey/15.12/boot_fat.uefi.img.tar.xz
wget http://builds.96boards.org/releases/reference-platform/aosp/hikey/15.12/cache.img.tar.xz
wget http://builds.96boards.org/releases/reference-platform/aosp/hikey/15.12/userdata.img.tar.xz
wget http://builds.96boards.org/releases/reference-platform/aosp/hikey/15.12/userdata-8gb.img.tar.xz
Since @system.img@ requires the user to accept an End User License Agreement covering the rights to download and use the proprietary Mali userspace driver, it needs to be manually downloaded via browser. Please go to "http://builds.96boards.org/releases/reference-platform/aosp/hikey/15.12/system.img.tar.xz":http://builds.96boards.org/releases/reference-platform/aosp/hikey/15.12/system.img.tar.xz and follow the instructions to download the file.
Uncompress the .tar.xz files using your operating system file manager, or with the following command, for each file:
bc. xz --decompress [filename].tar.xz; tar -xvf [filename].tar
h3. Flashing
h4. Bootloader
To flash the bootloader the recovery mode is required. For more information about the recovery mode, how to enable and use, please go to "https://github.com/96boards/documentation/wiki/Reference-Bootloader-Hikey#enabling-recovery-mode":https://github.com/96boards/documentation/wiki/Reference-Bootloader-Hikey#enabling-recovery-mode
Now you need to identify if your device contains 4G or 8G of eMMC (LeMaker produces 2 HiKey versions, one with 4G and another with 8G of storage). The @ptable-aosp@ and @userdata@ files will differ depending on the board you have.
On recovery mode, flash the bootloader with the following command:
bc. sudo python hisi-idt.py --img1=l-loader.bin -d /dev/ttyUSB0
Then on a 4G compatible device:
bc. sudo fastboot flash ptable ptable-aosp-4g.img
Or the following on a 8G compatible device:
bc. sudo fastboot flash ptable ptable-aosp-8g.img
Then flash UEFI:
bc. sudo fastboot flash fastboot fip.bin
Change @ttyUSB0@ to the right interface name that gets exported to your host system.
Make sure to reboot the board after updating the partition table (@ptable-aosp@), otherwise flashing the system image might fail.
h4. Boot, System, Cache and Userdata
Fastboot is required to flash boot, system, cache and userdata.
*Flashing boot, cache, system and userdata:*
Enable fastboot (either via recovery or by changing the boot jumpers), and then just flash the required files:
bc. sudo fastboot flash boot boot_fat.uefi.img
sudo fastboot flash cache cache.img
sudo fastboot flash system system.img
sudo fastboot flash nvme nvme.img
Then on a 4G compatible device:
bc. sudo fastboot flash userdata userdata.img
Or the following on a 8G compatible device:
bc. sudo fastboot flash userdata userdata-8gb.img
Once flashed, make sure recovery mode is not enabled (pin3-pin4 on J15), that you don't have any sd card in place (since it first tries to boot from sd card, boot order can be changed with @sudo fastboot oem bootdevice [emmc|sd]@), then just reboot the board and enjoy :-)
h3. Additional resources
For known issues and more information about this release, please check "https://github.com/96boards/documentation/wiki/ReferencePlatform":https://github.com/96boards/documentation/wiki/ReferencePlatform

View file

@ -0,0 +1,97 @@
h2. Install Instructions - CE Debian RPB 15.12 - HiKey
This guide describes how to get started with the CE Debian Reference Platform Build, release 15.12, for HiKey.
For more information about the HiKey development board, please check "https://www.96boards.org/products/ce/hikey/":https://www.96boards.org/products/ce/hikey/
h3. Image Components
The CE Debian RPB 15.12 - HiKey build is composed of the following artifacts:
* Bootloader:
** ARM Trusted Firmware, EDK2/UEFI and Grub2
** For more information about the reference bootloader used by HiKey, please check "Reference-Bootloader-Hikey":https://github.com/96boards/documentation/wiki/Reference-Bootloader-Hikey
** Pre-built files: "http://builds.96boards.org/releases/reference-platform/debian/hikey/15.12/bootloader":http://builds.96boards.org/releases/reference-platform/debian/hikey/15.12/bootloader
* Linux Kernel:
** Upstream plus extra changes for a better hardware support
** Git: "https://github.com/rsalveti/linux.git":https://github.com/rsalveti/linux.git
** Branch: *reference-hikey-rebase*
* Debian "Jessie"
** ALIP (LXDE based)
** Custom 96Boards artworks and default settings
** Additional packages provided by "linaro-overlay":http://repo.linaro.org/ubuntu/linaro-overlay
** Kernel and initrd loaded from the rootfs (under /boot)
h4. Closed source binaries
The following components requires a closed source binary for better hardware support:
* TI wlan firmware (@wl18xx@)
** Git: "http://git.ti.com/wilink8-wlan/wl18xx_fw":http://git.ti.com/wilink8-wlan/wl18xx_fw
** Branch: *R8.6*
* Extra firmware files available from firmware-linux
* Mali (not yet included by default)
h3. Downloading the pre-built binaries
The build is mainly composed by two image files (boot and rootfs), but to avoid incompatibilities issues with older bootloaders, or different partition tables, it's also recommended to flash the bootloader.
Flashing and booting from the external SD Card is not supported by this release.
*Bootloader files:*
bc. wget http://builds.96boards.org/releases/reference-platform/debian/hikey/15.12/bootloader/l-loader.bin
wget http://builds.96boards.org/releases/reference-platform/debian/hikey/15.12/bootloader/nvme.img
wget http://builds.96boards.org/releases/reference-platform/debian/hikey/15.12/bootloader/fip.bin
wget http://builds.96boards.org/releases/reference-platform/debian/hikey/15.12/bootloader/ptable-linux-4g.img
wget http://builds.96boards.org/releases/reference-platform/debian/hikey/15.12/bootloader/ptable-linux-8g.img
wget http://builds.96boards.org/releases/reference-platform/debian/hikey/15.12/bootloader/hisi-idt.py
*CE Debian RPB image:*
bc. wget https://builds.96boards.org/releases/reference-platform/debian/hikey/15.12/hikey-boot-linux-20151214-35.uefi.img.gz
wget https://builds.96boards.org/releases/reference-platform/debian/hikey/15.12/hikey-rootfs-debian-jessie-alip-20151214-35.emmc.img.gz
gunzip hikey-*
h3. Flashing
h4. Bootloader
To flash the bootloader the recovery mode is required. For more information about the recovery mode, how to enable and use, please check "https://github.com/96boards/documentation/wiki/Reference-Bootloader-Hikey#enabling-recovery-mode":https://github.com/96boards/documentation/wiki/Reference-Bootloader-Hikey#enabling-recovery-mode
Now you need to identify if your device contains 4G or 8G of eMMC (LeMaker produces 2 HiKey versions, one with 4G and another with 8G of storage). The @ptable-linux@ file will differ depending on the board you have.
On recovery mode, flash the bootloader with the following command:
bc. sudo python hisi-idt.py --img1=l-loader.bin
Then on a 4G compatible device:
bc. sudo fastboot flash ptable ptable-linux-4g.img
Or the following on a 8G compatible device:
bc. sudo fastboot flash ptable ptable-linux-8g.img
Then flash UEFI:
bc. sudo fastboot flash fastboot fip.bin
Make sure to reboot the board after updating the partition table (@ptable-linux@), otherwise flashing the rootfs might fail.
h4. Boot and Rootfs
Fastboot is required to flash both the boot and rootfs images.
To avoid bug "117 (UEFI fastboot uploads hangs for large images)":https://bugs.96boards.org/show_bug.cgi?id=117, it's recommended to flash both the boot and rootfs images via recovery mode (after running @hisi-idt.py@).
*Flashing boot and rootfs:*
bc. sudo fastboot flash boot hikey-boot-linux-20151214-35.uefi.img
sudo fastboot flash system hikey-rootfs-debian-jessie-alip-20151214-35.emmc.img
Once flashed, make sure recovery mode is not enabled (pin3-pin4 on J15), that you dont have any sd card in place (since it first tries to boot from sd card, boot order can be changed with sudo fastboot oem bootdevice [emmc|sd]), then just reboot the board and enjoy :-)
h3. Additional resources
For known issues and more information about this release, please check "https://github.com/96boards/documentation/wiki/ReferencePlatform":https://github.com/96boards/documentation/wiki/ReferencePlatform

View file

@ -0,0 +1,18 @@
# HiKey Reference Platform Build - 15.12
- **Install Instructions:** For "out-of-box" users. Instructions for installing pre-build Reference Platform images onto your 96Boards.
- **Build from Source:** For Advanced users. Instructions for building and installing the various Reference Platform components used by Consumer Edition 96Boards.
- **Known Issues:** List of current bugs and issues for each Reference Platform Build. Includes links to bug reports for tracking resolution progress.
- **Test Report:** Provides test results and bug status for kernel, firmware, and images with a straight forward pass/fail legend.
***
#### HiKey
| **CE Debian RPB - 15.12** | **CE AOSP RPB - 15.12** |
|:------------------------------------------------------:|:---------------------------------------------------:|
| [Install Instructions](InstallDebianRPB-15.12.md) | [Install Instructions](InstallAOSPRPB-15.12.md) |
| [Build from Source](BFSDebianRPB-15.12.md) | [Build from Source](BFSAOSPRPB-15.12.md) |
| [Known issues](../../Known-Issues.md) | [Known issues](../../Known-Issues.md) |
***