nrf_dfu_mbr.h 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  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_mbr MBR functions
  43. * @{
  44. * @ingroup nrf_dfu
  45. */
  46. #ifndef NRF_DFU_MBR_H__
  47. #define NRF_DFU_MBR_H__
  48. #include <stdint.h>
  49. #ifdef __cplusplus
  50. extern "C" {
  51. #endif
  52. /** @brief Function for copying the bootloader using an MBR command.
  53. *
  54. * @param[in] p_src Source address of the bootloader data to copy.
  55. * @param[in] len Length of the data to copy in bytes.
  56. *
  57. * @return This function will return only if the command request could not be run.
  58. * See @ref sd_mbr_command_copy_bl_t for possible return values.
  59. */
  60. uint32_t nrf_dfu_mbr_copy_bl(uint32_t * p_src, uint32_t len);
  61. /** @brief Function for initializing the SoftDevice using an MBR command.
  62. *
  63. * @retval NRF_SUCCESS If the SoftDevice was initialized successfully.
  64. * Any other return value indicates that the SoftDevice
  65. * could not be initialized.
  66. */
  67. uint32_t nrf_dfu_mbr_init_sd(void);
  68. /** @brief Function for setting the address of the IRQ table to the app's using an MBR command.
  69. *
  70. * @retval NRF_SUCCESS If the address of the new irq table was set. Any other
  71. * return value indicates that the address could not be set.
  72. */
  73. uint32_t nrf_dfu_mbr_irq_forward_address_set(void);
  74. #ifdef __cplusplus
  75. }
  76. #endif
  77. #endif // NRF_DFU_MBR_H__
  78. /** @} */