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.
5 #include "chrome/browser/usb/usb_device_handle.h"
10 #include "base/message_loop/message_loop.h"
11 #include "base/stl_util.h"
12 #include "base/strings/string16.h"
13 #include "base/synchronization/lock.h"
14 #include "chrome/browser/usb/usb_context.h"
15 #include "chrome/browser/usb/usb_device.h"
16 #include "chrome/browser/usb/usb_interface.h"
17 #include "chrome/browser/usb/usb_service.h"
18 #include "content/public/browser/browser_thread.h"
19 #include "third_party/libusb/src/libusb/libusb.h"
21 using content::BrowserThread
;
22 void HandleTransferCompletion(PlatformUsbTransferHandle transfer
);
26 static uint8
ConvertTransferDirection(
27 const UsbEndpointDirection direction
) {
29 case USB_DIRECTION_INBOUND
:
30 return LIBUSB_ENDPOINT_IN
;
31 case USB_DIRECTION_OUTBOUND
:
32 return LIBUSB_ENDPOINT_OUT
;
35 return LIBUSB_ENDPOINT_IN
;
39 static uint8
CreateRequestType(const UsbEndpointDirection direction
,
40 const UsbDeviceHandle::TransferRequestType request_type
,
41 const UsbDeviceHandle::TransferRecipient recipient
) {
42 uint8 result
= ConvertTransferDirection(direction
);
44 switch (request_type
) {
45 case UsbDeviceHandle::STANDARD
:
46 result
|= LIBUSB_REQUEST_TYPE_STANDARD
;
48 case UsbDeviceHandle::CLASS
:
49 result
|= LIBUSB_REQUEST_TYPE_CLASS
;
51 case UsbDeviceHandle::VENDOR
:
52 result
|= LIBUSB_REQUEST_TYPE_VENDOR
;
54 case UsbDeviceHandle::RESERVED
:
55 result
|= LIBUSB_REQUEST_TYPE_RESERVED
;
60 case UsbDeviceHandle::DEVICE
:
61 result
|= LIBUSB_RECIPIENT_DEVICE
;
63 case UsbDeviceHandle::INTERFACE
:
64 result
|= LIBUSB_RECIPIENT_INTERFACE
;
66 case UsbDeviceHandle::ENDPOINT
:
67 result
|= LIBUSB_RECIPIENT_ENDPOINT
;
69 case UsbDeviceHandle::OTHER
:
70 result
|= LIBUSB_RECIPIENT_OTHER
;
77 static UsbTransferStatus
ConvertTransferStatus(
78 const libusb_transfer_status status
) {
80 case LIBUSB_TRANSFER_COMPLETED
:
81 return USB_TRANSFER_COMPLETED
;
82 case LIBUSB_TRANSFER_ERROR
:
83 return USB_TRANSFER_ERROR
;
84 case LIBUSB_TRANSFER_TIMED_OUT
:
85 return USB_TRANSFER_TIMEOUT
;
86 case LIBUSB_TRANSFER_STALL
:
87 return USB_TRANSFER_STALLED
;
88 case LIBUSB_TRANSFER_NO_DEVICE
:
89 return USB_TRANSFER_DISCONNECT
;
90 case LIBUSB_TRANSFER_OVERFLOW
:
91 return USB_TRANSFER_OVERFLOW
;
92 case LIBUSB_TRANSFER_CANCELLED
:
93 return USB_TRANSFER_CANCELLED
;
96 return USB_TRANSFER_ERROR
;
100 static void LIBUSB_CALL
PlatformTransferCompletionCallback(
101 PlatformUsbTransferHandle transfer
) {
102 BrowserThread::PostTask(BrowserThread::FILE,
104 base::Bind(HandleTransferCompletion
, transfer
));
109 void HandleTransferCompletion(PlatformUsbTransferHandle transfer
) {
110 DCHECK(BrowserThread::CurrentlyOn(BrowserThread::FILE));
111 UsbDeviceHandle
* const device_handle
=
112 reinterpret_cast<UsbDeviceHandle
*>(transfer
->user_data
);
113 CHECK(device_handle
) << "Device handle is closed before transfer finishes.";
114 device_handle
->TransferComplete(transfer
);
115 libusb_free_transfer(transfer
);
119 class UsbDeviceHandle::InterfaceClaimer
120 : public base::RefCountedThreadSafe
<UsbDeviceHandle::InterfaceClaimer
> {
122 InterfaceClaimer(const scoped_refptr
<UsbDeviceHandle
> handle
,
123 const int interface_number
);
127 int alternate_setting() const { return alternate_setting_
; }
128 void set_alternate_setting(const int alternate_setting
) {
129 alternate_setting_
= alternate_setting
;
133 friend class UsbDevice
;
134 friend class base::RefCountedThreadSafe
<InterfaceClaimer
>;
137 const scoped_refptr
<UsbDeviceHandle
> handle_
;
138 const int interface_number_
;
139 int alternate_setting_
;
141 DISALLOW_COPY_AND_ASSIGN(InterfaceClaimer
);
144 UsbDeviceHandle::InterfaceClaimer::InterfaceClaimer(
145 const scoped_refptr
<UsbDeviceHandle
> handle
, const int interface_number
)
147 interface_number_(interface_number
),
148 alternate_setting_(0) {
151 UsbDeviceHandle::InterfaceClaimer::~InterfaceClaimer() {
152 libusb_release_interface(handle_
->handle(), interface_number_
);
155 bool UsbDeviceHandle::InterfaceClaimer::Claim() const {
156 return libusb_claim_interface(handle_
->handle(), interface_number_
) == 0;
159 struct UsbDeviceHandle::Transfer
{
163 UsbTransferType transfer_type
;
164 scoped_refptr
<net::IOBuffer
> buffer
;
165 scoped_refptr
<UsbDeviceHandle::InterfaceClaimer
> claimed_interface
;
166 scoped_refptr
<base::MessageLoopProxy
> message_loop_proxy
;
168 UsbTransferCallback callback
;
171 UsbDeviceHandle::Transfer::Transfer()
172 : transfer_type(USB_TRANSFER_CONTROL
),
176 UsbDeviceHandle::Transfer::~Transfer() {}
178 UsbDeviceHandle::UsbDeviceHandle(
179 scoped_refptr
<UsbContext
> context
,
181 PlatformUsbDeviceHandle handle
,
182 scoped_refptr
<UsbConfigDescriptor
> interfaces
)
185 interfaces_(interfaces
),
187 DCHECK(thread_checker_
.CalledOnValidThread());
188 DCHECK(handle
) << "Cannot create device with NULL handle.";
189 DCHECK(interfaces_
) << "Unabled to list interfaces";
192 UsbDeviceHandle::UsbDeviceHandle() : device_(NULL
), handle_(NULL
) {
195 UsbDeviceHandle::~UsbDeviceHandle() {
196 DCHECK(thread_checker_
.CalledOnValidThread());
198 libusb_close(handle_
);
202 scoped_refptr
<UsbDevice
> UsbDeviceHandle::device() const {
206 void UsbDeviceHandle::Close() {
207 DCHECK(thread_checker_
.CalledOnValidThread());
209 device_
->Close(this);
212 void UsbDeviceHandle::TransferComplete(PlatformUsbTransferHandle handle
) {
213 DCHECK(ContainsKey(transfers_
, handle
)) << "Missing transfer completed";
215 Transfer transfer
= transfers_
[handle
];
216 transfers_
.erase(handle
);
218 DCHECK_GE(handle
->actual_length
, 0) << "Negative actual length received";
219 size_t actual_length
=
220 static_cast<size_t>(std::max(handle
->actual_length
, 0));
222 DCHECK(transfer
.length
>= actual_length
) <<
223 "data too big for our buffer (libusb failure?)";
225 scoped_refptr
<net::IOBuffer
> buffer
= transfer
.buffer
;
226 switch (transfer
.transfer_type
) {
227 case USB_TRANSFER_CONTROL
:
228 // If the transfer is a control transfer we do not expose the control
229 // setup header to the caller. This logic strips off the header if
230 // present before invoking the callback provided with the transfer.
231 if (actual_length
> 0) {
232 CHECK(transfer
.length
>= LIBUSB_CONTROL_SETUP_SIZE
) <<
233 "buffer was not correctly set: too small for the control header";
235 if (transfer
.length
>= actual_length
&&
236 actual_length
>= LIBUSB_CONTROL_SETUP_SIZE
) {
237 // If the payload is zero bytes long, pad out the allocated buffer
238 // size to one byte so that an IOBuffer of that size can be allocated.
239 scoped_refptr
<net::IOBuffer
> resized_buffer
= new net::IOBuffer(
240 std::max(actual_length
, static_cast<size_t>(1)));
241 memcpy(resized_buffer
->data(),
242 buffer
->data() + LIBUSB_CONTROL_SETUP_SIZE
,
244 buffer
= resized_buffer
;
249 case USB_TRANSFER_ISOCHRONOUS
:
250 // Isochronous replies might carry data in the different isoc packets even
251 // if the transfer actual_data value is zero. Furthermore, not all of the
252 // received packets might contain data, so we need to calculate how many
253 // data bytes we are effectively providing and pack the results.
254 if (actual_length
== 0) {
255 size_t packet_buffer_start
= 0;
256 for (int i
= 0; i
< handle
->num_iso_packets
; ++i
) {
257 PlatformUsbIsoPacketDescriptor packet
= &handle
->iso_packet_desc
[i
];
258 if (packet
->actual_length
> 0) {
259 // We don't need to copy as long as all packets until now provide
260 // all the data the packet can hold.
261 if (actual_length
< packet_buffer_start
) {
262 CHECK(packet_buffer_start
+ packet
->actual_length
<=
264 memmove(buffer
->data() + actual_length
,
265 buffer
->data() + packet_buffer_start
,
266 packet
->actual_length
);
268 actual_length
+= packet
->actual_length
;
271 packet_buffer_start
+= packet
->length
;
276 case USB_TRANSFER_BULK
:
277 case USB_TRANSFER_INTERRUPT
:
281 NOTREACHED() << "Invalid usb transfer type";
285 transfer
.message_loop_proxy
->PostTask(
287 base::Bind(transfer
.callback
,
288 ConvertTransferStatus(handle
->status
),
292 // Must release interface first before actually delete this.
293 transfer
.claimed_interface
= NULL
;
296 bool UsbDeviceHandle::ClaimInterface(const int interface_number
) {
297 DCHECK(thread_checker_
.CalledOnValidThread());
298 if (!device_
) return false;
299 if (ContainsKey(claimed_interfaces_
, interface_number
)) return true;
301 scoped_refptr
<InterfaceClaimer
> claimer
=
302 new InterfaceClaimer(this, interface_number
);
304 if (claimer
->Claim()) {
305 claimed_interfaces_
[interface_number
]= claimer
;
306 RefreshEndpointMap();
312 bool UsbDeviceHandle::ReleaseInterface(const int interface_number
) {
313 DCHECK(thread_checker_
.CalledOnValidThread());
314 if (!device_
) return false;
315 if (!ContainsKey(claimed_interfaces_
, interface_number
)) return false;
317 // Cancel all the transfers on that interface.
318 InterfaceClaimer
* interface_claimer
=
319 claimed_interfaces_
[interface_number
].get();
320 for (TransferMap::iterator it
= transfers_
.begin();
321 it
!= transfers_
.end(); ++it
) {
322 if (it
->second
.claimed_interface
.get() == interface_claimer
)
323 libusb_cancel_transfer(it
->first
);
325 claimed_interfaces_
.erase(interface_number
);
327 RefreshEndpointMap();
331 bool UsbDeviceHandle::SetInterfaceAlternateSetting(
332 const int interface_number
,
333 const int alternate_setting
) {
334 DCHECK(thread_checker_
.CalledOnValidThread());
335 if (!device_
) return false;
336 if (!ContainsKey(claimed_interfaces_
, interface_number
)) return false;
337 const int rv
= libusb_set_interface_alt_setting(handle_
,
338 interface_number
, alternate_setting
);
340 claimed_interfaces_
[interface_number
]->
341 set_alternate_setting(alternate_setting
);
342 RefreshEndpointMap();
348 bool UsbDeviceHandle::ResetDevice() {
349 DCHECK(thread_checker_
.CalledOnValidThread());
350 if (!device_
) return false;
352 return libusb_reset_device(handle_
) == 0;
355 bool UsbDeviceHandle::GetSerial(base::string16
* serial
) {
356 DCHECK(thread_checker_
.CalledOnValidThread());
357 PlatformUsbDevice device
= libusb_get_device(handle_
);
358 libusb_device_descriptor desc
;
360 if (libusb_get_device_descriptor(device
, &desc
) != LIBUSB_SUCCESS
)
363 if (desc
.iSerialNumber
== 0)
366 // Getting supported language ID.
367 uint16 langid
[128] = { 0 };
369 int size
= libusb_get_string_descriptor(
371 reinterpret_cast<unsigned char*>(&langid
[0]), sizeof(langid
));
375 int language_count
= (size
- 2) / 2;
377 for (int i
= 1; i
<= language_count
; ++i
) {
378 // Get the string using language ID.
379 base::char16 text
[256] = { 0 };
380 size
= libusb_get_string_descriptor(
381 handle_
, desc
.iSerialNumber
, langid
[i
],
382 reinterpret_cast<unsigned char*>(&text
[0]), sizeof(text
));
385 if ((text
[0] >> 8) != LIBUSB_DT_STRING
)
387 if ((text
[0] & 255) > size
)
391 *serial
= base::string16(text
+ 1, size
);
397 void UsbDeviceHandle::ControlTransfer(const UsbEndpointDirection direction
,
398 const TransferRequestType request_type
, const TransferRecipient recipient
,
399 const uint8 request
, const uint16 value
, const uint16 index
,
400 net::IOBuffer
* buffer
, const size_t length
, const unsigned int timeout
,
401 const UsbTransferCallback
& callback
) {
403 callback
.Run(USB_TRANSFER_DISCONNECT
, buffer
, 0);
407 const size_t resized_length
= LIBUSB_CONTROL_SETUP_SIZE
+ length
;
408 scoped_refptr
<net::IOBuffer
> resized_buffer(new net::IOBufferWithSize(
410 memcpy(resized_buffer
->data() + LIBUSB_CONTROL_SETUP_SIZE
, buffer
->data(),
413 PlatformUsbTransferHandle
const transfer
= libusb_alloc_transfer(0);
414 const uint8 converted_type
= CreateRequestType(direction
, request_type
,
416 libusb_fill_control_setup(reinterpret_cast<uint8
*>(resized_buffer
->data()),
417 converted_type
, request
, value
, index
, length
);
418 libusb_fill_control_transfer(
421 reinterpret_cast<uint8
*>(resized_buffer
->data()),
422 PlatformTransferCompletionCallback
,
426 BrowserThread::PostTask(
429 base::Bind(&UsbDeviceHandle::SubmitTransfer
,
432 USB_TRANSFER_CONTROL
,
435 base::MessageLoopProxy::current(),
439 void UsbDeviceHandle::BulkTransfer(const UsbEndpointDirection direction
,
440 const uint8 endpoint
, net::IOBuffer
* buffer
, const size_t length
,
441 const unsigned int timeout
, const UsbTransferCallback
& callback
) {
443 callback
.Run(USB_TRANSFER_DISCONNECT
, buffer
, 0);
447 PlatformUsbTransferHandle
const transfer
= libusb_alloc_transfer(0);
448 const uint8 new_endpoint
= ConvertTransferDirection(direction
) | endpoint
;
449 libusb_fill_bulk_transfer(transfer
, handle_
, new_endpoint
,
450 reinterpret_cast<uint8
*>(buffer
->data()), length
,
451 PlatformTransferCompletionCallback
, this, timeout
);
453 BrowserThread::PostTask(
456 base::Bind(&UsbDeviceHandle::SubmitTransfer
,
460 make_scoped_refptr(buffer
),
462 base::MessageLoopProxy::current(),
466 void UsbDeviceHandle::InterruptTransfer(const UsbEndpointDirection direction
,
467 const uint8 endpoint
, net::IOBuffer
* buffer
, const size_t length
,
468 const unsigned int timeout
, const UsbTransferCallback
& callback
) {
470 callback
.Run(USB_TRANSFER_DISCONNECT
, buffer
, 0);
474 PlatformUsbTransferHandle
const transfer
= libusb_alloc_transfer(0);
475 const uint8 new_endpoint
= ConvertTransferDirection(direction
) | endpoint
;
476 libusb_fill_interrupt_transfer(transfer
, handle_
, new_endpoint
,
477 reinterpret_cast<uint8
*>(buffer
->data()), length
,
478 PlatformTransferCompletionCallback
, this, timeout
);
479 BrowserThread::PostTask(
482 base::Bind(&UsbDeviceHandle::SubmitTransfer
,
485 USB_TRANSFER_INTERRUPT
,
486 make_scoped_refptr(buffer
),
488 base::MessageLoopProxy::current(),
492 void UsbDeviceHandle::IsochronousTransfer(const UsbEndpointDirection direction
,
493 const uint8 endpoint
, net::IOBuffer
* buffer
, const size_t length
,
494 const unsigned int packets
, const unsigned int packet_length
,
495 const unsigned int timeout
, const UsbTransferCallback
& callback
) {
497 callback
.Run(USB_TRANSFER_DISCONNECT
, buffer
, 0);
501 const uint64 total_length
= packets
* packet_length
;
502 CHECK(packets
<= length
&& total_length
<= length
) <<
503 "transfer length is too small";
505 PlatformUsbTransferHandle
const transfer
= libusb_alloc_transfer(packets
);
506 const uint8 new_endpoint
= ConvertTransferDirection(direction
) | endpoint
;
507 libusb_fill_iso_transfer(transfer
, handle_
, new_endpoint
,
508 reinterpret_cast<uint8
*>(buffer
->data()), length
, packets
,
509 PlatformTransferCompletionCallback
, this, timeout
);
510 libusb_set_iso_packet_lengths(transfer
, packet_length
);
512 BrowserThread::PostTask(
515 base::Bind(&UsbDeviceHandle::SubmitTransfer
,
518 USB_TRANSFER_ISOCHRONOUS
,
519 make_scoped_refptr(buffer
),
521 base::MessageLoopProxy::current(),
525 void UsbDeviceHandle::RefreshEndpointMap() {
526 DCHECK(thread_checker_
.CalledOnValidThread());
527 endpoint_map_
.clear();
528 for (ClaimedInterfaceMap::iterator it
= claimed_interfaces_
.begin();
529 it
!= claimed_interfaces_
.end(); ++it
) {
530 scoped_refptr
<const UsbInterfaceAltSettingDescriptor
> interface_desc
=
531 interfaces_
->GetInterface(it
->first
)->GetAltSetting(
532 it
->second
->alternate_setting());
533 for (size_t i
= 0; i
< interface_desc
->GetNumEndpoints(); i
++) {
534 scoped_refptr
<const UsbEndpointDescriptor
> endpoint
=
535 interface_desc
->GetEndpoint(i
);
536 endpoint_map_
[endpoint
->GetAddress()] = it
->first
;
541 scoped_refptr
<UsbDeviceHandle::InterfaceClaimer
>
542 UsbDeviceHandle::GetClaimedInterfaceForEndpoint(unsigned char endpoint
) {
543 unsigned char address
= endpoint
& LIBUSB_ENDPOINT_ADDRESS_MASK
;
544 if (ContainsKey(endpoint_map_
, address
))
545 return claimed_interfaces_
[endpoint_map_
[address
]];
549 void UsbDeviceHandle::SubmitTransfer(
550 PlatformUsbTransferHandle handle
,
551 UsbTransferType transfer_type
,
552 net::IOBuffer
* buffer
,
554 scoped_refptr
<base::MessageLoopProxy
> message_loop_proxy
,
555 const UsbTransferCallback
& callback
) {
556 DCHECK(thread_checker_
.CalledOnValidThread());
558 message_loop_proxy
->PostTask(
560 base::Bind(callback
, USB_TRANSFER_DISCONNECT
,
561 make_scoped_refptr(buffer
), 0));
565 transfer
.transfer_type
= transfer_type
;
566 transfer
.buffer
= buffer
;
567 transfer
.length
= length
;
568 transfer
.callback
= callback
;
569 transfer
.message_loop_proxy
= message_loop_proxy
;
571 // It's OK for this method to return NULL. libusb_submit_transfer will fail if
572 // it requires an interface we didn't claim.
573 transfer
.claimed_interface
= GetClaimedInterfaceForEndpoint(handle
->endpoint
);
575 if (libusb_submit_transfer(handle
) == LIBUSB_SUCCESS
) {
576 transfers_
[handle
] = transfer
;
578 message_loop_proxy
->PostTask(
580 base::Bind(callback
, USB_TRANSFER_ERROR
,
581 make_scoped_refptr(buffer
), 0));
585 void UsbDeviceHandle::InternalClose() {
586 DCHECK(thread_checker_
.CalledOnValidThread());
587 if (!device_
) return;
589 // Cancel all the transfers.
590 for (TransferMap::iterator it
= transfers_
.begin();
591 it
!= transfers_
.end(); ++it
) {
592 // The callback will be called some time later.
593 libusb_cancel_transfer(it
->first
);
596 // Attempt-release all the interfaces.
597 // It will be retained until the transfer cancellation is finished.
598 claimed_interfaces_
.clear();
600 // Cannot close device handle here. Need to wait for libusb_cancel_transfer to