USB user mode interface namespace. More...

Namespaces
namespace	__

namespace	audio
	generic USB audio 1.0

namespace	isoc

namespace	platform
	platform dependend namespace

namespace	stream
	USB user mode streaming interface namespace.

Classes
struct	__request_type
	standard USB control request definitions More...

struct	control

union	descriptor

class	device

struct	endpoint
	USB specific errors. More...

class	interface

struct	midi
	USB MIDI packetizer. More...

class	pipe

struct	request

struct	request< data_t >

Enumerations
enum	language : uint16_t { standard = english }

Functions
std::ostream &	operator<< (std::ostream &os, const control &control)

std::ostream &	operator<< (std::ostream &os, const decltype(audio::descriptor::endpoint)&endpoint)

std::ostream &	operator<< (std::ostream &os, const decltype(audio::descriptor::interface::control::clock_multiplier)&clock_multiplier)

std::ostream &	operator<< (std::ostream &os, const decltype(audio::descriptor::interface::control::clock_selector1)&clock_selector1)

std::ostream &	operator<< (std::ostream &os, const decltype(audio::descriptor::interface::control::clock_source)&clock_source)

std::ostream &	operator<< (std::ostream &os, const decltype(audio::descriptor::interface::control::effect_unit1)&effect_unit1)

std::ostream &	operator<< (std::ostream &os, const decltype(audio::descriptor::interface::control::extension_unit1)&extension_unit1)

std::ostream &	operator<< (std::ostream &os, const decltype(audio::descriptor::interface::control::feature_unit1)&feature_unit1)

std::ostream &	operator<< (std::ostream &os, const decltype(audio::descriptor::interface::control::processing_unit1)&processing_unit1)

std::ostream &	operator<< (std::ostream &os, const decltype(audio::descriptor::interface::control::samplerate_converter)&samplerate_converter)

std::ostream &	operator<< (std::ostream &os, const decltype(audio::descriptor::interface::control::selector_unit1)&selector_unit1)

std::ostream &	operator<< (std::ostream &os, const decltype(audio::descriptor::interface::control::v1)&control)

std::ostream &	operator<< (std::ostream &os, const decltype(audio::descriptor::interface::control::v2)&control)

std::ostream &	operator<< (std::ostream &os, const decltype(audio::descriptor::interface::midi)&midi)

std::ostream &	operator<< (std::ostream &os, const decltype(audio::descriptor::interface::midi::header)&header)

std::ostream &	operator<< (std::ostream &os, const decltype(audio::descriptor::interface::midi::jack)&jack)

std::ostream &	operator<< (std::ostream &os, const decltype(audio::descriptor::interface::streaming::encoder)&encoder)

std::ostream &	operator<< (std::ostream &os, const decltype(audio::descriptor::interface::streaming::format::ex::type1)&format)

std::ostream &	operator<< (std::ostream &os, const decltype(audio::descriptor::interface::streaming::format::type1::v1)&format)

std::ostream &	operator<< (std::ostream &os, const decltype(audio::descriptor::interface::streaming::format::type1::v2)&format)

std::ostream &	operator<< (std::ostream &os, const decltype(audio::descriptor::interface::streaming::format::type2::v1)&format)

std::ostream &	operator<< (std::ostream &os, const decltype(audio::descriptor::interface::streaming::format::type2::v2)&format)

std::ostream &	operator<< (std::ostream &os, const decltype(audio::descriptor::interface::streaming::format::v1)&format)

std::ostream &	operator<< (std::ostream &os, const decltype(audio::descriptor::interface::streaming::format::v2)&format)

std::ostream &	operator<< (std::ostream &os, const decltype(audio::descriptor::interface::streaming::general::v1)&general)
	usb::audio::descriptor::interface::streaming logging

std::ostream &	operator<< (std::ostream &os, const decltype(audio::descriptor::interface::streaming::general::v2)&general)

std::ostream &	operator<< (std::ostream &os, const decltype(audio::descriptor::interface::streaming::v1)&streaming)

std::ostream &	operator<< (std::ostream &os, const decltype(audio::descriptor::interface::streaming::v2)&streaming)

dx_packed_end std::ostream &	operator<< (std::ostream &os, const decltype(descriptor::device)&device)

std::ostream &	operator<< (std::ostream &os, const decltype(descriptor::endpoint)&endpoint)

std::ostream &	operator<< (std::ostream &os, const decltype(descriptor::interface)&interface)

std::ostream &	operator<< (std::ostream &os, const endpoint &endpoint)

std::ostream &	operator<< (std::ostream &os, const interface &interface)

template<typename data_t >
std::ostream &	operator<< (std::ostream &os, const request< data_t > &request)

std::ostream &	operator<< (std::ostream &os, const struct audio::descriptor::interface::control::header &header)
	usb::audio::descriptor::interface::control logging

std::ostream &	operator<< (std::ostream &os, const struct audio::descriptor::interface::control::input_terminal::v1 &input_terminal)

std::ostream &	operator<< (std::ostream &os, const struct audio::descriptor::interface::control::input_terminal::v2 &input_terminal)

std::ostream &	operator<< (std::ostream &os, const struct audio::descriptor::interface::control::mixer_unit< 1 >::v1 &mixer_unit1)

std::ostream &	operator<< (std::ostream &os, const struct audio::descriptor::interface::control::mixer_unit< 1 >::v2 &mixer_unit1)

std::ostream &	operator<< (std::ostream &os, const struct audio::descriptor::interface::control::output_terminal::v1 &output_terminal)

std::ostream &	operator<< (std::ostream &os, const struct audio::descriptor::interface::control::output_terminal::v2 &output_terminal)

std::ostream &	operator<< (std::ostream &os, enum platform::device::speed speed)

Detailed Description

USB user mode interface namespace.

generic USB user mode interface namespace

Enumeration Type Documentation

◆ language

enum dx::usb::language : uint16_t

Enumerator
standard

Function Documentation

◆ operator<<() [1/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const control &	control )

inline

◆ operator<<() [2/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const decltype(audio::descriptor::endpoint)&	endpoint )

inline

◆ operator<<() [3/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const decltype(audio::descriptor::interface::control::clock_multiplier)&	clock_multiplier )

inline

< D1..0: Clock Frequency Control D3..2: Clock Validity Control; D7..4: Reserved. Must be set to 0.

< Index of a string descriptor, describing the Clock Source Entity.

◆ operator<<() [4/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const decltype(audio::descriptor::interface::control::clock_selector1)&	clock_selector1 )

inline

◆ operator<<() [5/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const decltype(audio::descriptor::interface::control::clock_source)&	clock_source )

inline

< Constant uniquely identifying the Clock Source Entity within the audio function. This value is used in all requests to address this Entity.

< D1..0: Clock Type: 00: External Clock 01: Internal fixed Clock 10: Internal variable Clock Internal programmable Clock 11:; D2: Clock synchronized to SOF D7..3: Must be set to 0.

< D1..0: Clock Frequency Control D3..2: Clock Validity Control; D7..4: Reserved. Must be set to 0.

< Terminal ID of the Terminal that is associated with this Clock Source.

< Index of a string descriptor, describing the Clock Source Entity.

◆ operator<<() [6/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const decltype(audio::descriptor::interface::control::effect_unit1)&	effect_unit1 )

inline

< Constant uniquely identifying the Unit within the audio function. This value is used in all requests to address this Unit.

< Constant identifying the type of effect this Unit is performing.

< ID of the Unit or Terminal to which this Feature Unit is connected.

< The Controls bitmap for master channel 0: D1..0: Mute Control; D3..2: Volume Control; D5..4: Bass Control; D7..6: Mid Control; D9..8: Treble Control; D11..10: Graphic Equalizer Control; D13..12: Automatic Gain Control; D15..14: Delay Control; D17..16: Bass Boost Control; D19..18: Loudness Control; D21..20: Input Gain Control; D23..22: Input Gain Pad Control; D25..24: Phase Inverter Control; D27..26: Underflow Control; D29..28: Overfow Control; D31..30: Reserved. Must be set to 0.

◆ operator<<() [7/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const decltype(audio::descriptor::interface::control::extension_unit1)&	extension_unit1 )

inline

◆ operator<<() [8/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const decltype(audio::descriptor::interface::control::feature_unit1)&	feature_unit1 )

inline

< Constant uniquely identifying the Unit within the audio function. This value is used in all requests to address this Unit.

< ID of the Unit or Terminal to which this Feature Unit is connected.

< The Controls bitmap for master channel 0: D1..0: Mute Control; D3..2: Volume Control; D5..4: Bass Control; D7..6: Mid Control; D9..8: Treble Control; D11..10: Graphic Equalizer Control; D13..12: Automatic Gain Control; D15..14: Delay Control; D17..16: Bass Boost Control; D19..18: Loudness Control; D21..20: Input Gain Control; D23..22: Input Gain Pad Control; D25..24: Phase Inverter Control; D27..26: Underflow Control; D29..28: Overfow Control; D31..30: Reserved. Must be set to 0.

◆ operator<<() [9/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const decltype(audio::descriptor::interface::control::processing_unit1)&	processing_unit1 )

inline

◆ operator<<() [10/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const decltype(audio::descriptor::interface::control::samplerate_converter)&	samplerate_converter )

inline

◆ operator<<() [11/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const decltype(audio::descriptor::interface::control::selector_unit1)&	selector_unit1 )

inline

< Constant uniquely identifying the Unit within the audio function. This value is used in all requests to address this Unit.

< Number of Input Pins of this Unit: p

< ID of the Unit or Terminal to which the n-th Input Pin of this Mixer Unit is connected.

< D1..0: Cluster Control; D3..2: Underflow Control; D5..4: Overflow Control; D7..6: Reserved. Must be set to 0.

< Index of a string descriptor, describing the Mixer Unit.

◆ operator<<() [12/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const decltype(audio::descriptor::interface::control::v1)&	control )

inline

◆ operator<<() [13/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const decltype(audio::descriptor::interface::control::v2)&	control )

inline

◆ operator<<() [14/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const decltype(audio::descriptor::interface::midi)&	midi )

inline

◆ operator<<() [15/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const decltype(audio::descriptor::interface::midi::header)&	header )

inline

< Revision of this class specification.

< Total size of class-specific descriptors.

◆ operator<<() [16/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const decltype(audio::descriptor::interface::midi::jack)&	jack )

inline

< EMBEDDED or EXTERNAL

< Constant uniquely identifying the MIDI IN/OUT Jack within the USB-MIDI function.

< Index of a string descriptor, describing the encoder.

< Number of Input Pins of this MIDI OUT Jack: p

< ID of the Entity to which the n-th Input Pin of this MIDI OUT Jack is connected.

< Output Pin number of the Entity to which the n-th Input Pin of this MIDI OUT Jack is connected.

< Index of a string descriptor, describing the MIDI OUT Jack.

◆ operator<<() [17/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const decltype(audio::descriptor::interface::streaming::encoder)&	encoder )

inline

< Constant uniquely identifying the encoder within the interface. This value is used in all requests to address this encoder.

< Constant identifying the encoder. See Appendix A.15, “Encoder Type Codes.”

< D1..0: Bit Rate Control; D3..2: Quality Control; D5..4: VBR Control; D7..6: Type Control; D9..8: Underflow Control; D11..10: Overflow Control; D13..12: Encoder Error Control; D15..14: Param1 Control; D17..16: Param2 Control; D19..18: Param3 Control; D21..20: Param4 Control; D23..22: Param5 Control; D25..24: Param6 Control; D27..26: Param7 Control; D29..28: Param8 Control; D31..30: Reserved. Must be set to 0.

< Index of a string descriptor, describing the encoder.

◆ operator<<() [18/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const decltype(audio::descriptor::interface::streaming::format::ex::type1)&	format )

inline

< Size of the Packet Header, in bytes.

< Size of the Control Channel Words, in bytes.

< Constant, identifying the Side Band Protocol used for the Packet Header and Control Channel content.

◆ operator<<() [19/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const decltype(audio::descriptor::interface::streaming::format::type1::v1)&	format )

inline

< Number of physical channels in the AS Interface audio channel cluster.

< The number of bytes per audio subframe.

< The number of effectively used bits from the available bits in an audio subslot.

< The number of sampling frequencies supported.

< Sampling frequency ns in Hz for this isochronous data endpoint. Lower/Upper bound in Hz of the sampling frequency range or array of discrete sampling frequencies for this isochronous data endpoint.

◆ operator<<() [20/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const decltype(audio::descriptor::interface::streaming::format::type1::v2)&	format )

inline

< The number of bytes occupied by one audio subslot. Can be 1, 2, 3 or 4.

< The number of effectively used bits from the available bits in an audio subslot.

◆ operator<<() [21/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const decltype(audio::descriptor::interface::streaming::format::type2::v1)&	format )

inline

< Indicates the maximum number of bits per second this interface can handle. Expressed in kbits/s.

< Indicates the number of PCM audio samples contained in one encoded audio frame.

< The number of sampling frequencies supported.

< Sampling frequency ns in Hz for this isochronous data endpoint. Lower/Upper bound in Hz of the sampling frequency range or array of discrete sampling frequencies for this isochronous data endpoint.

◆ operator<<() [22/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const decltype(audio::descriptor::interface::streaming::format::type2::v2)&	format )

inline

< Indicates the maximum number of bits per second this interface can handle. Expressed in kbits/s.

< Indicates the number of PCM audio slots contained in one encoded audio frame.

◆ operator<<() [23/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const decltype(audio::descriptor::interface::streaming::format::v1)&	format )

inline

< FORMAT_TYPE_I. Constant identifying the Format Type the AudioStreaming interface is using.

◆ operator<<() [24/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const decltype(audio::descriptor::interface::streaming::format::v2)&	format )

inline

< FORMAT_TYPE_I. Constant identifying the Format Type the AudioStreaming interface is using.

◆ operator<<() [25/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const decltype(audio::descriptor::interface::streaming::general::v1)&	general )

inline

usb::audio::descriptor::interface::streaming logging

< The Terminal ID of the Terminal to which this interface is connected.

< Delay (δ) introduced by the data path (see Section 3.4, “Inter Channel Synchronization”). Expressed in number of frames.

< The Audio Data Format that has to be used to communicate with this interface.

◆ operator<<() [26/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const decltype(audio::descriptor::interface::streaming::general::v2)&	general )

inline

< The Terminal ID of the Terminal to which this interface is connected.

< D1..0: Active Alternate Setting Control; D3..2: Valid Alternate Settings Control; D7..4: Reserved. Must be set to 0.

< Constant identifying the Format Type the AudioStreaming interface is using.

< The Audio Data Format(s) that can be used to communicate with this interface. See the USB Audio Data Formats document for further details.

< Number of physical channels in the AS Interface audio channel cluster.

< Describes the spatial location of the physical channels.

< Index of a string descriptor, describing the name of the first physical channel.

◆ operator<<() [27/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const decltype(audio::descriptor::interface::streaming::v1)&	streaming )

inline

◆ operator<<() [28/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const decltype(audio::descriptor::interface::streaming::v2)&	streaming )

inline

◆ operator<<() [29/42]

dx_packed_end std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const decltype(descriptor::device)&	device )

inline

◆ operator<<() [30/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const decltype(descriptor::endpoint)&	endpoint )

inline

◆ operator<<() [31/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const decltype(descriptor::interface)&	interface )

inline

◆ operator<<() [32/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const endpoint &	endpoint )

inline

◆ operator<<() [33/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const interface &	interface )

inline

◆ operator<<() [34/42]

template<typename data_t >

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const request< data_t > &	request )

inline

◆ operator<<() [35/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const struct audio::descriptor::interface::control::header &	header )

inline

usb::audio::descriptor::interface::control logging

< BCD: Audio Device Class Specification Release Number in Binary-Coded Decimal.

< Constant, indicating the primary use of this audio function, as intended by the manufacturer. See Appendix A.7, “Audio Function Category Codes.”

< Total number of bytes returned for the class-specific AudioControl interface descriptor. Includes the combined length of this descriptor header and all Clock Source, Unit and Terminal descriptors.

< D1..0: Latency Control; D7..2: Reserved. Must be set to 0.

◆ operator<<() [36/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const struct audio::descriptor::interface::control::input_terminal::v1 &	input_terminal )

inline

< Constant uniquely identifying the Terminal within the audio function. This value is used in all requests to address this Terminal.

< Constant characterizing the type of Terminal. See USB Audio Terminal Types.

< ID of the Output Terminal to which this Input Terminal is associated.

< Number of logical output channels in the Terminal’s output audio channel cluster.

< Describes the spatial location of the logical channels.

< Index of a string descriptor, describing the name of the first logical channel.

< Index of a string descriptor, describing the Input Terminal.

◆ operator<<() [37/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const struct audio::descriptor::interface::control::input_terminal::v2 &	input_terminal )

inline

< Constant uniquely identifying the Terminal within the audio function. This value is used in all requests to address this Terminal.

< Constant characterizing the type of Terminal. See USB Audio Terminal Types.

< ID of the Output Terminal to which this Input Terminal is associated.

< ID of the Clock Entity to which this Input Terminal is connected.

< Number of logical output channels in the Terminal’s output audio channel cluster.

< Describes the spatial location of the logical channels.

< Index of a string descriptor, describing the name of the first logical channel.

< D1..0: Copy Protect Control D3..2: Connector Control D5..4: Overload Control D7..6: Cluster Control D9..8: Underflow Control D11..10: Overflow Control D15..12: Reserved. Must be set to 0.

< Index of a string descriptor, describing the Input Terminal.

◆ operator<<() [38/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const struct audio::descriptor::interface::control::mixer_unit< 1 >::v1 &	mixer_unit1 )

inline

< Constant uniquely identifying the Unit within the audio function. This value is used in all requests to address this Unit.

< Number of Input Pins of this Unit: p

< ID of the Unit or Terminal to which the n-th Input Pin of this Mixer Unit is connected.

< Number of logical output channels in the Mixer’s output audio channel cluster.

< Describes the spatial location of the logical channels.

< Index of a string descriptor, describing the name of the first logical channel.

< Bit map indicating which Mixer Controls are programmable.

< Index of a string descriptor, describing the Mixer Unit.

◆ operator<<() [39/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const struct audio::descriptor::interface::control::mixer_unit< 1 >::v2 &	mixer_unit1 )

inline

< Constant uniquely identifying the Unit within the audio function. This value is used in all requests to address this Unit.

< Number of Input Pins of this Unit: p

< ID of the Unit or Terminal to which the n-th Input Pin of this Mixer Unit is connected.

< Number of logical output channels in the Mixer’s output audio channel cluster.

< Describes the spatial location of the logical channels.

< Index of a string descriptor, describing the name of the first logical channel.

< Bit map indicating which Mixer Controls are programmable.

<

< Index of a string descriptor, describing the Mixer Unit.

◆ operator<<() [40/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const struct audio::descriptor::interface::control::output_terminal::v1 &	output_terminal )

inline

< Constant uniquely identifying the Terminal within the audio function. This value is used in all requests to address this Terminal.

< Constant characterizing the type of Terminal. See USB Audio Terminal Types.

< ID of the Output Terminal to which this Input Terminal is associated.

< ID of the Unit or Terminal to which this Terminal is connected.

< Index of a string descriptor, describing the Input Terminal.

◆ operator<<() [41/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		const struct audio::descriptor::interface::control::output_terminal::v2 &	output_terminal )

inline

< Constant uniquely identifying the Terminal within the audio function. This value is used in all requests to address this Terminal.

< Constant characterizing the type of Terminal. See USB Audio Terminal Types.

< ID of the Output Terminal to which this Input Terminal is associated.

< ID of the Unit or Terminal to which this Terminal is connected.

< ID of the Clock Entity to which this Input Terminal is connected.

< D1..0: Copy Protect Control D3..2: Connector Control D5..4: Overload Control D7..6: Cluster Control D9..8: Underflow Control D11..10: Overflow Control D15..12: Reserved. Must be set to 0.

< Index of a string descriptor, describing the Input Terminal.

◆ operator<<() [42/42]

std::ostream & dx::usb::operator<<	(	std::ostream &	os,
		enum platform::device::speed	speed )

inline

Namespaces

Classes

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ language

Function Documentation

◆ operator<<() [1/42]

◆ operator<<() [2/42]

◆ operator<<() [3/42]

◆ operator<<() [4/42]

◆ operator<<() [5/42]

◆ operator<<() [6/42]

◆ operator<<() [7/42]

◆ operator<<() [8/42]

◆ operator<<() [9/42]

◆ operator<<() [10/42]

◆ operator<<() [11/42]

◆ operator<<() [12/42]

◆ operator<<() [13/42]

◆ operator<<() [14/42]

◆ operator<<() [15/42]

◆ operator<<() [16/42]

◆ operator<<() [17/42]

◆ operator<<() [18/42]

◆ operator<<() [19/42]

◆ operator<<() [20/42]

◆ operator<<() [21/42]

◆ operator<<() [22/42]

◆ operator<<() [23/42]

◆ operator<<() [24/42]

◆ operator<<() [25/42]

◆ operator<<() [26/42]

◆ operator<<() [27/42]

◆ operator<<() [28/42]

◆ operator<<() [29/42]

◆ operator<<() [30/42]

◆ operator<<() [31/42]

◆ operator<<() [32/42]

◆ operator<<() [33/42]

◆ operator<<() [34/42]

◆ operator<<() [35/42]

◆ operator<<() [36/42]

◆ operator<<() [37/42]

◆ operator<<() [38/42]

◆ operator<<() [39/42]

◆ operator<<() [40/42]

◆ operator<<() [41/42]

◆ operator<<() [42/42]