xref: /rk3399_ARM-atf/plat/st/common/include/stm32mp_common.h (revision d82d4ff0666711067328d2d34e2bdc009e84969f)
1 /*
2  * Copyright (C) 2018-2019, STMicroelectronics - All Rights Reserved
3  * Copyright (c) 2018-2019, Linaro Limited
4  *
5  * SPDX-License-Identifier: BSD-3-Clause
6  */
7 
8 #ifndef STM32MP_COMMON_H
9 #define STM32MP_COMMON_H
10 
11 #include <stdbool.h>
12 
13 #include <arch_helpers.h>
14 
15 /* Functions to save and get boot context address given by ROM code */
16 void stm32mp_save_boot_ctx_address(uintptr_t address);
17 uintptr_t stm32mp_get_boot_ctx_address(void);
18 
19 /*
20  * Platform util functions for the GPIO driver
21  * @bank: Target GPIO bank ID as per DT bindings
22  *
23  * Platform shall implement these functions to provide to stm32_gpio
24  * driver the resource reference for a target GPIO bank. That are
25  * memory mapped interface base address, interface offset (see below)
26  * and clock identifier.
27  *
28  * stm32_get_gpio_bank_offset() returns a bank offset that is used to
29  * check DT configuration matches platform implementation of the banks
30  * description.
31  */
32 uintptr_t stm32_get_gpio_bank_base(unsigned int bank);
33 unsigned long stm32_get_gpio_bank_clock(unsigned int bank);
34 uint32_t stm32_get_gpio_bank_offset(unsigned int bank);
35 
36 /*
37  * Util for clock gating and to get clock rate for stm32 and platform drivers
38  * @id: Target clock ID, ID used in clock DT bindings
39  */
40 bool stm32mp_clk_is_enabled(unsigned long id);
41 int stm32mp_clk_enable(unsigned long id);
42 int stm32mp_clk_disable(unsigned long id);
43 unsigned long stm32mp_clk_get_rate(unsigned long id);
44 
45 /* Initialise the IO layer and register platform IO devices */
46 void stm32mp_io_setup(void);
47 
48 static inline uint64_t arm_cnt_us2cnt(uint32_t us)
49 {
50 	return ((uint64_t)us * (uint64_t)read_cntfrq()) / 1000000ULL;
51 }
52 
53 static inline uint64_t timeout_init_us(uint32_t us)
54 {
55 	return read_cntpct_el0() + arm_cnt_us2cnt(us);
56 }
57 
58 static inline bool timeout_elapsed(uint64_t expire)
59 {
60 	return read_cntpct_el0() > expire;
61 }
62 
63 #endif /* STM32MP_COMMON_H */
64