/** ****************************************************************************** * @file py32f0xx_hal_flash.h * @author MCU Application Team * @brief Header file of FLASH HAL module. ****************************************************************************** * @attention * *

© Copyright (c) Puya Semiconductor Co. * All rights reserved.

* *

© Copyright (c) 2016 STMicroelectronics. * All rights reserved.

* * This software component is licensed by ST under BSD 3-Clause license, * the "License"; You may not use this file except in compliance with the * License. You may obtain a copy of the License at: * opensource.org/licenses/BSD-3-Clause * ****************************************************************************** */ /* Define to prevent recursive inclusion -------------------------------------*/ #ifndef __PY32F0xx_LL_FLASH_H #define __PY32F0xx_LL_FLASH_H #ifdef __cplusplus extern "C" { #endif /* Includes ------------------------------------------------------------------*/ #include "py32f0xx.h" /** @addtogroup PY32F0xx_LL_Driver * @{ */ /** @addtogroup FLASH * @{ */ /* Exported types ------------------------------------------------------------*/ /** @defgroup FLASH_Exported_Types FLASH Exported Types * @{ */ /** * @brief LL Lock structures definition */ typedef enum { LL_UNLOCKED = 0x00U, LL_LOCKED = 0x01U } LL_LockTypeDef; /** * @brief FLASH Erase structure definition */ typedef struct { uint32_t TypeErase; /*!< Mass erase or page erase. This parameter can be a value of @ref FLASH_Type_Erase */ uint32_t PageAddress; /*!< PageAdress: Initial FLASH page address to erase when mass erase and sector erase is disabled This parameter must be a number between Min_Data = FLASH_BASE and Max_Data = FLASH_END */ uint32_t NbPages; /*!< Number of pages to be erased. This parameter must be a value between 1 and (FLASH_PAGE_NB - value of initial page)*/ uint32_t SectorAddress; /*!< PageAdress: Initial FLASH page address to erase when mass erase and page erase is disabled This parameter must be a number between Min_Data = FLASH_BASE and Max_Data = FLASH_BANK1_END */ uint32_t NbSectors; /*!< Number of sectors to be erased. This parameter must be a value between 1 and (FLASH_SECTOR_NB - value of initial sector)*/ } FLASH_EraseInitTypeDef; /** * @brief FLASH Option Bytes PROGRAM structure definition */ typedef struct { uint32_t OptionType; /*!< OptionType: Option byte to be configured. This parameter can be a value of @ref FLASH_Option_Type */ uint32_t WRPSector; /*!< WRPSector: This bitfield specifies the sector (s) which are write protected. This parameter can be a combination of @ref FLASH_Option_Bytes_Write_Protection */ uint32_t SDKStartAddr; /*!< SDK Start address (used for FLASH_SDKR). It represents first address of start block to protect. Make sure this parameter is multiple of SDK granularity: 2048 Bytes.*/ uint32_t SDKEndAddr; /*!< SDK End address (used for FLASH_SDKR). It represents first address of end block to protect. Make sure this parameter is multiple of SDK granularity: 2048 Bytes.*/ uint32_t RDPLevel; /*!< RDPLevel: Set the read protection level. This parameter can be a value of @ref FLASH_OB_Read_Protection */ uint32_t USERType; /*!< User option byte(s) to be configured (used for OPTIONBYTE_USER). This parameter can be a combination of @ref FLASH_OB_USER_Type */ uint32_t USERConfig; /*!< Value of the user option byte (used for OPTIONBYTE_USER). This parameter can be a combination of @ref FLASH_OB_USER_BOR_ENABLE, @ref FLASH_OB_USER_BOR_LEVEL, @ref FLASH_OB_USER_RESET_CONFIG, @ref FLASH_OB_USER_IWDG_SW, @ref FLASH_OB_USER_WWDG_SW, @ref FLASH_OB_USER_nBOOT1 */ } FLASH_OBProgramInitTypeDef; /** * @brief FLASH handle Structure definition */ typedef struct { LL_LockTypeDef Lock; /* FLASH locking object */ uint32_t ErrorCode; /* FLASH error code */ uint32_t ProcedureOnGoing; /* Internal variable to indicate which procedure is ongoing or not in IT context */ uint32_t Address; /* Internal variable to save address selected for program in IT context */ uint32_t PageOrSector; /* Internal variable to define the current page or sector which is erasing in IT context */ uint32_t NbPagesSectorsToErase; /* Internal variable to save the remaining pages to erase in IT context */ } FLASH_ProcessTypeDef; /** * @} */ /* Exported constants --------------------------------------------------------*/ /** @defgroup FLASH_Exported_Constants FLASH Exported Constants * @{ */ /** * @} */ /** @defgroup FLASH_Latency FLASH Latency * @{ */ #define FLASH_LATENCY_0 0x00000000UL /*!< FLASH Zero wait state */ #define FLASH_LATENCY_1 FLASH_ACR_LATENCY /*!< FLASH One wait state */ /** * @} */ /** @defgroup FLASH_Type_Erase FLASH erase type * @{ */ #define FLASH_TYPEERASE_MASSERASE (0x01U) /*!ACR, FLASH_ACR_LATENCY, (__LATENCY__)) /** * @brief Get the FLASH Latency. * @retval FLASH Latency * Returned value can be one of the following values : * @arg @ref FLASH_LATENCY_0 FLASH Zero wait state * @arg @ref FLASH_LATENCY_1 FLASH One wait state * */ #define __LL_FLASH_GET_LATENCY() READ_BIT(FLASH->ACR, FLASH_ACR_LATENCY) /** @defgroup FLASH_Interrupt FLASH Interrupts Macros * @brief macros to handle FLASH interrupts * @{ */ /** * @brief Enable the specified FLASH interrupt. * @param __INTERRUPT__ FLASH interrupt * This parameter can be any combination of the following values: * @arg @ref FLASH_IT_EOP End of FLASH Operation Interrupt * @arg @ref FLASH_IT_OPERR Error Interrupt * @note (*) availability depends on devices * @retval none */ #define __LL_FLASH_ENABLE_IT(__INTERRUPT__) SET_BIT(FLASH->CR, (__INTERRUPT__)) /** * @brief Disable the specified FLASH interrupt. * @param __INTERRUPT__ FLASH interrupt * This parameter can be any combination of the following values: * @arg @ref FLASH_IT_EOP End of FLASH Operation Interrupt * @arg @ref FLASH_IT_OPERR Error Interrupt * @note (*) availability depends on devices * @retval none */ #define __LL_FLASH_DISABLE_IT(__INTERRUPT__) CLEAR_BIT(FLASH->CR, (__INTERRUPT__)) /** * @brief Check whether the specified FLASH flag is set or not. * @param __FLAG__ specifies the FLASH flag to check. * This parameter can be one of the following values: * @arg @ref FLASH_FLAG_EOP FLASH End of Operation flag * @arg @ref FLASH_FLAG_WRPERR FLASH Write protection error flag * @arg @ref FLASH_FLAG_OPTVERR FLASH Option validity error flag * @arg @ref FLASH_FLAG_BSY FLASH write/erase operations in progress flag * @arg @ref FLASH_FLAG_ALL_ERRORS FLASH All errors flags * @note (*) availability depends on devices * @retval The new state of FLASH_FLAG (SET or RESET). */ #define __LL_FLASH_GET_FLAG(__FLAG__) (READ_BIT(FLASH->SR, (__FLAG__)) == (__FLAG__)) /** * @brief Clear the FLASHs pending flags. * @param __FLAG__ specifies the FLASH flags to clear. * This parameter can be any combination of the following values: * @arg @ref FLASH_FLAG_EOP FLASH End of Operation flag * @arg @ref FLASH_FLAG_WRPERR FLASH Write protection error flag * @arg @ref FLASH_FLAG_OPTVERR FLASH Option validity error flag * @arg @ref FLASH_FLAG_ALL_ERRORS FLASH All errors flags * @retval None */ #define __LL_FLASH_CLEAR_FLAG(__FLAG__) do { WRITE_REG(FLASH->SR, (__FLAG__)); \ } while(0U) /** * @} */ #define __LL_FLASH_TIME_REG_SET(__EPPARA0__,__EPPARA1__,__EPPARA2__,__EPPARA3__,__EPPARA4__) \ do { \ FLASH->TS0 = (__EPPARA0__)&0xFF; \ FLASH->TS1 = ((__EPPARA0__)>>16)&0x1FF; \ FLASH->TS3 = ((__EPPARA0__)>>8)&0xFF; \ FLASH->TS2P = (__EPPARA1__)&0xFF; \ FLASH->TPS3 = ((__EPPARA1__)>>16)&0x7FF; \ FLASH->PERTPE = (__EPPARA2__)&0x1FFFF; \ FLASH->SMERTPE = (__EPPARA3__)&0x1FFFF; \ FLASH->PRGTPE = (__EPPARA4__)&0xFFFF; \ FLASH->PRETPE = ((__EPPARA4__)>>16)&0x3FFF; \ } while(0U) #define __LL_FLASH_IS_INVALID_TIMMING_SEQUENCE(_INDEX_) (((FLASH->TS0) != ((*(uint32_t *)(_FlashTimmingParam[_INDEX_]))&0xFF)) || \ ((FLASH->TS1) != (((*(uint32_t *)(_FlashTimmingParam[_INDEX_]))>>16)&0x1FF)) || \ ((FLASH->TS3) != (((*(uint32_t *)(_FlashTimmingParam[_INDEX_]))>>8)&0xFF)) || \ ((FLASH->TS2P) != ((*(uint32_t *)(_FlashTimmingParam[_INDEX_]+4))&0xFF)) || \ ((FLASH->TPS3) != (((*(uint32_t *)(_FlashTimmingParam[_INDEX_]+4))>>16)&0x7FF)) || \ ((FLASH->PERTPE) != ((*(uint32_t *)(_FlashTimmingParam[_INDEX_]+8))&0x1FFFF)) || \ ((FLASH->SMERTPE) != ((*(uint32_t *)(_FlashTimmingParam[_INDEX_]+12))&0x1FFFF)) || \ ((FLASH->PRGTPE) != ((*(uint32_t *)(_FlashTimmingParam[_INDEX_]+16))&0xFFFF)) || \ ((FLASH->PRETPE) != (((*(uint32_t *)(_FlashTimmingParam[_INDEX_]+16))>>16)&0x3FFF))) #define __LL_FLASH_TIMMING_SEQUENCE_CONFIG() do{ \ uint32_t tmpreg = (RCC->ICSCR & RCC_ICSCR_HSI_FS) >> RCC_ICSCR_HSI_FS_Pos; \ if (__LL_FLASH_IS_INVALID_TIMMING_SEQUENCE(tmpreg)) \ { \ __LL_FLASH_TIME_REG_SET((*(uint32_t *)(_FlashTimmingParam[tmpreg])), \ (*(uint32_t *)(_FlashTimmingParam[tmpreg]+4)), \ (*(uint32_t *)(_FlashTimmingParam[tmpreg]+8)), \ (*(uint32_t *)(_FlashTimmingParam[tmpreg]+12)), \ (*(uint32_t *)(_FlashTimmingParam[tmpreg]+16))); \ } \ }while(0U) /* Include FLASH HAL Extended module */ /* Exported variables --------------------------------------------------------*/ /** @defgroup FLASH_Exported_Variables FLASH Exported Variables * @{ */ extern FLASH_ProcessTypeDef pFlash; /** * @} */ /* Exported functions --------------------------------------------------------*/ /** @addtogroup FLASH_Exported_Functions * @{ */ /* Program operation functions ***********************************************/ /** @addtogroup FLASH_Exported_Functions_Group1 * @{ */ ErrorStatus LL_FLASH_Program(uint32_t TypeProgram, uint32_t Address, uint32_t *DataAddr ); ErrorStatus LL_FLASH_Program_IT(uint32_t TypeProgram, uint32_t Address, uint32_t *DataAddr); ErrorStatus LL_FLASH_PageProgram(uint32_t Address, uint32_t *DataAddr ); ErrorStatus LL_FLASH_PageProgram_IT(uint32_t Address, uint32_t *DataAddr); /* FLASH IRQ handler method */ void LL_FLASH_IRQHandler(void); /* Callbacks in non blocking modes */ void LL_FLASH_EndOfOperationCallback(uint32_t ReturnValue); void LL_FLASH_OperationErrorCallback(uint32_t ReturnValue); ErrorStatus LL_FLASH_Erase(FLASH_EraseInitTypeDef *pEraseInit, uint32_t *PageError); ErrorStatus LL_FLASH_Erase_IT(FLASH_EraseInitTypeDef *pEraseInit); #define LL_FLASHEx_Erase LL_FLASH_Erase #define LL_FLASHEx_Erase_IT LL_FLASH_Erase_IT /** * @} */ /* Peripheral Control functions **********************************************/ /** @addtogroup FLASH_Exported_Functions_Group2 * @{ */ ErrorStatus LL_FLASH_Unlock(void); ErrorStatus LL_FLASH_Lock(void); /* Option bytes control */ ErrorStatus LL_FLASH_OB_Unlock(void); ErrorStatus LL_FLASH_OB_Lock(void); ErrorStatus LL_FLASH_OB_Launch(void); ErrorStatus LL_FLASH_OBProgram(FLASH_OBProgramInitTypeDef *pOBInit); void LL_FLASH_OBGetConfig(FLASH_OBProgramInitTypeDef *pOBInit); ErrorStatus LL_FLASH_OB_RDP_LevelConfig(uint8_t ReadProtectLevel); /** * @} */ /* Peripheral State functions ************************************************/ /** @addtogroup FLASH_Exported_Functions_Group3 * @{ */ uint32_t LL_FLASH_GetError(void); /** * @} */ /** * @} */ /* Private types --------------------------------------------------------*/ /** @defgroup FLASH_Private_types FLASH Private Types * @{ */ ErrorStatus FLASH_WaitForLastOperation(uint32_t Timeout); /** * @} */ /* Private constants --------------------------------------------------------*/ /** @defgroup FLASH_Private_Constants FLASH Private Constants * @{ */ #define FLASH_TIMEOUT_VALUE 1000U /*!< FLASH Execution Timeout, 1 s */ #define FLASH_TYPENONE 0x00000000U /*!< No Programmation Procedure On Going */ #define FLASH_FLAG_SR_ERROR (FLASH_FLAG_OPTVERR | FLASH_FLAG_WRPERR) /*!< All SR error flags */ #define FLASH_FLAG_SR_CLEAR (FLASH_FLAG_SR_ERROR | FLASH_SR_EOP) /** * @} */ /* Private macros ------------------------------------------------------------*/ /** @defgroup FLASH_Private_Macros FLASH Private Macros * @{ */ #define IS_FLASH_MAIN_MEM_ADDRESS(__ADDRESS__) (((__ADDRESS__) >= (FLASH_BASE)) && ((__ADDRESS__) <= (FLASH_BASE + FLASH_SIZE - 1UL))) #define IS_FLASH_PROGRAM_MAIN_MEM_ADDRESS(__ADDRESS__) (((__ADDRESS__) >= (FLASH_BASE)) && ((__ADDRESS__) <= (FLASH_BASE + FLASH_SIZE - 8UL))) #define IS_FLASH_PROGRAM_ADDRESS(__ADDRESS__) (IS_FLASH_PROGRAM_MAIN_MEM_ADDRESS(__ADDRESS__)) #define IS_FLASH_NB_PAGES(__ADDRESS__, __VALUE__) (((__ADDRESS__) >= (FLASH_BASE)) && ((__ADDRESS__ + (__VALUE__*FLASH_PAGE_SIZE)) <= (FLASH_BASE + FLASH_SIZE - 1UL))) #define IS_FLASH_NB_SECTORS(__ADDRESS__, __VALUE__) (((__ADDRESS__) >= (FLASH_BASE)) && ((__ADDRESS__ + (__VALUE__*FLASH_SECTOR_SIZE)) <= (FLASH_BASE + FLASH_SIZE - 1UL))) #define IS_FLASH_FAST_PROGRAM_ADDRESS(__ADDRESS__) (((__ADDRESS__) >= (FLASH_BASE)) && ((__ADDRESS__) <= (FLASH_BASE + FLASH_SIZE - 256UL))) #define IS_FLASH_PAGE(__PAGE__) ((__PAGE__) < FLASH_PAGE_NB) #define IS_FLASH_BANK(__BANK__) ((__BANK__) == 0x00UL) #define IS_FLASH_TYPEERASE(__VALUE__) (((__VALUE__) == FLASH_TYPEERASE_PAGEERASE) || \ ((__VALUE__) == FLASH_TYPEERASE_SECTORERASE) || \ ((__VALUE__) == FLASH_TYPEERASE_MASSERASE)) #define IS_FLASH_TYPEPROGRAM(__VALUE__) ((__VALUE__) == FLASH_TYPEPROGRAM_PAGE) #define IS_FLASH_TIMECONFIG_CLOCK(__VALUE__) (((__VALUE__) == FLASH_PROGRAM_ERASE_CLOCK_4MHZ) || \ ((__VALUE__) == FLASH_PROGRAM_ERASE_CLOCK_8MHZ) || \ ((__VALUE__) == FLASH_PROGRAM_ERASE_CLOCK_16MHZ) || \ ((__VALUE__) == FLASH_PROGRAM_ERASE_CLOCK_22p12MHZ) || \ ((__VALUE__) == FLASH_PROGRAM_ERASE_CLOCK_24MHZ)) #define IS_OPTIONBYTE(__VALUE__) ((((__VALUE__) & OPTIONBYTE_ALL) != 0x00U) && \ (((__VALUE__) & ~OPTIONBYTE_ALL) == 0x00U)) #define IS_OB_RDP_LEVEL(__LEVEL__) (((__LEVEL__) == OB_RDP_LEVEL_0) ||\ ((__LEVEL__) == OB_RDP_LEVEL_1)) #define IS_OB_USER_TYPE(__TYPE__) ((((__TYPE__) & OB_USER_ALL) != 0x00U) && \ (((__TYPE__) & ~OB_USER_ALL) == 0x00U)) #define IS_OB_USER_CONFIG(__TYPE__,__CONFIG__) ((~(__TYPE__) & (__CONFIG__)) == 0x00U) #if defined(FLASH_PCROP_SUPPORT) #define IS_OB_PCROP_CONFIG(__CONFIG__) (((__CONFIG__) & ~(OB_PCROP_ZONE_A | OB_PCROP_ZONE_B | OB_PCROP_RDP_ERASE)) == 0x00U) #endif #if defined(FLASH_SECURABLE_MEMORY_SUPPORT) #define IS_OB_SEC_BOOT_LOCK(__VALUE__) (((__VALUE__) == OB_BOOT_ENTRY_FORCED_NONE) || ((__VALUE__) == OB_BOOT_ENTRY_FORCED_FLASH)) #define IS_OB_SEC_SIZE(__VALUE__) ((__VALUE__) < (FLASH_PAGE_NB + 1U)) #endif #define IS_FLASH_LATENCY(__LATENCY__) (((__LATENCY__) == FLASH_LATENCY_0) || \ ((__LATENCY__) == FLASH_LATENCY_1)) #define IS_WRPSTATE(__VALUE__) (((__VALUE__) == OB_WRPSTATE_DISABLE) || \ ((__VALUE__) == OB_WRPSTATE_ENABLE)) /** * @} */ /** * @} */ /** * @} */ #ifdef __cplusplus } #endif #endif /* __PY32F0xx_LL_FLASH_H */ /************************ (C) COPYRIGHT Puya *****END OF FILE****/