Demos/Device/ClassDriver/DualMIDI/Descriptors.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2018.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2018  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  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.
  20
  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
  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
  42                 #include <avr/pgmspace.h>
  43
  44         /* Macros: */
  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  | 2)
  47
  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 | 1)
  50
  51                 /** Endpoint size in bytes of the Audio isochronous streaming data IN and OUT endpoints. */
  52                 #define MIDI_STREAM_EPSIZE          64
  53
  54         /* Type Defines: */
  55                 /** Type define for a dual jack endpoint descriptor. This is identical to the LUFA MIDI class driver's
  56                  *  USB_MIDI_Descriptor_Jack_Endpoint_t, except that it contains two jack association entries.
  57                  */
  58                 typedef struct
  59                 {
  60                         USB_Descriptor_Header_t   Header; /**< Regular descriptor header containing the descriptor's type and length. */
  61                         uint8_t                   Subtype; /**< Sub type value used to distinguish between audio class-specific descriptors. */
  62
  63                         uint8_t                   TotalEmbeddedJacks; /**< Total number of jacks inside this endpoint. */
  64                         uint8_t                   AssociatedJackID[2]; /**< IDs of each jack inside the endpoint. */
  65                 } ATTR_PACKED USB_MIDI_Descriptor_DualJack_Endpoint_t;
  66
  67                 /** Type define for the device configuration descriptor structure. This must be defined in the
  68                  *  application code, as the configuration descriptor contains several sub-descriptors which
  69                  *  vary between devices, and which describe the device's usage to the host.
  70                  */
  71                 typedef struct
  72                 {
  73                         USB_Descriptor_Configuration_Header_t     Config;
  74
  75                         // MIDI Audio Control Interface
  76                         USB_Descriptor_Interface_t                Audio_ControlInterface;
  77                         USB_Audio_Descriptor_Interface_AC_t       Audio_ControlInterface_SPC;
  78
  79                         // MIDI Audio Streaming Interface
  80                         USB_Descriptor_Interface_t                Audio_StreamInterface;
  81                         USB_MIDI_Descriptor_AudioInterface_AS_t   Audio_StreamInterface_SPC;
  82                         USB_MIDI_Descriptor_InputJack_t           MIDI_In_Jack_Emb;
  83                         USB_MIDI_Descriptor_InputJack_t           MIDI_In_Jack_Emb2;
  84                         USB_MIDI_Descriptor_InputJack_t           MIDI_In_Jack_Ext;
  85                         USB_MIDI_Descriptor_InputJack_t           MIDI_In_Jack_Ext2;
  86                         USB_MIDI_Descriptor_OutputJack_t          MIDI_Out_Jack_Emb;
  87                         USB_MIDI_Descriptor_OutputJack_t          MIDI_Out_Jack_Emb2;
  88                         USB_MIDI_Descriptor_OutputJack_t          MIDI_Out_Jack_Ext;
  89                         USB_MIDI_Descriptor_OutputJack_t          MIDI_Out_Jack_Ext2;
  90                         USB_Audio_Descriptor_StreamEndpoint_Std_t MIDI_In_Jack_Endpoint;
  91                         USB_MIDI_Descriptor_DualJack_Endpoint_t   MIDI_In_Jack_Endpoint_SPC;
  92                         USB_Audio_Descriptor_StreamEndpoint_Std_t MIDI_Out_Jack_Endpoint;
  93                         USB_MIDI_Descriptor_DualJack_Endpoint_t   MIDI_Out_Jack_Endpoint_SPC;
  94                 } USB_Descriptor_Configuration_t;
  95
  96                 /** Enum for the device interface descriptor IDs within the device. Each interface descriptor
  97                  *  should have a unique ID index associated with it, which can be used to refer to the
  98                  *  interface from other descriptors.
  99                  */
 100                 enum InterfaceDescriptors_t
 101                 {
 102                         INTERFACE_ID_AudioControl = 0, /**< Audio control interface descriptor ID */
 103                         INTERFACE_ID_AudioStream  = 1, /**< Audio streaming interface descriptor ID */
 104                 };
 105
 106                 /** Enum for the device string descriptor IDs within the device. Each string descriptor should
 107                  *  have a unique ID index associated with it, which can be used to refer to the string from
 108                  *  other descriptors.
 109                  */
 110                 enum StringDescriptors_t
 111                 {
 112                         STRING_ID_Language     = 0, /**< Supported Languages string descriptor ID (must be zero) */
 113                         STRING_ID_Manufacturer = 1, /**< Manufacturer string ID */
 114                         STRING_ID_Product      = 2, /**< Product string ID */
 115                 };
 116
 117         /* Function Prototypes: */
 118                 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
 119                                                     const uint16_t wIndex,
 120                                                     const void** const DescriptorAddress)
 121                                                     ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
 122
 123 #endif
 124