servo/stm32usb.py

# Copyright 2016 The Chromium OS Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

"""Allows creation of an interface via stm32 usb."""

import logging
import usb


class SusbError(Exception):
  """Class for exceptions of Susb."""
  def __init__(self, msg, value=0):
    """SusbError constructor.

    Args:
      msg: string, message describing error in detail
      value: integer, value of error when non-zero status returned.  Default=0
    """
    super(SusbError, self).__init__(msg, value)
    self.msg = msg
    self.value = value


class Susb():
  """Provide stm32 USB functionality.

  Instance Variables:
  _logger: S.* tagged log output
  _dev: pyUSB device object
  _read_ep: pyUSB read endpoint for this interface
  _write_ep: pyUSB write endpoint for this interface
  """
  READ_ENDPOINT = 0x81
  WRITE_ENDPOINT = 0x1
  TIMEOUT_MS = 100

  def __init__(self, vendor=0x18d1,
               product=0x500f, interface=1, serialname=None, logger=None):
    """Susb constructor.

    Disconvers and connects to stm32 USB endpoints.

    Args:
      vendor    : usb vendor id of stm32 device
      product   : usb product id of stm32 device
      interface : interface number ( 1 - 4 ) of stm32 device to use
      serialname: string of device serialname.

    Raises:
      SusbError: An error accessing Susb object
    """
    if not logger:
      raise SusbError("No logger defined")
    self._logger = logger
    self._logger.debug("")

    self._vendor = vendor
    self._product = product
    self._interface = interface
    self._serialname = serialname
    self._find_device()

  def reset_usb(self):
    """Reinitializes USB based on the device based settings from __init__"""
    try:
      self._find_device()
    except:
        self._logger.info("device not found: %04x:%04x %s" %
                          (self._vendor, self._product, self._serialname))

  def _find_device(self):
    """Set up the usb endpoint"""
    # Find the stm32.
    dev_list = usb.core.find(idVendor=self._vendor, idProduct=self._product,
                             find_all=True)
    if dev_list is None or len(dev_list) is 0:
      raise SusbError("USB device not found")

    # Check if we have multiple stm32s and we've specified the serial.
    dev = None
    if len(dev_list) > 1 and self._serialname is not None:
      for d in dev_list:
        if usb.util.get_string(d, 256, d.iSerialNumber) == self._serialname:
          dev = d
          break
      if dev is None:
        raise SusbError("USB device(%s) not found" % self._serialname)
    else:
      dev = dev_list[0]

    serial = '(%s)' % self._serialname if self._serialname else ''
    self._logger.debug("Found stm32%s: %04x:%04x" % (serial, self._vendor,
                                                     self._product))
    # If we can't set configuration, it's already been set.
    try:
      dev.set_configuration()
    except usb.core.USBError:
      pass
    self._dev = dev

    # Get an endpoint instance.
    cfg = dev.get_active_configuration()
    intf = usb.util.find_descriptor(cfg, bInterfaceNumber=self._interface)
    self._intf = intf

    # Detatch raiden.ko if it is loaded.
    if dev.is_kernel_driver_active(intf.bInterfaceNumber) is True:
            dev.detach_kernel_driver(intf.bInterfaceNumber)
    self._logger.debug("InterfaceNumber: %s" % intf.bInterfaceNumber)

    read_ep_number = intf.bInterfaceNumber + self.READ_ENDPOINT
    read_ep = usb.util.find_descriptor(intf, bEndpointAddress=read_ep_number)
    self._read_ep = read_ep
    self._logger.debug("Reader endpoint: 0x%x" % read_ep.bEndpointAddress)

    write_ep_number = intf.bInterfaceNumber + self.WRITE_ENDPOINT
    write_ep = usb.util.find_descriptor(intf, bEndpointAddress=write_ep_number)
    self._write_ep = write_ep
    self._logger.debug("Writer endpoint: 0x%x" % write_ep.bEndpointAddress)

    self._logger.debug("Set up stm32 usb")

  def control(self, request, value):
    """Send control transfer.

    Args:
      request: the request type to send, bmRequestType
      data: the data to send, wValue

    Returns:
      boolean success/fail
    """
    # usb_setup_packet: ec/include/usb_descriptor.h:231
    reqtype = (usb.util.CTRL_OUT |
               usb.util.CTRL_TYPE_VENDOR |
               usb.util.CTRL_RECIPIENT_INTERFACE)
    ret = self._dev.ctrl_transfer(bmRequestType = reqtype,
                                  bRequest = request,
                                  wIndex = self._interface,
                                  wValue = value)
    return True

  def __del__(self):
    """Sgpio destructor."""
    self._logger.debug("Close")