app_usbd_msc_desc.h 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
  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_MSC_DESC_H__
  41. #define APP_USBD_MSC_DESC_H__
  42. #include "app_usbd_descriptor.h"
  43. #ifdef __cplusplus
  44. extern "C" {
  45. #endif
  46. /**
  47. * @defgroup app_usbd_msc_desc USB MSC descriptors
  48. * @ingroup app_usbd_msc
  49. *
  50. * @brief @tagAPI52840 Descriptors for the USB MSC class.
  51. * @{
  52. */
  53. /**
  54. * @brief Initializer of interface descriptor for MSC class.
  55. *
  56. * @param interface_number Interface number.
  57. * @param subclass Subclass, @ref app_usbd_msc_subclass_t
  58. * @param protocol Protocol, @ref app_usbd_msc_protocol_t
  59. * */
  60. #define APP_USBD_MSC_INTERFACE_DSC(interface_number, subclass, protocol) \
  61. /*.bLength = */ sizeof(app_usbd_descriptor_iface_t), \
  62. /*.bDescriptorType = */ APP_USBD_DESCRIPTOR_INTERFACE, \
  63. /*.bInterfaceNumber = */ interface_number, \
  64. /*.bAlternateSetting = */ 0x00, \
  65. /*.bNumEndpoints = */ 2, \
  66. /*.bInterfaceClass = */ APP_USBD_MSC_CLASS, \
  67. /*.bInterfaceSubClass = */ subclass, \
  68. /*.bInterfaceProtocol = */ protocol, \
  69. /*.iInterface = 0, */ 0x00, \
  70. /**
  71. * @brief Initializer of endpoint descriptors for MSC class.
  72. *
  73. * @param endpoint_in IN endpoint.
  74. * @param endpoint_out OUT endpoint.
  75. * @param ep_size Endpoint size.
  76. * */
  77. #define APP_USBD_MSC_EP_DSC(endpoint_in, endpoint_out, ep_size) \
  78. /*.bLength = */ sizeof(app_usbd_descriptor_ep_t), \
  79. /*.bDescriptorType = */ APP_USBD_DESCRIPTOR_ENDPOINT, \
  80. /*.bEndpointAddress = */ endpoint_in, \
  81. /*.bmAttributes = */ APP_USBD_DESCRIPTOR_EP_ATTR_TYPE_BULK, \
  82. /*.wMaxPacketSize = */ APP_USBD_U16_TO_RAW_DSC(ep_size), \
  83. /*.bInterval = */ 0, \
  84. /*.bLength = */ sizeof(app_usbd_descriptor_ep_t), \
  85. /*.bDescriptorType = */ APP_USBD_DESCRIPTOR_ENDPOINT, \
  86. /*.bEndpointAddress = */ endpoint_out, \
  87. /*.bmAttributes = */ APP_USBD_DESCRIPTOR_EP_ATTR_TYPE_BULK, \
  88. /*.wMaxPacketSize = */ APP_USBD_U16_TO_RAW_DSC(ep_size), \
  89. /*.bInterval = */ 0, \
  90. /** @} */
  91. #ifdef __cplusplus
  92. }
  93. #endif
  94. #endif /* APP_USBD_MSC_DESC_H__ */