tmk_core/protocol/lufa/LUFA-git/Projects/SerialToLCD/Descriptors.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2014.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2014  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11   Copyright 2012  Simon Foster (simon.foster [at] inbox [dot] com)
  12
  13   Permission to use, copy, modify, distribute, and sell this
  14   software and its documentation for any purpose is hereby granted
  15   without fee, provided that the above copyright notice appear in
  16   all copies and that both that the copyright notice and this
  17   permission notice and warranty disclaimer appear in supporting
  18   documentation, and that the name of the author not be used in
  19   advertising or publicity pertaining to distribution of the
  20   software without specific, written prior permission.
  21
  22   The author disclaims all warranties with regard to this
  23   software, including all implied warranties of merchantability
  24   and fitness.  In no event shall the author be liable for any
  25   special, indirect or consequential damages or any damages
  26   whatsoever resulting from loss of use, data or profits, whether
  27   in an action of contract, negligence or other tortious action,
  28   arising out of or in connection with the use or performance of
  29   this software.
  30 */
  31
  32 /** \file
  33  *
  34  *  Header file for Descriptors.c.
  35  */
  36
  37 #ifndef _DESCRIPTORS_H_
  38 #define _DESCRIPTORS_H_
  39
  40         /* Includes: */
  41                 #include <avr/pgmspace.h>
  42
  43                 #include <LUFA/Drivers/USB/USB.h>
  44
  45         /* Macros: */
  46                 /** Endpoint address of the CDC device-to-host notification IN endpoint. */
  47                 #define CDC_NOTIFICATION_EPADDR        (ENDPOINT_DIR_IN  | 2)
  48
  49                 /** Endpoint address of the CDC device-to-host data IN endpoint. */
  50                 #define CDC_TX_EPADDR                  (ENDPOINT_DIR_IN  | 3)
  51
  52                 /** Endpoint address of the CDC host-to-device data OUT endpoint. */
  53                 #define CDC_RX_EPADDR                  (ENDPOINT_DIR_OUT | 4)
  54
  55                 /** Size in bytes of the CDC device-to-host notification IN endpoint. */
  56                 #define CDC_NOTIFICATION_EPSIZE        8
  57
  58                 /** Size in bytes of the CDC data IN and OUT endpoints. */
  59                 #define CDC_TXRX_EPSIZE                16
  60
  61         /* Type Defines: */
  62                 /** Type define for the device configuration descriptor structure. This must be defined in the
  63                  *  application code, as the configuration descriptor contains several sub-descriptors which
  64                  *  vary between devices, and which describe the device's usage to the host.
  65                  */
  66                 typedef struct
  67                 {
  68                         USB_Descriptor_Configuration_Header_t    Config;
  69
  70                         // CDC Command Interface
  71                         USB_Descriptor_Interface_t               CDC_CCI_Interface;
  72                         USB_CDC_Descriptor_FunctionalHeader_t    CDC_Functional_Header;
  73                         USB_CDC_Descriptor_FunctionalACM_t       CDC_Functional_ACM;
  74                         USB_CDC_Descriptor_FunctionalUnion_t     CDC_Functional_Union;
  75                         USB_Descriptor_Endpoint_t                CDC_NotificationEndpoint;
  76
  77                         // CDC Data Interface
  78                         USB_Descriptor_Interface_t               CDC_DCI_Interface;
  79                         USB_Descriptor_Endpoint_t                CDC_DataOutEndpoint;
  80                         USB_Descriptor_Endpoint_t                CDC_DataInEndpoint;
  81                 } USB_Descriptor_Configuration_t;
  82
  83                 /** Enum for the device interface descriptor IDs within the device. Each interface descriptor
  84                  *  should have a unique ID index associated with it, which can be used to refer to the
  85                  *  interface from other descriptors.
  86                  */
  87                 enum InterfaceDescriptors_t
  88                 {
  89                         INTERFACE_ID_CDC_CCI = 0, /**< CDC CCI interface descriptor ID */
  90                         INTERFACE_ID_CDC_DCI = 1, /**< CDC DCI interface descriptor ID */
  91                 };
  92
  93                 /** Enum for the device string descriptor IDs within the device. Each string descriptor should
  94                  *  have a unique ID index associated with it, which can be used to refer to the string from
  95                  *  other descriptors.
  96                  */
  97                 enum StringDescriptors_t
  98                 {
  99                         STRING_ID_Language     = 0, /**< Supported Languages string descriptor ID (must be zero) */
 100                         STRING_ID_Manufacturer = 1, /**< Manufacturer string ID */
 101                         STRING_ID_Product      = 2, /**< Product string ID */
 102                 };
 103
 104         /* Function Prototypes: */
 105                 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
 106                                                     const uint8_t wIndex,
 107                                                     const void** const DescriptorAddress)
 108                                                     ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
 109
 110 #endif
 111