blob: 7098d6809ee8a1eb47845b23432c7e901c9e413b [file] [log] [blame]
// Copyright 2014 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 DEVICE_USB_USB_DEVICE_HANDLE_H_
#define DEVICE_USB_USB_DEVICE_HANDLE_H_
#include <map>
#include <vector>
#include "base/callback.h"
#include "base/memory/ref_counted.h"
#include "base/strings/string16.h"
#include "base/threading/thread_checker.h"
#include "device/usb/usb_descriptors.h"
#include "net/base/io_buffer.h"
namespace device {
class UsbDevice;
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 };
virtual scoped_refptr<UsbDevice> GetDevice() const = 0;
// 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() = 0;
// Device manipulation operations. These methods are blocking and must be
// called on FILE thread.
virtual bool SetConfiguration(int configuration_value) = 0;
virtual bool ClaimInterface(int interface_number) = 0;
virtual bool ReleaseInterface(int interface_number) = 0;
virtual bool SetInterfaceAlternateSetting(int interface_number,
int alternate_setting) = 0;
virtual bool ResetDevice() = 0;
// Gets the string descriptor with the given index from the device, or returns
// false. This method is blocking and must be called on the FILE thread.
virtual bool GetStringDescriptor(uint8 string_id, base::string16* string) = 0;
// Async IO. Can be called on any thread.
virtual void ControlTransfer(UsbEndpointDirection direction,
TransferRequestType request_type,
TransferRecipient recipient,
uint8 request,
uint16 value,
uint16 index,
net::IOBuffer* buffer,
size_t length,
unsigned int timeout,
const UsbTransferCallback& callback) = 0;
virtual void BulkTransfer(UsbEndpointDirection direction,
uint8 endpoint,
net::IOBuffer* buffer,
size_t length,
unsigned int timeout,
const UsbTransferCallback& callback) = 0;
virtual void InterruptTransfer(UsbEndpointDirection direction,
uint8 endpoint,
net::IOBuffer* buffer,
size_t length,
unsigned int timeout,
const UsbTransferCallback& callback) = 0;
virtual void IsochronousTransfer(UsbEndpointDirection direction,
uint8 endpoint,
net::IOBuffer* buffer,
size_t length,
unsigned int packets,
unsigned int packet_length,
unsigned int timeout,
const UsbTransferCallback& callback) = 0;
protected:
friend class base::RefCountedThreadSafe<UsbDeviceHandle>;
UsbDeviceHandle() {};
virtual ~UsbDeviceHandle() {};
DISALLOW_COPY_AND_ASSIGN(UsbDeviceHandle);
};
} // namespace device
#endif // DEVICE_USB_USB_DEVICE_HANDLE_H_