lib/lufa/Projects/XPLAINBridge/USARTDescriptors.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 USARTDescriptors.c.
  34  */
  35
  36 #ifndef _USART_DESCRIPTORS_H_
  37 #define _USART_DESCRIPTORS_H_
  38
  39         /* Includes: */
  40                 #include <avr/pgmspace.h>
  41
  42                 #include <LUFA/Drivers/USB/USB.h>
  43
  44                 #include "Config/AppConfig.h"
  45
  46         /* Macros: */
  47                 /** Endpoint address of the CDC device-to-host notification IN endpoint. */
  48                 #define CDC_NOTIFICATION_EPADDR        (ENDPOINT_DIR_IN  | 2)
  49
  50                 /** Endpoint address of the CDC device-to-host data IN endpoint. */
  51                 #define CDC_TX_EPADDR                  (ENDPOINT_DIR_IN  | 3)
  52
  53                 /** Endpoint address of the CDC host-to-device data OUT endpoint. */
  54                 #define CDC_RX_EPADDR                  (ENDPOINT_DIR_OUT | 4)
  55
  56                 /** Size in bytes of the CDC device-to-host notification IN endpoint. */
  57                 #define CDC_NOTIFICATION_EPSIZE        8
  58
  59                 /** Size in bytes of the CDC data IN and OUT endpoints. */
  60                 #define CDC_TXRX_EPSIZE                16
  61
  62         /* Type Defines: */
  63                 /** Type define for the device configuration descriptor structure. This must be defined in the
  64                  *  application code, as the configuration descriptor contains several sub-descriptors which
  65                  *  vary between devices, and which describe the device's usage to the host.
  66                  */
  67                 typedef struct
  68                 {
  69                         USB_Descriptor_Configuration_Header_t    Config;
  70
  71                         // CDC Control Interface
  72                         USB_Descriptor_Interface_t               CDC_CCI_Interface;
  73                         USB_CDC_Descriptor_FunctionalHeader_t    CDC_Functional_Header;
  74                         USB_CDC_Descriptor_FunctionalACM_t       CDC_Functional_ACM;
  75                         USB_CDC_Descriptor_FunctionalUnion_t     CDC_Functional_Union;
  76                         USB_Descriptor_Endpoint_t                CDC_NotificationEndpoint;
  77
  78                         // CDC Data Interface
  79                         USB_Descriptor_Interface_t               CDC_DCI_Interface;
  80                         USB_Descriptor_Endpoint_t                CDC_DataOutEndpoint;
  81                         USB_Descriptor_Endpoint_t                CDC_DataInEndpoint;
  82                 } USART_USB_Descriptor_Configuration_t;
  83
  84                 /** Enum for the device interface descriptor IDs within the device. Each interface descriptor
  85                  *  should have a unique ID index associated with it, which can be used to refer to the
  86                  *  interface from other descriptors.
  87                  */
  88                 enum USART_InterfaceDescriptors_t
  89                 {
  90                         INTERFACE_ID_CDC_CCI = 0, /**< CDC CCI interface descriptor ID */
  91                         INTERFACE_ID_CDC_DCI = 1, /**< CDC DCI interface descriptor ID */
  92                 };
  93
  94                 /** Enum for the device string descriptor IDs within the device. Each string descriptor should
  95                  *  have a unique ID index associated with it, which can be used to refer to the string from
  96                  *  other descriptors.
  97                  */
  98                 enum USART_StringDescriptors_t
  99                 {
 100                         USART_STRING_ID_Language     = 0, /**< Supported Languages string descriptor ID (must be zero) */
 101                         USART_STRING_ID_Manufacturer = 1, /**< Manufacturer string ID */
 102                         USART_STRING_ID_Product      = 2, /**< Product string ID */
 103                 };
 104
 105         /* Function Prototypes: */
 106                 uint16_t USART_GetDescriptor(const uint16_t wValue,
 107                                              const uint16_t wIndex,
 108                                              const void** const DescriptorAddress);
 109
 110 #endif
 111