1 /**
2  * \file
3  *
4  * \brief Common Delay Service
5  *
6  * Copyright (c) 2013-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  * Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel Support</a>
45  */
46 #ifndef DELAY_H_INCLUDED
47 #define DELAY_H_INCLUDED
48 
49 #ifdef __cplusplus
50 extern "C" {
51 #endif
52 
53 /**
54  * @defgroup group_common_services_delay Busy-Wait Delay Routines
55  *
56  * This module provides simple loop-based delay routines for those
57  * applications requiring a brief wait during execution. Common for
58  * API ver. 2.
59  *
60  * @{
61  */
62 
63 #ifdef SYSTICK_MODE
64 #include "sam0/systick_counter.h"
65 #endif
66 #ifdef CYCLE_MODE
67 #include "sam0/cycle_counter.h"
68 #endif
69 
70 void delay_init(void);
71 
72 /**
73  * \def delay_s
74  * \brief Delay in at least specified number of seconds.
75  * \param delay Delay in seconds
76  */
77 #define delay_s(delay)          ((delay) ? cpu_delay_s(delay) : cpu_delay_us(1))
78 
79 /**
80  * \def delay_ms
81  * \brief Delay in at least specified number of milliseconds.
82  * \param delay Delay in milliseconds
83  */
84 #define delay_ms(delay)         ((delay) ? cpu_delay_ms(delay) : cpu_delay_us(1))
85 
86 /**
87  * \def delay_us
88  * \brief Delay in at least specified number of microseconds.
89  * \param delay Delay in microseconds
90  */
91 #define delay_us(delay)         ((delay) ? cpu_delay_us(delay) : cpu_delay_us(1))
92 
93 #ifdef __cplusplus
94 }
95 #endif
96 
97 /**
98  * @}
99  */
100 
101 #endif /* DELAY_H_INCLUDED */
102