Merge remote-tracking branch 'upstream/master'

Author: Pavlos1

.envrc

@@ -0,0 +1 @@
+use flake .

.github/workflows/build.yml

@@ -2,15 +2,31 @@ name: Build
 on: [push, pull_request]
 
 jobs:
+  check-nix-flake:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: cachix/install-nix-action@v30
+      - name: Check Nix Flake
+        run: nix flake check --print-build-logs
+
+  check-nix-build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: cachix/install-nix-action@v30
+      - name: Build package
+        run: nix build --print-build-logs
+
   build-windows:
     runs-on: windows-2022
     defaults:
       run:
         shell: cmd
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
-          submodules: 'recursive'
+          submodules: "recursive"
       - uses: lukka/get-cmake@latest
       - name: Build blisp tool
         run: |
@@ -19,19 +35,19 @@ jobs:
           cmake .. -DBLISP_BUILD_CLI=ON -DCMAKE_BUILD_TYPE=Release
           cmake --build . --config Release
       - name: Upload results
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
-          name: blips-windows-x86_64.zip
+          name: blips-windows-x86_64
           path: |
             build/tools/blisp/Release/blisp.exe
           if-no-files-found: error
 
   build-macos:
     runs-on: macos-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
-          submodules: 'recursive'
+          submodules: "recursive"
       - uses: lukka/get-cmake@latest
       - name: Build blisp tool
         run: |
@@ -40,19 +56,19 @@ jobs:
           cmake .. -DBLISP_BUILD_CLI=ON -DCMAKE_BUILD_TYPE=Release
           cmake --build .
       - name: Upload results
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
-          name: blips-apple-universal.zip
+          name: blips-apple-universal
           path: |
             build/tools/blisp/blisp
           if-no-files-found: error
 
   build-linux:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
-          submodules: 'recursive'
+          submodules: "recursive"
       - uses: lukka/get-cmake@latest
       - name: Build blisp tool
         run: |
@@ -61,12 +77,12 @@ jobs:
           cmake .. -DBLISP_BUILD_CLI=ON -DCMAKE_BUILD_TYPE=Release
           cmake --build .
       - name: Upload results
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
-          name: blips-linux-x86_64.zip
+          name: blips-linux-x86_64
           path: |
             build/tools/blisp/blisp
-          if-no-files-found: error 
+          if-no-files-found: error
 
   build-linux-alternative-arch:
     runs-on: ubuntu-latest
@@ -83,9 +99,9 @@ jobs:
           - arch: riscv64
             distro: ubuntu_latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
-          submodules: 'recursive'
+          submodules: "recursive"
       - uses: uraimo/run-on-arch-action@v2
         name: Build artifact
         id: build
@@ -133,9 +149,35 @@ jobs:
             echo "Produced artifact at /artifacts/${artifact_name}"
 
       - name: Upload results
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
-          name: blisp-linux-${{ matrix.arch }}.zip
+          name: blisp-linux-${{ matrix.arch }}
           path: |
             artifacts/blisp-*
-          if-no-files-found: error 
+          if-no-files-found: error
+
+  test-linux:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: "recursive"
+      - uses: lukka/get-cmake@latest
+      - name: Build blisp tool & unit tests
+        run: |
+          mkdir build
+          cd build
+          cmake .. -DBLISP_BUILD_CLI=ON -DCOMPILE_TESTS=ON
+          cmake --build .
+      - name: Run unit tests
+        run: |
+          cd build
+          for f in $(find . -type f -executable -iname "*_test"); do
+            echo "Running test file $f"
+            "$f"
+            status=$?
+            if [ $status -ne 0 ]; then
+              echo "Test $f failed with exit code $status"
+              exit $status
+            fi
+          done

.gitignore

@@ -77,4 +77,5 @@ fabric.properties
 .idea/caches/build_file_checksums.ser
 build/
 
-.DS_Store
+.DS_Store
+.cache/

CMakeLists.txt

@@ -1,5 +1,6 @@
 cmake_minimum_required(VERSION 3.16)
-set(CMAKE_OSX_ARCHITECTURES "arm64;x86_64" CACHE STRING "" FORCE)
+list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
+# set(CMAKE_OSX_ARCHITECTURES "arm64;x86_64" CACHE STRING "" FORCE)
 project(blisp C)
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 set(CMAKE_C_STANDARD 11)
@@ -43,19 +44,18 @@ set_target_properties(libblisp_static PROPERTIES
         OUTPUT_NAME "blisp")
 
 if(BLISP_USE_SYSTEM_LIBRARIES)
-    find_package(PkgConfig)
-    pkg_search_module(LIBSERIALPORT REQUIRED libserialport)
-    target_link_libraries(libblisp PUBLIC ${LIBSERIALPORT_LIBRARIES})
-    target_link_libraries(libblisp_static PUBLIC ${LIBSERIALPORT_LIBRARIES})
-    target_include_directories(libblisp_obj PUBLIC ${LIBSERIALPORT_INCLUDE_DIRS})
+    find_package(Libserialport REQUIRED)
+    target_link_libraries(libblisp PUBLIC Libserialport::Libserialport)
+    target_link_libraries(libblisp_static PUBLIC Libserialport::Libserialport)
+    target_include_directories(libblisp_obj PUBLIC ${Libserialport_INCLUDE_DIRS})
 else()
-	if(NOT ${CMAKE_SYSTEM_NAME} STREQUAL "FreeBSD")
-	target_sources(libblisp_obj PRIVATE
+    if(NOT ${CMAKE_SYSTEM_NAME} STREQUAL "FreeBSD")
+        target_sources(libblisp_obj PRIVATE
         ${CMAKE_SOURCE_DIR}/vendor/libserialport/serialport.c
         ${CMAKE_SOURCE_DIR}/vendor/libserialport/timing.c)
 
-	target_include_directories(libblisp_obj PRIVATE ${CMAKE_SOURCE_DIR}/vendor/libserialport)
-	endif()
+        target_include_directories(libblisp_obj PRIVATE ${CMAKE_SOURCE_DIR}/vendor/libserialport)
+    endif()
 
     if(WIN32)
         target_link_libraries(libblisp PRIVATE Setupapi.lib)
@@ -93,7 +93,7 @@ else()
 endif()
 
 include(GNUInstallDirs)
-install(TARGETS libblisp libblisp_static 
+install(TARGETS libblisp libblisp_static
     RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
     LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
     ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
@@ -106,5 +106,21 @@ endif()
 
 
 if(COMPILE_TESTS)
-    add_subdirectory(tools/blisp/src/cmd/dfu/tests)
+    # Bring in googletest & C++
+    enable_language(CXX)
+    enable_testing()
+    include(FetchContent)
+
+
+    FetchContent_Declare(
+        googletest
+        GIT_REPOSITORY https://github.com/google/googletest.git
+        GIT_TAG v1.17.0
+    )
+    FetchContent_MakeAvailable(googletest)
+    add_library(GTest::GTest INTERFACE IMPORTED)
+    target_link_libraries(GTest::GTest INTERFACE gtest_main)
+
+    add_subdirectory(tools/blisp/src/file_parsers/dfu/tests)
+    add_subdirectory(tools/blisp/src/file_parsers/hex/tests)
 endif(COMPILE_TESTS)

Makefile

@@ -0,0 +1,35 @@
+#!/usr/bin/env make -f
+
+### global variables section
+
+# static vars
+BUILD_DIR:="build"
+BUILD_BIN:="$(BUILD_DIR)/tools/blisp/blisp"
+
+# dynamic vars
+FILES_CMAKE:=$(shell find  .  -path ./$(BUILD_DIR) -prune -false  -o  -type f  -name '*.cmake'  -o  -type f  -name 'CMakeLists.txt')
+FILES_SRC:=$(shell   find  .  -path ./$(BUILD_DIR) -prune -false  -o  -type f  -name '*.c'      -o  -type f  -name '*.h')
+
+### main targets section
+
+# simplify build
+build:  $(FILES_CMAKE)  $(FILES_SRC)  Makefile
+	@echo "\n>>>> Generating build files in: $(BUILD_DIR) ...\n"
+	@cmake  -S .  -B $(BUILD_DIR)  -DBLISP_BUILD_CLI=ON
+	@echo "\n>>>> Building...\n"
+	@cmake  --build  $(BUILD_DIR)
+	@echo "\n>>>> DONE: $(BUILD_BIN)\n"
+
+# deleting output build directory with its content
+clean:
+	-@rm -rf $(BUILD_DIR)/
+
+# printf-like debug target
+vars:
+	@echo "\n>>>> FILES_CMAKE:"
+	@echo "$(FILES_CMAKE)" | sed 's, ,\n,g'
+	@echo "\n>>>> FILES_SRC:"
+	@echo "$(FILES_SRC)" | sed 's, ,\n,g'
+
+.PHONY: clean  vars
+

README.md

@@ -4,7 +4,7 @@
 [![GitHub release](https://img.shields.io/github/v/release/pine64/blisp?color=5791ac)](https://github.com/pine64/blisp/releases/tag/v0.0.4)
 
 <img src="./img/Gradient-white-blue-03.png" align="left" width="60" > <br clear="left" />
-# BLISP 
+# BLISP
 
 Bouffalo Labs ISP (in-system-programming) tool & library: an open source tool to flash Bouffalo RISC-V MCUs.
 
@@ -16,13 +16,13 @@ Bouffalo Labs ISP (in-system-programming) tool & library: an open source tool to
 - [x] `bl70x` - BL702 / BL704 / BL706
 <br>
 
-## Supported Devices 
- | System  | <img width="15" src="https://cdn.simpleicons.org/Windows11/5791ac" /> Windows | <img width="15" src="https://cdn.simpleicons.org/Apple/5791ac" /> MacOS| <img width="17" src="https://cdn.simpleicons.org/Linux/5791ac" /> Linux| <img width="15" src="https://cdn.simpleicons.org/Freebsd/5791ac" /> FreeBSD |
+## Supported Devices
+ | System  | <img width="15" src="img/win32.png" /> Windows | <img width="15" src="https://cdn.simpleicons.org/Apple/5791ac" /> MacOS| <img width="17" src="https://cdn.simpleicons.org/Linux/5791ac" /> Linux| <img width="15" src="https://cdn.simpleicons.org/Freebsd/5791ac" /> FreeBSD |
  | :-----: | :------: | :------: | :------: | :------: |
  | Pinecil V2  |<img width="22" src="https://cdn.simpleicons.org/cachet/5791ac" />|<img width="22" src="https://cdn.simpleicons.org/cachet/5791ac" />| <img width="22" src="https://cdn.simpleicons.org/cachet/5791ac" />| <img width="22" src="https://cdn.simpleicons.org/cachet/5791ac" /> |
  | Pinecone  |<img width="22" src="https://cdn.simpleicons.org/cachet/5791ac" />|<img width="22" src="https://cdn.simpleicons.org/cachet/5791ac" />|<img width="22" src="https://cdn.simpleicons.org/cachet/5791ac" />| <img width="22" src="https://cdn.simpleicons.org/cachet/5791ac" /> |
  <br>
- 
+
 ## How to update Pinecil V2
 
 Download the newest release of [Blisp updater here](https://github.com/pine64/blisp/releases/).
@@ -94,6 +94,15 @@ Because this is done at the lowest level of serial communication, the
 displays aren't packet-aware or know about the chip's command set or such.
 This is really only useful for debugging systems-level issues withing
 the device or blisp itself.
+## Running unit tests
+
+```shell
+mkdir build && cd build
+cmake -DBLISP_BUILD_CLI=ON -DCOMPILE_TESTS=ON ..
+cmake --build .
+# Find all compiled unit test files; you can now run these directly
+find . -type f -executable -iname "*_test" -print
+```
 
 ## Troubleshooting
 

blisp.nix

@@ -0,0 +1,49 @@
+{
+  lib,
+  self,
+  stdenv,
+  fetchFromGitHub,
+  argtable,
+  cmake,
+  libserialport,
+  pkg-config,
+  testers,
+  IOKit ? null,
+}:
+
+stdenv.mkDerivation (finalAttrs: {
+  pname = "blisp";
+  version = "0.0.4-unstable";
+  src = self;
+
+  nativeBuildInputs = [
+    cmake
+    pkg-config
+  ];
+
+  buildInputs = [
+    argtable
+    libserialport
+  ] ++ lib.optional stdenv.hostPlatform.isDarwin IOKit;
+
+  cmakeFlags = [
+    "-DBLISP_BUILD_CLI=ON"
+    "-DBLISP_USE_SYSTEM_LIBRARIES=ON"
+  ];
+
+  env.NIX_CFLAGS_COMPILE = lib.optionalString stdenv.hostPlatform.isDarwin "-Wno-error=implicit-function-declaration";
+
+  passthru.tests.version = testers.testVersion {
+    package = finalAttrs.finalPackage;
+    version = "v${finalAttrs.version}";
+  };
+
+  meta = with lib; {
+    description = "In-System-Programming (ISP) tool & library for Bouffalo Labs RISC-V Microcontrollers and SoCs";
+    license = licenses.mit;
+    mainProgram = "blisp";
+    homepage = "https://github.com/pine64/blisp";
+    platforms = platforms.unix;
+    maintainers = [ maintainers.bdd ];
+  };
+})