1a36e5920737c6adbddd3e43b760e5de8431db6e0Torne (Richard Coles)// Copyright (c) 2013 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch#ifndef CHROME_BROWSER_USB_USB_DEVICE_HANDLE_H_ 6a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch#define CHROME_BROWSER_USB_USB_DEVICE_HANDLE_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <map> 990dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)#include <vector> 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/ref_counted.h" 12bbcdd45c55eb7c4641ab97aef9889b0fc828e7d3Ben Murdoch#include "base/strings/string16.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/synchronization/lock.h" 14ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch#include "base/threading/thread_checker.h" 1590dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)#include "chrome/browser/usb/usb_interface.h" 16ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch#include "content/public/browser/browser_thread.h" 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "net/base/completion_callback.h" 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "net/base/io_buffer.h" 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)struct libusb_device_handle; 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)struct libusb_iso_packet_descriptor; 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)struct libusb_transfer; 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)typedef libusb_device_handle* PlatformUsbDeviceHandle; 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)typedef libusb_iso_packet_descriptor* PlatformUsbIsoPacketDescriptor; 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)typedef libusb_transfer* PlatformUsbTransferHandle; 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 28ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdochclass UsbContext; 29ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdochclass UsbConfigDescriptor; 30ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdochclass UsbDevice; 31424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles)class UsbInterfaceDescriptor; 32ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 33ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdochnamespace base { 34ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch class MessageLoopProxy; 35ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch} // namespace base 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace net { 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class IOBuffer; 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace net 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)enum UsbTransferStatus { 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) USB_TRANSFER_COMPLETED = 0, 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) USB_TRANSFER_ERROR, 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) USB_TRANSFER_TIMEOUT, 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) USB_TRANSFER_CANCELLED, 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) USB_TRANSFER_STALLED, 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) USB_TRANSFER_DISCONNECT, 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) USB_TRANSFER_OVERFLOW, 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) USB_TRANSFER_LENGTH_SHORT, 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)typedef base::Callback<void(UsbTransferStatus, scoped_refptr<net::IOBuffer>, 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t)> UsbTransferCallback; 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch// UsbDeviceHandle class provides basic I/O related functionalities. 56ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdochclass UsbDeviceHandle : public base::RefCountedThreadSafe<UsbDeviceHandle> { 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) enum TransferRequestType { STANDARD, CLASS, VENDOR, RESERVED }; 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) enum TransferRecipient { DEVICE, INTERFACE, ENDPOINT, OTHER }; 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 61ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch scoped_refptr<UsbDevice> device() const; 62ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch PlatformUsbDeviceHandle handle() const { return handle_; } 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 64ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // Notifies UsbDevice to drop the reference of this object; cancels all the 65ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // flying transfers. 66ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // It is possible that the object has no other reference after this call. So 67ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // if it is called using a raw pointer, it could be invalidated. 68ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // The platform device handle will be closed when UsbDeviceHandle destructs. 69a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch virtual void Close(); 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 71ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // Device manipulation operations. These methods are blocking and must be 72ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // called on FILE thread. 73a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch virtual bool ClaimInterface(const int interface_number); 74a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch virtual bool ReleaseInterface(const int interface_number); 75a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch virtual bool SetInterfaceAlternateSetting( 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const int interface_number, 77a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch const int alternate_setting); 78a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch virtual bool ResetDevice(); 79ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch virtual bool GetSerial(base::string16* serial); 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 81ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // Async IO. Can be called on any thread. 8290dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) virtual void ControlTransfer(const UsbEndpointDirection direction, 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const TransferRequestType request_type, 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const TransferRecipient recipient, 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const uint8 request, 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const uint16 value, 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const uint16 index, 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) net::IOBuffer* buffer, 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const size_t length, 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const unsigned int timeout, 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const UsbTransferCallback& callback); 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9390dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) virtual void BulkTransfer(const UsbEndpointDirection direction, 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const uint8 endpoint, 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) net::IOBuffer* buffer, 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const size_t length, 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const unsigned int timeout, 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const UsbTransferCallback& callback); 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10090dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) virtual void InterruptTransfer(const UsbEndpointDirection direction, 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const uint8 endpoint, 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) net::IOBuffer* buffer, 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const size_t length, 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const unsigned int timeout, 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const UsbTransferCallback& callback); 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10790dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) virtual void IsochronousTransfer(const UsbEndpointDirection direction, 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const uint8 endpoint, 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) net::IOBuffer* buffer, 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const size_t length, 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const unsigned int packets, 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const unsigned int packet_length, 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const unsigned int timeout, 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const UsbTransferCallback& callback); 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 117ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch friend class base::RefCountedThreadSafe<UsbDeviceHandle>; 118ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch friend class UsbDevice; 119ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 120ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // This constructor is called by UsbDevice. 121ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch UsbDeviceHandle(scoped_refptr<UsbContext> context, 122424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) UsbDevice* device, PlatformUsbDeviceHandle handle, 123424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) scoped_refptr<UsbConfigDescriptor> interfaces); 124ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This constructor variant is for use in testing only. 126a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch UsbDeviceHandle(); 127a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch virtual ~UsbDeviceHandle(); 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 129ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch UsbDevice* device_; 130ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 132ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch friend void HandleTransferCompletion(PlatformUsbTransferHandle handle); 133ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 134ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch class InterfaceClaimer; 135ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch struct Transfer; 1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 137ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // Refresh endpoint_map_ after ClaimInterface, ReleaseInterface and 138ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // SetInterfaceAlternateSetting. 139ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch void RefreshEndpointMap(); 1405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 141ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // Look up the claimed interface by endpoint. Return NULL if the interface 142ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // of the endpoint is not found. 143ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch scoped_refptr<InterfaceClaimer> GetClaimedInterfaceForEndpoint( 144ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch unsigned char endpoint); 1455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Submits a transfer and starts tracking it. Retains the buffer and copies 1475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the completion callback until the transfer finishes, whereupon it invokes 1485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the callback then releases the buffer. 1495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SubmitTransfer(PlatformUsbTransferHandle handle, 1505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) UsbTransferType transfer_type, 1515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) net::IOBuffer* buffer, 1525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const size_t length, 153ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch scoped_refptr<base::MessageLoopProxy> message_loop_proxy, 1545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const UsbTransferCallback& callback); 1555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 156ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // Invokes the callbacks associated with a given transfer, and removes it from 157ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // the in-flight transfer set. 158ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch void TransferComplete(PlatformUsbTransferHandle transfer); 159ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 160ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // Informs the object to drop internal references. 161ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch void InternalClose(); 162ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 1635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PlatformUsbDeviceHandle handle_; 1645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 165ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch scoped_refptr<UsbConfigDescriptor> interfaces_; 166ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 167ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch typedef std::map<int, scoped_refptr<InterfaceClaimer> > ClaimedInterfaceMap; 168ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch ClaimedInterfaceMap claimed_interfaces_; 169ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 170ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch typedef std::map<PlatformUsbTransferHandle, Transfer> TransferMap; 171ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch TransferMap transfers_; 172ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 173ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // A map from endpoints to interfaces 174ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch typedef std::map<int, int> EndpointMap; 175ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch EndpointMap endpoint_map_; 176ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 177ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // Retain the UsbContext so that the platform context will not be destroyed 178ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch // before this handle. 179ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch scoped_refptr<UsbContext> context_; 180ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch 181ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch base::ThreadChecker thread_checker_; 1825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 183a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch DISALLOW_COPY_AND_ASSIGN(UsbDeviceHandle); 1845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 186a3f7b4e666c476898878fa745f637129375cd889Ben Murdoch#endif // CHROME_BROWSER_USB_USB_DEVICE_HANDLE_H_ 187