雄介 太田 / mbed

mbed(SerialHalfDuplex入り)

Fork of mbed by mbed official

TARGET_MTS_MDOT_F411RE/stm32f4xx_hal_nor.h@98:01a414ca7d6d, 2015-04-08 (annotated)

Committer:
yusuke_kyo
Date:
Wed Apr 08 08:04:18 2015 +0000
Revision:
98:01a414ca7d6d
Parent:
93:e188a91d3eaa 
remove SerialHalfDuplex.h

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Kojto 93:e188a91d3eaa 1 /**
Kojto 93:e188a91d3eaa 2 ******************************************************************************
Kojto 93:e188a91d3eaa 3 * @file stm32f4xx_hal_nor.h
Kojto 93:e188a91d3eaa 4 * @author MCD Application Team
Kojto 93:e188a91d3eaa 5 * @version V1.1.0
Kojto 93:e188a91d3eaa 6 * @date 19-June-2014
Kojto 93:e188a91d3eaa 7 * @brief Header file of NOR HAL module.
Kojto 93:e188a91d3eaa 8 ******************************************************************************
Kojto 93:e188a91d3eaa 9 * @attention
Kojto 93:e188a91d3eaa 10 *
Kojto 93:e188a91d3eaa 11 * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
Kojto 93:e188a91d3eaa 12 *
Kojto 93:e188a91d3eaa 13 * Redistribution and use in source and binary forms, with or without modification,
Kojto 93:e188a91d3eaa 14 * are permitted provided that the following conditions are met:
Kojto 93:e188a91d3eaa 15 * 1. Redistributions of source code must retain the above copyright notice,
Kojto 93:e188a91d3eaa 16 * this list of conditions and the following disclaimer.
Kojto 93:e188a91d3eaa 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
Kojto 93:e188a91d3eaa 18 * this list of conditions and the following disclaimer in the documentation
Kojto 93:e188a91d3eaa 19 * and/or other materials provided with the distribution.
Kojto 93:e188a91d3eaa 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Kojto 93:e188a91d3eaa 21 * may be used to endorse or promote products derived from this software
Kojto 93:e188a91d3eaa 22 * without specific prior written permission.
Kojto 93:e188a91d3eaa 23 *
Kojto 93:e188a91d3eaa 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Kojto 93:e188a91d3eaa 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Kojto 93:e188a91d3eaa 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Kojto 93:e188a91d3eaa 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Kojto 93:e188a91d3eaa 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Kojto 93:e188a91d3eaa 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Kojto 93:e188a91d3eaa 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Kojto 93:e188a91d3eaa 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Kojto 93:e188a91d3eaa 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Kojto 93:e188a91d3eaa 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Kojto 93:e188a91d3eaa 34 *
Kojto 93:e188a91d3eaa 35 ******************************************************************************
Kojto 93:e188a91d3eaa 36 */
Kojto 93:e188a91d3eaa 37
Kojto 93:e188a91d3eaa 38 /* Define to prevent recursive inclusion -------------------------------------*/
Kojto 93:e188a91d3eaa 39 #ifndef __STM32F4xx_HAL_NOR_H
Kojto 93:e188a91d3eaa 40 #define __STM32F4xx_HAL_NOR_H
Kojto 93:e188a91d3eaa 41
Kojto 93:e188a91d3eaa 42 #ifdef __cplusplus
Kojto 93:e188a91d3eaa 43 extern "C" {
Kojto 93:e188a91d3eaa 44 #endif
Kojto 93:e188a91d3eaa 45
Kojto 93:e188a91d3eaa 46 /* Includes ------------------------------------------------------------------*/
Kojto 93:e188a91d3eaa 47 #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx)|| defined(STM32F417xx)
Kojto 93:e188a91d3eaa 48 #include "stm32f4xx_ll_fsmc.h"
Kojto 93:e188a91d3eaa 49 #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx */
Kojto 93:e188a91d3eaa 50
Kojto 93:e188a91d3eaa 51 #if defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx)|| defined(STM32F439xx)
Kojto 93:e188a91d3eaa 52 #include "stm32f4xx_ll_fmc.h"
Kojto 93:e188a91d3eaa 53 #endif /* STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx */
Kojto 93:e188a91d3eaa 54
Kojto 93:e188a91d3eaa 55 /** @addtogroup STM32F4xx_HAL_Driver
Kojto 93:e188a91d3eaa 56 * @{
Kojto 93:e188a91d3eaa 57 */
Kojto 93:e188a91d3eaa 58
Kojto 93:e188a91d3eaa 59 /** @addtogroup NOR
Kojto 93:e188a91d3eaa 60 * @{
Kojto 93:e188a91d3eaa 61 */
Kojto 93:e188a91d3eaa 62
Kojto 93:e188a91d3eaa 63 #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx) || defined(STM32F417xx) || defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx)
Kojto 93:e188a91d3eaa 64
Kojto 93:e188a91d3eaa 65 /* Exported typedef ----------------------------------------------------------*/
Kojto 93:e188a91d3eaa 66 /**
Kojto 93:e188a91d3eaa 67 * @brief HAL SRAM State structures definition
Kojto 93:e188a91d3eaa 68 */
Kojto 93:e188a91d3eaa 69 typedef enum
Kojto 93:e188a91d3eaa 70 {
Kojto 93:e188a91d3eaa 71 HAL_NOR_STATE_RESET = 0x00, /*!< NOR not yet initialized or disabled */
Kojto 93:e188a91d3eaa 72 HAL_NOR_STATE_READY = 0x01, /*!< NOR initialized and ready for use */
Kojto 93:e188a91d3eaa 73 HAL_NOR_STATE_BUSY = 0x02, /*!< NOR internal processing is ongoing */
Kojto 93:e188a91d3eaa 74 HAL_NOR_STATE_ERROR = 0x03, /*!< NOR error state */
Kojto 93:e188a91d3eaa 75 HAL_NOR_STATE_PROTECTED = 0x04 /*!< NOR NORSRAM device write protected */
Kojto 93:e188a91d3eaa 76 }HAL_NOR_StateTypeDef;
Kojto 93:e188a91d3eaa 77
Kojto 93:e188a91d3eaa 78 /**
Kojto 93:e188a91d3eaa 79 * @brief FMC NOR Status typedef
Kojto 93:e188a91d3eaa 80 */
Kojto 93:e188a91d3eaa 81 typedef enum
Kojto 93:e188a91d3eaa 82 {
Kojto 93:e188a91d3eaa 83 NOR_SUCCESS = 0,
Kojto 93:e188a91d3eaa 84 NOR_ONGOING,
Kojto 93:e188a91d3eaa 85 NOR_ERROR,
Kojto 93:e188a91d3eaa 86 NOR_TIMEOUT
Kojto 93:e188a91d3eaa 87 }NOR_StatusTypedef;
Kojto 93:e188a91d3eaa 88
Kojto 93:e188a91d3eaa 89 /**
Kojto 93:e188a91d3eaa 90 * @brief FMC NOR ID typedef
Kojto 93:e188a91d3eaa 91 */
Kojto 93:e188a91d3eaa 92 typedef struct
Kojto 93:e188a91d3eaa 93 {
Kojto 93:e188a91d3eaa 94 uint16_t Manufacturer_Code; /*!< Defines the device's manufacturer code used to identify the memory */
Kojto 93:e188a91d3eaa 95
Kojto 93:e188a91d3eaa 96 uint16_t Device_Code1;
Kojto 93:e188a91d3eaa 97
Kojto 93:e188a91d3eaa 98 uint16_t Device_Code2;
Kojto 93:e188a91d3eaa 99
Kojto 93:e188a91d3eaa 100 uint16_t Device_Code3; /*!< Defines the devices' codes used to identify the memory.
Kojto 93:e188a91d3eaa 101 These codes can be accessed by performing read operations with specific
Kojto 93:e188a91d3eaa 102 control signals and addresses set.They can also be accessed by issuing
Kojto 93:e188a91d3eaa 103 an Auto Select command */
Kojto 93:e188a91d3eaa 104 }NOR_IDTypeDef;
Kojto 93:e188a91d3eaa 105
Kojto 93:e188a91d3eaa 106 /**
Kojto 93:e188a91d3eaa 107 * @brief FMC NOR CFI typedef
Kojto 93:e188a91d3eaa 108 */
Kojto 93:e188a91d3eaa 109 typedef struct
Kojto 93:e188a91d3eaa 110 {
Kojto 93:e188a91d3eaa 111 /*!< Defines the information stored in the memory's Common flash interface
Kojto 93:e188a91d3eaa 112 which contains a description of various electrical and timing parameters,
Kojto 93:e188a91d3eaa 113 density information and functions supported by the memory */
Kojto 93:e188a91d3eaa 114
Kojto 93:e188a91d3eaa 115 uint16_t CFI_1;
Kojto 93:e188a91d3eaa 116
Kojto 93:e188a91d3eaa 117 uint16_t CFI_2;
Kojto 93:e188a91d3eaa 118
Kojto 93:e188a91d3eaa 119 uint16_t CFI_3;
Kojto 93:e188a91d3eaa 120
Kojto 93:e188a91d3eaa 121 uint16_t CFI_4;
Kojto 93:e188a91d3eaa 122 }NOR_CFITypeDef;
Kojto 93:e188a91d3eaa 123
Kojto 93:e188a91d3eaa 124 /**
Kojto 93:e188a91d3eaa 125 * @brief NOR handle Structure definition
Kojto 93:e188a91d3eaa 126 */
Kojto 93:e188a91d3eaa 127 typedef struct
Kojto 93:e188a91d3eaa 128 {
Kojto 93:e188a91d3eaa 129 FMC_NORSRAM_TypeDef *Instance; /*!< Register base address */
Kojto 93:e188a91d3eaa 130
Kojto 93:e188a91d3eaa 131 FMC_NORSRAM_EXTENDED_TypeDef *Extended; /*!< Extended mode register base address */
Kojto 93:e188a91d3eaa 132
Kojto 93:e188a91d3eaa 133 FMC_NORSRAM_InitTypeDef Init; /*!< NOR device control configuration parameters */
Kojto 93:e188a91d3eaa 134
Kojto 93:e188a91d3eaa 135 HAL_LockTypeDef Lock; /*!< NOR locking object */
Kojto 93:e188a91d3eaa 136
Kojto 93:e188a91d3eaa 137 __IO HAL_NOR_StateTypeDef State; /*!< NOR device access state */
Kojto 93:e188a91d3eaa 138
Kojto 93:e188a91d3eaa 139 }NOR_HandleTypeDef;
Kojto 93:e188a91d3eaa 140
Kojto 93:e188a91d3eaa 141 /* Exported constants --------------------------------------------------------*/
Kojto 93:e188a91d3eaa 142 /** @defgroup NOR_Exported_Constants
Kojto 93:e188a91d3eaa 143 * @{
Kojto 93:e188a91d3eaa 144 */
Kojto 93:e188a91d3eaa 145 /* NOR device IDs addresses */
Kojto 93:e188a91d3eaa 146 #define MC_ADDRESS ((uint16_t)0x0000)
Kojto 93:e188a91d3eaa 147 #define DEVICE_CODE1_ADDR ((uint16_t)0x0001)
Kojto 93:e188a91d3eaa 148 #define DEVICE_CODE2_ADDR ((uint16_t)0x000E)
Kojto 93:e188a91d3eaa 149 #define DEVICE_CODE3_ADDR ((uint16_t)0x000F)
Kojto 93:e188a91d3eaa 150
Kojto 93:e188a91d3eaa 151 /* NOR CFI IDs addresses */
Kojto 93:e188a91d3eaa 152 #define CFI1_ADDRESS ((uint16_t)0x61)
Kojto 93:e188a91d3eaa 153 #define CFI2_ADDRESS ((uint16_t)0x62)
Kojto 93:e188a91d3eaa 154 #define CFI3_ADDRESS ((uint16_t)0x63)
Kojto 93:e188a91d3eaa 155 #define CFI4_ADDRESS ((uint16_t)0x64)
Kojto 93:e188a91d3eaa 156
Kojto 93:e188a91d3eaa 157 /* NOR operation wait timeout */
Kojto 93:e188a91d3eaa 158 #define NOR_TMEOUT ((uint16_t)0xFFFF)
Kojto 93:e188a91d3eaa 159
Kojto 93:e188a91d3eaa 160 /* NOR memory data width */
Kojto 93:e188a91d3eaa 161 #define NOR_MEMORY_8B ((uint8_t)0x0)
Kojto 93:e188a91d3eaa 162 #define NOR_MEMORY_16B ((uint8_t)0x1)
Kojto 93:e188a91d3eaa 163
Kojto 93:e188a91d3eaa 164 /* NOR memory device read/write start address */
Kojto 93:e188a91d3eaa 165 #define NOR_MEMORY_ADRESS1 ((uint32_t)0x60000000)
Kojto 93:e188a91d3eaa 166 #define NOR_MEMORY_ADRESS2 ((uint32_t)0x64000000)
Kojto 93:e188a91d3eaa 167 #define NOR_MEMORY_ADRESS3 ((uint32_t)0x68000000)
Kojto 93:e188a91d3eaa 168 #define NOR_MEMORY_ADRESS4 ((uint32_t)0x6C000000)
Kojto 93:e188a91d3eaa 169
Kojto 93:e188a91d3eaa 170 /**
Kojto 93:e188a91d3eaa 171 * @}
Kojto 93:e188a91d3eaa 172 */
Kojto 93:e188a91d3eaa 173
Kojto 93:e188a91d3eaa 174 /* Exported macro ------------------------------------------------------------*/
Kojto 93:e188a91d3eaa 175
Kojto 93:e188a91d3eaa 176 /** @brief Reset NOR handle state
Kojto 93:e188a91d3eaa 177 * @param __HANDLE__: specifies the NOR handle.
Kojto 93:e188a91d3eaa 178 * @retval None
Kojto 93:e188a91d3eaa 179 */
Kojto 93:e188a91d3eaa 180 #define __HAL_NOR_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_NOR_STATE_RESET)
Kojto 93:e188a91d3eaa 181
Kojto 93:e188a91d3eaa 182 /**
Kojto 93:e188a91d3eaa 183 * @brief NOR memory address shifting.
Kojto 93:e188a91d3eaa 184 * @param __ADDRESS__: NOR memory address
Kojto 93:e188a91d3eaa 185 * @retval NOR shifted address value
Kojto 93:e188a91d3eaa 186 */
Kojto 93:e188a91d3eaa 187 #define __NOR_ADDR_SHIFT(__NOR_ADDRESS, __NOR_MEMORY_WIDTH_, __ADDRESS__) (((__NOR_MEMORY_WIDTH_) == NOR_MEMORY_8B)? ((uint32_t)((__NOR_ADDRESS) + (2 * (__ADDRESS__)))):\
Kojto 93:e188a91d3eaa 188 ((uint32_t)((__NOR_ADDRESS) + (__ADDRESS__))))
Kojto 93:e188a91d3eaa 189
Kojto 93:e188a91d3eaa 190 /**
Kojto 93:e188a91d3eaa 191 * @brief NOR memory write data to specified address.
Kojto 93:e188a91d3eaa 192 * @param __ADDRESS__: NOR memory address
Kojto 93:e188a91d3eaa 193 * @param __DATA__: Data to write
Kojto 93:e188a91d3eaa 194 * @retval None
Kojto 93:e188a91d3eaa 195 */
Kojto 93:e188a91d3eaa 196 #define __NOR_WRITE(__ADDRESS__, __DATA__) (*(__IO uint16_t *)((uint32_t)(__ADDRESS__)) = (__DATA__))
Kojto 93:e188a91d3eaa 197
Kojto 93:e188a91d3eaa 198 /* Exported functions --------------------------------------------------------*/
Kojto 93:e188a91d3eaa 199
Kojto 93:e188a91d3eaa 200 /* Initialization/de-initialization functions ********************************/
Kojto 93:e188a91d3eaa 201 HAL_StatusTypeDef HAL_NOR_Init(NOR_HandleTypeDef *hnor, FMC_NORSRAM_TimingTypeDef *Timing, FMC_NORSRAM_TimingTypeDef *ExtTiming);
Kojto 93:e188a91d3eaa 202 HAL_StatusTypeDef HAL_NOR_DeInit(NOR_HandleTypeDef *hnor);
Kojto 93:e188a91d3eaa 203 void HAL_NOR_MspInit(NOR_HandleTypeDef *hnor);
Kojto 93:e188a91d3eaa 204 void HAL_NOR_MspDeInit(NOR_HandleTypeDef *hnor);
Kojto 93:e188a91d3eaa 205 void HAL_NOR_MspWait(NOR_HandleTypeDef *hnor, uint32_t Timeout);
Kojto 93:e188a91d3eaa 206
Kojto 93:e188a91d3eaa 207 /* I/O operation functions ***************************************************/
Kojto 93:e188a91d3eaa 208 HAL_StatusTypeDef HAL_NOR_Read_ID(NOR_HandleTypeDef *hnor, NOR_IDTypeDef *pNOR_ID);
Kojto 93:e188a91d3eaa 209 HAL_StatusTypeDef HAL_NOR_ReturnToReadMode(NOR_HandleTypeDef *hnor);
Kojto 93:e188a91d3eaa 210 HAL_StatusTypeDef HAL_NOR_Read(NOR_HandleTypeDef *hnor, uint32_t *pAddress, uint16_t *pData);
Kojto 93:e188a91d3eaa 211 HAL_StatusTypeDef HAL_NOR_Program(NOR_HandleTypeDef *hnor, uint32_t *pAddress, uint16_t *pData);
Kojto 93:e188a91d3eaa 212
Kojto 93:e188a91d3eaa 213 HAL_StatusTypeDef HAL_NOR_ReadBuffer(NOR_HandleTypeDef *hnor, uint32_t uwAddress, uint16_t *pData, uint32_t uwBufferSize);
Kojto 93:e188a91d3eaa 214 HAL_StatusTypeDef HAL_NOR_ProgramBuffer(NOR_HandleTypeDef *hnor, uint32_t uwAddress, uint16_t *pData, uint32_t uwBufferSize);
Kojto 93:e188a91d3eaa 215
Kojto 93:e188a91d3eaa 216 HAL_StatusTypeDef HAL_NOR_Erase_Block(NOR_HandleTypeDef *hnor, uint32_t BlockAddress, uint32_t Address);
Kojto 93:e188a91d3eaa 217 HAL_StatusTypeDef HAL_NOR_Erase_Chip(NOR_HandleTypeDef *hnor, uint32_t Address);
Kojto 93:e188a91d3eaa 218 HAL_StatusTypeDef HAL_NOR_Read_CFI(NOR_HandleTypeDef *hnor, NOR_CFITypeDef *pNOR_CFI);
Kojto 93:e188a91d3eaa 219
Kojto 93:e188a91d3eaa 220 /* NOR Control functions *****************************************************/
Kojto 93:e188a91d3eaa 221 HAL_StatusTypeDef HAL_NOR_WriteOperation_Enable(NOR_HandleTypeDef *hnor);
Kojto 93:e188a91d3eaa 222 HAL_StatusTypeDef HAL_NOR_WriteOperation_Disable(NOR_HandleTypeDef *hnor);
Kojto 93:e188a91d3eaa 223
Kojto 93:e188a91d3eaa 224 /* NOR State functions ********************************************************/
Kojto 93:e188a91d3eaa 225 HAL_NOR_StateTypeDef HAL_NOR_GetState(NOR_HandleTypeDef *hnor);
Kojto 93:e188a91d3eaa 226 NOR_StatusTypedef HAL_NOR_GetStatus(NOR_HandleTypeDef *hnor, uint32_t Address, uint32_t Timeout);
Kojto 93:e188a91d3eaa 227
Kojto 93:e188a91d3eaa 228 #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx || STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx */
Kojto 93:e188a91d3eaa 229 /**
Kojto 93:e188a91d3eaa 230 * @}
Kojto 93:e188a91d3eaa 231 */
Kojto 93:e188a91d3eaa 232
Kojto 93:e188a91d3eaa 233 /**
Kojto 93:e188a91d3eaa 234 * @}
Kojto 93:e188a91d3eaa 235 */
Kojto 93:e188a91d3eaa 236
Kojto 93:e188a91d3eaa 237 #ifdef __cplusplus
Kojto 93:e188a91d3eaa 238 }
Kojto 93:e188a91d3eaa 239 #endif
Kojto 93:e188a91d3eaa 240
Kojto 93:e188a91d3eaa 241 #endif /* __STM32F4xx_HAL_NOR_H */
Kojto 93:e188a91d3eaa 242
Kojto 93:e188a91d3eaa 243 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/