Skip to content

v0.6.0

Choose a tag to compare

@github-actions github-actions released this 13 Nov 05:36
· 25 commits to main since this release

The C ABI changes: one way to open a Node. A Spec says what a function is, a placement says where
it goes on a Device. The wire protocol is unchanged; the firmware has one fix (below).

Hardware-verified on 2026-11-13 (see "Run on a board") for the parts listed there. A 0.5.0
board has to be flashed with this release's firmware, because the library refuses a board of another
minor version.

Run on a board

2026-11-13, a Raspberry Pi Pico (RP2040) flashed with this release's firmware image through
mimusb_device_enter_bootloader, a Prolific PL2303 adapter (7,812,500 baud), the target the same
Linux machine (a VMware guest, both USB devices passed through). Not run: a second machine as the
target, Windows or macOS, the RP2350, the other boards, the mimusb_verify_* programs.

  • hw_bulk wait|newest|oldest, hw_control_rules, hw_composite, hw_bytes bytes|bos, hw_iso,
    hw_cdc: all passed, with no error on the link counters.
  • hw_msc (new): a mass storage function; the kernel's usb-storage found the disk, 4 KiB reads and
    writes matched byte for byte, and the Bulk-Only Mass Storage Reset passed. It failed before the
    firmware fix below: the first CBW after a clear_halt of an endpoint that was not halted was lost.
  • hw_ecm (new): a CDC-ECM network adapter; the kernel made the interface, ARP and ICMP echo of frames
    from 60 to 1514 bytes and 200 full-size round trips passed.
  • hw_dfu, hw_printer (the kernel's usblp bound it), hw_midi (the kernel's snd-usb-audio made a
    sound card) (all new): passed.

Changed

  • mimusb_node_open(device, spec, placement, timeouts, &node) is the only way to open a Node. It
    replaces mimusb_node_open_profile and the old mimusb_node_open(device, node_config, ...).
  • mimusb_node_placement (interface number, string, the endpoints of the Spec's roles) replaces
    mimusb_hid_node_config, which is gone together with mimusb_hid_node_config_init.
    mimusb_node_placement_init and mimusb_placed_endpoint are new.
  • The HID descriptor and Interface descriptor values (bcd_hid, subclass, protocol,
    country_code) moved from the Node's config to the Spec: every HID options structure ends with a
    required mimusb_hid_function function. A zero bcd_hid is MIMUSB_ERR_UNSET_FIELD.
  • Any class of Node is a Spec too: mimusb_spec_create_interfaces(mimusb_node_config*) copies the
    interfaces, items and rules into a Spec of kind MIMUSB_PROFILE_INTERFACES, which is opened with
    an empty placement.

Fixed

  • Firmware (RP2040, RP2350): CLEAR_FEATURE(ENDPOINT_HALT) on an endpoint that was not halted left an
    armed OUT transfer expecting the old data toggle, so the target's next packet (DATA0) was taken for
    a retransmission and dropped. The toggle is now returned to DATA0 at once (USB 2.0 9.4.5), which is
    what a Bulk-Only Mass Storage Reset needs.

Added

  • mimusb_spec_roles lists the endpoint roles of a Spec (MIMUSB_HID_ROLE_IN, required;
    MIMUSB_HID_ROLE_OUT, optional), so a caller sees what its placement must give.
  • Refusals with the field named in mimusb_error_detail: a role given twice or one the Spec does not
    have, a nonzero reserved field, a missing IN role, a non-empty placement for a Spec of interfaces.

Firmware Binary Third-Party Notices

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

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

Firmware asset Third-party components & licenses
mimusb_firmware-rp2040-*, mimusb_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
mimusb_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
mimusb_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
mimusb_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 mimusb_firmware-THIRD_PARTY_NOTICES-0.6.0.txt and in THIRD_PARTY_NOTICES.md / NOTICE.