stm32f413h_discovery_sd.h

00001 /**
00002   ******************************************************************************
00003   * @file    stm32f413h_discovery_sd.h
00004   * @author  MCD Application Team
00005   * @brief   This file contains the common defines and functions prototypes for
00006   *          the stm32413h_discovery_sd.c driver.
00007   ******************************************************************************
00008   * @attention
00009   *
00010   * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
00011   *
00012   * Redistribution and use in source and binary forms, with or without modification,
00013   * are permitted provided that the following conditions are met:
00014   *   1. Redistributions of source code must retain the above copyright notice,
00015   *      this list of conditions and the following disclaimer.
00016   *   2. Redistributions in binary form must reproduce the above copyright notice,
00017   *      this list of conditions and the following disclaimer in the documentation
00018   *      and/or other materials provided with the distribution.
00019   *   3. Neither the name of STMicroelectronics nor the names of its contributors
00020   *      may be used to endorse or promote products derived from this software
00021   *      without specific prior written permission.
00022   *
00023   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00024   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00025   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00026   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
00027   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00028   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00029   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00030   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00031   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00032   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00033   *
00034   ******************************************************************************
00035   */ 
00036 
00037 /* Define to prevent recursive inclusion -------------------------------------*/
00038 #ifndef __STM32F413H_DISCOVERY_SD_H
00039 #define __STM32F413H_DISCOVERY_SD_H
00040 
00041 #ifdef __cplusplus
00042  extern "C" {
00043 #endif 
00044 
00045 /* Includes ------------------------------------------------------------------*/
00046 #include "stm32f413h_discovery.h"
00047 
00048 /** @addtogroup BSP
00049   * @{
00050   */ 
00051 
00052 /** @addtogroup STM32F413H_DISCOVERY
00053   * @{
00054   */
00055     
00056 /** @addtogroup STM32F413H_DISCOVERY_SD
00057   * @{
00058   */    
00059 
00060 /** @addtogroup STM32F413H_DISCOVERY_SD_Private_Variables
00061   * @{
00062   */
00063 
00064 /** 
00065   * @brief SD Card information structure 
00066   */
00067 #define BSP_SD_CardInfo HAL_SD_CardInfoTypeDef
00068 /**
00069   * @}
00070   */
00071   
00072 /** @defgroup STM32F413H_DISCOVERY_SD_Exported_Constants STM32F413H DISCOVERY SD Exported Constants
00073   * @{
00074   */ 
00075 
00076 /** 
00077   * @brief  SD status structure definition  
00078   */     
00079 #define   MSD_OK                        ((uint8_t)0x00)
00080 #define   MSD_ERROR                     ((uint8_t)0x01)
00081 #define   MSD_ERROR_SD_NOT_PRESENT      ((uint8_t)0x02)
00082 
00083 /** 
00084   * @brief  SD transfer state definition  
00085   */     
00086 #define   SD_TRANSFER_OK                ((uint8_t)0x00)
00087 #define   SD_TRANSFER_BUSY              ((uint8_t)0x01)    
00088 #define SD_PRESENT               ((uint8_t)0x01)
00089 #define SD_NOT_PRESENT           ((uint8_t)0x00)
00090 
00091 #define SD_DATATIMEOUT           ((uint32_t)100000000)
00092     
00093 /* DMA definitions for SD DMA transfer */
00094 #define __DMAx_TxRx_CLK_ENABLE            __HAL_RCC_DMA2_CLK_ENABLE
00095 #define SD_DMAx_Tx_CHANNEL                DMA_CHANNEL_4
00096 #define SD_DMAx_Rx_CHANNEL                DMA_CHANNEL_4
00097 #define SD_DMAx_Tx_STREAM                 DMA2_Stream6  
00098 #define SD_DMAx_Rx_STREAM                 DMA2_Stream3  
00099 #define SD_DMAx_Tx_IRQn                   DMA2_Stream6_IRQn
00100 #define SD_DMAx_Rx_IRQn                   DMA2_Stream3_IRQn
00101 #define BSP_SD_IRQHandler                 SDIO_IRQHandler
00102 #define BSP_SD_DMA_Tx_IRQHandler          DMA2_Stream6_IRQHandler   
00103 #define BSP_SD_DMA_Rx_IRQHandler          DMA2_Stream3_IRQHandler 
00104 #define SD_DetectIRQHandler()             HAL_GPIO_EXTI_IRQHandler(SD_DETECT_PIN)
00105 /**
00106   * @}
00107   */
00108    
00109 /** @defgroup STM32F413H_DISCOVERY_SD_Exported_Functions STM32F413H DISCOVERY SD Exported Functions
00110   * @{
00111   */   
00112 uint8_t BSP_SD_Init(void);
00113 uint8_t BSP_SD_DeInit(void);
00114 uint8_t BSP_SD_ITConfig(void);
00115 uint8_t BSP_SD_ReadBlocks(uint32_t *pData, uint32_t ReadAddr, uint32_t NumOfBlocks, uint32_t Timeout);
00116 uint8_t BSP_SD_WriteBlocks(uint32_t *pData, uint32_t WriteAddr, uint32_t NumOfBlocks, uint32_t Timeout);
00117 uint8_t BSP_SD_ReadBlocks_DMA(uint32_t *pData, uint32_t ReadAddr, uint32_t NumOfBlocks);
00118 uint8_t BSP_SD_WriteBlocks_DMA(uint32_t *pData, uint32_t WriteAddr, uint32_t NumOfBlocks);
00119 uint8_t BSP_SD_Erase(uint32_t StartAddr, uint32_t EndAddr);
00120 uint8_t BSP_SD_GetCardState(void);
00121 void    BSP_SD_GetCardInfo(HAL_SD_CardInfoTypeDef *CardInfo);
00122 uint8_t BSP_SD_IsDetected(void);
00123 
00124 /* These functions can be modified in case the current settings (e.g. DMA stream)
00125    need to be changed for specific application needs */
00126 void    BSP_SD_MspInit(SD_HandleTypeDef *hsd, void *Params);
00127 void    BSP_SD_Detect_MspInit(SD_HandleTypeDef *hsd, void *Params);
00128 void    BSP_SD_MspDeInit(SD_HandleTypeDef *hsd, void *Params);
00129 void    BSP_SD_AbortCallback(void);
00130 void    BSP_SD_WriteCpltCallback(void);
00131 void    BSP_SD_ReadCpltCallback(void);
00132 
00133 /**
00134   * @}
00135   */ 
00136 
00137 /**
00138   * @}
00139   */ 
00140 
00141 /**
00142   * @}
00143   */ 
00144 
00145 /**
00146   * @}
00147   */ 
00148 
00149 #ifdef __cplusplus
00150 }
00151 #endif
00152 
00153 #endif /* __STM32F413H_DISCOVERY_SD_H */
00154 
00155 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/