Adrien Destugues | 703832c | 2021-09-26 10:16:19 +0200 | [diff] [blame] | 1 | /* |
| 2 | LUFA Library |
| 3 | Copyright (C) Dean Camera, 2021. |
| 4 | |
| 5 | dean [at] fourwalledcubicle [dot] com |
| 6 | www.lufa-lib.org |
| 7 | */ |
| 8 | |
| 9 | /* |
| 10 | Copyright 2021 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 Descriptors.c. |
| 34 | */ |
| 35 | |
| 36 | #ifndef _DESCRIPTORS_H_ |
| 37 | #define _DESCRIPTORS_H_ |
| 38 | |
| 39 | /* Includes: */ |
| 40 | #include <avr/pgmspace.h> |
| 41 | |
| 42 | #include <LUFA/Drivers/USB/USB.h> |
| 43 | |
| 44 | /* Type Defines: */ |
| 45 | /** Type define for the device configuration descriptor structure. This must be defined in the |
| 46 | * application code, as the configuration descriptor contains several sub-descriptors which |
| 47 | * vary between devices, and which describe the device's usage to the host. |
| 48 | */ |
| 49 | typedef struct |
| 50 | { |
| 51 | USB_Descriptor_Configuration_Header_t Config; |
| 52 | |
| 53 | // Joystick HID Interface |
| 54 | USB_Descriptor_Interface_t HID_Interface; |
| 55 | USB_HID_Descriptor_HID_t HID_JoystickHID; |
| 56 | USB_Descriptor_Endpoint_t HID_ReportINEndpoint; |
| 57 | } USB_Descriptor_Configuration_t; |
| 58 | |
| 59 | /** Enum for the device interface descriptor IDs within the device. Each interface descriptor |
| 60 | * should have a unique ID index associated with it, which can be used to refer to the |
| 61 | * interface from other descriptors. |
| 62 | */ |
| 63 | enum InterfaceDescriptors_t |
| 64 | { |
| 65 | INTERFACE_ID_Joystick = 0, /**< Joystick interface desciptor ID */ |
| 66 | }; |
| 67 | |
| 68 | /** Enum for the device string descriptor IDs within the device. Each string descriptor should |
| 69 | * have a unique ID index associated with it, which can be used to refer to the string from |
| 70 | * other descriptors. |
| 71 | */ |
| 72 | enum StringDescriptors_t |
| 73 | { |
| 74 | STRING_ID_Language = 0, /**< Supported Languages string descriptor ID (must be zero) */ |
| 75 | STRING_ID_Manufacturer = 1, /**< Manufacturer string ID */ |
| 76 | STRING_ID_Product = 2, /**< Product string ID */ |
| 77 | }; |
| 78 | |
| 79 | /* Macros: */ |
| 80 | /** Endpoint address of the Joystick HID reporting IN endpoint. */ |
| 81 | #define JOYSTICK_EPADDR (ENDPOINT_DIR_IN | 1) |
| 82 | |
| 83 | /** Size in bytes of the Joystick HID reporting IN endpoint. */ |
| 84 | #define JOYSTICK_EPSIZE 8 |
| 85 | |
| 86 | /* Function Prototypes: */ |
| 87 | uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, |
| 88 | const uint16_t wIndex, |
| 89 | const void** const DescriptorAddress) |
| 90 | ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3); |
| 91 | |
| 92 | #endif |
| 93 | |