[Android] Convert battery utilities to DeviceUtils.

build/android/pylib/device/device_utils.py

 # Copyright 2014 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 """Provides a variety of device interactions based on adb.
 
 Eventually, this will be based on adb_wrapper.
 """
 # pylint: disable=unused-argument
 
@@ skipping 26 matching lines @@
 from pylib.utils import zip_utils
 
 _DEFAULT_TIMEOUT = 30
 _DEFAULT_RETRIES = 3
 
 # A sentinel object for default values
 # TODO(jbudorick,perezju): revisit how default values are handled by
 # the timeout_retry decorators.
 DEFAULT = object()
 
+_CONTROL_USB_CHARGING_COMMANDS = [
+  {
+    # Nexus 4
+    'witness_file': '/sys/module/pm8921_charger/parameters/disabled',
+    'enable_command': 'echo 0 > /sys/module/pm8921_charger/parameters/disabled',
+    'disable_command':
+        'echo 1 > /sys/module/pm8921_charger/parameters/disabled',
+  },
+  {
+    # Nexus 5
+    # Setting the HIZ bit of the bq24192 causes the charger to actually ignore
+    # energy coming from USB. Setting the power_supply offline just updates the
+    # Android system to reflect that.
+    'witness_file': '/sys/kernel/debug/bq24192/INPUT_SRC_CONT',
+    'enable_command': (
+        'echo 0x4A > /sys/kernel/debug/bq24192/INPUT_SRC_CONT && '
+        'echo 1 > /sys/class/power_supply/usb/online'),
+    'disable_command': (
+        'echo 0xCA > /sys/kernel/debug/bq24192/INPUT_SRC_CONT && '
+        'chmod 644 /sys/class/power_supply/usb/online && '
+        'echo 0 > /sys/class/power_supply/usb/online'),
+  },
+]
+
 
 @decorators.WithExplicitTimeoutAndRetries(
     _DEFAULT_TIMEOUT, _DEFAULT_RETRIES)
 def GetAVDs():
   """Returns a list of Android Virtual Devices.
 
   Returns:
     A list containing the configured AVDs.
   """
   lines = cmd_helper.GetCmdOutput([
@@ skipping 79 matching lines @@
       self.old_interface = device
     else:
       raise ValueError('Unsupported device value: %r' % device)
     self._commands_installed = None
     self._default_timeout = default_timeout
     self._default_retries = default_retries
     self._cache = {}
     assert hasattr(self, decorators.DEFAULT_TIMEOUT_ATTR)
     assert hasattr(self, decorators.DEFAULT_RETRIES_ATTR)
 
+  def __str__(self):
+    """Returns the device serial."""
+    return self.adb.GetDeviceSerial()
+
   @decorators.WithTimeoutAndRetriesFromInstance()
   def IsOnline(self, timeout=None, retries=None):
     """Checks whether the device is online.
 
     Args:
       timeout: timeout in seconds
       retries: number of retries
 
     Returns:
       True if the device is online, False otherwise.
@@ skipping 1207 matching lines @@
 
     Parameters passed to this function are passed directly to
     |logcat_monitor.LogcatMonitor| and are documented there.
 
     Args:
       timeout: timeout in seconds
       retries: number of retries
     """
     return logcat_monitor.LogcatMonitor(self.adb, *args, **kwargs)
 
-  def __str__(self):
-    """Returns the device serial."""
-    return self.adb.GetDeviceSerial()
+  @decorators.WithTimeoutAndRetriesFromInstance()
+  def GetBatteryInfo(self, timeout=None, retries=None):
+    """Gets battery info for the device.
+
+    Args:
+      timeout: timeout in seconds
+      retries: number of retries
+    Returns:
+      A dict containing various battery information as reported by dumpsys
+      battery.
+    """
+    result = {}
+    # Skip the first line, which is just a header.
+    for line in self.RunShellCommand(['dumpsys', 'battery'])[1:]:

[perezju, 2015/02/23 10:43:32]

check_return=True?

[jbudorick, 2015/02/24 15:44:53]

Nice catch. Done.

+      k, v = line.split(': ', 1)
+      result[k.strip()] = v.strip()
+    return result
+
+  @decorators.WithTimeoutAndRetriesFromInstance()
+  def GetUsbCharging(self, timeout=None, retries=None):
+    """Gets the USB charging state of the device.
+
+    Args:
+      timeout: timeout in seconds
+      retries: number of retries
+    Returns:
+      True if the device is charging via USB, false otherwise.
+    """
+    return (self.GetBatteryInfo().get('USB powered', '').lower()
+            in ('true', '1', 'yes'))
+
+  @decorators.WithTimeoutAndRetriesFromInstance()
+  def SetUsbCharging(self, enabled, timeout=None, retries=None):
+    """Enables or disables USB charging on the device.
+
+    Args:
+      enabled: A boolean indicating whether USB charging should be enabled or
+        disabled.
+      timeout: timeout in seconds
+      retries: number of retries
+    """
+    if 'usb_charging' not in self._cache:

[perezju, 2015/02/23 10:43:32]

should we call it usb_charging_config or usb_charging_commands? First I thought
this was going to cache the current enabled/disabled status of usb charging.

[jbudorick, 2015/02/24 15:44:53]

Ah, hadn't thought of that. Switched to 'usb_charging_config'.

+      for c in _CONTROL_USB_CHARGING_COMMANDS:
+        if self.FileExists(c['witness_file']):
+          self._cache['usb_charging'] = c
+          break
+      else:
+        raise device_errors.CommandFailedError(
+            'Unable to find charging commands.')
+
+    if enabled:
+      command = self._cache['usb_charging']['enable_command']
+    else:
+      command = self._cache['usb_charging']['disable_command']
+
+    while self.GetUsbCharging() != enabled:

[perezju, 2015/02/23 10:43:32]

This seems a bit blunt. Should we use WaitFor?

[jbudorick, 2015/02/24 15:44:53]

Ha, it's certainly more than a bit blunt.

Switched to WaitFor.

+      self.RunShellCommand(command)
 
   @decorators.WithTimeoutAndRetriesFromInstance()
   def GetDevicePieWrapper(self, timeout=None, retries=None):
     """Gets the absolute path to the run_pie wrapper on the device.
 
     We have to build our device executables to be PIE, but they need to be able
     to run on versions of android that don't support PIE (i.e. ICS and below).
     To do so, we push a wrapper to the device that lets older android versions
     run PIE executables. This method pushes that wrapper to the device if
     necessary and returns the path to it.
@@ skipping 40 matching lines @@
     Returns:
       A Parallelizer operating over |devices|.
     """
     if not devices:
       devices = adb_wrapper.AdbWrapper.GetDevices()
     devices = [d if isinstance(d, cls) else cls(d) for d in devices]
     if async:
       return parallelizer.Parallelizer(devices)
     else:
       return parallelizer.SyncParallelizer(devices)