Demos/Device/LowLevel/VirtualSerial/Descriptors.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  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 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
  42                 #include <avr/pgmspace.h>
  43
  44         /* Macros: */
  45                 /** Endpoint number of the CDC device-to-host notification IN endpoint. */
  46                 #define CDC_NOTIFICATION_EPNUM         2
  47
  48                 /** Endpoint number of the CDC device-to-host data IN endpoint. */
  49                 #define CDC_TX_EPNUM                   3
  50
  51                 /** Endpoint number of the CDC host-to-device data OUT endpoint. */
  52                 #define CDC_RX_EPNUM                   4
  53
  54                 /** Size in bytes of the CDC device-to-host notification IN endpoint. */
  55                 #define CDC_NOTIFICATION_EPSIZE        8
  56
  57                 /** Size in bytes of the CDC data IN and OUT endpoints. */
  58                 #define CDC_TXRX_EPSIZE                16
  59
  60         /* Type Defines: */
  61                 /** Type define for a CDC class-specific functional header descriptor. This indicates to the host that the device
  62                  *  contains one or more CDC functional data descriptors, which give the CDC interface's capabilities and configuration.
  63                  *  See the CDC class specification for more details.
  64                  */
  65                 typedef struct
  66                 {
  67                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
  68                         uint8_t                 Subtype; /**< Sub type value used to distinguish between CDC class-specific descriptors. */
  69                         uint16_t                CDCSpecification; /**< Version number of the CDC specification implemented by the device,
  70                                                                    *   encoded in BCD format.
  71                                                                    */
  72                 } USB_Descriptor_CDC_FunctionalHeader_t;
  73
  74                 /** Type define for a CDC class-specific functional ACM descriptor. This indicates to the host that the CDC interface
  75                  *  supports the CDC ACM subclass of the CDC specification. See the CDC class specification for more details.
  76                  */
  77                 typedef struct
  78                 {
  79                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
  80                         uint8_t                 Subtype; /**< Sub type value used to distinguish between CDC class-specific descriptors. */
  81                         uint8_t                 Capabilities; /**< Capabilities of the ACM interface, given as a bit mask. */
  82                 } USB_Descriptor_CDC_FunctionalACM_t;
  83
  84                 /** Type define for a CDC class-specific functional Union descriptor. This indicates to the host that specific
  85                  *  CDC control and data interfaces are related. See the CDC class specification for more details.
  86                  */
  87                 typedef struct
  88                 {
  89                         USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
  90                         uint8_t                 Subtype; /**< Sub type value used to distinguish between CDC class-specific descriptors. */
  91                         uint8_t                 MasterInterfaceNumber; /**< Interface number of the CDC Control interface. */
  92                         uint8_t                 SlaveInterfaceNumber; /**< Interface number of the CDC Data interface. */
  93                 } USB_Descriptor_CDC_FunctionalUnion_t;
  94
  95                 /** Type define for the device configuration descriptor structure. This must be defined in the
  96                  *  application code, as the configuration descriptor contains several sub-descriptors which
  97                  *  vary between devices, and which describe the device's usage to the host.
  98                  */
  99                 typedef struct
 100                 {
 101                         USB_Descriptor_Configuration_Header_t    Config;
 102                         USB_Descriptor_Interface_t               CDC_CCI_Interface;
 103                         USB_Descriptor_CDC_FunctionalHeader_t    CDC_Functional_Header;
 104                         USB_Descriptor_CDC_FunctionalACM_t       CDC_Functional_ACM;
 105                         USB_Descriptor_CDC_FunctionalUnion_t     CDC_Functional_Union;
 106                         USB_Descriptor_Endpoint_t                CDC_NotificationEndpoint;
 107                         USB_Descriptor_Interface_t               CDC_DCI_Interface;
 108                         USB_Descriptor_Endpoint_t                CDC_DataOutEndpoint;
 109                         USB_Descriptor_Endpoint_t                CDC_DataInEndpoint;
 110                 } USB_Descriptor_Configuration_t;
 111
 112         /* Function Prototypes: */
 113                 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
 114                                                     const uint8_t wIndex,
 115                                                     const void** const DescriptorAddress)
 116                                                     ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
 117
 118 #endif