lib/lufa/Demos/Device/LowLevel/AudioInput/Descriptors.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2017.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2017  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                 #include "Config/AppConfig.h"
  45
  46         /* Macros: */
  47                 /** Endpoint address of the Audio isochronous streaming data IN endpoint. */
  48                 #define AUDIO_STREAM_EPADDR          (ENDPOINT_DIR_IN | 1)
  49
  50                 /** Endpoint size in bytes of the Audio isochronous streaming data endpoint. */
  51                 #define AUDIO_STREAM_EPSIZE           256
  52
  53         /* Type Defines: */
  54                 /** Type define for the device configuration descriptor structure. This must be defined in the
  55                  *  application code, as the configuration descriptor contains several sub-descriptors which
  56                  *  vary between devices, and which describe the device's usage to the host.
  57                  */
  58                 typedef struct
  59                 {
  60                         USB_Descriptor_Configuration_Header_t     Config;
  61
  62                         // Audio Control Interface
  63                         USB_Descriptor_Interface_t                Audio_ControlInterface;
  64                         USB_Audio_Descriptor_Interface_AC_t       Audio_ControlInterface_SPC;
  65                         USB_Audio_Descriptor_InputTerminal_t      Audio_InputTerminal;
  66                         USB_Audio_Descriptor_OutputTerminal_t     Audio_OutputTerminal;
  67
  68                         // Audio Streaming Interface
  69                         USB_Descriptor_Interface_t                Audio_StreamInterface_Alt0;
  70                         USB_Descriptor_Interface_t                Audio_StreamInterface_Alt1;
  71                         USB_Audio_Descriptor_Interface_AS_t       Audio_StreamInterface_SPC;
  72                         USB_Audio_Descriptor_Format_t             Audio_AudioFormat;
  73                         USB_Audio_SampleFreq_t                    Audio_AudioFormatSampleRates[5];
  74                         USB_Audio_Descriptor_StreamEndpoint_Std_t Audio_StreamEndpoint;
  75                         USB_Audio_Descriptor_StreamEndpoint_Spc_t Audio_StreamEndpoint_SPC;
  76                 } USB_Descriptor_Configuration_t;
  77
  78                 /** Enum for the device interface descriptor IDs within the device. Each interface descriptor
  79                  *  should have a unique ID index associated with it, which can be used to refer to the
  80                  *  interface from other descriptors.
  81                  */
  82                 enum InterfaceDescriptors_t
  83                 {
  84                         INTERFACE_ID_AudioControl = 0, /**< Audio control interface descriptor ID */
  85                         INTERFACE_ID_AudioStream  = 1, /**< Audio stream interface descriptor ID */
  86                 };
  87
  88                 /** Enum for the device string descriptor IDs within the device. Each string descriptor should
  89                  *  have a unique ID index associated with it, which can be used to refer to the string from
  90                  *  other descriptors.
  91                  */
  92                 enum StringDescriptors_t
  93                 {
  94                         STRING_ID_Language     = 0, /**< Supported Languages string descriptor ID (must be zero) */
  95                         STRING_ID_Manufacturer = 1, /**< Manufacturer string ID */
  96                         STRING_ID_Product      = 2, /**< Product string ID */
  97                 };
  98
  99         /* Function Prototypes: */
 100                 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
 101                                                     const uint16_t wIndex,
 102                                                     const void** const DescriptorAddress)
 103                                                     ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
 104
 105 #endif
 106