/** ****************************************************************************** * @file stm32l0xx_hal_firewall.c * @author MCD Application Team * @version V1.2.0 * @date 06-February-2015 * @brief FIREWALL HAL module driver. * * This file provides firmware functions to manage the Firewall * Peripheral initialization and enabling. * * @verbatim =============================================================================== ##### How to use this driver ##### =============================================================================== [..] The FIREWALL HAL driver can be used as follows: (#) Declare a FIREWALL_InitTypeDef initialization structure. (#) Resort to HAL_FIREWALL_Config() API to initialize the Firewall (#) Enable the FIREWALL in calling HAL_FIREWALL_EnableFirewall() API (#) To ensure that any code executed outside the protected segment closes the FIREWALL, the user must set the flag FIREWALL_PRE_ARM_SET in calling __HAL_FIREWALL_PREARM_ENABLE() macro if called within a protected code segment or HAL_FIREWALL_EnablePreArmFlag() API if called outside of protected code segment after HAL_FIREWALL_Config() call. @endverbatim ****************************************************************************** * @attention * *

© COPYRIGHT(c) 2015 STMicroelectronics

* * Redistribution and use in source and binary forms, with or without modification, * are permitted provided that the following conditions are met: * 1. Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. * 3. Neither the name of STMicroelectronics nor the names of its contributors * may be used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * ****************************************************************************** */ /* Includes ------------------------------------------------------------------*/ #include "stm32l0xx_hal.h" /** @addtogroup STM32L0xx_HAL_Driver * @{ */ /** @defgroup FIREWALL FIREWALL * @brief HAL FIREWALL module driver * @{ */ #ifdef HAL_FIREWALL_MODULE_ENABLED /* Private typedef -----------------------------------------------------------*/ /* Private define ------------------------------------------------------------*/ /* Private macro -------------------------------------------------------------*/ /* Private variables ---------------------------------------------------------*/ /* Private function prototypes -----------------------------------------------*/ /* Private functions ---------------------------------------------------------*/ /** @defgroup FIREWALL_Exported_Functions FIREWALL Exported Functions * @{ */ /** @defgroup FIREWALL_Exported_Functions_Group1 Initialization Functions * @brief Initialization and Configuration Functions * @verbatim =============================================================================== ##### Initialization and Configuration functions ##### =============================================================================== [..] This subsection provides the functions allowing to initialize the Firewall. Initialization is done by HAL_FIREWALL_Config(): (+) Enable the Firewall clock thru __HAL_RCC_FIREWALL_CLK_ENABLE() macro. (+) Set the protected code segment address start and length. (+) Set the protected non-volatile and/or volatile data segments address starts and lengths if applicable. (+) Set the volatile data segment execution and sharing status. (+) Length must be set to 0 for an unprotected segment. @endverbatim * @{ */ /** * @brief Initialize the Firewall according to the FIREWALL_InitTypeDef structure parameters. * @param fw_init: Firewall initialization structure * @note The API returns HAL_ERROR if the Firewall is already enabled. * @retval HAL status */ HAL_StatusTypeDef HAL_FIREWALL_Config(FIREWALL_InitTypeDef * fw_init) { /* Check the Firewall initialization structure allocation */ if(fw_init == NULL) { return HAL_ERROR; } /* Enable Firewall clock */ __HAL_RCC_FIREWALL_CLK_ENABLE(); /* Make sure that Firewall is not enabled already */ if (__HAL_FIREWALL_IS_ENABLED() != RESET) { return HAL_ERROR; } /* Check Firewall configuration addresses and lengths when segment is protected */ /* Code segment */ if (fw_init->CodeSegmentLength != 0) { assert_param(IS_FIREWALL_CODE_SEGMENT_ADDRESS(fw_init->CodeSegmentStartAddress)); assert_param(IS_FIREWALL_CODE_SEGMENT_LENGTH(fw_init->CodeSegmentStartAddress, fw_init->CodeSegmentLength)); } /* Non volatile data segment */ if (fw_init->NonVDataSegmentLength != 0) { assert_param(IS_FIREWALL_NONVOLATILEDATA_SEGMENT_ADDRESS(fw_init->NonVDataSegmentStartAddress)); assert_param(IS_FIREWALL_NONVOLATILEDATA_SEGMENT_LENGTH(fw_init->NonVDataSegmentStartAddress, fw_init->NonVDataSegmentLength)); } /* Volatile data segment */ if (fw_init->VDataSegmentLength != 0) { assert_param(IS_FIREWALL_VOLATILEDATA_SEGMENT_ADDRESS(fw_init->VDataSegmentStartAddress)); assert_param(IS_FIREWALL_VOLATILEDATA_SEGMENT_LENGTH(fw_init->VDataSegmentStartAddress, fw_init->VDataSegmentLength)); } /* Check Firewall Configuration Register parameters */ assert_param(IS_FIREWALL_VOLATILEDATA_EXECUTE(fw_init->VolatileDataExecution)); assert_param(IS_FIREWALL_VOLATILEDATA_SHARE(fw_init->VolatileDataShared)); /* Configuration */ /* Protected code segment start address configuration */ WRITE_REG(FW->CSSA, (FW_CSSA_ADD & fw_init->CodeSegmentStartAddress)); /* Protected code segment length configuration */ WRITE_REG(FW->CSL, (FW_CSL_LENG & fw_init->CodeSegmentLength)); /* Protected non volatile data segment start address configuration */ WRITE_REG(FW->NVDSSA, (FW_NVDSSA_ADD & fw_init->NonVDataSegmentStartAddress)); /* Protected non volatile data segment length configuration */ WRITE_REG(FW->NVDSL, (FW_NVDSL_LENG & fw_init->NonVDataSegmentLength)); /* Protected volatile data segment start address configuration */ WRITE_REG(FW->VDSSA, (FW_VDSSA_ADD & fw_init->VDataSegmentStartAddress)); /* Protected volatile data segment length configuration */ WRITE_REG(FW->VDSL, (FW_VDSL_LENG & fw_init->VDataSegmentLength)); /* Set Firewall Configuration Register VDE and VDS bits (volatile data execution and shared configuration) */ MODIFY_REG(FW->CR, FW_CR_VDS|FW_CR_VDE, fw_init->VolatileDataExecution|fw_init->VolatileDataShared); return HAL_OK; } /** * @brief Retrieve the Firewall configuration. * @param fw_config: Firewall configuration, type is same as initialization structure * @note This API can't be executed inside a code area protected by the Firewall * when the Firewall is enabled * @note If NVDSL register is different from 0, that is, if the non volatile data segment * is defined, this API can't be executed when the Firewall is enabled. * @note User should resort to __HAL_FIREWALL_GET_PREARM() macro to retrieve FPA bit status * @retval None */ void HAL_FIREWALL_GetConfig(FIREWALL_InitTypeDef * fw_config) { /* Enable Firewall clock, in case no Firewall configuration has been carried out up to this point */ __HAL_RCC_FIREWALL_CLK_ENABLE(); /* Retrieve code segment protection setting */ fw_config->CodeSegmentStartAddress = (READ_REG(FW->CSSA) & FW_CSSA_ADD); fw_config->CodeSegmentLength = (READ_REG(FW->CSL) & FW_CSL_LENG); /* Retrieve non volatile data segment protection setting */ fw_config->NonVDataSegmentStartAddress = (READ_REG(FW->NVDSSA) & FW_NVDSSA_ADD); fw_config->NonVDataSegmentLength = (READ_REG(FW->NVDSL) & FW_NVDSL_LENG); /* Retrieve volatile data segment protection setting */ fw_config->VDataSegmentStartAddress = (READ_REG(FW->VDSSA) & FW_VDSSA_ADD); fw_config->VDataSegmentLength = (READ_REG(FW->VDSL) & FW_VDSL_LENG); /* Retrieve volatile data execution setting */ fw_config->VolatileDataExecution = (READ_REG(FW->CR) & FW_CR_VDE); /* Retrieve volatile data shared setting */ fw_config->VolatileDataShared = (READ_REG(FW->CR) & FW_CR_VDS); return; } /** * @brief Enable FIREWALL. * @note Firewall is enabled in clearing FWDIS bit of SYSCFG CFGR1 register. * Once enabled, the Firewall cannot be disabled by software. Only a * system reset can set again FWDIS bit. * @retval None */ void HAL_FIREWALL_EnableFirewall(void) { /* Clears FWDIS bit of SYSCFG CFGR1 register */ CLEAR_BIT(SYSCFG->CFGR2, SYSCFG_CFGR2_FWDISEN); } /** * @brief Enable FIREWALL pre arm. * @note When FPA bit is set, any code executed outside the protected segment * will close the Firewall. * @note This API provides the same service as __HAL_FIREWALL_PREARM_ENABLE() macro * but can't be executed inside a code area protected by the Firewall. * @note -- When the Firewall is disabled, user can resort to * HAL_FIREWALL_EnablePreArmFlag() API any time. * -- When the Firewall is enabled and NVDSL register is equal to 0 (that is, * when the non volatile data segment is not defined), * ** this API can be executed when the Firewall is closed * ** when the Firewall is opened, user should resort to * __HAL_FIREWALL_PREARM_ENABLE() macro instead * -- When the Firewall is enabled and NVDSL register is different from 0 * (that is, when the non volatile data segment is defined) * ** FW_CR register can be accessed only when the Firewall is opened: * user should resort to __HAL_FIREWALL_PREARM_ENABLE() macro instead. * @retval None */ void HAL_FIREWALL_EnablePreArmFlag(void) { /* Set FPA bit */ SET_BIT(FW->CR, FW_CR_FPA); } /** * @brief Disable FIREWALL pre arm. * @note When FPA bit is reset, any code executed outside the protected segment * when the Firewall is opened will generate a system reset. * @note This API provides the same service as __HAL_FIREWALL_PREARM_DISABLE() macro * but can't be executed inside a code area protected by the Firewall. * @note -- When the Firewall is disabled, user can resort to * HAL_FIREWALL_EnablePreArmFlag() API any time. * -- When the Firewall is enabled and NVDSL register is equal to 0 (that is, * when the non volatile data segment is not defined), * ** this API can be executed when the Firewall is closed * ** when the Firewall is opened, user should resort to * __HAL_FIREWALL_PREARM_DISABLE() macro instead * -- When the Firewall is enabled and NVDSL register is different from 0 * (that is, when the non volatile data segment is defined) * ** FW_CR register can be accessed only when the Firewall is opened: * user should resort to __HAL_FIREWALL_PREARM_DISABLE() macro instead. * @retval None */ void HAL_FIREWALL_DisablePreArmFlag(void) { /* Clear FPA bit */ CLEAR_BIT(FW->CR, FW_CR_FPA); } /** * @} */ /** * @} */ #endif /* HAL_FIREWALL_MODULE_ENABLED */ /** * @} */ /** * @} */ /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/