app_usbd_dummy_internal.h 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115
  1. /**
  2. * Copyright (c) 2017 - 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_DUMMY_INTERNAL_H__
  41. #define APP_USBD_DUMMY_INTERNAL_H__
  42. #ifdef __cplusplus
  43. extern "C" {
  44. #endif
  45. /**
  46. * @defgroup app_usbd_dummy_internals USB Dummy internals
  47. * @ingroup app_usbd_dummy
  48. *
  49. * @brief @tagAPI52840 Internals of the USB Dummy class.
  50. * @{
  51. */
  52. /** @brief Forward declaration of Dummy Class type */
  53. APP_USBD_CLASS_FORWARD(app_usbd_dummy);
  54. /** @brief Dummy part of class instance data */
  55. typedef struct {
  56. uint8_t none;
  57. } app_usbd_dummy_inst_t;
  58. /** @brief Dummy context */
  59. typedef struct {
  60. uint8_t none;
  61. } app_usbd_dummy_ctx_t;
  62. /**
  63. * @brief Dummy configuration macro.
  64. *
  65. * Used by @ref APP_USBD_DUMMY_GLOBAL_DEF
  66. *
  67. * @param iface Interface number.
  68. * */
  69. #define APP_USBD_DUMMY_CONFIG(iface) (iface)
  70. /**
  71. * @brief Specific class constant data for Dummy.
  72. *
  73. * @ref app_usbd_dummy_inst_t
  74. */
  75. #define APP_USBD_DUMMY_INSTANCE_SPECIFIC_DEC app_usbd_dummy_inst_t inst;
  76. /**
  77. * @brief Specific class data for Dummy.
  78. *
  79. * @ref app_usbd_dummy_ctx_t
  80. * */
  81. #define APP_USBD_DUMMY_DATA_SPECIFIC_DEC app_usbd_dummy_ctx_t ctx;
  82. /** @brief Public Dummy class interface */
  83. extern const app_usbd_class_methods_t app_usbd_dummy_class_methods;
  84. /** @brief Global definition of Dummy instance */
  85. #define APP_USBD_DUMMY_GLOBAL_DEF_INTERNAL(instance_name, interface_number) \
  86. APP_USBD_CLASS_INST_NO_EP_GLOBAL_DEF( \
  87. instance_name, \
  88. app_usbd_dummy, \
  89. &app_usbd_dummy_class_methods, \
  90. APP_USBD_DUMMY_CONFIG((interface_number)), \
  91. () \
  92. )
  93. /** @} */
  94. #ifdef __cplusplus
  95. }
  96. #endif
  97. #endif /* APP_USBD_DUMMY_INTERNAL_H__ */