1 /* 2 * Copyright (C) 2018-2026, 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 #define STM32MP_CHIP_SEC_CLOSED U(0x34D9CCC5) 18 #define STM32MP_CHIP_SEC_OPEN U(0xA764D182) 19 20 /* FWU configuration (max supported value is 15) */ 21 #define FWU_MAX_TRIAL_REBOOT U(3) 22 23 /* Define maximum page size for NAND devices */ 24 #define PLATFORM_MTD_MAX_PAGE_SIZE U(0x1000) 25 26 /* Needed by STM32CubeProgrammer support */ 27 #define DWL_BUFFER_SIZE U(0x01000000) 28 29 /* Functions to save and get boot context address given by ROM code */ 30 void stm32mp_save_boot_ctx_address(uintptr_t address); 31 uintptr_t stm32mp_get_boot_ctx_address(void); 32 uint16_t stm32mp_get_boot_itf_selected(void); 33 34 bool stm32mp_is_single_core(void); 35 bool stm32mp_is_auth_supported(void); 36 uint32_t stm32mp_check_closed_device(void); 37 38 /* Return the base address of the DDR controller */ 39 uintptr_t stm32mp_ddrctrl_base(void); 40 41 /* Return the base address of the DDR PHY */ 42 uintptr_t stm32mp_ddrphyc_base(void); 43 44 /* Return the base address of the PWR peripheral */ 45 uintptr_t stm32mp_pwr_base(void); 46 47 /* Return the base address of the RCC peripheral */ 48 uintptr_t stm32mp_rcc_base(void); 49 50 void stm32mp_gic_cpuif_enable(void); 51 void stm32mp_gic_cpuif_disable(void); 52 void stm32mp_gic_pcpu_init(void); 53 void stm32mp_gic_init(void); 54 55 /* Check MMU status to allow spinlock use */ 56 bool stm32mp_lock_available(void); 57 58 int stm32_get_otp_index(const char *otp_name, uint32_t *otp_idx, 59 uint32_t *otp_len); 60 int stm32_get_otp_value(const char *otp_name, uint32_t *otp_val); 61 int stm32_get_otp_value_from_idx(const uint32_t otp_idx, uint32_t *otp_val); 62 /* update UID_WORD_NB array */ 63 int stm32_get_uid_otp(uint32_t uid[]); 64 65 /* Get IWDG platform instance ID from peripheral IO memory base address */ 66 uint32_t stm32_iwdg_get_instance(uintptr_t base); 67 68 /* Return bitflag mask for expected IWDG configuration from OTP content */ 69 uint32_t stm32_iwdg_get_otp_config(uint32_t iwdg_inst); 70 71 #if defined(IMAGE_BL2) 72 /* Update OTP shadow registers with IWDG configuration from device tree */ 73 uint32_t stm32_iwdg_shadow_update(uint32_t iwdg_inst, uint32_t flags); 74 #endif 75 76 #if STM32MP_UART_PROGRAMMER || !defined(IMAGE_BL2) 77 /* Get the UART address from its instance number */ 78 uintptr_t get_uart_address(uint32_t instance_nb); 79 #endif 80 81 /* Setup the UART console */ 82 int stm32mp_uart_console_setup(void); 83 84 bool stm32mp_is_wakeup_from_standby(void); 85 86 /* 87 * Platform util functions for the GPIO driver 88 * @bank: Target GPIO bank ID as per DT bindings 89 * 90 * Platform shall implement these functions to provide to stm32_gpio 91 * driver the resource reference for a target GPIO bank. That are 92 * memory mapped interface base address, interface offset (see below) 93 * and clock identifier. 94 * 95 * stm32_get_gpio_bank_offset() returns a bank offset that is used to 96 * check DT configuration matches platform implementation of the banks 97 * description. 98 */ 99 uintptr_t stm32_get_gpio_bank_base(unsigned int bank); 100 unsigned long stm32_get_gpio_bank_clock(unsigned int bank); 101 uint32_t stm32_get_gpio_bank_offset(unsigned int bank); 102 bool stm32_gpio_is_secure_at_reset(unsigned int bank); 103 104 /* Return node offset for target GPIO bank ID @bank or a FDT error code */ 105 int stm32_get_gpio_bank_pinctrl_node(void *fdt, unsigned int bank); 106 107 /* Get the chip revision */ 108 uint32_t stm32mp_get_chip_version(void); 109 /* Get the chip device ID */ 110 uint32_t stm32mp_get_chip_dev_id(void); 111 112 /* Get SOC name */ 113 #define STM32_SOC_NAME_SIZE 20 114 void stm32mp_get_soc_name(char name[STM32_SOC_NAME_SIZE]); 115 116 /* Print CPU information */ 117 void stm32mp_print_cpuinfo(void); 118 119 /* Print board information */ 120 void stm32mp_print_boardinfo(void); 121 122 /* Initialise the IO layer and register platform IO devices */ 123 void stm32mp_io_setup(void); 124 125 /* Functions to map DDR in MMU with non-cacheable attribute, and unmap it */ 126 int stm32mp_map_ddr_non_cacheable(void); 127 int stm32mp_unmap_ddr(void); 128 129 /* Functions to map RETRAM, and unmap it */ 130 int stm32mp_map_retram(void); 131 int stm32mp_unmap_retram(void); 132 133 /* Function to save boot info */ 134 void stm32_save_boot_info(boot_api_context_t *boot_context); 135 /* Function to get boot peripheral info */ 136 void stm32_get_boot_interface(uint32_t *interface, uint32_t *instance); 137 /* Function to get BOOT_MODE backup register address */ 138 uintptr_t stm32_get_bkpr_boot_mode_addr(void); 139 140 /* Display board information from the value found in OTP fuse */ 141 void stm32_display_board_info(uint32_t board_id); 142 143 #if PSA_FWU_SUPPORT 144 uintptr_t stm32_get_bkpr_fwu_info_addr(void); 145 void stm32_fwu_set_boot_idx(void); 146 uint32_t stm32_get_and_dec_fwu_trial_boot_cnt(void); 147 void stm32_set_max_fwu_trial_boot_cnt(void); 148 void stm32_clear_fwu_trial_boot_cnt(void); 149 #endif /* PSA_FWU_SUPPORT */ 150 151 #endif /* STM32MP_COMMON_H */ 152