wdt_callback.h 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105
  1. /**
  2. * \file
  3. *
  4. * \brief SAM Watchdog Driver
  5. *
  6. * Copyright (C) 2013-2015 Atmel Corporation. All rights reserved.
  7. *
  8. * \asf_license_start
  9. *
  10. * \page License
  11. *
  12. * Redistribution and use in source and binary forms, with or without
  13. * modification, are permitted provided that the following conditions are met:
  14. *
  15. * 1. Redistributions of source code must retain the above copyright notice,
  16. * this list of conditions and the following disclaimer.
  17. *
  18. * 2. Redistributions in binary form must reproduce the above copyright notice,
  19. * this list of conditions and the following disclaimer in the documentation
  20. * and/or other materials provided with the distribution.
  21. *
  22. * 3. The name of Atmel may not be used to endorse or promote products derived
  23. * from this software without specific prior written permission.
  24. *
  25. * 4. This software may only be redistributed and used in connection with an
  26. * Atmel microcontroller product.
  27. *
  28. * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
  29. * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  30. * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
  31. * EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR
  32. * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  33. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  34. * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  35. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  36. * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  37. * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  38. * POSSIBILITY OF SUCH DAMAGE.
  39. *
  40. * \asf_license_stop
  41. *
  42. */
  43. /*
  44. * Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel Support</a>
  45. */
  46. #ifndef WDT_CALLBACK_H_INCLUDED
  47. #define WDT_CALLBACK_H_INCLUDED
  48. #include <compiler.h>
  49. #include "wdt.h"
  50. #ifdef __cplusplus
  51. extern "C" {
  52. #endif
  53. /**
  54. * \addtogroup asfdoc_sam0_wdt_group
  55. *
  56. * @{
  57. */
  58. /** \name Callback Configuration and Initialization
  59. * @{
  60. */
  61. /** Type definition for a WDT module callback function. */
  62. typedef void (*wdt_callback_t)(void);
  63. /** Enum for the possible callback types for the WDT module. */
  64. enum wdt_callback
  65. {
  66. /** Callback type for when an early warning callback from the WDT module
  67. * is issued
  68. */
  69. WDT_CALLBACK_EARLY_WARNING,
  70. };
  71. enum status_code wdt_register_callback(
  72. const wdt_callback_t callback,
  73. const enum wdt_callback type);
  74. enum status_code wdt_unregister_callback(
  75. const enum wdt_callback type);
  76. /** @} */
  77. /** \name Callback Enabling and Disabling
  78. * @{
  79. */
  80. enum status_code wdt_enable_callback(
  81. const enum wdt_callback type);
  82. enum status_code wdt_disable_callback(
  83. const enum wdt_callback type);
  84. /** @} */
  85. /** @} */
  86. #ifdef __cplusplus
  87. }
  88. #endif
  89. #endif