Skip to content

Commit

Permalink
Bring in more external images, fix wiki references
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 14d896b commit 327fdc1
Show file tree
Hide file tree
Showing 15 changed files with 13 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docs/Accelerator-Engines.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
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 wiki](FW-ADT.md). Can we make a progress matrix regarding firmware?
*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?

## Names

Expand Down
2 changes: 1 addition & 1 deletion docs/Developer-Quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -288,7 +288,7 @@ In the coming weeks we'll be designing an open hardware interface for interfacin

### USB gadget mode using a standard USB cable

m1n1 now supports exposing its debug console and proxy interface via a standard USB [CDC-ACM](https://en.wikipedia.org/wiki/USB_communications_device_class) device. All you need is a standard USB cable (C to C or A to C, as appropriate for your host machine). ![USB Type-C to Type A cable](https://raw.githubusercontent.com/amworsley/asahi-wiki/main/images/USB-TypeC-A-cable.png)
m1n1 now supports exposing its debug console and proxy interface via a standard USB [CDC-ACM](https://en.wikipedia.org/wiki/USB_communications_device_class) device. All you need is a standard USB cable (C to C or A to C, as appropriate for your host machine). ![USB Type-C to Type A cable](assets/USB-TypeC-A-cable.png)

This interface is much faster than a serial port, and is the preferred way of using m1n1 remotely. However, a serial console is still recommended in addition to this for low-level debugging and development.

Expand Down
6 changes: 3 additions & 3 deletions docs/Low-level-serial-debug.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,8 @@ This is all rather rudimentary because it's a stop-gap for the proper solution,

An alternative to the above DIY approach is the Central Scrutinizer project, which started exactly as the above, only using a custom PCB instead of a breadboard. It has since evolved to support additional features, but the core functionality is exactly the same:

![PXL_20230721_101806861~2](https://github.com/AsahiLinux/docs/assets/19569618/bf545188-f8d8-4888-acd9-58985ac84099)
![](https://cdn.tindiemedia.com/images/resize/7EHWxGEFPrA2RvpCMu6XwfxsC2c=/p/full-fit-in/1200x800/i/441372/products/2023-08-26T15%3A13%3A11.940Z-PXL_20230826_151035866~2.jpg)
![Central Scrutinizer](assets/central-scrutinizer.jpg)
![Central Scrutinizer (side)](assets/central-scrutinizer-2.jpg)

Main features are:
- RaspberryPi Pico as the micro-controller (yes, totally overkill, but cheaper than an Arduino!)
Expand All @@ -90,4 +90,4 @@ If you want more information about this project, feel free to get in touch with

~~In the coming weeks we'll be designing an open hardware interface for interfacing to M1 serial ports, and more (supporting other debug pinsets on Apple devices, as well as UARTs on other devices such as certain Android phones, etc). Stay tuned for more information. Established kernel developers who want to get an early prototype when they become available should contact [marcan](mailto:[email protected]).~~

Note: This is indefinitely backburnered and mostly rendered obsolete by USB support in m1n1/hypervisor.
Note: This is indefinitely backburnered and mostly rendered obsolete by USB support in m1n1/hypervisor.
4 changes: 2 additions & 2 deletions docs/SW-Keyboard-Layouts.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Next, make sure you have your keyboard model correctly selected. In your keyboar

Finally, choose the layout that looks right for your language. This *should* be just the plain language type, since Mac-specific customizations should be applied based on the keyboard model. However, please do try multiple options (e.g. some languages may have a *Macintosh* variant, though this may make things worse).

Then add a report using the template below (edit the wiki page and copy the template section). If your layout is already listed but you have a different experience (e.g. on another machine), add a new *System configuration* subsection and note any differences you see in it.
Then add a report using the template below ([send a PR](https://github.com/AsahiLinux/docs) following the template section). If your layout is already listed but you have a different experience (e.g. on another machine), add a new *System configuration* subsection and note any differences you see in it.

Please add as much detail as you can about what works, what is different from what's printed on the keycaps, any language- or region-specific quirks or issues we need to be aware of, anything special that macOS does, hidden combinations that are *not* printed on the keycaps that should work, how this might differ from your experience on Windows and generic Linux desktops on non-Apple keyboards, etc. We need as much information as possible in order to do the right thing in the future.

Expand Down Expand Up @@ -280,4 +280,4 @@ error: package 'xkeyboard-config-asahi' was not found
Apple MacBook Air (M1, 2020)
00
0d
```
```
2 changes: 1 addition & 1 deletion docs/SW-Linux-USBKeyboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@
* Booted it directly via ```python3.9 proxyclient/tools/linux.py -b 'earlycon console=tty0 console=tty0 debug' Image-dwc3.gz t8103-j274.dtb initrd-be2.gz```
* Where the Image-dwc3.gz is the Asahi dart/dev kernel, the t8103.j274.dtb built with that kernel, at **linux/arch/arm64/boot/dts/apple/t8103-j274.dtb**, and initrd-be2.gz is the modified debian Bullseye initrd to just run **/bin/sh** after the set up.
* Then I used a Type-C to Type-A adapter to plug in a normal old USB Dell keyboard and enter commands into the /bin/sh running.
![Linux running on M1 macbook with input via external USB keyboard](https://github.com/amworsley/asahi-wiki/blob/main/images/linuxOnM1.png)
![Linux running on M1 macbook with input via external USB keyboard](assets/linuxOnM1.png)

* You can go one step further and try [booting a USB drive](SW-Linux-USB-drive.md)
2 changes: 1 addition & 1 deletion docs/SW-Linux-X11.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@
* For a web browser install firefox as Chrome requires special kernel paging support (not available at this time)
`sudo apt install firefox-esr`

(![X11 running on Macbook Air 2020](https://raw.githubusercontent.com/amworsley/asahi-wiki/main/images/mba-xorg-fbdev.png))
(![X11 running on Macbook Air 2020](assets/mba-xorg-fbdev.png))
2 changes: 1 addition & 1 deletion docs/SW-Linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ cp ../linux/arch/arm64/boot/dts/apple/t8103-j274.dtb t8103-j274.dtb
python3.9 proxyclient/tools/chainload.py build/m1n1.macho
```
# Running Linux via USB cable
* Connecting [USB Type-C to Type A/C cable](Developer-Quickstart.md#usb-gadget-mode-using-a-standard-usb-cable) to M1 Mac provides two USB serial interfaces on the other computer![USB Type-C to Type A cable connecting M1 MacBookAir and 2012 MacBootAir Pro](https://raw.githubusercontent.com/amworsley/asahi-wiki/main/images/usb-setup.png)
* Connecting [USB Type-C to Type A/C cable](Developer-Quickstart.md#usb-gadget-mode-using-a-standard-usb-cable) to M1 Mac provides two USB serial interfaces on the other computer![USB Type-C to Type A cable connecting M1 MacBookAir and 2012 MacBootAir Pro](assets/usb-setup.png)
* This can be connected to via the python proxy tool to boot up Linux directly or load up a macho binary like an updated m1n1 version or combined with a Linux image
* Get a 27Mb initrd from debian arm64 installer
```
Expand Down
3 changes: 2 additions & 1 deletion docs/When-will-Asahi-Linux-be-done.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ If you're after the support status of a specific feature, [Feature Support](Feat
## Why you shouldn't ask this question on IRC

If you ask on any of our IRC channels when Asahi Linux will be done, you will likely get one of these responses, or a variant thereof:

* "Soon"
* "It already works"
* "Never"
Expand Down Expand Up @@ -33,4 +34,4 @@ The time it takes us to bring new hardware online is entirely dependent on the c

Apple make things somewhat easier for us by only introducing changes to hardware when it is absolutely necessary to do so. The original iteration of the AIC (Apple Interrupt Controller) was unchanged from the early iPhones all the way to the M1. We expect AIC2, first found in the M1 Pro and Max, to have a similar, if not longer lifespan. Generally, changes to any piece of hardware will be supported in less time than it took to bring up the hardware initially.

Large architectural changes to things like the GPU and Neural Engine may take slightly longer to figure out. As such, we cannot guarantee dates or turnaround times for any new silicon Apple release. The answer to the question "When will [_feature_] on [_machine_] be supported?" is always "When it is listed as supported on the Wiki."
Large architectural changes to things like the GPU and Neural Engine may take slightly longer to figure out. As such, we cannot guarantee dates or turnaround times for any new silicon Apple release. The answer to the question "When will [_feature_] on [_machine_] be supported?" is always "When it is listed as supported in the documentation."
Binary file added docs/assets/USB-TypeC-A-cable.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/central-scrutinizer-2.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/central-scrutinizer.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/linuxOnM1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/mba-xorg-fbdev.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/usb-setup.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ markdown_extensions:
- pymdownx.tasklist:
custom_checkbox: true
clickable_checkbox: true
- pymdownx.tilde

plugins:
- redirects:
Expand Down

0 comments on commit 327fdc1

Please sign in to comment.