diff options
| author | Jack Humbert <[email protected]> | 2017-07-07 11:55:23 -0400 | 
|---|---|---|
| committer | Jack Humbert <[email protected]> | 2017-07-07 11:55:23 -0400 | 
| commit | 60b30c036397cb5627fa374bb930794b225daa29 (patch) | |
| tree | e156c2d6b27f01db6985f2cc560c9c345d48fdac /Demos/Device/ClassDriver/DualMIDI/Descriptors.c | |
| download | qmk_firmware-60b30c036397cb5627fa374bb930794b225daa29.tar.gz qmk_firmware-60b30c036397cb5627fa374bb930794b225daa29.zip | |
Squashed 'lib/lufa/' content from commit 385d40300
git-subtree-dir: lib/lufa
git-subtree-split: 385d4030035dbaf41591309dbde47653bd03841b
Diffstat (limited to 'Demos/Device/ClassDriver/DualMIDI/Descriptors.c')
| -rw-r--r-- | Demos/Device/ClassDriver/DualMIDI/Descriptors.c | 366 | 
1 files changed, 366 insertions, 0 deletions
| diff --git a/Demos/Device/ClassDriver/DualMIDI/Descriptors.c b/Demos/Device/ClassDriver/DualMIDI/Descriptors.c new file mode 100644 index 0000000000..a286c5e9e0 --- /dev/null +++ b/Demos/Device/ClassDriver/DualMIDI/Descriptors.c @@ -0,0 +1,366 @@ +/* +             LUFA Library +     Copyright (C) Dean Camera, 2017. + +  dean [at] fourwalledcubicle [dot] com +           www.lufa-lib.org +*/ + +/* +  Copyright 2017  Dean Camera (dean [at] fourwalledcubicle [dot] com) + +  Permission to use, copy, modify, distribute, and sell this +  software and its documentation for any purpose is hereby granted +  without fee, provided that the above copyright notice appear in +  all copies and that both that the copyright notice and this +  permission notice and warranty disclaimer appear in supporting +  documentation, and that the name of the author not be used in +  advertising or publicity pertaining to distribution of the +  software without specific, written prior permission. + +  The author disclaims all warranties with regard to this +  software, including all implied warranties of merchantability +  and fitness.  In no event shall the author be liable for any +  special, indirect or consequential damages or any damages +  whatsoever resulting from loss of use, data or profits, whether +  in an action of contract, negligence or other tortious action, +  arising out of or in connection with the use or performance of +  this software. +*/ + +/** \file + * + *  USB Device Descriptors, for library use when in USB device mode. Descriptors are special + *  computer-readable structures which the host requests upon device enumeration, to determine + *  the device's capabilities and functions. + */ + +#include "Descriptors.h" + +/** Device descriptor structure. This descriptor, located in FLASH memory, describes the overall + *  device characteristics, including the supported USB version, control endpoint size and the + *  number of device configurations. The descriptor is read out by the USB host when the enumeration + *  process begins. + */ +const USB_Descriptor_Device_t PROGMEM DeviceDescriptor = +{ +	.Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device}, + +	.USBSpecification       = VERSION_BCD(1,1,0), +	.Class                  = USB_CSCP_NoDeviceClass, +	.SubClass               = USB_CSCP_NoDeviceSubclass, +	.Protocol               = USB_CSCP_NoDeviceProtocol, + +	.Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE, + +	.VendorID               = 0x03EB, +	.ProductID              = 0x206D, +	.ReleaseNumber          = VERSION_BCD(0,0,2), + +	.ManufacturerStrIndex   = STRING_ID_Manufacturer, +	.ProductStrIndex        = STRING_ID_Product, +	.SerialNumStrIndex      = NO_DESCRIPTOR, + +	.NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS +}; + +/** Configuration descriptor structure. This descriptor, located in FLASH memory, describes the usage + *  of the device in one of its supported configurations, including information about any device interfaces + *  and endpoints. The descriptor is read out by the USB host during the enumeration process when selecting + *  a configuration so that the host may correctly communicate with the USB device. + */ +const USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor = +{ +	.Config = +		{ +			.Header                   = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration}, + +			.TotalConfigurationSize   = sizeof(USB_Descriptor_Configuration_t), +			.TotalInterfaces          = 2, + +			.ConfigurationNumber      = 1, +			.ConfigurationStrIndex    = NO_DESCRIPTOR, + +			.ConfigAttributes         = (USB_CONFIG_ATTR_RESERVED | USB_CONFIG_ATTR_SELFPOWERED), + +			.MaxPowerConsumption      = USB_CONFIG_POWER_MA(100) +		}, + +	.Audio_ControlInterface = +		{ +			.Header                   = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface}, + +			.InterfaceNumber          = INTERFACE_ID_AudioControl, +			.AlternateSetting         = 0, + +			.TotalEndpoints           = 0, + +			.Class                    = AUDIO_CSCP_AudioClass, +			.SubClass                 = AUDIO_CSCP_ControlSubclass, +			.Protocol                 = AUDIO_CSCP_ControlProtocol, + +			.InterfaceStrIndex        = NO_DESCRIPTOR +		}, + +	.Audio_ControlInterface_SPC = +		{ +			.Header                   = {.Size = sizeof(USB_Audio_Descriptor_Interface_AC_t), .Type = DTYPE_CSInterface}, +			.Subtype                  = AUDIO_DSUBTYPE_CSInterface_Header, + +			.ACSpecification          = VERSION_BCD(1,0,0), +			.TotalLength              = sizeof(USB_Audio_Descriptor_Interface_AC_t), + +			.InCollection             = 1, +			.InterfaceNumber          = INTERFACE_ID_AudioStream, +		}, + +	.Audio_StreamInterface = +		{ +			.Header                   = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface}, + +			.InterfaceNumber          = INTERFACE_ID_AudioStream, +			.AlternateSetting         = 0, + +			.TotalEndpoints           = 2, + +			.Class                    = AUDIO_CSCP_AudioClass, +			.SubClass                 = AUDIO_CSCP_MIDIStreamingSubclass, +			.Protocol                 = AUDIO_CSCP_StreamingProtocol, + +			.InterfaceStrIndex        = NO_DESCRIPTOR +		}, + +	.Audio_StreamInterface_SPC = +		{ +			.Header                   = {.Size = sizeof(USB_MIDI_Descriptor_AudioInterface_AS_t), .Type = DTYPE_CSInterface}, +			.Subtype                  = AUDIO_DSUBTYPE_CSInterface_General, + +			.AudioSpecification       = VERSION_BCD(1,0,0), + +			.TotalLength              = (sizeof(USB_Descriptor_Configuration_t) - +			                             offsetof(USB_Descriptor_Configuration_t, Audio_StreamInterface_SPC)) +		}, + +	.MIDI_In_Jack_Emb = +		{ +			.Header                   = {.Size = sizeof(USB_MIDI_Descriptor_InputJack_t), .Type = DTYPE_CSInterface}, +			.Subtype                  = AUDIO_DSUBTYPE_CSInterface_InputTerminal, + +			.JackType                 = MIDI_JACKTYPE_Embedded, +			.JackID                   = 0x01, + +			.JackStrIndex             = NO_DESCRIPTOR +		}, + +	.MIDI_In_Jack_Emb2 = +		{ +			.Header                   = {.Size = sizeof(USB_MIDI_Descriptor_InputJack_t), .Type = DTYPE_CSInterface}, +			.Subtype                  = AUDIO_DSUBTYPE_CSInterface_InputTerminal, + +			.JackType                 = MIDI_JACKTYPE_Embedded, +			.JackID                   = 0x02, + +			.JackStrIndex             = NO_DESCRIPTOR +		}, + +	.MIDI_In_Jack_Ext = +		{ +			.Header                   = {.Size = sizeof(USB_MIDI_Descriptor_InputJack_t), .Type = DTYPE_CSInterface}, +			.Subtype                  = AUDIO_DSUBTYPE_CSInterface_InputTerminal, + +			.JackType                 = MIDI_JACKTYPE_External, +			.JackID                   = 0x03, + +			.JackStrIndex             = NO_DESCRIPTOR +		}, + +	.MIDI_In_Jack_Ext2 = +		{ +			.Header                   = {.Size = sizeof(USB_MIDI_Descriptor_InputJack_t), .Type = DTYPE_CSInterface}, +			.Subtype                  = AUDIO_DSUBTYPE_CSInterface_InputTerminal, + +			.JackType                 = MIDI_JACKTYPE_External, +			.JackID                   = 0x04, + +			.JackStrIndex             = NO_DESCRIPTOR +		}, + +	.MIDI_Out_Jack_Emb = +		{ +			.Header                   = {.Size = sizeof(USB_MIDI_Descriptor_OutputJack_t), .Type = DTYPE_CSInterface}, +			.Subtype                  = AUDIO_DSUBTYPE_CSInterface_OutputTerminal, + +			.JackType                 = MIDI_JACKTYPE_Embedded, +			.JackID                   = 0x05, + +			.NumberOfPins             = 1, +			.SourceJackID             = {0x03}, +			.SourcePinID              = {0x01}, + +			.JackStrIndex             = NO_DESCRIPTOR +		}, + +	.MIDI_Out_Jack_Emb2 = +		{ +			.Header                   = {.Size = sizeof(USB_MIDI_Descriptor_OutputJack_t), .Type = DTYPE_CSInterface}, +			.Subtype                  = AUDIO_DSUBTYPE_CSInterface_OutputTerminal, + +			.JackType                 = MIDI_JACKTYPE_Embedded, +			.JackID                   = 0x06, + +			.NumberOfPins             = 1, +			.SourceJackID             = {0x04}, +			.SourcePinID              = {0x01}, + +			.JackStrIndex             = NO_DESCRIPTOR +		}, + +	.MIDI_Out_Jack_Ext = +		{ +			.Header                   = {.Size = sizeof(USB_MIDI_Descriptor_OutputJack_t), .Type = DTYPE_CSInterface}, +			.Subtype                  = AUDIO_DSUBTYPE_CSInterface_OutputTerminal, + +			.JackType                 = MIDI_JACKTYPE_External, +			.JackID                   = 0x07, + +			.NumberOfPins             = 1, +			.SourceJackID             = {0x01}, +			.SourcePinID              = {0x01}, + +			.JackStrIndex             = NO_DESCRIPTOR +		}, + +	.MIDI_Out_Jack_Ext2 = +		{ +			.Header                   = {.Size = sizeof(USB_MIDI_Descriptor_OutputJack_t), .Type = DTYPE_CSInterface}, +			.Subtype                  = AUDIO_DSUBTYPE_CSInterface_OutputTerminal, + +			.JackType                 = MIDI_JACKTYPE_External, +			.JackID                   = 0x08, + +			.NumberOfPins             = 1, +			.SourceJackID             = {0x02}, +			.SourcePinID              = {0x01}, + +			.JackStrIndex             = NO_DESCRIPTOR +		}, + +	.MIDI_In_Jack_Endpoint = +		{ +			.Endpoint = +				{ +					.Header              = {.Size = sizeof(USB_Audio_Descriptor_StreamEndpoint_Std_t), .Type = DTYPE_Endpoint}, + +					.EndpointAddress     = MIDI_STREAM_OUT_EPADDR, +					.Attributes          = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA), +					.EndpointSize        = MIDI_STREAM_EPSIZE, +					.PollingIntervalMS   = 0x05 +				}, + +			.Refresh                  = 0, +			.SyncEndpointNumber       = 0 +		}, + +	.MIDI_In_Jack_Endpoint_SPC = +		{ +			.Header                   = {.Size = sizeof(USB_MIDI_Descriptor_DualJack_Endpoint_t), .Type = DTYPE_CSEndpoint}, +			.Subtype                  = AUDIO_DSUBTYPE_CSEndpoint_General, + +			.TotalEmbeddedJacks       = 0x02, +			.AssociatedJackID         = {0x01, 0x02} +		}, + +	.MIDI_Out_Jack_Endpoint = +		{ +			.Endpoint = +				{ +					.Header              = {.Size = sizeof(USB_Audio_Descriptor_StreamEndpoint_Std_t), .Type = DTYPE_Endpoint}, + +					.EndpointAddress     = MIDI_STREAM_IN_EPADDR, +					.Attributes          = (EP_TYPE_BULK | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA), +					.EndpointSize        = MIDI_STREAM_EPSIZE, +					.PollingIntervalMS   = 0x05 +				}, + +			.Refresh                  = 0, +			.SyncEndpointNumber       = 0 +		}, + +	.MIDI_Out_Jack_Endpoint_SPC = +		{ +			.Header                   = {.Size = sizeof(USB_MIDI_Descriptor_DualJack_Endpoint_t), .Type = DTYPE_CSEndpoint}, +			.Subtype                  = AUDIO_DSUBTYPE_CSEndpoint_General, + +			.TotalEmbeddedJacks       = 0x02, +			.AssociatedJackID         = {0x05, 0x06} +		} +}; + +/** Language descriptor structure. This descriptor, located in FLASH memory, is returned when the host requests + *  the string descriptor with index 0 (the first index). It is actually an array of 16-bit integers, which indicate + *  via the language ID table available at USB.org what languages the device supports for its string descriptors. + */ +const USB_Descriptor_String_t PROGMEM LanguageString = USB_STRING_DESCRIPTOR_ARRAY(LANGUAGE_ID_ENG); + +/** Manufacturer descriptor string. This is a Unicode string containing the manufacturer's details in human readable + *  form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device + *  Descriptor. + */ +const USB_Descriptor_String_t PROGMEM ManufacturerString = USB_STRING_DESCRIPTOR(L"Dean Camera"); + +/** Product descriptor string. This is a Unicode string containing the product's details in human readable form, + *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device + *  Descriptor. + */ +const USB_Descriptor_String_t PROGMEM ProductString = USB_STRING_DESCRIPTOR(L"LUFA Dual MIDI Demo"); + +/** This function is called by the library when in device mode, and must be overridden (see library "USB Descriptors" + *  documentation) by the application code so that the address and size of a requested descriptor can be given + *  to the USB library. When the device receives a Get Descriptor request on the control endpoint, this function + *  is called so that the descriptor details can be passed back and the appropriate descriptor sent back to the + *  USB host. + */ +uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, +                                    const uint16_t wIndex, +                                    const void** const DescriptorAddress) +{ +	const uint8_t  DescriptorType   = (wValue >> 8); +	const uint8_t  DescriptorNumber = (wValue & 0xFF); + +	const void* Address = NULL; +	uint16_t    Size    = NO_DESCRIPTOR; + +	switch (DescriptorType) +	{ +		case DTYPE_Device: +			Address = &DeviceDescriptor; +			Size    = sizeof(USB_Descriptor_Device_t); +			break; +		case DTYPE_Configuration: +			Address = &ConfigurationDescriptor; +			Size    = sizeof(USB_Descriptor_Configuration_t); +			break; +		case DTYPE_String: +			switch (DescriptorNumber) +			{ +				case STRING_ID_Language: +					Address = &LanguageString; +					Size    = pgm_read_byte(&LanguageString.Header.Size); +					break; +				case STRING_ID_Manufacturer: +					Address = &ManufacturerString; +					Size    = pgm_read_byte(&ManufacturerString.Header.Size); +					break; +				case STRING_ID_Product: +					Address = &ProductString; +					Size    = pgm_read_byte(&ProductString.Header.Size); +					break; +			} + +			break; +	} + +	*DescriptorAddress = Address; +	return Size; +} + | 
