Elijah Orr / mbed-renbed

Fork of the official mbed C/C SDK provides the software platform and libraries to build your applications for RenBED.

Dependents:   1-RenBuggyTimed RenBED_RGB RenBED_RGB_PWM RenBED_RGB

Fork of mbed by mbed official

TARGET_NUCLEO_F303K8/stm32f3xx_hal_sram.h@121:672067c3ada4, 2016-04-14 (annotated)

Committer:
elijahorr
Date:
Thu Apr 14 07:28:54 2016 +0000
Revision:
121:672067c3ada4
Parent:
109:9296ab0bfc11 
.

Who changed what in which revision?

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