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