Descriptors.h 2.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  1. /*
  2. LUFA Library
  3. Copyright (C) Dean Camera, 2018.
  4. dean [at] fourwalledcubicle [dot] com
  5. www.lufa-lib.org
  6. */
  7. /*
  8. Copyright 2018 Dean Camera (dean [at] fourwalledcubicle [dot] com)
  9. Permission to use, copy, modify, distribute, and sell this
  10. software and its documentation for any purpose is hereby granted
  11. without fee, provided that the above copyright notice appear in
  12. all copies and that both that the copyright notice and this
  13. permission notice and warranty disclaimer appear in supporting
  14. documentation, and that the name of the author not be used in
  15. advertising or publicity pertaining to distribution of the
  16. software without specific, written prior permission.
  17. The author disclaims all warranties with regard to this
  18. software, including all implied warranties of merchantability
  19. and fitness. In no event shall the author be liable for any
  20. special, indirect or consequential damages or any damages
  21. whatsoever resulting from loss of use, data or profits, whether
  22. in an action of contract, negligence or other tortious action,
  23. arising out of or in connection with the use or performance of
  24. this software.
  25. */
  26. /** \file
  27. *
  28. * Header file for Descriptors.c.
  29. */
  30. #ifndef _DESCRIPTORS_H_
  31. #define _DESCRIPTORS_H_
  32. /* Includes: */
  33. #include <LUFA/Drivers/USB/USB.h>
  34. /* Type Defines: */
  35. /** Type define for the device configuration descriptor structure. This must be defined in the
  36. * application code, as the configuration descriptor contains several sub-descriptors which
  37. * vary between devices, and which describe the device's usage to the host.
  38. */
  39. typedef struct
  40. {
  41. USB_Descriptor_Configuration_Header_t Config;
  42. // Generic HID Interface
  43. USB_Descriptor_Interface_t HID_Interface;
  44. USB_HID_Descriptor_HID_t HID_VendorHID;
  45. USB_Descriptor_Endpoint_t HID_ReportINEndpoint;
  46. } USB_Descriptor_Configuration_t;
  47. /** Enum for the device interface descriptor IDs within the device. Each interface descriptor
  48. * should have a unique ID index associated with it, which can be used to refer to the
  49. * interface from other descriptors.
  50. */
  51. enum InterfaceDescriptors_t
  52. {
  53. INTERFACE_ID_GenericHID = 0, /**< GenericHID interface descriptor ID */
  54. };
  55. /* Macros: */
  56. /** Endpoint address of the HID data IN endpoint. */
  57. #define HID_IN_EPADDR (ENDPOINT_DIR_IN | 1)
  58. /** Size in bytes of the HID reporting IN endpoint. */
  59. #define HID_IN_EPSIZE 64
  60. /* Function Prototypes: */
  61. uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
  62. const uint16_t wIndex,
  63. const void** const DescriptorAddress)
  64. ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
  65. #endif