Demos/Device/MIDI/Descriptors.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   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.
  20
  21   The author disclaim 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
  28   this software.
  29 */
  30
  31 /** \file
  32  *
  33  *  Header file for Descriptors.c.
  34  */
  35
  36 #ifndef _DESCRIPTORS_H_
  37 #define _DESCRIPTORS_H_
  38
  39         /* Includes: */
  40                 #include <LUFA/Drivers/USB/USB.h>
  41                 #include <LUFA/Drivers/USB/Class/Device/MIDI.h>
  42
  43                 #include <avr/pgmspace.h>
  44
  45         /* Macros: */
  46                 /** Endpoint number of the MIDI streaming data IN endpoint, for device-to-host data transfers. */
  47                 #define MIDI_STREAM_IN_EPNUM        2
  48
  49                 /** Endpoint number of the MIDI streaming data OUT endpoint, for host-to-device data transfers. */
  50                 #define MIDI_STREAM_OUT_EPNUM       1
  51
  52                 /** Endpoint size in bytes of the Audio isochronous streaming data IN and OUT endpoints. */
  53                 #define MIDI_STREAM_EPSIZE          64
  54
  55         /* Type Defines: */
  56                 /** Type define for the device configuration descriptor structure. This must be defined in the
  57                  *  application code, as the configuration descriptor contains several sub-descriptors which
  58                  *  vary between devices, and which describe the device's usage to the host.
  59                  */
  60                 typedef struct
  61                 {
  62                         USB_Descriptor_Configuration_Header_t Config;
  63                         USB_Descriptor_Interface_t            AudioControlInterface;
  64                         USB_AudioInterface_AC_t               AudioControlInterface_SPC;
  65                         USB_Descriptor_Interface_t            AudioStreamInterface;
  66                         USB_AudioInterface_MIDI_AS_t          AudioStreamInterface_SPC;
  67                         USB_MIDI_In_Jack_t                    MIDI_In_Jack_Emb;
  68                         USB_MIDI_In_Jack_t                    MIDI_In_Jack_Ext;
  69                         USB_MIDI_Out_Jack_t                   MIDI_Out_Jack_Emb;
  70                         USB_MIDI_Out_Jack_t                   MIDI_Out_Jack_Ext;
  71                         USB_AudioStreamEndpoint_Std_t         MIDI_In_Jack_Endpoint;
  72                         USB_MIDI_Jack_Endpoint_t              MIDI_In_Jack_Endpoint_SPC;
  73                         USB_AudioStreamEndpoint_Std_t         MIDI_Out_Jack_Endpoint;
  74                         USB_MIDI_Jack_Endpoint_t              MIDI_Out_Jack_Endpoint_SPC;
  75                 } USB_Descriptor_Configuration_t;
  76
  77         /* Function Prototypes: */
  78                 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)
  79                                                                                         ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
  80
  81 #endif