Merge "Docs: Changes to source.android.com"

am: f3e7e140eb Change-Id: I4dfb1bb26bb34dca69f063d6eb22904bdce25f57
author: Clay Murphy <claym@google.com> 2017-11-21 18:26:25 +0000
committer: android-build-merger <android-build-merger@google.com> 2017-11-21 18:26:25 +0000
commit: f7589848f0a87d4de2f076ecb1ba05600838602a (patch)
tree: 39231430651ca3210a79e1a8dbb2b14c41ed4a68 /en/setup/devices.html
parent: bf32eb5d4814ca1ba17503c6da6a797c21bd1295 (diff)
parent: f3e7e140eb98c82b182eb71d7190a6774b2a35f1 (diff)
download: source.android.com-f7589848f0a87d4de2f076ecb1ba05600838602a.tar.gz
1 files changed, 357 insertions, 0 deletions
diff --git a/en/setup/devices.html b/en/setup/devices.html
new file mode 100644
index 00000000..c8bbbe75
--- /dev/null
+++ b/en/setup/devices.html
@@ -0,0 +1,357 @@
+<html devsite>
+  <head>
+    <title>Using Reference Boards</title>
+    <meta name="project_path" value="/_project.yaml" />
+    <meta name="book_path" value="/_book.yaml" />
+  </head>
+  <body>
+  <!--
+      Copyright 2017 The Android Open Source Project
+
+      Licensed under the Apache License, Version 2.0 (the "License");
+      you may not use this file except in compliance with the License.
+      You may obtain a copy of the License at
+
+          http://www.apache.org/licenses/LICENSE-2.0
+
+      Unless required by applicable law or agreed to in writing, software
+      distributed under the License is distributed on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+      See the License for the specific language governing permissions and
+      limitations under the License.
+  -->
+
+
+<p>You can create builds for Nexus devices using Android Open Source Project
+(AOSP) builds and the relevant hardware-specific binaries. For available
+Android builds and targeted devices, see
+<a href="/setup/build-numbers.html#source-code-tags-and-builds">Source Code,
+Tags, and Builds</a>.</p>
+
+<p>You can also create builds for
+<a href="https://android.googlesource.com/device/linaro/hikey/" class="external">HiKey</a>
+Android reference boards, which are designed to help non-Nexus component vendors
+develop and port drivers to Android releases. Using a reference board can ease
+upgrade efforts, reduce time-to-market for new Android devices, lower device
+costs by enabling ODM/OEMs to choose from a wider range of compatible
+components, and increase the speed of innovation among component suppliers.</p>
+
+<p>Google supports <a href="#960hikey">HiKey960</a> and
+<a href="#620hikey">HiKey</a> certified
+<a href="https://www.96boards.org/products/ce/" class="external">96Boards</a>
+as Android reference boards. AOSP provides kernel source and board support for
+HiKey so developers can easily create and debug new and existing peripheral
+drivers, do kernel development, and perform other tasks with fewer OEM
+encumbrances. To develop new ContextHub features that use new sensors or LEDs,
+you can also use a <a href="#neonkey">Neonkey SensorHub</a> connected to a HiKey
+or HiKey960 development board.</p>
+
+<h2 id="960hikey">HiKey960 boards</h2>
+
+<p>The HiKey960 board is available in a 3GB RAM configuration from LeMaker (via
+<a href="https://www.amazon.com/dp/B071RD3V34" class="external">Amazon.com</a>)
+and from <a href="http://www.lenovator.com/product/80.html" class="external">Lenovator<a/>.
+</p>
+
+<img src="images/hikey960.png" alt="HiKey960 board image" />
+<figcaption><strong>Figure 1.</strong> HiKey960 board by Lenovator</figcaption>
+
+<p>Additional resources:</p>
+<ul>
+<li>
+<a href="https://github.com/96boards/documentation/blob/master/ConsumerEdition/HiKey960/HardwareDocs/HiKey960_Schematics.pdf" class="external">HiKey960
+schematics</a></li>
+<li>
+<a href="http://www.96boards.org/documentation/ConsumerEdition/HiKey960/HardwareDocs/HardwareUserManual.md/" class="external">HiKey960
+user guide</a></li>
+<li>
+<a href="https://github.com/96boards/documentation/wiki/" class="external">96boards wiki</a></li>
+</ul>
+
+<p>Use the following commands to download, build, and run Android on the
+HiKey960 board.</p>
+
+<h3 id="960userspace">Compiling userspace</h3>
+<ol>
+  <li>Download the Android source tree:
+<pre class="devsite-click-to-copy">
+<code class="devsite-terminal">repo init -u <a href="https://android.googlesource.com/platform/manifest">https://android.googlesource.com/platform/manifest</a> -b master</code>
+<code class="devsite-terminal">repo sync -j24</code>
+</pre>
+  </li>
+  <li>Download and extract binaries into the Android source tree:
+<pre class="devsite-click-to-copy">
+<code class="devsite-terminal">wget https://dl.google.com/dl/android/aosp/arm-hikey960-OPR-cf4e0c80.tgz</code>
+<code class="devsite-terminal">tar xzf arm-hikey960-OPR-cf4e0c80.tgz</code>
+<code class="devsite-terimnal">./extract-arm-hikey960.sh</code>
+</pre>
+  </li>
+  <li>Build:
+<pre class="devsite-click-to-copy">
+<code class="devsite-terminal">. ./build/envsetup.sh</code>
+<code class="devsite-terminal">lunch hikey960-userdebug</code>
+<code class="devsite-terminal">make -j32</code>
+</pre>
+  </li>
+</ol>
+
+<h3 id="960fastboot">Installing initial images</h3>
+<ol>
+  <li>Select fastboot mode turning ON switch 1 and 3 (for details, refer to the
+HiKey960 user guide).</li>
+  <li>Power the board.</li>
+  <li>Flash initial images:
+<pre class="devsite-click-to-copy">
+<code class="devsite-terminal">cd device/linaro/hikey/installer/hikey960</code>
+<code class="devsite-terminal">./flash-all.sh</code>
+</pre>
+  </li>
+  <li>Turn OFF switch 3 and power cycle the board.</li>
+</ol>
+
+<h3 id="960images">Flashing images</h3>
+<ol>
+  <li>Enter fastboot mode by turning ON switch 1 and 3.</li>
+  <li>Flash images by running the following commands:
+<pre class="devsite-click-to-copy">
+<code class="devsite-terminal">fastboot flash boot out/target/product/hikey960/boot.img</code>
+<code class="devsite-terminal">fastboot flash dts out/target/product/hikey960/dt.img</code>
+<code class="devsite-terminal">fastboot flash system out/target/product/hikey960/system.img</code>
+<code class="devsite-terminal">fastboot flash cache out/target/product/hikey960/cache.img</code>
+<code class="devsite-terminal">fastboot flash userdata out/target/product/hikey960/userdata.img</code>
+</pre>
+  </li>
+  <li>Turn OFF switch 3 and power cycle the board.</li>
+</ol>
+
+<h3 id="960kernel">Building the kernel</h3>
+<ol>
+  <li>Run the following commands:
+<pre class="devsite-click-to-copy">
+<code class="devsite-terminal">git clone <a href="https://android.googlesource.com/kernel/hikey-linaro">https://android.googlesource.com/kernel/hikey-linaro</a></code>
+<code class="devsite-terminal">cd hikey-linaro</code>
+<code class="devsite-terminal">git checkout -b android-hikey-linaro-4.9 origin/android-hikey-linaro-4.9</code>
+<code class="devsite-terminal">make ARCH=arm64 hikey960_defconfig</code>
+<code class="devsite-terminal">make ARCH=arm64 CROSS_COMPILE=aarch64-linux-android- -j24</code>
+</pre>
+  </li>
+  <li>Update the kernel in the boot image.
+    <ul>
+      <li>Copy <code>hi3660-hikey960.dtb</code>
+        (<code>arch/arm64/boot/dts/hisilicon/hi3660-hikey960.dtb</code>) to the
+        <code>hikey-kernel</code> directory as file:
+      <code>hi3660-hikey960.dtb-4.9</code></li>
+      <li>Copy the Image file <code>(arch/arm64/boot/Image.gz</code>) to the
+        <code>hikey-kernel</code> directory as file:
+        <code>Image.gz-hikey960-4.9</code></li>
+    </ul>
+  <li>Make the boot image:
+<pre class="devsite-terminal devsite-click-to-copy">
+make bootimage -j24
+</pre>
+  </li>
+</ol>
+
+<h3 id="960serial">Setting serial number</h3>
+<p>To set random serial number, run:
+<pre class="devsite-terminal devsite-click-to-copy">
+fastboot getvar nve:SN@<var>16_DIGIT_NUMBER</var>
+</pre>
+<p>Bootloader exports the generated serial number to kernel via
+<code>androidboot.serialno=</code>.
+
+<h3 id="960resolution">Setting monitor resolution</h3>
+<p>Edit the <code>device/linaro/hikey/hikey960/BoardConfig.mk</code> parameter
+<code>BOARD_KERNEL_CMDLINE</code> and configure the <code>video</code> setting.
+Example setting for a 24" monitor is <code>video=HDMI-A-1:1280x800@60</code>.
+</p>
+
+<h2 id="620hikey">HiKey boards</h2>
+
+<p>The HiKey board (also known as HiKey620) is available in
+<a href="http://www.lenovator.com/product/86.html" class="external">1GB RAM</a>
+and <a href="http://www.lenovator.com/product/90.html" class="external">2GB
+RAM</a> configurations from <a href="http://www.lenovator.com" class="external">Lenovator</a>:
+</p>
+
+<img src="images/hikey620.png" alt="HiKey620 board image"/>
+<figcaption><strong>Figure 2.</strong> HiKey board by Lenovator</figcaption>
+
+<p>Additional resources:</p>
+<ul>
+<li>
+<a href="https://github.com/96boards/documentation/blob/master/ConsumerEdition/HiKey/HardwareDocs/HiKey_schematics_LeMaker_version_Rev_A1.pdf" class="external">HiKey
+schematics</a></li>
+<li>
+<a href="https://www.96boards.org/wp-content/uploads/2015/02/HiKey_User_Guide_Rev0.2.pdf" class="external">HiKey
+user guide</a></li>
+<li><a href="https://github.com/96boards/documentation/wiki/" class="external">96boards
+wiki</a></li>
+</ul>
+
+<p>Use the following commands to download, build, and run Android on the HiKey
+board.</p>
+
+<h3 id="620userspace">Compiling userspace</h3>
+<ol>
+  <li>Download the Android source tree:
+<pre class="devsite-click-to-copy">
+<code class="devsite-terminal">repo init -u <a href="https://android.googlesource.com/platform/manifest">https://android.googlesource.com/platform/manifest</a> -b master</code>
+<code class="devsite-terminal">repo sync -j24</code>
+</pre>
+  </li>
+  <li>Download and extract HDMI binaries into the Android source tree:
+<pre class="devsite-click-to-copy">
+<code class="devsite-terminal">wget <a href="https://dl.google.com/dl/android/aosp/linaro-hikey-20170523-4b9ebaff.tgz">https://dl.google.com/dl/android/aosp/linaro-hikey-20170523-4b9ebaff.tgz</a></code>
+<code class="devsite-terminal">tar xzf linaro-hikey-20170523-4b9ebaff.tgz</code>
+<code class="devsite-terminal">./extract-linaro-hikey.sh</code>
+</pre>
+  </li>
+  <li>Install mcopy utility:
+<pre class="devsite-terminal devsite-click-to-copy">
+apt-get install mtools
+</pre>
+  </li>
+  <li>Build:
+<pre class="devsite-click-to-copy">
+<code class="devsite-terminal">. ./build/envsetup.sh</code>
+<code class="devsite-terminal">lunch hikey-userdebug</code>
+<code class="devsite-terminal">make -j32</code>
+</pre>
+  </li>
+</ol>
+
+<p class="note"><strong>Note:</strong> For 4GB eMMC, instead of <code>$ make -j32</code>
+use: <code>$ make -j32 TARGET_USERDATAIMAGE_4GB=true</code>.</p>
+
+<h3 id="620fastboot">Installing initial fastboot and ptable</h3>
+<ol>
+  <li>Select special bootloader mode by linking J15 1-2 and 3-4 pins (for details,
+refer to the
+<a href="https://www.96boards.org/wp-content/uploads/2015/02/HiKey_User_Guide_Rev0.2.pdf" class="external">HiKey
+user guide</a>).</li>
+  <li>Connect USB to PC to get ttyUSB device (ex: <code>/dev/ttyUSB1</code>).</li>
+  <li>Power the board:
+<pre class="devsite-click-to-copy">
+<code class="devsite-terminal">cd device/linaro/hikey/installer/hikey</code>
+<code class="devsite-terminal">./flash-all.sh /dev/ttyUSB1 [4g]</code>
+</pre>
+  </li>
+  <li>Remove jumper 3-4 and power the board.</li>
+</ol>
+
+<h3 id="620images">Flashing images</h3>
+<ol>
+  <li>Enter fastboot mode by linking J15 1-2 and 5-6 pins.</li>
+  <li>Run the following commands:
+<pre class="devsite-click-to-copy">
+<code class="devsite-terminal">fastboot flash boot out/target/product/hikey/boot.img</code>
+<code class="devsite-terminal">fastboot flash -w system out/target/product/hikey/system.img</code>
+</pre>
+  </li>
+  <li>Remove jumper 5-6 and power the board.</li>
+</ol>
+
+<h3 id="620kernel">Building the kernel</h3>
+<ol>
+  <li>Run the following commands:
+<pre class="devsite-click-to-copy">
+<code class="devsite-terminal">git clone <a href="https://android.googlesource.com/kernel/hikey-linaro">https://android.googlesource.com/kernel/hikey-linaro</a></code>
+<code class="devsite-terminal">cd hikey-linaro</code>
+<code class="devsite-terminal">git checkout -b android-hikey-linaro-4.9 origin/android-hikey-linaro-4.9</code>
+<code class="devsite-terminal">make ARCH=arm64 hikey_defconfig</code>
+<code class="devsite-terminal">make ARCH=arm64 CROSS_COMPILE=aarch64-linux-android- -j24</code>
+</pre>
+  </li>
+  <li>Copy output to the hikey kernel directory (<code>/kernel/hikey-linaro</code>):
+    <ul>
+      <li>Copy hi6220-hikey.dtb (<code>arch/arm64/boot/dts/hisilicon/hi6220-hikey.dtb</code>) to the
+hikey-kernel directory as file hi6220-hikey.dtb-4.9.</li>
+  <li>Copy the Image file <code>(arch/arm64/boot/Image-dtb</code>) to the
+hikey-kernel directory as file Image-dtb-4.9.</li>
+    </ul>
+  <li>Make the boot image:
+<pre class="devsite-terminal devsite-click-to-copy">
+make bootimage -j24
+</pre>
+  </li>
+</ol>
+
+<h3 id="620resolution">Setting monitor resolution</h3>
+<p>Edit <code>device/linaro/hikey/hikey/BoardConfig.mk</code> parameter
+<code>BOARD_KERNEL_CMDLINE</code> and configure the <code>video</code> setting.
+Example setting for a 24" monitor: <code>video=HDMI-A-1:1280x800@60</code>.</p>
+
+<h3 id="620serial">Configuring kernel serial output (uart3)</h3>
+<p>Set the J2 low speed expansion connector to 1 - Gnd, 11 - Rx, 13 - Tx. For
+details, refer to the
+<a href="https://www.96boards.org/wp-content/uploads/2015/02/HiKey_User_Guide_Rev0.2.pdf" class="external">HiKey
+user guide</a>.</p>
+
+<h2 id="neonkey">Neonkey SensorHub</h2>
+<p>To develop new ContextHub features that use new sensors or LEDs, you can use
+<a href="http://www.96boards.org/product/neonkey/" class="external">Neonkey
+SensorHub</a> connected to a Hikey or Hikey960 development board.</p>
+
+<img src="images/neonkey-sensorhub.png" alt="Neonkey Sensorhub image" />
+<figcaption><strong>Figure 3.</strong> Neonkey SensorHub</figcaption>
+
+<p>Neonkey is a certified <a href="http://www.96boards.org/" class="external">96Boards</a>
+mezzanine base on STM32F411CE with the following components:</p>
+
+<ul>
+<li>Pressure sensor: BMP280</li>
+<li>ALS/Proximity sensor: RPR-0521RS</li>
+<li>ARM Hall sensor: MRMS501A</li>
+<li>LED driver with 15 LEDs: LP3943</li>
+<li>Accel/Gyro + Geomagnetic sensors: BMI160 + BMM150</li>
+<li>Temp/Humidity sensor: SI7034-A10</li>
+<li>4 GPIO-driven LEDs, I2C expansion, GPIO (2 lines) expansion, JTAG connector</li>
+<li>NOR Flash: 512KB</li>
+<li>SRAM: 128 KB, 96boards LS Expansion connector</li>
+</ul>
+
+<p>Kernel source and ContextHub board support is available in AOSP to help
+developers create and debug new sensors, make new HAL and kernel changes, etc.
+with fewer OEM encumbrances.</p>
+
+<p>To build, enable, and upload Neonkey:</p>
+
+<ol>
+<li>Pull AOSP source:
+<pre class="devsite-terminal">
+repo init -u https://android.googlesource.com/platform/manifest -b master &amp; repo sync -j24
+</pre>
+</li>
+<li>Build:
+<pre class="devsite-click-to-copy">
+<code class="devsite-terminal">. ./build/envsetup.sh</code>
+<code class="devsite-terminal">lunch hikey-userdebug</code>
+<code class="devsite-terminal">. device/google/contexthub/firmware/toolchain-setup.sh</code>
+<code class="devsite-terminal">make -C device/google/contexthub/firmware/variant/neonkey</code>
+<code class="devsite-terminal">adb push device/google/contexthub/firmware/out/nanohub/neonkey/full.bin /data/local/tmp</code>
+</pre>
+</li>
+<li>To enable Neonkey, enter boot mode using the following method:
+<ol>
+<li>Connect BOOT0 to 1V8 (link JTAG P4 1-5 pins)</li>
+<li>Hold USR button</li>
+<li>Push RST button</li>
+</ol>
+</li>
+<li>To upload the firmware:
+<pre class="devsite-click-to-copy">
+<code class="devsite-terminal">adb root</code>
+<code class="devsite-terminal">adb shell stm32_flash -u -d /dev/ttyAMA2 -e 0xffff -w /data/local/tmp/full.bin</code>
+</pre>
+</li>
+<li>To build userspace HAL:
+<pre class="devsite-click-to-copy">
+<code class="devsite-terminal">make TARGET_SENSOR_MEZZANINE=neonkey -j24</code>
+<code class="devsite-terminal">fastboot flashall</code>
+</pre>
+</li>
+</ol>
+
+  </body>
+</html>
author	Clay Murphy <claym@google.com>	2017-11-21 18:26:25 +0000
committer	android-build-merger <android-build-merger@google.com>	2017-11-21 18:26:25 +0000
commit	f7589848f0a87d4de2f076ecb1ba05600838602a (patch)
tree	39231430651ca3210a79e1a8dbb2b14c41ed4a68 /en/setup/devices.html
parent	bf32eb5d4814ca1ba17503c6da6a797c21bd1295 (diff)
parent	f3e7e140eb98c82b182eb71d7190a6774b2a35f1 (diff)
download	source.android.com-f7589848f0a87d4de2f076ecb1ba05600838602a.tar.gz