From 4c821f783a855095a1be5a6943f4aa80dad2ae53 Mon Sep 17 00:00:00 2001 From: Ali Bross Date: Fri, 10 Jul 2026 15:19:23 +0100 Subject: [PATCH] feat: ship a self-contained macOS flasher --- .github/scripts/build-dfu-util-macos.sh | 66 ++++ .github/workflows/ci.yml | 1 + .github/workflows/release.yml | 16 +- .gitignore | 2 + BUILD_PLAN.md | 7 +- CHANGELOG.md | 31 +- README.md | 21 +- docs/THIRD_PARTY_NOTICES.md | 36 ++ docs/licenses/dfu-util-GPL-2.0.txt | 341 ++++++++++++++++ docs/licenses/libusb-LGPL-2.1.txt | 503 ++++++++++++++++++++++++ package-lock.json | 4 +- package.json | 2 +- src-tauri/Cargo.lock | 75 +++- src-tauri/Cargo.toml | 3 +- src-tauri/src/flash.rs | 140 ++++++- src-tauri/src/lib.rs | 7 + src-tauri/tauri.conf.json | 2 +- src-tauri/tauri.release.conf.json | 14 + src/App.tsx | 47 ++- src/backend.ts | 12 + src/types.ts | 7 + 21 files changed, 1290 insertions(+), 47 deletions(-) create mode 100755 .github/scripts/build-dfu-util-macos.sh create mode 100644 docs/THIRD_PARTY_NOTICES.md create mode 100644 docs/licenses/dfu-util-GPL-2.0.txt create mode 100644 docs/licenses/libusb-LGPL-2.1.txt create mode 100644 src-tauri/tauri.release.conf.json diff --git a/.github/scripts/build-dfu-util-macos.sh b/.github/scripts/build-dfu-util-macos.sh new file mode 100755 index 0000000..27bf3bb --- /dev/null +++ b/.github/scripts/build-dfu-util-macos.sh @@ -0,0 +1,66 @@ +#!/usr/bin/env bash +set -euo pipefail + +readonly DFU_UTIL_VERSION="0.11" +readonly DFU_UTIL_SHA256="b4b53ba21a82ef7e3d4c47df2952adf5fa494f499b6b0b57c58c5d04ae8ff19e" +readonly DFU_UTIL_URL="https://dfu-util.sourceforge.net/releases/dfu-util-${DFU_UTIL_VERSION}.tar.gz" +readonly LIBUSB_VERSION="1.0.30" +readonly LIBUSB_SHA256="fea36f34f9156400209595e300840767ab1a385ede1dc7ee893015aea9c6dbaf" +readonly LIBUSB_URL="https://github.com/libusb/libusb/releases/download/v${LIBUSB_VERSION}/libusb-${LIBUSB_VERSION}.tar.bz2" +readonly TARGET_TRIPLE="aarch64-apple-darwin" +readonly ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd)" +readonly WORK_DIR="${RUNNER_TEMP:-${TMPDIR:-/tmp}}/touch-manager-dfu-util" +readonly ARCHIVE="${WORK_DIR}/dfu-util-${DFU_UTIL_VERSION}.tar.gz" +readonly LIBUSB_ARCHIVE="${WORK_DIR}/libusb-${LIBUSB_VERSION}.tar.bz2" +readonly SOURCE_DIR="${WORK_DIR}/dfu-util-${DFU_UTIL_VERSION}" +readonly LIBUSB_SOURCE_DIR="${WORK_DIR}/libusb-${LIBUSB_VERSION}" +readonly LIBUSB_PREFIX="${WORK_DIR}/libusb-static" +readonly OUTPUT_DIR="${ROOT_DIR}/src-tauri/binaries" +readonly OUTPUT="${OUTPUT_DIR}/dfu-util-${TARGET_TRIPLE}" +readonly SOURCE_ASSET_DIR="${ROOT_DIR}/release-assets" + +if [[ "$(uname -m)" != "arm64" ]]; then + echo "The Apple Silicon release helper must run on an arm64 macOS runner." >&2 + exit 1 +fi + +rm -rf "${WORK_DIR}" +mkdir -p "${WORK_DIR}" "${OUTPUT_DIR}" "${SOURCE_ASSET_DIR}" + +curl --fail --location --retry 3 --silent --show-error "${DFU_UTIL_URL}" --output "${ARCHIVE}" +echo "${DFU_UTIL_SHA256} ${ARCHIVE}" | shasum -a 256 --check +curl --fail --location --retry 3 --silent --show-error "${LIBUSB_URL}" --output "${LIBUSB_ARCHIVE}" +echo "${LIBUSB_SHA256} ${LIBUSB_ARCHIVE}" | shasum -a 256 --check +tar -xzf "${ARCHIVE}" -C "${WORK_DIR}" +tar -xjf "${LIBUSB_ARCHIVE}" -C "${WORK_DIR}" + +cd "${LIBUSB_SOURCE_DIR}" +./configure --disable-shared --enable-static --prefix="${LIBUSB_PREFIX}" +make -j"$(sysctl -n hw.logicalcpu)" +make install + +cd "${SOURCE_DIR}" +USB_CFLAGS="-I${LIBUSB_PREFIX}/include/libusb-1.0" \ +USB_LIBS="${LIBUSB_PREFIX}/lib/libusb-1.0.a -framework IOKit -framework CoreFoundation -framework Security" \ + ./configure --disable-silent-rules +make -j"$(sysctl -n hw.logicalcpu)" + +install -m 0755 src/dfu-util "${OUTPUT}" +strip "${OUTPUT}" +# Tauri copies sidecars into the Cargo target directory. Remove any prior copy so a +# rebuilt helper can never be silently replaced by a stale cached executable. +rm -f "${ROOT_DIR}/src-tauri/target/${TARGET_TRIPLE}/release/dfu-util" +"${OUTPUT}" --version +file "${OUTPUT}" | grep -q "Mach-O 64-bit executable arm64" + +if otool -L "${OUTPUT}" | grep -E '/(opt/homebrew|usr/local)/|libusb'; then + echo "Bundled dfu-util unexpectedly depends on a non-system dynamic library." >&2 + exit 1 +fi + +install -m 0644 "${ARCHIVE}" "${SOURCE_ASSET_DIR}/dfu-util-${DFU_UTIL_VERSION}.tar.gz" +install -m 0644 "${LIBUSB_ARCHIVE}" "${SOURCE_ASSET_DIR}/libusb-${LIBUSB_VERSION}.tar.bz2" +shasum -a 256 \ + "${OUTPUT}" \ + "${SOURCE_ASSET_DIR}/dfu-util-${DFU_UTIL_VERSION}.tar.gz" \ + "${SOURCE_ASSET_DIR}/libusb-${LIBUSB_VERSION}.tar.bz2" diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index f4e61aa..422d9ca 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -37,6 +37,7 @@ jobs: workspaces: src-tauri - run: npm ci + - run: bash -n .github/scripts/build-dfu-util-macos.sh - run: npm test - run: npm run build - run: cargo fmt --all -- --check diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 75aef5a..17e5204 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -24,6 +24,9 @@ jobs: with: targets: aarch64-apple-darwin + - name: Build self-contained flashing engine + run: .github/scripts/build-dfu-util-macos.sh + - run: npm ci - name: Build and publish DMG @@ -34,10 +37,17 @@ jobs: tagName: ${{ github.ref_name }} releaseName: Touch Manager ${{ github.ref_name }} releaseBody: | - Apple Silicon development preview. + Self-contained Apple Silicon development preview. + + The flashing engine is included; Homebrew and Terminal setup are not required. This build is not Apple-notarized. On first launch, Control-click Touch Manager and choose Open. - This build is not Apple-notarized. On first launch, Control-click Touch Manager and choose Open. Install dfu-util separately with Homebrew before flashing hardware. + Touch Manager includes dfu-util 0.11 under GPL-2.0-or-later and statically linked libusb 1.0.30 under LGPL-2.1-or-later. Their exact corresponding source archives are attached to this release. prerelease: true - args: --target aarch64-apple-darwin --bundles dmg + args: --target aarch64-apple-darwin --bundles dmg --config src-tauri/tauri.release.conf.json releaseAssetNamePattern: Touch-Manager_[version]_[arch].[ext] uploadUpdaterSignatures: false + + - name: Upload bundled component source + env: + GH_TOKEN: ${{ github.token }} + run: gh release upload "${GITHUB_REF_NAME}" release-assets/dfu-util-0.11.tar.gz release-assets/libusb-1.0.30.tar.bz2 --clobber diff --git a/.gitignore b/.gitignore index 15cc938..8c90406 100644 --- a/.gitignore +++ b/.gitignore @@ -2,5 +2,7 @@ node_modules/ dist/ src-tauri/target/ src-tauri/gen/ +src-tauri/binaries/dfu-util-* +release-assets/ *.log .DS_Store diff --git a/BUILD_PLAN.md b/BUILD_PLAN.md index 0dfea9c..ecec301 100644 --- a/BUILD_PLAN.md +++ b/BUILD_PLAN.md @@ -26,7 +26,7 @@ The physical BOOT/RESET path remains the permanent recovery mechanism. - Detection of runtime CDC, STM32 ROM DFU, and Daisy Bootloader DFU states. - Safe support for internal, `BOOT_SRAM`, and `BOOT_QSPI` binaries. - Guided DFU entry and semantic flash progress. -- Guarded `dfu-util` backend with fixed target profiles. +- Guarded, self-contained `dfu-util` backend with fixed target profiles. - Runtime return detection and contextual handling of the known post-transfer `get_status` disconnect. - USB serial diagnostics, searchable console, and exported support transcript. @@ -71,8 +71,8 @@ The physical BOOT/RESET path remains the permanent recovery mechanism. - `catalog`: loads the bundled catalog, resolves local artifacts, and exposes typed firmware metadata. - `device`: enumerates USB and serial devices and models runtime/DFU state. -- `flash`: converts approved profiles into fixed `dfu-util` invocations and interprets - progress/results. +- `flash`: resolves the bundled flashing engine, converts approved profiles into fixed + `dfu-util` invocations, and interprets progress/results. - `diagnostics`: opens CDC serial ports and emits log events to the interface. - `history`: records attempted and completed installs in SQLite. @@ -195,6 +195,7 @@ the flow on a dedicated test Seed, with recovery tested after interruption. ### Phase 4 — distribution +- Self-contained Apple Silicon DMG with a checksum-pinned flashing sidecar. - Signed/notarized macOS DMG. - Signed Windows installer and explicit Driver Doctor for WinUSB. - Debian package with narrow udev rules and AppImage fallback. diff --git a/CHANGELOG.md b/CHANGELOG.md index e057df2..c5b5f51 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,13 +5,6 @@ All notable changes to Touch Manager will be documented here. The project follow ## Unreleased -### Added - -- On-demand, checksum-verified downloads for licensed official firmware. -- Content-addressed firmware cache in the application data directory. -- Curated community-directory and upstream-source links opened in the system browser. -- Official firmware redistribution notices. - ### Planned - Signed remote catalog updates. @@ -19,6 +12,30 @@ All notable changes to Touch Manager will be documented here. The project follow - Signed and notarized release automation. - Windows and Linux hardware packaging. +## 0.3.0 - 2026-07-10 + +### Added + +- Self-contained Apple Silicon application bundle with a built-in `dfu-util` 0.11 + flashing engine and statically linked `libusb`. +- Startup flashing-engine health and version check shown on the Device page. +- Checksum-pinned third-party build automation, bundled GPL/LGPL notices, and corresponding + `dfu-util` and `libusb` source archives attached to releases. + +### Changed + +- Production firmware writes always use the bundled flashing engine. External paths remain + available only in development builds. + +## 0.2.0 - 2026-07-10 + +### Added + +- On-demand, checksum-verified downloads for licensed official firmware. +- Content-addressed firmware cache in the application data directory. +- Curated community-directory and upstream-source links opened in the system browser. +- Official firmware redistribution notices. + ## 0.1.0 - 2026-07-10 ### Added diff --git a/README.md b/README.md index 762fff5..9ecbe88 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ BOOT/RESET recovery path. > connected during an installation and retain a known-good firmware binary. Automated > tests never write to a connected device. -## What works in 0.2 +## What works in 0.3 - Bundled metadata for 23 official and community Touch 2 instruments. - On-demand downloading and verified local caching for redistributable official firmware. @@ -21,7 +21,7 @@ BOOT/RESET recovery path. - SHA-256, size, Thumb-vector, stack-pointer, and execution-layout validation. - Fixed profiles for STM32 internal flash, Daisy `BOOT_SRAM`, and Daisy `BOOT_QSPI`. - Detection of runtime USB, STM32 ROM DFU, Daisy Bootloader DFU, and serial ports. -- Profile-specific update instructions and an explicitly confirmed `dfu-util` installer. +- Profile-specific update instructions and a built-in, version-checked flashing engine. - Runtime-return detection, recovery-aware results, and SQLite install history. - USB serial diagnostics and support-transcript export. - Responsive macOS-first interface built with Tauri, React, TypeScript, and Rust. @@ -34,10 +34,11 @@ roadmap are in [BUILD_PLAN.md](BUILD_PLAN.md). Download the latest macOS installer from [GitHub Releases](https://github.com/alibros/touch-manager/releases). -The current preview is built for Apple Silicon Macs. It is ad-hoc signed rather than -Apple-notarized, so first launch may require Control-clicking the app, choosing **Open**, -or approving it in **System Settings → Privacy & Security**. Install `dfu-util` with -`brew install dfu-util` before writing firmware. +The current preview is built for Apple Silicon Macs and is fully self-contained: its +flashing engine is included in the application, so Homebrew and Terminal setup are not +required. It is ad-hoc signed rather than Apple-notarized, so first launch may require +Control-clicking the app, choosing **Open**, or approving it in **System Settings → +Privacy & Security**. Release builds can download the eight official firmware binaries whose upstream MIT licenses permit redistribution. Every download is checked against its catalog SHA-256 and @@ -65,7 +66,7 @@ Prerequisites: - macOS, Windows, or Linux with the [Tauri 2 prerequisites](https://v2.tauri.app/start/prerequisites/) - Node.js 20.19 or newer - Current stable Rust -- `dfu-util` 0.11 or newer for real hardware installation +- `dfu-util` 0.11 or newer for local development only; release builds include it On macOS: @@ -126,6 +127,12 @@ release still requires Apple Developer ID signing and notarization. Windows rele explicit WinUSB guidance, and Linux releases need narrow udev rules; those distribution tasks remain on the roadmap. +The tagged macOS release workflow builds `dfu-util` 0.11 and `libusb` 1.0.30 from their +checksum-pinned sources, statically links them, verifies that no non-system dynamic +libraries remain, and embeds the executable in the application bundle. Both corresponding +source archives and the required license notices ship with every release. See +[third-party notices](docs/THIRD_PARTY_NOTICES.md). + ## Buttonless updates The application contains the host-side TouchLink update request. Existing instruments do diff --git a/docs/THIRD_PARTY_NOTICES.md b/docs/THIRD_PARTY_NOTICES.md new file mode 100644 index 0000000..bdd8354 --- /dev/null +++ b/docs/THIRD_PARTY_NOTICES.md @@ -0,0 +1,36 @@ +# Third-party notices + +Touch Manager includes the following separately maintained open-source component in its +macOS release bundle. + +## dfu-util 0.11 + +`dfu-util` is a host-side implementation of USB Device Firmware Upgrade protocols. Touch +Manager invokes it as a separate executable for firmware transfers. + +- Project: +- Version: 0.11 +- Source archive SHA-256: `b4b53ba21a82ef7e3d4c47df2952adf5fa494f499b6b0b57c58c5d04ae8ff19e` +- License: GNU General Public License, version 2 or later +- Copyright 2005–2009 Weston Schmidt, Harald Welte and OpenMoko Inc. +- Copyright 2010–2021 Tormod Volden and Stefan Schmidt + +The complete license text is bundled at `licenses/dfu-util-GPL-2.0.txt`. The exact +corresponding `dfu-util-0.11.tar.gz` source archive is attached to every Touch Manager +macOS release that includes this executable. + +## libusb 1.0.30 + +The bundled `dfu-util` executable statically incorporates `libusb` for USB access. + +- Project: +- Version: 1.0.30 +- Source archive SHA-256: `fea36f34f9156400209595e300840767ab1a385ede1dc7ee893015aea9c6dbaf` +- License: GNU Lesser General Public License, version 2.1 or later + +The complete license text is bundled at `licenses/libusb-LGPL-2.1.txt`. The exact +corresponding `libusb-1.0.30.tar.bz2` source archive is attached to every Touch Manager +macOS release that includes this library. + +Touch Manager itself remains licensed under the MIT License. Third-party components remain +subject to their respective licenses. diff --git a/docs/licenses/dfu-util-GPL-2.0.txt b/docs/licenses/dfu-util-GPL-2.0.txt new file mode 100644 index 0000000..1c3a797 --- /dev/null +++ b/docs/licenses/dfu-util-GPL-2.0.txt @@ -0,0 +1,341 @@ +tar: Failed to set default locale + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General +Public License instead of this License. diff --git a/docs/licenses/libusb-LGPL-2.1.txt b/docs/licenses/libusb-LGPL-2.1.txt new file mode 100644 index 0000000..6490a11 --- /dev/null +++ b/docs/licenses/libusb-LGPL-2.1.txt @@ -0,0 +1,503 @@ +tar: Failed to set default locale + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random Hacker. + + , 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! diff --git a/package-lock.json b/package-lock.json index 6100c1c..adf93ba 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "touch-manager", - "version": "0.2.0", + "version": "0.3.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "touch-manager", - "version": "0.2.0", + "version": "0.3.0", "license": "MIT", "dependencies": { "@tauri-apps/api": "^2.11.1", diff --git a/package.json b/package.json index 56b2036..c5ac444 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "touch-manager", "private": true, - "version": "0.2.0", + "version": "0.3.0", "description": "A safe firmware library, installer, and diagnostic console for Synthux Touch 2.", "license": "MIT", "author": "Ali Bross", diff --git a/src-tauri/Cargo.lock b/src-tauri/Cargo.lock index b879f58..3c75b40 100644 --- a/src-tauri/Cargo.lock +++ b/src-tauri/Cargo.lock @@ -910,6 +910,15 @@ version = "1.2.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "4ef6b89e5b37196644d8796de5268852ff179b44e96276cf4290264843743bb7" +[[package]] +name = "encoding_rs" +version = "0.8.35" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "75030f3c4f45dafd7586dd6780965a8c7e8e285a5ecb86713e63a79c5b2766f3" +dependencies = [ + "cfg-if", +] + [[package]] name = "endi" version = "1.1.1" @@ -2560,6 +2569,16 @@ dependencies = [ "pin-project-lite", ] +[[package]] +name = "os_pipe" +version = "1.2.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7d8fae84b431384b68627d0f9b3b1245fcf9f46f6c0e3dc902e9dce64edd1967" +dependencies = [ + "libc", + "windows-sys 0.61.2", +] + [[package]] name = "pango" version = "0.18.3" @@ -3392,12 +3411,44 @@ dependencies = [ "digest 0.11.3", ] +[[package]] +name = "shared_child" +version = "1.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1e362d9935bc50f019969e2f9ecd66786612daae13e8f277be7bfb66e8bed3f7" +dependencies = [ + "libc", + "sigchld", + "windows-sys 0.60.2", +] + [[package]] name = "shlex" version = "2.0.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "f8fadd59c855ef2080decdef8ff161eb6661b86933c9d82e5ba29dc602a55aba" +[[package]] +name = "sigchld" +version = "0.2.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "47106eded3c154e70176fc83df9737335c94ce22f821c32d17ed1db1f83badb1" +dependencies = [ + "libc", + "os_pipe", + "signal-hook", +] + +[[package]] +name = "signal-hook" +version = "0.3.18" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d881a16cf4426aa584979d30bd82cb33429027e42122b169753d6ef1085ed6e2" +dependencies = [ + "libc", + "signal-hook-registry", +] + [[package]] name = "signal-hook-registry" version = "1.4.8" @@ -3874,6 +3925,27 @@ dependencies = [ "zbus", ] +[[package]] +name = "tauri-plugin-shell" +version = "2.3.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8457dbf9e2bab1edd8df22bb2c20857a59a9868e79cb3eac5ed639eec4d0c73b" +dependencies = [ + "encoding_rs", + "log", + "open", + "os_pipe", + "regex", + "schemars 0.8.22", + "serde", + "serde_json", + "shared_child", + "tauri", + "tauri-plugin", + "thiserror 2.0.18", + "tokio", +] + [[package]] name = "tauri-runtime" version = "2.11.3" @@ -4250,7 +4322,7 @@ checksum = "756daf9b1013ebe47a8776667b466417e2d4c5679d441c26230efd9ef78692db" [[package]] name = "touch-manager" -version = "0.2.0" +version = "0.3.0" dependencies = [ "chrono", "hex", @@ -4266,6 +4338,7 @@ dependencies = [ "tauri-build", "tauri-plugin-dialog", "tauri-plugin-opener", + "tauri-plugin-shell", "thiserror 2.0.18", "uuid", ] diff --git a/src-tauri/Cargo.toml b/src-tauri/Cargo.toml index 33505db..f2eb5bb 100644 --- a/src-tauri/Cargo.toml +++ b/src-tauri/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "touch-manager" -version = "0.2.0" +version = "0.3.0" description = "Firmware library and diagnostic manager for Synthux Touch 2" authors = ["Ali Bross"] edition = "2021" @@ -29,5 +29,6 @@ sha2 = "0.11.0" tauri = { version = "2.11.5", features = [] } tauri-plugin-dialog = "2.7.1" tauri-plugin-opener = "2.5.4" +tauri-plugin-shell = "2.3.5" thiserror = "2.0.18" uuid = { version = "1.20.0", features = ["v4", "serde"] } diff --git a/src-tauri/src/flash.rs b/src-tauri/src/flash.rs index 33e0d24..cd8d90a 100644 --- a/src-tauri/src/flash.rs +++ b/src-tauri/src/flash.rs @@ -5,14 +5,26 @@ use crate::{ }; use serde::{Deserialize, Serialize}; use std::{ - env, path::Path, - path::PathBuf, - process::Command, thread, time::{Duration, Instant}, }; use tauri::{AppHandle, Emitter, State}; +use tauri_plugin_shell::{process::Command, ShellExt}; + +#[cfg(debug_assertions)] +use std::{env, path::PathBuf}; + +const BUNDLED_DFU_UTIL: &str = "dfu-util"; + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +pub struct FlashingEngineStatus { + pub ready: bool, + pub source: String, + pub version: Option, + pub message: String, +} #[derive(Debug, Clone, Deserialize)] #[serde(rename_all = "camelCase")] @@ -92,17 +104,22 @@ pub async fn run_flash( } emit(&app, "writing", "Erasing and writing firmware"); - let path = request.path.clone(); let address = format!("{}:leave", request.target_profile.address()); - let dfu_util = find_dfu_util(); - let output = tauri::async_runtime::spawn_blocking(move || { - Command::new(dfu_util) - .args(["-a", "0", "-d", ",0483:df11", "-s", &address, "-D", &path]) - .output() - }) - .await - .map_err(|error| error.to_string())? - .map_err(|error| format!("Could not launch dfu-util: {error}"))?; + let command = flashing_command(&app)?; + let output = command + .args([ + "-a", + "0", + "-d", + ",0483:df11", + "-s", + &address, + "-D", + &request.path, + ]) + .output() + .await + .map_err(|error| format!("Could not launch the built-in flashing engine: {error}"))?; let transcript = format!( "{}{}", @@ -168,15 +185,94 @@ pub async fn run_flash( }) } -fn find_dfu_util() -> PathBuf { +pub async fn flashing_engine_status(app: &AppHandle) -> FlashingEngineStatus { + let source = flashing_engine_source(); + let command = match flashing_command(app) { + Ok(command) => command, + Err(error) => { + return FlashingEngineStatus { + ready: false, + source: "missing".into(), + version: None, + message: error, + }; + } + }; + + match command.arg("--version").output().await { + Ok(output) if output.status.success() => { + let combined = format!( + "{}{}", + String::from_utf8_lossy(&output.stdout), + String::from_utf8_lossy(&output.stderr) + ); + let version = parse_dfu_util_version(&combined); + FlashingEngineStatus { + ready: version.is_some(), + source: source.into(), + version, + message: if source == "bundled" { + "Included with Touch Manager".into() + } else { + "Development flashing engine".into() + }, + } + } + Ok(output) => FlashingEngineStatus { + ready: false, + source: source.into(), + version: None, + message: format!("Flashing engine exited with status {:?}", output.status.code()), + }, + Err(error) => FlashingEngineStatus { + ready: false, + source: "missing".into(), + version: None, + message: format!( + "The built-in flashing engine is unavailable. Reinstall the latest official Touch Manager release. {error}" + ), + }, + } +} + +fn flashing_command(app: &AppHandle) -> Result { + #[cfg(debug_assertions)] + if let Some(path) = development_dfu_util() { + return Ok(app.shell().command(path)); + } + + app.shell() + .sidecar(BUNDLED_DFU_UTIL) + .map_err(|error| format!("Could not locate the built-in flashing engine: {error}")) +} + +fn flashing_engine_source() -> &'static str { + #[cfg(debug_assertions)] + if development_dfu_util().is_some() { + return "development"; + } + "bundled" +} + +fn parse_dfu_util_version(output: &str) -> Option { + output + .lines() + .find(|line| line.trim_start().starts_with("dfu-util ")) + .map(|line| line.trim().to_string()) +} + +#[cfg(debug_assertions)] +fn development_dfu_util() -> Option { if let Some(path) = env::var_os("TOUCH_MANAGER_DFU_UTIL") { - return PathBuf::from(path); + let path = PathBuf::from(path); + if path.is_file() { + return Some(path); + } } ["/opt/homebrew/bin/dfu-util", "/usr/local/bin/dfu-util"] .into_iter() .map(PathBuf::from) .find(|path| path.is_file()) - .unwrap_or_else(|| PathBuf::from("dfu-util")) } fn wait_for_runtime(timeout: Duration) -> bool { @@ -202,10 +298,22 @@ fn emit(app: &AppHandle, phase: &str, message: &str) { #[cfg(test)] mod tests { + use super::parse_dfu_util_version; + #[test] fn recognizes_known_leave_disconnect_as_post_transfer() { let transcript = "File downloaded successfully\nError during download get_status"; assert!(transcript.contains("File downloaded successfully")); assert!(transcript.contains("Error during download get_status")); } + + #[test] + fn parses_bundled_flashing_engine_version() { + let output = "dfu-util 0.11\n\nCopyright 2005-2021"; + assert_eq!( + parse_dfu_util_version(output).as_deref(), + Some("dfu-util 0.11") + ); + assert_eq!(parse_dfu_util_version("not dfu-util"), None); + } } diff --git a/src-tauri/src/lib.rs b/src-tauri/src/lib.rs index 381c4e0..8117a1e 100644 --- a/src-tauri/src/lib.rs +++ b/src-tauri/src/lib.rs @@ -79,10 +79,16 @@ async fn flash_firmware( flash::run_flash(app, history, request).await } +#[tauri::command] +async fn get_flashing_engine(app: tauri::AppHandle) -> flash::FlashingEngineStatus { + flash::flashing_engine_status(&app).await +} + pub fn run() { tauri::Builder::default() .plugin(tauri_plugin_dialog::init()) .plugin(tauri_plugin_opener::init()) + .plugin(tauri_plugin_shell::init()) .setup(|app| { let data_dir = app.path().app_data_dir()?; fs::create_dir_all(&data_dir)?; @@ -103,6 +109,7 @@ pub fn run() { request_update_mode, save_transcript, flash_firmware, + get_flashing_engine, ]) .run(tauri::generate_context!()) .expect("error while running Touch Manager"); diff --git a/src-tauri/tauri.conf.json b/src-tauri/tauri.conf.json index 03619ba..ecb1a6a 100644 --- a/src-tauri/tauri.conf.json +++ b/src-tauri/tauri.conf.json @@ -1,7 +1,7 @@ { "$schema": "https://schema.tauri.app/config/2", "productName": "Touch Manager", - "version": "0.2.0", + "version": "0.3.0", "identifier": "academy.synthux.touch-manager", "build": { "beforeDevCommand": "npm run dev", diff --git a/src-tauri/tauri.release.conf.json b/src-tauri/tauri.release.conf.json new file mode 100644 index 0000000..7cfa36f --- /dev/null +++ b/src-tauri/tauri.release.conf.json @@ -0,0 +1,14 @@ +{ + "$schema": "https://schema.tauri.app/config/2", + "bundle": { + "externalBin": ["binaries/dfu-util"], + "resources": { + "../docs/THIRD_PARTY_NOTICES.md": "licenses/THIRD_PARTY_NOTICES.md", + "../docs/licenses/dfu-util-GPL-2.0.txt": "licenses/dfu-util-GPL-2.0.txt", + "../docs/licenses/libusb-LGPL-2.1.txt": "licenses/libusb-LGPL-2.1.txt" + }, + "macOS": { + "signingIdentity": "-" + } + } +} diff --git a/src/App.tsx b/src/App.tsx index 4f4ddb8..b92ab3f 100644 --- a/src/App.tsx +++ b/src/App.tsx @@ -32,6 +32,7 @@ import { downloadOfficialFirmware, flashFirmware, getCatalog, + getFlashingEngine, getHistory, isDesktop, requestUpdateMode, @@ -45,6 +46,7 @@ import type { FirmwareAnalysis, FlashEvent, FlashResult, + FlashingEngineStatus, HistoryEntry, TargetProfile, TouchDevice, @@ -76,6 +78,7 @@ function App() { const [installing, setInstalling] = useState(null); const [loading, setLoading] = useState(true); const [downloadingId, setDownloadingId] = useState(null); + const [flashingEngine, setFlashingEngine] = useState(null); const [error, setError] = useState(null); const refreshDevices = useCallback(async () => { @@ -95,11 +98,12 @@ function App() { }, []); useEffect(() => { - Promise.all([getCatalog(), scanDevices(), getHistory()]) - .then(([items, foundDevices, entries]) => { + Promise.all([getCatalog(), scanDevices(), getHistory(), getFlashingEngine()]) + .then(([items, foundDevices, entries, engine]) => { setCatalog(items); setDevices(foundDevices); setHistory(entries); + setFlashingEngine(engine); setSelected(items.find((item) => item.featured) ?? items[0] ?? null); }) .catch((reason) => setError(String(reason))) @@ -247,6 +251,7 @@ function App() { query={query} filter={filter} deviceConnected={Boolean(runtimeDevice || dfuDevice)} + flashingEngineReady={flashingEngine?.ready ?? false} onQuery={setQuery} onFilter={setFilter} onSelect={setSelected} @@ -256,7 +261,12 @@ function App() { onImport={importFirmware} /> ) : page === "device" ? ( - setPage("library")} /> + setPage("library")} + /> ) : page === "console" ? ( ) : ( @@ -352,6 +362,7 @@ function LibraryPage({ query, filter, deviceConnected, + flashingEngineReady, onQuery, onFilter, onSelect, @@ -365,6 +376,7 @@ function LibraryPage({ query: string; filter: string; deviceConnected: boolean; + flashingEngineReady: boolean; onQuery: (value: string) => void; onFilter: (value: string) => void; onSelect: (item: CatalogItem) => void; @@ -426,6 +438,7 @@ function LibraryPage({ onInstall(selected)} onDownload={() => onDownload(selected)} @@ -462,12 +475,14 @@ function FirmwareCard({ item, selected, onSelect }: { item: CatalogItem; selecte function FirmwareDetail({ item, deviceConnected, + flashingEngineReady, downloading, onInstall, onDownload, }: { item: CatalogItem; deviceConnected: boolean; + flashingEngineReady: boolean; downloading: boolean; onInstall: () => void; onDownload: () => void; @@ -495,7 +510,7 @@ function FirmwareDetail({
{item.availableLocally ? ( - @@ -508,6 +523,9 @@ function FirmwareDetail({ {!item.availableLocally && !downloadable && item.trust === "official" && (

This official binary is not mirrored because its upstream redistribution license is not confirmed.

)} + {item.availableLocally && !flashingEngineReady && isDesktop && ( +

The built-in flashing engine is unavailable. Reinstall the latest official Touch Manager release.

+ )} {item.trust !== "official" && ( Browse the Touch 2 community directory @@ -519,7 +537,17 @@ function FirmwareDetail({ ); } -function DevicePage({ devices, onRefresh, onLibrary }: { devices: TouchDevice[]; onRefresh: () => void; onLibrary: () => void }) { +function DevicePage({ + devices, + flashingEngine, + onRefresh, + onLibrary, +}: { + devices: TouchDevice[]; + flashingEngine: FlashingEngineStatus | null; + onRefresh: () => void; + onLibrary: () => void; +}) { const device = devices[0]; return (
@@ -551,6 +579,15 @@ function DevicePage({ devices, onRefresh, onLibrary }: { devices: TouchDevice[];

The factory STM32 recovery cannot be erased by an ordinary firmware install.

  1. Hold BOOT
  2. Tap RESET
  3. Release BOOT
+
+

Flashing engine

+
+
Status
{flashingEngine?.ready ? "Ready" : "Unavailable"}
+
Installation
{flashingEngine?.source === "bundled" ? "Built in" : "Development"}
+
Version
{flashingEngine?.version ?? "—"}
+
+

{flashingEngine?.message ?? "Checking the flashing engine…"}

+
) : ( diff --git a/src/backend.ts b/src/backend.ts index ccda199..cfd349d 100644 --- a/src/backend.ts +++ b/src/backend.ts @@ -4,6 +4,7 @@ import type { CatalogItem, DownloadResult, FirmwareAnalysis, + FlashingEngineStatus, FlashResult, HistoryEntry, TargetProfile, @@ -40,6 +41,17 @@ export async function getHistory(): Promise { return invoke("list_history"); } +export async function getFlashingEngine(): Promise { + if (!isDesktop) { + return { + ready: false, + source: "missing", + message: "Available in the packaged desktop application", + }; + } + return invoke("get_flashing_engine"); +} + export async function startConsole(portName: string): Promise { return invoke("start_serial_console", { portName, baudRate: 115200 }); } diff --git a/src/types.ts b/src/types.ts index 52a8377..1dd9832 100644 --- a/src/types.ts +++ b/src/types.ts @@ -91,3 +91,10 @@ export interface FlashResult { transcript: string; message: string; } + +export interface FlashingEngineStatus { + ready: boolean; + source: "bundled" | "development" | "missing"; + version?: string; + message: string; +}