1 /**
2 * \file  hw_timer.h
3 *
4 * \brief Wrapper used by sw_timer utility using ASF timer api's
5 *
6 * Copyright (C) 2016 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 #ifndef HW_TIMER_H_INCLUDED
45 #define HW_TIMER_H_INCLUDED
46 
47 #include <stdint.h>
48 #include <stdbool.h>
49 
50 #ifdef __cplusplus
51 extern "C" {
52 #endif
53 
54 /**************************************** INCLUDES*****************************/
55 
56 /**************************************** MACROS******************************/
57 
58 /**************************************** TYPES*****************************/
59 
60 typedef void (*HwTimerCallback_t) (void);
61 
62 /***************************************PROTOTYPES**************************/
63 
64 /**
65 * \brief Initializes the hw timer module
66 */
67 void HwTimerInit(void);
68 
69 /**
70 * \brief This function is used to set the callback when the hw timer
71 * expires.
72 * \param callback Callback to be registered
73 */
74 void HwTimerAlarmSetCallback(HwTimerCallback_t callback);
75 
76 /**
77 * \brief This function is used to set the callback when the hw timer
78 * overflows.
79 * \param callback Callback to be registered
80 */
81 void HwTimerOverflowSetCallback(HwTimerCallback_t callback);
82 
83 /**
84 * \brief Loads the absolute timeout in terms of ticks into the hardware
85 * \ticks Absolute time value in terms of timer ticks
86 */
87 bool HwTimerLoadAbsoluteTicks(uint32_t ticks);
88 
89 /**
90 * \brief Gets the absolute time value
91 * \retval Absolute time in ticks
92 */
93 uint32_t HwTimerGetTime(void);
94 
95 /**
96 * \brief Disables the hw timer module
97 */
98 void HwTimerDisable(void);
99 
100 #ifdef	__cplusplus
101 }
102 #endif
103 #endif /* HW_TIMER_H_INCLUDED */
104