Merge pull request #4 from fpistm/ffconf_custom

Add several update

Author: fpistm

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`

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;
 

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()

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:

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()

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)
 

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()

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()

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.

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)