nrf_cli_ble_uart.h 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123
  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_BLE_UART_H__
  41. #define NRF_CLI_BLE_UART_H__
  42. #ifdef __cplusplus
  43. extern "C" {
  44. #endif
  45. #include "nrf_cli.h"
  46. #include "ble.h"
  47. #include "app_timer.h"
  48. #include "nrf_ringbuf.h"
  49. #include "nordic_common.h"
  50. #include "nrf_ble_gatt.h"
  51. /**@file
  52. *
  53. * @defgroup nrf_cli_ble_uart BLE UART command line interface transport layer
  54. * @ingroup nrf_cli
  55. *
  56. * @{
  57. *
  58. */
  59. /**
  60. * @brief Command line interface transport.
  61. */
  62. ret_code_t nrf_cli_ble_uart_service_init(void);
  63. extern const nrf_cli_transport_api_t nrf_cli_ble_uart_transport_api;
  64. typedef struct nrf_cli_ble_uart_internal_s nrf_cli_ble_uart_internal_t;
  65. typedef struct {
  66. nrf_cli_transport_handler_t handler;
  67. void * p_context;
  68. uint16_t conn_handle;
  69. bool timer_created;
  70. bool service_started;
  71. } nrf_cli_ble_uart_internal_cb_t;
  72. struct nrf_cli_ble_uart_internal_s {
  73. nrf_cli_transport_t transport;
  74. nrf_cli_ble_uart_internal_cb_t * p_cb;
  75. app_timer_id_t const * p_timer;
  76. nrf_ringbuf_t const * p_rx_ringbuf;
  77. nrf_ringbuf_t const * p_tx_ringbuf;
  78. nrf_ble_gatt_t const * p_gatt;
  79. };
  80. typedef struct {
  81. uint16_t conn_handle;
  82. } nrf_cli_ble_uart_config_t;
  83. /**@brief CLI Bluetooth transport definition.
  84. *
  85. * @param _name Name of the instance.
  86. * @param _p_gatt Pointer to the nrf_ble_gatt module.
  87. * @param _tx_buf_sz Size of TX ring buffer.
  88. * @param _rx_buf_sz Size of RX ring buffer.
  89. */
  90. #define NRF_CLI_BLE_UART_DEF(_name, _p_gatt, _tx_buf_sz, _rx_buf_sz) \
  91. APP_TIMER_DEF(CONCAT_2(_name, _timer)); \
  92. NRF_RINGBUF_DEF(CONCAT_2(_name,_tx_ringbuf), _tx_buf_sz); \
  93. NRF_RINGBUF_DEF(CONCAT_2(_name,_rx_ringbuf), _rx_buf_sz); \
  94. static nrf_cli_ble_uart_internal_cb_t CONCAT_2(_name, _cb); \
  95. static const nrf_cli_ble_uart_internal_t _name = { \
  96. .transport = {.p_api = &nrf_cli_ble_uart_transport_api}, \
  97. .p_cb = &CONCAT_2(_name, _cb), \
  98. .p_timer = &CONCAT_2(_name, _timer), \
  99. .p_rx_ringbuf = &CONCAT_2(_name,_rx_ringbuf), \
  100. .p_tx_ringbuf = &CONCAT_2(_name,_tx_ringbuf), \
  101. .p_gatt = _p_gatt, \
  102. }
  103. /** @} */
  104. #ifdef __cplusplus
  105. }
  106. #endif
  107. #endif /* NRF_CLI_BLE_UART_H__ */