# Supported platforms

## Recommended: Raspberry Pi 4 or Pi 5

gokrazy development happens primarily on the Raspberry Pi 5, but the Pi 4 is also a great choice!

## All currently supported platforms

#### Raspberry Pi 5

#### Raspberry Pi 4B

#### PC Engines APU

#### Raspberry Pi Zero 2W

#### Raspberry Pi 3 B and 3 B+

## Continuous Integration (CI)

Appliances which are marked in bold are tested in the CI setup on real hardware and gate new kernel and firmware versions, and hence can be considered supported.

Non-bold appliances are supported in a best-effort way, meaning they might be temporarily broken at HEAD.

The leading `github.com` in front of package import paths has been omitted for space reasons.

Target | Hardware | GOARCH | Kernel package | Firmware package | Appliances
--- | --- | --- | --- | --- | ---
apu2c4 | apu2c4 | amd64 | rtr7/kernel | rtr7/kernel | gokrazy/bakery/cmd/bake
|  |  |  |  | rtr7/router7
x86-64 | qemu | amd64 | rtr7/kernel | rtr7/kernel | gokrazy/bakery/cmd/bake
rpi5b | raspi5b | arm64 | gokrazy/kernel.rpi | gokrazy/firmware | gokrazy/bakery/cmd/bake stapelberg/scan2drive
rpi4b | raspi4b | arm64 | gokrazy/kernel | gokrazy/firmware | gokrazy/bakery/cmd/bake stapelberg/hmgo
rpi3b | raspi3b | arm64 | gokrazy/kernel | gokrazy/firmware | gokrazy/bakery/cmd/bake
rpi3b+ | raspi3b+ | arm64 | gokrazy/kernel | gokrazy/firmware | gokrazy/bakery/cmd/bake
rpizero2w | raspizero2w | arm64 | gokrazy/kernel | gokrazy/firmware | gokrazy/bakery/cmd/bake

## Performance

The turbojpeg encoding column is the result of running scan2drive’s `turbojpeg` micro-benchmark

The json column is the result of running the `json` benchmark from the x/benchmarks repo.

Hardware | turbojpeg encoding | json
--- | --- | ---
raspi5b | 0.32s | 24ms
raspi4b | 1.00s | 38ms
raspi3b | 1.05s | 216ms
raspizero2w | 1.04s | 184ms

## Power Usage

These power measurements were done using a myStrom WiFi Switch with measurement feature.

The Raspberry Pi 4 and Pi 5 were using their original Raspberry Pi power supply, the others were measured with a random USB power supply.

An Ethernet cable was connected in all tests, WiFi was not enabled.

Hardware | Power Usage (with Ethernet) | Power Usage (with HDMI and WiFi)
--- | --- | ---
apu2c4 | 4.0W | n/a
raspi5b | 3.2W | 3.5W
raspi4b | 2.8W | 3.3W
raspi3b+ | 2.5W | TODO
raspi3b | 1.5W | TODO
raspizero2w | 0.8W | TODO

## Hardware Support

Hardware | WiFi | Bluetooth
--- | --- | ---
apu2c4 | needs card, untested | needs dongle, untested
raspi3b | open or WPA-PSK | limited
raspi3b+ | open or WPA-PSK | limited
raspi4b | open or WPA-PSK | limited
raspi5b | open or WPA-PSK | limited
raspizero2w | open or WPA-PSK | limited

## gokrazy kernel repository map

### Officially supported kernels

These kernels are tested in Continuous Integration.

They are built from one of two sources: Either from Raspberry Pi’s Linux kernel fork, or from the upstream Linux kernel from kernel.org.

The upstream Linux kernel gets security fixes the quickest, but the Raspberry Pi Linux kernel supports more Raspberry Pi models (notably the Pi 5, which upstream does not support) and peripherals.

repository | source | devices
--- | --- | ---
gokrazy/kernel.rpi | Raspberry Pi | Pi 3, Pi 4, Pi 5, Pi Zero 2 W
gokrazy/kernel | kernel.org | Pi 3, Pi 4, Pi Zero 2 W
gokrazy/kernel.amd64 | kernel.org | PC x86_64, VMs
gokrazy/kernel.arm64 | kernel.org | PC arm64, VMs

### Community-supported kernels

Independently from the officially supported gokrazy kernels listed above, people of our community provide alternative kernels and firmwares, in order to run gokrazy on unsupported platform or to provide new features. They may not be as thoroughly tested as the official platforms. Please report any issue to their respective repository.

repository | source | devices
--- | --- | ---
gokrazy-community/kernel-rpi-os-32 | Raspberry Pi | Pi 1, Pi 2, Pi 3, Pi 4, Pi 5, Pi Zero W, Pi Zero 2 W (32 bit)
anupcshan/gokrazy-odroidxu4-kernel | kernel.org | Odroid XU4, HC1, HC2
anupcshan/gokrazy-rock64-kernel | kernel.org | Pine64 Rock64

## Community-supported platforms

This section provides more details for community-supported platforms.

### Community-supported Odroid XU4/HC1/HC2

Odroid XU4/HC1/HC2 is based on a Samsung Exynos 5422 SOC (4 ARM Cortex-A15 cores and 4 ARM Cortex-A7 cores) and has been on the market since ~2016. HC1 and HC2 variants support installing a 2.5’/3.5’ hard drive on board.

Kernel for these devices is available at github.com/anupcshan/gokrazy-odroidxu4-kernel. This package contains a recent kernel, U-boot and some binary blobs that are required to initiate the boot process. It has been tested against Odroid HC2 hardware with gigabit networking, USB and HDD functional.

See github.com/anupcshan/odroidbake for an example on how to create a new disk image.

    {
        "Hostname": "odroid",
        "DeviceType": "odroidhc1",
        "Packages": [
            "github.com/gokrazy/fbstatus",
            "github.com/gokrazy/hello",
            "github.com/gokrazy/serial-busybox",
            "github.com/gokrazy/breakglass"
        ],
        "KernelPackage": "github.com/anupcshan/gokrazy-odroidxu4-kernel",
        "FirmwarePackage": "",
        "EEPROMPackage": ""
    }

### Community-supported Rock64

Pine64 Rock64 is based on a Rockchip RK3328 SOC (4 ARM Cortex-A53 cores) and has been on the market since ~2017.

Kernel for these devices is available at github.com/anupcshan/gokrazy-rock64-kernel. This package contains a recent kernel and mainline U-boot required to initiate the boot process. These have been tested against real hardware with gigabit networking and USB working under Gokrazy.

Usage of eMMC module is not supported yet - github.com/gokrazy/gokrazy/issues/270.

    {
        "Hostname": "my-rock64",
        "DeviceType": "rock64",
        "Packages": [
            "github.com/gokrazy/fbstatus",
            "github.com/gokrazy/hello",
            "github.com/gokrazy/serial-busybox",
            "github.com/gokrazy/breakglass"
        ],
        "KernelPackage": "github.com/anupcshan/gokrazy-rock64-kernel",
        "FirmwarePackage": "",
        "EEPROMPackage": ""
    }