60d266cbc6
A UF2 device exposes a VFAT block device (sometimes called a Mass
Storage Device) which has a virtual file called `INFO_UF2.TXT` where
metadata can be read. It may also have a the current firmware exported
as a file called `CURRENT.UF2` which is in a 512 byte-block UF2 format.
Writing any file to the MSD will cause the firmware to be written.
Sometimes the device will restart and the volume will be unmounted
and then mounted again. In some cases the volume may not “come back”
until the user manually puts the device back in programming mode.
Match the block devices using the VID*PID, UUID or label, and then
create a UF2 device which can be used to flash firmware.
Note: We only read metadata from allow-listed IDs to avoid causing
regressions on non-UF2 volumes. To get the UUID and label you can
use commands like:
udisksctl info -b /dev/sda1
|
||
|---|---|---|
| .. | ||
| ci | ||
| debian | ||
| firmware_packager | ||
| flatpak@3e60bea4e7 | ||
| freebsd | ||
| qubes | ||
| snap | ||
| standalone-installer | ||
| vscode | ||
| build-openbmc.sh | ||
| codespell.cfg | ||
| fix_translations.py | ||
| fwupd.spec.in | ||
| generate-version-script.py | ||
| meson.build | ||
| mingw64.cross | ||
| PKGBUILD | ||
| prepare-system | ||
| README.md | ||
| reformat-code.py | ||
| run-tests.sh | ||
| setup | ||
| setup-win32.nsi.in | ||
Distribution packages
The relevant packaging necessary to generate RPM, DEB and PKG distribution packages is contained here. It is used regularly for continuous integration using Travis CI. The generated packages can be used on a distribution such as Fedora, Debian, Ubuntu or Arch Linux.
The build can be performed using Linux containers with Docker.
RPM packages
A Dockerfile for Fedora can be generated in contrib.
To prepare the Docker container run this command:
OS=fedora ./generate_docker.py build
To build the RPMs run this command (from the root of your git checkout):
docker run --privileged -t -v `pwd`:/github/workspace fwupd-fedora
RPMs will be made available in your working directory when complete.
To build additional RPM packages for Qubes OS (fwupd-qubes-dom0 and
fwupd-qubes-vm) add QUBES=true environment variable:
docker run --privileged -e QUBES=true -t -v `pwd`:/github/workspace fwupd-fedora
DEB packages
A Dockerfile for Debian or Ubuntu can be generated in contrib.
To prepare the Docker container run one of these commands:
OS=debian-x86_64 ./generate_docker.py build
OS=debian-i386 ./generate_docker.py build
OS=ubuntu-x86_64 ./generate_docker.py build
To build the DEBs run one of these commands (from the root of your git checkout):
docker run --privileged -t -v `pwd`:/github/workspace fwupd-debian-x86_64
docker run --privileged -t -v `pwd`:/github/workspace fwupd-debian-i386
docker run --privileged -t -v `pwd`:/github/workspace fwupd-ubuntu-x86_64
DEBs will be made available in your working directory when complete.
To build additional DEB package for Qubes OS (fwupd-qubes-vm-whonix)
add QUBES=true environment variable:
docker run --privileged -t -v `pwd`:/github/workspace fwupd-debian-x86_64-qubes
PKG packages
A Dockerfile for Arch can be generated in contrib.
To prepare the Docker container run this command:
OS=arch ./generate_docker.py
To build the PKGs run this command (from the root of your git checkout):
docker run -t -v `pwd`:/build fwupd-arch
PKGs will be made available in your working directory when complete.
Additional packages
Submissions for generating additional packages for other distribution mechanisms are also welcome. All builds should occur in Docker containers.
Please feel free to submit the following:
- Dockerfile for the container for your distro
- Relevant technical packaging scripts (such as ebuilds, spec file etc)
- A shell script that can be launched in the container to generate distribution packages