Skip to content

v0.2.1

Choose a tag to compare

@github-actions github-actions released this 10 Nov 12:49
· 75 commits to main since this release

Not hardware-verified. The wire protocol and the C ABI are those of 0.2.0 (a 0.2.0 board and this library
talk to each other); this release fixes four bugs, changes the release packaging and adds tests and
documentation. None of it has run on a board. Asset names changed: a script that downloads the old
-shared / -static names must be changed.

Fixed

  • Null options and configuration pointers are recorded in mimhid_last_error. Passing a null
    options or config pointer to the nine mimhid_spec_create_* factories, mimhid_device_open,
    mimhid_node_open, mimhid_node_open_raw, or the calls taking mimhid_commit_timeouts now
    populates mimhid_last_error() with MIMHID_ERR_PARAM and the structure name instead of leaving
    the thread-local error detail at MIMHID_OK.
  • Frame type names. mimhid_frame_type_name now returns "PROBE" for MIMHID_T_PROBE
    (0x1C) and "COUNTERS" for MIMHID_T_COUNTERS (0x1D).
  • 3-byte detach COMMIT on close. mimhid_device_close now sends the standard 3-byte
    {1, 0, 0} detach COMMIT payload matching Link::disconnect and commit_device instead of a
    1-byte {1} payload.
  • device->closing check across all device calls. mimhid_device_wait_ready,
    mimhid_device_remote_wakeup, mimhid_device_board_info, mimhid_device_link_counters, and
    mimhid_device_limits now reject a closing mimhid_device* with MIMHID_ERR_PARAM, matching
    the other device operations.

Changed

  • Tests. A scripted board on a pseudo-terminal (mimhid.scripted) tests the transport and the C
    ABI when the board NAKs, stays silent, refuses a rate or hangs up; new unit suites cover every
    factory and input refusal. The pseudo-terminal tests of the real firmware core are now called
    sim (mimhid.sim-*). A Coverage CI job measures src/ with gcovr. tests/README.md describes
    the unit, scripted, sim and hardware layers; tests/hw/README.md is the hardware procedure;
    docs/VERIFICATION.md summarizes what is verified across all four layers.
  • The release no longer publishes *-runtime bundles. The *-shared archive already carries the
    shared library with the same license documents, and nothing in the project consumed the smaller
    bundle. A release now has 35 assets instead of 41.
  • One archive per platform, one SBOM per release; asset names change. Each platform's archive
    is now libmimhid-X.Y.Z-<platform>-<arch>[-ubuntu22.04].tar.gz|zip, without the -shared /
    -static suffix, and holds both libraries (the static one is libmimhid_static.a /
    mimhid_static.lib), the CMake package files of both components and both pkg-config files;
    find_package(mimhid COMPONENTS shared) and COMPONENTS static both work from it. The twelve
    .spdx.json sidecars are replaced by libmimhid-X.Y.Z.spdx.json, one SPDX 2.3 document with a
    package per archive. A release has 18 assets instead of 35; a script that downloads the old
    names must be changed. The release workflow also gained a workflow_dispatch dry run
    (dry_run, on by default) that builds and checks every asset and keeps them as a workflow
    artifact without publishing anything.

Firmware Binary Third-Party Notices

The host library (libmimhid) is licensed under the MIT License and has no third-party runtime library dependencies.

Prebuilt microcontroller firmware images (mimhid_firmware-*) incorporate third-party SDK and USB stack components under permissive licenses:

Firmware asset Third-party components & licenses
mimhid_firmware-rp2040-*, mimhid_firmware-rp2350-* TinyUSB 0.18.0 (MIT), Raspberry Pi Pico SDK 2.2.0 (BSD-3-Clause, Copyright (c) 2020 Raspberry Pi (Trading) Ltd.), Arm CMSIS Core (Apache-2.0), Newlib C runtime
mimhid_firmware-nrf52840-* TinyUSB 0.18.0 (MIT), Nordic Semiconductor nrfx (BSD-3-Clause, Copyright (c) 2017-2024 Nordic Semiconductor ASA), Arm CMSIS 5 (Apache-2.0), Newlib C runtime
mimhid_firmware-stm32f4-* TinyUSB 0.18.0 (MIT), STMicroelectronics cmsis_device_f4 & stm32f4xx_hal_driver (BSD-3-Clause / Apache-2.0, Copyright (c) 2016-2019 STMicroelectronics), Arm CMSIS 5 (Apache-2.0), Newlib C runtime
mimhid_firmware-esp32s3-* TinyUSB 0.18.0 (MIT), Espressif ESP-IDF v5.4.2 (Apache-2.0, Copyright 2015-2025 Espressif Systems), Amazon FreeRTOS Kernel (MIT), Newlib C runtime

Complete copyright notices, license texts, and warranty disclaimers for all firmware binaries are provided in the release asset mimhid_firmware-THIRD_PARTY_NOTICES-0.2.1.txt and in THIRD_PARTY_NOTICES.md / NOTICE.