Mirrors/m1n1
2
0
Fork 0
mirror of https://github.com/AsahiLinux/m1n1 synced 2024-11-21 14:23:01 +00:00
Code Issues Projects Releases Packages Wiki Activity
No description
2215 commits 13 branches 49 tags 8.6 MiB
Python 53.9%
C 44.5%
Assembly 0.8%
Rust 0.5%
Makefile 0.2%
Other 0.1%
Find a file
Eileen Yoon 476c31e973 afk.rbep: Bootstrap ringbuf block size at runtime 
Make the ringbuffer class robust to various block sizes to generalize to
both DCP and AOP.

The first three blocks of the ringbuffer is reserved for exchanging size,
rptr, wptr:

```
           bufsize      unk
00000000  00007e80 00070006 00000000 00000000 00000000 00000000 00000000 00000000
00000020  00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000
00000040  *   rptr
00000080  00000600 00000000 00000000 00000000 00000000 00000000 00000000 00000000
000000a0  00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000
000000c0  *   wptr
00000100  00000680 00000000 00000000 00000000 00000000 00000000 00000000 00000000
00000120  00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000
00000140  *
```

Each block is spread out by some block_size multiple of 0x40 (step). The
0th block holds the size of the ringbuffer contents, the 1st block holds
the rptr, and the 2nd block holds the wptr. The actual contents of the
ringbuffer starts after the first three blocks, which will be
collectively called the "header".

However, this block_size isn't constant. DCP seems to consistently use
0x40, but AOP can use both 0x40/0x80. Since we're not given the block_size,
so wemust bootstrap it. Recall we are given the total size of the
rinbuffer in the mailbox message. Since we're always given the size of
the ringbuffer `bufsize` at offset +block_size * 0 (or simply 0), and we
can find the header size by subtracting `bufsize` from the total size.
Since we also know that the header is always 3 blocks wide, we can
divide the header size by 3 to obtain the block_size.

Signed-off-by: Eileen Yoon <eyn@gmx.com>
2024-10-31 01:24:36 +09:00
.github/workflows github: workflow: Update to actions/upload-artifact@v4 2024-09-25 08:22:36 +09:00
3rdparty_licenses usb: add drivers/usb/dwc3/core.h from linux 2021-04-15 18:39:33 +09:00
artwork@35626c31f5 Initial commit 2021-01-15 04:03:35 +09:00
data bash is not available everywhere. Use #!/usr/bin/env sh instead 2023-11-02 15:54:34 +09:00
font fb console: add Source Code Pro font 2021-04-14 18:11:37 +09:00
proxyclient afk.rbep: Bootstrap ringbuf block size at runtime 2024-10-31 01:24:36 +09:00
rust rust: Switch to new core::ffi types 2024-04-09 13:20:00 +09:00
src Cleanup and name some previouly-unnamed registers 2024-10-31 01:22:58 +09:00
sysinc math: Add powf() 2023-06-27 18:35:00 +09:00
tools hv: Use architectural ACTLR_EL12 on M2+ 2024-09-22 01:09:43 +09:00
udev udev/80-m1n1.rules: Add udev rules 2022-07-30 13:41:38 +09:00
.clang-format rust: Initial Rust-based EFI FAT32 chainloader 2022-03-09 22:01:42 +09:00
.editorconfig .editorconfig: trim trailing whitespace 2021-01-15 04:04:12 +09:00
.gitignore Add a few more temporary files to .gitignore 2021-08-03 13:52:31 +09:00
.gitmodules rust: Switch to new core::ffi types 2024-04-09 13:20:00 +09:00
config.h display: Add NO_DISPLAY build config to skip display init 2023-11-27 13:33:08 +09:00
docker-compose.yml tooling: Add container setup for build environment 2021-02-18 16:14:15 +09:00
Dockerfile docker: install rust toolchain for stage1 builds 2024-09-25 08:31:20 +09:00
LICENSE LICENSE: Fix copyright line 2022-03-07 23:59:25 +09:00
m1n1-raw.ld rust: Initial Rust-based EFI FAT32 chainloader 2022-03-09 22:01:42 +09:00
m1n1.ld rust: Initial Rust-based EFI FAT32 chainloader 2022-03-09 22:01:42 +09:00
Makefile Makefile: Fix build when using clang as AS 2024-09-25 08:30:36 +09:00
README.md Add option for building verbosely 2023-12-03 17:45:52 +09:00
version.sh Replace bashisms with posix shell alternatives. 2023-01-13 17:29:15 +09:00

README.md

m1n1: an experimentation playground for Apple Silicon

(And to some extent a Linux bootloader)

Building

You need an aarch64-linux-gnu-gcc cross-compiler toolchain (or a native one, if running on ARM64).

$ git clone --recursive https://github.com/AsahiLinux/m1n1.git
$ cd m1n1
$ make

The output will be in build/m1n1.macho.

To build on a native arm64 machine, use make ARCH=.

To build verbosely, use make V=1.

Building on ARM64 macOS is supported with clang and LLVM; you need to use Homebrew to install the required dependencies:

$ brew install llvm

After that, just type make.

Building using the container setup

If you have a container runtime installed, like Podman or Docker, you can make use of the compose setup, which contains all build dependencies.

$ git clone --recursive https://github.com/AsahiLinux/m1n1.git
$ cd m1n1
$ podman-compose run m1n1 make
$ # or
$ docker-compose run m1n1 make

Usage

Our wiki has more information on how to use m1n1.

To install on an OS container based on macOS <12.1, use m1n1.macho:

kmutil configure-boot -c m1n1.macho -v <path to your OS volume>

To install on an OS container based on macOS >=12.1, use m1n1.bin:

kmutil configure-boot -c m1n1.bin --raw --entry-point 2048 --lowest-virtual-address 0 -v <path to your OS volume>

Payloads

m1n1 supports running payloads by simple concatenation:

$ cat build/m1n1.macho Image.gz build/dtb/apple-j274.dtb initramfs.cpio.gz > m1n1-payload.macho
$ cat build/m1n1.bin Image.gz build/dtb/apple-j274.dtb initramfs.cpio.gz > m1n1-payload.bin

Supported payload file formats:

  • Kernel images (or compatible). Must be compressed or last payload.
  • Devicetree blobs (FDT). May be uncompressed or compressed.
  • Initramfs cpio images. Must be compressed.

Supported compression formats:

  • gzip
  • xz

License

m1n1 is licensed under the MIT license, as included in the LICENSE file.

  • Copyright The Asahi Linux Contributors

Please see the Git history for authorship information.

Portions of m1n1 are based on mini:

m1n1 embeds libfdt, which is dual BSD and GPL-2 licensed and copyright:

  • Copyright (C) 2014 David Gibson david@gibson.dropbear.id.au
  • Copyright (C) 2018 embedded brains GmbH
  • Copyright (C) 2006-2012 David Gibson, IBM Corporation.
  • Copyright (C) 2012 David Gibson, IBM Corporation.
  • Copyright 2012 Kim Phillips, Freescale Semiconductor.
  • Copyright (C) 2016 Free Electrons
  • Copyright (C) 2016 NextThing Co.

The ADT code in mini is also based on libfdt and subject to the same license.

m1n1 embeds minlzma, which is MIT licensed and copyright:

  • Copyright (c) 2020 Alex Ionescu

m1n1 embeds a slightly modified version of tinf, which is ZLIB licensed and copyright:

  • Copyright (c) 2003-2019 Joergen Ibsen

m1n1 embeds portions taken from arm-trusted-firmware, which is BSD licensed and copyright:

  • Copyright (c) 2013-2020, ARM Limited and Contributors. All rights reserved.

m1n1 embeds Doug Lea's malloc (dlmalloc), which is in the public domain (CC0).

m1n1 embeds portions of PDCLib, which is in the public domain (CC0).

m1n1 embeds the Source Code Pro font, which is licensed under the OFL-1.1 license and copyright:

  • Copyright 2010-2019 Adobe (http://www.adobe.com/), with Reserved Font Name 'Source'. All Rights Reserved. Source is a trademark of Adobe in the United States and/or other countries.
  • This Font Software is licensed under the SIL Open Font License, Version 1.1.

m1n1 embeds portions of the dwc3 usb linux driver, which was BSD-or-GPLv2 dual-licensed and copyright

m1n1 embeds portions of musl-libc's floating point library, which are MIT licensed and copyright

  • Copyright (c) 2017-2018, Arm Limited.

m1n1 embeds some rust crates. Licenses can be found in the vendor directory for every crate.