lib/main/STM32F4/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_sram.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32f4xx_hal_sram.h
   4   * @author  MCD Application Team
   5   * @version V1.7.1
   6   * @date    14-April-2017
   7   * @brief   Header file of SRAM HAL module.
   8   ******************************************************************************
   9   * @attention
  10   *
  11   * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
  12   *
  13   * Redistribution and use in source and binary forms, with or without modification,
  14   * are permitted provided that the following conditions are met:
  15   *   1. Redistributions of source code must retain the above copyright notice,
  16   *      this list of conditions and the following disclaimer.
  17   *   2. Redistributions in binary form must reproduce the above copyright notice,
  18   *      this list of conditions and the following disclaimer in the documentation
  19   *      and/or other materials provided with the distribution.
  20   *   3. Neither the name of STMicroelectronics nor the names of its contributors
  21   *      may be used to endorse or promote products derived from this software
  22   *      without specific prior written permission.
  23   *
  24   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  25   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  27   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  28   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  30   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  31   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  32   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  33   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34   *
  35   ******************************************************************************
  36   */
  37
  38 /* Define to prevent recursive inclusion -------------------------------------*/
  39 #ifndef __STM32F4xx_HAL_SRAM_H
  40 #define __STM32F4xx_HAL_SRAM_H
  41
  42 #ifdef __cplusplus
  43  extern "C" {
  44 #endif
  45
  46 /* Includes ------------------------------------------------------------------*/
  47 #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx) || defined(STM32F417xx) || defined(STM32F412Zx) ||\
  48     defined(STM32F412Vx) || defined(STM32F412Rx) || defined(STM32F413xx) || defined(STM32F423xx)
  49   #include "stm32f4xx_ll_fsmc.h"
  50 #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx || STM32F412Zx || STM32F412Vx || STM32F412Rx || STM32F413xx || STM32F423xx */
  51
  52 #if defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx)|| defined(STM32F439xx) ||\
  53  defined(STM32F446xx) || defined(STM32F469xx) || defined(STM32F479xx)
  54   #include "stm32f4xx_ll_fmc.h"
  55 #endif /* STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx || STM32F446xx || STM32F469xx || STM32F479xx */
  56
  57
  58 /** @addtogroup STM32F4xx_HAL_Driver
  59   * @{
  60   */
  61
  62 #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx) || defined(STM32F417xx) ||\
  63     defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx) ||\
  64     defined(STM32F446xx) || defined(STM32F469xx) || defined(STM32F479xx) || defined(STM32F412Zx) ||\
  65     defined(STM32F412Vx) || defined(STM32F412Rx) || defined(STM32F413xx) || defined(STM32F423xx)
  66
  67 /** @addtogroup SRAM
  68   * @{
  69   */
  70
  71 /* Exported typedef ----------------------------------------------------------*/
  72
  73 /** @defgroup SRAM_Exported_Types SRAM Exported Types
  74   * @{
  75   */
  76 /**
  77   * @brief  HAL SRAM State structures definition
  78   */
  79 typedef enum
  80 {
  81   HAL_SRAM_STATE_RESET     = 0x00U,  /*!< SRAM not yet initialized or disabled           */
  82   HAL_SRAM_STATE_READY     = 0x01U,  /*!< SRAM initialized and ready for use             */
  83   HAL_SRAM_STATE_BUSY      = 0x02U,  /*!< SRAM internal process is ongoing               */
  84   HAL_SRAM_STATE_ERROR     = 0x03U,  /*!< SRAM error state                               */
  85   HAL_SRAM_STATE_PROTECTED = 0x04U   /*!< SRAM peripheral NORSRAM device write protected */
  86
  87 }HAL_SRAM_StateTypeDef;
  88
  89 /**
  90   * @brief  SRAM handle Structure definition
  91   */
  92 typedef struct
  93 {
  94   FMC_NORSRAM_TypeDef           *Instance;  /*!< Register base address                        */
  95
  96   FMC_NORSRAM_EXTENDED_TypeDef  *Extended;  /*!< Extended mode register base address          */
  97
  98   FMC_NORSRAM_InitTypeDef       Init;       /*!< SRAM device control configuration parameters */
  99
 100   HAL_LockTypeDef               Lock;       /*!< SRAM locking object                          */
 101
 102   __IO HAL_SRAM_StateTypeDef    State;      /*!< SRAM device access state                     */
 103
 104   DMA_HandleTypeDef             *hdma;      /*!< Pointer DMA handler                          */
 105
 106 }SRAM_HandleTypeDef;
 107
 108 /**
 109   * @}
 110   */
 111
 112 /* Exported constants --------------------------------------------------------*/
 113 /* Exported macro ------------------------------------------------------------*/
 114
 115 /** @defgroup SRAM_Exported_Macros SRAM Exported Macros
 116   * @{
 117   */
 118 /** @brief Reset SRAM handle state
 119   * @param  __HANDLE__: SRAM handle
 120   * @retval None
 121   */
 122 #define __HAL_SRAM_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_SRAM_STATE_RESET)
 123
 124 /**
 125   * @}
 126   */
 127 /* Exported functions --------------------------------------------------------*/
 128
 129 /** @addtogroup SRAM_Exported_Functions
 130  *  @{
 131  */
 132
 133 /** @addtogroup SRAM_Exported_Functions_Group1
 134  *  @{
 135  */
 136 /* Initialization/de-initialization functions  **********************************/
 137 HAL_StatusTypeDef HAL_SRAM_Init(SRAM_HandleTypeDef *hsram, FMC_NORSRAM_TimingTypeDef *Timing, FMC_NORSRAM_TimingTypeDef *ExtTiming);
 138 HAL_StatusTypeDef HAL_SRAM_DeInit(SRAM_HandleTypeDef *hsram);
 139 void              HAL_SRAM_MspInit(SRAM_HandleTypeDef *hsram);
 140 void              HAL_SRAM_MspDeInit(SRAM_HandleTypeDef *hsram);
 141
 142 void              HAL_SRAM_DMA_XferCpltCallback(DMA_HandleTypeDef *hdma);
 143 void              HAL_SRAM_DMA_XferErrorCallback(DMA_HandleTypeDef *hdma);
 144 /**
 145   * @}
 146   */
 147
 148 /** @addtogroup SRAM_Exported_Functions_Group2
 149  *  @{
 150  */
 151 /* I/O operation functions  *****************************************************/
 152 HAL_StatusTypeDef HAL_SRAM_Read_8b(SRAM_HandleTypeDef *hsram, uint32_t *pAddress, uint8_t *pDstBuffer, uint32_t BufferSize);
 153 HAL_StatusTypeDef HAL_SRAM_Write_8b(SRAM_HandleTypeDef *hsram, uint32_t *pAddress, uint8_t *pSrcBuffer, uint32_t BufferSize);
 154 HAL_StatusTypeDef HAL_SRAM_Read_16b(SRAM_HandleTypeDef *hsram, uint32_t *pAddress, uint16_t *pDstBuffer, uint32_t BufferSize);
 155 HAL_StatusTypeDef HAL_SRAM_Write_16b(SRAM_HandleTypeDef *hsram, uint32_t *pAddress, uint16_t *pSrcBuffer, uint32_t BufferSize);
 156 HAL_StatusTypeDef HAL_SRAM_Read_32b(SRAM_HandleTypeDef *hsram, uint32_t *pAddress, uint32_t *pDstBuffer, uint32_t BufferSize);
 157 HAL_StatusTypeDef HAL_SRAM_Write_32b(SRAM_HandleTypeDef *hsram, uint32_t *pAddress, uint32_t *pSrcBuffer, uint32_t BufferSize);
 158 HAL_StatusTypeDef HAL_SRAM_Read_DMA(SRAM_HandleTypeDef *hsram, uint32_t *pAddress, uint32_t *pDstBuffer, uint32_t BufferSize);
 159 HAL_StatusTypeDef HAL_SRAM_Write_DMA(SRAM_HandleTypeDef *hsram, uint32_t *pAddress, uint32_t *pSrcBuffer, uint32_t BufferSize);
 160 /**
 161   * @}
 162   */
 163
 164 /** @addtogroup SRAM_Exported_Functions_Group3
 165  *  @{
 166  */
 167 /* SRAM Control functions  ******************************************************/
 168 HAL_StatusTypeDef HAL_SRAM_WriteOperation_Enable(SRAM_HandleTypeDef *hsram);
 169 HAL_StatusTypeDef HAL_SRAM_WriteOperation_Disable(SRAM_HandleTypeDef *hsram);
 170 /**
 171   * @}
 172   */
 173
 174 /** @addtogroup SRAM_Exported_Functions_Group4
 175  *  @{
 176  */
 177 /* SRAM State functions *********************************************************/
 178 HAL_SRAM_StateTypeDef HAL_SRAM_GetState(SRAM_HandleTypeDef *hsram);
 179 /**
 180   * @}
 181   */
 182
 183 /**
 184   * @}
 185   */
 186
 187 /* Private types -------------------------------------------------------------*/
 188 /* Private variables ---------------------------------------------------------*/
 189 /* Private constants ---------------------------------------------------------*/
 190 /* Private macros ------------------------------------------------------------*/
 191 /* Private functions ---------------------------------------------------------*/
 192 /**
 193   * @}
 194   */
 195
 196 #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx || STM32F427xx || STM32F437xx ||\
 197           STM32F429xx || STM32F439xx || STM32F446xx || STM32F469xx || STM32F479xx || STM32F412Zx ||\
 198           STM32F412Vx || STM32F412Rx || STM32F413xx || STM32F423xx */
 199 /**
 200   * @}
 201   */
 202 #ifdef __cplusplus
 203 }
 204 #endif
 205
 206 #endif /* __STM32F4xx_HAL_SRAM_H */
 207
 208 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/