blob: 26a3802d655d8e0a64204f60c824d1d72c15ef0a [file] [log] [blame]
// SPDX-License-Identifier: BSD-3-Clause
/*
* Copyright (c) 2017-2019, STMicroelectronics
*/
#include <drivers/stm32_etzpc.h>
#include <drivers/stm32_gpio.h>
#include <drivers/stm32mp1_etzpc.h>
#include <drivers/stm32mp1_rcc.h>
#include <dt-bindings/clock/stm32mp1-clks.h>
#include <initcall.h>
#include <io.h>
#include <keep.h>
#include <kernel/generic_boot.h>
#include <kernel/panic.h>
#include <kernel/pm.h>
#include <kernel/spinlock.h>
#include <mm/core_memprot.h>
#include <platform_config.h>
#include <stm32_util.h>
#include <stdbool.h>
#include <string.h>
#ifdef CFG_DT
#include <libfdt.h>
#endif
/*
* Once one starts to get the resource registering state, one cannot register
* new resources. This ensures resource state cannot change.
*/
static bool registering_locked;
/*
* Shared register access: upon shared resource lock
*/
static unsigned int shregs_lock = SPINLOCK_UNLOCK;
/* Shared resource lock: assume not required if MMU is disabled */
static uint32_t lock_stm32shregs(void)
{
return may_spin_lock(&shregs_lock);
}
static void unlock_stm32shregs(uint32_t exceptions)
{
may_spin_unlock(&shregs_lock, exceptions);
}
void io_mask32_stm32shregs(vaddr_t va, uint32_t value, uint32_t mask)
{
uint32_t exceptions = lock_stm32shregs();
io_mask32(va, value, mask);
unlock_stm32shregs(exceptions);
}
void io_clrsetbits32_stm32shregs(vaddr_t va, uint32_t clr, uint32_t set)
{
uint32_t exceptions = lock_stm32shregs();
io_clrsetbits32(va, clr, set);
unlock_stm32shregs(exceptions);
}
/*
* Shared peripherals and resources registration
*
* Each resource assignation is stored in a table. The state defaults
* to PERIPH_UNREGISTERED if the resource is not explicitly assigned.
*
* Resource driver that as not embedded (a.k.a their related CFG_xxx build
* directive is disabled) are assigned to the non-secure world.
*
* Each IO of the GPIOZ IO can be secure or non-secure.
*
* It is the platform responsibility the ensure resource assignation
* matches the access permission firewalls configuration.
*/
enum shres_state {
SHRES_UNREGISTERED = 0,
SHRES_SECURE,
SHRES_NON_SECURE,
};
/* Use a byte array to store each resource state */
static uint8_t shres_state[STM32MP1_SHRES_COUNT] = {
#if !defined(CFG_STM32_IWDG)
[STM32MP1_SHRES_IWDG1] = SHRES_NON_SECURE,
#endif
#if !defined(CFG_STM32_UART)
[STM32MP1_SHRES_USART1] = SHRES_NON_SECURE,
#endif
#if !defined(CFG_STM32_SPI)
[STM32MP1_SHRES_SPI6] = SHRES_NON_SECURE,
#endif
#if !defined(CFG_STM32_I2C)
[STM32MP1_SHRES_I2C4] = SHRES_NON_SECURE,
[STM32MP1_SHRES_I2C6] = SHRES_NON_SECURE,
#endif
#if !defined(CFG_STM32_GPIO)
[STM32MP1_SHRES_GPIOZ(0)] = SHRES_NON_SECURE,
[STM32MP1_SHRES_GPIOZ(1)] = SHRES_NON_SECURE,
[STM32MP1_SHRES_GPIOZ(2)] = SHRES_NON_SECURE,
[STM32MP1_SHRES_GPIOZ(3)] = SHRES_NON_SECURE,
[STM32MP1_SHRES_GPIOZ(4)] = SHRES_NON_SECURE,
[STM32MP1_SHRES_GPIOZ(5)] = SHRES_NON_SECURE,
[STM32MP1_SHRES_GPIOZ(6)] = SHRES_NON_SECURE,
[STM32MP1_SHRES_GPIOZ(7)] = SHRES_NON_SECURE,
#endif
#if !defined(CFG_STM32_RNG)
[STM32MP1_SHRES_RNG1] = SHRES_NON_SECURE,
#endif
#if !defined(CFG_STM32_HASH)
[STM32MP1_SHRES_HASH1] = SHRES_NON_SECURE,
#endif
#if !defined(CFG_STM32_CRYP)
[STM32MP1_SHRES_CRYP1] = SHRES_NON_SECURE,
#endif
#if !defined(CFG_STM32_RTC)
[STM32MP1_SHRES_RTC] = SHRES_NON_SECURE,
#endif
};
static const char __maybe_unused *shres2str_id_tbl[STM32MP1_SHRES_COUNT] = {
[STM32MP1_SHRES_GPIOZ(0)] = "GPIOZ0",
[STM32MP1_SHRES_GPIOZ(1)] = "GPIOZ1",
[STM32MP1_SHRES_GPIOZ(2)] = "GPIOZ2",
[STM32MP1_SHRES_GPIOZ(3)] = "GPIOZ3",
[STM32MP1_SHRES_GPIOZ(4)] = "GPIOZ4",
[STM32MP1_SHRES_GPIOZ(5)] = "GPIOZ5",
[STM32MP1_SHRES_GPIOZ(6)] = "GPIOZ6",
[STM32MP1_SHRES_GPIOZ(7)] = "GPIOZ7",
[STM32MP1_SHRES_IWDG1] = "IWDG1",
[STM32MP1_SHRES_USART1] = "USART1",
[STM32MP1_SHRES_SPI6] = "SPI6",
[STM32MP1_SHRES_I2C4] = "I2C4",
[STM32MP1_SHRES_RNG1] = "RNG1",
[STM32MP1_SHRES_HASH1] = "HASH1",
[STM32MP1_SHRES_CRYP1] = "CRYP1",
[STM32MP1_SHRES_I2C6] = "I2C6",
[STM32MP1_SHRES_RTC] = "RTC",
[STM32MP1_SHRES_MCU] = "MCU",
[STM32MP1_SHRES_HSI] = "HSI",
[STM32MP1_SHRES_LSI] = "LSI",
[STM32MP1_SHRES_HSE] = "HSE",
[STM32MP1_SHRES_LSE] = "LSE",
[STM32MP1_SHRES_CSI] = "CSI",
[STM32MP1_SHRES_PLL1] = "PLL1",
[STM32MP1_SHRES_PLL1_P] = "PLL1_P",
[STM32MP1_SHRES_PLL1_Q] = "PLL1_Q",
[STM32MP1_SHRES_PLL1_R] = "PLL1_R",
[STM32MP1_SHRES_PLL2] = "PLL2",
[STM32MP1_SHRES_PLL2_P] = "PLL2_P",
[STM32MP1_SHRES_PLL2_Q] = "PLL2_Q",
[STM32MP1_SHRES_PLL2_R] = "PLL2_R",
[STM32MP1_SHRES_PLL3] = "PLL3",
[STM32MP1_SHRES_PLL3_P] = "PLL3_P",
[STM32MP1_SHRES_PLL3_Q] = "PLL3_Q",
[STM32MP1_SHRES_PLL3_R] = "PLL3_R",
};
static __maybe_unused const char *shres2str_id(enum stm32mp_shres id)
{
return shres2str_id_tbl[id];
}
static const char *shres2str_state_tbl[4] __maybe_unused = {
[SHRES_UNREGISTERED] = "unregistered",
[SHRES_NON_SECURE] = "non-secure",
[SHRES_SECURE] = "secure",
};
static __maybe_unused const char *shres2str_state(enum stm32mp_shres id)
{
return shres2str_state_tbl[id];
}
/* GPIOZ bank pin count depends on SoC variants */
#ifdef CFG_DT
/* A light count routine for unpaged context to not depend on DTB support */
static int gpioz_nbpin = -1;
static unsigned int get_gpioz_nbpin(void)
{
if (gpioz_nbpin < 0)
panic();
return gpioz_nbpin;
}
static TEE_Result set_gpioz_nbpin_from_dt(void)
{
void *fdt = get_embedded_dt();
int node = fdt_path_offset(fdt, "/soc/pin-controller-z");
int count = stm32_get_gpio_count(fdt, node, GPIO_BANK_Z);
if (count < 0 || count > STM32MP1_GPIOZ_PIN_MAX_COUNT)
panic();
gpioz_nbpin = count;
return TEE_SUCCESS;
}
/* Get GPIOZ pin count before drivers initialization, hence service_init() */
service_init(set_gpioz_nbpin_from_dt);
#else
static unsigned int get_gpioz_nbpin(void)
{
return STM32MP1_GPIOZ_PIN_MAX_COUNT;
}
#endif
static void register_periph(enum stm32mp_shres id, enum shres_state state)
{
assert(id < STM32MP1_SHRES_COUNT &&
(state == SHRES_SECURE || state == SHRES_NON_SECURE));
if (registering_locked)
panic();
if (shres_state[id] != SHRES_UNREGISTERED &&
shres_state[id] != state) {
DMSG("Cannot change %s from %s to %s",
shres2str_id(id),
shres2str_state(shres_state[id]),
shres2str_state(state));
panic();
}
if (shres_state[id] == SHRES_UNREGISTERED)
DMSG("Register %s as %s",
shres2str_id(id), shres2str_state(state));
switch (id) {
case STM32MP1_SHRES_GPIOZ(0):
case STM32MP1_SHRES_GPIOZ(1):
case STM32MP1_SHRES_GPIOZ(2):
case STM32MP1_SHRES_GPIOZ(3):
case STM32MP1_SHRES_GPIOZ(4):
case STM32MP1_SHRES_GPIOZ(5):
case STM32MP1_SHRES_GPIOZ(6):
case STM32MP1_SHRES_GPIOZ(7):
if ((id - STM32MP1_SHRES_GPIOZ(0)) >= get_gpioz_nbpin()) {
EMSG("Invalid GPIO %u >= %u",
id - STM32MP1_SHRES_GPIOZ(0), get_gpioz_nbpin());
panic();
}
break;
default:
break;
}
shres_state[id] = state;
/* Explore clock tree to lock secure clock dependencies */
if (state == SHRES_SECURE) {
switch (id) {
case STM32MP1_SHRES_GPIOZ(0):
case STM32MP1_SHRES_GPIOZ(1):
case STM32MP1_SHRES_GPIOZ(2):
case STM32MP1_SHRES_GPIOZ(3):
case STM32MP1_SHRES_GPIOZ(4):
case STM32MP1_SHRES_GPIOZ(5):
case STM32MP1_SHRES_GPIOZ(6):
case STM32MP1_SHRES_GPIOZ(7):
stm32mp_register_clock_parents_secure(GPIOZ);
break;
case STM32MP1_SHRES_IWDG1:
stm32mp_register_clock_parents_secure(IWDG1);
break;
case STM32MP1_SHRES_USART1:
stm32mp_register_clock_parents_secure(USART1_K);
break;
case STM32MP1_SHRES_SPI6:
stm32mp_register_clock_parents_secure(SPI6_K);
break;
case STM32MP1_SHRES_I2C4:
stm32mp_register_clock_parents_secure(I2C4_K);
break;
case STM32MP1_SHRES_RNG1:
stm32mp_register_clock_parents_secure(RNG1_K);
break;
case STM32MP1_SHRES_HASH1:
stm32mp_register_clock_parents_secure(HASH1);
break;
case STM32MP1_SHRES_CRYP1:
stm32mp_register_clock_parents_secure(CRYP1);
break;
case STM32MP1_SHRES_I2C6:
stm32mp_register_clock_parents_secure(I2C6_K);
break;
case STM32MP1_SHRES_RTC:
stm32mp_register_clock_parents_secure(RTC);
break;
case STM32MP1_SHRES_PLL1_P:
case STM32MP1_SHRES_PLL1_Q:
case STM32MP1_SHRES_PLL1_R:
register_periph(STM32MP1_SHRES_PLL1, SHRES_SECURE);
break;
case STM32MP1_SHRES_PLL1:
stm32mp_register_clock_parents_secure(PLL1);
break;
case STM32MP1_SHRES_PLL2_P:
case STM32MP1_SHRES_PLL2_Q:
case STM32MP1_SHRES_PLL2_R:
register_periph(STM32MP1_SHRES_PLL2, SHRES_SECURE);
break;
case STM32MP1_SHRES_PLL2:
stm32mp_register_clock_parents_secure(PLL2);
break;
case STM32MP1_SHRES_PLL3_P:
case STM32MP1_SHRES_PLL3_Q:
case STM32MP1_SHRES_PLL3_R:
register_periph(STM32MP1_SHRES_PLL3, SHRES_SECURE);
break;
case STM32MP1_SHRES_PLL3:
stm32mp_register_clock_parents_secure(PLL3);
break;
default:
/* No expected resource dependency */
break;
}
}
}
/* Register resource by ID */
void stm32mp_register_secure_periph(enum stm32mp_shres id)
{
register_periph(id, SHRES_SECURE);
}
void stm32mp_register_non_secure_periph(enum stm32mp_shres id)
{
register_periph(id, SHRES_NON_SECURE);
}
/* Register resource by IO memory base address */
static void register_periph_iomem(vaddr_t base, enum shres_state state)
{
enum stm32mp_shres id = STM32MP1_SHRES_COUNT;
switch (base) {
case IWDG1_BASE:
id = STM32MP1_SHRES_IWDG1;
break;
case USART1_BASE:
id = STM32MP1_SHRES_USART1;
break;
case SPI6_BASE:
id = STM32MP1_SHRES_SPI6;
break;
case I2C4_BASE:
id = STM32MP1_SHRES_I2C4;
break;
case I2C6_BASE:
id = STM32MP1_SHRES_I2C6;
break;
case RTC_BASE:
id = STM32MP1_SHRES_RTC;
break;
case RNG1_BASE:
id = STM32MP1_SHRES_RNG1;
break;
case CRYP1_BASE:
id = STM32MP1_SHRES_CRYP1;
break;
case HASH1_BASE:
id = STM32MP1_SHRES_HASH1;
break;
/* Always non-secure resource cases */
#ifdef CFG_WITH_NSEC_GPIOS
case GPIOA_BASE:
case GPIOB_BASE:
case GPIOC_BASE:
case GPIOD_BASE:
case GPIOE_BASE:
case GPIOF_BASE:
case GPIOG_BASE:
case GPIOH_BASE:
case GPIOI_BASE:
case GPIOJ_BASE:
case GPIOK_BASE:
/* Fall through */
#endif
#ifdef CFG_WITH_NSEC_UARTS
case USART2_BASE:
case USART3_BASE:
case UART4_BASE:
case UART5_BASE:
case USART6_BASE:
case UART7_BASE:
case UART8_BASE:
/* Fall through */
#endif
case IWDG2_BASE:
/* Allow drivers to register some non-secure resources */
DMSG("IO for non-secure resource 0x%lx", base);
if (state != SHRES_NON_SECURE)
panic();
return;
default:
panic();
break;
}
register_periph(id, state);
}
void stm32mp_register_secure_periph_iomem(vaddr_t base)
{
register_periph_iomem(base, SHRES_SECURE);
}
void stm32mp_register_non_secure_periph_iomem(vaddr_t base)
{
register_periph_iomem(base, SHRES_NON_SECURE);
}
/* Register GPIO resource */
void stm32mp_register_secure_gpio(unsigned int bank, unsigned int pin)
{
switch (bank) {
case GPIO_BANK_Z:
assert(pin < get_gpioz_nbpin());
register_periph(STM32MP1_SHRES_GPIOZ(pin), SHRES_SECURE);
break;
default:
EMSG("GPIO bank %u cannot be secured", bank);
panic();
}
}
void stm32mp_register_non_secure_gpio(unsigned int bank, unsigned int pin)
{
switch (bank) {
case GPIO_BANK_Z:
assert(pin < get_gpioz_nbpin());
register_periph(STM32MP1_SHRES_GPIOZ(pin), SHRES_NON_SECURE);
break;
default:
break;
}
}
static void lock_registering(void)
{
registering_locked = true;
}
bool stm32mp_periph_is_secure(enum stm32mp_shres id)
{
lock_registering();
return shres_state[id] == SHRES_SECURE;
}
bool stm32mp_gpio_bank_is_shared(unsigned int bank)
{
unsigned int not_secure = 0;
unsigned int pin = 0;
lock_registering();
if (bank != GPIO_BANK_Z)
return false;
for (pin = 0; pin < get_gpioz_nbpin(); pin++)
if (!stm32mp_periph_is_secure(STM32MP1_SHRES_GPIOZ(pin)))
not_secure++;
return not_secure > 0 && not_secure < get_gpioz_nbpin();
}
bool stm32mp_gpio_bank_is_non_secure(unsigned int bank)
{
unsigned int not_secure = 0;
unsigned int pin = 0;
lock_registering();
if (bank != GPIO_BANK_Z)
return true;
for (pin = 0; pin < get_gpioz_nbpin(); pin++)
if (!stm32mp_periph_is_secure(STM32MP1_SHRES_GPIOZ(pin)))
not_secure++;
return not_secure > 0 && not_secure == get_gpioz_nbpin();
}
bool stm32mp_gpio_bank_is_secure(unsigned int bank)
{
unsigned int secure = 0;
unsigned int pin = 0;
lock_registering();
if (bank != GPIO_BANK_Z)
return false;
for (pin = 0; pin < get_gpioz_nbpin(); pin++)
if (stm32mp_periph_is_secure(STM32MP1_SHRES_GPIOZ(pin)))
secure++;
return secure > 0 && secure == get_gpioz_nbpin();
}
bool stm32mp_clock_is_shareable(unsigned long clock_id)
{
switch (clock_id) {
case GPIOZ:
/* GPIOZ clocking may be shared */
return get_gpioz_nbpin() > 0;
case RTCAPB:
/* RTCAPB clock is shared: non-secure backup registers */
return true;
default:
return false;
}
}
bool stm32mp_clock_is_shared(unsigned long clock_id)
{
lock_registering();
switch (clock_id) {
case GPIOZ:
/* GPIOZ clocking may be shared */
if (get_gpioz_nbpin() > 0)
return stm32mp_gpio_bank_is_shared(GPIO_BANK_Z);
else
return false;
case RTCAPB:
/* RTCAPB clock must be shared: non-secure backup registers */
return true;
default:
return false;
}
}
bool stm32mp_clock_is_non_secure(unsigned long clock_id)
{
enum stm32mp_shres shres_id = STM32MP1_SHRES_COUNT;
lock_registering();
if (stm32mp_clock_is_shared(clock_id))
return false;
switch (clock_id) {
case BSEC:
case BKPSRAM:
case TZPC:
case TZC1:
case TZC2:
case STGEN_K:
case DDRC1:
case DDRC1LP:
case DDRC2:
case DDRC2LP:
case DDRPHYC:
case DDRPHYCLP:
case DDRCAPB:
case DDRCAPBLP:
case AXIDCG:
case DDRPHYCAPB:
case DDRPHYCAPBLP:
return false;
case IWDG1:
shres_id = STM32MP1_SHRES_IWDG1;
break;
case USART1_K:
shres_id = STM32MP1_SHRES_USART1;
break;
case SPI6_K:
shres_id = STM32MP1_SHRES_SPI6;
break;
case I2C4_K:
shres_id = STM32MP1_SHRES_I2C4;
break;
case RNG1_K:
shres_id = STM32MP1_SHRES_RNG1;
break;
case HASH1:
shres_id = STM32MP1_SHRES_HASH1;
break;
case CRYP1:
shres_id = STM32MP1_SHRES_CRYP1;
break;
case I2C6_K:
shres_id = STM32MP1_SHRES_I2C6;
break;
case RTC:
shres_id = STM32MP1_SHRES_RTC;
break;
default:
return true;
}
return !stm32mp_periph_is_secure(shres_id);
}
static bool mckprot_resource(enum stm32mp_shres id)
{
switch (id) {
case STM32MP1_SHRES_MCU:
case STM32MP1_SHRES_PLL3:
case STM32MP1_SHRES_PLL3_P:
case STM32MP1_SHRES_PLL3_Q:
case STM32MP1_SHRES_PLL3_R:
return true;
default:
return false;
}
}
#ifdef CFG_STM32_ETZPC
static enum etzpc_decprot_attributes shres2decprot_attr(enum stm32mp_shres id)
{
if (!stm32mp_periph_is_secure(id))
return ETZPC_DECPROT_NS_RW;
if (mckprot_resource(id))
return ETZPC_DECPROT_MCU_ISOLATION;
return ETZPC_DECPROT_S_RW;
}
static void set_etzpc_secure_configuration(void)
{
/* Some peripherals shall be secure */
etzpc_configure_decprot(STM32MP1_ETZPC_STGENC_ID, ETZPC_DECPROT_S_RW);
etzpc_configure_decprot(STM32MP1_ETZPC_BKPSRAM_ID, ETZPC_DECPROT_S_RW);
etzpc_configure_decprot(STM32MP1_ETZPC_DDRCTRL_ID, ETZPC_DECPROT_S_RW);
etzpc_configure_decprot(STM32MP1_ETZPC_DDRPHYC_ID, ETZPC_DECPROT_S_RW);
/* Configure ETZPC with peripheral registering */
etzpc_configure_decprot(STM32MP1_ETZPC_IWDG1_ID,
shres2decprot_attr(STM32MP1_SHRES_IWDG1));
etzpc_configure_decprot(STM32MP1_ETZPC_USART1_ID,
shres2decprot_attr(STM32MP1_SHRES_USART1));
etzpc_configure_decprot(STM32MP1_ETZPC_SPI6_ID,
shres2decprot_attr(STM32MP1_SHRES_SPI6));
etzpc_configure_decprot(STM32MP1_ETZPC_I2C4_ID,
shres2decprot_attr(STM32MP1_SHRES_I2C4));
etzpc_configure_decprot(STM32MP1_ETZPC_RNG1_ID,
shres2decprot_attr(STM32MP1_SHRES_RNG1));
etzpc_configure_decprot(STM32MP1_ETZPC_HASH1_ID,
shres2decprot_attr(STM32MP1_SHRES_HASH1));
etzpc_configure_decprot(STM32MP1_ETZPC_CRYP1_ID,
shres2decprot_attr(STM32MP1_SHRES_CRYP1));
etzpc_configure_decprot(STM32MP1_ETZPC_I2C6_ID,
shres2decprot_attr(STM32MP1_SHRES_I2C6));
}
#else
static void set_etzpc_secure_configuration(void)
{
/* Nothing to do */
}
#endif
static void check_rcc_secure_configuration(void)
{
bool secure = stm32_rcc_is_secure();
bool mckprot = stm32_rcc_is_mckprot();
enum stm32mp_shres id = STM32MP1_SHRES_COUNT;
bool have_error = false;
if (stm32mp_is_closed_device() && !secure)
panic();
for (id = 0; id < STM32MP1_SHRES_COUNT; id++) {
if (shres_state[id] != SHRES_SECURE)
continue;
if ((mckprot_resource(id) && !mckprot) || !secure) {
EMSG("RCC %s MCKPROT %s and %s (%u) secure",
secure ? "secure" : "non-secure",
mckprot ? "set" : "not set",
shres2str_id(id), id);
have_error = true;
}
}
if (have_error)
panic();
}
static void set_gpio_secure_configuration(void)
{
unsigned int pin = 0;
for (pin = 0; pin < get_gpioz_nbpin(); pin++) {
enum stm32mp_shres shres = STM32MP1_SHRES_GPIOZ(pin);
bool secure = stm32mp_periph_is_secure(shres);
stm32_gpio_set_secure_cfg(GPIO_BANK_Z, pin, secure);
}
}
static TEE_Result gpioz_pm(enum pm_op op, uint32_t pm_hint __unused,
const struct pm_callback_handle *hdl __unused)
{
if (op == PM_OP_RESUME)
set_gpio_secure_configuration();
return TEE_SUCCESS;
}
KEEP_PAGER(gpioz_pm);
static TEE_Result stm32mp1_init_final_shres(void)
{
enum stm32mp_shres id = STM32MP1_SHRES_COUNT;
lock_registering();
for (id = (enum stm32mp_shres)0; id < STM32MP1_SHRES_COUNT; id++) {
uint8_t __maybe_unused *state = &shres_state[id];
DMSG("stm32mp %-8s (%2u): %-14s",
shres2str_id(id), id, shres2str_state(*state));
}
set_etzpc_secure_configuration();
set_gpio_secure_configuration();
register_pm_driver_cb(gpioz_pm, NULL);
check_rcc_secure_configuration();
return TEE_SUCCESS;
}
/* Finalize shres after drivers initialization, hence driver_init_late() */
driver_init_late(stm32mp1_init_final_shres);