STM32469I_EVAL BSP User Manual: stm32469i_eval_sd.h Source File

00001 /**
00002   ******************************************************************************
00003   * @file    stm32469i_eval_sd.h
00004   * @author  MCD Application Team
00005   * @version V1.0.2
00006   * @date    12-January-2016
00007   * @brief   This file contains the common defines and functions prototypes for
00008   *          the stm32469i_eval_sd.c driver.
00009   ******************************************************************************
00010   * @attention
00011   *
00012   * <h2><center>&copy; COPYRIGHT(c) 2015 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 __STM32469I_EVAL_SD_H
00041 #define __STM32469I_EVAL_SD_H
00042 
00043 #ifdef __cplusplus
00044  extern "C" {
00045 #endif
00046 
00047 /* Includes ------------------------------------------------------------------*/
00048 #include "stm32469i_eval.h"
00049 #include "stm32469i_eval_io.h"
00050 
00051 /** @addtogroup BSP
00052   * @{
00053   */
00054 
00055 /** @addtogroup STM32469I_EVAL
00056   * @{
00057   */
00058 
00059 /** @defgroup STM32469I-EVAL_SD STM32469I EVAL SD
00060   * @{
00061   */
00062 
00063 /** @defgroup STM32469I-EVAL_SD_Exported_Types STM32469I EVAL SD Exported Types
00064   * @{
00065   */
00066 
00067 /**
00068   * @brief SD Card information structure
00069   */
00070 #define SD_CardInfo HAL_SD_CardInfoTypedef
00071 /**
00072   * @}
00073   */
00074 
00075 /**
00076   * @brief  SD status structure definition
00077   */
00078 #define   MSD_OK                        ((uint8_t)0x00)
00079 #define   MSD_ERROR                     ((uint8_t)0x01)
00080 #define   MSD_ERROR_SD_NOT_PRESENT      ((uint8_t)0x02)
00081 
00082 /** @defgroup STM32469I-EVAL_SD_Exported_Constants STM32469I EVAL SD Exported Constants
00083   * @{
00084   */
00085 #define SD_PRESENT               ((uint8_t)0x01)
00086 #define SD_NOT_PRESENT           ((uint8_t)0x00)
00087 
00088 #define SD_DATATIMEOUT           ((uint32_t)100000000)
00089 
00090 /* DMA definitions for SD DMA transfer */
00091 #define __DMAx_TxRx_CLK_ENABLE            __HAL_RCC_DMA2_CLK_ENABLE
00092 #define SD_DMAx_Tx_CHANNEL                DMA_CHANNEL_4
00093 #define SD_DMAx_Rx_CHANNEL                DMA_CHANNEL_4
00094 #define SD_DMAx_Tx_STREAM                 DMA2_Stream6
00095 #define SD_DMAx_Rx_STREAM                 DMA2_Stream3
00096 #define SD_DMAx_Tx_IRQn                   DMA2_Stream6_IRQn
00097 #define SD_DMAx_Rx_IRQn                   DMA2_Stream3_IRQn
00098 #define SD_DMAx_Tx_IRQHandler             DMA2_Stream6_IRQHandler
00099 #define SD_DMAx_Rx_IRQHandler             DMA2_Stream3_IRQHandler
00100 #define SD_DetectIRQHandler()             HAL_GPIO_EXTI_IRQHandler(GPIO_PIN_8)
00101 /**
00102   * @}
00103   */
00104 
00105 /** @defgroup STM32469I-EVAL_SD_Exported_Macro STM32469I EVAL SD Exported Macro
00106   * @{
00107   */
00108 /**
00109   * @}
00110   */
00111 
00112 /** @defgroup STM32469I-EVAL_SD_Exported_Functions STM32469I EVAL SD Exported Functions
00113   * @{
00114   */
00115 uint8_t BSP_SD_Init(void);
00116 uint8_t BSP_SD_DeInit(void);
00117 uint8_t BSP_SD_ITConfig(void);
00118 void    BSP_SD_DetectIT(void);
00119 void    BSP_SD_DetectCallback(void);
00120 uint8_t BSP_SD_ReadBlocks(uint32_t *pData, uint64_t ReadAddr, uint32_t BlockSize, uint32_t NumOfBlocks);
00121 uint8_t BSP_SD_WriteBlocks(uint32_t *pData, uint64_t WriteAddr, uint32_t BlockSize, uint32_t NumOfBlocks);
00122 uint8_t BSP_SD_ReadBlocks_DMA(uint32_t *pData, uint64_t ReadAddr, uint32_t BlockSize, uint32_t NumOfBlocks);
00123 uint8_t BSP_SD_WriteBlocks_DMA(uint32_t *pData, uint64_t WriteAddr, uint32_t BlockSize, uint32_t NumOfBlocks);
00124 uint8_t BSP_SD_Erase(uint64_t StartAddr, uint64_t EndAddr);
00125 void    BSP_SD_IRQHandler(void);
00126 void    BSP_SD_DMA_Tx_IRQHandler(void);
00127 void    BSP_SD_DMA_Rx_IRQHandler(void);
00128 HAL_SD_TransferStateTypedef BSP_SD_GetStatus(void);
00129 void    BSP_SD_GetCardInfo(HAL_SD_CardInfoTypedef *CardInfo);
00130 uint8_t BSP_SD_IsDetected(void);
00131 
00132 /* These function can be modified in case the current settings (e.g. DMA stream)
00133    need to be changed for specific application needs */
00134 void    BSP_SD_MspInit(SD_HandleTypeDef *hsd, void *Params);
00135 void    BSP_SD_MspDeInit(SD_HandleTypeDef *hsd, void *Params);
00136 
00137 /**
00138   * @}
00139   */
00140 
00141 /**
00142   * @}
00143   */
00144 
00145 /**
00146   * @}
00147   */
00148 
00149 /**
00150   * @}
00151   */
00152 
00153 #ifdef __cplusplus
00154 }
00155 #endif
00156 
00157 #endif /* __STM32469I_EVAL_SD_H */
00158 
00159 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/