123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326 |
- /**
- ******************************************************************************
- * @file stm32f1xx_hal_nor.h
- * @author MCD Application Team
- * @brief Header file of NOR HAL module.
- ******************************************************************************
- * @attention
- *
- * Copyright (c) 2016 STMicroelectronics.
- * All rights reserved.
- *
- * This software is licensed under terms that can be found in the LICENSE file
- * in the root directory of this software component.
- * If no LICENSE file comes with this software, it is provided AS-IS.
- *
- ******************************************************************************
- */
- /* Define to prevent recursive inclusion -------------------------------------*/
- #ifndef STM32F1xx_HAL_NOR_H
- #define STM32F1xx_HAL_NOR_H
- #ifdef __cplusplus
- extern "C" {
- #endif
- #if defined(FSMC_BANK1)
- /* Includes ------------------------------------------------------------------*/
- #include "stm32f1xx_ll_fsmc.h"
- /** @addtogroup STM32F1xx_HAL_Driver
- * @{
- */
- /** @addtogroup NOR
- * @{
- */
- /* Exported typedef ----------------------------------------------------------*/
- /** @defgroup NOR_Exported_Types NOR Exported Types
- * @{
- */
- /**
- * @brief HAL SRAM State structures definition
- */
- typedef enum
- {
- HAL_NOR_STATE_RESET = 0x00U, /*!< NOR not yet initialized or disabled */
- HAL_NOR_STATE_READY = 0x01U, /*!< NOR initialized and ready for use */
- HAL_NOR_STATE_BUSY = 0x02U, /*!< NOR internal processing is ongoing */
- HAL_NOR_STATE_ERROR = 0x03U, /*!< NOR error state */
- HAL_NOR_STATE_PROTECTED = 0x04U /*!< NOR NORSRAM device write protected */
- } HAL_NOR_StateTypeDef;
- /**
- * @brief FSMC NOR Status typedef
- */
- typedef enum
- {
- HAL_NOR_STATUS_SUCCESS = 0U,
- HAL_NOR_STATUS_ONGOING,
- HAL_NOR_STATUS_ERROR,
- HAL_NOR_STATUS_TIMEOUT
- } HAL_NOR_StatusTypeDef;
- /**
- * @brief FSMC NOR ID typedef
- */
- typedef struct
- {
- uint16_t Manufacturer_Code; /*!< Defines the device's manufacturer code used to identify the memory */
- uint16_t Device_Code1;
- uint16_t Device_Code2;
- uint16_t Device_Code3; /*!< Defines the device's codes used to identify the memory.
- These codes can be accessed by performing read operations with specific
- control signals and addresses set.They can also be accessed by issuing
- an Auto Select command */
- } NOR_IDTypeDef;
- /**
- * @brief FSMC NOR CFI typedef
- */
- typedef struct
- {
- /*!< Defines the information stored in the memory's Common flash interface
- which contains a description of various electrical and timing parameters,
- density information and functions supported by the memory */
- uint16_t CFI_1;
- uint16_t CFI_2;
- uint16_t CFI_3;
- uint16_t CFI_4;
- } NOR_CFITypeDef;
- /**
- * @brief NOR handle Structure definition
- */
- #if (USE_HAL_NOR_REGISTER_CALLBACKS == 1)
- typedef struct __NOR_HandleTypeDef
- #else
- typedef struct
- #endif /* USE_HAL_NOR_REGISTER_CALLBACKS */
- {
- FSMC_NORSRAM_TypeDef *Instance; /*!< Register base address */
- FSMC_NORSRAM_EXTENDED_TypeDef *Extended; /*!< Extended mode register base address */
- FSMC_NORSRAM_InitTypeDef Init; /*!< NOR device control configuration parameters */
- HAL_LockTypeDef Lock; /*!< NOR locking object */
- __IO HAL_NOR_StateTypeDef State; /*!< NOR device access state */
- uint32_t CommandSet; /*!< NOR algorithm command set and control */
- #if (USE_HAL_NOR_REGISTER_CALLBACKS == 1)
- void (* MspInitCallback)(struct __NOR_HandleTypeDef *hnor); /*!< NOR Msp Init callback */
- void (* MspDeInitCallback)(struct __NOR_HandleTypeDef *hnor); /*!< NOR Msp DeInit callback */
- #endif /* USE_HAL_NOR_REGISTER_CALLBACKS */
- } NOR_HandleTypeDef;
- #if (USE_HAL_NOR_REGISTER_CALLBACKS == 1)
- /**
- * @brief HAL NOR Callback ID enumeration definition
- */
- typedef enum
- {
- HAL_NOR_MSP_INIT_CB_ID = 0x00U, /*!< NOR MspInit Callback ID */
- HAL_NOR_MSP_DEINIT_CB_ID = 0x01U /*!< NOR MspDeInit Callback ID */
- } HAL_NOR_CallbackIDTypeDef;
- /**
- * @brief HAL NOR Callback pointer definition
- */
- typedef void (*pNOR_CallbackTypeDef)(NOR_HandleTypeDef *hnor);
- #endif /* USE_HAL_NOR_REGISTER_CALLBACKS */
- /**
- * @}
- */
- /* Exported constants --------------------------------------------------------*/
- /* Exported macro ------------------------------------------------------------*/
- /** @defgroup NOR_Exported_Macros NOR Exported Macros
- * @{
- */
- /** @brief Reset NOR handle state
- * @param __HANDLE__ specifies the NOR handle.
- * @retval None
- */
- #if (USE_HAL_NOR_REGISTER_CALLBACKS == 1)
- #define __HAL_NOR_RESET_HANDLE_STATE(__HANDLE__) do { \
- (__HANDLE__)->State = HAL_NOR_STATE_RESET; \
- (__HANDLE__)->MspInitCallback = NULL; \
- (__HANDLE__)->MspDeInitCallback = NULL; \
- } while(0)
- #else
- #define __HAL_NOR_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_NOR_STATE_RESET)
- #endif /* USE_HAL_NOR_REGISTER_CALLBACKS */
- /**
- * @}
- */
- /* Exported functions --------------------------------------------------------*/
- /** @addtogroup NOR_Exported_Functions NOR Exported Functions
- * @{
- */
- /** @addtogroup NOR_Exported_Functions_Group1 Initialization and de-initialization functions
- * @{
- */
- /* Initialization/de-initialization functions ********************************/
- HAL_StatusTypeDef HAL_NOR_Init(NOR_HandleTypeDef *hnor, FSMC_NORSRAM_TimingTypeDef *Timing,
- FSMC_NORSRAM_TimingTypeDef *ExtTiming);
- HAL_StatusTypeDef HAL_NOR_DeInit(NOR_HandleTypeDef *hnor);
- void HAL_NOR_MspInit(NOR_HandleTypeDef *hnor);
- void HAL_NOR_MspDeInit(NOR_HandleTypeDef *hnor);
- void HAL_NOR_MspWait(NOR_HandleTypeDef *hnor, uint32_t Timeout);
- /**
- * @}
- */
- /** @addtogroup NOR_Exported_Functions_Group2 Input and Output functions
- * @{
- */
- /* I/O operation functions ***************************************************/
- HAL_StatusTypeDef HAL_NOR_Read_ID(NOR_HandleTypeDef *hnor, NOR_IDTypeDef *pNOR_ID);
- HAL_StatusTypeDef HAL_NOR_ReturnToReadMode(NOR_HandleTypeDef *hnor);
- HAL_StatusTypeDef HAL_NOR_Read(NOR_HandleTypeDef *hnor, uint32_t *pAddress, uint16_t *pData);
- HAL_StatusTypeDef HAL_NOR_Program(NOR_HandleTypeDef *hnor, uint32_t *pAddress, uint16_t *pData);
- HAL_StatusTypeDef HAL_NOR_ReadBuffer(NOR_HandleTypeDef *hnor, uint32_t uwAddress, uint16_t *pData,
- uint32_t uwBufferSize);
- HAL_StatusTypeDef HAL_NOR_ProgramBuffer(NOR_HandleTypeDef *hnor, uint32_t uwAddress, uint16_t *pData,
- uint32_t uwBufferSize);
- HAL_StatusTypeDef HAL_NOR_Erase_Block(NOR_HandleTypeDef *hnor, uint32_t BlockAddress, uint32_t Address);
- HAL_StatusTypeDef HAL_NOR_Erase_Chip(NOR_HandleTypeDef *hnor, uint32_t Address);
- HAL_StatusTypeDef HAL_NOR_Read_CFI(NOR_HandleTypeDef *hnor, NOR_CFITypeDef *pNOR_CFI);
- #if (USE_HAL_NOR_REGISTER_CALLBACKS == 1)
- /* NOR callback registering/unregistering */
- HAL_StatusTypeDef HAL_NOR_RegisterCallback(NOR_HandleTypeDef *hnor, HAL_NOR_CallbackIDTypeDef CallbackId,
- pNOR_CallbackTypeDef pCallback);
- HAL_StatusTypeDef HAL_NOR_UnRegisterCallback(NOR_HandleTypeDef *hnor, HAL_NOR_CallbackIDTypeDef CallbackId);
- #endif /* USE_HAL_NOR_REGISTER_CALLBACKS */
- /**
- * @}
- */
- /** @addtogroup NOR_Exported_Functions_Group3 NOR Control functions
- * @{
- */
- /* NOR Control functions *****************************************************/
- HAL_StatusTypeDef HAL_NOR_WriteOperation_Enable(NOR_HandleTypeDef *hnor);
- HAL_StatusTypeDef HAL_NOR_WriteOperation_Disable(NOR_HandleTypeDef *hnor);
- /**
- * @}
- */
- /** @addtogroup NOR_Exported_Functions_Group4 NOR State functions
- * @{
- */
- /* NOR State functions ********************************************************/
- HAL_NOR_StateTypeDef HAL_NOR_GetState(const NOR_HandleTypeDef *hnor);
- HAL_NOR_StatusTypeDef HAL_NOR_GetStatus(NOR_HandleTypeDef *hnor, uint32_t Address, uint32_t Timeout);
- /**
- * @}
- */
- /**
- * @}
- */
- /* Private types -------------------------------------------------------------*/
- /* Private variables ---------------------------------------------------------*/
- /* Private constants ---------------------------------------------------------*/
- /** @defgroup NOR_Private_Constants NOR Private Constants
- * @{
- */
- /* NOR device IDs addresses */
- #define MC_ADDRESS ((uint16_t)0x0000)
- #define DEVICE_CODE1_ADDR ((uint16_t)0x0001)
- #define DEVICE_CODE2_ADDR ((uint16_t)0x000E)
- #define DEVICE_CODE3_ADDR ((uint16_t)0x000F)
- /* NOR CFI IDs addresses */
- #define CFI1_ADDRESS ((uint16_t)0x0061)
- #define CFI2_ADDRESS ((uint16_t)0x0062)
- #define CFI3_ADDRESS ((uint16_t)0x0063)
- #define CFI4_ADDRESS ((uint16_t)0x0064)
- /* NOR operation wait timeout */
- #define NOR_TMEOUT ((uint16_t)0xFFFF)
- /* NOR memory data width */
- #define NOR_MEMORY_8B ((uint8_t)0x00)
- #define NOR_MEMORY_16B ((uint8_t)0x01)
- /* NOR memory device read/write start address */
- #define NOR_MEMORY_ADRESS1 (0x60000000U)
- #define NOR_MEMORY_ADRESS2 (0x64000000U)
- #define NOR_MEMORY_ADRESS3 (0x68000000U)
- #define NOR_MEMORY_ADRESS4 (0x6C000000U)
- /**
- * @}
- */
- /* Private macros ------------------------------------------------------------*/
- /** @defgroup NOR_Private_Macros NOR Private Macros
- * @{
- */
- /**
- * @brief NOR memory address shifting.
- * @param __NOR_ADDRESS NOR base address
- * @param __NOR_MEMORY_WIDTH_ NOR memory width
- * @param __ADDRESS__ NOR memory address
- * @retval NOR shifted address value
- */
- #define NOR_ADDR_SHIFT(__NOR_ADDRESS, __NOR_MEMORY_WIDTH_, __ADDRESS__) \
- ((uint32_t)(((__NOR_MEMORY_WIDTH_) == NOR_MEMORY_16B)? \
- ((uint32_t)((__NOR_ADDRESS) + (2U * (__ADDRESS__)))): \
- ((uint32_t)((__NOR_ADDRESS) + (__ADDRESS__)))))
- /**
- * @brief NOR memory write data to specified address.
- * @param __ADDRESS__ NOR memory address
- * @param __DATA__ Data to write
- * @retval None
- */
- #define NOR_WRITE(__ADDRESS__, __DATA__) do{ \
- (*(__IO uint16_t *)((uint32_t)(__ADDRESS__)) = (__DATA__)); \
- __DSB(); \
- } while(0)
- /**
- * @}
- */
- /**
- * @}
- */
- /**
- * @}
- */
- #endif /* FSMC_BANK1 */
- #ifdef __cplusplus
- }
- #endif
- #endif /* STM32F1xx_HAL_NOR_H */
|