src/chrome/browser/usb/usb_device_handle.h

   1 // Copyright (c) 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CHROME_BROWSER_USB_USB_DEVICE_HANDLE_H_
   6 #define CHROME_BROWSER_USB_USB_DEVICE_HANDLE_H_
   7
   8 #include <map>
   9 #include <vector>
  10
  11 #include "base/memory/ref_counted.h"
  12 #include "base/strings/string16.h"
  13 #include "base/synchronization/lock.h"
  14 #include "base/threading/thread_checker.h"
  15 #include "chrome/browser/usb/usb_interface.h"
  16 #include "net/base/completion_callback.h"
  17 #include "net/base/io_buffer.h"
  18
  19 struct libusb_device_handle;
  20 struct libusb_iso_packet_descriptor;
  21 struct libusb_transfer;
  22
  23 typedef libusb_device_handle* PlatformUsbDeviceHandle;
  24 typedef libusb_iso_packet_descriptor* PlatformUsbIsoPacketDescriptor;
  25 typedef libusb_transfer* PlatformUsbTransferHandle;
  26
  27 class UsbContext;
  28 class UsbConfigDescriptor;
  29 class UsbDevice;
  30 class UsbInterfaceDescriptor;
  31
  32 namespace base {
  33   class MessageLoopProxy;
  34 }  // namespace base
  35
  36 namespace net {
  37 class IOBuffer;
  38 }  // namespace net
  39
  40 enum UsbTransferStatus {
  41   USB_TRANSFER_COMPLETED = 0,
  42   USB_TRANSFER_ERROR,
  43   USB_TRANSFER_TIMEOUT,
  44   USB_TRANSFER_CANCELLED,
  45   USB_TRANSFER_STALLED,
  46   USB_TRANSFER_DISCONNECT,
  47   USB_TRANSFER_OVERFLOW,
  48   USB_TRANSFER_LENGTH_SHORT,
  49 };
  50
  51 typedef base::Callback<void(UsbTransferStatus, scoped_refptr<net::IOBuffer>,
  52     size_t)> UsbTransferCallback;
  53
  54 // UsbDeviceHandle class provides basic I/O related functionalities.
  55 class UsbDeviceHandle : public base::RefCountedThreadSafe<UsbDeviceHandle> {
  56  public:
  57   enum TransferRequestType { STANDARD, CLASS, VENDOR, RESERVED };
  58   enum TransferRecipient { DEVICE, INTERFACE, ENDPOINT, OTHER };
  59
  60   scoped_refptr<UsbDevice> device() const;
  61   PlatformUsbDeviceHandle handle() const { return handle_; }
  62
  63   // Notifies UsbDevice to drop the reference of this object; cancels all the
  64   // flying transfers.
  65   // It is possible that the object has no other reference after this call. So
  66   // if it is called using a raw pointer, it could be invalidated.
  67   // The platform device handle will be closed when UsbDeviceHandle destructs.
  68   virtual void Close();
  69
  70   // Device manipulation operations. These methods are blocking and must be
  71   // called on FILE thread.
  72   virtual bool ClaimInterface(const int interface_number);
  73   virtual bool ReleaseInterface(const int interface_number);
  74   virtual bool SetInterfaceAlternateSetting(
  75       const int interface_number,
  76       const int alternate_setting);
  77   virtual bool ResetDevice();
  78   virtual bool GetSerial(base::string16* serial);
  79
  80   // Async IO. Can be called on any thread.
  81   virtual void ControlTransfer(const UsbEndpointDirection direction,
  82                                const TransferRequestType request_type,
  83                                const TransferRecipient recipient,
  84                                const uint8 request,
  85                                const uint16 value,
  86                                const uint16 index,
  87                                net::IOBuffer* buffer,
  88                                const size_t length,
  89                                const unsigned int timeout,
  90                                const UsbTransferCallback& callback);
  91
  92   virtual void BulkTransfer(const UsbEndpointDirection direction,
  93                             const uint8 endpoint,
  94                             net::IOBuffer* buffer,
  95                             const size_t length,
  96                             const unsigned int timeout,
  97                             const UsbTransferCallback& callback);
  98
  99   virtual void InterruptTransfer(const UsbEndpointDirection direction,
 100                                  const uint8 endpoint,
 101                                  net::IOBuffer* buffer,
 102                                  const size_t length,
 103                                  const unsigned int timeout,
 104                                  const UsbTransferCallback& callback);
 105
 106   virtual void IsochronousTransfer(const UsbEndpointDirection direction,
 107                                    const uint8 endpoint,
 108                                    net::IOBuffer* buffer,
 109                                    const size_t length,
 110                                    const unsigned int packets,
 111                                    const unsigned int packet_length,
 112                                    const unsigned int timeout,
 113                                    const UsbTransferCallback& callback);
 114
 115  protected:
 116   friend class base::RefCountedThreadSafe<UsbDeviceHandle>;
 117   friend class UsbDevice;
 118
 119   // This constructor is called by UsbDevice.
 120   UsbDeviceHandle(scoped_refptr<UsbContext> context,
 121                   UsbDevice* device, PlatformUsbDeviceHandle handle,
 122                   scoped_refptr<UsbConfigDescriptor> interfaces);
 123
 124   // This constructor variant is for use in testing only.
 125   UsbDeviceHandle();
 126   virtual ~UsbDeviceHandle();
 127
 128   UsbDevice* device_;
 129
 130  private:
 131   friend void HandleTransferCompletion(PlatformUsbTransferHandle handle);
 132
 133   class InterfaceClaimer;
 134   struct Transfer;
 135
 136   // Refresh endpoint_map_ after ClaimInterface, ReleaseInterface and
 137   // SetInterfaceAlternateSetting.
 138   void RefreshEndpointMap();
 139
 140   // Look up the claimed interface by endpoint. Return NULL if the interface
 141   // of the endpoint is not found.
 142   scoped_refptr<InterfaceClaimer> GetClaimedInterfaceForEndpoint(
 143       unsigned char endpoint);
 144
 145   // Submits a transfer and starts tracking it. Retains the buffer and copies
 146   // the completion callback until the transfer finishes, whereupon it invokes
 147   // the callback then releases the buffer.
 148   void SubmitTransfer(PlatformUsbTransferHandle handle,
 149                       UsbTransferType transfer_type,
 150                       net::IOBuffer* buffer,
 151                       const size_t length,
 152                       scoped_refptr<base::MessageLoopProxy> message_loop_proxy,
 153                       const UsbTransferCallback& callback);
 154
 155   // Invokes the callbacks associated with a given transfer, and removes it from
 156   // the in-flight transfer set.
 157   void TransferComplete(PlatformUsbTransferHandle transfer);
 158
 159   // Informs the object to drop internal references.
 160   void InternalClose();
 161
 162   PlatformUsbDeviceHandle handle_;
 163
 164   scoped_refptr<UsbConfigDescriptor> interfaces_;
 165
 166   typedef std::map<int, scoped_refptr<InterfaceClaimer> > ClaimedInterfaceMap;
 167   ClaimedInterfaceMap claimed_interfaces_;
 168
 169   typedef std::map<PlatformUsbTransferHandle, Transfer> TransferMap;
 170   TransferMap transfers_;
 171
 172   // A map from endpoints to interfaces
 173   typedef std::map<int, int> EndpointMap;
 174   EndpointMap endpoint_map_;
 175
 176   // Retain the UsbContext so that the platform context will not be destroyed
 177   // before this handle.
 178   scoped_refptr<UsbContext> context_;
 179
 180   base::ThreadChecker thread_checker_;
 181
 182   DISALLOW_COPY_AND_ASSIGN(UsbDeviceHandle);
 183 };
 184
 185 #endif  // CHROME_BROWSER_USB_USB_DEVICE_HANDLE_H_