Gitiles
Code Review Sign In
gerrit.twrp.me / android_bootable_recovery / 1e7d0922c79602c3233f1e11e7925adf11693e98
commit1e7d0922c79602c3233f1e11e7925adf11693e98[log] [tgz]
authorTao Bao <tbao@google.com>Thu Feb 08 19:40:31 2018 +0000
committerandroid-build-merger <android-build-merger@google.com>Thu Feb 08 19:40:31 2018 +0000
treef5119f8e501e50309fdeaea4a1cc51e19813fc4d
parent39b6c7fcfecbc226cda1c8f132a61cae78ca82be [diff]
parent41186e13b7ae0e4e6213b3718163c5a2906ed63a [diff]
Merge "Document instructions for using adb under recovery." am: 7ee7e27400
am: 41186e13b7

Change-Id: I400e8c56060cf52718603fff80423ec5f1780088
tree: f5119f8e501e50309fdeaea4a1cc51e19813fc4d
  1. applypatch/
  2. boot_control/
  3. bootloader_message/
  4. edify/
  5. etc/
  6. fonts/
  7. minadbd/
  8. minui/
  9. otafault/
  10. otautil/
  11. private/
  12. res-hdpi/
  13. res-mdpi/
  14. res-xhdpi/
  15. res-xxhdpi/
  16. res-xxxhdpi/
  17. tests/
  18. tools/
  19. uncrypt/
  20. update_verifier/
  21. updater/
  22. res-560dpi ⇨ res-xxxhdpi
  23. .clang-format
  24. adb_install.cpp
  25. adb_install.h
  26. Android.bp
  27. Android.mk
  28. asn1_decoder.cpp
  29. asn1_decoder.h
  30. bootloader.h
  31. CleanSpec.mk
  32. common.h
  33. default_device.cpp
  34. device.cpp
  35. device.h
  36. fuse_sdcard_provider.cpp
  37. fuse_sdcard_provider.h
  38. fuse_sideload.cpp
  39. fuse_sideload.h
  40. install.cpp
  41. install.h
  42. interlace-frames.py
  43. mounts.cpp
  44. mounts.h
  45. NOTICE
  46. OWNERS
  47. PREUPLOAD.cfg
  48. README.md
  49. recovery-persist.cpp
  50. recovery-persist.rc
  51. recovery-refresh.cpp
  52. recovery-refresh.rc
  53. recovery.cpp
  54. roots.cpp
  55. roots.h
  56. rotate_logs.cpp
  57. rotate_logs.h
  58. screen_ui.cpp
  59. screen_ui.h
  60. stub_ui.h
  61. ui.cpp
  62. ui.h
  63. verifier.cpp
  64. verifier.h
  65. vr_device.cpp
  66. vr_ui.cpp
  67. vr_ui.h
  68. wear_device.cpp
  69. wear_ui.cpp
  70. wear_ui.h
README.md

The Recovery Image

Quick turn-around testing

mm -j && m ramdisk-nodeps && m recoveryimage-nodeps

# To boot into the new recovery image
# without flashing the recovery partition:
adb reboot bootloader
fastboot boot $ANDROID_PRODUCT_OUT/recovery.img

Running the tests

# After setting up environment and lunch.
mmma -j bootable/recovery

# Running the tests on device.
adb root
adb sync data

# 32-bit device
adb shell /data/nativetest/recovery_unit_test/recovery_unit_test
adb shell /data/nativetest/recovery_component_test/recovery_component_test

# Or 64-bit device
adb shell /data/nativetest64/recovery_unit_test/recovery_unit_test
adb shell /data/nativetest64/recovery_component_test/recovery_component_test

Running the manual tests

recovery-refresh and recovery-persist executables exist only on systems without /cache partition. And we need to follow special steps to run tests for them.

  • Execute the test on an A/B device first. The test should fail but it will log some contents to pmsg.

  • Reboot the device immediately and run the test again. The test should save the contents of pmsg buffer into /data/misc/recovery/inject.txt. Test will pass if this file has expected contents.

ResourceTest validates whether the png files are qualified as background text image under recovery.

1. `adb sync data` to make sure the test-dir has the images to test.
2. The test will automatically pickup and verify all `_text.png` files in
   the test dir.

Using adb under recovery

When running recovery image from debuggable builds (i.e. -eng or -userdebug build variants, or ro.debuggable=1 in /prop.default), adbd service is enabled and started by default, which allows adb communication. A device should be listed under adb devices, either in recovery or sideload state.

$ adb devices
List of devices attached
1234567890abcdef    recovery

Although /sbin/adbd shares the same binary between normal boot and recovery images, only a subset of adb commands are meaningful under recovery, such as adb root, adb shell, adb push, adb pull etc. adb shell works only after manually mounting /system from recovery menu (assuming a valid system image on device).

Troubleshooting

adb devices doesn't show the device.

$ adb devices
List of devices attached
  • Ensure adbd is built and running.

By default, adbd is always included into recovery image, as /sbin/adbd. init starts adbd service automatically only in debuggable builds. This behavior is controlled by the recovery specific /init.rc, whose source code is at bootable/recovery/etc/init.rc.

The best way to confirm a running adbd is by checking the serial output, which shows a service start log as below.

[   18.961986] c1      1 init: starting service 'adbd'...
  • Ensure USB gadget has been enabled.

If adbd service has been started but device not shown under adb devices, use lsusb(8) (on host) to check if the device is visible to the host.

bootable/recovery/etc/init.rc disables Android USB gadget (via sysfs) as part of the fs action trigger, and will only re-enable it in debuggable builds (the on property rule will always run after on fs).

on fs
    write /sys/class/android_usb/android0/enable 0

# Always start adbd on userdebug and eng builds
on property:ro.debuggable=1
    write /sys/class/android_usb/android0/enable 1
    start adbd

If device is using configfs, check if configfs has been properly set up in init rc scripts. See the example configuration for Pixel 2 devices. Note that the flag set via sysfs (i.e. the one above) is no-op when using configfs.

adb devices shows the device, but in unauthorized state.

$ adb devices
List of devices attached
1234567890abcdef    unauthorized

recovery image doesn't honor the USB debugging toggle and the authorizations added under normal boot (because such authorization data stays in /data, which recovery doesn't mount), nor does it support authorizing a host device under recovery. We can use one of the following options instead.

  • Option 1 (Recommended): Authorize a host device with adb vendor keys.

For debuggable builds, an RSA keypair can be used to authorize a host device that has the private key. The public key, defined via PRODUCT_ADB_KEYS, will be copied to /adb_keys. When starting the host-side adbd, make sure the filename (or the directory) of the matching private key has been added to $ADB_VENDOR_KEYS.

$ export ADB_VENDOR_KEYS=/path/to/adb/private/key
$ adb kill-server
$ adb devices

-user builds filter out PRODUCT_ADB_KEYS, so no /adb_keys will be included there.

Note that this mechanism applies to both of normal boot and recovery modes.

  • Option 2: Allow adbd to connect without authentication.
    • adbd is compiled with ALLOW_ADBD_NO_AUTH (only on debuggable builds).
    • ro.adb.secure has a value of 0.

Both of the two conditions need to be satisfied. Although ro.adb.secure is a runtime property, its value is set at build time (written into /prop.default). It defaults to 1 on -user builds, and 0 for other build variants. The value is overridable via PRODUCT_DEFAULT_PROPERTY_OVERRIDES.