Skip to content

v0.5.0

Choose a tag to compare

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

Not hardware-verified. Nothing of this release was run on a board: the simulated board (the
firmware core on a fake HAL) and the scripted board cover it. The wire protocol and the firmware
behaviour are unchanged from 0.4.0; the firmware images differ only in the version they report.
The C ABI changes (mimusb_usb_endpoint is 12 bytes, mimusb_usb_interface has settings), so a
program built against 0.4.0 needs the changes below, and the shared library keeps SOVERSION 0
while the version is 0.x.

Added

  • mimusb_cdc_acm_descriptors_make and mimusb_cdc_acm_rules: the class descriptors, the
    Interface Association descriptor and the line-coding control rules of a CDC-ACM function, for a
    Node opened with mimusb_node_open.

Changed

  • An interface of a Node is a list of alternate settings, and a setting is a sequence of
    items
    (mimusb_usb_interface.settings, mimusb_usb_setting, mimusb_usb_item): an endpoint
    or one whole descriptor, in bus order. This replaces class_descriptors, endpoints and
    endpoint_count, and takes class descriptors that sit between or after endpoints (CDC, audio,
    video, MIDI). mimusb_usb_endpoint is 12 bytes: it gains audio_form, refresh,
    synch_address, sync_type and usage_type for the 9-byte audio endpoint form and the
    isochronous synchronization and usage types.

  • A Node can carry isochronous endpoints, in a setting other than 0; INTERFACE_ALTERNATE names
    the Node that owns the interface (node_id). Nodes and Devices given as bytes share one
    endpoint check.

  • Renamed from libmimhid to libmimusb, because the library is no longer about HID alone. Every
    public name changes with it: the mimhid_ prefix is mimusb_, MIMHID_ is MIMUSB_, the
    headers are mimusb.h and mimusb.hpp, the CMake package is mimusb (targets mimusb::mimusb,
    mimusb::mimusb_static, mimusb::cpp), the pkg-config files are mimusb.pc and
    mimusb-static.pc, the CMake options are MIMUSB_*, the Python, Rust and C# packages are
    mimusb, mimusb-sys and MimUsb, and the repository is nemarpuc/libmimusb. The wire
    protocol and the firmware behaviour are unchanged; the names in proto/mimusb_proto.h change
    with the prefix. Code that uses 0.4.0 changes names only.


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