Clean up code

Signed-off-by: Frederic.Pillon <frederic.pillon@st.com>

Author: fpistm

src/SD.cpp

@@ -62,10 +62,10 @@ SDClass SD;
   * @param  None
   * @retval TRUE or FALSE
   */
-uint8_t SDClass::begin(uint32_t cspin)
+uint8_t SDClass::begin(uint32_t detectpin)
 {
   /*##-1- Initializes SD IOs #############################################*/
-  if (_card.init(cspin)) {
+  if (_card.init(detectpin)) {
     return _fatFs.init();
   }
   return FALSE;

src/STM32SD.h

@@ -81,7 +81,7 @@ class SDClass {
   public:
 
     /* Initialize the SD peripheral */
-    uint8_t begin(uint32_t cspin = SD_DETECT_NONE);
+    uint8_t begin(uint32_t detectpin = SD_DETECT_NONE);
     static File open(const char *filepath, uint8_t mode);
     static File open(const char *filepath);
     static uint8_t exists(const char *filepath);

src/Sd2Card.cpp

@@ -37,13 +37,13 @@
 #include <Arduino.h>
 #include "Sd2Card.h"
 
-uint8_t Sd2Card::init(uint32_t cspin)
+uint8_t Sd2Card::init(uint32_t detectpin)
 {
-  if (cspin != SD_DETECT_NONE) {
-    PinName p = digitalPinToPinName(cspin);
+  if (detectpin != SD_DETECT_NONE) {
+    PinName p = digitalPinToPinName(detectpin);
     if ((p == NC) || \
-        BSP_SD_CSSet(set_GPIO_Port_Clock(STM_PORT(p)),
-                     STM_GPIO_PIN(p)) != MSD_OK) {
+        BSP_SD_DetectPin(set_GPIO_Port_Clock(STM_PORT(p)),
+                         STM_GPIO_PIN(p)) != MSD_OK) {
       return FALSE;
     }
   }

src/Sd2Card.h

@@ -56,7 +56,7 @@
 class Sd2Card {
   public:
 
-    uint8_t init(uint32_t cspin = SD_DETECT_NONE);
+    uint8_t init(uint32_t detectpin = SD_DETECT_NONE);
 
     /** Return the card type: SD V1, SD V2 or SDHC */
     uint8_t type(void) const;

src/bsp_sd.c

@@ -1,9 +1,6 @@
 /**
 ******************************************************************************
 * @file    bsp_sd.c
-* @author  MCD Application Team
-* @version V1.0.0
-* @date    10-June-2016
 * @brief   This file includes the uSD card driver mounted on stm32
 *          board.
 ******************************************************************************
@@ -36,48 +33,6 @@
 ******************************************************************************
 */
 
-/* File Info : -----------------------------------------------------------------
-                                   User NOTES
-1. How To use this driver:
---------------------------
-   - This driver is used to drive the micro SD external card mounted on a board.
-   - This driver does not need a specific component driver for the micro SD device
-     to be included with.
-
-2. Driver description:
----------------------
-  + Initialization steps:
-     o Initialize the micro SD card using the BSP_SD_Init() function. This
-       function includes the MSP layer hardware resources initialization and the
-       SDIO interface configuration to interface with the external micro SD. It
-       also includes the micro SD initialization sequence.
-     o To check the SD card presence you can use the function BSP_SD_IsDetected() which
-       returns the detection status
-     o If SD presence detection interrupt mode is desired, you must configure the
-       SD detection interrupt mode by calling the function BSP_SD_ITConfig(). The interrupt
-       is generated as an external interrupt whenever the micro SD card is
-       plugged/unplugged in/from the board. The SD detection interrupt
-       is handled by calling the function BSP_SD_DetectIT() which is called in the IRQ
-       handler file, the user callback is implemented in the function BSP_SD_DetectCallback().
-     o The function BSP_SD_GetCardInfo() is used to get the micro SD card information
-       which is stored in the structure "HAL_SD_CardInfoTypedef".
-
-  + Micro SD card operations
-     o The micro SD card can be accessed with read/write block(s) operations once
-       it is reay for access. The access cand be performed whether using the polling
-       mode by calling the functions BSP_SD_ReadBlocks()/BSP_SD_WriteBlocks(), or by DMA
-       transfer using the functions BSP_SD_ReadBlocks_DMA()/BSP_SD_WriteBlocks_DMA()
-     o The DMA transfer complete is used with interrupt mode. Once the SD transfer
-       is complete, the SD interrupt is handeled using the function BSP_SD_IRQHandler(),
-       the DMA Tx/Rx transfer complete are handeled using the functions
-       BSP_SD_DMA_Tx_IRQHandler()/BSP_SD_DMA_Rx_IRQHandler(). The corresponding user callbacks
-       are implemented by the user at application level.
-     o The SD erase block(s) is performed using the function BSP_SD_Erase() with specifying
-       the number of blocks to erase.
-     o The SD runtime status is returned when calling the function BSP_SD_GetStatus().
-
-------------------------------------------------------------------------------*/
-
 /* Includes ------------------------------------------------------------------*/
 #include "bsp_sd.h"
 #include "PeripheralPins.h"
@@ -139,8 +94,6 @@ uint8_t BSP_SD_Init(void)
 {
   uint8_t sd_state = MSD_OK;
 
-  /* PLLSAI is dedicated to LCD periph. Do not use it to get 48MHz*/
-
   /* uSD device interface configuration */
   uSdHandle.Instance = SD_INSTANCE;
 
@@ -186,22 +139,6 @@ uint8_t BSP_SD_Init(void)
   return  sd_state;
 }
 
-/**
-  * @brief  Set the SD card device detect pin and port.
-  * @param  csport one of the gpio port
-  * @param  cspin one of the gpio pin
-  * @retval SD status
-  */
-uint8_t BSP_SD_CSSet(GPIO_TypeDef *csport, uint32_t cspin)
-{
-  if (csport != 0) {
-    SD_detect_gpio_pin = cspin;
-    SD_detect_gpio_port = csport;
-    return MSD_OK;
-  }
-  return MSD_ERROR;
-}
-
 /**
   * @brief  DeInitializes the SD card device.
   * @retval SD status
@@ -224,11 +161,27 @@ uint8_t BSP_SD_DeInit(void)
   return  sd_state;
 }
 
+/**
+  * @brief  Set the SD card device detect pin and port.
+  * @param  port one of the gpio port
+  * @param  pin one of the gpio pin
+  * @retval SD status
+  */
+uint8_t BSP_SD_DetectPin(GPIO_TypeDef *port, uint32_t pin)
+{
+  if (port != 0) {
+    SD_detect_gpio_pin = pin;
+    SD_detect_gpio_port = port;
+    return MSD_OK;
+  }
+  return MSD_ERROR;
+}
+
 /**
   * @brief  Configures Interrupt mode for SD detection pin.
-  * @retval Returns 0
+  * @retval Status
   */
-uint8_t BSP_SD_ITConfig(void)
+uint8_t BSP_SD_DetectITConfig(void)
 {
   uint8_t sd_state = MSD_OK;
   GPIO_InitTypeDef gpio_init_structure;
@@ -443,9 +396,6 @@ __weak void BSP_SD_MspDeInit(SD_HandleTypeDef *hsd, void *Params)
 
   /* Disable SDIO clock */
   SD_CLK_DISABLE();
-
-  /* GPOI pins clock and DMA cloks can be shut down in the applic
-     by surcgarging this __weak function */
 }
 
 #ifndef STM32L1xx
@@ -485,20 +435,4 @@ void BSP_SD_GetCardInfo(HAL_SD_CardInfoTypeDef *CardInfo)
   HAL_SD_Get_CardInfo(&uSdHandle, CardInfo);
 }
 
-/**
-  * @}
-  */
-
-/**
-  * @}
-  */
-
-/**
-  * @}
-  */
-
-/**
-  * @}
-  */
-
 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/

src/bsp_sd.h

@@ -79,9 +79,9 @@ Please update the core or install previous libray version."
 
 /* SD Exported Functions */
 uint8_t BSP_SD_Init(void);
-uint8_t BSP_SD_CSSet(GPIO_TypeDef *csport, uint32_t cspin);
 uint8_t BSP_SD_DeInit(void);
-uint8_t BSP_SD_ITConfig(void);
+uint8_t BSP_SD_DetectPin(GPIO_TypeDef *port, uint32_t pin);
+uint8_t BSP_SD_DetectITConfig(void);
 #ifndef STM32L1xx
 uint8_t BSP_SD_ReadBlocks(uint32_t *pData, uint32_t ReadAddr, uint32_t NumOfBlocks, uint32_t Timeout);
 uint8_t BSP_SD_WriteBlocks(uint32_t *pData, uint32_t WriteAddr, uint32_t NumOfBlocks, uint32_t Timeout);