nrf_bootloader_wdt.h 3.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879
  1. /**
  2. * Copyright (c) 2017 - 2018, 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_BOOTLOADER_WDT_H
  41. #define NRF_BOOTLOADER_WDT_H
  42. /**@file
  43. *
  44. * @defgroup nrf_bootloader_wdt Automated feeding of the watchdog
  45. * @{
  46. * @ingroup nrf_bootloader
  47. * @brief Module that keeps the WDT from timing out if the WDT has been started in the application.
  48. */
  49. #include "sdk_errors.h"
  50. #ifdef __cplusplus
  51. extern "C" {
  52. #endif
  53. /**
  54. * @brief Function for checking whether the WDT peripheral is started and for getting its configuration.
  55. *
  56. * The module uses app_timer to start regular feeding of the watchdog. Timer interval
  57. * is chosen based on watchdog settings. When @ref nrf_bootloader_wdt_feed is called, internal
  58. * feeding is stopped assuming that the application takes responsibity of watchdog feeding.
  59. * However, if @ref NRF_BL_WDT_MAX_SCHEDULER_LATENCY_MS or the watchdog is configured to
  60. * run during sleep, then internal feeding (from app_timer handler context) is kept active.
  61. */
  62. void nrf_bootloader_wdt_init(void);
  63. /**
  64. * @brief Function for feeding the watchdog (if active).
  65. */
  66. void nrf_bootloader_wdt_feed(void);
  67. #ifdef __cplusplus
  68. }
  69. #endif
  70. /** @} */
  71. #endif //NRF_BOOTLOADER_WDT_H