device/usb/usb_device_handle.h

   1 // Copyright 2014 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 DEVICE_USB_USB_DEVICE_HANDLE_H_
   6 #define DEVICE_USB_USB_DEVICE_HANDLE_H_
   7
   8 #include <map>
   9 #include <vector>
  10
  11 #include "base/callback.h"
  12 #include "base/memory/ref_counted.h"
  13 #include "base/strings/string16.h"
  14 #include "base/threading/thread_checker.h"
  15 #include "device/usb/usb_descriptors.h"
  16 #include "net/base/io_buffer.h"
  17
  18 namespace device {
  19
  20 class UsbDevice;
  21
  22 enum UsbTransferStatus {
  23   USB_TRANSFER_COMPLETED = 0,
  24   USB_TRANSFER_ERROR,
  25   USB_TRANSFER_TIMEOUT,
  26   USB_TRANSFER_CANCELLED,
  27   USB_TRANSFER_STALLED,
  28   USB_TRANSFER_DISCONNECT,
  29   USB_TRANSFER_OVERFLOW,
  30   USB_TRANSFER_LENGTH_SHORT,
  31 };
  32
  33 // UsbDeviceHandle class provides basic I/O related functionalities.
  34 class UsbDeviceHandle : public base::RefCountedThreadSafe<UsbDeviceHandle> {
  35  public:
  36   using ResultCallback = base::Callback<void(bool)>;
  37   using TransferCallback = base::Callback<
  38       void(UsbTransferStatus, scoped_refptr<net::IOBuffer>, size_t)>;
  39
  40   enum TransferRequestType { STANDARD, CLASS, VENDOR, RESERVED };
  41   enum TransferRecipient { DEVICE, INTERFACE, ENDPOINT, OTHER };
  42
  43   virtual scoped_refptr<UsbDevice> GetDevice() const = 0;
  44
  45   // Notifies UsbDevice to drop the reference of this object; cancels all the
  46   // flying transfers.
  47   // It is possible that the object has no other reference after this call. So
  48   // if it is called using a raw pointer, it could be invalidated.
  49   // The platform device handle will be closed when UsbDeviceHandle destructs.
  50   virtual void Close() = 0;
  51
  52   // Device manipulation operations.
  53   virtual void SetConfiguration(int configuration_value,
  54                                 const ResultCallback& callback) = 0;
  55   virtual void ClaimInterface(int interface_number,
  56                               const ResultCallback& callback) = 0;
  57   virtual bool ReleaseInterface(int interface_number) = 0;
  58   virtual void SetInterfaceAlternateSetting(int interface_number,
  59                                             int alternate_setting,
  60                                             const ResultCallback& callback) = 0;
  61   virtual void ResetDevice(const ResultCallback& callback) = 0;
  62   virtual void ClearHalt(uint8 endpoint, const ResultCallback& callback) = 0;
  63
  64   // The transfer functions may be called from any thread. The provided callback
  65   // will be run on the caller's thread.
  66   virtual void ControlTransfer(UsbEndpointDirection direction,
  67                                TransferRequestType request_type,
  68                                TransferRecipient recipient,
  69                                uint8 request,
  70                                uint16 value,
  71                                uint16 index,
  72                                scoped_refptr<net::IOBuffer> buffer,
  73                                size_t length,
  74                                unsigned int timeout,
  75                                const TransferCallback& callback) = 0;
  76
  77   virtual void BulkTransfer(UsbEndpointDirection direction,
  78                             uint8 endpoint,
  79                             scoped_refptr<net::IOBuffer> buffer,
  80                             size_t length,
  81                             unsigned int timeout,
  82                             const TransferCallback& callback) = 0;
  83
  84   virtual void InterruptTransfer(UsbEndpointDirection direction,
  85                                  uint8 endpoint,
  86                                  scoped_refptr<net::IOBuffer> buffer,
  87                                  size_t length,
  88                                  unsigned int timeout,
  89                                  const TransferCallback& callback) = 0;
  90
  91   virtual void IsochronousTransfer(UsbEndpointDirection direction,
  92                                    uint8 endpoint,
  93                                    scoped_refptr<net::IOBuffer> buffer,
  94                                    size_t length,
  95                                    unsigned int packets,
  96                                    unsigned int packet_length,
  97                                    unsigned int timeout,
  98                                    const TransferCallback& callback) = 0;
  99
 100  protected:
 101   friend class base::RefCountedThreadSafe<UsbDeviceHandle>;
 102
 103   UsbDeviceHandle() {};
 104
 105   virtual ~UsbDeviceHandle() {};
 106
 107   DISALLOW_COPY_AND_ASSIGN(UsbDeviceHandle);
 108 };
 109
 110 }  // namespace device
 111
 112 #endif  // DEVICE_USB_USB_DEVICE_HANDLE_H_