Add README files for open source release
[manifest/android/binary.git] / README_SHIELD
1 Welcome to the SHIELD Open Source + Binary Driver Release.
2
3 In this README, you will find sync, build, and flashing instructions.
4
5 ==========
6 HowTo Sync:
7 ==========
8
9 Syncing this release requires git and the repo tool from Google:
10 http://source.android.com/source/downloading.html#installing-repo
11
12 mkdir ~/shield-open-source
13 cd ~/shield-open-source
14 repo init -u git://nv-tegra.nvidia.com/manifest/android/binary.git -b rel-24-uda-r1.1-partner -m tlk/t210.xml
15 repo sync -j5
16
17
18 ==========
19 HowTo Build:
20 ==========
21
22 Building this release requires a Linux build environment configured to
23 build Android: http://source.android.com/source/initializing.html
24
25 Additionally, you will be required to agree to license terms when extracting
26 the binary drivers.
27
28 cd ~/shield-open-source
29 export TOP=`pwd`
30 cd vendor/nvidia/licensed-binaries
31 ./extract-nv-bins.sh
32 cd $TOP
33 . build/envsetup.sh
34 setpaths
35 lunch <product>-userdebug   (See below table for selecting <product>)
36 mp dev
37
38 ------------------------------------------------------------
39 Sr.No.|           SHEILD               |      <product>    |
40 ------------------------------------------------------------
41   1.  | SHIELD Android TV Base         |      foster_e     |
42 ------------------------------------------------------------
43   2.  | SHIELD Android TV Premium      |    foster_e_hdd   |
44 ------------------------------------------------------------
45
46
47 ==========
48 HowTo Flash:
49 ==========
50
51 Before flashing images from this build to your SHIELD, connect your SHIELD
52 via USB to the PC where you built this tree.
53
54 Next, put your SHIELD into fastboot mode using following method:
55 SW method:
56    Boot to android home screen
57    Connect the device to linux system
58    Open terminal(on linux)
59    Type "adb reboot bootloader" in terminal
60
61 HW method:
62    Disconnect power cable
63    Insert USB OTG cable and make sure to connect other end to a host PC
64    Connect power cable to SHIELD
65    Quickly start pressing power button for ~3 seconds
66    Do not hold the button and connect power supply afterwards
67    HDMI TV should be always connected to SHIELD
68
69 Alternative method:
70    Perform software shutdown on SHIELD by holding Power button for 10 seconds
71    Connect USB OTG cable to SHIELD
72    Start pressing power button for 3 seconds
73    HDMI TV should be always connected to SHIELD
74
75 Fastboot menu navigation:
76    Single tap on touch button for navigations between different menu.
77    Hold down touch button for 4 second and release for selecting any menu
78
79 If this is the first time you have done this procedure, you must unlock
80 your bootloader. To unlock your bootloader, run the following command
81 in a terminal:
82
83 fastboot oem unlock
84
85 It will take you to '!!! READ THE FOLLOWING !!!' page.
86 Two selectable options are available. 'Confirm' and 'Back to menu'.
87 Select 'Confirm' to unlock the bootloader.
88
89 Your device's bootloader should now be unlocked.
90
91 To flash images from this build to your SHIELD, run the following commands
92 from the same terminal where you did your build:
93
94 fastboot oem dtbname                  (This will print the DTB name for a given product)
95
96 cd $OUT
97 fastboot flash recovery recovery.img
98 fastboot flash boot boot.img
99 fastboot flash system system.img
100 fastboot flash vendor vendor.img
101 fastboot flash dtb <DTB file name>    (Use result from "fastboot oem dtbname" in <DTB file name>)
102 fastboot reboot
103