dtm_uart_params.h 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293
  1. /**
  2. * Copyright (c) 2013 - 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 DTM_UART_PARAMS_H__
  41. #define DTM_UART_PARAMS_H__
  42. #include <stdbool.h>
  43. #include <stdint.h>
  44. #ifdef __cplusplus
  45. extern "C" {
  46. #endif
  47. /** @ingroup ble_dtm_app
  48. */
  49. /**@brief Enumeration of supported baud rates. */
  50. typedef enum
  51. {
  52. UART_BAUD_RATE_1200, /**< Baud rate 1200. */
  53. UART_BAUD_RATE_2400, /**< Baud rate 2400. */
  54. UART_BAUD_RATE_4800, /**< Baud rate 4800. */
  55. UART_BAUD_RATE_9600, /**< Baud rate 9600. */
  56. UART_BAUD_RATE_14400, /**< Baud rate 14400. */
  57. UART_BAUD_RATE_19200, /**< Baud rate 19200. */
  58. UART_BAUD_RATE_28800, /**< Baud rate 28800. */
  59. UART_BAUD_RATE_38400, /**< Baud rate 38400. */
  60. UART_BAUD_RATE_57600, /**< Baud rate 57600. */
  61. UART_BAUD_RATE_76800, /**< Baud rate 76800. */
  62. UART_BAUD_RATE_115200, /**< Baud rate 115200. */
  63. UART_BAUD_RATE_230400, /**< Baud rate 230400. */
  64. UART_BAUD_RATE_250000, /**< Baud rate 250000. */
  65. UART_BAUD_RATE_460800, /**< Baud rate 460800. */
  66. UART_BAUD_RATE_921600, /**< Baud rate 921600. */
  67. UART_BAUD_RATE_1000000, /**< Baud rate 1000000. */
  68. UART_BAUD_RATE_MAX /**< Enumeration upper bound. */
  69. } app_uart_stream_baud_rate_t;
  70. /**@brief UART communication structure holding configuration settings for the peripheral.
  71. */
  72. typedef struct
  73. {
  74. uint8_t rx_pin_no; /**< RX pin number. */
  75. uint8_t tx_pin_no; /**< TX pin number. */
  76. uint8_t rts_pin_no; /**< RTS pin number, only used if flow control is enabled. */
  77. uint8_t cts_pin_no; /**< CTS pin number, only used if flow control is enabled. */
  78. bool use_parity; /**< Even parity if TRUE, no parity if FALSE. */
  79. app_uart_stream_baud_rate_t baud_rate; /**< Baud rate configuration. */
  80. } app_uart_stream_comm_params_t;
  81. #ifdef __cplusplus
  82. }
  83. #endif
  84. #endif // DTM_UART_PARAMS_H__