dfukit 2.0.0__tar.gz

dfukit-2.0.0/.clang-format

@@ -0,0 +1,20 @@
+# Kernel style: tabs, 8 wide, 100 columns
+---
+BasedOnStyle: LLVM
+AlignConsecutiveMacros: AcrossComments
+AllowShortBlocksOnASingleLine: Never
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortEnumsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: None
+AllowShortIfStatementsOnASingleLine: false
+AllowShortLoopsOnASingleLine: false
+BreakBeforeBraces: Linux
+ColumnLimit: 100
+ContinuationIndentWidth: 8
+IndentCaseLabels: false
+IndentGotoLabels: false
+IndentWidth: 8
+InsertBraces: true
+InsertNewlineAtEOF: true
+SortIncludes: Never
+UseTab: ForContinuationAndIndentation

dfukit-2.0.0/.github/workflows/tests.yml

@@ -0,0 +1,20 @@
+name: Tests
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Test tools
+        run: pip install pytest "nanobind>=2.5"
+      - name: Build
+        run: cmake -S . -B build && cmake --build build
+      - name: Test
+        run: ctest --test-dir build --no-tests=error --output-on-failure

dfukit-2.0.0/.github/workflows/wheels.yml

@@ -0,0 +1,93 @@
+name: Wheels
+
+# A version tag publishes to PyPI and creates the GitHub release. By hand it only builds
+on:
+  workflow_dispatch:
+  push:
+    tags:
+      - "v[0-9]*"
+
+jobs:
+  # Before anything is built: a version without a changelog entry is not released
+  changelog:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Take the version's entry
+        if: github.ref_type == 'tag'
+        run: |
+          version="${GITHUB_REF_NAME#v}"
+          awk -v heading="## [$version]" '
+            /^## \[/ { found = index($0, heading) == 1; next }
+            /^\[[^]]+\]: / { next }
+            found
+          ' CHANGELOG.md > notes.md
+          if ! grep -q '[^[:space:]]' notes.md; then
+            echo "::error file=CHANGELOG.md::No entry for $version"
+            exit 1
+          fi
+      - uses: actions/upload-artifact@v4
+        if: github.ref_type == 'tag'
+        with:
+          name: release-notes
+          path: notes.md
+
+  sdist:
+    needs: changelog
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Build
+        run: pipx run build --sdist
+      - name: Check metadata
+        run: pipx run twine check dist/*
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist-sdist
+          path: dist/*.tar.gz
+
+  wheels:
+    needs: changelog
+    name: Wheels on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-15-intel, macos-14, windows-latest]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pypa/cibuildwheel@v2.23
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist-${{ matrix.os }}
+          path: wheelhouse/*.whl
+
+  publish:
+    if: github.event_name == 'push'
+    needs: [sdist, wheels]
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          path: dist
+          pattern: dist-*
+          merge-multiple: true
+      - uses: pypa/gh-action-pypi-publish@release/v1
+
+  release:
+    needs: publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: release-notes
+      - name: Create the release
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: >
+          gh release create "$GITHUB_REF_NAME" --repo "$GITHUB_REPOSITORY" --verify-tag
+          --title "$GITHUB_REF_NAME" --notes-file notes.md

dfukit-2.0.0/.gitignore

@@ -0,0 +1,6 @@
+build*/
+__pycache__/
+*.egg-info/
+dist/
+.coverage
+.pytest_cache/

dfukit-2.0.0/.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "python.testing.pytestArgs": [
+        "tests"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true
+}

dfukit-2.0.0/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project
+adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [2.0.0] - 2026-11-04
+
+A new protocol and library. Not compatible with dfukit 1.
+
+### Added
+
+- A firmware update protocol for any link: a credit window, go-back-N, resume, a 32-bit board ID
+  per image target, and a CRC-32 of each image
+- A server and a client in C, without threads, heap or platform code
+- A RAM backend, and a pass-through that carries a session to a device further down a chain
+- The CRC-32 as a small module (`lib/crc32`) that an application can replace
+- A Python interface to the server and the client (`dfukit.Server`, `dfukit.Client`)
+- Wheels for Linux, macOS and Windows
+
+[2.0.0]: https://github.com/fvsolutions-dev/dfukit/releases/tag/v2.0.0

dfukit-2.0.0/CMakeLists.txt

@@ -0,0 +1,73 @@
+# An ESP-IDF component when ESP-IDF builds it; a plain CMake project (with the tests) otherwise
+if(ESP_PLATFORM)
+  idf_component_register(
+    SRCS
+      src/dfukit_server.c
+      src/dfukit_client.c
+      lib/crc32/dfukit_crc32.c
+      backends/ram/dfukit_ram.c
+    INCLUDE_DIRS src lib/crc32 backends/ram
+  )
+  return()
+endif()
+
+cmake_minimum_required(VERSION 3.22)
+project(dfukit C)
+
+set(CMAKE_C_STANDARD 99)
+set(CMAKE_C_STANDARD_REQUIRED ON)
+set(CMAKE_POSITION_INDEPENDENT_CODE ON)
+
+set(DFUKIT_SOURCES
+  ${CMAKE_CURRENT_SOURCE_DIR}/src/dfukit_server.c
+  ${CMAKE_CURRENT_SOURCE_DIR}/src/dfukit_client.c
+  ${CMAKE_CURRENT_SOURCE_DIR}/lib/crc32/dfukit_crc32.c
+)
+
+add_library(dfukit STATIC ${DFUKIT_SOURCES})
+target_include_directories(dfukit PUBLIC src lib/crc32)
+if(CMAKE_C_COMPILER_ID MATCHES "GNU|Clang")
+  target_compile_options(dfukit PRIVATE -Werror=implicit-function-declaration)
+  target_compile_options(dfukit PRIVATE -Wall -Wextra -Wconversion -Wno-sign-conversion)
+endif()
+
+add_library(dfukit_ram STATIC backends/ram/dfukit_ram.c)
+target_include_directories(dfukit_ram PUBLIC backends/ram)
+target_link_libraries(dfukit_ram PUBLIC dfukit)
+# Plain C99, as documented: what it does not have is an error
+set_target_properties(dfukit dfukit_ram PROPERTIES C_EXTENSIONS OFF)
+
+# The Python module (python/dfukit_native.cpp, nanobind): dfukit whole, with the ram backend. Tests
+# run through it
+option(DFUKIT_PYTHON "Build the Python module" ${PROJECT_IS_TOP_LEVEL})
+option(DFUKIT_COVERAGE "Measure what the tests cover (tests/README.md)" OFF)
+if(DFUKIT_PYTHON OR SKBUILD)
+  enable_language(CXX)
+  find_package(Python 3.10 REQUIRED COMPONENTS Interpreter Development.Module
+    OPTIONAL_COMPONENTS Development.SABIModule)
+  execute_process(COMMAND "${Python_EXECUTABLE}" -m nanobind --cmake_dir
+    OUTPUT_STRIP_TRAILING_WHITESPACE OUTPUT_VARIABLE NANOBIND_DIR ERROR_QUIET)
+  list(APPEND CMAKE_PREFIX_PATH "${NANOBIND_DIR}")
+  find_package(nanobind CONFIG QUIET)
+  if(nanobind_FOUND)
+    nanobind_add_module(_dfukit STABLE_ABI NB_STATIC
+      ${DFUKIT_SOURCES} backends/ram/dfukit_ram.c python/dfukit_native.cpp)
+    target_include_directories(_dfukit PRIVATE src lib/crc32 backends/ram)
+    if(DFUKIT_COVERAGE)
+      target_compile_options(_dfukit PRIVATE --coverage -O0)
+      target_link_options(_dfukit PRIVATE --coverage)
+    endif()
+    if(SKBUILD)
+      install(TARGETS _dfukit LIBRARY DESTINATION .)
+    endif()
+  else()
+    message(FATAL_ERROR "No nanobind: the tests need it. Install it, or -DDFUKIT_PYTHON=OFF")
+  endif()
+endif()
+
+if(PROJECT_IS_TOP_LEVEL AND NOT SKBUILD)
+  include(CTest)
+  if(BUILD_TESTING)
+    add_subdirectory(tests)
+  endif()
+endif()