Repository navigation
v0.2.1
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
optionsorconfigpointer to the ninemimhid_spec_create_*factories,mimhid_device_open,
mimhid_node_open,mimhid_node_open_raw, or the calls takingmimhid_commit_timeoutsnow
populatesmimhid_last_error()withMIMHID_ERR_PARAMand the structure name instead of leaving
the thread-local error detail atMIMHID_OK. - Frame type names.
mimhid_frame_type_namenow returns"PROBE"forMIMHID_T_PROBE
(0x1C) and"COUNTERS"forMIMHID_T_COUNTERS(0x1D). - 3-byte detach
COMMITon close.mimhid_device_closenow sends the standard 3-byte
{1, 0, 0}detachCOMMITpayload matchingLink::disconnectandcommit_deviceinstead of a
1-byte{1}payload. device->closingcheck across all device calls.mimhid_device_wait_ready,
mimhid_device_remote_wakeup,mimhid_device_board_info,mimhid_device_link_counters, and
mimhid_device_limitsnow reject a closingmimhid_device*withMIMHID_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 measuressrc/with gcovr.tests/README.mddescribes
the unit, scripted, sim and hardware layers;tests/hw/README.mdis the hardware procedure;
docs/VERIFICATION.mdsummarizes what is verified across all four layers. - The release no longer publishes
*-runtimebundles. The*-sharedarchive 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 nowlibmimhid-X.Y.Z-<platform>-<arch>[-ubuntu22.04].tar.gz|zip, without the-shared/
-staticsuffix, and holds both libraries (the static one islibmimhid_static.a/
mimhid_static.lib), the CMake package files of both components and both pkg-config files;
find_package(mimhid COMPONENTS shared)andCOMPONENTS staticboth work from it. The twelve
.spdx.jsonsidecars are replaced bylibmimhid-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 aworkflow_dispatchdry 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.