app_usbd_dummy.h 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138
  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_H__
  41. #define APP_USBD_DUMMY_H__
  42. #include <stdint.h>
  43. #include <stdbool.h>
  44. #include "nrf_drv_usbd.h"
  45. #include "nrf_block_dev.h"
  46. #include "app_usbd_class_base.h"
  47. #include "app_usbd.h"
  48. #include "app_usbd_core.h"
  49. #include "app_usbd_descriptor.h"
  50. #include "app_usbd_dummy_types.h"
  51. #include "app_usbd_dummy_internal.h"
  52. #ifdef __cplusplus
  53. extern "C" {
  54. #endif
  55. /**
  56. * @defgroup app_usbd_dummy USB Dummy class
  57. * @ingroup app_usbd
  58. *
  59. * @brief @tagAPI52840 Module with types, definitions,
  60. * and API used by the USB Dummy class.
  61. *
  62. * @note Class is used as a filler to provide correct alignement of interfaces.
  63. *
  64. * @{
  65. */
  66. #ifdef DOXYGEN
  67. /**
  68. * @brief Dummy class instance type.
  69. *
  70. * @ref APP_USBD_CLASS_TYPEDEF
  71. */
  72. typedef struct { } app_usbd_dummy_t;
  73. #else
  74. /*lint -save -e10 -e26 -e123 -e505 */
  75. APP_USBD_CLASS_NO_EP_TYPEDEF(app_usbd_dummy, \
  76. APP_USBD_DUMMY_CONFIG(0), \
  77. APP_USBD_DUMMY_INSTANCE_SPECIFIC_DEC, \
  78. APP_USBD_DUMMY_DATA_SPECIFIC_DEC \
  79. );
  80. #endif
  81. /*lint -restore*/
  82. /**
  83. * @brief Global definition of app_usbd_dummy_t class.
  84. *
  85. * @param instance_name Name of global instance.
  86. * @param interface_number Unique interface number.
  87. *
  88. * @note This macro is just simplified version of @ref APP_USBD_DUMMY_GLOBAL_DEF_INTERNAL
  89. *
  90. */
  91. /*lint -save -emacro(26 64 123 505 651, APP_USBD_DUMMY_GLOBAL_DEF)*/
  92. #define APP_USBD_DUMMY_GLOBAL_DEF(instance_name, interface_number) \
  93. APP_USBD_DUMMY_GLOBAL_DEF_INTERNAL(instance_name, interface_number)
  94. /*lint -restore*/
  95. /**
  96. * @@brief Helper function to get class instance from dummy.
  97. *
  98. * @param[in] p_dummy Dummy instance
  99. * (declared by @ref APP_USBD_DUMMY_GLOBAL_DEF).
  100. *
  101. * @return Base class instance.
  102. */
  103. static inline app_usbd_class_inst_t const *
  104. app_usbd_dummy_class_inst_get(app_usbd_dummy_t const * p_dummy)
  105. {
  106. return &p_dummy->base;
  107. }
  108. /**
  109. * @brief Helper function to get dummy from base class instance.
  110. *
  111. * @param[in] p_inst Base class instance.
  112. *
  113. * @return Dummy class handle.
  114. */
  115. static inline app_usbd_dummy_t const *
  116. app_usbd_dummy_class_get( app_usbd_class_inst_t const * p_inst)
  117. {
  118. return (app_usbd_dummy_t const *)p_inst;
  119. }
  120. /** @} */
  121. #ifdef __cplusplus
  122. }
  123. #endif
  124. #endif /* APP_USBD_DUMMY_H__ */