3 Copyright (C) Dean Camera, 2014.
5 dean [at] fourwalledcubicle [dot] com
10 Copyright 2014 Dean Camera (dean [at] fourwalledcubicle [dot] com)
12 Permission to use, copy, modify, distribute, and sell this
13 software and its documentation for any purpose is hereby granted
14 without fee, provided that the above copyright notice appear in
15 all copies and that both that the copyright notice and this
16 permission notice and warranty disclaimer appear in supporting
17 documentation, and that the name of the author not be used in
18 advertising or publicity pertaining to distribution of the
19 software without specific, written prior permission.
21 The author disclaims all warranties with regard to this
22 software, including all implied warranties of merchantability
23 and fitness. In no event shall the author be liable for any
24 special, indirect or consequential damages or any damages
25 whatsoever resulting from loss of use, data or profits, whether
26 in an action of contract, negligence or other tortious action,
27 arising out of or in connection with the use or performance of
33 * Header file for Descriptors.c.
36 #ifndef _DESCRIPTORS_H_
37 #define _DESCRIPTORS_H_
40 #include <LUFA/Drivers/USB/USB.h>
42 #include <avr/pgmspace.h>
45 /** Endpoint address of the MIDI streaming data IN endpoint, for device-to-host data transfers. */
46 #define MIDI_STREAM_IN_EPADDR (ENDPOINT_DIR_IN | 1)
48 /** Endpoint address of the MIDI streaming data OUT endpoint, for host-to-device data transfers. */
49 #define MIDI_STREAM_OUT_EPADDR (ENDPOINT_DIR_OUT | 2)
51 /** Endpoint size in bytes of the Audio isochronous streaming data IN and OUT endpoints. */
52 #define MIDI_STREAM_EPSIZE 64
55 /** Type define for the device configuration descriptor structure. This must be defined in the
56 * application code, as the configuration descriptor contains several sub-descriptors which
57 * vary between devices, and which describe the device's usage to the host.
61 USB_Descriptor_Configuration_Header_t Config;
63 // MIDI Audio Control Interface
64 USB_Descriptor_Interface_t Audio_ControlInterface;
65 USB_Audio_Descriptor_Interface_AC_t Audio_ControlInterface_SPC;
67 // MIDI Audio Streaming Interface
68 USB_Descriptor_Interface_t Audio_StreamInterface;
69 USB_MIDI_Descriptor_AudioInterface_AS_t Audio_StreamInterface_SPC;
70 USB_MIDI_Descriptor_InputJack_t MIDI_In_Jack_Emb;
71 USB_MIDI_Descriptor_InputJack_t MIDI_In_Jack_Ext;
72 USB_MIDI_Descriptor_OutputJack_t MIDI_Out_Jack_Emb;
73 USB_MIDI_Descriptor_OutputJack_t MIDI_Out_Jack_Ext;
74 USB_Audio_Descriptor_StreamEndpoint_Std_t MIDI_In_Jack_Endpoint;
75 USB_MIDI_Descriptor_Jack_Endpoint_t MIDI_In_Jack_Endpoint_SPC;
76 USB_Audio_Descriptor_StreamEndpoint_Std_t MIDI_Out_Jack_Endpoint;
77 USB_MIDI_Descriptor_Jack_Endpoint_t MIDI_Out_Jack_Endpoint_SPC;
78 } USB_Descriptor_Configuration_t;
80 /** Enum for the device interface descriptor IDs within the device. Each interface descriptor
81 * should have a unique ID index associated with it, which can be used to refer to the
82 * interface from other descriptors.
84 enum InterfaceDescriptors_t
86 INTERFACE_ID_AudioControl = 0, /**< Audio control interface descriptor ID */
87 INTERFACE_ID_AudioStream = 1, /**< Audio stream interface descriptor ID */
90 /** Enum for the device string descriptor IDs within the device. Each string descriptor should
91 * have a unique ID index associated with it, which can be used to refer to the string from
94 enum StringDescriptors_t
96 STRING_ID_Language = 0, /**< Supported Languages string descriptor ID (must be zero) */
97 STRING_ID_Manufacturer = 1, /**< Manufacturer string ID */
98 STRING_ID_Product = 2, /**< Product string ID */
101 /* Function Prototypes: */
102 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
103 const uint8_t wIndex,
104 const void** const DescriptorAddress)
105 ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);