288 lines
9.5 KiB
C++
288 lines
9.5 KiB
C++
/*! \file piusb.h
|
||
* \ingroup USB
|
||
* \~\brief
|
||
* \~english USB device
|
||
* \~russian Устройство USB
|
||
*/
|
||
/*
|
||
PIP - Platform Independent Primitives
|
||
USB, based on libusb
|
||
Ivan Pelipenko peri4ko@yandex.ru
|
||
|
||
This program is free software: you can redistribute it and/or modify
|
||
it under the terms of the GNU Lesser General Public License as published by
|
||
the Free Software Foundation, either version 3 of the License, or
|
||
(at your option) any later version.
|
||
|
||
This program is distributed in the hope that it will be useful,
|
||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
GNU Lesser General Public License for more details.
|
||
|
||
You should have received a copy of the GNU Lesser General Public License
|
||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||
*/
|
||
//! \defgroup USB USB
|
||
//! \~\brief
|
||
//! \~english USB support via libusb
|
||
//! \~russian Поддержка USB с помощью libusb
|
||
//!
|
||
//! \~\details
|
||
//! \~english \section cmake_module_USB Building with CMake
|
||
//! \~russian \section cmake_module_USB Сборка с использованием CMake
|
||
//!
|
||
//! \~\code
|
||
//! find_package(PIP REQUIRED)
|
||
//! target_link_libraries([target] PIP::USB)
|
||
//! \endcode
|
||
//!
|
||
//! \~english \par Common
|
||
//! \~russian \par Общее
|
||
//!
|
||
//! \~english
|
||
//! These files provides works with raw USB device
|
||
//!
|
||
//! \~russian
|
||
//! Эти файлы обеспечивают работу с сырым USB устройством
|
||
//!
|
||
//! \~\authors
|
||
//! \~english
|
||
//! Ivan Pelipenko peri4ko@yandex.ru;
|
||
//! Andrey Bychkov work.a.b@yandex.ru;
|
||
//! \~russian
|
||
//! Иван Пелипенко peri4ko@yandex.ru;
|
||
//! Андрей Бычков work.a.b@yandex.ru;
|
||
//!
|
||
|
||
#ifndef PIUSB_H
|
||
#define PIUSB_H
|
||
|
||
#include "piiodevice.h"
|
||
#include "pip_usb_export.h"
|
||
|
||
struct usb_dev_handle;
|
||
|
||
//! \ingroup IO
|
||
//! \~\brief
|
||
//! \~english USB device.
|
||
//! \~russian Устройство USB.
|
||
class PIP_USB_EXPORT PIUSB: public PIIODevice {
|
||
PIIODEVICE(PIUSB, "usb");
|
||
|
||
public:
|
||
//! \~english Constructs %PIUSB with vendor ID "vid" and product ID "pid"
|
||
//! \~russian Создаёт %PIUSB с идентификатором поставщика "vid" и идентификатором продукта "pid"
|
||
explicit PIUSB(ushort vid = 0, ushort pid = 0);
|
||
|
||
//! \~english Destructor
|
||
//! \~russian Деструктор
|
||
virtual ~PIUSB();
|
||
|
||
//! \~english USB endpoint structure
|
||
//! \~russian Структура USB endpoint
|
||
struct PIP_USB_EXPORT Endpoint {
|
||
Endpoint(uchar a = 0, uchar at = 0, ushort mps = 0) {
|
||
address = a;
|
||
attributes = at;
|
||
max_packet_size = mps;
|
||
parse();
|
||
}
|
||
|
||
enum Direction {
|
||
Write = 0,
|
||
Read = 1
|
||
};
|
||
enum TransferType {
|
||
Control = 0,
|
||
Isochronous = 1,
|
||
Bulk = 2,
|
||
Interrupt = 3
|
||
};
|
||
enum SynchronisationType {
|
||
NoSynchonisation = 0,
|
||
Asynchronous = 2,
|
||
Adaptive = 1,
|
||
Synchronous = 3
|
||
};
|
||
enum UsageType {
|
||
DataEndpoint = 0,
|
||
FeedbackEndpoint = 2,
|
||
ExplicitFeedbackDataEndpoint = 1
|
||
};
|
||
|
||
void parse();
|
||
bool isNull() const { return address == 0; }
|
||
|
||
uchar address;
|
||
uchar attributes;
|
||
ushort max_packet_size;
|
||
Direction direction;
|
||
TransferType transfer_type;
|
||
SynchronisationType synchronisation_type = NoSynchonisation;
|
||
UsageType usage_type = DataEndpoint;
|
||
};
|
||
|
||
//! \~english USB interface structure
|
||
//! \~russian Структура USB интерфейса
|
||
struct PIP_USB_EXPORT Interface {
|
||
uchar index = 0;
|
||
uchar value_to_select = 0;
|
||
ushort class_code = 0;
|
||
ushort subclass_code = 0;
|
||
ushort protocol_code = 0;
|
||
PIVector<PIUSB::Endpoint> endpoints;
|
||
};
|
||
|
||
//! \~english USB configuration structure
|
||
//! \~russian Структура USB конфигурации
|
||
struct PIP_USB_EXPORT Configuration {
|
||
uchar index = 0;
|
||
uchar value_to_select = 0;
|
||
uchar attributes = 0;
|
||
ushort max_power = 0; // mA
|
||
bool self_powered = false;
|
||
bool remote_wakeup = false;
|
||
PIVector<PIUSB::Interface> interfaces;
|
||
};
|
||
|
||
//! \~english USB device descriptor structure
|
||
//! \~russian Структура дескриптора USB устройства
|
||
struct PIP_USB_EXPORT Descriptor {
|
||
ushort usb_spec_number = 0;
|
||
uchar device_class = 0;
|
||
uchar device_subclass = 0;
|
||
uchar device_protocol = 0;
|
||
uchar max_packet_size = 0;
|
||
ushort id_vendor = 0;
|
||
ushort id_product = 0;
|
||
ushort id_device_release = 0;
|
||
uchar index_manufacturer = 0;
|
||
uchar index_product = 0;
|
||
uchar index_serial = 0;
|
||
PIVector<PIUSB::Configuration> configurations;
|
||
};
|
||
|
||
//! \~english Returns current device descriptor
|
||
//! \~russian Возвращает текущий дескриптор устройства
|
||
const PIUSB::Descriptor & currentDescriptor() const { return desc_; }
|
||
|
||
//! \~english Returns current configuration
|
||
//! \~russian Возвращает текущую конфигурацию
|
||
const PIUSB::Configuration & currentConfiguration() const { return conf_; }
|
||
|
||
//! \~english Returns current interface
|
||
//! \~russian Возвращает текущий интерфейс
|
||
const PIUSB::Interface & currentInterface() const { return iface_; }
|
||
|
||
//! \~english Returns vendor ID
|
||
//! \~russian Возвращает ID поставщика
|
||
ushort vendorID() const { return vid_; }
|
||
|
||
//! \~english Returns product ID
|
||
//! \~russian Возвращает ID продукта
|
||
ushort productID() const { return pid_; }
|
||
|
||
//! \~english Returns device number
|
||
//! \~russian Возвращает номер устройства
|
||
int deviceNumber() const { return property("deviceNumber").toInt(); }
|
||
|
||
//! \~english Returns read timeout in milliseconds
|
||
//! \~russian Возвращает таймаут чтения в миллисекундах
|
||
int timeoutRead() const { return property("timeoutRead").toInt(); }
|
||
|
||
//! \~english Returns write timeout in milliseconds
|
||
//! \~russian Возвращает таймаут записи в миллисекундах
|
||
int timeoutWrite() const { return property("timeoutWrite").toInt(); }
|
||
|
||
//! \~english Returns read endpoint
|
||
//! \~russian Возвращает endpoint для чтения
|
||
const PIUSB::Endpoint & endpointRead() const { return ep_read; }
|
||
|
||
//! \~english Returns write endpoint
|
||
//! \~russian Возвращает endpoint для записи
|
||
const PIUSB::Endpoint & endpointWrite() const { return ep_write; }
|
||
|
||
//! \~english Returns all endpoints
|
||
//! \~russian Возвращает все endpoints
|
||
const PIVector<PIUSB::Endpoint> & endpoints() const { return eps; }
|
||
|
||
//! \~english Returns read endpoints
|
||
//! \~russian Возвращает endpoints для чтения
|
||
PIVector<PIUSB::Endpoint> endpointsRead();
|
||
|
||
//! \~english Returns write endpoints
|
||
//! \~russian Возвращает endpoints для записи
|
||
PIVector<PIUSB::Endpoint> endpointsWrite();
|
||
|
||
//! \~english Returns endpoint by address
|
||
//! \~russian Возвращает endpoint по адресу
|
||
PIUSB::Endpoint getEndpointByAddress(uchar address);
|
||
|
||
//! \~english Set vendor ID to "vid"
|
||
//! \~russian Устанавливает ID поставщика в "vid"
|
||
void setVendorID(ushort vid);
|
||
|
||
//! \~english Set product ID to "pid"
|
||
//! \~russian Устанавливает ID продукта в "pid"
|
||
void setProductID(ushort pid);
|
||
|
||
//! \~english Set configuration by value
|
||
//! \~russian Устанавливает конфигурацию по значению
|
||
bool setConfiguration(uchar value);
|
||
|
||
//! \~english Set interface by value
|
||
//! \~russian Устанавливает интерфейс по значению
|
||
bool setInterface(uchar value);
|
||
|
||
//! \~english Set read endpoint
|
||
//! \~russian Устанавливает endpoint для чтения
|
||
void setEndpointRead(const PIUSB::Endpoint & ep) { ep_read = ep; }
|
||
|
||
//! \~english Set write endpoint
|
||
//! \~russian Устанавливает endpoint для записи
|
||
void setEndpointWrite(const PIUSB::Endpoint & ep) { ep_write = ep; }
|
||
|
||
//! \~english Set device number
|
||
//! \~russian Устанавливает номер устройства
|
||
void setDeviceNumber(int dn) { setProperty("deviceNumber", dn); }
|
||
|
||
//! \~english Set read timeout in milliseconds
|
||
//! \~russian Устанавливает таймаут чтения в миллисекундах
|
||
void setTimeoutRead(int t) { setProperty("timeoutRead", t); }
|
||
|
||
//! \~english Set write timeout in milliseconds
|
||
//! \~russian Устанавливает таймаут записи в миллисекундах
|
||
void setTimeoutWrite(int t) { setProperty("timeoutWrite", t); }
|
||
|
||
//! \~english Control write to device
|
||
//! \~russian Управляющая запись в устройство
|
||
int controlWrite(const void * data, int max_size);
|
||
|
||
virtual void flush() override;
|
||
|
||
protected:
|
||
bool configureDevice(const void * e_main, const void * e_parent = 0) override;
|
||
PIString constructFullPathDevice() const override;
|
||
void configureFromFullPathDevice(const PIString & full_path) override;
|
||
ssize_t readDevice(void * read_to, ssize_t max_size) override;
|
||
ssize_t writeDevice(const void * data, ssize_t max_size) override;
|
||
bool openDevice() override;
|
||
bool closeDevice() override;
|
||
DeviceInfoFlags deviceInfoFlags() const override { return PIIODevice::Reliable; }
|
||
|
||
PIVector<PIUSB::Endpoint> eps;
|
||
ushort vid_, pid_;
|
||
int intefrace_, timeout_r, timeout_w;
|
||
int interface_claimed;
|
||
PIUSB::Endpoint ep_read, ep_write;
|
||
Descriptor desc_;
|
||
Configuration conf_;
|
||
Interface iface_;
|
||
usb_dev_handle * hdev;
|
||
};
|
||
|
||
PIP_USB_EXPORT PICout operator<<(PICout s, const PIUSB::Endpoint & v);
|
||
|
||
|
||
#endif
|