3 Copyright (C) Dean Camera, 2014.
5 dean [at] fourwalledcubicle [dot] com
10 Copyright 2014 Dean Camera (dean [at] fourwalledcubicle [dot] com)
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.
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
33 * Header file for Descriptors.c.
36 #ifndef _DESCRIPTORS_H_
37 #define _DESCRIPTORS_H_
40 #include <LUFA/Drivers/USB/USB.h>
42 #include <avr/pgmspace.h>
44 #include "Config/AppConfig.h"
47 /** Endpoint address of the CDC device-to-host data IN endpoint. */
48 #define CDC_TX_EPADDR (ENDPOINT_DIR_IN | 1)
50 /** Endpoint address of the CDC host-to-device data OUT endpoint. */
51 #define CDC_RX_EPADDR (ENDPOINT_DIR_OUT | 2)
53 /** Endpoint address of the CDC device-to-host notification IN endpoint. */
54 #define CDC_NOTIFICATION_EPADDR (ENDPOINT_DIR_IN | 3)
56 /** Size in bytes of the CDC data IN and OUT endpoints. */
57 #define CDC_TXRX_EPSIZE 64
59 /** Size in bytes of the CDC device-to-host notification IN endpoint. */
60 #define CDC_NOTIFICATION_EPSIZE 8
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.
69 USB_Descriptor_Configuration_Header_t Config;
71 // RNDIS 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;
78 // RNDIS CDC Data Interface
79 USB_Descriptor_Interface_t CDC_DCI_Interface;
80 USB_Descriptor_Endpoint_t RNDIS_DataOutEndpoint;
81 USB_Descriptor_Endpoint_t RNDIS_DataInEndpoint;
82 } USB_Descriptor_Configuration_t;
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.
88 enum InterfaceDescriptors_t
90 INTERFACE_ID_CDC_CCI = 0, /**< CDC CCI interface descriptor ID */
91 INTERFACE_ID_CDC_DCI = 1, /**< CDC DCI interface descriptor ID */
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
98 enum StringDescriptors_t
100 STRING_ID_Language = 0, /**< Supported Languages string descriptor ID (must be zero) */
101 STRING_ID_Manufacturer = 1, /**< Manufacturer string ID */
102 STRING_ID_Product = 2, /**< Product string ID */
105 /* Function Prototypes: */
106 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
107 const uint8_t wIndex,
108 const void** const DescriptorAddress)
109 ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);