1 /**
2  * \file
3  *
4  * \brief HAL delay related functionality declaration.
5  *
6  * Copyright (C) 2014-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 #include <hpl_irq.h>
45 #include <hpl_reset.h>
46 #include <hpl_sleep.h>
47 
48 #ifndef _HAL_DELAY_H_INCLUDED
49 #define _HAL_DELAY_H_INCLUDED
50 
51 #include <compiler.h>
52 
53 #ifdef __cplusplus
54 extern "C" {
55 #endif
56 
57 /**
58  * \addtogroup doc_driver_hal_delay Delay Driver
59  *
60  *@{
61  */
62 
63 /**
64  * \brief Initialize Delay driver
65  *
66  * \param[in] hw The pointer to hardware instance
67  */
68 void delay_init(void *const hw);
69 
70 /**
71  * \brief Perform delay in us
72  *
73  * This function performs delay for the given amount of microseconds.
74  *
75  * \param[in] us The amount delay in us
76  */
77 void delay_us(const uint16_t us);
78 
79 /**
80  * \brief Perform delay in ms
81  *
82  * This function performs delay for the given amount of milliseconds.
83  *
84  * \param[in] ms The amount delay in ms
85  */
86 void delay_ms(const uint16_t ms);
87 
88 /**
89  * \brief Retrieve the current driver version
90  *
91  * \return Current driver version.
92  */
93 uint32_t delay_get_version(void);
94 
95 /**@}*/
96 #ifdef __cplusplus
97 }
98 #endif
99 #endif /* _HAL_DELAY_H_INCLUDED */
100