ser_conn_dtm_cmd_decoder.h 3.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  1. /**
  2. * Copyright (c) 2014 - 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. /**
  41. * @addtogroup ser_conn Connectivity application code
  42. * @ingroup ble_sdk_lib_serialization
  43. */
  44. /** @file
  45. *
  46. * @defgroup ser_dtm_decoder DTM Command Decoder in the Connectivity Chip
  47. * @{
  48. * @ingroup ser_conn
  49. *
  50. * @brief Decoder for serialized DTM commands from the Application Chip.
  51. *
  52. * @details This file contains declaration of common function used for DTM commands decoding and
  53. * sending responses back to the Application Chip after a DTM command is processed.
  54. */
  55. #ifndef SER_CONN_DTM_CMD_DECODER_H__
  56. #define SER_CONN_DTM_CMD_DECODER_H__
  57. #include <stdint.h>
  58. #ifdef __cplusplus
  59. extern "C" {
  60. #endif
  61. /**@brief A function for processing the encoded DTM commands from the Application Chip.
  62. *
  63. * @details The function decodes encoded DTM commands and calls the appropriate DTM API.
  64. * Then creates a DTM Command Response packet with the return value from the
  65. * DTM API encoded in it and sends it to the Application Chip.
  66. *
  67. * @param[in] p_command The encoded command.
  68. * @param[in] command_len Length of the encoded command.
  69. *
  70. * @retval NRF_SUCCESS If the decoding of the command was successful, the DTM API
  71. * was called, and the command response was sent to peer, otherwise an
  72. * error code.
  73. */
  74. uint32_t ser_conn_dtm_command_process(uint8_t * p_command, uint16_t command_len);
  75. /**@brief A function for checking if the Connectivity Chip is ready to enter the DTM mode.
  76. *
  77. * @details The function checks if the Connectivity Chip is ready to enter into DTM mode.
  78. * If it is ready, then it disables the SoftDevice, closes HAL Transport Layer,
  79. * and starts DTM mode.
  80. */
  81. void ser_conn_is_ready_to_enter_dtm(void);
  82. #ifdef __cplusplus
  83. }
  84. #endif
  85. #endif /* SER_CONN_DTM_CMD_DECODER_H__ */
  86. /** @} */