1 /* 2 * Copyright (C) 2018-2022, STMicroelectronics - All Rights Reserved 3 * 4 * SPDX-License-Identifier: BSD-3-Clause 5 */ 6 7 #ifndef STM32MP_COMMON_H 8 #define STM32MP_COMMON_H 9 10 #include <stdbool.h> 11 12 #include <platform_def.h> 13 14 #define JEDEC_ST_BKID U(0x0) 15 #define JEDEC_ST_MFID U(0x20) 16 17 /* Functions to save and get boot context address given by ROM code */ 18 void stm32mp_save_boot_ctx_address(uintptr_t address); 19 uintptr_t stm32mp_get_boot_ctx_address(void); 20 uint16_t stm32mp_get_boot_itf_selected(void); 21 22 bool stm32mp_is_single_core(void); 23 bool stm32mp_is_closed_device(void); 24 25 /* Return the base address of the DDR controller */ 26 uintptr_t stm32mp_ddrctrl_base(void); 27 28 /* Return the base address of the DDR PHY */ 29 uintptr_t stm32mp_ddrphyc_base(void); 30 31 /* Return the base address of the PWR peripheral */ 32 uintptr_t stm32mp_pwr_base(void); 33 34 /* Return the base address of the RCC peripheral */ 35 uintptr_t stm32mp_rcc_base(void); 36 37 /* Check MMU status to allow spinlock use */ 38 bool stm32mp_lock_available(void); 39 40 int stm32_get_otp_index(const char *otp_name, uint32_t *otp_idx, 41 uint32_t *otp_len); 42 int stm32_get_otp_value(const char *otp_name, uint32_t *otp_val); 43 int stm32_get_otp_value_from_idx(const uint32_t otp_idx, uint32_t *otp_val); 44 45 /* Get IWDG platform instance ID from peripheral IO memory base address */ 46 uint32_t stm32_iwdg_get_instance(uintptr_t base); 47 48 /* Return bitflag mask for expected IWDG configuration from OTP content */ 49 uint32_t stm32_iwdg_get_otp_config(uint32_t iwdg_inst); 50 51 #if defined(IMAGE_BL2) 52 /* Update OTP shadow registers with IWDG configuration from device tree */ 53 uint32_t stm32_iwdg_shadow_update(uint32_t iwdg_inst, uint32_t flags); 54 #endif 55 56 #if STM32MP_UART_PROGRAMMER || !defined(IMAGE_BL2) 57 /* Get the UART address from its instance number */ 58 uintptr_t get_uart_address(uint32_t instance_nb); 59 #endif 60 61 /* Setup the UART console */ 62 int stm32mp_uart_console_setup(void); 63 64 /* 65 * Platform util functions for the GPIO driver 66 * @bank: Target GPIO bank ID as per DT bindings 67 * 68 * Platform shall implement these functions to provide to stm32_gpio 69 * driver the resource reference for a target GPIO bank. That are 70 * memory mapped interface base address, interface offset (see below) 71 * and clock identifier. 72 * 73 * stm32_get_gpio_bank_offset() returns a bank offset that is used to 74 * check DT configuration matches platform implementation of the banks 75 * description. 76 */ 77 uintptr_t stm32_get_gpio_bank_base(unsigned int bank); 78 unsigned long stm32_get_gpio_bank_clock(unsigned int bank); 79 uint32_t stm32_get_gpio_bank_offset(unsigned int bank); 80 bool stm32_gpio_is_secure_at_reset(unsigned int bank); 81 82 /* Return node offset for target GPIO bank ID @bank or a FDT error code */ 83 int stm32_get_gpio_bank_pinctrl_node(void *fdt, unsigned int bank); 84 85 /* Get the chip revision */ 86 uint32_t stm32mp_get_chip_version(void); 87 /* Get the chip device ID */ 88 uint32_t stm32mp_get_chip_dev_id(void); 89 90 /* Get SOC name */ 91 #define STM32_SOC_NAME_SIZE 20 92 void stm32mp_get_soc_name(char name[STM32_SOC_NAME_SIZE]); 93 94 /* Print CPU information */ 95 void stm32mp_print_cpuinfo(void); 96 97 /* Print board information */ 98 void stm32mp_print_boardinfo(void); 99 100 /* Initialise the IO layer and register platform IO devices */ 101 void stm32mp_io_setup(void); 102 103 #if STM32MP_USE_STM32IMAGE 104 /* 105 * Check that the STM32 header of a .stm32 binary image is valid 106 * @param header: pointer to the stm32 image header 107 * @param buffer: address of the binary image (payload) 108 * @return: 0 on success, negative value in case of error 109 */ 110 int stm32mp_check_header(boot_api_image_header_t *header, uintptr_t buffer); 111 #endif /* STM32MP_USE_STM32IMAGE */ 112 113 /* Functions to map DDR in MMU with non-cacheable attribute, and unmap it */ 114 int stm32mp_map_ddr_non_cacheable(void); 115 int stm32mp_unmap_ddr(void); 116 117 /* Functions to save and get boot peripheral info */ 118 void stm32_save_boot_interface(uint32_t interface, uint32_t instance); 119 void stm32_get_boot_interface(uint32_t *interface, uint32_t *instance); 120 121 #if !STM32MP_USE_STM32IMAGE && PSA_FWU_SUPPORT 122 void stm32mp1_fwu_set_boot_idx(void); 123 #endif /* !STM32MP_USE_STM32IMAGE && PSA_FWU_SUPPORT */ 124 125 #endif /* STM32MP_COMMON_H */ 126