nrf_dfu_transport.h 5.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134
  1. /**
  2. * Copyright (c) 2016 - 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. /**@file
  41. *
  42. * @defgroup sdk_nrf_dfu_transport DFU transport
  43. * @{
  44. * @ingroup nrf_dfu
  45. * @brief Generic Device Firmware Update (DFU) transport interface.
  46. *
  47. * @details The DFU transport module defines a generic interface that must
  48. * be implemented for each transport layer.
  49. */
  50. #ifndef NRF_DFU_TRANSPORT_H__
  51. #define NRF_DFU_TRANSPORT_H__
  52. #include <stdint.h>
  53. #include "nrf_section.h"
  54. #include "nrf_dfu_types.h"
  55. #ifdef __cplusplus
  56. extern "C" {
  57. #endif
  58. /** @brief Forward declaration of nrf_dfu_transport_t */
  59. typedef struct nrf_dfu_transport_s nrf_dfu_transport_t;
  60. /** @brief Function type for initializing a DFU transport.
  61. *
  62. * @details This function initializes a DFU transport. The implementation
  63. * of the function must initialize DFU mode and stay in service
  64. * until either the device is reset or the DFU operation is finalized.
  65. * When the DFU transport receives requests, it should call @ref nrf_dfu_req_handler_on_req for handling the requests.
  66. *
  67. * @param observer Callback function for receiving DFU transport notifications.
  68. *
  69. * @retval NRF_SUCCESS If initialization was successful for the transport. Any other return code indicates that the DFU transport could not be initialized.
  70. */
  71. typedef uint32_t (*nrf_dfu_init_fn_t)(nrf_dfu_observer_t observer);
  72. /** @brief Function type for closing down a DFU transport.
  73. *
  74. * @details This function closes down a DFU transport in a gentle way.
  75. *
  76. * @param[in] p_exception If exception matches current transport closing should be omitted.
  77. *
  78. * @retval NRF_SUCCESS If closing was successful for the transport. Any other return code indicates that the DFU transport could not be closed closed down.
  79. */
  80. typedef uint32_t (*nrf_dfu_close_fn_t)(nrf_dfu_transport_t const * p_exception);
  81. /** @brief DFU transport registration.
  82. *
  83. * @details Every DFU transport must provide a registration of the initialization function.
  84. */
  85. struct nrf_dfu_transport_s
  86. {
  87. nrf_dfu_init_fn_t init_func; /**< Registration of the init function to run to initialize a DFU transport. */
  88. nrf_dfu_close_fn_t close_func; /**< Registration of the close function to close down a DFU transport. */
  89. };
  90. /** @brief Function for initializing all the registered DFU transports.
  91. *
  92. * @retval NRF_SUCCESS If all DFU transport were initialized successfully.
  93. * Any other error code indicates that at least one DFU
  94. * transport could not be initialized.
  95. */
  96. uint32_t nrf_dfu_transports_init(nrf_dfu_observer_t observer);
  97. /** @brief Function for closing down all (with optional exception) the registered DFU transports.
  98. *
  99. * @param[in] p_exception Transport which should not be closed. NULL if all transports should be closed.
  100. * @retval NRF_SUCCESS If all DFU transport were closed down successfully.
  101. * Any other error code indicates that at least one DFU
  102. * transport could not be closed down.
  103. */
  104. uint32_t nrf_dfu_transports_close(nrf_dfu_transport_t const * p_exception);
  105. /** @brief Macro for registering a DFU transport by using section variables.
  106. *
  107. * @details This macro places a variable in a section named "dfu_trans", which
  108. * is initialized by @ref nrf_dfu_transports_init.
  109. */
  110. #define DFU_TRANSPORT_REGISTER(trans_var) NRF_SECTION_ITEM_REGISTER(dfu_trans, trans_var)
  111. #ifdef __cplusplus
  112. }
  113. #endif
  114. #endif // NRF_DFU_TRANSPORT_H__
  115. /** @} */