Merge pull request #4 from fpistm/ffconf_custom

fpistm · web-flow · commit 94eca6716e6d · 2018-09-19T09:45:40.000+02:00
Add several update
diff --git a/README.md b/README.md
@@ -1,6 +1,4 @@
-# STM32SD
-
-## SD library for Arduino
+# STM32 SD library for Arduino
 
 With an STM32 board with SD card slot availability, this library enables
 reading and writing on SD card using SD card slot of a STM32 board (NUCLEO, DISCOVERY, ...).
@@ -10,9 +8,25 @@ This library follow Arduino API.
 For more information about it, please visit:
 http://www.arduino.cc/en/Reference/SD
 
-## Note
+## Dependency
 
-The library is based on FatFs, a generic FAT file system module for small embedded systems.  
+This library is based on FatFs, a generic FAT file system module for small embedded systems.  
 [http://elm-chan.org/fsw/ff](http://elm-chan.org/fsw/ff/00index_e.html)
 
-The FatFs has been ported as Arduino library [here](https://github.com/stm32duino/FatFs). The STM32SD library depends on it.
+The FatFs has been ported as Arduino library [here](https://github.com/stm32duino/FatFs).
+The STM32SD library depends on it.
+
+## Configuration
+
+### FatFs
+The FatFs has several user defined options, which is specified from within the `ffconf.h` file.
+
+This library provides a default user defined options file named `ffconf_default.h`.
+
+User can provide his own defined options by adding his configuration in a file named
+`ffconf_custom.h` at sketch level or in variant folder.
+
+### SD detect and timeout
+* `SD_DETECT_PIN` pin number can be defined in `variant.h` or using `build_opt.h`.
+
+* `SD_DATATIMEOUT` constant for Read/Write block could be redefined in `variant.h` or using `build_opt.h`
diff --git a/examples/CardInfo/CardInfo.ino b/examples/CardInfo/CardInfo.ino
@@ -11,6 +11,12 @@
 // include the SD library:
 #include <STM32SD.h>
 
+// If SD card slot has no detect pin then define it as SD_DETECT_NONE
+// to ignore it. One other option is to call 'card.init()' without parameter.
+#ifndef SD_DETECT_PIN
+#define SD_DETECT_PIN SD_DETECT_NONE
+#endif
+
 Sd2Card card;
 SdFatFs fatFs;
 
diff --git a/examples/Datalogger/Datalogger.ino b/examples/Datalogger/Datalogger.ino
@@ -12,6 +12,12 @@
 
 #include <STM32SD.h>
 
+// If SD card slot has no detect pin then define it as SD_DETECT_NONE
+// to ignore it. One other option is to call 'SD.begin()' without parameter.
+#ifndef SD_DETECT_PIN
+#define SD_DETECT_PIN SD_DETECT_NONE
+#endif
+
 uint32_t A[] = { A0, A1, A2};
 
 void setup()
diff --git a/examples/DumpFile/DumpFile.ino b/examples/DumpFile/DumpFile.ino
@@ -13,6 +13,12 @@
 
 #include <STM32SD.h>
 
+// If SD card slot has no detect pin then define it as SD_DETECT_NONE
+// to ignore it. One other option is to call 'SD.begin()' without parameter.
+#ifndef SD_DETECT_PIN
+#define SD_DETECT_PIN SD_DETECT_NONE
+#endif
+
 void setup()
 {
   // Open serial communications and wait for port to open:
diff --git a/examples/Files/Files.ino b/examples/Files/Files.ino
@@ -10,6 +10,12 @@
  */
 #include <STM32SD.h>
 
+// If SD card slot has no detect pin then define it as SD_DETECT_NONE
+// to ignore it. One other option is to call 'SD.begin()' without parameter.
+#ifndef SD_DETECT_PIN
+#define SD_DETECT_PIN SD_DETECT_NONE
+#endif
+
 File myFile;
 
 void setup()
diff --git a/examples/Full/Full.ino b/examples/Full/Full.ino
@@ -1,5 +1,11 @@
 #include <STM32SD.h>
 
+// If SD card slot has no detect pin then define it as SD_DETECT_NONE
+// to ignore it. One other option is to call 'SD.begin()' without parameter.
+#ifndef SD_DETECT_PIN
+#define SD_DETECT_PIN SD_DETECT_NONE
+#endif
+
 #define COUNTOF(__BUFFER__)   (sizeof(__BUFFER__) / sizeof(*(__BUFFER__)))
 #define BUFFERSIZE                       (COUNTOF(wtext) -1)
 
diff --git a/examples/ReadWrite/ReadWrite.ino b/examples/ReadWrite/ReadWrite.ino
@@ -11,6 +11,12 @@
 
 #include <STM32SD.h>
 
+// If SD card slot has no detect pin then define it as SD_DETECT_NONE
+// to ignore it. One other option is to call 'SD.begin()' without parameter.
+#ifndef SD_DETECT_PIN
+#define SD_DETECT_PIN SD_DETECT_NONE
+#endif
+
 File myFile;
 
 void setup()
diff --git a/examples/listfiles/listfiles.ino b/examples/listfiles/listfiles.ino
@@ -12,6 +12,12 @@
  */
 #include <STM32SD.h>
 
+// If SD card slot has no detect pin then define it as SD_DETECT_NONE
+// to ignore it. One other option is to call 'SD.begin()' without parameter.
+#ifndef SD_DETECT_PIN
+#define SD_DETECT_PIN SD_DETECT_NONE
+#endif
+
 File root;
 
 void setup()
diff --git a/library.properties b/library.properties
@@ -1,5 +1,5 @@
 name=STM32duino STM32SD
-version=1.0.1
+version=1.1.0
 author=Several
 maintainer=stm32duino
 sentence=Enables reading and writing on SD card using SD card slot of the STM32 Board.
diff --git a/src/SD.cpp b/src/SD.cpp
@@ -59,38 +59,17 @@ SDClass SD;
 
 /**
   * @brief  Link SD, register the file system object to the FatFs mode and configure
-  *         relatives SD IOs except SD Detect Pin
+  *         relatives SD IOs including SD Detect Pin if any
   * @param  None
   * @retval TRUE or FALSE
   */
-uint8_t SDClass::begin()
-{
-	/*##-1- Initializes SD IOs #############################################*/
-	if (_card.init()) {
-		return _fatFs.init();
-    }
-    else
-    {
-	  return FALSE;
-    }
-}
-
-/**
-  * @brief  Link SD, register the file system object to the FatFs mode and configure
-  *         relatives SD IOs including SD Detect Pin
-  * @param  None
-  * @retval TRUE or FALSE
-  */
-uint8_t SDClass::begin(uint8_t cspin)
+uint8_t SDClass::begin(uint32_t cspin)
 {
 	/*##-1- Initializes SD IOs #############################################*/
 	if (_card.init(cspin)) {
 		return _fatFs.init();
     }
-    else
-    {
-	  return FALSE;
-    }
+    return FALSE;
 }
 
 /**
@@ -593,11 +572,9 @@ uint8_t File::isDirectory()
 		{
 			return TRUE;
 		}
-		else
-		{
-			return FALSE;
-		}
 	}
+	// Assume not a directory
+	return FALSE;
 }
 
 File File::openNextFile(uint8_t mode)
diff --git a/src/STM32SD.h b/src/STM32SD.h
@@ -78,8 +78,7 @@ class SDClass {
 public:
 
   /* Initialize the SD peripheral */
-  uint8_t begin();
-  uint8_t begin(uint8_t cspin);
+  uint8_t begin(uint32_t cspin = 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);
diff --git a/src/Sd2Card.cpp b/src/Sd2Card.cpp
@@ -37,22 +37,20 @@
 #include <Arduino.h>
 #include "Sd2Card.h"
 
-uint8_t Sd2Card::init(void) {
-	if (BSP_SD_Init() == MSD_OK) {
-		BSP_SD_GetCardInfo(&_SdCardInfo);
-		return TRUE;
-	} else {
-		return FALSE;
+uint8_t Sd2Card::init(uint32_t cspin) {
+	if(cspin != SD_DETECT_NONE) {
+		PinName p = digitalPinToPinName(cspin);
+		if((p == NC) ||\
+		   BSP_SD_CSSet(set_GPIO_Port_Clock(STM_PORT(p)),
+						 STM_GPIO_PIN(p)) != MSD_OK) {
+			return FALSE;
+		}
 	}
-}
-
-uint8_t Sd2Card::init(uint8_t cspin) {
-	if (BSP_SD_CSInit() == MSD_OK) {
+	if (BSP_SD_Init() == MSD_OK) {
 		BSP_SD_GetCardInfo(&_SdCardInfo);
 		return TRUE;
-	} else {
-		return FALSE;
 	}
+	return FALSE;
 }
 
 uint8_t Sd2Card::type(void) const {
diff --git a/src/Sd2Card.h b/src/Sd2Card.h
@@ -56,8 +56,7 @@
 class Sd2Card {
  public:
 
-  uint8_t init(void);
-  uint8_t init(uint8_t cspin);
+  uint8_t init(uint32_t cspin = SD_DETECT_NONE);
 
   /** Return the card type: SD V1, SD V2 or SDHC */
   uint8_t type(void) const;
diff --git a/src/bsp_sd.c b/src/bsp_sd.c
diff --git a/src/bsp_sd.h b/src/bsp_sd.h
diff --git a/src/ffconf.h b/src/ffconf.h
diff --git a/src/ffconf_default.h b/src/ffconf_default.h
