dxd - dynax driver framework 2.3.0d127
cross platform open source driver development framework
|
#include <dx_usb_device.h>
Public Types | |
enum class | speed : uint8_t { low = ::kUSBDeviceSpeedLow , full = ::kUSBDeviceSpeedFull , high = ::kUSBDeviceSpeedHigh , super = ::kUSBDeviceSpeedSuper , superplus = ::kUSBDeviceSpeedSuperPlus , superplus2 = ::kUSBDeviceSpeedSuperPlusBy2 , usb1 = full , usb2 = high , usb3 = super , usb31 = super , usb32 = superplus , usb32x2 = superplus2 , low = ::UsbLowSpeed , full = ::UsbFullSpeed , high = ::UsbHighSpeed , super = ::UsbSuperSpeed , superplus = 4 , superplus2 = 5 , usb1 = full , usb2 = high , usb3 = super , usb31 = super , usb32 = superplus , usb32x2 = superplus2 } |
USB speed. More... | |
enum class | speed : uint8_t { low = ::kUSBDeviceSpeedLow , full = ::kUSBDeviceSpeedFull , high = ::kUSBDeviceSpeedHigh , super = ::kUSBDeviceSpeedSuper , superplus = ::kUSBDeviceSpeedSuperPlus , superplus2 = ::kUSBDeviceSpeedSuperPlusBy2 , usb1 = full , usb2 = high , usb3 = super , usb31 = super , usb32 = superplus , usb32x2 = superplus2 , low = ::UsbLowSpeed , full = ::UsbFullSpeed , high = ::UsbHighSpeed , super = ::UsbSuperSpeed , superplus = 4 , superplus2 = 5 , usb1 = full , usb2 = high , usb3 = super , usb31 = super , usb32 = superplus , usb32x2 = superplus2 } |
Public Member Functions | |
device & | close () noexcept |
device & | close (bool force=false) noexcept |
virtual void | conclude () noexcept |
conclude notification: object will be removed. If you overwrite conclude() you also need to overwrite destructor and check if its needed to be called from there. | |
void | conclude () noexcept override |
conclude notification: object will be removed. If you overwrite conclude() you also need to overwrite destructor and check if its needed to be called from there. | |
uint8_t | configurations () const |
auto | count () const noexcept |
auto | count () const noexcept |
void | ctl (uint32_t ioctl) const |
void | ctl (unsigned int ioctl) const |
dx_catchall_rethrow () device &open() | |
for macOS compatibility only | |
dx_catchall_rethrow () template< typename data_t >device &submit(const request< data_t > &request) const try | |
standard device request | |
dx_catchall_rethrow () unsigned char configurations() const noexcept | |
dx_catchall_rethrow (, "name: %s, access rights: %x, sharing options:%x", name, access, share) | |
dx_catchall_rethrow (if(autoclear) try {const_cast< device * >(this) ->clear();} dx_catchall(), "handle: %p size: %lld request: %x idx: %x value: %x length: %x", winusb.handle, sizeof(request), request.control::request, request.index, request.value, request.length) template< typename data_t | |
dx_catchall_rethrow (try {if(exception.error==stalled) const_cast< device * >(this) ->clear();} dx_catchall_handler(this,), "request type:%x [recipient:%d type:%x direction:%x] request:%x value:%x index:%x length:%d", reinterpret_cast< const uint8_t & >(request), request.recipient, request.type, request.direction, request.control::request, request.value, request.index, request.length) template< typename data_t >data_t submit(const control &control) const | |
device control request | |
virtual uint64_t | frame () const try |
uint64_t | frame () const try |
::CFTypeRef | get (::CFStringRef key) const |
template<typename value_t , typename = cf::enable_if_convertible<value_t>> | |
value_t | get (::CFStringRef key) const |
::CFTypeRef | get (::CFStringRef key, ::CFTypeRef dflt) const noexcept |
template<typename value_t , typename = cf::enable_if_convertible<value_t>> | |
value_t | get (::CFStringRef key, ::CFTypeRef dflt) const noexcept |
template<typename value_t , typename = cf::enable_if_convertible<value_t>> | |
value_t | get (::CFStringRef key, value_t dflt) const noexcept |
template<typename value_t , typename = cf::enable_if_convertible<value_t>> | |
value_t | get (::CFStringRef key, value_t dflt) const noexcept |
template<typename key_t , typename = cf::enable_if_convertible<key_t>> | |
::CFTypeRef | get (key_t key) const |
template<typename key_t , typename value_t , typename = cf::enable_if_convertible<key_t>, typename = cf::enable_if_convertible<value_t>> | |
value_t | get (key_t key) const |
template<typename rx_t > | |
rx_t | ictl (uint32_t ioctl) const |
member ioctl | |
template<typename rx_t > | |
size_t | ictl (uint32_t ioctl, rx_t &rx) const |
template<typename rx_t > | |
rx_t | ictl (unsigned int ioctl) const |
Windows: member ioctl. | |
template<typename rx_t > | |
size_t | ictl (unsigned int ioctl, rx_t &rx) const |
void | initialize (const char *name, ::DWORD access=GENERIC_READ|GENERIC_WRITE, ::DWORD share=FILE_SHARE_READ|FILE_SHARE_WRITE) try |
(re-)initialization the underlaying windows API is CreateFile(). for detailed information see http://msdn.microsoft.com/en-us/library/aa363858(VS.85).aspx | |
template<typename rx_t , typename tx_t > | |
rx_t | ioctl (uint32_t ioctl, const tx_t &tx) const |
template<typename rx_t , typename tx_t > | |
size_t | ioctl (uint32_t ioctl, const tx_t &tx, rx_t &rx) const |
size_t | ioctl (uint32_t ioctl, const void *tx=nullptr, size_t tx_size=0, void *rx=nullptr, size_t rx_size=0) const |
template<typename rx_t , typename tx_t > | |
rx_t | ioctl (unsigned int ioctl, const tx_t &tx) const |
template<typename tx_t , typename rx_t > | |
size_t | ioctl (unsigned int ioctl, const tx_t &tx, rx_t &rx) const |
virtual void | launch () |
launch notification: object mounted and ready to use | |
template<typename tx_t > | |
void | octl (uint32_t ioctl, const tx_t &tx) const |
template<typename tx_t > | |
void | octl (unsigned int ioctl, const tx_t &tx) const |
device & | open () |
opens the USB device for exclusice access | |
operator const ::io_registry_entry_t & () const noexcept | |
auto converter into const io_object | |
operator const ::io_registry_entry_t & () const noexcept | |
auto converter into const io_object | |
operator uint64_t () const | |
operator uint64_t () const | |
operator::CFMutableDictionaryRef () const | |
operator::CFMutableDictionaryRef () const | |
operator::CFStringRef () const | |
operator::CFStringRef () const | |
operator::io_registry_entry_t & () noexcept | |
auto converter into io_object | |
operator::io_registry_entry_t & () noexcept | |
auto converter into io_object | |
operator::io_registry_entry_t * () noexcept | |
auto converter into io_object pointer | |
operator::io_registry_entry_t * () noexcept | |
auto converter into io_object pointer | |
bool | operator== (::io_registry_entry_t io_object) const noexcept |
bool | operator== (::io_registry_entry_t io_object) const noexcept |
::CFTypeRef | operator[] (::CFStringRef key) const |
::CFTypeRef | operator[] (::CFStringRef key) const |
template<typename key_t , typename = cf::enable_if_convertible<key_t>> | |
::CFTypeRef | operator[] (key_t key) const |
template<typename key_t , typename = cf::enable_if_convertible<key_t>> | |
::CFTypeRef | operator[] (key_t key) const |
device & | reenumerate () |
device & | reset () |
reference & | retain () |
reference & | retain () |
registry & | set (::CFStringRef key, ::CFTypeRef value) |
registry & | set (::CFStringRef key, ::CFTypeRef value) noexcept |
template<typename value_t , typename = cf::enable_if_convertible<value_t>> | |
registry & | set (::CFStringRef key, value_t value) |
template<typename value_t , typename = cf::enable_if_convertible<value_t>> | |
registry & | set (::CFStringRef key, value_t value) |
registry & | set (::CFTypeRef properties) |
Setting properties in a registry entry is not generally supported, it is more common to support setting of properties of the connection based property setting of dx::device. | |
registry & | set (::CFTypeRef properties) |
Setting properties in a registry entry is not generally supported, it is more common to support setting of properties of the connection based property setting of dx::device. | |
template<typename key_t , typename = cf::enable_if_convertible<key_t>> | |
registry & | set (key_t key, ::CFTypeRef value) |
template<typename key_t , typename = cf::enable_if_convertible<key_t>> | |
registry & | set (key_t key, ::CFTypeRef value) |
template<typename key_t , typename value_t , typename = cf::enable_if_convertible<key_t>, typename = cf::enable_if_convertible<value_t>> | |
registry & | set (key_t key, value_t value) |
template<typename key_t , typename value_t , typename = cf::enable_if_convertible<key_t>, typename = cf::enable_if_convertible<value_t>> | |
registry & | set (key_t key, value_t value) |
std::string | string (uint8_t idx) const |
device & | submit (const control &control) const |
template<typename data_t > | |
device & | submit (const request< data_t > &request, bool autoclear=true) const try |
Public Attributes | |
std::map< pid_t, std::string > | clients |
std::map< pid_t, std::string > | clients |
std::map< pid_t, std::string > | clients |
bool | composite = false |
indicate WinUSB matched against single interface of composit device; | |
dx::driver< decltype(id)> & | driver |
dx::driver< decltype(id)> & | driver |
dx::driver< decltype(id)> & | driver |
const std::string | id |
const ::io_service_t | id |
const ::io_service_t | id |
bool | launched {} |
bool | launched {} |
bool | launched {} |
registry | preference |
std::string | puid |
persistent UID - system unique - could change with location | |
std::string | puid |
persistent UID (i.e. serial number) - system unique - if no other option to identify could change with location | |
std::string | puuid |
persistent universal UID - universally unique ID (i.e. serial number) | |
std::string | puuid |
persistent universal UID - universally unique ID | |
enum dx::usb::platform::device::speed | speed |
Protected Types | |
enum class | type : unsigned long { uint32 = REG_DWORD , uint64 = REG_QWORD , string = REG_SZ , vendor = REG_BINARY } |
Protected Member Functions | |
iterator | begin () const |
iterator | end () const |
void | initialize (::IOCFPlugInInterface **cf_interface, ::CFUUIDRef uuid) |
registry & | initialize (const char *path, ::HKEY root, ::REGSAM rights=KEY_ALL_ACCESS, const std::string &key={}) try |
void | initialize (io_object_t io_object, ::CFUUIDRef type, ::CFUUIDRef uuid) |
std::string | key_from_index (uint32_t index) const try |
::IOUSBDeviceInterface650 * | operator-> () const |
operator::IOUSBDeviceInterface650 ** () const | |
Protected Attributes | ||
bool | connected = false | |
struct { | ||
cf::type< const char * > bundle_id | ||
cf::type< const char * > class_name | ||
} | kernel | |
std::atomic< int > | opened {} | |
const char * | path | |
io::port | port | |
const char ::HKEY ::REGSAM | rights | |
const char ::HKEY | root | |
struct { | ||
::WINUSB_INTERFACE_HANDLE handle | ||
} | winusb | |
|
stronginherited |
|
stronginherited |
|
strongprotectedinherited |
|
inlineprotectedinherited |
|
inlinenoexceptinherited |
|
inlinenoexceptinherited |
|
inlinevirtualnoexceptinherited |
conclude notification: object will be removed. If you overwrite conclude() you also need to overwrite destructor and check if its needed to be called from there.
Reimplemented in dx::proxy::stream::_device< desc_t, preference_t, stream_t >, dx::usb::pipe< device_t >, dx::usb::pipe< device_t >, dx::virtuel::stream::_device< desc_t, preference_t, stream_t >, dx::proxy::device, dx::proxy::device, dx::map::driver< device >, and dx::map::driver< device_t >.
|
inlineoverridevirtualnoexceptinherited |
conclude notification: object will be removed. If you overwrite conclude() you also need to overwrite destructor and check if its needed to be called from there.
Reimplemented from dx::object.
Reimplemented in dx::proxy::stream::_device< desc_t, preference_t, stream_t >.
|
inlineinherited |
|
inlinenoexceptinherited |
|
inlinenoexceptinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
for macOS compatibility only
|
inlineinherited |
standard device request
|
inlinenoexceptinherited |
|
inherited |
|
inherited |
|
inlineinherited |
device control request
|
inlineprotectedinherited |
|
inlinevirtualinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlinenoexceptinherited |
|
inlinenoexceptinherited |
|
inlinenoexceptinherited |
|
inlinenoexceptinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
member ioctl
this member retreives data from the device by providing an IOCTL code. the template argument defines the type of data to be retreived. this member is intended as a convinient way to retreive only small amounts of data since there is an intermediate stack copy involved in returning the data.
|
inlineinherited |
|
inlineinherited |
Windows: member ioctl.
this member retreives data from the device by providing an IOCTL code. the template argument defines the type of data to be retreived. this member is intended as a convinient way to retreive only small amounts of data since there is an intermediate stack copy involved in returning the data.
the underlaying windows API is DeviceIoControl(). for detailed information see http://msdn.microsoft.com/en-us/library/aa363216(VS.85).aspx
n/a | microsoft does not give information about what possible errors values are provided by its OS other than |
ERROR_INSUFFICIENT_BUFFER | if the output buffer is too small to receive any data |
|
inlineinherited |
|
inlineprotectedinherited |
|
inlineinherited |
(re-)initialization the underlaying windows API is CreateFile(). for detailed information see http://msdn.microsoft.com/en-us/library/aa363858(VS.85).aspx
n/a | microsoft does not give information about what possible errors values are provided by its OS |
|
inlineprotectedinherited |
|
protectedinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineprotectedinherited |
|
inlinevirtualinherited |
launch notification: object mounted and ready to use
Reimplemented in dx::stream::stream< device< desc_t, dx::preference, pipe >, dx::circular, usb::pipe< device< desc_t, dx::preference, pipe > > >, dx::stream::stream< device_t, dx::circular, usb::pipe< device_t > >, dx::usb::stream::_device< desc_t, preference_t, stream_t >, dx::virtuel::driver< device_t >, dx::map::driver< device >, dx::map::driver< device_t >, dx::proxy::driver< device< pin_t > >, dx::proxy::driver< device< stream_pin_t > >, dx::proxy::driver< device< super_device_t > >, dx::proxy::driver< device_t >, dx::proxy::driver< dx::test::device< super_device_t > >, dx::proxy::driver< dx::test::midi::device< super_device_t > >, dx::proxy::driver< device_t >, dx::proxy::driver< device< pin_t > >, dx::proxy::driver< device< stream_pin_t > >, dx::proxy::driver< device< super_device_t > >, dx::proxy::driver< device_t >, dx::proxy::driver< dx::test::device< super_device_t > >, dx::proxy::driver< dx::test::midi::device< super_device_t > >, and dx::proxy::driver< device_t >.
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
opens the USB device for exclusice access
|
inlinenoexceptinherited |
auto converter into const io_object
|
inlinenoexceptinherited |
auto converter into const io_object
|
inlineexplicitinherited |
|
inlineexplicitinherited |
|
inlineinherited |
|
inlineexplicitinherited |
|
inlineexplicitinherited |
|
inlineexplicitinherited |
|
inlineexplicitinherited |
|
inlinenoexceptinherited |
auto converter into io_object
|
inlinenoexceptinherited |
auto converter into io_object
|
inlinenoexceptinherited |
auto converter into io_object pointer
|
inlinenoexceptinherited |
auto converter into io_object pointer
|
inlineinherited |
|
inlinenoexceptinherited |
|
inlinenoexceptinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlinenoexceptinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
Setting properties in a registry entry is not generally supported, it is more common to support setting of properties of the connection based property setting of dx::device.
|
inlineinherited |
Setting properties in a registry entry is not generally supported, it is more common to support setting of properties of the connection based property setting of dx::device.
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
indicate WinUSB matched against single interface of composit device;
|
protectedinherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
struct { ... } dx::proxy::device::kernel |
|
inherited |
|
inherited |
|
inherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
inherited |
|
inherited |
persistent UID - system unique - could change with location
|
inherited |
persistent UID (i.e. serial number) - system unique - if no other option to identify could change with location
|
inherited |
persistent universal UID - universally unique ID (i.e. serial number)
|
inherited |
persistent universal UID - universally unique ID
|
protectedinherited |
|
protectedinherited |
|
inherited |
struct { ... } dx::usb::platform::device::winusb |
(c) copyright 2009 dynamic acoustics e.U. | generated on Sat Jun 7 2025 |