1 /* SPDX-License-Identifier: BSD-2-Clause */
2 /*
3  * Copyright (c) 2018, Linaro Limited
4  * Copyright (C) 2017, Fuzhou Rockchip Electronics Co., Ltd.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright notice,
11  * this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright notice,
14  * this list of conditions and the following disclaimer in the documentation
15  * and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
21  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27  * POSSIBILITY OF SUCH DAMAGE.
28  */
29 
30 #ifndef __KERNEL_DELAY_H
31 #define __KERNEL_DELAY_H
32 
33 #include <kernel/delay_arch.h>
34 #include <stdbool.h>
35 #include <stdint.h>
36 #include <util.h>
37 
38 #ifdef CFG_CORE_HAS_GENERIC_TIMER
39 /* Convert microsecond base delay @us into architecture time tick counts */
delay_us2cnt(uint32_t us)40 static inline uint64_t delay_us2cnt(uint32_t us)
41 {
42 	return ((uint64_t)us * (uint64_t)delay_cnt_freq()) / ULL(1000000);
43 }
44 
45 /* Return delay tick counter for a timeout expiration in @us microseconds */
timeout_init_us(uint32_t us)46 static inline uint64_t timeout_init_us(uint32_t us)
47 {
48 	return delay_cnt_read() + delay_us2cnt(us);
49 }
50 
51 /* Check if timeout tick counter @expire from timeout_init_us() has expired */
52 
timeout_elapsed(uint64_t expire)53 static inline bool timeout_elapsed(uint64_t expire)
54 {
55 	return delay_cnt_read() >= expire;
56 }
57 
58 /*
59  * Return the time in microseconds since/until timeout tick counter @expired,
60  * that was initialized with timeout_init_us() or like, has/will expire.
61  * A positive value means the timeout has expired and a negative one it has not.
62  */
63 int timeout_elapsed_us(uint64_t expire);
64 #endif /*CFG_CORE_HAS_GENERIC_TIMER*/
65 
66 /* Wait @us microseconds actively polling on architecture timer */
67 void udelay(uint32_t us);
68 
69 /* Wait @ms milliseconds actively polling on architecture timer */
70 void mdelay(uint32_t ms);
71 #endif
72