Collaboration diagram for Usbd_audio_speaker:

Data Structures
struct	AUDDSpeakerDriver
	Audio speaker driver struct. More...
struct	_AUDHeaderDescriptor1
struct	_AUDFeatureUnitDescriptor3
struct	_AUDDSpeakerDriverAudioControlDescriptors
struct	_AUDFormatTypeOneDescriptor1
struct	_AUDDSpeakerDriverConfigurationDescriptors
Modules
	USB Device Audio Speaker streams
	USB Device Audio Speaker Codes
	USB Device Audio Speaker Channel Numbers
	USB Device Audio Speaker Interface IDs
	USB Device Audio Speaker Entity IDs
Functions
void	AUDDSpeakerDriver_Initialize (const USBDDriverDescriptors *pDescriptors)
void	AUDDSpeakerDriver_ConfigurationChangeHandler (uint8_t cfgnum)
void	AUDDSpeakerDriver_InterfaceSettingChangedHandler (uint8_t interface, uint8_t setting)
void	AUDDSpeakerDriver_RequestHandler (const USBGenericRequest *request)
uint8_t	AUDDSpeakerDriver_Read (void buffer, uint32_t length, TransferCallback callback, void argument)
WEAK void	AUDDSpeakerDriver_MuteChanged (uint8_t channel, uint8_t muted)
WEAK void	AUDDSpeakerDriver_StreamSettingChanged (uint8_t newSetting)
struct _AUDHeaderDescriptor1	__attribute__ ((__packed__)) AUDHeaderDescriptor1
Variables
const USBDeviceDescriptor	deviceDescriptor
const AUDDSpeakerDriverConfigurationDescriptors	fsConfigurationDescriptors
const AUDDSpeakerDriverConfigurationDescriptors	hsConfigurationDescriptors
const unsigned char	languageIdDescriptor []
const unsigned char	manufacturerDescriptor []
const unsigned char	productDescriptor []
const unsigned char	serialNumberDescriptor []
const unsigned char *	stringDescriptors []
const USBDDriverDescriptors	auddSpeakerDriverDescriptors
const USBDeviceDescriptor	deviceDescriptor
const HidAuddDriverConfigurationDescriptors	fsConfigurationDescriptors
const HidAuddDriverConfigurationDescriptors	hsConfigurationDescriptors
const unsigned char	languageIdDescriptor []
const unsigned char	manufacturerDescriptor []
const unsigned char	productDescriptor []
const unsigned char	serialNumberDescriptor []
const unsigned char *	stringDescriptors []
const USBDDriverDescriptors	hidauddDriverDescriptors

Function Documentation

void AUDDSpeakerDriver_ConfigurationChangeHandler ( uint8_t cfgnum )

Invoked whenever the active configuration of device is changed by the host.

Parameters:

cfgnum

Configuration number.

void AUDDSpeakerDriver_Initialize ( const USBDDriverDescriptors * pDescriptors )

Initializes an USB audio speaker device driver, as well as the underlying USB controller.

void AUDDSpeakerDriver_InterfaceSettingChangedHandler	(	uint8_t	interface,
		uint8_t	setting
	)

Invoked whenever the active setting of an interface is changed by the host. Changes the status of the third LED accordingly.

Parameters:

	interface	Interface number.
	setting	Newly active setting.

WEAK void AUDDSpeakerDriver_MuteChanged	(	uint8_t	channel,
		uint8_t	muted
	)

Invoked when an audio channel get muted or unmuted. Mutes/unmutes the channel at the DAC level.

Parameters:

	channel	Channel number that changed.
	muted	Indicates the new mute status of the channel.

uint8_t AUDDSpeakerDriver_Read	(	void *	buffer,
		uint32_t	length,
		TransferCallback	callback,
		void *	argument
	)

Reads incoming audio data sent by the USB host into the provided buffer. When the transfer is complete, an optional callback function is invoked.

Parameters:

	buffer	Pointer to the data storage buffer.
	length	Size of the buffer in bytes.
	callback	Optional callback function.
	argument	Optional argument to the callback function.

Returns:: USBD_STATUS_SUCCESS if the transfer is started successfully; otherwise an error code.

void AUDDSpeakerDriver_RequestHandler ( const USBGenericRequest * request )

Handles audio-specific USB requests sent by the host, and forwards standard ones to the USB device driver.

Parameters:

request

Pointer to a USBGenericRequest instance.

WEAK void AUDDSpeakerDriver_StreamSettingChanged ( uint8_t newSetting )

Invoked when an audio streaming interface setting changed. Actually control streaming rate.

Parameters:

newSetting

New stream (interface) setting.

Variable Documentation

const USBDDriverDescriptors auddSpeakerDriverDescriptors

Initial value:

 {

    &deviceDescriptor,
    (const USBConfigurationDescriptor *) &fsConfigurationDescriptors,
    &qualifierDescriptor,
    0,
    0,
    (const USBConfigurationDescriptor *) &hsConfigurationDescriptors,
    &qualifierDescriptor,
    0,
    stringDescriptors, 4 
}

List of descriptors required by an USB audio speaker device driver.

Definition at line 513 of file USBDDriverDescriptors.c.

const USBDeviceDescriptor deviceDescriptor

Initial value:

 {

    sizeof(USBDeviceDescriptor),
    USBGenericDescriptor_DEVICE,
    USBDeviceDescriptor_USB2_00,
    AUDDeviceDescriptor_CLASS,
    AUDDeviceDescriptor_SUBCLASS,
    AUDDeviceDescriptor_PROTOCOL,
    CHIP_USB_ENDPOINTS_MAXPACKETSIZE(0),
    AUDDSpeakerDriverDescriptors_VENDORID,
    AUDDSpeakerDriverDescriptors_PRODUCTID,
    AUDDSpeakerDriverDescriptors_RELEASE,
    1, 
    2, 
    3, 
    1  
}

Device descriptor for a USB audio speaker driver.

Definition at line 98 of file USBDDriverDescriptors.c.

const USBDeviceDescriptor deviceDescriptor

Initial value:

 {

    sizeof(USBDeviceDescriptor),
    USBGenericDescriptor_DEVICE,
    USBDeviceDescriptor_USB2_00,
    AUDDeviceDescriptor_CLASS,
    AUDDeviceDescriptor_SUBCLASS,
    AUDDeviceDescriptor_PROTOCOL,
    CHIP_USB_ENDPOINTS_MAXPACKETSIZE(0),
    AUDDSpeakerDriverDescriptors_VENDORID,
    AUDDSpeakerDriverDescriptors_PRODUCTID,
    AUDDSpeakerDriverDescriptors_RELEASE,
    1, 
    2, 
    3, 
    1  
}

Device descriptor for a USB audio speaker driver.

Definition at line 77 of file USBDDriverDescriptors.c.

const AUDDSpeakerDriverConfigurationDescriptors fsConfigurationDescriptors

Configuration descriptors for a USB audio speaker driver.

Definition at line 131 of file USBDDriverDescriptors.c.

const HidAuddDriverConfigurationDescriptors fsConfigurationDescriptors

Configuration descriptors for a USB HID(keyboard) + Audio(speaker) driver.

Definition at line 110 of file USBDDriverDescriptors.c.

const USBDDriverDescriptors hidauddDriverDescriptors

Initial value:

 {

    &deviceDescriptor,
    (const USBConfigurationDescriptor *) &fsConfigurationDescriptors,
    &qualifierDescriptor,
    0,
    0,
    (const USBConfigurationDescriptor *) &hsConfigurationDescriptors,
    &qualifierDescriptor,
    0,
    stringDescriptors, 4 
}

List of descriptors required by an USB audio speaker device driver.

Definition at line 605 of file USBDDriverDescriptors.c.

const AUDDSpeakerDriverConfigurationDescriptors hsConfigurationDescriptors

Configuration descriptors for a USB audio speaker driver.

Definition at line 289 of file USBDDriverDescriptors.c.

const HidAuddDriverConfigurationDescriptors hsConfigurationDescriptors

Configuration descriptors for a USB HID(keyboard) + Audio(speaker) driver.

Definition at line 325 of file USBDDriverDescriptors.c.

const unsigned char languageIdDescriptor[]

Initial value:

 {

    USBStringDescriptor_LENGTH(1),
    USBGenericDescriptor_STRING,
    USBStringDescriptor_ENGLISH_US
}

String descriptor with the supported languages.

Definition at line 447 of file USBDDriverDescriptors.c.

const unsigned char languageIdDescriptor[]

Initial value:

 {

    USBStringDescriptor_LENGTH(1),
    USBGenericDescriptor_STRING,
    USBStringDescriptor_ENGLISH_US
}

String descriptor with the supported languages.

Definition at line 540 of file USBDDriverDescriptors.c.

const unsigned char manufacturerDescriptor[]

Initial value:

 {

    USBStringDescriptor_LENGTH(5),
    USBGenericDescriptor_STRING,
    USBStringDescriptor_UNICODE('A'),
    USBStringDescriptor_UNICODE('t'),
    USBStringDescriptor_UNICODE('m'),
    USBStringDescriptor_UNICODE('e'),
    USBStringDescriptor_UNICODE('l')
}

Manufacturer name.

Definition at line 548 of file USBDDriverDescriptors.c.

const unsigned char manufacturerDescriptor[]

Initial value:

 {

    USBStringDescriptor_LENGTH(5),
    USBGenericDescriptor_STRING,
    USBStringDescriptor_UNICODE('A'),
    USBStringDescriptor_UNICODE('t'),
    USBStringDescriptor_UNICODE('m'),
    USBStringDescriptor_UNICODE('e'),
    USBStringDescriptor_UNICODE('l')
}

Manufacturer name.

Definition at line 455 of file USBDDriverDescriptors.c.

const unsigned char productDescriptor[]

Initial value:

 {

    USBStringDescriptor_LENGTH(14),
    USBGenericDescriptor_STRING,
    USBStringDescriptor_UNICODE('K'),
    USBStringDescriptor_UNICODE('e'),
    USBStringDescriptor_UNICODE('y'),
    USBStringDescriptor_UNICODE('p'),
    USBStringDescriptor_UNICODE('a'),
    USBStringDescriptor_UNICODE('d'),
    USBStringDescriptor_UNICODE('&'),
    USBStringDescriptor_UNICODE('s'),
    USBStringDescriptor_UNICODE('p'),
    USBStringDescriptor_UNICODE('e'),
    USBStringDescriptor_UNICODE('a'),
    USBStringDescriptor_UNICODE('k'),
    USBStringDescriptor_UNICODE('e'),
    USBStringDescriptor_UNICODE('r')
}

Product name.

Definition at line 560 of file USBDDriverDescriptors.c.

const unsigned char productDescriptor[]

Initial value:

 {

    USBStringDescriptor_LENGTH(15),
    USBGenericDescriptor_STRING,
    USBStringDescriptor_UNICODE('D'),
    USBStringDescriptor_UNICODE('e'),
    USBStringDescriptor_UNICODE('s'),
    USBStringDescriptor_UNICODE('k'),
    USBStringDescriptor_UNICODE('t'),
    USBStringDescriptor_UNICODE('o'),
    USBStringDescriptor_UNICODE('p'),
    USBStringDescriptor_UNICODE(' '),
    USBStringDescriptor_UNICODE('s'),
    USBStringDescriptor_UNICODE('p'),
    USBStringDescriptor_UNICODE('e'),
    USBStringDescriptor_UNICODE('a'),
    USBStringDescriptor_UNICODE('k'),
    USBStringDescriptor_UNICODE('e'),
    USBStringDescriptor_UNICODE('r')
}

Product name.

Definition at line 467 of file USBDDriverDescriptors.c.

const unsigned char serialNumberDescriptor[]

Initial value:

 {

    USBStringDescriptor_LENGTH(4),
    USBGenericDescriptor_STRING,
    USBStringDescriptor_UNICODE('0'),
    USBStringDescriptor_UNICODE('1'),
    USBStringDescriptor_UNICODE('2'),
    USBStringDescriptor_UNICODE('3')
}

Product serial number.

Definition at line 489 of file USBDDriverDescriptors.c.

const unsigned char serialNumberDescriptor[]

Initial value:

 {

    USBStringDescriptor_LENGTH(4),
    USBGenericDescriptor_STRING,
    USBStringDescriptor_UNICODE('0'),
    USBStringDescriptor_UNICODE('1'),
    USBStringDescriptor_UNICODE('2'),
    USBStringDescriptor_UNICODE('3')
}

Product serial number.

Definition at line 581 of file USBDDriverDescriptors.c.

const unsigned char* stringDescriptors[]

Initial value:

 {

    languageIdDescriptor,
    manufacturerDescriptor,
    productDescriptor,
    serialNumberDescriptor,
}

Array of pointers to the four string descriptors.

Definition at line 500 of file USBDDriverDescriptors.c.

const unsigned char* stringDescriptors[]

Initial value:

 {

    languageIdDescriptor,
    manufacturerDescriptor,
    productDescriptor,
    serialNumberDescriptor,
}

Array of pointers to the four string descriptors.

Definition at line 592 of file USBDDriverDescriptors.c.

Usbd_audio_speaker [Common-used USB Descriptors]

Data Structures

Modules

Functions

Variables

Function Documentation

Variable Documentation

Usbd_audio_speaker
[Common-used USB Descriptors]