Jean-Baptiste Queru | b4d39b4 | 2011-04-11 13:53:58 -0700 | [diff] [blame] | 1 | <!-- |
| 2 | Copyright 2010 The Android Open Source Project |
| 3 | |
| 4 | Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | you may not use this file except in compliance with the License. |
| 6 | You may obtain a copy of the License at |
| 7 | |
| 8 | http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | |
| 10 | Unless required by applicable law or agreed to in writing, software |
| 11 | distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | See the License for the specific language governing permissions and |
| 14 | limitations under the License. |
| 15 | --> |
| 16 | |
| 17 | # Building for devices # |
| 18 | |
Jean-Baptiste Queru | 3e466b0 | 2011-10-06 14:34:00 -0700 | [diff] [blame] | 19 | This page complements the main page about [Building](building.html) with |
| 20 | information that is specific to individual devices. |
Jean-Baptiste Queru | b4d39b4 | 2011-04-11 13:53:58 -0700 | [diff] [blame] | 21 | |
Jean-Baptiste Queru | c10820f | 2012-07-17 13:33:48 -0700 | [diff] [blame] | 22 | With the current release, it is possible to build for Nexus 7, for some |
| 23 | variants of Galaxy Nexus, for a variant of the Motorola Xoom, and for |
| 24 | all variants of Nexus S and Nexus S 4G. The exact level of functionality |
| 25 | for each device depends on the availability of the relevant proprietary |
| 26 | hardware-specific binaries. |
Jean-Baptiste Queru | 35f5101 | 2011-12-14 09:32:22 -0800 | [diff] [blame] | 27 | |
Jean-Baptiste Queru | c10820f | 2012-07-17 13:33:48 -0700 | [diff] [blame] | 28 | All variants of Nexus 7 can be used. On Nexus 7, graphics and audio are |
Jean-Baptiste Queru | c6dd102 | 2012-10-04 14:00:14 -0700 | [diff] [blame^] | 29 | functional, as well as WiFi and Bluetooth. Due to hardware differences, do |
| 30 | not use 4.1.1 on a Nexus 7 that was originally sold with 4.1.2 or newer. |
Jean-Baptiste Queru | 35f5101 | 2011-12-14 09:32:22 -0800 | [diff] [blame] | 31 | |
Jean-Baptiste Queru | c6dd102 | 2012-10-04 14:00:14 -0700 | [diff] [blame^] | 32 | The variants of Galaxy Nexus that can be used are the GSM/HSPA+ configuration |
Jean-Baptiste Queru | c10820f | 2012-07-17 13:33:48 -0700 | [diff] [blame] | 33 | "maguro" (only if it was originally sold with a "yakju" or "takju" operating |
| 34 | system) and the VZW CDMA/LTE configuration "toro". On those devices, graphics |
| 35 | and audio are functional, as well as WiFi, Bluetooth, and access to the |
| 36 | respective cellular networks. The orientation sensors are functional. |
Jean-Baptiste Queru | 35f5101 | 2011-12-14 09:32:22 -0800 | [diff] [blame] | 37 | |
Jean-Baptiste Queru | c6dd102 | 2012-10-04 14:00:14 -0700 | [diff] [blame^] | 38 | The Sprint CDMA/LTE configuration "toroplus" of Galaxy Nexus is supported |
| 39 | experimentally. On that configuration, the cellular network is not functional, |
| 40 | and the other peripherals work like they do on "toro". |
| 41 | |
| 42 | The Motorola Xoom can be used in the Wi-Fi configuration "wingray" |
Jean-Baptiste Queru | c10820f | 2012-07-17 13:33:48 -0700 | [diff] [blame] | 43 | sold in the USA. Graphics and audio are functional as well as WiFi and |
| 44 | Bluetooth and the orientation sensors. |
Jean-Baptiste Queru | 3e466b0 | 2011-10-06 14:34:00 -0700 | [diff] [blame] | 45 | |
Jean-Baptiste Queru | c10820f | 2012-07-17 13:33:48 -0700 | [diff] [blame] | 46 | All configurations of Nexus S and Nexus S 4G can be used, and on those |
| 47 | devices all the peripherals are functional: graphics, audio, Wifi, Bluetooth, |
| 48 | cell networks, sensors, camera, hardware codecs, NFC, GPS. |
| 49 | |
| 50 | In addition, [PandaBoard](http://pandaboard.org) a.k.a. "panda" can be used |
| 51 | in the master branch, but is considered experimental. |
Jean-Baptiste Queru | 3e466b0 | 2011-10-06 14:34:00 -0700 | [diff] [blame] | 52 | The specific details to use a PandaBoard with the Android Open-Source Project |
| 53 | are in the file `device/ti/panda/README` in the source tree. |
| 54 | |
Jean-Baptiste Queru | c10820f | 2012-07-17 13:33:48 -0700 | [diff] [blame] | 55 | Nexus One a.k.a. "passion" is obsolete, was experimental in gingerbread, |
| 56 | and can't be used with newer versions of the Android Open-Source |
Jean-Baptiste Queru | 3e466b0 | 2011-10-06 14:34:00 -0700 | [diff] [blame] | 57 | Project. |
| 58 | |
| 59 | Android Developer Phones (ADP1 and ADP2, a.k.a. "dream" and "sapphire") are |
Jean-Baptiste Queru | c10820f | 2012-07-17 13:33:48 -0700 | [diff] [blame] | 60 | obsolete, were experimental in froyo, and can't be used with |
Jean-Baptiste Queru | 3e466b0 | 2011-10-06 14:34:00 -0700 | [diff] [blame] | 61 | newer versions of the Android Open-Source Project. |
Jean-Baptiste Queru | b4d39b4 | 2011-04-11 13:53:58 -0700 | [diff] [blame] | 62 | |
| 63 | ## Building fastboot and adb ## |
| 64 | |
| 65 | If you don't already have those tools, fastboot and adb can be built with |
| 66 | the regular build system. Follow the instructions on the page about |
| 67 | [building](building.html), and replace the main `make` command with |
| 68 | |
| 69 | $ make fastboot adb |
| 70 | |
| 71 | ## Booting into fastboot mode ## |
| 72 | |
| 73 | During a cold boot, the following key combinations can be used to boot into fastboot mode, |
| 74 | which is a mode in the bootloader that can be used to flash the devices: |
| 75 | |
| 76 | Device | Keys |
| 77 | ---------|------ |
Jean-Baptiste Queru | c10820f | 2012-07-17 13:33:48 -0700 | [diff] [blame] | 78 | grouper | Press *Power* for a second, and press *Volume Down* when the bootloader logo appears |
Jean-Baptiste Queru | 3e466b0 | 2011-10-06 14:34:00 -0700 | [diff] [blame] | 79 | maguro | Press and hold both *Volume Up* and *Volume Down*, then press and hold *Power* |
Jean-Baptiste Queru | c10820f | 2012-07-17 13:33:48 -0700 | [diff] [blame] | 80 | toro | Press and hold both *Volume Up* and *Volume Down*, then press and hold *Power* |
Conley Owens | 9aaa52a | 2012-02-03 14:13:27 -0800 | [diff] [blame] | 81 | panda | Press and hold *Input*, then press *Power* |
Jean-Baptiste Queru | 35f5101 | 2011-12-14 09:32:22 -0800 | [diff] [blame] | 82 | wingray | Press and hold *Volume Down*, then press and hold *Power* |
Jean-Baptiste Queru | b4d39b4 | 2011-04-11 13:53:58 -0700 | [diff] [blame] | 83 | crespo | Press and hold *Volume Up*, then press and hold *Power* |
Jean-Baptiste Queru | c10820f | 2012-07-17 13:33:48 -0700 | [diff] [blame] | 84 | crespo4g | Press and hold *Volume Up*, then press and hold *Power* |
Jean-Baptiste Queru | b4d39b4 | 2011-04-11 13:53:58 -0700 | [diff] [blame] | 85 | passion | Press and hold the trackball, then press *Power* |
| 86 | sapphire | Press and hold *Back*, then press *Power* |
| 87 | dream | Press and hold *Back*, then press *Power* |
| 88 | |
Jean-Baptiste Queru | c10820f | 2012-07-17 13:33:48 -0700 | [diff] [blame] | 89 | Also, the command `adb reboot bootloader` can be used to reboot from |
Jean-Baptiste Queru | b4d39b4 | 2011-04-11 13:53:58 -0700 | [diff] [blame] | 90 | Android directly into the bootloader with no key combinations. |
| 91 | |
| 92 | ## Unlocking the bootloader ## |
| 93 | |
| 94 | It's only possible to flash a custom system if the bootloader allows it. |
| 95 | |
| 96 | This is the default setup on ADP1 and ADP2. |
| 97 | |
Jean-Baptiste Queru | c10820f | 2012-07-17 13:33:48 -0700 | [diff] [blame] | 98 | On Nexus One, Nexus S, Nexus S 4G, Xoom, Galaxy Nexus, and Nexus 7, |
Jean-Baptiste Queru | 35f5101 | 2011-12-14 09:32:22 -0800 | [diff] [blame] | 99 | the bootloader is locked by default. With the device in fastboot mode, the |
| 100 | bootloader is unlocked with |
Jean-Baptiste Queru | b4d39b4 | 2011-04-11 13:53:58 -0700 | [diff] [blame] | 101 | |
| 102 | $ fastboot oem unlock |
| 103 | |
| 104 | The procedure must be confirmed on-screen, and deletes the user data for |
| 105 | privacy reasons. It only needs to be run once. |
| 106 | |
Jean-Baptiste Queru | c10820f | 2012-07-17 13:33:48 -0700 | [diff] [blame] | 107 | Note that on the Nexus S, Nexus S 4G, Motorola Xoom, Galaxy Nexus, |
| 108 | and on Nexus 7, |
Jean-Baptiste Queru | 93afea9 | 2011-12-16 18:25:07 -0800 | [diff] [blame] | 109 | all data on the phone is erased, i.e. both the applications' private data |
| 110 | and the shared data that is accessible over USB, including photos and |
| 111 | movies. Be sure to make a backup of any precious files you have before |
| 112 | unlocking the bootloader. |
| 113 | |
Jean-Baptiste Queru | b4d39b4 | 2011-04-11 13:53:58 -0700 | [diff] [blame] | 114 | On Nexus One, the operation voids the warranty and is irreversible. |
| 115 | |
Jean-Baptiste Queru | c10820f | 2012-07-17 13:33:48 -0700 | [diff] [blame] | 116 | On Nexus S, Nexus S 4G, Xoom, Galaxy Nexus, and Nexus 7, |
Jean-Baptiste Queru | 35f5101 | 2011-12-14 09:32:22 -0800 | [diff] [blame] | 117 | the bootloader can be locked back with |
Jean-Baptiste Queru | b4d39b4 | 2011-04-11 13:53:58 -0700 | [diff] [blame] | 118 | |
| 119 | $ fastboot oem lock |
| 120 | |
Jean-Baptiste Queru | 93afea9 | 2011-12-16 18:25:07 -0800 | [diff] [blame] | 121 | Note that this erases user data on Xoom (including the shared USB data). |
Jean-Baptiste Queru | 35f5101 | 2011-12-14 09:32:22 -0800 | [diff] [blame] | 122 | |
Jean-Baptiste Queru | 5da7539 | 2011-05-17 14:32:56 -0700 | [diff] [blame] | 123 | ## Obtaining proprietary binaries ## |
Jean-Baptiste Queru | b4d39b4 | 2011-04-11 13:53:58 -0700 | [diff] [blame] | 124 | |
Jean-Baptiste Queru | c10820f | 2012-07-17 13:33:48 -0700 | [diff] [blame] | 125 | Starting with Ice Cream Sandwich, the Android Open-Source Project can't be used |
Jean-Baptiste Queru | 3e466b0 | 2011-10-06 14:34:00 -0700 | [diff] [blame] | 126 | from pure source code only, and requires additional hardware-related proprietary |
| 127 | libraries to run, specifically for hardware graphics acceleration. |
Jean-Baptiste Queru | b4d39b4 | 2011-04-11 13:53:58 -0700 | [diff] [blame] | 128 | |
Jean-Baptiste Queru | c10820f | 2012-07-17 13:33:48 -0700 | [diff] [blame] | 129 | Official binaries for Nexus S, Nexus S 4G, Galaxy Nexus, Nexus 7, and PandaBoard |
| 130 | can be downloaded from |
Jean-Baptiste Queru | 66426b3 | 2012-04-20 07:14:05 -0700 | [diff] [blame] | 131 | [Google's Nexus driver page](https://developers.google.com/android/nexus/drivers), |
Jean-Baptiste Queru | 5da7539 | 2011-05-17 14:32:56 -0700 | [diff] [blame] | 132 | which add access to additional hardware capabilities with non-Open-Source code. |
Jean-Baptiste Queru | b4d39b4 | 2011-04-11 13:53:58 -0700 | [diff] [blame] | 133 | |
Jean-Baptiste Queru | c10820f | 2012-07-17 13:33:48 -0700 | [diff] [blame] | 134 | When using the master branch for a device, the binaries for the most |
Jean-Baptiste Queru | 993d0b8 | 2012-04-19 17:24:35 -0700 | [diff] [blame] | 135 | recent numbered release are the ones that should be used in the master |
| 136 | branch. |
| 137 | |
Jean-Baptiste Queru | c10820f | 2012-07-17 13:33:48 -0700 | [diff] [blame] | 138 | There are limited binaries for Nexus One, and none for ADP2 or ADP1. |
Jean-Baptiste Queru | 5da7539 | 2011-05-17 14:32:56 -0700 | [diff] [blame] | 139 | |
| 140 | ### Extracting the proprietary binaries ### |
Jean-Baptiste Queru | b4d39b4 | 2011-04-11 13:53:58 -0700 | [diff] [blame] | 141 | |
Jean-Baptiste Queru | 3e466b0 | 2011-10-06 14:34:00 -0700 | [diff] [blame] | 142 | Each set of binaries comes as a self-extracting script in a compressed archive. |
Jean-Baptiste Queru | b4d39b4 | 2011-04-11 13:53:58 -0700 | [diff] [blame] | 143 | After uncompressing each archive, run the included self-extracting script |
| 144 | from the root of the source tree, confirm that you agree to the terms of the |
Jean-Baptiste Queru | 5da7539 | 2011-05-17 14:32:56 -0700 | [diff] [blame] | 145 | enclosed license agreement, and the binaries and their matching makefiles |
Jean-Baptiste Queru | b4d39b4 | 2011-04-11 13:53:58 -0700 | [diff] [blame] | 146 | will get installed in the `vendor/` hierarchy of the source tree. |
| 147 | |
Jean-Baptiste Queru | 5da7539 | 2011-05-17 14:32:56 -0700 | [diff] [blame] | 148 | ### Cleaning up when adding proprietary binaries ### |
| 149 | |
| 150 | In order to make sure that the newly installed binaries are properly |
Jean-Baptiste Queru | b4d39b4 | 2011-04-11 13:53:58 -0700 | [diff] [blame] | 151 | taken into account after being extracted, the existing output of any previous |
| 152 | build needs to be deleted with |
| 153 | |
| 154 | $ make clobber |
| 155 | |
| 156 | ## Picking and building the configuration that matches a device ## |
| 157 | |
| 158 | The steps to configure and build the Android Open-Source Project |
| 159 | are described in the page about [Building](building.html). |
| 160 | |
| 161 | The recommended builds for the various devices are available through |
Jean-Baptiste Queru | 3e466b0 | 2011-10-06 14:34:00 -0700 | [diff] [blame] | 162 | the lunch menu, accessed when running the `lunch` command with no arguments: |
Jean-Baptiste Queru | b4d39b4 | 2011-04-11 13:53:58 -0700 | [diff] [blame] | 163 | |
Jean-Baptiste Queru | 993d0b8 | 2012-04-19 17:24:35 -0700 | [diff] [blame] | 164 | Device | Branch | Build configuration |
| 165 | ---------|------------------------------|------------------------ |
Jean-Baptiste Queru | c6dd102 | 2012-10-04 14:00:14 -0700 | [diff] [blame^] | 166 | grouper | android-4.1.2_r1 or master | full_grouper-userdebug |
| 167 | maguro | android-4.1.2_r1 or master | full_maguro-userdebug |
| 168 | toro | android-4.1.2_r1 or master | full_toro-userdebug |
| 169 | toroplus | master | full_toroplus-userdebug |
Jean-Baptiste Queru | 993d0b8 | 2012-04-19 17:24:35 -0700 | [diff] [blame] | 170 | panda | master | full_panda-userdebug |
Jean-Baptiste Queru | c6dd102 | 2012-10-04 14:00:14 -0700 | [diff] [blame^] | 171 | wingray | android-4.1.2_r1 or master | full_wingray-userdebug |
| 172 | crespo | android-4.1.2_r1 or master | full_crespo-userdebug |
| 173 | crespo4g | android-4.1.2_r1 or master | full_crespo4g-userdebug |
Jean-Baptiste Queru | 993d0b8 | 2012-04-19 17:24:35 -0700 | [diff] [blame] | 174 | passion | android-2.3.7_r1 | full_passion-userdebug |
| 175 | sapphire | android-2.2.3_r1 | full_sapphire-userdebug |
| 176 | dream | android-2.2.3_r1 | full_dream-userdebug |
Jean-Baptiste Queru | b4d39b4 | 2011-04-11 13:53:58 -0700 | [diff] [blame] | 177 | |
Jean-Baptiste Queru | c6dd102 | 2012-10-04 14:00:14 -0700 | [diff] [blame^] | 178 | Do not use 4.1.1 on a Nexus 7 that was originally sold with 4.1.2 |
| 179 | or newer. |
| 180 | |
Jean-Baptiste Queru | b4d39b4 | 2011-04-11 13:53:58 -0700 | [diff] [blame] | 181 | ## Flashing a device ## |
| 182 | |
| 183 | Set the device in fastboot mode if necessary (see above). |
| 184 | |
Jean-Baptiste Queru | b4d39b4 | 2011-04-11 13:53:58 -0700 | [diff] [blame] | 185 | An entire Android system can be flashed in a single command: this writes |
Jean-Baptiste Queru | ccdda52 | 2011-05-19 10:47:27 -0700 | [diff] [blame] | 186 | the boot, recovery and system partitions together after verifying that the |
Jean-Baptiste Queru | 61745ea | 2011-09-08 14:44:15 -0700 | [diff] [blame] | 187 | system being flashed is compatible with the installed bootloader and radio, |
Jean-Baptiste Queru | c10820f | 2012-07-17 13:33:48 -0700 | [diff] [blame] | 188 | and reboots the system. This also erases all the user data, similarly to |
| 189 | `fastboot oem unlock` mentioned earlier. |
Jean-Baptiste Queru | b4d39b4 | 2011-04-11 13:53:58 -0700 | [diff] [blame] | 190 | |
| 191 | $ fastboot -w flashall |
| 192 | |
Jean-Baptiste Queru | 35f5101 | 2011-12-14 09:32:22 -0800 | [diff] [blame] | 193 | Note that filesystems created via fastboot on Motorola Xoom aren't working |
| 194 | optimally, and it is strongly recommended to re-create them through recovery |
| 195 | |
| 196 | $ adb reboot recovery |
| 197 | |
| 198 | Once in recovery, open the menu (press Power + Volume Up), wipe the cache |
| 199 | partition, then wipe data. |
| 200 | |
Jean-Baptiste Queru | 93afea9 | 2011-12-16 18:25:07 -0800 | [diff] [blame] | 201 | ## Restoring a device to its original factory state ## |
| 202 | |
Jean-Baptiste Queru | 0318a19 | 2012-04-05 08:13:08 -0700 | [diff] [blame] | 203 | Factory images |
Jean-Baptiste Queru | c10820f | 2012-07-17 13:33:48 -0700 | [diff] [blame] | 204 | for Nexus 7, |
| 205 | for Galaxy Nexus (GSM/HSPA+ "yakju" and "takju", and CDMA/LTE "mysid"), |
Jean-Baptiste Queru | 0318a19 | 2012-04-05 08:13:08 -0700 | [diff] [blame] | 206 | and |
Jean-Baptiste Queru | c10820f | 2012-07-17 13:33:48 -0700 | [diff] [blame] | 207 | for Nexus S and Nexus S 4G (all variants) |
Jean-Baptiste Queru | 0318a19 | 2012-04-05 08:13:08 -0700 | [diff] [blame] | 208 | are available from |
Jean-Baptiste Queru | 66426b3 | 2012-04-20 07:14:05 -0700 | [diff] [blame] | 209 | [Google's factory image page](https://developers.google.com/android/nexus/images). |
Jean-Baptiste Queru | 93afea9 | 2011-12-16 18:25:07 -0800 | [diff] [blame] | 210 | |
| 211 | Factory images for the Motorola Xoom are distributed directly by Motorola. |
| 212 | |
Jean-Baptiste Queru | 0318a19 | 2012-04-05 08:13:08 -0700 | [diff] [blame] | 213 | No factory images are available for Nexus One. |