dxd - dynax driver framework 2.5.0d148
cross platform open source driver development framework
Loading...
Searching...
No Matches
dx::usb::stream::_device< desc_t, preference_t, stream_t > Class Template Reference

#include <dx_usb_stream_device.h>

+ Inheritance diagram for dx::usb::stream::_device< desc_t, preference_t, stream_t >:
+ Collaboration diagram for dx::usb::stream::_device< desc_t, preference_t, stream_t >:

Public Types

typedef desc_t desc_t
 
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

template<typename driver_t >
 _device (driver_t &driver, decltype(super::id)&id, const desc_t &desc={})
 
deviceclose () noexcept
 
deviceclose (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 notifacation: device will be removed from tree
 
uint8_t configurations () const
 
virtual void configure ()
 
auto count () const noexcept
 
auto count () const noexcept
 
void ctl (uint32_t ioctl) const try
 
void ctl (unsigned int ioctl) const
 
 dx_catchall_handler (this,) void conclude() noexcept override
 
 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
 
 dx_pass (::IOConnectCallStructMethod(io_connect, ioctl, nullptr, 0, &rx, &size), "%s rx:%p size:%d", fourchar::to::string(ioctl).c_str(), &rx, size)
 
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
 
virtual void hw_clock (dx::event< user > &hw_clock)
 
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 info (std::ostream &os) noexcept override
 log object class information
 
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 (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
 
void launch () override
 launch notification: object mounted and ready to use
 
template<typename tx_t >
void octl (unsigned int ioctl, const tx_t &tx) const
 
deviceopen ()
 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
 
devicereenumerate ()
 
devicereset ()
 
referenceretain ()
 
referenceretain ()
 
registryset (::CFStringRef key, ::CFTypeRef value)
 
registryset (::CFStringRef key, ::CFTypeRef value) noexcept
 
template<typename value_t , typename = cf::enable_if_convertible<value_t>>
registryset (::CFStringRef key, value_t value)
 
template<typename value_t , typename = cf::enable_if_convertible<value_t>>
registryset (::CFStringRef key, value_t value)
 
registryset (::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.
 
registryset (::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>>
registryset (key_t key, ::CFTypeRef value)
 
template<typename key_t , typename = cf::enable_if_convertible<key_t>>
registryset (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>>
registryset (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>>
registryset (key_t key, value_t value)
 
virtual bool start (uint64_t=0, unsigned int starting=1)
 
virtual unsigned int stop (bool force=false) noexcept
 
devicesubmit (const control &control) const
 
template<typename data_t >
devicesubmit (const request< data_t > &request, bool autoclear=true) const try
 

Public Attributes

union { 
 
   struct { 
 
      struct { 
 
         struct { 
 
            uint8_t   id 
 
         }   selector 
 
         struct { 
 
            uint8_t   id 
 
         }   source 
 
      }   clock 
 
   }   v2 
 
adc 
 
uint16_t bcdADC = 0
 
promoted< uint32_t >::preference< preference_t > clocksource
 
bool composite = false
 indicate WinUSB matched against single interface of composit device;
 
std::atomic< size_t > counter
 
dx::driver< decltype(id)> & driver
 
dx::driver< decltype(id)> & driver
 
dx::driver< decltype(id)> & driver
 
struct { 
 
   dx::event< user > *   clock 
 
   std::atomic< size_t >   counter 
 
   uint32_t   iosize 
 
hw 
 
std::weak_ptr< dx::circularimplicit_feedback
 
uint32_t iosize
 
promoted< uint32_t >::preference< preference_t > iosize
 
bool launched {}
 
bool launched {}
 
bool launched {}
 
dx::stream::device::monitor monitor
 
std::deque< std::function< void(control &)> notify )
 
preference_t 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
 
promoted< uint32_t >::preference< preference_t > safety_offset [direction::directions]
 
return size
 
enum dx::usb::platform::device::speed speed
 
std::atomic< unsigned int > started
 
std::map< decltype(_desc_t::stream::target.idx()), std::weak_ptr< stream_t > > streams
 
promoted< uint32_t >::preference< preference_t > sync_cycle_ticks
 
promoted< uint32_t >::preference< preference_t > sync_reference
 
rx_t &rx const try
 
dx::stream::device::monitor version
 

Protected Types

enum class  type : ::DWORD {
  undefined = REG_NONE , uint32 = REG_DWORD , uint64 = REG_QWORD , string = REG_SZ ,
  vendor = REG_BINARY
}
 

Protected Member Functions

dx_catchall_rethrow() class iterator iterator begin () const
 
iterator end () const
 
registryerase (const char *subkey=nullptr) try
 
virtual void flush ()
 
virtual void halt ()
 
void initialize (::IOCFPlugInInterface **cf_interface, ::CFUUIDRef uuid)
 
registryinitialize (const std::string &key, ::HKEY root=HKEY_CURRENT_USER, ::REGSAM rights=KEY_ALL_ACCESS) try
 
registryinitialize (const std::string &key, ::REGSAM rights, ::HKEY root, const char *path=nullptr) try
 
void initialize (io_object_t io_object, ::CFUUIDRef type, ::CFUUIDRef uuid)
 
std::string key_from_index (size_t index) const try
 
dx_catchall_rethrow() registry &initializeoperator keys () const noexcept
 
::IOUSBDeviceInterface650 * operator-> () const
 
 operator::IOUSBDeviceInterface650 ** () const
 

Protected Attributes

struct { 
 
   struct { 
 
      bool   initialized 
 
      uint32_t   value 
 
   }   samplerate 
 
cache 
 
bool connected = false
 
struct { 
 
   cf::type< const char * >   bundle_id 
 
   cf::type< const char * >   class_name 
 
kernel 
 
std::atomic< int > opened {}
 
io::port port
 
decltype(super::samplerate) ::chain samplerate_server
 
std::recursive_mutex start_stop_in_progress
 start/stop operation in progress
 
struct { 
 
   ::WINUSB_INTERFACE_HANDLE   handle 
 
winusb 
 

Member Typedef Documentation

◆ desc_t

typedef desc_t dx::stream::device< dx::stream::control< usb::device > , desc_t , preference_t, stream_t >::desc_t
inherited

Member Enumeration Documentation

◆ speed [1/2]

USB speed.

Enumerator
low 
full 
high 
super 

SuperSpeed (Gen 1) 5Gbps device.

superplus 

SuperSpeed Plus (Gen 2) 10Gbps device.

superplus2 

SuperSpeed Plus (Gen 2 X 2) 20Gbps device

usb1 
usb2 
usb3 
usb31 
usb32 
usb32x2 
low 
full 
high 
super 
superplus 
superplus2 
usb1 
usb2 
usb3 
usb31 
usb32 
usb32x2 

◆ speed [2/2]

Enumerator
low 
full 
high 
super 

SuperSpeed (Gen 1) 5Gbps device.

superplus 

SuperSpeed Plus (Gen 2) 10Gbps device.

superplus2 

SuperSpeed Plus (Gen 2 X 2) 20Gbps device

usb1 
usb2 
usb3 
usb31 
usb32 
usb32x2 
low 
full 
high 
super 
superplus 
superplus2 
usb1 
usb2 
usb3 
usb31 
usb32 
usb32x2 

◆ type

enum class dx::registry::type : ::DWORD
strongprotectedinherited
Enumerator
undefined 
uint32 
uint64 
string 
vendor 

Constructor & Destructor Documentation

◆ _device()

template<typename desc_t , typename preference_t , typename stream_t >
template<typename driver_t >
dx::usb::stream::_device< desc_t, preference_t, stream_t >::_device ( driver_t & driver,
decltype(super::id)& id,
const desc_t & desc = {} )
inline

Member Function Documentation

◆ begin()

dx_catchall_rethrow() class iterator iterator dx::registry::begin ( ) const
inlineprotectedinherited

◆ close() [1/2]

device & dx::usb::platform::device::close ( )
inlinenoexceptinherited

◆ close() [2/2]

device & dx::usb::platform::device::close ( bool force = false)
inlinenoexceptinherited

◆ conclude() [1/2]

virtual void dx::object::conclude ( )
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::map::driver< device >, and dx::map::driver< device_t >.

+ Here is the caller graph for this function:

◆ conclude() [2/2]

void dx::proxy::device::conclude ( )
inlineoverridevirtualnoexceptinherited

conclude notifacation: device will be removed from tree

Reimplemented from dx::object.

Reimplemented in dx::proxy::stream::_device< desc_t, preference_t, stream_t >.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ configurations()

uint8_t dx::usb::platform::device::configurations ( ) const
inlineinherited

◆ configure()

template<typename desc_t , typename preference_t , typename stream_t >
virtual void dx::usb::stream::_device< desc_t, preference_t, stream_t >::configure ( )
inlinevirtual
Todo
usb::stream::device::configure(): support odd sample rate ranges
+ Here is the call graph for this function:

◆ count() [1/2]

auto io::reference< ::io_registry_entry_t >::count ( ) const
inlinenoexceptinherited

◆ count() [2/2]

auto io::reference< ::io_registry_entry_t >::count ( ) const
inlinenoexceptinherited

◆ ctl() [1/2]

void dx::proxy::device::ctl ( uint32_t ioctl) const
inlineinherited
+ Here is the call graph for this function:

◆ ctl() [2/2]

void dx::proxy::device::ctl ( unsigned int ioctl) const
inlineinherited

◆ dx_catchall_handler()

dx::stream::control< usb::device >::dx_catchall_handler ( this )
inlineoverridenoexceptinherited

◆ dx_catchall_rethrow() [1/6]

dx::usb::platform::device::dx_catchall_rethrow ( ) &
inlineinherited

for macOS compatibility only

◆ dx_catchall_rethrow() [2/6]

dx::usb::platform::device::dx_catchall_rethrow ( ) const &
inlineinherited

standard device request

◆ dx_catchall_rethrow() [3/6]

dx::usb::platform::device::dx_catchall_rethrow ( ) const
inlinenoexceptinherited

◆ dx_catchall_rethrow() [4/6]

dx::file::dx_catchall_rethrow ( "name: % s,
access rights:% x,
sharing options:%x" ,
name ,
access ,
share  )
inherited

◆ dx_catchall_rethrow() [5/6]

dx::usb::platform::device::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 )
inherited

◆ dx_catchall_rethrow() [6/6]

dx::usb::platform::device::dx_catchall_rethrow ( try { ifexception.error==stalled) const_cast< device * >(this) ->clear();} dx_catchall_handler(this,,
"request type:%x request:%x value:%x index:%x length:%d" [recipient:%d type:%x direction:%x],
reinterpret_cast< const uint8_t & > request,
request. recipient,
request. type,
request. direction,
request.control::request ,
request. value,
request. index,
request. length ) const &
inlineinherited

device control request

◆ dx_pass()

dx::proxy::device::dx_pass ( ::IOConnectCallStructMethod(io_connect, ioctl, nullptr, 0, &rx, &size) ,
"%s rx:%p size:%d" ,
fourchar::to::string(ioctl).c_str() ,
& rx,
size  )
inherited

◆ end()

iterator dx::registry::end ( ) const
inlineprotectedinherited

◆ erase()

registry & dx::registry::erase ( const char * subkey = nullptr)
inlineprotectedinherited
Todo
registry::erase(): investigate why it's not working
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ flush()

virtual void dx::stream::control< usb::device >::flush ( )
inlineprotectedvirtualinherited

◆ frame() [1/2]

virtual uint64_t dx::usb::platform::device::frame ( ) const
inlinevirtualinherited
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ frame() [2/2]

uint64_t dx::usb::platform::device::frame ( ) const
inlineinherited
+ Here is the call graph for this function:

◆ get() [1/8]

::CFTypeRef io::registry::get ( ::CFStringRef key) const
inlineinherited
+ Here is the caller graph for this function:

◆ get() [2/8]

template<typename value_t , typename = cf::enable_if_convertible<value_t>>
value_t io::registry::get ( ::CFStringRef key) const
inlineinherited
+ Here is the call graph for this function:

◆ get() [3/8]

::CFTypeRef io::registry::get ( ::CFStringRef key,
::CFTypeRef dflt ) const
inlinenoexceptinherited

◆ get() [4/8]

template<typename value_t , typename = cf::enable_if_convertible<value_t>>
value_t io::registry::get ( ::CFStringRef key,
::CFTypeRef dflt ) const
inlinenoexceptinherited
+ Here is the call graph for this function:

◆ get() [5/8]

template<typename value_t , typename = cf::enable_if_convertible<value_t>>
value_t io::registry::get ( ::CFStringRef key,
value_t dflt ) const
inlinenoexceptinherited
+ Here is the call graph for this function:

◆ get() [6/8]

template<typename value_t , typename = cf::enable_if_convertible<value_t>>
value_t io::registry::get ( ::CFStringRef key,
value_t dflt ) const
inlinenoexceptinherited
+ Here is the call graph for this function:

◆ get() [7/8]

template<typename key_t , typename = cf::enable_if_convertible<key_t>>
::CFTypeRef io::registry::get ( key_t key) const
inlineinherited
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ get() [8/8]

template<typename key_t , typename value_t , typename = cf::enable_if_convertible<key_t>, typename = cf::enable_if_convertible<value_t>>
value_t io::registry::get ( key_t key) const
inlineinherited
+ Here is the call graph for this function:

◆ halt()

virtual void dx::stream::control< usb::device >::halt ( )
inlineprotectedvirtualinherited

◆ hw_clock()

virtual void dx::stream::device< dx::stream::control< usb::device > , desc_t , preference_t, stream_t >::hw_clock ( dx::event< user > & hw_clock)
inlinevirtualinherited

◆ ictl() [1/2]

template<typename rx_t >
rx_t dx::proxy::device::ictl ( unsigned int ioctl) const
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

Exceptions
n/amicrosoft does not give information about what possible errors values are provided by its OS other than
ERROR_INSUFFICIENT_BUFFERif the output buffer is too small to receive any data

◆ ictl() [2/2]

template<typename rx_t >
size_t dx::proxy::device::ictl ( unsigned int ioctl,
rx_t & rx ) const
inlineinherited

◆ info()

template<typename desc_t , typename preference_t , typename stream_t >
void dx::usb::stream::_device< desc_t, preference_t, stream_t >::info ( std::ostream & os)
inlineoverridevirtualnoexcept

◆ initialize() [1/5]

void cf::interface< ::IOUSBDeviceInterface650 >::initialize ( ::IOCFPlugInInterface ** cf_interface,
::CFUUIDRef uuid )
inlineprotectedinherited

◆ initialize() [2/5]

void dx::file::initialize ( const char * name,
::DWORD access = GENERIC_READ| GENERIC_WRITE,
::DWORD share = FILE_SHARE_READ| FILE_SHARE_WRITE )
inlineinherited

(re-)initialization the underlaying windows API is CreateFile(). for detailed information see http://msdn.microsoft.com/en-us/library/aa363858(VS.85).aspx

Exceptions
n/amicrosoft does not give information about what possible errors values are provided by its OS
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ initialize() [3/5]

registry & dx::registry::initialize ( const std::string & key,
::HKEY root = HKEY_CURRENT_USER,
::REGSAM rights = KEY_ALL_ACCESS )
inlineprotectedinherited
+ Here is the call graph for this function:

◆ initialize() [4/5]

registry & dx::registry::initialize ( const std::string & key,
::REGSAM rights,
::HKEY root,
const char * path = nullptr )
inlineprotectedinherited
+ Here is the caller graph for this function:

◆ initialize() [5/5]

void cf::interface< ::IOUSBDeviceInterface650 >::initialize ( io_object_t io_object,
::CFUUIDRef type,
::CFUUIDRef uuid )
protectedinherited

◆ ioctl() [1/2]

template<typename rx_t , typename tx_t >
rx_t dx::proxy::device::ioctl ( unsigned int ioctl,
const tx_t & tx ) const
inlineinherited

◆ ioctl() [2/2]

template<typename tx_t , typename rx_t >
size_t dx::proxy::device::ioctl ( unsigned int ioctl,
const tx_t & tx,
rx_t & rx ) const
inlineinherited
+ Here is the caller graph for this function:

◆ key_from_index()

std::string dx::registry::key_from_index ( size_t index) const
inlineprotectedinherited

◆ launch()

template<typename desc_t , typename preference_t , typename stream_t >
void dx::usb::stream::_device< desc_t, preference_t, stream_t >::launch ( )
inlineoverridevirtual

launch notification: object mounted and ready to use

Reimplemented from dx::object.

◆ octl()

template<typename tx_t >
void dx::proxy::device::octl ( unsigned int ioctl,
const tx_t & tx ) const
inlineinherited
+ Here is the caller graph for this function:

◆ open()

device & dx::usb::platform::device::open ( )
inlineinherited

opens the USB device for exclusice access

+ Here is the caller graph for this function:

◆ operator const ::io_registry_entry_t &() [1/2]

io::reference< ::io_registry_entry_t >::operator const ::io_registry_entry_t & ( ) const
inlinenoexceptinherited

auto converter into const io_object

◆ operator const ::io_registry_entry_t &() [2/2]

io::reference< ::io_registry_entry_t >::operator const ::io_registry_entry_t & ( ) const
inlinenoexceptinherited

auto converter into const io_object

◆ operator keys()

dx_catchall_rethrow() registry &initialize( dx::registry::operator keys ( ) const
inlineprotectednoexceptinherited

◆ operator uint64_t() [1/2]

io::registry::operator uint64_t ( ) const
inlineexplicitinherited

◆ operator uint64_t() [2/2]

io::registry::operator uint64_t ( ) const
inlineexplicitinherited

◆ operator->()

::IOUSBDeviceInterface650 * cf::interface< ::IOUSBDeviceInterface650 >::operator-> ( ) const
inlineinherited

◆ operator::CFMutableDictionaryRef() [1/2]

io::registry::operator::CFMutableDictionaryRef ( ) const
inlineexplicitinherited
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ operator::CFMutableDictionaryRef() [2/2]

io::registry::operator::CFMutableDictionaryRef ( ) const
inlineexplicitinherited
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ operator::CFStringRef() [1/2]

io::registry::operator::CFStringRef ( ) const
inlineexplicitinherited

◆ operator::CFStringRef() [2/2]

io::registry::operator::CFStringRef ( ) const
inlineexplicitinherited

◆ operator::io_registry_entry_t &() [1/2]

io::reference< ::io_registry_entry_t >::operator ::io_registry_entry_t & ( )
inlinenoexceptinherited

auto converter into io_object

◆ operator::io_registry_entry_t &() [2/2]

io::reference< ::io_registry_entry_t >::operator ::io_registry_entry_t & ( )
inlinenoexceptinherited

auto converter into io_object

◆ operator::io_registry_entry_t *() [1/2]

io::reference< ::io_registry_entry_t >::operator ::io_registry_entry_t * ( )
inlinenoexceptinherited

auto converter into io_object pointer

◆ operator::io_registry_entry_t *() [2/2]

io::reference< ::io_registry_entry_t >::operator ::io_registry_entry_t * ( )
inlinenoexceptinherited

auto converter into io_object pointer

◆ operator::IOUSBDeviceInterface650 **()

cf::interface< ::IOUSBDeviceInterface650 >::operator ::IOUSBDeviceInterface650 ** ( ) const
inlineinherited

◆ operator==() [1/2]

bool io::reference< ::io_registry_entry_t >::operator== ( ::io_registry_entry_t io_object) const
inlinenoexceptinherited

◆ operator==() [2/2]

bool io::reference< ::io_registry_entry_t >::operator== ( ::io_registry_entry_t io_object) const
inlinenoexceptinherited

◆ operator[]() [1/4]

::CFTypeRef io::registry::operator[] ( ::CFStringRef key) const
inlineinherited
+ Here is the call graph for this function:

◆ operator[]() [2/4]

::CFTypeRef io::registry::operator[] ( ::CFStringRef key) const
inlineinherited
+ Here is the call graph for this function:

◆ operator[]() [3/4]

template<typename key_t , typename = cf::enable_if_convertible<key_t>>
::CFTypeRef io::registry::operator[] ( key_t key) const
inlineinherited
+ Here is the call graph for this function:

◆ operator[]() [4/4]

template<typename key_t , typename = cf::enable_if_convertible<key_t>>
::CFTypeRef io::registry::operator[] ( key_t key) const
inlineinherited
+ Here is the call graph for this function:

◆ reenumerate()

device & dx::usb::platform::device::reenumerate ( )
inlineinherited
+ Here is the call graph for this function:

◆ reset()

device & dx::usb::platform::device::reset ( )
inlineinherited
+ Here is the call graph for this function:

◆ retain() [1/2]

reference & io::reference< ::io_registry_entry_t >::retain ( )
inlineinherited

◆ retain() [2/2]

reference & io::reference< ::io_registry_entry_t >::retain ( )
inlineinherited

◆ set() [1/10]

registry & io::registry::set ( ::CFStringRef key,
::CFTypeRef value )
inlineinherited

◆ set() [2/10]

registry & dx::proxy::device::set ( ::CFStringRef key,
::CFTypeRef value )
inlinenoexceptinherited

◆ set() [3/10]

template<typename value_t , typename = cf::enable_if_convertible<value_t>>
registry & dx::proxy::device::set ( ::CFStringRef key,
value_t value )
inlineinherited

◆ set() [4/10]

template<typename value_t , typename = cf::enable_if_convertible<value_t>>
registry & io::registry::set ( ::CFStringRef key,
value_t value )
inlineinherited
+ Here is the call graph for this function:

◆ set() [5/10]

registry & dx::proxy::device::set ( ::CFTypeRef properties)
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.

◆ set() [6/10]

registry & io::registry::set ( ::CFTypeRef properties)
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.

+ Here is the caller graph for this function:

◆ set() [7/10]

template<typename key_t , typename = cf::enable_if_convertible<key_t>>
registry & dx::proxy::device::set ( key_t key,
::CFTypeRef value )
inlineinherited

◆ set() [8/10]

template<typename key_t , typename = cf::enable_if_convertible<key_t>>
registry & io::registry::set ( key_t key,
::CFTypeRef value )
inlineinherited
+ Here is the call graph for this function:

◆ set() [9/10]

template<typename key_t , typename value_t , typename = cf::enable_if_convertible<key_t>, typename = cf::enable_if_convertible<value_t>>
registry & dx::proxy::device::set ( key_t key,
value_t value )
inlineinherited

◆ set() [10/10]

template<typename key_t , typename value_t , typename = cf::enable_if_convertible<key_t>, typename = cf::enable_if_convertible<value_t>>
registry & io::registry::set ( key_t key,
value_t value )
inlineinherited
+ Here is the call graph for this function:

◆ start()

virtual bool dx::stream::control< usb::device >::start ( uint64_t = 0,
unsigned int starting = 1 )
inlinevirtualinherited

result indicates if start changed the state.

◆ stop()

virtual unsigned int dx::stream::control< usb::device >::stop ( bool force = false)
inlinevirtualnoexceptinherited

result indicates the amount of stopped start references

◆ submit() [1/2]

device & dx::usb::platform::device::submit ( const control & control) const
inlineinherited
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ submit() [2/2]

template<typename data_t >
device & dx::usb::platform::device::submit ( const request< data_t > & request,
bool autoclear = true ) const
inlineinherited

Member Data Documentation

◆ [union]

union { ... } dx::usb::stream::_device< desc_t, preference_t, stream_t >::adc

◆ bcdADC

template<typename desc_t , typename preference_t , typename stream_t >
uint16_t dx::usb::stream::_device< desc_t, preference_t, stream_t >::bcdADC = 0

◆ bundle_id

cf::type<const char*> dx::proxy::device::bundle_id
inherited

◆ [struct]

struct { ... } dx::usb::stream::_device< desc_t, preference_t, stream_t >::cache

◆ [struct]

struct { ... } dx::usb::stream::_device< desc_t, preference_t, stream_t >::clock

◆ clocksource

promoted<uint32_t>::preference<preference_t> dx::stream::device< dx::stream::control< usb::device > , desc_t , preference_t, stream_t >::clocksource
inherited

◆ composite

bool dx::usb::platform::device::composite = false
inherited

indicate WinUSB matched against single interface of composit device;

◆ connected

bool dx::proxy::device::connected = false
protectedinherited

◆ counter

std::atomic<size_t> dx::stream::device< dx::stream::control< usb::device > , desc_t , preference_t, stream_t >::counter
inherited

◆ driver [1/3]

dx::driver<decltype(id)>& dx::device< std::string >::driver
inherited

◆ driver [2/3]

dx::driver<decltype(id)>& dx::device< ::io_service_t >::driver
inherited

◆ driver [3/3]

dx::driver<decltype(id)>& dx::device< ::io_service_t >::driver
inherited

◆ handle

::WINUSB_INTERFACE_HANDLE dx::usb::platform::device::handle
inherited

◆ [struct]

struct { ... } dx::stream::device< dx::stream::control< usb::device > , desc_t , preference_t, stream_t >::hw

◆ id

template<typename desc_t , typename preference_t , typename stream_t >
uint8_t dx::usb::stream::_device< desc_t, preference_t, stream_t >::id

◆ implicit_feedback

template<typename desc_t , typename preference_t , typename stream_t >
std::weak_ptr<dx::circular> dx::usb::stream::_device< desc_t, preference_t, stream_t >::implicit_feedback

◆ initialized

template<typename desc_t , typename preference_t , typename stream_t >
bool dx::usb::stream::_device< desc_t, preference_t, stream_t >::initialized

◆ iosize [1/2]

uint32_t dx::stream::device< dx::stream::control< usb::device > , desc_t , preference_t, stream_t >::iosize
inherited

◆ iosize [2/2]

promoted<uint32_t>::preference<preference_t> dx::stream::device< dx::stream::control< usb::device > , desc_t , preference_t, stream_t >::iosize
inherited

◆ [struct]

struct { ... } dx::proxy::device::kernel

◆ launched [1/3]

bool dx::object::launched {}
inherited

◆ launched [2/3]

bool dx::object::launched {}
inherited

◆ launched [3/3]

bool dx::object::launched {}
inherited

◆ monitor

dx::stream::device::monitor dx::stream::device< dx::stream::control< usb::device > , desc_t , preference_t, stream_t >::monitor
inherited

◆ notify

std::deque<std::function<void(control&)> dx::stream::control< usb::device >::notify)
inherited

◆ opened

std::atomic< int > dx::usb::platform::device::opened {}
protectedinherited
Todo
add runloop ////////////////////////////////////////////////////////////////////////////

◆ port

io::port dx::proxy::device::port
protectedinherited

◆ preference

preference_t dx::stream::device< dx::stream::control< usb::device > , desc_t , preference_t, stream_t >::preference
inherited

◆ puid [1/2]

std::string dx::device< ::io_service_t >::puid
inherited

persistent UID - system unique - could change with location

◆ puid [2/2]

std::string dx::proxy::device::puid
inherited

persistent UID (i.e. serial number) - system unique - if no other option to identify could change with location

◆ puuid [1/2]

std::string dx::device< ::io_service_t >::puuid
inherited

persistent universal UID - universally unique ID (i.e. serial number)

◆ puuid [2/2]

std::string dx::proxy::device::puuid
inherited

persistent universal UID - universally unique ID

◆ safety_offset

promoted<uint32_t>::preference<preference_t> dx::stream::device< dx::stream::control< usb::device > , desc_t , preference_t, stream_t >::safety_offset[direction::directions]
inherited

◆ [struct]

struct { ... } dx::usb::stream::_device< desc_t, preference_t, stream_t >::samplerate

◆ samplerate_server

template<typename desc_t , typename preference_t , typename stream_t >
decltype(super::samplerate) ::chain dx::usb::stream::_device< desc_t, preference_t, stream_t >::samplerate_server
protected

◆ [struct]

struct { ... } dx::usb::stream::_device< desc_t, preference_t, stream_t >::selector

◆ size

return dx::proxy::device::size
inherited

◆ [struct]

struct { ... } dx::usb::stream::_device< desc_t, preference_t, stream_t >::source

◆ speed

◆ start_stop_in_progress

std::recursive_mutex dx::stream::control< usb::device >::start_stop_in_progress
protectedinherited

start/stop operation in progress

◆ started

std::atomic<unsigned int> dx::stream::control< usb::device >::started
inherited

◆ streams

std::map<decltype(_desc_t::stream::target.idx()), std::weak_ptr<stream_t> > dx::stream::device< dx::stream::control< usb::device > , desc_t , preference_t, stream_t >::streams
inherited

◆ sync_cycle_ticks

promoted<uint32_t>::preference<preference_t> dx::stream::device< dx::stream::control< usb::device > , desc_t , preference_t, stream_t >::sync_cycle_ticks
inherited

◆ sync_reference

promoted<uint32_t>::preference<preference_t> dx::stream::device< dx::stream::control< usb::device > , desc_t , preference_t, stream_t >::sync_reference
inherited

◆ try

rx_t& rx const dx::proxy::device::try
inherited
Initial value:
{
size_t size= sizeof rx
return size
Definition macOS/dx_proxy_device.h:219

◆ [struct]

struct { ... } dx::usb::stream::_device< desc_t, preference_t, stream_t >::v2

◆ value

template<typename desc_t , typename preference_t , typename stream_t >
uint32_t dx::usb::stream::_device< desc_t, preference_t, stream_t >::value

◆ version

dx::stream::device::monitor dx::stream::device< dx::stream::control< usb::device > , desc_t , preference_t, stream_t >::version
inherited

◆ [struct]

struct { ... } dx::usb::platform::device::winusb

The documentation for this class was generated from the following file:

(c) copyright 2009 dynamic acoustics e.U. generated on Fri Aug 22 2025

a closed source license may be obtained by requesting a written permission from dynamic acoustics e.U.
however - governmental use generally and military use especially is strictly prohibited though.