Add Block Device Support

BUILD.bazel

@@ -147,6 +147,8 @@ cc_binary(
         "//errors",
         "//lib/nlohmann_json:json",
         "//picoboot_connection",
+        "//lib/littlefs",
+        "//lib/oofatfs:fatfs",
         "@libusb",
         "@pico-sdk//src/common/boot_picobin_headers",
         "@pico-sdk//src/common/boot_picoboot_headers",

CMakeLists.txt

@@ -57,6 +57,7 @@ endif()
 list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_LIST_DIR}/cmake)
 
 add_subdirectory(lib)
+suppress_oofatfs_warnings()
 
 if (NOT DEFINED USE_PRECOMPILED)
     set(USE_PRECOMPILED true)
@@ -340,6 +341,8 @@ else()
     target_compile_definitions(picotool PRIVATE HAS_LIBUSB=1)
     target_link_libraries(picotool 
         picoboot_connection_cxx
+        fatfs
+        littlefs
         ${LIBUSB_LIBRARIES})
 endif()
 

bdev_test.sh

@@ -0,0 +1,79 @@
+#!/bin/bash
+
+set -e
+
+cat >tmppt.json << EOL
+{
+    "version": [1, 0],
+    "unpartitioned": {
+        "families": ["absolute"],
+        "permissions": {
+            "secure": "rw",
+            "nonsecure": "rw",
+            "bootloader": "rw"
+        }
+    },
+    "partitions": [
+        {
+            "name": "Filesystem",
+            "id": "0x626C6F636B646576",
+            "size": "100K",
+            "families": [],
+            "permissions": {
+                "secure": "rw",
+                "nonsecure": "rw",
+                "bootloader": "rw"
+            }
+        }
+    ]
+}
+EOL
+
+picotool erase || true
+picotool reboot
+while ! picotool info; do sleep 1; done
+
+picotool partition create tmppt.json tmppt.bin
+picotool load -x tmppt.bin
+while ! picotool info; do sleep 1; done
+
+declare -a filesystems=("littlefs" "fatfs")
+for filesystem in "${filesystems[@]}"
+do
+    picotool bdev format --filesystem $filesystem
+
+    echo "this is file 1" > tmpfile1.txt
+    echo "this is file 2" > tmpfile2.txt
+    picotool bdev cp tmpfile1.txt :/
+    picotool bdev cp tmpfile2.txt :/
+    picotool bdev ls | grep "tmpfile2.txt"
+    picotool bdev rm tmpfile2.txt
+    if picotool bdev ls | grep "tmpfile2.txt"; then
+        echo "Error: tmpfile2.txt was not deleted"
+        exit 1
+    fi
+    picotool bdev cat tmpfile1.txt
+    picotool bdev cat tmpfile1.txt > tmpfile1.txt.device
+
+    if ! cmp -s tmpfile1.txt tmpfile1.txt.device; then
+        echo "Error: tmpfile1.txt content has changed"
+        exit 1
+    fi
+
+    echo "this is new file 2" > tmpfile2.txt
+    picotool bdev cp tmpfile2.txt :/
+    picotool bdev cat tmpfile2.txt
+    picotool bdev cat tmpfile2.txt > tmpfile2.txt.device
+
+    if ! cmp -s tmpfile2.txt tmpfile2.txt.device; then
+        echo "Error: tmpfile2.txt content has changed"
+        exit 1
+    fi
+done
+
+rm tmpfile1.txt
+rm tmpfile1.txt.device
+rm tmpfile2.txt
+rm tmpfile2.txt.device
+rm tmppt.json
+rm tmppt.bin

lib/CMakeLists.txt

@@ -18,6 +18,9 @@ endif()
 set(JSON_BuildTests OFF CACHE INTERNAL "")
 add_subdirectory(nlohmann_json EXCLUDE_FROM_ALL)
 
+add_subdirectory(oofatfs EXCLUDE_FROM_ALL)
+add_subdirectory(littlefs EXCLUDE_FROM_ALL)
+
 add_subdirectory(whereami EXCLUDE_FROM_ALL)
 
 # Taken from pico-sdk/src/rp2_common/pico_mbedtls/CMakeLists.txt

lib/littlefs/BUILD.bazel

@@ -0,0 +1,16 @@
+load("@rules_cc//cc:cc_library.bzl", "cc_library")
+
+package(default_visibility = ["//visibility:public"])
+
+cc_library(
+    name = "littlefs",
+    srcs = [
+        "lfs.c",
+        "lfs_util.c",
+    ],
+    hdrs = [
+        "lfs.h",
+        "lfs_util.h",
+    ],
+    includes = ["."],
+)

lib/littlefs/CMakeLists.txt

@@ -0,0 +1,9 @@
+add_library(littlefs INTERFACE)
+
+target_sources(littlefs INTERFACE
+        ${CMAKE_CURRENT_LIST_DIR}/lfs.c
+        ${CMAKE_CURRENT_LIST_DIR}/lfs_util.c)
+
+target_include_directories(littlefs INTERFACE ${CMAKE_CURRENT_LIST_DIR})
+
+target_compile_definitions(littlefs INTERFACE LFS_NO_ERROR=1 LFS_NO_WARN=1 LFS_NO_DEBUG=1)

lib/littlefs/LICENSE.md

@@ -0,0 +1,25 @@
+Copyright (c) 2022, The littlefs authors.  
+Copyright (c) 2017, Arm Limited. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+-  Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+-  Redistributions in binary form must reproduce the above copyright notice, this
+   list of conditions and the following disclaimer in the documentation and/or
+   other materials provided with the distribution.
+-  Neither the name of ARM nor the names of its contributors may be used to
+   endorse or promote products derived from this software without specific prior
+   written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

lib/littlefs/README.md

@@ -0,0 +1,7 @@
+littlefs library
+================
+
+The upstream source for the files in this directory is
+https://github.com/littlefs-project/littlefs
+
+The current files come from v2.11.1