mbed-src - mbed library sources

Users » mbed_official » Code » mbed-src

mbed library sources

Dependents: Encrypted my_mbed lklk CyaSSL_DTLS_Cellular ... more

Superseded

This library was superseded by mbed-dev - https://os.mbed.com/users/mbed_official/code/mbed-dev/.

Development branch of the mbed library sources. This library is kept in synch with the latest changes from the mbed SDK and it is not guaranteed to work.

If you are looking for a stable and tested release, please import one of the official mbed library releases:

Import library mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Diff: targets/cmsis/TARGET_STM/TARGET_NUCLEO_F401RE/stm32f4xx_hal_sram.c

Revision:: 226:b062af740e40
Parent:: 106:ced8cbb51063
Child:: 369:2e96f1b71984

--- a/targets/cmsis/TARGET_STM/TARGET_NUCLEO_F401RE/stm32f4xx_hal_sram.c	Wed Jun 11 09:30:07 2014 +0100
+++ b/targets/cmsis/TARGET_STM/TARGET_NUCLEO_F401RE/stm32f4xx_hal_sram.c	Wed Jun 11 09:45:09 2014 +0100
@@ -2,8 +2,8 @@
   ******************************************************************************
   * @file    stm32f4xx_hal_sram.c
   * @author  MCD Application Team
-  * @version V1.0.0
-  * @date    18-February-2014
+  * @version V1.1.0RC2
+  * @date    14-May-2014
   * @brief   SRAM HAL module driver.
   *          This file provides a generic firmware to drive SRAM memories  
   *          mounted as external device.
@@ -134,7 +134,8 @@
 
 /**
   * @brief  Performs the SRAM device initialization sequence
-  * @param  hsram: pointer to SRAM handle
+  * @param  hsram: pointer to a SRAM_HandleTypeDef structure that contains
+  *                the configuration information for SRAM module.
   * @param  Timing: Pointer to SRAM control timing structure 
   * @param  ExtTiming: Pointer to SRAM extended mode timing structure  
   * @retval HAL status
@@ -170,7 +171,8 @@
 
 /**
   * @brief  Performs the SRAM device De-initialization sequence.
-  * @param  hsram: pointer to SRAM handle
+  * @param  hsram: pointer to a SRAM_HandleTypeDef structure that contains
+  *                the configuration information for SRAM module.
   * @retval HAL status
   */
 HAL_StatusTypeDef  HAL_SRAM_DeInit(SRAM_HandleTypeDef *hsram)
@@ -191,7 +193,8 @@
 
 /**
   * @brief  SRAM MSP Init.
-  * @param  hsram: pointer to SRAM handle
+  * @param  hsram: pointer to a SRAM_HandleTypeDef structure that contains
+  *                the configuration information for SRAM module.
   * @retval None
   */
 __weak void HAL_SRAM_MspInit(SRAM_HandleTypeDef *hsram)
@@ -203,7 +206,8 @@
 
 /**
   * @brief  SRAM MSP DeInit.
-  * @param  hsram: pointer to SRAM handle
+  * @param  hsram: pointer to a SRAM_HandleTypeDef structure that contains
+  *                the configuration information for SRAM module.
   * @retval None
   */
 __weak void HAL_SRAM_MspDeInit(SRAM_HandleTypeDef *hsram)
@@ -215,8 +219,9 @@
 
 /**
   * @brief  DMA transfer complete callback.
-  * @param  hsram: pointer to SRAM handle
-  * @retval none
+  * @param  hsram: pointer to a SRAM_HandleTypeDef structure that contains
+  *                the configuration information for SRAM module.
+  * @retval None
   */
 __weak void HAL_SRAM_DMA_XferCpltCallback(DMA_HandleTypeDef *hdma)
 {
@@ -227,8 +232,9 @@
 
 /**
   * @brief  DMA transfer complete error callback.
-  * @param  hsram: pointer to SRAM handle
-  * @retval none
+  * @param  hsram: pointer to a SRAM_HandleTypeDef structure that contains
+  *                the configuration information for SRAM module.
+  * @retval None
   */
 __weak void HAL_SRAM_DMA_XferErrorCallback(DMA_HandleTypeDef *hdma)
 {
@@ -257,7 +263,8 @@
 
 /**
   * @brief  Reads 8-bit buffer from SRAM memory. 
-  * @param  hsram: pointer to SRAM handle
+  * @param  hsram: pointer to a SRAM_HandleTypeDef structure that contains
+  *                the configuration information for SRAM module.
   * @param  pAddress: Pointer to read start address
   * @param  pDstBuffer: Pointer to destination buffer  
   * @param  BufferSize: Size of the buffer to read from memory
@@ -292,7 +299,8 @@
 
 /**
   * @brief  Writes 8-bit buffer to SRAM memory. 
-  * @param  hsram: pointer to SRAM handle
+  * @param  hsram: pointer to a SRAM_HandleTypeDef structure that contains
+  *                the configuration information for SRAM module.
   * @param  pAddress: Pointer to write start address
   * @param  pSrcBuffer: Pointer to source buffer to write  
   * @param  BufferSize: Size of the buffer to write to memory
@@ -333,7 +341,8 @@
 
 /**
   * @brief  Reads 16-bit buffer from SRAM memory. 
-  * @param  hsram: pointer to SRAM handle
+  * @param  hsram: pointer to a SRAM_HandleTypeDef structure that contains
+  *                the configuration information for SRAM module.
   * @param  pAddress: Pointer to read start address
   * @param  pDstBuffer: Pointer to destination buffer  
   * @param  BufferSize: Size of the buffer to read from memory
@@ -368,7 +377,8 @@
 
 /**
   * @brief  Writes 16-bit buffer to SRAM memory. 
-  * @param  hsram: pointer to SRAM handle
+  * @param  hsram: pointer to a SRAM_HandleTypeDef structure that contains
+  *                the configuration information for SRAM module.
   * @param  pAddress: Pointer to write start address
   * @param  pSrcBuffer: Pointer to source buffer to write  
   * @param  BufferSize: Size of the buffer to write to memory
@@ -409,7 +419,8 @@
 
 /**
   * @brief  Reads 32-bit buffer from SRAM memory. 
-  * @param  hsram: pointer to SRAM handle
+  * @param  hsram: pointer to a SRAM_HandleTypeDef structure that contains
+  *                the configuration information for SRAM module.
   * @param  pAddress: Pointer to read start address
   * @param  pDstBuffer: Pointer to destination buffer  
   * @param  BufferSize: Size of the buffer to read from memory
@@ -442,7 +453,8 @@
 
 /**
   * @brief  Writes 32-bit buffer to SRAM memory. 
-  * @param  hsram: pointer to SRAM handle
+  * @param  hsram: pointer to a SRAM_HandleTypeDef structure that contains
+  *                the configuration information for SRAM module.
   * @param  pAddress: Pointer to write start address
   * @param  pSrcBuffer: Pointer to source buffer to write  
   * @param  BufferSize: Size of the buffer to write to memory
@@ -481,7 +493,8 @@
 
 /**
   * @brief  Reads a Words data from the SRAM memory using DMA transfer.
-  * @param  hsram: pointer to SRAM handle
+  * @param  hsram: pointer to a SRAM_HandleTypeDef structure that contains
+  *                the configuration information for SRAM module.
   * @param  pAddress: Pointer to read start address
   * @param  pDstBuffer: Pointer to destination buffer  
   * @param  BufferSize: Size of the buffer to read from memory
@@ -513,7 +526,8 @@
 
 /**
   * @brief  Writes a Words data buffer to SRAM memory using DMA transfer.
-  * @param  hsram: pointer to SRAM handle
+  * @param  hsram: pointer to a SRAM_HandleTypeDef structure that contains
+  *                the configuration information for SRAM module.
   * @param  pAddress: Pointer to write start address
   * @param  pSrcBuffer: Pointer to source buffer to write  
   * @param  BufferSize: Size of the buffer to write to memory
@@ -570,7 +584,8 @@
     
 /**
   * @brief  Enables dynamically SRAM write operation.
-  * @param  hsram: pointer to SRAM handle
+  * @param  hsram: pointer to a SRAM_HandleTypeDef structure that contains
+  *                the configuration information for SRAM module.
   * @retval HAL status
   */
 HAL_StatusTypeDef HAL_SRAM_WriteOperation_Enable(SRAM_HandleTypeDef *hsram)
@@ -592,7 +607,8 @@
 
 /**
   * @brief  Disables dynamically SRAM write operation.
-  * @param  hsram: pointer to SRAM handle
+  * @param  hsram: pointer to a SRAM_HandleTypeDef structure that contains
+  *                the configuration information for SRAM module.
   * @retval HAL status
   */
 HAL_StatusTypeDef HAL_SRAM_WriteOperation_Disable(SRAM_HandleTypeDef *hsram)
@@ -636,8 +652,9 @@
   
 /**
   * @brief  Returns the SRAM controller state
-  * @param  hsram: pointer to SRAM handle
-  * @retval SRAM controller state
+  * @param  hsram: pointer to a SRAM_HandleTypeDef structure that contains
+  *                the configuration information for SRAM module.
+  * @retval HAL state
   */
 HAL_SRAM_StateTypeDef HAL_SRAM_GetState(SRAM_HandleTypeDef *hsram)
 {