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.
5 #ifndef DEVICE_USB_USB_DEVICE_HANDLE_H_
6 #define DEVICE_USB_USB_DEVICE_HANDLE_H_
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"
22 enum UsbTransferStatus
{
23 USB_TRANSFER_COMPLETED
= 0,
26 USB_TRANSFER_CANCELLED
,
28 USB_TRANSFER_DISCONNECT
,
29 USB_TRANSFER_OVERFLOW
,
30 USB_TRANSFER_LENGTH_SHORT
,
33 typedef base::Callback
<
34 void(UsbTransferStatus
, scoped_refptr
<net::IOBuffer
>, size_t)>
37 // UsbDeviceHandle class provides basic I/O related functionalities.
38 class UsbDeviceHandle
: public base::RefCountedThreadSafe
<UsbDeviceHandle
> {
40 enum TransferRequestType
{ STANDARD
, CLASS
, VENDOR
, RESERVED
};
41 enum TransferRecipient
{ DEVICE
, INTERFACE
, ENDPOINT
, OTHER
};
43 virtual scoped_refptr
<UsbDevice
> GetDevice() const = 0;
45 // Notifies UsbDevice to drop the reference of this object; cancels all the
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;
52 // Device manipulation operations. These methods are blocking and must be
53 // called on FILE thread.
54 virtual bool ClaimInterface(int interface_number
) = 0;
55 virtual bool ReleaseInterface(int interface_number
) = 0;
56 virtual bool SetInterfaceAlternateSetting(int interface_number
,
57 int alternate_setting
) = 0;
58 virtual bool ResetDevice() = 0;
59 virtual bool GetManufacturer(base::string16
* manufacturer
) = 0;
60 virtual bool GetProduct(base::string16
* product
) = 0;
61 virtual bool GetSerial(base::string16
* serial
) = 0;
63 // Async IO. Can be called on any thread.
64 virtual void ControlTransfer(UsbEndpointDirection direction
,
65 TransferRequestType request_type
,
66 TransferRecipient recipient
,
70 net::IOBuffer
* buffer
,
73 const UsbTransferCallback
& callback
) = 0;
75 virtual void BulkTransfer(UsbEndpointDirection direction
,
77 net::IOBuffer
* buffer
,
80 const UsbTransferCallback
& callback
) = 0;
82 virtual void InterruptTransfer(UsbEndpointDirection direction
,
84 net::IOBuffer
* buffer
,
87 const UsbTransferCallback
& callback
) = 0;
89 virtual void IsochronousTransfer(UsbEndpointDirection direction
,
91 net::IOBuffer
* buffer
,
94 unsigned int packet_length
,
96 const UsbTransferCallback
& callback
) = 0;
99 friend class base::RefCountedThreadSafe
<UsbDeviceHandle
>;
101 UsbDeviceHandle() {};
103 virtual ~UsbDeviceHandle() {};
105 DISALLOW_COPY_AND_ASSIGN(UsbDeviceHandle
);
108 } // namespace device
110 #endif // DEVICE_USB_USB_DEVICE_HANDLE_H_