nrf_cli_cdc_acm.h 3.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  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 NRF_CLI_CDC_ACM_H__
  41. #define NRF_CLI_CDC_ACM_H__
  42. #include <stdbool.h>
  43. #include "nrf_cli.h"
  44. #include "app_usbd_cdc_acm.h"
  45. #ifdef __cplusplus
  46. extern "C" {
  47. #endif
  48. /**@file
  49. *
  50. * @defgroup nrf_cli_cdc_acm CDC ACM command line interface transport layer
  51. * @ingroup nrf_cli
  52. *
  53. * @{
  54. *
  55. */
  56. /**
  57. * @brief Command line interface transport.
  58. */
  59. extern const nrf_cli_transport_api_t nrf_cli_cdc_acm_transport_api;
  60. /**
  61. * @brief Command line interface class instance.
  62. */
  63. extern const app_usbd_cdc_acm_t nrf_cli_cdc_acm;
  64. typedef struct {
  65. nrf_cli_transport_handler_t handler;
  66. void * p_context;
  67. } nrf_cli_cdc_acm_internal_cb_t;
  68. typedef struct {
  69. nrf_cli_transport_t transport;
  70. nrf_cli_cdc_acm_internal_cb_t * p_cb;
  71. } nrf_cli_cdc_acm_internal_t;
  72. /**@brief CLI USB transport definition */
  73. #define NRF_CLI_CDC_ACM_DEF(_name_) \
  74. static nrf_cli_cdc_acm_internal_cb_t CONCAT_2(_name_, _cb); \
  75. static const nrf_cli_cdc_acm_internal_t _name_ = { \
  76. .transport = {.p_api = &nrf_cli_cdc_acm_transport_api}, \
  77. .p_cb = &CONCAT_2(_name_, _cb), \
  78. }
  79. /** @} */
  80. #ifdef __cplusplus
  81. }
  82. #endif
  83. #endif /* NRF_CLI_CDC_ACM_H__ */