usb_descriptors.h 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116
  1. // SPDX-License-Identifier: BSD-3-Clause
  2. // Copyright (c) 2019-2022, Alex Taradov <alex@taradov.com>. All rights reserved.
  3. #ifndef _USB_DESCRIPTORS_H_
  4. #define _USB_DESCRIPTORS_H_
  5. /*- Includes ----------------------------------------------------------------*/
  6. #include "usb_std.h"
  7. #include "usb_cdc.h"
  8. #include "usb_hid.h"
  9. #include "usb_winusb.h"
  10. #include "hal_config.h"
  11. /*- Definitions -------------------------------------------------------------*/
  12. #define USB_ENABLE_BOS
  13. #define USB_BCD_VERSION 0x0210
  14. enum
  15. {
  16. USB_STR_ZERO,
  17. USB_STR_MANUFACTURER,
  18. USB_STR_PRODUCT,
  19. USB_STR_SERIAL_NUMBER,
  20. USB_STR_CMSIS_DAP_V1,
  21. USB_STR_CMSIS_DAP_V2,
  22. #ifdef HAL_CONFIG_ENABLE_VCP
  23. USB_STR_COM_PORT,
  24. #endif
  25. USB_STR_COUNT,
  26. };
  27. enum
  28. {
  29. USB_HID_EP_SEND = 1,
  30. USB_HID_EP_RECV = 2,
  31. USB_BULK_EP_RECV = 3,
  32. USB_BULK_EP_SEND = 4,
  33. USB_CDC_EP_COMM = 5,
  34. USB_CDC_EP_SEND = 6,
  35. USB_CDC_EP_RECV = 7,
  36. };
  37. enum
  38. {
  39. USB_INTF_HID,
  40. USB_INTF_BULK,
  41. #ifdef HAL_CONFIG_ENABLE_VCP
  42. USB_INTF_CDC_COMM,
  43. USB_INTF_CDC_DATA,
  44. #endif
  45. USB_INTF_COUNT,
  46. };
  47. /*- Types -------------------------------------------------------------------*/
  48. typedef struct USB_PACK
  49. {
  50. usb_configuration_descriptor_t configuration;
  51. usb_interface_descriptor_t hid_interface;
  52. usb_hid_descriptor_t hid;
  53. usb_endpoint_descriptor_t hid_ep_in;
  54. usb_endpoint_descriptor_t hid_ep_out;
  55. usb_interface_descriptor_t bulk_interface;
  56. usb_endpoint_descriptor_t bulk_ep_out;
  57. usb_endpoint_descriptor_t bulk_ep_in;
  58. #ifdef HAL_CONFIG_ENABLE_VCP
  59. usb_interface_association_descriptor_t iad;
  60. usb_interface_descriptor_t interface_comm;
  61. usb_cdc_header_functional_descriptor_t cdc_header;
  62. usb_cdc_abstract_control_managment_descriptor_t cdc_acm;
  63. usb_cdc_call_managment_functional_descriptor_t cdc_call_mgmt;
  64. usb_cdc_union_functional_descriptor_t cdc_union;
  65. usb_endpoint_descriptor_t ep_comm;
  66. usb_interface_descriptor_t interface_data;
  67. usb_endpoint_descriptor_t ep_in;
  68. usb_endpoint_descriptor_t ep_out;
  69. #endif
  70. } usb_configuration_hierarchy_t;
  71. typedef struct USB_PACK
  72. {
  73. usb_binary_object_store_descriptor_t bos;
  74. usb_winusb_capability_descriptor_t winusb;
  75. } usb_bos_hierarchy_t;
  76. typedef struct USB_PACK
  77. {
  78. usb_winusb_subset_header_function_t header;
  79. usb_winusb_feature_compatble_id_t comp_id;
  80. usb_winusb_feature_reg_property_guids_t property;
  81. } usb_msos_descriptor_subset_t;
  82. typedef struct USB_PACK
  83. {
  84. usb_winusb_set_header_descriptor_t header;
  85. usb_msos_descriptor_subset_t subset;
  86. } usb_msos_descriptor_set_t;
  87. //-----------------------------------------------------------------------------
  88. extern const usb_device_descriptor_t usb_device_descriptor;
  89. extern const usb_configuration_hierarchy_t usb_configuration_hierarchy;
  90. extern const usb_bos_hierarchy_t usb_bos_hierarchy;
  91. extern const usb_msos_descriptor_set_t usb_msos_descriptor_set;
  92. extern const uint8_t usb_hid_report_descriptor[28];
  93. extern const usb_string_descriptor_zero_t usb_string_descriptor_zero;
  94. extern const char *usb_strings[];
  95. #ifdef HAL_CONFIG_ENABLE_VCP
  96. extern const usb_class_handler_t usb_class_handlers[3];
  97. #else
  98. extern const usb_class_handler_t usb_class_handlers[2];
  99. #endif
  100. extern char usb_serial_number[16];
  101. #endif // _USB_DESCRIPTORS_H_