Skip to content

v0.4.0

Choose a tag to compare

@github-actions github-actions released this 12 Nov 12:15
· 45 commits to main since this release

Not hardware-verified as tests/hw/README.md defines it; what was run on a board is listed under
"Run on a board" below.
The wire protocol changes (a new event, a new bit in the PONG's
transfer_types): a 0.3.x board and this library do not talk to each other, and the firmware of
this release is needed to use isochronous endpoints.

Run on a board

2026-11-12, a Raspberry Pi Pico (RP2040), a Prolific PL2303 adapter, a Windows 10 machine as the
target. Not run: Linux, macOS or Android as the target, the RP2350, the other boards, audio
classes, an isochronous OUT endpoint, the mimhid_verify_* programs.

  • A UVC camera (128x96 YUY2, 256-byte isochronous packets, descriptors as bytes) enumerated by
    Windows, opened by its camera application, and streamed: four openings and closings of the
    stream in a row, then a program restart with the stream open, three times, with no stop of the
    board and no error on the link counters.
  • Before the fix under "Fixed", the second opening of the stream stopped the board (its USB core:
    commands that run there timed out while the serial link still answered) until it was unplugged.

Added

  • Alternate settings and isochronous endpoints in a Device given as bytes
    (mimhid_device_set_descriptors): interfaces may have settings 0, 1, 2, ... in order, an endpoint
    may be named by several settings of its interface, and a board whose transfer_types has
    MIMHID_TRANSFER_ISOCHRONOUS (the RP2040 and RP2350 firmware: packets up to 1023 bytes) takes
    isochronous endpoints, which is what the audio and video classes stream on. Endpoint descriptors
    may be 7 bytes or the 9-byte audio-class form. The target's SET_INTERFACE switches the
    isochronous endpoints of the interface and is reported as MIMHID_EVENT_INTERFACE_ALTERNATE
    (wire event SET_INTERFACE, 14); GET_INTERFACE answers the selected setting. The board adds
    nothing to a stream: no padding, no pacing, no resampling.
  • mimhid_device_endpoint_write refuses an isochronous transfer longer than the endpoint's packet.
  • Simulated-board scenario mimhid.sim-iso, host walker and firmware tests for settings and
    isochronous descriptors.

Fixed

  • A target that leaves an alternate setting with an isochronous endpoint and selects it again (a
    camera application closed and opened again) stopped the RP2040 and RP2350 board: the transfer
    armed on the controller was never taken by the target, and TinyUSB's driver stops with "ep was
    already available" when the next one is armed on top of it. SET_INTERFACE now takes the armed
    transfer off the controller of every isochronous endpoint it stops or starts
    (hal_usb_clear_endpoint). Seen on a board: four openings and closings of a UVC stream in a row,
    and a detach while streaming followed by three attaches, with no stop; before, the second opening
    stopped the board until it was unplugged.

Changed

  • A Node still has bulk and interrupt endpoints only: an isochronous transfer_type in a Node is
    MIMHID_ERR_UNSUPPORTED (it needs settings, which a Device given as bytes has).
  • On a board with isochronous endpoints max_transfer_bytes is its isochronous packet (1023, 64
    before), so a long write to a bulk endpoint goes in frames of up to 960 bytes (a multiple of the
    endpoint's packet size) instead of 64; the target sees the same transfer.
  • A configuration for the RP2040 and RP2350 is checked against the controller's 3712 bytes of
    packet memory at COMMIT (NAK_OVERFLOW): the driver stopped the board when it ran out.
  • The wire protocol gains an event and the PONG's transfer_types a bit; the firmware version
    number is not changed here (the release's to choose).

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.4.0.txt and in THIRD_PARTY_NOTICES.md / NOTICE.