nrf_dfu_serial.h 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111
  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_DFU_SERIAL_H__
  41. #define NRF_DFU_SERIAL_H__
  42. #include <stdint.h>
  43. #include "sdk_errors.h"
  44. #include "nrf_dfu_req_handler.h"
  45. #include "nrf_dfu_transport.h"
  46. #ifdef __cplusplus
  47. extern "C" {
  48. #endif
  49. /**@file
  50. *
  51. * @defgroup nrf_dfu_serial DFU Serial transports shared part
  52. * @{
  53. * @ingroup nrf_dfu
  54. * @brief Shared part of Device Firmware Update (DFU) transport layers using serial interface (UART, USB CDC ACM).
  55. *
  56. * @defgroup nrf_dfu_serial_uart DFU Serial UART transport
  57. * @ingroup nrf_dfu_serial
  58. * @brief Configuration for Device Firmware Update (DFU) transport layer using UART.
  59. *
  60. * @defgroup nrf_dfu_serial_usb DFU Serial USB CDC ACM transport
  61. * @ingroup nrf_dfu_serial
  62. * @brief Configuration for Device Firmware Update (DFU) transport layer using USB CDC ACM.
  63. *
  64. */
  65. #define NRF_SERIAL_MAX_RESPONSE_SIZE (sizeof(nrf_dfu_response_t))
  66. /**
  67. * Prototype for function for sending response over serial DFU transport.
  68. */
  69. typedef ret_code_t (*nrf_serial_rsp_func_t)(uint8_t const * p_data, uint32_t length);
  70. /**
  71. * Prototype for function for freeing RX buffer.
  72. *
  73. * Function is called when input data is processed.
  74. */
  75. typedef void (*nrf_serial_rx_buf_free_func_t)(void * p_buf);
  76. /**@brief DFU serial transport layer state.
  77. *
  78. * @details This structure contains status information related to the serial transport layer type.
  79. */
  80. typedef struct
  81. {
  82. uint16_t pkt_notif_target;
  83. uint16_t pkt_notif_target_count;
  84. nrf_serial_rsp_func_t rsp_func;
  85. nrf_serial_rx_buf_free_func_t payload_free_func;
  86. uint32_t mtu;
  87. uint8_t * p_rsp_buf;
  88. nrf_dfu_transport_t const * p_low_level_transport;
  89. } nrf_dfu_serial_t;
  90. void nrf_dfu_serial_on_packet_received(nrf_dfu_serial_t * p_transport,
  91. uint8_t const * p_data,
  92. uint32_t length);
  93. /** @} */
  94. #ifdef __cplusplus
  95. }
  96. #endif
  97. #endif // NRF_DFU_SERIAL_H__