--- /dev/null
+/*\r
+ LUFA Library\r
+ Copyright (C) Dean Camera, 2009.\r
+ \r
+ dean [at] fourwalledcubicle [dot] com\r
+ www.fourwalledcubicle.com\r
+*/\r
+\r
+/*\r
+ Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+ Permission to use, copy, modify, and distribute this software\r
+ and its documentation for any purpose and without fee is hereby\r
+ granted, provided that the above copyright notice appear in all\r
+ copies and that both that the copyright notice and this\r
+ permission notice and warranty disclaimer appear in supporting\r
+ documentation, and that the name of the author not be used in\r
+ advertising or publicity pertaining to distribution of the\r
+ software without specific, written prior permission.\r
+\r
+ The author disclaim all warranties with regard to this\r
+ software, including all implied warranties of merchantability\r
+ and fitness. In no event shall the author be liable for any\r
+ special, indirect or consequential damages or any damages\r
+ whatsoever resulting from loss of use, data or profits, whether\r
+ in an action of contract, negligence or other tortious action,\r
+ arising out of or in connection with the use or performance of\r
+ this software.\r
+*/\r
+\r
+/** \file\r
+ *\r
+ * Header file for Descriptors.c.\r
+ */\r
+ \r
+#ifndef _DESCRIPTORS_H_\r
+#define _DESCRIPTORS_H_\r
+\r
+ /* Includes: */\r
+ #include <LUFA/Drivers/USB/USB.h>\r
+\r
+ #include <avr/pgmspace.h>\r
+\r
+ /* Macros: */\r
+ /** Descriptor header constant to indicate a Audio class interface descriptor. */\r
+ #define DTYPE_AudioInterface 0x24\r
+\r
+ /** Descriptor header constant to indicate a Audio class endpoint descriptor. */\r
+ #define DTYPE_AudioEndpoint 0x25\r
+\r
+ /** Audio class descriptor subtype value for a Audio class specific header descriptor. */\r
+ #define DSUBTYPE_Header 0x01\r
+\r
+ /** Audio class descriptor subtype value for a Audio class specific MIDI input jack descriptor. */\r
+ #define DSUBTYPE_InputJack 0x02\r
+\r
+ /** Audio class descriptor subtype value for a Audio class specific MIDI output jack descriptor. */\r
+ #define DSUBTYPE_OutputJack 0x03\r
+\r
+ /** Audio class descriptor subtype value for a general Audio class specific descriptor. */\r
+ #define DSUBTYPE_General 0x01\r
+\r
+ /** Audio class descriptor jack type value for an embedded (logical) MIDI input or output jack. */\r
+ #define JACKTYPE_EMBEDDED 0x01\r
+\r
+ /** Audio class descriptor jack type value for an external (physical) MIDI input or output jack. */\r
+ #define JACKTYPE_EXTERNAL 0x02\r
+ \r
+ /** Endpoint number of the MIDI streaming data OUT endpoint, for host-to-device data transfers. */\r
+ #define MIDI_STREAM_OUT_EPNUM 1\r
+\r
+ /** Endpoint number of the MIDI streaming data IN endpoint, for device-to-host data transfers. */\r
+ #define MIDI_STREAM_IN_EPNUM 2\r
+\r
+ /** Endpoint size in bytes of the Audio isochronous streaming data IN and OUT endpoints. */\r
+ #define MIDI_STREAM_EPSIZE 64\r
+ \r
+ /* Type Defines: */\r
+ /** Type define for an Audio class specific interface descriptor. This follows a regular interface descriptor to\r
+ * supply extra information about the audio device's layout to the host. See the USB Audio specification for more\r
+ * details.\r
+ */\r
+ typedef struct\r
+ {\r
+ USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length */\r
+ uint8_t Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */\r
+\r
+ uint16_t ACSpecification; /** Binary coded decimal value, indicating the supported Audio Class specification version */\r
+ uint16_t TotalLength; /** Total length of the Audio class specific control descriptors, including this descriptor */\r
+ \r
+ uint8_t InCollection; /** Total number of audio class interfaces within this device */\r
+ uint8_t InterfaceNumbers[1]; /** Interface numbers of each audio interface */\r
+ } USB_AudioInterface_AC_t;\r
+ \r
+ /** Type define for an Audio class specific MIDI streaming interface descriptor. This indicates to the host\r
+ * how MIDI the specification compliance of the device and the total length of the Audio class specific descriptors.\r
+ * See the USB Audio specification for more details.\r
+ */\r
+ typedef struct\r
+ {\r
+ USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length */\r
+ uint8_t Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */\r
+ \r
+ uint16_t AudioSpecification; /**< Binary coded decimal value, indicating the supported Audio Class specification version */\r
+ uint16_t TotalLength; /**< Total length of the Audio class specific descriptors, including this descriptor */\r
+ } USB_AudioInterface_MIDI_AS_t;\r
+ \r
+ /** Type define for an Audio class specific endpoint descriptor. This contains a regular endpoint \r
+ * descriptor with a few Audio-class specific extensions. See the USB Audio specification for more details.\r
+ */\r
+ typedef struct\r
+ {\r
+ USB_Descriptor_Endpoint_t Endpoint; /**< Standard endpoint descriptor describing the audio endpoint */\r
+\r
+ uint8_t Refresh; /**< Always set to zero */\r
+ uint8_t SyncEndpointNumber; /**< Endpoint address to send synchronisation information to, if needed (zero otherwise) */\r
+ } USB_AudioStreamEndpoint_Std_t;\r
+\r
+ /** Type define for an Audio class specific MIDI IN jack. This gives information to the host on a MIDI input, either\r
+ * a physical input jack, or a logical jack (recieving input data internally, or from the host via an endpoint).\r
+ */\r
+ typedef struct\r
+ {\r
+ USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length */\r
+ uint8_t Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */\r
+\r
+ uint8_t JackType; /**< Type of jack, one of the JACKTYPE_* mask values */\r
+ uint8_t JackID; /**< ID value of this jack - must be a unique value within the device */\r
+ \r
+ uint8_t JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device */\r
+ } USB_MIDI_In_Jack_t;\r
+\r
+ /** Type define for an Audio class specific MIDI OUT jack. This gives information to the host on a MIDI output, either\r
+ * a physical output jack, or a logical jack (sending output data internally, or to the host via an endpoint).\r
+ */\r
+ typedef struct\r
+ {\r
+ USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length */\r
+ uint8_t Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */\r
+\r
+ uint8_t JackType; /**< Type of jack, one of the JACKTYPE_* mask values */\r
+ uint8_t JackID; /**< ID value of this jack - must be a unique value within the device */\r
+ \r
+ uint8_t NumberOfPins; /**< Number of output channels within the jack, either physical or logical */\r
+ uint8_t SourceJackID[1]; /**< ID of each output pin's source data jack */\r
+ uint8_t SourcePinID[1]; /**< Pin number in the input jack of each output pin's source data */\r
+ \r
+ uint8_t JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device */\r
+ } USB_MIDI_Out_Jack_t;\r
+ \r
+ /** Type define for an Audio class specific extended MIDI jack endpoint descriptor. This contains extra information\r
+ * on the usage of MIDI endpoints used to stream MIDI events in and out of the USB Audio device, and follows an Audio\r
+ * class specific extended MIDI endpoint descriptor. See the USB Audio specification for more details.\r
+ */\r
+ typedef struct\r
+ {\r
+ USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length */\r
+ uint8_t Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */\r
+\r
+ uint8_t TotalEmbeddedJacks; /**< Total number of jacks inside this endpoint */\r
+ uint8_t AssociatedJackID[1]; /**< IDs of each jack inside the endpoint */\r
+ } USB_MIDI_Jack_Endpoint_t;\r
+\r
+ /** Type define for the device configuration descriptor structure. This must be defined in the\r
+ * application code, as the configuration descriptor contains several sub-descriptors which\r
+ * vary between devices, and which describe the device's usage to the host.\r
+ */\r
+ typedef struct\r
+ {\r
+ USB_Descriptor_Configuration_Header_t Config;\r
+ USB_Descriptor_Interface_t AudioControlInterface;\r
+ USB_AudioInterface_AC_t AudioControlInterface_SPC;\r
+ USB_Descriptor_Interface_t AudioStreamInterface;\r
+ USB_AudioInterface_MIDI_AS_t AudioStreamInterface_SPC;\r
+ USB_MIDI_In_Jack_t MIDI_In_Jack_Emb;\r
+ USB_MIDI_In_Jack_t MIDI_In_Jack_Ext;\r
+ USB_MIDI_Out_Jack_t MIDI_Out_Jack_Emb;\r
+ USB_MIDI_Out_Jack_t MIDI_Out_Jack_Ext;\r
+ USB_AudioStreamEndpoint_Std_t MIDI_In_Jack_Endpoint;\r
+ USB_MIDI_Jack_Endpoint_t MIDI_In_Jack_Endpoint_SPC;\r
+ USB_AudioStreamEndpoint_Std_t MIDI_Out_Jack_Endpoint;\r
+ USB_MIDI_Jack_Endpoint_t MIDI_Out_Jack_Endpoint_SPC;\r
+ } USB_Descriptor_Configuration_t;\r
+ \r
+ /* Function Prototypes: */\r
+ uint16_t USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)\r
+ ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);\r
+\r
+#endif\r
projects / pub / lufa.git / blobdiff