STM32F769I-Discovery BSP User Manual: stm32f769i_discovery_sd.h Source File

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