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