hal_timer_critical.h 3.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. /**
  2. * Copyright (c) 2016 - 2020 Nordic Semiconductor ASA and Luxoft Global Operations Gmbh.
  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. *
  10. * 1. Redistributions of source code must retain the above copyright notice, this
  11. * list of conditions and the following disclaimer.
  12. *
  13. * 2. Redistributions in binary form, except as embedded into a Nordic
  14. * Semiconductor ASA integrated circuit in a product or a software update for
  15. * such product, must reproduce the above copyright notice, this list of
  16. * conditions and the following disclaimer in the documentation and/or other
  17. * materials provided with the distribution.
  18. *
  19. * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
  20. * contributors may be used to endorse or promote products derived from this
  21. * software without specific prior written permission.
  22. *
  23. * 4. This software, with or without modification, must only be used with a
  24. * Nordic Semiconductor ASA integrated circuit.
  25. *
  26. * 5. Any software provided in binary form under this license must not be reverse
  27. * engineered, decompiled, modified and/or disassembled.
  28. *
  29. *
  30. * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
  31. * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  32. * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
  33. * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
  34. * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  35. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  36. * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  37. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  38. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  39. * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  40. *
  41. */
  42. #ifndef HAL_TIMER_CRITICAL_H_INCLUDED
  43. #define HAL_TIMER_CRITICAL_H_INCLUDED
  44. #include <stdint.h>
  45. #include <stdbool.h>
  46. /**
  47. * @defgroup hal_timer_critical HAL Hardware Critical Timer
  48. * @ingroup hal_15_4
  49. * @{
  50. * @brief Module to declare HAL hardware critical timer interface
  51. */
  52. /**@brief Prototype for critical timer handler.
  53. */
  54. typedef void (* hal_timer_critical_handler_t)(void);
  55. /**@brief Starts hardware critical timer.
  56. *
  57. * @param[in] interval_us timer interval for timer start.
  58. * @param[in] handler critical timer event handler.
  59. */
  60. void hal_timer_critical_start(uint32_t interval_us, hal_timer_critical_handler_t handler);
  61. /**@brief Stops hardware critical timer.
  62. */
  63. void hal_timer_critical_stop(void);
  64. /**@brief Check if critical timer is currently used.
  65. *
  66. * @retval timer_state true - timer is running now
  67. * false - timer in stop mode
  68. */
  69. bool is_critical_timer_started(void);
  70. /** @} */
  71. #endif /* HAL_TIMER_CRITICAL_H_INCLUDED */