1 /** 2 * \file 3 * 4 * \brief Common Delay Service 5 * 6 * Copyright (c) 2014-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 _DELAY_H_ 47 #define _DELAY_H_ 48 49 #ifdef __cplusplus 50 extern "C" { 51 #endif 52 53 #include <sysclk.h> 54 55 #if UC3 56 # include <cycle_counter.h> 57 #elif XMEGA 58 # include "xmega/cycle_counter.h" 59 #elif MEGA 60 # include "mega/cycle_counter.h" 61 #elif SAM 62 # include "sam/cycle_counter.h" 63 #endif 64 65 /** 66 * @defgroup group_common_services_delay Busy-Wait Delay Routines 67 * 68 * This module provides simple loop-based delay routines for those 69 * applications requiring a brief wait during execution. Common API 70 * for UC3, XMEGA, and AVR MEGA. 71 * 72 * @{ 73 */ 74 75 /** 76 * @def F_CPU 77 * @brief MCU Clock Frequency (Hertz) 78 * 79 * @deprecated 80 * The \ref F_CPU configuration constant is used for compatibility with the 81 * \ref group_common_services_delay routines. The common loop-based delay 82 * routines are designed to use the \ref clk_group modules while anticipating 83 * support for legacy applications assuming a statically defined clock 84 * frequency. Applications using a statically configured MCU clock frequency 85 * can define \ref F_CPU (Hertz), in which case the common delay routines will 86 * use this value rather than calling sysclk_get_cpu_hz() to get the current 87 * MCU clock frequency. 88 */ 89 #ifndef F_CPU 90 # define F_CPU sysclk_get_cpu_hz() 91 #endif 92 93 /** 94 * @def delay_init 95 * 96 * @brief Initialize the delay driver. 97 * @param fcpu_hz CPU frequency in Hz 98 * 99 * @deprecated 100 * This function is provided for compatibility with ASF applications that 101 * may not have been updated to configure the system clock via the common 102 * clock service; e.g. sysclk_init() and a configuration header file are 103 * used to configure clocks. 104 * 105 * The functions in this module call \ref sysclk_get_cpu_hz() function to 106 * obtain the system clock frequency. 107 */ 108 #define delay_init(fcpu_hz) 109 110 /** 111 * @def delay_s 112 * @brief Delay in seconds. 113 * @param delay Delay in seconds 114 */ 115 #define delay_s(delay) cpu_delay_ms(1000 * delay, F_CPU) 116 117 /** 118 * @def delay_ms 119 * @brief Delay in milliseconds. 120 * @param delay Delay in milliseconds 121 */ 122 #define delay_ms(delay) cpu_delay_ms(delay, F_CPU) 123 124 /** 125 * @def delay_us 126 * @brief Delay in microseconds. 127 * @param delay Delay in microseconds 128 */ 129 #define delay_us(delay) cpu_delay_us(delay, F_CPU) 130 131 #ifdef __cplusplus 132 } 133 #endif 134 135 /** 136 * @} 137 */ 138 139 #endif /* _DELAY_H_ */ 140