Skip to content

Commit

Permalink
Fix bare links
Browse files Browse the repository at this point in the history
Signed-off-by: Davide Cavalca <[email protected]>
  • Loading branch information
davide125 committed Feb 20, 2025
1 parent 5f4582e commit bf0d323
Show file tree
Hide file tree
Showing 11 changed files with 57 additions and 57 deletions.
2 changes: 1 addition & 1 deletion docs/Accelerator-Engines.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
The SoC has several onboard accelerator units, this is a useful list of the names and what they refer to. Most of the accelerators run firmware that can be found in the pre-boot partition `/System/Volumes/Preboot/[UUID]/restore/Firmware`, packaged as im4p files which may be extracted with https://github.com/19h/ftab-dump/blob/master/rkos.py and some dd.
The SoC has several onboard accelerator units, this is a useful list of the names and what they refer to. Most of the accelerators run firmware that can be found in the pre-boot partition `/System/Volumes/Preboot/[UUID]/restore/Firmware`, packaged as im4p files which may be extracted with <https://github.com/19h/ftab-dump/blob/master/rkos.py> and some dd.

*Update none of the ANE, AVE, ADT im4p's extract with that. I'm not sure which ones do. You are better off following the im4p extraction steps in [ADT](FW-ADT.md). Can we make a progress matrix regarding firmware?

Expand Down
60 changes: 30 additions & 30 deletions docs/Broken-Software.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,43 +90,43 @@ run). You may have varying levels of success by attempting to run your software
## Broken packages
| Package | Upstream report | Notes |
| ------- | --------------- | ----- |
| Chromium | https://issues.chromium.org/issues/378017037 | cppgc crashes on Linux w/ 16KiB pages because of hardcoded kGuardPageSize |
| hardened_malloc | https://github.com/GrapheneOS/hardened_malloc/issues/183 | There are more changes necessary to hardened_malloc before 16k page support is done. It is also not a high priority at the moment as we need MTE |
| jemalloc | https://github.com/jemalloc/jemalloc/issues/467 | Upstream unwilling to fix, Needs build options if compiled on a 4k page size system. Addressed in [ArchLinuxARM](https://github.com/archlinuxarm/PKGBUILDs/pull/1914). |
| MEGAsync | https://github.com/meganz/MEGAsync/pull/801 |
| notion-app(-enhancer) | https://github.com/notion-enhancer/notion-repackaged/issues/107 | electron + broken build flags |
| Wine | https://bugs.winehq.org/show_bug.cgi?id=52715 |
| Zig | https://github.com/ziglang/zig/issues/11308 |
| Chromium | <https://issues.chromium.org/issues/378017037> | cppgc crashes on Linux w/ 16KiB pages because of hardcoded kGuardPageSize |
| hardened_malloc | <https://github.com/GrapheneOS/hardened_malloc/issues/183> | There are more changes necessary to hardened_malloc before 16k page support is done. It is also not a high priority at the moment as we need MTE |
| jemalloc | <https://github.com/jemalloc/jemalloc/issues/467> | Upstream unwilling to fix, Needs build options if compiled on a 4k page size system. Addressed in [ArchLinuxARM](https://github.com/archlinuxarm/PKGBUILDs/pull/1914). |
| MEGAsync | <https://github.com/meganz/MEGAsync/pull/801> |
| notion-app(-enhancer) | <https://github.com/notion-enhancer/notion-repackaged/issues/107> | electron + broken build flags |
| Wine | <https://bugs.winehq.org/show_bug.cgi?id=52715> |
| Zig | <https://github.com/ziglang/zig/issues/11308> |

\* Running x86-64 software is supported via a 4k page size microVM running FEX.

## Fixed packages
| Package | Fixing commit | Notes |
| ------- | ------------- | ----- |
| 1Password | _proprietary_ | Fixed as of 8.8.0-119 beta. |
| Android Cuttlefish | https://android-review.googlesource.com/c/device/google/cuttlefish/+/2545951 | Fixed in AOSP main branch by switching to musl. |
| box64 | https://github.com/ptitSeb/box64/issues/384 | Fixed since 0.2.8 |
| btrfs | https://lore.kernel.org/lkml/[email protected]/ | Fixed since Linux 5.19 ([caveats](https://social.treehouse.systems/@marcan/111493984306764821)) |
| Chromium | https://bugs.chromium.org/p/chromium/issues/detail?id=1301788| Includes Electron apps.<br>Fixed since 102. |
| Emacs | https://lists.gnu.org/archive/html/bug-gnu-emacs/2021-03/msg01260.html | Fixed since 28.0 |
| f2fs | https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=d7e9a9037de27b642d5a3edef7c69e2a2b460287 | Fixed since Linux 6.7 |
| fd | https://github.com/sharkdp/fd/issues/1085 | Fixed since 10.1 |
| k3s-io | https://github.com/k3s-io/k3s/issues/7335 | Fixed since 1.27.2 |
| KiCad | https://gitlab.com/kicad/code/kicad/-/issues/16008 | Fixed since 7.0.10 |
| libglvnd | https://gitlab.freedesktop.org/glvnd/libglvnd/-/merge_requests/262 | Fixed since 1.5.0 |
| libunwind | https://github.com/libunwind/libunwind/pull/330 | Fixed since 1.7.0 |
| libunwind | https://github.com/libunwind/libunwind/issues/260 | Fixed since 1.8.0 |
| libvirt/QEMU/KVM | https://patchew.org/QEMU/[email protected]/ | Fixed since QEMU 7.2.6 / 8.0.5 / 8.1.1 |
| lvm2 | https://bugzilla.redhat.com/show_bug.cgi?id=2059734 | Fixed since 2.03.21 |
| pdfium | https://bugs.chromium.org/p/pdfium/issues/detail?id=1853 | Fixed and shipped with Chromium 108 |
| qt5-webengine | https://bugreports.qt.io/browse/QTBUG-105145 | chromium 87, likely won’t be fixed upstream. [Fixed in downstream ArchLinuxARM](https://github.com/archlinuxarm/PKGBUILDs/pull/1928) |
| qt6-webengine | https://bugreports.qt.io/browse/QTBUG-105145 | chromium 94 for 6.3, partially fixed upstream in 6.4 for webview but not for QtPdf. [Fixed in downstream ArchLinuxARM](https://github.com/archlinuxarm/PKGBUILDs/pull/1928) |
| Redis | https://bugzilla.redhat.com/show_bug.cgi?id=2240293 https://bodhi.fedoraproject.org/updates/FEDORA-2023-bdb1515542 | Fixed in fedora since redis-7.0.13-2.fc38 and redis-7.2.1-2.fc39) |
| rr | https://github.com/rr-debugger/rr/pull/3146 | Fixed since 5.6.0 |
| Rust | https://github.com/archlinuxarm/PKGBUILDs/commit/19a1393 | Fixed for `rust-1.62.1-1.1` in ALARM/extra |
| Telegram Desktop | https://github.com/telegramdesktop/tdesktop/issues/26103 | Fixed since 4.1.1 |
| Visual Studio Code | https://aur.archlinux.org/packages/visual-studio-code-bin | Fixed since 1.71.0 (uses Electron 19) |
| WebKitGTK | https://github.com/WebKit/WebKit/commit/0a4a03da45f774 | Fixed since 2.34.6 |
| Android Cuttlefish | <https://android-review.googlesource.com/c/device/google/cuttlefish/+/2545951> | Fixed in AOSP main branch by switching to musl. |
| box64 | <https://github.com/ptitSeb/box64/issues/384> | Fixed since 0.2.8 |
| btrfs | <https://lore.kernel.org/lkml/[email protected]/> | Fixed since Linux 5.19 ([caveats](https://social.treehouse.systems/@marcan/111493984306764821)) |
| Chromium | <https://bugs.chromium.org/p/chromium/issues/detail?id=1301788> | Includes Electron apps.<br>Fixed since 102. |
| Emacs | <https://lists.gnu.org/archive/html/bug-gnu-emacs/2021-03/msg01260.html> | Fixed since 28.0 |
| f2fs | <https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=d7e9a9037de27b642d5a3edef7c69e2a2b460287> | Fixed since Linux 6.7 |
| fd | <https://github.com/sharkdp/fd/issues/1085> | Fixed since 10.1 |
| k3s-io | <https://github.com/k3s-io/k3s/issues/7335> | Fixed since 1.27.2 |
| KiCad | <https://gitlab.com/kicad/code/kicad/-/issues/16008> | Fixed since 7.0.10 |
| libglvnd | <https://gitlab.freedesktop.org/glvnd/libglvnd/-/merge_requests/262> | Fixed since 1.5.0 |
| libunwind | <https://github.com/libunwind/libunwind/pull/330> | Fixed since 1.7.0 |
| libunwind | <https://github.com/libunwind/libunwind/issues/260> | Fixed since 1.8.0 |
| libvirt/QEMU/KVM | <https://patchew.org/QEMU/[email protected]/> | Fixed since QEMU 7.2.6 / 8.0.5 / 8.1.1 |
| lvm2 | <https://bugzilla.redhat.com/show_bug.cgi?id=2059734> | Fixed since 2.03.21 |
| pdfium | <https://bugs.chromium.org/p/pdfium/issues/detail?id=1853> | Fixed and shipped with Chromium 108 |
| qt5-webengine | <https://bugreports.qt.io/browse/QTBUG-105145> | chromium 87, likely won’t be fixed upstream. [Fixed in downstream ArchLinuxARM](https://github.com/archlinuxarm/PKGBUILDs/pull/1928) |
| qt6-webengine | <https://bugreports.qt.io/browse/QTBUG-105145> | chromium 94 for 6.3, partially fixed upstream in 6.4 for webview but not for QtPdf. [Fixed in downstream ArchLinuxARM](https://github.com/archlinuxarm/PKGBUILDs/pull/1928) |
| Redis | <https://bugzilla.redhat.com/show_bug.cgi?id=2240293> <https://bodhi.fedoraproject.org/updates/FEDORA-2023-bdb1515542> | Fixed in fedora since redis-7.0.13-2.fc38 and redis-7.2.1-2.fc39) |
| rr | <https://github.com/rr-debugger/rr/pull/3146> | Fixed since 5.6.0 |
| Rust | <https://github.com/archlinuxarm/PKGBUILDs/commit/19a1393> | Fixed for `rust-1.62.1-1.1` in ALARM/extra |
| Telegram Desktop | <https://github.com/telegramdesktop/tdesktop/issues/26103> | Fixed since 4.1.1 |
| Visual Studio Code | <https://aur.archlinux.org/packages/visual-studio-code-bin> | Fixed since 1.71.0 (uses Electron 19) |
| WebKitGTK | <https://github.com/WebKit/WebKit/commit/0a4a03da45f774> | Fixed since 2.34.6 |

## Bugs

Expand Down
2 changes: 1 addition & 1 deletion docs/HW-AVD.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ Apple Video Decoder.

Supports AVC, HEVC, AV1, VP9.

Notes: https://eiln.net/avd-notes.html
Notes: <https://web.archive.org/web/20240105073841/https://eiln.net/avd-notes.html>
2 changes: 1 addition & 1 deletion docs/Kernel-config-notes-for-distros.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ CONFIG_IIO_AOP_SENSOR_ALS=m

(Distros intending to support other platforms with their 16k arm64 kernel besides Apple Silicon will be inclined to build as many of these drivers as modules as they can. This is fine, though from a reliability standpoint building NVME_APPLE and SPI_HID_APPLE_OF in-kernel has worked much better for me.)

~~(Also note that the configuration options above do not match the standard dracut configuration provided by asahi-scripts.)~~ It looks like a recent change to asahi-scripts makes your choices of modules much less important: https://github.com/AsahiLinux/asahi-scripts/commit/4acd310cd8c394f9ec2e7e7506d89b7bb3c3ca39
~~(Also note that the configuration options above do not match the standard dracut configuration provided by asahi-scripts.)~~ It looks like a recent change to asahi-scripts makes your choices of modules much less important: <https://github.com/AsahiLinux/asahi-scripts/commit/4acd310cd8c394f9ec2e7e7506d89b7bb3c3ca39>

You should also double-check that you have the following configuration options set:

Expand Down
2 changes: 1 addition & 1 deletion docs/Open-OS-Ecosystem-on-Apple-Silicon-Macs-historical.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ Currently, Broadcom FullMAC WiFi firmware is packaged. These blobs have also bee
* AVD (Apple Video Decoder) Cortex-M3 firmware
* USB xHCI firmware (only needed for iMac models with 4 USB-C ports).

Details on Broadcom FullMAC WiFi firmware naming: https://lore.kernel.org/all/[email protected]/
Details on Broadcom FullMAC WiFi firmware naming: <https://lore.kernel.org/all/[email protected]/>

### VendorFW package

Expand Down
2 changes: 1 addition & 1 deletion docs/Open-OS-Ecosystem-on-Apple-Silicon-Macs.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ And these blobs aren't yet packaged:

* AVD (Apple Video Decoder) Cortex-M3 firmware

Details on Broadcom FullMAC WiFi firmware naming: https://lore.kernel.org/all/[email protected]/
Details on Broadcom FullMAC WiFi firmware naming: <https://lore.kernel.org/all/[email protected]/>

### VendorFW package

Expand Down
2 changes: 1 addition & 1 deletion docs/Reference-Asahi-kernel-config.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
See https://github.com/zzywysm/asahi-kernel-configs
See <https://github.com/zzywysm/asahi-kernel-configs>
26 changes: 13 additions & 13 deletions docs/SW-Alternative-Distros.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@ The primary supported distribution is the [Fedora Asahi Remix](https://asahilinu

| Distro | Maintainer | Installation Guide |
|--------|------------|--------------------|
| Alpine Linux | IRC: mps (https://arvanta.net/alpine) | https://arvanta.net/alpine/install-alpine-m1/ |
| AOSC OS | https://github.com/AOSC-Dev | https://aosc.io/downloads/asahi |
| Arch Linux ARM | https://github.com/asahi-alarm/ | https://github.com/asahi-alarm/asahi-alarm |
| CentOS Stream | https://github.com/ericcurtin | https://github.com/ericcurtin/asahi-centosstream-builder |
| Debian | https://thomas.glanzmann.de/ | https://git.zerfleddert.de/cgi-bin/gitweb.cgi/m1-debian/ |
| deepin | https://github.com/deepin-community| https://github.com/deepin-community/deepin-m1 |
| deepin | deepin M1 SIG | https://www.deepin.org/index/docs/sig/sig/deepin-m1/README |
| Fedora | https://github.com/leifliddy | https://github.com/leifliddy/asahi-fedora-builder |
| Gentoo<br>(LiveCD method) | IRC: chadmed (https://github.com/chadmed) | [Installing Gentoo with LiveCD](Installing-Gentoo-with-LiveCD.md) |
| NixOS | IRC: tpw_rules (https://github.com/tpwrules) | https://github.com/tpwrules/nixos-apple-silicon/blob/main/docs/uefi-standalone.md |
| Rocky Linux | https://github.com/leifliddy| https://github.com/leifliddy/asahi-rocky-builder |
| Ubuntu | https://github.com/UbuntuAsahi | https://ubuntuasahi.org/ |
| Void Linux | https://voidlinux.org/news/2025/02/new-images.html | https://docs.voidlinux.org/installation/guides/arm-devices/apple-silicon.html |
| Alpine Linux | IRC: mps (<https://arvanta.net/alpine>) | <https://arvanta.net/alpine/install-alpine-m1/> |
| AOSC OS | <https://github.com/AOSC-Dev> | <https://aosc.io/downloads/asahi> |
| Arch Linux ARM | <https://github.com/asahi-alarm/> | <https://github.com/asahi-alarm/asahi-alarm> |
| CentOS Stream | <https://github.com/ericcurtin> | <https://github.com/ericcurtin/asahi-centosstream-builder> |
| Debian | <https://thomas.glanzmann.de/> | <https://git.zerfleddert.de/cgi-bin/gitweb.cgi/m1-debian/> |
| deepin | <https://github.com/deepin-community> | <https://github.com/deepin-community/deepin-m1> |
| deepin | deepin M1 SIG | <https://www.deepin.org/index/docs/sig/sig/deepin-m1/README> |
| Fedora | <https://github.com/leifliddy> | <https://github.com/leifliddy/asahi-fedora-builder> |
| Gentoo<br>(LiveCD method) | IRC: chadmed (<https://github.com/chadmed>) | [Installing Gentoo with LiveCD](Installing-Gentoo-with-LiveCD.md) |
| NixOS | IRC: tpw_rules (<https://github.com/tpwrules>) | <https://github.com/tpwrules/nixos-apple-silicon/blob/main/docs/uefi-standalone.md> |
| Rocky Linux | <https://github.com/leifliddy> | <https://github.com/leifliddy/asahi-rocky-builder> |
| Ubuntu | <https://github.com/UbuntuAsahi> | <https://ubuntuasahi.org/> |
| Void Linux | <https://voidlinux.org/news/2025/02/new-images.html> | <https://docs.voidlinux.org/installation/guides/arm-devices/apple-silicon.html> |
2 changes: 1 addition & 1 deletion docs/SW-Keyboard-Layouts.md
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ Apple MacBook Pro (14-inch, M1 Pro, 2021)
* Best XKB keyboard layout/variant: **English (US)**

* My original keyboard is ISO German with stickers for International English. Working correctly in Mac OS.
* Looks like https://www.apple.com/uk/shop/product/MK2A3Z/A/magic-keyboard-international-english
* Looks like <https://www.apple.com/uk/shop/product/MK2A3Z/A/magic-keyboard-international-english>
* Preview works for "English (US)", not for any of the English international variants.
* Difference 1 with English (US): Key between Shift and Z is ~` on physical keyboard but types < > in Fedora.
* Difference 2 with English (US): Key in top left next to 1 is +- § on physical keyboard but types ~` in Fedora.
Expand Down
12 changes: 6 additions & 6 deletions docs/SW-Ubuntu-Asahi-Qemu.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,12 +145,12 @@ https://blogs.oracle.com/virtualization/post/install-microsoft-windows-11-on-vir

b) Figure out UEFI and TPM and how to activate it, not tested:

- https://getlabsdone.com/how-to-install-windows-11-on-kvm/
- https://getlabsdone.com/how-to-enable-tpm-and-secure-boot-on-kvm/
- https://github.com/stefanberger/swtpm/wiki
- https://www.reddit.com/r/AsahiLinux/comments/y7hplo/virtual_machines_on_asahi_linux/
- https://that.guru/blog/uefi-secure-boot-in-libvirt/
- https://www.reddit.com/r/AsahiLinux/comments/107m4nb/windows_vm_on_asahi_qemukvm_virtmanager/
- <https://getlabsdone.com/how-to-install-windows-11-on-kvm/>
- <https://getlabsdone.com/how-to-enable-tpm-and-secure-boot-on-kvm/>
- <https://github.com/stefanberger/swtpm/wiki>
- <https://www.reddit.com/r/AsahiLinux/comments/y7hplo/virtual_machines_on_asahi_linux/>
- <https://that.guru/blog/uefi-secure-boot-in-libvirt/>
- <https://www.reddit.com/r/AsahiLinux/comments/107m4nb/windows_vm_on_asahi_qemukvm_virtmanager/>

```
sudo apt-get install dh-autoreconf libssl-dev \
Expand Down
2 changes: 1 addition & 1 deletion docs/Yaks-in-need-of-shaving.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ any questions or are in need of assistance.
| Extend tipd driver | **Unclaimed** | Add support to reset other Apple Silicon machines, and to enable serial, to [tipd](https://github.com/AsahiLinux/linux/blob/asahi/drivers/usb/typec/tipd/core.c). On the Macs, some parts of the USB specification are implemented by (undocumented) CD321x chips, similar to [TPS65982](https://www.ti.com/lit/ds/symlink/tps65982.pdf). Apple added some [debugging features](HW-USB-PD.md) to their Type-C ports, and if we want to make use of those when running Linux on an M1/M2 host for development (connected to another M1/M2 machine being the target of experimentation), we need to extend the `tipd` driver. | suggested by sven |
| Bluetooth suspend | **Unclaimed** | Currently, when suspending and then resuming Bluetooth breaks. This is either an issue with the way hci_bcm4377 uses the bluetooth suspend API or we are missing some special vendor-specific commands before suspend or after resume. It's probably possible to figure this out without making the hypervisor survive a full suspend/resume cycle by using Apple's PacketLogger which is part of the "Additional Tools for XCode" to look for additional commands. It's probably also a good idea to compare how hci_bcm4377 suspend works to other Bluetooth drivers since it's also possible that it's just misusing some API that gets the device stuck in a wrong state. | sven |
| Keyboard layout cleanup (XKB/hid_apple) | Unclaimed | Apple keyboard support across the Linux desktop stack has been hit-and-miss, across layouts and hardware keyboards. Since our keyboard drivers are not upstream yet, we have the chance to do some major cleanup. In particular, the keyboards on these machines have a soft *Fn* key that is handled entirely in software. The `hid_apple` driver currently does this in the kernel, but this is the wrong approach. This key should be handled in userspace in XKB/Wayland (Xorg cannot do it, but it's deprecated), so that we can have more comprehensive Fn key mappings including letting users customize the key bindings like they would any other modifier key, or offer special symbols like macOS does. This should probably be done by introducing new XKB keyboard models, which do this mapping in userspace. To test this, use the `fnmode=0` module parameter for `hid_apple` to disable all Fn key processing. We will later want to introduce a new fnmode that *only* does Fn key combination emulation for the edit keys (insert/delete/home/end/pgup/pgdown), which is the minimum required for a usable TTY and Xorg, and leave the rest to XKB, defaulting to this mode on Apple Silicon machines. Besides the Fn story, there are also many regional Mac layouts that need to be fixed in XKB configuration, and everyone with a non-English keyboard is welcome to help out with that effort. [Relevant xkeyboard-config issue](https://gitlab.freedesktop.org/xkeyboard-config/xkeyboard-config/-/issues/379)| marcan |
| Various unexplained errors | Unclaimed | As of asahi-6.8.10-4, there continue to be a variety of low-severity messages logged in the dmesg. They don't appear to prevent proper functioning, but someone with kernel debugging experience should track them down and submit fixes for them. Here are some examples from a M1 MacBook Air, found by running `sudo dmesg`: https://gist.github.com/zzywysm/d4f1669ff3b7454e2821a65e31c511e1 | ? |
| Various unexplained errors | Unclaimed | As of asahi-6.8.10-4, there continue to be a variety of low-severity messages logged in the dmesg. They don't appear to prevent proper functioning, but someone with kernel debugging experience should track them down and submit fixes for them. Here are [some examples](https://gist.github.com/zzywysm/d4f1669ff3b7454e2821a65e31c511e1) from a M1 MacBook Air, found by running `sudo dmesg`. | ? |

0 comments on commit bf0d323

Please sign in to comment.