Merge pull request #32 from adafruit/update-sdfat-v2.3.0

Update sdfat v2.3.0

Author: hathach

.github/workflows/githubci.yml

@@ -11,6 +11,7 @@ jobs:
           - 'feather_esp32s2'
           - 'feather_esp32s3'
           - 'feather_rp2040'
+          - 'metro_rp2040'
           - 'metro_m0'
           - 'metro_m4'
           - 'nrf52840'
@@ -23,10 +24,10 @@ jobs:
         python-version: '3.x'
 
     - name: Checkout code
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Checkout adafruit/ci-arduino
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
          repository: adafruit/ci-arduino
          path: ci

.gitignore

@@ -1,215 +1,36 @@
-#################
-## Eclipse
-#################
-
-*.pydevproject
-.project
-.metadata
-bin/
-tmp/
-*.tmp
-*.bak
-*.swp
-*~.nib
-local.properties
-.classpath
-.settings/
-.loadpath
-
-# External tool builders
-.externalToolBuilders/
-
-# Locally stored "Eclipse launch configurations"
-*.launch
-
-# CDT-specific
-.cproject
-
-# PDT-specific
-.buildpath
-
-
-#################
-## Visual Studio
-#################
-
-## Ignore Visual Studio temporary files, build results, and
-## files generated by popular Visual Studio add-ons.
-
-# User-specific files
-*.suo
-*.user
-*.sln.docstates
-
-# Build results
-
-[Dd]ebug/
-[Rr]elease/
-x64/
-build/
-[Bb]in/
-[Oo]bj/
-
-# MSTest test Results
-[Tt]est[Rr]esult*/
-[Bb]uild[Ll]og.*
-
-*_i.c
-*_p.c
-*.ilk
-*.meta
-*.obj
-*.pch
-*.pdb
-*.pgc
-*.pgd
-*.rsp
-*.sbr
-*.tlb
-*.tli
-*.tlh
-*.tmp
-*.tmp_proj
-*.log
-*.vspscc
-*.vssscc
-.builds
-*.pidb
-*.log
-*.scc
-
-# Visual C++ cache files
-ipch/
-*.aps
-*.ncb
-*.opensdf
-*.sdf
-*.cachefile
-
-# Visual Studio profiler
-*.psess
-*.vsp
-*.vspx
-
-# Guidance Automation Toolkit
-*.gpState
-
-# ReSharper is a .NET coding add-in
-_ReSharper*/
-*.[Rr]e[Ss]harper
-
-# TeamCity is a build add-in
-_TeamCity*
-
-# DotCover is a Code Coverage Tool
-*.dotCover
-
-# NCrunch
-*.ncrunch*
-.*crunch*.local.xml
-
-# Installshield output folder
-[Ee]xpress/
-
-# DocProject is a documentation generator add-in
-DocProject/buildhelp/
-DocProject/Help/*.HxT
-DocProject/Help/*.HxC
-DocProject/Help/*.hhc
-DocProject/Help/*.hhk
-DocProject/Help/*.hhp
-DocProject/Help/Html2
-DocProject/Help/html
-
-# Click-Once directory
-publish/
-
-# Publish Web Output
-*.Publish.xml
-*.pubxml
-
-# NuGet Packages Directory
-## TODO: If you have NuGet Package Restore enabled, uncomment the next line
-#packages/
-
-# Windows Azure Build Output
-csx
-*.build.csdef
-
-# Windows Store app package directory
-AppPackages/
-
-# Others
-sql/
-*.Cache
-ClientBin/
-[Ss]tyle[Cc]op.*
-~$*
-*~
-*.dbmdl
-*.[Pp]ublish.xml
-*.pfx
-*.publishsettings
-
-# RIA/Silverlight projects
-Generated_Code/
-
-# Backup & report files from converting an old project file to a newer
-# Visual Studio version. Backup files are not needed, because we have git ;-)
-_UpgradeReport_Files/
-Backup*/
-UpgradeLog*.XML
-UpgradeLog*.htm
-
-# SQL Server files
-App_Data/*.mdf
-App_Data/*.ldf
-
-#############
-## Windows detritus
-#############
-
-# Windows image file caches
-Thumbs.db
-ehthumbs.db
-
-# Folder config file
-Desktop.ini
-
-# Recycle Bin used on file shares
-$RECYCLE.BIN/
-
-# Mac crap
+# Windows image file caches
+Thumbs.db
+ehthumbs.db
+
+# Folder config file
+Desktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msm
+*.msp
+
+# =========================
+# Operating System Files
+# =========================
+
+# OSX
+# =========================
+
 .DS_Store
+.AppleDouble
+.LSOverride
 
+# Icon must ends with two \r.
+Icon
 
-#############
-## Python
-#############
-
-*.py[co]
-
-# Packages
-*.egg
-*.egg-info
-dist/
-build/
-eggs/
-parts/
-var/
-sdist/
-develop-eggs/
-.installed.cfg
-
-# Installer logs
-pip-log.txt
-
-# Unit test / coverage reports
-.coverage
-.tox
-
-#Translations
-*.mo
+# Thumbnails
+._*
 
-#Mr Developer
-.mr.developer.cfg
+# Files that might appear on external disk
+.Spotlight-V100
+.Trashes

CMakeLists.txt

@@ -0,0 +1,55 @@
+cmake_minimum_required(VERSION 3.20)
+
+function(adafruit_sdfat_add TARGET)
+  target_sources(${TARGET} PUBLIC
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/FreeStack.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/MinimumSerial.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/common/FmtNumber.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/common/FsCache.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/common/FsDateTime.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/common/FsName.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/common/FsStructs.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/common/FsUtf.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/common/PrintBasic.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/common/upcase.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/common
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/ExFatLib/ExFatDbg.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/ExFatLib/ExFatFile.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/ExFatLib/ExFatFilePrint.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/ExFatLib/ExFatFileWrite.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/ExFatLib/ExFatFormatter.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/ExFatLib/ExFatName.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/ExFatLib/ExFatPartition.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/ExFatLib/ExFatVolume.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/FatLib/FatDbg.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/FatLib/FatFile.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/FatLib/FatFileLFN.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/FatLib/FatFilePrint.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/FatLib/FatFileSFN.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/FatLib/FatFormatter.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/FatLib/FatName.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/FatLib/FatPartition.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/FatLib/FatVolume.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/FsLib/FsFile.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/FsLib/FsNew.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/FsLib/FsVolume.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/iostream/istream.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/iostream/ostream.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/iostream/StdioStream.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/iostream/StreamBaseClass.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/SdCard/Rp2040Sdio/PioSdioCard.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/SdCard/SdCardInfo.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/SdCard/SdSpiCard.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/SdCard/TeensySdio/TeensySdio.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/SpiDriver/SdSpiArtemis.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/SpiDriver/SdSpiChipSelect.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/SpiDriver/SdSpiDue.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/SpiDriver/SdSpiParticle.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/SpiDriver/SdSpiSTM32.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/SpiDriver/SdSpiSTM32Core.cpp
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src/SpiDriver/SdSpiTeensy3.cpp
+    )
+  target_include_directories(${TARGET} PUBLIC
+    ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/src
+    )
+endfunction()

README.md

@@ -1,8 +1,69 @@
-### Warning: This is SdFat Version 2.
+### Warning: This version has major internal changes.
 
-Earlier releases of Version 1 are here:
+SdFat version 2.3.0 has major changes to implement RP2040/RP2350 SDIO.
 
-https://github.com/greiman/SdFat/releases
+In addition there are number of bug fixes.
+
+Begin by running the Rp2040SdioSetup example  to try RP2040/RP2350 SDIO.
+
+This example requires a SDIO Card socket with the following six lines.
+
+* CLK - A clock signal sent to the card by the MCU.
+* CMD - A bidirectional line for for commands and responses.
+* DAT[0:3] - Four bidirectional lines for data transfer.
+CLK and CMD can be connected to any GPIO pins. DAT[0:3] can be connected
+to any four consecutive GPIO pins in the order DAT0, DAT1, DAT2, DAT3.
+
+Here is an example of SDIO for Pico using an Adafruit socket, PiCowbell
+Proto and PiCowbell Proto Doubler.
+
+![Alt text](images/SdioSpi.jpg)
+
+This Socket supports SDIO with:
+```
+#define RP_CLK_GPIO 10
+#define RP_CMD_GPIO 11
+#define RP_DAT0_GPIO 12  // DAT1: GPIO13 DAT2: GPIO14, DAT3: GPIO15.
+```
+It also can be used on SPI1 with:
+```
+const uint8_t SD_CS_PIN = 15;
+#define SD_CONFIG SdSpiConfig(SD_CS_PIN, DEDICATED_SPI, SPI_CLOCK, &SPI1)
+
+  // In setup
+  SPI1.setSCK(10);
+  SPI1.setTX(11);
+  SPI1.setRX(12);
+```
+
+This setup gets the following result in the bench example using SDIO.
+
+<pre>
+FILE_SIZE_MB = 5
+BUF_SIZE = 512 bytes
+Starting write test, please wait.
+
+write speed and latency
+speed,max,min,avg
+KB/Sec,usec,usec,usec
+15014.05,1165,32,32
+15289.54,1249,32,32
+
+Starting read test, please wait.
+
+read speed and latency
+speed,max,min,avg
+KB/Sec,usec,usec,usec
+15624.00,58,32,32
+15624.00,51,32,32
+</pre>
+
+
+File copy constructors and file assignment operators have been made private by
+default in 2.2.3 to prevent call by value and multiple copies of file instances.
+
+SdFatConfig.h has options to make file constructors and assignment operators
+public.
 
 UTF-8 encoded filenames are supported in v2.1.0 or later.