Add new tag for the LUFA-120219-BETA release.
[pub/USBasp.git] / Demos / Device / LowLevel / AudioInput / Descriptors.c
index 46b43ac..0b16522 100644 (file)
@@ -1,21 +1,21 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2012.
+
   dean [at] fourwalledcubicle [dot] com
-      www.fourwalledcubicle.com
+           www.lufa-lib.org
 */
 
 /*
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
-  Permission to use, copy, modify, distribute, and sell this 
+  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 
+  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 
+  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 disclaim all warranties with regard to this
 
 /** \file
  *
- *  USB Device Descriptors, for library use when in USB device mode. Descriptors are special 
+ *  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.  
+ *  the device's capabilities and functions.
  */
+
 #include "Descriptors.h"
 
 /** Device descriptor structure. This descriptor, located in FLASH memory, describes the overall
  *  number of device configurations. The descriptor is read out by the USB host when the enumeration
  *  process begins.
  */
-USB_Descriptor_Device_t PROGMEM DeviceDescriptor =
+const USB_Descriptor_Device_t PROGMEM DeviceDescriptor =
 {
        .Header                 = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
-               
-       .USBSpecification       = VERSION_BCD(02.00),
-       .Class                  = 0x00,
-       .SubClass               = 0x00,
-       .Protocol               = 0x00,
-                               
+
+       .USBSpecification       = VERSION_BCD(01.10),
+       .Class                  = USB_CSCP_NoDeviceClass,
+       .SubClass               = USB_CSCP_NoDeviceSubclass,
+       .Protocol               = USB_CSCP_NoDeviceProtocol,
+
        .Endpoint0Size          = FIXED_CONTROL_ENDPOINT_SIZE,
-               
+
        .VendorID               = 0x03EB,
        .ProductID              = 0x2047,
-       .ReleaseNumber          = 0x0000,
-               
+       .ReleaseNumber          = VERSION_BCD(00.02),
+
        .ManufacturerStrIndex   = 0x01,
        .ProductStrIndex        = 0x02,
        .SerialNumStrIndex      = NO_DESCRIPTOR,
-               
+
        .NumberOfConfigurations = FIXED_NUM_CONFIGURATIONS
 };
 
@@ -69,9 +69,9 @@ USB_Descriptor_Device_t PROGMEM DeviceDescriptor =
  *  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.
  */
-USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =
+const USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =
 {
-       .Config = 
+       .Config =
                {
                        .Header                   = {.Size = sizeof(USB_Descriptor_Configuration_Header_t), .Type = DTYPE_Configuration},
 
@@ -80,154 +80,163 @@ USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =
 
                        .ConfigurationNumber      = 1,
                        .ConfigurationStrIndex    = NO_DESCRIPTOR,
-                               
-                       .ConfigAttributes         = (USB_CONFIG_ATTR_BUSPOWERED | USB_CONFIG_ATTR_SELFPOWERED),
-                       
+
+                       .ConfigAttributes         = (USB_CONFIG_ATTR_RESERVED | USB_CONFIG_ATTR_SELFPOWERED),
+
                        .MaxPowerConsumption      = USB_CONFIG_POWER_MA(100)
                },
-               
-       .Audio_ControlInterface = 
+
+       .Audio_ControlInterface =
                {
                        .Header                   = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 
                        .InterfaceNumber          = 0,
                        .AlternateSetting         = 0,
-                       
+
                        .TotalEndpoints           = 0,
-                               
-                       .Class                    = 0x01,
-                       .SubClass                 = 0x01,
-                       .Protocol                 = 0x00,
-                               
+
+                       .Class                    = AUDIO_CSCP_AudioClass,
+                       .SubClass                 = AUDIO_CSCP_ControlSubclass,
+                       .Protocol                 = AUDIO_CSCP_ControlProtocol,
+
                        .InterfaceStrIndex        = NO_DESCRIPTOR
                },
-       
-       .Audio_ControlInterface_SPC = 
+
+       .Audio_ControlInterface_SPC =
                {
-                       .Header                   = {.Size = sizeof(USB_Audio_Interface_AC_t), .Type = DTYPE_AudioInterface},
-                       .Subtype                  = DSUBTYPE_Header,
-                       
+                       .Header                   = {.Size = sizeof(USB_Audio_Descriptor_Interface_AC_t), .Type = DTYPE_CSInterface},
+                       .Subtype                  = AUDIO_DSUBTYPE_CSInterface_Header,
+
                        .ACSpecification          = VERSION_BCD(01.00),
-                       .TotalLength              = (sizeof(USB_Audio_Interface_AC_t) +
-                                                    sizeof(USB_Audio_InputTerminal_t) +
-                                                    sizeof(USB_Audio_OutputTerminal_t)),
-                       
+                       .TotalLength              = (sizeof(USB_Audio_Descriptor_Interface_AC_t) +
+                                                    sizeof(USB_Audio_Descriptor_InputTerminal_t) +
+                                                    sizeof(USB_Audio_Descriptor_OutputTerminal_t)),
+
                        .InCollection             = 1,
-                       .InterfaceNumbers         = {1},
+                       .InterfaceNumber          = 1,
                },
 
-       .Audio_InputTerminal = 
+       .Audio_InputTerminal =
                {
-                       .Header                   = {.Size = sizeof(USB_Audio_InputTerminal_t), .Type = DTYPE_AudioInterface},
-                       .Subtype                  = DSUBTYPE_InputTerminal,
-               
+                       .Header                   = {.Size = sizeof(USB_Audio_Descriptor_InputTerminal_t), .Type = DTYPE_CSInterface},
+                       .Subtype                  = AUDIO_DSUBTYPE_CSInterface_InputTerminal,
+
                        .TerminalID               = 0x01,
-                       .TerminalType             = TERMINAL_IN_MIC,
+                       .TerminalType             = AUDIO_TERMINAL_IN_MIC,
                        .AssociatedOutputTerminal = 0x00,
-                       
+
                        .TotalChannels            = 1,
                        .ChannelConfig            = 0,
-                       
+
                        .ChannelStrIndex          = NO_DESCRIPTOR,
                        .TerminalStrIndex         = NO_DESCRIPTOR
                },
 
-       .Audio_OutputTerminal = 
+       .Audio_OutputTerminal =
                {
-                       .Header                   = {.Size = sizeof(USB_Audio_OutputTerminal_t), .Type = DTYPE_AudioInterface},
-                       .Subtype                  = DSUBTYPE_OutputTerminal,
-               
+                       .Header                   = {.Size = sizeof(USB_Audio_Descriptor_OutputTerminal_t), .Type = DTYPE_CSInterface},
+                       .Subtype                  = AUDIO_DSUBTYPE_CSInterface_OutputTerminal,
+
                        .TerminalID               = 0x02,
-                       .TerminalType             = TERMINAL_STREAMING,
+                       .TerminalType             = AUDIO_TERMINAL_STREAMING,
                        .AssociatedInputTerminal  = 0x00,
-                       
+
                        .SourceID                 = 0x01,
-                       
+
                        .TerminalStrIndex         = NO_DESCRIPTOR
                },
 
-       .Audio_StreamInterface_Alt0 = 
+       .Audio_StreamInterface_Alt0 =
                {
                        .Header                   = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 
                        .InterfaceNumber          = 1,
                        .AlternateSetting         = 0,
-                       
+
                        .TotalEndpoints           = 0,
-                               
-                       .Class                    = 0x01,
-                       .SubClass                 = 0x02,
-                       .Protocol                 = 0x00,
-                               
+
+                       .Class                    = AUDIO_CSCP_AudioClass,
+                       .SubClass                 = AUDIO_CSCP_AudioStreamingSubclass,
+                       .Protocol                 = AUDIO_CSCP_StreamingProtocol,
+
                        .InterfaceStrIndex        = NO_DESCRIPTOR
                },
 
-       .Audio_StreamInterface_Alt1 = 
+       .Audio_StreamInterface_Alt1 =
                {
                        .Header                   = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
 
                        .InterfaceNumber          = 1,
                        .AlternateSetting         = 1,
-                       
+
                        .TotalEndpoints           = 1,
-                               
-                       .Class                    = 0x01,
-                       .SubClass                 = 0x02,
-                       .Protocol                 = 0x00,
-                               
+
+                       .Class                    = AUDIO_CSCP_AudioClass,
+                       .SubClass                 = AUDIO_CSCP_AudioStreamingSubclass,
+                       .Protocol                 = AUDIO_CSCP_StreamingProtocol,
+
                        .InterfaceStrIndex        = NO_DESCRIPTOR
                },
-               
-       .Audio_StreamInterface_SPC = 
+
+       .Audio_StreamInterface_SPC =
                {
-                       .Header                   = {.Size = sizeof(USB_Audio_Interface_AS_t), .Type = DTYPE_AudioInterface},
-                       .Subtype                  = DSUBTYPE_General,
-                       
+                       .Header                   = {.Size = sizeof(USB_Audio_Descriptor_Interface_AS_t), .Type = DTYPE_CSInterface},
+                       .Subtype                  = AUDIO_DSUBTYPE_CSInterface_General,
+
                        .TerminalLink             = 0x02,
-                       
+
                        .FrameDelay               = 1,
                        .AudioFormat              = 0x0001
                },
-               
-       .Audio_AudioFormat = 
+
+       .Audio_AudioFormat =
                {
-                       .Header                   = {.Size = sizeof(USB_Audio_Format_t), .Type = DTYPE_AudioInterface},
-                       .Subtype                  = DSUBTYPE_Format,
+                       .Header                   = {.Size = sizeof(USB_Audio_Descriptor_Format_t) +
+                                                            sizeof(ConfigurationDescriptor.Audio_AudioFormatSampleRates),
+                                                    .Type = DTYPE_CSInterface},
+                       .Subtype                  = AUDIO_DSUBTYPE_CSInterface_FormatType,
 
                        .FormatType               = 0x01,
                        .Channels                 = 0x01,
-                       
+
                        .SubFrameSize             = 0x02,
                        .BitResolution            = 16,
-                       .SampleFrequencyType      = (sizeof(ConfigurationDescriptor.Audio_AudioFormat.SampleFrequencies) /
-                                                    sizeof(Audio_SampleFreq_t)),
-               
-                       .SampleFrequencies        = {SAMPLE_FREQ(AUDIO_SAMPLE_FREQUENCY)}
+
+                       .TotalDiscreteSampleRates = (sizeof(ConfigurationDescriptor.Audio_AudioFormatSampleRates) / sizeof(USB_Audio_SampleFreq_t)),
+               },
+
+       .Audio_AudioFormatSampleRates =
+               {
+                       AUDIO_SAMPLE_FREQ(8000),
+                       AUDIO_SAMPLE_FREQ(11025),
+                       AUDIO_SAMPLE_FREQ(22050),
+                       AUDIO_SAMPLE_FREQ(44100),
+                       AUDIO_SAMPLE_FREQ(48000),
                },
-       
-       .Audio_StreamEndpoint = 
+
+       .Audio_StreamEndpoint =
                {
-                       .Endpoint = 
+                       .Endpoint =
                                {
-                                       .Header              = {.Size = sizeof(USB_Audio_StreamEndpoint_Std_t), .Type = DTYPE_Endpoint},
+                                       .Header              = {.Size = sizeof(USB_Audio_Descriptor_StreamEndpoint_Std_t), .Type = DTYPE_Endpoint},
 
-                                       .EndpointAddress     = (ENDPOINT_DESCRIPTOR_DIR_IN | AUDIO_STREAM_EPNUM),
+                                       .EndpointAddress     = (ENDPOINT_DIR_IN | AUDIO_STREAM_EPNUM),
                                        .Attributes          = (EP_TYPE_ISOCHRONOUS | ENDPOINT_ATTR_SYNC | ENDPOINT_USAGE_DATA),
                                        .EndpointSize        = AUDIO_STREAM_EPSIZE,
-                                       .PollingIntervalMS   = 1
+                                       .PollingIntervalMS   = 0x01
                                },
-                       
+
                        .Refresh                  = 0,
                        .SyncEndpointNumber       = 0
                },
-               
-       .Audio_StreamEndpoint_SPC = 
+
+       .Audio_StreamEndpoint_SPC =
                {
-                       .Header                   = {.Size = sizeof(USB_Audio_StreamEndpoint_Spc_t), .Type = DTYPE_AudioEndpoint},
-                       .Subtype                  = DSUBTYPE_General,
-                       
-                       .Attributes               = 0x00,
-                       
+                       .Header                   = {.Size = sizeof(USB_Audio_Descriptor_StreamEndpoint_Spc_t), .Type = DTYPE_CSEndpoint},
+                       .Subtype                  = AUDIO_DSUBTYPE_CSEndpoint_General,
+
+                       .Attributes               = (AUDIO_EP_ACCEPTS_SMALL_PACKETS | AUDIO_EP_SAMPLE_FREQ_CONTROL),
+
                        .LockDelayUnits           = 0x00,
                        .LockDelay                = 0x0000
                }
@@ -237,10 +246,10 @@ USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =
  *  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.
  */
-USB_Descriptor_String_t PROGMEM LanguageString =
+const USB_Descriptor_String_t PROGMEM LanguageString =
 {
        .Header                 = {.Size = USB_STRING_LEN(1), .Type = DTYPE_String},
-               
+
        .UnicodeString          = {LANGUAGE_ID_ENG}
 };
 
@@ -248,10 +257,10 @@ USB_Descriptor_String_t PROGMEM LanguageString =
  *  form, and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
  *  Descriptor.
  */
-USB_Descriptor_String_t PROGMEM ManufacturerString =
+const USB_Descriptor_String_t PROGMEM ManufacturerString =
 {
        .Header                 = {.Size = USB_STRING_LEN(11), .Type = DTYPE_String},
-               
+
        .UnicodeString          = L"Dean Camera"
 };
 
@@ -259,10 +268,10 @@ USB_Descriptor_String_t PROGMEM ManufacturerString =
  *  and is read out upon request by the host when the appropriate string ID is requested, listed in the Device
  *  Descriptor.
  */
-USB_Descriptor_String_t PROGMEM ProductString =
+const USB_Descriptor_String_t PROGMEM ProductString =
 {
        .Header                 = {.Size = USB_STRING_LEN(18), .Type = DTYPE_String},
-               
+
        .UnicodeString          = L"LUFA Audio In Demo"
 };
 
@@ -288,30 +297,31 @@ uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
                        Address = &DeviceDescriptor;
                        Size    = sizeof(USB_Descriptor_Device_t);
                        break;
-               case DTYPE_Configuration: 
+               case DTYPE_Configuration:
                        Address = &ConfigurationDescriptor;
                        Size    = sizeof(USB_Descriptor_Configuration_t);
                        break;
-               case DTYPE_String: 
+               case DTYPE_String:
                        switch (DescriptorNumber)
                        {
-                               case 0x00: 
+                               case 0x00:
                                        Address = &LanguageString;
                                        Size    = pgm_read_byte(&LanguageString.Header.Size);
                                        break;
-                               case 0x01: 
+                               case 0x01:
                                        Address = &ManufacturerString;
                                        Size    = pgm_read_byte(&ManufacturerString.Header.Size);
                                        break;
-                               case 0x02: 
+                               case 0x02:
                                        Address = &ProductString;
                                        Size    = pgm_read_byte(&ProductString.Header.Size);
                                        break;
                        }
-                       
+
                        break;
        }
-       
+
        *DescriptorAddress = Address;
        return Size;
 }
+