nrf_drv_wdt.h 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111
  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. #ifndef NRF_DRV_WDT_H__
  41. #define NRF_DRV_WDT_H__
  42. #include <nrfx_wdt.h>
  43. #ifdef __cplusplus
  44. extern "C" {
  45. #endif
  46. /**
  47. * @defgroup nrf_drv_wdt WDT driver - legacy layer
  48. * @{
  49. * @ingroup nrf_wdt
  50. *
  51. * @brief A layer providing compatibility with former API.
  52. */
  53. /** @brief Type definition for forwarding the new implementation. */
  54. typedef nrfx_wdt_config_t nrf_drv_wdt_config_t;
  55. /** @brief Macro for forwarding the new implementation. */
  56. #define NRF_DRV_WDT_DEAFULT_CONFIG NRFX_WDT_DEAFULT_CONFIG
  57. /** @brief Macro for forwarding the new implementation. */
  58. #define nrf_wdt_event_handler_t nrfx_wdt_event_handler_t
  59. /** @brief Macro for forwarding the new implementation. */
  60. #define nrf_drv_wdt_channel_id nrfx_wdt_channel_id
  61. /** @brief Macro for forwarding the new implementation. */
  62. #define nrf_drv_wdt_channel_alloc nrfx_wdt_channel_alloc
  63. /** @brief Macro for forwarding the new implementation. */
  64. #define nrf_drv_wdt_enable nrfx_wdt_enable
  65. /** @brief Macro for forwarding the new implementation. */
  66. #define nrf_drv_wdt_feed nrfx_wdt_feed
  67. /** @brief Macro for forwarding the new implementation. */
  68. #define nrf_drv_wdt_channel_feed nrfx_wdt_channel_feed
  69. /** @brief Macro for forwarding the new implementation. */
  70. #define nrf_drv_wdt_ppi_task_addr nrfx_wdt_ppi_task_addr
  71. /** @brief Macro for forwarding the new implementation. */
  72. #define nrf_drv_wdt_ppi_event_addr nrfx_wdt_ppi_event_addr
  73. /**
  74. * @brief This function initializes watchdog.
  75. *
  76. * @param[in] p_config Pointer to the structure with initial configuration. Default
  77. * configuration used if NULL.
  78. * @param[in] wdt_event_handler Specifies event handler provided by user.
  79. *
  80. * @note Function asserts if wdt_event_handler is NULL.
  81. *
  82. * @return NRF_SUCCESS on success, otherwise an error code.
  83. */
  84. __STATIC_INLINE ret_code_t nrf_drv_wdt_init(nrf_drv_wdt_config_t const * p_config,
  85. nrf_wdt_event_handler_t wdt_event_handler)
  86. {
  87. if (p_config == NULL)
  88. {
  89. static const nrfx_wdt_config_t default_config = NRFX_WDT_DEAFULT_CONFIG;
  90. p_config = &default_config;
  91. }
  92. return nrfx_wdt_init(p_config, wdt_event_handler);
  93. }
  94. /** @} */
  95. #ifdef __cplusplus
  96. }
  97. #endif
  98. #endif // NRF_DRV_WDT_H__