app_usbd_cdc_desc.h 9.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208
  1. /**
  2. * Copyright (c) 2016 - 2020, Nordic Semiconductor ASA
  3. *
  4. * All rights reserved.
  5. *
  6. * Redistribution and use in source and binary forms, with or without modification,
  7. * are permitted provided that the following conditions are met:
  8. *
  9. * 1. Redistributions of source code must retain the above copyright notice, this
  10. * list of conditions and the following disclaimer.
  11. *
  12. * 2. Redistributions in binary form, except as embedded into a Nordic
  13. * Semiconductor ASA integrated circuit in a product or a software update for
  14. * such product, must reproduce the above copyright notice, this list of
  15. * conditions and the following disclaimer in the documentation and/or other
  16. * materials provided with the distribution.
  17. *
  18. * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
  19. * contributors may be used to endorse or promote products derived from this
  20. * software without specific prior written permission.
  21. *
  22. * 4. This software, with or without modification, must only be used with a
  23. * Nordic Semiconductor ASA integrated circuit.
  24. *
  25. * 5. Any software provided in binary form under this license must not be reverse
  26. * engineered, decompiled, modified and/or disassembled.
  27. *
  28. * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
  29. * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  30. * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
  31. * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
  32. * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  33. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  34. * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  35. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  36. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  37. * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  38. *
  39. */
  40. #ifndef APP_USBD_CDC_DESC_H__
  41. #define APP_USBD_CDC_DESC_H__
  42. #include <stdint.h>
  43. #include <stdbool.h>
  44. #include "app_usbd_descriptor.h"
  45. #include "app_usbd_cdc_types.h"
  46. #ifdef __cplusplus
  47. extern "C" {
  48. #endif
  49. /**
  50. * @defgroup app_usbd_cdc_desc CDC class descriptors
  51. * @brief @tagAPI52840 Descriptors used in the USB CDC class implementation.
  52. * @ingroup app_usbd_cdc_acm
  53. *
  54. * A group of macros used to initialize CDC descriptors
  55. * @{
  56. */
  57. /**
  58. * @brief Initializer of IAD descriptor for CDC class.
  59. *
  60. * @param interface_number Interface number.
  61. * @param subclass Subclass, @ref app_usbd_cdc_subclass_t.
  62. * @param protocol Protocol, @ref app_usbd_cdc_comm_protocol_t.
  63. */
  64. #define APP_USBD_CDC_IAD_DSC(interface_number, subclass, protocol) \
  65. /*.bLength = */ sizeof(app_usbd_descriptor_iad_t), \
  66. /*.bDescriptorType = */ APP_USBD_DESCRIPTOR_INTERFACE_ASSOCIATION, \
  67. /*.bFirstInterface = */ interface_number, \
  68. /*.bInterfaceCount = */ 2, \
  69. /*.bFunctionClass = */ APP_USBD_CDC_COMM_CLASS, \
  70. /*.bFunctionSubClass = */ subclass, \
  71. /*.bFunctionProtocol = */ protocol, \
  72. /*.iFunction = */ 0, \
  73. /**
  74. * @brief Initializer of interface descriptor for CDC COMM class.
  75. *
  76. * @param interface_number Interface number.
  77. * @param subclass Subclass, @ref app_usbd_cdc_subclass_t.
  78. * @param protocol Protocol, @ref app_usbd_cdc_comm_protocol_t.
  79. */
  80. #define APP_USBD_CDC_COMM_INTERFACE_DSC(interface_number, subclass, protocol) \
  81. /*.bLength = */ sizeof(app_usbd_descriptor_iface_t), \
  82. /*.bDescriptorType = */ APP_USBD_DESCRIPTOR_INTERFACE, \
  83. /*.bInterfaceNumber = */ interface_number, \
  84. /*.bAlternateSetting = */ 0x00, \
  85. /*.bNumEndpoints = */ 1, \
  86. /*.bInterfaceClass = */ APP_USBD_CDC_COMM_CLASS, \
  87. /*.bInterfaceSubClass = */ subclass, \
  88. /*.bInterfaceProtocol = */ protocol, \
  89. /*.iInterface = 0, */ 0x00, \
  90. /**
  91. * @brief Initializer of interface descriptor for CDC DATA class.
  92. *
  93. * @param interface_number Interface number.
  94. * @param subclass Subclass, @ref app_usbd_cdc_subclass_t.
  95. * @param protocol Protocol, @ref app_usbd_cdc_data_protocol_t.
  96. */
  97. #define APP_USBD_CDC_DATA_INTERFACE_DSC(interface_number, subclass, protocol) \
  98. /*.bLength = */ sizeof(app_usbd_descriptor_iface_t), \
  99. /*.bDescriptorType = */ APP_USBD_DESCRIPTOR_INTERFACE, \
  100. /*.bInterfaceNumber = */ interface_number, \
  101. /*.bAlternateSetting = */ 0x00, \
  102. /*.bNumEndpoints = */ 2, \
  103. /*.bInterfaceClass = */ APP_USBD_CDC_DATA_CLASS, \
  104. /*.bInterfaceSubClass = */ subclass, \
  105. /*.bInterfaceProtocol = */ protocol, \
  106. /*.iInterface = 0, */ 0x00, \
  107. /**
  108. * @brief Initializer of endpoint descriptor for CDC COM class.
  109. *
  110. * @param endpoint_in IN endpoint.
  111. * @param ep_size Endpoint size.
  112. */
  113. #define APP_USBD_CDC_COM_EP_DSC(endpoint_in, ep_size) \
  114. /*.bLength = */ sizeof(app_usbd_descriptor_ep_t), \
  115. /*.bDescriptorType = */ APP_USBD_DESCRIPTOR_ENDPOINT, \
  116. /*.bEndpointAddress = */ endpoint_in, \
  117. /*.bmAttributes = */ APP_USBD_DESCRIPTOR_EP_ATTR_TYPE_INTERRUPT, \
  118. /*.wMaxPacketSize = */ APP_USBD_U16_TO_RAW_DSC(ep_size), \
  119. /*.bInterval = */ 16, \
  120. /**
  121. * @brief Initializer of endpoint descriptors for CDC DATA class.
  122. *
  123. * @param endpoint_in IN endpoint.
  124. * @param endpoint_out OUT endpoint.
  125. * @param ep_size Endpoint size.
  126. */
  127. #define APP_USBD_CDC_DATA_EP_DSC(endpoint_in, endpoint_out, ep_size) \
  128. /*.bLength = */ sizeof(app_usbd_descriptor_ep_t), \
  129. /*.bDescriptorType = */ APP_USBD_DESCRIPTOR_ENDPOINT, \
  130. /*.bEndpointAddress = */ endpoint_in, \
  131. /*.bmAttributes = */ APP_USBD_DESCRIPTOR_EP_ATTR_TYPE_BULK, \
  132. /*.wMaxPacketSize = */ APP_USBD_U16_TO_RAW_DSC(ep_size), \
  133. /*.bInterval = */ 0, \
  134. /*.bLength = */ sizeof(app_usbd_descriptor_ep_t), \
  135. /*.bDescriptorType = */ APP_USBD_DESCRIPTOR_ENDPOINT, \
  136. /*.bEndpointAddress = */ endpoint_out, \
  137. /*.bmAttributes = */ APP_USBD_DESCRIPTOR_EP_ATTR_TYPE_BULK, \
  138. /*.wMaxPacketSize = */ APP_USBD_U16_TO_RAW_DSC(ep_size), \
  139. /*.bInterval = */ 0, \
  140. /**
  141. * @brief Initializer of endpoint descriptors for CDC header descriptor.
  142. *
  143. * @param bcd_cdc BCD CDC version.
  144. */
  145. #define APP_USBD_CDC_HEADER_DSC(bcd_cdc) \
  146. /*.bLength = */ sizeof(app_usbd_cdc_desc_header_t), \
  147. /*.bDescriptorType = */ APP_USBD_CDC_CS_INTERFACE, \
  148. /*.bDescriptorSubtype = */ APP_USBD_CDC_SCS_HEADER, \
  149. /*.bcdCDC = */ APP_USBD_U16_TO_RAW_DSC(bcd_cdc), \
  150. /**
  151. * @brief Initializer of endpoint descriptors for CDC call management descriptor.
  152. *
  153. * @param capabilities Capabilities.
  154. * @param data_interface Data interface.
  155. */
  156. #define APP_USBD_CDC_CALL_MGMT_DSC(capabilities, data_interface) \
  157. /*.bLength = */ sizeof(app_usbd_cdc_desc_call_mgmt_t), \
  158. /*.bDescriptorType = */ APP_USBD_CDC_CS_INTERFACE, \
  159. /*.bDescriptorSubtype = */ APP_USBD_CDC_SCS_CALL_MGMT, \
  160. /*.bmCapabilities = */ capabilities, \
  161. /*.bDataInterface = */ data_interface, \
  162. /**
  163. * @brief Initializer of endpoint descriptors for CDC DATA class.
  164. *
  165. * @param capabilities Capabilities.
  166. */
  167. #define APP_USBD_CDC_ACM_DSC(capabilities) \
  168. /*.bLength = */ sizeof(app_usbd_cdc_desc_acm_t), \
  169. /*.bDescriptorType = */ APP_USBD_CDC_CS_INTERFACE, \
  170. /*.bDescriptorSubtype = */ APP_USBD_CDC_SCS_ACM, \
  171. /*.bmCapabilities = */ capabilities, \
  172. /**
  173. * @brief Initializer of endpoint descriptors for CDC DATA class.
  174. *
  175. * @param control_interface Control interface.
  176. * @param ... Subordinate interfaces list.
  177. */
  178. #define APP_USBD_CDC_UNION_DSC(control_interface, ...) \
  179. /*.bLength = */ sizeof(app_usbd_cdc_desc_union_t) + (NUM_VA_ARGS(__VA_ARGS__)), \
  180. /*.bDescriptorType = */ APP_USBD_CDC_CS_INTERFACE, \
  181. /*.bDescriptorSubtype = */ APP_USBD_CDC_SCS_UNION, \
  182. /*.bControlInterface = */ control_interface, \
  183. /*.bSubordinateInterface = */ __VA_ARGS__, \
  184. /** @} */
  185. #ifdef __cplusplus
  186. }
  187. #endif
  188. #endif /* APP_USBD_CDC_H__ */