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 /** Type define for the device configuration descriptor structure. This must be defined in the
48 * application code, as the configuration descriptor contains several sub-descriptors which
49 * vary between devices, and which describe the device's usage to the host.
53 USB_Descriptor_Configuration_Header_t Config;
55 // Generic HID Interface
56 USB_Descriptor_Interface_t HID_Interface;
57 USB_HID_Descriptor_HID_t HID_GenericHID;
58 USB_Descriptor_Endpoint_t HID_ReportINEndpoint;
59 USB_Descriptor_Endpoint_t HID_ReportOUTEndpoint;
60 } USB_Descriptor_Configuration_t;
62 /** Enum for the device interface descriptor IDs within the device. Each interface descriptor
63 * should have a unique ID index associated with it, which can be used to refer to the
64 * interface from other descriptors.
66 enum InterfaceDescriptors_t
68 INTERFACE_ID_GenericHID = 0, /**< GenericHID interface descriptor ID */
71 /** Enum for the device string descriptor IDs within the device. Each string descriptor should
72 * have a unique ID index associated with it, which can be used to refer to the string from
75 enum StringDescriptors_t
77 STRING_ID_Language = 0, /**< Supported Languages string descriptor ID (must be zero) */
78 STRING_ID_Manufacturer = 1, /**< Manufacturer string ID */
79 STRING_ID_Product = 2, /**< Product string ID */
83 /** Endpoint address of the Generic HID reporting IN endpoint. */
84 #define GENERIC_IN_EPADDR (ENDPOINT_DIR_IN | 1)
86 /** Endpoint address of the Generic HID reporting OUT endpoint. */
87 #define GENERIC_OUT_EPADDR (ENDPOINT_DIR_OUT | 2)
89 /** Size in bytes of the Generic HID reporting endpoint. */
90 #define GENERIC_EPSIZE 8
92 /* Function Prototypes: */
93 uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
95 const void** const DescriptorAddress)
96 ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);