SAMV71 Xplained Ultra Software Package 1.5

AUDDescriptors.h File Reference

#include <stdint.h>

Go to the source code of this file.

Data Structures

struct  _AUDStreamingInterfaceDescriptor
struct  _AUDEndpointDescriptor
struct  _AUDDataEndpointDescriptor
struct  _AUDHeaderDescriptor
struct  _AUDInputTerminalDescriptor
struct  _AUDOutputTerminalDescriptor
struct  _AUDFeatureUnitDescriptor
struct  _AUDFormatTypeOneDescriptor

Defines

#define AUDGenericDescriptor_DEVICE   0x21
#define AUDGenericDescriptor_CONFIGURATION   0x22
#define AUDGenericDescriptor_STRING   0x23
#define AUDGenericDescriptor_INTERFACE   0x24
#define AUDGenericDescriptor_ENDPOINT   0x25
#define AUDGenericDescriptor_HEADER   0x01
#define AUDGenericDescriptor_INPUTTERMINAL   0x02
#define AUDGenericDescriptor_OUTPUTTERMINAL   0x03
#define AUDGenericDescriptor_MIXERUNIT   0x04
#define AUDGenericDescriptor_SELECTORUNIT   0x05
#define AUDGenericDescriptor_FEATUREUNIT   0x06
#define AUDGenericDescriptor_PROCESSINGUNIT   0x07
#define AUDGenericDescriptor_EXTENSIONUNIT   0x08
#define AUDDeviceDescriptor_CLASS   0x00
#define AUDDeviceDescriptor_SUBCLASS   0x00
#define AUDDeviceDescriptor_PROTOCOL   0x00
#define AUDStreamingInterfaceDescriptor_CLASS   0x01
#define AUDStreamingInterfaceDescriptor_SUBCLASS   0x02
#define AUDStreamingInterfaceDescriptor_PROTOCOL   0x00
#define AUDStreamingInterfaceDescriptor_GENERAL   0x01
#define AUDStreamingInterfaceDescriptor_FORMATTYPE   0x02
#define AUDStreamingInterfaceDescriptor_FORMATSPECIFIC   0x03
#define AUDControlInterfaceDescriptor_CLASS   0x01
#define AUDControlInterfaceDescriptor_SUBCLASS   0x01
#define AUDControlInterfaceDescriptor_PROTOCOL   0x00
#define AUDDataEndpointDescriptor_SUBTYPE   0x01
#define AUDDataEndpointDescriptor_MILLISECONDS   1
#define AUDDataEndpointDescriptor_PCMSAMPLES   2
#define AUDHeaderDescriptor_AUD1_00   0x0100
#define AUDTerminalDescriptor_USBSTREAMING   0x0101
#define AUDTerminalDescriptor_MICROPHONE   0x0201
#define AUDTerminalDescriptor_HANDSETIN   0x0401
#define AUDTerminalDescriptor_SPEAKERPHONE   0x0403
#define AUDTerminalDescriptor_LINEIN   0x0501
#define AUDInputTerminalDescriptor_USBSTREAMING   0x0101
#define AUDInputTerminalDescriptor_MICROPHONE   0x0201
#define AUDInputTerminalDescriptor_HANDSETIN   0x0401
#define AUDInputTerminalDescriptor_SPEAKERPHONE   0x0403
#define AUDInputTerminalDescriptor_LINEIN   0x0501
#define AUDInputTerminalDescriptor_LEFTFRONT   (1 << 0)
#define AUDInputTerminalDescriptor_RIGHTFRONT   (1 << 1)
#define AUDInputTerminalDescriptor_CENTERFRONT   (1 << 2)
#define AUDOutputTerminalDescriptor_USBTREAMING   0x0101
#define AUDOutputTerminalDescriptor_SPEAKER   0x0301
#define AUDOutputTerminalDescriptor_HANDSETOUT   0x0401
#define AUDOutputTerminalDescriptor_LINEOUT   0x0501
#define AUDFeatureUnitDescriptor_MUTE   (1 << 0)
#define AUDFeatureUnitDescriptor_VOLUME   (1 << 1)
#define AUDFeatureUnitDescriptor_BASS   (1 << 2)
#define AUDFeatureUnitDescriptor_MID   (1 << 3)
#define AUDFeatureUnitDescriptor_TREBLE   (1 << 4)
#define AUDFormatTypeOneDescriptor_FORMATTYPEONE   0x01
#define AUDFormatTypeOneDescriptor_PCM   0x0001
#define AUDFormatTypeOneDescriptor_CONTINUOUS   0

Functions

struct
_AUDStreamingInterfaceDescriptor 
__attribute__ ((__packed__)) AUDStreamingInterfaceDescriptor

Variables

uint8_t bLength
uint8_t bDescriptorType
uint8_t bDescriptorSubType
uint8_t bTerminalLink
uint8_t bDelay
uint16_t wFormatTag
uint8_t bEndpointAddress
uint8_t bmAttributes
uint16_t wMaxPacketSize
uint8_t bInterval
uint8_t bRefresh
uint8_t bSyncAddress
uint8_t bLockDelayUnits
uint16_t wLockDelay
uint16_t bcdADC
uint16_t wTotalLength
uint8_t bInCollection
uint8_t bTerminalID
uint16_t wTerminalType
uint8_t bAssocTerminal
uint8_t bNrChannels
uint16_t wChannelConfig
uint8_t iChannelNames
uint8_t iTerminal
uint8_t bSourceID
uint8_t bUnitID
uint8_t bControlSize
uint8_t bFormatType
uint8_t bSubFrameSize
uint8_t bBitResolution
uint8_t bSamFreqType

Detailed Description

Definitions and classes for USB Audio class descriptors.

Definition in file AUDDescriptors.h.


Variable Documentation

uint8_t bAssocTerminal

ID of the output terminal to which this input terminal is associated.

Identifier of the associated input terminal.

Definition at line 468 of file AUDDescriptors.h.

uint8_t bBitResolution

Number of bits effectively used in an audio subframe.

Definition at line 551 of file AUDDescriptors.h.

uint16_t bcdADC

Audio class release number in BCD format

See also:
USB Audio class releases USB Audio class releases

Definition at line 432 of file AUDDescriptors.h.

uint8_t bControlSize

Size in bytes of a channel controls field.

Definition at line 518 of file AUDDescriptors.h.

uint8_t bDelay

Delay introduced by the data path, in number of frames.

Definition at line 358 of file AUDDescriptors.h.

Descriptor subtype (AUDStreamingInterfaceDescriptor_GENERAL).

Descriptor subtype (AUDDataEndpointDescriptor_SUBTYPE).

Descriptor subtype (AUDGenericDescriptor_HEADER).

Descriptor subtype (AUDGenericDescriptor_INPUTTERMINAL).

Descriptor subtype (AUDGenericDescriptor_OUTPUTTERMINAL).

Descriptor subtype (AUDGenericDescriptor_FEATURE).

Descriptor subtype (AUDStreamingInterfaceDescriptor_FORMATTYPE).

Definition at line 354 of file AUDDescriptors.h.

uint8_t bDescriptorType

Descriptor type (AUDGenericDescriptor_INTERFACE).

Descriptor type (USBGenericDescriptor_ENDPOINT).

Descriptor type (AUDGenericDescriptor_ENDPOINT).

Descriptor type (AUDGenericDescriptor_INTERFACE).

Definition at line 352 of file AUDDescriptors.h.

Address and direction of the endpoint.

Definition at line 380 of file AUDDescriptors.h.

uint8_t bFormatType

Format type (AUDFormatTypeOneDescriptor_FORMATTYPEONE).

Definition at line 545 of file AUDDescriptors.h.

uint8_t bInCollection

Number of Streaming interfaces contained in this collection.

Definition at line 436 of file AUDDescriptors.h.

uint8_t bInterval

Polling rate of the endpoint.

Definition at line 386 of file AUDDescriptors.h.

uint8_t bLength

Size of descriptor in bytes.

Size of the descriptor in bytes.

Definition at line 350 of file AUDDescriptors.h.

uint8_t bLockDelayUnits

Indicates the units of the wLockDelay fields.

See also:
USB Audio Lock delay units USB Audio Lock delay units

Definition at line 412 of file AUDDescriptors.h.

uint8_t bmAttributes

Endpoint type and additional characteristics (for isochronous endpoints).

Indicates available controls and requirement on packet sizes.

Configuration characteristics.

Definition at line 382 of file AUDDescriptors.h.

uint8_t bNrChannels

Number of logical output channels in this terminal.

Number of physical channels in the audio stream.

Definition at line 470 of file AUDDescriptors.h.

uint8_t bRefresh

Refresh rate for a feedback endpoint.

Definition at line 388 of file AUDDescriptors.h.

uint8_t bSamFreqType

Number of supported discrete sampling frequencies, or AUDFormatTypeOneDescriptor_CONTINUOUS.

Definition at line 554 of file AUDDescriptors.h.

uint8_t bSourceID

Identifier of the unit or terminal to which this terminal is connected.

Identifier of the unit or terminal this feature unit is connected to.

Definition at line 497 of file AUDDescriptors.h.

uint8_t bSubFrameSize

Number of bytes occupied by one audio subframe.

Definition at line 549 of file AUDDescriptors.h.

uint8_t bSyncAddress

Address of the associated feedback endpoint if any.

Definition at line 390 of file AUDDescriptors.h.

uint8_t bTerminalID

ID of the terminal in the audio function.

Identifier for this terminal.

Definition at line 462 of file AUDDescriptors.h.

uint8_t bTerminalLink

Terminal ID to which the interface is connected.

Definition at line 356 of file AUDDescriptors.h.

uint8_t bUnitID

Identifier of this feature unit.

Definition at line 514 of file AUDDescriptors.h.

uint8_t iChannelNames

Index of a string descriptor for the first logical channel.

Definition at line 474 of file AUDDescriptors.h.

uint8_t iTerminal

Index of a string descriptor for this terminal.

Definition at line 476 of file AUDDescriptors.h.

uint16_t wChannelConfig

Spatial configuration of the logical channels.

Definition at line 472 of file AUDDescriptors.h.

uint16_t wFormatTag

Audio data format used by this interface.

Definition at line 360 of file AUDDescriptors.h.

uint16_t wLockDelay

Time it takes for the endpoint to lock its internal clock circuitry.

Definition at line 414 of file AUDDescriptors.h.

uint16_t wMaxPacketSize

Maximum packet size (in bytes) of the endpoint.

Definition at line 384 of file AUDDescriptors.h.

uint16_t wTerminalType

Terminal type.

See also:
USB Audio Input terminal types USB Audio Input terminal types

Terminal type.

See also:
"USB Audio Output terminal types"

Definition at line 466 of file AUDDescriptors.h.

uint16_t wTotalLength

Length of all descriptors used to qualify the Audio Control interface.

Definition at line 434 of file AUDDescriptors.h.

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines