dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::stream Struct Reference

dx::desc::stream interface descriptor More...

#include <dx_stream.h>

Collaboration diagram for dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::stream:

Classes
struct	config
	dx::desc::stream::config interface descriptor More...
struct	pin
	a pin of the stream: the channels a host attaches to as one entity, their format and what they are wired to. A stream's channels may be split into several pins, and a hidden one is not offered to the host More...

Public Types
typedef stream	desc

Public Member Functions
uint32_t	enumerate (const format &format) const
	enumerate typified pins
const struct pin *	find (uint32_t &idx, const format &format=any, const direction::direction &direction=direction::any) const
	find typified pin
	operator const target_t & () const
direction::direction	transport () const
	the transport of the stream's ring - in writes it, out reads it, none where it has none: a directed stream's is its device end, of the stream's direction; a bidirectional one's is the pin marked sync_reference, a host end - an out pin's writes the ring

Public Attributes
struct dx::stream::desc::stream::config	config [max_configurations]
uint32_t	configurations {}
	number of configurations for this stream
uint32_t	group {}
	optional: streaming group id - the streams of one group are always streamed together, by one thread
struct dx::stream::desc::stream::pin	pin [max_pins]
uint32_t	pins {}
uint32_t	selector {}
	bus entity switching the source (USB: selector unit id)
name_id	source [max_sources] {}
	name, id: the bus entity's index of the source (USB: the selector unit's 1-based input pin)
uint32_t	sources {}
	optional: selectable sources of the stream's channels, 0: fixed
target_t	target {}
	hardware interface

Detailed Description

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1, int max_sources = 1>
struct dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::stream

dx::desc::stream interface descriptor

Member Typedef Documentation

desc

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1, int max_sources = 1>

typedef stream dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::stream::desc

Member Function Documentation

enumerate()

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1, int max_sources = 1>

uint32_t dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::stream::enumerate ( const format & format ) const

inline

enumerate typified pins

find()

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1, int max_sources = 1>

const struct pin * dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::stream::find ( uint32_t & idx, const format & format = any, const direction::direction & direction = direction::any ) const

inline

find typified pin

Here is the caller graph for this function:

operator const target_t &()

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1, int max_sources = 1>

dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::stream::operator const target_t & ( ) const

inline

transport()

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1, int max_sources = 1>

direction::direction dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::stream::transport ( ) const

inline

the transport of the stream's ring - in writes it, out reads it, none where it has none: a directed stream's is its device end, of the stream's direction; a bidirectional one's is the pin marked sync_reference, a host end - an out pin's writes the ring

Here is the call graph for this function:

Member Data Documentation

config

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1, int max_sources = 1>

struct dx::stream::desc::stream::config dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::stream::config[max_configurations]

configurations

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1, int max_sources = 1>

uint32_t dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::stream::configurations {}

number of configurations for this stream

group

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1, int max_sources = 1>

uint32_t dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::stream::group {}

optional: streaming group id - the streams of one group are always streamed together, by one thread

pin

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1, int max_sources = 1>

struct dx::stream::desc::stream::pin dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::stream::pin[max_pins]

pins

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1, int max_sources = 1>

uint32_t dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::stream::pins {}

selector

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1, int max_sources = 1>

uint32_t dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::stream::selector {}

bus entity switching the source (USB: selector unit id)

source

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1, int max_sources = 1>

name_id dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::stream::source[max_sources] {}

name, id: the bus entity's index of the source (USB: the selector unit's 1-based input pin)

sources

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1, int max_sources = 1>

uint32_t dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::stream::sources {}

optional: selectable sources of the stream's channels, 0: fixed

target

template<typename target_t = void_struct, int max_streams = 2, int max_pins = 1, int max_clock_settings = 1, int max_clocks = 1, int max_configurations = 1, int max_sources = 1>

target_t dx::stream::desc< target_t, max_streams, max_pins, max_clock_settings, max_clocks, max_configurations, max_sources >::stream::target {}

hardware interface

---

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

• dx_stream.h