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